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 | 31 | # TODO: do we need to support '\n' too |
16d5b0c3 JM |
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" | |
31690700 JM |
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") | |
cc021efe JM |
48 | parser.add_argument('--pre-eval', default=None, type=str, |
49 | help="Mal code to evaluate prior to running the test") | |
ab01be18 JM |
50 | parser.add_argument('--no-pty', action='store_true', |
51 | help="Use direct pipes instead of pseudo-tty") | |
5abaa3dc | 52 | parser.add_argument('--log-file', type=str, |
97e27599 JM |
53 | help="Write messages to the named file in addition the screen") |
54 | parser.add_argument('--debug-file', type=str, | |
5abaa3dc | 55 | help="Write all test interaction the named file") |
f3ea3be3 JM |
56 | parser.add_argument('--hard', action='store_true', |
57 | help="Turn soft tests following a ';>>> soft=True' into hard failures") | |
31690700 | 58 | |
a1eb30fc JM |
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) | |
46e25689 JM |
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 | ||
18616b10 | 71 | parser.add_argument('test_file', type=str, |
31690700 JM |
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 | ||
7907cd90 | 77 | class Runner(): |
97e27599 | 78 | def __init__(self, args, no_pty=False): |
612bfe4a | 79 | #print "args: %s" % repr(args) |
ab01be18 | 80 | self.no_pty = no_pty |
612bfe4a JM |
81 | |
82 | # Cleanup child process on exit | |
83 | atexit.register(self.cleanup) | |
84 | ||
8caf6211 JM |
85 | self.p = None |
86 | env = os.environ | |
87 | env['TERM'] = 'dumb' | |
92dcc815 | 88 | env['INPUTRC'] = '/dev/null' |
82acd3de | 89 | env['PERL_RL'] = 'false' |
ab01be18 | 90 | if no_pty: |
612bfe4a JM |
91 | self.p = Popen(args, bufsize=0, |
92 | stdin=PIPE, stdout=PIPE, stderr=STDOUT, | |
8caf6211 JM |
93 | preexec_fn=os.setsid, |
94 | env=env) | |
7907cd90 JM |
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() | |
b3c30da9 JM |
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 | ||
612bfe4a JM |
106 | self.p = Popen(args, bufsize=0, |
107 | stdin=slave, stdout=slave, stderr=STDOUT, | |
8caf6211 JM |
108 | preexec_fn=os.setsid, |
109 | env=env) | |
b020aa3e JM |
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) | |
7907cd90 JM |
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: | |
96deb6a9 JM |
124 | [outs,_,_] = select([self.stdout], [], [], 1) |
125 | if self.stdout in outs: | |
126 | new_data = self.stdout.read(1) | |
8e4628da | 127 | new_data = new_data.decode("utf-8") if IS_PY_3 else new_data |
97e27599 JM |
128 | #print("new_data: '%s'" % new_data) |
129 | debug(new_data) | |
e17aef04 | 130 | # Perform newline cleanup |
ab01be18 | 131 | if self.no_pty: |
9a383535 JM |
132 | self.buf += new_data.replace("\n", "\r\n") |
133 | else: | |
134 | self.buf += new_data | |
0e508fa5 | 135 | self.buf = self.buf.replace("\r\r", "\r") |
9a66ffcd JM |
136 | # Remove ANSI codes generally |
137 | #ansi_escape = re.compile(r'\x1B\[[0-?]*[ -/]*[@-~]') | |
138 | # Remove rustyline ANSI CSI codes: | |
139 | # - [6C - CR + cursor forward | |
140 | # - [6K - CR + erase in line | |
141 | ansi_escape = re.compile(r'\r\x1B\[[0-9]*[CK]') | |
142 | self.buf = ansi_escape.sub('', self.buf) | |
7907cd90 JM |
143 | for prompt in prompts: |
144 | regexp = re.compile(prompt) | |
145 | match = regexp.search(self.buf) | |
146 | if match: | |
147 | end = match.end() | |
96c09dcd | 148 | buf = self.buf[0:match.start()] |
7907cd90 JM |
149 | self.buf = self.buf[end:] |
150 | self.last_prompt = prompt | |
18616b10 | 151 | return buf.replace("^M", "\r") |
7907cd90 JM |
152 | return None |
153 | ||
96deb6a9 | 154 | def writeline(self, str): |
8e4628da | 155 | def _to_bytes(s): |
156 | return bytes(s, "utf-8") if IS_PY_3 else s | |
157 | ||
18616b10 | 158 | self.stdin.write(_to_bytes(str.replace('\r', '\x16\r') + "\n")) |
7907cd90 | 159 | |
f6c83b2b | 160 | def cleanup(self): |
612bfe4a | 161 | #print "cleaning up" |
f6c83b2b | 162 | if self.p: |
10034e82 JM |
163 | try: |
164 | os.killpg(self.p.pid, signal.SIGTERM) | |
165 | except OSError: | |
166 | pass | |
f6c83b2b JM |
167 | self.p = None |
168 | ||
98af2ae3 | 169 | class TestReader: |
46e25689 | 170 | def __init__(self, test_file): |
98af2ae3 | 171 | self.line_num = 0 |
18616b10 JM |
172 | f = open(test_file, newline='') if IS_PY_3 else open(test_file) |
173 | self.data = f.read().split('\n') | |
98af2ae3 | 174 | self.soft = False |
a1eb30fc | 175 | self.deferrable = False |
46e25689 | 176 | self.optional = False |
98af2ae3 JM |
177 | |
178 | def next(self): | |
46e25689 | 179 | self.msg = None |
98af2ae3 JM |
180 | self.form = None |
181 | self.out = "" | |
182 | self.ret = None | |
183 | ||
184 | while self.data: | |
185 | self.line_num += 1 | |
186 | line = self.data.pop(0) | |
187 | if re.match(r"^\s*$", line): # blank line | |
188 | continue | |
189 | elif line[0:3] == ";;;": # ignore comment | |
190 | continue | |
191 | elif line[0:2] == ";;": # output comment | |
46e25689 JM |
192 | self.msg = line[3:] |
193 | return True | |
98af2ae3 JM |
194 | elif line[0:5] == ";>>> ": # settings/commands |
195 | settings = {} | |
196 | exec(line[5:], {}, settings) | |
46e25689 JM |
197 | if 'soft' in settings: |
198 | self.soft = settings['soft'] | |
a1eb30fc JM |
199 | if 'deferrable' in settings and settings['deferrable']: |
200 | self.deferrable = "\nSkipping deferrable and optional tests" | |
46e25689 JM |
201 | return True |
202 | if 'optional' in settings and settings['optional']: | |
203 | self.optional = "\nSkipping optional tests" | |
204 | return True | |
98af2ae3 JM |
205 | continue |
206 | elif line[0:1] == ";": # unexpected comment | |
18f0ec21 | 207 | raise Exception("Test data error at line %d:\n%s" % (self.line_num, line)) |
98af2ae3 JM |
208 | self.form = line # the line is a form to send |
209 | ||
210 | # Now find the output and return value | |
211 | while self.data: | |
212 | line = self.data[0] | |
213 | if line[0:3] == ";=>": | |
8d78bc26 | 214 | self.ret = line[3:] |
98af2ae3 JM |
215 | self.line_num += 1 |
216 | self.data.pop(0) | |
217 | break | |
f6f5d4f2 | 218 | elif line[0:2] == ";/": |
98af2ae3 JM |
219 | self.out = self.out + line[2:] + sep |
220 | self.line_num += 1 | |
221 | self.data.pop(0) | |
222 | else: | |
f6f5d4f2 | 223 | self.ret = "" |
98af2ae3 | 224 | break |
f6f5d4f2 | 225 | if self.ret != None: break |
98af2ae3 | 226 | |
f6f5d4f2 JM |
227 | if self.out[-2:] == sep and not self.ret: |
228 | # If there is no return value, output should not end in | |
229 | # separator | |
230 | self.out = self.out[0:-2] | |
98af2ae3 JM |
231 | return self.form |
232 | ||
31690700 | 233 | args = parser.parse_args(sys.argv[1:]) |
406761e7 JM |
234 | # Workaround argparse issue with two '--' on command line |
235 | if sys.argv.count('--') > 0: | |
236 | args.mal_cmd = sys.argv[sys.argv.index('--')+1:] | |
31690700 JM |
237 | |
238 | if args.rundir: os.chdir(args.rundir) | |
239 | ||
97e27599 JM |
240 | if args.log_file: log_file = open(args.log_file, "a") |
241 | if args.debug_file: debug_file = open(args.debug_file, "a") | |
242 | ||
243 | r = Runner(args.mal_cmd, no_pty=args.no_pty) | |
98af2ae3 | 244 | t = TestReader(args.test_file) |
53beaa0a | 245 | |
31690700 | 246 | |
98af2ae3 | 247 | def assert_prompt(runner, prompts, timeout): |
cc021efe | 248 | # Wait for the initial prompt |
98af2ae3 | 249 | header = runner.read_to_prompt(prompts, timeout=timeout) |
7907cd90 JM |
250 | if not header == None: |
251 | if header: | |
97e27599 | 252 | log("Started with:\n%s" % header) |
7907cd90 | 253 | else: |
97e27599 JM |
254 | log("Did not one of following prompt(s): %s" % repr(prompts)) |
255 | log(" Got : %s" % repr(r.buf)) | |
cc021efe JM |
256 | sys.exit(1) |
257 | ||
31690700 JM |
258 | |
259 | # Wait for the initial prompt | |
16d5b0c3 | 260 | try: |
96c09dcd | 261 | assert_prompt(r, ['[^\s()<>]+> '], args.start_timeout) |
16d5b0c3 JM |
262 | except: |
263 | _, exc, _ = sys.exc_info() | |
264 | log("\nException: %s" % repr(exc)) | |
265 | log("Output before exception:\n%s" % r.buf) | |
266 | sys.exit(1) | |
cc021efe JM |
267 | |
268 | # Send the pre-eval code if any | |
269 | if args.pre_eval: | |
270 | sys.stdout.write("RUNNING pre-eval: %s" % args.pre_eval) | |
c2b6285e NB |
271 | r.writeline(args.pre_eval) |
272 | assert_prompt(r, ['[^\s()<>]+> '], args.test_timeout) | |
31690700 | 273 | |
97e27599 JM |
274 | test_cnt = 0 |
275 | pass_cnt = 0 | |
31690700 | 276 | fail_cnt = 0 |
98af2ae3 | 277 | soft_fail_cnt = 0 |
00724049 | 278 | failures = [] |
31690700 | 279 | |
98af2ae3 | 280 | while t.next(): |
a1eb30fc JM |
281 | if args.deferrable == False and t.deferrable: |
282 | log(t.deferrable) | |
46e25689 JM |
283 | break |
284 | ||
285 | if args.optional == False and t.optional: | |
286 | log(t.optional) | |
287 | break | |
288 | ||
289 | if t.msg != None: | |
290 | log(t.msg) | |
291 | continue | |
292 | ||
293 | if t.form == None: continue | |
294 | ||
18616b10 | 295 | log("TEST: %s -> [%s,%s]" % (repr(t.form), repr(t.out), t.ret), end='') |
d2f0f672 JM |
296 | |
297 | # The repeated form is to get around an occasional OS X issue | |
298 | # where the form is repeated. | |
299 | # https://github.com/kanaka/mal/issues/30 | |
f6f5d4f2 JM |
300 | expects = ["%s%s%s%s" % (re.escape(t.form), sep, |
301 | t.out, re.escape(t.ret)), | |
302 | "%s%s%s%s%s%s" % (re.escape(t.form), sep, | |
303 | re.escape(t.form), sep, | |
304 | t.out, re.escape(t.ret))] | |
31690700 | 305 | |
98af2ae3 | 306 | r.writeline(t.form) |
31690700 | 307 | try: |
97e27599 | 308 | test_cnt += 1 |
96c09dcd | 309 | res = r.read_to_prompt(['\r\n[^\s()<>]+> ', '\n[^\s()<>]+> '], |
7907cd90 | 310 | timeout=args.test_timeout) |
31690700 | 311 | #print "%s,%s,%s" % (idx, repr(p.before), repr(p.after)) |
f6f5d4f2 JM |
312 | if (t.ret == "" and t.out == ""): |
313 | log(" -> SUCCESS (result ignored)") | |
314 | pass_cnt += 1 | |
315 | elif (re.search(expects[0], res, re.S) or | |
316 | re.search(expects[1], res, re.S)): | |
97e27599 JM |
317 | log(" -> SUCCESS") |
318 | pass_cnt += 1 | |
31690700 | 319 | else: |
f3ea3be3 | 320 | if t.soft and not args.hard: |
97e27599 | 321 | log(" -> SOFT FAIL (line %d):" % t.line_num) |
98af2ae3 | 322 | soft_fail_cnt += 1 |
00724049 | 323 | fail_type = "SOFT " |
98af2ae3 | 324 | else: |
97e27599 | 325 | log(" -> FAIL (line %d):" % t.line_num) |
98af2ae3 | 326 | fail_cnt += 1 |
00724049 | 327 | fail_type = "" |
f6f5d4f2 | 328 | log(" Expected : %s" % repr(expects[0])) |
97e27599 | 329 | log(" Got : %s" % repr(res)) |
00724049 DM |
330 | failed_test = """%sFAILED TEST (line %d): %s -> [%s,%s]: |
331 | Expected : %s | |
f6f5d4f2 JM |
332 | Got : %s""" % (fail_type, t.line_num, t.form, repr(t.out), |
333 | t.ret, repr(expects[0]), repr(res)) | |
00724049 | 334 | failures.append(failed_test) |
7907cd90 | 335 | except: |
10034e82 | 336 | _, exc, _ = sys.exc_info() |
97e27599 JM |
337 | log("\nException: %s" % repr(exc)) |
338 | log("Output before exception:\n%s" % r.buf) | |
31690700 JM |
339 | sys.exit(1) |
340 | ||
00724049 DM |
341 | if len(failures) > 0: |
342 | log("\nFAILURES:") | |
343 | for f in failures: | |
344 | log(f) | |
345 | ||
346 | results = """ | |
347 | TEST RESULTS (for %s): | |
97e27599 JM |
348 | %3d: soft failing tests |
349 | %3d: failing tests | |
350 | %3d: passing tests | |
351 | %3d: total tests | |
18616b10 | 352 | """ % (args.test_file, soft_fail_cnt, fail_cnt, |
97e27599 JM |
353 | pass_cnt, test_cnt) |
354 | log(results) | |
355 | ||
356 | debug("\n") # add some separate to debug log | |
357 | ||
31690700 | 358 | if fail_cnt > 0: |
97e27599 | 359 | sys.exit(1) |
31690700 | 360 | sys.exit(0) |