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

Uploaded Source

Built Distribution

cwltest-2.3.20230527113600-py3-none-any.whl (40.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: cwltest-2.3.20230527113600.tar.gz
  • Upload date:
  • Size: 56.2 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.20230527113600.tar.gz
Algorithm Hash digest
SHA256 6ca261e6a0fdc813ade20cf0b8ca340c9283a1aff1c4523deb78504290ac16ee
MD5 19f54cd4a31f04f3ea4c102ded38011f
BLAKE2b-256 b3b284e3448df3e6d6e7b636136ba8165712867b6c5b4af14ae7e471b28641d1

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for cwltest-2.3.20230527113600-py3-none-any.whl
Algorithm Hash digest
SHA256 a1beda194eee141440a80cd67b9410b8cdd8ceb6cac9497bc521ae91ca2dc28d
MD5 a3e4561885ebe4ab3242de905e677d0e
BLAKE2b-256 98e623b290ce9e5242499395cb777b6d43aa0eedc023b201ca20fbaf5f3c334b

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