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"
51 # Singleton metaclass that works in Python 2 & 3
52 # http://stackoverflow.com/questions/6760685/creating-a-singleton-in-python
53 class _Singleton(type):
54 """ 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]
60 class Singleton(_Singleton('SingletonMeta', (object,), {})): pass
62 SIGNALS_TO_NAMES_DICT = dict((getattr(signal, n), n) \
63 for n in dir(signal) if n.startswith('SIG') and '_' not in n )
68 def tesh_exit(errcode):
69 #If you do not flush some prints are skipped
71 #os._exit exit even when executed within a thread
76 print("[Tesh/CRITICAL] "+str(msg))
80 #Set an environment variable.
81 # arg must be a string with the format "variable=value"
83 print("[Tesh/INFO] setenv "+arg)
85 os.environ[t[0]] = t[1]
86 #os.putenv(t[0], t[1]) does not work
87 #see http://stackoverflow.com/questions/17705419/python-os-environ-os-putenv-usr-bin-env
90 #http://stackoverflow.com/questions/30734967/how-to-expand-environment-variables-in-python-as-bash-does
91 def expandvars2(path):
92 return re.sub(r'(?<!\\)\$[A-Za-z_][A-Za-z0-9_]*', '', os.path.expandvars(path))
94 # https://github.com/Cadair/jupyter_environment_kernels/issues/10
99 FileNotFoundError = OSError
110 # read file line per line (and concat line that ends with "\")
111 class FileReader(Singleton):
112 def __init__(self, filename=None):
114 self.filename = "(stdin)"
117 self.filename_raw = filename
118 self.filename = os.path.basename(filename)
119 self.abspath = os.path.abspath(filename)
120 self.f = open(self.filename_raw)
125 return self.filename+":"+str(self.linenumber)
127 def readfullline(self):
131 except StopIteration:
137 while len(line) > 1 and line[-2] == "\\":
145 #keep the state of tesh (mostly configuration values)
146 class TeshState(Singleton):
149 self.args_suffix = ""
150 self.ignore_regexps_common = []
151 self.jenkins = False # not a Jenkins run by default
152 self.timeout = 10 # default value: 10 sec
156 def add_thread(self, thread):
157 self.threads.append(thread)
159 def join_all_threads(self):
160 for t in self.threads:
168 self.output_pipe_stdout = []
169 self.output_pipe_stderr = []
170 self.timeout = TeshState().timeout
174 self.background = False
177 self.ignore_output = False
178 self.expect_return = 0
180 self.output_display = False
184 self.ignore_regexps = TeshState().ignore_regexps_common
186 def add_input_pipe(self, l):
187 self.input_pipe.append(l)
189 def add_output_pipe_stdout(self, l):
190 self.output_pipe_stdout.append(l)
192 def add_output_pipe_stderr(self, l):
193 self.output_pipe_stderr.append(l)
195 def set_cmd(self, args, linenumber):
197 self.linenumber = linenumber
199 def add_ignore(self, txt):
200 self.ignore_regexps.append(re.compile(txt))
202 def remove_ignored_lines(self, lines):
203 for ign in self.ignore_regexps:
204 lines = [l for l in lines if not ign.match(l)]
208 def _cmd_mkfile(self, argline):
209 filename = argline[len("mkfile "):]
210 file = open(filename, "w")
212 fatal_error("Unable to create file "+filename)
213 file.write("\n".join(self.input_pipe))
217 def _cmd_cd(self, argline):
218 args = shlex.split(argline)
220 fatal_error("Too many arguments to cd")
223 print("[Tesh/INFO] change directory to "+args[1])
224 except FileNotFoundError:
225 print("Chdir to "+args[1]+" failed: No such file or directory")
226 print("Test suite `"+FileReader().filename+"': NOK (system error)")
230 #Run the Cmd if possible.
231 # Return False if nothing has been ran.
232 def run_if_possible(self):
235 #Python threads loose the cwd
236 self.cwd = os.getcwd()
237 lock = _thread.allocate_lock()
239 TeshState().add_thread(lock)
240 _thread.start_new_thread( Cmd._run, (self, lock) )
248 def _run(self, lock=None):
249 #Python threads loose the cwd
250 if self.cwd is not None:
254 #retrocompatibility: support ${aaa:=.} variable format
255 def replace_perl_variables(m):
257 vdefault = m.group(2)
258 if vname in os.environ:
262 self.args = re.sub(r"\${(\w+):=([^}]*)}", replace_perl_variables, self.args)
264 #replace bash environment variables ($THINGS) to their values
265 self.args = expandvars2(self.args)
267 if re.match("^mkfile ", self.args) is not None:
268 self._cmd_mkfile(self.args)
269 if lock is not None: lock.release()
272 if re.match("^cd ", self.args) is not None:
273 self._cmd_cd(self.args)
274 if lock is not None: lock.release()
277 if TeshState().wrapper is not None:
279 self.args = TeshState().wrapper + self.args
280 elif re.match(".*smpirun.*", self.args) is not None:
281 self.args = "sh " + self.args
282 if TeshState().jenkins and self.timeout != None:
285 self.args += TeshState().args_suffix
287 print("["+FileReader().filename+":"+str(self.linenumber)+"] "+self.args)
289 args = shlex.split(self.args)
293 proc = subprocess.Popen(args, bufsize=1, stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.STDOUT, universal_newlines=True)
294 except FileNotFoundError:
295 print("["+FileReader().filename+":"+str(self.linenumber)+"] Cannot start '"+args[0]+"': File not found")
297 except OSError as osE:
299 osE.strerror += "\nOSError: [Errno 8] Executed scripts should start with shebang line (like #!/bin/sh)"
302 cmdName = FileReader().filename+":"+str(self.linenumber)
304 (stdout_data, stderr_data) = proc.communicate("\n".join(self.input_pipe), self.timeout)
305 except subprocess.TimeoutExpired:
306 print("Test suite `"+FileReader().filename+"': NOK (<"+cmdName+"> timeout after "+str(self.timeout)+" sec)")
310 if self.output_display:
314 ansi_escape = re.compile(r'\x1b[^m]*m')
315 stdout_data = ansi_escape.sub('', stdout_data)
317 #print ((stdout_data, stderr_data))
319 if self.ignore_output:
320 print("(ignoring the output of <"+cmdName+"> as requested)")
322 stdouta = stdout_data.split("\n")
323 while len(stdouta) > 0 and stdouta[-1] == "":
325 stdouta = self.remove_ignored_lines(stdouta)
328 # Mimic the "sort" bash command, which is case unsensitive.
330 stdouta.sort(key=lambda x: x.lower())
331 self.output_pipe_stdout.sort(key=lambda x: x.lower())
333 stdouta.sort(key=lambda x: x[:self.sort].lower())
334 self.output_pipe_stdout.sort(key=lambda x: x[:self.sort].lower())
336 diff = list(difflib.unified_diff(self.output_pipe_stdout, stdouta,lineterm="",fromfile='expected', tofile='obtained'))
338 print("Output of <"+cmdName+"> mismatch:")
339 if self.sort >= 0: # If sorted, truncate the diff output and show the unsorted version
346 print("(diff truncated after 50 lines)")
347 print("Unsorted observed output:\n")
350 else: # If not sorted, just display the diff
354 print("Test suite `"+FileReader().filename+"': NOK (<"+cmdName+"> output mismatch)")
355 if lock is not None: lock.release()
357 f = open('obtained','w')
358 obtained = stdout_data.split("\n")
359 while len(obtained) > 0 and obtained[-1] == "":
361 obtained = self.remove_ignored_lines(obtained)
362 for line in obtained:
363 f.write("> "+line+"\n")
365 print("Obtained output kept as requested: "+os.path.abspath("obtained"))
368 #print ((proc.returncode, self.expect_return))
370 if proc.returncode != self.expect_return:
371 if proc.returncode >= 0:
372 print("Test suite `"+FileReader().filename+"': NOK (<"+cmdName+"> returned code "+str(proc.returncode)+")")
373 if lock is not None: lock.release()
376 print("Test suite `"+FileReader().filename+"': NOK (<"+cmdName+"> got signal "+SIGNALS_TO_NAMES_DICT[-proc.returncode]+")")
377 if lock is not None: lock.release()
378 tesh_exit(-proc.returncode)
380 if lock is not None: lock.release()
385 return self.args is not None
398 if __name__ == '__main__':
400 parser = argparse.ArgumentParser(description='tesh -- testing shell', add_help=True)
401 group1 = parser.add_argument_group('Options')
402 group1.add_argument('teshfile', nargs='?', help='Name of teshfile, stdin if omitted')
403 group1.add_argument('--cd', metavar='some/directory', help='ask tesh to switch the working directory before launching the tests')
404 group1.add_argument('--setenv', metavar='var=value', action='append', help='set a specific environment variable')
405 group1.add_argument('--cfg', metavar='arg', action='append', help='add parameter --cfg=arg to each command line')
406 group1.add_argument('--log', metavar='arg', action='append', help='add parameter --log=arg to each command line')
407 group1.add_argument('--ignore-jenkins', action='store_true', help='ignore all cruft generated on SimGrid continous integration servers')
408 group1.add_argument('--wrapper', metavar='arg', help='Run each command in the provided wrapper (eg valgrind)')
409 group1.add_argument('--keep', action='store_true', help='Keep the obtained output when it does not match the expected one')
412 options = parser.parse_args()
416 if options.cd is not None:
419 if options.ignore_jenkins:
420 print("Ignore all cruft seen on SimGrid's continous integration servers")
421 # Note: regexps should match at the beginning of lines
422 TeshState().ignore_regexps_common = [
423 re.compile("profiling:"),
424 re.compile("Unable to clean temporary file C:"),
425 re.compile(".*Configuration change: Set \'contexts/"),
426 re.compile("Picked up JAVA_TOOL_OPTIONS: "),
427 re.compile("Picked up _JAVA_OPTIONS: "),
428 re.compile("==[0-9]+== ?WARNING: ASan doesn\'t fully support"),
429 re.compile("==[0-9]+== ?WARNING: ASan is ignoring requested __asan_handle_no_return: stack top:"),
430 re.compile("False positive error reports may follow"),
431 re.compile("For details see http://code.google.com/p/address-sanitizer/issues/detail\\?id=189"),
432 re.compile("For details see https://github.com/google/sanitizers/issues/189"),
433 re.compile("Python runtime initialized with LC_CTYPE=C .*"),
434 re.compile("cmake: /usr/local/lib/libcurl.so.4: no version information available (required by cmake)"), # Seen on CircleCI
436 TeshState().jenkins = True # This is a Jenkins build
438 if options.teshfile is None:
440 print("Test suite from stdin")
442 if not os.path.isfile(options.teshfile):
443 print("Cannot open teshfile '"+options.teshfile+"': File not found")
445 f = FileReader(options.teshfile)
446 print("Test suite '"+f.abspath+"'")
448 if options.setenv is not None:
449 for e in options.setenv:
452 if options.cfg is not None:
453 for c in options.cfg:
454 TeshState().args_suffix += " --cfg=" + c
455 if options.log is not None:
456 for l in options.log:
457 TeshState().args_suffix += " --log=" + l
459 if options.wrapper is not None:
460 TeshState().wrapper = options.wrapper
463 TeshState().keep = True
465 #cmd holds the current command line
466 # tech commands will add some parameters to it
467 # when ready, we execute it.
470 line = f.readfullline()
471 while line is not None:
472 #print(">>============="+line+"==<<")
474 #print ("END CMD block")
475 if cmd.run_if_possible():
481 elif line[0:2] == "p ":
482 print("["+str(FileReader())+"] "+line[2:])
484 elif line[0:2] == "< ":
485 cmd.add_input_pipe(line[2:])
486 elif line[0:1] == "<":
487 cmd.add_input_pipe(line[1:])
489 elif line[0:2] == "> ":
490 cmd.add_output_pipe_stdout(line[2:])
491 elif line[0:1] == ">":
492 cmd.add_output_pipe_stdout(line[1:])
494 elif line[0:2] == "$ ":
495 if cmd.run_if_possible():
497 cmd.set_cmd(line[2:], f.linenumber)
499 elif line[0:2] == "& ":
500 if cmd.run_if_possible():
502 cmd.set_cmd(line[2:], f.linenumber)
503 cmd.background = True
505 elif line[0:15] == "! output ignore":
506 cmd.ignore_output = True
507 #print("cmd.ignore_output = True")
508 elif line[0:16] == "! output display":
509 cmd.output_display = True
510 cmd.ignore_output = True
511 elif line[0:15] == "! expect return":
512 cmd.expect_return = int(line[16:])
513 #print("expect return "+str(int(line[16:])))
514 elif line[0:15] == "! expect signal":
516 #get the signal integer value from the signal module
517 if sig not in signal.__dict__:
518 fatal_error("unrecognized signal '"+sig+"'")
519 sig = int(signal.__dict__[sig])
520 #popen return -signal when a process ends with a signal
521 cmd.expect_return = -sig
522 elif line[0:len("! timeout ")] == "! timeout ":
523 if "no" in line[len("! timeout "):]:
526 cmd.timeout = int(line[len("! timeout "):])
528 elif line[0:len("! output sort")] == "! output sort":
529 if len(line) >= len("! output sort "):
530 sort = int(line[len("! output sort "):])
534 elif line[0:len("! setenv ")] == "! setenv ":
535 setenv(line[len("! setenv "):])
537 elif line[0:len("! ignore ")] == "! ignore ":
538 cmd.add_ignore(line[len("! ignore "):])
541 fatal_error("UNRECOGNIZED OPTION")
544 line = f.readfullline()
546 cmd.run_if_possible()
548 TeshState().join_all_threads()
550 if f.filename == "(stdin)":
551 print("Test suite from stdin OK")
553 print("Test suite `"+f.filename+"' OK")