Skip to content

Commit

Permalink
more clarifications
Browse files Browse the repository at this point in the history
  • Loading branch information
mr-c committed Oct 5, 2021
1 parent 871961d commit 19cb687
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion CONFORMANCE_TESTS.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,12 +132,16 @@ We will use this single entry to explain the format
args: [cat, hello.txt]
tags: [ required, command_line_tool ]
```
- `doc`: A sentence that explain what is being tested. Will be printed at test execution time. Should be unique.
- `doc`: A unique, single-line sentence that explain what is being tested.
Will be printed at test execution time, so please don't make it too long!
Additional documentation can go as comments in the CWL document itself.
- `label`: a short list of underscore (`_`) separated words that succinctly identifies and explains the test.
- `tool` the path to the CWL document to run
- `job`: the CWL input object in YAML/JSON format. If there are no inputs then use `tests/empty.json`.
- `output` [the CWL output object expected.](#output-matching)
- `tags`: a yaml list of tag names, see [the list of canonical tags below](#tags-for-conformance-tests).
Must include one or more of the following tags: `command_line_tool`, `expression_tool` or `workflow`.
If the test does not test any optional features, the tag `required` is required.

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

0 comments on commit 19cb687

Please sign in to comment.