Skip to content

Commit 4bd3310

Browse files
committed
more clarifications
1 parent c365b70 commit 4bd3310

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

CONFORMANCE_TESTS.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,12 +132,16 @@ We will use this single entry to explain the format
132132
args: [cat, hello.txt]
133133
tags: [ required, command_line_tool ]
134134
```
135-
- `doc`: A sentence that explain what is being tested. Will be printed at test execution time. Should be unique.
135+
- `doc`: A unique, single-line sentence that explain what is being tested.
136+
Will be printed at test execution time, so please don't make it too long!
137+
Additional documentation can go as comments in the CWL document itself.
136138
- `label`: a short list of underscore (`_`) separated words that succinctly identifies and explains the test.
137139
- `tool` the path to the CWL document to run
138140
- `job`: the CWL input object in YAML/JSON format. If there are no inputs then use `tests/empty.json`.
139141
- `output` [the CWL output object expected.](#output-matching)
140142
- `tags`: a yaml list of tag names, see [the list of canonical tags below](#tags-for-conformance-tests).
143+
Must include one or more of the following tags: `command_line_tool`, `expression_tool` or `workflow`.
144+
If the test does not test any optional features, the tag `required` is required.
141145

142146
Because `conformance_tests.yaml` is a `schema-salad` processed document, [`$import`](https://www.commonwl.org/v1.2/SchemaSalad.html#Import)
143147
can be used to organize the tests into separate files.

0 commit comments

Comments
 (0)