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))
85 Set an environment variable.
86 arg must be a string with the format "variable=value"
88 print("[Tesh/INFO] setenv " + arg)
89 (var, val) = arg.split("=", 1)
91 # os.putenv(var, val) does not work
92 # see http://stackoverflow.com/questions/17705419/python-os-environ-os-putenv-usr-bin-env
95 def expandvars2(path):
96 """ http://stackoverflow.com/questions/30734967/how-to-expand-environment-variables-in-python-as-bash-does """
97 return re.sub(r'(?<!\\)\$[A-Za-z_][A-Za-z0-9_]*', '', os.path.expandvars(path))
105 def process_is_dead(pid):
106 """ Tests whether the process is dead already """
109 except ProcessLookupError:
111 except OSError as err:
112 if err.errno == errno.ESRCH: # ESRCH == No such process. The process is now dead
116 def kill_process_group(pid):
117 """ This function send TERM signal + KILL signal after 0.2s to the group of the specified process """
119 # Nobody to kill. We don't have anyone to kill on signal handler
123 pgid = os.getpgid(pid)
125 # os.getpgid failed. Ok, don't cleanup.
129 os.killpg(pgid, signal.SIGTERM)
130 if process_is_dead(pid):
133 os.killpg(pgid, signal.SIGKILL)
135 # os.killpg failed. OK. Some subprocesses may still be running.
138 def signal_handler(signo, _frame):
139 """ Signal handler """
140 print("Caught signal {}".format(SIGNALS_TO_NAMES_DICT[signo]))
141 running_pids = TeshState().running_pids # Just in case of interthread conflicts.
142 for pid in running_pids:
143 kill_process_group(pid)
144 TeshState().running_pids.clear()
155 class FileReader(Singleton):
156 """ Read file line per line (and concat line that ends with "\") """
157 def __init__(self, filename=None):
159 self.filename = "(stdin)"
160 self.fileno = sys.stdin
162 self.filename_raw = filename
163 self.filename = os.path.basename(filename)
164 self.abspath = os.path.abspath(filename)
165 self.fileno = open(self.filename_raw)
170 return self.filename + ":" + str(self.linenumber)
172 def readfullline(self):
173 """ Read a full line """
175 line = next(self.fileno)
177 except StopIteration:
183 while len(line) > 1 and line[-2] == "\\":
185 line = next(self.fileno)
191 class TeshState(Singleton):
192 """ Keep the state of tesh (mostly configuration values) """
194 self.running_pids = list() # stores which process group should be killed (or None otherwise)
196 self.args_suffix = ""
197 self.ignore_regexps_common = []
198 self.jenkins = False # not a Jenkins run by default
199 self.auto_valgrind = True
200 self.timeout = 10 # default value: 10 sec
205 def add_thread(self, thread):
206 """ Add another thread to wait for """
207 self.threads.append(thread)
209 def join_all_threads(self):
210 """ Wait for all threads """
211 for thread in self.threads:
215 def set_return_code(self, value):
216 """ Set exit status """
217 if value > self.return_code:
218 self.return_code = value
222 """ Command line object """
225 self.output_pipe_stdout = []
226 self.output_pipe_stderr = []
227 self.timeout = TeshState().timeout
231 self.background = False
232 # Python threads loose the cwd
233 self.cwd = os.getcwd()
235 self.ignore_output = False
236 self.expect_return = [0]
238 self.output_display = False
241 self.rerun_with_valgrind = False
243 self.ignore_regexps = TeshState().ignore_regexps_common
245 def add_input_pipe(self, line):
246 """ Add a line to stdin input """
247 self.input_pipe.append(line)
249 def add_output_pipe_stdout(self, line):
250 """ Add a line to stdout output """
251 self.output_pipe_stdout.append(line)
253 def add_output_pipe_stderr(self, line):
254 """ Add a line to stderr output """
255 self.output_pipe_stderr.append(line)
257 def set_cmd(self, args, linenumber):
258 """ Set command line """
260 self.linenumber = linenumber
262 def add_ignore(self, txt):
263 """ Add regexp to ignore lines """
264 self.ignore_regexps.append(re.compile(txt))
266 def remove_ignored_lines(self, lines):
267 """ Remove ignored lines """
268 for ign in self.ignore_regexps:
269 lines = [l for l in lines if not ign.match(l)]
272 def _cmd_mkfile(self, argline):
273 filename = argline[len("mkfile "):]
274 file = open(filename, "w")
276 fatal_error("Unable to create file " + filename)
277 file.write("\n".join(self.input_pipe))
281 def _cmd_cd(self, argline): # pylint: disable=no-self-use
282 args = shlex.split(argline)
284 fatal_error("Too many arguments to cd")
287 print("[Tesh/INFO] change directory to " + args[1])
288 except FileNotFoundError:
289 print("Chdir to " + args[1] + " failed: No such file or directory")
290 print("Test suite `" + FileReader().filename + "': NOK (system error)")
293 def run_if_possible(self):
295 Run the Cmd if possible.
296 Return False if nothing has been ran.
298 if not self.can_run():
301 lock = _thread.allocate_lock()
303 TeshState().add_thread(lock)
304 _thread.start_new_thread(Cmd._run, (self, lock))
307 if self.rerun_with_valgrind and TeshState().auto_valgrind:
308 print('\n\n\nXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
309 print( 'XXXXXXXXX Rerunning this test with valgrind to help debugging it XXXXXXXXX')
310 print( 'XXXXXXXX (this will fail if valgrind is not installed, of course) XXXXXXXX')
311 print( 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\n\n\n')
313 self.args = "valgrind " + self.args
317 def _run(self, lock=None):
318 # Python threads loose the cwd
321 # retrocompatibility: support ${aaa:=.} variable format
322 def replace_perl_variables(arg):
324 vdefault = arg.group(2)
325 if vname in os.environ:
329 self.args = re.sub(r"\${(\w+):=([^}]*)}", replace_perl_variables, self.args)
331 # replace bash environment variables ($THINGS) to their values
332 self.args = expandvars2(self.args)
334 if re.match("^mkfile ", self.args) is not None:
335 self._cmd_mkfile(self.args)
340 if re.match("^cd ", self.args) is not None:
341 self._cmd_cd(self.args)
346 if TeshState().wrapper is not None:
348 self.args = TeshState().wrapper + self.args
349 elif re.match(".*smpirun.*", self.args) is not None:
350 self.args = "sh " + self.args
351 if TeshState().jenkins and self.timeout is not None:
354 self.args += TeshState().args_suffix
357 print("[{file}:{number}] {args}".format(file=FileReader().filename,
358 number=self.linenumber, args=self.args), flush=True)
360 args = shlex.split(self.args)
365 preexec_function = lambda: os.setpgid(0, 0)
366 proc = subprocess.Popen( # pylint: disable=subprocess-popen-preexec-fn
369 stdin=subprocess.PIPE,
370 stdout=subprocess.PIPE,
371 stderr=subprocess.STDOUT,
372 universal_newlines=True,
373 preexec_fn=preexec_function)
375 TeshState().running_pids.append(local_pid)
376 except PermissionError:
377 logs.append("[{file}:{number}] Cannot start '{cmd}': The binary is not executable.".format(
378 file=FileReader().filename, number=self.linenumber, cmd=args[0]))
379 logs.append("[{file}:{number}] Current dir: {dir}".format(file=FileReader().filename,
380 number=self.linenumber, dir=os.getcwd()))
381 TeshState().set_return_code(3)
382 print('\n'.join(logs))
384 except NotADirectoryError:
385 logs.append("[{file}:{number}] Cannot start '{cmd}': The path to binary does not exist.".format(
386 file=FileReader().filename, number=self.linenumber, cmd=args[0]))
387 logs.append("[{file}:{number}] Current dir: {dir}".format(file=FileReader().filename,
388 number=self.linenumber, dir=os.getcwd()))
389 TeshState().set_return_code(3)
390 print('\n'.join(logs))
392 except FileNotFoundError:
393 logs.append("[{file}:{number}] Cannot start '{cmd}': File not found.".format(
394 file=FileReader().filename, number=self.linenumber, cmd=args[0]))
395 TeshState().set_return_code(3)
396 print('\n'.join(logs))
398 except OSError as err:
401 "\nOSError: [Errno 8] Executed scripts should start with shebang line (like #!/usr/bin/env sh)"
404 cmd_name = FileReader().filename + ":" + str(self.linenumber)
406 (stdout_data, _stderr_data) = proc.communicate("\n".join(self.input_pipe), self.timeout)
407 timeout_reached = False
408 except subprocess.TimeoutExpired:
409 timeout_reached = True
410 logs.append("Test suite `{file}': NOK (<{cmd}> timeout after {timeout} sec)".format(
411 file=FileReader().filename, cmd=cmd_name, timeout=self.timeout))
412 TeshState().running_pids.remove(local_pid)
413 kill_process_group(local_pid)
414 # Try to get the output of the timeout process, to help in debugging.
416 (stdout_data, _stderr_data) = proc.communicate(timeout=1)
417 except subprocess.TimeoutExpired:
418 logs.append("[{file}:{number}] Could not retrieve output. Killing the process group failed?".format(
419 file=FileReader().filename, number=self.linenumber))
420 TeshState().set_return_code(3)
421 print('\n'.join(logs))
425 ansi_escape = re.compile(r'\x1b[^m]*m')
426 stdout_data = ansi_escape.sub('', stdout_data)
428 if self.output_display:
429 logs.append(str(stdout_data))
431 if self.rerun_with_valgrind:
432 print(str(stdout_data), file=sys.stderr)
435 if self.ignore_output:
436 logs.append("(ignoring the output of <{cmd}> as requested)".format(cmd=cmd_name))
438 stdouta = stdout_data.split("\n")
439 stdouta = self.remove_ignored_lines(stdouta)
440 while stdouta and stdouta[-1] == "":
444 # Mimic the "sort" bash command, which is case unsensitive.
446 stdouta.sort(key=lambda x: x.lower())
447 self.output_pipe_stdout.sort(key=lambda x: x.lower())
449 stdouta.sort(key=lambda x: x[:self.sort].lower())
450 self.output_pipe_stdout.sort(key=lambda x: x[:self.sort].lower())
453 difflib.unified_diff(
454 self.output_pipe_stdout,
460 logs.append("Output of <{cmd}> mismatch:".format(cmd=cmd_name))
461 if self.sort >= 0: # If sorted, truncate the diff output and show the unsorted version
468 logs.append("(diff truncated after 50 lines)")
469 logs.append("Unsorted observed output:\n")
472 else: # If not sorted, just display the diff
476 logs.append("Test suite `{file}': NOK (<{cmd}> output mismatch)".format(
477 file=FileReader().filename, cmd=cmd_name))
479 # Also report any failed return code and/or signal we got in case of output mismatch
480 if not proc.returncode in self.expect_return:
481 if proc.returncode >= 0:
482 logs.append("In addition, <{cmd}> returned code {code}.".format(
483 cmd=cmd_name, code=proc.returncode))
485 logs.append("In addition, <{cmd}> got signal {sig}.".format(cmd=cmd_name,
486 sig=SIGNALS_TO_NAMES_DICT[-proc.returncode]))
487 if proc.returncode == -signal.SIGSEGV:
488 self.rerun_with_valgrind = True
493 file = open('obtained', 'w')
494 obtained = stdout_data.split("\n")
495 while obtained and obtained[-1] == "":
497 obtained = self.remove_ignored_lines(obtained)
498 for line in obtained:
499 file.write("> " + line + "\n")
501 logs.append("Obtained output kept as requested: {path}".format(path=os.path.abspath("obtained")))
502 TeshState().set_return_code(2)
503 print('\n'.join(logs))
507 TeshState().set_return_code(3)
508 print('\n'.join(logs))
511 if not proc.returncode in self.expect_return:
512 if proc.returncode >= 0:
513 logs.append("Test suite `{file}': NOK (<{cmd}> returned code {code})".format(
514 file=FileReader().filename, cmd=cmd_name, code=proc.returncode))
517 TeshState().set_return_code(2)
518 print('\n'.join(logs))
521 logs.append("Test suite `{file}': NOK (<{cmd}> got signal {sig})".format(
522 file=FileReader().filename, cmd=cmd_name,
523 sig=SIGNALS_TO_NAMES_DICT[-proc.returncode]))
525 if proc.returncode == -signal.SIGSEGV:
526 self.rerun_with_valgrind = True
530 TeshState().set_return_code(max(-proc.returncode, 1))
531 print('\n'.join(logs))
537 print('\n'.join(logs))
540 """ Check if ready to run """
541 return self.args is not None
550 """ main function """
551 signal.signal(signal.SIGINT, signal_handler)
552 signal.signal(signal.SIGTERM, signal_handler)
554 parser = argparse.ArgumentParser(description='tesh -- testing shell')
555 group1 = parser.add_argument_group('Options')
556 group1.add_argument('teshfile', nargs='?', help='Name of teshfile, stdin if omitted')
559 metavar='some/directory',
560 help='ask tesh to switch the working directory before launching the tests')
561 group1.add_argument('--setenv', metavar='var=value', action='append', help='set a specific environment variable')
562 group1.add_argument('--cfg', metavar='arg', action='append', help='add parameter --cfg=arg to each command line')
563 group1.add_argument('--log', metavar='arg', action='append', help='add parameter --log=arg to each command line')
567 help='ignore all cruft generated on SimGrid continuous integration servers')
569 '--no-auto-valgrind',
571 help='do not automaticall launch segfaulting commands in valgrind')
572 group1.add_argument('--wrapper', metavar='arg', help='Run each command in the provided wrapper (eg valgrind)')
576 help='Keep the obtained output when it does not match the expected one')
578 options = parser.parse_args()
580 if options.cd is not None:
581 print("[Tesh/INFO] change directory to " + options.cd)
584 if options.ignore_jenkins:
585 print("Ignore all cruft seen on SimGrid's continuous integration servers")
586 # Note: regexps should match at the beginning of lines
587 TeshState().ignore_regexps_common = [
588 re.compile(r"profiling:"),
589 re.compile(r"Unable to clean temporary file C:"),
590 re.compile(r".*Configuration change: Set 'contexts/"),
591 re.compile(r"==[0-9]+== ?WARNING: ASan doesn't fully support"),
592 re.compile(r"==[0-9]+== ?WARNING: ASan is ignoring requested __asan_handle_no_return: stack "),
593 re.compile(r"False positive error reports may follow"),
594 re.compile(r"For details see http://code\.google\.com/p/address-sanitizer/issues/detail\?id=189"),
595 re.compile(r"For details see https://github\.com/google/sanitizers/issues/189"),
596 re.compile(r"Python runtime initialized with LC_CTYPE=C .*"),
597 re.compile(r"sthread is intercepting the execution of \.*"),
599 re.compile(r"cmake: /usr/local/lib/libcurl\.so\.4: no version information available \(required by cmake\)"),
601 r".*mmap broken on FreeBSD, but dlopen\+thread broken too\. Switching to dlopen\+raw contexts\."),
602 re.compile(r".*dlopen\+thread broken on Apple and BSD\. Switching to raw contexts\."),
604 TeshState().jenkins = True # This is a Jenkins build
606 if options.no_auto_valgrind:
607 TeshState().auto_valgrind = False
609 if options.teshfile is None:
610 file = FileReader(None)
611 print("Test suite from stdin")
613 if not os.path.isfile(options.teshfile):
614 print("Cannot open teshfile '" + options.teshfile + "': File not found")
616 file = FileReader(options.teshfile)
617 print("Test suite '" + file.abspath + "'")
619 if options.setenv is not None:
620 for env in options.setenv:
623 if options.cfg is not None:
624 for cfg in options.cfg:
625 TeshState().args_suffix += " --cfg=" + cfg
626 if options.log is not None:
627 for log in options.log:
628 TeshState().args_suffix += " --log=" + log
630 if options.wrapper is not None:
631 TeshState().wrapper = options.wrapper
634 TeshState().keep = True
636 # cmd holds the current command line
637 # tech commands will add some parameters to it
638 # when ready, we execute it.
641 line = file.readfullline()
642 while line is not None:
643 # print(">>============="+line+"==<<")
645 #print ("END CMD block")
646 if cmd.run_if_possible():
652 elif line[0:2] == "p ":
653 print("[" + str(FileReader()) + "] " + line[2:])
655 elif line[0:2] == "< ":
656 cmd.add_input_pipe(line[2:])
657 elif line[0:1] == "<":
658 cmd.add_input_pipe(line[1:])
660 elif line[0:2] == "> ":
661 cmd.add_output_pipe_stdout(line[2:])
662 elif line[0:1] == ">":
663 cmd.add_output_pipe_stdout(line[1:])
665 elif line[0:2] == "$ ":
666 if cmd.run_if_possible():
668 cmd.set_cmd(line[2:], file.linenumber)
670 elif line[0:2] == "& ":
671 if cmd.run_if_possible():
673 cmd.set_cmd(line[2:], file.linenumber)
674 cmd.background = True
676 elif line[0:15] == "! output ignore":
677 cmd.ignore_output = True
678 #print("cmd.ignore_output = True")
679 elif line[0:16] == "! output display":
680 cmd.output_display = True
681 cmd.ignore_output = True
682 elif line[0:15] == "! expect return":
683 cmd.expect_return = [int(line[16:])]
684 #print("expect return "+str(int(line[16:])))
685 elif line[0:15] == "! expect signal":
686 cmd.expect_return = []
687 for sig in (line[16:]).split("|"):
688 # get the signal integer value from the signal module
689 if sig not in signal.__dict__:
690 fatal_error("unrecognized signal '" + sig + "'")
691 sig = int(signal.__dict__[sig])
692 # popen return -signal when a process ends with a signal
693 cmd.expect_return.append(-sig)
694 elif line[0:len("! timeout ")] == "! timeout ":
695 if "no" in line[len("! timeout "):]:
698 cmd.timeout = int(line[len("! timeout "):])
700 elif line[0:len("! output sort")] == "! output sort":
701 if len(line) >= len("! output sort "):
702 sort = int(line[len("! output sort "):])
706 elif line[0:len("! setenv ")] == "! setenv ":
707 setenv(line[len("! setenv "):])
709 elif line[0:len("! ignore ")] == "! ignore ":
710 cmd.add_ignore(line[len("! ignore "):])
713 fatal_error(f"UNRECOGNIZED OPTION LINE: {line}\n"
717 " ! output display\n"
720 " ! expect return NN\n"
721 " ! expect signal NN\n"
724 line = file.readfullline()
726 cmd.run_if_possible()
728 TeshState().join_all_threads()
730 if TeshState().return_code == 0:
731 if file.filename == "(stdin)":
732 print("Test suite from stdin OK")
734 print("Test suite `" + file.filename + "' OK")
735 tesh_exit(TeshState().return_code)
737 if __name__ == '__main__':