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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for cwltest-2.4.20240129145612.tar.gz
Algorithm Hash digest
SHA256 44045f8d4975296108727cf463e31fcbcc59a02f87c4849545a0ef5f0af7abcd
MD5 91a62e6d4e5e3f1bcd5b289f469bcf17
BLAKE2b-256 758085eea61a3a0695640afbb72c060a96ee50ffa2c94dac67b473bf55740f32

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for cwltest-2.4.20240129145612-py3-none-any.whl
Algorithm Hash digest
SHA256 f8361755a802e5ab8c10309fe695c12d3b723ba9d32d505f272aab759727b9a8
MD5 78377d4b4e3841067bbcbd83b598cd57
BLAKE2b-256 d9ffee35283e545bfb696572ab4d1b17e42e80bae2cd01a2a987545cc6291e5a

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