Testrun CLI options

Home - Test organization - Testrun CLI options

---

The table below shows the CLI options that can be used to configure a testrun. The table has the following columns:

• Name. Name of CLI option
• wdio. Whether for WebdriverIO testruns this option is required (+), optional (-), sometimes required (?), or not supported (x).
• karma. Whether for Karma testruns this option is required (+), optional (-), sometimes required (?), or not supported (x).
• Description. What the option does, what valid values are, and if there are alternative methods for specifying a value. If the option is optional, what the default value. If the option is required only sometimes, it lists under which circumstances it is required.

Name	wdio	karma	Description
--server	+	+	Selenium/Appium server that controls the web-browser. Use bs for BrowserStack and local for local server. If tests are run via BrowserStack, additional logs are available in their dashboard, and --url should point to a publicly accessible URL, such as the stager or Pavlovia. The bs setting requires features only available to the PsychoPy/PsychoJS team
--label	+	+	Which test to execute. See Overview of tests. Can be any string with * and . wildcards. If label contains a slash (/), then it is interpreted as a path to a test in ./tests (e.g. wdio_img is all test with the label wdio_img, /wdio_img is a single test with the path ./tests/wdio_img)
--url	+	x	URL where test-experiments are hosted. The URL can have four values: (1) local is interpreted as http://localhost/psychojs/{{experiment}}, (2) stager is interpreted as https://staging.psychopy.org/experiments/<branch>/{{experiment}}, and (3) pavlovia uses the pavlovia_url in the configuration file of a test-experiment. (4) Any other value is interpreted as a URL. For all cases {{experiment}} is replaced by the path to the current test experiment. The stager setting requires features only available to the PsychoPy/PsychoJS team
--branch	?	?	Branch is part of the build/directory name used to organize test logs on BrowserStack and stager, and branch is part of the default URL where a WebdriverIO test looks for test experiments on the staging server. Required if --uploadResults, --server bs or --url stager. Can be any string, but characters that are not letters, numbers, dots, and underscores, are filtered out. Alternatively, branch can be specified via GITHUB_REF environment variable.
--platform	?	?	Platforms to run tests on. Can be any string with * and . wildcards. Required if --server bs.
--uploadResults	-	-	Upload test logs to PsychoPy's stager. Disabled by default; add this CLI option to enable. The --uploadResults option requires features only available to the PsychoPy/PsychoJS team
--subset	-	-	Only run the tests on a subset of pre-specified platforms. Disabled by default; add this CLI option to enable
--testrun	-	-	Testrun is part of the build/directory name used to organize logs on BrowserStack and stager. By default testrun has the same value as label. Can be any string, but characters that are not letters, numbers, dots, and underscores, are filtered out.

Notes:

• A set of standard WebDriverIO CLI options and Karma CLI options are available for their respective tests.