sdk/cwl/arvados_cwl/arvworkflow.py

   1 # Copyright (C) The Arvados Authors. All rights reserved.
   2 #
   3 # SPDX-License-Identifier: Apache-2.0
   4
   5 import os
   6 import json
   7 import copy
   8 import logging
   9
  10 from schema_salad.sourceline import SourceLine, cmap
  11
  12 from cwltool.pack import pack
  13 from cwltool.load_tool import fetch_document
  14 from cwltool.process import shortname
  15 from cwltool.workflow import Workflow, WorkflowException, WorkflowStep
  16 from cwltool.pathmapper import adjustFileObjs, adjustDirObjs, visit_class
  17 from cwltool.builder import Builder
  18 from cwltool.context import LoadingContext
  19
  20 import ruamel.yaml as yaml
  21
  22 from .runner import (upload_dependencies, packed_workflow, upload_workflow_collection,
  23                      trim_anonymous_location, remove_redundant_fields, discover_secondary_files)
  24 from .pathmapper import ArvPathMapper, trim_listing
  25 from .arvtool import ArvadosCommandTool, check_cluster_target
  26 from .perf import Perf
  27
  28 logger = logging.getLogger('arvados.cwl-runner')
  29 metrics = logging.getLogger('arvados.cwl-runner.metrics')
  30
  31 max_res_pars = ("coresMin", "coresMax", "ramMin", "ramMax", "tmpdirMin", "tmpdirMax")
  32 sum_res_pars = ("outdirMin", "outdirMax")
  33
  34 def upload_workflow(arvRunner, tool, job_order, project_uuid, uuid=None,
  35                     submit_runner_ram=0, name=None, merged_map=None):
  36
  37     packed = packed_workflow(arvRunner, tool, merged_map)
  38
  39     adjustDirObjs(job_order, trim_listing)
  40     adjustFileObjs(job_order, trim_anonymous_location)
  41     adjustDirObjs(job_order, trim_anonymous_location)
  42
  43     main = [p for p in packed["$graph"] if p["id"] == "#main"][0]
  44     for inp in main["inputs"]:
  45         sn = shortname(inp["id"])
  46         if sn in job_order:
  47             inp["default"] = job_order[sn]
  48
  49     if not name:
  50         name = tool.tool.get("label", os.path.basename(tool.tool["id"]))
  51
  52     upload_dependencies(arvRunner, name, tool.doc_loader,
  53                         packed, tool.tool["id"], False)
  54
  55     if submit_runner_ram:
  56         hints = main.get("hints", [])
  57         found = False
  58         for h in hints:
  59             if h["class"] == "http://arvados.org/cwl#WorkflowRunnerResources":
  60                 h["ramMin"] = submit_runner_ram
  61                 found = True
  62                 break
  63         if not found:
  64             hints.append({"class": "http://arvados.org/cwl#WorkflowRunnerResources",
  65                           "ramMin": submit_runner_ram})
  66         main["hints"] = hints
  67
  68     body = {
  69         "workflow": {
  70             "name": name,
  71             "description": tool.tool.get("doc", ""),
  72             "definition":json.dumps(packed, sort_keys=True, indent=4, separators=(',',': '))
  73         }}
  74     if project_uuid:
  75         body["workflow"]["owner_uuid"] = project_uuid
  76
  77     if uuid:
  78         call = arvRunner.api.workflows().update(uuid=uuid, body=body)
  79     else:
  80         call = arvRunner.api.workflows().create(body=body)
  81     return call.execute(num_retries=arvRunner.num_retries)["uuid"]
  82
  83 def dedup_reqs(reqs):
  84     dedup = {}
  85     for r in reversed(reqs):
  86         if r["class"] not in dedup and not r["class"].startswith("http://arvados.org/cwl#"):
  87             dedup[r["class"]] = r
  88     return [dedup[r] for r in sorted(dedup.keys())]
  89
  90 def get_overall_res_req(res_reqs):
  91     """Take the overall of a list of ResourceRequirement,
  92     i.e., the max of coresMin, coresMax, ramMin, ramMax, tmpdirMin, tmpdirMax
  93     and the sum of outdirMin, outdirMax."""
  94
  95     all_res_req = {}
  96     exception_msgs = []
  97     for a in max_res_pars + sum_res_pars:
  98         all_res_req[a] = []
  99         for res_req in res_reqs:
 100             if a in res_req:
 101                 if isinstance(res_req[a], int): # integer check
 102                     all_res_req[a].append(res_req[a])
 103                 else:
 104                     msg = SourceLine(res_req, a).makeError(
 105                     "Non-top-level ResourceRequirement in single container cannot have expressions")
 106                     exception_msgs.append(msg)
 107     if exception_msgs:
 108         raise WorkflowException("\n".join(exception_msgs))
 109     else:
 110         overall_res_req = {}
 111         for a in all_res_req:
 112             if all_res_req[a]:
 113                 if a in max_res_pars:
 114                     overall_res_req[a] = max(all_res_req[a])
 115                 elif a in sum_res_pars:
 116                     overall_res_req[a] = sum(all_res_req[a])
 117         if overall_res_req:
 118             overall_res_req["class"] = "ResourceRequirement"
 119         return cmap(overall_res_req)
 120
 121 class ArvadosWorkflowStep(WorkflowStep):
 122     def __init__(self,
 123                  toolpath_object,      # type: Dict[Text, Any]
 124                  pos,                  # type: int
 125                  loadingContext,       # type: LoadingContext
 126                  *argc,
 127                  **argv
 128                 ):  # type: (...) -> None
 129
 130         super(ArvadosWorkflowStep, self).__init__(toolpath_object, pos, loadingContext, *argc, **argv)
 131         self.tool["class"] = "WorkflowStep"
 132
 133     def job(self, joborder, output_callback, runtimeContext):
 134         builder = self._init_job({shortname(k): v for k,v in joborder.items()}, runtimeContext)
 135         check_cluster_target(self, builder, runtimeContext)
 136         return super(ArvadosWorkflowStep, self).job(joborder, output_callback, runtimeContext)
 137
 138 class ArvadosWorkflow(Workflow):
 139     """Wrap cwltool Workflow to override selected methods."""
 140
 141     def __init__(self, arvrunner, toolpath_object, loadingContext):
 142         super(ArvadosWorkflow, self).__init__(toolpath_object, loadingContext)
 143         self.arvrunner = arvrunner
 144         self.wf_pdh = None
 145         self.dynamic_resource_req = []
 146         self.static_resource_req = []
 147         self.wf_reffiles = []
 148         self.loadingContext = loadingContext
 149
 150     def job(self, joborder, output_callback, runtimeContext):
 151
 152         builder = self._init_job(joborder, runtimeContext)
 153         check_cluster_target(self, builder, runtimeContext)
 154
 155         req, _ = self.get_requirement("http://arvados.org/cwl#RunInSingleContainer")
 156         if not req:
 157             return super(ArvadosWorkflow, self).job(joborder, output_callback, runtimeContext)
 158
 159         # RunInSingleContainer is true
 160
 161         with SourceLine(self.tool, None, WorkflowException, logger.isEnabledFor(logging.DEBUG)):
 162             if "id" not in self.tool:
 163                 raise WorkflowException("%s object must have 'id'" % (self.tool["class"]))
 164         document_loader, workflowobj, uri = (self.doc_loader, self.doc_loader.fetch(self.tool["id"]), self.tool["id"])
 165
 166         discover_secondary_files(self.tool["inputs"], joborder)
 167
 168         with Perf(metrics, "subworkflow upload_deps"):
 169             upload_dependencies(self.arvrunner,
 170                                 os.path.basename(joborder.get("id", "#")),
 171                                 document_loader,
 172                                 joborder,
 173                                 joborder.get("id", "#"),
 174                                 False)
 175
 176             if self.wf_pdh is None:
 177                 workflowobj["requirements"] = dedup_reqs(self.requirements)
 178                 workflowobj["hints"] = dedup_reqs(self.hints)
 179
 180                 packed = pack(document_loader, workflowobj, uri, self.metadata)
 181
 182                 def visit(item):
 183                     for t in ("hints", "requirements"):
 184                         if t not in item:
 185                             continue
 186                         for req in item[t]:
 187                             if req["class"] == "ResourceRequirement":
 188                                 dyn = False
 189                                 for k in max_res_pars + sum_res_pars:
 190                                     if k in req:
 191                                         if isinstance(req[k], basestring):
 192                                             if item["id"] == "#main":
 193                                                 # only the top-level requirements/hints may contain expressions
 194                                                 self.dynamic_resource_req.append(req)
 195                                                 dyn = True
 196                                                 break
 197                                             else:
 198                                                 with SourceLine(req, k, WorkflowException):
 199                                                     raise WorkflowException("Non-top-level ResourceRequirement in single container cannot have expressions")
 200                                 if not dyn:
 201                                     self.static_resource_req.append(req)
 202
 203                 visit_class(packed["$graph"], ("Workflow", "CommandLineTool"), visit)
 204
 205                 if self.static_resource_req:
 206                     self.static_resource_req = [get_overall_res_req(self.static_resource_req)]
 207
 208                 upload_dependencies(self.arvrunner,
 209                                     runtimeContext.name,
 210                                     document_loader,
 211                                     packed,
 212                                     uri,
 213                                     False)
 214
 215                 # Discover files/directories referenced by the
 216                 # workflow (mainly "default" values)
 217                 visit_class(packed, ("File", "Directory"), self.wf_reffiles.append)
 218
 219
 220         if self.dynamic_resource_req:
 221             # Evaluate dynamic resource requirements using current builder
 222             rs = copy.copy(self.static_resource_req)
 223             for dyn_rs in self.dynamic_resource_req:
 224                 eval_req = {"class": "ResourceRequirement"}
 225                 for a in max_res_pars + sum_res_pars:
 226                     if a in dyn_rs:
 227                         eval_req[a] = builder.do_eval(dyn_rs[a])
 228                 rs.append(eval_req)
 229             job_res_reqs = [get_overall_res_req(rs)]
 230         else:
 231             job_res_reqs = self.static_resource_req
 232
 233         with Perf(metrics, "subworkflow adjust"):
 234             joborder_resolved = copy.deepcopy(joborder)
 235             joborder_keepmount = copy.deepcopy(joborder)
 236
 237             reffiles = []
 238             visit_class(joborder_keepmount, ("File", "Directory"), reffiles.append)
 239
 240             mapper = ArvPathMapper(self.arvrunner, reffiles+self.wf_reffiles, runtimeContext.basedir,
 241                                    "/keep/%s",
 242                                    "/keep/%s/%s")
 243
 244             # For containers API, we need to make sure any extra
 245             # referenced files (ie referenced by the workflow but
 246             # not in the inputs) are included in the mounts.
 247             if self.wf_reffiles:
 248                 runtimeContext = runtimeContext.copy()
 249                 runtimeContext.extra_reffiles = copy.deepcopy(self.wf_reffiles)
 250
 251             def keepmount(obj):
 252                 remove_redundant_fields(obj)
 253                 with SourceLine(obj, None, WorkflowException, logger.isEnabledFor(logging.DEBUG)):
 254                     if "location" not in obj:
 255                         raise WorkflowException("%s object is missing required 'location' field: %s" % (obj["class"], obj))
 256                 with SourceLine(obj, "location", WorkflowException, logger.isEnabledFor(logging.DEBUG)):
 257                     if obj["location"].startswith("keep:"):
 258                         obj["location"] = mapper.mapper(obj["location"]).target
 259                         if "listing" in obj:
 260                             del obj["listing"]
 261                     elif obj["location"].startswith("_:"):
 262                         del obj["location"]
 263                     else:
 264                         raise WorkflowException("Location is not a keep reference or a literal: '%s'" % obj["location"])
 265
 266             visit_class(joborder_keepmount, ("File", "Directory"), keepmount)
 267
 268             def resolved(obj):
 269                 if obj["location"].startswith("keep:"):
 270                     obj["location"] = mapper.mapper(obj["location"]).resolved
 271
 272             visit_class(joborder_resolved, ("File", "Directory"), resolved)
 273
 274             if self.wf_pdh is None:
 275                 adjustFileObjs(packed, keepmount)
 276                 adjustDirObjs(packed, keepmount)
 277                 self.wf_pdh = upload_workflow_collection(self.arvrunner, shortname(self.tool["id"]), packed)
 278
 279         wf_runner = cmap({
 280             "class": "CommandLineTool",
 281             "baseCommand": "cwltool",
 282             "inputs": self.tool["inputs"],
 283             "outputs": self.tool["outputs"],
 284             "stdout": "cwl.output.json",
 285             "requirements": self.requirements+job_res_reqs+[
 286                 {"class": "InlineJavascriptRequirement"},
 287                 {
 288                 "class": "InitialWorkDirRequirement",
 289                 "listing": [{
 290                         "entryname": "workflow.cwl",
 291                         "entry": '$({"class": "File", "location": "keep:%s/workflow.cwl"})' % self.wf_pdh
 292                     }, {
 293                         "entryname": "cwl.input.yml",
 294                         "entry": json.dumps(joborder_keepmount, indent=2, sort_keys=True, separators=(',',': ')).replace("\\", "\\\\").replace('$(', '\$(').replace('${', '\${')
 295                     }]
 296             }],
 297             "hints": self.hints,
 298             "arguments": ["--no-container", "--move-outputs", "--preserve-entire-environment", "workflow.cwl#main", "cwl.input.yml"],
 299             "id": "#"
 300         })
 301         return ArvadosCommandTool(self.arvrunner, wf_runner, self.loadingContext).job(joborder_resolved, output_callback, runtimeContext)
 302
 303     def make_workflow_step(self,
 304                            toolpath_object,      # type: Dict[Text, Any]
 305                            pos,                  # type: int
 306                            loadingContext,       # type: LoadingContext
 307                            *argc,
 308                            **argv
 309     ):
 310         # (...) -> WorkflowStep
 311         return ArvadosWorkflowStep(toolpath_object, pos, loadingContext, *argc, **argv)