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.timeout = 10  # default value: 10 sec
 200         self.wrapper = None
 201         self.keep = False
 202         self.return_code = 0
 203
 204     def add_thread(self, thread):
 205         """ Add another thread to wait for """
 206         self.threads.append(thread)
 207
 208     def join_all_threads(self):
 209         """ Wait for all threads """
 210         for thread in self.threads:
 211             thread.acquire()
 212             thread.release()
 213
 214     def set_return_code(self, value):
 215         """ Set exit status """
 216         if value > self.return_code:
 217             self.return_code = value
 218
 219
 220 class Cmd:
 221     """ Command line object """
 222     def __init__(self):
 223         self.input_pipe = []
 224         self.output_pipe_stdout = []
 225         self.output_pipe_stderr = []
 226         self.timeout = TeshState().timeout
 227         self.args = None
 228         self.linenumber = -1
 229
 230         self.background = False
 231         # Python threads loose the cwd
 232         self.cwd = os.getcwd()
 233
 234         self.ignore_output = False
 235         self.expect_return = [0]
 236
 237         self.output_display = False
 238
 239         self.sort = -1
 240         self.rerun_with_valgrind = False
 241
 242         self.ignore_regexps = TeshState().ignore_regexps_common
 243
 244     def add_input_pipe(self, line):
 245         """ Add a line to stdin input """
 246         self.input_pipe.append(line)
 247
 248     def add_output_pipe_stdout(self, line):
 249         """ Add a line to stdout output """
 250         self.output_pipe_stdout.append(line)
 251
 252     def add_output_pipe_stderr(self, line):
 253         """ Add a line to stderr output """
 254         self.output_pipe_stderr.append(line)
 255
 256     def set_cmd(self, args, linenumber):
 257         """ Set command line """
 258         self.args = args
 259         self.linenumber = linenumber
 260
 261     def add_ignore(self, txt):
 262         """ Add regexp to ignore lines """
 263         self.ignore_regexps.append(re.compile(txt))
 264
 265     def remove_ignored_lines(self, lines):
 266         """ Remove ignored lines """
 267         for ign in self.ignore_regexps:
 268             lines = [l for l in lines if not ign.match(l)]
 269         return lines
 270
 271     def _cmd_mkfile(self, argline):
 272         filename = argline[len("mkfile "):]
 273         file = open(filename, "w")
 274         if file is None:
 275             fatal_error("Unable to create file " + filename)
 276         file.write("\n".join(self.input_pipe))
 277         file.write("\n")
 278         file.close()
 279
 280     def _cmd_cd(self, argline): # pylint: disable=no-self-use
 281         args = shlex.split(argline)
 282         if len(args) != 2:
 283             fatal_error("Too many arguments to cd")
 284         try:
 285             os.chdir(args[1])
 286             print("[Tesh/INFO] change directory to " + args[1])
 287         except FileNotFoundError:
 288             print("Chdir to " + args[1] + " failed: No such file or directory")
 289             print("Test suite `" + FileReader().filename + "': NOK (system error)")
 290             tesh_exit(4)
 291
 292     def run_if_possible(self):
 293         """
 294         Run the Cmd if possible.
 295         Return False if nothing has been ran.
 296         """
 297         if not self.can_run():
 298             return False
 299         if self.background:
 300             lock = _thread.allocate_lock()
 301             lock.acquire()
 302             TeshState().add_thread(lock)
 303             _thread.start_new_thread(Cmd._run, (self, lock))
 304         else:
 305             self._run()
 306             if self.rerun_with_valgrind:
 307                 print('\n\n\nXXXXXXXXX Rerunning this test with valgrind to help debugging it XXXXXXXXX')
 308                 print('(this will fail if valgrind is not installed, of course)\n\n\n')
 309
 310                 self.args = "valgrind " + self.args
 311                 self._run()
 312         return True
 313
 314     def _run(self, lock=None):
 315         # Python threads loose the cwd
 316         os.chdir(self.cwd)
 317
 318         # retrocompatibility: support ${aaa:=.} variable format
 319         def replace_perl_variables(arg):
 320             vname = arg.group(1)
 321             vdefault = arg.group(2)
 322             if vname in os.environ:
 323                 return "$" + vname
 324             return vdefault
 325
 326         self.args = re.sub(r"\${(\w+):=([^}]*)}", replace_perl_variables, self.args)
 327
 328         # replace bash environment variables ($THINGS) to their values
 329         self.args = expandvars2(self.args)
 330
 331         if re.match("^mkfile ", self.args) is not None:
 332             self._cmd_mkfile(self.args)
 333             if lock is not None:
 334                 lock.release()
 335             return
 336
 337         if re.match("^cd ", self.args) is not None:
 338             self._cmd_cd(self.args)
 339             if lock is not None:
 340                 lock.release()
 341             return
 342
 343         if TeshState().wrapper is not None:
 344             self.timeout *= 20
 345             self.args = TeshState().wrapper + self.args
 346         elif re.match(".*smpirun.*", self.args) is not None:
 347             self.args = "sh " + self.args
 348         if TeshState().jenkins and self.timeout is not None:
 349             self.timeout *= 10
 350
 351         self.args += TeshState().args_suffix
 352
 353         logs = list()
 354         logs.append("[{file}:{number}] {args}".format(file=FileReader().filename,
 355                                                       number=self.linenumber, args=self.args))
 356
 357         args = shlex.split(self.args)
 358
 359         local_pid = None
 360
 361         try:
 362             preexec_function = lambda: os.setpgid(0, 0)
 363             proc = subprocess.Popen( # pylint: disable=subprocess-popen-preexec-fn
 364                 args,
 365                 bufsize=1,
 366                 stdin=subprocess.PIPE,
 367                 stdout=subprocess.PIPE,
 368                 stderr=subprocess.STDOUT,
 369                 universal_newlines=True,
 370                 preexec_fn=preexec_function)
 371             local_pid = proc.pid
 372             TeshState().running_pids.append(local_pid)
 373         except PermissionError:
 374             logs.append("[{file}:{number}] Cannot start '{cmd}': The binary is not executable.".format(
 375                 file=FileReader().filename, number=self.linenumber, cmd=args[0]))
 376             logs.append("[{file}:{number}] Current dir: {dir}".format(file=FileReader().filename,
 377                                                                       number=self.linenumber, dir=os.getcwd()))
 378             TeshState().set_return_code(3)
 379             print('\n'.join(logs))
 380             return
 381         except NotADirectoryError:
 382             logs.append("[{file}:{number}] Cannot start '{cmd}': The path to binary does not exist.".format(
 383                 file=FileReader().filename, number=self.linenumber, cmd=args[0]))
 384             logs.append("[{file}:{number}] Current dir: {dir}".format(file=FileReader().filename,
 385                                                                       number=self.linenumber, dir=os.getcwd()))
 386             TeshState().set_return_code(3)
 387             print('\n'.join(logs))
 388             return
 389         except FileNotFoundError:
 390             logs.append("[{file}:{number}] Cannot start '{cmd}': File not found.".format(
 391                 file=FileReader().filename, number=self.linenumber, cmd=args[0]))
 392             TeshState().set_return_code(3)
 393             print('\n'.join(logs))
 394             return
 395         except OSError as err:
 396             if err.errno == 8:
 397                 err.strerror += \
 398                     "\nOSError: [Errno 8] Executed scripts should start with shebang line (like #!/usr/bin/env sh)"
 399             raise err
 400
 401         cmd_name = FileReader().filename + ":" + str(self.linenumber)
 402         try:
 403             (stdout_data, _stderr_data) = proc.communicate("\n".join(self.input_pipe), self.timeout)
 404             timeout_reached = False
 405         except subprocess.TimeoutExpired:
 406             timeout_reached = True
 407             logs.append("Test suite `{file}': NOK (<{cmd}> timeout after {timeout} sec)".format(
 408                 file=FileReader().filename, cmd=cmd_name, timeout=self.timeout))
 409             TeshState().running_pids.remove(local_pid)
 410             kill_process_group(local_pid)
 411             # Try to get the output of the timeout process, to help in debugging.
 412             try:
 413                 (stdout_data, _stderr_data) = proc.communicate(timeout=1)
 414             except subprocess.TimeoutExpired:
 415                 logs.append("[{file}:{number}] Could not retrieve output. Killing the process group failed?".format(
 416                     file=FileReader().filename, number=self.linenumber))
 417                 TeshState().set_return_code(3)
 418                 print('\n'.join(logs))
 419                 return
 420
 421         if self.output_display:
 422             logs.append(str(stdout_data))
 423
 424         # remove text colors
 425         ansi_escape = re.compile(r'\x1b[^m]*m')
 426         stdout_data = ansi_escape.sub('', stdout_data)
 427
 428         if self.ignore_output:
 429             logs.append("(ignoring the output of <{cmd}> as requested)".format(cmd=cmd_name))
 430         else:
 431             stdouta = stdout_data.split("\n")
 432             stdouta = self.remove_ignored_lines(stdouta)
 433             while stdouta and stdouta[-1] == "":
 434                 del stdouta[-1]
 435             stdcpy = stdouta[:]
 436
 437             # Mimic the "sort" bash command, which is case unsensitive.
 438             if self.sort == 0:
 439                 stdouta.sort(key=lambda x: x.lower())
 440                 self.output_pipe_stdout.sort(key=lambda x: x.lower())
 441             elif self.sort > 0:
 442                 stdouta.sort(key=lambda x: x[:self.sort].lower())
 443                 self.output_pipe_stdout.sort(key=lambda x: x[:self.sort].lower())
 444
 445             diff = list(
 446                 difflib.unified_diff(
 447                     self.output_pipe_stdout,
 448                     stdouta,
 449                     lineterm="",
 450                     fromfile='expected',
 451                     tofile='obtained'))
 452             if diff:
 453                 logs.append("Output of <{cmd}> mismatch:".format(cmd=cmd_name))
 454                 if self.sort >= 0:  # If sorted, truncate the diff output and show the unsorted version
 455                     difflen = 0
 456                     for line in diff:
 457                         if difflen < 50:
 458                             print(line)
 459                         difflen += 1
 460                     if difflen > 50:
 461                         logs.append("(diff truncated after 50 lines)")
 462                     logs.append("Unsorted observed output:\n")
 463                     for line in stdcpy:
 464                         logs.append(line)
 465                 else:  # If not sorted, just display the diff
 466                     for line in diff:
 467                         logs.append(line)
 468
 469                 logs.append("Test suite `{file}': NOK (<{cmd}> output mismatch)".format(
 470                     file=FileReader().filename, cmd=cmd_name))
 471
 472                 # Also report any failed return code and/or signal we got in case of output mismatch
 473                 if not proc.returncode in self.expect_return:
 474                     if proc.returncode >= 0:
 475                         logs.append("In addition, <{cmd}> returned code {code}.".format(
 476                             cmd=cmd_name, code=proc.returncode))
 477                     else:
 478                         logs.append("In addition, <{cmd}> got signal {sig}.".format(cmd=cmd_name,
 479                             sig=SIGNALS_TO_NAMES_DICT[-proc.returncode]))
 480                     if proc.returncode == -signal.SIGSEGV:
 481                         self.rerun_with_valgrind = True
 482
 483                 if lock is not None:
 484                     lock.release()
 485                 if TeshState().keep:
 486                     file = open('obtained', 'w')
 487                     obtained = stdout_data.split("\n")
 488                     while obtained and obtained[-1] == "":
 489                         del obtained[-1]
 490                     obtained = self.remove_ignored_lines(obtained)
 491                     for line in obtained:
 492                         file.write("> " + line + "\n")
 493                     file.close()
 494                     logs.append("Obtained output kept as requested: {path}".format(path=os.path.abspath("obtained")))
 495                 TeshState().set_return_code(2)
 496                 print('\n'.join(logs))
 497                 return
 498
 499         if timeout_reached:
 500             TeshState().set_return_code(3)
 501             print('\n'.join(logs))
 502             return
 503
 504         if not proc.returncode in self.expect_return:
 505             if proc.returncode >= 0:
 506                 logs.append("Test suite `{file}': NOK (<{cmd}> returned code {code})".format(
 507                     file=FileReader().filename, cmd=cmd_name, code=proc.returncode))
 508                 if lock is not None:
 509                     lock.release()
 510                 TeshState().set_return_code(2)
 511                 print('\n'.join(logs))
 512                 return
 513
 514             logs.append("Test suite `{file}': NOK (<{cmd}> got signal {sig})".format(
 515                 file=FileReader().filename, cmd=cmd_name,
 516                 sig=SIGNALS_TO_NAMES_DICT[-proc.returncode]))
 517
 518             if proc.returncode == -signal.SIGSEGV:
 519                 self.rerun_with_valgrind = True
 520
 521             if lock is not None:
 522                 lock.release()
 523             TeshState().set_return_code(max(-proc.returncode, 1))
 524             print('\n'.join(logs))
 525             return
 526
 527         if lock is not None:
 528             lock.release()
 529
 530         print('\n'.join(logs))
 531
 532     def can_run(self):
 533         """ Check if ready to run """
 534         return self.args is not None
 535
 536 ##############
 537 #
 538 # Main
 539 #
 540 #
 541
 542 def main():
 543     """ main function """
 544     signal.signal(signal.SIGINT, signal_handler)
 545     signal.signal(signal.SIGTERM, signal_handler)
 546
 547     parser = argparse.ArgumentParser(description='tesh -- testing shell')
 548     group1 = parser.add_argument_group('Options')
 549     group1.add_argument('teshfile', nargs='?', help='Name of teshfile, stdin if omitted')
 550     group1.add_argument(
 551         '--cd',
 552         metavar='some/directory',
 553         help='ask tesh to switch the working directory before launching the tests')
 554     group1.add_argument('--setenv', metavar='var=value', action='append', help='set a specific environment variable')
 555     group1.add_argument('--cfg', metavar='arg', action='append', help='add parameter --cfg=arg to each command line')
 556     group1.add_argument('--log', metavar='arg', action='append', help='add parameter --log=arg to each command line')
 557     group1.add_argument(
 558         '--ignore-jenkins',
 559         action='store_true',
 560         help='ignore all cruft generated on SimGrid continuous integration servers')
 561     group1.add_argument('--wrapper', metavar='arg', help='Run each command in the provided wrapper (eg valgrind)')
 562     group1.add_argument(
 563         '--keep',
 564         action='store_true',
 565         help='Keep the obtained output when it does not match the expected one')
 566
 567     options = parser.parse_args()
 568
 569     if options.cd is not None:
 570         print("[Tesh/INFO] change directory to " + options.cd)
 571         os.chdir(options.cd)
 572
 573     if options.ignore_jenkins:
 574         print("Ignore all cruft seen on SimGrid's continuous integration servers")
 575         # Note: regexps should match at the beginning of lines
 576         TeshState().ignore_regexps_common = [
 577             re.compile(r"profiling:"),
 578             re.compile(r"Unable to clean temporary file C:"),
 579             re.compile(r".*Configuration change: Set 'contexts/"),
 580             re.compile(r"==[0-9]+== ?WARNING: ASan doesn't fully support"),
 581             re.compile(r"==[0-9]+== ?WARNING: ASan is ignoring requested __asan_handle_no_return: stack "),
 582             re.compile(r"False positive error reports may follow"),
 583             re.compile(r"For details see http://code\.google\.com/p/address-sanitizer/issues/detail\?id=189"),
 584             re.compile(r"For details see https://github\.com/google/sanitizers/issues/189"),
 585             re.compile(r"Python runtime initialized with LC_CTYPE=C .*"),
 586             # Seen on CircleCI
 587             re.compile(r"cmake: /usr/local/lib/libcurl\.so\.4: no version information available \(required by cmake\)"),
 588             re.compile(
 589                 r".*mmap broken on FreeBSD, but dlopen\+thread broken too\. Switching to dlopen\+raw contexts\."),
 590             re.compile(r".*dlopen\+thread broken on Apple and BSD\. Switching to raw contexts\."),
 591         ]
 592         TeshState().jenkins = True  # This is a Jenkins build
 593
 594     if options.teshfile is None:
 595         file = FileReader(None)
 596         print("Test suite from stdin")
 597     else:
 598         if not os.path.isfile(options.teshfile):
 599             print("Cannot open teshfile '" + options.teshfile + "': File not found")
 600             tesh_exit(3)
 601         file = FileReader(options.teshfile)
 602         print("Test suite '" + file.abspath + "'")
 603
 604     if options.setenv is not None:
 605         for env in options.setenv:
 606             setenv(env)
 607
 608     if options.cfg is not None:
 609         for cfg in options.cfg:
 610             TeshState().args_suffix += " --cfg=" + cfg
 611     if options.log is not None:
 612         for log in options.log:
 613             TeshState().args_suffix += " --log=" + log
 614
 615     if options.wrapper is not None:
 616         TeshState().wrapper = options.wrapper
 617
 618     if options.keep:
 619         TeshState().keep = True
 620
 621     # cmd holds the current command line
 622     # tech commands will add some parameters to it
 623     # when ready, we execute it.
 624     cmd = Cmd()
 625
 626     line = file.readfullline()
 627     while line is not None:
 628         # print(">>============="+line+"==<<")
 629         if not line:
 630             #print ("END CMD block")
 631             if cmd.run_if_possible():
 632                 cmd = Cmd()
 633
 634         elif line[0] == "#":
 635             pass
 636
 637         elif line[0:2] == "p ":
 638             print("[" + str(FileReader()) + "] " + line[2:])
 639
 640         elif line[0:2] == "< ":
 641             cmd.add_input_pipe(line[2:])
 642         elif line[0:1] == "<":
 643             cmd.add_input_pipe(line[1:])
 644
 645         elif line[0:2] == "> ":
 646             cmd.add_output_pipe_stdout(line[2:])
 647         elif line[0:1] == ">":
 648             cmd.add_output_pipe_stdout(line[1:])
 649
 650         elif line[0:2] == "$ ":
 651             if cmd.run_if_possible():
 652                 cmd = Cmd()
 653             cmd.set_cmd(line[2:], file.linenumber)
 654
 655         elif line[0:2] == "& ":
 656             if cmd.run_if_possible():
 657                 cmd = Cmd()
 658             cmd.set_cmd(line[2:], file.linenumber)
 659             cmd.background = True
 660
 661         elif line[0:15] == "! output ignore":
 662             cmd.ignore_output = True
 663             #print("cmd.ignore_output = True")
 664         elif line[0:16] == "! output display":
 665             cmd.output_display = True
 666             cmd.ignore_output = True
 667         elif line[0:15] == "! expect return":
 668             cmd.expect_return = [int(line[16:])]
 669             #print("expect return "+str(int(line[16:])))
 670         elif line[0:15] == "! expect signal":
 671             cmd.expect_return = []
 672             for sig in (line[16:]).split("|"):
 673                 # get the signal integer value from the signal module
 674                 if sig not in signal.__dict__:
 675                     fatal_error("unrecognized signal '" + sig + "'")
 676                 sig = int(signal.__dict__[sig])
 677                 # popen return -signal when a process ends with a signal
 678                 cmd.expect_return.append(-sig)
 679         elif line[0:len("! timeout ")] == "! timeout ":
 680             if "no" in line[len("! timeout "):]:
 681                 cmd.timeout = None
 682             else:
 683                 cmd.timeout = int(line[len("! timeout "):])
 684
 685         elif line[0:len("! output sort")] == "! output sort":
 686             if len(line) >= len("! output sort "):
 687                 sort = int(line[len("! output sort "):])
 688             else:
 689                 sort = 0
 690             cmd.sort = sort
 691         elif line[0:len("! setenv ")] == "! setenv ":
 692             setenv(line[len("! setenv "):])
 693
 694         elif line[0:len("! ignore ")] == "! ignore ":
 695             cmd.add_ignore(line[len("! ignore "):])
 696
 697         else:
 698             fatal_error(f"UNRECOGNIZED OPTION LINE: {line}")
 699
 700         line = file.readfullline()
 701
 702     cmd.run_if_possible()
 703
 704     TeshState().join_all_threads()
 705
 706     if TeshState().return_code == 0:
 707         if file.filename == "(stdin)":
 708             print("Test suite from stdin OK")
 709         else:
 710             print("Test suite `" + file.filename + "' OK")
 711     tesh_exit(TeshState().return_code)
 712
 713 if __name__ == '__main__':
 714     main()