2 # -*- coding: utf-8 -*-
6 ========================
8 Copyright (c) 2012-2023. 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.
13 #TODO: child of child of child that printfs. Does it work?
14 #TODO: a child dies after its parent. What happen?
16 #TODO: regular expression in output
17 #ex: >> Time taken: [0-9]+s
18 #TODO: linked regular expression in output
20 # >> Bytes sent: ([0-9]+)
37 if sys.version_info[0] == 3:
41 raise RuntimeError("This program is expected to run with Python3 only")
49 # Singleton metaclass that works in Python 2 & 3
50 # http://stackoverflow.com/questions/6760685/creating-a-singleton-in-python
52 class _Singleton(type):
53 """ A metaclass that creates a Singleton base class when called. """
56 def __call__(cls, *args, **kwargs):
57 if cls not in cls._instances:
58 cls._instances[cls] = super(_Singleton, cls).__call__(*args, **kwargs)
59 return cls._instances[cls]
61 class Singleton(_Singleton('SingletonMeta', (object,), {})):
62 """ The Singleton base class """
65 SIGNALS_TO_NAMES_DICT = dict((getattr(signal, n), n)
66 for n in dir(signal) if n.startswith('SIG') and '_' not in n)
68 def tesh_exit(errcode):
69 """ Exit correctly """
70 # If you do not flush some prints are skipped
72 # os._exit exit even when executed within a thread
73 # pylint: disable=protected-access
78 """ Exit with error """
79 print("[Tesh/CRITICAL] " + str(msg))
82 # retrocompatibility: support ${aaa:=.} variable format
83 def replace_perl_variables(arg):
85 vdefault = arg.group(2)
86 if vname in os.environ:
92 Set an environment variable.
93 arg must be a string with the format "variable=value"
96 arg = re.sub(r"\${(\w+):=([^}]*)}", replace_perl_variables, arg)
97 arg = expandvars2(arg)
98 (var, val) = arg.split("=", 1)
99 print("[Tesh/INFO] setenv " + var + "=" + val)
100 os.environ[var] = val
101 # os.putenv(var, val) does not work
102 # see http://stackoverflow.com/questions/17705419/python-os-environ-os-putenv-usr-bin-env
105 def expandvars2(path):
106 """ http://stackoverflow.com/questions/30734967/how-to-expand-environment-variables-in-python-as-bash-does """
107 return re.sub(r'(?<!\\)\$[A-Za-z_][A-Za-z0-9_]*', '', os.path.expandvars(path))
115 def process_is_dead(pid):
116 """ Tests whether the process is dead already """
119 except ProcessLookupError:
121 except OSError as err:
122 if err.errno == errno.ESRCH: # ESRCH == No such process. The process is now dead
126 def kill_process_group(pid):
127 """ This function send TERM signal + KILL signal after 0.2s to the group of the specified process """
129 # Nobody to kill. We don't have anyone to kill on signal handler
133 pgid = os.getpgid(pid)
135 # os.getpgid failed. Ok, don't cleanup.
139 os.killpg(pgid, signal.SIGTERM)
140 if process_is_dead(pid):
143 os.killpg(pgid, signal.SIGKILL)
145 # os.killpg failed. OK. Some subprocesses may still be running.
148 def signal_handler(signo, _frame):
149 """ Signal handler """
150 print("Caught signal {}".format(SIGNALS_TO_NAMES_DICT[signo]))
151 running_pids = TeshState().running_pids # Just in case of interthread conflicts.
152 for pid in running_pids:
153 kill_process_group(pid)
154 TeshState().running_pids.clear()
165 class FileReader(Singleton):
166 """ Read file line per line (and concat line that ends with "\") """
167 def __init__(self, filename=None):
169 self.filename = "(stdin)"
170 self.fileno = sys.stdin
172 self.filename_raw = filename
173 self.filename = os.path.basename(filename)
174 self.abspath = os.path.abspath(filename)
175 self.fileno = open(self.filename_raw)
180 return self.filename + ":" + str(self.linenumber)
182 def readfullline(self):
183 """ Read a full line """
185 line = next(self.fileno)
187 except StopIteration:
193 while len(line) > 1 and line[-2] == "\\":
195 line = next(self.fileno)
201 class TeshState(Singleton):
202 """ Keep the state of tesh (mostly configuration values) """
204 self.running_pids = list() # stores which process group should be killed (or None otherwise)
206 self.args_suffix = ""
207 self.ignore_regexps_common = []
208 self.jenkins = False # not a Jenkins run by default
209 self.auto_valgrind = True
210 self.timeout = 10 # default value: 10 sec
215 def add_thread(self, thread):
216 """ Add another thread to wait for """
217 self.threads.append(thread)
219 def join_all_threads(self):
220 """ Wait for all threads """
221 for thread in self.threads:
225 def set_return_code(self, value):
226 """ Set exit status """
227 if value > self.return_code:
228 self.return_code = value
232 """ Command line object """
235 self.output_pipe_stdout = []
236 self.output_pipe_stderr = []
237 self.timeout = TeshState().timeout
241 self.background = False
242 # Python threads loose the cwd
243 self.cwd = os.getcwd()
245 self.ignore_output = False
246 self.expect_return = [0]
248 self.output_display = False
251 self.rerun_with_valgrind = False
253 self.ignore_regexps = TeshState().ignore_regexps_common
255 def add_input_pipe(self, line):
256 """ Add a line to stdin input """
257 self.input_pipe.append(line)
259 def add_output_pipe_stdout(self, line):
260 """ Add a line to stdout output """
261 self.output_pipe_stdout.append(line)
263 def add_output_pipe_stderr(self, line):
264 """ Add a line to stderr output """
265 self.output_pipe_stderr.append(line)
267 def set_cmd(self, args, linenumber):
268 """ Set command line """
270 self.linenumber = linenumber
272 def add_ignore(self, txt):
273 """ Add regexp to ignore lines """
274 self.ignore_regexps.append(re.compile(txt))
276 def remove_ignored_lines(self, lines):
277 """ Remove ignored lines """
278 for ign in self.ignore_regexps:
279 lines = [l for l in lines if not ign.match(l)]
282 def _cmd_mkfile(self, argline):
283 filename = argline[len("mkfile "):]
284 file = open(filename, "w")
286 fatal_error("Unable to create file " + filename)
287 file.write("\n".join(self.input_pipe))
291 def _cmd_cd(self, argline): # pylint: disable=no-self-use
292 args = shlex.split(argline)
294 fatal_error("Too many arguments to cd")
297 print("[Tesh/INFO] change directory to " + args[1])
298 except FileNotFoundError:
299 print("Chdir to " + args[1] + " failed: No such file or directory")
300 print("Test suite `" + FileReader().filename + "': NOK (system error)")
303 def run_if_possible(self):
305 Run the Cmd if possible.
306 Return False if nothing has been ran.
308 if not self.can_run():
311 lock = _thread.allocate_lock()
313 TeshState().add_thread(lock)
314 _thread.start_new_thread(Cmd._run, (self, lock))
317 if self.rerun_with_valgrind and TeshState().auto_valgrind:
318 print('\n\n\nXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
319 print( 'XXXXXXXXX Rerunning this test with valgrind to help debugging it XXXXXXXXX')
320 print( 'XXXXXXXX (this will fail if valgrind is not installed, of course) XXXXXXXX')
321 print( 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\n\n\n')
323 self.args = "valgrind " + self.args
328 def _run(self, lock=None):
329 # Python threads loose the cwd
332 self.args = re.sub(r"\${(\w+):=([^}]*)}", replace_perl_variables, self.args)
334 # replace bash environment variables ($THINGS) to their values
335 self.args = expandvars2(self.args)
337 if re.match("^mkfile ", self.args) is not None:
338 self._cmd_mkfile(self.args)
343 if re.match("^cd ", self.args) is not None:
344 self._cmd_cd(self.args)
349 if TeshState().wrapper is not None:
351 self.args = TeshState().wrapper + self.args
352 elif re.match(".*smpirun.*", self.args) is not None:
353 self.args = "sh " + self.args
354 if TeshState().jenkins and self.timeout is not None:
357 self.args += TeshState().args_suffix
360 msg = "[{file}:{number}] {args}".format(file=FileReader().filename, number=self.linenumber, args=self.args)
364 print(msg, flush=True)
366 args = shlex.split(self.args)
371 preexec_function = lambda: os.setpgid(0, 0)
372 proc = subprocess.Popen( # pylint: disable=subprocess-popen-preexec-fn
375 stdin=subprocess.PIPE,
376 stdout=subprocess.PIPE,
377 stderr=subprocess.STDOUT,
378 universal_newlines=True,
379 preexec_fn=preexec_function)
381 TeshState().running_pids.append(local_pid)
382 except PermissionError:
383 logs.append("[{file}:{number}] Cannot start '{cmd}': The binary is not executable.".format(
384 file=FileReader().filename, number=self.linenumber, cmd=args[0]))
385 logs.append("[{file}:{number}] Current dir: {dir}".format(file=FileReader().filename,
386 number=self.linenumber, dir=os.getcwd()))
387 TeshState().set_return_code(3)
388 print('\n'.join(logs))
390 except NotADirectoryError:
391 logs.append("[{file}:{number}] Cannot start '{cmd}': The path to binary does not exist.".format(
392 file=FileReader().filename, number=self.linenumber, cmd=args[0]))
393 logs.append("[{file}:{number}] Current dir: {dir}".format(file=FileReader().filename,
394 number=self.linenumber, dir=os.getcwd()))
395 TeshState().set_return_code(3)
396 print('\n'.join(logs))
398 except FileNotFoundError:
399 logs.append("[{file}:{number}] Cannot start '{cmd}': File not found.".format(
400 file=FileReader().filename, number=self.linenumber, cmd=args[0]))
401 TeshState().set_return_code(3)
402 print('\n'.join(logs))
404 except OSError as err:
407 "\nOSError: [Errno 8] Executed scripts should start with shebang line (like #!/usr/bin/env sh)"
410 cmd_name = FileReader().filename + ":" + str(self.linenumber)
412 (stdout_data, _stderr_data) = proc.communicate("\n".join(self.input_pipe), self.timeout)
413 timeout_reached = False
414 except subprocess.TimeoutExpired:
415 timeout_reached = True
416 logs.append("Test suite `{file}': NOK (<{cmd}> timeout after {timeout} sec)".format(
417 file=FileReader().filename, cmd=cmd_name, timeout=self.timeout))
418 TeshState().running_pids.remove(local_pid)
419 kill_process_group(local_pid)
420 # Try to get the output of the timeout process, to help in debugging.
422 (stdout_data, _stderr_data) = proc.communicate(timeout=1)
423 except subprocess.TimeoutExpired:
424 logs.append("[{file}:{number}] Could not retrieve output. Killing the process group failed?".format(
425 file=FileReader().filename, number=self.linenumber))
426 TeshState().set_return_code(3)
427 print('\n'.join(logs))
431 ansi_escape = re.compile(r'\x1b[^m]*m')
432 stdout_data = ansi_escape.sub('', stdout_data)
434 if self.output_display:
435 logs.append(str(stdout_data))
437 if self.rerun_with_valgrind:
438 print(str(stdout_data), file=sys.stderr)
441 if self.ignore_output:
442 logs.append("(ignoring the output of <{cmd}> as requested)".format(cmd=cmd_name))
444 stdouta = stdout_data.split("\n")
445 stdouta = self.remove_ignored_lines(stdouta)
446 while stdouta and stdouta[-1] == "":
450 # Mimic the "sort" bash command, which is case unsensitive.
452 stdouta.sort(key=lambda x: x.lower())
453 self.output_pipe_stdout.sort(key=lambda x: x.lower())
455 stdouta.sort(key=lambda x: x[:self.sort].lower())
456 self.output_pipe_stdout.sort(key=lambda x: x[:self.sort].lower())
459 difflib.unified_diff(
460 self.output_pipe_stdout,
466 logs.append("Output of <{cmd}> mismatch:".format(cmd=cmd_name))
467 if self.sort >= 0: # If sorted, truncate the diff output and show the unsorted version
474 logs.append("(diff truncated after 50 lines)")
475 logs.append("Unsorted observed output:\n")
478 else: # If not sorted, just display the diff
482 logs.append("Test suite `{file}': NOK (<{cmd}> output mismatch)".format(
483 file=FileReader().filename, cmd=cmd_name))
485 # Also report any failed return code and/or signal we got in case of output mismatch
486 if not proc.returncode in self.expect_return:
487 if proc.returncode >= 0:
488 logs.append("In addition, <{cmd}> returned code {code}.".format(
489 cmd=cmd_name, code=proc.returncode))
491 logs.append("In addition, <{cmd}> got signal {sig}.".format(cmd=cmd_name,
492 sig=SIGNALS_TO_NAMES_DICT[-proc.returncode]))
493 if proc.returncode == -signal.SIGSEGV:
494 self.rerun_with_valgrind = True
499 file = open('obtained', 'w')
500 obtained = stdout_data.split("\n")
501 while obtained and obtained[-1] == "":
503 obtained = self.remove_ignored_lines(obtained)
504 for line in obtained:
505 file.write("> " + line + "\n")
507 logs.append("Obtained output kept as requested: {path}".format(path=os.path.abspath("obtained")))
508 TeshState().set_return_code(2)
509 print('\n'.join(logs))
513 TeshState().set_return_code(3)
514 print('\n'.join(logs))
517 if not proc.returncode in self.expect_return:
518 if proc.returncode >= 0:
519 logs.append("Test suite `{file}': NOK (<{cmd}> returned code {code})".format(
520 file=FileReader().filename, cmd=cmd_name, code=proc.returncode))
523 TeshState().set_return_code(2)
524 print('\n'.join(logs))
527 logs.append("Test suite `{file}': NOK (<{cmd}> got signal {sig})".format(
528 file=FileReader().filename, cmd=cmd_name,
529 sig=SIGNALS_TO_NAMES_DICT[-proc.returncode]))
531 if proc.returncode == -signal.SIGSEGV:
532 self.rerun_with_valgrind = True
536 TeshState().set_return_code(max(-proc.returncode, 1))
537 print('\n'.join(logs))
543 print('\n'.join(logs))
546 """ Check if ready to run """
547 return self.args is not None
556 """ main function """
557 signal.signal(signal.SIGINT, signal_handler)
558 signal.signal(signal.SIGTERM, signal_handler)
560 parser = argparse.ArgumentParser(description='tesh -- testing shell')
561 group1 = parser.add_argument_group('Options')
562 group1.add_argument('teshfile', nargs='?', help='Name of teshfile, stdin if omitted')
565 metavar='some/directory',
566 help='ask tesh to switch the working directory before launching the tests')
567 group1.add_argument('--setenv', metavar='var=value', action='append', help='set a specific environment variable')
568 group1.add_argument('--cfg', metavar='arg', action='append', help='add parameter --cfg=arg to each command line')
569 group1.add_argument('--log', metavar='arg', action='append', help='add parameter --log=arg to each command line')
573 help='ignore all cruft generated on SimGrid continuous integration servers')
575 '--no-auto-valgrind',
577 help='do not automaticall launch segfaulting commands in valgrind')
578 group1.add_argument('--wrapper', metavar='arg', help='Run each command in the provided wrapper (eg valgrind)')
582 help='Keep the obtained output when it does not match the expected one')
584 options = parser.parse_args()
586 if options.cd is not None:
587 print("[Tesh/INFO] change directory to " + options.cd)
590 if options.ignore_jenkins:
591 print("Ignore all cruft seen on SimGrid's continuous integration servers")
592 # Note: regexps should match at the beginning of lines
593 TeshState().ignore_regexps_common = [
594 re.compile(r"profiling:"),
595 re.compile(r"Unable to clean temporary file C:"),
596 re.compile(r".*Configuration change: Set 'contexts/"),
597 re.compile(r"==[0-9]+== ?WARNING: ASan doesn't fully support"),
598 re.compile(r"==[0-9]+== ?WARNING: ASan is ignoring requested __asan_handle_no_return: stack "),
599 re.compile(r"False positive error reports may follow"),
600 re.compile(r"For details see http://code\.google\.com/p/address-sanitizer/issues/detail\?id=189"),
601 re.compile(r"For details see https://github\.com/google/sanitizers/issues/189"),
602 re.compile(r"Python runtime initialized with LC_CTYPE=C .*"),
603 re.compile(r"sthread is intercepting the execution of \.*"),
605 re.compile(r"cmake: /usr/local/lib/libcurl\.so\.4: no version information available \(required by cmake\)"),
607 r".*mmap broken on FreeBSD, but dlopen\+thread broken too\. Switching to dlopen\+raw contexts\."),
608 re.compile(r".*dlopen\+thread broken on Apple and BSD\. Switching to raw contexts\."),
610 TeshState().jenkins = True # This is a Jenkins build
612 if options.no_auto_valgrind:
613 TeshState().auto_valgrind = False
615 if options.teshfile is None:
616 file = FileReader(None)
617 print("Test suite from stdin")
619 if not os.path.isfile(options.teshfile):
620 print("Cannot open teshfile '" + options.teshfile + "': File not found")
622 file = FileReader(options.teshfile)
623 print("Test suite '" + file.abspath + "'")
625 if options.setenv is not None:
626 for env in options.setenv:
629 if options.cfg is not None:
630 for cfg in options.cfg:
631 TeshState().args_suffix += " --cfg=" + cfg
632 if options.log is not None:
633 for log in options.log:
634 TeshState().args_suffix += " --log=" + log
636 if options.wrapper is not None:
637 TeshState().wrapper = options.wrapper
640 TeshState().keep = True
642 # cmd holds the current command line
643 # tech commands will add some parameters to it
644 # when ready, we execute it.
647 line = file.readfullline()
648 while line is not None:
649 # print(">>============="+line+"==<<")
651 #print ("END CMD block")
652 if cmd.run_if_possible():
658 elif line[0:2] == "p ":
659 print("[" + str(FileReader()) + "] " + line[2:])
661 elif line[0:2] == "< ":
662 cmd.add_input_pipe(line[2:])
663 elif line[0:1] == "<":
664 cmd.add_input_pipe(line[1:])
666 elif line[0:2] == "> ":
667 cmd.add_output_pipe_stdout(line[2:])
668 elif line[0:1] == ">":
669 cmd.add_output_pipe_stdout(line[1:])
671 elif line[0:2] == "$ ":
672 if cmd.run_if_possible():
674 cmd.set_cmd(line[2:], file.linenumber)
676 elif line[0:2] == "& ":
677 if cmd.run_if_possible():
679 cmd.set_cmd(line[2:], file.linenumber)
680 cmd.background = True
682 elif line[0:15] == "! output ignore":
683 cmd.ignore_output = True
684 #print("cmd.ignore_output = True")
685 elif line[0:16] == "! output display":
686 cmd.output_display = True
687 cmd.ignore_output = True
688 elif line[0:15] == "! expect return":
690 cmd.expect_return = [int(line[16:])]
691 except ValueError as err:
692 fatal_error("Invalid expect return value: \""+(line[16:])+"\"")
693 #print("expect return "+str(int(line[16:])))
694 elif line[0:15] == "! expect signal":
695 cmd.expect_return = []
696 for sig in (line[16:]).split("|"):
697 # get the signal integer value from the signal module
698 if sig not in signal.__dict__:
699 fatal_error("unrecognized signal '" + sig + "'")
700 sig = int(signal.__dict__[sig])
701 # popen return -signal when a process ends with a signal
702 cmd.expect_return.append(-sig)
703 elif line[0:len("! timeout ")] == "! timeout ":
704 if "no" in line[len("! timeout "):]:
708 cmd.timeout = int(line[len("! timeout "):])
709 except ValueError as err:
710 fatal_error("Invalid timeout value: \""+(line[len("! timeout "):])+"\"")
712 elif line[0:len("! output sort")] == "! output sort":
713 if len(line) >= len("! output sort "):
715 sort = int(line[len("! output sort "):])
716 except ValueError as err:
717 fatal_error("Invalid sort value: \""+(line[len("! output sort "):])+"\"")
721 elif line[0:len("! setenv ")] == "! setenv ":
722 setenv(line[len("! setenv "):])
724 elif line[0:len("! ignore ")] == "! ignore ":
725 cmd.add_ignore(line[len("! ignore "):])
728 fatal_error(f"UNRECOGNIZED OPTION LINE: {line}\n"
732 " ! output display\n"
735 " ! expect return NN\n"
736 " ! expect signal NN\n"
739 line = file.readfullline()
741 cmd.run_if_possible()
743 TeshState().join_all_threads()
745 if TeshState().return_code == 0:
746 if file.filename == "(stdin)":
747 print("Test suite from stdin OK")
749 print("Test suite `" + file.filename + "' OK")
750 tesh_exit(TeshState().return_code)
752 if __name__ == '__main__':