commit | e52eed3d943daecca42c83c0b9aea8bc80f8b8d0 | [log] [tgz] |
---|---|---|
author | tkappurify <terence@appurify.com> | Fri May 02 20:20:49 2014 |
committer | tkappurify <terence@appurify.com> | Fri May 02 20:20:49 2014 |
tree | 8d34e234fc7bd11ff6f871f4082c786b25985af9 | |
parent | 5f579341aa874419753a86a770a77cb396f52119 [diff] | |
parent | 9ea2d2a4e1f06be77aacb82ab3ea15a0ea97b89b [diff] |
Merge branch 'master' of https://github.com/appurify/appurify-python
The official Python client for the Appurify API.
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
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
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.
API_KEY
: Used for authenticationAPI_SECRET
: Used for authenticationAPP_SRC
: The path or URL to the app binary (.ipa or .apk)TEST_SRC
: The path or URL where the test files are locatedTEST_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 testRESULT_DIR
: The directory on your local machine where you want your results to be written.In Jenkins create a new Execute Shell build step and upload your app using the Python wrapper as pictured below.
To facilitate error reporting, the client will report one of the following error codes on exit:
Code | Meaning |
---|---|
0 | Test completed with no exceptions or errors |
1 | Test completed normally but reported test failures |
2 | Test was aborted by the user or system |
3 | Test was aborted by the system because of timeout |
4 | Test could not be completed because the device could not be activated or reserved |
5 | Test could not execute because there was an error in the configuration or uploaded files |
6 | Test could not execute because the server rejected the provided credentials |
7 | Test could not execute because of other server/remote exception |
8 | Test could not execute because of an unexpected error in the client |
Found a bug or want to add a much needed feature? Go for it and send us the Pull Request!
--version
flag to print version and exit--timeout
parameter to specify the desired timeout at runtime, or using the os environment variable APPURIFY_API_TIMEOUT
. Specify desired timeout in seconds.ios_sencharobot
test typenetwork_headers
test type no longer requires app sourceresult-dir
parameter.kif
test type