tools/tesh/tesh.py

   1 #! @PYTHON_EXECUTABLE@
   2 # -*- coding: utf-8 -*-
   3 """
   4
   5 tesh -- testing shell
   6 ========================
   7
   8 Copyright (c) 2012-2018. The SimGrid Team. All rights reserved.
   9
  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.
  12
  13
  14 #TODO: child of child of child that printfs. Does it work?
  15 #TODO: a child dies after its parent. What happen?
  16
  17 #TODO: regular expression in output
  18 #ex: >> Time taken: [0-9]+s
  19 #TODO: linked regular expression in output
  20 #ex:
  21 # >> Bytes sent: ([0-9]+)
  22 # >> Bytes recv: \1
  23 # then, even better:
  24 # ! expect (\1 > 500)
  25
  26 """
  27
  28
  29 import sys, os
  30 import shlex
  31 import re
  32 import difflib
  33 import signal
  34 import argparse
  35
  36 if sys.version_info[0] == 3:
  37     import subprocess
  38     import _thread
  39 else:
  40     raise "This program is expected to run with Python3 only"
  41
  42 ##############
  43 #
  44 # Utilities
  45 #
  46 #
  47
  48 def isWindows():
  49     return sys.platform.startswith('win')
  50
  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. """
  55     _instances = {}
  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
  61
  62 SIGNALS_TO_NAMES_DICT = dict((getattr(signal, n), n) \
  63     for n in dir(signal) if n.startswith('SIG') and '_' not in n )
  64
  65
  66
  67 #exit correctly
  68 def tesh_exit(errcode):
  69     #If you do not flush some prints are skipped
  70     sys.stdout.flush()
  71     #os._exit exit even when executed within a thread
  72     os._exit(errcode)
  73
  74
  75 def fatal_error(msg):
  76     print("[Tesh/CRITICAL] "+str(msg))
  77     tesh_exit(1)
  78
  79
  80 #Set an environment variable.
  81 # arg must be a string with the format "variable=value"
  82 def setenv(arg):
  83     print("[Tesh/INFO] setenv "+arg)
  84     t = arg.split("=")
  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
  88
  89
  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))
  93
  94 # https://github.com/Cadair/jupyter_environment_kernels/issues/10
  95 try:
  96     FileNotFoundError
  97 except NameError:
  98     #py2
  99     FileNotFoundError = OSError
 100
 101 ##############
 102 #
 103 # Cleanup on signal
 104 #
 105 #
 106
 107 # Global variable. Stores which process group should be killed (or None otherwise)
 108 pgtokill = None
 109
 110 def kill_process_group(pgid):
 111     if pgid is None: # Nobody to kill. We don't know who to kill on windows, or we don't have anyone to kill on signal handler
 112         return
 113
 114     # print("Kill process group {}".format(pgid))
 115     try:
 116         os.killpg(pgid, signal.SIGTERM)
 117     except OSError:
 118         # os.killpg failed. OK. Some subprocesses may still be running.
 119         pass
 120
 121 def signal_handler(signal, frame):
 122     print("Caught signal {}".format(SIGNALS_TO_NAMES_DICT[signal]))
 123     if pgtokill is not None:
 124         kill_process_group(pgtokill)
 125     tesh_exit(5)
 126
 127
 128
 129 ##############
 130 #
 131 # Classes
 132 #
 133 #
 134
 135
 136
 137 # read file line per line (and concat line that ends with "\")
 138 class FileReader(Singleton):
 139     def __init__(self, filename=None):
 140         if filename is None:
 141             self.filename = "(stdin)"
 142             self.f = sys.stdin
 143         else:
 144             self.filename_raw = filename
 145             self.filename = os.path.basename(filename)
 146             self.abspath = os.path.abspath(filename)
 147             self.f = open(self.filename_raw)
 148
 149         self.linenumber = 0
 150
 151     def __repr__(self):
 152         return self.filename+":"+str(self.linenumber)
 153
 154     def readfullline(self):
 155         try:
 156             line = next(self.f)
 157             self.linenumber += 1
 158         except StopIteration:
 159             return None
 160         if line[-1] == "\n":
 161             txt = line[0:-1]
 162         else:
 163             txt = line
 164         while len(line) > 1 and line[-2] == "\\":
 165             txt = txt[0:-1]
 166             line = next(self.f)
 167             self.linenumber += 1
 168             txt += line[0:-1]
 169         return txt
 170
 171
 172 #keep the state of tesh (mostly configuration values)
 173 class TeshState(Singleton):
 174     def __init__(self):
 175         self.threads = []
 176         self.args_suffix = ""
 177         self.ignore_regexps_common = []
 178         self.jenkins = False # not a Jenkins run by default
 179         self.timeout = 10 # default value: 10 sec
 180         self.wrapper = None
 181         self.keep = False
 182
 183     def add_thread(self, thread):
 184         self.threads.append(thread)
 185
 186     def join_all_threads(self):
 187         for t in self.threads:
 188             t.acquire()
 189             t.release()
 190
 191 #Command line object
 192 class Cmd(object):
 193     def __init__(self):
 194         self.input_pipe = []
 195         self.output_pipe_stdout = []
 196         self.output_pipe_stderr = []
 197         self.timeout = TeshState().timeout
 198         self.args = None
 199         self.linenumber = -1
 200
 201         self.background = False
 202         self.cwd = None
 203
 204         self.ignore_output = False
 205         self.expect_return = 0
 206
 207         self.output_display = False
 208
 209         self.sort = -1
 210
 211         self.ignore_regexps = TeshState().ignore_regexps_common
 212
 213     def add_input_pipe(self, l):
 214         self.input_pipe.append(l)
 215
 216     def add_output_pipe_stdout(self, l):
 217         self.output_pipe_stdout.append(l)
 218
 219     def add_output_pipe_stderr(self, l):
 220         self.output_pipe_stderr.append(l)
 221
 222     def set_cmd(self, args, linenumber):
 223         self.args = args
 224         self.linenumber = linenumber
 225
 226     def add_ignore(self, txt):
 227         self.ignore_regexps.append(re.compile(txt))
 228
 229     def remove_ignored_lines(self, lines):
 230         for ign in self.ignore_regexps:
 231                 lines = [l for l in lines if not ign.match(l)]
 232         return lines
 233
 234
 235     def _cmd_mkfile(self, argline):
 236         filename = argline[len("mkfile "):]
 237         file = open(filename, "w")
 238         if file is None:
 239             fatal_error("Unable to create file "+filename)
 240         file.write("\n".join(self.input_pipe))
 241         file.write("\n")
 242         file.close()
 243
 244     def _cmd_cd(self, argline):
 245         args = shlex.split(argline)
 246         if len(args) != 2:
 247             fatal_error("Too many arguments to cd")
 248         try:
 249             os.chdir(args[1])
 250             print("[Tesh/INFO] change directory to "+args[1])
 251         except FileNotFoundError:
 252             print("Chdir to "+args[1]+" failed: No such file or directory")
 253             print("Test suite `"+FileReader().filename+"': NOK (system error)")
 254             tesh_exit(4)
 255
 256
 257     #Run the Cmd if possible.
 258     # Return False if nothing has been ran.
 259     def run_if_possible(self):
 260         if self.can_run():
 261             if self.background:
 262                 #Python threads loose the cwd
 263                 self.cwd = os.getcwd()
 264                 lock = _thread.allocate_lock()
 265                 lock.acquire()
 266                 TeshState().add_thread(lock)
 267                 _thread.start_new_thread( Cmd._run, (self, lock) )
 268             else:
 269                 self._run()
 270             return True
 271         else:
 272             return False
 273
 274
 275     def _run(self, lock=None):
 276         #Python threads loose the cwd
 277         if self.cwd is not None:
 278             os.chdir(self.cwd)
 279             self.cwd = None
 280
 281         #retrocompatibility: support ${aaa:=.} variable format
 282         def replace_perl_variables(m):
 283             vname = m.group(1)
 284             vdefault = m.group(2)
 285             if vname in os.environ:
 286                 return "$"+vname
 287             else:
 288                 return vdefault
 289         self.args = re.sub(r"\${(\w+):=([^}]*)}", replace_perl_variables, self.args)
 290
 291         #replace bash environment variables ($THINGS) to their values
 292         self.args = expandvars2(self.args)
 293
 294         if re.match("^mkfile ", self.args) is not None:
 295             self._cmd_mkfile(self.args)
 296             if lock is not None: lock.release()
 297             return
 298
 299         if re.match("^cd ", self.args) is not None:
 300             self._cmd_cd(self.args)
 301             if lock is not None: lock.release()
 302             return
 303
 304         if TeshState().wrapper is not None:
 305             self.timeout *= 20
 306             self.args = TeshState().wrapper + self.args
 307         elif re.match(".*smpirun.*", self.args) is not None:
 308             self.args = "sh " + self.args
 309         if TeshState().jenkins and self.timeout != None:
 310             self.timeout *= 10
 311
 312         self.args += TeshState().args_suffix
 313
 314         print("["+FileReader().filename+":"+str(self.linenumber)+"] "+self.args)
 315
 316         args = shlex.split(self.args)
 317         #print (args)
 318
 319         global pgtokill
 320
 321         try:
 322             proc = subprocess.Popen(args, bufsize=1, stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.STDOUT, universal_newlines=True, start_new_session=True)
 323             try:
 324                 if not isWindows():
 325                     pgtokill = os.getpgid(proc.pid)
 326             except OSError:
 327                 # os.getpgid failed. OK. No cleanup.
 328                 pass
 329         except PermissionError:
 330             print("["+FileReader().filename+":"+str(self.linenumber)+"] Cannot start '"+args[0]+"': The binary is not executable.")
 331             print("["+FileReader().filename+":"+str(self.linenumber)+"] Current dir: "+os.getcwd())
 332             tesh_exit(3)
 333         except NotADirectoryError:
 334             print("["+FileReader().filename+":"+str(self.linenumber)+"] Cannot start '"+args[0]+"': The path to binary does not exist.")
 335             print("["+FileReader().filename+":"+str(self.linenumber)+"] Current dir: "+os.getcwd())
 336             tesh_exit(3)
 337         except FileNotFoundError:
 338             print("["+FileReader().filename+":"+str(self.linenumber)+"] Cannot start '"+args[0]+"': File not found")
 339             tesh_exit(3)
 340         except OSError as osE:
 341             if osE.errno == 8:
 342                 osE.strerror += "\nOSError: [Errno 8] Executed scripts should start with shebang line (like #!/usr/bin/env sh)"
 343             raise osE
 344
 345         cmdName = FileReader().filename+":"+str(self.linenumber)
 346         try:
 347             (stdout_data, stderr_data) = proc.communicate("\n".join(self.input_pipe), self.timeout)
 348             pgtokill = None
 349         except subprocess.TimeoutExpired:
 350             print("Test suite `"+FileReader().filename+"': NOK (<"+cmdName+"> timeout after "+str(self.timeout)+" sec)")
 351             kill_process_group(pgtokill)
 352             tesh_exit(3)
 353
 354         if self.output_display:
 355             print(stdout_data)
 356
 357         #remove text colors
 358         ansi_escape = re.compile(r'\x1b[^m]*m')
 359         stdout_data = ansi_escape.sub('', stdout_data)
 360
 361         #print ((stdout_data, stderr_data))
 362
 363         if self.ignore_output:
 364             print("(ignoring the output of <"+cmdName+"> as requested)")
 365         else:
 366             stdouta = stdout_data.split("\n")
 367             while len(stdouta) > 0 and stdouta[-1] == "":
 368                 del stdouta[-1]
 369             stdouta = self.remove_ignored_lines(stdouta)
 370             stdcpy = stdouta[:]
 371
 372             # Mimic the "sort" bash command, which is case unsensitive.
 373             if self.sort == 0:
 374                 stdouta.sort(key=lambda x: x.lower())
 375                 self.output_pipe_stdout.sort(key=lambda x: x.lower())
 376             elif self.sort > 0:
 377                 stdouta.sort(key=lambda x: x[:self.sort].lower())
 378                 self.output_pipe_stdout.sort(key=lambda x: x[:self.sort].lower())
 379
 380             diff = list(difflib.unified_diff(self.output_pipe_stdout, stdouta,lineterm="",fromfile='expected', tofile='obtained'))
 381             if len(diff) > 0:
 382                 print("Output of <"+cmdName+"> mismatch:")
 383                 if self.sort >= 0: # If sorted, truncate the diff output and show the unsorted version
 384                     difflen = 0;
 385                     for line in diff:
 386                         if difflen<50:
 387                             print(line)
 388                         difflen += 1
 389                     if difflen > 50:
 390                         print("(diff truncated after 50 lines)")
 391                     print("Unsorted observed output:\n")
 392                     for line in stdcpy:
 393                         print(line)
 394                 else: # If not sorted, just display the diff
 395                     for line in diff:
 396                         print(line)
 397
 398                 print("Test suite `"+FileReader().filename+"': NOK (<"+cmdName+"> output mismatch)")
 399                 if lock is not None: lock.release()
 400                 if TeshState().keep:
 401                     f = open('obtained','w')
 402                     obtained = stdout_data.split("\n")
 403                     while len(obtained) > 0 and obtained[-1] == "":
 404                         del obtained[-1]
 405                     obtained = self.remove_ignored_lines(obtained)
 406                     for line in obtained:
 407                         f.write("> "+line+"\n")
 408                     f.close()
 409                     print("Obtained output kept as requested: "+os.path.abspath("obtained"))
 410                 tesh_exit(2)
 411
 412         #print ((proc.returncode, self.expect_return))
 413
 414         if proc.returncode != self.expect_return:
 415             if proc.returncode >= 0:
 416                 print("Test suite `"+FileReader().filename+"': NOK (<"+cmdName+"> returned code "+str(proc.returncode)+")")
 417                 if lock is not None: lock.release()
 418                 tesh_exit(2)
 419             else:
 420                 print("Test suite `"+FileReader().filename+"': NOK (<"+cmdName+"> got signal "+SIGNALS_TO_NAMES_DICT[-proc.returncode]+")")
 421                 if lock is not None: lock.release()
 422                 tesh_exit(-proc.returncode)
 423
 424         if lock is not None: lock.release()
 425
 426
 427
 428     def can_run(self):
 429         return self.args is not None
 430
 431
 432
 433
 434 ##############
 435 #
 436 # Main
 437 #
 438 #
 439
 440
 441
 442 if __name__ == '__main__':
 443     signal.signal(signal.SIGINT, signal_handler)
 444     signal.signal(signal.SIGTERM, signal_handler)
 445
 446     parser = argparse.ArgumentParser(description='tesh -- testing shell', add_help=True)
 447     group1 = parser.add_argument_group('Options')
 448     group1.add_argument('teshfile', nargs='?', help='Name of teshfile, stdin if omitted')
 449     group1.add_argument('--cd', metavar='some/directory', help='ask tesh to switch the working directory before launching the tests')
 450     group1.add_argument('--setenv', metavar='var=value', action='append', help='set a specific environment variable')
 451     group1.add_argument('--cfg', metavar='arg', action='append', help='add parameter --cfg=arg to each command line')
 452     group1.add_argument('--log', metavar='arg', action='append', help='add parameter --log=arg to each command line')
 453     group1.add_argument('--ignore-jenkins', action='store_true', help='ignore all cruft generated on SimGrid continous integration servers')
 454     group1.add_argument('--wrapper', metavar='arg', help='Run each command in the provided wrapper (eg valgrind)')
 455     group1.add_argument('--keep', action='store_true', help='Keep the obtained output when it does not match the expected one')
 456
 457     try:
 458         options = parser.parse_args()
 459     except SystemExit:
 460         tesh_exit(1)
 461
 462     if options.cd is not None:
 463         print("[Tesh/INFO] change directory to " + options.cd)
 464         os.chdir(options.cd)
 465
 466     if options.ignore_jenkins:
 467         print("Ignore all cruft seen on SimGrid's continous integration servers")
 468         # Note: regexps should match at the beginning of lines
 469         TeshState().ignore_regexps_common = [
 470            re.compile(r"profiling:"),
 471            re.compile(r"Unable to clean temporary file C:"),
 472            re.compile(r".*Configuration change: Set 'contexts/"),
 473            re.compile(r"Picked up JAVA_TOOL_OPTIONS: "),
 474            re.compile(r"Picked up _JAVA_OPTIONS: "),
 475            re.compile(r"==[0-9]+== ?WARNING: ASan doesn't fully support"),
 476            re.compile(r"==[0-9]+== ?WARNING: ASan is ignoring requested __asan_handle_no_return: stack top:"),
 477            re.compile(r"False positive error reports may follow"),
 478            re.compile(r"For details see http://code.google.com/p/address-sanitizer/issues/detail\?id=189"),
 479            re.compile(r"For details see https://github.com/google/sanitizers/issues/189"),
 480            re.compile(r"Python runtime initialized with LC_CTYPE=C .*"),
 481            re.compile(r"cmake: /usr/local/lib/libcurl\.so\.4: no version information available \(required by cmake\)"), # Seen on CircleCI
 482            re.compile(r".*mmap broken on FreeBSD, but dlopen\+thread broken too. Switching to dlopen\+raw contexts\."),
 483            re.compile(r".*dlopen\+thread broken on Apple and BSD\. Switching to raw contexts\."),
 484            ]
 485         TeshState().jenkins = True # This is a Jenkins build
 486
 487     if options.teshfile is None:
 488         f = FileReader(None)
 489         print("Test suite from stdin")
 490     else:
 491         if not os.path.isfile(options.teshfile):
 492             print("Cannot open teshfile '"+options.teshfile+"': File not found")
 493             tesh_exit(3)
 494         f = FileReader(options.teshfile)
 495         print("Test suite '"+f.abspath+"'")
 496
 497     if options.setenv is not None:
 498         for e in options.setenv:
 499             setenv(e)
 500
 501     if options.cfg is not None:
 502         for c in options.cfg:
 503             TeshState().args_suffix += " --cfg=" + c
 504     if options.log is not None:
 505         for l in options.log:
 506             TeshState().args_suffix += " --log=" + l
 507
 508     if options.wrapper is not None:
 509         TeshState().wrapper = options.wrapper
 510
 511     if options.keep:
 512         TeshState().keep = True
 513
 514     #cmd holds the current command line
 515     # tech commands will add some parameters to it
 516     # when ready, we execute it.
 517     cmd = Cmd()
 518
 519     line = f.readfullline()
 520     while line is not None:
 521         #print(">>============="+line+"==<<")
 522         if len(line) == 0:
 523             #print ("END CMD block")
 524             if cmd.run_if_possible():
 525                 cmd = Cmd()
 526
 527         elif line[0] == "#":
 528             pass
 529
 530         elif line[0:2] == "p ":
 531             print("["+str(FileReader())+"] "+line[2:])
 532
 533         elif line[0:2] == "< ":
 534             cmd.add_input_pipe(line[2:])
 535         elif line[0:1] == "<":
 536             cmd.add_input_pipe(line[1:])
 537
 538         elif line[0:2] == "> ":
 539             cmd.add_output_pipe_stdout(line[2:])
 540         elif line[0:1] == ">":
 541             cmd.add_output_pipe_stdout(line[1:])
 542
 543         elif line[0:2] == "$ ":
 544             if cmd.run_if_possible():
 545                 cmd = Cmd()
 546             cmd.set_cmd(line[2:], f.linenumber)
 547
 548         elif line[0:2] == "& ":
 549             if cmd.run_if_possible():
 550                 cmd = Cmd()
 551             cmd.set_cmd(line[2:], f.linenumber)
 552             cmd.background = True
 553
 554         elif line[0:15] == "! output ignore":
 555             cmd.ignore_output = True
 556             #print("cmd.ignore_output = True")
 557         elif line[0:16] == "! output display":
 558             cmd.output_display = True
 559             cmd.ignore_output = True
 560         elif line[0:15] == "! expect return":
 561             cmd.expect_return = int(line[16:])
 562             #print("expect return "+str(int(line[16:])))
 563         elif line[0:15] == "! expect signal":
 564             sig = line[16:]
 565             #get the signal integer value from the signal module
 566             if sig not in signal.__dict__:
 567                 fatal_error("unrecognized signal '"+sig+"'")
 568             sig = int(signal.__dict__[sig])
 569             #popen return -signal when a process ends with a signal
 570             cmd.expect_return = -sig
 571         elif line[0:len("! timeout ")] == "! timeout ":
 572             if "no" in line[len("! timeout "):]:
 573                 cmd.timeout = None
 574             else:
 575                 cmd.timeout = int(line[len("! timeout "):])
 576
 577         elif line[0:len("! output sort")] == "! output sort":
 578             if len(line) >= len("! output sort "):
 579                 sort = int(line[len("! output sort "):])
 580             else:
 581                 sort = 0
 582             cmd.sort = sort
 583         elif line[0:len("! setenv ")] == "! setenv ":
 584             setenv(line[len("! setenv "):])
 585
 586         elif line[0:len("! ignore ")] == "! ignore ":
 587             cmd.add_ignore(line[len("! ignore "):])
 588
 589         else:
 590             fatal_error("UNRECOGNIZED OPTION")
 591
 592
 593         line = f.readfullline()
 594
 595     cmd.run_if_possible()
 596
 597     TeshState().join_all_threads()
 598
 599     if f.filename == "(stdin)":
 600         print("Test suite from stdin OK")
 601     else:
 602         print("Test suite `"+f.filename+"' OK")