Nicolas Noble | ddef246 | 2015-01-06 18:08:25 -0800 | [diff] [blame] | 1 | """Run a group of subprocesses and then finish.""" |
| 2 | |
Craig Tiller | 7173518 | 2015-01-15 17:07:13 -0800 | [diff] [blame] | 3 | import hashlib |
Nicolas Noble | ddef246 | 2015-01-06 18:08:25 -0800 | [diff] [blame] | 4 | import multiprocessing |
Craig Tiller | 7173518 | 2015-01-15 17:07:13 -0800 | [diff] [blame] | 5 | import os |
Nicolas Noble | ddef246 | 2015-01-06 18:08:25 -0800 | [diff] [blame] | 6 | import random |
| 7 | import subprocess |
| 8 | import sys |
ctiller | 3040cb7 | 2015-01-07 12:13:17 -0800 | [diff] [blame] | 9 | import tempfile |
| 10 | import time |
Nicolas Noble | ddef246 | 2015-01-06 18:08:25 -0800 | [diff] [blame] | 11 | |
ctiller | 3040cb7 | 2015-01-07 12:13:17 -0800 | [diff] [blame] | 12 | |
ctiller | 94e5dde | 2015-01-09 10:41:59 -0800 | [diff] [blame] | 13 | _DEFAULT_MAX_JOBS = 16 * multiprocessing.cpu_count() |
Nicolas Noble | ddef246 | 2015-01-06 18:08:25 -0800 | [diff] [blame] | 14 | |
| 15 | |
| 16 | def shuffle_iteratable(it): |
| 17 | """Return an iterable that randomly walks it""" |
| 18 | # take a random sampling from the passed in iterable |
| 19 | # we take an element with probablity 1/p and rapidly increase |
| 20 | # p as we take elements - this gives us a somewhat random set of values before |
| 21 | # we've seen all the values, but starts producing values without having to |
| 22 | # compute ALL of them at once, allowing tests to start a little earlier |
| 23 | nextit = [] |
| 24 | p = 1 |
| 25 | for val in it: |
| 26 | if random.randint(0, p) == 0: |
ctiller | 3040cb7 | 2015-01-07 12:13:17 -0800 | [diff] [blame] | 27 | p = min(p*2, 100) |
Nicolas Noble | ddef246 | 2015-01-06 18:08:25 -0800 | [diff] [blame] | 28 | yield val |
| 29 | else: |
| 30 | nextit.append(val) |
| 31 | # after taking a random sampling, we shuffle the rest of the elements and |
| 32 | # yield them |
| 33 | random.shuffle(nextit) |
| 34 | for val in nextit: |
| 35 | yield val |
| 36 | |
| 37 | |
ctiller | 3040cb7 | 2015-01-07 12:13:17 -0800 | [diff] [blame] | 38 | _SUCCESS = object() |
| 39 | _FAILURE = object() |
| 40 | _RUNNING = object() |
| 41 | _KILLED = object() |
| 42 | |
| 43 | |
Craig Tiller | 3b08306 | 2015-01-12 13:51:28 -0800 | [diff] [blame] | 44 | _COLORS = { |
Nicolas Noble | 044db74 | 2015-01-14 16:57:24 -0800 | [diff] [blame] | 45 | 'red': [ 31, 0 ], |
| 46 | 'green': [ 32, 0 ], |
| 47 | 'yellow': [ 33, 0 ], |
| 48 | 'lightgray': [ 37, 0], |
| 49 | 'gray': [ 30, 1 ], |
Craig Tiller | 3b08306 | 2015-01-12 13:51:28 -0800 | [diff] [blame] | 50 | } |
| 51 | |
| 52 | |
| 53 | _BEGINNING_OF_LINE = '\x1b[0G' |
| 54 | _CLEAR_LINE = '\x1b[2K' |
| 55 | |
| 56 | |
| 57 | _TAG_COLOR = { |
| 58 | 'FAILED': 'red', |
| 59 | 'PASSED': 'green', |
Nicolas Noble | 044db74 | 2015-01-14 16:57:24 -0800 | [diff] [blame] | 60 | 'START': 'gray', |
Craig Tiller | 3b08306 | 2015-01-12 13:51:28 -0800 | [diff] [blame] | 61 | 'WAITING': 'yellow', |
Nicolas Noble | 044db74 | 2015-01-14 16:57:24 -0800 | [diff] [blame] | 62 | 'SUCCESS': 'green', |
| 63 | 'IDLE': 'gray', |
Craig Tiller | 3b08306 | 2015-01-12 13:51:28 -0800 | [diff] [blame] | 64 | } |
| 65 | |
| 66 | |
Nicolas Noble | 044db74 | 2015-01-14 16:57:24 -0800 | [diff] [blame] | 67 | def message(tag, message, explanatory_text=None, do_newline=False): |
| 68 | sys.stdout.write('%s%s%s\x1b[%d;%dm%s\x1b[0m: %s%s' % ( |
Craig Tiller | 3b08306 | 2015-01-12 13:51:28 -0800 | [diff] [blame] | 69 | _BEGINNING_OF_LINE, |
| 70 | _CLEAR_LINE, |
Nicolas Noble | 044db74 | 2015-01-14 16:57:24 -0800 | [diff] [blame] | 71 | '\n%s' % explanatory_text if explanatory_text is not None else '', |
| 72 | _COLORS[_TAG_COLOR[tag]][1], |
| 73 | _COLORS[_TAG_COLOR[tag]][0], |
Craig Tiller | 3b08306 | 2015-01-12 13:51:28 -0800 | [diff] [blame] | 74 | tag, |
| 75 | message, |
Nicolas Noble | 044db74 | 2015-01-14 16:57:24 -0800 | [diff] [blame] | 76 | '\n' if do_newline or explanatory_text is not None else '')) |
Craig Tiller | 3b08306 | 2015-01-12 13:51:28 -0800 | [diff] [blame] | 77 | sys.stdout.flush() |
| 78 | |
| 79 | |
Craig Tiller | 7173518 | 2015-01-15 17:07:13 -0800 | [diff] [blame] | 80 | def which(filename): |
| 81 | if '/' in filename: |
| 82 | return filename |
| 83 | for path in os.environ['PATH'].split(os.pathsep): |
| 84 | if os.path.exists(os.path.join(path, filename)): |
| 85 | return os.path.join(path, filename) |
| 86 | raise Exception('%s not found' % filename) |
| 87 | |
| 88 | |
Craig Tiller | 547db2b | 2015-01-30 14:08:39 -0800 | [diff] [blame^] | 89 | class JobSpec(object): |
| 90 | """Specifies what to run for a job.""" |
| 91 | |
| 92 | def __init__(self, cmdline, shortname=None, environ={}, hash_targets=[]): |
| 93 | """ |
| 94 | Arguments: |
| 95 | cmdline: a list of arguments to pass as the command line |
| 96 | environ: a dictionary of environment variables to set in the child process |
| 97 | hash_targets: which files to include in the hash representing the jobs version |
| 98 | (or empty, indicating the job should not be hashed) |
| 99 | """ |
| 100 | self.cmdline = cmdline |
| 101 | self.environ = environ |
| 102 | self.shortname = cmdline[0] if shortname is None else shortname |
| 103 | self.hash_targets = hash_targets or [] |
| 104 | |
| 105 | def identity(self): |
| 106 | return '%r %r %r' % (self.cmdline, self.environ, self.hash_targets) |
| 107 | |
| 108 | def __hash__(self): |
| 109 | return hash(self.identity()) |
| 110 | |
| 111 | def __cmp__(self, other): |
| 112 | return self.identity() == other.identity() |
| 113 | |
| 114 | |
ctiller | 3040cb7 | 2015-01-07 12:13:17 -0800 | [diff] [blame] | 115 | class Job(object): |
| 116 | """Manages one job.""" |
| 117 | |
Craig Tiller | 547db2b | 2015-01-30 14:08:39 -0800 | [diff] [blame^] | 118 | def __init__(self, spec, bin_hash, newline_on_success): |
| 119 | self._spec = spec |
Craig Tiller | 7173518 | 2015-01-15 17:07:13 -0800 | [diff] [blame] | 120 | self._bin_hash = bin_hash |
ctiller | 3040cb7 | 2015-01-07 12:13:17 -0800 | [diff] [blame] | 121 | self._tempfile = tempfile.TemporaryFile() |
Craig Tiller | 547db2b | 2015-01-30 14:08:39 -0800 | [diff] [blame^] | 122 | env = os.environ.copy() |
| 123 | for k, v in spec.environ.iteritems(): |
| 124 | env[k] = v |
| 125 | self._process = subprocess.Popen(args=spec.cmdline, |
ctiller | 3040cb7 | 2015-01-07 12:13:17 -0800 | [diff] [blame] | 126 | stderr=subprocess.STDOUT, |
Craig Tiller | 547db2b | 2015-01-30 14:08:39 -0800 | [diff] [blame^] | 127 | stdout=self._tempfile, |
| 128 | env=env) |
ctiller | 3040cb7 | 2015-01-07 12:13:17 -0800 | [diff] [blame] | 129 | self._state = _RUNNING |
Nicolas Noble | 044db74 | 2015-01-14 16:57:24 -0800 | [diff] [blame] | 130 | self._newline_on_success = newline_on_success |
Craig Tiller | 547db2b | 2015-01-30 14:08:39 -0800 | [diff] [blame^] | 131 | message('START', spec.shortname) |
ctiller | 3040cb7 | 2015-01-07 12:13:17 -0800 | [diff] [blame] | 132 | |
Craig Tiller | 7173518 | 2015-01-15 17:07:13 -0800 | [diff] [blame] | 133 | def state(self, update_cache): |
ctiller | 3040cb7 | 2015-01-07 12:13:17 -0800 | [diff] [blame] | 134 | """Poll current state of the job. Prints messages at completion.""" |
| 135 | if self._state == _RUNNING and self._process.poll() is not None: |
| 136 | if self._process.returncode != 0: |
| 137 | self._state = _FAILURE |
| 138 | self._tempfile.seek(0) |
| 139 | stdout = self._tempfile.read() |
Craig Tiller | 7173518 | 2015-01-15 17:07:13 -0800 | [diff] [blame] | 140 | message('FAILED', '%s [ret=%d]' % ( |
Craig Tiller | 547db2b | 2015-01-30 14:08:39 -0800 | [diff] [blame^] | 141 | self._spec.shortname, self._process.returncode), stdout) |
ctiller | 3040cb7 | 2015-01-07 12:13:17 -0800 | [diff] [blame] | 142 | else: |
| 143 | self._state = _SUCCESS |
Craig Tiller | 547db2b | 2015-01-30 14:08:39 -0800 | [diff] [blame^] | 144 | message('PASSED', self._spec.shortname, |
Craig Tiller | 7173518 | 2015-01-15 17:07:13 -0800 | [diff] [blame] | 145 | do_newline=self._newline_on_success) |
Craig Tiller | 547db2b | 2015-01-30 14:08:39 -0800 | [diff] [blame^] | 146 | if self._bin_hash: |
| 147 | update_cache.finished(self._spec.identity(), self._bin_hash) |
ctiller | 3040cb7 | 2015-01-07 12:13:17 -0800 | [diff] [blame] | 148 | return self._state |
| 149 | |
| 150 | def kill(self): |
| 151 | if self._state == _RUNNING: |
| 152 | self._state = _KILLED |
| 153 | self._process.terminate() |
| 154 | |
| 155 | |
Nicolas Noble | ddef246 | 2015-01-06 18:08:25 -0800 | [diff] [blame] | 156 | class Jobset(object): |
| 157 | """Manages one run of jobs.""" |
| 158 | |
Craig Tiller | 7173518 | 2015-01-15 17:07:13 -0800 | [diff] [blame] | 159 | def __init__(self, check_cancelled, maxjobs, newline_on_success, cache): |
ctiller | 3040cb7 | 2015-01-07 12:13:17 -0800 | [diff] [blame] | 160 | self._running = set() |
| 161 | self._check_cancelled = check_cancelled |
| 162 | self._cancelled = False |
Nicolas Noble | ddef246 | 2015-01-06 18:08:25 -0800 | [diff] [blame] | 163 | self._failures = 0 |
Craig Tiller | 738c334 | 2015-01-12 14:28:33 -0800 | [diff] [blame] | 164 | self._completed = 0 |
ctiller | 94e5dde | 2015-01-09 10:41:59 -0800 | [diff] [blame] | 165 | self._maxjobs = maxjobs |
Nicolas Noble | 044db74 | 2015-01-14 16:57:24 -0800 | [diff] [blame] | 166 | self._newline_on_success = newline_on_success |
Craig Tiller | 7173518 | 2015-01-15 17:07:13 -0800 | [diff] [blame] | 167 | self._cache = cache |
Nicolas Noble | ddef246 | 2015-01-06 18:08:25 -0800 | [diff] [blame] | 168 | |
Craig Tiller | 547db2b | 2015-01-30 14:08:39 -0800 | [diff] [blame^] | 169 | def start(self, spec): |
ctiller | 3040cb7 | 2015-01-07 12:13:17 -0800 | [diff] [blame] | 170 | """Start a job. Return True on success, False on failure.""" |
ctiller | 94e5dde | 2015-01-09 10:41:59 -0800 | [diff] [blame] | 171 | while len(self._running) >= self._maxjobs: |
ctiller | 3040cb7 | 2015-01-07 12:13:17 -0800 | [diff] [blame] | 172 | if self.cancelled(): return False |
| 173 | self.reap() |
| 174 | if self.cancelled(): return False |
Craig Tiller | 547db2b | 2015-01-30 14:08:39 -0800 | [diff] [blame^] | 175 | if spec.hash_targets: |
| 176 | bin_hash = hashlib.sha1() |
| 177 | for fn in spec.hash_targets: |
| 178 | with open(which(fn)) as f: |
| 179 | bin_hash.update(f.read()) |
| 180 | bin_hash = bin_hash.hexdigest() |
| 181 | should_run = self._cache.should_run(spec.identity(), bin_hash) |
| 182 | else: |
| 183 | bin_hash = None |
| 184 | should_run = True |
| 185 | if should_run: |
| 186 | self._running.add(Job(spec, |
| 187 | bin_hash, |
| 188 | self._newline_on_success)) |
ctiller | 3040cb7 | 2015-01-07 12:13:17 -0800 | [diff] [blame] | 189 | return True |
Nicolas Noble | ddef246 | 2015-01-06 18:08:25 -0800 | [diff] [blame] | 190 | |
ctiller | 3040cb7 | 2015-01-07 12:13:17 -0800 | [diff] [blame] | 191 | def reap(self): |
| 192 | """Collect the dead jobs.""" |
| 193 | while self._running: |
| 194 | dead = set() |
| 195 | for job in self._running: |
Craig Tiller | 7173518 | 2015-01-15 17:07:13 -0800 | [diff] [blame] | 196 | st = job.state(self._cache) |
ctiller | 3040cb7 | 2015-01-07 12:13:17 -0800 | [diff] [blame] | 197 | if st == _RUNNING: continue |
| 198 | if st == _FAILURE: self._failures += 1 |
| 199 | dead.add(job) |
| 200 | for job in dead: |
Craig Tiller | 738c334 | 2015-01-12 14:28:33 -0800 | [diff] [blame] | 201 | self._completed += 1 |
ctiller | 3040cb7 | 2015-01-07 12:13:17 -0800 | [diff] [blame] | 202 | self._running.remove(job) |
Craig Tiller | 3b08306 | 2015-01-12 13:51:28 -0800 | [diff] [blame] | 203 | if dead: return |
Craig Tiller | 6f5e2c4 | 2015-01-21 18:05:31 -0800 | [diff] [blame] | 204 | message('WAITING', '%d jobs running, %d complete, %d failed' % ( |
| 205 | len(self._running), self._completed, self._failures)) |
ctiller | 3040cb7 | 2015-01-07 12:13:17 -0800 | [diff] [blame] | 206 | time.sleep(0.1) |
| 207 | |
| 208 | def cancelled(self): |
| 209 | """Poll for cancellation.""" |
| 210 | if self._cancelled: return True |
| 211 | if not self._check_cancelled(): return False |
| 212 | for job in self._running: |
| 213 | job.kill() |
| 214 | self._cancelled = True |
| 215 | return True |
| 216 | |
| 217 | def finish(self): |
| 218 | while self._running: |
| 219 | if self.cancelled(): pass # poll cancellation |
| 220 | self.reap() |
| 221 | return not self.cancelled() and self._failures == 0 |
Nicolas Noble | ddef246 | 2015-01-06 18:08:25 -0800 | [diff] [blame] | 222 | |
| 223 | |
ctiller | 3040cb7 | 2015-01-07 12:13:17 -0800 | [diff] [blame] | 224 | def _never_cancelled(): |
| 225 | return False |
| 226 | |
| 227 | |
Craig Tiller | 7173518 | 2015-01-15 17:07:13 -0800 | [diff] [blame] | 228 | # cache class that caches nothing |
| 229 | class NoCache(object): |
| 230 | def should_run(self, cmdline, bin_hash): |
| 231 | return True |
| 232 | |
| 233 | def finished(self, cmdline, bin_hash): |
| 234 | pass |
| 235 | |
| 236 | |
Nicolas Noble | b09078f | 2015-01-14 18:06:05 -0800 | [diff] [blame] | 237 | def run(cmdlines, |
| 238 | check_cancelled=_never_cancelled, |
| 239 | maxjobs=None, |
Craig Tiller | 7173518 | 2015-01-15 17:07:13 -0800 | [diff] [blame] | 240 | newline_on_success=False, |
| 241 | cache=None): |
ctiller | 94e5dde | 2015-01-09 10:41:59 -0800 | [diff] [blame] | 242 | js = Jobset(check_cancelled, |
Nicolas Noble | 044db74 | 2015-01-14 16:57:24 -0800 | [diff] [blame] | 243 | maxjobs if maxjobs is not None else _DEFAULT_MAX_JOBS, |
Craig Tiller | 7173518 | 2015-01-15 17:07:13 -0800 | [diff] [blame] | 244 | newline_on_success, |
| 245 | cache if cache is not None else NoCache()) |
ctiller | 3040cb7 | 2015-01-07 12:13:17 -0800 | [diff] [blame] | 246 | for cmdline in shuffle_iteratable(cmdlines): |
| 247 | if not js.start(cmdline): |
| 248 | break |
| 249 | return js.finish() |