s3:smbd: s/event_add_fd/tevent_add_fd and s/EVENT_FD_/TEVENT_FD_
[Samba/gebeck_regimport.git] / selftest / subunithelper.py
blob057e1390508a57740c837bf35d5f9fb67152c244
1 # Python module for parsing and generating the Subunit protocol
2 # (Samba-specific)
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']
20 import re
21 import sys
22 import subunit
23 import subunit.iso8601
24 import testtools
25 from testtools import content, content_type
27 VALID_RESULTS = ['success', 'successful', 'failure', 'fail', 'skip', 'knownfail', 'error', 'xfail', 'skip-testsuite', 'testsuite-failure', 'testsuite-xfail', 'testsuite-success', 'testsuite-error', 'uxsuccess']
29 class TestsuiteEnabledTestResult(testtools.testresult.TestResult):
31 def start_testsuite(self, name):
32 raise NotImplementedError(self.start_testsuite)
35 def parse_results(msg_ops, statistics, fh):
36 exitcode = 0
37 open_tests = {}
39 while fh:
40 l = fh.readline()
41 if l == "":
42 break
43 parts = l.split(None, 1)
44 if not len(parts) == 2 or not l.startswith(parts[0]):
45 msg_ops.output_msg(l)
46 continue
47 command = parts[0].rstrip(":")
48 arg = parts[1]
49 if command in ("test", "testing"):
50 msg_ops.control_msg(l)
51 name = arg.rstrip()
52 test = subunit.RemotedTestCase(name)
53 if name in open_tests:
54 msg_ops.addError(open_tests.pop(name), subunit.RemoteError(u"Test already running"))
55 msg_ops.startTest(test)
56 open_tests[name] = test
57 elif command == "time":
58 msg_ops.control_msg(l)
59 try:
60 dt = subunit.iso8601.parse_date(arg.rstrip("\n"))
61 except TypeError, e:
62 print "Unable to parse time line: %s" % arg.rstrip("\n")
63 else:
64 msg_ops.time(dt)
65 elif command in VALID_RESULTS:
66 msg_ops.control_msg(l)
67 result = command
68 grp = re.match("(.*?)( \[)?([ \t]*)( multipart)?\n", arg)
69 (testname, hasreason) = (grp.group(1), grp.group(2))
70 if hasreason:
71 reason = ""
72 # reason may be specified in next lines
73 terminated = False
74 while fh:
75 l = fh.readline()
76 if l == "":
77 break
78 msg_ops.control_msg(l)
79 if l == "]\n":
80 terminated = True
81 break
82 else:
83 reason += l
85 remote_error = subunit.RemoteError(reason.decode("utf-8"))
87 if not terminated:
88 statistics['TESTS_ERROR']+=1
89 msg_ops.addError(subunit.RemotedTestCase(testname), subunit.RemoteError(u"reason (%s) interrupted" % result))
90 return 1
91 else:
92 reason = None
93 remote_error = subunit.RemoteError(u"No reason specified")
94 if result in ("success", "successful"):
95 try:
96 test = open_tests.pop(testname)
97 except KeyError:
98 statistics['TESTS_ERROR']+=1
99 exitcode = 1
100 msg_ops.addError(subunit.RemotedTestCase(testname), subunit.RemoteError(u"Test was never started"))
101 else:
102 statistics['TESTS_EXPECTED_OK']+=1
103 msg_ops.addSuccess(test)
104 elif result in ("xfail", "knownfail"):
105 try:
106 test = open_tests.pop(testname)
107 except KeyError:
108 statistics['TESTS_ERROR']+=1
109 exitcode = 1
110 msg_ops.addError(subunit.RemotedTestCase(testname), subunit.RemoteError(u"Test was never started"))
111 else:
112 statistics['TESTS_EXPECTED_FAIL']+=1
113 msg_ops.addExpectedFailure(test, remote_error)
114 elif result in ("uxsuccess", ):
115 try:
116 test = open_tests.pop(testname)
117 except KeyError:
118 statistics['TESTS_ERROR']+=1
119 exitcode = 1
120 msg_ops.addError(subunit.RemotedTestCase(testname), subunit.RemoteError(u"Test was never started"))
121 else:
122 statistics['TESTS_UNEXPECTED_OK']+=1
123 msg_ops.addUnexpectedSuccess(test, remote_error)
124 exitcode = 1
125 elif result in ("failure", "fail"):
126 try:
127 test = open_tests.pop(testname)
128 except KeyError:
129 statistics['TESTS_ERROR']+=1
130 exitcode = 1
131 msg_ops.addError(subunit.RemotedTestCase(testname), subunit.RemoteError(u"Test was never started"))
132 else:
133 statistics['TESTS_UNEXPECTED_FAIL']+=1
134 exitcode = 1
135 msg_ops.addFailure(test, remote_error)
136 elif result == "skip":
137 statistics['TESTS_SKIP']+=1
138 # Allow tests to be skipped without prior announcement of test
139 try:
140 test = open_tests.pop(testname)
141 except KeyError:
142 test = subunit.RemotedTestCase(testname)
143 msg_ops.addSkip(test, reason)
144 elif result == "error":
145 statistics['TESTS_ERROR']+=1
146 exitcode = 1
147 try:
148 test = open_tests.pop(testname)
149 except KeyError:
150 test = subunit.RemotedTestCase(testname)
151 msg_ops.addError(test, remote_error)
152 elif result == "skip-testsuite":
153 msg_ops.skip_testsuite(testname)
154 elif result == "testsuite-success":
155 msg_ops.end_testsuite(testname, "success", reason)
156 elif result == "testsuite-failure":
157 msg_ops.end_testsuite(testname, "failure", reason)
158 exitcode = 1
159 elif result == "testsuite-xfail":
160 msg_ops.end_testsuite(testname, "xfail", reason)
161 elif result == "testsuite-error":
162 msg_ops.end_testsuite(testname, "error", reason)
163 exitcode = 1
164 else:
165 raise AssertionError("Recognized but unhandled result %r" %
166 result)
167 elif command == "testsuite":
168 msg_ops.start_testsuite(arg.strip())
169 elif command == "progress":
170 arg = arg.strip()
171 if arg == "pop":
172 msg_ops.progress(None, subunit.PROGRESS_POP)
173 elif arg == "push":
174 msg_ops.progress(None, subunit.PROGRESS_PUSH)
175 elif arg[0] in '+-':
176 msg_ops.progress(int(arg), subunit.PROGRESS_CUR)
177 else:
178 msg_ops.progress(int(arg), subunit.PROGRESS_SET)
179 else:
180 msg_ops.output_msg(l)
182 while open_tests:
183 test = subunit.RemotedTestCase(open_tests.popitem()[1])
184 msg_ops.addError(test, subunit.RemoteError(u"was started but never finished!"))
185 statistics['TESTS_ERROR']+=1
186 exitcode = 1
188 return exitcode
191 class SubunitOps(subunit.TestProtocolClient,TestsuiteEnabledTestResult):
193 # The following are Samba extensions:
194 def start_testsuite(self, name):
195 self._stream.write("testsuite: %s\n" % name)
197 def skip_testsuite(self, name, reason=None):
198 if reason:
199 self._stream.write("skip-testsuite: %s [\n%s\n]\n" % (name, reason))
200 else:
201 self._stream.write("skip-testsuite: %s\n" % name)
203 def end_testsuite(self, name, result, reason=None):
204 if reason:
205 self._stream.write("testsuite-%s: %s [\n%s\n]\n" % (result, name, reason))
206 else:
207 self._stream.write("testsuite-%s: %s\n" % (result, name))
209 def output_msg(self, msg):
210 self._stream.write(msg)
213 def read_test_regexes(name):
214 ret = {}
215 f = open(name, 'r')
216 try:
217 for l in f:
218 l = l.strip()
219 if l == "" or l[0] == "#":
220 continue
221 if "#" in l:
222 (regex, reason) = l.split("#", 1)
223 ret[regex.strip()] = reason.strip()
224 else:
225 ret[l] = None
226 finally:
227 f.close()
228 return ret
231 def find_in_list(regexes, fullname):
232 for regex, reason in regexes.iteritems():
233 if re.match(regex, fullname):
234 if reason is None:
235 return ""
236 return reason
237 return None
240 class ImmediateFail(Exception):
241 """Raised to abort immediately."""
243 def __init__(self):
244 super(ImmediateFail, self).__init__("test failed and fail_immediately set")
247 class FilterOps(testtools.testresult.TestResult):
249 def control_msg(self, msg):
250 pass # We regenerate control messages, so ignore this
252 def time(self, time):
253 self._ops.time(time)
255 def progress(self, delta, whence):
256 self._ops.progress(delta, whence)
258 def output_msg(self, msg):
259 if self.output is None:
260 sys.stdout.write(msg)
261 else:
262 self.output+=msg
264 def startTest(self, test):
265 self.seen_output = True
266 test = self._add_prefix(test)
267 if self.strip_ok_output:
268 self.output = ""
270 self._ops.startTest(test)
272 def _add_prefix(self, test):
273 prefix = ""
274 suffix = ""
275 if self.prefix is not None:
276 prefix = self.prefix
277 if self.suffix is not None:
278 suffix = self.suffix
280 return subunit.RemotedTestCase(prefix + test.id() + suffix)
282 def addError(self, test, details=None):
283 test = self._add_prefix(test)
284 self.error_added+=1
285 self.total_error+=1
286 self._ops.addError(test, details)
287 self.output = None
288 if self.fail_immediately:
289 raise ImmediateFail()
291 def addSkip(self, test, details=None):
292 self.seen_output = True
293 test = self._add_prefix(test)
294 self._ops.addSkip(test, details)
295 self.output = None
297 def addExpectedFailure(self, test, details=None):
298 test = self._add_prefix(test)
299 self._ops.addExpectedFailure(test, details)
300 self.output = None
302 def addUnexpectedSuccess(self, test, details=None):
303 test = self._add_prefix(test)
304 self._ops.addUnexpectedSuccess(test, details)
305 self.output = None
307 def addFailure(self, test, details=None):
308 test = self._add_prefix(test)
309 xfail_reason = find_in_list(self.expected_failures, test.id())
310 if xfail_reason is None:
311 xfail_reason = find_in_list(self.flapping, test.id())
312 if xfail_reason is not None:
313 self.xfail_added+=1
314 self.total_xfail+=1
315 if details is not None:
316 details = subunit.RemoteError(unicode(details[1]) + xfail_reason.decode("utf-8"))
317 else:
318 details = subunit.RemoteError(xfail_reason.decode("utf-8"))
319 self._ops.addExpectedFailure(test, details)
320 else:
321 self.fail_added+=1
322 self.total_fail+=1
323 self._ops.addFailure(test, details)
324 if self.output:
325 self._ops.output_msg(self.output)
326 if self.fail_immediately:
327 raise ImmediateFail()
328 self.output = None
330 def addSuccess(self, test, details=None):
331 test = self._add_prefix(test)
332 xfail_reason = find_in_list(self.expected_failures, test.id())
333 if xfail_reason is not None:
334 self.uxsuccess_added += 1
335 self.total_uxsuccess += 1
336 if details is None:
337 details = {}
338 details['reason'] = content.Content(
339 content_type.ContentType("text", "plain",
340 {"charset": "utf8"}), lambda: xfail_reason)
341 self._ops.addUnexpectedSuccess(test, details)
342 if self.output:
343 self._ops.output_msg(self.output)
344 if self.fail_immediately:
345 raise ImmediateFail()
346 else:
347 self._ops.addSuccess(test, details)
348 self.output = None
350 def skip_testsuite(self, name, reason=None):
351 self._ops.skip_testsuite(name, reason)
353 def start_testsuite(self, name):
354 self._ops.start_testsuite(name)
355 self.error_added = 0
356 self.fail_added = 0
357 self.xfail_added = 0
358 self.uxsuccess_added = 0
360 def end_testsuite(self, name, result, reason=None):
361 xfail = False
363 if self.xfail_added > 0:
364 xfail = True
365 if self.fail_added > 0 or self.error_added > 0:
366 xfail = False
368 if xfail and result in ("fail", "failure"):
369 result = "xfail"
371 if self.fail_added > 0 and result != "failure":
372 result = "failure"
373 if reason is None:
374 reason = "Subunit/Filter Reason"
375 reason += "\n failures[%d]" % self.fail_added
377 if self.error_added > 0 and result != "error":
378 result = "error"
379 if reason is None:
380 reason = "Subunit/Filter Reason"
381 reason += "\n errors[%d]" % self.error_added
383 self._ops.end_testsuite(name, result, reason)
385 def __init__(self, out, prefix=None, suffix=None, expected_failures=None,
386 strip_ok_output=False, fail_immediately=False,
387 flapping=None):
388 self._ops = out
389 self.seen_output = False
390 self.output = None
391 self.prefix = prefix
392 self.suffix = suffix
393 if expected_failures is not None:
394 self.expected_failures = expected_failures
395 else:
396 self.expected_failures = {}
397 if flapping is not None:
398 self.flapping = flapping
399 else:
400 self.flapping = {}
401 self.strip_ok_output = strip_ok_output
402 self.xfail_added = 0
403 self.fail_added = 0
404 self.uxsuccess_added = 0
405 self.total_xfail = 0
406 self.total_error = 0
407 self.total_fail = 0
408 self.total_uxsuccess = 0
409 self.error_added = 0
410 self.fail_immediately = fail_immediately
413 class PlainFormatter(TestsuiteEnabledTestResult):
415 def __init__(self, verbose, immediate, statistics,
416 totaltests=None):
417 super(PlainFormatter, self).__init__()
418 self.verbose = verbose
419 self.immediate = immediate
420 self.statistics = statistics
421 self.start_time = None
422 self.test_output = {}
423 self.suitesfailed = []
424 self.suites_ok = 0
425 self.skips = {}
426 self.index = 0
427 self.name = None
428 self._progress_level = 0
429 self.totalsuites = totaltests
430 self.last_time = None
432 @staticmethod
433 def _format_time(delta):
434 minutes, seconds = divmod(delta.seconds, 60)
435 hours, minutes = divmod(minutes, 60)
436 ret = ""
437 if hours:
438 ret += "%dh" % hours
439 if minutes:
440 ret += "%dm" % minutes
441 ret += "%ds" % seconds
442 return ret
444 def progress(self, offset, whence):
445 if whence == subunit.PROGRESS_POP:
446 self._progress_level -= 1
447 elif whence == subunit.PROGRESS_PUSH:
448 self._progress_level += 1
449 elif whence == subunit.PROGRESS_SET:
450 if self._progress_level == 0:
451 self.totalsuites = offset
452 elif whence == subunit.PROGRESS_CUR:
453 raise NotImplementedError
455 def time(self, dt):
456 if self.start_time is None:
457 self.start_time = dt
458 self.last_time = dt
460 def start_testsuite(self, name):
461 self.index += 1
462 self.name = name
464 if not self.verbose:
465 self.test_output[name] = ""
467 out = "[%d" % self.index
468 if self.totalsuites is not None:
469 out += "/%d" % self.totalsuites
470 if self.start_time is not None:
471 out += " in " + self._format_time(self.last_time - self.start_time)
472 if self.suitesfailed:
473 out += ", %d errors" % (len(self.suitesfailed),)
474 out += "] %s" % name
475 if self.immediate:
476 sys.stdout.write(out + "\n")
477 else:
478 sys.stdout.write(out + ": ")
480 def output_msg(self, output):
481 if self.verbose:
482 sys.stdout.write(output)
483 elif self.name is not None:
484 self.test_output[self.name] += output
485 else:
486 sys.stdout.write(output)
488 def control_msg(self, output):
489 pass
491 def end_testsuite(self, name, result, reason):
492 out = ""
493 unexpected = False
495 if not name in self.test_output:
496 print "no output for name[%s]" % name
498 if result in ("success", "xfail"):
499 self.suites_ok+=1
500 else:
501 self.output_msg("ERROR: Testsuite[%s]\n" % name)
502 if reason is not None:
503 self.output_msg("REASON: %s\n" % (reason,))
504 self.suitesfailed.append(name)
505 if self.immediate and not self.verbose and name in self.test_output:
506 out += self.test_output[name]
507 unexpected = True
509 if not self.immediate:
510 if not unexpected:
511 out += " ok\n"
512 else:
513 out += " " + result.upper() + "\n"
515 sys.stdout.write(out)
517 def startTest(self, test):
518 pass
520 def addSuccess(self, test):
521 self.end_test(test.id(), "success", False)
523 def addError(self, test, details=None):
524 self.end_test(test.id(), "error", True, details)
526 def addFailure(self, test, details=None):
527 self.end_test(test.id(), "failure", True, details)
529 def addSkip(self, test, details=None):
530 self.end_test(test.id(), "skip", False, details)
532 def addExpectedFailure(self, test, details=None):
533 self.end_test(test.id(), "xfail", False, details)
535 def addUnexpectedSuccess(self, test, details=None):
536 self.end_test(test.id(), "uxsuccess", True, details)
538 def end_test(self, testname, result, unexpected, details=None):
539 if not unexpected:
540 self.test_output[self.name] = ""
541 if not self.immediate:
542 sys.stdout.write({
543 'failure': 'f',
544 'xfail': 'X',
545 'skip': 's',
546 'success': '.'}.get(result, "?(%s)" % result))
547 return
549 if not self.name in self.test_output:
550 self.test_output[self.name] = ""
552 self.test_output[self.name] += "UNEXPECTED(%s): %s\n" % (result, testname)
553 if details is not None:
554 self.test_output[self.name] += "REASON: %s\n" % (unicode(details[1]).encode("utf-8").strip(),)
556 if self.immediate and not self.verbose:
557 sys.stdout.write(self.test_output[self.name])
558 self.test_output[self.name] = ""
560 if not self.immediate:
561 sys.stdout.write({
562 'error': 'E',
563 'failure': 'F',
564 'uxsuccess': 'U',
565 'success': 'S'}.get(result, "?"))
567 def write_summary(self, path):
568 f = open(path, 'w+')
570 if self.suitesfailed:
571 f.write("= Failed tests =\n")
573 for suite in self.suitesfailed:
574 f.write("== %s ==\n" % suite)
575 if suite in self.test_output:
576 f.write(self.test_output[suite]+"\n\n")
578 f.write("\n")
580 if not self.immediate and not self.verbose:
581 for suite in self.suitesfailed:
582 print "=" * 78
583 print "FAIL: %s" % suite
584 if suite in self.test_output:
585 print self.test_output[suite]
586 print ""
588 f.write("= Skipped tests =\n")
589 for reason in self.skips.keys():
590 f.write(reason + "\n")
591 for name in self.skips[reason]:
592 f.write("\t%s\n" % name)
593 f.write("\n")
594 f.close()
596 if (not self.suitesfailed and
597 not self.statistics['TESTS_UNEXPECTED_FAIL'] and
598 not self.statistics['TESTS_UNEXPECTED_OK'] and
599 not self.statistics['TESTS_ERROR']):
600 ok = (self.statistics['TESTS_EXPECTED_OK'] +
601 self.statistics['TESTS_EXPECTED_FAIL'])
602 print "\nALL OK (%d tests in %d testsuites)" % (ok, self.suites_ok)
603 else:
604 print "\nFAILED (%d failures, %d errors and %d unexpected successes in %d testsuites)" % (
605 self.statistics['TESTS_UNEXPECTED_FAIL'],
606 self.statistics['TESTS_ERROR'],
607 self.statistics['TESTS_UNEXPECTED_OK'],
608 len(self.suitesfailed))
610 def skip_testsuite(self, name, reason="UNKNOWN"):
611 self.skips.setdefault(reason, []).append(name)
612 if self.totalsuites:
613 self.totalsuites-=1