runtest.py

   1 #!/usr/bin/env python
   2
   3 from __future__ import print_function
   4 import os, sys, re
   5 import argparse, time
   6 import signal, atexit
   7
   8 from subprocess import Popen, STDOUT, PIPE
   9 from select import select
  10
  11 # Pseudo-TTY and terminal manipulation
  12 import pty, array, fcntl, termios
  13
  14 IS_PY_3 = sys.version_info[0] == 3
  15
  16 debug_file = None
  17 log_file = None
  18
  19 def debug(data):
  20     if debug_file:
  21         debug_file.write(data)
  22         debug_file.flush()
  23
  24 def log(data, end='\n'):
  25     if log_file:
  26         log_file.write(data + end)
  27         log_file.flush()
  28     print(data, end=end)
  29     sys.stdout.flush()
  30
  31 # TODO: do we need to support '\n' too
  32 import platform
  33 if platform.system().find("CYGWIN_NT") >= 0:
  34     # TODO: this is weird, is this really right on Cygwin?
  35     sep = "\n\r\n"
  36 else:
  37     sep = "\r\n"
  38 rundir = None
  39
  40 parser = argparse.ArgumentParser(
  41         description="Run a test file against a Mal implementation")
  42 parser.add_argument('--rundir',
  43         help="change to the directory before running tests")
  44 parser.add_argument('--start-timeout', default=10, type=int,
  45         help="default timeout for initial prompt")
  46 parser.add_argument('--test-timeout', default=20, type=int,
  47         help="default timeout for each individual test action")
  48 parser.add_argument('--pre-eval', default=None, type=str,
  49         help="Mal code to evaluate prior to running the test")
  50 parser.add_argument('--no-pty', action='store_true',
  51         help="Use direct pipes instead of pseudo-tty")
  52 parser.add_argument('--log-file', type=str,
  53         help="Write messages to the named file in addition the screen")
  54 parser.add_argument('--debug-file', type=str,
  55         help="Write all test interaction the named file")
  56 parser.add_argument('--hard', action='store_true',
  57         help="Turn soft tests following a ';>>> soft=True' into hard failures")
  58
  59 # Control whether deferrable and optional tests are executed
  60 parser.add_argument('--deferrable', dest='deferrable', action='store_true',
  61         help="Enable deferrable tests that follow a ';>>> deferrable=True'")
  62 parser.add_argument('--no-deferrable', dest='deferrable', action='store_false',
  63         help="Disable deferrable tests that follow a ';>>> deferrable=True'")
  64 parser.set_defaults(deferrable=True)
  65 parser.add_argument('--optional', dest='optional', action='store_true',
  66         help="Enable optional tests that follow a ';>>> optional=True'")
  67 parser.add_argument('--no-optional', dest='optional', action='store_false',
  68         help="Disable optional tests that follow a ';>>> optional=True'")
  69 parser.set_defaults(optional=True)
  70
  71 parser.add_argument('test_file', type=argparse.FileType('r'),
  72         help="a test file formatted as with mal test data")
  73 parser.add_argument('mal_cmd', nargs="*",
  74         help="Mal implementation command line. Use '--' to "
  75              "specify a Mal command line with dashed options.")
  76
  77 class Runner():
  78     def __init__(self, args, no_pty=False):
  79         #print "args: %s" % repr(args)
  80         self.no_pty = no_pty
  81
  82         # Cleanup child process on exit
  83         atexit.register(self.cleanup)
  84
  85         self.p = None
  86         env = os.environ
  87         env['TERM'] = 'dumb'
  88         env['INPUTRC'] = '/dev/null'
  89         env['PERL_RL'] = 'false'
  90         if no_pty:
  91             self.p = Popen(args, bufsize=0,
  92                            stdin=PIPE, stdout=PIPE, stderr=STDOUT,
  93                            preexec_fn=os.setsid,
  94                            env=env)
  95             self.stdin = self.p.stdin
  96             self.stdout = self.p.stdout
  97         else:
  98             # provide tty to get 'interactive' readline to work
  99             master, slave = pty.openpty()
 100
 101             # Set terminal size large so that readline will not send
 102             # ANSI/VT escape codes when the lines are long.
 103             buf = array.array('h', [100, 200, 0, 0])
 104             fcntl.ioctl(master, termios.TIOCSWINSZ, buf, True)
 105
 106             self.p = Popen(args, bufsize=0,
 107                            stdin=slave, stdout=slave, stderr=STDOUT,
 108                            preexec_fn=os.setsid,
 109                            env=env)
 110             # Now close slave so that we will get an exception from
 111             # read when the child exits early
 112             # http://stackoverflow.com/questions/11165521
 113             os.close(slave)
 114             self.stdin = os.fdopen(master, 'r+b', 0)
 115             self.stdout = self.stdin
 116
 117         #print "started"
 118         self.buf = ""
 119         self.last_prompt = ""
 120
 121     def read_to_prompt(self, prompts, timeout):
 122         end_time = time.time() + timeout
 123         while time.time() < end_time:
 124             [outs,_,_] = select([self.stdout], [], [], 1)
 125             if self.stdout in outs:
 126                 new_data = self.stdout.read(1)
 127                 new_data = new_data.decode("utf-8") if IS_PY_3 else new_data
 128                 #print("new_data: '%s'" % new_data)
 129                 debug(new_data)
 130                 if self.no_pty:
 131                     self.buf += new_data.replace("\n", "\r\n")
 132                 else:
 133                     self.buf += new_data
 134                 self.buf = self.buf.replace("\r\r", "\r")
 135                 for prompt in prompts:
 136                     regexp = re.compile(prompt)
 137                     match = regexp.search(self.buf)
 138                     if match:
 139                         end = match.end()
 140                         buf = self.buf[0:end-len(prompt)]
 141                         self.buf = self.buf[end:]
 142                         self.last_prompt = prompt
 143                         return buf
 144         return None
 145
 146     def writeline(self, str):
 147         def _to_bytes(s):
 148             return bytes(s, "utf-8") if IS_PY_3 else s
 149
 150         self.stdin.write(_to_bytes(str + "\n"))
 151
 152     def cleanup(self):
 153         #print "cleaning up"
 154         if self.p:
 155             try:
 156                 os.killpg(self.p.pid, signal.SIGTERM)
 157             except OSError:
 158                 pass
 159             self.p = None
 160
 161 class TestReader:
 162     def __init__(self, test_file):
 163         self.line_num = 0
 164         self.data = test_file.read().split('\n')
 165         self.soft = False
 166         self.deferrable = False
 167         self.optional = False
 168
 169     def next(self):
 170         self.msg = None
 171         self.form = None
 172         self.out = ""
 173         self.ret = None
 174
 175         while self.data:
 176             self.line_num += 1
 177             line = self.data.pop(0)
 178             if re.match(r"^\s*$", line):   # blank line
 179                 continue
 180             elif line[0:3] == ";;;":       # ignore comment
 181                 continue
 182             elif line[0:2] == ";;":        # output comment
 183                 self.msg = line[3:]
 184                 return True
 185             elif line[0:5] == ";>>> ":     # settings/commands
 186                 settings = {}
 187                 exec(line[5:], {}, settings)
 188                 if 'soft' in settings:
 189                     self.soft = settings['soft']
 190                 if 'deferrable' in settings and settings['deferrable']:
 191                     self.deferrable = "\nSkipping deferrable and optional tests"
 192                     return True
 193                 if 'optional' in settings and settings['optional']:
 194                     self.optional = "\nSkipping optional tests"
 195                     return True
 196                 continue
 197             elif line[0:1] == ";":         # unexpected comment
 198                 log("Test data error at line %d:\n%s" % (self.line_num, line))
 199                 return None
 200             self.form = line   # the line is a form to send
 201
 202             # Now find the output and return value
 203             while self.data:
 204                 line = self.data[0]
 205                 if line[0:3] == ";=>":
 206                     self.ret = line[3:]
 207                     self.line_num += 1
 208                     self.data.pop(0)
 209                     break
 210                 elif line[0:2] == "; ":
 211                     self.out = self.out + line[2:] + sep
 212                     self.line_num += 1
 213                     self.data.pop(0)
 214                 else:
 215                     self.ret = "*"
 216                     break
 217             if self.ret: break
 218
 219         return self.form
 220
 221 args = parser.parse_args(sys.argv[1:])
 222 # Workaround argparse issue with two '--' on command line
 223 if sys.argv.count('--') > 0:
 224     args.mal_cmd = sys.argv[sys.argv.index('--')+1:]
 225
 226 if args.rundir: os.chdir(args.rundir)
 227
 228 if args.log_file:   log_file   = open(args.log_file, "a")
 229 if args.debug_file: debug_file = open(args.debug_file, "a")
 230
 231 r = Runner(args.mal_cmd, no_pty=args.no_pty)
 232 t = TestReader(args.test_file)
 233
 234
 235 def assert_prompt(runner, prompts, timeout):
 236     # Wait for the initial prompt
 237     header = runner.read_to_prompt(prompts, timeout=timeout)
 238     if not header == None:
 239         if header:
 240             log("Started with:\n%s" % header)
 241     else:
 242         log("Did not one of following prompt(s): %s" % repr(prompts))
 243         log("    Got      : %s" % repr(r.buf))
 244         sys.exit(1)
 245
 246
 247 # Wait for the initial prompt
 248 try:
 249     assert_prompt(r, ['user> ', 'mal-user> '], args.start_timeout)
 250 except:
 251     _, exc, _ = sys.exc_info()
 252     log("\nException: %s" % repr(exc))
 253     log("Output before exception:\n%s" % r.buf)
 254     sys.exit(1)
 255
 256 # Send the pre-eval code if any
 257 if args.pre_eval:
 258     sys.stdout.write("RUNNING pre-eval: %s" % args.pre_eval)
 259     p.write(args.pre_eval)
 260     assert_prompt(args.test_timeout)
 261
 262 test_cnt = 0
 263 pass_cnt = 0
 264 fail_cnt = 0
 265 soft_fail_cnt = 0
 266 failures = []
 267
 268 while t.next():
 269     if args.deferrable == False and t.deferrable:
 270         log(t.deferrable)
 271         break
 272
 273     if args.optional == False and t.optional:
 274         log(t.optional)
 275         break
 276
 277     if t.msg != None:
 278         log(t.msg)
 279         continue
 280
 281     if t.form == None: continue
 282
 283     log("TEST: %s -> [%s,%s]" % (t.form, repr(t.out), t.ret), end='')
 284
 285     # The repeated form is to get around an occasional OS X issue
 286     # where the form is repeated.
 287     # https://github.com/kanaka/mal/issues/30
 288     expected = ["%s%s%s%s" % (t.form, sep, t.out, t.ret),
 289                 "%s%s%s%s%s%s" % (t.form, sep, t.form, sep, t.out, t.ret)]
 290
 291     r.writeline(t.form)
 292     try:
 293         test_cnt += 1
 294         res = r.read_to_prompt(['\r\nuser> ', '\nuser> ',
 295                                 '\r\nmal-user> ', '\nmal-user> '],
 296                                 timeout=args.test_timeout)
 297         #print "%s,%s,%s" % (idx, repr(p.before), repr(p.after))
 298         if t.ret == "*" or res in expected:
 299             log(" -> SUCCESS")
 300             pass_cnt += 1
 301         else:
 302             if t.soft and not args.hard:
 303                 log(" -> SOFT FAIL (line %d):" % t.line_num)
 304                 soft_fail_cnt += 1
 305                 fail_type = "SOFT "
 306             else:
 307                 log(" -> FAIL (line %d):" % t.line_num)
 308                 fail_cnt += 1
 309                 fail_type = ""
 310             log("    Expected : %s" % repr(expected[0]))
 311             log("    Got      : %s" % repr(res))
 312             failed_test = """%sFAILED TEST (line %d): %s -> [%s,%s]:
 313     Expected : %s
 314     Got      : %s""" % (fail_type, t.line_num, t.form, repr(t.out), t.ret, repr(expected[0]), repr(res))
 315             failures.append(failed_test)
 316     except:
 317         _, exc, _ = sys.exc_info()
 318         log("\nException: %s" % repr(exc))
 319         log("Output before exception:\n%s" % r.buf)
 320         sys.exit(1)
 321
 322 if len(failures) > 0:
 323     log("\nFAILURES:")
 324     for f in failures:
 325         log(f)
 326
 327 results = """
 328 TEST RESULTS (for %s):
 329   %3d: soft failing tests
 330   %3d: failing tests
 331   %3d: passing tests
 332   %3d: total tests
 333 """ % (args.test_file.name, soft_fail_cnt, fail_cnt,
 334         pass_cnt, test_cnt)
 335 log(results)
 336
 337 debug("\n") # add some separate to debug log
 338
 339 if fail_cnt > 0:
 340     sys.exit(1)
 341 sys.exit(0)