Step 0 of Make-a-Lisp for Erlang
[jackhill/mal.git] / runtest.py
index 8a3f26d..436b769 100755 (executable)
@@ -1,13 +1,20 @@
 #!/usr/bin/env python
 
 import os, sys, re
-import argparse
+import argparse, time
+import signal, atexit
 
-# http://pexpect.sourceforge.net/pexpect.html
-from pexpect import spawn, EOF, TIMEOUT
+from subprocess import Popen, STDOUT, PIPE
+from select import select
+
+# Pseudo-TTY and terminal manipulation
+import pty, array, fcntl, termios
+
+IS_PY_3 = sys.version_info[0] == 3
 
 # TODO: do we need to support '\n' too
 sep = "\r\n"
+#sep = "\n"
 rundir = None
 
 parser = argparse.ArgumentParser(
@@ -18,8 +25,10 @@ parser.add_argument('--start-timeout', default=10, type=int,
         help="default timeout for initial prompt")
 parser.add_argument('--test-timeout', default=20, type=int,
         help="default timeout for each individual test action")
-parser.add_argument('--redirect', action='store_true',
-        help="Run implementation in bash and redirect output to /dev/null")
+parser.add_argument('--pre-eval', default=None, type=str,
+        help="Mal code to evaluate prior to running the test")
+parser.add_argument('--no-pty', action='store_true',
+        help="Use direct pipes instead of pseudo-tty")
 
 parser.add_argument('test_file', type=argparse.FileType('r'),
         help="a test file formatted as with mal test data")
@@ -27,16 +36,95 @@ parser.add_argument('mal_cmd', nargs="*",
         help="Mal implementation command line. Use '--' to "
              "specify a Mal command line with dashed options.")
 
+class Runner():
+    def __init__(self, args, no_pty=False):
+        #print "args: %s" % repr(args)
+        self.no_pty = no_pty
+
+        # Cleanup child process on exit
+        atexit.register(self.cleanup)
+
+        self.p = None
+        env = os.environ
+        env['TERM'] = 'dumb'
+        env['INPUTRC'] = '/dev/null'
+        env['PERL_RL'] = 'false'
+        if no_pty:
+            self.p = Popen(args, bufsize=0,
+                           stdin=PIPE, stdout=PIPE, stderr=STDOUT,
+                           preexec_fn=os.setsid,
+                           env=env)
+            self.stdin = self.p.stdin
+            self.stdout = self.p.stdout
+        else:
+            # provide tty to get 'interactive' readline to work
+            master, slave = pty.openpty()
+
+            # Set terminal size large so that readline will not send
+            # ANSI/VT escape codes when the lines are long.
+            buf = array.array('h', [100, 200, 0, 0])
+            fcntl.ioctl(master, termios.TIOCSWINSZ, buf, True)
+
+            self.p = Popen(args, bufsize=0,
+                           stdin=slave, stdout=slave, stderr=STDOUT,
+                           preexec_fn=os.setsid,
+                           env=env)
+            # Now close slave so that we will get an exception from
+            # read when the child exits early
+            # http://stackoverflow.com/questions/11165521
+            os.close(slave)
+            self.stdin = os.fdopen(master, 'r+b', 0)
+            self.stdout = self.stdin
+
+        #print "started"
+        self.buf = ""
+        self.last_prompt = ""
+
+    def read_to_prompt(self, prompts, timeout):
+        end_time = time.time() + timeout
+        while time.time() < end_time:
+            [outs,_,_] = select([self.stdout], [], [], 1)
+            if self.stdout in outs:
+                new_data = self.stdout.read(1)
+                new_data = new_data.decode("utf-8") if IS_PY_3 else new_data
+                #print "new_data: '%s'" % new_data
+                if self.no_pty:
+                    self.buf += new_data.replace("\n", "\r\n")
+                else:
+                    self.buf += new_data
+                for prompt in prompts:
+                    regexp = re.compile(prompt)
+                    match = regexp.search(self.buf)
+                    if match:
+                        end = match.end()
+                        buf = self.buf[0:end-len(prompt)]
+                        self.buf = self.buf[end:]
+                        self.last_prompt = prompt
+                        return buf
+        return None
+
+    def writeline(self, str):
+        def _to_bytes(s):
+            return bytes(s, "utf-8") if IS_PY_3 else s
+
+        self.stdin.write(_to_bytes(str + "\n"))
+
+    def cleanup(self):
+        #print "cleaning up"
+        if self.p:
+            try:
+                os.killpg(self.p.pid, signal.SIGTERM)
+            except OSError:
+                pass
+            self.p = None
+
+
 args = parser.parse_args(sys.argv[1:])
 test_data = args.test_file.read().split('\n')
 
 if args.rundir: os.chdir(args.rundir)
 
-if args.redirect:
-    # Redirect to try and force raw mode (no ASCII codes)
-    p = spawn('/bin/bash -c "' + " ".join(args.mal_cmd) + ' |tee /dev/null"')
-else:
-    p = spawn(args.mal_cmd[0], args.mal_cmd[1:])
+r = Runner(args.mal_cmd, no_pty=args.no_pty)
 
 
 test_idx = 0
@@ -51,10 +139,10 @@ def read_test(data):
         elif line[0:3] == ";;;":       # ignore comment
             continue
         elif line[0:2] == ";;":        # output comment
-            print line[3:]
+            print(line[3:])
             continue
         elif line[0:2] == ";":         # unexpected comment
-            print "Test data error at line %d:\n%s" % (test_idx, line)
+            print("Test data error at line %d:\n%s" % (test_idx, line))
             return None, None, None, test_idx
         form = line   # the line is a form to send
 
@@ -77,14 +165,26 @@ def read_test(data):
 
     return form, output, ret, test_idx
 
+def assert_prompt(timeout):
+    # Wait for the initial prompt
+    header = r.read_to_prompt(['user> ', 'mal-user> '], timeout=timeout)
+    if not header == None:
+        if header:
+            print("Started with:\n%s" % header)
+    else:
+        print("Did not get 'user> ' or 'mal-user> ' prompt")
+        print("    Got      : %s" % repr(r.buf))
+        sys.exit(1)
+
 
 # Wait for the initial prompt
-idx = p.expect(['user> ', 'mal-user> ', EOF, TIMEOUT],
-               timeout=args.start_timeout)
-if idx not in [0,1]:
-    print "Never got 'user> ' prompt"
-    print "    Got      : %s" % repr(p.before)
-    sys.exit(1)
+assert_prompt(args.start_timeout)
+
+# Send the pre-eval code if any
+if args.pre_eval:
+    sys.stdout.write("RUNNING pre-eval: %s" % args.pre_eval)
+    p.write(args.pre_eval)
+    assert_prompt(args.test_timeout)
 
 fail_cnt = 0
 
@@ -94,29 +194,33 @@ while test_data:
         break
     sys.stdout.write("TEST: %s -> [%s,%s]" % (form, repr(out), repr(ret)))
     sys.stdout.flush()
-    expected = "%s%s%s%s" % (form, sep, out, ret)
 
-    p.sendline(form)
+    # The repeated form is to get around an occasional OS X issue
+    # where the form is repeated.
+    # https://github.com/kanaka/mal/issues/30
+    expected = ["%s%s%s%s" % (form, sep, out, ret),
+                "%s%s%s%s%s%s" % (form, sep, form, sep, out, ret)]
+
+    r.writeline(form)
     try:
-        idx = p.expect(['\r\nuser> ', '\nuser> ',
-                        '\r\nmal-user> ', '\nmal-user> '],
-                       timeout=args.test_timeout)
+        res = r.read_to_prompt(['\r\nuser> ', '\nuser> ',
+                                '\r\nmal-user> ', '\nmal-user> '],
+                                timeout=args.test_timeout)
         #print "%s,%s,%s" % (idx, repr(p.before), repr(p.after))
-        if ret == "*" or p.before == expected:
-            print " -> SUCCESS"
+        if ret == "*" or res in expected:
+            print(" -> SUCCESS")
         else:
-            print " -> FAIL (line %d):" % line_num
-            print "    Expected : %s" % repr(expected)
-            print "    Got      : %s" % repr(p.before)
+            print(" -> FAIL (line %d):" % line_num)
+            print("    Expected : %s" % repr(expected))
+            print("    Got      : %s" % repr(res))
             fail_cnt += 1
-    except EOF:
-        print "Got EOF"
-        sys.exit(1)
-    except TIMEOUT:
-        print "Got TIMEOUT, received: %s" % repr(p.before)
+    except:
+        _, exc, _ = sys.exc_info()
+        print("\nException: %s" % repr(exc))
+        print("Output before exception:\n%s" % r.buf)
         sys.exit(1)
 
 if fail_cnt > 0:
-    print "FAILURES: %d" % fail_cnt
+    print("FAILURES: %d" % fail_cnt)
     sys.exit(2)
 sys.exit(0)