Craig Tiller | c2c7921 | 2015-02-16 12:00:01 -0800 | [diff] [blame] | 1 | # Copyright 2015, Google Inc. |
| 2 | # All rights reserved. |
| 3 | # |
| 4 | # Redistribution and use in source and binary forms, with or without |
| 5 | # modification, are permitted provided that the following conditions are |
| 6 | # met: |
| 7 | # |
| 8 | # * Redistributions of source code must retain the above copyright |
| 9 | # notice, this list of conditions and the following disclaimer. |
| 10 | # * Redistributions in binary form must reproduce the above |
| 11 | # copyright notice, this list of conditions and the following disclaimer |
| 12 | # in the documentation and/or other materials provided with the |
| 13 | # distribution. |
| 14 | # * Neither the name of Google Inc. nor the names of its |
| 15 | # contributors may be used to endorse or promote products derived from |
| 16 | # this software without specific prior written permission. |
| 17 | # |
| 18 | # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS |
| 19 | # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT |
| 20 | # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR |
| 21 | # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT |
| 22 | # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, |
| 23 | # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT |
| 24 | # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, |
| 25 | # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY |
| 26 | # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT |
| 27 | # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE |
| 28 | # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| 29 | |
Nicolas Noble | ddef246 | 2015-01-06 18:08:25 -0800 | [diff] [blame] | 30 | """Run a group of subprocesses and then finish.""" |
| 31 | |
Craig Tiller | 7173518 | 2015-01-15 17:07:13 -0800 | [diff] [blame] | 32 | import hashlib |
Nicolas Noble | ddef246 | 2015-01-06 18:08:25 -0800 | [diff] [blame] | 33 | import multiprocessing |
Craig Tiller | 7173518 | 2015-01-15 17:07:13 -0800 | [diff] [blame] | 34 | import os |
Craig Tiller | 5058c69 | 2015-04-08 09:42:04 -0700 | [diff] [blame] | 35 | import platform |
Craig Tiller | 336ad50 | 2015-02-24 14:46:02 -0800 | [diff] [blame] | 36 | import signal |
Nicolas "Pixel" Noble | 5937b5b | 2015-06-26 02:04:12 +0200 | [diff] [blame] | 37 | import string |
Nicolas Noble | ddef246 | 2015-01-06 18:08:25 -0800 | [diff] [blame] | 38 | import subprocess |
| 39 | import sys |
ctiller | 3040cb7 | 2015-01-07 12:13:17 -0800 | [diff] [blame] | 40 | import tempfile |
| 41 | import time |
Nicolas "Pixel" Noble | 5937b5b | 2015-06-26 02:04:12 +0200 | [diff] [blame] | 42 | import xml.etree.cElementTree as ET |
Nicolas Noble | ddef246 | 2015-01-06 18:08:25 -0800 | [diff] [blame] | 43 | |
ctiller | 3040cb7 | 2015-01-07 12:13:17 -0800 | [diff] [blame] | 44 | |
ctiller | 94e5dde | 2015-01-09 10:41:59 -0800 | [diff] [blame] | 45 | _DEFAULT_MAX_JOBS = 16 * multiprocessing.cpu_count() |
Nicolas Noble | ddef246 | 2015-01-06 18:08:25 -0800 | [diff] [blame] | 46 | |
| 47 | |
Craig Tiller | 336ad50 | 2015-02-24 14:46:02 -0800 | [diff] [blame] | 48 | # setup a signal handler so that signal.pause registers 'something' |
| 49 | # when a child finishes |
| 50 | # not using futures and threading to avoid a dependency on subprocess32 |
Adele Zhou | e4c3561 | 2015-10-16 15:34:23 -0700 | [diff] [blame^] | 51 | if platform.system() == 'Windows': |
Craig Tiller | 5058c69 | 2015-04-08 09:42:04 -0700 | [diff] [blame] | 52 | pass |
| 53 | else: |
| 54 | have_alarm = False |
| 55 | def alarm_handler(unused_signum, unused_frame): |
| 56 | global have_alarm |
| 57 | have_alarm = False |
| 58 | |
| 59 | signal.signal(signal.SIGCHLD, lambda unused_signum, unused_frame: None) |
| 60 | signal.signal(signal.SIGALRM, alarm_handler) |
Craig Tiller | 336ad50 | 2015-02-24 14:46:02 -0800 | [diff] [blame] | 61 | |
| 62 | |
ctiller | 3040cb7 | 2015-01-07 12:13:17 -0800 | [diff] [blame] | 63 | _SUCCESS = object() |
| 64 | _FAILURE = object() |
| 65 | _RUNNING = object() |
| 66 | _KILLED = object() |
| 67 | |
| 68 | |
Craig Tiller | 3b08306 | 2015-01-12 13:51:28 -0800 | [diff] [blame] | 69 | _COLORS = { |
Nicolas Noble | 044db74 | 2015-01-14 16:57:24 -0800 | [diff] [blame] | 70 | 'red': [ 31, 0 ], |
| 71 | 'green': [ 32, 0 ], |
| 72 | 'yellow': [ 33, 0 ], |
| 73 | 'lightgray': [ 37, 0], |
| 74 | 'gray': [ 30, 1 ], |
Craig Tiller | d7e09c3 | 2015-09-25 11:33:39 -0700 | [diff] [blame] | 75 | 'purple': [ 35, 0 ], |
Craig Tiller | 3b08306 | 2015-01-12 13:51:28 -0800 | [diff] [blame] | 76 | } |
| 77 | |
| 78 | |
| 79 | _BEGINNING_OF_LINE = '\x1b[0G' |
| 80 | _CLEAR_LINE = '\x1b[2K' |
| 81 | |
| 82 | |
| 83 | _TAG_COLOR = { |
| 84 | 'FAILED': 'red', |
Craig Tiller | d7e09c3 | 2015-09-25 11:33:39 -0700 | [diff] [blame] | 85 | 'FLAKE': 'purple', |
Craig Tiller | 3dc1e4f | 2015-09-25 11:46:56 -0700 | [diff] [blame] | 86 | 'TIMEOUT_FLAKE': 'purple', |
Masood Malekghassemi | e5f7002 | 2015-06-29 09:20:26 -0700 | [diff] [blame] | 87 | 'WARNING': 'yellow', |
Craig Tiller | e1d0d1c | 2015-02-27 08:54:23 -0800 | [diff] [blame] | 88 | 'TIMEOUT': 'red', |
Craig Tiller | 3b08306 | 2015-01-12 13:51:28 -0800 | [diff] [blame] | 89 | 'PASSED': 'green', |
Nicolas Noble | 044db74 | 2015-01-14 16:57:24 -0800 | [diff] [blame] | 90 | 'START': 'gray', |
Craig Tiller | 3b08306 | 2015-01-12 13:51:28 -0800 | [diff] [blame] | 91 | 'WAITING': 'yellow', |
Nicolas Noble | 044db74 | 2015-01-14 16:57:24 -0800 | [diff] [blame] | 92 | 'SUCCESS': 'green', |
| 93 | 'IDLE': 'gray', |
Craig Tiller | 3b08306 | 2015-01-12 13:51:28 -0800 | [diff] [blame] | 94 | } |
| 95 | |
| 96 | |
Nicolas "Pixel" Noble | 99768ac | 2015-05-13 02:34:06 +0200 | [diff] [blame] | 97 | def message(tag, msg, explanatory_text=None, do_newline=False): |
| 98 | if message.old_tag == tag and message.old_msg == msg and not explanatory_text: |
| 99 | return |
| 100 | message.old_tag = tag |
| 101 | message.old_msg = msg |
Craig Tiller | 23d2f3f | 2015-02-24 15:23:32 -0800 | [diff] [blame] | 102 | try: |
Craig Tiller | 9f3b2d7 | 2015-08-25 11:50:57 -0700 | [diff] [blame] | 103 | if platform.system() == 'Windows' or not sys.stdout.isatty(): |
| 104 | if explanatory_text: |
| 105 | print explanatory_text |
| 106 | print '%s: %s' % (tag, msg) |
| 107 | return |
vjpai | a29d2d7 | 2015-07-08 10:31:15 -0700 | [diff] [blame] | 108 | sys.stdout.write('%s%s%s\x1b[%d;%dm%s\x1b[0m: %s%s' % ( |
| 109 | _BEGINNING_OF_LINE, |
| 110 | _CLEAR_LINE, |
| 111 | '\n%s' % explanatory_text if explanatory_text is not None else '', |
| 112 | _COLORS[_TAG_COLOR[tag]][1], |
| 113 | _COLORS[_TAG_COLOR[tag]][0], |
| 114 | tag, |
| 115 | msg, |
| 116 | '\n' if do_newline or explanatory_text is not None else '')) |
Craig Tiller | 23d2f3f | 2015-02-24 15:23:32 -0800 | [diff] [blame] | 117 | sys.stdout.flush() |
| 118 | except: |
| 119 | pass |
Craig Tiller | 3b08306 | 2015-01-12 13:51:28 -0800 | [diff] [blame] | 120 | |
Adele Zhou | e4c3561 | 2015-10-16 15:34:23 -0700 | [diff] [blame^] | 121 | message.old_tag = '' |
| 122 | message.old_msg = '' |
Craig Tiller | 3b08306 | 2015-01-12 13:51:28 -0800 | [diff] [blame] | 123 | |
Craig Tiller | 7173518 | 2015-01-15 17:07:13 -0800 | [diff] [blame] | 124 | def which(filename): |
| 125 | if '/' in filename: |
| 126 | return filename |
| 127 | for path in os.environ['PATH'].split(os.pathsep): |
| 128 | if os.path.exists(os.path.join(path, filename)): |
| 129 | return os.path.join(path, filename) |
| 130 | raise Exception('%s not found' % filename) |
| 131 | |
| 132 | |
Jan Tattermusch | 3ea4362 | 2015-10-14 16:35:15 -0700 | [diff] [blame] | 133 | def _filter_stdout(stdout): |
| 134 | """Filters out nonprintable and XML-illegal characters from stdout.""" |
| 135 | # keep whitespaces but remove formfeed and vertical tab characters |
| 136 | # that make XML report unparseable. |
| 137 | return filter(lambda x: x in string.printable and x != '\f' and x != '\v', |
| 138 | stdout.decode(errors='ignore')) |
| 139 | |
| 140 | |
Craig Tiller | 547db2b | 2015-01-30 14:08:39 -0800 | [diff] [blame] | 141 | class JobSpec(object): |
| 142 | """Specifies what to run for a job.""" |
| 143 | |
Jan Tattermusch | 725835a | 2015-08-01 21:02:35 -0700 | [diff] [blame] | 144 | def __init__(self, cmdline, shortname=None, environ=None, hash_targets=None, |
Craig Tiller | 95cc07b | 2015-09-28 13:41:30 -0700 | [diff] [blame] | 145 | cwd=None, shell=False, timeout_seconds=5*60, flake_retries=0, |
Jan Tattermusch | e268628 | 2015-10-08 16:27:07 -0700 | [diff] [blame] | 146 | timeout_retries=0, kill_handler=None): |
Craig Tiller | 547db2b | 2015-01-30 14:08:39 -0800 | [diff] [blame] | 147 | """ |
| 148 | Arguments: |
| 149 | cmdline: a list of arguments to pass as the command line |
| 150 | environ: a dictionary of environment variables to set in the child process |
| 151 | hash_targets: which files to include in the hash representing the jobs version |
| 152 | (or empty, indicating the job should not be hashed) |
Jan Tattermusch | e268628 | 2015-10-08 16:27:07 -0700 | [diff] [blame] | 153 | kill_handler: a handler that will be called whenever job.kill() is invoked |
Craig Tiller | 547db2b | 2015-01-30 14:08:39 -0800 | [diff] [blame] | 154 | """ |
murgatroid99 | 132ce6a | 2015-03-04 17:29:14 -0800 | [diff] [blame] | 155 | if environ is None: |
| 156 | environ = {} |
| 157 | if hash_targets is None: |
| 158 | hash_targets = [] |
Craig Tiller | 547db2b | 2015-01-30 14:08:39 -0800 | [diff] [blame] | 159 | self.cmdline = cmdline |
| 160 | self.environ = environ |
| 161 | self.shortname = cmdline[0] if shortname is None else shortname |
| 162 | self.hash_targets = hash_targets or [] |
Craig Tiller | 5058c69 | 2015-04-08 09:42:04 -0700 | [diff] [blame] | 163 | self.cwd = cwd |
Jan Tattermusch | e824359 | 2015-04-17 14:14:01 -0700 | [diff] [blame] | 164 | self.shell = shell |
Jan Tattermusch | 725835a | 2015-08-01 21:02:35 -0700 | [diff] [blame] | 165 | self.timeout_seconds = timeout_seconds |
Craig Tiller | 91318bc | 2015-09-24 08:58:39 -0700 | [diff] [blame] | 166 | self.flake_retries = flake_retries |
Craig Tiller | bfc8a06 | 2015-09-28 14:40:21 -0700 | [diff] [blame] | 167 | self.timeout_retries = timeout_retries |
Jan Tattermusch | e268628 | 2015-10-08 16:27:07 -0700 | [diff] [blame] | 168 | self.kill_handler = kill_handler |
Craig Tiller | 547db2b | 2015-01-30 14:08:39 -0800 | [diff] [blame] | 169 | |
| 170 | def identity(self): |
| 171 | return '%r %r %r' % (self.cmdline, self.environ, self.hash_targets) |
| 172 | |
| 173 | def __hash__(self): |
| 174 | return hash(self.identity()) |
| 175 | |
| 176 | def __cmp__(self, other): |
| 177 | return self.identity() == other.identity() |
| 178 | |
| 179 | |
Adele Zhou | e4c3561 | 2015-10-16 15:34:23 -0700 | [diff] [blame^] | 180 | class JobResult(object): |
| 181 | def __init__(self): |
| 182 | self.state = 'UNKNOWN' |
| 183 | self.returncode = -1 |
| 184 | self.elapsed_time = 0 |
| 185 | self.retries = 0 |
| 186 | self.message = '' |
| 187 | |
| 188 | |
ctiller | 3040cb7 | 2015-01-07 12:13:17 -0800 | [diff] [blame] | 189 | class Job(object): |
| 190 | """Manages one job.""" |
| 191 | |
Craig Tiller | f53d9c8 | 2015-08-04 14:19:43 -0700 | [diff] [blame] | 192 | def __init__(self, spec, bin_hash, newline_on_success, travis, add_env, xml_report): |
Craig Tiller | 547db2b | 2015-01-30 14:08:39 -0800 | [diff] [blame] | 193 | self._spec = spec |
Craig Tiller | 7173518 | 2015-01-15 17:07:13 -0800 | [diff] [blame] | 194 | self._bin_hash = bin_hash |
Nicolas Noble | 044db74 | 2015-01-14 16:57:24 -0800 | [diff] [blame] | 195 | self._newline_on_success = newline_on_success |
Nicolas "Pixel" Noble | a7df3f9 | 2015-02-26 22:07:04 +0100 | [diff] [blame] | 196 | self._travis = travis |
Craig Tiller | 91318bc | 2015-09-24 08:58:39 -0700 | [diff] [blame] | 197 | self._add_env = add_env.copy() |
Nicolas "Pixel" Noble | 5937b5b | 2015-06-26 02:04:12 +0200 | [diff] [blame] | 198 | self._xml_test = ET.SubElement(xml_report, 'testcase', |
| 199 | name=self._spec.shortname) if xml_report is not None else None |
Craig Tiller | 91318bc | 2015-09-24 08:58:39 -0700 | [diff] [blame] | 200 | self._retries = 0 |
Craig Tiller | 95cc07b | 2015-09-28 13:41:30 -0700 | [diff] [blame] | 201 | self._timeout_retries = 0 |
Jan Tattermusch | 91ad018 | 2015-10-01 09:22:03 -0700 | [diff] [blame] | 202 | self._suppress_failure_message = False |
Craig Tiller | b84728d | 2015-02-26 15:40:39 -0800 | [diff] [blame] | 203 | message('START', spec.shortname, do_newline=self._travis) |
Adele Zhou | e4c3561 | 2015-10-16 15:34:23 -0700 | [diff] [blame^] | 204 | self.result = JobResult() |
Craig Tiller | 91318bc | 2015-09-24 08:58:39 -0700 | [diff] [blame] | 205 | self.start() |
| 206 | |
Adele Zhou | e4c3561 | 2015-10-16 15:34:23 -0700 | [diff] [blame^] | 207 | def GetSpec(self): |
| 208 | return self._spec |
| 209 | |
Craig Tiller | 91318bc | 2015-09-24 08:58:39 -0700 | [diff] [blame] | 210 | def start(self): |
| 211 | self._tempfile = tempfile.TemporaryFile() |
| 212 | env = dict(os.environ) |
| 213 | env.update(self._spec.environ) |
| 214 | env.update(self._add_env) |
| 215 | self._start = time.time() |
| 216 | self._process = subprocess.Popen(args=self._spec.cmdline, |
| 217 | stderr=subprocess.STDOUT, |
| 218 | stdout=self._tempfile, |
| 219 | cwd=self._spec.cwd, |
| 220 | shell=self._spec.shell, |
| 221 | env=env) |
| 222 | self._state = _RUNNING |
ctiller | 3040cb7 | 2015-01-07 12:13:17 -0800 | [diff] [blame] | 223 | |
Craig Tiller | 7173518 | 2015-01-15 17:07:13 -0800 | [diff] [blame] | 224 | def state(self, update_cache): |
ctiller | 3040cb7 | 2015-01-07 12:13:17 -0800 | [diff] [blame] | 225 | """Poll current state of the job. Prints messages at completion.""" |
| 226 | if self._state == _RUNNING and self._process.poll() is not None: |
Craig Tiller | 9d6139a | 2015-02-26 15:24:43 -0800 | [diff] [blame] | 227 | elapsed = time.time() - self._start |
Nicolas "Pixel" Noble | 5937b5b | 2015-06-26 02:04:12 +0200 | [diff] [blame] | 228 | self._tempfile.seek(0) |
| 229 | stdout = self._tempfile.read() |
Jan Tattermusch | 3ea4362 | 2015-10-14 16:35:15 -0700 | [diff] [blame] | 230 | filtered_stdout = _filter_stdout(stdout) |
Nicolas "Pixel" Noble | 4a5a8f3 | 2015-08-13 19:43:00 +0200 | [diff] [blame] | 231 | # TODO: looks like jenkins master is slow because parsing the junit results XMLs is not |
| 232 | # implemented efficiently. This is an experiment to workaround the issue by making sure |
| 233 | # results.xml file is small enough. |
| 234 | filtered_stdout = filtered_stdout[-128:] |
Adele Zhou | e4c3561 | 2015-10-16 15:34:23 -0700 | [diff] [blame^] | 235 | self.result.message = filtered_stdout |
| 236 | self.result.elapsed_time = elapsed |
Nicolas "Pixel" Noble | 5937b5b | 2015-06-26 02:04:12 +0200 | [diff] [blame] | 237 | if self._xml_test is not None: |
| 238 | self._xml_test.set('time', str(elapsed)) |
| 239 | ET.SubElement(self._xml_test, 'system-out').text = filtered_stdout |
ctiller | 3040cb7 | 2015-01-07 12:13:17 -0800 | [diff] [blame] | 240 | if self._process.returncode != 0: |
Craig Tiller | 91318bc | 2015-09-24 08:58:39 -0700 | [diff] [blame] | 241 | if self._retries < self._spec.flake_retries: |
| 242 | message('FLAKE', '%s [ret=%d, pid=%d]' % ( |
Craig Tiller | d0ffe14 | 2015-05-19 21:51:13 -0700 | [diff] [blame] | 243 | self._spec.shortname, self._process.returncode, self._process.pid), |
| 244 | stdout, do_newline=True) |
Craig Tiller | 91318bc | 2015-09-24 08:58:39 -0700 | [diff] [blame] | 245 | self._retries += 1 |
Adele Zhou | e4c3561 | 2015-10-16 15:34:23 -0700 | [diff] [blame^] | 246 | self.result.retries = self._timeout_retries + self._retries |
Craig Tiller | 91318bc | 2015-09-24 08:58:39 -0700 | [diff] [blame] | 247 | self.start() |
| 248 | else: |
| 249 | self._state = _FAILURE |
Jan Tattermusch | 91ad018 | 2015-10-01 09:22:03 -0700 | [diff] [blame] | 250 | if not self._suppress_failure_message: |
| 251 | message('FAILED', '%s [ret=%d, pid=%d]' % ( |
| 252 | self._spec.shortname, self._process.returncode, self._process.pid), |
| 253 | stdout, do_newline=True) |
Adele Zhou | e4c3561 | 2015-10-16 15:34:23 -0700 | [diff] [blame^] | 254 | self.result.state = 'FAILED' |
| 255 | self.result.returncode = self._process.returncode |
Craig Tiller | 91318bc | 2015-09-24 08:58:39 -0700 | [diff] [blame] | 256 | if self._xml_test is not None: |
Jan Tattermusch | 3ea4362 | 2015-10-14 16:35:15 -0700 | [diff] [blame] | 257 | ET.SubElement(self._xml_test, 'failure', message='Failure') |
ctiller | 3040cb7 | 2015-01-07 12:13:17 -0800 | [diff] [blame] | 258 | else: |
| 259 | self._state = _SUCCESS |
Craig Tiller | 95cc07b | 2015-09-28 13:41:30 -0700 | [diff] [blame] | 260 | message('PASSED', '%s [time=%.1fsec; retries=%d;%d]' % ( |
| 261 | self._spec.shortname, elapsed, self._retries, self._timeout_retries), |
| 262 | do_newline=self._newline_on_success or self._travis) |
Adele Zhou | e4c3561 | 2015-10-16 15:34:23 -0700 | [diff] [blame^] | 263 | self.result.state = 'PASSED' |
Craig Tiller | 547db2b | 2015-01-30 14:08:39 -0800 | [diff] [blame] | 264 | if self._bin_hash: |
| 265 | update_cache.finished(self._spec.identity(), self._bin_hash) |
Jan Tattermusch | 725835a | 2015-08-01 21:02:35 -0700 | [diff] [blame] | 266 | elif self._state == _RUNNING and time.time() - self._start > self._spec.timeout_seconds: |
Craig Tiller | 8421678 | 2015-05-12 09:43:54 -0700 | [diff] [blame] | 267 | self._tempfile.seek(0) |
| 268 | stdout = self._tempfile.read() |
Jan Tattermusch | 3ea4362 | 2015-10-14 16:35:15 -0700 | [diff] [blame] | 269 | filtered_stdout = _filter_stdout(stdout) |
Adele Zhou | e4c3561 | 2015-10-16 15:34:23 -0700 | [diff] [blame^] | 270 | self.result.message = filtered_stdout |
Craig Tiller | 95cc07b | 2015-09-28 13:41:30 -0700 | [diff] [blame] | 271 | if self._timeout_retries < self._spec.timeout_retries: |
Craig Tiller | 3dc1e4f | 2015-09-25 11:46:56 -0700 | [diff] [blame] | 272 | message('TIMEOUT_FLAKE', self._spec.shortname, stdout, do_newline=True) |
Craig Tiller | 95cc07b | 2015-09-28 13:41:30 -0700 | [diff] [blame] | 273 | self._timeout_retries += 1 |
Adele Zhou | e4c3561 | 2015-10-16 15:34:23 -0700 | [diff] [blame^] | 274 | self.result.retries = self._timeout_retries + self._retries |
Craig Tiller | 3dc1e4f | 2015-09-25 11:46:56 -0700 | [diff] [blame] | 275 | self._process.terminate() |
| 276 | self.start() |
| 277 | else: |
| 278 | message('TIMEOUT', self._spec.shortname, stdout, do_newline=True) |
| 279 | self.kill() |
Adele Zhou | e4c3561 | 2015-10-16 15:34:23 -0700 | [diff] [blame^] | 280 | self.result.state = 'TIMEOUT' |
Craig Tiller | 3dc1e4f | 2015-09-25 11:46:56 -0700 | [diff] [blame] | 281 | if self._xml_test is not None: |
| 282 | ET.SubElement(self._xml_test, 'system-out').text = filtered_stdout |
| 283 | ET.SubElement(self._xml_test, 'error', message='Timeout') |
ctiller | 3040cb7 | 2015-01-07 12:13:17 -0800 | [diff] [blame] | 284 | return self._state |
| 285 | |
| 286 | def kill(self): |
| 287 | if self._state == _RUNNING: |
| 288 | self._state = _KILLED |
Jan Tattermusch | e268628 | 2015-10-08 16:27:07 -0700 | [diff] [blame] | 289 | if self._spec.kill_handler: |
| 290 | self._spec.kill_handler(self) |
ctiller | 3040cb7 | 2015-01-07 12:13:17 -0800 | [diff] [blame] | 291 | self._process.terminate() |
| 292 | |
Jan Tattermusch | 91ad018 | 2015-10-01 09:22:03 -0700 | [diff] [blame] | 293 | def suppress_failure_message(self): |
| 294 | self._suppress_failure_message = True |
| 295 | |
ctiller | 3040cb7 | 2015-01-07 12:13:17 -0800 | [diff] [blame] | 296 | |
Nicolas Noble | ddef246 | 2015-01-06 18:08:25 -0800 | [diff] [blame] | 297 | class Jobset(object): |
| 298 | """Manages one run of jobs.""" |
| 299 | |
Craig Tiller | 533b1a2 | 2015-05-29 08:41:29 -0700 | [diff] [blame] | 300 | def __init__(self, check_cancelled, maxjobs, newline_on_success, travis, |
Craig Tiller | f53d9c8 | 2015-08-04 14:19:43 -0700 | [diff] [blame] | 301 | stop_on_failure, add_env, cache, xml_report): |
ctiller | 3040cb7 | 2015-01-07 12:13:17 -0800 | [diff] [blame] | 302 | self._running = set() |
| 303 | self._check_cancelled = check_cancelled |
| 304 | self._cancelled = False |
Nicolas Noble | ddef246 | 2015-01-06 18:08:25 -0800 | [diff] [blame] | 305 | self._failures = 0 |
Craig Tiller | 738c334 | 2015-01-12 14:28:33 -0800 | [diff] [blame] | 306 | self._completed = 0 |
ctiller | 94e5dde | 2015-01-09 10:41:59 -0800 | [diff] [blame] | 307 | self._maxjobs = maxjobs |
Nicolas Noble | 044db74 | 2015-01-14 16:57:24 -0800 | [diff] [blame] | 308 | self._newline_on_success = newline_on_success |
Nicolas "Pixel" Noble | a7df3f9 | 2015-02-26 22:07:04 +0100 | [diff] [blame] | 309 | self._travis = travis |
Craig Tiller | 7173518 | 2015-01-15 17:07:13 -0800 | [diff] [blame] | 310 | self._cache = cache |
Craig Tiller | 533b1a2 | 2015-05-29 08:41:29 -0700 | [diff] [blame] | 311 | self._stop_on_failure = stop_on_failure |
Craig Tiller | 74e770d | 2015-06-11 09:38:09 -0700 | [diff] [blame] | 312 | self._hashes = {} |
Nicolas "Pixel" Noble | 5937b5b | 2015-06-26 02:04:12 +0200 | [diff] [blame] | 313 | self._xml_report = xml_report |
Craig Tiller | f53d9c8 | 2015-08-04 14:19:43 -0700 | [diff] [blame] | 314 | self._add_env = add_env |
Adele Zhou | e4c3561 | 2015-10-16 15:34:23 -0700 | [diff] [blame^] | 315 | self.resultset = {} |
| 316 | |
| 317 | def get_num_failures(self): |
| 318 | return self._failures |
Nicolas Noble | ddef246 | 2015-01-06 18:08:25 -0800 | [diff] [blame] | 319 | |
Craig Tiller | 547db2b | 2015-01-30 14:08:39 -0800 | [diff] [blame] | 320 | def start(self, spec): |
ctiller | 3040cb7 | 2015-01-07 12:13:17 -0800 | [diff] [blame] | 321 | """Start a job. Return True on success, False on failure.""" |
ctiller | 94e5dde | 2015-01-09 10:41:59 -0800 | [diff] [blame] | 322 | while len(self._running) >= self._maxjobs: |
ctiller | 3040cb7 | 2015-01-07 12:13:17 -0800 | [diff] [blame] | 323 | if self.cancelled(): return False |
| 324 | self.reap() |
| 325 | if self.cancelled(): return False |
Craig Tiller | 547db2b | 2015-01-30 14:08:39 -0800 | [diff] [blame] | 326 | if spec.hash_targets: |
Craig Tiller | 74e770d | 2015-06-11 09:38:09 -0700 | [diff] [blame] | 327 | if spec.identity() in self._hashes: |
| 328 | bin_hash = self._hashes[spec.identity()] |
| 329 | else: |
| 330 | bin_hash = hashlib.sha1() |
| 331 | for fn in spec.hash_targets: |
| 332 | with open(which(fn)) as f: |
| 333 | bin_hash.update(f.read()) |
| 334 | bin_hash = bin_hash.hexdigest() |
| 335 | self._hashes[spec.identity()] = bin_hash |
Craig Tiller | 547db2b | 2015-01-30 14:08:39 -0800 | [diff] [blame] | 336 | should_run = self._cache.should_run(spec.identity(), bin_hash) |
| 337 | else: |
| 338 | bin_hash = None |
| 339 | should_run = True |
| 340 | if should_run: |
Adele Zhou | e4c3561 | 2015-10-16 15:34:23 -0700 | [diff] [blame^] | 341 | job = Job(spec, |
| 342 | bin_hash, |
| 343 | self._newline_on_success, |
| 344 | self._travis, |
| 345 | self._add_env, |
| 346 | self._xml_report) |
| 347 | self._running.add(job) |
| 348 | self.resultset[job.GetSpec().shortname] = None |
ctiller | 3040cb7 | 2015-01-07 12:13:17 -0800 | [diff] [blame] | 349 | return True |
Nicolas Noble | ddef246 | 2015-01-06 18:08:25 -0800 | [diff] [blame] | 350 | |
ctiller | 3040cb7 | 2015-01-07 12:13:17 -0800 | [diff] [blame] | 351 | def reap(self): |
| 352 | """Collect the dead jobs.""" |
| 353 | while self._running: |
| 354 | dead = set() |
| 355 | for job in self._running: |
Craig Tiller | 7173518 | 2015-01-15 17:07:13 -0800 | [diff] [blame] | 356 | st = job.state(self._cache) |
ctiller | 3040cb7 | 2015-01-07 12:13:17 -0800 | [diff] [blame] | 357 | if st == _RUNNING: continue |
Craig Tiller | 533b1a2 | 2015-05-29 08:41:29 -0700 | [diff] [blame] | 358 | if st == _FAILURE or st == _KILLED: |
| 359 | self._failures += 1 |
| 360 | if self._stop_on_failure: |
| 361 | self._cancelled = True |
| 362 | for job in self._running: |
| 363 | job.kill() |
ctiller | 3040cb7 | 2015-01-07 12:13:17 -0800 | [diff] [blame] | 364 | dead.add(job) |
Craig Tiller | 74e770d | 2015-06-11 09:38:09 -0700 | [diff] [blame] | 365 | break |
ctiller | 3040cb7 | 2015-01-07 12:13:17 -0800 | [diff] [blame] | 366 | for job in dead: |
Craig Tiller | 738c334 | 2015-01-12 14:28:33 -0800 | [diff] [blame] | 367 | self._completed += 1 |
Adele Zhou | e4c3561 | 2015-10-16 15:34:23 -0700 | [diff] [blame^] | 368 | self.resultset[job.GetSpec().shortname] = job.result |
ctiller | 3040cb7 | 2015-01-07 12:13:17 -0800 | [diff] [blame] | 369 | self._running.remove(job) |
Craig Tiller | 3b08306 | 2015-01-12 13:51:28 -0800 | [diff] [blame] | 370 | if dead: return |
Nicolas "Pixel" Noble | a7df3f9 | 2015-02-26 22:07:04 +0100 | [diff] [blame] | 371 | if (not self._travis): |
| 372 | message('WAITING', '%d jobs running, %d complete, %d failed' % ( |
| 373 | len(self._running), self._completed, self._failures)) |
Craig Tiller | 5058c69 | 2015-04-08 09:42:04 -0700 | [diff] [blame] | 374 | if platform.system() == 'Windows': |
| 375 | time.sleep(0.1) |
| 376 | else: |
| 377 | global have_alarm |
| 378 | if not have_alarm: |
| 379 | have_alarm = True |
| 380 | signal.alarm(10) |
| 381 | signal.pause() |
ctiller | 3040cb7 | 2015-01-07 12:13:17 -0800 | [diff] [blame] | 382 | |
| 383 | def cancelled(self): |
| 384 | """Poll for cancellation.""" |
| 385 | if self._cancelled: return True |
| 386 | if not self._check_cancelled(): return False |
| 387 | for job in self._running: |
| 388 | job.kill() |
| 389 | self._cancelled = True |
| 390 | return True |
| 391 | |
| 392 | def finish(self): |
| 393 | while self._running: |
| 394 | if self.cancelled(): pass # poll cancellation |
| 395 | self.reap() |
| 396 | return not self.cancelled() and self._failures == 0 |
Nicolas Noble | ddef246 | 2015-01-06 18:08:25 -0800 | [diff] [blame] | 397 | |
| 398 | |
ctiller | 3040cb7 | 2015-01-07 12:13:17 -0800 | [diff] [blame] | 399 | def _never_cancelled(): |
| 400 | return False |
| 401 | |
| 402 | |
Craig Tiller | 7173518 | 2015-01-15 17:07:13 -0800 | [diff] [blame] | 403 | # cache class that caches nothing |
| 404 | class NoCache(object): |
| 405 | def should_run(self, cmdline, bin_hash): |
| 406 | return True |
| 407 | |
| 408 | def finished(self, cmdline, bin_hash): |
| 409 | pass |
| 410 | |
| 411 | |
Nicolas Noble | b09078f | 2015-01-14 18:06:05 -0800 | [diff] [blame] | 412 | def run(cmdlines, |
| 413 | check_cancelled=_never_cancelled, |
| 414 | maxjobs=None, |
Craig Tiller | 7173518 | 2015-01-15 17:07:13 -0800 | [diff] [blame] | 415 | newline_on_success=False, |
Nicolas "Pixel" Noble | a7df3f9 | 2015-02-26 22:07:04 +0100 | [diff] [blame] | 416 | travis=False, |
David Garcia Quintas | e90cd37 | 2015-05-31 18:15:26 -0700 | [diff] [blame] | 417 | infinite_runs=False, |
Craig Tiller | 533b1a2 | 2015-05-29 08:41:29 -0700 | [diff] [blame] | 418 | stop_on_failure=False, |
Nicolas "Pixel" Noble | 5937b5b | 2015-06-26 02:04:12 +0200 | [diff] [blame] | 419 | cache=None, |
Craig Tiller | f53d9c8 | 2015-08-04 14:19:43 -0700 | [diff] [blame] | 420 | xml_report=None, |
| 421 | add_env={}): |
ctiller | 94e5dde | 2015-01-09 10:41:59 -0800 | [diff] [blame] | 422 | js = Jobset(check_cancelled, |
Nicolas Noble | 044db74 | 2015-01-14 16:57:24 -0800 | [diff] [blame] | 423 | maxjobs if maxjobs is not None else _DEFAULT_MAX_JOBS, |
Craig Tiller | f53d9c8 | 2015-08-04 14:19:43 -0700 | [diff] [blame] | 424 | newline_on_success, travis, stop_on_failure, add_env, |
Nicolas "Pixel" Noble | 5937b5b | 2015-06-26 02:04:12 +0200 | [diff] [blame] | 425 | cache if cache is not None else NoCache(), |
| 426 | xml_report) |
Craig Tiller | b84728d | 2015-02-26 15:40:39 -0800 | [diff] [blame] | 427 | for cmdline in cmdlines: |
ctiller | 3040cb7 | 2015-01-07 12:13:17 -0800 | [diff] [blame] | 428 | if not js.start(cmdline): |
| 429 | break |
Adele Zhou | e4c3561 | 2015-10-16 15:34:23 -0700 | [diff] [blame^] | 430 | js.finish() |
| 431 | return js.get_num_failures(), js.resultset |