2 # -*- coding: utf-8 -*-
6 ========================
8 Copyright (c) 2012-2017. 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]+)
36 if sys.version_info[0] == 3:
40 raise "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
51 class _Singleton(type):
52 """ A metaclass that creates a Singleton base class when called. """
54 def __call__(cls, *args, **kwargs):
55 if cls not in cls._instances:
56 cls._instances[cls] = super(_Singleton, cls).__call__(*args, **kwargs)
57 return cls._instances[cls]
58 class Singleton(_Singleton('SingletonMeta', (object,), {})): pass
60 SIGNALS_TO_NAMES_DICT = dict((getattr(signal, n), n) \
61 for n in dir(signal) if n.startswith('SIG') and '_' not in n )
66 def tesh_exit(errcode):
67 #If you do not flush some prints are skipped
69 #os._exit exit even when executed within a thread
74 print("[Tesh/CRITICAL] "+str(msg))
78 #Set an environment variable.
79 # arg must be a string with the format "variable=value"
81 print("[Tesh/INFO] setenv "+arg)
83 os.environ[t[0]] = t[1]
84 #os.putenv(t[0], t[1]) does not work
85 #see http://stackoverflow.com/questions/17705419/python-os-environ-os-putenv-usr-bin-env
88 #http://stackoverflow.com/questions/30734967/how-to-expand-environment-variables-in-python-as-bash-does
89 def expandvars2(path):
90 return re.sub(r'(?<!\\)\$[A-Za-z_][A-Za-z0-9_]*', '', os.path.expandvars(path))
92 # https://github.com/Cadair/jupyter_environment_kernels/issues/10
97 FileNotFoundError = OSError
105 # Global variable. Stores which process group should be killed (or None otherwise)
108 def kill_process_group(pgid):
109 # print("Kill process group {}".format(pgid))
111 os.killpg(pgid, signal.SIGTERM)
113 # os.killpg failed. OK. Some subprocesses may still be running.
116 def signal_handler(signal, frame):
117 print("Caught signal {}".format(SIGNALS_TO_NAMES_DICT[signal]))
118 if pgtokill is not None:
119 kill_process_group(pgtokill)
132 # read file line per line (and concat line that ends with "\")
133 class FileReader(Singleton):
134 def __init__(self, filename=None):
136 self.filename = "(stdin)"
139 self.filename_raw = filename
140 self.filename = os.path.basename(filename)
141 self.abspath = os.path.abspath(filename)
142 self.f = open(self.filename_raw)
147 return self.filename+":"+str(self.linenumber)
149 def readfullline(self):
153 except StopIteration:
159 while len(line) > 1 and line[-2] == "\\":
167 #keep the state of tesh (mostly configuration values)
168 class TeshState(Singleton):
171 self.args_suffix = ""
172 self.ignore_regexps_common = []
173 self.jenkins = False # not a Jenkins run by default
174 self.timeout = 10 # default value: 10 sec
178 def add_thread(self, thread):
179 self.threads.append(thread)
181 def join_all_threads(self):
182 for t in self.threads:
190 self.output_pipe_stdout = []
191 self.output_pipe_stderr = []
192 self.timeout = TeshState().timeout
196 self.background = False
199 self.ignore_output = False
200 self.expect_return = 0
202 self.output_display = False
206 self.ignore_regexps = TeshState().ignore_regexps_common
208 def add_input_pipe(self, l):
209 self.input_pipe.append(l)
211 def add_output_pipe_stdout(self, l):
212 self.output_pipe_stdout.append(l)
214 def add_output_pipe_stderr(self, l):
215 self.output_pipe_stderr.append(l)
217 def set_cmd(self, args, linenumber):
219 self.linenumber = linenumber
221 def add_ignore(self, txt):
222 self.ignore_regexps.append(re.compile(txt))
224 def remove_ignored_lines(self, lines):
225 for ign in self.ignore_regexps:
226 lines = [l for l in lines if not ign.match(l)]
230 def _cmd_mkfile(self, argline):
231 filename = argline[len("mkfile "):]
232 file = open(filename, "w")
234 fatal_error("Unable to create file "+filename)
235 file.write("\n".join(self.input_pipe))
239 def _cmd_cd(self, argline):
240 args = shlex.split(argline)
242 fatal_error("Too many arguments to cd")
245 print("[Tesh/INFO] change directory to "+args[1])
246 except FileNotFoundError:
247 print("Chdir to "+args[1]+" failed: No such file or directory")
248 print("Test suite `"+FileReader().filename+"': NOK (system error)")
252 #Run the Cmd if possible.
253 # Return False if nothing has been ran.
254 def run_if_possible(self):
257 #Python threads loose the cwd
258 self.cwd = os.getcwd()
259 lock = _thread.allocate_lock()
261 TeshState().add_thread(lock)
262 _thread.start_new_thread( Cmd._run, (self, lock) )
270 def _run(self, lock=None):
271 #Python threads loose the cwd
272 if self.cwd is not None:
276 #retrocompatibility: support ${aaa:=.} variable format
277 def replace_perl_variables(m):
279 vdefault = m.group(2)
280 if vname in os.environ:
284 self.args = re.sub(r"\${(\w+):=([^}]*)}", replace_perl_variables, self.args)
286 #replace bash environment variables ($THINGS) to their values
287 self.args = expandvars2(self.args)
289 if re.match("^mkfile ", self.args) is not None:
290 self._cmd_mkfile(self.args)
291 if lock is not None: lock.release()
294 if re.match("^cd ", self.args) is not None:
295 self._cmd_cd(self.args)
296 if lock is not None: lock.release()
299 if TeshState().wrapper is not None:
301 self.args = TeshState().wrapper + self.args
302 elif re.match(".*smpirun.*", self.args) is not None:
303 self.args = "sh " + self.args
304 if TeshState().jenkins and self.timeout != None:
307 self.args += TeshState().args_suffix
309 print("["+FileReader().filename+":"+str(self.linenumber)+"] "+self.args)
311 args = shlex.split(self.args)
317 proc = subprocess.Popen(args, bufsize=1, stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.STDOUT, universal_newlines=True, preexec_fn=os.setsid)
319 pgtokill = os.getpgid(proc.pid)
321 # os.getpgid failed. OK. No cleanup.
323 except FileNotFoundError:
324 print("["+FileReader().filename+":"+str(self.linenumber)+"] Cannot start '"+args[0]+"': File not found")
326 except OSError as osE:
328 osE.strerror += "\nOSError: [Errno 8] Executed scripts should start with shebang line (like #!/usr/bin/env sh)"
331 cmdName = FileReader().filename+":"+str(self.linenumber)
333 (stdout_data, stderr_data) = proc.communicate("\n".join(self.input_pipe), self.timeout)
335 except subprocess.TimeoutExpired:
336 print("Test suite `"+FileReader().filename+"': NOK (<"+cmdName+"> timeout after "+str(self.timeout)+" sec)")
337 kill_process_group(pgtokill)
340 if self.output_display:
344 ansi_escape = re.compile(r'\x1b[^m]*m')
345 stdout_data = ansi_escape.sub('', stdout_data)
347 #print ((stdout_data, stderr_data))
349 if self.ignore_output:
350 print("(ignoring the output of <"+cmdName+"> as requested)")
352 stdouta = stdout_data.split("\n")
353 while len(stdouta) > 0 and stdouta[-1] == "":
355 stdouta = self.remove_ignored_lines(stdouta)
358 # Mimic the "sort" bash command, which is case unsensitive.
360 stdouta.sort(key=lambda x: x.lower())
361 self.output_pipe_stdout.sort(key=lambda x: x.lower())
363 stdouta.sort(key=lambda x: x[:self.sort].lower())
364 self.output_pipe_stdout.sort(key=lambda x: x[:self.sort].lower())
366 diff = list(difflib.unified_diff(self.output_pipe_stdout, stdouta,lineterm="",fromfile='expected', tofile='obtained'))
368 print("Output of <"+cmdName+"> mismatch:")
369 if self.sort >= 0: # If sorted, truncate the diff output and show the unsorted version
376 print("(diff truncated after 50 lines)")
377 print("Unsorted observed output:\n")
380 else: # If not sorted, just display the diff
384 print("Test suite `"+FileReader().filename+"': NOK (<"+cmdName+"> output mismatch)")
385 if lock is not None: lock.release()
387 f = open('obtained','w')
388 obtained = stdout_data.split("\n")
389 while len(obtained) > 0 and obtained[-1] == "":
391 obtained = self.remove_ignored_lines(obtained)
392 for line in obtained:
393 f.write("> "+line+"\n")
395 print("Obtained output kept as requested: "+os.path.abspath("obtained"))
398 #print ((proc.returncode, self.expect_return))
400 if proc.returncode != self.expect_return:
401 if proc.returncode >= 0:
402 print("Test suite `"+FileReader().filename+"': NOK (<"+cmdName+"> returned code "+str(proc.returncode)+")")
403 if lock is not None: lock.release()
406 print("Test suite `"+FileReader().filename+"': NOK (<"+cmdName+"> got signal "+SIGNALS_TO_NAMES_DICT[-proc.returncode]+")")
407 if lock is not None: lock.release()
408 tesh_exit(-proc.returncode)
410 if lock is not None: lock.release()
415 return self.args is not None
428 if __name__ == '__main__':
429 signal.signal(signal.SIGINT, signal_handler)
430 signal.signal(signal.SIGTERM, signal_handler)
432 parser = argparse.ArgumentParser(description='tesh -- testing shell', add_help=True)
433 group1 = parser.add_argument_group('Options')
434 group1.add_argument('teshfile', nargs='?', help='Name of teshfile, stdin if omitted')
435 group1.add_argument('--cd', metavar='some/directory', help='ask tesh to switch the working directory before launching the tests')
436 group1.add_argument('--setenv', metavar='var=value', action='append', help='set a specific environment variable')
437 group1.add_argument('--cfg', metavar='arg', action='append', help='add parameter --cfg=arg to each command line')
438 group1.add_argument('--log', metavar='arg', action='append', help='add parameter --log=arg to each command line')
439 group1.add_argument('--ignore-jenkins', action='store_true', help='ignore all cruft generated on SimGrid continous integration servers')
440 group1.add_argument('--wrapper', metavar='arg', help='Run each command in the provided wrapper (eg valgrind)')
441 group1.add_argument('--keep', action='store_true', help='Keep the obtained output when it does not match the expected one')
444 options = parser.parse_args()
448 if options.cd is not None:
449 print("[Tesh/INFO] change directory to " + options.cd)
452 if options.ignore_jenkins:
453 print("Ignore all cruft seen on SimGrid's continous integration servers")
454 # Note: regexps should match at the beginning of lines
455 TeshState().ignore_regexps_common = [
456 re.compile("profiling:"),
457 re.compile("Unable to clean temporary file C:"),
458 re.compile(".*Configuration change: Set \'contexts/"),
459 re.compile("Picked up JAVA_TOOL_OPTIONS: "),
460 re.compile("Picked up _JAVA_OPTIONS: "),
461 re.compile("==[0-9]+== ?WARNING: ASan doesn\'t fully support"),
462 re.compile("==[0-9]+== ?WARNING: ASan is ignoring requested __asan_handle_no_return: stack top:"),
463 re.compile("False positive error reports may follow"),
464 re.compile("For details see http://code.google.com/p/address-sanitizer/issues/detail\\?id=189"),
465 re.compile("For details see https://github.com/google/sanitizers/issues/189"),
466 re.compile("Python runtime initialized with LC_CTYPE=C .*"),
467 re.compile("cmake: /usr/local/lib/libcurl.so.4: no version information available (required by cmake)"), # Seen on CircleCI
469 TeshState().jenkins = True # This is a Jenkins build
471 if options.teshfile is None:
473 print("Test suite from stdin")
475 if not os.path.isfile(options.teshfile):
476 print("Cannot open teshfile '"+options.teshfile+"': File not found")
478 f = FileReader(options.teshfile)
479 print("Test suite '"+f.abspath+"'")
481 if options.setenv is not None:
482 for e in options.setenv:
485 if options.cfg is not None:
486 for c in options.cfg:
487 TeshState().args_suffix += " --cfg=" + c
488 if options.log is not None:
489 for l in options.log:
490 TeshState().args_suffix += " --log=" + l
492 if options.wrapper is not None:
493 TeshState().wrapper = options.wrapper
496 TeshState().keep = True
498 #cmd holds the current command line
499 # tech commands will add some parameters to it
500 # when ready, we execute it.
503 line = f.readfullline()
504 while line is not None:
505 #print(">>============="+line+"==<<")
507 #print ("END CMD block")
508 if cmd.run_if_possible():
514 elif line[0:2] == "p ":
515 print("["+str(FileReader())+"] "+line[2:])
517 elif line[0:2] == "< ":
518 cmd.add_input_pipe(line[2:])
519 elif line[0:1] == "<":
520 cmd.add_input_pipe(line[1:])
522 elif line[0:2] == "> ":
523 cmd.add_output_pipe_stdout(line[2:])
524 elif line[0:1] == ">":
525 cmd.add_output_pipe_stdout(line[1:])
527 elif line[0:2] == "$ ":
528 if cmd.run_if_possible():
530 cmd.set_cmd(line[2:], f.linenumber)
532 elif line[0:2] == "& ":
533 if cmd.run_if_possible():
535 cmd.set_cmd(line[2:], f.linenumber)
536 cmd.background = True
538 elif line[0:15] == "! output ignore":
539 cmd.ignore_output = True
540 #print("cmd.ignore_output = True")
541 elif line[0:16] == "! output display":
542 cmd.output_display = True
543 cmd.ignore_output = True
544 elif line[0:15] == "! expect return":
545 cmd.expect_return = int(line[16:])
546 #print("expect return "+str(int(line[16:])))
547 elif line[0:15] == "! expect signal":
549 #get the signal integer value from the signal module
550 if sig not in signal.__dict__:
551 fatal_error("unrecognized signal '"+sig+"'")
552 sig = int(signal.__dict__[sig])
553 #popen return -signal when a process ends with a signal
554 cmd.expect_return = -sig
555 elif line[0:len("! timeout ")] == "! timeout ":
556 if "no" in line[len("! timeout "):]:
559 cmd.timeout = int(line[len("! timeout "):])
561 elif line[0:len("! output sort")] == "! output sort":
562 if len(line) >= len("! output sort "):
563 sort = int(line[len("! output sort "):])
567 elif line[0:len("! setenv ")] == "! setenv ":
568 setenv(line[len("! setenv "):])
570 elif line[0:len("! ignore ")] == "! ignore ":
571 cmd.add_ignore(line[len("! ignore "):])
574 fatal_error("UNRECOGNIZED OPTION")
577 line = f.readfullline()
579 cmd.run_if_possible()
581 TeshState().join_all_threads()
583 if f.filename == "(stdin)":
584 print("Test suite from stdin OK")
586 print("Test suite `"+f.filename+"' OK")