summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorRoman Smrž <roman.smrz@seznam.cz>2026-09-06 22:24:00 +0200
committerRoman Smrž <roman.smrz@seznam.cz>2026-09-08 21:01:58 +0200
commit2f5a9e98948393fad44e1282b418e86492786b83 (patch)
tree2fa6a032c0d883082c20a3492f2c5571bcd95102 /README.md
parent66b914a1eef9a86126cd39954c676a51e92fa182 (diff)
Describe reporting options in README
Diffstat (limited to 'README.md')
-rw-r--r--README.md32
1 files changed, 23 insertions, 9 deletions
diff --git a/README.md b/README.md
index 96ac81a..3adcbce 100644
--- a/README.md
+++ b/README.md
@@ -31,17 +31,15 @@ Usage
-----
The `erebos-tester` tool, when executed without any arguments,
-looks for a `erebos-tester.yaml` file in the current or any parent directory (see below for details).
-Run `erebos-tester --help` for details about command-line parameters.
+looks for an `erebos-tester.yaml` file in the current or any parent directory (see below for details).
+Run `erebos-tester --help` for details about available command-line parameters.
-The tester can be installed from sources or directly via cabal:
-```
-cabal install erebos-tester
-```
+### Examples
-When available in the `PATH`, it can be run to test the [Haskell Erebos implementation](https://erebosprotocol.net/erebos):
+When available in the `PATH`, it can be run, for example, to test
+the [Haskell Erebos implementation](https://erebosprotocol.net/erebos):
```
-git clone git://erebosprotocol.net/erebos
+git clone https://code.erebosprotocol.net/erebos
cd erebos
cabal build
erebos-tester --tool="$(cabal list-bin erebos) test" --verbose
@@ -49,13 +47,15 @@ erebos-tester --tool="$(cabal list-bin erebos) test" --verbose
or the [C++ one](https://erebosprotocol.net/cpp):
```
-git clone git://erebosprotocol.net/cpp
+git clone https://code.erebosprotocol.net/cpp
cd cpp
cmake -B build
cmake --build build
erebos-tester --verbose
```
+### Running
+
To run all tests from project configuration (see below), run the tester without any argument:
```
erebos-tester
@@ -78,6 +78,20 @@ To select single test from a file, use `:` separator:
erebos-tester path/to/script.et:TestName
```
+### Reports
+
+By default, `erebos-tester` stops when a test fails, showing backtrace and
+values of used variables. That can be changed with the following command-line
+options:
+
+* `--report`: run all the tests, continuing even in the case of error, and
+ print a short summary of the number of passed and failed test, and a list of
+ those that failed.
+
+* `--junit-report=<path>`: run all the tests, and write the report to the file
+ in `<path>` using the JUnit XML format.
+
+
Configuration
-------------