2 # -*- coding: utf-8 -*-
6 ========================
8 Copyright (c) 2012-2016. The SimGrid Team.
11 This program is free software; you can redistribute it and/or modify it
12 under the terms of the license (GNU LGPL) which comes with this package.
15 #TODO: child of child of child that printfs. Does it work?
16 #TODO: a child dies after its parent. What happen?
18 #TODO: regular expression in output
19 #ex: >> Time taken: [0-9]+s
20 #TODO: linked regular expression in output
22 # >> Bytes sent: ([0-9]+)
27 # TODO: If the output is sorted, we should report it to the users. Corresponding perl chunk
28 # print "WARNING: Both the observed output and expected output were sorted as requested.\n";
29 # print "WARNING: Output were only sorted using the $sort_prefix first chars.\n"
30 # if ( $sort_prefix > 0 );
31 # print "WARNING: Use <! output sort 19> to sort by simulated date and process ID only.\n";
33 # print "----8<--------------- Begin of unprocessed observed output (as it should appear in file):\n";
34 # map {print "> $_\n"} @{$cmd{'unsorted got'}};
35 # print "--------------->8---- End of the unprocessed observed output.\n";
48 if sys.version_info[0] == 3:
52 raise "This program is expected to run with Python3 only"
63 # Singleton metaclass that works in Python 2 & 3
64 # http://stackoverflow.com/questions/6760685/creating-a-singleton-in-python
65 class _Singleton(type):
66 """ A metaclass that creates a Singleton base class when called. """
68 def __call__(cls, *args, **kwargs):
69 if cls not in cls._instances:
70 cls._instances[cls] = super(_Singleton, cls).__call__(*args, **kwargs)
71 return cls._instances[cls]
72 class Singleton(_Singleton('SingletonMeta', (object,), {})): pass
74 SIGNALS_TO_NAMES_DICT = dict((getattr(signal, n), n) \
75 for n in dir(signal) if n.startswith('SIG') and '_' not in n )
81 #If you do not flush some prints are skipped
83 #os._exit exit even when executed within a thread
88 print("[Tesh/CRITICAL] "+str(msg))
92 #Set an environment variable.
93 # arg must be a string with the format "variable=value"
95 print("[Tesh/INFO] setenv "+arg)
97 os.environ[t[0]] = t[1]
98 #os.putenv(t[0], t[1]) does not work
99 #see http://stackoverflow.com/questions/17705419/python-os-environ-os-putenv-usr-bin-env
102 #http://stackoverflow.com/questions/30734967/how-to-expand-environment-variables-in-python-as-bash-does
103 def expandvars2(path):
104 return re.sub(r'(?<!\\)\$[A-Za-z_][A-Za-z0-9_]*', '', os.path.expandvars(path))
106 # https://github.com/Cadair/jupyter_environment_kernels/issues/10
111 FileNotFoundError = OSError
122 # read file line per line (and concat line that ends with "\")
123 class FileReader(Singleton):
124 def __init__(self, filename):
126 self.filename = "(stdin)"
129 self.filename_raw = filename
130 self.filename = os.path.basename(filename)
131 self.abspath = os.path.abspath(filename)
132 self.f = open(self.filename_raw)
136 def linenumber(self):
137 return self.linenumber
140 return self.filename+":"+str(self.linenumber)
142 def readfullline(self):
146 except StopIteration:
152 while len(line) > 1 and line[-2] == "\\":
160 #keep the state of tesh (mostly configuration values)
161 class TeshState(Singleton):
164 self.args_suffix = ""
165 self.ignore_regexps_common = []
169 def add_thread(self, thread):
170 self.threads.append(thread)
172 def join_all_threads(self):
173 for t in self.threads:
181 self.output_pipe_stdout = []
182 self.output_pipe_stderr = []
187 self.background = False
190 self.ignore_output = False
191 self.expect_return = 0
193 self.output_display = False
197 self.ignore_regexps = TeshState().ignore_regexps_common
199 def add_input_pipe(self, l):
200 self.input_pipe.append(l)
202 def add_output_pipe_stdout(self, l):
203 self.output_pipe_stdout.append(l)
205 def add_output_pipe_stderr(self, l):
206 self.output_pipe_stderr.append(l)
208 def set_cmd(self, args, linenumber):
210 self.linenumber = linenumber
212 def add_ignore(self, txt):
213 self.ignore_regexps.append(re.compile(txt))
215 def remove_ignored_lines(self, lines):
216 for ign in self.ignore_regexps:
217 lines = [l for l in lines if not ign.match(l)]
221 def _cmd_mkfile(self, argline):
222 filename = argline[len("mkfile "):]
223 file = open(filename, "w")
225 fatal_error("Unable to create file "+filename)
226 file.write("\n".join(self.input_pipe))
230 def _cmd_cd(self, argline):
231 args = shlex.split(argline)
233 fatal_error("Too many arguments to cd")
236 print("[Tesh/INFO] change directory to "+args[1])
237 except FileNotFoundError:
238 print("Chdir to "+args[1]+" failed: No such file or directory")
239 print("Test suite `"+FileReader().filename+"': NOK (system error)")
243 #Run the Cmd if possible.
244 # Return False if nothing has been ran.
245 def run_if_possible(self):
248 #Python threads loose the cwd
249 self.cwd = os.getcwd()
250 lock = _thread.allocate_lock()
252 TeshState().add_thread(lock)
253 _thread.start_new_thread( Cmd._run, (self, lock) )
261 def _run(self, lock=None):
262 #Python threads loose the cwd
263 if self.cwd is not None:
267 #retrocompatibility: support ${aaa:=.} variable format
268 def replace_perl_variables(m):
270 vdefault = m.group(2)
271 if vname in os.environ:
275 self.args = re.sub(r"\${(\w+):=([^}]*)}", replace_perl_variables, self.args)
277 #replace bash environment variables ($THINGS) to their values
278 self.args = expandvars2(self.args)
280 if re.match("^mkfile ", self.args) is not None:
281 self._cmd_mkfile(self.args)
282 if lock is not None: lock.release()
285 if re.match("^cd ", self.args) is not None:
286 self._cmd_cd(self.args)
287 if lock is not None: lock.release()
290 if TeshState().wrapper is not None:
292 self.args = TeshState().wrapper + self.args
293 elif re.match(".*smpirun.*", self.args) is not None:
294 self.args = "sh " + self.args
296 self.args += TeshState().args_suffix
298 print("["+FileReader().filename+":"+str(self.linenumber)+"] "+self.args)
300 args = shlex.split(self.args)
303 proc = subprocess.Popen(args, bufsize=1, stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.STDOUT, universal_newlines=True)
306 e.strerror += "\nOSError: [Errno 8] Executed scripts should start with shebang line (like #!/bin/sh)"
309 cmdName = FileReader().filename+":"+str(self.linenumber)
311 (stdout_data, stderr_data) = proc.communicate("\n".join(self.input_pipe), self.timeout)
312 except subprocess.TimeoutExpired:
313 print("Test suite `"+FileReader().filename+"': NOK (<"+cmdName+"> timeout after "+str(self.timeout)+" sec)")
316 if self.output_display:
320 ansi_escape = re.compile(r'\x1b[^m]*m')
321 stdout_data = ansi_escape.sub('', stdout_data)
323 #print ((stdout_data, stderr_data))
325 if self.ignore_output:
326 print("(ignoring the output of <"+cmdName+"> as requested)")
328 stdouta = stdout_data.split("\n")
329 while len(stdouta) > 0 and stdouta[-1] == "":
331 stdouta = self.remove_ignored_lines(stdouta)
332 stdcpy = self.output_pipe_stdout[:]
334 # Mimic the "sort" bash command, which is case unsensitive.
336 stdouta.sort(key=lambda x: x.lower())
337 self.output_pipe_stdout.sort(key=lambda x: x.lower())
339 stdouta.sort(key=lambda x: x[:self.sort].lower())
340 self.output_pipe_stdout.sort(key=lambda x: x[:self.sort].lower())
342 diff = list(difflib.unified_diff(self.output_pipe_stdout, stdouta,lineterm="",fromfile='expected', tofile='obtained'))
344 print("Output of <"+cmdName+"> mismatch:")
351 print("(diff truncated after 250 lines)")
353 print("Unsorted observed output:\n")
357 print("Test suite `"+FileReader().filename+"': NOK (<"+cmdName+"> output mismatch)")
358 if lock is not None: lock.release()
360 f = open('obtained','w')
361 obtained = stdout_data.split("\n")
362 while len(obtained) > 0 and obtained[-1] == "":
364 obtained = self.remove_ignored_lines(obtained)
365 for line in obtained:
366 f.write("> "+line+"\n")
368 print("Obtained output kept as requested: "+os.path.abspath("obtained"))
371 #print ((proc.returncode, self.expect_return))
373 if proc.returncode != self.expect_return:
374 if proc.returncode >= 0:
375 print("Test suite `"+FileReader().filename+"': NOK (<"+cmdName+"> returned code "+str(proc.returncode)+")")
376 if lock is not None: lock.release()
379 print("Test suite `"+FileReader().filename+"': NOK (<"+cmdName+"> got signal "+SIGNALS_TO_NAMES_DICT[-proc.returncode]+")")
380 if lock is not None: lock.release()
381 exit(-proc.returncode)
383 if lock is not None: lock.release()
388 return self.args is not None
401 if __name__ == '__main__':
403 parser = argparse.ArgumentParser(description='tesh -- testing shell', add_help=True)
404 group1 = parser.add_argument_group('Options')
405 group1.add_argument('teshfile', nargs='?', help='Name of teshfile, stdin if omitted')
406 group1.add_argument('--cd', metavar='some/directory', help='ask tesh to switch the working directory before launching the tests')
407 group1.add_argument('--setenv', metavar='var=value', action='append', help='set a specific environment variable')
408 group1.add_argument('--cfg', metavar='arg', help='add parameter --cfg=arg to each command line')
409 group1.add_argument('--log', metavar='arg', help='add parameter --log=arg to each command line')
410 group1.add_argument('--ignore-jenkins', action='store_true', help='ignore all cruft generated on SimGrid continous integration servers')
411 group1.add_argument('--wrapper', metavar='arg', help='Run each command in the provided wrapper (eg valgrind)')
412 group1.add_argument('--keep', action='store_true', help='Keep the obtained output when it does not match the expected one')
415 options = parser.parse_args()
419 if options.cd is not None:
422 if options.ignore_jenkins:
423 print("Ignore all cruft seen on SimGrid's continous integration servers")
424 TeshState().ignore_regexps_common = [
425 re.compile("^profiling:"),
426 re.compile(".*WARNING: ASan doesn\'t fully support"),
427 re.compile("Unable to clean temporary file C:.*"),
428 re.compile(".*Configuration change: Set \'contexts/")]
430 if options.teshfile is None:
432 print("Test suite from stdin")
434 f = FileReader(options.teshfile)
435 print("Test suite '"+f.abspath+"'")
437 if options.setenv is not None:
438 for e in options.setenv:
441 if options.cfg is not None:
442 TeshState().args_suffix += " --cfg="+options.cfg
443 if options.log is not None:
444 TeshState().args_suffix += " --log="+options.log
446 if options.wrapper is not None:
447 TeshState().wrapper = options.wrapper
450 TeshState().keep = True
452 #cmd holds the current command line
453 # tech commands will add some parameters to it
454 # when ready, we execute it.
457 line = f.readfullline()
458 while line is not None:
459 #print(">>============="+line+"==<<")
461 #print ("END CMD block")
462 if cmd.run_if_possible():
468 elif line[0:2] == "p ":
469 print("["+str(FileReader())+"] "+line[2:])
471 elif line[0:2] == "< ":
472 cmd.add_input_pipe(line[2:])
473 elif line[0:1] == "<":
474 cmd.add_input_pipe(line[1:])
476 elif line[0:2] == "> ":
477 cmd.add_output_pipe_stdout(line[2:])
478 elif line[0:1] == ">":
479 cmd.add_output_pipe_stdout(line[1:])
481 elif line[0:2] == "$ ":
482 if cmd.run_if_possible():
484 cmd.set_cmd(line[2:], f.linenumber)
486 elif line[0:2] == "& ":
487 if cmd.run_if_possible():
489 cmd.set_cmd(line[2:], f.linenumber)
490 cmd.background = True
492 elif line[0:15] == "! output ignore":
493 cmd.ignore_output = True
494 #print("cmd.ignore_output = True")
495 elif line[0:16] == "! output display":
496 cmd.output_display = True
497 cmd.ignore_output = True
498 elif line[0:15] == "! expect return":
499 cmd.expect_return = int(line[16:])
500 #print("expect return "+str(int(line[16:])))
501 elif line[0:15] == "! expect signal":
503 #get the signal integer value from the signal module
504 if sig not in signal.__dict__:
505 fatal_error("unrecognized signal '"+sig+"'")
506 sig = int(signal.__dict__[sig])
507 #popen return -signal when a process ends with a signal
508 cmd.expect_return = -sig
509 elif line[0:len("! timeout ")] == "! timeout ":
510 if "no" in line[len("! timeout "):]:
513 cmd.timeout = int(line[len("! timeout "):])
515 elif line[0:len("! output sort")] == "! output sort":
516 if len(line) >= len("! output sort "):
517 sort = int(line[len("! output sort "):])
521 elif line[0:len("! setenv ")] == "! setenv ":
522 setenv(line[len("! setenv "):])
524 elif line[0:len("! ignore ")] == "! ignore ":
525 cmd.add_ignore(line[len("! ignore "):])
528 fatal_error("UNRECOGNIZED OPTION")
531 line = f.readfullline()
533 cmd.run_if_possible()
535 TeshState().join_all_threads()
537 if f.filename == "(stdin)":
538 print("Test suite from stdin OK")
540 print("Test suite `"+f.filename+"' OK")