Our VM/Docker sharing infrastructure and management component
Java Common Workflow Language wdl Shell HTML Scala Other
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.github Feature/dockstore classpath (#342) Jul 21, 2016
THIRD-PARTY-NOTICES Standardize model boilerplate (#1356) Apr 23, 2018
dockstore-client [maven-release-plugin] prepare for next development iteration Aug 17, 2018
dockstore-common [maven-release-plugin] prepare for next development iteration Aug 17, 2018
dockstore-event-consumer [maven-release-plugin] prepare for next development iteration Aug 17, 2018
dockstore-file-plugin-parent [maven-release-plugin] prepare for next development iteration Aug 17, 2018
dockstore-integration-testing [maven-release-plugin] prepare for next development iteration Aug 17, 2018
dockstore-webservice [maven-release-plugin] prepare for next development iteration Aug 17, 2018
reports [maven-release-plugin] prepare for next development iteration Aug 17, 2018
scripts Feature/more tests (#1720) Aug 17, 2018
swagger-java-bitbucket-client [maven-release-plugin] prepare for next development iteration Aug 17, 2018
swagger-java-client [maven-release-plugin] prepare for next development iteration Aug 17, 2018
swagger-java-quay-client [maven-release-plugin] prepare for next development iteration Aug 17, 2018
swagger-java-sam-client [maven-release-plugin] prepare for next development iteration Aug 17, 2018
.codecov.yml Stop failing builds for minor decreases in coverage (#1522) Jun 20, 2018
.gitignore Feature/more tests (#1720) Aug 17, 2018
.travis.yml Feature/more tests (#1720) Aug 17, 2018
CHANGELOG.md Feature/docs (#340) Jul 20, 2016
CITATION Create CITATION Dec 16, 2016
Dockerfile Fix up docker files Dec 15, 2015
Dockstore.cwl Stub dockstore.cwl Dec 15, 2015
LICENSE Update LICENSE Apr 20, 2018
README.md Feature/1146/openapi generate (#1225) Mar 16, 2018
checkstyle-suppressions.xml Feature/non confidential unit tests (#1190) Feb 26, 2018
checkstyle.xml Feature/api update (#1640) Jul 25, 2018
codestyle.xml Update copyright notices for production release (#937) Oct 10, 2017
docker-dockstore-entrypoint.sh Fix up docker files Dec 15, 2015
dockstore.yml Feature/api update (#1640) Jul 25, 2018
encrypt.sh Feature/more tests (#1720) Aug 17, 2018
expand_confidential_bundle.sh Feature/more tests (#1720) Aug 17, 2018
findbugs-exclude.xml Update copyright notices for production release (#937) Oct 10, 2017
legacy.md Update legacy.md Nov 17, 2017
pom.xml [maven-release-plugin] prepare for next development iteration Aug 17, 2018
propose_migration.sh Feature/864/file format search (#1383) May 11, 2018
secrets.tar.enc Feature/more tests (#1720) Aug 17, 2018

README.md

Build Status Coverage Status Website Gitter
DOI Uptime Robot status license

Dockstore

Dockstore provides a place for users to share tools encapsulated in Docker and described with the Common Workflow Language (CWL) or WDL (Workflow Description Language). This enables scientists to share analytical workflows so that they are machine readable as well as runnable in a variety of environments. While the Dockstore is focused on serving researchers in the biosciences, the combination of Docker + CWL/WDL can be used by anyone to describe the tools and services in their Docker images in a standardized, machine-readable way.
We hope to use this project as motivation to create a GA4GH API standard for container registries.

For the live site see dockstore.org

This repo contains the web service and CLI components for Dockstore as well as collecting documentation and the issues for the project as a whole. The usage of this is to enumerate the docker containers (from quay.io and hopefully docker hub) and the workflows (from github/bitbucket) that are available to users of Dockstore.org.

For the related web UI see the dockstore-ui project.

For Dockstore Users

The following section is useful for users of Dockstore (e.g. those that want to browse, register, and launch tools).

After registering at dockstore.org, you will be able to download the Dockstore CLI at https://dockstore.org/onboarding

The CLI has the following dependencies

  • Java 8 (Update 101 or newer)
  • cwltool (to run CWL workflows locally)

To install CWL tool:

pip install --user cwl-runner cwltool==1.0.20170828135420 schema-salad==2.6.20170806163416 avro==1.8.1 ruamel.yaml==0.14.12 requests==2.18.4

You may need other pip installable tools like typing or setuptools. This depends on your python environment.

Configuration File

A basic Dockstore configuration file is available/should be created in ~/.dockstore/config and contains the following at minimum:

token = <your generated by the dockstore site>
server-url = https://www.dockstore.org:8443

Migration to Dockstore 1.3

  1. Ensure that your Java 8 version is newer than update 101.

Migration to Dockstore 1.2

This keeps track of breaking changes when migrating from Dockstore 1.1 to beta releases of 1.2 on the client side.

  1. Paths for input files are standardized to paths like s3://test.bucket/test, icgc://1234-efg, https://file.org/test.txt. This means paths like icgc:1234-efg will no longer work
  2. A new version of cwltool
  3. The syntax for launching tools has been simplified. --local-entry is no longer a flag, but is an alternative to --entry.

Migration to Dockstore 1.2.5

Unfortunately, new unique indexes enforcing better data consistency require a clean-up of unpublished workflows. Published content should remain unaffected.

delete from workflow_workflowversion ww where ww.workflowid in (select id from workflow where ispublished='f');
delete from workflow where ispublished='f';

File Provisioning

By default, cwltool reads input files from the local filesystem. Dockstore also adds support for additional file systems such as http, https, and ftp. Through a plug-in system, Dockstore also supports the Amazon S3, Synapse, and ICGC Storage Client via plugins.

Download the above set of default plugins via:

dockstore plugin download

Configuration for plugins can be placed inside the Dockstore configuration file in the following format

token = <your generated by the dockstore site>
server-url = https://www.dockstore.org:8443

# options below this are optional

use-cache = false                           #set this to true to cache input files for rapid development
cache-dir = /home/<user>/.dockstore/cache   #set this to determine where input files are cached (should be the same filesystem as your tool working directories)

[dockstore-file-synapse-plugin]

[dockstore-file-s3-plugin]
endpoint = #set this to point at a non AWS S3 endpoint

[dockstore-file-icgc-storage-client-plugin]
client = /media/large_volume/icgc-storage-client-1.0.23/bin/icgc-storage-client

Additional plugins can be created by taking one of the repos in plugins as a model and using pf4j as a reference. See additional documentation for more details.

For Dockstore Developers

The following section is useful for Dockstore developers (e.g. those that want to improve or fix the Dockstore web service and UI)

Dependencies

The dependency environment for Dockstore is described by our Travis-CI config. In addition to the dependencies for Dockstore users, note the setup instructions for postgres. Specifically, you will need to have postgres installed and setup with the database user specified in .travis.yml (ideally, postgres is need only for integration tests but not unit tests). Additional, OpenAPI generation requires swagger2openapi installed with npm install -g swagger2openapi@2.11.16.

Building

If you maven build in the root directory this will build not only the web service but the client tool:

mvn clean install
# or
mvn clean install -Punit-tests

If you're running tests on Travis-CI (or otherwise have access to the confidential data bundle) Run them via:

mvn clean install -Pintegration-tests

There are also certain categories for tests that they can be added to when writing new tests. Categories include:

  1. ToilOnlyTest are tests that can only be run by Toil (which also installs a different version of cwltool)
  2. ToilCompatibleTest are tests that can be run with our default cwltool and with Toil
  3. ConfidentialTest are tests that require access to our confidential testing bundle (ask a member of the development team if you're on the team)

Running Locally

You can also run it on your local computer but will need to setup postgres separately.

  1. Fill in the template dockstore.yml and stash it somewhere outside the git repo (like ~/.dockstore)
  2. The dockstore.yml is mostly a standard Dropwizard configuration file. Refer to the linked document to setup httpClient and database.
  3. Start with java -jar dockstore-webservice/target/dockstore-webservice-*.jar server ~/.dockstore/dockstore.yml
  4. If you need integration with GitHub.com, Quay.io. or Bitbucket for your work, you will need to follow the appropriate sections below and then fill out the corresponding fields in your dockstore.yml.

View Swagger UI

The Swagger UI is reachable while the Dockstore webservice is running. This allows you to explore available web resources.

  1. Browse to http://localhost:8080/static/swagger-ui/index.html

Development

Coding Standards

codestyle.xml defines the coding style for Dockstore as an IntelliJ Code Style XML file that should be imported into IntelliJ IDE. We also have a matching checkstyle.xml that can be imported into other IDEs and is run during the build.

For users of Intellij or comparable IDEs, we also suggest loading the checkstyle.xml with a plugin in order to display warnings and errors while coding live rather than encountering them later when running a build.

Dockstore Command Line

The dockstore command line should be installed in a location in your path.

/dockstore-client/bin/dockstore

You then need to setup a ~/.dockstore/config file with the following contents:

token: <dockstore_token_from_web_app>
server-url: http://www.dockstore.org:8080

If you are working with a custom-built or updated dockstore client you will need to update the jar in: ~/.dockstore/config/self-installs.

Swagger Client Generation

We use the swagger-codegen-maven-plugin to generate several sections of code which are not checked in. These include

  1. All of swagger-java-client (talks to our webservice for the CLI)
  2. All of swagger-java-quay-client (talks to Quay.io for our webservice)
  3. The Tool Registry Server components (serves up the TRS endpoints)

To update these, you will need to point at a new version of the swagger.yaml provided by a service. For example, update the equivalent of inputSpec in your branch.

HubFlow Operations

How to perform a Maven release for a Unstable Release

This is for pre-release versions that have not been released to production.

  1. Create a release tag and iterate pom file versions mvn release:prepare
  2. Release from the tag into artifactory (you may need permissions) mvn release:perform
  3. Merge to master if this is a stable release git checkout master; git merge <your tag here>

Special note: If a test is failing during perform, but did not fail during prepare or Travis-CI builds, you may have a non-deterministic error. Skip tests during a release with mvn release:perform -Darguments="-DskipTests"

After the release to Artifactory, document the release on GitHub via the Releases page. Take a look at commits since the last release and closed pull requests for information on what goes into the changelog. Also attach the newly created Dockstore script and shaded client jar.

How to perform a Maven release for an Stable Release

This is for release versions that have been released to production.

  1. Create a hotfix branch mvn hf hotfix start <version>
  2. Iterate pom file versions to a SNAPSHOT if needed mvn versions:set -DnewVersion=<version>-SNAPSHOT
  3. Prepare the release and the perform it (you may need permissions) mvn release:prepare and mvn release:perform
  4. Merge to master and develop mvn hf hotfix finish

As with the unstable release, document the release and attach the new Dockstore script and shaded client jar.

Encrypted Documents for Travis-CI

Encrypted documents necessary for confidential testing are handled as indicated in the documents at Travis-CI for
files and environment variables.

A convenience script is provided as encrypt.sh which will compress confidential files, encrypt them, and then update an encrypted archive on GitHub. Confidential files should also be added to .gitignore to prevent accidental check-in. The unencrypted secrets.tar should be privately distributed among members of the team that need to work with confidential data. When using this script you will likely want to alter the CUSTOM_DIR_NAME. This is necessary since running the script will overwrite the existing encryption keys, instantly breaking existing builds using that key. Our current workaround is to use a new directory when providing a new bundle.

Adding Copyright header to all files with IntelliJ

To add copyright headers to all files with IntelliJ

  1. Ensure the Copyright plugin is installed (Settings -> Plugins)
  2. Create a new copyright profile matching existing copyright header found on all files, name it Dockstore (Settings -> Copyright -> Copyright Profiles -> Add New)
  3. Set the default project copyright to Dockstore (Settings -> Copyright)

Legacy Material

Additional documentation on developing Dockstore is available at legacy.md