Google Git
Sign in
chromium / external / github.com / appurify / appurify-python / 23d71a62d5a2ff6311217c8ad8a438eab18c0cef
commit23d71a62d5a2ff6311217c8ad8a438eab18c0cef[log] [tgz]
authorAbhinav Singh <mailsforabhinav@gmail.com>Wed Mar 12 04:11:41 2014
committerAbhinav Singh <mailsforabhinav@gmail.com>Wed Mar 12 04:11:41 2014
tree6e184d49aa6099282052a6500c0db5a9ef019bdc
parentf276f5c1feda71fdbbda97ab21f31aad85de9935 [diff]
add tunnel usage info in readme
1 file changed
tree: 6e184d49aa6099282052a6500c0db5a9ef019bdc
  1. appurify/
  2. dist/
  3. pycrypto/
  4. tests/
  5. .gitignore
  6. appurify-client.py
  7. appurify-tunnel.py
  8. appurify.conf
  9. jenkins.png
  10. LICENSE
  11. Makefile
  12. MANIFEST.in
  13. README.md
  14. README.txt
  15. requirements.txt
  16. setup.py
  17. tox.ini
README.md

Appurify Python Client

The official Python client for the Appurify API.

Installation

pip install appurify-0.2.9.tar.gz

This will install any missing dependencies and add two executable scripts to your bin folder:

$ appurify-client.py -h
$ appurify-tunnel.py -h

Running Tests

appurify-client.py --api-key $API_KEY --api-secret $API_SECRET \
--app-src $APP-SRC --app-test-type $TEST_TYPE --test-src $TEST_SRC --test-type $TEST_TYPE \
--device-type-id $DEVICE_TYPE_IDS --result-dir $RESULT_DIR

Starting Tunnel

appurify-tunnel.py --api-key $API_KEY --api-secret $API_SECRET

To provide local/private network environment to your tests, they must be started after tunnel has been established.

Parameters

  • API_KEY: Used for authentication
  • API_SECRET: Used for authentication
  • APP_SRC: The path or URL to the app binary (.ipa or .apk)
  • TEST_SRC: The path or URL where the test files are located
  • TEST_TYPE: Your test framework name e.g. calabash, ios_robot, ocunit, uiautomation. See constants.py for list of supported test types.
  • DEVICE_TYPE_IDS: A comma separated list of numbers representing the device type IDs you wish to use for your test
  • RESULT_DIR: The directory on your local machine where you want your results to be written.

Jenkins Integration

In Jenkins create a new Execute Shell build step and upload your app using the Python wrapper as pictured below.

Jenkins Integration

Contribution

Found a bug or want to add a much needed feature? Go for it and send us the Pull Request!

Release Notes

0.2.9

  • Handle case where test results may not immediately be ready for download after a test completes.

0.2.8

  • Added --version flag to print version and exit

0.2.6

  • Users will receive a warning when attempting to upload a web test without specifying the url parameter.
  • Support for both --timeout parameter to specify the desired timeout at runtime, or using the os environment variable APPURIFY_API_TIMEOUT. Specify desired timeout in seconds.

0.2.2

  • Added ios_sencharobot test type

0.2.1

  • network_headers test type no longer requires app source
  • Fixed an issue where test results were not properly downloaded despite setting the result-dir parameter.
  • Test source is now optional for kif test type
  • Improved test status information when polling a running test
  • Configuration values are now printed when running a test
  • Fixed a bug where ``name``` parameter was not respected for web apps