PyPI: 
Conda: 
This is a testing tool for checking the output of Tools and Workflows described with the Common Workflow Language. Among other uses, it is used to run the CWL conformance tests.
This is written and tested for Python 3.9, 3.10, 3.11, 3.12, and 3.13.
Install
Installing the official package from PyPi
pip install cwltestOr from bioconda
conda install -c bioconda cwltestOr from source
git clone https://github.com/common-workflow-language/cwltest.git
cd cwltest && pip install .Run on the command line
Simple command:
cwltest --test test-descriptions.yml --tool cwl-runner
Generate conformance badges using cwltest
To make badges that show the results of the conformance test, you can generate JSON files for https://badgen.net by using –badgedir option
To generate JSON files:
cwltest --test test-descriptions.yml --tool cwl-runner --badgedir badges
...
$ cat badges/command_line_tool.json | jq .
{
"subject": "command_line_tool",
"status": "100%",
"color": "green"
}
Once you upload JSON file to a server, you make a badge by using a link like https://badgen.net/https/path/to/generated/json or https://flat.badgen.net/https/path/to/generated/json (for flat badges).
Here is an example of markdown to add a badge:
Custom file access module
If your CWL implementation does not write output files to a local file system location but instead to some other remote storage system, you can provide an alternate implementation of the StdFsAccess object that is able to access your storage system.
Step 1:
Implement your own class with the same public interface of the StdFsAccess object in cwltest/stdfsaccess.py (as of this writing, the methods are open, size, isfile and isdir). These methods should expect to be called with URIs from the location field of the outputs of test cases.
Define a function that, when called, returns a new instance of your object.
Step 2:
Create a Python package containing your class (or add it to an existing one).
In the package metadata, add an entry point that declares the module (in this example, my_cwl_runner.fsaccess) containing the function (in this example, get_fsaccess) that cwltest will invoke to get an object implementing the StdFsAccess interface.
In setup.py this looks like:
setup(
...
entry_points={"cwltest.fsaccess": ["fsaccess=my_cwl_runner.fsaccess:get_fsaccess"]}},
...
)In pyproject.toml it looks like:
[project.entry-points.'cwltest.fsaccess']
fsaccess = 'my_cwl_runner.fsaccess:get_fsaccess'Step 3:
Install your package in the same Python environemnt as the installation of cwltest. When invoked, cwltest will query Python package metadata for a package with the cwltest.fsaccess entry point and call it to get back a custom filesystem access object.
Metadata
Release files for cwltest 2.6.20250818005349
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| cwltest-2.6.20250818005349.tar.gz | 73.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| cwltest-2.6.20250818005349-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 122.1 kB
Release files / cwltest-2.6.20250818005349.tar.gz
| Download URL | cwltest-2.6.20250818005349.tar.gz |
|---|---|
| Size | 73.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
33dec12cce5b72b940b8223f7b03445259d691f8a0e6ed762fcb48003508e7f7
|
|
BLAKE2b-256 checksum How to use checksums |
d6b7bd1a2139d50aa85d3a0209b6718270aeb53c7285b9bfc0f00500c3cbc387
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.14.0rc2
|
Release files / cwltest-2.6.20250818005349-py3-none-any.whl
| Download URL | cwltest-2.6.20250818005349-py3-none-any.whl |
|---|---|
| Size | 48.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
63e278ee3794f747c07ca265c5d2ead244307f195ea140c172438f419f690709
|
|
BLAKE2b-256 checksum How to use checksums |
7d22870186d8d8c8567f5b828752f934e154da791924b173262e4e58b1d1e2d5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.1.0 CPython/3.14.0rc2
|
