3 # Implement cwl-runner interface for submitting and running jobs on Arvados.
7 import arvados.collection
8 import arvados.commands.keepdocker
9 import arvados.commands.run
14 from cwltool.draft2tool import revmap_file, remove_hostfs, CommandLineTool
15 from cwltool.errors import WorkflowException
17 import cwltool.workflow
19 from functools import partial
23 import pkg_resources # part of setuptools
27 from cwltool.load_tool import fetch_document
28 from cwltool.builder import Builder
30 from .arvcontainer import ArvadosContainer
31 from .arvjob import ArvadosJob
32 from .arvdocker import arv_docker_get_image
34 from cwltool.process import shortname, get_feature, adjustFiles, adjustFileObjs, scandeps
35 from arvados.api import OrderedJsonModel
37 logger = logging.getLogger('arvados.cwl-runner')
38 logger.setLevel(logging.INFO)
40 class CollectionFsAccess(cwltool.process.StdFsAccess):
41 """Implement the cwltool FsAccess interface for Arvados Collections."""
43 def __init__(self, basedir):
44 super(CollectionFsAccess, self).__init__(basedir)
47 def get_collection(self, path):
49 if p[0].startswith("keep:") and arvados.util.keep_locator_pattern.match(p[0][5:]):
51 if pdh not in self.collections:
52 self.collections[pdh] = arvados.collection.CollectionReader(pdh)
53 return (self.collections[pdh], "/".join(p[1:]))
57 def _match(self, collection, patternsegments, parent):
58 if not patternsegments:
61 if not isinstance(collection, arvados.collection.RichCollectionBase):
65 # iterate over the files and subcollections in 'collection'
66 for filename in collection:
67 if patternsegments[0] == '.':
68 # Pattern contains something like "./foo" so just shift
70 ret.extend(self._match(collection, patternsegments[1:], parent))
71 elif fnmatch.fnmatch(filename, patternsegments[0]):
72 cur = os.path.join(parent, filename)
73 if len(patternsegments) == 1:
76 ret.extend(self._match(collection[filename], patternsegments[1:], cur))
79 def glob(self, pattern):
80 collection, rest = self.get_collection(pattern)
81 patternsegments = rest.split("/")
82 return self._match(collection, patternsegments, "keep:" + collection.manifest_locator())
84 def open(self, fn, mode):
85 collection, rest = self.get_collection(fn)
87 return collection.open(rest, mode)
89 return open(self._abs(fn), mode)
92 collection, rest = self.get_collection(fn)
94 return collection.exists(rest)
96 return os.path.exists(self._abs(fn))
100 class RunnerJob(object):
101 """Submit and manage a Crunch job that runs crunch_scripts/cwl-runner."""
103 def __init__(self, runner, tool, job_order, enable_reuse):
104 self.arvrunner = runner
106 self.job_order = job_order
108 self.enable_reuse = enable_reuse
110 def update_pipeline_component(self, record):
113 def upload_docker(self, tool):
114 if isinstance(tool, CommandLineTool):
115 (docker_req, docker_is_req) = get_feature(tool, "DockerRequirement")
117 arv_docker_get_image(self.arvrunner.api, docker_req, True, self.arvrunner.project_uuid)
118 elif isinstance(tool, cwltool.workflow.Workflow):
120 self.upload_docker(s.embedded_tool)
122 def arvados_job_spec(self, dry_run=False, pull_image=True, **kwargs):
123 """Create an Arvados job specification for this workflow.
125 The returned dict can be used to create a job (i.e., passed as
126 the +body+ argument to jobs().create()), or as a component in
127 a pipeline template or pipeline instance.
129 self.upload_docker(self.tool)
131 workflowfiles = set()
133 workflowfiles.add(self.tool.tool["id"])
135 self.name = os.path.basename(self.tool.tool["id"])
137 def visitFiles(files, path):
141 document_loader, workflowobj, uri = fetch_document(self.tool.tool["id"])
143 return document_loader.fetch(urlparse.urljoin(b, u))
145 sc = scandeps(uri, workflowobj,
146 set(("$import", "run")),
147 set(("$include", "$schemas", "path")),
149 adjustFiles(sc, partial(visitFiles, workflowfiles))
150 adjustFiles(self.job_order, partial(visitFiles, jobfiles))
152 workflowmapper = ArvPathMapper(self.arvrunner, workflowfiles, "",
158 jobmapper = ArvPathMapper(self.arvrunner, jobfiles, "",
161 name=os.path.basename(self.job_order.get("id", "#")),
164 adjustFiles(self.job_order, lambda p: jobmapper.mapper(p)[1])
166 if "id" in self.job_order:
167 del self.job_order["id"]
169 self.job_order["cwl:tool"] = workflowmapper.mapper(self.tool.tool["id"])[1]
171 "script": "cwl-runner",
172 "script_version": "master",
173 "repository": "arvados",
174 "script_parameters": self.job_order,
175 "runtime_constraints": {
176 "docker_image": "arvados/jobs"
180 def run(self, *args, **kwargs):
181 job_spec = self.arvados_job_spec(*args, **kwargs)
182 job_spec.setdefault("owner_uuid", self.arvrunner.project_uuid)
184 response = self.arvrunner.api.jobs().create(
186 find_or_create=self.enable_reuse
187 ).execute(num_retries=self.arvrunner.num_retries)
189 self.uuid = response["uuid"]
190 self.arvrunner.jobs[self.uuid] = self
192 logger.info("Submitted job %s", response["uuid"])
194 if kwargs.get("submit"):
195 self.pipeline = self.arvrunner.api.pipeline_instances().create(
197 "owner_uuid": self.arvrunner.project_uuid,
198 "name": shortname(self.tool.tool["id"]),
199 "components": {"cwl-runner": {"job": {"uuid": self.uuid, "state": response["state"]} } },
200 "state": "RunningOnClient"}).execute(num_retries=self.arvrunner.num_retries)
202 if response["state"] in ("Complete", "Failed", "Cancelled"):
205 def done(self, record):
206 if record["state"] == "Complete":
207 processStatus = "success"
209 processStatus = "permanentFail"
214 outc = arvados.collection.Collection(record["output"])
215 with outc.open("cwl.output.json") as f:
216 outputs = json.load(f)
218 if not path.startswith("keep:"):
219 return "keep:%s/%s" % (record["output"], path)
220 adjustFiles(outputs, keepify)
221 except Exception as e:
222 logger.error("While getting final output object: %s", e)
223 self.arvrunner.output_callback(outputs, processStatus)
225 del self.arvrunner.jobs[record["uuid"]]
228 class RunnerTemplate(object):
229 """An Arvados pipeline template that invokes a CWL workflow."""
231 type_to_dataclass = {
232 'boolean': 'boolean',
239 def __init__(self, runner, tool, job_order, enable_reuse):
242 self.job = RunnerJob(
246 enable_reuse=enable_reuse)
248 def pipeline_component_spec(self):
249 """Return a component that Workbench and a-r-p-i will understand.
251 Specifically, translate CWL input specs to Arvados pipeline
252 format, like {"dataclass":"File","value":"xyz"}.
254 spec = self.job.arvados_job_spec()
256 # Most of the component spec is exactly the same as the job
257 # spec (script, script_version, etc.).
258 # spec['script_parameters'] isn't right, though. A component
259 # spec's script_parameters hash is a translation of
260 # self.tool.tool['inputs'] with defaults/overrides taken from
261 # the job order. So we move the job parameters out of the way
262 # and build a new spec['script_parameters'].
263 job_params = spec['script_parameters']
264 spec['script_parameters'] = {}
266 for param in self.tool.tool['inputs']:
267 param = copy.deepcopy(param)
269 # Data type and "required" flag...
270 types = param['type']
271 if not isinstance(types, list):
273 param['required'] = 'null' not in types
274 non_null_types = set(types) - set(['null'])
275 if len(non_null_types) == 1:
276 the_type = [c for c in non_null_types][0]
277 dataclass = self.type_to_dataclass.get(the_type)
279 param['dataclass'] = dataclass
280 # Note: If we didn't figure out a single appropriate
281 # dataclass, we just left that attribute out. We leave
282 # the "type" attribute there in any case, which might help
285 # Title and description...
286 title = param.pop('label', '')
287 descr = param.pop('description', '').rstrip('\n')
289 param['title'] = title
291 param['description'] = descr
293 # Fill in the value from the current job order, if any.
294 param_id = shortname(param.pop('id'))
295 value = job_params.get(param_id)
298 elif not isinstance(value, dict):
299 param['value'] = value
300 elif param.get('dataclass') == 'File' and value.get('path'):
301 param['value'] = value['path']
303 spec['script_parameters'][param_id] = param
304 spec['script_parameters']['cwl:tool'] = job_params['cwl:tool']
308 job_spec = self.pipeline_component_spec()
309 response = self.runner.api.pipeline_templates().create(body={
311 self.job.name: job_spec,
313 "name": self.job.name,
314 "owner_uuid": self.runner.project_uuid,
315 }, ensure_unique_name=True).execute(num_retries=self.runner.num_retries)
316 self.uuid = response["uuid"]
317 logger.info("Created template %s", self.uuid)
320 class ArvPathMapper(cwltool.pathmapper.PathMapper):
321 """Convert container-local paths to and from Keep collection ids."""
323 def __init__(self, arvrunner, referenced_files, input_basedir,
324 collection_pattern, file_pattern, name=None, **kwargs):
325 self._pathmap = arvrunner.get_uploaded()
328 pdh_path = re.compile(r'^keep:[0-9a-f]{32}\+\d+/.+')
330 for src in referenced_files:
331 if isinstance(src, basestring) and pdh_path.match(src):
332 self._pathmap[src] = (src, collection_pattern % src[5:])
334 src = src[:src.index("#")]
335 if src not in self._pathmap:
336 ab = cwltool.pathmapper.abspath(src, input_basedir)
337 st = arvados.commands.run.statfile("", ab, fnPattern=file_pattern)
338 if kwargs.get("conformance_test"):
339 self._pathmap[src] = (src, ab)
340 elif isinstance(st, arvados.commands.run.UploadFile):
341 uploadfiles.add((src, ab, st))
342 elif isinstance(st, arvados.commands.run.ArvFile):
343 self._pathmap[src] = (ab, st.fn)
345 raise cwltool.workflow.WorkflowException("Input file path '%s' is invalid" % st)
348 arvados.commands.run.uploadfiles([u[2] for u in uploadfiles],
350 dry_run=kwargs.get("dry_run"),
352 fnPattern=file_pattern,
354 project=arvrunner.project_uuid)
356 for src, ab, st in uploadfiles:
357 arvrunner.add_uploaded(src, (ab, st.fn))
358 self._pathmap[src] = (ab, st.fn)
362 def reversemap(self, target):
363 if target.startswith("keep:"):
364 return (target, target)
365 elif self.keepdir and target.startswith(self.keepdir):
366 return (target, "keep:" + target[len(self.keepdir)+1:])
368 return super(ArvPathMapper, self).reversemap(target)
371 class ArvadosCommandTool(CommandLineTool):
372 """Wrap cwltool CommandLineTool to override selected methods."""
374 def __init__(self, arvrunner, toolpath_object, crunch2, **kwargs):
375 super(ArvadosCommandTool, self).__init__(toolpath_object, **kwargs)
376 self.arvrunner = arvrunner
377 self.crunch2 = crunch2
379 def makeJobRunner(self):
381 return ArvadosContainer(self.arvrunner)
383 return ArvadosJob(self.arvrunner)
385 def makePathMapper(self, reffiles, **kwargs):
387 return ArvPathMapper(self.arvrunner, reffiles, kwargs["basedir"],
392 return ArvPathMapper(self.arvrunner, reffiles, kwargs["basedir"],
394 "$(task.keep)/%s/%s",
398 class ArvCwlRunner(object):
399 """Execute a CWL tool or workflow, submit crunch jobs, wait for them to
400 complete, and report output."""
402 def __init__(self, api_client, crunch2):
403 self.api = api_client
405 self.lock = threading.Lock()
406 self.cond = threading.Condition(self.lock)
407 self.final_output = None
411 self.crunch2 = crunch2
413 def arvMakeTool(self, toolpath_object, **kwargs):
414 if "class" in toolpath_object and toolpath_object["class"] == "CommandLineTool":
415 return ArvadosCommandTool(self, toolpath_object, crunch2=self.crunch2, **kwargs)
417 return cwltool.workflow.defaultMakeTool(toolpath_object, **kwargs)
419 def output_callback(self, out, processStatus):
420 if processStatus == "success":
421 logger.info("Overall job status is %s", processStatus)
423 self.api.pipeline_instances().update(uuid=self.pipeline["uuid"],
424 body={"state": "Complete"}).execute(num_retries=self.num_retries)
427 logger.warn("Overall job status is %s", processStatus)
429 self.api.pipeline_instances().update(uuid=self.pipeline["uuid"],
430 body={"state": "Failed"}).execute(num_retries=self.num_retries)
431 self.final_output = out
433 def on_message(self, event):
434 if "object_uuid" in event:
435 if event["object_uuid"] in self.jobs and event["event_type"] == "update":
436 if event["properties"]["new_attributes"]["state"] == "Running" and self.jobs[event["object_uuid"]].running is False:
437 uuid = event["object_uuid"]
440 logger.info("Job %s (%s) is Running", j.name, uuid)
442 j.update_pipeline_component(event["properties"]["new_attributes"])
443 elif event["properties"]["new_attributes"]["state"] in ("Complete", "Failed", "Cancelled"):
444 uuid = event["object_uuid"]
448 logger.info("Job %s (%s) is %s", j.name, uuid, event["properties"]["new_attributes"]["state"])
449 j.done(event["properties"]["new_attributes"])
454 def get_uploaded(self):
455 return self.uploaded.copy()
457 def add_uploaded(self, src, pair):
458 self.uploaded[src] = pair
460 def arvExecutor(self, tool, job_order, **kwargs):
461 self.debug = kwargs.get("debug")
463 if kwargs.get("quiet"):
464 logger.setLevel(logging.WARN)
465 logging.getLogger('arvados.arv-run').setLevel(logging.WARN)
467 useruuid = self.api.users().current().execute()["uuid"]
468 self.project_uuid = kwargs.get("project_uuid") if kwargs.get("project_uuid") else useruuid
471 if kwargs.get("create_template"):
472 tmpl = RunnerTemplate(self, tool, job_order, kwargs.get("enable_reuse"))
474 # cwltool.main will write our return value to stdout.
477 if kwargs.get("submit"):
478 runnerjob = RunnerJob(self, tool, job_order, kwargs.get("enable_reuse"))
480 if not kwargs.get("submit") and "cwl_runner_job" not in kwargs:
481 # Create pipeline for local run
482 self.pipeline = self.api.pipeline_instances().create(
484 "owner_uuid": self.project_uuid,
485 "name": shortname(tool.tool["id"]),
487 "state": "RunningOnClient"}).execute(num_retries=self.num_retries)
488 logger.info("Pipeline instance %s", self.pipeline["uuid"])
490 if kwargs.get("submit") and not kwargs.get("wait"):
492 return runnerjob.uuid
495 events = arvados.events.subscribe(arvados.api('v1'), [["object_uuid", "is_a", "arvados#container"]], self.on_message)
497 events = arvados.events.subscribe(arvados.api('v1'), [["object_uuid", "is_a", "arvados#job"]], self.on_message)
499 self.debug = kwargs.get("debug")
500 self.ignore_docker_for_reuse = kwargs.get("ignore_docker_for_reuse")
501 self.fs_access = CollectionFsAccess(kwargs["basedir"])
503 kwargs["fs_access"] = self.fs_access
504 kwargs["enable_reuse"] = kwargs.get("enable_reuse")
507 kwargs["outdir"] = "/var/spool/cwl"
508 kwargs["tmpdir"] = "/tmp"
510 kwargs["outdir"] = "$(task.outdir)"
511 kwargs["tmpdir"] = "$(task.tmpdir)"
513 if kwargs.get("conformance_test"):
514 return cwltool.main.single_job_executor(tool, job_order, **kwargs)
516 if kwargs.get("submit"):
517 jobiter = iter((runnerjob,))
519 if "cwl_runner_job" in kwargs:
520 self.uuid = kwargs.get("cwl_runner_job").get('uuid')
521 jobiter = tool.job(job_order,
522 self.output_callback,
523 docker_outdir="$(task.outdir)",
528 # Will continue to hold the lock for the duration of this code
529 # except when in cond.wait(), at which point on_message can update
530 # job state and process output callbacks.
532 for runnable in jobiter:
534 runnable.run(**kwargs)
539 logger.error("Workflow is deadlocked, no runnable jobs and not waiting on any pending jobs.")
547 if sys.exc_info()[0] is KeyboardInterrupt:
548 logger.error("Interrupted, marking pipeline as failed")
550 logger.error("Caught unhandled exception, marking pipeline as failed. Error was: %s", sys.exc_info()[0], exc_info=(sys.exc_info()[1] if self.debug else False))
552 self.api.pipeline_instances().update(uuid=self.pipeline["uuid"],
553 body={"state": "Failed"}).execute(num_retries=self.num_retries)
557 if self.final_output is None:
558 raise cwltool.workflow.WorkflowException("Workflow did not return a result.")
560 return self.final_output
563 """Print version string of key packages for provenance and debugging."""
565 arvcwlpkg = pkg_resources.require("arvados-cwl-runner")
566 arvpkg = pkg_resources.require("arvados-python-client")
567 cwlpkg = pkg_resources.require("cwltool")
569 return "%s %s, %s %s, %s %s" % (sys.argv[0], arvcwlpkg[0].version,
570 "arvados-python-client", arvpkg[0].version,
571 "cwltool", cwlpkg[0].version)
573 def arg_parser(): # type: () -> argparse.ArgumentParser
574 parser = argparse.ArgumentParser(description='Arvados executor for Common Workflow Language')
576 parser.add_argument("--conformance-test", action="store_true")
577 parser.add_argument("--basedir", type=str,
578 help="Base directory used to resolve relative references in the input, default to directory of input object file or current directory (if inputs piped/provided on command line).")
579 parser.add_argument("--outdir", type=str, default=os.path.abspath('.'),
580 help="Output directory, default current directory")
582 parser.add_argument("--eval-timeout",
583 help="Time to wait for a Javascript expression to evaluate before giving an error, default 20s.",
586 parser.add_argument("--version", action="store_true", help="Print version and exit")
588 exgroup = parser.add_mutually_exclusive_group()
589 exgroup.add_argument("--verbose", action="store_true", help="Default logging")
590 exgroup.add_argument("--quiet", action="store_true", help="Only print warnings and errors.")
591 exgroup.add_argument("--debug", action="store_true", help="Print even more logging")
593 parser.add_argument("--tool-help", action="store_true", help="Print command line help for tool")
595 exgroup = parser.add_mutually_exclusive_group()
596 exgroup.add_argument("--enable-reuse", action="store_true",
597 default=True, dest="enable_reuse",
599 exgroup.add_argument("--disable-reuse", action="store_false",
600 default=True, dest="enable_reuse",
603 parser.add_argument("--project-uuid", type=str, help="Project that will own the workflow jobs, if not provided, will go to home project.")
604 parser.add_argument("--ignore-docker-for-reuse", action="store_true",
605 help="Ignore Docker image version when deciding whether to reuse past jobs.",
608 exgroup = parser.add_mutually_exclusive_group()
609 exgroup.add_argument("--submit", action="store_true", help="Submit workflow to run on Arvados.",
610 default=True, dest="submit")
611 exgroup.add_argument("--local", action="store_false", help="Run workflow on local host (submits jobs to Arvados).",
612 default=True, dest="submit")
613 exgroup.add_argument("--create-template", action="store_true", help="Create an Arvados pipeline template.")
615 exgroup = parser.add_mutually_exclusive_group()
616 exgroup.add_argument("--wait", action="store_true", help="After submitting workflow runner job, wait for completion.",
617 default=True, dest="wait")
618 exgroup.add_argument("--no-wait", action="store_false", help="Submit workflow runner job and exit.",
619 default=True, dest="wait")
621 exgroup = parser.add_mutually_exclusive_group()
622 exgroup.add_argument("--crunch1", action="store_false",
623 default=False, dest="crunch2",
624 help="Use Crunch v1 Jobs API")
626 exgroup.add_argument("--crunch2", action="store_true",
627 default=False, dest="crunch2",
628 help="Use Crunch v2 Containers API")
630 parser.add_argument("workflow", type=str, nargs="?", default=None)
631 parser.add_argument("job_order", nargs=argparse.REMAINDER)
635 def main(args, stdout, stderr, api_client=None):
636 parser = arg_parser()
638 job_order_object = None
639 arvargs = parser.parse_args(args)
640 if arvargs.create_template and not arvargs.job_order:
641 job_order_object = ({}, "")
644 if api_client is None:
645 api_client=arvados.api('v1', model=OrderedJsonModel())
646 runner = ArvCwlRunner(api_client, crunch2=arvargs.crunch2)
647 except Exception as e:
651 return cwltool.main.main(args=arvargs,
654 executor=runner.arvExecutor,
655 makeTool=runner.arvMakeTool,
656 versionfunc=versionstring,
657 job_order_object=job_order_object)