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

Uploaded Source

Built Distribution

cwltest-2.5.20240304113812-py3-none-any.whl (41.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: cwltest-2.5.20240304113812.tar.gz
  • Upload date:
  • Size: 67.9 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.20240304113812.tar.gz
Algorithm Hash digest
SHA256 f59cb666de2bb9089d89290ab67d30f540aa2245cc5343a3200a5218bce681f8
MD5 6dda19116baf06e0af0b1549601944cd
BLAKE2b-256 4267062614afd2ba0fe259a9d3bb1a5b84844b14a5510cdbb3ba649699156a85

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for cwltest-2.5.20240304113812-py3-none-any.whl
Algorithm Hash digest
SHA256 a0bbc6d4faf7516e140058a8213726b4286214dbf5917d9ba96c722be7cb74b0
MD5 09cd4409c2221c4dfb862f024406b08c
BLAKE2b-256 5a64924feeb703f8da6bd58d07b5dd392de02d5d13e442596b153cfc45560a98

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