config.rst (2831B)
1 wptrunner Configuration 2 ======================= 3 4 wptrunner can be configured using two mechanisms: 5 6 * Command line arguments 7 8 * A ``wptrunner.ini`` configuration file 9 10 Command Line Arguments 11 ---------------------- 12 13 Command line arguments are the most common way of configuring 14 wptrunner. The current list of command line arguments can be seen by 15 starting wptrunner with the ``--help`` command line argument. 16 17 Command line arguments override options given in the configuration file. 18 19 20 Configuration File 21 ------------------ 22 23 A configuration file can be passed using the ``--config`` command line 24 argument. If no argument is supplied then ``wptrunner.ini`` in the 25 current working directory will be used, if it exists, otherwise 26 ``wptrunner.default.ini`` in the wptrunner directory. Only a single 27 configuration file is used. 28 29 Typicaly frontends to wptrunner are expected to pass in their own 30 configuration file. 31 32 The configuration file contains the following known paths and sections: 33 34 :paths: 35 Data about default paths to use. 36 37 :prefs: 38 Path to profile root directory. Equivalent to the 39 ``--profile-root`` command line argument. 40 41 :run_info: 42 Path to the directory containing extra run info JSON 43 files to add to the run info data. Equivalent to the ``--run-info`` 44 command line argument. 45 46 :ws_extra: 47 Semicolon-separated list of extra paths to use for 48 websockets handlers. Equivalent to the ``--ws-extra`` command line 49 argument. 50 51 :web-platform-tests: 52 Data about the web-platform-tests repository. This is only used by the 53 repository sync code and can be considered deprecated. 54 55 :remote_url: URL of the wpt repository to sync from 56 :branch: Branch name to sync from 57 :sync_path: Directory to use when performing a sync 58 59 In addition the command line allows specifying *multiple* sections 60 each corresponding to a test manifest. These are named 61 ``manifest:[name]``. The ``name`` is arbitary, but must be unique in 62 the file. At least one such section is required so that wptrunner 63 knows where to find some tests. 64 65 :manifest\:[name]: 66 Data about tests in a given subtree. 67 68 :tests: Path to the root of the subtree containing tests. 69 :meta: Path to the corresponding metadata directory. 70 :url_base: URL prefix to for the tests in this manifest. This 71 should be ``/`` for the default manifest but must be 72 different for other manifests. 73 74 For example a vendor with both upstream web-platform-tests under an 75 ``upstream`` subtree, and vendor-specific web-platform-tests under a 76 ``local`` substree, might have a configuration like:: 77 78 [manifest:upstream] 79 tests = upstream/tests 80 metadata = upstream/meta 81 url_base = / 82 83 [manifest:vendor] 84 tests = local/tests 85 metadata = local/meta 86 url_base = /_local/