summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorRoman Smrž <roman.smrz@seznam.cz>2026-10-17 11:10:40 +0200
committerRoman Smrž <roman.smrz@seznam.cz>2026-10-20 20:21:44 +0200
commit5f892bc3cd212f362b0a8f29528b783b142da8e8 (patch)
treea345cab6908eb72632684be751caf0ea1c793f1c /README.md
parentdb6cd2706417d38b670438475c30a657ce2e5ed4 (diff)
Config option to find tool path using cabal
Changelog: Added config file option to find test tool executable via cabal.
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 7 insertions, 3 deletions
diff --git a/README.md b/README.md
index 3adcbce..e5013dc 100644
--- a/README.md
+++ b/README.md
@@ -19,8 +19,8 @@ The test framework uses two components from the tested project:
The test tool can be set either:
* by the `--tool` command-line parameter of `erebos-tester`, or
- * in the `erebos-tester.yaml` configuration file, or
- * by the `EREBOS_TEST_TOOL` environment variable.
+ * by the `EREBOS_TEST_TOOL` environment variable, or
+ * in the `erebos-tester.yaml` configuration file.
2. Test script – defines how to run the instances of test tool and in what kind
of network topology. Contains commands to send to the test tool instances
@@ -100,7 +100,11 @@ per-project configuration can be done using `erebos-tester.yaml` file placed in
(or other directory from which the tests will be executed).
This is a YAML file with following fields:
-* `tool`: path to the test tool, which may be overridden by the `--tool` command-line option.
+* `tool`: test tool (may be overridden by the `--tool` command-line option or `EREBOS_TEST_TOOL` environment variable), and can be either:
+ * `string` giving path to the executable, or
+ * mapping with one of the following keys:
+ * `path`: `string` giving path to executable
+ * `cabal`: `string` giving cabal executable name
* `tests`: glob pattern that expands to all the test script files that should be used.
* `select`: tests or tags to be selected for running by default (if not provided, all tests will be executed);
given as a single `string` or a list of `string`s.