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 'f57578d5cfda7f70fef00cbc4b621e6b+58/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': 'f57578d5cfda7f70fef00cbc4b621e6b+58/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("time.sleep")
238 def test_submit(self, stubs, tm):
239 capture_stdout = cStringIO.StringIO()
240 exited = arvados_cwl.main(
241 ["--submit", "--no-wait", "--api=jobs", "--debug",
242 "tests/wf/submit_wf.cwl", "tests/submit_test_job.json"],
243 capture_stdout, sys.stderr, api_client=stubs.api)
244 self.assertEqual(exited, 0)
246 stubs.api.collections().create.assert_has_calls([
248 mock.call(body=JsonDiffMatcher({
250 '. 5bcc9fe8f8d5992e6cf418dc7ce4dbb3+16 0:16:blub.txt\n',
252 'name': 'submit_tool.cwl dependencies',
253 }), ensure_unique_name=True),
254 mock.call().execute(),
255 mock.call(body=JsonDiffMatcher({
257 '. 979af1245a12a1fed634d4222473bfdc+16 0:16:blorp.txt\n',
259 'name': 'submit_wf.cwl input',
260 }), ensure_unique_name=True),
261 mock.call().execute()])
263 expect_pipeline = copy.deepcopy(stubs.expect_pipeline_instance)
264 stubs.api.pipeline_instances().create.assert_called_with(
265 body=JsonDiffMatcher(expect_pipeline))
266 self.assertEqual(capture_stdout.getvalue(),
267 stubs.expect_pipeline_uuid + '\n')
270 @mock.patch("time.sleep")
272 def test_submit_no_reuse(self, stubs, tm):
273 capture_stdout = cStringIO.StringIO()
274 exited = arvados_cwl.main(
275 ["--submit", "--no-wait", "--api=jobs", "--debug", "--disable-reuse",
276 "tests/wf/submit_wf.cwl", "tests/submit_test_job.json"],
277 capture_stdout, sys.stderr, api_client=stubs.api)
278 self.assertEqual(exited, 0)
280 expect_pipeline = copy.deepcopy(stubs.expect_pipeline_instance)
281 expect_pipeline["components"]["cwl-runner"]["script_parameters"]["arv:enable_reuse"] = {"value": False}
283 stubs.api.pipeline_instances().create.assert_called_with(
284 body=JsonDiffMatcher(expect_pipeline))
285 self.assertEqual(capture_stdout.getvalue(),
286 stubs.expect_pipeline_uuid + '\n')
288 @mock.patch("time.sleep")
290 def test_submit_on_error(self, stubs, tm):
291 capture_stdout = cStringIO.StringIO()
292 exited = arvados_cwl.main(
293 ["--submit", "--no-wait", "--api=jobs", "--debug", "--on-error=stop",
294 "tests/wf/submit_wf.cwl", "tests/submit_test_job.json"],
295 capture_stdout, sys.stderr, api_client=stubs.api)
296 self.assertEqual(exited, 0)
298 expect_pipeline = copy.deepcopy(stubs.expect_pipeline_instance)
299 expect_pipeline["components"]["cwl-runner"]["script_parameters"]["arv:on_error"] = "stop"
301 stubs.api.pipeline_instances().create.assert_called_with(
302 body=JsonDiffMatcher(expect_pipeline))
303 self.assertEqual(capture_stdout.getvalue(),
304 stubs.expect_pipeline_uuid + '\n')
307 @mock.patch("time.sleep")
309 def test_submit_runner_ram(self, stubs, tm):
310 capture_stdout = cStringIO.StringIO()
311 exited = arvados_cwl.main(
312 ["--submit", "--no-wait", "--debug", "--submit-runner-ram=2048",
313 "tests/wf/submit_wf.cwl", "tests/submit_test_job.json"],
314 capture_stdout, sys.stderr, api_client=stubs.api)
315 self.assertEqual(exited, 0)
317 expect_pipeline = copy.deepcopy(stubs.expect_pipeline_instance)
318 expect_pipeline["components"]["cwl-runner"]["runtime_constraints"]["min_ram_mb_per_node"] = 2048
320 stubs.api.pipeline_instances().create.assert_called_with(
321 body=JsonDiffMatcher(expect_pipeline))
322 self.assertEqual(capture_stdout.getvalue(),
323 stubs.expect_pipeline_uuid + '\n')
326 @mock.patch("time.sleep")
328 def test_submit_invalid_runner_ram(self, stubs, tm):
329 capture_stdout = cStringIO.StringIO()
330 exited = arvados_cwl.main(
331 ["--submit", "--no-wait", "--debug", "--submit-runner-ram=-2048",
332 "tests/wf/submit_wf.cwl", "tests/submit_test_job.json"],
333 capture_stdout, sys.stderr, api_client=stubs.api)
334 self.assertEqual(exited, 1)
336 @mock.patch("time.sleep")
338 def test_submit_output_name(self, stubs, tm):
339 output_name = "test_output_name"
341 capture_stdout = cStringIO.StringIO()
342 exited = arvados_cwl.main(
343 ["--submit", "--no-wait", "--debug", "--output-name", output_name,
344 "tests/wf/submit_wf.cwl", "tests/submit_test_job.json"],
345 capture_stdout, sys.stderr, api_client=stubs.api)
346 self.assertEqual(exited, 0)
348 expect_pipeline = copy.deepcopy(stubs.expect_pipeline_instance)
349 expect_pipeline["components"]["cwl-runner"]["script_parameters"]["arv:output_name"] = output_name
351 stubs.api.pipeline_instances().create.assert_called_with(
352 body=JsonDiffMatcher(expect_pipeline))
353 self.assertEqual(capture_stdout.getvalue(),
354 stubs.expect_pipeline_uuid + '\n')
357 @mock.patch("time.sleep")
359 def test_submit_pipeline_name(self, stubs, tm):
360 capture_stdout = cStringIO.StringIO()
361 exited = arvados_cwl.main(
362 ["--submit", "--no-wait", "--debug", "--name=hello job 123",
363 "tests/wf/submit_wf.cwl", "tests/submit_test_job.json"],
364 capture_stdout, sys.stderr, api_client=stubs.api)
365 self.assertEqual(exited, 0)
367 expect_pipeline = copy.deepcopy(stubs.expect_pipeline_instance)
368 expect_pipeline["name"] = "hello job 123"
370 stubs.api.pipeline_instances().create.assert_called_with(
371 body=expect_pipeline)
372 self.assertEqual(capture_stdout.getvalue(),
373 stubs.expect_pipeline_uuid + '\n')
375 @mock.patch("time.sleep")
377 def test_submit_output_tags(self, stubs, tm):
378 output_tags = "tag0,tag1,tag2"
380 capture_stdout = cStringIO.StringIO()
381 exited = arvados_cwl.main(
382 ["--submit", "--no-wait", "--debug", "--output-tags", output_tags,
383 "tests/wf/submit_wf.cwl", "tests/submit_test_job.json"],
384 capture_stdout, sys.stderr, api_client=stubs.api)
385 self.assertEqual(exited, 0)
387 expect_pipeline = copy.deepcopy(stubs.expect_pipeline_instance)
388 expect_pipeline["components"]["cwl-runner"]["script_parameters"]["arv:output_tags"] = output_tags
390 stubs.api.pipeline_instances().create.assert_called_with(
391 body=JsonDiffMatcher(expect_pipeline))
392 self.assertEqual(capture_stdout.getvalue(),
393 stubs.expect_pipeline_uuid + '\n')
395 @mock.patch("time.sleep")
397 def test_submit_with_project_uuid(self, stubs, tm):
398 project_uuid = 'zzzzz-j7d0g-zzzzzzzzzzzzzzz'
400 exited = arvados_cwl.main(
401 ["--submit", "--no-wait",
402 "--project-uuid", project_uuid,
403 "tests/wf/submit_wf.cwl", "tests/submit_test_job.json"],
404 sys.stdout, sys.stderr, api_client=stubs.api)
405 self.assertEqual(exited, 0)
407 expect_pipeline = copy.deepcopy(stubs.expect_pipeline_instance)
408 expect_pipeline["owner_uuid"] = project_uuid
409 stubs.api.pipeline_instances().create.assert_called_with(
410 body=JsonDiffMatcher(expect_pipeline))
413 def test_submit_container(self, stubs):
414 capture_stdout = cStringIO.StringIO()
416 exited = arvados_cwl.main(
417 ["--submit", "--no-wait", "--api=containers", "--debug",
418 "tests/wf/submit_wf.cwl", "tests/submit_test_job.json"],
419 capture_stdout, sys.stderr, api_client=stubs.api, keep_client=stubs.keep_client)
420 self.assertEqual(exited, 0)
422 logging.exception("")
424 stubs.api.collections().create.assert_has_calls([
426 mock.call(body=JsonDiffMatcher({
428 '. 5bcc9fe8f8d5992e6cf418dc7ce4dbb3+16 0:16:blub.txt\n',
430 'name': 'submit_tool.cwl dependencies',
431 }), ensure_unique_name=True),
432 mock.call().execute(),
433 mock.call(body=JsonDiffMatcher({
435 '. 979af1245a12a1fed634d4222473bfdc+16 0:16:blorp.txt\n',
437 'name': 'submit_wf.cwl input',
438 }), ensure_unique_name=True),
439 mock.call().execute()])
441 expect_container = copy.deepcopy(stubs.expect_container_spec)
442 stubs.api.container_requests().create.assert_called_with(
443 body=JsonDiffMatcher(expect_container))
444 self.assertEqual(capture_stdout.getvalue(),
445 stubs.expect_container_request_uuid + '\n')
448 def test_submit_container_no_reuse(self, stubs):
449 capture_stdout = cStringIO.StringIO()
451 exited = arvados_cwl.main(
452 ["--submit", "--no-wait", "--api=containers", "--debug", "--disable-reuse",
453 "tests/wf/submit_wf.cwl", "tests/submit_test_job.json"],
454 capture_stdout, sys.stderr, api_client=stubs.api, keep_client=stubs.keep_client)
455 self.assertEqual(exited, 0)
457 logging.exception("")
459 expect_container = copy.deepcopy(stubs.expect_container_spec)
460 expect_container["command"] = ['arvados-cwl-runner', '--local', '--api=containers', '--no-log-timestamps',
461 '--disable-reuse', '--on-error=continue',
462 '/var/lib/cwl/workflow.json#main', '/var/lib/cwl/cwl.input.json']
464 stubs.api.container_requests().create.assert_called_with(
465 body=JsonDiffMatcher(expect_container))
466 self.assertEqual(capture_stdout.getvalue(),
467 stubs.expect_container_request_uuid + '\n')
471 def test_submit_container_on_error(self, stubs):
472 capture_stdout = cStringIO.StringIO()
474 exited = arvados_cwl.main(
475 ["--submit", "--no-wait", "--api=containers", "--debug", "--on-error=stop",
476 "tests/wf/submit_wf.cwl", "tests/submit_test_job.json"],
477 capture_stdout, sys.stderr, api_client=stubs.api, keep_client=stubs.keep_client)
478 self.assertEqual(exited, 0)
480 logging.exception("")
482 expect_container = copy.deepcopy(stubs.expect_container_spec)
483 expect_container["command"] = ['arvados-cwl-runner', '--local', '--api=containers', '--no-log-timestamps',
484 '--enable-reuse', '--on-error=stop',
485 '/var/lib/cwl/workflow.json#main', '/var/lib/cwl/cwl.input.json']
487 stubs.api.container_requests().create.assert_called_with(
488 body=JsonDiffMatcher(expect_container))
489 self.assertEqual(capture_stdout.getvalue(),
490 stubs.expect_container_request_uuid + '\n')
493 def test_submit_container_output_name(self, stubs):
494 output_name = "test_output_name"
496 capture_stdout = cStringIO.StringIO()
498 exited = arvados_cwl.main(
499 ["--submit", "--no-wait", "--api=containers", "--debug", "--output-name", output_name,
500 "tests/wf/submit_wf.cwl", "tests/submit_test_job.json"],
501 capture_stdout, sys.stderr, api_client=stubs.api, keep_client=stubs.keep_client)
502 self.assertEqual(exited, 0)
504 logging.exception("")
506 expect_container = copy.deepcopy(stubs.expect_container_spec)
507 expect_container["command"] = ['arvados-cwl-runner', '--local', '--api=containers', '--no-log-timestamps',
508 "--output-name="+output_name, '--enable-reuse', '--on-error=continue',
509 '/var/lib/cwl/workflow.json#main', '/var/lib/cwl/cwl.input.json']
510 expect_container["output_name"] = output_name
512 stubs.api.container_requests().create.assert_called_with(
513 body=JsonDiffMatcher(expect_container))
514 self.assertEqual(capture_stdout.getvalue(),
515 stubs.expect_container_request_uuid + '\n')
518 def test_submit_container_output_tags(self, stubs):
519 output_tags = "tag0,tag1,tag2"
521 capture_stdout = cStringIO.StringIO()
523 exited = arvados_cwl.main(
524 ["--submit", "--no-wait", "--api=containers", "--debug", "--output-tags", output_tags,
525 "tests/wf/submit_wf.cwl", "tests/submit_test_job.json"],
526 capture_stdout, sys.stderr, api_client=stubs.api, keep_client=stubs.keep_client)
527 self.assertEqual(exited, 0)
529 logging.exception("")
531 expect_container = copy.deepcopy(stubs.expect_container_spec)
532 expect_container["command"] = ['arvados-cwl-runner', '--local', '--api=containers', '--no-log-timestamps',
533 "--output-tags="+output_tags, '--enable-reuse', '--on-error=continue',
534 '/var/lib/cwl/workflow.json#main', '/var/lib/cwl/cwl.input.json']
536 stubs.api.container_requests().create.assert_called_with(
537 body=JsonDiffMatcher(expect_container))
538 self.assertEqual(capture_stdout.getvalue(),
539 stubs.expect_container_request_uuid + '\n')
542 def test_submit_container_runner_ram(self, stubs):
543 capture_stdout = cStringIO.StringIO()
545 exited = arvados_cwl.main(
546 ["--submit", "--no-wait", "--api=containers", "--debug", "--submit-runner-ram=2048",
547 "tests/wf/submit_wf.cwl", "tests/submit_test_job.json"],
548 capture_stdout, sys.stderr, api_client=stubs.api, keep_client=stubs.keep_client)
549 self.assertEqual(exited, 0)
551 logging.exception("")
553 expect_container = copy.deepcopy(stubs.expect_container_spec)
554 expect_container["runtime_constraints"]["ram"] = 2048*1024*1024
556 stubs.api.container_requests().create.assert_called_with(
557 body=JsonDiffMatcher(expect_container))
558 self.assertEqual(capture_stdout.getvalue(),
559 stubs.expect_container_request_uuid + '\n')
561 @mock.patch("arvados.collection.CollectionReader")
562 @mock.patch("time.sleep")
564 def test_submit_file_keepref(self, stubs, tm, collectionReader):
565 capture_stdout = cStringIO.StringIO()
566 exited = arvados_cwl.main(
567 ["--submit", "--no-wait", "--api=containers", "--debug",
568 "tests/wf/submit_keepref_wf.cwl"],
569 capture_stdout, sys.stderr, api_client=stubs.api)
570 self.assertEqual(exited, 0)
573 @mock.patch("arvados.collection.CollectionReader")
574 @mock.patch("time.sleep")
576 def test_submit_keepref(self, stubs, tm, reader):
577 capture_stdout = cStringIO.StringIO()
579 with open("tests/wf/expect_arvworkflow.cwl") as f:
580 reader().open().__enter__().read.return_value = f.read()
582 exited = arvados_cwl.main(
583 ["--submit", "--no-wait", "--api=containers", "--debug",
584 "keep:99999999999999999999999999999994+99/expect_arvworkflow.cwl#main", "-x", "XxX"],
585 capture_stdout, sys.stderr, api_client=stubs.api)
586 self.assertEqual(exited, 0)
596 'path': '/var/spool/cwl/cwl.output.json',
599 '/var/lib/cwl/workflow': {
600 'portable_data_hash': '99999999999999999999999999999994+99',
603 '/var/lib/cwl/cwl.input.json': {
609 }, 'state': 'Committed',
611 'output_path': '/var/spool/cwl',
612 'name': 'expect_arvworkflow.cwl#main',
613 'container_image': 'arvados/jobs:'+arvados_cwl.__version__,
614 'command': ['arvados-cwl-runner', '--local', '--api=containers', '--no-log-timestamps',
615 '--enable-reuse', '--on-error=continue',
616 '/var/lib/cwl/workflow/expect_arvworkflow.cwl#main', '/var/lib/cwl/cwl.input.json'],
617 'cwd': '/var/spool/cwl',
618 'runtime_constraints': {
626 stubs.api.container_requests().create.assert_called_with(
627 body=JsonDiffMatcher(expect_container))
628 self.assertEqual(capture_stdout.getvalue(),
629 stubs.expect_container_request_uuid + '\n')
632 @mock.patch("arvados.collection.CollectionReader")
633 @mock.patch("time.sleep")
635 def test_submit_jobs_keepref(self, stubs, tm, reader):
636 capture_stdout = cStringIO.StringIO()
638 with open("tests/wf/expect_arvworkflow.cwl") as f:
639 reader().open().__enter__().read.return_value = f.read()
641 exited = arvados_cwl.main(
642 ["--submit", "--no-wait", "--api=jobs", "--debug",
643 "keep:99999999999999999999999999999994+99/expect_arvworkflow.cwl#main", "-x", "XxX"],
644 capture_stdout, sys.stderr, api_client=stubs.api)
645 self.assertEqual(exited, 0)
647 expect_pipeline = copy.deepcopy(stubs.expect_pipeline_instance)
648 expect_pipeline["components"]["cwl-runner"]["script_parameters"]["x"] = "XxX"
649 del expect_pipeline["components"]["cwl-runner"]["script_parameters"]["y"]
650 del expect_pipeline["components"]["cwl-runner"]["script_parameters"]["z"]
651 expect_pipeline["components"]["cwl-runner"]["script_parameters"]["cwl:tool"] = "99999999999999999999999999999994+99/expect_arvworkflow.cwl#main"
652 expect_pipeline["name"] = "expect_arvworkflow.cwl#main"
653 stubs.api.pipeline_instances().create.assert_called_with(
654 body=JsonDiffMatcher(expect_pipeline))
656 @mock.patch("time.sleep")
658 def test_submit_arvworkflow(self, stubs, tm):
659 capture_stdout = cStringIO.StringIO()
661 with open("tests/wf/expect_arvworkflow.cwl") as f:
662 stubs.api.workflows().get().execute.return_value = {"definition": f.read(), "name": "a test workflow"}
664 exited = arvados_cwl.main(
665 ["--submit", "--no-wait", "--api=containers", "--debug",
666 "962eh-7fd4e-gkbzl62qqtfig37", "-x", "XxX"],
667 capture_stdout, sys.stderr, api_client=stubs.api)
668 self.assertEqual(exited, 0)
678 'path': '/var/spool/cwl/cwl.output.json',
681 '/var/lib/cwl/workflow.json': {
684 'cwlVersion': 'v1.0',
689 {'type': 'string', 'id': '#main/x'}
692 {'in': [{'source': '#main/x', 'id': '#main/step1/x'}],
693 'run': '#submit_tool.cwl',
703 'inputBinding': {'position': 1},
705 'id': '#submit_tool.cwl/x'}
708 {'dockerPull': 'debian:8', 'class': 'DockerRequirement'}
710 'id': '#submit_tool.cwl',
712 'baseCommand': 'cat',
713 'class': 'CommandLineTool'
718 '/var/lib/cwl/cwl.input.json': {
724 }, 'state': 'Committed',
726 'output_path': '/var/spool/cwl',
727 'name': 'a test workflow',
728 'container_image': 'arvados/jobs:'+arvados_cwl.__version__,
729 'command': ['arvados-cwl-runner', '--local', '--api=containers', '--no-log-timestamps',
730 '--enable-reuse', '--on-error=continue',
731 '/var/lib/cwl/workflow.json#main', '/var/lib/cwl/cwl.input.json'],
732 'cwd': '/var/spool/cwl',
733 'runtime_constraints': {
739 "template_uuid": "962eh-7fd4e-gkbzl62qqtfig37"
743 stubs.api.container_requests().create.assert_called_with(
744 body=JsonDiffMatcher(expect_container))
745 self.assertEqual(capture_stdout.getvalue(),
746 stubs.expect_container_request_uuid + '\n')
750 def test_submit_container_name(self, stubs):
751 capture_stdout = cStringIO.StringIO()
753 exited = arvados_cwl.main(
754 ["--submit", "--no-wait", "--api=containers", "--debug", "--name=hello container 123",
755 "tests/wf/submit_wf.cwl", "tests/submit_test_job.json"],
756 capture_stdout, sys.stderr, api_client=stubs.api, keep_client=stubs.keep_client)
757 self.assertEqual(exited, 0)
759 logging.exception("")
761 expect_container = copy.deepcopy(stubs.expect_container_spec)
762 expect_container["name"] = "hello container 123"
764 stubs.api.container_requests().create.assert_called_with(
765 body=JsonDiffMatcher(expect_container))
766 self.assertEqual(capture_stdout.getvalue(),
767 stubs.expect_container_request_uuid + '\n')
771 def test_submit_job_runner_image(self, stubs):
772 capture_stdout = cStringIO.StringIO()
774 exited = arvados_cwl.main(
775 ["--submit", "--no-wait", "--api=jobs", "--debug", "--submit-runner-image=arvados/jobs:123",
776 "tests/wf/submit_wf.cwl", "tests/submit_test_job.json"],
777 capture_stdout, sys.stderr, api_client=stubs.api, keep_client=stubs.keep_client)
778 self.assertEqual(exited, 0)
780 logging.exception("")
782 stubs.expect_pipeline_instance["components"]["cwl-runner"]["runtime_constraints"]["docker_image"] = "arvados/jobs:123"
784 expect_pipeline = copy.deepcopy(stubs.expect_pipeline_instance)
785 stubs.api.pipeline_instances().create.assert_called_with(
786 body=JsonDiffMatcher(expect_pipeline))
787 self.assertEqual(capture_stdout.getvalue(),
788 stubs.expect_pipeline_uuid + '\n')
791 def test_submit_container_runner_image(self, stubs):
792 capture_stdout = cStringIO.StringIO()
794 exited = arvados_cwl.main(
795 ["--submit", "--no-wait", "--api=containers", "--debug", "--submit-runner-image=arvados/jobs:123",
796 "tests/wf/submit_wf.cwl", "tests/submit_test_job.json"],
797 capture_stdout, sys.stderr, api_client=stubs.api, keep_client=stubs.keep_client)
798 self.assertEqual(exited, 0)
800 logging.exception("")
802 stubs.expect_container_spec["container_image"] = "arvados/jobs:123"
804 expect_container = copy.deepcopy(stubs.expect_container_spec)
805 stubs.api.container_requests().create.assert_called_with(
806 body=JsonDiffMatcher(expect_container))
807 self.assertEqual(capture_stdout.getvalue(),
808 stubs.expect_container_request_uuid + '\n')
811 @mock.patch("arvados.commands.keepdocker.find_one_image_hash")
812 @mock.patch("cwltool.docker.get_image")
813 @mock.patch("arvados.api")
814 def test_arvados_jobs_image(self, api, get_image, find_one_image_hash):
815 arvrunner = mock.MagicMock()
816 arvrunner.project_uuid = ""
817 api.return_value = mock.MagicMock()
818 arvrunner.api = api.return_value
819 arvrunner.api.links().list().execute.side_effect = ({"items": [], "items_available": 0, "offset": 0},
820 {"items": [], "items_available": 0, "offset": 0},
821 {"items": [], "items_available": 0, "offset": 0},
822 {"items": [{"created_at": "",
824 "link_class": "docker_image_hash",
827 "properties": {"image_timestamp": ""}}], "items_available": 1, "offset": 0},
828 {"items": [], "items_available": 0, "offset": 0},
829 {"items": [{"created_at": "",
831 "link_class": "docker_image_repo+tag",
832 "name": "arvados/jobs:"+arvados_cwl.__version__,
834 "properties": {"image_timestamp": ""}}], "items_available": 1, "offset": 0},
835 {"items": [{"created_at": "",
837 "link_class": "docker_image_hash",
840 "properties": {"image_timestamp": ""}}], "items_available": 1, "offset": 0} ,
842 find_one_image_hash.return_value = "123456"
844 arvrunner.api.collections().list().execute.side_effect = ({"items": [], "items_available": 0, "offset": 0},
845 {"items": [{"uuid": "",
849 }], "items_available": 1, "offset": 0},
850 {"items": [{"uuid": ""}], "items_available": 1, "offset": 0})
851 arvrunner.api.collections().create().execute.return_value = {"uuid": ""}
852 self.assertEqual("arvados/jobs:"+arvados_cwl.__version__, arvados_cwl.runner.arvados_jobs_image(arvrunner, "arvados/jobs:"+arvados_cwl.__version__))
854 class TestCreateTemplate(unittest.TestCase):
855 existing_template_uuid = "zzzzz-d1hrv-validworkfloyml"
857 def _adjust_script_params(self, expect_component):
858 expect_component['script_parameters']['x'] = {
862 'value': '99999999999999999999999999999992+99/blorp.txt',
864 expect_component['script_parameters']['y'] = {
865 'dataclass': 'Collection',
868 'value': '99999999999999999999999999999998+99',
870 expect_component['script_parameters']['z'] = {
871 'dataclass': 'Collection',
877 def test_create(self, stubs):
878 project_uuid = 'zzzzz-j7d0g-zzzzzzzzzzzzzzz'
880 capture_stdout = cStringIO.StringIO()
882 exited = arvados_cwl.main(
883 ["--create-workflow", "--debug",
885 "--project-uuid", project_uuid,
886 "tests/wf/submit_wf.cwl", "tests/submit_test_job.json"],
887 capture_stdout, sys.stderr, api_client=stubs.api)
888 self.assertEqual(exited, 0)
890 stubs.api.pipeline_instances().create.refute_called()
891 stubs.api.jobs().create.refute_called()
893 expect_component = copy.deepcopy(stubs.expect_job_spec)
894 self._adjust_script_params(expect_component)
897 "submit_wf.cwl": expect_component,
899 "name": "submit_wf.cwl",
900 "owner_uuid": project_uuid,
902 stubs.api.pipeline_templates().create.assert_called_with(
903 body=JsonDiffMatcher(expect_template), ensure_unique_name=True)
905 self.assertEqual(capture_stdout.getvalue(),
906 stubs.expect_pipeline_template_uuid + '\n')
910 def test_create_name(self, stubs):
911 project_uuid = 'zzzzz-j7d0g-zzzzzzzzzzzzzzz'
913 capture_stdout = cStringIO.StringIO()
915 exited = arvados_cwl.main(
916 ["--create-workflow", "--debug",
917 "--project-uuid", project_uuid,
919 "--name", "testing 123",
920 "tests/wf/submit_wf.cwl", "tests/submit_test_job.json"],
921 capture_stdout, sys.stderr, api_client=stubs.api)
922 self.assertEqual(exited, 0)
924 stubs.api.pipeline_instances().create.refute_called()
925 stubs.api.jobs().create.refute_called()
927 expect_component = copy.deepcopy(stubs.expect_job_spec)
928 self._adjust_script_params(expect_component)
931 "testing 123": expect_component,
933 "name": "testing 123",
934 "owner_uuid": project_uuid,
936 stubs.api.pipeline_templates().create.assert_called_with(
937 body=JsonDiffMatcher(expect_template), ensure_unique_name=True)
939 self.assertEqual(capture_stdout.getvalue(),
940 stubs.expect_pipeline_template_uuid + '\n')
944 def test_update_name(self, stubs):
945 project_uuid = 'zzzzz-j7d0g-zzzzzzzzzzzzzzz'
947 capture_stdout = cStringIO.StringIO()
949 exited = arvados_cwl.main(
950 ["--update-workflow", self.existing_template_uuid,
952 "--project-uuid", project_uuid,
954 "--name", "testing 123",
955 "tests/wf/submit_wf.cwl", "tests/submit_test_job.json"],
956 capture_stdout, sys.stderr, api_client=stubs.api)
957 self.assertEqual(exited, 0)
959 stubs.api.pipeline_instances().create.refute_called()
960 stubs.api.jobs().create.refute_called()
962 expect_component = copy.deepcopy(stubs.expect_job_spec)
963 self._adjust_script_params(expect_component)
966 "testing 123": expect_component,
968 "name": "testing 123",
969 "owner_uuid": project_uuid,
971 stubs.api.pipeline_templates().create.refute_called()
972 stubs.api.pipeline_templates().update.assert_called_with(
973 body=JsonDiffMatcher(expect_template), uuid=self.existing_template_uuid)
975 self.assertEqual(capture_stdout.getvalue(),
976 self.existing_template_uuid + '\n')
979 class TestCreateWorkflow(unittest.TestCase):
980 existing_workflow_uuid = "zzzzz-7fd4e-validworkfloyml"
981 expect_workflow = open("tests/wf/expect_packed.cwl").read()
984 def test_create(self, stubs):
985 project_uuid = 'zzzzz-j7d0g-zzzzzzzzzzzzzzz'
987 capture_stdout = cStringIO.StringIO()
989 exited = arvados_cwl.main(
990 ["--create-workflow", "--debug",
992 "--project-uuid", project_uuid,
993 "tests/wf/submit_wf.cwl", "tests/submit_test_job.json"],
994 capture_stdout, sys.stderr, api_client=stubs.api)
995 self.assertEqual(exited, 0)
997 stubs.api.pipeline_templates().create.refute_called()
998 stubs.api.container_requests().create.refute_called()
1002 "owner_uuid": project_uuid,
1003 "name": "submit_wf.cwl",
1005 "definition": self.expect_workflow,
1008 stubs.api.workflows().create.assert_called_with(
1009 body=JsonDiffMatcher(body))
1011 self.assertEqual(capture_stdout.getvalue(),
1012 stubs.expect_workflow_uuid + '\n')
1016 def test_create_name(self, stubs):
1017 project_uuid = 'zzzzz-j7d0g-zzzzzzzzzzzzzzz'
1019 capture_stdout = cStringIO.StringIO()
1021 exited = arvados_cwl.main(
1022 ["--create-workflow", "--debug",
1024 "--project-uuid", project_uuid,
1025 "--name", "testing 123",
1026 "tests/wf/submit_wf.cwl", "tests/submit_test_job.json"],
1027 capture_stdout, sys.stderr, api_client=stubs.api)
1028 self.assertEqual(exited, 0)
1030 stubs.api.pipeline_templates().create.refute_called()
1031 stubs.api.container_requests().create.refute_called()
1035 "owner_uuid": project_uuid,
1036 "name": "testing 123",
1038 "definition": self.expect_workflow,
1041 stubs.api.workflows().create.assert_called_with(
1042 body=JsonDiffMatcher(body))
1044 self.assertEqual(capture_stdout.getvalue(),
1045 stubs.expect_workflow_uuid + '\n')
1048 def test_incompatible_api(self, stubs):
1049 capture_stderr = cStringIO.StringIO()
1050 logging.getLogger('arvados.cwl-runner').addHandler(
1051 logging.StreamHandler(capture_stderr))
1053 exited = arvados_cwl.main(
1054 ["--update-workflow", self.existing_workflow_uuid,
1057 "tests/wf/submit_wf.cwl", "tests/submit_test_job.json"],
1058 sys.stderr, sys.stderr, api_client=stubs.api)
1059 self.assertEqual(exited, 1)
1060 self.assertRegexpMatches(
1061 capture_stderr.getvalue(),
1062 "--update-workflow arg '{}' uses 'containers' API, but --api='jobs' specified".format(self.existing_workflow_uuid))
1065 def test_update(self, stubs):
1066 capture_stdout = cStringIO.StringIO()
1068 exited = arvados_cwl.main(
1069 ["--update-workflow", self.existing_workflow_uuid,
1071 "tests/wf/submit_wf.cwl", "tests/submit_test_job.json"],
1072 capture_stdout, sys.stderr, api_client=stubs.api)
1073 self.assertEqual(exited, 0)
1077 "name": "submit_wf.cwl",
1079 "definition": self.expect_workflow,
1082 stubs.api.workflows().update.assert_called_with(
1083 uuid=self.existing_workflow_uuid,
1084 body=JsonDiffMatcher(body))
1085 self.assertEqual(capture_stdout.getvalue(),
1086 self.existing_workflow_uuid + '\n')
1090 def test_update_name(self, stubs):
1091 capture_stdout = cStringIO.StringIO()
1093 exited = arvados_cwl.main(
1094 ["--update-workflow", self.existing_workflow_uuid,
1095 "--debug", "--name", "testing 123",
1096 "tests/wf/submit_wf.cwl", "tests/submit_test_job.json"],
1097 capture_stdout, sys.stderr, api_client=stubs.api)
1098 self.assertEqual(exited, 0)
1102 "name": "testing 123",
1104 "definition": self.expect_workflow,
1107 stubs.api.workflows().update.assert_called_with(
1108 uuid=self.existing_workflow_uuid,
1109 body=JsonDiffMatcher(body))
1110 self.assertEqual(capture_stdout.getvalue(),
1111 self.existing_workflow_uuid + '\n')
1114 class TestTemplateInputs(unittest.TestCase):
1117 "inputs_test.cwl": {
1118 'runtime_constraints': {
1119 'docker_image': 'arvados/jobs:'+arvados_cwl.__version__,
1120 'min_ram_mb_per_node': 1024
1122 'script_parameters': {
1124 '5800682d508698dc9ce6d2fc618f21d8+58/workflow.cwl#main',
1125 'optionalFloatInput': None,
1128 'dataclass': 'File',
1130 'title': "It's a file; we expect to find some characters in it.",
1131 'description': 'If there were anything further to say, it would be said here,\nor here.'
1135 'dataclass': 'number',
1137 'title': 'Floats like a duck',
1141 'optionalFloatInput': {
1142 'type': ['null', 'float'],
1143 'dataclass': 'number',
1148 'dataclass': 'boolean',
1150 'title': 'True or false?',
1153 'repository': 'arvados',
1154 'script_version': 'master',
1155 'minimum_script_version': '570509ab4d2ef93d870fd2b1f2eab178afb1bad9',
1156 'script': 'cwl-runner',
1159 "name": "inputs_test.cwl",
1163 def test_inputs_empty(self, stubs):
1164 exited = arvados_cwl.main(
1165 ["--create-template",
1166 "tests/wf/inputs_test.cwl", "tests/order/empty_order.json"],
1167 cStringIO.StringIO(), sys.stderr, api_client=stubs.api)
1168 self.assertEqual(exited, 0)
1170 stubs.api.pipeline_templates().create.assert_called_with(
1171 body=JsonDiffMatcher(self.expect_template), ensure_unique_name=True)
1174 def test_inputs(self, stubs):
1175 exited = arvados_cwl.main(
1176 ["--create-template",
1177 "tests/wf/inputs_test.cwl", "tests/order/inputs_test_order.json"],
1178 cStringIO.StringIO(), sys.stderr, api_client=stubs.api)
1179 self.assertEqual(exited, 0)
1181 expect_template = copy.deepcopy(self.expect_template)
1182 params = expect_template[
1183 "components"]["inputs_test.cwl"]["script_parameters"]
1184 params["fileInput"]["value"] = '99999999999999999999999999999992+99/blorp.txt'
1185 params["floatInput"]["value"] = 1.234
1186 params["boolInput"]["value"] = True
1188 stubs.api.pipeline_templates().create.assert_called_with(
1189 body=JsonDiffMatcher(expect_template), ensure_unique_name=True)