1 from __future__ import absolute_import
2 import os, signal, subprocess, sys
7 import lit.ShUtil as ShUtil
8 import lit.Test as Test
11 class InternalShellError(Exception):
12 def __init__(self, command, message):
13 self.command = command
14 self.message = message
16 kIsWindows = platform.system() == 'Windows'
18 # Don't use close_fds on Windows.
19 kUseCloseFDs = not kIsWindows
21 # Use temporary files to replace /dev/null on Windows.
22 kAvoidDevNull = kIsWindows
24 def executeShCmd(cmd, cfg, cwd, results):
25 if isinstance(cmd, ShUtil.Seq):
27 res = executeShCmd(cmd.lhs, cfg, cwd, results)
28 return executeShCmd(cmd.rhs, cfg, cwd, results)
31 raise InternalShellError(cmd,"unsupported shell operator: '&'")
34 res = executeShCmd(cmd.lhs, cfg, cwd, results)
36 res = executeShCmd(cmd.rhs, cfg, cwd, results)
40 res = executeShCmd(cmd.lhs, cfg, cwd, results)
45 res = executeShCmd(cmd.rhs, cfg, cwd, results)
48 raise ValueError('Unknown shell command: %r' % cmd.op)
50 assert isinstance(cmd, ShUtil.Pipeline)
52 input = subprocess.PIPE
56 # To avoid deadlock, we use a single stderr stream for piped
57 # output. This is null until we have seen some output using
59 for i,j in enumerate(cmd.commands):
60 # Apply the redirections, we use (N,) as a sentinel to indicate stdin,
61 # stdout, stderr for N equal to 0, 1, or 2 respectively. Redirects to or
62 # from a file are represented with a list [file, mode, file-object]
63 # where file-object is initially None.
64 redirects = [(0,), (1,), (2,)]
67 redirects[2] = [r[1], 'w', None]
68 elif r[0] == ('>>',2):
69 redirects[2] = [r[1], 'a', None]
70 elif r[0] == ('>&',2) and r[1] in '012':
71 redirects[2] = redirects[int(r[1])]
72 elif r[0] == ('>&',) or r[0] == ('&>',):
73 redirects[1] = redirects[2] = [r[1], 'w', None]
75 redirects[1] = [r[1], 'w', None]
77 redirects[1] = [r[1], 'a', None]
79 redirects[0] = [r[1], 'r', None]
81 raise InternalShellError(j,"Unsupported redirect: %r" % (r,))
83 # Map from the final redirections to something subprocess can handle.
85 for index,r in enumerate(redirects):
90 raise InternalShellError(j,"Unsupported redirect for stdin")
92 result = subprocess.PIPE
94 result = subprocess.STDOUT
97 raise InternalShellError(j,"Unsupported redirect on stdout")
98 result = subprocess.PIPE
101 if kAvoidDevNull and r[0] == '/dev/null':
102 r[2] = tempfile.TemporaryFile(mode=r[1])
104 r[2] = open(r[0], r[1])
105 # Workaround a Win32 and/or subprocess bug when appending.
107 # FIXME: Actually, this is probably an instance of PR6753.
110 opened_files.append(r[2])
112 final_redirects.append(result)
114 stdin, stdout, stderr = final_redirects
116 # If stderr wants to come from stdout, but stdout isn't a pipe, then put
117 # stderr on a pipe and treat it as stdout.
118 if (stderr == subprocess.STDOUT and stdout != subprocess.PIPE):
119 stderr = subprocess.PIPE
120 stderrIsStdout = True
122 stderrIsStdout = False
124 # Don't allow stderr on a PIPE except for the last
125 # process, this could deadlock.
127 # FIXME: This is slow, but so is deadlock.
128 if stderr == subprocess.PIPE and j != cmd.commands[-1]:
129 stderr = tempfile.TemporaryFile(mode='w+b')
130 stderrTempFiles.append((i, stderr))
132 # Resolve the executable path ourselves.
134 args[0] = lit.util.which(args[0], cfg.environment['PATH'])
136 raise InternalShellError(j, '%r: command not found' % j.args[0])
138 # Replace uses of /dev/null with temporary files.
140 for i,arg in enumerate(args):
141 if arg == "/dev/null":
142 f = tempfile.NamedTemporaryFile(delete=False)
144 named_temp_files.append(f.name)
147 procs.append(subprocess.Popen(args, cwd=cwd,
151 env = cfg.environment,
152 close_fds = kUseCloseFDs))
154 # Immediately close stdin for any process taking stdin from us.
155 if stdin == subprocess.PIPE:
156 procs[-1].stdin.close()
157 procs[-1].stdin = None
159 # Update the current stdin source.
160 if stdout == subprocess.PIPE:
161 input = procs[-1].stdout
163 input = procs[-1].stderr
165 input = subprocess.PIPE
167 # Explicitly close any redirected files. We need to do this now because we
168 # need to release any handles we may have on the temporary files (important
169 # on Win32, for example). Since we have already spawned the subprocess, our
170 # handles have already been transferred so we do not need them anymore.
171 for f in opened_files:
174 # FIXME: There is probably still deadlock potential here. Yawn.
175 procData = [None] * len(procs)
176 procData[-1] = procs[-1].communicate()
178 for i in range(len(procs) - 1):
179 if procs[i].stdout is not None:
180 out = procs[i].stdout.read()
183 if procs[i].stderr is not None:
184 err = procs[i].stderr.read()
187 procData[i] = (out,err)
189 # Read stderr out of the temp files.
190 for i,f in stderrTempFiles:
192 procData[i] = (procData[i][0], f.read())
195 for i,(out,err) in enumerate(procData):
196 res = procs[i].wait()
197 # Detect Ctrl-C in subprocess.
198 if res == -signal.SIGINT:
199 raise KeyboardInterrupt
201 # Ensure the resulting output is always of string type.
203 out = str(out.decode('ascii'))
207 err = str(err.decode('ascii'))
211 results.append((cmd.commands[i], out, err, res))
213 # Python treats the exit code as a signed char.
217 exitCode = min(exitCode, res)
219 exitCode = max(exitCode, res)
223 # Remove any named temporary files we created.
224 for f in named_temp_files:
231 exitCode = not exitCode
235 def executeScriptInternal(test, litConfig, tmpBase, commands, cwd):
239 cmds.append(ShUtil.ShParser(ln, litConfig.isWindows,
240 test.config.pipefail).parse())
242 return (Test.FAIL, "shell parser error on: %r" % ln)
246 cmd = ShUtil.Seq(cmd, '&&', c)
250 exitCode = executeShCmd(cmd, test.config, cwd, results)
251 except InternalShellError:
252 e = sys.exc_info()[1]
254 results.append((e.command, '', e.message, exitCode))
257 for i,(cmd, cmd_out,cmd_err,res) in enumerate(results):
258 out += 'Command %d: %s\n' % (i, ' '.join('"%s"' % s for s in cmd.args))
259 out += 'Command %d Result: %r\n' % (i, res)
260 out += 'Command %d Output:\n%s\n\n' % (i, cmd_out)
261 out += 'Command %d Stderr:\n%s\n\n' % (i, cmd_err)
263 return out, err, exitCode
265 def executeScript(test, litConfig, tmpBase, commands, cwd):
266 bashPath = litConfig.getBashPath();
267 isWin32CMDEXE = (litConfig.isWindows and not bashPath)
268 script = tmpBase + '.script'
274 if litConfig.isWindows and not isWin32CMDEXE:
275 mode += 'b' # Avoid CRLFs when writing bash scripts.
276 f = open(script, mode)
278 f.write('\nif %ERRORLEVEL% NEQ 0 EXIT\n'.join(commands))
280 if test.config.pipefail:
281 f.write('set -o pipefail;')
282 f.write('{ ' + '; } &&\n{ '.join(commands) + '; }')
287 command = ['cmd','/c', script]
290 command = [bashPath, script]
292 command = ['/bin/sh', script]
293 if litConfig.useValgrind:
294 # FIXME: Running valgrind on sh is overkill. We probably could just
295 # run on clang with no real loss.
296 command = litConfig.valgrindArgs + command
298 return lit.util.executeCommand(command, cwd=cwd,
299 env=test.config.environment)
301 def parseIntegratedTestScriptCommands(source_path):
303 parseIntegratedTestScriptCommands(source_path) -> commands
305 Parse the commands in an integrated test script file into a list of
306 (line_number, command_type, line).
309 # This code is carefully written to be dual compatible with Python 2.5+ and
310 # Python 3 without requiring input files to always have valid codings. The
311 # trick we use is to open the file in binary mode and use the regular
312 # expression library to find the commands, with it scanning strings in
313 # Python2 and bytes in Python3.
315 # Once we find a match, we do require each script line to be decodable to
316 # ascii, so we convert the outputs to ascii before returning. This way the
317 # remaining code can work with "strings" agnostic of the executing Python
321 # Encode to Latin1 to get binary data.
322 return str.encode('ISO-8859-1')
323 keywords = ('RUN:', 'XFAIL:', 'REQUIRES:', 'END.')
324 keywords_re = re.compile(
325 to_bytes("(%s)(.*)\n" % ("|".join(k for k in keywords),)))
327 f = open(source_path, 'rb')
329 # Read the entire file contents.
332 # Iterate over the matches.
334 last_match_position = 0
335 for match in keywords_re.finditer(data):
336 # Compute the updated line number by counting the intervening
338 match_position = match.start()
339 line_number += data.count(to_bytes('\n'), last_match_position,
341 last_match_position = match_position
343 # Convert the keyword and line to ascii strings and yield the
344 # command. Note that we take care to return regular strings in
345 # Python 2, to avoid other code having to differentiate between the
346 # str and unicode types.
347 keyword,ln = match.groups()
348 yield (line_number, str(keyword[:-1].decode('ascii')),
349 str(ln.decode('ascii')))
353 def parseIntegratedTestScript(test, normalize_slashes=False,
354 extra_substitutions=[]):
355 """parseIntegratedTestScript - Scan an LLVM/Clang style integrated test
356 script and extract the lines to 'RUN' as well as 'XFAIL' and 'REQUIRES'
357 information. The RUN lines also will have variable substitution performed.
360 # Get the temporary location, this is always relative to the test suite
361 # root, not test source root.
363 # FIXME: This should not be here?
364 sourcepath = test.getSourcePath()
365 sourcedir = os.path.dirname(sourcepath)
366 execpath = test.getExecPath()
367 execdir,execbase = os.path.split(execpath)
368 tmpDir = os.path.join(execdir, 'Output')
369 tmpBase = os.path.join(tmpDir, execbase)
371 # Normalize slashes, if requested.
372 if normalize_slashes:
373 sourcepath = sourcepath.replace('\\', '/')
374 sourcedir = sourcedir.replace('\\', '/')
375 tmpDir = tmpDir.replace('\\', '/')
376 tmpBase = tmpBase.replace('\\', '/')
378 # We use #_MARKER_# to hide %% while we do the other substitutions.
379 substitutions = list(extra_substitutions)
380 substitutions.extend([('%%', '#_MARKER_#')])
381 substitutions.extend(test.config.substitutions)
382 substitutions.extend([('%s', sourcepath),
385 ('%{pathsep}', os.pathsep),
386 ('%t', tmpBase + '.tmp'),
388 ('#_MARKER_#', '%')])
390 # "%/[STpst]" should be normalized.
391 substitutions.extend([
392 ('%/s', sourcepath.replace('\\', '/')),
393 ('%/S', sourcedir.replace('\\', '/')),
394 ('%/p', sourcedir.replace('\\', '/')),
395 ('%/t', tmpBase.replace('\\', '/') + '.tmp'),
396 ('%/T', tmpDir.replace('\\', '/')),
399 # Collect the test lines from the script.
402 for line_number, command_type, ln in \
403 parseIntegratedTestScriptCommands(sourcepath):
404 if command_type == 'RUN':
405 # Trim trailing whitespace.
408 # Substitute line number expressions
409 ln = re.sub('%\(line\)', str(line_number), ln)
410 def replace_line_number(match):
411 if match.group(1) == '+':
412 return str(line_number + int(match.group(2)))
413 if match.group(1) == '-':
414 return str(line_number - int(match.group(2)))
415 ln = re.sub('%\(line *([\+-]) *(\d+)\)', replace_line_number, ln)
417 # Collapse lines with trailing '\\'.
418 if script and script[-1][-1] == '\\':
419 script[-1] = script[-1][:-1] + ln
422 elif command_type == 'XFAIL':
423 test.xfails.extend([s.strip() for s in ln.split(',')])
424 elif command_type == 'REQUIRES':
425 requires.extend([s.strip() for s in ln.split(',')])
426 elif command_type == 'END':
427 # END commands are only honored if the rest of the line is empty.
431 raise ValueError("unknown script command type: %r" % (
434 # Apply substitutions to the script. Allow full regular
435 # expression syntax. Replace each matching occurrence of regular
436 # expression pattern a with substitution b in line ln.
438 # Apply substitutions
439 for a,b in substitutions:
441 b = b.replace("\\","\\\\")
442 ln = re.sub(a, b, ln)
444 # Strip the trailing newline and any extra whitespace.
446 script = [processLine(ln)
449 # Verify the script contains a run line.
451 return (Test.UNRESOLVED, "Test has no run line!")
453 # Check for unterminated run lines.
454 if script[-1][-1] == '\\':
455 return (Test.UNRESOLVED, "Test has unterminated run lines (with '\\')")
457 # Check that we have the required features:
458 missing_required_features = [f for f in requires
459 if f not in test.config.available_features]
460 if missing_required_features:
461 msg = ', '.join(missing_required_features)
462 return (Test.UNSUPPORTED,
463 "Test requires the following features: %s" % msg)
465 return script,tmpBase,execdir
467 def formatTestOutput(status, out, err, exitCode, script):
475 """ % ('\n'.join(script), exitCode)
477 # Append the stdout, if present.
480 Command Output (stdout):
486 # Append the stderr, if present.
489 Command Output (stderr):
494 return (status, output)
496 def executeShTest(test, litConfig, useExternalSh,
497 extra_substitutions=[]):
498 if test.config.unsupported:
499 return (Test.UNSUPPORTED, 'Test is unsupported')
501 res = parseIntegratedTestScript(test, useExternalSh, extra_substitutions)
505 script, tmpBase, execdir = res
507 if litConfig.noExecute:
508 return (Test.PASS, '')
510 # Create the output directory if it does not already exist.
511 lit.util.mkdir_p(os.path.dirname(tmpBase))
514 res = executeScript(test, litConfig, tmpBase, script, execdir)
516 res = executeScriptInternal(test, litConfig, tmpBase, script, execdir)
520 out,err,exitCode = res
526 return formatTestOutput(status, out, err, exitCode, script)