sdk/python/arvados/commands/run.py

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