1 # Python module for parsing and generating the Subunit protocol
3 # Copyright (C) 2008-2009 Jelmer Vernooij <jelmer@samba.org>
5 # This program is free software; you can redistribute it and/or modify
6 # it under the terms of the GNU General Public License as published by
7 # the Free Software Foundation; either version 3 of the License, or
8 # (at your option) any later version.
10 # This program is distributed in the hope that it will be useful,
11 # but WITHOUT ANY WARRANTY; without even the implied warranty of
12 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 # GNU General Public License for more details.
15 # You should have received a copy of the GNU General Public License
16 # along with this program. If not, see <http://www.gnu.org/licenses/>.
18 __all__ = ['parse_results']
25 VALID_RESULTS = ['success', 'successful', 'failure', 'fail', 'skip', 'knownfail', 'error', 'xfail', 'skip-testsuite', 'testsuite-failure', 'testsuite-xfail', 'testsuite-success', 'testsuite-error']
27 def parse_results(msg_ops, statistics, fh):
35 if l.startswith("test: "):
36 msg_ops.control_msg(l)
37 name = l.split(":", 1)[1].strip()
38 msg_ops.start_test(name)
39 open_tests.append(name)
40 elif l.startswith("time: "):
42 "^time: (\d+)-(\d+)-(\d+) (\d+):(\d+):(\d+)\n", l)
43 msg_ops.report_time(time.mktime((int(grp.group(1)), int(grp.group(2)), int(grp.group(3)), int(grp.group(4)), int(grp.group(5)), int(grp.group(6)), 0, 0, 0)))
44 elif re.match("^(" + "|".join(VALID_RESULTS) + "): (.*?)( \[)?([ \t]*)( multipart)?\n", l):
45 msg_ops.control_msg(l)
46 grp = re.match("^(" + "|".join(VALID_RESULTS) + "): (.*?)( \[)?([ \t]*)( multipart)?\n", l)
47 (result, testname, hasreason) = (grp.group(1), grp.group(2), grp.group(3))
50 # reason may be specified in next lines
56 msg_ops.control_msg(l)
64 statistics['TESTS_ERROR']+=1
65 msg_ops.end_test(testname, "error", True,
66 "reason (%s) interrupted" % result)
70 if result in ("success", "successful"):
71 open_tests.pop() #FIXME: Check that popped value == $testname
72 statistics['TESTS_EXPECTED_OK']+=1
73 msg_ops.end_test(testname, "success", False, reason)
74 elif result in ("xfail", "knownfail"):
75 open_tests.pop() #FIXME: Check that popped value == $testname
76 statistics['TESTS_EXPECTED_FAIL']+=1
77 msg_ops.end_test(testname, "xfail", False, reason)
79 elif result in ("failure", "fail"):
80 open_tests.pop() #FIXME: Check that popped value == $testname
81 statistics['TESTS_UNEXPECTED_FAIL']+=1
82 msg_ops.end_test(testname, "failure", True, reason)
83 elif result == "skip":
84 statistics['TESTS_SKIP']+=1
85 # Allow tests to be skipped without prior announcement of test
86 last = open_tests.pop()
87 if last is not None and last != testname:
88 open_tests.append(testname)
89 msg_ops.end_test(testname, "skip", False, reason)
90 elif result == "error":
91 statistics['TESTS_ERROR']+=1
92 open_tests.pop() #FIXME: Check that popped value == $testname
93 msg_ops.end_test(testname, "error", True, reason)
94 elif result == "skip-testsuite":
95 msg_ops.skip_testsuite(testname)
96 elif result == "testsuite-success":
97 msg_ops.end_testsuite(testname, "success", reason)
98 elif result == "testsuite-failure":
99 msg_ops.end_testsuite(testname, "failure", reason)
100 elif result == "testsuite-xfail":
101 msg_ops.end_testsuite(testname, "xfail", reason)
102 elif result == "testsuite-error":
103 msg_ops.end_testsuite(testname, "error", reason)
104 elif l.startswith("testsuite: "):
105 msg_ops.start_testsuite(l.split(":", 1)[1].strip())
106 elif l.startswith("testsuite-count: "):
107 msg_ops.testsuite_count(int(l.split(":", 1)[1].strip()))
108 elif l.startswith("progress: "):
109 arg = l.split(":", 1)[1].strip()
111 msg_ops.progress(None, subunit.PROGRESS_POP)
113 msg_ops.progress(None, subunit.PROGRESS_PUSH)
115 msg_ops.progress(int(arg), subunit.PROGRESS_CUR)
117 msg_ops.progress(int(arg), subunit.PROGRESS_SET)
119 msg_ops.output_msg(l)
122 msg_ops.end_test(open_tests.pop(), "error", True,
123 "was started but never finished!")
124 statistics['TESTS_ERROR']+=1
126 if statistics['TESTS_ERROR'] > 0:
128 if statistics['TESTS_UNEXPECTED_FAIL'] > 0:
133 class SubunitOps(object):
135 def start_test(self, testname):
136 print "test: %s" % testname
138 def end_test(self, name, result, reason=None):
140 print "%s: %s [" % (result, name)
144 print "%s: %s" % (result, name)
146 def skip_test(self, name, reason=None):
147 self.end_test(name, "skip", reason)
149 def fail_test(self, name, reason=None):
150 self.end_test(name, "fail", reason)
152 def success_test(self, name, reason=None):
153 self.end_test(name, "success", reason)
155 def xfail_test(self, name, reason=None):
156 self.end_test(name, "xfail", reason)
158 def report_time(self, t):
159 (year, mon, mday, hour, min, sec, wday, yday, isdst) = time.localtime(t)
160 print "time: %04d-%02d-%02d %02d:%02d:%02d" % (year, mon, mday, hour, min, sec)
162 def progress(self, offset, whence):
163 if whence == subunit.PROGRESS_CUR and offset > -1:
165 elif whence == subunit.PROGRESS_PUSH:
168 elif whence == subunit.PROGRESS_POP:
173 print "progress: %s%s" % (prefix, offset)
175 # The following are Samba extensions:
176 def start_testsuite(self, name):
177 print "testsuite: %s" % name
179 def skip_testsuite(self, name, reason=None):
181 print "skip-testsuite: %s [\n%s\n]" % (name, reason)
183 print "skip-testsuite: %s" % name
185 def end_testsuite(self, name, result, reason=None):
187 print "testsuite-%s: %s [" % (result, name)
191 print "testsuite-%s: %s" % (result, name)
193 def testsuite_count(self, count):
194 print "testsuite-count: %d" % count
197 def read_test_regexes(name):
202 if l == "" or l[0] == "#":
205 (regex, reason) = l.split("#", 1)
206 yield (regex.strip(), reason.strip())
213 def find_in_list(regexes, fullname):
214 for regex, reason in regexes:
215 if re.match(regex, fullname):
222 class FilterOps(object):
224 def control_msg(self, msg):
225 pass # We regenerate control messages, so ignore this
227 def report_time(self, time):
228 self._ops.report_time(time)
230 def progress(self, delta, whence):
231 self._ops.progress(delta, whence)
233 def output_msg(self, msg):
234 if self.output is None:
235 sys.stdout.write(msg)
239 def start_test(self, testname):
240 if self.prefix is not None:
241 testname = self.prefix + testname
243 if self.strip_ok_output:
246 self._ops.start_test(testname)
248 def end_test(self, testname, result, unexpected, reason):
249 if self.prefix is not None:
250 testname = self.prefix + testname
252 if result in ("fail", "failure") and not unexpected:
256 xfail_reason = find_in_list(self.expected_failures, testname)
257 if xfail_reason is not None and result in ("fail", "failure"):
261 reason += xfail_reason
263 if result in ("fail", "failure"):
267 if result == "error":
271 if self.strip_ok_output:
272 if result not in ("success", "xfail", "skip"):
276 self._ops.end_test(testname, result, reason)
278 def skip_testsuite(self, name, reason=None):
279 self._ops.skip_testsuite(name, reason)
281 def start_testsuite(self, name):
282 self._ops.start_testsuite(name)
288 def end_testsuite(self, name, result, reason=None):
291 if self.xfail_added > 0:
293 if self.fail_added > 0 or self.error_added > 0:
296 if xfail and result in ("fail", "failure"):
299 if self.fail_added > 0 and result != "failure":
302 reason = "Subunit/Filter Reason"
303 reason += "\n failures[%d]" % self.fail_added
305 if self.error_added > 0 and result != "error":
308 reason = "Subunit/Filter Reason"
309 reason += "\n errors[%d]" % self.error_added
311 self._ops.end_testsuite(name, result, reason)
313 def testsuite_count(self, count):
314 self._ops.testsuite_count(count)
316 def __init__(self, prefix, expected_failures, strip_ok_output):
317 self._ops = SubunitOps()
320 self.expected_failures = expected_failures
321 self.strip_ok_output = strip_ok_output