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), "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                 if not terminated:
  85                     statistics['TESTS_ERROR']+=1
  86                     msg_ops.addError(subunit.RemotedTestCase(testname), "reason (%s) interrupted" % result)
  87                     return 1
  88             else:
  89                 reason = None
  90             if result in ("success", "successful"):
  91                 try:
  92                     test = open_tests.pop(testname)
  93                 except KeyError:
  94                     statistics['TESTS_ERROR']+=1
  95                     msg_ops.addError(subunit.RemotedTestCase(testname), "Test was never started")
  96                 else:
  97                     statistics['TESTS_EXPECTED_OK']+=1
  98                     msg_ops.addSuccess(test, reason)
  99             elif result in ("xfail", "knownfail"):
 100                 try:
 101                     test = open_tests.pop(testname)
 102                 except KeyError:
 103                     statistics['TESTS_ERROR']+=1
 104                     msg_ops.addError(subunit.RemotedTestCase(testname), "Test was never started")
 105                 else:
 106                     statistics['TESTS_EXPECTED_FAIL']+=1
 107                     msg_ops.addExpectedFail(test, reason)
 108                     expected_fail+=1
 109             elif result in ("failure", "fail"):
 110                 try:
 111                     test = open_tests.pop(testname)
 112                 except KeyError:
 113                     statistics['TESTS_ERROR']+=1
 114                     msg_ops.addError(subunit.RemotedTestCase(testname), "Test was never started")
 115                 else:
 116                     statistics['TESTS_UNEXPECTED_FAIL']+=1
 117                     msg_ops.addFailure(test, reason)
 118             elif result == "skip":
 119                 statistics['TESTS_SKIP']+=1
 120                 # Allow tests to be skipped without prior announcement of test
 121                 try:
 122                     test = open_tests.pop(testname)
 123                 except KeyError:
 124                     test = subunit.RemotedTestCase(testname)
 125                 msg_ops.addSkip(test, reason)
 126             elif result == "error":
 127                 statistics['TESTS_ERROR']+=1
 128                 try:
 129                     test = open_tests.pop(testname)
 130                 except KeyError:
 131                     test = subunit.RemotedTestCase(testname)
 132                 msg_ops.addError(test, reason)
 133             elif result == "skip-testsuite":
 134                 msg_ops.skip_testsuite(testname)
 135             elif result == "testsuite-success":
 136                 msg_ops.end_testsuite(testname, "success", reason)
 137             elif result == "testsuite-failure":
 138                 msg_ops.end_testsuite(testname, "failure", reason)
 139             elif result == "testsuite-xfail":
 140                 msg_ops.end_testsuite(testname, "xfail", reason)
 141             elif result == "testsuite-error":
 142                 msg_ops.end_testsuite(testname, "error", reason)
 143             else:
 144                 raise AssertionError("Recognized but unhandled result %r" %
 145                     result)
 146         elif command == "testsuite":
 147             msg_ops.start_testsuite(arg.strip())
 148         elif command == "progress":
 149             arg = arg.strip()
 150             if arg == "pop":
 151                 msg_ops.progress(None, subunit.PROGRESS_POP)
 152             elif arg == "push":
 153                 msg_ops.progress(None, subunit.PROGRESS_PUSH)
 154             elif arg[0] in '+-':
 155                 msg_ops.progress(int(arg), subunit.PROGRESS_CUR)
 156             else:
 157                 msg_ops.progress(int(arg), subunit.PROGRESS_SET)
 158         else:
 159             msg_ops.output_msg(l)
 160
 161     while open_tests:
 162         test = subunit.RemotedTestCase(open_tests.popitem()[1])
 163         msg_ops.addError(test, "was started but never finished!")
 164         statistics['TESTS_ERROR']+=1
 165
 166     if statistics['TESTS_ERROR'] > 0:
 167         return 1
 168     if statistics['TESTS_UNEXPECTED_FAIL'] > 0:
 169         return 1
 170     return 0
 171
 172
 173 class SubunitOps(subunit.TestProtocolClient,TestsuiteEnabledTestResult):
 174
 175     def addError(self, test, details=None):
 176         self.end_test(test.id(), "error", details)
 177
 178     def addSuccess(self, test, details=None):
 179         self.end_test(test.id(), "success", details)
 180
 181     def addExpectedFail(self, test, details=None):
 182         self.end_test(test.id(), "xfail", details)
 183
 184     def addFailure(self, test, details=None):
 185         self.end_test(test.id(), "failure", details)
 186
 187     def addSkip(self, test, details=None):
 188         self.end_test(test.id(), "skip", details)
 189
 190     def end_test(self, name, result, reason=None):
 191         if reason:
 192             self._stream.write("%s: %s [\n%s\n]\n" % (result, name, reason))
 193         else:
 194             self._stream.write("%s: %s\n" % (result, name))
 195
 196     # The following are Samba extensions:
 197     def start_testsuite(self, name):
 198         self._stream.write("testsuite: %s\n" % name)
 199
 200     def skip_testsuite(self, name, reason=None):
 201         if reason:
 202             self._stream.write("skip-testsuite: %s [\n%s\n]\n" % (name, reason))
 203         else:
 204             self._stream.write("skip-testsuite: %s\n" % name)
 205
 206     def end_testsuite(self, name, result, reason=None):
 207         if reason:
 208             self._stream.write("testsuite-%s: %s [\n%s\n]\n" % (result, name, reason))
 209         else:
 210             self._stream.write("testsuite-%s: %s\n" % (result, name))
 211
 212
 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
 229
 230
 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
 238
 239
 240 class FilterOps(testtools.testresult.TestResult):
 241
 242     def control_msg(self, msg):
 243         pass # We regenerate control messages, so ignore this
 244
 245     def time(self, time):
 246         self._ops.time(time)
 247
 248     def progress(self, delta, whence):
 249         self._ops.progress(delta, whence)
 250
 251     def output_msg(self, msg):
 252         if self.output is None:
 253             sys.stdout.write(msg)
 254         else:
 255             self.output+=msg
 256
 257     def startTest(self, test):
 258         test = self._add_prefix(test)
 259         if self.strip_ok_output:
 260            self.output = ""
 261
 262         self._ops.startTest(test)
 263
 264     def _add_prefix(self, test):
 265         if self.prefix is not None:
 266             return subunit.RemotedTestCase(self.prefix + test.id())
 267         else:
 268             return test
 269
 270     def addError(self, test, details=None):
 271         test = self._add_prefix(test)
 272         self.end_test(test.id(), "error", True, details)
 273
 274     def addSkip(self, test, details=None):
 275         test = self._add_prefix(test)
 276         self.end_test(test.id(), "skip", False, details)
 277
 278     def addExpectedFail(self, test, details=None):
 279         test = self._add_prefix(test)
 280         self.end_test(test.id(), "xfail", False, details)
 281
 282     def addFailure(self, test, details=None):
 283         test = self._add_prefix(test)
 284         self.end_test(test.id(), "failure", True, details)
 285
 286     def addSuccess(self, test, details=None):
 287         test = self._add_prefix(test)
 288         self.end_test(test.id(), "success", False, details)
 289
 290     def end_test(self, testname, result, unexpected, reason):
 291         if result in ("fail", "failure") and not unexpected:
 292             result = "xfail"
 293             self.xfail_added+=1
 294             self.total_xfail+=1
 295         xfail_reason = find_in_list(self.expected_failures, testname)
 296         if xfail_reason is not None and result in ("fail", "failure"):
 297             result = "xfail"
 298             self.xfail_added+=1
 299             self.total_xfail+=1
 300             reason += xfail_reason
 301
 302         if result in ("fail", "failure"):
 303             self.fail_added+=1
 304             self.total_fail+=1
 305
 306         if result == "error":
 307             self.error_added+=1
 308             self.total_error+=1
 309
 310         if self.strip_ok_output:
 311             if result not in ("success", "xfail", "skip"):
 312                 print self.output
 313         self.output = None
 314
 315         self._ops.end_test(testname, result, reason)
 316
 317     def skip_testsuite(self, name, reason=None):
 318         self._ops.skip_testsuite(name, reason)
 319
 320     def start_testsuite(self, name):
 321         self._ops.start_testsuite(name)
 322
 323         self.error_added = 0
 324         self.fail_added = 0
 325         self.xfail_added = 0
 326
 327     def end_testsuite(self, name, result, reason=None):
 328         xfail = False
 329
 330         if self.xfail_added > 0:
 331             xfail = True
 332         if self.fail_added > 0 or self.error_added > 0:
 333             xfail = False
 334
 335         if xfail and result in ("fail", "failure"):
 336             result = "xfail"
 337
 338         if self.fail_added > 0 and result != "failure":
 339             result = "failure"
 340             if reason is None:
 341                 reason = "Subunit/Filter Reason"
 342             reason += "\n failures[%d]" % self.fail_added
 343
 344         if self.error_added > 0 and result != "error":
 345             result = "error"
 346             if reason is None:
 347                 reason = "Subunit/Filter Reason"
 348             reason += "\n errors[%d]" % self.error_added
 349
 350         self._ops.end_testsuite(name, result, reason)
 351
 352     def __init__(self, out, prefix, expected_failures, strip_ok_output):
 353         self._ops = out
 354         self.output = None
 355         self.prefix = prefix
 356         self.expected_failures = expected_failures
 357         self.strip_ok_output = strip_ok_output
 358         self.xfail_added = 0
 359         self.total_xfail = 0
 360         self.total_error = 0
 361         self.total_fail = 0