Metadata-Version: 2.1
Name: cwltest
Version: 2.1.20210423130452
Summary: Common workflow language testing framework
Home-page: https://github.com/common-workflow-language/cwltest
Author: Common workflow language working group
Author-email: common-workflow-language@googlegroups.com
License: Apache 2.0
Download-URL: https://github.com/common-workflow-language/cwltest
Platform: UNKNOWN
Requires-Python: >=3.5, <4
Description-Content-Type: text/x-rst
Requires-Dist: schema-salad (<8,>=5.0.20200220195218)
Requires-Dist: junit-xml (>=1.8)

|Linux Build Status| |Windows Build status| |Code coverage|

.. |Linux Build Status| image:: https://img.shields.io/travis/common-workflow-language/cwltest/master.svg?label=unix%20build
   :target: https://travis-ci.org/common-workflow-language/cwltest
.. |Windows Build status| image:: https://img.shields.io/appveyor/ci/mr-c/cwltest/master.svg?label=windows%20build
   :target: https://ci.appveyor.com/project/mr-c/cwltest/branch/master
.. |Code coverage| image:: https://codecov.io/gh/common-workflow-language/cwltest/branch/master/graph/badge.svg
   :target: https://codecov.io/gh/common-workflow-language/cwltest

==========================================
Common workflow language testing framework
==========================================

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 2.7, 3.4, 3.5, 3.6, and 3.7

Install
-------

Installing the official package from PyPi::

  pip install 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)


