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
 195 def read_test_regexes(name):
 196     ret = {}
 197     f = open(name, 'r')
 198     try:
 199         for l in f:
 200             l = l.strip()
 201             if l == "" or l[0] == "#":
 202                 continue
 203             if "#" in l:
 204                 (regex, reason) = l.split("#", 1)
 205                 ret[regex.strip()] = reason.strip()
 206             else:
 207                 ret[l] = None
 208     finally:
 209         f.close()
 210     return ret
 211
 212
 213 def find_in_list(regexes, fullname):
 214     for regex, reason in regexes.iteritems():
 215         if re.match(regex, fullname):
 216             if reason is None:
 217                 return ""
 218             return reason
 219     return None
 220
 221
 222 class FilterOps(testtools.testresult.TestResult):
 223
 224     def control_msg(self, msg):
 225         pass # We regenerate control messages, so ignore this
 226
 227     def time(self, time):
 228         self._ops.time(time)
 229
 230     def progress(self, delta, whence):
 231         self._ops.progress(delta, whence)
 232
 233     def output_msg(self, msg):
 234         if self.output is None:
 235             sys.stdout.write(msg)
 236         else:
 237             self.output+=msg
 238
 239     def startTest(self, test):
 240         test = self._add_prefix(test)
 241         if self.strip_ok_output:
 242            self.output = ""
 243
 244         self._ops.startTest(test)
 245
 246     def _add_prefix(self, test):
 247         if self.prefix is not None:
 248             return subunit.RemotedTestCase(self.prefix + test.id())
 249         else:
 250             return test
 251
 252     def addError(self, test, details=None):
 253         test = self._add_prefix(test)
 254         self.error_added+=1
 255         self.total_error+=1
 256         self._ops.addError(test, details)
 257         self.output = None
 258
 259     def addSkip(self, test, details=None):
 260         test = self._add_prefix(test)
 261         self._ops.addSkip(test, details)
 262         self.output = None
 263
 264     def addExpectedFailure(self, test, details=None):
 265         test = self._add_prefix(test)
 266         self._ops.addExpectedFailure(test, details)
 267         self.output = None
 268
 269     def addFailure(self, test, details=None):
 270         test = self._add_prefix(test)
 271         xfail_reason = find_in_list(self.expected_failures, test.id())
 272         if xfail_reason is not None:
 273             self.xfail_added+=1
 274             self.total_xfail+=1
 275             if details is not None:
 276                 details = subunit.RemoteError(details[1].message + xfail_reason.decode("utf-8"))
 277             else:
 278                 details = subunit.RemoteError(xfail_reason.decode("utf-8"))
 279             self._ops.addExpectedFailure(test, details)
 280         else:
 281             self.fail_added+=1
 282             self.total_fail+=1
 283             self._ops.addFailure(test, details)
 284             if self.output:
 285                 self._ops.output_msg(self.output)
 286         self.output = None
 287
 288     def addSuccess(self, test, details=None):
 289         test = self._add_prefix(test)
 290         self._ops.addSuccess(test, details)
 291         self.output = None
 292
 293     def skip_testsuite(self, name, reason=None):
 294         self._ops.skip_testsuite(name, reason)
 295
 296     def start_testsuite(self, name):
 297         self._ops.start_testsuite(name)
 298
 299         self.error_added = 0
 300         self.fail_added = 0
 301         self.xfail_added = 0
 302
 303     def end_testsuite(self, name, result, reason=None):
 304         xfail = False
 305
 306         if self.xfail_added > 0:
 307             xfail = True
 308         if self.fail_added > 0 or self.error_added > 0:
 309             xfail = False
 310
 311         if xfail and result in ("fail", "failure"):
 312             result = "xfail"
 313
 314         if self.fail_added > 0 and result != "failure":
 315             result = "failure"
 316             if reason is None:
 317                 reason = "Subunit/Filter Reason"
 318             reason += "\n failures[%d]" % self.fail_added
 319
 320         if self.error_added > 0 and result != "error":
 321             result = "error"
 322             if reason is None:
 323                 reason = "Subunit/Filter Reason"
 324             reason += "\n errors[%d]" % self.error_added
 325
 326         self._ops.end_testsuite(name, result, reason)
 327
 328     def __init__(self, out, prefix, expected_failures, strip_ok_output):
 329         self._ops = out
 330         self.output = None
 331         self.prefix = prefix
 332         self.expected_failures = expected_failures
 333         self.strip_ok_output = strip_ok_output
 334         self.xfail_added = 0
 335         self.total_xfail = 0
 336         self.total_error = 0
 337         self.total_fail = 0