Skip to content

Commit 4cd15d0

Browse files
author
Kaushik Ghose
authored
Improve formatting
Add examples showing how to run particular tests, pass in extra options etc.
1 parent 7fbf6fd commit 4cd15d0

File tree

1 file changed

+20
-8
lines changed

1 file changed

+20
-8
lines changed

index.md

Lines changed: 20 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -25,43 +25,55 @@ Also available are inheritance graphs (as SVG images) for the [Schema Salad obje
2525

2626
# Running the CWL conformance tests
2727

28-
1. Install a CWL runner of your choice. The reference runner can be installed as
28+
Install a CWL runner of your choice. The reference runner can be installed as
2929
the default runner by doing:
3030
```
3131
pip install cwlref-runner
3232
```
3333

34-
2. Install the CWL test parser:
35-
34+
Install the CWL test parser:
3635
```
3736
pip install cwltest
3837
```
3938
You may need to activate a virtualenv first, or do a local install by adding `--user` after `install` above.
4039

41-
3. From within a copy of [this repository](https://github.com/common-workflow-language/cwl-v1.1) (e.g. cwl-v1.1) execute the main test script
40+
From within a copy of [this repository](https://github.com/common-workflow-language/cwl-v1.1) (e.g. cwl-v1.1) execute the main test script
4241
```
4342
./run_test.sh
4443
```
4544

46-
If the CWL runner isn't installed as `cwl-runner` then you can specify the name:
47-
45+
If the CWL runner isn't installed as `cwl-runner` then you can specify the name for the runner:
4846
```
4947
./run_test.sh RUNNER=cwltool
5048
```
5149

5250
You can also specify additional options that are specific for the particular CWL runner you are using.
5351
For example, with CWL reference runner you can turn on parallel execution mode:
54-
5552
```
5653
./run_test.sh RUNNER=cwltool EXTRA=--parallel
5754
```
5855

5956
This can be combined with launching more than one CWL conformance test at once with `-j`:
60-
6157
```
6258
./run_test.sh -j4 RUNNER=cwltool EXTRA=--parallel
6359
```
6460

61+
You can list all the tests
62+
```
63+
./run_test.sh -l
64+
```
65+
66+
You can run a particular test
67+
```
68+
./run_test.sh -n23
69+
```
70+
71+
72+
If you are running tests for an unreleased CWL version use the `--enable-dev` flag:
73+
```
74+
./run_test.sh EXTRA=--enable-dev
75+
```
76+
6577

6678
For details of options you can pass to the test script, do:
6779
```

0 commit comments

Comments
 (0)