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