tools/tesh/tesh.py

   1 #! @PYTHON_EXECUTABLE@
   2 # -*- coding: utf-8 -*-
   3 """
   4
   5 tesh -- testing shell
   6 ========================
   7
   8 Copyright (c) 2012-2016. The SimGrid Team.
   9 All rights reserved.
  10
  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.
  13
  14
  15 #TODO: child of child of child that printfs. Does it work?
  16 #TODO: a child dies after its parent. What happen?
  17
  18 #TODO: regular expression in output
  19 #ex: >> Time taken: [0-9]+s
  20 #TODO: linked regular expression in output
  21 #ex:
  22 # >> Bytes sent: ([0-9]+)
  23 # >> Bytes recv: \1
  24 # then, even better:
  25 # ! expect (\1 > 500)
  26
  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";
  32 #
  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";
  36
  37
  38 """
  39
  40
  41 import sys, os
  42 import shlex
  43 import re
  44 import difflib
  45 import signal
  46 import argparse
  47
  48 if sys.version_info[0] == 3:
  49     import subprocess
  50     import _thread
  51 else:
  52     raise "This program is expected to run with Python3 only"
  53
  54
  55
  56 ##############
  57 #
  58 # Utilities
  59 #
  60 #
  61
  62
  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. """
  67     _instances = {}
  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
  73
  74 SIGNALS_TO_NAMES_DICT = dict((getattr(signal, n), n) \
  75     for n in dir(signal) if n.startswith('SIG') and '_' not in n )
  76
  77
  78
  79 #exit correctly
  80 def exit(errcode):
  81     #If you do not flush some prints are skipped
  82     sys.stdout.flush()
  83     #os._exit exit even when executed within a thread
  84     os._exit(errcode)
  85
  86
  87 def fatal_error(msg):
  88     print("[Tesh/CRITICAL] "+str(msg))
  89     exit(1)
  90
  91
  92 #Set an environment variable.
  93 # arg must be a string with the format "variable=value"
  94 def setenv(arg):
  95     print("[Tesh/INFO] setenv "+arg)
  96     t = arg.split("=")
  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
 100
 101
 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))
 105
 106 # https://github.com/Cadair/jupyter_environment_kernels/issues/10
 107 try:
 108     FileNotFoundError
 109 except NameError:
 110     #py2
 111     FileNotFoundError = OSError
 112
 113
 114 ##############
 115 #
 116 # Classes
 117 #
 118 #
 119
 120
 121
 122 # read file line per line (and concat line that ends with "\")
 123 class FileReader(Singleton):
 124     def __init__(self, filename):
 125         if filename is None:
 126             self.filename = "(stdin)"
 127             self.f = sys.stdin
 128         else:
 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)
 133
 134         self.linenumber = 0
 135
 136     def linenumber(self):
 137         return self.linenumber
 138
 139     def __repr__(self):
 140         return self.filename+":"+str(self.linenumber)
 141
 142     def readfullline(self):
 143         try:
 144             line = next(self.f)
 145             self.linenumber += 1
 146         except StopIteration:
 147             return None
 148         if line[-1] == "\n":
 149             txt = line[0:-1]
 150         else:
 151             txt = line
 152         while len(line) > 1 and line[-2] == "\\":
 153             txt = txt[0:-1]
 154             line = next(self.f)
 155             self.linenumber += 1
 156             txt += line[0:-1]
 157         return txt
 158
 159
 160 #keep the state of tesh (mostly configuration values)
 161 class TeshState(Singleton):
 162     def __init__(self):
 163         self.threads = []
 164         self.args_suffix = ""
 165         self.ignore_regexps_common = []
 166         self.wrapper = None
 167         self.keep = False
 168
 169     def add_thread(self, thread):
 170         self.threads.append(thread)
 171
 172     def join_all_threads(self):
 173         for t in self.threads:
 174             t.acquire()
 175             t.release()
 176
 177 #Command line object
 178 class Cmd(object):
 179     def __init__(self):
 180         self.input_pipe = []
 181         self.output_pipe_stdout = []
 182         self.output_pipe_stderr = []
 183         self.timeout = 5
 184         self.args = None
 185         self.linenumber = -1
 186
 187         self.background = False
 188         self.cwd = None
 189
 190         self.ignore_output = False
 191         self.expect_return = 0
 192
 193         self.output_display = False
 194
 195         self.sort = -1
 196
 197         self.ignore_regexps = TeshState().ignore_regexps_common
 198
 199     def add_input_pipe(self, l):
 200         self.input_pipe.append(l)
 201
 202     def add_output_pipe_stdout(self, l):
 203         self.output_pipe_stdout.append(l)
 204
 205     def add_output_pipe_stderr(self, l):
 206         self.output_pipe_stderr.append(l)
 207
 208     def set_cmd(self, args, linenumber):
 209         self.args = args
 210         self.linenumber = linenumber
 211
 212     def add_ignore(self, txt):
 213         self.ignore_regexps.append(re.compile(txt))
 214
 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)]
 218         return lines
 219
 220
 221     def _cmd_mkfile(self, argline):
 222         filename = argline[len("mkfile "):]
 223         file = open(filename, "w")
 224         if file is None:
 225             fatal_error("Unable to create file "+filename)
 226         file.write("\n".join(self.input_pipe))
 227         file.write("\n")
 228         file.close()
 229
 230     def _cmd_cd(self, argline):
 231         args = shlex.split(argline)
 232         if len(args) != 2:
 233             fatal_error("Too many arguments to cd")
 234         try:
 235             os.chdir(args[1])
 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)")
 240             exit(4)
 241
 242
 243     #Run the Cmd if possible.
 244     # Return False if nothing has been ran.
 245     def run_if_possible(self):
 246         if self.can_run():
 247             if self.background:
 248                 #Python threads loose the cwd
 249                 self.cwd = os.getcwd()
 250                 lock = _thread.allocate_lock()
 251                 lock.acquire()
 252                 TeshState().add_thread(lock)
 253                 _thread.start_new_thread( Cmd._run, (self, lock) )
 254             else:
 255                 self._run()
 256             return True
 257         else:
 258             return False
 259
 260
 261     def _run(self, lock=None):
 262         #Python threads loose the cwd
 263         if self.cwd is not None:
 264             os.chdir(self.cwd)
 265             self.cwd = None
 266
 267         #retrocompatibility: support ${aaa:=.} variable format
 268         def replace_perl_variables(m):
 269             vname = m.group(1)
 270             vdefault = m.group(2)
 271             if vname in os.environ:
 272                 return "$"+vname
 273             else:
 274                 return vdefault
 275         self.args = re.sub(r"\${(\w+):=([^}]*)}", replace_perl_variables, self.args)
 276
 277         #replace bash environment variables ($THINGS) to their values
 278         self.args = expandvars2(self.args)
 279
 280         if re.match("^mkfile ", self.args) is not None:
 281             self._cmd_mkfile(self.args)
 282             if lock is not None: lock.release()
 283             return
 284
 285         if re.match("^cd ", self.args) is not None:
 286             self._cmd_cd(self.args)
 287             if lock is not None: lock.release()
 288             return
 289
 290         if TeshState().wrapper is not None:
 291             self.timeout *= 20
 292             self.args = TeshState().wrapper + self.args
 293         elif re.match(".*smpirun.*", self.args) is not None:
 294             self.args = "sh " + self.args
 295
 296         self.args += TeshState().args_suffix
 297
 298         print("["+FileReader().filename+":"+str(self.linenumber)+"] "+self.args)
 299
 300         args = shlex.split(self.args)
 301         #print (args)
 302         try:
 303             proc = subprocess.Popen(args, bufsize=1, stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.STDOUT, universal_newlines=True)
 304         except OSError as e:
 305             if e.errno == 8:
 306                 e.strerror += "\nOSError: [Errno 8] Executed scripts should start with shebang line (like #!/bin/sh)"
 307             raise e
 308
 309         cmdName = FileReader().filename+":"+str(self.linenumber)
 310         try:
 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)")
 314             exit(3)
 315
 316         if self.output_display:
 317             print(stdout_data)
 318
 319         #remove text colors
 320         ansi_escape = re.compile(r'\x1b[^m]*m')
 321         stdout_data = ansi_escape.sub('', stdout_data)
 322
 323         #print ((stdout_data, stderr_data))
 324
 325         if self.ignore_output:
 326             print("(ignoring the output of <"+cmdName+"> as requested)")
 327         else:
 328             stdouta = stdout_data.split("\n")
 329             while len(stdouta) > 0 and stdouta[-1] == "":
 330                 del stdouta[-1]
 331             stdouta = self.remove_ignored_lines(stdouta)
 332
 333             #the "sort" bash command is case unsensitive,
 334             # we mimic its behaviour
 335             if self.sort == 0:
 336                 stdouta.sort(key=lambda x: x.lower())
 337                 self.output_pipe_stdout.sort(key=lambda x: x.lower())
 338             elif self.sort > 0:
 339                 stdouta.sort(key=lambda x: x[:self.sort].lower())
 340                 self.output_pipe_stdout.sort(key=lambda x: x[:self.sort].lower())
 341
 342             diff = list(difflib.unified_diff(self.output_pipe_stdout, stdouta,lineterm="",fromfile='expected', tofile='obtained'))
 343             if len(diff) > 0:
 344                 print("Output of <"+cmdName+"> mismatch:")
 345                 for line in diff:
 346                     print(line)
 347                 print("Test suite `"+FileReader().filename+"': NOK (<"+cmdName+"> output mismatch)")
 348                 if lock is not None: lock.release()
 349                 if TeshState().keep:
 350                     f = open('obtained','w')
 351                     obtained = stdout_data.split("\n")
 352                     while len(obtained) > 0 and obtained[-1] == "":
 353                         del obtained[-1]
 354                     obtained = self.remove_ignored_lines(obtained)
 355                     for line in obtained:
 356                         f.write("> "+line+"\n")
 357                     f.close()
 358                     print("Obtained output kept as requested: "+os.path.abspath("obtained"))
 359                 exit(2)
 360
 361         #print ((proc.returncode, self.expect_return))
 362
 363         if proc.returncode != self.expect_return:
 364             if proc.returncode >= 0:
 365                 print("Test suite `"+FileReader().filename+"': NOK (<"+cmdName+"> returned code "+str(proc.returncode)+")")
 366                 if lock is not None: lock.release()
 367                 exit(2)
 368             else:
 369                 print("Test suite `"+FileReader().filename+"': NOK (<"+cmdName+"> got signal "+SIGNALS_TO_NAMES_DICT[-proc.returncode]+")")
 370                 if lock is not None: lock.release()
 371                 exit(-proc.returncode)
 372
 373         if lock is not None: lock.release()
 374
 375
 376
 377     def can_run(self):
 378         return self.args is not None
 379
 380
 381
 382
 383 ##############
 384 #
 385 # Main
 386 #
 387 #
 388
 389
 390
 391 if __name__ == '__main__':
 392
 393     parser = argparse.ArgumentParser(description='tesh -- testing shell', add_help=True)
 394     group1 = parser.add_argument_group('Options')
 395     group1.add_argument('teshfile', nargs='?', help='Name of teshfile, stdin if omitted')
 396     group1.add_argument('--cd', metavar='some/directory', help='ask tesh to switch the working directory before launching the tests')
 397     group1.add_argument('--setenv', metavar='var=value', action='append', help='set a specific environment variable')
 398     group1.add_argument('--cfg', metavar='arg', help='add parameter --cfg=arg to each command line')
 399     group1.add_argument('--log', metavar='arg', help='add parameter --log=arg to each command line')
 400     group1.add_argument('--ignore-jenkins', action='store_true', help='ignore all cruft generated on SimGrid continous integration servers')
 401     group1.add_argument('--wrapper', metavar='arg', help='Run each command in the provided wrapper (eg valgrind)')
 402     group1.add_argument('--keep', action='store_true', help='Keep the obtained output when it does not match the expected one')
 403
 404     try:
 405         options = parser.parse_args()
 406     except:
 407         exit(1)
 408
 409     if options.cd is not None:
 410         os.chdir(options.cd)
 411
 412     if options.ignore_jenkins:
 413         print("Ignore all cruft seen on SimGrid's continous integration servers")
 414         TeshState().ignore_regexps_common = [
 415            re.compile("^profiling:"),
 416            re.compile(".*WARNING: ASan doesn\'t fully support"),
 417            re.compile("Unable to clean temporary file C:.*")]
 418
 419     if options.teshfile is None:
 420         f = FileReader(None)
 421         print("Test suite from stdin")
 422     else:
 423         f = FileReader(options.teshfile)
 424         print("Test suite '"+f.abspath+"'")
 425
 426     if options.setenv is not None:
 427         for e in options.setenv:
 428             setenv(e)
 429
 430     if options.cfg is not None:
 431         TeshState().args_suffix += " --cfg="+options.cfg
 432     if options.log is not None:
 433         TeshState().args_suffix += " --log="+options.log
 434
 435     if options.wrapper is not None:
 436         TeshState().wrapper = options.wrapper
 437
 438     if options.keep:
 439         TeshState().keep = True
 440
 441     #cmd holds the current command line
 442     # tech commands will add some parameters to it
 443     # when ready, we execute it.
 444     cmd = Cmd()
 445
 446     line = f.readfullline()
 447     while line is not None:
 448         #print(">>============="+line+"==<<")
 449         if len(line) == 0:
 450             #print ("END CMD block")
 451             if cmd.run_if_possible():
 452                 cmd = Cmd()
 453
 454         elif line[0] == "#":
 455             pass
 456
 457         elif line[0:2] == "p ":
 458             print("["+str(FileReader())+"] "+line[2:])
 459
 460         elif line[0:2] == "< ":
 461             cmd.add_input_pipe(line[2:])
 462         elif line[0:1] == "<":
 463             cmd.add_input_pipe(line[1:])
 464
 465         elif line[0:2] == "> ":
 466             cmd.add_output_pipe_stdout(line[2:])
 467         elif line[0:1] == ">":
 468             cmd.add_output_pipe_stdout(line[1:])
 469
 470         elif line[0:2] == "$ ":
 471             if cmd.run_if_possible():
 472                 cmd = Cmd()
 473             cmd.set_cmd(line[2:], f.linenumber)
 474
 475         elif line[0:2] == "& ":
 476             if cmd.run_if_possible():
 477                 cmd = Cmd()
 478             cmd.set_cmd(line[2:], f.linenumber)
 479             cmd.background = True
 480
 481         elif line[0:15] == "! output ignore":
 482             cmd.ignore_output = True
 483             #print("cmd.ignore_output = True")
 484         elif line[0:16] == "! output display":
 485             cmd.output_display = True
 486             cmd.ignore_output = True
 487         elif line[0:15] == "! expect return":
 488             cmd.expect_return = int(line[16:])
 489             #print("expect return "+str(int(line[16:])))
 490         elif line[0:15] == "! expect signal":
 491             sig = line[16:]
 492             #get the signal integer value from the signal module
 493             if sig not in signal.__dict__:
 494                 fatal_error("unrecognized signal '"+sig+"'")
 495             sig = int(signal.__dict__[sig])
 496             #popen return -signal when a process ends with a signal
 497             cmd.expect_return = -sig
 498         elif line[0:len("! timeout ")] == "! timeout ":
 499             if "no" in line[len("! timeout "):]:
 500                 cmd.timeout = None
 501             else:
 502                 cmd.timeout = int(line[len("! timeout "):])
 503
 504         elif line[0:len("! output sort")] == "! output sort":
 505             if len(line) >= len("! output sort "):
 506                 sort = int(line[len("! output sort "):])
 507             else:
 508                 sort = 0
 509             cmd.sort = sort
 510         elif line[0:len("! setenv ")] == "! setenv ":
 511             setenv(line[len("! setenv "):])
 512
 513         elif line[0:len("! ignore ")] == "! ignore ":
 514             cmd.add_ignore(line[len("! ignore "):])
 515
 516         else:
 517             fatal_error("UNRECOGNIZED OPTION")
 518
 519
 520         line = f.readfullline()
 521
 522     cmd.run_if_possible()
 523
 524     TeshState().join_all_threads()
 525
 526     if f.filename == "(stdin)":
 527         print("Test suite from stdin OK")
 528     else:
 529         print("Test suite `"+f.filename+"' OK")