selftest/subunithelper.py

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