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.6, 3.7, 3.8, 3.9, 3.10, and 3.11.

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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for cwltest-2.3.20230825125225.tar.gz
Algorithm Hash digest
SHA256 0728e22b6e6797c7ceced0c9e388e4a3eb578e7b260ebaee50cfd28a0d5491f6
MD5 5c05ff11a420155402f65d5fe2a8ae29
BLAKE2b-256 9fc01447e3a1155ca97e3f9f0a8591217980e2dc17103febcc28597ca77d79fe

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for cwltest-2.3.20230825125225-py3-none-any.whl
Algorithm Hash digest
SHA256 16f74777baddec2c48f173aa605e8014950d247603b7057a2e3f37a73146da36
MD5 f0f386befb06367bba03c5d9832edc5a
BLAKE2b-256 5187226f790567b7504aa654b5dd097f9cc3e77a4074b5fa0b6ed0fdb9581d8d

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