sdk/python/arvados/commands/run.py

   1 #!/usr/bin/env python
   2
   3 import arvados
   4 import argparse
   5 import json
   6 import re
   7 import os
   8 import stat
   9 import put
  10 import time
  11 import arvados.commands.ws as ws
  12 import subprocess
  13 import logging
  14
  15 logger = logging.getLogger('arvados.arv-run')
  16
  17 arvrun_parser = argparse.ArgumentParser()
  18 arvrun_parser.add_argument('--dry-run', action="store_true", help="Print out the pipeline that would be submitted and exit")
  19 arvrun_parser.add_argument('--local', action="store_true", help="Run locally using arv-crunch-job")
  20 arvrun_parser.add_argument('--docker-image', type=str, default="arvados/jobs", help="Docker image to use, default arvados/jobs")
  21 arvrun_parser.add_argument('--git-dir', type=str, default="", help="Git repository passed to arv-crunch-job when using --local")
  22 arvrun_parser.add_argument('--repository', type=str, default="arvados", help="repository field of component, default 'arvados'")
  23 arvrun_parser.add_argument('--script-version', type=str, default="master", help="script_version field of component, default 'master'")
  24 arvrun_parser.add_argument('args', nargs=argparse.REMAINDER)
  25
  26 class ArvFile(object):
  27     def __init__(self, prefix, fn):
  28         self.prefix = prefix
  29         self.fn = fn
  30
  31 class UploadFile(ArvFile):
  32     pass
  33
  34 def is_in_collection(root, branch):
  35     if root == "/":
  36         return (None, None)
  37     fn = os.path.join(root, ".arvados#collection")
  38     if os.path.exists(fn):
  39         with file(fn, 'r') as f:
  40             c = json.load(f)
  41         return (c["portable_data_hash"], branch)
  42     else:
  43         sp = os.path.split(root)
  44         return is_in_collection(sp[0], os.path.join(sp[1], branch))
  45
  46 def statfile(prefix, fn):
  47     absfn = os.path.abspath(fn)
  48     if os.path.exists(absfn):
  49         st = os.stat(absfn)
  50         if stat.S_ISREG(st.st_mode):
  51             sp = os.path.split(absfn)
  52             (pdh, branch) = is_in_collection(sp[0], sp[1])
  53             if pdh:
  54                 return ArvFile(prefix, "$(file %s/%s)" % (pdh, branch))
  55             else:
  56                 # trim leading '/' for path prefix test later
  57                 return UploadFile(prefix, absfn[1:])
  58     return prefix+fn
  59
  60 def main(arguments=None):
  61     args = arvrun_parser.parse_args(arguments)
  62
  63     if len(args.args) == 0:
  64         arvrun_parser.print_help()
  65         return
  66
  67     starting_args = args.args
  68
  69     reading_into = 2
  70
  71     slots = [[], [], []]
  72     for c in args.args:
  73         if c.startswith('>'):
  74             reading_into = 0
  75             if len(c) > 1:
  76                 slots[reading_into].append(c[1:])
  77         elif c.startswith('<'):
  78             reading_into = 1
  79             if len(c) > 1:
  80                 slots[reading_into].append(c[1:])
  81         elif c == '|':
  82             reading_into = len(slots)
  83             slots.append([])
  84         else:
  85             slots[reading_into].append(c)
  86
  87     if slots[0] and len(slots[0]) > 1:
  88         logger.error("Can only specify a single stdout file (run-command substitutions are permitted)")
  89         return
  90
  91     patterns = [re.compile("(--[^=]+=)(.*)"),
  92                 re.compile("(-[^=]+=)(.*)"),
  93                 re.compile("(-.)(.+)")]
  94
  95     for command in slots[1:]:
  96         for i in xrange(0, len(command)):
  97             a = command[i]
  98             if a[0] == '-':
  99                 # parameter starts with '-' so it might be a command line
 100                 # parameter with a file name, do some pattern matching
 101                 matched = False
 102                 for p in patterns:
 103                     m = p.match(a)
 104                     if m:
 105                         command[i] = statfile(m.group(1), m.group(2))
 106                         break
 107             else:
 108                 # parameter might be a file, so test it
 109                 command[i] = statfile('', a)
 110
 111     n = True
 112     pathprefix = "/"
 113     files = [c for command in slots[1:] for c in command if isinstance(c, UploadFile)]
 114     if len(files) > 0:
 115         # Find the smallest path prefix that includes all the files that need to be uploaded.
 116         # This starts at the root and iteratively removes common parent directory prefixes
 117         # until all file pathes no longer have a common parent.
 118         while n:
 119             pathstep = None
 120             for c in files:
 121                 if pathstep is None:
 122                     sp = c.fn.split('/')
 123                     if len(sp) < 2:
 124                         # no parent directories left
 125                         n = False
 126                         break
 127                     # path step takes next directory
 128                     pathstep = sp[0] + "/"
 129                 else:
 130                     # check if pathstep is common prefix for all files
 131                     if not c.fn.startswith(pathstep):
 132                         n = False
 133                         break
 134             if n:
 135                 # pathstep is common parent directory for all files, so remove the prefix
 136                 # from each path
 137                 pathprefix += pathstep
 138                 for c in files:
 139                     c.fn = c.fn[len(pathstep):]
 140
 141         os.chdir(pathprefix)
 142
 143         if args.dry_run:
 144             print("cd %s" % pathprefix)
 145             print("arv-put \"%s\"" % '" "'.join([c.fn for c in files]))
 146             pdh = "$(input)"
 147         else:
 148             pdh = put.main(["--portable-data-hash"]+[c.fn for c in files])
 149
 150         for c in files:
 151             c.fn = "$(file %s/%s)" % (pdh, c.fn)
 152
 153     for i in xrange(1, len(slots)):
 154         slots[i] = [("%s%s" % (c.prefix, c.fn)) if isinstance(c, ArvFile) else c for c in slots[i]]
 155
 156     component = {
 157         "script": "run-command",
 158         "script_version": args.script_version,
 159         "repository": args.repository,
 160         "script_parameters": {
 161         },
 162         "runtime_constraints": {
 163             "docker_image": args.docker_image
 164         }
 165     }
 166
 167     task_foreach = []
 168     group_parser = argparse.ArgumentParser()
 169     group_parser.add_argument('--batch-size', type=int)
 170     group_parser.add_argument('args', nargs=argparse.REMAINDER)
 171
 172     for s in xrange(2, len(slots)):
 173         for i in xrange(0, len(slots[s])):
 174             if slots[s][i] == '--':
 175                 inp = "input%i" % (s-2)
 176                 groupargs = group_parser.parse_args(slots[2][i+1:])
 177                 if groupargs.batch_size:
 178                     component["script_parameters"][inp] = {"batch":groupargs.args, "size":groupargs.batch_size}
 179                     slots[s] = slots[s][0:i] + [{"foreach": inp, "command": "$(%s)" % inp}]
 180                 else:
 181                     component["script_parameters"][inp] = groupargs.args
 182                     slots[s] = slots[s][0:i] + ["$(%s)" % inp]
 183                 task_foreach.append(inp)
 184                 break
 185             if slots[s][i] == '\--':
 186                 slots[s][i] = '--'
 187
 188     if slots[0]:
 189         component["script_parameters"]["task.stdout"] = slots[0][0]
 190     if slots[1]:
 191         task_foreach.append("stdin")
 192         component["script_parameters"]["stdin"] = slots[1]
 193         component["script_parameters"]["task.stdin"] = "$(stdin)"\
 194
 195     if task_foreach:
 196         component["script_parameters"]["task.foreach"] = task_foreach
 197
 198     component["script_parameters"]["command"] = slots[2:]
 199
 200     pipeline = {
 201         "name": " ".join(starting_args),
 202         "components": {
 203             "command": component
 204         },
 205         "state":"RunningOnServer"
 206     }
 207
 208     if args.dry_run:
 209         print(json.dumps(pipeline, indent=4))
 210     elif args.local:
 211         subprocess.call(["arv-crunch-job", "--job", json.dumps(component), "--git-dir", args.git_dir])
 212     else:
 213         api = arvados.api('v1')
 214         pi = api.pipeline_instances().create(body=pipeline).execute()
 215         print "Running pipeline %s" % pi["uuid"]
 216         ws.main(["--pipeline", pi["uuid"]])
 217
 218 if __name__ == '__main__':
 219     main()