Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (pypi.python.org).
Help us improve Python packaging - Donate today!

Common workflow language reference implementation

Project Description

CWL conformance tests: Travis CI:

This is the reference implementation of the Common Workflow Language. It is intended to feature complete and provide comprehensive validation of CWL files as well as provide other tools related to working with CWL.

This is written and tested for Python 2.7 and 3.x {x = 3, 4, 5, 6}

The reference implementation consists of two packages. The cwltool package is the primary Python module containing the reference implementation in the cwltool module and console executable by the same name.

The cwlref-runner package is optional and provides an additional entry point under the alias cwl-runner, which is the implementation-agnostic name for the default CWL interpreter installed on a host.

Install

It is highly recommended to setup virtual environment before installing cwltool:

virtualenv -p python2 venv   # Create a virtual environment, can use `python3` as well
source venv/bin/activate     # Activate environment before installing `cwltool`

1. Installing the official package from PyPi (will install “cwltool” package as well)

pip install cwlref-runner

If installing alongside another CWL implementation then

pip install cwltool
  1. To install from source
git clone https://github.com/common-workflow-language/cwltool.git # clone cwltool repo
cd cwltool         # Switch to source directory
pip install .      # Install `cwltool` from source
cwltool --version  # Check if the installation works correctly

Remember, if co-installing multiple CWL implementations then you need to maintain which implementation cwl-runner points to via a symbolic file system link or another facility.

Running tests locally

  • Running basic tests (/tests):

We use tox to run various tests in all supported Python environments. You can run the test suite by simply running the following in the terminal: pip install tox; tox

List of all environment can be seen using: tox --listenvs and running a specfic test env using: tox -e <env name>

  • Running the entire suite of CWL conformance tests:

The GitHub repository for the CWL specifications contains a script that tests a CWL implementation against a wide array of valid CWL files using the cwltest program

Instructions for running these tests can be found in the Common Workflow Language Specification repository at https://github.com/common-workflow-language/common-workflow-language/blob/master/CONFORMANCE_TESTS.md

Run on the command line

Simple command:

cwl-runner [tool-or-workflow-description] [input-job-settings]

Or if you have multiple CWL implementations installed and you want to override the default cwl-runner use:

cwltool [tool-or-workflow-description] [input-job-settings]

Use with boot2docker

boot2docker is running docker inside a virtual machine and it only mounts Users on it. The default behavior of CWL is to create temporary directories under e.g. /Var which is not accessible to Docker containers.

To run CWL successfully with boot2docker you need to set the --tmpdir-prefix and --tmp-outdir-prefix to somewhere under /Users:

$ cwl-runner --tmp-outdir-prefix=/Users/username/project --tmpdir-prefix=/Users/username/project wc-tool.cwl wc-job.json

Tool or workflow loading from remote or local locations

cwltool can run tool and workflow descriptions on both local and remote systems via its support for HTTP[S] URLs.

Input job files and Workflow steps (via the run directive) can reference CWL documents using absolute or relative local filesytem paths. If a relative path is referenced and that document isn’t found in the current directory then the following locations will be searched: http://www.commonwl.org/v1.0/CommandLineTool.html#Discovering_CWL_documents_on_a_local_filesystem

Use with GA4GH Tool Registry API

Cwltool can launch tools directly from GA4GH Tool Registry API endpoints.

By default, cwltool searches https://dockstore.org/ . Use –add-tool-registry to add other registries to the search path.

For example

cwltool --non-strict quay.io/collaboratory/dockstore-tool-bamstats:master test.json

and (defaults to latest when a version is not specified)

cwltool --non-strict quay.io/collaboratory/dockstore-tool-bamstats test.json

For this example, grab the test.json (and input file) from https://github.com/CancerCollaboratory/dockstore-tool-bamstats

Import as a module

Add

import cwltool

to your script.

The easiest way to use cwltool to run a tool or workflow from Python is to use a Factory

import cwltool.factory
fac = cwltool.factory.Factory()

echo = f.make("echo.cwl")
result = echo(inp="foo")

# result["out"] == "foo"

Leveraging SoftwareRequirements (Beta)

CWL tools may be decorated with SoftwareRequirement hints that cwltool may in turn use to resolve to packages in various package managers or dependency management systems such as Environment Modules.

Utilizing SoftwareRequirement hints using cwltool requires an optional dependency, for this reason be sure to use specify the deps modifier when installing cwltool. For instance:

$ pip install 'cwltool[deps]'

Installing cwltool in this fashion enables several new command line options. The most general of these options is --beta-dependency-resolvers-configuration. This option allows one to specify a dependency resolvers configuration file. This file may be specified as either XML or YAML and very simply describes various plugins to enable to “resolve” SoftwareRequirement dependencies.

To discuss some of these plugins and how to configure them, first consider the following hint definition for an example CWL tool.

SoftwareRequirement:
  packages:
  - package: seqtk
    version:
    - r93

Now imagine deploying cwltool on a cluster with Software Modules installed and that a seqtk module is available at version r93. This means cluster users likely won’t have the binary seqtk on their PATH by default, but after sourcing this module with the command modulecmd sh load seqtk/r93 seqtk is available on the PATH. A simple dependency resolvers configuration file, called dependency-resolvers-conf.yml for instance, that would enable cwltool to source the correct module environment before executing the above tool would simply be:

- type: module

The outer list indicates that one plugin is being enabled, the plugin parameters are defined as a dictionary for this one list item. There is only one required parameter for the plugin above, this is type and defines the plugin type. This parameter is required for all plugins. The available plugins and the parameters available for each are documented (incompletely) here. Unfortunately, this documentation is in the context of Galaxy tool requirement s instead of CWL SoftwareRequirement s, but the concepts map fairly directly.

cwltool is distributed with an example of such seqtk tool and sample corresponding job. It could executed from the cwltool root using a dependency resolvers configuration file such as the above one using the command:

cwltool --beta-dependency-resolvers-configuration /path/to/dependency-resolvers-conf.yml \
    tests/seqtk_seq.cwl \
    tests/seqtk_seq_job.json

This example demonstrates both that cwltool can leverage existing software installations and also handle workflows with dependencies on different versions of the same software and libraries. However the above example does require an existing module setup so it is impossible to test this example “out of the box” with cwltool. For a more isolated test that demonstrates all the same concepts - the resolver plugin type galaxy_packages can be used.

“Galaxy packages” are a lighter weight alternative to Environment Modules that are really just defined by a way to lay out directories into packages and versions to find little scripts that are sourced to modify the environment. They have been used for years in Galaxy community to adapt Galaxy tools to cluster environments but require neither knowledge of Galaxy nor any special tools to setup. These should work just fine for CWL tools.

The cwltool source code repository’s test directory is setup with a very simple directory that defines a set of “Galaxy packages” (but really just defines one package named random-lines). The directory layout is simply:

tests/test_deps_env/
  random-lines/
    1.0/
      env.sh

If the galaxy_packages plugin is enabled and pointed at the tests/test_deps_env directory in cwltool’s root and a SoftwareRequirement such as the following is encountered.

hints:
  SoftwareRequirement:
    packages:
    - package: 'random-lines'
      version:
      - '1.0'

Then cwltool will simply find that env.sh file and source it before executing the corresponding tool. That env.sh script is only responsible for modifying the job’s PATH to add the required binaries.

This is a full example that works since resolving “Galaxy packages” has no external requirements. Try it out by executing the following command from cwltool’s root directory:

cwltool --beta-dependency-resolvers-configuration tests/test_deps_env_resolvers_conf.yml \
    tests/random_lines.cwl \
    tests/random_lines_job.json

The resolvers configuration file in the above example was simply:

- type: galaxy_packages
  base_path: ./tests/test_deps_env

It is possible that the SoftwareRequirement s in a given CWL tool will not match the module names for a given cluster. Such requirements can be re-mapped to specific deployed packages and/or versions using another file specified using the resolver plugin parameter mapping_files. We will demonstrate this using galaxy_packages but the concepts apply equally well to Environment Modules or Conda packages (described below) for instance.

So consider the resolvers configuration file (tests/test_deps_env_resolvers_conf_rewrite.yml):

- type: galaxy_packages
  base_path: ./tests/test_deps_env
  mapping_files: ./tests/test_deps_mapping.yml

And the corresponding mapping configuraiton file (tests/test_deps_mapping.yml):

- from:
    name: randomLines
    version: 1.0.0-rc1
  to:
    name: random-lines
    version: '1.0'

This is saying if cwltool encounters a requirement of randomLines at version 1.0.0-rc1 in a tool, to rewrite to our specific plugin as random-lines at version 1.0. cwltool has such a test tool called random_lines_mapping.cwl that contains such a source SoftwareRequirement. To try out this example with mapping, execute the following command from the cwltool root directory:

cwltool --beta-dependency-resolvers-configuration tests/test_deps_env_resolvers_conf_rewrite.yml \
    tests/random_lines_mapping.cwl \
    tests/random_lines_job.json

The previous examples demonstrated leveraging existing infrastructure to provide requirements for CWL tools. If instead a real package manager is used cwltool has the oppertunity to install requirements as needed. While initial support for Homebrew/Linuxbrew plugins is available, the most developed such plugin is for the Conda package manager. Conda has the nice properties of allowing multiple versions of a package to be installed simultaneously, not requiring evalated permissions to install Conda itself or packages using Conda, and being cross platform. For these reasons, cwltool may run as a normal user, install its own Conda environment and manage multiple versions of Conda packages on both Linux and Mac OS X.

The Conda plugin can be endlessly configured, but a sensible set of defaults that has proven a powerful stack for dependency management within the Galaxy tool development ecosystem can be enabled by simply passing cwltool the --beta-conda-dependencies flag.

With this we can use the seqtk example above without Docker and without any externally managed services - cwltool should install everything it needs and create an environment for the tool. Try it out with the follwing command:

cwltool --beta-conda-dependencies tests/seqtk_seq.cwl tests/seqtk_seq_job.json

The CWL specification allows URIs to be attached to SoftwareRequirement s that allow disambiguation of package names. If the mapping files described above allow deployers to adapt tools to their infrastructure, this mechanism allows tools to adapt their requirements to multiple package managers. To demonstrate this within the context of the seqtk, we can simply break the package name we use and then specify a specific Conda package as follows:

hints:
  SoftwareRequirement:
    packages:
    - package: seqtk_seq
      version:
      - '1.2'
      specs:
      - https://anaconda.org/bioconda/seqtk
      - https://packages.debian.org/sid/seqtk

The example can be executed using the command:

cwltool --beta-conda-dependencies tests/seqtk_seq_wrong_name.cwl tests/seqtk_seq_job.json

The plugin framework for managing resolution of these software requirements as maintained as part of galaxy-lib - a small, portable subset of the Galaxy project. More information on configuration and implementation can be found at the following links:

CWL Tool Control Flow

Technical outline of how cwltool works internally, for maintainers.

  1. Use CWL load_tool() to load document.
    1. Fetches the document from file or URL
    2. Applies preprocessing (syntax/identifier expansion and normalization)
    3. Validates the document based on cwlVersion
    4. If necessary, updates the document to latest spec
    5. Constructs a Process object using make_tool()` callback. This yields a CommandLineTool, Workflow, or ExpressionTool. For workflows, this recursively constructs each workflow step.
    6. To construct custom types for CommandLineTool, Workflow, or ExpressionTool, provide a custom make_tool()
  2. Iterate on the job() method of the Process object to get back runnable jobs.
    1. job() is a generator method (uses the Python iterator protocol)
    2. Each time the job() method is invoked in an iteration, it returns one of: a runnable item (an object with a run() method), None (indicating there is currently no work ready to run) or end of iteration (indicating the process is complete.)
    3. Invoke the runnable item by calling run(). This runs the tool and gets output.
    4. Output of a process is reported by an output callback.
    5. job() may be iterated over multiple times. It will yield all the work that is currently ready to run and then yield None.
  3. Workflow objects create a corresponding WorkflowJob and WorkflowJobStep objects to hold the workflow state for the duration of the job invocation.
    1. The WorkflowJob iterates over each WorkflowJobStep and determines if the inputs the step are ready.
    2. When a step is ready, it constructs an input object for that step and iterates on the job() method of the workflow job step.
    3. Each runnable item is yielded back up to top level run loop
    4. When a step job completes and receives an output callback, the job outputs are assigned to the output of the workflow step.
    5. When all steps are complete, the intermediate files are moved to a final workflow output, intermediate directories are deleted, and the output callback for the workflow is called.
  4. CommandLineTool job() objects yield a single runnable object.
    1. The CommandLineTool job() method calls makeJobRunner() to create a CommandLineJob object
    2. The job method configures the CommandLineJob object by setting public attributes
    3. The job method iterates over file and directories inputs to the CommandLineTool and creates a “path map”.
    4. Files are mapped from their “resolved” location to a “target” path where they will appear at tool invocation (for example, a location inside a Docker container.) The target paths are used on the command line.
    5. Files are staged to targets paths using either Docker volume binds (when using containers) or symlinks (if not). This staging step enables files to be logically rearranged or renamed independent of their source layout.
    6. The run() method of CommandLineJob executes the command line tool or Docker container, waits for it to complete, collects output, and makes the output callback.

Extension points

The following functions can be provided to main(), to load_tool(), or to the executor to override or augment the listed behaviors.

executor
executor(tool, job_order_object, **kwargs)
  (Process, Dict[Text, Any], **Any) -> Tuple[Dict[Text, Any], Text]

A toplevel workflow execution loop, should synchronously execute a process object and return an output object.

makeTool
makeTool(toolpath_object, **kwargs)
  (Dict[Text, Any], **Any) -> Process

Construct a Process object from a document.

selectResources
selectResources(request)
  (Dict[Text, int]) -> Dict[Text, int]

Take a resource request and turn it into a concrete resource assignment.

versionfunc
()
  () -> Text

Return version string.

make_fs_access
make_fs_access(basedir)
  (Text) -> StdFsAccess

Return a file system access object.

fetcher_constructor
fetcher_constructor(cache, session)
  (Dict[unicode, unicode], requests.sessions.Session) -> Fetcher

Construct a Fetcher object with the supplied cache and HTTP session.

resolver
resolver(document_loader, document)
  (Loader, Union[Text, dict[Text, Any]]) -> Text

Resolve a relative document identifier to an absolute one which can be fetched.

logger_handler
logger_handler
  logging.Handler

Handler object for logging.

Running user-space implementations of Docker

Some compute environments disallow user-space installation of Docker due to incompatiblities in libraries or to meet security requirements. The CWL reference supports using a user space implementation with the –user-space-docker-cmd option.

Example using dx-docker (https://wiki.dnanexus.com/Developer-Tutorials/Using-Docker-Images):

For use on Linux, install the DNAnexus toolkit (see https://wiki.dnanexus.com/Downloads for instructions).

Run cwltool just as you normally would, but with the new option, e.g. from the conformance tests:

` cwltool --user-space-docker-cmd=dx-docker --outdir=/tmp/tmpidytmp v1.0/test-cwl-out2.cwl v1.0/empty.json `

Release History

Release History

This version
History Node

1.0.20171107133715

History Node

1.0.20171017195544

History Node

1.0.20170928192020

History Node

1.0.20170927182241

History Node

1.0.20170828135420

History Node

1.0.20170822192924

History Node

1.0.20170817131858

History Node

1.0.20170815202200

History Node

1.0.20170811195303

History Node

1.0.20170810192106

History Node

1.0.20170803160545

History Node

1.0.20170727112954

History Node

1.0.20170723124118

History Node

1.0.20170721221557

History Node

1.0.20170721160741

History Node

1.0.20170721130823

History Node

1.0.20170718140316

History Node

1.0.20170717200612

History Node

1.0.20170717120410

History Node

1.0.20170713151519

History Node

1.0.20170713144155

History Node

1.0.20170707200431

History Node

1.0.20170704143016

History Node

1.0.20170629171139

History Node

1.0.20170622090721

History Node

1.0.20170525215327

History Node

1.0.20170516234254

History Node

1.0.20170510165748

History Node

1.0.20170510151339

History Node

1.0.20170413194156

History Node

1.0.20170413151007

History Node

1.0.20170329142446

History Node

1.0.20170327143622

History Node

1.0.20170309164828

History Node

1.0.20170308174714

History Node

1.0.20170224141733

History Node

1.0.20170217172322

History Node

1.0.20170213175853

History Node

1.0.20170119234115

History Node

1.0.20170119182607

History Node

1.0.20170118141124

History Node

1.0.20170114120503

History Node

1.0.20170112185927

History Node

1.0.20170112154257

History Node

1.0.20170111193653

History Node

1.0.20170105144051

History Node

1.0.20161227200419

History Node

1.0.20161223144155

History Node

1.0.20161221171240

History Node

1.0.20161216212910

History Node

1.0.20161207161158

History Node

1.0.20161206204434

History Node

1.0.20161206195941

History Node

1.0.20161202203310

History Node

1.0.20161128202906

History Node

1.0.20161123190203

History Node

1.0.20161122201220

History Node

1.0.20161115095848

History Node

1.0.20161114152756

History Node

1.0.20161107145355

History Node

1.0.20161007181528

History Node

1.0.20161005195021

History Node

1.0.20160930152149

History Node

1.0.20160923180109

History Node

1.0.20160922135240

History Node

1.0.20160919152321

History Node

1.0.20160918012352

History Node

1.0.20160915202519

History Node

1.0.20160913171024

History Node

1.0.20160912182208

History Node

1.0.20160907141844

History Node

1.0.20160901133827

History Node

1.0.20160829211335

History Node

1.0.20160829192223

History Node

1.0.20160811184335

History Node

1.0.20160810200423

History Node

1.0.20160810161358

History Node

1.0.20160805221855

History Node

1.0.20160726135535

History Node

1.0.20160714182449

History Node

1.0.20160712154127

History Node

1.0.20160708190014

History Node

1.0.20160707195347

History Node

1.0.20160706132520

History Node

1.0.20160630171631

History Node

1.0.20160629140624

History Node

1.0.20160628194545

History Node

1.0.20160627152300

History Node

1.0.20160626203316

History Node

1.0.20160623183600

History Node

1.0.20160616182520

History Node

1.0.20160614212644

History Node

1.0.20160610111115

History Node

1.0.20160609160402

History Node

1.0.20160608124624

History Node

1.0.20160531173804

History Node

1.0.20160523144113

History Node

1.0.20160519182434

History Node

1.0.20160518201549

History Node

1.0.20160518200809

History Node

1.0.20160515155531

History Node

1.0.20160511213450

History Node

1.0.20160511162129

History Node

1.0.20160511142738

History Node

1.0.20160510161706

History Node

1.0.20160507101510

History Node

1.0.20160505211047

History Node

1.0.20160504183010

History Node

1.0.20160427142240

History Node

1.0.20160426185417

History Node

1.0.20160425140546

History Node

1.0.20160422204730

History Node

1.0.20160422203349

History Node

1.0.20160421171618

History Node

1.0.20160421140153

History Node

1.0.20160415153333

History Node

1.0.20160413143011

History Node

1.0.20160412203002

History Node

1.0.20160411194133

History Node

1.0.20160411021840

History Node

1.0.20160408133555

History Node

1.0.20160331184641

History Node

1.0.20160325210917

History Node

1.0.20160325200114

History Node

1.0.20160323212343

History Node

1.0.20160322201127

History Node

1.0.20160316204054

History Node

1.0.20160316150250

History Node

1.0.20160315233236

History Node

1.0.20160311201238

History Node

1.0.20160311170456

History Node

1.0.20160310215251

History Node

1.0.20160310140736

History Node

1.0.20160309204538

History Node

1.0.20160308152645

History Node

1.0.20160307200623

History Node

1.0.20160304012934

History Node

1.0.20160302134341

History Node

1.0.20160226205952

History Node

1.0.20160225202307

History Node

1.0.20160225040942

History Node

1.0.20160225033850

History Node

1.0.20160222205901

History Node

1.0.20160209222805

History Node

1.0.20160203221531

History Node

1.0.20160203144931

History Node

1.0.20160129183049

History Node

1.0.20160129161544

History Node

1.0.20160129152024

History Node

1.0.20160128142049

History Node

1.0.20160127144612

History Node

1.0.20160126211726

History Node

1.0.20160126152227

History Node

1.0.20160115132942

History Node

1.0.20160108200940

History Node

1.0.20160108161501

History Node

1.0.20151211155311

History Node

1.0.20151211141743

History Node

1.0.20151210154014

History Node

1.0.20151209160516

History Node

1.0.20151130204648

History Node

1.0.20151130190253

History Node

1.0.20151125221324

History Node

1.0.20151125211848

History Node

1.0.20151125172224

History Node

1.0.20151124220039

History Node

1.0.20151124040259

History Node

1.0.20151122025918

History Node

1.0.20151121032923

History Node

1.0.20151121025646

History Node

1.0.20151120220905

History Node

1.0.20151112194920

History Node

1.0.20151110030107

History Node

1.0.20151104062100

History Node

1.0.20151026181844

History Node

1.0.20151022085449

History Node

1.0.20151013173827

History Node

1.0.20151013135545

History Node

1.0.20151013134821

History Node

1.0.20151012173709

History Node

1.0.20151012161407

History Node

1.0.20151009020717

History Node

1.0.20151007133346

History Node

1.0.20150929170517

History Node

1.0.20150925123259

History Node

1.0.20150923183439

History Node

1.0.20150918080732

History Node

1.0.20150916124227

History Node

1.0.20150916041152

History Node

1.0.20150915034626

History Node

1.0.20150910021332

History Node

1.0.20150814191928

History Node

1.0.20150814015745

History Node

1.0.20150813132038

History Node

1.0.20150808190318

History Node

1.0.20150728161219

History Node

1.0.20150723141036

History Node

1.0.20150722144138

History Node

1.0.20150720194125

History Node

1.0.20150715173345

History Node

1.0.20150714132635

History Node

1.0.20150713185212

History Node

1.0.20150713152138

History Node

1.0.20150713135958

History Node

1.0.20150711153503

History Node

1.0.20150709135652

History Node

1.0.20150708115452

History Node

1.0.20150707043955

History Node

1.0.20150706174116

History Node

1.0.20150627015636

History Node

1.0.20150626035417

History Node

1.0.20150626035015

History Node

1.0.20150626032845

History Node

1.0.20150624201710

History Node

1.0.20150624181807

History Node

1.0.20150623031442

History Node

1.0.20150623020304

History Node

1.0.20150622183905

History Node

1.0.20150622144406

History Node

1.0.20150622134207

History Node

1.0.20150621230545

History Node

1.0.20150621213723

History Node

1.0.20150610150530

History Node

1.0.20150609205603

History Node

1.0.20150609024148

History Node

1.0.20150606210100

History Node

1.0.20150605134212

History Node

1.0.20150602212140

History Node

1.0.20150601200103

History Node

1.0.20150601172915

History Node

1.0.20150527172438

History Node

1.0.20150525010411

History Node

1.0.20150522025529

History Node

1.0.20150512164512

History Node

1.0.20150512154247

History Node

1.0.20150508023316

History Node

1.0.20150429022405

History Node

1.0.20150415152714

History Node

1.0.20150409193818

History Node

1.0.20150407211342

History Node

1.0.20150403144650

History Node

1.0.20150401014645

History Node

1.0.20150331014533

History Node

1.0.20150327211418

History Node

1.0.20150326211508

History Node

1.0.20150326005309

History Node

1.0.20150324211351

History Node

1.0.20150324203244

History Node

1.0.20150324200038

History Node

1.0.20150324194338

History Node

1.0.20150324173916

History Node

1.0.20150324172633

History Node

1.0.20150324012706

History Node

1.0.20150324011020

History Node

1.0.20150318015654

History Node

1.0.20150318010828

History Node

1.0.20150317015350

Download Files

Download Files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

File Name & Checksum SHA256 Checksum Help Version File Type Upload Date
cwltool-1.0.20171107133715-py2.py3-none-any.whl (340.2 kB) Copy SHA256 Checksum SHA256 py2.py3 Wheel Nov 8, 2017
cwltool-1.0.20171107133715.tar.gz (267.9 kB) Copy SHA256 Checksum SHA256 Source Nov 8, 2017

Supported By

WebFaction WebFaction Technical Writing Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Rackspace Rackspace Cloud Servers DreamHost DreamHost Log Hosting