Common Workflow Language testing framework

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.8, 3.9, 3.10, 3.11, 3.12, and 3.13.

Table of Contents

• Install
• Run on the command line
• Generate conformance badges using cwltest

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)