Skip to content

Commit 122aa58

Browse files
author
Aleksandra Pasek
committed
Update testsuite README.md to mention test.yaml "control" entry
The semantics for test.yaml files were not updated after the migration of the testsuite to e3-testsuite. Update old "skip" entry to "control" entry. TN: T616-039
1 parent 199a9ab commit 122aa58

File tree

1 file changed

+9
-8
lines changed

1 file changed

+9
-8
lines changed

testsuite/README.md

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -148,14 +148,15 @@ Test can also be skipped based on a set of given conditions. For example:
148148
```yaml
149149

150150
description: A test
151-
skip:
152-
- ['XFAIL', 'env.build.os.name == "windows"']
151+
control:
152+
- [XFAIL, 'env.build.os.name == "windows"']
153153
```
154154
155-
The skip entry is a list of tuple of the form (status, condition). If the
156-
condition (a **Python** expression) is True then test is skipped and test
157-
status set to ``status``. Note that currently only the following symbols are
158-
available in the conditions: ``env`` (a BaseEnv object), ``test_env`` (the
159-
test.yaml file as a **Python** dict) and the function ``disk_space`` (return
160-
the available disk space in the working directory).
155+
The control entry is a list of tuple of the form (status, condition, optional message).
156+
If the condition (a **Python** expression) is True then the action described in the
157+
status is performed on the test (e.g. SKIP, XFAIL) and test status set to ``status``.
158+
Note that currently only the following symbols are available in the conditions:
159+
``env`` (a BaseEnv object), ``test_env`` (the test.yaml file as a **Python** dict)
160+
and the function ``disk_space`` (return the available disk space in the working
161+
directory).
161162

0 commit comments

Comments
 (0)