Skip to content

Commit e68fb10

Browse files
authored
Explain use of tags in conformance tests (#67)
1 parent 8df8665 commit e68fb10

File tree

2 files changed

+28
-3
lines changed

2 files changed

+28
-3
lines changed

CONFORMANCE_TESTS.md

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ implementation. It uses the module cwltest from https://github.com/common-workf
55

66
## Usage
77

8-
```
8+
```bash
99
$ ./run_test.sh
1010
--- Running conformance test draft-3 on cwl-runner ---
1111
Test [49/49]
@@ -30,7 +30,7 @@ Extra options to pass to the CWL runner
3030
For example, to run conformance test 15 against the "cwltool"
3131
reference implementation with `--parallel`:
3232

33-
```
33+
```bash
3434
$ ./run_test.sh RUNNER=cwltool -n15 EXTRA=--parallel
3535
Test [15/49]
3636
All tests passed
@@ -43,3 +43,28 @@ system some needed GNU-like tools like `greadlink`.
4343

4444
1. If you haven't already, install [brew](http://brew.sh/) package manager in your mac
4545
2. Run `brew install coreutils`
46+
47+
## Tags for conformance tests
48+
49+
Each test in the [conformance_tests.yaml](conformance_tests.yaml) should be tagged with one or more tags.
50+
51+
1. A `command_line_tool`, `expression_tool` or `workflow` tag to identify whether a CommandLineTool, ExpressionTool
52+
or Workflow is being tested
53+
2. If the test does not test any optional features, the tag `required`
54+
3. The name of any features that are being tested:
55+
1. `docker` for DockerRequirement
56+
1. `env_var` for EnvVarRequirement
57+
1. `format_checking` for checking format requirement annotation on File inputs
58+
1. `initial_work_dir` for InitialWorkDirRequirements
59+
1. `inline_javascript` for InlineJavascriptRequirement
60+
1. `inplace_update` for InplaceUpdateRequirement
61+
1. `input_object_requirements` for tests that use cwl:requirements in the input object
62+
1. `multiple_input` for MultipleInputFeatureRequirement
63+
1. `networkaccess` for NetworkAccess
64+
1. `resource` for ResourceRequirement
65+
1. `scatter` for ScatterFeatureRequirement
66+
1. `schema_def` for SchemaDefRequirement
67+
1. `shell_command` for ShellCommandRequirement
68+
1. `step_input` for StepInputExpressionRequirement
69+
1. `subworkflow` for SubworkflowRequirement
70+
1. `timelimit` for ToolTimeLimit

conformance_tests.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1580,7 +1580,7 @@
15801580
label: nameroot_nameext_generated
15811581
id: 112
15821582
doc: Test that nameroot and nameext are generated from basename at execution time by the runner
1583-
tags: [ step_input_expression, workflow ]
1583+
tags: [ step_input, workflow ]
15841584

15851585
- job: tests/wc-job.json
15861586
output: {}

0 commit comments

Comments
 (0)