X-Git-Url: http://info.iut-bm.univ-fcomte.fr/pub/gitweb/simgrid.git/blobdiff_plain/3eeef4fa4113c9307170633de5346ef6f9a94dc1..75b65a5359d9a02cc2f199c2eb34838e85650eac:/tools/tesh/tesh.py diff --git a/tools/tesh/tesh.py b/tools/tesh/tesh.py index 984e23d3b7..68a661eb64 100755 --- a/tools/tesh/tesh.py +++ b/tools/tesh/tesh.py @@ -1,19 +1,18 @@ -#!/usr/bin/env python +#! @PYTHON_EXECUTABLE@ # -*- coding: utf-8 -*- """ tesh -- testing shell ======================== -Copyright (c) 2012-2015. The SimGrid Team. -All rights reserved. +Copyright (c) 2012-2017. 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 die after its parent. What happen? +#TODO: a child dies after its parent. What happen? #TODO: regular expression in output #ex: >> Time taken: [0-9]+s @@ -37,11 +36,8 @@ import argparse if sys.version_info[0] == 3: import subprocess import _thread -elif sys.version_info[0] < 3: - import subprocess32 as subprocess - import thread as _thread else: - raise "This program has not been made to exist this long" + raise "This program is expected to run with Python3 only" @@ -69,7 +65,7 @@ SIGNALS_TO_NAMES_DICT = dict((getattr(signal, n), n) \ #exit correctly -def exit(errcode): +def tesh_exit(errcode): #If you do not flush some prints are skipped sys.stdout.flush() #os._exit exit even when executed within a thread @@ -78,7 +74,7 @@ def exit(errcode): def fatal_error(msg): print("[Tesh/CRITICAL] "+str(msg)) - exit(1) + tesh_exit(1) #Set an environment variable. @@ -113,23 +109,21 @@ except NameError: # read file line per line (and concat line that ends with "\") class FileReader(Singleton): - def __init__(self, filename): + def __init__(self, filename=None): if filename is None: self.filename = "(stdin)" self.f = sys.stdin else: self.filename_raw = filename self.filename = os.path.basename(filename) + self.abspath = os.path.abspath(filename) self.f = open(self.filename_raw) - + self.linenumber = 0 - def linenumber(self): - return self.linenumber - def __repr__(self): return self.filename+":"+str(self.linenumber) - + def readfullline(self): try: line = next(self.f) @@ -154,38 +148,39 @@ class TeshState(Singleton): self.threads = [] self.args_suffix = "" self.ignore_regexps_common = [] - + self.jenkins = False # not a Jenkins run by default + self.timeout = 10 # default value: 10 sec + self.wrapper = None + self.keep = False + def add_thread(self, thread): self.threads.append(thread) - + def join_all_threads(self): for t in self.threads: t.acquire() t.release() - - - #Command line object class Cmd(object): def __init__(self): self.input_pipe = [] self.output_pipe_stdout = [] self.output_pipe_stderr = [] - self.timeout = 5 + self.timeout = TeshState().timeout self.args = None self.linenumber = -1 - + self.background = False self.cwd = None - + self.ignore_output = False self.expect_return = 0 - + self.output_display = False - + self.sort = -1 - + self.ignore_regexps = TeshState().ignore_regexps_common def add_input_pipe(self, l): @@ -200,10 +195,10 @@ class Cmd(object): def set_cmd(self, args, linenumber): self.args = args self.linenumber = linenumber - + def add_ignore(self, txt): self.ignore_regexps.append(re.compile(txt)) - + def remove_ignored_lines(self, lines): for ign in self.ignore_regexps: lines = [l for l in lines if not ign.match(l)] @@ -216,6 +211,7 @@ class Cmd(object): if file is None: fatal_error("Unable to create file "+filename) file.write("\n".join(self.input_pipe)) + file.write("\n") file.close() def _cmd_cd(self, argline): @@ -228,7 +224,7 @@ class Cmd(object): except FileNotFoundError: print("Chdir to "+args[1]+" failed: No such file or directory") print("Test suite `"+FileReader().filename+"': NOK (system error)") - exit(4) + tesh_exit(4) #Run the Cmd if possible. @@ -254,7 +250,7 @@ class Cmd(object): if self.cwd is not None: os.chdir(self.cwd) self.cwd = None - + #retrocompatibility: support ${aaa:=.} variable format def replace_perl_variables(m): vname = m.group(1) @@ -267,35 +263,49 @@ class Cmd(object): #replace bash environment variables ($THINGS) to their values self.args = expandvars2(self.args) - + if re.match("^mkfile ", self.args) is not None: self._cmd_mkfile(self.args) if lock is not None: lock.release() return - + if re.match("^cd ", self.args) is not None: self._cmd_cd(self.args) if lock is not None: lock.release() return - + + if TeshState().wrapper is not None: + self.timeout *= 20 + self.args = TeshState().wrapper + self.args + elif re.match(".*smpirun.*", self.args) is not None: + self.args = "sh " + self.args + if TeshState().jenkins and self.timeout != None: + self.timeout *= 10 + self.args += TeshState().args_suffix - + print("["+FileReader().filename+":"+str(self.linenumber)+"] "+self.args) - + args = shlex.split(self.args) #print (args) + try: proc = subprocess.Popen(args, bufsize=1, stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.STDOUT, universal_newlines=True) - except OSError as e: - if e.errno == 8: - e.strerror += "\nOSError: [Errno 8] Executed scripts should start with shebang line (like #!/bin/sh)" - raise e - + except FileNotFoundError: + print("["+FileReader().filename+":"+str(self.linenumber)+"] Cannot start '"+args[0]+"': File not found") + tesh_exit(3) + except OSError as osE: + if osE.errno == 8: + osE.strerror += "\nOSError: [Errno 8] Executed scripts should start with shebang line (like #!/bin/sh)" + raise osE + + cmdName = FileReader().filename+":"+str(self.linenumber) try: (stdout_data, stderr_data) = proc.communicate("\n".join(self.input_pipe), self.timeout) except subprocess.TimeoutExpired: - print("Test suite `"+FileReader().filename+"': NOK (<"+FileReader().filename+":"+str(self.linenumber)+"> timeout after "+str(self.timeout)+" sec)") - exit(3) + print("Test suite `"+FileReader().filename+"': NOK (<"+cmdName+"> timeout after "+str(self.timeout)+" sec)") + proc.kill() + tesh_exit(3) if self.output_display: print(stdout_data) @@ -303,59 +313,76 @@ class Cmd(object): #remove text colors ansi_escape = re.compile(r'\x1b[^m]*m') stdout_data = ansi_escape.sub('', stdout_data) - + #print ((stdout_data, stderr_data)) - + if self.ignore_output: - print("(ignoring the output of <"+FileReader().filename+":"+str(self.linenumber)+"> as requested)") + print("(ignoring the output of <"+cmdName+"> as requested)") else: stdouta = stdout_data.split("\n") while len(stdouta) > 0 and stdouta[-1] == "": del stdouta[-1] stdouta = self.remove_ignored_lines(stdouta) + stdcpy = stdouta[:] - #the "sort" bash command is case unsensitive, - # we mimic its behaviour + # Mimic the "sort" bash command, which is case unsensitive. if self.sort == 0: stdouta.sort(key=lambda x: x.lower()) self.output_pipe_stdout.sort(key=lambda x: x.lower()) elif self.sort > 0: stdouta.sort(key=lambda x: x[:self.sort].lower()) self.output_pipe_stdout.sort(key=lambda x: x[:self.sort].lower()) - + diff = list(difflib.unified_diff(self.output_pipe_stdout, stdouta,lineterm="",fromfile='expected', tofile='obtained')) - if len(diff) > 0: - print("Output of <"+FileReader().filename+":"+str(self.linenumber)+"> mismatch:") - for line in diff: - print(line) - print("Test suite `"+FileReader().filename+"': NOK (<"+str(FileReader())+"> output mismatch)") + if len(diff) > 0: + print("Output of <"+cmdName+"> mismatch:") + if self.sort >= 0: # If sorted, truncate the diff output and show the unsorted version + difflen = 0; + for line in diff: + if difflen<50: + print(line) + difflen += 1 + if difflen > 50: + print("(diff truncated after 50 lines)") + print("Unsorted observed output:\n") + for line in stdcpy: + print(line) + else: # If not sorted, just display the diff + for line in diff: + print(line) + + print("Test suite `"+FileReader().filename+"': NOK (<"+cmdName+"> output mismatch)") if lock is not None: lock.release() - exit(2) - + if TeshState().keep: + f = open('obtained','w') + obtained = stdout_data.split("\n") + while len(obtained) > 0 and obtained[-1] == "": + del obtained[-1] + obtained = self.remove_ignored_lines(obtained) + for line in obtained: + f.write("> "+line+"\n") + f.close() + print("Obtained output kept as requested: "+os.path.abspath("obtained")) + tesh_exit(2) + #print ((proc.returncode, self.expect_return)) - + if proc.returncode != self.expect_return: if proc.returncode >= 0: - print("Test suite `"+FileReader().filename+"': NOK (<"+str(FileReader())+"> returned code "+str(proc.returncode)+")") + print("Test suite `"+FileReader().filename+"': NOK (<"+cmdName+"> returned code "+str(proc.returncode)+")") if lock is not None: lock.release() - exit(2) + tesh_exit(2) else: - print("Test suite `"+FileReader().filename+"': NOK (<"+str(FileReader())+"> got signal "+SIGNALS_TO_NAMES_DICT[-proc.returncode]+")") + print("Test suite `"+FileReader().filename+"': NOK (<"+cmdName+"> got signal "+SIGNALS_TO_NAMES_DICT[-proc.returncode]+")") if lock is not None: lock.release() - exit(-proc.returncode) - - if lock is not None: lock.release() - - - - def can_run(self): - return self.args is not None - - + tesh_exit(-proc.returncode) + if lock is not None: lock.release() + def can_run(self): + return self.args is not None @@ -369,50 +396,77 @@ class Cmd(object): if __name__ == '__main__': - + parser = argparse.ArgumentParser(description='tesh -- testing shell', add_help=True) group1 = parser.add_argument_group('Options') group1.add_argument('teshfile', nargs='?', help='Name of teshfile, stdin if omitted') group1.add_argument('--cd', metavar='some/directory', help='ask tesh to switch the working directory before launching the tests') group1.add_argument('--setenv', metavar='var=value', action='append', help='set a specific environment variable') - group1.add_argument('--cfg', metavar='arg', help='add parameter --cfg=arg to each command line') - group1.add_argument('--log', metavar='arg', help='add parameter --log=arg to each command line') - group1.add_argument('--enable-coverage', action='store_true', help='ignore output lines starting with "profiling:"') + group1.add_argument('--cfg', metavar='arg', action='append', help='add parameter --cfg=arg to each command line') + group1.add_argument('--log', metavar='arg', action='append', help='add parameter --log=arg to each command line') + group1.add_argument('--ignore-jenkins', action='store_true', help='ignore all cruft generated on SimGrid continous integration servers') + group1.add_argument('--wrapper', metavar='arg', help='Run each command in the provided wrapper (eg valgrind)') + group1.add_argument('--keep', action='store_true', help='Keep the obtained output when it does not match the expected one') try: options = parser.parse_args() - except: - exit(1) + except SystemExit: + tesh_exit(1) if options.cd is not None: os.chdir(options.cd) - if options.enable_coverage: - print("Enable coverage") - TeshState().ignore_regexps_common = [re.compile("^profiling:")] - + if options.ignore_jenkins: + print("Ignore all cruft seen on SimGrid's continous integration servers") + # Note: regexps should match at the beginning of lines + TeshState().ignore_regexps_common = [ + re.compile("profiling:"), + re.compile("Unable to clean temporary file C:"), + re.compile(".*Configuration change: Set \'contexts/"), + re.compile("Picked up JAVA_TOOL_OPTIONS: "), + re.compile("Picked up _JAVA_OPTIONS: "), + re.compile("==[0-9]+== ?WARNING: ASan doesn\'t fully support"), + re.compile("==[0-9]+== ?WARNING: ASan is ignoring requested __asan_handle_no_return: stack top:"), + re.compile("False positive error reports may follow"), + re.compile("For details see http://code.google.com/p/address-sanitizer/issues/detail\\?id=189"), + re.compile("For details see https://github.com/google/sanitizers/issues/189"), + re.compile("Python runtime initialized with LC_CTYPE=C .*"), + re.compile("^cmake: .*? no version information available (required by cmake)"), # Seen on CircleCI + ] + TeshState().jenkins = True # This is a Jenkins build + if options.teshfile is None: f = 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.filename+"'") - + print("Test suite '"+f.abspath+"'") + if options.setenv is not None: for e in options.setenv: setenv(e) - + if options.cfg is not None: - TeshState().args_suffix += " --cfg="+options.cfg + for c in options.cfg: + TeshState().args_suffix += " --cfg=" + c if options.log is not None: - TeshState().args_suffix += " --log="+options.log - - + for l in options.log: + TeshState().args_suffix += " --log=" + l + + if options.wrapper is not None: + TeshState().wrapper = options.wrapper + + if options.keep: + TeshState().keep = True + #cmd holds the current command line # tech commands will add some parameters to it # when ready, we execute it. cmd = Cmd() - + line = f.readfullline() while line is not None: #print(">>============="+line+"==<<") @@ -420,34 +474,34 @@ if __name__ == '__main__': #print ("END CMD block") if cmd.run_if_possible(): cmd = Cmd() - + elif line[0] == "#": pass - + elif line[0:2] == "p ": print("["+str(FileReader())+"] "+line[2:]) - + elif line[0:2] == "< ": cmd.add_input_pipe(line[2:]) elif line[0:1] == "<": cmd.add_input_pipe(line[1:]) - + elif line[0:2] == "> ": cmd.add_output_pipe_stdout(line[2:]) elif line[0:1] == ">": cmd.add_output_pipe_stdout(line[1:]) - + elif line[0:2] == "$ ": if cmd.run_if_possible(): cmd = Cmd() cmd.set_cmd(line[2:], f.linenumber) - + elif line[0:2] == "& ": if cmd.run_if_possible(): cmd = Cmd() cmd.set_cmd(line[2:], f.linenumber) cmd.background = True - + elif line[0:15] == "! output ignore": cmd.ignore_output = True #print("cmd.ignore_output = True") @@ -470,7 +524,7 @@ if __name__ == '__main__': cmd.timeout = None else: cmd.timeout = int(line[len("! timeout "):]) - + elif line[0:len("! output sort")] == "! output sort": if len(line) >= len("! output sort "): sort = int(line[len("! output sort "):]) @@ -479,26 +533,21 @@ if __name__ == '__main__': cmd.sort = sort elif line[0:len("! setenv ")] == "! setenv ": setenv(line[len("! setenv "):]) - + elif line[0:len("! ignore ")] == "! ignore ": cmd.add_ignore(line[len("! ignore "):]) - + else: fatal_error("UNRECOGNIZED OPTION") - - + + line = f.readfullline() cmd.run_if_possible() - + TeshState().join_all_threads() - + if f.filename == "(stdin)": print("Test suite from stdin OK") else: print("Test suite `"+f.filename+"' OK") - - - - -