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 && python setup.py 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.4.20231031143732.tar.gz (67.7 kB view details)

Uploaded Source

Built Distribution

cwltest-2.4.20231031143732-py3-none-any.whl (40.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: cwltest-2.4.20231031143732.tar.gz
  • Upload date:
  • Size: 67.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.2

File hashes

Hashes for cwltest-2.4.20231031143732.tar.gz
Algorithm Hash digest
SHA256 cbc51a974fc488d9057dd0d97fbf8c94a339944a4268db4610423d15d3683ed1
MD5 75f3c08bebeb303ed27c080a678bdc3a
BLAKE2b-256 dfabe3d322a699b81876d89e45942420338610cefa93e2818f5adc72152f358b

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for cwltest-2.4.20231031143732-py3-none-any.whl
Algorithm Hash digest
SHA256 15fd227d39b825154275ccc0e0a9598ef46bb7ba05cda15cde40e164f36b797f
MD5 8d95b3195eb41d30ac168b10ce2d5275
BLAKE2b-256 54ebdfe0057335d4fd382394c4757ed618885c269546bf0c44be8c186fb9cc41

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