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]+)
26 # TODO: If the output is sorted, we should report it to the users. Corresponding perl chunk
27 # print "WARNING: Both the observed output and expected output were sorted as requested.\n";
28 # print "WARNING: Output were only sorted using the $sort_prefix first chars.\n"
29 # if ( $sort_prefix > 0 );
30 # print "WARNING: Use <! output sort 19> to sort by simulated date and process ID only.\n";
32 # print "----8<--------------- Begin of unprocessed observed output (as it should appear in file):\n";
33 # map {print "> $_\n"} @{$cmd{'unsorted got'}};
34 # print "--------------->8---- End of the unprocessed observed output.\n";
47 if sys.version_info[0] == 3:
51 raise "This program is expected to run with Python3 only"
62 # Singleton metaclass that works in Python 2 & 3
63 # http://stackoverflow.com/questions/6760685/creating-a-singleton-in-python
64 class _Singleton(type):
65 """ A metaclass that creates a Singleton base class when called. """
67 def __call__(cls, *args, **kwargs):
68 if cls not in cls._instances:
69 cls._instances[cls] = super(_Singleton, cls).__call__(*args, **kwargs)
70 return cls._instances[cls]
71 class Singleton(_Singleton('SingletonMeta', (object,), {})): pass
73 SIGNALS_TO_NAMES_DICT = dict((getattr(signal, n), n) \
74 for n in dir(signal) if n.startswith('SIG') and '_' not in n )
80 #If you do not flush some prints are skipped
82 #os._exit exit even when executed within a thread
87 print("[Tesh/CRITICAL] "+str(msg))
91 #Set an environment variable.
92 # arg must be a string with the format "variable=value"
94 print("[Tesh/INFO] setenv "+arg)
96 os.environ[t[0]] = t[1]
97 #os.putenv(t[0], t[1]) does not work
98 #see http://stackoverflow.com/questions/17705419/python-os-environ-os-putenv-usr-bin-env
101 #http://stackoverflow.com/questions/30734967/how-to-expand-environment-variables-in-python-as-bash-does
102 def expandvars2(path):
103 return re.sub(r'(?<!\\)\$[A-Za-z_][A-Za-z0-9_]*', '', os.path.expandvars(path))
105 # https://github.com/Cadair/jupyter_environment_kernels/issues/10
110 FileNotFoundError = OSError
121 # read file line per line (and concat line that ends with "\")
122 class FileReader(Singleton):
123 def __init__(self, filename):
125 self.filename = "(stdin)"
128 self.filename_raw = filename
129 self.filename = os.path.basename(filename)
130 self.abspath = os.path.abspath(filename)
131 self.f = open(self.filename_raw)
135 def linenumber(self):
136 return self.linenumber
139 return self.filename+":"+str(self.linenumber)
141 def readfullline(self):
145 except StopIteration:
151 while len(line) > 1 and line[-2] == "\\":
159 #keep the state of tesh (mostly configuration values)
160 class TeshState(Singleton):
163 self.args_suffix = ""
164 self.ignore_regexps_common = []
165 self.jenkins = False # not a Jenkins run by default
166 self.timeout = 10 # default value: 10 sec
170 def add_thread(self, thread):
171 self.threads.append(thread)
173 def join_all_threads(self):
174 for t in self.threads:
182 self.output_pipe_stdout = []
183 self.output_pipe_stderr = []
184 self.timeout = TeshState().timeout
188 self.background = False
191 self.ignore_output = False
192 self.expect_return = 0
194 self.output_display = False
198 self.ignore_regexps = TeshState().ignore_regexps_common
200 def add_input_pipe(self, l):
201 self.input_pipe.append(l)
203 def add_output_pipe_stdout(self, l):
204 self.output_pipe_stdout.append(l)
206 def add_output_pipe_stderr(self, l):
207 self.output_pipe_stderr.append(l)
209 def set_cmd(self, args, linenumber):
211 self.linenumber = linenumber
213 def add_ignore(self, txt):
214 self.ignore_regexps.append(re.compile(txt))
216 def remove_ignored_lines(self, lines):
217 for ign in self.ignore_regexps:
218 lines = [l for l in lines if not ign.match(l)]
222 def _cmd_mkfile(self, argline):
223 filename = argline[len("mkfile "):]
224 file = open(filename, "w")
226 fatal_error("Unable to create file "+filename)
227 file.write("\n".join(self.input_pipe))
231 def _cmd_cd(self, argline):
232 args = shlex.split(argline)
234 fatal_error("Too many arguments to cd")
237 print("[Tesh/INFO] change directory to "+args[1])
238 except FileNotFoundError:
239 print("Chdir to "+args[1]+" failed: No such file or directory")
240 print("Test suite `"+FileReader().filename+"': NOK (system error)")
244 #Run the Cmd if possible.
245 # Return False if nothing has been ran.
246 def run_if_possible(self):
249 #Python threads loose the cwd
250 self.cwd = os.getcwd()
251 lock = _thread.allocate_lock()
253 TeshState().add_thread(lock)
254 _thread.start_new_thread( Cmd._run, (self, lock) )
262 def _run(self, lock=None):
263 #Python threads loose the cwd
264 if self.cwd is not None:
268 #retrocompatibility: support ${aaa:=.} variable format
269 def replace_perl_variables(m):
271 vdefault = m.group(2)
272 if vname in os.environ:
276 self.args = re.sub(r"\${(\w+):=([^}]*)}", replace_perl_variables, self.args)
278 #replace bash environment variables ($THINGS) to their values
279 self.args = expandvars2(self.args)
281 if re.match("^mkfile ", self.args) is not None:
282 self._cmd_mkfile(self.args)
283 if lock is not None: lock.release()
286 if re.match("^cd ", self.args) is not None:
287 self._cmd_cd(self.args)
288 if lock is not None: lock.release()
291 if TeshState().wrapper is not None:
293 self.args = TeshState().wrapper + self.args
294 elif re.match(".*smpirun.*", self.args) is not None:
295 self.args = "sh " + self.args
296 if TeshState().jenkins and self.timeout != None:
299 self.args += TeshState().args_suffix
301 print("["+FileReader().filename+":"+str(self.linenumber)+"] "+self.args)
303 args = shlex.split(self.args)
307 proc = subprocess.Popen(args, bufsize=1, stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.STDOUT, universal_newlines=True)
310 e.strerror += "\nOSError: [Errno 8] Executed scripts should start with shebang line (like #!/bin/sh)"
312 except FileNotFoundError:
313 print("["+FileReader().filename+":"+str(self.linenumber)+"] Cannot start '"+args[0]+"': File not found")
316 cmdName = FileReader().filename+":"+str(self.linenumber)
318 (stdout_data, stderr_data) = proc.communicate("\n".join(self.input_pipe), self.timeout)
319 except subprocess.TimeoutExpired:
320 print("Test suite `"+FileReader().filename+"': NOK (<"+cmdName+"> timeout after "+str(self.timeout)+" sec)")
324 if self.output_display:
328 ansi_escape = re.compile(r'\x1b[^m]*m')
329 stdout_data = ansi_escape.sub('', stdout_data)
331 #print ((stdout_data, stderr_data))
333 if self.ignore_output:
334 print("(ignoring the output of <"+cmdName+"> as requested)")
336 stdouta = stdout_data.split("\n")
337 while len(stdouta) > 0 and stdouta[-1] == "":
339 stdouta = self.remove_ignored_lines(stdouta)
342 # Mimic the "sort" bash command, which is case unsensitive.
344 stdouta.sort(key=lambda x: x.lower())
345 self.output_pipe_stdout.sort(key=lambda x: x.lower())
347 stdouta.sort(key=lambda x: x[:self.sort].lower())
348 self.output_pipe_stdout.sort(key=lambda x: x[:self.sort].lower())
350 diff = list(difflib.unified_diff(self.output_pipe_stdout, stdouta,lineterm="",fromfile='expected', tofile='obtained'))
352 print("Output of <"+cmdName+"> mismatch:")
353 if self.sort >= 0: # If sorted, truncate the diff output and show the unsorted version
360 print("(diff truncated after 250 lines)")
361 print("Unsorted observed output:\n")
364 else: # If not sorted, just display the diff
368 print("Test suite `"+FileReader().filename+"': NOK (<"+cmdName+"> output mismatch)")
369 if lock is not None: lock.release()
371 f = open('obtained','w')
372 obtained = stdout_data.split("\n")
373 while len(obtained) > 0 and obtained[-1] == "":
375 obtained = self.remove_ignored_lines(obtained)
376 for line in obtained:
377 f.write("> "+line+"\n")
379 print("Obtained output kept as requested: "+os.path.abspath("obtained"))
382 #print ((proc.returncode, self.expect_return))
384 if proc.returncode != self.expect_return:
385 if proc.returncode >= 0:
386 print("Test suite `"+FileReader().filename+"': NOK (<"+cmdName+"> returned code "+str(proc.returncode)+")")
387 if lock is not None: lock.release()
390 print("Test suite `"+FileReader().filename+"': NOK (<"+cmdName+"> got signal "+SIGNALS_TO_NAMES_DICT[-proc.returncode]+")")
391 if lock is not None: lock.release()
392 exit(-proc.returncode)
394 if lock is not None: lock.release()
399 return self.args is not None
412 if __name__ == '__main__':
414 parser = argparse.ArgumentParser(description='tesh -- testing shell', add_help=True)
415 group1 = parser.add_argument_group('Options')
416 group1.add_argument('teshfile', nargs='?', help='Name of teshfile, stdin if omitted')
417 group1.add_argument('--cd', metavar='some/directory', help='ask tesh to switch the working directory before launching the tests')
418 group1.add_argument('--setenv', metavar='var=value', action='append', help='set a specific environment variable')
419 group1.add_argument('--cfg', metavar='arg', help='add parameter --cfg=arg to each command line')
420 group1.add_argument('--log', metavar='arg', help='add parameter --log=arg to each command line')
421 group1.add_argument('--ignore-jenkins', action='store_true', help='ignore all cruft generated on SimGrid continous integration servers')
422 group1.add_argument('--wrapper', metavar='arg', help='Run each command in the provided wrapper (eg valgrind)')
423 group1.add_argument('--keep', action='store_true', help='Keep the obtained output when it does not match the expected one')
426 options = parser.parse_args()
430 if options.cd is not None:
433 if options.ignore_jenkins:
434 print("Ignore all cruft seen on SimGrid's continous integration servers")
435 TeshState().ignore_regexps_common = [
436 re.compile("^profiling:"),
437 re.compile(".*WARNING: ASan doesn\'t fully support"),
438 re.compile("Unable to clean temporary file C:.*"),
439 re.compile(".*Configuration change: Set \'contexts/"),
440 re.compile(".*Picked up JAVA_TOOL_OPTIONS.*"),
442 re.compile("==WARNING: ASan is ignoring requested __asan_handle_no_return: stack top:"),
443 re.compile("False positive error reports may follow"),
444 re.compile("For details see http://code.google.com/p/address-sanitizer/issues/detail?id=189"),
446 re.compile("Python runtime initialized with LC_CTYPE=C .*"),
448 TeshState().jenkins = True # This is a Jenkins build
450 if options.teshfile is None:
452 print("Test suite from stdin")
454 if not os.path.isfile(options.teshfile):
455 print("Cannot open teshfile '"+options.teshfile+"': File not found")
457 f = FileReader(options.teshfile)
458 print("Test suite '"+f.abspath+"'")
460 if options.setenv is not None:
461 for e in options.setenv:
464 if options.cfg is not None:
465 TeshState().args_suffix += " --cfg="+options.cfg
466 if options.log is not None:
467 TeshState().args_suffix += " --log="+options.log
469 if options.wrapper is not None:
470 TeshState().wrapper = options.wrapper
473 TeshState().keep = True
475 #cmd holds the current command line
476 # tech commands will add some parameters to it
477 # when ready, we execute it.
480 line = f.readfullline()
481 while line is not None:
482 #print(">>============="+line+"==<<")
484 #print ("END CMD block")
485 if cmd.run_if_possible():
491 elif line[0:2] == "p ":
492 print("["+str(FileReader())+"] "+line[2:])
494 elif line[0:2] == "< ":
495 cmd.add_input_pipe(line[2:])
496 elif line[0:1] == "<":
497 cmd.add_input_pipe(line[1:])
499 elif line[0:2] == "> ":
500 cmd.add_output_pipe_stdout(line[2:])
501 elif line[0:1] == ">":
502 cmd.add_output_pipe_stdout(line[1:])
504 elif line[0:2] == "$ ":
505 if cmd.run_if_possible():
507 cmd.set_cmd(line[2:], f.linenumber)
509 elif line[0:2] == "& ":
510 if cmd.run_if_possible():
512 cmd.set_cmd(line[2:], f.linenumber)
513 cmd.background = True
515 elif line[0:15] == "! output ignore":
516 cmd.ignore_output = True
517 #print("cmd.ignore_output = True")
518 elif line[0:16] == "! output display":
519 cmd.output_display = True
520 cmd.ignore_output = True
521 elif line[0:15] == "! expect return":
522 cmd.expect_return = int(line[16:])
523 #print("expect return "+str(int(line[16:])))
524 elif line[0:15] == "! expect signal":
526 #get the signal integer value from the signal module
527 if sig not in signal.__dict__:
528 fatal_error("unrecognized signal '"+sig+"'")
529 sig = int(signal.__dict__[sig])
530 #popen return -signal when a process ends with a signal
531 cmd.expect_return = -sig
532 elif line[0:len("! timeout ")] == "! timeout ":
533 if "no" in line[len("! timeout "):]:
536 cmd.timeout = int(line[len("! timeout "):])
538 elif line[0:len("! output sort")] == "! output sort":
539 if len(line) >= len("! output sort "):
540 sort = int(line[len("! output sort "):])
544 elif line[0:len("! setenv ")] == "! setenv ":
545 setenv(line[len("! setenv "):])
547 elif line[0:len("! ignore ")] == "! ignore ":
548 cmd.add_ignore(line[len("! ignore "):])
551 fatal_error("UNRECOGNIZED OPTION")
554 line = f.readfullline()
556 cmd.run_if_possible()
558 TeshState().join_all_threads()
560 if f.filename == "(stdin)":
561 print("Test suite from stdin OK")
563 print("Test suite `"+f.filename+"' OK")