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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: cwltest-2.4.20231222081524.tar.gz
  • Upload date:
  • Size: 68.0 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.20231222081524.tar.gz
Algorithm Hash digest
SHA256 a0c763a5746c58d136afea3e2cc59c0687ad157c94568ca135b07eddae62ccbc
MD5 c33ab0eb2f548026d2ab92993751cc36
BLAKE2b-256 a9564928863cfe1218aacb46fb142dc43e50fcc74aefb7b985a6b6fa9b81f5f0

See more details on using hashes here.

Provenance

File details

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

File metadata

File hashes

Hashes for cwltest-2.4.20231222081524-py3-none-any.whl
Algorithm Hash digest
SHA256 e253f511a0ec48ae35c13568fbf02f5c75bf466c4fd59c74255a5d3a1a3e08d4
MD5 45747c9af619ba69df80abf411082ad2
BLAKE2b-256 bc8b5a5c1a936b45c24cb15a457db02d7a4e1ea94afb74a7f196613a0bf24cf0

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