1 # Copyright (C) The Arvados Authors. All rights reserved.
3 # SPDX-License-Identifier: Apache-2.0
10 from schema_salad.sourceline import SourceLine, cmap
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
20 import ruamel.yaml as yaml
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
28 logger = logging.getLogger('arvados.cwl-runner')
29 metrics = logging.getLogger('arvados.cwl-runner.metrics')
31 max_res_pars = ("coresMin", "coresMax", "ramMin", "ramMax", "tmpdirMin", "tmpdirMax")
32 sum_res_pars = ("outdirMin", "outdirMax")
34 def upload_workflow(arvRunner, tool, job_order, project_uuid, uuid=None,
35 submit_runner_ram=0, name=None, merged_map=None):
37 packed = packed_workflow(arvRunner, tool, merged_map)
39 adjustDirObjs(job_order, trim_listing)
40 adjustFileObjs(job_order, trim_anonymous_location)
41 adjustDirObjs(job_order, trim_anonymous_location)
43 main = [p for p in packed["$graph"] if p["id"] == "#main"][0]
44 for inp in main["inputs"]:
45 sn = shortname(inp["id"])
47 inp["default"] = job_order[sn]
50 name = tool.tool.get("label", os.path.basename(tool.tool["id"]))
52 upload_dependencies(arvRunner, name, tool.doc_loader,
53 packed, tool.tool["id"], False)
56 hints = main.get("hints", [])
59 if h["class"] == "http://arvados.org/cwl#WorkflowRunnerResources":
60 h["ramMin"] = submit_runner_ram
64 hints.append({"class": "http://arvados.org/cwl#WorkflowRunnerResources",
65 "ramMin": submit_runner_ram})
71 "description": tool.tool.get("doc", ""),
72 "definition":json.dumps(packed, sort_keys=True, indent=4, separators=(',',': '))
75 body["workflow"]["owner_uuid"] = project_uuid
78 call = arvRunner.api.workflows().update(uuid=uuid, body=body)
80 call = arvRunner.api.workflows().create(body=body)
81 return call.execute(num_retries=arvRunner.num_retries)["uuid"]
85 for r in reversed(reqs):
86 if r["class"] not in dedup and not r["class"].startswith("http://arvados.org/cwl#"):
88 return [dedup[r] for r in sorted(dedup.keys())]
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."""
97 for a in max_res_pars + sum_res_pars:
99 for res_req in res_reqs:
101 if isinstance(res_req[a], int): # integer check
102 all_res_req[a].append(res_req[a])
104 msg = SourceLine(res_req, a).makeError(
105 "Non-top-level ResourceRequirement in single container cannot have expressions")
106 exception_msgs.append(msg)
108 raise WorkflowException("\n".join(exception_msgs))
111 for a in all_res_req:
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])
118 overall_res_req["class"] = "ResourceRequirement"
119 return cmap(overall_res_req)
121 class ArvadosWorkflowStep(WorkflowStep):
122 def job(self, joborder, output_callback, runtimeContext):
123 builder = self._init_job(joborder, runtimeContext)
124 check_cluster_target(self, builder, runtimeContext)
125 return super(ArvadosWorkflowStep, self).job(joborder, output_callback, runtimeContext)
127 class ArvadosWorkflow(Workflow):
128 """Wrap cwltool Workflow to override selected methods."""
130 def __init__(self, arvrunner, toolpath_object, loadingContext):
131 super(ArvadosWorkflow, self).__init__(toolpath_object, loadingContext)
132 self.arvrunner = arvrunner
134 self.dynamic_resource_req = []
135 self.static_resource_req = []
136 self.wf_reffiles = []
137 self.loadingContext = loadingContext
139 def job(self, joborder, output_callback, runtimeContext):
141 builder = self._init_job(joborder, runtimeContext)
142 check_cluster_target(self, builder, runtimeContext)
144 req, _ = self.get_requirement("http://arvados.org/cwl#RunInSingleContainer")
146 return super(ArvadosWorkflow, self).job(joborder, output_callback, runtimeContext)
148 # RunInSingleContainer is true
150 with SourceLine(self.tool, None, WorkflowException, logger.isEnabledFor(logging.DEBUG)):
151 if "id" not in self.tool:
152 raise WorkflowException("%s object must have 'id'" % (self.tool["class"]))
153 document_loader, workflowobj, uri = (self.doc_loader, self.doc_loader.fetch(self.tool["id"]), self.tool["id"])
155 discover_secondary_files(self.tool["inputs"], joborder)
157 with Perf(metrics, "subworkflow upload_deps"):
158 upload_dependencies(self.arvrunner,
159 os.path.basename(joborder.get("id", "#")),
162 joborder.get("id", "#"),
165 if self.wf_pdh is None:
166 workflowobj["requirements"] = dedup_reqs(self.requirements)
167 workflowobj["hints"] = dedup_reqs(self.hints)
169 packed = pack(document_loader, workflowobj, uri, self.metadata)
172 for t in ("hints", "requirements"):
176 if req["class"] == "ResourceRequirement":
178 for k in max_res_pars + sum_res_pars:
180 if isinstance(req[k], basestring):
181 if item["id"] == "#main":
182 # only the top-level requirements/hints may contain expressions
183 self.dynamic_resource_req.append(req)
187 with SourceLine(req, k, WorkflowException):
188 raise WorkflowException("Non-top-level ResourceRequirement in single container cannot have expressions")
190 self.static_resource_req.append(req)
192 visit_class(packed["$graph"], ("Workflow", "CommandLineTool"), visit)
194 if self.static_resource_req:
195 self.static_resource_req = [get_overall_res_req(self.static_resource_req)]
197 upload_dependencies(self.arvrunner,
204 # Discover files/directories referenced by the
205 # workflow (mainly "default" values)
206 visit_class(packed, ("File", "Directory"), self.wf_reffiles.append)
209 if self.dynamic_resource_req:
210 # Evaluate dynamic resource requirements using current builder
211 rs = copy.copy(self.static_resource_req)
212 for dyn_rs in self.dynamic_resource_req:
213 eval_req = {"class": "ResourceRequirement"}
214 for a in max_res_pars + sum_res_pars:
216 eval_req[a] = builder.do_eval(dyn_rs[a])
218 job_res_reqs = [get_overall_res_req(rs)]
220 job_res_reqs = self.static_resource_req
222 with Perf(metrics, "subworkflow adjust"):
223 joborder_resolved = copy.deepcopy(joborder)
224 joborder_keepmount = copy.deepcopy(joborder)
227 visit_class(joborder_keepmount, ("File", "Directory"), reffiles.append)
229 mapper = ArvPathMapper(self.arvrunner, reffiles+self.wf_reffiles, runtimeContext.basedir,
233 # For containers API, we need to make sure any extra
234 # referenced files (ie referenced by the workflow but
235 # not in the inputs) are included in the mounts.
237 runtimeContext = runtimeContext.copy()
238 runtimeContext.extra_reffiles = copy.deepcopy(self.wf_reffiles)
241 remove_redundant_fields(obj)
242 with SourceLine(obj, None, WorkflowException, logger.isEnabledFor(logging.DEBUG)):
243 if "location" not in obj:
244 raise WorkflowException("%s object is missing required 'location' field: %s" % (obj["class"], obj))
245 with SourceLine(obj, "location", WorkflowException, logger.isEnabledFor(logging.DEBUG)):
246 if obj["location"].startswith("keep:"):
247 obj["location"] = mapper.mapper(obj["location"]).target
250 elif obj["location"].startswith("_:"):
253 raise WorkflowException("Location is not a keep reference or a literal: '%s'" % obj["location"])
255 visit_class(joborder_keepmount, ("File", "Directory"), keepmount)
258 if obj["location"].startswith("keep:"):
259 obj["location"] = mapper.mapper(obj["location"]).resolved
261 visit_class(joborder_resolved, ("File", "Directory"), resolved)
263 if self.wf_pdh is None:
264 adjustFileObjs(packed, keepmount)
265 adjustDirObjs(packed, keepmount)
266 self.wf_pdh = upload_workflow_collection(self.arvrunner, shortname(self.tool["id"]), packed)
269 "class": "CommandLineTool",
270 "baseCommand": "cwltool",
271 "inputs": self.tool["inputs"],
272 "outputs": self.tool["outputs"],
273 "stdout": "cwl.output.json",
274 "requirements": self.requirements+job_res_reqs+[
275 {"class": "InlineJavascriptRequirement"},
277 "class": "InitialWorkDirRequirement",
279 "entryname": "workflow.cwl",
280 "entry": '$({"class": "File", "location": "keep:%s/workflow.cwl"})' % self.wf_pdh
282 "entryname": "cwl.input.yml",
283 "entry": json.dumps(joborder_keepmount, indent=2, sort_keys=True, separators=(',',': ')).replace("\\", "\\\\").replace('$(', '\$(').replace('${', '\${')
287 "arguments": ["--no-container", "--move-outputs", "--preserve-entire-environment", "workflow.cwl#main", "cwl.input.yml"],
290 return ArvadosCommandTool(self.arvrunner, wf_runner, self.loadingContext).job(joborder_resolved, output_callback, runtimeContext)
292 def make_workflow_step(self,
293 toolpath_object, # type: Dict[Text, Any]
295 loadingContext, # type: LoadingContext
296 parentworkflowProv=None # type: Optional[CreateProvProfile]
298 # (...) -> WorkflowStep
299 return WorkflowStep(toolpath_object, pos, loadingContext, parentworkflowProv)