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']
22 from samba import subunit
23 from samba.subunit.run import TestProtocolClient
24 from samba.subunit import iso8601
27 VALID_RESULTS = set(['success', 'successful', 'failure', 'fail', 'skip',
28 'knownfail', 'error', 'xfail', 'skip-testsuite',
29 'testsuite-failure', 'testsuite-xfail',
30 'testsuite-success', 'testsuite-error',
31 'uxsuccess', 'testsuite-uxsuccess'])
33 class TestsuiteEnabledTestResult(unittest.TestResult):
35 def start_testsuite(self, name):
36 raise NotImplementedError(self.start_testsuite)
39 def parse_results(msg_ops, statistics, fh):
47 parts = l.split(None, 1)
48 if not len(parts) == 2 or not l.startswith(parts[0]):
51 command = parts[0].rstrip(":")
53 if command in ("test", "testing"):
54 msg_ops.control_msg(l)
56 test = subunit.RemotedTestCase(name)
57 if name in open_tests:
58 msg_ops.addError(open_tests.pop(name), subunit.RemoteError(u"Test already running"))
59 msg_ops.startTest(test)
60 open_tests[name] = test
61 elif command == "time":
62 msg_ops.control_msg(l)
64 dt = iso8601.parse_date(arg.rstrip("\n"))
66 print "Unable to parse time line: %s" % arg.rstrip("\n")
69 elif command in VALID_RESULTS:
70 msg_ops.control_msg(l)
72 grp = re.match("(.*?)( \[)?([ \t]*)( multipart)?\n", arg)
73 (testname, hasreason) = (grp.group(1), grp.group(2))
76 # reason may be specified in next lines
82 msg_ops.control_msg(l)
89 remote_error = subunit.RemoteError(reason.decode("utf-8"))
92 statistics['TESTS_ERROR']+=1
93 msg_ops.addError(subunit.RemotedTestCase(testname), subunit.RemoteError(u"reason (%s) interrupted" % result))
97 remote_error = subunit.RemoteError(u"No reason specified")
98 if result in ("success", "successful"):
100 test = open_tests.pop(testname)
102 statistics['TESTS_ERROR']+=1
104 msg_ops.addError(subunit.RemotedTestCase(testname), subunit.RemoteError(u"Test was never started"))
106 statistics['TESTS_EXPECTED_OK']+=1
107 msg_ops.addSuccess(test)
108 elif result in ("xfail", "knownfail"):
110 test = open_tests.pop(testname)
112 statistics['TESTS_ERROR']+=1
114 msg_ops.addError(subunit.RemotedTestCase(testname), subunit.RemoteError(u"Test was never started"))
116 statistics['TESTS_EXPECTED_FAIL']+=1
117 msg_ops.addExpectedFailure(test, remote_error)
118 elif result in ("uxsuccess", ):
120 test = open_tests.pop(testname)
122 statistics['TESTS_ERROR']+=1
124 msg_ops.addError(subunit.RemotedTestCase(testname), subunit.RemoteError(u"Test was never started"))
126 statistics['TESTS_UNEXPECTED_OK']+=1
127 msg_ops.addUnexpectedSuccess(test)
129 elif result in ("failure", "fail"):
131 test = open_tests.pop(testname)
133 statistics['TESTS_ERROR']+=1
135 msg_ops.addError(subunit.RemotedTestCase(testname), subunit.RemoteError(u"Test was never started"))
137 statistics['TESTS_UNEXPECTED_FAIL']+=1
139 msg_ops.addFailure(test, remote_error)
140 elif result == "skip":
141 statistics['TESTS_SKIP']+=1
142 # Allow tests to be skipped without prior announcement of test
144 test = open_tests.pop(testname)
146 test = subunit.RemotedTestCase(testname)
147 msg_ops.addSkip(test, reason)
148 elif result == "error":
149 statistics['TESTS_ERROR']+=1
152 test = open_tests.pop(testname)
154 test = subunit.RemotedTestCase(testname)
155 msg_ops.addError(test, remote_error)
156 elif result == "skip-testsuite":
157 msg_ops.skip_testsuite(testname)
158 elif result == "testsuite-success":
159 msg_ops.end_testsuite(testname, "success", reason)
160 elif result == "testsuite-failure":
161 msg_ops.end_testsuite(testname, "failure", reason)
163 elif result == "testsuite-xfail":
164 msg_ops.end_testsuite(testname, "xfail", reason)
165 elif result == "testsuite-uxsuccess":
166 msg_ops.end_testsuite(testname, "uxsuccess", reason)
168 elif result == "testsuite-error":
169 msg_ops.end_testsuite(testname, "error", reason)
172 raise AssertionError("Recognized but unhandled result %r" %
174 elif command == "testsuite":
175 msg_ops.start_testsuite(arg.strip())
176 elif command == "progress":
179 msg_ops.progress(None, subunit.PROGRESS_POP)
181 msg_ops.progress(None, subunit.PROGRESS_PUSH)
183 msg_ops.progress(int(arg), subunit.PROGRESS_CUR)
185 msg_ops.progress(int(arg), subunit.PROGRESS_SET)
187 msg_ops.output_msg(l)
190 test = subunit.RemotedTestCase(open_tests.popitem()[1])
191 msg_ops.addError(test, subunit.RemoteError(u"was started but never finished!"))
192 statistics['TESTS_ERROR']+=1
198 class SubunitOps(TestProtocolClient,TestsuiteEnabledTestResult):
200 def progress(self, count, whence):
201 if whence == subunit.PROGRESS_POP:
202 self._stream.write("progress: pop\n")
203 elif whence == subunit.PROGRESS_PUSH:
204 self._stream.write("progress: push\n")
205 elif whence == subunit.PROGRESS_SET:
206 self._stream.write("progress: %d\n" % count)
207 elif whence == subunit.PROGRESS_CUR:
208 raise NotImplementedError
210 # The following are Samba extensions:
211 def start_testsuite(self, name):
212 self._stream.write("testsuite: %s\n" % name)
214 def skip_testsuite(self, name, reason=None):
216 self._stream.write("skip-testsuite: %s [\n%s\n]\n" % (name, reason))
218 self._stream.write("skip-testsuite: %s\n" % name)
220 def end_testsuite(self, name, result, reason=None):
222 self._stream.write("testsuite-%s: %s [\n%s\n]\n" % (result, name, reason))
224 self._stream.write("testsuite-%s: %s\n" % (result, name))
226 def output_msg(self, msg):
227 self._stream.write(msg)
230 def read_test_regexes(name):
236 if l == "" or l[0] == "#":
239 (regex, reason) = l.split("#", 1)
240 ret[regex.strip()] = reason.strip()
248 def find_in_list(regexes, fullname):
249 for regex, reason in regexes.iteritems():
250 if re.match(regex, fullname):
257 class ImmediateFail(Exception):
258 """Raised to abort immediately."""
261 super(ImmediateFail, self).__init__("test failed and fail_immediately set")
264 class FilterOps(unittest.TestResult):
266 def control_msg(self, msg):
267 pass # We regenerate control messages, so ignore this
269 def time(self, time):
272 def progress(self, delta, whence):
273 self._ops.progress(delta, whence)
275 def output_msg(self, msg):
276 if self.output is None:
277 sys.stdout.write(msg)
281 def startTest(self, test):
282 self.seen_output = True
283 test = self._add_prefix(test)
284 if self.strip_ok_output:
287 self._ops.startTest(test)
289 def _add_prefix(self, test):
292 if self.prefix is not None:
294 if self.suffix is not None:
297 return subunit.RemotedTestCase(prefix + test.id() + suffix)
299 def addError(self, test, err=None):
300 test = self._add_prefix(test)
303 self._ops.addError(test, err)
305 if self.fail_immediately:
306 raise ImmediateFail()
308 def addSkip(self, test, reason=None):
309 self.seen_output = True
310 test = self._add_prefix(test)
311 self._ops.addSkip(test, reason)
314 def addExpectedFailure(self, test, err=None):
315 test = self._add_prefix(test)
316 self._ops.addExpectedFailure(test, err)
319 def addUnexpectedSuccess(self, test):
320 test = self._add_prefix(test)
321 self.uxsuccess_added+=1
322 self.total_uxsuccess+=1
323 self._ops.addUnexpectedSuccess(test)
325 self._ops.output_msg(self.output)
327 if self.fail_immediately:
328 raise ImmediateFail()
330 def addFailure(self, test, err=None):
331 test = self._add_prefix(test)
332 xfail_reason = find_in_list(self.expected_failures, test.id())
333 if xfail_reason is None:
334 xfail_reason = find_in_list(self.flapping, test.id())
335 if xfail_reason is not None:
338 self._ops.addExpectedFailure(test, err)
342 self._ops.addFailure(test, err)
344 self._ops.output_msg(self.output)
345 if self.fail_immediately:
346 raise ImmediateFail()
349 def addSuccess(self, test):
350 test = self._add_prefix(test)
351 xfail_reason = find_in_list(self.expected_failures, test.id())
352 if xfail_reason is not None:
353 self.uxsuccess_added += 1
354 self.total_uxsuccess += 1
355 self._ops.addUnexpectedSuccess(test)
357 self._ops.output_msg(self.output)
358 if self.fail_immediately:
359 raise ImmediateFail()
361 self._ops.addSuccess(test)
364 def skip_testsuite(self, name, reason=None):
365 self._ops.skip_testsuite(name, reason)
367 def start_testsuite(self, name):
368 self._ops.start_testsuite(name)
372 self.uxsuccess_added = 0
374 def end_testsuite(self, name, result, reason=None):
377 if self.xfail_added > 0:
379 if self.fail_added > 0 or self.error_added > 0 or self.uxsuccess_added > 0:
382 if xfail and result in ("fail", "failure"):
385 if self.uxsuccess_added > 0 and result != "uxsuccess":
388 reason = "Subunit/Filter Reason"
389 reason += "\n uxsuccess[%d]" % self.uxsuccess_added
391 if self.fail_added > 0 and result != "failure":
394 reason = "Subunit/Filter Reason"
395 reason += "\n failures[%d]" % self.fail_added
397 if self.error_added > 0 and result != "error":
400 reason = "Subunit/Filter Reason"
401 reason += "\n errors[%d]" % self.error_added
403 self._ops.end_testsuite(name, result, reason)
404 if result not in ("success", "xfail"):
406 self._ops.output_msg(self.output)
407 if self.fail_immediately:
408 raise ImmediateFail()
411 def __init__(self, out, prefix=None, suffix=None, expected_failures=None,
412 strip_ok_output=False, fail_immediately=False,
415 self.seen_output = False
419 if expected_failures is not None:
420 self.expected_failures = expected_failures
422 self.expected_failures = {}
423 if flapping is not None:
424 self.flapping = flapping
427 self.strip_ok_output = strip_ok_output
430 self.uxsuccess_added = 0
434 self.total_uxsuccess = 0
436 self.fail_immediately = fail_immediately
439 class PlainFormatter(TestsuiteEnabledTestResult):
441 def __init__(self, verbose, immediate, statistics,
443 super(PlainFormatter, self).__init__()
444 self.verbose = verbose
445 self.immediate = immediate
446 self.statistics = statistics
447 self.start_time = None
448 self.test_output = {}
449 self.suitesfailed = []
454 self._progress_level = 0
455 self.totalsuites = totaltests
456 self.last_time = None
459 def _format_time(delta):
460 minutes, seconds = divmod(delta.seconds, 60)
461 hours, minutes = divmod(minutes, 60)
466 ret += "%dm" % minutes
467 ret += "%ds" % seconds
470 def progress(self, offset, whence):
471 if whence == subunit.PROGRESS_POP:
472 self._progress_level -= 1
473 elif whence == subunit.PROGRESS_PUSH:
474 self._progress_level += 1
475 elif whence == subunit.PROGRESS_SET:
476 if self._progress_level == 0:
477 self.totalsuites = offset
478 elif whence == subunit.PROGRESS_CUR:
479 raise NotImplementedError
482 if self.start_time is None:
486 def start_testsuite(self, name):
491 self.test_output[name] = ""
493 total_tests = (self.statistics['TESTS_EXPECTED_OK'] +
494 self.statistics['TESTS_EXPECTED_FAIL'] +
495 self.statistics['TESTS_ERROR'] +
496 self.statistics['TESTS_UNEXPECTED_FAIL'] +
497 self.statistics['TESTS_UNEXPECTED_OK'])
499 out = "[%d(%d)" % (self.index, total_tests)
500 if self.totalsuites is not None:
501 out += "/%d" % self.totalsuites
502 if self.start_time is not None:
503 out += " at " + self._format_time(self.last_time - self.start_time)
504 if self.suitesfailed:
505 out += ", %d errors" % (len(self.suitesfailed),)
508 sys.stdout.write(out + "\n")
510 sys.stdout.write(out + ": ")
512 def output_msg(self, output):
514 sys.stdout.write(output)
515 elif self.name is not None:
516 self.test_output[self.name] += output
518 sys.stdout.write(output)
520 def control_msg(self, output):
523 def end_testsuite(self, name, result, reason):
527 if not name in self.test_output:
528 print "no output for name[%s]" % name
530 if result in ("success", "xfail"):
533 self.output_msg("ERROR: Testsuite[%s]\n" % name)
534 if reason is not None:
535 self.output_msg("REASON: %s\n" % (reason,))
536 self.suitesfailed.append(name)
537 if self.immediate and not self.verbose and name in self.test_output:
538 out += self.test_output[name]
541 if not self.immediate:
545 out += " " + result.upper() + "\n"
547 sys.stdout.write(out)
549 def startTest(self, test):
552 def addSuccess(self, test):
553 self.end_test(test.id(), "success", False)
555 def addError(self, test, err=None):
556 self.end_test(test.id(), "error", True, err)
558 def addFailure(self, test, err=None):
559 self.end_test(test.id(), "failure", True, err)
561 def addSkip(self, test, reason=None):
562 self.end_test(test.id(), "skip", False, reason)
564 def addExpectedFailure(self, test, err=None):
565 self.end_test(test.id(), "xfail", False, err)
567 def addUnexpectedSuccess(self, test):
568 self.end_test(test.id(), "uxsuccess", True)
570 def end_test(self, testname, result, unexpected, err=None):
572 self.test_output[self.name] = ""
573 if not self.immediate:
578 'success': '.'}.get(result, "?(%s)" % result))
581 if not self.name in self.test_output:
582 self.test_output[self.name] = ""
584 self.test_output[self.name] += "UNEXPECTED(%s): %s\n" % (result, testname)
586 self.test_output[self.name] += "REASON: %s\n" % str(err[1]).strip()
588 if self.immediate and not self.verbose:
589 sys.stdout.write(self.test_output[self.name])
590 self.test_output[self.name] = ""
592 if not self.immediate:
597 'success': 'S'}.get(result, "?"))
599 def write_summary(self, path):
602 if self.suitesfailed:
603 f.write("= Failed tests =\n")
605 for suite in self.suitesfailed:
606 f.write("== %s ==\n" % suite)
607 if suite in self.test_output:
608 f.write(self.test_output[suite]+"\n\n")
612 if not self.immediate and not self.verbose:
613 for suite in self.suitesfailed:
615 print "FAIL: %s" % suite
616 if suite in self.test_output:
617 print self.test_output[suite]
620 f.write("= Skipped tests =\n")
621 for reason in self.skips.keys():
622 f.write(reason + "\n")
623 for name in self.skips[reason]:
624 f.write("\t%s\n" % name)
628 if (not self.suitesfailed and
629 not self.statistics['TESTS_UNEXPECTED_FAIL'] and
630 not self.statistics['TESTS_UNEXPECTED_OK'] and
631 not self.statistics['TESTS_ERROR']):
632 ok = (self.statistics['TESTS_EXPECTED_OK'] +
633 self.statistics['TESTS_EXPECTED_FAIL'])
634 print "\nALL OK (%d tests in %d testsuites)" % (ok, self.suites_ok)
636 print "\nFAILED (%d failures, %d errors and %d unexpected successes in %d testsuites)" % (
637 self.statistics['TESTS_UNEXPECTED_FAIL'],
638 self.statistics['TESTS_ERROR'],
639 self.statistics['TESTS_UNEXPECTED_OK'],
640 len(self.suitesfailed))
642 def skip_testsuite(self, name, reason="UNKNOWN"):
643 self.skips.setdefault(reason, []).append(name)