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.20240425111257.tar.gz (68.3 kB view details)

Uploaded Source

Built Distribution

cwltest-2.5.20240425111257-py3-none-any.whl (42.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: cwltest-2.5.20240425111257.tar.gz
  • Upload date:
  • Size: 68.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.12.0

File hashes

Hashes for cwltest-2.5.20240425111257.tar.gz
Algorithm Hash digest
SHA256 6da11b08de4fed2c6d92c63e7cfb7718ae3b76a3d41609d19ab875f3097974b5
MD5 92152fe11bed2cc5e6e956c795f09faa
BLAKE2b-256 69433cc85b42dbba46904e7abfee9835bdf35ce758f7cb10d47228e2db731536

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for cwltest-2.5.20240425111257-py3-none-any.whl
Algorithm Hash digest
SHA256 bd82531526834903a980ea45c31965e32acd2b70e97ac25ba7d2ca70860a27a0
MD5 67eff1ac39ccbb60510c958369f219ab
BLAKE2b-256 c72297ea0e1c0039c01f52617b2e7c8f9c306ffd8b14c728f4c0b404e6eb9152

See more details on using hashes here.

Provenance

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