Merge branch '10346-rearrange-api-docs' closes #10346
[arvados.git] / sdk / cwl / arvados_cwl / arvworkflow.py
index 8e45890a8d6226d9387524e1dc330effe900e163..ce633d43285a537268f3bc96dc446696d17d06a6 100644 (file)
@@ -1,22 +1,32 @@
 import os
 import json
 import copy
+import logging
 
 from cwltool.pack import pack
 from cwltool.load_tool import fetch_document
 from cwltool.process import shortname
+from cwltool.workflow import Workflow, WorkflowException
+from cwltool.pathmapper import adjustFileObjs, adjustDirObjs
 
 import ruamel.yaml as yaml
 
-from .runner import upload_docker, upload_dependencies
+from .runner import upload_docker, upload_dependencies, trim_listing
+from .arvtool import ArvadosCommandTool
+from .perf import Perf
 
-def make_workflow(arvRunner, tool, job_order, project_uuid, update_uuid):
+logger = logging.getLogger('arvados.cwl-runner')
+metrics = logging.getLogger('arvados.cwl-runner.metrics')
+
+def upload_workflow(arvRunner, tool, job_order, project_uuid, update_uuid):
     upload_docker(arvRunner, tool)
 
     document_loader, workflowobj, uri = (tool.doc_loader, tool.doc_loader.fetch(tool.tool["id"]), tool.tool["id"])
 
     packed = pack(document_loader, workflowobj, uri, tool.metadata)
 
+    adjustDirObjs(job_order, trim_listing)
+
     main = [p for p in packed["$graph"] if p["id"] == "#main"][0]
     for inp in main["inputs"]:
         sn = shortname(inp["id"])
@@ -39,3 +49,82 @@ def make_workflow(arvRunner, tool, job_order, project_uuid, update_uuid):
         return arvRunner.api.workflows().update(uuid=update_uuid, body=body).execute(num_retries=arvRunner.num_retries)["uuid"]
     else:
         return arvRunner.api.workflows().create(body=body).execute(num_retries=arvRunner.num_retries)["uuid"]
+
+class ArvadosWorkflow(Workflow):
+    """Wrap cwltool Workflow to override selected methods."""
+
+    def __init__(self, arvrunner, toolpath_object, **kwargs):
+        super(ArvadosWorkflow, self).__init__(toolpath_object, **kwargs)
+        self.arvrunner = arvrunner
+        self.work_api = kwargs["work_api"]
+
+    def job(self, joborder, output_callback, **kwargs):
+        kwargs["work_api"] = self.work_api
+        req, _ = self.get_requirement("http://arvados.org/cwl#RunInSingleContainer")
+        if req:
+            document_loader, workflowobj, uri = (self.doc_loader, self.doc_loader.fetch(self.tool["id"]), self.tool["id"])
+
+            with Perf(metrics, "subworkflow upload_deps"):
+                workflowobj["requirements"] = self.requirements + workflowobj.get("requirements", [])
+                workflowobj["hints"] = self.hints + workflowobj.get("hints", [])
+                packed = pack(document_loader, workflowobj, uri, self.metadata)
+
+                upload_dependencies(self.arvrunner,
+                                    kwargs.get("name", ""),
+                                    document_loader,
+                                    packed,
+                                    uri,
+                                    False)
+
+                upload_dependencies(self.arvrunner,
+                                    os.path.basename(joborder.get("id", "#")),
+                                    document_loader,
+                                    joborder,
+                                    joborder.get("id", "#"),
+                                    False)
+
+            with Perf(metrics, "subworkflow adjust"):
+                joborder_keepmount = copy.deepcopy(joborder)
+
+                def keepmount(obj):
+                    if "location" not in obj:
+                        raise WorkflowException("%s object is missing required 'location' field: %s" % (obj["class"], obj))
+                    if obj["location"].startswith("keep:"):
+                        obj["location"] = "/keep/" + obj["location"][5:]
+                        if "listing" in obj:
+                            del obj["listing"]
+                    elif obj["location"].startswith("_:"):
+                        del obj["location"]
+                    else:
+                        raise WorkflowException("Location is not a keep reference or a literal: '%s'" % obj["location"])
+
+                adjustFileObjs(joborder_keepmount, keepmount)
+                adjustDirObjs(joborder_keepmount, keepmount)
+                adjustFileObjs(packed, keepmount)
+                adjustDirObjs(packed, keepmount)
+
+            wf_runner = {
+                "class": "CommandLineTool",
+                "baseCommand": "cwltool",
+                "inputs": self.tool["inputs"],
+                "outputs": self.tool["outputs"],
+                "stdout": "cwl.output.json",
+                "requirements": workflowobj["requirements"]+[
+                    {
+                    "class": "InitialWorkDirRequirement",
+                    "listing": [{
+                            "entryname": "workflow.cwl",
+                            "entry": yaml.safe_dump(packed).replace("\\", "\\\\").replace('$(', '\$(').replace('${', '\${')
+                        }, {
+                            "entryname": "cwl.input.yml",
+                            "entry": yaml.safe_dump(joborder_keepmount).replace("\\", "\\\\").replace('$(', '\$(').replace('${', '\${')
+                        }]
+                }],
+                "hints": workflowobj["hints"],
+                "arguments": ["--no-container", "--move-outputs", "--preserve-entire-environment", "workflow.cwl#main", "cwl.input.yml"]
+            }
+            kwargs["loader"] = self.doc_loader
+            kwargs["avsc_names"] = self.doc_schema
+            return ArvadosCommandTool(self.arvrunner, wf_runner, **kwargs).job(joborder, output_callback, **kwargs)
+        else:
+            return super(ArvadosWorkflow, self).job(joborder, output_callback, **kwargs)