Common Workflow Language testing framework
Project description
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.8, 3.9, 3.10, 3.11, 3.12, and 3.13.
Install
Installing the official package from PyPi
pip install cwltest
Or from bioconda
conda install -c bioconda cwltest
Or 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:
![test result](https://flat.badgen.net/https/path/to/generated/json?icon=commonwl)
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for cwltest-2.5.20240906231108.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 1cb5fe21612d72bea94f9c072031d557c1d1ee1a0c127e2201c8da655e9ee73a |
|
MD5 | 5f73ed6556943021c2fe7f101da69d4a |
|
BLAKE2b-256 | a78953959ef866dfa77347ebf2c1befe9bfb327b1fee34aa98cdb1dcf50a808f |
Hashes for cwltest-2.5.20240906231108-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6e20c4f66972cd7e6b054308a112b79490b69ad820764a5ea9574b443d273cd9 |
|
MD5 | fd287002e11549a2e3b67ad81dae5cba |
|
BLAKE2b-256 | 1e31ed08759542383ca58046275fa1696cce7e3c5894c88e31ccfa11231c1842 |