selftest: Avoid accessing deprecated BaseException.message.
[samba.git] / selftest / subunithelper.py
index 11b581f6f167b171d61984e231381c60cbddd966..5128d4a63ae09d0a2e31c5722faf6632ed59edbb 100644 (file)
@@ -20,14 +20,20 @@ __all__ = ['parse_results']
 import re
 import sys
 import subunit
+import subunit.iso8601
 import testtools
-import time
 
 VALID_RESULTS = ['success', 'successful', 'failure', 'fail', 'skip', 'knownfail', 'error', 'xfail', 'skip-testsuite', 'testsuite-failure', 'testsuite-xfail', 'testsuite-success', 'testsuite-error']
 
+class TestsuiteEnabledTestResult(testtools.testresult.TestResult):
+
+    def start_testsuite(self, name):
+        raise NotImplementedError(self.start_testsuite)
+
+
 def parse_results(msg_ops, statistics, fh):
     expected_fail = 0
-    open_tests = []
+    open_tests = {}
 
     while fh:
         l = fh.readline()
@@ -41,19 +47,20 @@ def parse_results(msg_ops, statistics, fh):
         arg = parts[1]
         if command in ("test", "testing"):
             msg_ops.control_msg(l)
-            msg_ops.start_test(arg.rstrip())
-            open_tests.append(arg.rstrip())
+            name = arg.rstrip()
+            test = subunit.RemotedTestCase(name)
+            if name in open_tests:
+                msg_ops.addError(open_tests.pop(name), subunit.RemoteError(u"Test already running"))
+            msg_ops.startTest(test)
+            open_tests[name] = test
         elif command == "time":
             msg_ops.control_msg(l)
-            grp = re.match(
-                '(\d+)-(\d+)-(\d+) (\d+):(\d+):([.0-9]+)\n', arg)
-            if grp is None:
-                grp = re.match(
-                    '(\d+)-(\d+)-(\d+) (\d+):(\d+):([.0-9]+)Z\n', arg)
-                if grp is None:
-                    print "Unable to parse time line: %s" % arg
-            if grp is not None:
-                msg_ops.report_time(time.mktime((int(grp.group(1)), int(grp.group(2)), int(grp.group(3)), int(grp.group(4)), int(grp.group(5)), int(float(grp.group(6))), 0, 0, 0)))
+            try:
+                dt = subunit.iso8601.parse_date(arg.rstrip("\n"))
+            except TypeError, e:
+                print "Unable to parse time line: %s" % arg.rstrip("\n")
+            else:
+                msg_ops.time(dt)
         elif command in VALID_RESULTS:
             msg_ops.control_msg(l)
             result = command
@@ -74,58 +81,58 @@ def parse_results(msg_ops, statistics, fh):
                     else:
                         reason += l
 
+                remote_error = subunit.RemoteError(reason.decode("utf-8"))
+
                 if not terminated:
                     statistics['TESTS_ERROR']+=1
-                    msg_ops.end_test(testname, "error", True, 
-                                       "reason (%s) interrupted" % result)
+                    msg_ops.addError(subunit.RemotedTestCase(testname), subunit.RemoteError(u"reason (%s) interrupted" % result))
                     return 1
             else:
                 reason = None
+                remote_error = subunit.RemoteError(u"No reason specified")
             if result in ("success", "successful"):
                 try:
-                    open_tests.remove(testname)
-                except ValueError:
+                    test = open_tests.pop(testname)
+                except KeyError:
                     statistics['TESTS_ERROR']+=1
-                    msg_ops.end_test(testname, "error", True, 
-                            "Test was never started")
+                    msg_ops.addError(subunit.RemotedTestCase(testname), subunit.RemoteError(u"Test was never started"))
                 else:
                     statistics['TESTS_EXPECTED_OK']+=1
-                    msg_ops.end_test(testname, "success", False, reason)
+                    msg_ops.addSuccess(test)
             elif result in ("xfail", "knownfail"):
                 try:
-                    open_tests.remove(testname)
-                except ValueError:
+                    test = open_tests.pop(testname)
+                except KeyError:
                     statistics['TESTS_ERROR']+=1
-                    msg_ops.end_test(testname, "error", True, 
-                            "Test was never started")
+                    msg_ops.addError(subunit.RemotedTestCase(testname), subunit.RemoteError(u"Test was never started"))
                 else:
                     statistics['TESTS_EXPECTED_FAIL']+=1
-                    msg_ops.end_test(testname, "xfail", False, reason)
+                    msg_ops.addExpectedFailure(test, remote_error)
                     expected_fail+=1
             elif result in ("failure", "fail"):
                 try:
-                    open_tests.remove(testname)
-                except ValueError:
+                    test = open_tests.pop(testname)
+                except KeyError:
                     statistics['TESTS_ERROR']+=1
-                    msg_ops.end_test(testname, "error", True, 
-                            "Test was never started")
+                    msg_ops.addError(subunit.RemotedTestCase(testname), subunit.RemoteError(u"Test was never started"))
                 else:
                     statistics['TESTS_UNEXPECTED_FAIL']+=1
-                    msg_ops.end_test(testname, "failure", True, reason)
+                    msg_ops.addFailure(test, remote_error)
             elif result == "skip":
                 statistics['TESTS_SKIP']+=1
                 # Allow tests to be skipped without prior announcement of test
-                last = open_tests.pop()
-                if last is not None and last != testname:
-                    open_tests.append(testname)
-                msg_ops.end_test(testname, "skip", False, reason)
+                try:
+                    test = open_tests.pop(testname)
+                except KeyError:
+                    test = subunit.RemotedTestCase(testname)
+                msg_ops.addSkip(test, reason)
             elif result == "error":
                 statistics['TESTS_ERROR']+=1
                 try:
-                    open_tests.remove(testname)
-                except ValueError:
-                    pass
-                msg_ops.end_test(testname, "error", True, reason)
+                    test = open_tests.pop(testname)
+                except KeyError:
+                    test = subunit.RemotedTestCase(testname)
+                msg_ops.addError(test, remote_error)
             elif result == "skip-testsuite":
                 msg_ops.skip_testsuite(testname)
             elif result == "testsuite-success":
@@ -155,76 +162,37 @@ def parse_results(msg_ops, statistics, fh):
             msg_ops.output_msg(l)
 
     while open_tests:
-        msg_ops.end_test(open_tests.pop(), "error", True,
-                   "was started but never finished!")
+        test = subunit.RemotedTestCase(open_tests.popitem()[1])
+        msg_ops.addError(test, subunit.RemoteError(u"was started but never finished!"))
         statistics['TESTS_ERROR']+=1
 
     if statistics['TESTS_ERROR'] > 0:
         return 1
     if statistics['TESTS_UNEXPECTED_FAIL'] > 0:
-        return 1 
+        return 1
     return 0
 
 
-class SubunitOps(object):
-
-    def start_test(self, testname):
-        print "test: %s" % testname
-
-    def end_test(self, name, result, reason=None):
-        if reason:
-            print "%s: %s [" % (result, name)
-            print reason
-            print "]"
-        else:
-            print "%s: %s" % (result, name)
-
-    def skip_test(self, name, reason=None):
-        self.end_test(name, "skip", reason)
-
-    def fail_test(self, name, reason=None):
-        self.end_test(name, "fail", reason)
-
-    def success_test(self, name, reason=None):
-        self.end_test(name, "success", reason)
-
-    def xfail_test(self, name, reason=None):
-        self.end_test(name, "xfail", reason)
-
-    def report_time(self, t):
-        (year, mon, mday, hour, min, sec, wday, yday, isdst) = time.localtime(t)
-        print "time: %04d-%02d-%02d %02d:%02d:%02d" % (year, mon, mday, hour, min, sec)
-
-    def progress(self, offset, whence):
-        if whence == subunit.PROGRESS_CUR and offset > -1:
-            prefix = "+"
-        elif whence == subunit.PROGRESS_PUSH:
-            prefix = ""
-            offset = "push"
-        elif whence == subunit.PROGRESS_POP:
-            prefix = ""
-            offset = "pop"
-        else:
-            prefix = ""
-        print "progress: %s%s" % (prefix, offset)
+class SubunitOps(subunit.TestProtocolClient,TestsuiteEnabledTestResult):
 
     # The following are Samba extensions:
     def start_testsuite(self, name):
-        print "testsuite: %s" % name
+        self._stream.write("testsuite: %s\n" % name)
 
     def skip_testsuite(self, name, reason=None):
         if reason:
-            print "skip-testsuite: %s [\n%s\n]" % (name, reason)
+            self._stream.write("skip-testsuite: %s [\n%s\n]\n" % (name, reason))
         else:
-            print "skip-testsuite: %s" % name
+            self._stream.write("skip-testsuite: %s\n" % name)
 
     def end_testsuite(self, name, result, reason=None):
         if reason:
-            print "testsuite-%s: %s [" % (result, name)
-            print "%s" % reason
-            print "]"
+            self._stream.write("testsuite-%s: %s [\n%s\n]\n" % (result, name, reason))
         else:
-            print "testsuite-%s: %s" % (result, name)
+            self._stream.write("testsuite-%s: %s\n" % (result, name))
+
+    def output_msg(self, msg):
+        self._stream.write(msg)
 
 
 def read_test_regexes(name):
@@ -254,13 +222,20 @@ def find_in_list(regexes, fullname):
     return None
 
 
+class ImmediateFail(Exception):
+    """Raised to abort immediately."""
+
+    def __init__(self):
+        super(ImmediateFail, self).__init__("test failed and fail_immediately set")
+
+
 class FilterOps(testtools.testresult.TestResult):
 
     def control_msg(self, msg):
         pass # We regenerate control messages, so ignore this
 
-    def report_time(self, time):
-        self._ops.report_time(time)
+    def time(self, time):
+        self._ops.time(time)
 
     def progress(self, delta, whence):
         self._ops.progress(delta, whence)
@@ -271,51 +246,69 @@ class FilterOps(testtools.testresult.TestResult):
         else:
             self.output+=msg
 
-    def start_test(self, testname):
-        if self.prefix is not None:
-            testname = self.prefix + testname
-
+    def startTest(self, test):
+        test = self._add_prefix(test)
         if self.strip_ok_output:
            self.output = ""
 
-        self._ops.start_test(testname)
+        self._ops.startTest(test)
 
-    def end_test(self, testname, result, unexpected, reason):
+    def _add_prefix(self, test):
         if self.prefix is not None:
-            testname = self.prefix + testname
+            return subunit.RemotedTestCase(self.prefix + test.id())
+        else:
+            return test
 
-        if result in ("fail", "failure") and not unexpected:
-            result = "xfail"
-            self.xfail_added+=1
-            self.total_xfail+=1
-        xfail_reason = find_in_list(self.expected_failures, testname)
-        if xfail_reason is not None and result in ("fail", "failure"):
-            result = "xfail"
+    def addError(self, test, details=None):
+        test = self._add_prefix(test)
+        self.error_added+=1
+        self.total_error+=1
+        self._ops.addError(test, details)
+        self.output = None
+        if self.fail_immediately:
+            raise ImmediateFail()
+
+    def addSkip(self, test, details=None):
+        test = self._add_prefix(test)
+        self._ops.addSkip(test, details)
+        self.output = None
+
+    def addExpectedFailure(self, test, details=None):
+        test = self._add_prefix(test)
+        self._ops.addExpectedFailure(test, details)
+        self.output = None
+
+    def addFailure(self, test, details=None):
+        test = self._add_prefix(test)
+        xfail_reason = find_in_list(self.expected_failures, test.id())
+        if xfail_reason is not None:
             self.xfail_added+=1
             self.total_xfail+=1
-            reason += xfail_reason
-
-        if result in ("fail", "failure"):
+            if details is not None:
+                details = subunit.RemoteError(unicode(details[1]) + xfail_reason.decode("utf-8"))
+            else:
+                details = subunit.RemoteError(xfail_reason.decode("utf-8"))
+            self._ops.addExpectedFailure(test, details)
+        else:
             self.fail_added+=1
             self.total_fail+=1
-
-        if result == "error":
-            self.error_added+=1
-            self.total_error+=1
-
-        if self.strip_ok_output:
-            if result not in ("success", "xfail", "skip"):
-                print self.output
+            self._ops.addFailure(test, details)
+            if self.output:
+                self._ops.output_msg(self.output)
+            if self.fail_immediately:
+                raise ImmediateFail()
         self.output = None
 
-        self._ops.end_test(testname, result, reason)
+    def addSuccess(self, test, details=None):
+        test = self._add_prefix(test)
+        self._ops.addSuccess(test, details)
+        self.output = None
 
     def skip_testsuite(self, name, reason=None):
         self._ops.skip_testsuite(name, reason)
 
     def start_testsuite(self, name):
         self._ops.start_testsuite(name)
-
         self.error_added = 0
         self.fail_added = 0
         self.xfail_added = 0
@@ -345,13 +338,17 @@ class FilterOps(testtools.testresult.TestResult):
 
         self._ops.end_testsuite(name, result, reason)
 
-    def __init__(self, prefix, expected_failures, strip_ok_output):
-        self._ops = SubunitOps()
+    def __init__(self, out, prefix, expected_failures, strip_ok_output, fail_immediately=False):
+        self._ops = out
         self.output = None
         self.prefix = prefix
         self.expected_failures = expected_failures
         self.strip_ok_output = strip_ok_output
         self.xfail_added = 0
+        self.fail_added = 0
         self.total_xfail = 0
         self.total_error = 0
         self.total_fail = 0
+        self.error_added = 0
+        self.fail_immediately = fail_immediately
+