Skip to main content

Common Workflow Language testing framework

Project description

Linux Build Status Code coverage

PyPI: PyPI Version PyPI Downloads Month Total PyPI Downloads

Conda: Conda Version Conda Installs

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, and 3.12.

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

cwltest-2.5.20240714110256.tar.gz (70.4 kB view details)

Uploaded Source

Built Distribution

cwltest-2.5.20240714110256-py3-none-any.whl (45.6 kB view details)

Uploaded Python 3

File details

Details for the file cwltest-2.5.20240714110256.tar.gz.

File metadata

  • Download URL: cwltest-2.5.20240714110256.tar.gz
  • Upload date:
  • Size: 70.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.3

File hashes

Hashes for cwltest-2.5.20240714110256.tar.gz
Algorithm Hash digest
SHA256 0ff3e6086ca319d90621ef6f4ce43f98f210628261dd3a322aa50365c24acff1
MD5 30d7592d22123a28ca8dcfed738891eb
BLAKE2b-256 b68fd0550b7a1dd46c5f8b9a596e30f877b4bc27f7cbfd7bd3ff711fa9201fb2

See more details on using hashes here.

File details

Details for the file cwltest-2.5.20240714110256-py3-none-any.whl.

File metadata

File hashes

Hashes for cwltest-2.5.20240714110256-py3-none-any.whl
Algorithm Hash digest
SHA256 2d0ac3d7c22c576bb07a1fd6bd25bb0b9816210fa62e9a9abdc335257d13da0d
MD5 9d033615b8ac55476b08da1d06691adc
BLAKE2b-256 ed33be44fa327e02f6e4a781b1536a9ea170f692fc0611b2880fdade5fc25356

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page