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