2 # -*- coding: utf-8 -*-
6 ========================
8 Copyright (c) 2012-2019. The SimGrid Team. All rights reserved.
10 This program is free software; you can redistribute it and/or modify it
11 under the terms of the license (GNU LGPL) which comes with this package.
14 #TODO: child of child of child that printfs. Does it work?
15 #TODO: a child dies after its parent. What happen?
17 #TODO: regular expression in output
18 #ex: >> Time taken: [0-9]+s
19 #TODO: linked regular expression in output
21 # >> Bytes sent: ([0-9]+)
37 if sys.version_info[0] == 3:
41 raise "This program is expected to run with Python3 only"
51 return sys.platform.startswith('win')
53 # Singleton metaclass that works in Python 2 & 3
54 # http://stackoverflow.com/questions/6760685/creating-a-singleton-in-python
57 class _Singleton(type):
58 """ A metaclass that creates a Singleton base class when called. """
61 def __call__(cls, *args, **kwargs):
62 if cls not in cls._instances:
63 cls._instances[cls] = super(_Singleton, cls).__call__(*args, **kwargs)
64 return cls._instances[cls]
67 class Singleton(_Singleton('SingletonMeta', (object,), {})):
71 SIGNALS_TO_NAMES_DICT = dict((getattr(signal, n), n)
72 for n in dir(signal) if n.startswith('SIG') and '_' not in n)
76 def tesh_exit(errcode):
77 # If you do not flush some prints are skipped
79 # os._exit exit even when executed within a thread
84 print("[Tesh/CRITICAL] " + str(msg))
88 # Set an environment variable.
89 # arg must be a string with the format "variable=value"
91 print("[Tesh/INFO] setenv " + arg)
93 os.environ[t[0]] = t[1]
94 # os.putenv(t[0], t[1]) does not work
95 # see http://stackoverflow.com/questions/17705419/python-os-environ-os-putenv-usr-bin-env
98 # http://stackoverflow.com/questions/30734967/how-to-expand-environment-variables-in-python-as-bash-does
99 def expandvars2(path):
100 return re.sub(r'(?<!\\)\$[A-Za-z_][A-Za-z0-9_]*', '', os.path.expandvars(path))
103 # https://github.com/Cadair/jupyter_environment_kernels/issues/10
108 FileNotFoundError = OSError
116 # Global variable. Stores which process group should be killed (or None otherwise)
120 def kill_process_group(pgid):
121 if pgid is None: # Nobody to kill. We don't know who to kill on windows, or we don't have anyone to kill on signal handler
124 # print("Kill process group {}".format(pgid))
126 os.killpg(pgid, signal.SIGTERM)
128 # os.killpg failed. OK. Some subprocesses may still be running.
132 def signal_handler(signal, frame):
133 print("Caught signal {}".format(SIGNALS_TO_NAMES_DICT[signal]))
134 if pgtokill is not None:
135 kill_process_group(pgtokill)
146 # read file line per line (and concat line that ends with "\")
147 class FileReader(Singleton):
148 def __init__(self, filename=None):
150 self.filename = "(stdin)"
153 self.filename_raw = filename
154 self.filename = os.path.basename(filename)
155 self.abspath = os.path.abspath(filename)
156 self.f = open(self.filename_raw)
161 return self.filename + ":" + str(self.linenumber)
163 def readfullline(self):
167 except StopIteration:
173 while len(line) > 1 and line[-2] == "\\":
181 # keep the state of tesh (mostly configuration values)
182 class TeshState(Singleton):
185 self.args_suffix = ""
186 self.ignore_regexps_common = []
187 self.jenkins = False # not a Jenkins run by default
188 self.timeout = 10 # default value: 10 sec
192 def add_thread(self, thread):
193 self.threads.append(thread)
195 def join_all_threads(self):
196 for t in self.threads:
200 # Command line object
206 self.output_pipe_stdout = []
207 self.output_pipe_stderr = []
208 self.timeout = TeshState().timeout
212 self.background = False
213 # Python threads loose the cwd
214 self.cwd = os.getcwd()
216 self.ignore_output = False
217 self.expect_return = 0
219 self.output_display = False
223 self.ignore_regexps = TeshState().ignore_regexps_common
225 def add_input_pipe(self, l):
226 self.input_pipe.append(l)
228 def add_output_pipe_stdout(self, l):
229 self.output_pipe_stdout.append(l)
231 def add_output_pipe_stderr(self, l):
232 self.output_pipe_stderr.append(l)
234 def set_cmd(self, args, linenumber):
236 self.linenumber = linenumber
238 def add_ignore(self, txt):
239 self.ignore_regexps.append(re.compile(txt))
241 def remove_ignored_lines(self, lines):
242 for ign in self.ignore_regexps:
243 lines = [l for l in lines if not ign.match(l)]
246 def _cmd_mkfile(self, argline):
247 filename = argline[len("mkfile "):]
248 file = open(filename, "w")
250 fatal_error("Unable to create file " + filename)
251 file.write("\n".join(self.input_pipe))
255 def _cmd_cd(self, argline):
256 args = shlex.split(argline)
258 fatal_error("Too many arguments to cd")
261 print("[Tesh/INFO] change directory to " + args[1])
262 except FileNotFoundError:
263 print("Chdir to " + args[1] + " failed: No such file or directory")
264 print("Test suite `" + FileReader().filename + "': NOK (system error)")
267 # Run the Cmd if possible.
268 # Return False if nothing has been ran.
270 def run_if_possible(self):
273 lock = _thread.allocate_lock()
275 TeshState().add_thread(lock)
276 _thread.start_new_thread(Cmd._run, (self, lock))
283 def _run(self, lock=None):
284 # Python threads loose the cwd
287 # retrocompatibility: support ${aaa:=.} variable format
288 def replace_perl_variables(m):
290 vdefault = m.group(2)
291 if vname in os.environ:
295 self.args = re.sub(r"\${(\w+):=([^}]*)}", replace_perl_variables, self.args)
297 # replace bash environment variables ($THINGS) to their values
298 self.args = expandvars2(self.args)
300 if re.match("^mkfile ", self.args) is not None:
301 self._cmd_mkfile(self.args)
306 if re.match("^cd ", self.args) is not None:
307 self._cmd_cd(self.args)
312 if TeshState().wrapper is not None:
314 self.args = TeshState().wrapper + self.args
315 elif re.match(".*smpirun.*", self.args) is not None:
316 self.args = "sh " + self.args
317 if TeshState().jenkins and self.timeout is not None:
320 self.args += TeshState().args_suffix
322 print("[" + FileReader().filename + ":" + str(self.linenumber) + "] " + self.args)
324 args = shlex.split(self.args)
330 proc = subprocess.Popen(
333 stdin=subprocess.PIPE,
334 stdout=subprocess.PIPE,
335 stderr=subprocess.STDOUT,
336 universal_newlines=True,
337 start_new_session=True)
340 pgtokill = os.getpgid(proc.pid)
342 # os.getpgid failed. OK. No cleanup.
344 except PermissionError:
345 print("[" + FileReader().filename + ":" + str(self.linenumber) +
346 "] Cannot start '" + args[0] + "': The binary is not executable.")
347 print("[" + FileReader().filename + ":" + str(self.linenumber) + "] Current dir: " + os.getcwd())
349 except NotADirectoryError:
350 print("[" + FileReader().filename + ":" + str(self.linenumber) + "] Cannot start '" +
351 args[0] + "': The path to binary does not exist.")
352 print("[" + FileReader().filename + ":" + str(self.linenumber) + "] Current dir: " + os.getcwd())
354 except FileNotFoundError:
355 print("[" + FileReader().filename + ":" + str(self.linenumber) +
356 "] Cannot start '" + args[0] + "': File not found")
358 except OSError as osE:
360 osE.strerror += "\nOSError: [Errno 8] Executed scripts should start with shebang line (like #!/usr/bin/env sh)"
363 cmdName = FileReader().filename + ":" + str(self.linenumber)
365 (stdout_data, stderr_data) = proc.communicate("\n".join(self.input_pipe), self.timeout)
367 except subprocess.TimeoutExpired:
368 print("Test suite `" + FileReader().filename + "': NOK (<" +
369 cmdName + "> timeout after " + str(self.timeout) + " sec)")
370 kill_process_group(pgtokill)
373 if self.output_display:
377 ansi_escape = re.compile(r'\x1b[^m]*m')
378 stdout_data = ansi_escape.sub('', stdout_data)
380 #print ((stdout_data, stderr_data))
382 if self.ignore_output:
383 print("(ignoring the output of <" + cmdName + "> as requested)")
385 stdouta = stdout_data.split("\n")
386 while len(stdouta) > 0 and stdouta[-1] == "":
388 stdouta = self.remove_ignored_lines(stdouta)
391 # Mimic the "sort" bash command, which is case unsensitive.
393 stdouta.sort(key=lambda x: x.lower())
394 self.output_pipe_stdout.sort(key=lambda x: x.lower())
396 stdouta.sort(key=lambda x: x[:self.sort].lower())
397 self.output_pipe_stdout.sort(key=lambda x: x[:self.sort].lower())
400 difflib.unified_diff(
401 self.output_pipe_stdout,
407 print("Output of <" + cmdName + "> mismatch:")
408 if self.sort >= 0: # If sorted, truncate the diff output and show the unsorted version
415 print("(diff truncated after 50 lines)")
416 print("Unsorted observed output:\n")
419 else: # If not sorted, just display the diff
423 print("Test suite `" + FileReader().filename + "': NOK (<" + cmdName + "> output mismatch)")
427 f = open('obtained', 'w')
428 obtained = stdout_data.split("\n")
429 while len(obtained) > 0 and obtained[-1] == "":
431 obtained = self.remove_ignored_lines(obtained)
432 for line in obtained:
433 f.write("> " + line + "\n")
435 print("Obtained output kept as requested: " + os.path.abspath("obtained"))
438 #print ((proc.returncode, self.expect_return))
440 if proc.returncode != self.expect_return:
441 if proc.returncode >= 0:
442 print("Test suite `" + FileReader().filename + "': NOK (<" +
443 cmdName + "> returned code " + str(proc.returncode) + ")")
448 print("Test suite `" + FileReader().filename + "': NOK (<" + cmdName +
449 "> got signal " + SIGNALS_TO_NAMES_DICT[-proc.returncode] + ")")
452 tesh_exit(-proc.returncode)
458 return self.args is not None
468 if __name__ == '__main__':
469 signal.signal(signal.SIGINT, signal_handler)
470 signal.signal(signal.SIGTERM, signal_handler)
472 parser = argparse.ArgumentParser(description='tesh -- testing shell', add_help=True)
473 group1 = parser.add_argument_group('Options')
474 group1.add_argument('teshfile', nargs='?', help='Name of teshfile, stdin if omitted')
477 metavar='some/directory',
478 help='ask tesh to switch the working directory before launching the tests')
479 group1.add_argument('--setenv', metavar='var=value', action='append', help='set a specific environment variable')
480 group1.add_argument('--cfg', metavar='arg', action='append', help='add parameter --cfg=arg to each command line')
481 group1.add_argument('--log', metavar='arg', action='append', help='add parameter --log=arg to each command line')
485 help='ignore all cruft generated on SimGrid continous integration servers')
486 group1.add_argument('--wrapper', metavar='arg', help='Run each command in the provided wrapper (eg valgrind)')
490 help='Keep the obtained output when it does not match the expected one')
493 options = parser.parse_args()
497 if options.cd is not None:
498 print("[Tesh/INFO] change directory to " + options.cd)
501 if options.ignore_jenkins:
502 print("Ignore all cruft seen on SimGrid's continous integration servers")
503 # Note: regexps should match at the beginning of lines
504 TeshState().ignore_regexps_common = [
505 re.compile(r"profiling:"),
506 re.compile(r"Unable to clean temporary file C:"),
507 re.compile(r".*Configuration change: Set 'contexts/"),
508 re.compile(r"Picked up JAVA_TOOL_OPTIONS: "),
509 re.compile(r"Picked up _JAVA_OPTIONS: "),
510 re.compile(r"==[0-9]+== ?WARNING: ASan doesn't fully support"),
511 re.compile(r"==[0-9]+== ?WARNING: ASan is ignoring requested __asan_handle_no_return: stack top:"),
512 re.compile(r"False positive error reports may follow"),
513 re.compile(r"For details see http://code.google.com/p/address-sanitizer/issues/detail\?id=189"),
514 re.compile(r"For details see https://github.com/google/sanitizers/issues/189"),
515 re.compile(r"Python runtime initialized with LC_CTYPE=C .*"),
517 re.compile(r"cmake: /usr/local/lib/libcurl\.so\.4: no version information available \(required by cmake\)"),
518 re.compile(r".*mmap broken on FreeBSD, but dlopen\+thread broken too. Switching to dlopen\+raw contexts\."),
519 re.compile(r".*dlopen\+thread broken on Apple and BSD\. Switching to raw contexts\."),
521 TeshState().jenkins = True # This is a Jenkins build
523 if options.teshfile is None:
525 print("Test suite from stdin")
527 if not os.path.isfile(options.teshfile):
528 print("Cannot open teshfile '" + options.teshfile + "': File not found")
530 f = FileReader(options.teshfile)
531 print("Test suite '" + f.abspath + "'")
533 if options.setenv is not None:
534 for e in options.setenv:
537 if options.cfg is not None:
538 for c in options.cfg:
539 TeshState().args_suffix += " --cfg=" + c
540 if options.log is not None:
541 for l in options.log:
542 TeshState().args_suffix += " --log=" + l
544 if options.wrapper is not None:
545 TeshState().wrapper = options.wrapper
548 TeshState().keep = True
550 # cmd holds the current command line
551 # tech commands will add some parameters to it
552 # when ready, we execute it.
555 line = f.readfullline()
556 while line is not None:
557 # print(">>============="+line+"==<<")
559 #print ("END CMD block")
560 if cmd.run_if_possible():
566 elif line[0:2] == "p ":
567 print("[" + str(FileReader()) + "] " + line[2:])
569 elif line[0:2] == "< ":
570 cmd.add_input_pipe(line[2:])
571 elif line[0:1] == "<":
572 cmd.add_input_pipe(line[1:])
574 elif line[0:2] == "> ":
575 cmd.add_output_pipe_stdout(line[2:])
576 elif line[0:1] == ">":
577 cmd.add_output_pipe_stdout(line[1:])
579 elif line[0:2] == "$ ":
580 if cmd.run_if_possible():
582 cmd.set_cmd(line[2:], f.linenumber)
584 elif line[0:2] == "& ":
585 if cmd.run_if_possible():
587 cmd.set_cmd(line[2:], f.linenumber)
588 cmd.background = True
590 elif line[0:15] == "! output ignore":
591 cmd.ignore_output = True
592 #print("cmd.ignore_output = True")
593 elif line[0:16] == "! output display":
594 cmd.output_display = True
595 cmd.ignore_output = True
596 elif line[0:15] == "! expect return":
597 cmd.expect_return = int(line[16:])
598 #print("expect return "+str(int(line[16:])))
599 elif line[0:15] == "! expect signal":
601 # get the signal integer value from the signal module
602 if sig not in signal.__dict__:
603 fatal_error("unrecognized signal '" + sig + "'")
604 sig = int(signal.__dict__[sig])
605 # popen return -signal when a process ends with a signal
606 cmd.expect_return = -sig
607 elif line[0:len("! timeout ")] == "! timeout ":
608 if "no" in line[len("! timeout "):]:
611 cmd.timeout = int(line[len("! timeout "):])
613 elif line[0:len("! output sort")] == "! output sort":
614 if len(line) >= len("! output sort "):
615 sort = int(line[len("! output sort "):])
619 elif line[0:len("! setenv ")] == "! setenv ":
620 setenv(line[len("! setenv "):])
622 elif line[0:len("! ignore ")] == "! ignore ":
623 cmd.add_ignore(line[len("! ignore "):])
626 fatal_error("UNRECOGNIZED OPTION")
628 line = f.readfullline()
630 cmd.run_if_possible()
632 TeshState().join_all_threads()
634 if f.filename == "(stdin)":
635 print("Test suite from stdin OK")
637 print("Test suite `" + f.filename + "' OK")