X-Git-Url: http://bilbo.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/b18431ee82f850d5f58e684b4aa97f30e37a6552..bfffef69e1b0554d13eec920f1a32f75b49ceac6:/tools/tesh/tesh.py diff --git a/tools/tesh/tesh.py b/tools/tesh/tesh.py index f9ef1d4775..0db9022224 100755 --- a/tools/tesh/tesh.py +++ b/tools/tesh/tesh.py @@ -5,12 +5,11 @@ tesh -- testing shell ======================== -Copyright (c) 2012-2019. The SimGrid Team. All rights reserved. +Copyright (c) 2012-2023. The SimGrid Team. All rights reserved. This program is free software; you can redistribute it and/or modify it under the terms of the license (GNU LGPL) which comes with this package. - #TODO: child of child of child that printfs. Does it work? #TODO: a child dies after its parent. What happen? @@ -25,8 +24,8 @@ under the terms of the license (GNU LGPL) which comes with this package. """ - import sys +import errno import os import shlex import re @@ -39,7 +38,7 @@ if sys.version_info[0] == 3: import subprocess import _thread else: - raise "This program is expected to run with Python3 only" + raise RuntimeError("This program is expected to run with Python3 only") ############## # @@ -47,14 +46,9 @@ else: # # - -def isWindows(): - return sys.platform.startswith('win') - # Singleton metaclass that works in Python 2 & 3 # http://stackoverflow.com/questions/6760685/creating-a-singleton-in-python - class _Singleton(type): """ A metaclass that creates a Singleton base class when called. """ _instances = {} @@ -64,62 +58,62 @@ class _Singleton(type): cls._instances[cls] = super(_Singleton, cls).__call__(*args, **kwargs) return cls._instances[cls] - class Singleton(_Singleton('SingletonMeta', (object,), {})): - pass - + """ The Singleton base class """ + # pass SIGNALS_TO_NAMES_DICT = dict((getattr(signal, n), n) for n in dir(signal) if n.startswith('SIG') and '_' not in n) -return_code = 0 - -# exit correctly def tesh_exit(errcode): + """ Exit correctly """ # If you do not flush some prints are skipped sys.stdout.flush() # os._exit exit even when executed within a thread + # pylint: disable=protected-access os._exit(errcode) def fatal_error(msg): + """ Exit with error """ print("[Tesh/CRITICAL] " + str(msg)) tesh_exit(1) +# retrocompatibility: support ${aaa:=.} variable format +def replace_perl_variables(arg): + vname = arg.group(1) + vdefault = arg.group(2) + if vname in os.environ: + return "$" + vname + return vdefault -# Set an environment variable. -# arg must be a string with the format "variable=value" def setenv(arg): - print("[Tesh/INFO] setenv " + arg) - t = arg.split("=", 1) - os.environ[t[0]] = t[1] - # os.putenv(t[0], t[1]) does not work + """ + Set an environment variable. + arg must be a string with the format "variable=value" + """ + if '$' in arg: + arg = re.sub(r"\${(\w+):=([^}]*)}", replace_perl_variables, arg) + arg = expandvars2(arg) + (var, val) = arg.split("=", 1) + print("[Tesh/INFO] setenv " + var + "=" + val) + os.environ[var] = val + # os.putenv(var, val) does not work # see http://stackoverflow.com/questions/17705419/python-os-environ-os-putenv-usr-bin-env -# http://stackoverflow.com/questions/30734967/how-to-expand-environment-variables-in-python-as-bash-does def expandvars2(path): + """ http://stackoverflow.com/questions/30734967/how-to-expand-environment-variables-in-python-as-bash-does """ return re.sub(r'(? 1 and line[-2] == "\\": txt = txt[0:-1] - line = next(self.f) + line = next(self.fileno) self.linenumber += 1 txt += line[0:-1] return txt -# keep the state of tesh (mostly configuration values) class TeshState(Singleton): + """ Keep the state of tesh (mostly configuration values) """ def __init__(self): + self.running_pids = list() # stores which process group should be killed (or None otherwise) self.threads = [] self.args_suffix = "" self.ignore_regexps_common = [] self.jenkins = False # not a Jenkins run by default + self.auto_valgrind = True self.timeout = 10 # default value: 10 sec self.wrapper = None self.keep = False + self.return_code = 0 def add_thread(self, thread): + """ Add another thread to wait for """ self.threads.append(thread) def join_all_threads(self): - for t in self.threads: - t.acquire() - t.release() + """ Wait for all threads """ + for thread in self.threads: + thread.acquire() + thread.release() -# Command line object + def set_return_code(self, value): + """ Set exit status """ + if value > self.return_code: + self.return_code = value -class Cmd(object): +class Cmd: + """ Command line object """ def __init__(self): self.input_pipe = [] self.output_pipe_stdout = [] @@ -238,31 +243,38 @@ class Cmd(object): self.cwd = os.getcwd() self.ignore_output = False - self.expect_return = 0 + self.expect_return = [0] self.output_display = False self.sort = -1 + self.rerun_with_valgrind = False self.ignore_regexps = TeshState().ignore_regexps_common - def add_input_pipe(self, l): - self.input_pipe.append(l) + def add_input_pipe(self, line): + """ Add a line to stdin input """ + self.input_pipe.append(line) - def add_output_pipe_stdout(self, l): - self.output_pipe_stdout.append(l) + def add_output_pipe_stdout(self, line): + """ Add a line to stdout output """ + self.output_pipe_stdout.append(line) - def add_output_pipe_stderr(self, l): - self.output_pipe_stderr.append(l) + def add_output_pipe_stderr(self, line): + """ Add a line to stderr output """ + self.output_pipe_stderr.append(line) def set_cmd(self, args, linenumber): + """ Set command line """ self.args = args self.linenumber = linenumber def add_ignore(self, txt): + """ Add regexp to ignore lines """ self.ignore_regexps.append(re.compile(txt)) def remove_ignored_lines(self, lines): + """ Remove ignored lines """ for ign in self.ignore_regexps: lines = [l for l in lines if not ign.match(l)] return lines @@ -276,7 +288,7 @@ class Cmd(object): file.write("\n") file.close() - def _cmd_cd(self, argline): + def _cmd_cd(self, argline): # pylint: disable=no-self-use args = shlex.split(argline) if len(args) != 2: fatal_error("Too many arguments to cd") @@ -288,34 +300,35 @@ class Cmd(object): print("Test suite `" + FileReader().filename + "': NOK (system error)") tesh_exit(4) - # Run the Cmd if possible. - # Return False if nothing has been ran. - def run_if_possible(self): - if self.can_run(): - if self.background: - lock = _thread.allocate_lock() - lock.acquire() - TeshState().add_thread(lock) - _thread.start_new_thread(Cmd._run, (self, lock)) - else: - self._run() - return True - else: + """ + Run the Cmd if possible. + Return False if nothing has been ran. + """ + if not self.can_run(): return False + if self.background: + lock = _thread.allocate_lock() + lock.acquire() + TeshState().add_thread(lock) + _thread.start_new_thread(Cmd._run, (self, lock)) + else: + self._run() + if self.rerun_with_valgrind and TeshState().auto_valgrind: + print('\n\n\nXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX') + print( 'XXXXXXXXX Rerunning this test with valgrind to help debugging it XXXXXXXXX') + print( 'XXXXXXXX (this will fail if valgrind is not installed, of course) XXXXXXXX') + print( 'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\n\n\n') + + self.args = "valgrind " + self.args + self._run() + return True + def _run(self, lock=None): # Python threads loose the cwd os.chdir(self.cwd) - # retrocompatibility: support ${aaa:=.} variable format - def replace_perl_variables(m): - vname = m.group(1) - vdefault = m.group(2) - if vname in os.environ: - return "$" + vname - else: - return vdefault self.args = re.sub(r"\${(\w+):=([^}]*)}", replace_perl_variables, self.args) # replace bash environment variables ($THINGS) to their values @@ -344,20 +357,19 @@ class Cmd(object): self.args += TeshState().args_suffix logs = list() - logs.append("[{file}:{number}] {args}".format(file=FileReader().filename, - number=self.linenumber, args=self.args)) + msg = "[{file}:{number}] {args}".format(file=FileReader().filename, number=self.linenumber, args=self.args) + if self.background: + logs.append(msg) + else: + print(msg, flush=True) args = shlex.split(self.args) - global running_pids local_pid = None - global return_code try: - preexec_function = None - if not isWindows(): - preexec_function = lambda: os.setpgid(0, 0) - proc = subprocess.Popen( + preexec_function = lambda: os.setpgid(0, 0) + proc = subprocess.Popen( # pylint: disable=subprocess-popen-preexec-fn args, bufsize=1, stdin=subprocess.PIPE, @@ -365,71 +377,74 @@ class Cmd(object): stderr=subprocess.STDOUT, universal_newlines=True, preexec_fn=preexec_function) - if not isWindows(): - local_pid = proc.pid - running_pids.append(local_pid) + local_pid = proc.pid + TeshState().running_pids.append(local_pid) except PermissionError: logs.append("[{file}:{number}] Cannot start '{cmd}': The binary is not executable.".format( file=FileReader().filename, number=self.linenumber, cmd=args[0])) logs.append("[{file}:{number}] Current dir: {dir}".format(file=FileReader().filename, - number=self.linenumber, dir=os.getcwd())) - return_code = max(3, return_code) + number=self.linenumber, dir=os.getcwd())) + TeshState().set_return_code(3) print('\n'.join(logs)) return except NotADirectoryError: logs.append("[{file}:{number}] Cannot start '{cmd}': The path to binary does not exist.".format( file=FileReader().filename, number=self.linenumber, cmd=args[0])) logs.append("[{file}:{number}] Current dir: {dir}".format(file=FileReader().filename, - number=self.linenumber, dir=os.getcwd())) - return_code = max(3, return_code) + number=self.linenumber, dir=os.getcwd())) + TeshState().set_return_code(3) print('\n'.join(logs)) return except FileNotFoundError: logs.append("[{file}:{number}] Cannot start '{cmd}': File not found.".format( file=FileReader().filename, number=self.linenumber, cmd=args[0])) - return_code = max(3, return_code) + TeshState().set_return_code(3) print('\n'.join(logs)) return - except OSError as osE: - if osE.errno == 8: - osE.strerror += "\nOSError: [Errno 8] Executed scripts should start with shebang line (like #!/usr/bin/env sh)" - raise osE + except OSError as err: + if err.errno == 8: + err.strerror += \ + "\nOSError: [Errno 8] Executed scripts should start with shebang line (like #!/usr/bin/env sh)" + raise err - cmdName = FileReader().filename + ":" + str(self.linenumber) + cmd_name = FileReader().filename + ":" + str(self.linenumber) try: - (stdout_data, stderr_data) = proc.communicate("\n".join(self.input_pipe), self.timeout) - local_pid = None + (stdout_data, _stderr_data) = proc.communicate("\n".join(self.input_pipe), self.timeout) timeout_reached = False except subprocess.TimeoutExpired: timeout_reached = True logs.append("Test suite `{file}': NOK (<{cmd}> timeout after {timeout} sec)".format( - file=FileReader().filename, cmd=cmdName, timeout=self.timeout)) - running_pids.remove(local_pid) + file=FileReader().filename, cmd=cmd_name, timeout=self.timeout)) + TeshState().running_pids.remove(local_pid) kill_process_group(local_pid) # Try to get the output of the timeout process, to help in debugging. try: - (stdout_data, stderr_data) = proc.communicate(timeout=1) + (stdout_data, _stderr_data) = proc.communicate(timeout=1) except subprocess.TimeoutExpired: logs.append("[{file}:{number}] Could not retrieve output. Killing the process group failed?".format( file=FileReader().filename, number=self.linenumber)) - return_code = max(3, return_code) + TeshState().set_return_code(3) print('\n'.join(logs)) return - if self.output_display: - logs.append(str(stdout_data)) - # remove text colors ansi_escape = re.compile(r'\x1b[^m]*m') stdout_data = ansi_escape.sub('', stdout_data) + if self.output_display: + logs.append(str(stdout_data)) + + if self.rerun_with_valgrind: + print(str(stdout_data), file=sys.stderr) + return + if self.ignore_output: - logs.append("(ignoring the output of <{cmd}> as requested)".format(cmd=cmdName)) + logs.append("(ignoring the output of <{cmd}> as requested)".format(cmd=cmd_name)) else: stdouta = stdout_data.split("\n") - while len(stdouta) > 0 and stdouta[-1] == "": - del stdouta[-1] stdouta = self.remove_ignored_lines(stdouta) + while stdouta and stdouta[-1] == "": + del stdouta[-1] stdcpy = stdouta[:] # Mimic the "sort" bash command, which is case unsensitive. @@ -447,8 +462,8 @@ class Cmd(object): lineterm="", fromfile='expected', tofile='obtained')) - if len(diff) > 0: - logs.append("Output of <{cmd}> mismatch:".format(cmd=cmdName)) + if diff: + logs.append("Output of <{cmd}> mismatch:".format(cmd=cmd_name)) if self.sort >= 0: # If sorted, truncate the diff output and show the unsorted version difflen = 0 for line in diff: @@ -465,64 +480,80 @@ class Cmd(object): logs.append(line) logs.append("Test suite `{file}': NOK (<{cmd}> output mismatch)".format( - file=FileReader().filename, cmd=cmdName)) + file=FileReader().filename, cmd=cmd_name)) + + # Also report any failed return code and/or signal we got in case of output mismatch + if not proc.returncode in self.expect_return: + if proc.returncode >= 0: + logs.append("In addition, <{cmd}> returned code {code}.".format( + cmd=cmd_name, code=proc.returncode)) + else: + logs.append("In addition, <{cmd}> got signal {sig}.".format(cmd=cmd_name, + sig=SIGNALS_TO_NAMES_DICT[-proc.returncode])) + if proc.returncode == -signal.SIGSEGV: + self.rerun_with_valgrind = True + if lock is not None: lock.release() if TeshState().keep: - f = open('obtained', 'w') + file = open('obtained', 'w') obtained = stdout_data.split("\n") - while len(obtained) > 0 and obtained[-1] == "": + while obtained and obtained[-1] == "": del obtained[-1] obtained = self.remove_ignored_lines(obtained) for line in obtained: - f.write("> " + line + "\n") - f.close() + file.write("> " + line + "\n") + file.close() logs.append("Obtained output kept as requested: {path}".format(path=os.path.abspath("obtained"))) - return_code = max(2, return_code) + TeshState().set_return_code(2) print('\n'.join(logs)) return if timeout_reached: - return_code = max(3, return_code) + TeshState().set_return_code(3) print('\n'.join(logs)) return - if proc.returncode != self.expect_return: + if not proc.returncode in self.expect_return: if proc.returncode >= 0: logs.append("Test suite `{file}': NOK (<{cmd}> returned code {code})".format( - file=FileReader().filename, cmd=cmdName, code=proc.returncode)) + file=FileReader().filename, cmd=cmd_name, code=proc.returncode)) if lock is not None: lock.release() - return_code = max(2, return_code) - print('\n'.join(logs)) - return - else: - logs.append("Test suite `{file}': NOK (<{cmd}> got signal {sig})".format( - file=FileReader().filename, cmd=cmdName, - sig=SIGNALS_TO_NAMES_DICT[-proc.returncode])) - if lock is not None: - lock.release() - return_code = max(max(-proc.returncode, 1), return_code) + TeshState().set_return_code(2) print('\n'.join(logs)) return + logs.append("Test suite `{file}': NOK (<{cmd}> got signal {sig})".format( + file=FileReader().filename, cmd=cmd_name, + sig=SIGNALS_TO_NAMES_DICT[-proc.returncode])) + + if proc.returncode == -signal.SIGSEGV: + self.rerun_with_valgrind = True + + if lock is not None: + lock.release() + TeshState().set_return_code(max(-proc.returncode, 1)) + print('\n'.join(logs)) + return + if lock is not None: lock.release() print('\n'.join(logs)) def can_run(self): + """ Check if ready to run """ return self.args is not None - ############## # # Main # # - -if __name__ == '__main__': +def main(): + """ main function """ signal.signal(signal.SIGINT, signal_handler) signal.signal(signal.SIGTERM, signal_handler) @@ -539,7 +570,11 @@ if __name__ == '__main__': group1.add_argument( '--ignore-jenkins', action='store_true', - help='ignore all cruft generated on SimGrid continous integration servers') + help='ignore all cruft generated on SimGrid continuous integration servers') + group1.add_argument( + '--no-auto-valgrind', + action='store_true', + help='do not automaticall launch segfaulting commands in valgrind') group1.add_argument('--wrapper', metavar='arg', help='Run each command in the provided wrapper (eg valgrind)') group1.add_argument( '--keep', @@ -553,47 +588,50 @@ if __name__ == '__main__': os.chdir(options.cd) if options.ignore_jenkins: - print("Ignore all cruft seen on SimGrid's continous integration servers") + print("Ignore all cruft seen on SimGrid's continuous integration servers") # Note: regexps should match at the beginning of lines TeshState().ignore_regexps_common = [ re.compile(r"profiling:"), re.compile(r"Unable to clean temporary file C:"), re.compile(r".*Configuration change: Set 'contexts/"), - re.compile(r"Picked up JAVA_TOOL_OPTIONS: "), - re.compile(r"Picked up _JAVA_OPTIONS: "), re.compile(r"==[0-9]+== ?WARNING: ASan doesn't fully support"), - re.compile(r"==[0-9]+== ?WARNING: ASan is ignoring requested __asan_handle_no_return: stack top:"), + re.compile(r"==[0-9]+== ?WARNING: ASan is ignoring requested __asan_handle_no_return: stack "), re.compile(r"False positive error reports may follow"), - re.compile(r"For details see http://code.google.com/p/address-sanitizer/issues/detail\?id=189"), - re.compile(r"For details see https://github.com/google/sanitizers/issues/189"), + re.compile(r"For details see http://code\.google\.com/p/address-sanitizer/issues/detail\?id=189"), + re.compile(r"For details see https://github\.com/google/sanitizers/issues/189"), re.compile(r"Python runtime initialized with LC_CTYPE=C .*"), + re.compile(r"sthread is intercepting the execution of \.*"), # Seen on CircleCI re.compile(r"cmake: /usr/local/lib/libcurl\.so\.4: no version information available \(required by cmake\)"), - re.compile(r".*mmap broken on FreeBSD, but dlopen\+thread broken too. Switching to dlopen\+raw contexts\."), + re.compile( + r".*mmap broken on FreeBSD, but dlopen\+thread broken too\. Switching to dlopen\+raw contexts\."), re.compile(r".*dlopen\+thread broken on Apple and BSD\. Switching to raw contexts\."), ] TeshState().jenkins = True # This is a Jenkins build + if options.no_auto_valgrind: + TeshState().auto_valgrind = False + if options.teshfile is None: - f = FileReader(None) + file = FileReader(None) print("Test suite from stdin") else: if not os.path.isfile(options.teshfile): print("Cannot open teshfile '" + options.teshfile + "': File not found") tesh_exit(3) - f = FileReader(options.teshfile) - print("Test suite '" + f.abspath + "'") + file = FileReader(options.teshfile) + print("Test suite '" + file.abspath + "'") if options.setenv is not None: - for e in options.setenv: - setenv(e) + for env in options.setenv: + setenv(env) if options.cfg is not None: - for c in options.cfg: - TeshState().args_suffix += " --cfg=" + c + for cfg in options.cfg: + TeshState().args_suffix += " --cfg=" + cfg if options.log is not None: - for l in options.log: - TeshState().args_suffix += " --log=" + l + for log in options.log: + TeshState().args_suffix += " --log=" + log if options.wrapper is not None: TeshState().wrapper = options.wrapper @@ -606,10 +644,10 @@ if __name__ == '__main__': # when ready, we execute it. cmd = Cmd() - line = f.readfullline() + line = file.readfullline() while line is not None: # print(">>============="+line+"==<<") - if len(line) == 0: + if not line: #print ("END CMD block") if cmd.run_if_possible(): cmd = Cmd() @@ -633,12 +671,12 @@ if __name__ == '__main__': elif line[0:2] == "$ ": if cmd.run_if_possible(): cmd = Cmd() - cmd.set_cmd(line[2:], f.linenumber) + cmd.set_cmd(line[2:], file.linenumber) elif line[0:2] == "& ": if cmd.run_if_possible(): cmd = Cmd() - cmd.set_cmd(line[2:], f.linenumber) + cmd.set_cmd(line[2:], file.linenumber) cmd.background = True elif line[0:15] == "! output ignore": @@ -648,25 +686,35 @@ if __name__ == '__main__': cmd.output_display = True cmd.ignore_output = True elif line[0:15] == "! expect return": - cmd.expect_return = int(line[16:]) + try: + cmd.expect_return = [int(line[16:])] + except ValueError as err: + fatal_error("Invalid expect return value: \""+(line[16:])+"\"") #print("expect return "+str(int(line[16:]))) elif line[0:15] == "! expect signal": - sig = line[16:] - # get the signal integer value from the signal module - if sig not in signal.__dict__: - fatal_error("unrecognized signal '" + sig + "'") - sig = int(signal.__dict__[sig]) - # popen return -signal when a process ends with a signal - cmd.expect_return = -sig + cmd.expect_return = [] + for sig in (line[16:]).split("|"): + # get the signal integer value from the signal module + if sig not in signal.__dict__: + fatal_error("unrecognized signal '" + sig + "'") + sig = int(signal.__dict__[sig]) + # popen return -signal when a process ends with a signal + cmd.expect_return.append(-sig) elif line[0:len("! timeout ")] == "! timeout ": if "no" in line[len("! timeout "):]: cmd.timeout = None else: - cmd.timeout = int(line[len("! timeout "):]) + try: + cmd.timeout = int(line[len("! timeout "):]) + except ValueError as err: + fatal_error("Invalid timeout value: \""+(line[len("! timeout "):])+"\"") elif line[0:len("! output sort")] == "! output sort": if len(line) >= len("! output sort "): - sort = int(line[len("! output sort "):]) + try: + sort = int(line[len("! output sort "):]) + except ValueError as err: + fatal_error("Invalid sort value: \""+(line[len("! output sort "):])+"\"") else: sort = 0 cmd.sort = sort @@ -677,18 +725,29 @@ if __name__ == '__main__': cmd.add_ignore(line[len("! ignore "):]) else: - fatal_error("UNRECOGNIZED OPTION") - - line = f.readfullline() + fatal_error(f"UNRECOGNIZED OPTION LINE: {line}\n" + "Valid requests:\n" + " ! output ignore\n" + " ! output sort\n" + " ! output display\n" + " ! setenv XX=YY\n" + " ! ignore XYZ\n" + " ! expect return NN\n" + " ! expect signal NN\n" + " ! timeout NN\n") + + line = file.readfullline() cmd.run_if_possible() TeshState().join_all_threads() - if return_code == 0: - if f.filename == "(stdin)": + if TeshState().return_code == 0: + if file.filename == "(stdin)": print("Test suite from stdin OK") else: - print("Test suite `" + f.filename + "' OK") - else: - tesh_exit(return_code) + print("Test suite `" + file.filename + "' OK") + tesh_exit(TeshState().return_code) + +if __name__ == '__main__': + main()