Skip to content
This repository has been archived by the owner on May 2, 2023. It is now read-only.

Commit

Permalink
Docs fix
Browse files Browse the repository at this point in the history
  • Loading branch information
Ran Ben Aharon committed Mar 10, 2015
1 parent bf4570e commit 17445d5
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions docs/setup.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,23 +21,24 @@ Running tests

$ magneto <TEST_DIR> --apk-path <PATH_TO_APK> --apk-package <APK_PACKAGE_NAME> --app-activity <APP_ACTIVITY>

Required params:
Required:

+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| Option | Description |
+=====================================+==========================================================================================================================+
| ``<TEST_DIR>`` | Test file directory path. Usually ``ui_tests`` (Required) |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| ``--app-package <APK_PACKAGE_NAME>``| Tested app package name. e.g. ``--app-package com.facebook.katana`` |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------+
| ``--app-activity <APK_ACTIVITY>`` | Tested app activity string. e.g. ``--app-activity com.facebook.katana.LoginActivity`` |
+-------------------------------------+--------------------------------------------------------------------------------------------------------------------------+


Additional params:

+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| Option | Description |
+=====================================+=============================================================================================================================================+
| ``--app-package <APK_PACKAGE_NAME>``| Tested app package name. e.g. ``--app-package com.facebook.katana`` |
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| ``--app-activity <APK_ACTIVITY>`` | Tested app activity string. e.g. ``--app-activity com.facebook.katana.LoginActivity`` |
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| ``-k <TEST_NAME / TAG>`` | Run only matching tests by test name (i.e. ``test_my_feature``) or @tag decorator (i.e. ``search_results``) |
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| ``--clean-install`` | Uninstalls and then installs the tested apk specifies in the parameter ``--apk-path``. |
Expand All @@ -55,4 +56,4 @@ Additional params:
| ``--magneto-failed-data-dir`` | Allows overriding the default ``/tmp/magneto_test_data/`` directory for failed test data. |
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
| ``--wait-for-element-timeout`` | Allows overriding the default 5000ms (5 seconds) element find timeout. |
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+
+-------------------------------------+---------------------------------------------------------------------------------------------------------------------------------------------+

0 comments on commit 17445d5

Please sign in to comment.