3 # Implement cwl-runner interface for submitting and running jobs on Arvados.
8 import arvados.commands.keepdocker
9 import arvados.commands.run
10 import arvados.collection
12 import cwltool.draft2tool
13 import cwltool.workflow
15 from cwltool.process import shortname
16 from cwltool.errors import WorkflowException
26 import pkg_resources # part of setuptools
28 from cwltool.process import get_feature, adjustFiles, scandeps
29 from arvados.api import OrderedJsonModel
31 logger = logging.getLogger('arvados.cwl-runner')
32 logger.setLevel(logging.INFO)
34 tmpdirre = re.compile(r"^\S+ \S+ \d+ \d+ stderr \S+ \S+ crunchrunner: \$\(task\.tmpdir\)=(.*)")
35 outdirre = re.compile(r"^\S+ \S+ \d+ \d+ stderr \S+ \S+ crunchrunner: \$\(task\.outdir\)=(.*)")
36 keepre = re.compile(r"^\S+ \S+ \d+ \d+ stderr \S+ \S+ crunchrunner: \$\(task\.keep\)=(.*)")
39 def arv_docker_get_image(api_client, dockerRequirement, pull_image, project_uuid):
40 """Check if a Docker image is available in Keep, if not, upload it using arv-keepdocker."""
42 if "dockerImageId" not in dockerRequirement and "dockerPull" in dockerRequirement:
43 dockerRequirement["dockerImageId"] = dockerRequirement["dockerPull"]
45 sp = dockerRequirement["dockerImageId"].split(":")
47 image_tag = sp[1] if len(sp) > 1 else None
49 images = arvados.commands.keepdocker.list_images_in_arv(api_client, 3,
50 image_name=image_name,
54 imageId = cwltool.docker.get_image(dockerRequirement, pull_image)
55 args = ["--project-uuid="+project_uuid, image_name]
57 args.append(image_tag)
58 logger.info("Uploading Docker image %s", ":".join(args[1:]))
59 arvados.commands.keepdocker.main(args, stdout=sys.stderr)
61 return dockerRequirement["dockerImageId"]
64 class CollectionFsAccess(cwltool.process.StdFsAccess):
65 """Implement the cwltool FsAccess interface for Arvados Collections."""
67 def __init__(self, basedir):
69 self.basedir = basedir
71 def get_collection(self, path):
73 if p[0].startswith("keep:") and arvados.util.keep_locator_pattern.match(p[0][5:]):
75 if pdh not in self.collections:
76 self.collections[pdh] = arvados.collection.CollectionReader(pdh)
77 return (self.collections[pdh], "/".join(p[1:]))
81 def _match(self, collection, patternsegments, parent):
82 if not patternsegments:
85 if not isinstance(collection, arvados.collection.RichCollectionBase):
89 # iterate over the files and subcollections in 'collection'
90 for filename in collection:
91 if patternsegments[0] == '.':
92 # Pattern contains something like "./foo" so just shift
94 ret.extend(self._match(collection, patternsegments[1:], parent))
95 elif fnmatch.fnmatch(filename, patternsegments[0]):
96 cur = os.path.join(parent, filename)
97 if len(patternsegments) == 1:
100 ret.extend(self._match(collection[filename], patternsegments[1:], cur))
103 def glob(self, pattern):
104 collection, rest = self.get_collection(pattern)
105 patternsegments = rest.split("/")
106 return self._match(collection, patternsegments, "keep:" + collection.manifest_locator())
108 def open(self, fn, mode):
109 collection, rest = self.get_collection(fn)
111 return collection.open(rest, mode)
113 return open(self._abs(fn), mode)
115 def exists(self, fn):
116 collection, rest = self.get_collection(fn)
118 return collection.exists(rest)
120 return os.path.exists(self._abs(fn))
122 class ArvadosJob(object):
123 """Submit and manage a Crunch job for executing a CWL CommandLineTool."""
125 def __init__(self, runner):
126 self.arvrunner = runner
129 def run(self, dry_run=False, pull_image=True, **kwargs):
130 script_parameters = {
131 "command": self.command_line
133 runtime_constraints = {}
135 if self.generatefiles:
136 vwd = arvados.collection.Collection()
137 script_parameters["task.vwd"] = {}
138 for t in self.generatefiles:
139 if isinstance(self.generatefiles[t], dict):
140 src, rest = self.arvrunner.fs_access.get_collection(self.generatefiles[t]["path"].replace("$(task.keep)/", "keep:"))
141 vwd.copy(rest, t, source_collection=src)
143 with vwd.open(t, "w") as f:
144 f.write(self.generatefiles[t])
146 for t in self.generatefiles:
147 script_parameters["task.vwd"][t] = "$(task.keep)/%s/%s" % (vwd.portable_data_hash(), t)
149 script_parameters["task.env"] = {"TMPDIR": "$(task.tmpdir)"}
151 script_parameters["task.env"].update(self.environment)
154 script_parameters["task.stdin"] = self.pathmapper.mapper(self.stdin)[1]
157 script_parameters["task.stdout"] = self.stdout
159 (docker_req, docker_is_req) = get_feature(self, "DockerRequirement")
160 if docker_req and kwargs.get("use_container") is not False:
161 runtime_constraints["docker_image"] = arv_docker_get_image(self.arvrunner.api, docker_req, pull_image, self.arvrunner.project_uuid)
163 runtime_constraints["docker_image"] = "arvados/jobs"
165 resources = self.builder.resources
166 if resources is not None:
167 runtime_constraints["min_cores_per_node"] = resources.get("cores", 1)
168 runtime_constraints["min_ram_mb_per_node"] = resources.get("ram")
169 runtime_constraints["min_scratch_mb_per_node"] = resources.get("tmpdirSize", 0) + resources.get("outdirSize", 0)
172 response = self.arvrunner.api.jobs().create(body={
173 "owner_uuid": self.arvrunner.project_uuid,
174 "script": "crunchrunner",
175 "repository": "arvados",
176 "script_version": "master",
177 "minimum_script_version": "9e5b98e8f5f4727856b53447191f9c06e3da2ba6",
178 "script_parameters": {"tasks": [script_parameters]},
179 "runtime_constraints": runtime_constraints
180 }, find_or_create=kwargs.get("enable_reuse", True)).execute(num_retries=self.arvrunner.num_retries)
182 self.arvrunner.jobs[response["uuid"]] = self
184 self.arvrunner.pipeline["components"][self.name] = {"job": response}
185 self.arvrunner.pipeline = self.arvrunner.api.pipeline_instances().update(uuid=self.arvrunner.pipeline["uuid"],
187 "components": self.arvrunner.pipeline["components"]
188 }).execute(num_retries=self.arvrunner.num_retries)
190 logger.info("Job %s (%s) is %s", self.name, response["uuid"], response["state"])
192 if response["state"] in ("Complete", "Failed", "Cancelled"):
194 except Exception as e:
195 logger.error("Got error %s" % str(e))
196 self.output_callback({}, "permanentFail")
198 def update_pipeline_component(self, record):
199 self.arvrunner.pipeline["components"][self.name] = {"job": record}
200 self.arvrunner.pipeline = self.arvrunner.api.pipeline_instances().update(uuid=self.arvrunner.pipeline["uuid"],
202 "components": self.arvrunner.pipeline["components"]
203 }).execute(num_retries=self.arvrunner.num_retries)
205 def done(self, record):
207 self.update_pipeline_component(record)
212 if record["state"] == "Complete":
213 processStatus = "success"
215 processStatus = "permanentFail"
220 logc = arvados.collection.Collection(record["log"])
221 log = logc.open(logc.keys()[0])
226 # Determine the tmpdir, outdir and keepdir paths from
227 # the job run. Unfortunately, we can't take the first
228 # values we find (which are expected to be near the
229 # top) and stop scanning because if the node fails and
230 # the job restarts on a different node these values
231 # will different runs, and we need to know about the
232 # final run that actually produced output.
234 g = tmpdirre.match(l)
237 g = outdirre.match(l)
244 colname = "Output %s of %s" % (record["output"][0:7], self.name)
246 # check if collection already exists with same owner, name and content
247 collection_exists = self.arvrunner.api.collections().list(
248 filters=[["owner_uuid", "=", self.arvrunner.project_uuid],
249 ['portable_data_hash', '=', record["output"]],
250 ["name", "=", colname]]
251 ).execute(num_retries=self.arvrunner.num_retries)
253 if not collection_exists["items"]:
254 # Create a collection located in the same project as the
255 # pipeline with the contents of the output.
256 # First, get output record.
257 collections = self.arvrunner.api.collections().list(
259 filters=[['portable_data_hash', '=', record["output"]]],
260 select=["manifest_text"]
261 ).execute(num_retries=self.arvrunner.num_retries)
263 if not collections["items"]:
264 raise WorkflowException(
265 "Job output '%s' cannot be found on API server" % (
268 # Create new collection in the parent project
269 # with the output contents.
270 self.arvrunner.api.collections().create(body={
271 "owner_uuid": self.arvrunner.project_uuid,
273 "portable_data_hash": record["output"],
274 "manifest_text": collections["items"][0]["manifest_text"]
275 }, ensure_unique_name=True).execute(
276 num_retries=self.arvrunner.num_retries)
278 self.builder.outdir = outdir
279 self.builder.pathmapper.keepdir = keepdir
280 outputs = self.collect_outputs("keep:" + record["output"])
281 except WorkflowException as e:
282 logger.error("Error while collecting job outputs:\n%s", e, exc_info=(e if self.arvrunner.debug else False))
283 processStatus = "permanentFail"
284 except Exception as e:
285 logger.exception("Got unknown exception while collecting job outputs:")
286 processStatus = "permanentFail"
288 self.output_callback(outputs, processStatus)
290 del self.arvrunner.jobs[record["uuid"]]
293 class RunnerJob(object):
294 """Submit and manage a Crunch job that runs crunch_scripts/cwl-runner."""
296 def __init__(self, runner, tool, job_order, enable_reuse):
297 self.arvrunner = runner
299 self.job_order = job_order
301 self.enable_reuse = enable_reuse
303 def update_pipeline_component(self, record):
306 def upload_docker(self, tool):
307 if isinstance(tool, cwltool.draft2tool.CommandLineTool):
308 (docker_req, docker_is_req) = get_feature(tool, "DockerRequirement")
310 arv_docker_get_image(self.arvrunner.api, docker_req, True, self.arvrunner.project_uuid)
311 elif isinstance(tool, cwltool.workflow.Workflow):
313 self.upload_docker(s.embedded_tool)
315 def run(self, dry_run=False, pull_image=True, **kwargs):
316 self.upload_docker(self.tool)
318 workflowfiles = set()
320 workflowfiles.add(self.tool.tool["id"])
322 self.name = os.path.basename(self.tool.tool["id"])
324 def visitFiles(files, path):
328 document_loader, _, _ = cwltool.process.get_schema()
330 return document_loader.resolve_ref(u, base_url=b)[0]
332 sc = scandeps("", self.tool.tool,
333 set(("$import", "run")),
334 set(("$include", "$schemas", "path")),
336 adjustFiles(sc, functools.partial(visitFiles, workflowfiles))
337 adjustFiles(self.job_order, functools.partial(visitFiles, jobfiles))
339 workflowmapper = ArvPathMapper(self.arvrunner, workflowfiles, "",
345 jobmapper = ArvPathMapper(self.arvrunner, jobfiles, "",
348 name=os.path.basename(self.job_order.get("id", "#")),
351 adjustFiles(self.job_order, lambda p: jobmapper.mapper(p)[1])
353 if "id" in self.job_order:
354 del self.job_order["id"]
356 self.job_order["cwl:tool"] = workflowmapper.mapper(self.tool.tool["id"])[1]
358 response = self.arvrunner.api.jobs().create(body={
359 "script": "cwl-runner",
360 "script_version": "master",
361 "repository": "arvados",
362 "script_parameters": self.job_order,
363 "runtime_constraints": {
364 "docker_image": "arvados/jobs"
366 }, find_or_create=self.enable_reuse).execute(num_retries=self.arvrunner.num_retries)
368 self.arvrunner.jobs[response["uuid"]] = self
370 logger.info("Submitted job %s", response["uuid"])
372 if response["state"] in ("Complete", "Failed", "Cancelled"):
375 def done(self, record):
376 if record["state"] == "Complete":
377 processStatus = "success"
379 processStatus = "permanentFail"
384 outc = arvados.collection.Collection(record["output"])
385 with outc.open("cwl.output.json") as f:
386 outputs = json.load(f)
387 except Exception as e:
388 logger.error("While getting final output object: %s", e)
389 self.arvrunner.output_callback(outputs, processStatus)
391 del self.arvrunner.jobs[record["uuid"]]
393 class ArvPathMapper(cwltool.pathmapper.PathMapper):
394 """Convert container-local paths to and from Keep collection ids."""
396 def __init__(self, arvrunner, referenced_files, basedir,
397 collection_pattern, file_pattern, name=None, **kwargs):
398 self._pathmap = arvrunner.get_uploaded()
401 pdh_path = re.compile(r'^keep:[0-9a-f]{32}\+\d+/.+')
403 for src in referenced_files:
404 if isinstance(src, basestring) and pdh_path.match(src):
405 self._pathmap[src] = (src, collection_pattern % src[5:])
407 src = src[:src.index("#")]
408 if src not in self._pathmap:
409 ab = cwltool.pathmapper.abspath(src, basedir)
410 st = arvados.commands.run.statfile("", ab, fnPattern=file_pattern)
411 if kwargs.get("conformance_test"):
412 self._pathmap[src] = (src, ab)
413 elif isinstance(st, arvados.commands.run.UploadFile):
414 uploadfiles.add((src, ab, st))
415 elif isinstance(st, arvados.commands.run.ArvFile):
416 self._pathmap[src] = (ab, st.fn)
418 raise cwltool.workflow.WorkflowException("Input file path '%s' is invalid" % st)
421 arvados.commands.run.uploadfiles([u[2] for u in uploadfiles],
423 dry_run=kwargs.get("dry_run"),
425 fnPattern=file_pattern,
427 project=arvrunner.project_uuid)
429 for src, ab, st in uploadfiles:
430 arvrunner.add_uploaded(src, (ab, st.fn))
431 self._pathmap[src] = (ab, st.fn)
435 def reversemap(self, target):
436 if target.startswith("keep:"):
437 return (target, target)
438 elif self.keepdir and target.startswith(self.keepdir):
439 return (target, "keep:" + target[len(self.keepdir)+1:])
441 return super(ArvPathMapper, self).reversemap(target)
444 class ArvadosCommandTool(cwltool.draft2tool.CommandLineTool):
445 """Wrap cwltool CommandLineTool to override selected methods."""
447 def __init__(self, arvrunner, toolpath_object, **kwargs):
448 super(ArvadosCommandTool, self).__init__(toolpath_object, **kwargs)
449 self.arvrunner = arvrunner
451 def makeJobRunner(self):
452 return ArvadosJob(self.arvrunner)
454 def makePathMapper(self, reffiles, input_basedir, **kwargs):
455 return ArvPathMapper(self.arvrunner, reffiles, input_basedir,
457 "$(task.keep)/%s/%s",
461 class ArvCwlRunner(object):
462 """Execute a CWL tool or workflow, submit crunch jobs, wait for them to
463 complete, and report output."""
465 def __init__(self, api_client):
466 self.api = api_client
468 self.lock = threading.Lock()
469 self.cond = threading.Condition(self.lock)
470 self.final_output = None
474 def arvMakeTool(self, toolpath_object, **kwargs):
475 if "class" in toolpath_object and toolpath_object["class"] == "CommandLineTool":
476 return ArvadosCommandTool(self, toolpath_object, **kwargs)
478 return cwltool.workflow.defaultMakeTool(toolpath_object, **kwargs)
480 def output_callback(self, out, processStatus):
481 if processStatus == "success":
482 logger.info("Overall job status is %s", processStatus)
484 self.api.pipeline_instances().update(uuid=self.pipeline["uuid"],
485 body={"state": "Complete"}).execute(num_retries=self.num_retries)
488 logger.warn("Overall job status is %s", processStatus)
490 self.api.pipeline_instances().update(uuid=self.pipeline["uuid"],
491 body={"state": "Failed"}).execute(num_retries=self.num_retries)
492 self.final_output = out
495 def on_message(self, event):
496 if "object_uuid" in event:
497 if event["object_uuid"] in self.jobs and event["event_type"] == "update":
498 if event["properties"]["new_attributes"]["state"] == "Running" and self.jobs[event["object_uuid"]].running is False:
499 uuid = event["object_uuid"]
502 logger.info("Job %s (%s) is Running", j.name, uuid)
504 j.update_pipeline_component(event["properties"]["new_attributes"])
505 elif event["properties"]["new_attributes"]["state"] in ("Complete", "Failed", "Cancelled"):
506 uuid = event["object_uuid"]
510 logger.info("Job %s (%s) is %s", j.name, uuid, event["properties"]["new_attributes"]["state"])
511 j.done(event["properties"]["new_attributes"])
516 def get_uploaded(self):
517 return self.uploaded.copy()
519 def add_uploaded(self, src, pair):
520 self.uploaded[src] = pair
522 def arvExecutor(self, tool, job_order, input_basedir, args, **kwargs):
523 self.debug = args.debug
526 logger.setLevel(logging.WARN)
527 logging.getLogger('arvados.arv-run').setLevel(logging.WARN)
529 useruuid = self.api.users().current().execute()["uuid"]
530 self.project_uuid = args.project_uuid if args.project_uuid else useruuid
534 runnerjob = RunnerJob(self, tool, job_order, args.enable_reuse)
539 events = arvados.events.subscribe(arvados.api('v1'), [["object_uuid", "is_a", "arvados#job"]], self.on_message)
541 self.fs_access = CollectionFsAccess(input_basedir)
543 kwargs["fs_access"] = self.fs_access
544 kwargs["enable_reuse"] = args.enable_reuse
546 kwargs["outdir"] = "$(task.outdir)"
547 kwargs["tmpdir"] = "$(task.tmpdir)"
549 if kwargs.get("conformance_test"):
550 return cwltool.main.single_job_executor(tool, job_order, input_basedir, args, **kwargs)
553 jobiter = iter((runnerjob,))
556 if "cwl_runner_job" in kwargs:
557 components[os.path.basename(tool.tool["id"])] = {"job": kwargs["cwl_runner_job"]}
559 self.pipeline = self.api.pipeline_instances().create(
561 "owner_uuid": self.project_uuid,
562 "name": shortname(tool.tool["id"]),
563 "components": components,
564 "state": "RunningOnClient"}).execute(num_retries=self.num_retries)
566 logger.info("Pipeline instance %s", self.pipeline["uuid"])
568 jobiter = tool.job(job_order,
570 self.output_callback,
571 docker_outdir="$(task.outdir)",
576 # Will continue to hold the lock for the duration of this code
577 # except when in cond.wait(), at which point on_message can update
578 # job state and process output callbacks.
580 for runnable in jobiter:
582 runnable.run(**kwargs)
587 logger.error("Workflow is deadlocked, no runnable jobs and not waiting on any pending jobs.")
595 if self.final_output is None:
596 raise cwltool.workflow.WorkflowException("Workflow did not return a result.")
598 # create final output collection
600 if sys.exc_info()[0] is KeyboardInterrupt:
601 logger.error("Interrupted, marking pipeline as failed")
603 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))
605 self.api.pipeline_instances().update(uuid=self.pipeline["uuid"],
606 body={"state": "Failed"}).execute(num_retries=self.num_retries)
610 return self.final_output
613 """Print version string of key packages for provenance and debugging."""
615 arvcwlpkg = pkg_resources.require("arvados-cwl-runner")
616 arvpkg = pkg_resources.require("arvados-python-client")
617 cwlpkg = pkg_resources.require("cwltool")
619 return "%s %s, %s %s, %s %s" % (sys.argv[0], arvcwlpkg[0].version,
620 "arvados-python-client", arvpkg[0].version,
621 "cwltool", cwlpkg[0].version)
623 def main(args, stdout, stderr, api_client=None):
624 args.insert(0, "--leave-outputs")
625 parser = cwltool.main.arg_parser()
627 exgroup = parser.add_mutually_exclusive_group()
628 exgroup.add_argument("--enable-reuse", action="store_true",
629 default=True, dest="enable_reuse",
631 exgroup.add_argument("--disable-reuse", action="store_false",
632 default=True, dest="enable_reuse",
635 parser.add_argument("--project-uuid", type=str, help="Project that will own the workflow jobs")
637 exgroup = parser.add_mutually_exclusive_group()
638 exgroup.add_argument("--submit", action="store_true", help="Submit workflow to run on Arvados.",
639 default=True, dest="submit")
640 exgroup.add_argument("--local", action="store_false", help="Run workflow on local host (submits jobs to Arvados).",
641 default=True, dest="submit")
643 exgroup = parser.add_mutually_exclusive_group()
644 exgroup.add_argument("--wait", action="store_true", help="After submitting workflow runner job, wait for completion.",
645 default=True, dest="wait")
646 exgroup.add_argument("--no-wait", action="store_false", help="Submit workflow runner job and exit.",
647 default=True, dest="wait")
650 if api_client is None:
651 api_client=arvados.api('v1', model=OrderedJsonModel())
652 runner = ArvCwlRunner(api_client)
653 except Exception as e:
657 return cwltool.main.main(args,
660 executor=runner.arvExecutor,
661 makeTool=runner.arvMakeTool,
663 versionfunc=versionstring)