11308: Merge branch 'master' into 11308-python3
[arvados.git] / sdk / python / arvados / commands / run.py
1 from __future__ import print_function
2 from __future__ import absolute_import
3 from builtins import range
4 from past.builtins import basestring
5 from builtins import object
6 import arvados
7 import arvados.commands.ws as ws
8 import argparse
9 import json
10 import re
11 import os
12 import stat
13 from . import put
14 import time
15 import subprocess
16 import logging
17 import sys
18 import errno
19 import arvados.commands._util as arv_cmd
20 import arvados.collection
21
22 from arvados._version import __version__
23
24 logger = logging.getLogger('arvados.arv-run')
25 logger.setLevel(logging.INFO)
26
27 arvrun_parser = argparse.ArgumentParser(parents=[arv_cmd.retry_opt])
28 arvrun_parser.add_argument('--dry-run', action="store_true",
29                            help="Print out the pipeline that would be submitted and exit")
30 arvrun_parser.add_argument('--local', action="store_true",
31                            help="Run locally using arv-run-pipeline-instance")
32 arvrun_parser.add_argument('--docker-image', type=str,
33                            help="Docker image to use, otherwise use instance default.")
34 arvrun_parser.add_argument('--ignore-rcode', action="store_true",
35                            help="Commands that return non-zero return codes should not be considered failed.")
36 arvrun_parser.add_argument('--no-reuse', action="store_true",
37                            help="Do not reuse past jobs.")
38 arvrun_parser.add_argument('--no-wait', action="store_true",
39                            help="Do not wait and display logs after submitting command, just exit.")
40 arvrun_parser.add_argument('--project-uuid', type=str,
41                            help="Parent project of the pipeline")
42 arvrun_parser.add_argument('--git-dir', type=str, default="",
43                            help="Git repository passed to arv-crunch-job when using --local")
44 arvrun_parser.add_argument('--repository', type=str, default="arvados",
45                            help="repository field of component, default 'arvados'")
46 arvrun_parser.add_argument('--script-version', type=str, default="master",
47                            help="script_version field of component, default 'master'")
48 arvrun_parser.add_argument('--version', action='version',
49                            version="%s %s" % (sys.argv[0], __version__),
50                            help='Print version and exit.')
51 arvrun_parser.add_argument('args', nargs=argparse.REMAINDER)
52
53 class ArvFile(object):
54     def __init__(self, prefix, fn):
55         self.prefix = prefix
56         self.fn = fn
57
58     def __hash__(self):
59         return (self.prefix+self.fn).__hash__()
60
61     def __eq__(self, other):
62         return (self.prefix == other.prefix) and (self.fn == other.fn)
63
64 class UploadFile(ArvFile):
65     pass
66
67 # Determine if a file is in a collection, and return a tuple consisting of the
68 # portable data hash and the path relative to the root of the collection.
69 # Return None if the path isn't with an arv-mount collection or there was is error.
70 def is_in_collection(root, branch):
71     try:
72         if root == "/":
73             return (None, None)
74         fn = os.path.join(root, ".arvados#collection")
75         if os.path.exists(fn):
76             with file(fn, 'r') as f:
77                 c = json.load(f)
78             return (c["portable_data_hash"], branch)
79         else:
80             sp = os.path.split(root)
81             return is_in_collection(sp[0], os.path.join(sp[1], branch))
82     except (IOError, OSError):
83         return (None, None)
84
85 # Determine the project to place the output of this command by searching upward
86 # for arv-mount psuedofile indicating the project.  If the cwd isn't within
87 # an arv-mount project or there is an error, return current_user.
88 def determine_project(root, current_user):
89     try:
90         if root == "/":
91             return current_user
92         fn = os.path.join(root, ".arvados#project")
93         if os.path.exists(fn):
94             with file(fn, 'r') as f:
95                 c = json.load(f)
96             if 'writable_by' in c and current_user in c['writable_by']:
97                 return c["uuid"]
98             else:
99                 return current_user
100         else:
101             sp = os.path.split(root)
102             return determine_project(sp[0], current_user)
103     except (IOError, OSError):
104         return current_user
105
106 # Determine if string corresponds to a file, and if that file is part of a
107 # arv-mounted collection or only local to the machine.  Returns one of
108 # ArvFile() (file already exists in a collection), UploadFile() (file needs to
109 # be uploaded to a collection), or simply returns prefix+fn (which yields the
110 # original parameter string).
111 def statfile(prefix, fn, fnPattern="$(file %s/%s)", dirPattern="$(dir %s/%s/)"):
112     absfn = os.path.abspath(fn)
113     try:
114         st = os.stat(absfn)
115         sp = os.path.split(absfn)
116         (pdh, branch) = is_in_collection(sp[0], sp[1])
117         if pdh:
118             if stat.S_ISREG(st.st_mode):
119                 return ArvFile(prefix, fnPattern % (pdh, branch))
120             elif stat.S_ISDIR(st.st_mode):
121                 return ArvFile(prefix, dirPattern % (pdh, branch))
122             else:
123                 raise Exception("%s is not a regular file or directory" % absfn)
124         else:
125             # trim leading '/' for path prefix test later
126             return UploadFile(prefix, absfn[1:])
127     except OSError as e:
128         if e.errno == errno.ENOENT:
129             pass
130         else:
131             raise
132
133     return prefix+fn
134
135 def write_file(collection, pathprefix, fn):
136     with open(os.path.join(pathprefix, fn)) as src:
137         dst = collection.open(fn, "w")
138         r = src.read(1024*128)
139         while r:
140             dst.write(r)
141             r = src.read(1024*128)
142         dst.close(flush=False)
143
144 def uploadfiles(files, api, dry_run=False, num_retries=0,
145                 project=None,
146                 fnPattern="$(file %s/%s)",
147                 name=None):
148     # Find the smallest path prefix that includes all the files that need to be uploaded.
149     # This starts at the root and iteratively removes common parent directory prefixes
150     # until all file paths no longer have a common parent.
151     n = True
152     pathprefix = "/"
153     while n:
154         pathstep = None
155         for c in files:
156             if pathstep is None:
157                 sp = c.fn.split('/')
158                 if len(sp) < 2:
159                     # no parent directories left
160                     n = False
161                     break
162                 # path step takes next directory
163                 pathstep = sp[0] + "/"
164             else:
165                 # check if pathstep is common prefix for all files
166                 if not c.fn.startswith(pathstep):
167                     n = False
168                     break
169         if n:
170             # pathstep is common parent directory for all files, so remove the prefix
171             # from each path
172             pathprefix += pathstep
173             for c in files:
174                 c.fn = c.fn[len(pathstep):]
175
176     logger.info("Upload local files: \"%s\"", '" "'.join([c.fn for c in files]))
177
178     if dry_run:
179         logger.info("$(input) is %s", pathprefix.rstrip('/'))
180         pdh = "$(input)"
181     else:
182         files = sorted(files, key=lambda x: x.fn)
183         collection = arvados.collection.Collection(api_client=api, num_retries=num_retries)
184         prev = ""
185         for f in files:
186             localpath = os.path.join(pathprefix, f.fn)
187             if prev and localpath.startswith(prev+"/"):
188                 # If this path is inside an already uploaded subdirectory,
189                 # don't redundantly re-upload it.
190                 # e.g. we uploaded /tmp/foo and the next file is /tmp/foo/bar
191                 # skip it because it starts with "/tmp/foo/"
192                 continue
193             prev = localpath
194             if os.path.isfile(localpath):
195                 write_file(collection, pathprefix, f.fn)
196             elif os.path.isdir(localpath):
197                 for root, dirs, iterfiles in os.walk(localpath):
198                     root = root[len(pathprefix):]
199                     for src in iterfiles:
200                         write_file(collection, pathprefix, os.path.join(root, src))
201
202         filters=[["portable_data_hash", "=", collection.portable_data_hash()],
203                  ["name", "like", name+"%"]]
204         if project:
205             filters.append(["owner_uuid", "=", project])
206
207         exists = api.collections().list(filters=filters, limit=1).execute(num_retries=num_retries)
208
209         if exists["items"]:
210             item = exists["items"][0]
211             pdh = item["portable_data_hash"]
212             logger.info("Using collection %s (%s)", pdh, item["uuid"])
213         else:
214             collection.save_new(name=name, owner_uuid=project, ensure_unique_name=True)
215             pdh = collection.portable_data_hash()
216             logger.info("Uploaded to %s (%s)", pdh, collection.manifest_locator())
217
218     for c in files:
219         c.keepref = "%s/%s" % (pdh, c.fn)
220         c.fn = fnPattern % (pdh, c.fn)
221
222
223 def main(arguments=None):
224     args = arvrun_parser.parse_args(arguments)
225
226     if len(args.args) == 0:
227         arvrun_parser.print_help()
228         return
229
230     starting_args = args.args
231
232     reading_into = 2
233
234     # Parse the command arguments into 'slots'.
235     # All words following '>' are output arguments and are collected into slots[0].
236     # All words following '<' are input arguments and are collected into slots[1].
237     # slots[2..] store the parameters of each command in the pipeline.
238     #
239     # e.g. arv-run foo arg1 arg2 '|' bar arg3 arg4 '<' input1 input2 input3 '>' output.txt
240     # will be parsed into:
241     #   [['output.txt'],
242     #    ['input1', 'input2', 'input3'],
243     #    ['foo', 'arg1', 'arg2'],
244     #    ['bar', 'arg3', 'arg4']]
245     slots = [[], [], []]
246     for c in args.args:
247         if c.startswith('>'):
248             reading_into = 0
249             if len(c) > 1:
250                 slots[reading_into].append(c[1:])
251         elif c.startswith('<'):
252             reading_into = 1
253             if len(c) > 1:
254                 slots[reading_into].append(c[1:])
255         elif c == '|':
256             reading_into = len(slots)
257             slots.append([])
258         else:
259             slots[reading_into].append(c)
260
261     if slots[0] and len(slots[0]) > 1:
262         logger.error("Can only specify a single stdout file (run-command substitutions are permitted)")
263         return
264
265     if not args.dry_run:
266         api = arvados.api('v1')
267         if args.project_uuid:
268             project = args.project_uuid
269         else:
270             project = determine_project(os.getcwd(), api.users().current().execute()["uuid"])
271
272     # Identify input files.  Look at each parameter and test to see if there is
273     # a file by that name.  This uses 'patterns' to look for within
274     # command line arguments, such as --foo=file.txt or -lfile.txt
275     patterns = [re.compile("([^=]+=)(.*)"),
276                 re.compile("(-[A-Za-z])(.+)")]
277     for j, command in enumerate(slots[1:]):
278         for i, a in enumerate(command):
279             if j > 0 and i == 0:
280                 # j == 0 is stdin, j > 0 is commands
281                 # always skip program executable (i == 0) in commands
282                 pass
283             elif a.startswith('\\'):
284                 # if it starts with a \ then don't do any interpretation
285                 command[i] = a[1:]
286             else:
287                 # See if it looks like a file
288                 command[i] = statfile('', a)
289
290                 # If a file named command[i] was found, it would now be an
291                 # ArvFile or UploadFile.  If command[i] is a basestring, that
292                 # means it doesn't correspond exactly to a file, so do some
293                 # pattern matching.
294                 if isinstance(command[i], basestring):
295                     for p in patterns:
296                         m = p.match(a)
297                         if m:
298                             command[i] = statfile(m.group(1), m.group(2))
299                             break
300
301     files = [c for command in slots[1:] for c in command if isinstance(c, UploadFile)]
302     if files:
303         uploadfiles(files, api, dry_run=args.dry_run, num_retries=args.retries, project=project)
304
305     for i in range(1, len(slots)):
306         slots[i] = [("%s%s" % (c.prefix, c.fn)) if isinstance(c, ArvFile) else c for c in slots[i]]
307
308     component = {
309         "script": "run-command",
310         "script_version": args.script_version,
311         "repository": args.repository,
312         "script_parameters": {
313         },
314         "runtime_constraints": {}
315     }
316
317     if args.docker_image:
318         component["runtime_constraints"]["docker_image"] = args.docker_image
319
320     task_foreach = []
321     group_parser = argparse.ArgumentParser()
322     group_parser.add_argument('-b', '--batch-size', type=int)
323     group_parser.add_argument('args', nargs=argparse.REMAINDER)
324
325     for s in range(2, len(slots)):
326         for i in range(0, len(slots[s])):
327             if slots[s][i] == '--':
328                 inp = "input%i" % (s-2)
329                 groupargs = group_parser.parse_args(slots[2][i+1:])
330                 if groupargs.batch_size:
331                     component["script_parameters"][inp] = {"value": {"batch":groupargs.args, "size":groupargs.batch_size}}
332                     slots[s] = slots[s][0:i] + [{"foreach": inp, "command": "$(%s)" % inp}]
333                 else:
334                     component["script_parameters"][inp] = groupargs.args
335                     slots[s] = slots[s][0:i] + ["$(%s)" % inp]
336                 task_foreach.append(inp)
337                 break
338             if slots[s][i] == '\--':
339                 slots[s][i] = '--'
340
341     if slots[0]:
342         component["script_parameters"]["task.stdout"] = slots[0][0]
343     if slots[1]:
344         task_foreach.append("stdin")
345         component["script_parameters"]["stdin"] = slots[1]
346         component["script_parameters"]["task.stdin"] = "$(stdin)"
347
348     if task_foreach:
349         component["script_parameters"]["task.foreach"] = task_foreach
350
351     component["script_parameters"]["command"] = slots[2:]
352     if args.ignore_rcode:
353         component["script_parameters"]["task.ignore_rcode"] = args.ignore_rcode
354
355     pipeline = {
356         "name": "arv-run " + " | ".join([s[0] for s in slots[2:]]),
357         "description": "@" + " ".join(starting_args) + "@",
358         "components": {
359             "command": component
360         },
361         "state": "RunningOnClient" if args.local else "RunningOnServer"
362     }
363
364     if args.dry_run:
365         print(json.dumps(pipeline, indent=4))
366     else:
367         pipeline["owner_uuid"] = project
368         pi = api.pipeline_instances().create(body=pipeline, ensure_unique_name=True).execute()
369         logger.info("Running pipeline %s", pi["uuid"])
370
371         if args.local:
372             subprocess.call(["arv-run-pipeline-instance", "--instance", pi["uuid"], "--run-jobs-here"] + (["--no-reuse"] if args.no_reuse else []))
373         elif not args.no_wait:
374             ws.main(["--pipeline", pi["uuid"]])
375
376         pi = api.pipeline_instances().get(uuid=pi["uuid"]).execute()
377         logger.info("Pipeline is %s", pi["state"])
378         if "output_uuid" in pi["components"]["command"]:
379             logger.info("Output is %s", pi["components"]["command"]["output_uuid"])
380         else:
381             logger.info("No output")
382
383 if __name__ == '__main__':
384     main()