12 import arvados.collection
14 import arvados_cwl.runner
17 from .matcher import JsonDiffMatcher
18 from .mock_discovery import get_rootDesc
20 import ruamel.yaml as yaml
25 @functools.wraps(func)
26 @mock.patch("arvados.commands.keepdocker.list_images_in_arv")
27 @mock.patch("arvados.collection.KeepClient")
28 @mock.patch("arvados.keep.KeepClient")
29 @mock.patch("arvados.events.subscribe")
30 def wrapped(self, events, keep_client1, keep_client2, keepdocker, *args, **kwargs):
35 stubs.keepdocker = keepdocker
38 def putstub(p, **kwargs):
39 return "%s+%i" % (hashlib.md5(p).hexdigest(), len(p))
40 keep_client1().put.side_effect = putstub
41 keep_client1.put.side_effect = putstub
42 keep_client2().put.side_effect = putstub
43 keep_client2.put.side_effect = putstub
45 stubs.keep_client = keep_client2
46 stubs.keepdocker.return_value = [("zzzzz-4zz18-zzzzzzzzzzzzzz3", "")]
47 stubs.fake_user_uuid = "zzzzz-tpzed-zzzzzzzzzzzzzzz"
49 stubs.api = mock.MagicMock()
50 stubs.api._rootDesc = get_rootDesc()
52 stubs.api.users().current().execute.return_value = {
53 "uuid": stubs.fake_user_uuid,
55 stubs.api.collections().list().execute.return_value = {"items": []}
56 stubs.api.collections().create().execute.side_effect = ({
57 "uuid": "zzzzz-4zz18-zzzzzzzzzzzzzz1",
58 "portable_data_hash": "99999999999999999999999999999991+99",
61 "uuid": "zzzzz-4zz18-zzzzzzzzzzzzzz2",
62 "portable_data_hash": "99999999999999999999999999999992+99",
63 "manifest_text": "./tool 00000000000000000000000000000000+0 0:0:submit_tool.cwl 0:0:blub.txt"
66 "uuid": "zzzzz-4zz18-zzzzzzzzzzzzzz4",
67 "portable_data_hash": "99999999999999999999999999999994+99",
71 "uuid": "zzzzz-4zz18-zzzzzzzzzzzzzz5",
72 "portable_data_hash": "99999999999999999999999999999995+99",
76 "uuid": "zzzzz-4zz18-zzzzzzzzzzzzzz6",
77 "portable_data_hash": "99999999999999999999999999999996+99",
81 stubs.api.collections().get().execute.return_value = {
82 "portable_data_hash": "99999999999999999999999999999993+99", "manifest_text": "./tool 00000000000000000000000000000000+0 0:0:submit_tool.cwl 0:0:blub.txt"}
84 stubs.expect_job_uuid = "zzzzz-8i9sb-zzzzzzzzzzzzzzz"
85 stubs.api.jobs().create().execute.return_value = {
86 "uuid": stubs.expect_job_uuid,
90 stubs.expect_container_request_uuid = "zzzzz-xvhdp-zzzzzzzzzzzzzzz"
91 stubs.api.container_requests().create().execute.return_value = {
92 "uuid": stubs.expect_container_request_uuid,
93 "container_uuid": "zzzzz-dz642-zzzzzzzzzzzzzzz",
97 stubs.expect_pipeline_template_uuid = "zzzzz-d1hrv-zzzzzzzzzzzzzzz"
98 stubs.api.pipeline_templates().create().execute.return_value = {
99 "uuid": stubs.expect_pipeline_template_uuid,
101 stubs.expect_job_spec = {
102 'runtime_constraints': {
103 'docker_image': 'arvados/jobs:'+arvados_cwl.__version__,
104 'min_ram_mb_per_node': 1024
106 'script_parameters': {
108 'basename': 'blorp.txt',
109 'location': 'keep:99999999999999999999999999999992+99/blorp.txt',
113 'basename': '99999999999999999999999999999998+99',
114 'location': 'keep:99999999999999999999999999999998+99',
118 'basename': 'anonymous',
120 "basename": "renamed.txt",
122 "location": "keep:99999999999999999999999999999998+99/file1.txt"
127 '99999999999999999999999999999994+99/workflow.cwl#main'
129 'repository': 'arvados',
130 'script_version': 'master',
131 'minimum_script_version': '570509ab4d2ef93d870fd2b1f2eab178afb1bad9',
132 'script': 'cwl-runner'
134 stubs.pipeline_component = stubs.expect_job_spec.copy()
135 stubs.expect_pipeline_instance = {
136 'name': 'submit_wf.cwl',
137 'state': 'RunningOnServer',
141 'runtime_constraints': {'docker_image': 'arvados/jobs:'+arvados_cwl.__version__, 'min_ram_mb_per_node': 1024},
142 'script_parameters': {
143 'y': {"value": {'basename': '99999999999999999999999999999998+99', 'location': 'keep:99999999999999999999999999999998+99', 'class': 'Directory'}},
144 'x': {"value": {'basename': 'blorp.txt', 'class': 'File', 'location': 'keep:99999999999999999999999999999992+99/blorp.txt'}},
145 'z': {"value": {'basename': 'anonymous', 'class': 'Directory',
147 {'basename': 'renamed.txt', 'class': 'File', 'location': 'keep:99999999999999999999999999999998+99/file1.txt'}
149 'cwl:tool': '99999999999999999999999999999994+99/workflow.cwl#main',
150 'arv:enable_reuse': True,
151 'arv:on_error': 'continue'
153 'repository': 'arvados',
154 'script_version': 'master',
155 'minimum_script_version': '570509ab4d2ef93d870fd2b1f2eab178afb1bad9',
156 'script': 'cwl-runner',
157 'job': {'state': 'Queued', 'uuid': 'zzzzz-8i9sb-zzzzzzzzzzzzzzz'}
161 stubs.pipeline_create = copy.deepcopy(stubs.expect_pipeline_instance)
162 stubs.expect_pipeline_uuid = "zzzzz-d1hrv-zzzzzzzzzzzzzzz"
163 stubs.pipeline_create["uuid"] = stubs.expect_pipeline_uuid
164 stubs.pipeline_with_job = copy.deepcopy(stubs.pipeline_create)
165 stubs.pipeline_with_job["components"]["cwl-runner"]["job"] = {
166 "uuid": "zzzzz-8i9sb-zzzzzzzzzzzzzzz",
169 stubs.api.pipeline_instances().create().execute.return_value = stubs.pipeline_create
170 stubs.api.pipeline_instances().get().execute.return_value = stubs.pipeline_with_job
172 with open("tests/wf/submit_wf_packed.cwl") as f:
173 expect_packed_workflow = yaml.round_trip_load(f)
175 stubs.expect_container_spec = {
182 '/var/lib/cwl/workflow.json': {
183 'content': expect_packed_workflow,
187 'path': '/var/spool/cwl/cwl.output.json',
190 '/var/lib/cwl/cwl.input.json': {
193 'y': {'basename': '99999999999999999999999999999998+99', 'location': 'keep:99999999999999999999999999999998+99', 'class': 'Directory'},
194 'x': {'basename': u'blorp.txt', 'class': 'File', 'location': u'keep:99999999999999999999999999999992+99/blorp.txt'},
195 'z': {'basename': 'anonymous', 'class': 'Directory', 'listing': [
196 {'basename': 'renamed.txt', 'class': 'File', 'location': 'keep:99999999999999999999999999999998+99/file1.txt'}
202 'state': 'Committed',
204 'command': ['arvados-cwl-runner', '--local', '--api=containers', '--no-log-timestamps',
205 '--enable-reuse', '--on-error=continue',
206 '/var/lib/cwl/workflow.json#main', '/var/lib/cwl/cwl.input.json'],
207 'name': 'submit_wf.cwl',
208 'container_image': 'arvados/jobs:'+arvados_cwl.__version__,
209 'output_path': '/var/spool/cwl',
210 'cwd': '/var/spool/cwl',
211 'runtime_constraints': {
214 'ram': 1024*1024*1024
219 stubs.expect_workflow_uuid = "zzzzz-7fd4e-zzzzzzzzzzzzzzz"
220 stubs.api.workflows().create().execute.return_value = {
221 "uuid": stubs.expect_workflow_uuid,
223 def update_mock(**kwargs):
224 stubs.updated_uuid = kwargs.get('uuid')
226 stubs.api.workflows().update.side_effect = update_mock
227 stubs.api.workflows().update().execute.side_effect = lambda **kwargs: {
228 "uuid": stubs.updated_uuid,
231 return func(self, stubs, *args, **kwargs)
235 class TestSubmit(unittest.TestCase):
236 @mock.patch("arvados_cwl.runner.arv_docker_get_image")
237 @mock.patch("time.sleep")
239 def test_submit(self, stubs, tm, arvdock):
240 capture_stdout = cStringIO.StringIO()
241 exited = arvados_cwl.main(
242 ["--submit", "--no-wait", "--api=jobs", "--debug",
243 "tests/wf/submit_wf.cwl", "tests/submit_test_job.json"],
244 capture_stdout, sys.stderr, api_client=stubs.api)
245 self.assertEqual(exited, 0)
247 stubs.api.collections().create.assert_has_calls([
249 mock.call(body=JsonDiffMatcher({
251 '. 5bcc9fe8f8d5992e6cf418dc7ce4dbb3+16 0:16:blub.txt\n',
252 'replication_desired': None,
253 'name': 'submit_tool.cwl dependencies',
254 }), ensure_unique_name=True),
255 mock.call().execute(num_retries=4),
256 mock.call(body=JsonDiffMatcher({
258 '. 979af1245a12a1fed634d4222473bfdc+16 0:16:blorp.txt\n',
259 'replication_desired': None,
260 'name': 'submit_wf.cwl input',
261 }), ensure_unique_name=True),
262 mock.call().execute(num_retries=4)])
264 arvdock.assert_has_calls([
265 mock.call(stubs.api, {"class": "DockerRequirement", "dockerPull": "debian:8"}, True, None),
266 mock.call(stubs.api, {'dockerPull': 'arvados/jobs:'+arvados_cwl.__version__}, True, None)
269 expect_pipeline = copy.deepcopy(stubs.expect_pipeline_instance)
270 stubs.api.pipeline_instances().create.assert_called_with(
271 body=JsonDiffMatcher(expect_pipeline))
272 self.assertEqual(capture_stdout.getvalue(),
273 stubs.expect_pipeline_uuid + '\n')
276 @mock.patch("time.sleep")
278 def test_submit_no_reuse(self, stubs, tm):
279 capture_stdout = cStringIO.StringIO()
280 exited = arvados_cwl.main(
281 ["--submit", "--no-wait", "--api=jobs", "--debug", "--disable-reuse",
282 "tests/wf/submit_wf.cwl", "tests/submit_test_job.json"],
283 capture_stdout, sys.stderr, api_client=stubs.api)
284 self.assertEqual(exited, 0)
286 expect_pipeline = copy.deepcopy(stubs.expect_pipeline_instance)
287 expect_pipeline["components"]["cwl-runner"]["script_parameters"]["arv:enable_reuse"] = {"value": False}
289 stubs.api.pipeline_instances().create.assert_called_with(
290 body=JsonDiffMatcher(expect_pipeline))
291 self.assertEqual(capture_stdout.getvalue(),
292 stubs.expect_pipeline_uuid + '\n')
294 @mock.patch("time.sleep")
296 def test_submit_on_error(self, stubs, tm):
297 capture_stdout = cStringIO.StringIO()
298 exited = arvados_cwl.main(
299 ["--submit", "--no-wait", "--api=jobs", "--debug", "--on-error=stop",
300 "tests/wf/submit_wf.cwl", "tests/submit_test_job.json"],
301 capture_stdout, sys.stderr, api_client=stubs.api)
302 self.assertEqual(exited, 0)
304 expect_pipeline = copy.deepcopy(stubs.expect_pipeline_instance)
305 expect_pipeline["components"]["cwl-runner"]["script_parameters"]["arv:on_error"] = "stop"
307 stubs.api.pipeline_instances().create.assert_called_with(
308 body=JsonDiffMatcher(expect_pipeline))
309 self.assertEqual(capture_stdout.getvalue(),
310 stubs.expect_pipeline_uuid + '\n')
313 @mock.patch("time.sleep")
315 def test_submit_runner_ram(self, stubs, tm):
316 capture_stdout = cStringIO.StringIO()
317 exited = arvados_cwl.main(
318 ["--submit", "--no-wait", "--debug", "--submit-runner-ram=2048",
319 "tests/wf/submit_wf.cwl", "tests/submit_test_job.json"],
320 capture_stdout, sys.stderr, api_client=stubs.api)
321 self.assertEqual(exited, 0)
323 expect_pipeline = copy.deepcopy(stubs.expect_pipeline_instance)
324 expect_pipeline["components"]["cwl-runner"]["runtime_constraints"]["min_ram_mb_per_node"] = 2048
326 stubs.api.pipeline_instances().create.assert_called_with(
327 body=JsonDiffMatcher(expect_pipeline))
328 self.assertEqual(capture_stdout.getvalue(),
329 stubs.expect_pipeline_uuid + '\n')
332 @mock.patch("time.sleep")
334 def test_submit_invalid_runner_ram(self, stubs, tm):
335 capture_stdout = cStringIO.StringIO()
336 exited = arvados_cwl.main(
337 ["--submit", "--no-wait", "--debug", "--submit-runner-ram=-2048",
338 "tests/wf/submit_wf.cwl", "tests/submit_test_job.json"],
339 capture_stdout, sys.stderr, api_client=stubs.api)
340 self.assertEqual(exited, 1)
342 @mock.patch("time.sleep")
344 def test_submit_output_name(self, stubs, tm):
345 output_name = "test_output_name"
347 capture_stdout = cStringIO.StringIO()
348 exited = arvados_cwl.main(
349 ["--submit", "--no-wait", "--debug", "--output-name", output_name,
350 "tests/wf/submit_wf.cwl", "tests/submit_test_job.json"],
351 capture_stdout, sys.stderr, api_client=stubs.api)
352 self.assertEqual(exited, 0)
354 expect_pipeline = copy.deepcopy(stubs.expect_pipeline_instance)
355 expect_pipeline["components"]["cwl-runner"]["script_parameters"]["arv:output_name"] = output_name
357 stubs.api.pipeline_instances().create.assert_called_with(
358 body=JsonDiffMatcher(expect_pipeline))
359 self.assertEqual(capture_stdout.getvalue(),
360 stubs.expect_pipeline_uuid + '\n')
363 @mock.patch("time.sleep")
365 def test_submit_pipeline_name(self, stubs, tm):
366 capture_stdout = cStringIO.StringIO()
367 exited = arvados_cwl.main(
368 ["--submit", "--no-wait", "--debug", "--name=hello job 123",
369 "tests/wf/submit_wf.cwl", "tests/submit_test_job.json"],
370 capture_stdout, sys.stderr, api_client=stubs.api)
371 self.assertEqual(exited, 0)
373 expect_pipeline = copy.deepcopy(stubs.expect_pipeline_instance)
374 expect_pipeline["name"] = "hello job 123"
376 stubs.api.pipeline_instances().create.assert_called_with(
377 body=JsonDiffMatcher(expect_pipeline))
378 self.assertEqual(capture_stdout.getvalue(),
379 stubs.expect_pipeline_uuid + '\n')
381 @mock.patch("time.sleep")
383 def test_submit_output_tags(self, stubs, tm):
384 output_tags = "tag0,tag1,tag2"
386 capture_stdout = cStringIO.StringIO()
387 exited = arvados_cwl.main(
388 ["--submit", "--no-wait", "--debug", "--output-tags", output_tags,
389 "tests/wf/submit_wf.cwl", "tests/submit_test_job.json"],
390 capture_stdout, sys.stderr, api_client=stubs.api)
391 self.assertEqual(exited, 0)
393 expect_pipeline = copy.deepcopy(stubs.expect_pipeline_instance)
394 expect_pipeline["components"]["cwl-runner"]["script_parameters"]["arv:output_tags"] = output_tags
396 stubs.api.pipeline_instances().create.assert_called_with(
397 body=JsonDiffMatcher(expect_pipeline))
398 self.assertEqual(capture_stdout.getvalue(),
399 stubs.expect_pipeline_uuid + '\n')
401 @mock.patch("time.sleep")
403 def test_submit_with_project_uuid(self, stubs, tm):
404 project_uuid = 'zzzzz-j7d0g-zzzzzzzzzzzzzzz'
406 exited = arvados_cwl.main(
407 ["--submit", "--no-wait",
408 "--project-uuid", project_uuid,
409 "tests/wf/submit_wf.cwl", "tests/submit_test_job.json"],
410 sys.stdout, sys.stderr, api_client=stubs.api)
411 self.assertEqual(exited, 0)
413 expect_pipeline = copy.deepcopy(stubs.expect_pipeline_instance)
414 expect_pipeline["owner_uuid"] = project_uuid
415 stubs.api.pipeline_instances().create.assert_called_with(
416 body=JsonDiffMatcher(expect_pipeline))
419 def test_submit_container(self, stubs):
420 capture_stdout = cStringIO.StringIO()
422 exited = arvados_cwl.main(
423 ["--submit", "--no-wait", "--api=containers", "--debug",
424 "tests/wf/submit_wf.cwl", "tests/submit_test_job.json"],
425 capture_stdout, sys.stderr, api_client=stubs.api, keep_client=stubs.keep_client)
426 self.assertEqual(exited, 0)
428 logging.exception("")
430 stubs.api.collections().create.assert_has_calls([
432 mock.call(body=JsonDiffMatcher({
434 '. 5bcc9fe8f8d5992e6cf418dc7ce4dbb3+16 0:16:blub.txt\n',
435 'replication_desired': None,
436 'name': 'submit_tool.cwl dependencies',
437 }), ensure_unique_name=True),
438 mock.call().execute(num_retries=4),
439 mock.call(body=JsonDiffMatcher({
441 '. 979af1245a12a1fed634d4222473bfdc+16 0:16:blorp.txt\n',
442 'replication_desired': None,
443 'name': 'submit_wf.cwl input',
444 }), ensure_unique_name=True),
445 mock.call().execute(num_retries=4)])
447 expect_container = copy.deepcopy(stubs.expect_container_spec)
448 stubs.api.container_requests().create.assert_called_with(
449 body=JsonDiffMatcher(expect_container))
450 self.assertEqual(capture_stdout.getvalue(),
451 stubs.expect_container_request_uuid + '\n')
454 def test_submit_container_no_reuse(self, stubs):
455 capture_stdout = cStringIO.StringIO()
457 exited = arvados_cwl.main(
458 ["--submit", "--no-wait", "--api=containers", "--debug", "--disable-reuse",
459 "tests/wf/submit_wf.cwl", "tests/submit_test_job.json"],
460 capture_stdout, sys.stderr, api_client=stubs.api, keep_client=stubs.keep_client)
461 self.assertEqual(exited, 0)
463 logging.exception("")
465 expect_container = copy.deepcopy(stubs.expect_container_spec)
466 expect_container["command"] = ['arvados-cwl-runner', '--local', '--api=containers', '--no-log-timestamps',
467 '--disable-reuse', '--on-error=continue',
468 '/var/lib/cwl/workflow.json#main', '/var/lib/cwl/cwl.input.json']
470 stubs.api.container_requests().create.assert_called_with(
471 body=JsonDiffMatcher(expect_container))
472 self.assertEqual(capture_stdout.getvalue(),
473 stubs.expect_container_request_uuid + '\n')
477 def test_submit_container_on_error(self, stubs):
478 capture_stdout = cStringIO.StringIO()
480 exited = arvados_cwl.main(
481 ["--submit", "--no-wait", "--api=containers", "--debug", "--on-error=stop",
482 "tests/wf/submit_wf.cwl", "tests/submit_test_job.json"],
483 capture_stdout, sys.stderr, api_client=stubs.api, keep_client=stubs.keep_client)
484 self.assertEqual(exited, 0)
486 logging.exception("")
488 expect_container = copy.deepcopy(stubs.expect_container_spec)
489 expect_container["command"] = ['arvados-cwl-runner', '--local', '--api=containers', '--no-log-timestamps',
490 '--enable-reuse', '--on-error=stop',
491 '/var/lib/cwl/workflow.json#main', '/var/lib/cwl/cwl.input.json']
493 stubs.api.container_requests().create.assert_called_with(
494 body=JsonDiffMatcher(expect_container))
495 self.assertEqual(capture_stdout.getvalue(),
496 stubs.expect_container_request_uuid + '\n')
499 def test_submit_container_output_name(self, stubs):
500 output_name = "test_output_name"
502 capture_stdout = cStringIO.StringIO()
504 exited = arvados_cwl.main(
505 ["--submit", "--no-wait", "--api=containers", "--debug", "--output-name", output_name,
506 "tests/wf/submit_wf.cwl", "tests/submit_test_job.json"],
507 capture_stdout, sys.stderr, api_client=stubs.api, keep_client=stubs.keep_client)
508 self.assertEqual(exited, 0)
510 logging.exception("")
512 expect_container = copy.deepcopy(stubs.expect_container_spec)
513 expect_container["command"] = ['arvados-cwl-runner', '--local', '--api=containers', '--no-log-timestamps',
514 "--output-name="+output_name, '--enable-reuse', '--on-error=continue',
515 '/var/lib/cwl/workflow.json#main', '/var/lib/cwl/cwl.input.json']
516 expect_container["output_name"] = output_name
518 stubs.api.container_requests().create.assert_called_with(
519 body=JsonDiffMatcher(expect_container))
520 self.assertEqual(capture_stdout.getvalue(),
521 stubs.expect_container_request_uuid + '\n')
525 def test_submit_container_output_ttl(self, stubs):
526 capture_stdout = cStringIO.StringIO()
528 exited = arvados_cwl.main(
529 ["--submit", "--no-wait", "--api=containers", "--debug", "--intermediate-output-ttl", "3600",
530 "tests/wf/submit_wf.cwl", "tests/submit_test_job.json"],
531 capture_stdout, sys.stderr, api_client=stubs.api, keep_client=stubs.keep_client)
532 self.assertEqual(exited, 0)
534 logging.exception("")
536 expect_container = copy.deepcopy(stubs.expect_container_spec)
537 expect_container["command"] = ['arvados-cwl-runner', '--local', '--api=containers', '--no-log-timestamps',
538 '--enable-reuse', '--on-error=continue',
539 "--intermediate-output-ttl=3600",
540 '/var/lib/cwl/workflow.json#main', '/var/lib/cwl/cwl.input.json']
542 stubs.api.container_requests().create.assert_called_with(
543 body=JsonDiffMatcher(expect_container))
544 self.assertEqual(capture_stdout.getvalue(),
545 stubs.expect_container_request_uuid + '\n')
548 def test_submit_container_output_tags(self, stubs):
549 output_tags = "tag0,tag1,tag2"
551 capture_stdout = cStringIO.StringIO()
553 exited = arvados_cwl.main(
554 ["--submit", "--no-wait", "--api=containers", "--debug", "--output-tags", output_tags,
555 "tests/wf/submit_wf.cwl", "tests/submit_test_job.json"],
556 capture_stdout, sys.stderr, api_client=stubs.api, keep_client=stubs.keep_client)
557 self.assertEqual(exited, 0)
559 logging.exception("")
561 expect_container = copy.deepcopy(stubs.expect_container_spec)
562 expect_container["command"] = ['arvados-cwl-runner', '--local', '--api=containers', '--no-log-timestamps',
563 "--output-tags="+output_tags, '--enable-reuse', '--on-error=continue',
564 '/var/lib/cwl/workflow.json#main', '/var/lib/cwl/cwl.input.json']
566 stubs.api.container_requests().create.assert_called_with(
567 body=JsonDiffMatcher(expect_container))
568 self.assertEqual(capture_stdout.getvalue(),
569 stubs.expect_container_request_uuid + '\n')
572 def test_submit_container_runner_ram(self, stubs):
573 capture_stdout = cStringIO.StringIO()
575 exited = arvados_cwl.main(
576 ["--submit", "--no-wait", "--api=containers", "--debug", "--submit-runner-ram=2048",
577 "tests/wf/submit_wf.cwl", "tests/submit_test_job.json"],
578 capture_stdout, sys.stderr, api_client=stubs.api, keep_client=stubs.keep_client)
579 self.assertEqual(exited, 0)
581 logging.exception("")
583 expect_container = copy.deepcopy(stubs.expect_container_spec)
584 expect_container["runtime_constraints"]["ram"] = 2048*1024*1024
586 stubs.api.container_requests().create.assert_called_with(
587 body=JsonDiffMatcher(expect_container))
588 self.assertEqual(capture_stdout.getvalue(),
589 stubs.expect_container_request_uuid + '\n')
591 @mock.patch("arvados.collection.CollectionReader")
592 @mock.patch("time.sleep")
594 def test_submit_file_keepref(self, stubs, tm, collectionReader):
595 capture_stdout = cStringIO.StringIO()
596 exited = arvados_cwl.main(
597 ["--submit", "--no-wait", "--api=containers", "--debug",
598 "tests/wf/submit_keepref_wf.cwl"],
599 capture_stdout, sys.stderr, api_client=stubs.api)
600 self.assertEqual(exited, 0)
603 @mock.patch("arvados.collection.CollectionReader")
604 @mock.patch("time.sleep")
606 def test_submit_keepref(self, stubs, tm, reader):
607 capture_stdout = cStringIO.StringIO()
609 with open("tests/wf/expect_arvworkflow.cwl") as f:
610 reader().open().__enter__().read.return_value = f.read()
612 exited = arvados_cwl.main(
613 ["--submit", "--no-wait", "--api=containers", "--debug",
614 "keep:99999999999999999999999999999994+99/expect_arvworkflow.cwl#main", "-x", "XxX"],
615 capture_stdout, sys.stderr, api_client=stubs.api)
616 self.assertEqual(exited, 0)
626 'path': '/var/spool/cwl/cwl.output.json',
629 '/var/lib/cwl/workflow': {
630 'portable_data_hash': '99999999999999999999999999999994+99',
633 '/var/lib/cwl/cwl.input.json': {
639 }, 'state': 'Committed',
641 'output_path': '/var/spool/cwl',
642 'name': 'expect_arvworkflow.cwl#main',
643 'container_image': 'arvados/jobs:'+arvados_cwl.__version__,
644 'command': ['arvados-cwl-runner', '--local', '--api=containers', '--no-log-timestamps',
645 '--enable-reuse', '--on-error=continue',
646 '/var/lib/cwl/workflow/expect_arvworkflow.cwl#main', '/var/lib/cwl/cwl.input.json'],
647 'cwd': '/var/spool/cwl',
648 'runtime_constraints': {
656 stubs.api.container_requests().create.assert_called_with(
657 body=JsonDiffMatcher(expect_container))
658 self.assertEqual(capture_stdout.getvalue(),
659 stubs.expect_container_request_uuid + '\n')
662 @mock.patch("arvados.collection.CollectionReader")
663 @mock.patch("time.sleep")
665 def test_submit_jobs_keepref(self, stubs, tm, reader):
666 capture_stdout = cStringIO.StringIO()
668 with open("tests/wf/expect_arvworkflow.cwl") as f:
669 reader().open().__enter__().read.return_value = f.read()
671 exited = arvados_cwl.main(
672 ["--submit", "--no-wait", "--api=jobs", "--debug",
673 "keep:99999999999999999999999999999994+99/expect_arvworkflow.cwl#main", "-x", "XxX"],
674 capture_stdout, sys.stderr, api_client=stubs.api)
675 self.assertEqual(exited, 0)
677 expect_pipeline = copy.deepcopy(stubs.expect_pipeline_instance)
678 expect_pipeline["components"]["cwl-runner"]["script_parameters"]["x"] = "XxX"
679 del expect_pipeline["components"]["cwl-runner"]["script_parameters"]["y"]
680 del expect_pipeline["components"]["cwl-runner"]["script_parameters"]["z"]
681 expect_pipeline["components"]["cwl-runner"]["script_parameters"]["cwl:tool"] = "99999999999999999999999999999994+99/expect_arvworkflow.cwl#main"
682 expect_pipeline["name"] = "expect_arvworkflow.cwl#main"
683 stubs.api.pipeline_instances().create.assert_called_with(
684 body=JsonDiffMatcher(expect_pipeline))
686 @mock.patch("time.sleep")
688 def test_submit_arvworkflow(self, stubs, tm):
689 capture_stdout = cStringIO.StringIO()
691 with open("tests/wf/expect_arvworkflow.cwl") as f:
692 stubs.api.workflows().get().execute.return_value = {"definition": f.read(), "name": "a test workflow"}
694 exited = arvados_cwl.main(
695 ["--submit", "--no-wait", "--api=containers", "--debug",
696 "962eh-7fd4e-gkbzl62qqtfig37", "-x", "XxX"],
697 capture_stdout, sys.stderr, api_client=stubs.api)
698 self.assertEqual(exited, 0)
708 'path': '/var/spool/cwl/cwl.output.json',
711 '/var/lib/cwl/workflow.json': {
714 'cwlVersion': 'v1.0',
719 {'type': 'string', 'id': '#main/x'}
722 {'in': [{'source': '#main/x', 'id': '#main/step1/x'}],
723 'run': '#submit_tool.cwl',
733 'inputBinding': {'position': 1},
735 'id': '#submit_tool.cwl/x'}
738 {'dockerPull': 'debian:8', 'class': 'DockerRequirement'}
740 'id': '#submit_tool.cwl',
742 'baseCommand': 'cat',
743 'class': 'CommandLineTool'
748 '/var/lib/cwl/cwl.input.json': {
754 }, 'state': 'Committed',
756 'output_path': '/var/spool/cwl',
757 'name': 'a test workflow',
758 'container_image': 'arvados/jobs:'+arvados_cwl.__version__,
759 'command': ['arvados-cwl-runner', '--local', '--api=containers', '--no-log-timestamps',
760 '--enable-reuse', '--on-error=continue',
761 '/var/lib/cwl/workflow.json#main', '/var/lib/cwl/cwl.input.json'],
762 'cwd': '/var/spool/cwl',
763 'runtime_constraints': {
769 "template_uuid": "962eh-7fd4e-gkbzl62qqtfig37"
773 stubs.api.container_requests().create.assert_called_with(
774 body=JsonDiffMatcher(expect_container))
775 self.assertEqual(capture_stdout.getvalue(),
776 stubs.expect_container_request_uuid + '\n')
780 def test_submit_container_name(self, stubs):
781 capture_stdout = cStringIO.StringIO()
783 exited = arvados_cwl.main(
784 ["--submit", "--no-wait", "--api=containers", "--debug", "--name=hello container 123",
785 "tests/wf/submit_wf.cwl", "tests/submit_test_job.json"],
786 capture_stdout, sys.stderr, api_client=stubs.api, keep_client=stubs.keep_client)
787 self.assertEqual(exited, 0)
789 logging.exception("")
791 expect_container = copy.deepcopy(stubs.expect_container_spec)
792 expect_container["name"] = "hello container 123"
794 stubs.api.container_requests().create.assert_called_with(
795 body=JsonDiffMatcher(expect_container))
796 self.assertEqual(capture_stdout.getvalue(),
797 stubs.expect_container_request_uuid + '\n')
801 def test_submit_job_runner_image(self, stubs):
802 capture_stdout = cStringIO.StringIO()
804 exited = arvados_cwl.main(
805 ["--submit", "--no-wait", "--api=jobs", "--debug", "--submit-runner-image=arvados/jobs:123",
806 "tests/wf/submit_wf.cwl", "tests/submit_test_job.json"],
807 capture_stdout, sys.stderr, api_client=stubs.api, keep_client=stubs.keep_client)
808 self.assertEqual(exited, 0)
810 logging.exception("")
812 stubs.expect_pipeline_instance["components"]["cwl-runner"]["runtime_constraints"]["docker_image"] = "arvados/jobs:123"
814 expect_pipeline = copy.deepcopy(stubs.expect_pipeline_instance)
815 stubs.api.pipeline_instances().create.assert_called_with(
816 body=JsonDiffMatcher(expect_pipeline))
817 self.assertEqual(capture_stdout.getvalue(),
818 stubs.expect_pipeline_uuid + '\n')
821 def test_submit_container_runner_image(self, stubs):
822 capture_stdout = cStringIO.StringIO()
824 exited = arvados_cwl.main(
825 ["--submit", "--no-wait", "--api=containers", "--debug", "--submit-runner-image=arvados/jobs:123",
826 "tests/wf/submit_wf.cwl", "tests/submit_test_job.json"],
827 capture_stdout, sys.stderr, api_client=stubs.api, keep_client=stubs.keep_client)
828 self.assertEqual(exited, 0)
830 logging.exception("")
832 stubs.expect_container_spec["container_image"] = "arvados/jobs:123"
834 expect_container = copy.deepcopy(stubs.expect_container_spec)
835 stubs.api.container_requests().create.assert_called_with(
836 body=JsonDiffMatcher(expect_container))
837 self.assertEqual(capture_stdout.getvalue(),
838 stubs.expect_container_request_uuid + '\n')
841 @mock.patch("arvados.commands.keepdocker.find_one_image_hash")
842 @mock.patch("cwltool.docker.get_image")
843 @mock.patch("arvados.api")
844 def test_arvados_jobs_image(self, api, get_image, find_one_image_hash):
845 arvrunner = mock.MagicMock()
846 arvrunner.project_uuid = ""
847 api.return_value = mock.MagicMock()
848 arvrunner.api = api.return_value
849 arvrunner.api.links().list().execute.side_effect = ({"items": [{"created_at": "",
850 "head_uuid": "zzzzz-4zz18-zzzzzzzzzzzzzzb",
851 "link_class": "docker_image_repo+tag",
852 "name": "arvados/jobs:"+arvados_cwl.__version__,
854 "properties": {"image_timestamp": ""}}], "items_available": 1, "offset": 0},
855 {"items": [{"created_at": "",
857 "link_class": "docker_image_hash",
860 "properties": {"image_timestamp": ""}}], "items_available": 1, "offset": 0}
862 find_one_image_hash.return_value = "123456"
864 arvrunner.api.collections().list().execute.side_effect = ({"items": [{"uuid": "zzzzz-4zz18-zzzzzzzzzzzzzzb",
868 }], "items_available": 1, "offset": 0},)
869 arvrunner.api.collections().create().execute.return_value = {"uuid": ""}
870 self.assertEqual("arvados/jobs:"+arvados_cwl.__version__,
871 arvados_cwl.runner.arvados_jobs_image(arvrunner, "arvados/jobs:"+arvados_cwl.__version__))
873 class TestCreateTemplate(unittest.TestCase):
874 existing_template_uuid = "zzzzz-d1hrv-validworkfloyml"
876 def _adjust_script_params(self, expect_component):
877 expect_component['script_parameters']['x'] = {
881 'value': '99999999999999999999999999999992+99/blorp.txt',
883 expect_component['script_parameters']['y'] = {
884 'dataclass': 'Collection',
887 'value': '99999999999999999999999999999998+99',
889 expect_component['script_parameters']['z'] = {
890 'dataclass': 'Collection',
896 def test_create(self, stubs):
897 project_uuid = 'zzzzz-j7d0g-zzzzzzzzzzzzzzz'
899 capture_stdout = cStringIO.StringIO()
901 exited = arvados_cwl.main(
902 ["--create-workflow", "--debug",
904 "--project-uuid", project_uuid,
905 "tests/wf/submit_wf.cwl", "tests/submit_test_job.json"],
906 capture_stdout, sys.stderr, api_client=stubs.api)
907 self.assertEqual(exited, 0)
909 stubs.api.pipeline_instances().create.refute_called()
910 stubs.api.jobs().create.refute_called()
912 expect_component = copy.deepcopy(stubs.expect_job_spec)
913 self._adjust_script_params(expect_component)
916 "submit_wf.cwl": expect_component,
918 "name": "submit_wf.cwl",
919 "owner_uuid": project_uuid,
921 stubs.api.pipeline_templates().create.assert_called_with(
922 body=JsonDiffMatcher(expect_template), ensure_unique_name=True)
924 self.assertEqual(capture_stdout.getvalue(),
925 stubs.expect_pipeline_template_uuid + '\n')
929 def test_create_name(self, stubs):
930 project_uuid = 'zzzzz-j7d0g-zzzzzzzzzzzzzzz'
932 capture_stdout = cStringIO.StringIO()
934 exited = arvados_cwl.main(
935 ["--create-workflow", "--debug",
936 "--project-uuid", project_uuid,
938 "--name", "testing 123",
939 "tests/wf/submit_wf.cwl", "tests/submit_test_job.json"],
940 capture_stdout, sys.stderr, api_client=stubs.api)
941 self.assertEqual(exited, 0)
943 stubs.api.pipeline_instances().create.refute_called()
944 stubs.api.jobs().create.refute_called()
946 expect_component = copy.deepcopy(stubs.expect_job_spec)
947 self._adjust_script_params(expect_component)
950 "testing 123": expect_component,
952 "name": "testing 123",
953 "owner_uuid": project_uuid,
955 stubs.api.pipeline_templates().create.assert_called_with(
956 body=JsonDiffMatcher(expect_template), ensure_unique_name=True)
958 self.assertEqual(capture_stdout.getvalue(),
959 stubs.expect_pipeline_template_uuid + '\n')
963 def test_update_name(self, stubs):
964 project_uuid = 'zzzzz-j7d0g-zzzzzzzzzzzzzzz'
966 capture_stdout = cStringIO.StringIO()
968 exited = arvados_cwl.main(
969 ["--update-workflow", self.existing_template_uuid,
971 "--project-uuid", project_uuid,
973 "--name", "testing 123",
974 "tests/wf/submit_wf.cwl", "tests/submit_test_job.json"],
975 capture_stdout, sys.stderr, api_client=stubs.api)
976 self.assertEqual(exited, 0)
978 stubs.api.pipeline_instances().create.refute_called()
979 stubs.api.jobs().create.refute_called()
981 expect_component = copy.deepcopy(stubs.expect_job_spec)
982 self._adjust_script_params(expect_component)
985 "testing 123": expect_component,
987 "name": "testing 123",
988 "owner_uuid": project_uuid,
990 stubs.api.pipeline_templates().create.refute_called()
991 stubs.api.pipeline_templates().update.assert_called_with(
992 body=JsonDiffMatcher(expect_template), uuid=self.existing_template_uuid)
994 self.assertEqual(capture_stdout.getvalue(),
995 self.existing_template_uuid + '\n')
998 class TestCreateWorkflow(unittest.TestCase):
999 existing_workflow_uuid = "zzzzz-7fd4e-validworkfloyml"
1000 expect_workflow = open("tests/wf/expect_packed.cwl").read()
1003 def test_create(self, stubs):
1004 project_uuid = 'zzzzz-j7d0g-zzzzzzzzzzzzzzz'
1006 capture_stdout = cStringIO.StringIO()
1008 exited = arvados_cwl.main(
1009 ["--create-workflow", "--debug",
1011 "--project-uuid", project_uuid,
1012 "tests/wf/submit_wf.cwl", "tests/submit_test_job.json"],
1013 capture_stdout, sys.stderr, api_client=stubs.api)
1014 self.assertEqual(exited, 0)
1016 stubs.api.pipeline_templates().create.refute_called()
1017 stubs.api.container_requests().create.refute_called()
1021 "owner_uuid": project_uuid,
1022 "name": "submit_wf.cwl",
1024 "definition": self.expect_workflow,
1027 stubs.api.workflows().create.assert_called_with(
1028 body=JsonDiffMatcher(body))
1030 self.assertEqual(capture_stdout.getvalue(),
1031 stubs.expect_workflow_uuid + '\n')
1035 def test_create_name(self, stubs):
1036 project_uuid = 'zzzzz-j7d0g-zzzzzzzzzzzzzzz'
1038 capture_stdout = cStringIO.StringIO()
1040 exited = arvados_cwl.main(
1041 ["--create-workflow", "--debug",
1043 "--project-uuid", project_uuid,
1044 "--name", "testing 123",
1045 "tests/wf/submit_wf.cwl", "tests/submit_test_job.json"],
1046 capture_stdout, sys.stderr, api_client=stubs.api)
1047 self.assertEqual(exited, 0)
1049 stubs.api.pipeline_templates().create.refute_called()
1050 stubs.api.container_requests().create.refute_called()
1054 "owner_uuid": project_uuid,
1055 "name": "testing 123",
1057 "definition": self.expect_workflow,
1060 stubs.api.workflows().create.assert_called_with(
1061 body=JsonDiffMatcher(body))
1063 self.assertEqual(capture_stdout.getvalue(),
1064 stubs.expect_workflow_uuid + '\n')
1067 def test_incompatible_api(self, stubs):
1068 capture_stderr = cStringIO.StringIO()
1069 logging.getLogger('arvados.cwl-runner').addHandler(
1070 logging.StreamHandler(capture_stderr))
1072 exited = arvados_cwl.main(
1073 ["--update-workflow", self.existing_workflow_uuid,
1076 "tests/wf/submit_wf.cwl", "tests/submit_test_job.json"],
1077 sys.stderr, sys.stderr, api_client=stubs.api)
1078 self.assertEqual(exited, 1)
1079 self.assertRegexpMatches(
1080 capture_stderr.getvalue(),
1081 "--update-workflow arg '{}' uses 'containers' API, but --api='jobs' specified".format(self.existing_workflow_uuid))
1084 def test_update(self, stubs):
1085 capture_stdout = cStringIO.StringIO()
1087 exited = arvados_cwl.main(
1088 ["--update-workflow", self.existing_workflow_uuid,
1090 "tests/wf/submit_wf.cwl", "tests/submit_test_job.json"],
1091 capture_stdout, sys.stderr, api_client=stubs.api)
1092 self.assertEqual(exited, 0)
1096 "name": "submit_wf.cwl",
1098 "definition": self.expect_workflow,
1101 stubs.api.workflows().update.assert_called_with(
1102 uuid=self.existing_workflow_uuid,
1103 body=JsonDiffMatcher(body))
1104 self.assertEqual(capture_stdout.getvalue(),
1105 self.existing_workflow_uuid + '\n')
1109 def test_update_name(self, stubs):
1110 capture_stdout = cStringIO.StringIO()
1112 exited = arvados_cwl.main(
1113 ["--update-workflow", self.existing_workflow_uuid,
1114 "--debug", "--name", "testing 123",
1115 "tests/wf/submit_wf.cwl", "tests/submit_test_job.json"],
1116 capture_stdout, sys.stderr, api_client=stubs.api)
1117 self.assertEqual(exited, 0)
1121 "name": "testing 123",
1123 "definition": self.expect_workflow,
1126 stubs.api.workflows().update.assert_called_with(
1127 uuid=self.existing_workflow_uuid,
1128 body=JsonDiffMatcher(body))
1129 self.assertEqual(capture_stdout.getvalue(),
1130 self.existing_workflow_uuid + '\n')
1133 class TestTemplateInputs(unittest.TestCase):
1136 "inputs_test.cwl": {
1137 'runtime_constraints': {
1138 'docker_image': 'arvados/jobs:'+arvados_cwl.__version__,
1139 'min_ram_mb_per_node': 1024
1141 'script_parameters': {
1143 '99999999999999999999999999999992+99/workflow.cwl#main',
1144 'optionalFloatInput': None,
1147 'dataclass': 'File',
1149 'title': "It's a file; we expect to find some characters in it.",
1150 'description': 'If there were anything further to say, it would be said here,\nor here.'
1154 'dataclass': 'number',
1156 'title': 'Floats like a duck',
1160 'optionalFloatInput': {
1161 'type': ['null', 'float'],
1162 'dataclass': 'number',
1167 'dataclass': 'boolean',
1169 'title': 'True or false?',
1172 'repository': 'arvados',
1173 'script_version': 'master',
1174 'minimum_script_version': '570509ab4d2ef93d870fd2b1f2eab178afb1bad9',
1175 'script': 'cwl-runner',
1178 "name": "inputs_test.cwl",
1182 def test_inputs_empty(self, stubs):
1183 exited = arvados_cwl.main(
1184 ["--create-template",
1185 "tests/wf/inputs_test.cwl", "tests/order/empty_order.json"],
1186 cStringIO.StringIO(), sys.stderr, api_client=stubs.api)
1187 self.assertEqual(exited, 0)
1189 stubs.api.pipeline_templates().create.assert_called_with(
1190 body=JsonDiffMatcher(self.expect_template), ensure_unique_name=True)
1193 def test_inputs(self, stubs):
1194 exited = arvados_cwl.main(
1195 ["--create-template",
1196 "tests/wf/inputs_test.cwl", "tests/order/inputs_test_order.json"],
1197 cStringIO.StringIO(), sys.stderr, api_client=stubs.api)
1198 self.assertEqual(exited, 0)
1200 expect_template = copy.deepcopy(self.expect_template)
1201 params = expect_template[
1202 "components"]["inputs_test.cwl"]["script_parameters"]
1203 params["fileInput"]["value"] = '99999999999999999999999999999992+99/blorp.txt'
1204 params["cwl:tool"] = '99999999999999999999999999999994+99/workflow.cwl#main'
1205 params["floatInput"]["value"] = 1.234
1206 params["boolInput"]["value"] = True
1208 stubs.api.pipeline_templates().create.assert_called_with(
1209 body=JsonDiffMatcher(expect_template), ensure_unique_name=True)