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.f = open(self.filename_raw)
 132
 133         self.linenumber = 0
 134
 135     def linenumber(self):
 136         return self.linenumber
 137
 138     def __repr__(self):
 139         return self.filename+":"+str(self.linenumber)
 140
 141     def readfullline(self):
 142         try:
 143             line = next(self.f)
 144             self.linenumber += 1
 145         except StopIteration:
 146             return None
 147         if line[-1] == "\n":
 148             txt = line[0:-1]
 149         else:
 150             txt = line
 151         while len(line) > 1 and line[-2] == "\\":
 152             txt = txt[0:-1]
 153             line = next(self.f)
 154             self.linenumber += 1
 155             txt += line[0:-1]
 156         return txt
 157
 158
 159 #keep the state of tesh (mostly configuration values)
 160 class TeshState(Singleton):
 161     def __init__(self):
 162         self.threads = []
 163         self.args_suffix = ""
 164         self.ignore_regexps_common = []
 165         self.wrapper = None
 166
 167     def add_thread(self, thread):
 168         self.threads.append(thread)
 169
 170     def join_all_threads(self):
 171         for t in self.threads:
 172             t.acquire()
 173             t.release()
 174
 175 #Command line object
 176 class Cmd(object):
 177     def __init__(self):
 178         self.input_pipe = []
 179         self.output_pipe_stdout = []
 180         self.output_pipe_stderr = []
 181         self.timeout = 5
 182         self.args = None
 183         self.linenumber = -1
 184
 185         self.background = False
 186         self.cwd = None
 187
 188         self.ignore_output = False
 189         self.expect_return = 0
 190
 191         self.output_display = False
 192
 193         self.sort = -1
 194
 195         self.ignore_regexps = TeshState().ignore_regexps_common
 196
 197     def add_input_pipe(self, l):
 198         self.input_pipe.append(l)
 199
 200     def add_output_pipe_stdout(self, l):
 201         self.output_pipe_stdout.append(l)
 202
 203     def add_output_pipe_stderr(self, l):
 204         self.output_pipe_stderr.append(l)
 205
 206     def set_cmd(self, args, linenumber):
 207         self.args = args
 208         self.linenumber = linenumber
 209
 210     def add_ignore(self, txt):
 211         self.ignore_regexps.append(re.compile(txt))
 212
 213     def remove_ignored_lines(self, lines):
 214         for ign in self.ignore_regexps:
 215                 lines = [l for l in lines if not ign.match(l)]
 216         return lines
 217
 218
 219     def _cmd_mkfile(self, argline):
 220         filename = argline[len("mkfile "):]
 221         file = open(filename, "w")
 222         if file is None:
 223             fatal_error("Unable to create file "+filename)
 224         file.write("\n".join(self.input_pipe))
 225         file.close()
 226
 227     def _cmd_cd(self, argline):
 228         args = shlex.split(argline)
 229         if len(args) != 2:
 230             fatal_error("Too many arguments to cd")
 231         try:
 232             os.chdir(args[1])
 233             print("[Tesh/INFO] change directory to "+args[1])
 234         except FileNotFoundError:
 235             print("Chdir to "+args[1]+" failed: No such file or directory")
 236             print("Test suite `"+FileReader().filename+"': NOK (system error)")
 237             exit(4)
 238
 239
 240     #Run the Cmd if possible.
 241     # Return False if nothing has been ran.
 242     def run_if_possible(self):
 243         if self.can_run():
 244             if self.background:
 245                 #Python threads loose the cwd
 246                 self.cwd = os.getcwd()
 247                 lock = _thread.allocate_lock()
 248                 lock.acquire()
 249                 TeshState().add_thread(lock)
 250                 _thread.start_new_thread( Cmd._run, (self, lock) )
 251             else:
 252                 self._run()
 253             return True
 254         else:
 255             return False
 256
 257
 258     def _run(self, lock=None):
 259         #Python threads loose the cwd
 260         if self.cwd is not None:
 261             os.chdir(self.cwd)
 262             self.cwd = None
 263
 264         #retrocompatibility: support ${aaa:=.} variable format
 265         def replace_perl_variables(m):
 266             vname = m.group(1)
 267             vdefault = m.group(2)
 268             if vname in os.environ:
 269                 return "$"+vname
 270             else:
 271                 return vdefault
 272         self.args = re.sub(r"\${(\w+):=([^}]*)}", replace_perl_variables, self.args)
 273
 274         #replace bash environment variables ($THINGS) to their values
 275         self.args = expandvars2(self.args)
 276
 277         if re.match("^mkfile ", self.args) is not None:
 278             self._cmd_mkfile(self.args)
 279             if lock is not None: lock.release()
 280             return
 281
 282         if re.match("^cd ", self.args) is not None:
 283             self._cmd_cd(self.args)
 284             if lock is not None: lock.release()
 285             return
 286
 287         if TeshState().wrapper is not None:
 288             self.timeout *= 20
 289             self.args = TeshState().wrapper + self.args
 290
 291         self.args += TeshState().args_suffix
 292
 293         print("["+FileReader().filename+":"+str(self.linenumber)+"] "+self.args)
 294
 295         args = shlex.split(self.args)
 296         #print (args)
 297         try:
 298             proc = subprocess.Popen(args, bufsize=1, stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.STDOUT, universal_newlines=True)
 299         except OSError as e:
 300             if e.errno == 8:
 301                 e.strerror += "\nOSError: [Errno 8] Executed scripts should start with shebang line (like #!/bin/sh)"
 302             raise e
 303
 304         try:
 305             (stdout_data, stderr_data) = proc.communicate("\n".join(self.input_pipe), self.timeout)
 306         except subprocess.TimeoutExpired:
 307             print("Test suite `"+FileReader().filename+"': NOK (<"+FileReader().filename+":"+str(self.linenumber)+"> timeout after "+str(self.timeout)+" sec)")
 308             exit(3)
 309
 310         if self.output_display:
 311             print(stdout_data)
 312
 313         #remove text colors
 314         ansi_escape = re.compile(r'\x1b[^m]*m')
 315         stdout_data = ansi_escape.sub('', stdout_data)
 316
 317         #print ((stdout_data, stderr_data))
 318
 319         if self.ignore_output:
 320             print("(ignoring the output of <"+FileReader().filename+":"+str(self.linenumber)+"> as requested)")
 321         else:
 322             stdouta = stdout_data.split("\n")
 323             while len(stdouta) > 0 and stdouta[-1] == "":
 324                 del stdouta[-1]
 325             stdouta = self.remove_ignored_lines(stdouta)
 326
 327             #the "sort" bash command is case unsensitive,
 328             # we mimic its behaviour
 329             if self.sort == 0:
 330                 stdouta.sort(key=lambda x: x.lower())
 331                 self.output_pipe_stdout.sort(key=lambda x: x.lower())
 332             elif self.sort > 0:
 333                 stdouta.sort(key=lambda x: x[:self.sort].lower())
 334                 self.output_pipe_stdout.sort(key=lambda x: x[:self.sort].lower())
 335
 336             diff = list(difflib.unified_diff(self.output_pipe_stdout, stdouta,lineterm="",fromfile='expected', tofile='obtained'))
 337             if len(diff) > 0:
 338                 print("Output of <"+FileReader().filename+":"+str(self.linenumber)+"> mismatch:")
 339                 for line in diff:
 340                     print(line)
 341                 print("Test suite `"+FileReader().filename+"': NOK (<"+str(FileReader())+"> output mismatch)")
 342                 if lock is not None: lock.release()
 343                 exit(2)
 344
 345         #print ((proc.returncode, self.expect_return))
 346
 347         if proc.returncode != self.expect_return:
 348             if proc.returncode >= 0:
 349                 print("Test suite `"+FileReader().filename+"': NOK (<"+str(FileReader())+"> returned code "+str(proc.returncode)+")")
 350                 if lock is not None: lock.release()
 351                 exit(2)
 352             else:
 353                 print("Test suite `"+FileReader().filename+"': NOK (<"+str(FileReader())+"> got signal "+SIGNALS_TO_NAMES_DICT[-proc.returncode]+")")
 354                 if lock is not None: lock.release()
 355                 exit(-proc.returncode)
 356
 357         if lock is not None: lock.release()
 358
 359
 360
 361     def can_run(self):
 362         return self.args is not None
 363
 364
 365
 366
 367 ##############
 368 #
 369 # Main
 370 #
 371 #
 372
 373
 374
 375 if __name__ == '__main__':
 376
 377     parser = argparse.ArgumentParser(description='tesh -- testing shell', add_help=True)
 378     group1 = parser.add_argument_group('Options')
 379     group1.add_argument('teshfile', nargs='?', help='Name of teshfile, stdin if omitted')
 380     group1.add_argument('--cd', metavar='some/directory', help='ask tesh to switch the working directory before launching the tests')
 381     group1.add_argument('--setenv', metavar='var=value', action='append', help='set a specific environment variable')
 382     group1.add_argument('--cfg', metavar='arg', help='add parameter --cfg=arg to each command line')
 383     group1.add_argument('--log', metavar='arg', help='add parameter --log=arg to each command line')
 384     group1.add_argument('--enable-coverage', action='store_true', help='ignore output lines starting with "profiling:"')
 385     group1.add_argument('--wrapper', metavar='arg', help='Run each command in the provided wrapper (eg valgrind)')
 386
 387     try:
 388         options = parser.parse_args()
 389     except:
 390         exit(1)
 391
 392     if options.cd is not None:
 393         os.chdir(options.cd)
 394
 395     if options.enable_coverage:
 396         print("Enable coverage")
 397         TeshState().ignore_regexps_common = [re.compile("^profiling:")]
 398
 399     if options.teshfile is None:
 400         f = FileReader(None)
 401         print("Test suite from stdin")
 402     else:
 403         f = FileReader(options.teshfile)
 404         print("Test suite '"+f.filename+"'")
 405
 406     if options.setenv is not None:
 407         for e in options.setenv:
 408             setenv(e)
 409
 410     if options.cfg is not None:
 411         TeshState().args_suffix += " --cfg="+options.cfg
 412     if options.log is not None:
 413         TeshState().args_suffix += " --log="+options.log
 414
 415     if options.wrapper is not None:
 416         TeshState().wrapper = options.wrapper
 417
 418     #cmd holds the current command line
 419     # tech commands will add some parameters to it
 420     # when ready, we execute it.
 421     cmd = Cmd()
 422
 423     line = f.readfullline()
 424     while line is not None:
 425         #print(">>============="+line+"==<<")
 426         if len(line) == 0:
 427             #print ("END CMD block")
 428             if cmd.run_if_possible():
 429                 cmd = Cmd()
 430
 431         elif line[0] == "#":
 432             pass
 433
 434         elif line[0:2] == "p ":
 435             print("["+str(FileReader())+"] "+line[2:])
 436
 437         elif line[0:2] == "< ":
 438             cmd.add_input_pipe(line[2:])
 439         elif line[0:1] == "<":
 440             cmd.add_input_pipe(line[1:])
 441
 442         elif line[0:2] == "> ":
 443             cmd.add_output_pipe_stdout(line[2:])
 444         elif line[0:1] == ">":
 445             cmd.add_output_pipe_stdout(line[1:])
 446
 447         elif line[0:2] == "$ ":
 448             if cmd.run_if_possible():
 449                 cmd = Cmd()
 450             cmd.set_cmd(line[2:], f.linenumber)
 451
 452         elif line[0:2] == "& ":
 453             if cmd.run_if_possible():
 454                 cmd = Cmd()
 455             cmd.set_cmd(line[2:], f.linenumber)
 456             cmd.background = True
 457
 458         elif line[0:15] == "! output ignore":
 459             cmd.ignore_output = True
 460             #print("cmd.ignore_output = True")
 461         elif line[0:16] == "! output display":
 462             cmd.output_display = True
 463             cmd.ignore_output = True
 464         elif line[0:15] == "! expect return":
 465             cmd.expect_return = int(line[16:])
 466             #print("expect return "+str(int(line[16:])))
 467         elif line[0:15] == "! expect signal":
 468             sig = line[16:]
 469             #get the signal integer value from the signal module
 470             if sig not in signal.__dict__:
 471                 fatal_error("unrecognized signal '"+sig+"'")
 472             sig = int(signal.__dict__[sig])
 473             #popen return -signal when a process ends with a signal
 474             cmd.expect_return = -sig
 475         elif line[0:len("! timeout ")] == "! timeout ":
 476             if "no" in line[len("! timeout "):]:
 477                 cmd.timeout = None
 478             else:
 479                 cmd.timeout = int(line[len("! timeout "):])
 480
 481         elif line[0:len("! output sort")] == "! output sort":
 482             if len(line) >= len("! output sort "):
 483                 sort = int(line[len("! output sort "):])
 484             else:
 485                 sort = 0
 486             cmd.sort = sort
 487         elif line[0:len("! setenv ")] == "! setenv ":
 488             setenv(line[len("! setenv "):])
 489
 490         elif line[0:len("! ignore ")] == "! ignore ":
 491             cmd.add_ignore(line[len("! ignore "):])
 492
 493         else:
 494             fatal_error("UNRECOGNIZED OPTION")
 495
 496
 497         line = f.readfullline()
 498
 499     cmd.run_if_possible()
 500
 501     TeshState().join_all_threads()
 502
 503     if f.filename == "(stdin)":
 504         print("Test suite from stdin OK")
 505     else:
 506         print("Test suite `"+f.filename+"' OK")