tools/tesh/tesh.py

   1 #! @PYTHON_EXECUTABLE@
   2 # -*- coding: utf-8 -*-
   3 """
   4
   5 tesh -- testing shell
   6 ========================
   7
   8 Copyright (c) 2012-2023. 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 #TODO: child of child of child that printfs. Does it work?
  14 #TODO: a child dies after its parent. What happen?
  15
  16 #TODO: regular expression in output
  17 #ex: >> Time taken: [0-9]+s
  18 #TODO: linked regular expression in output
  19 #ex:
  20 # >> Bytes sent: ([0-9]+)
  21 # >> Bytes recv: \1
  22 # then, even better:
  23 # ! expect (\1 > 500)
  24
  25 """
  26
  27 import sys
  28 import errno
  29 import os
  30 import shlex
  31 import re
  32 import difflib
  33 import signal
  34 import argparse
  35 import time
  36
  37 if sys.version_info[0] == 3:
  38     import subprocess
  39     import _thread
  40 else:
  41     raise RuntimeError("This program is expected to run with Python3 only")
  42
  43 ##############
  44 #
  45 # Utilities
  46 #
  47 #
  48
  49 # Singleton metaclass that works in Python 2 & 3
  50 # http://stackoverflow.com/questions/6760685/creating-a-singleton-in-python
  51
  52 class _Singleton(type):
  53     """ A metaclass that creates a Singleton base class when called. """
  54     _instances = {}
  55
  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
  61 class Singleton(_Singleton('SingletonMeta', (object,), {})):
  62     """ The Singleton base class """
  63     # pass
  64
  65 SIGNALS_TO_NAMES_DICT = dict((getattr(signal, n), n)
  66                              for n in dir(signal) if n.startswith('SIG') and '_' not in n)
  67
  68 def tesh_exit(errcode):
  69     """ Exit correctly """
  70     # If you do not flush some prints are skipped
  71     sys.stdout.flush()
  72     # os._exit exit even when executed within a thread
  73     # pylint: disable=protected-access
  74     os._exit(errcode)
  75
  76
  77 def fatal_error(msg):
  78     """ Exit with error """
  79     print("[Tesh/CRITICAL] " + str(msg))
  80     tesh_exit(1)
  81
  82
  83 def setenv(arg):
  84     """
  85     Set an environment variable.
  86     arg must be a string with the format "variable=value"
  87     """
  88     print("[Tesh/INFO] setenv " + arg)
  89     (var, val) = arg.split("=", 1)
  90     os.environ[var] = val
  91     # os.putenv(var, val) does not work
  92     # see http://stackoverflow.com/questions/17705419/python-os-environ-os-putenv-usr-bin-env
  93
  94
  95 def expandvars2(path):
  96     """ http://stackoverflow.com/questions/30734967/how-to-expand-environment-variables-in-python-as-bash-does """
  97     return re.sub(r'(?<!\\)\$[A-Za-z_][A-Za-z0-9_]*', '', os.path.expandvars(path))
  98
  99 ##############
 100 #
 101 # Cleanup on signal
 102 #
 103 #
 104
 105 def process_is_dead(pid):
 106     """ Tests whether the process is dead already """
 107     try:
 108         os.kill(pid, 0)
 109     except ProcessLookupError:
 110         return True
 111     except OSError as err:
 112         if err.errno == errno.ESRCH: # ESRCH == No such process. The process is now dead
 113             return True
 114     return False
 115
 116 def kill_process_group(pid):
 117     """ This function send TERM signal + KILL signal after 0.2s to the group of the specified process """
 118     if pid is None:
 119         # Nobody to kill. We don't have anyone to kill on signal handler
 120         return
 121
 122     try:
 123         pgid = os.getpgid(pid)
 124     except OSError:
 125         # os.getpgid failed. Ok, don't cleanup.
 126         return
 127
 128     try:
 129         os.killpg(pgid, signal.SIGTERM)
 130         if process_is_dead(pid):
 131             return
 132         time.sleep(0.2)
 133         os.killpg(pgid, signal.SIGKILL)
 134     except OSError:
 135         # os.killpg failed. OK. Some subprocesses may still be running.
 136         pass
 137
 138 def signal_handler(signo, _frame):
 139     """ Signal handler """
 140     print("Caught signal {}".format(SIGNALS_TO_NAMES_DICT[signo]))
 141     running_pids = TeshState().running_pids # Just in case of interthread conflicts.
 142     for pid in running_pids:
 143         kill_process_group(pid)
 144     TeshState().running_pids.clear()
 145     tesh_exit(5)
 146
 147
 148 ##############
 149 #
 150 # Classes
 151 #
 152 #
 153
 154
 155 class FileReader(Singleton):
 156     """ Read file line per line (and concat line that ends with "\") """
 157     def __init__(self, filename=None):
 158         if filename is None:
 159             self.filename = "(stdin)"
 160             self.fileno = sys.stdin
 161         else:
 162             self.filename_raw = filename
 163             self.filename = os.path.basename(filename)
 164             self.abspath = os.path.abspath(filename)
 165             self.fileno = open(self.filename_raw)
 166
 167         self.linenumber = 0
 168
 169     def __repr__(self):
 170         return self.filename + ":" + str(self.linenumber)
 171
 172     def readfullline(self):
 173         """ Read a full line """
 174         try:
 175             line = next(self.fileno)
 176             self.linenumber += 1
 177         except StopIteration:
 178             return None
 179         if line[-1] == "\n":
 180             txt = line[0:-1]
 181         else:
 182             txt = line
 183         while len(line) > 1 and line[-2] == "\\":
 184             txt = txt[0:-1]
 185             line = next(self.fileno)
 186             self.linenumber += 1
 187             txt += line[0:-1]
 188         return txt
 189
 190
 191 class TeshState(Singleton):
 192     """ Keep the state of tesh (mostly configuration values) """
 193     def __init__(self):
 194         self.running_pids = list() # stores which process group should be killed (or None otherwise)
 195         self.threads = []
 196         self.args_suffix = ""
 197         self.ignore_regexps_common = []
 198         self.jenkins = False  # not a Jenkins run by default
 199         self.auto_valgrind = True
 200         self.timeout = 10  # default value: 10 sec
 201         self.wrapper = None
 202         self.keep = False
 203         self.return_code = 0
 204
 205     def add_thread(self, thread):
 206         """ Add another thread to wait for """
 207         self.threads.append(thread)
 208
 209     def join_all_threads(self):
 210         """ Wait for all threads """
 211         for thread in self.threads:
 212             thread.acquire()
 213             thread.release()
 214
 215     def set_return_code(self, value):
 216         """ Set exit status """
 217         if value > self.return_code:
 218             self.return_code = value
 219
 220
 221 class Cmd:
 222     """ Command line object """
 223     def __init__(self):
 224         self.input_pipe = []
 225         self.output_pipe_stdout = []
 226         self.output_pipe_stderr = []
 227         self.timeout = TeshState().timeout
 228         self.args = None
 229         self.linenumber = -1
 230
 231         self.background = False
 232         # Python threads loose the cwd
 233         self.cwd = os.getcwd()
 234
 235         self.ignore_output = False
 236         self.expect_return = [0]
 237
 238         self.output_display = False
 239
 240         self.sort = -1
 241         self.rerun_with_valgrind = False
 242
 243         self.ignore_regexps = TeshState().ignore_regexps_common
 244
 245     def add_input_pipe(self, line):
 246         """ Add a line to stdin input """
 247         self.input_pipe.append(line)
 248
 249     def add_output_pipe_stdout(self, line):
 250         """ Add a line to stdout output """
 251         self.output_pipe_stdout.append(line)
 252
 253     def add_output_pipe_stderr(self, line):
 254         """ Add a line to stderr output """
 255         self.output_pipe_stderr.append(line)
 256
 257     def set_cmd(self, args, linenumber):
 258         """ Set command line """
 259         self.args = args
 260         self.linenumber = linenumber
 261
 262     def add_ignore(self, txt):
 263         """ Add regexp to ignore lines """
 264         self.ignore_regexps.append(re.compile(txt))
 265
 266     def remove_ignored_lines(self, lines):
 267         """ Remove ignored lines """
 268         for ign in self.ignore_regexps:
 269             lines = [l for l in lines if not ign.match(l)]
 270         return lines
 271
 272     def _cmd_mkfile(self, argline):
 273         filename = argline[len("mkfile "):]
 274         file = open(filename, "w")
 275         if file is None:
 276             fatal_error("Unable to create file " + filename)
 277         file.write("\n".join(self.input_pipe))
 278         file.write("\n")
 279         file.close()
 280
 281     def _cmd_cd(self, argline): # pylint: disable=no-self-use
 282         args = shlex.split(argline)
 283         if len(args) != 2:
 284             fatal_error("Too many arguments to cd")
 285         try:
 286             os.chdir(args[1])
 287             print("[Tesh/INFO] change directory to " + args[1])
 288         except FileNotFoundError:
 289             print("Chdir to " + args[1] + " failed: No such file or directory")
 290             print("Test suite `" + FileReader().filename + "': NOK (system error)")
 291             tesh_exit(4)
 292
 293     def run_if_possible(self):
 294         """
 295         Run the Cmd if possible.
 296         Return False if nothing has been ran.
 297         """
 298         if not self.can_run():
 299             return False
 300         if self.background:
 301             lock = _thread.allocate_lock()
 302             lock.acquire()
 303             TeshState().add_thread(lock)
 304             _thread.start_new_thread(Cmd._run, (self, lock))
 305         else:
 306             self._run()
 307             if self.rerun_with_valgrind and TeshState().auto_valgrind:
 308                 print('\n\n\nXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
 309                 print(      'XXXXXXXXX Rerunning this test with valgrind to help debugging it XXXXXXXXX')
 310                 print(      'XXXXXXXX (this will fail if valgrind is not installed, of course) XXXXXXXX')
 311                 print(      'XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX\n\n\n')
 312
 313                 self.args = "valgrind " + self.args
 314                 self._run()
 315         return True
 316
 317     def _run(self, lock=None):
 318         # Python threads loose the cwd
 319         os.chdir(self.cwd)
 320
 321         # retrocompatibility: support ${aaa:=.} variable format
 322         def replace_perl_variables(arg):
 323             vname = arg.group(1)
 324             vdefault = arg.group(2)
 325             if vname in os.environ:
 326                 return "$" + vname
 327             return vdefault
 328
 329         self.args = re.sub(r"\${(\w+):=([^}]*)}", replace_perl_variables, self.args)
 330
 331         # replace bash environment variables ($THINGS) to their values
 332         self.args = expandvars2(self.args)
 333
 334         if re.match("^mkfile ", self.args) is not None:
 335             self._cmd_mkfile(self.args)
 336             if lock is not None:
 337                 lock.release()
 338             return
 339
 340         if re.match("^cd ", self.args) is not None:
 341             self._cmd_cd(self.args)
 342             if lock is not None:
 343                 lock.release()
 344             return
 345
 346         if TeshState().wrapper is not None:
 347             self.timeout *= 20
 348             self.args = TeshState().wrapper + self.args
 349         elif re.match(".*smpirun.*", self.args) is not None:
 350             self.args = "sh " + self.args
 351         if TeshState().jenkins and self.timeout is not None:
 352             self.timeout *= 10
 353
 354         self.args += TeshState().args_suffix
 355
 356         logs = list()
 357         msg = "[{file}:{number}] {args}".format(file=FileReader().filename, number=self.linenumber, args=self.args)
 358         if self.background:
 359             logs.append(msg)
 360         else:
 361             print(msg, flush=True)
 362
 363         args = shlex.split(self.args)
 364
 365         local_pid = None
 366
 367         try:
 368             preexec_function = lambda: os.setpgid(0, 0)
 369             proc = subprocess.Popen( # pylint: disable=subprocess-popen-preexec-fn
 370                 args,
 371                 bufsize=1,
 372                 stdin=subprocess.PIPE,
 373                 stdout=subprocess.PIPE,
 374                 stderr=subprocess.STDOUT,
 375                 universal_newlines=True,
 376                 preexec_fn=preexec_function)
 377             local_pid = proc.pid
 378             TeshState().running_pids.append(local_pid)
 379         except PermissionError:
 380             logs.append("[{file}:{number}] Cannot start '{cmd}': The binary is not executable.".format(
 381                 file=FileReader().filename, number=self.linenumber, cmd=args[0]))
 382             logs.append("[{file}:{number}] Current dir: {dir}".format(file=FileReader().filename,
 383                                                                       number=self.linenumber, dir=os.getcwd()))
 384             TeshState().set_return_code(3)
 385             print('\n'.join(logs))
 386             return
 387         except NotADirectoryError:
 388             logs.append("[{file}:{number}] Cannot start '{cmd}': The path to binary does not exist.".format(
 389                 file=FileReader().filename, number=self.linenumber, cmd=args[0]))
 390             logs.append("[{file}:{number}] Current dir: {dir}".format(file=FileReader().filename,
 391                                                                       number=self.linenumber, dir=os.getcwd()))
 392             TeshState().set_return_code(3)
 393             print('\n'.join(logs))
 394             return
 395         except FileNotFoundError:
 396             logs.append("[{file}:{number}] Cannot start '{cmd}': File not found.".format(
 397                 file=FileReader().filename, number=self.linenumber, cmd=args[0]))
 398             TeshState().set_return_code(3)
 399             print('\n'.join(logs))
 400             return
 401         except OSError as err:
 402             if err.errno == 8:
 403                 err.strerror += \
 404                     "\nOSError: [Errno 8] Executed scripts should start with shebang line (like #!/usr/bin/env sh)"
 405             raise err
 406
 407         cmd_name = FileReader().filename + ":" + str(self.linenumber)
 408         try:
 409             (stdout_data, _stderr_data) = proc.communicate("\n".join(self.input_pipe), self.timeout)
 410             timeout_reached = False
 411         except subprocess.TimeoutExpired:
 412             timeout_reached = True
 413             logs.append("Test suite `{file}': NOK (<{cmd}> timeout after {timeout} sec)".format(
 414                 file=FileReader().filename, cmd=cmd_name, timeout=self.timeout))
 415             TeshState().running_pids.remove(local_pid)
 416             kill_process_group(local_pid)
 417             # Try to get the output of the timeout process, to help in debugging.
 418             try:
 419                 (stdout_data, _stderr_data) = proc.communicate(timeout=1)
 420             except subprocess.TimeoutExpired:
 421                 logs.append("[{file}:{number}] Could not retrieve output. Killing the process group failed?".format(
 422                     file=FileReader().filename, number=self.linenumber))
 423                 TeshState().set_return_code(3)
 424                 print('\n'.join(logs))
 425                 return
 426
 427         # remove text colors
 428         ansi_escape = re.compile(r'\x1b[^m]*m')
 429         stdout_data = ansi_escape.sub('', stdout_data)
 430
 431         if self.output_display:
 432             logs.append(str(stdout_data))
 433
 434         if self.rerun_with_valgrind:
 435             print(str(stdout_data), file=sys.stderr)
 436             return
 437
 438         if self.ignore_output:
 439             logs.append("(ignoring the output of <{cmd}> as requested)".format(cmd=cmd_name))
 440         else:
 441             stdouta = stdout_data.split("\n")
 442             stdouta = self.remove_ignored_lines(stdouta)
 443             while stdouta and stdouta[-1] == "":
 444                 del stdouta[-1]
 445             stdcpy = stdouta[:]
 446
 447             # Mimic the "sort" bash command, which is case unsensitive.
 448             if self.sort == 0:
 449                 stdouta.sort(key=lambda x: x.lower())
 450                 self.output_pipe_stdout.sort(key=lambda x: x.lower())
 451             elif self.sort > 0:
 452                 stdouta.sort(key=lambda x: x[:self.sort].lower())
 453                 self.output_pipe_stdout.sort(key=lambda x: x[:self.sort].lower())
 454
 455             diff = list(
 456                 difflib.unified_diff(
 457                     self.output_pipe_stdout,
 458                     stdouta,
 459                     lineterm="",
 460                     fromfile='expected',
 461                     tofile='obtained'))
 462             if diff:
 463                 logs.append("Output of <{cmd}> mismatch:".format(cmd=cmd_name))
 464                 if self.sort >= 0:  # If sorted, truncate the diff output and show the unsorted version
 465                     difflen = 0
 466                     for line in diff:
 467                         if difflen < 50:
 468                             print(line)
 469                         difflen += 1
 470                     if difflen > 50:
 471                         logs.append("(diff truncated after 50 lines)")
 472                     logs.append("Unsorted observed output:\n")
 473                     for line in stdcpy:
 474                         logs.append(line)
 475                 else:  # If not sorted, just display the diff
 476                     for line in diff:
 477                         logs.append(line)
 478
 479                 logs.append("Test suite `{file}': NOK (<{cmd}> output mismatch)".format(
 480                     file=FileReader().filename, cmd=cmd_name))
 481
 482                 # Also report any failed return code and/or signal we got in case of output mismatch
 483                 if not proc.returncode in self.expect_return:
 484                     if proc.returncode >= 0:
 485                         logs.append("In addition, <{cmd}> returned code {code}.".format(
 486                             cmd=cmd_name, code=proc.returncode))
 487                     else:
 488                         logs.append("In addition, <{cmd}> got signal {sig}.".format(cmd=cmd_name,
 489                             sig=SIGNALS_TO_NAMES_DICT[-proc.returncode]))
 490                     if proc.returncode == -signal.SIGSEGV:
 491                         self.rerun_with_valgrind = True
 492
 493                 if lock is not None:
 494                     lock.release()
 495                 if TeshState().keep:
 496                     file = open('obtained', 'w')
 497                     obtained = stdout_data.split("\n")
 498                     while obtained and obtained[-1] == "":
 499                         del obtained[-1]
 500                     obtained = self.remove_ignored_lines(obtained)
 501                     for line in obtained:
 502                         file.write("> " + line + "\n")
 503                     file.close()
 504                     logs.append("Obtained output kept as requested: {path}".format(path=os.path.abspath("obtained")))
 505                 TeshState().set_return_code(2)
 506                 print('\n'.join(logs))
 507                 return
 508
 509         if timeout_reached:
 510             TeshState().set_return_code(3)
 511             print('\n'.join(logs))
 512             return
 513
 514         if not proc.returncode in self.expect_return:
 515             if proc.returncode >= 0:
 516                 logs.append("Test suite `{file}': NOK (<{cmd}> returned code {code})".format(
 517                     file=FileReader().filename, cmd=cmd_name, code=proc.returncode))
 518                 if lock is not None:
 519                     lock.release()
 520                 TeshState().set_return_code(2)
 521                 print('\n'.join(logs))
 522                 return
 523
 524             logs.append("Test suite `{file}': NOK (<{cmd}> got signal {sig})".format(
 525                 file=FileReader().filename, cmd=cmd_name,
 526                 sig=SIGNALS_TO_NAMES_DICT[-proc.returncode]))
 527
 528             if proc.returncode == -signal.SIGSEGV:
 529                 self.rerun_with_valgrind = True
 530
 531             if lock is not None:
 532                 lock.release()
 533             TeshState().set_return_code(max(-proc.returncode, 1))
 534             print('\n'.join(logs))
 535             return
 536
 537         if lock is not None:
 538             lock.release()
 539
 540         print('\n'.join(logs))
 541
 542     def can_run(self):
 543         """ Check if ready to run """
 544         return self.args is not None
 545
 546 ##############
 547 #
 548 # Main
 549 #
 550 #
 551
 552 def main():
 553     """ main function """
 554     signal.signal(signal.SIGINT, signal_handler)
 555     signal.signal(signal.SIGTERM, signal_handler)
 556
 557     parser = argparse.ArgumentParser(description='tesh -- testing shell')
 558     group1 = parser.add_argument_group('Options')
 559     group1.add_argument('teshfile', nargs='?', help='Name of teshfile, stdin if omitted')
 560     group1.add_argument(
 561         '--cd',
 562         metavar='some/directory',
 563         help='ask tesh to switch the working directory before launching the tests')
 564     group1.add_argument('--setenv', metavar='var=value', action='append', help='set a specific environment variable')
 565     group1.add_argument('--cfg', metavar='arg', action='append', help='add parameter --cfg=arg to each command line')
 566     group1.add_argument('--log', metavar='arg', action='append', help='add parameter --log=arg to each command line')
 567     group1.add_argument(
 568         '--ignore-jenkins',
 569         action='store_true',
 570         help='ignore all cruft generated on SimGrid continuous integration servers')
 571     group1.add_argument(
 572         '--no-auto-valgrind',
 573         action='store_true',
 574         help='do not automaticall launch segfaulting commands in valgrind')
 575     group1.add_argument('--wrapper', metavar='arg', help='Run each command in the provided wrapper (eg valgrind)')
 576     group1.add_argument(
 577         '--keep',
 578         action='store_true',
 579         help='Keep the obtained output when it does not match the expected one')
 580
 581     options = parser.parse_args()
 582
 583     if options.cd is not None:
 584         print("[Tesh/INFO] change directory to " + options.cd)
 585         os.chdir(options.cd)
 586
 587     if options.ignore_jenkins:
 588         print("Ignore all cruft seen on SimGrid's continuous integration servers")
 589         # Note: regexps should match at the beginning of lines
 590         TeshState().ignore_regexps_common = [
 591             re.compile(r"profiling:"),
 592             re.compile(r"Unable to clean temporary file C:"),
 593             re.compile(r".*Configuration change: Set 'contexts/"),
 594             re.compile(r"==[0-9]+== ?WARNING: ASan doesn't fully support"),
 595             re.compile(r"==[0-9]+== ?WARNING: ASan is ignoring requested __asan_handle_no_return: stack "),
 596             re.compile(r"False positive error reports may follow"),
 597             re.compile(r"For details see http://code\.google\.com/p/address-sanitizer/issues/detail\?id=189"),
 598             re.compile(r"For details see https://github\.com/google/sanitizers/issues/189"),
 599             re.compile(r"Python runtime initialized with LC_CTYPE=C .*"),
 600             re.compile(r"sthread is intercepting the execution of \.*"),
 601             # Seen on CircleCI
 602             re.compile(r"cmake: /usr/local/lib/libcurl\.so\.4: no version information available \(required by cmake\)"),
 603             re.compile(
 604                 r".*mmap broken on FreeBSD, but dlopen\+thread broken too\. Switching to dlopen\+raw contexts\."),
 605             re.compile(r".*dlopen\+thread broken on Apple and BSD\. Switching to raw contexts\."),
 606         ]
 607         TeshState().jenkins = True  # This is a Jenkins build
 608
 609     if options.no_auto_valgrind:
 610         TeshState().auto_valgrind = False
 611
 612     if options.teshfile is None:
 613         file = FileReader(None)
 614         print("Test suite from stdin")
 615     else:
 616         if not os.path.isfile(options.teshfile):
 617             print("Cannot open teshfile '" + options.teshfile + "': File not found")
 618             tesh_exit(3)
 619         file = FileReader(options.teshfile)
 620         print("Test suite '" + file.abspath + "'")
 621
 622     if options.setenv is not None:
 623         for env in options.setenv:
 624             setenv(env)
 625
 626     if options.cfg is not None:
 627         for cfg in options.cfg:
 628             TeshState().args_suffix += " --cfg=" + cfg
 629     if options.log is not None:
 630         for log in options.log:
 631             TeshState().args_suffix += " --log=" + log
 632
 633     if options.wrapper is not None:
 634         TeshState().wrapper = options.wrapper
 635
 636     if options.keep:
 637         TeshState().keep = True
 638
 639     # cmd holds the current command line
 640     # tech commands will add some parameters to it
 641     # when ready, we execute it.
 642     cmd = Cmd()
 643
 644     line = file.readfullline()
 645     while line is not None:
 646         # print(">>============="+line+"==<<")
 647         if not line:
 648             #print ("END CMD block")
 649             if cmd.run_if_possible():
 650                 cmd = Cmd()
 651
 652         elif line[0] == "#":
 653             pass
 654
 655         elif line[0:2] == "p ":
 656             print("[" + str(FileReader()) + "] " + line[2:])
 657
 658         elif line[0:2] == "< ":
 659             cmd.add_input_pipe(line[2:])
 660         elif line[0:1] == "<":
 661             cmd.add_input_pipe(line[1:])
 662
 663         elif line[0:2] == "> ":
 664             cmd.add_output_pipe_stdout(line[2:])
 665         elif line[0:1] == ">":
 666             cmd.add_output_pipe_stdout(line[1:])
 667
 668         elif line[0:2] == "$ ":
 669             if cmd.run_if_possible():
 670                 cmd = Cmd()
 671             cmd.set_cmd(line[2:], file.linenumber)
 672
 673         elif line[0:2] == "& ":
 674             if cmd.run_if_possible():
 675                 cmd = Cmd()
 676             cmd.set_cmd(line[2:], file.linenumber)
 677             cmd.background = True
 678
 679         elif line[0:15] == "! output ignore":
 680             cmd.ignore_output = True
 681             #print("cmd.ignore_output = True")
 682         elif line[0:16] == "! output display":
 683             cmd.output_display = True
 684             cmd.ignore_output = True
 685         elif line[0:15] == "! expect return":
 686             cmd.expect_return = [int(line[16:])]
 687             #print("expect return "+str(int(line[16:])))
 688         elif line[0:15] == "! expect signal":
 689             cmd.expect_return = []
 690             for sig in (line[16:]).split("|"):
 691                 # get the signal integer value from the signal module
 692                 if sig not in signal.__dict__:
 693                     fatal_error("unrecognized signal '" + sig + "'")
 694                 sig = int(signal.__dict__[sig])
 695                 # popen return -signal when a process ends with a signal
 696                 cmd.expect_return.append(-sig)
 697         elif line[0:len("! timeout ")] == "! timeout ":
 698             if "no" in line[len("! timeout "):]:
 699                 cmd.timeout = None
 700             else:
 701                 cmd.timeout = int(line[len("! timeout "):])
 702
 703         elif line[0:len("! output sort")] == "! output sort":
 704             if len(line) >= len("! output sort "):
 705                 sort = int(line[len("! output sort "):])
 706             else:
 707                 sort = 0
 708             cmd.sort = sort
 709         elif line[0:len("! setenv ")] == "! setenv ":
 710             setenv(line[len("! setenv "):])
 711
 712         elif line[0:len("! ignore ")] == "! ignore ":
 713             cmd.add_ignore(line[len("! ignore "):])
 714
 715         else:
 716             fatal_error(f"UNRECOGNIZED OPTION LINE: {line}\n"
 717             "Valid requests:\n"
 718             "   ! output ignore\n"
 719             "   ! output sort\n"
 720             "   ! output display\n"
 721             "   ! setenv XX=YY\n"
 722             "   ! ignore XYZ\n"
 723             "   ! expect return NN\n"
 724             "   ! expect signal NN\n"
 725             "   ! timeout NN\n")
 726
 727         line = file.readfullline()
 728
 729     cmd.run_if_possible()
 730
 731     TeshState().join_all_threads()
 732
 733     if TeshState().return_code == 0:
 734         if file.filename == "(stdin)":
 735             print("Test suite from stdin OK")
 736         else:
 737             print("Test suite `" + file.filename + "' OK")
 738     tesh_exit(TeshState().return_code)
 739
 740 if __name__ == '__main__':
 741     main()