Merge lp:~jml/subunit/move-ls into lp:~subunit/subunit/trunk

[Jonathan Lange]

Move subunit-ls guts into subunit.test_results

This moves the code with the logic for subunit-ls out of the binary and into subunit.test_results, where it can be imported from and re-used in other Python applications.

[Jelmer Vernooij (jelmer)]

review: Approve

=== modified file 'filters/subunit-ls'
--- filters/subunit-ls	2009-09-30 12:04:18 +0000
+++ filters/subunit-ls	2010-08-04 17:10:55 +0000
@@ -18,58 +18,9 @@
 
 from optparse import OptionParser
 import sys
-import unittest
 
 from subunit import DiscardStream, ProtocolTestCase
-
-class TestIdPrintingResult(unittest.TestResult):
-
-    def __init__(self, stream, show_times=False):
-        """Create a FilterResult object outputting to stream."""
-        unittest.TestResult.__init__(self)
-        self._stream = stream
-        self.failed_tests = 0
-        self.__time = 0
-        self.show_times = show_times
-        self._test = None
-        self._test_duration = 0
-        
-    def addError(self, test, err):
-        self.failed_tests += 1
-        self._test = test
-
-    def addFailure(self, test, err):
-        self.failed_tests += 1
-        self._test = test
-
-    def addSuccess(self, test):
-        self._test = test
-
-    def reportTest(self, test, duration):
-        if self.show_times:
-            seconds = duration.seconds
-            seconds += duration.days * 3600 * 24
-            seconds += duration.microseconds / 1000000.0
-            self._stream.write(test.id() + ' %0.3f\n' % seconds)
-        else:
-            self._stream.write(test.id() + '\n')
-
-    def startTest(self, test):
-        self._start_time = self._time()
-
-    def stopTest(self, test):
-        test_duration = self._time() - self._start_time
-        self.reportTest(self._test, test_duration)
-
-    def time(self, time):
-        self.__time = time
-
-    def _time(self):
-        return self.__time
-
-    def wasSuccessful(self):
-        "Tells whether or not this result was a success"
-        return self.failed_tests == 0
+from subunit.test_results import TestIdPrintingResult
 
 
 parser = OptionParser(description=__doc__)

=== modified file 'python/subunit/test_results.py'
--- python/subunit/test_results.py	2010-03-11 21:12:10 +0000
+++ python/subunit/test_results.py	2010-08-04 17:10:55 +0000
@@ -6,7 +6,7 @@
 #  license at the users choice. A copy of both licenses are available in the
 #  project source as Apache-2.0 and BSD. You may not use this file except in
 #  compliance with one of these two licences.
-#  
+#
 #  Unless required by applicable law or agreed to in writing, software
 #  distributed under these licenses is distributed on an "AS IS" BASIS, WITHOUT
 #  WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.  See the
@@ -21,16 +21,14 @@
 import iso8601
 import testtools
 
-import subunit
-
 
 # NOT a TestResult, because we are implementing the interface, not inheriting
 # it.
 class TestResultDecorator(object):
     """General pass-through decorator.
 
-    This provides a base that other TestResults can inherit from to 
-    gain basic forwarding functionality. It also takes care of 
+    This provides a base that other TestResults can inherit from to
+    gain basic forwarding functionality. It also takes care of
     handling the case where the target doesn't support newer methods
     or features by degrading them.
     """
@@ -201,11 +199,11 @@
     """A pyunit TestResult interface implementation which filters tests.
 
     Tests that pass the filter are handed on to another TestResult instance
-    for further processing/reporting. To obtain the filtered results, 
+    for further processing/reporting. To obtain the filtered results,
     the other instance must be interrogated.
 
     :ivar result: The result that tests are passed to after filtering.
-    :ivar filter_predicate: The callback run to decide whether to pass 
+    :ivar filter_predicate: The callback run to decide whether to pass
         a result.
     """
 
@@ -213,7 +211,7 @@
         filter_success=True, filter_skip=False,
         filter_predicate=None):
         """Create a FilterResult object filtering to result.
-        
+
         :param filter_error: Filter out errors.
         :param filter_failure: Filter out failures.
         :param filter_success: Filter out successful tests.
@@ -238,9 +236,9 @@
         self._current_test_filtered = None
         # The (new, gone) tags for the current test.
         self._current_test_tags = None
-        
+
     def addError(self, test, err=None, details=None):
-        if (not self._filter_error and 
+        if (not self._filter_error and
             self.filter_predicate(test, 'error', err, details)):
             self.decorated.startTest(test)
             self.decorated.addError(test, err, details=details)
@@ -288,17 +286,17 @@
 
     def startTest(self, test):
         """Start a test.
-        
+
         Not directly passed to the client, but used for handling of tags
         correctly.
         """
         self._current_test = test
         self._current_test_filtered = False
         self._current_test_tags = set(), set()
-    
+
     def stopTest(self, test):
         """Stop a test.
-        
+
         Not directly passed to the client, but used for handling of tags
         correctly.
         """
@@ -316,7 +314,7 @@
 
         Adds and removes tags as appropriate. If a test is currently running,
         tags are not affected for subsequent tests.
-        
+
         :param new_tags: Tags to add,
         :param gone_tags: Tags to remove.
         """
@@ -332,3 +330,53 @@
         if id.startswith("subunit.RemotedTestCase."):
             return id[len("subunit.RemotedTestCase."):]
         return id
+
+
+class TestIdPrintingResult(testtools.TestResult):
+
+    def __init__(self, stream, show_times=False):
+        """Create a FilterResult object outputting to stream."""
+        testtools.TestResult.__init__(self)
+        self._stream = stream
+        self.failed_tests = 0
+        self.__time = 0
+        self.show_times = show_times
+        self._test = None
+        self._test_duration = 0
+
+    def addError(self, test, err):
+        self.failed_tests += 1
+        self._test = test
+
+    def addFailure(self, test, err):
+        self.failed_tests += 1
+        self._test = test
+
+    def addSuccess(self, test):
+        self._test = test
+
+    def reportTest(self, test, duration):
+        if self.show_times:
+            seconds = duration.seconds
+            seconds += duration.days * 3600 * 24
+            seconds += duration.microseconds / 1000000.0
+            self._stream.write(test.id() + ' %0.3f\n' % seconds)
+        else:
+            self._stream.write(test.id() + '\n')
+
+    def startTest(self, test):
+        self._start_time = self._time()
+
+    def stopTest(self, test):
+        test_duration = self._time() - self._start_time
+        self.reportTest(self._test, test_duration)
+
+    def time(self, time):
+        self.__time = time
+
+    def _time(self):
+        return self.__time
+
+    def wasSuccessful(self):
+        "Tells whether or not this result was a success"
+        return self.failed_tests == 0