Project

General

Profile

Arvados-cwl-runner development » History » Version 11

Eric Biagiotti, 02/05/2019 02:15 PM

1 1 Peter Amstutz
h1. Arvados-cwl-runner development
2
3 9 Eric Biagiotti
Arvados-cwl-runner has two modes: submitting a workflow, and actively managing a workflow.
4 2 Peter Amstutz
5 9 Eric Biagiotti
In submit mode (--submit) it creates a container request which executes arvados-cwl-runner (a-c-r) inside a container.  The container request uses the docker image "arvados/jobs" and the docker tag is the version of submitting a-c-r instance.  The a-c-r instance inside the container actively manages the workflow, and gets information about the container it is running in using containers().current().
6 2 Peter Amstutz
7 9 Eric Biagiotti
When doing development related to workflow execution, you can use "--local" to run a locally managed workflow using your development code.  However, you still need to test that the workflow can be submitted and run in the container.  This requires building a development "arvados/jobs" image with the correct code and version tag.
8 1 Peter Amstutz
9 9 Eric Biagiotti
h2. Example development process
10 2 Peter Amstutz
11 9 Eric Biagiotti
_Setup python virtual environment, edit code, and test locally_
12
13 1 Peter Amstutz
# $ virtualenv venv
14
# $ . venv/bin/activate
15
# $ (cd ~/arvados/sdk/cwl && python setup.py develop)
16 2 Peter Amstutz
# _do your development_
17
# $ arvados-cwl-runner --local
18 9 Eric Biagiotti
19
_Commit code, build development docker jobs image, and test submission_
20
21 2 Peter Amstutz
# $ git commit
22
# $ (cd ~/arvados/sdk/cwl && python setup.py develop)
23
# $ ~/arvados/build/build-dev-docker-jobs-image.sh
24
# $ arvados-cwl-runner --submit
25 3 Peter Amstutz
26 9 Eric Biagiotti
_Important to note:_
27 6 Peter Amstutz
28 10 Eric Biagiotti
* You need to have ARVADOS_API_HOST and ARVADOS_API_TOKEN in your environment. This can be obtained by opening workbench and clicking on _Current token_ in the user dropdown menu. 
29 7 Peter Amstutz
* "setup.py develop" is convenient for editing files in place, but whenever you commit to git remember to re-run setup.py to record the new version number (which is derived from the git commit timestamp).
30 10 Eric Biagiotti
* If you are using arvbox, the paths here refer to your development arvados repository in the .arvbox folder
31 9 Eric Biagiotti
* You can specify custom schema salad, cwltool packages, and/or the python executable to use in the dev docker jobs image by doing the following:
32
    
33
     * $ PYCMD=python_or_python3 SALAD=/path/to/schema-salad CWLTOOL=/path/to/cwltool ~/arvados/build/build-dev-docker-jobs-image.sh
34 1 Peter Amstutz
35 10 Eric Biagiotti
h2. Testing
36 1 Peter Amstutz
37 10 Eric Biagiotti
This section describes how to set up your testing environment and run/debug CWL conformance and Arvados integration tests. Tests can be run 4 different ways. You can run tests using a Python 3 virtualenv in a docker image running Python 2, vice versa, or in a pure Python 2 or 3 setup. Python 2 is the default for build-dev-docker-jobs-image.sh. Use "PYCMD=python3 arvados/build/build-dev-docker-jobs-image.sh" to get a Python 3 dev docker image. You can use the --python="path/to/python/exec/" virtualenv argument to specify your python version.
38
39 11 Eric Biagiotti
If using arvbox, you can more easily test with test_with_arvbox.sh, which is in the arvados/sdk/cwl folder. Commands include:
40
41
--pythoncmd (python|python3)
42
43
--suite (conformance|integration)
44
45
--api (jobs|containers)
46
47
Example: test_with_arvbox.sh --no-reset-container --leave-running --config dev --build --pythoncmd python3 --suite integration -j3
48
49
50 10 Eric Biagiotti
h3. Environment setup
51
52
# $ "arvbox start" and "arvswitch" to your dev cluster or run "arvbox start dev"
53
# If ARVADOS_API_HOST and ARVADOS_API_TOKEN are not set, find the the workbench ip address from the arvbox output. Open it in a browser and add a new account with fake credentials. Click on _Current token_ in the user dropdown menu and follow instructions. If you subsequently receive localhost match errors, use "export ARVADOS_API_HOST_INSECURE=1".
54 1 Peter Amstutz
# $ virtualenv venv
55
# $ . venv/bin/activate
56
# $ (cd ~/arvados/sdk/cwl && python setup.py develop)
57 10 Eric Biagiotti
# $ ~/arvados/build/build-dev-docker-jobs-image.sh.
58
59
h3. Running CWL conformance tests
60
 
61
run_tests.sh is located in the common-workflow-language repository. To improve speed, use -jx, where x is the number tests to run simultaneously. To run a single test, use -nx where x is the test number zero-indexed. 
62
63 1 Peter Amstutz
# $ pip install cwltest
64
# $ git clone https://github.com/common-workflow-language/common-workflow-language.git
65
66 10 Eric Biagiotti
_Run tests_
67 1 Peter Amstutz
68 10 Eric Biagiotti
# $ ./run_test.sh RUNNER=arvados-cwl-runner EXTRA="--api=containers --compute-checksum --disable-reuse --local"
69
# $ ./run_test.sh RUNNER=arvados-cwl-runner EXTRA="--api=containers --compute-checksum --disable-reuse --submit"
70
71
_Debug tests_
72
73
When a test fails, there should be output displaying _Test failed:_ followed by the test command. Copy the command. 
74
75
# $ cd common-workflow-language/v1.0
76
# $ Paste the command and replace the --quiet flag with --debug
77
78
h3. Running arvados CWL integration tests
79
80 4 Peter Amstutz
# $ cd arvados/sdk/cwl/tests
81 1 Peter Amstutz
# $ ./arvados-tests.sh