Test configuration file

Home - Test organization - Test configuration file

---

The test configuration file describes a single Karma or WebdriverIO test. It is a file named testconfig.json that should be in the same directory as your testscript (and test-experiment) is at. To get started, see this existing test: tests/wdio_img

The table below shows the properties of a test configuration file. The table has the following columns:

• Name. Name of CLI option
• wdio. Whether for WebdriverIO tests 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
test_framework	+	+	Whether this test is based on the WebdriverIO ("wdio") or Karma ("karma") framework
labels	+	+	An array of labels for identifying this test. These labels can be used to select a set of tests for a testrun via the label CLI option. Each label may only contain letters, numbers, dots, and underscores. For example: ["wdio_img", "wdio", "batch", "all"]
author	+	+	Contact information of the person who created this test. For example: "Thomas Pronk <pronkthomas@gmail.com> (https://thomaspronk.com)"
contributors	o	o	An array with contact information of people that contributed to this test. Each element should have the same format as the author field.
testscript_file	+	+	The script that conducts the tests. For example: "wdio_img.cjs"
experiment_file	+	x	The file the contains the test-experiment. For example: "wdio_img.psyexp"
description	+	+	A brief description of this test. For example: Presents a JPG and PNG image, both straight and rotated by 5 degrees
pavlovia_url	o	x	The URL of the test-experiment on pavlovia.org
fine_calibration	o	x	Whether this test requires fine-grained calibration. false by default.