Merge lp:~bac/testrepository/bug-949950-2 into lp:~testrepository/testrepository/trunk

[Brad Crittenden]

As requested, a '--subunit' option was added to the run command to get results in subunit format.

The change to test_cli.py was required or 'make_results' was unhappy due to not having an 'options' attribute, so the tests were made more robust.

In response to a previous review, moved the TestResultFilter into the UI 'make_results' method and added a '--full-results' option to not do any filtering. The default is to filter as before.

[Jonathan Lange (jml)]

Hi Brad,

Thanks for the changes, it really makes a difference.

I've tweaked the tests to test behaviour rather than return type (http://paste.ubuntu.com/935581/). Other than that, is good to land as-is. Will do so now.

jml

review: Approve

=== modified file 'testrepository/commands/load.py'
--- testrepository/commands/load.py	2011-11-03 15:09:02 +0000
+++ testrepository/commands/load.py	2012-04-17 20:38:17 +0000
@@ -21,7 +21,6 @@
 
 from testrepository.commands import Command
 from testrepository.repository import RepositoryNotFound
-from testrepository.results import TestResultFilter
 
 
 class load(Command):
@@ -42,6 +41,10 @@
             "--force-init", action="store_true",
             default=False,
             help="Initialise the repository if it does not exist already"),
+        optparse.Option("--subunit", action="store_true",
+            default=False, help="Display results in subunit format."),
+        optparse.Option("--full-results", action="store_true",
+            default=False, help="Show all test results."),
         ]
 
     def run(self):
@@ -69,16 +72,14 @@
         except KeyError:
             previous_run = None
         output_result = self.ui.make_result(lambda: run_id, previous_run)
-        # XXX: We want to *count* skips, but not show them.
-        filtered = TestResultFilter(output_result, filter_skip=False)
-        filtered.startTestRun()
+        output_result.startTestRun()
         inserter.startTestRun()
         try:
-            case.run(MultiTestResult(inserter, filtered))
+            case.run(MultiTestResult(inserter, output_result))
         finally:
             run_id = inserter.stopTestRun()
-            filtered.stopTestRun()
-        if not filtered.wasSuccessful():
+            output_result.stopTestRun()
+        if not output_result.wasSuccessful():
             return 1
         else:
             return 0

=== modified file 'testrepository/commands/run.py'
--- testrepository/commands/run.py	2010-12-19 09:17:29 +0000
+++ testrepository/commands/run.py	2012-04-17 20:38:17 +0000
@@ -1,11 +1,11 @@
 #
-# Copyright (c) 2010 Testrepository Contributors
-# 
+# Copyright (c) 2010-2012 Testrepository Contributors
+#
 # Licensed under either the Apache License, Version 2.0 or the BSD 3-clause
 # 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
@@ -14,11 +14,7 @@
 
 """Run a projects tests and load them into testrepository."""
 
-import ConfigParser
-from cStringIO import StringIO
 import optparse
-import os.path
-import string
 
 from testtools import TestResult
 
@@ -39,7 +35,12 @@
         optparse.Option("--parallel", action="store_true",
             default=False, help="Run tests in parallel processes."),
         optparse.Option("--partial", action="store_true",
-            default=False, help="Only some tests will be run. Implied by --failing."),
+            default=False,
+            help="Only some tests will be run. Implied by --failing."),
+        optparse.Option("--subunit", action="store_true",
+            default=False, help="Display results in subunit format."),
+        optparse.Option("--full-results", action="store_true",
+            default=False, help="Show all test results."),
         ]
     args = [StringArgument('testargs', 0, None)]
     # Can be assigned to to inject a custom command factory.

=== modified file 'testrepository/tests/test_ui.py'
--- testrepository/tests/test_ui.py	2011-11-02 19:27:08 +0000
+++ testrepository/tests/test_ui.py	2012-04-17 20:38:17 +0000
@@ -1,11 +1,11 @@
 #
 # Copyright (c) 2009, 2010 Testrepository Contributors
-# 
+#
 # Licensed under either the Apache License, Version 2.0 or the BSD 3-clause
 # 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
@@ -17,15 +17,18 @@
 from cStringIO import StringIO
 import optparse
 import subprocess
+import subunit
 import sys
 
 from testtools.matchers import raises
 
 from testrepository import arguments, commands
 from testrepository.commands import load
+from testrepository.commands.run import run
 from testrepository.repository import memory
+from testrepository.results import TestResultFilter
+from testrepository.tests import ResourcedTestCase
 from testrepository.ui import cli, decorator, model
-from testrepository.tests import ResourcedTestCase
 
 
 def cli_ui_factory(input_streams=None, options=(), args=()):
@@ -119,7 +122,7 @@
         # output_table shows a table.
         ui = self.get_test_ui()
         ui.output_table([('col1', 'col2'), ('row1c1','row1c2')])
-        
+
     def test_output_tests(self):
         # output_tests can be called, and takes a list of tests to output.
         ui = self.get_test_ui()
@@ -228,7 +231,35 @@
         # make_result can take a previous run.
         ui = self.ui_factory()
         ui.set_command(commands.Command(ui))
-        result = ui.make_result(lambda: None, memory.Repository().get_failing())
+        result = ui.make_result(
+            lambda: None, memory.Repository().get_failing())
         result.startTestRun()
         result.stopTestRun()
         self.assertEqual(0, result.testsRun)
+
+
+class TestCLIUISpecific(ResourcedTestCase):
+
+    def test_run_subunit_option(self):
+        ui = cli_ui_factory(options=[('subunit', True)])
+        ui.set_command(run)
+        self.assertEqual(True, ui.options.subunit)
+
+    def test_check_result_output_filtered(self):
+        ui = cli_ui_factory(
+            options=[
+                ('subunit', True),
+                ])
+        ui.set_command(run)
+        result = ui.make_result(lambda: None)
+        self.assertTrue(isinstance(result, TestResultFilter))
+
+    def test_check_result_output_unfiltered(self):
+        ui = cli_ui_factory(
+            options=[
+                ('subunit', True),
+                ('full-results', True),
+                ])
+        ui.set_command(run)
+        result = ui.make_result(lambda: None)
+        self.assertTrue(isinstance(result, subunit.TestProtocolClient))

=== modified file 'testrepository/tests/ui/test_cli.py'
--- testrepository/tests/ui/test_cli.py	2012-04-02 12:14:26 +0000
+++ testrepository/tests/ui/test_cli.py	2012-04-17 20:38:17 +0000
@@ -17,6 +17,7 @@
 
 import doctest
 from cStringIO import StringIO
+import optparse
 import sys
 
 from testtools import TestCase
@@ -230,10 +231,19 @@
         except ZeroDivisionError:
             return sys.exc_info()
 
-    def make_result(self, stream=None):
+    def make_result(self, stream=None, fullresults=False):
         if stream is None:
             stream = StringIO()
-        ui = cli.UI([], None, stream, None)
+        argv = []
+        if fullresults:
+            argv.append('--full-results')
+        ui = cli.UI(argv, None, stream, None)
+        cmd = commands.Command(ui)
+        if fullresults:
+            cmd.options = [optparse.Option(
+                "--full-results", action="store_true", default=False,
+                help="Show full results.")]
+        ui.set_command(cmd)
         return ui.make_result(lambda: None)
 
     def test_initial_stream(self):
@@ -247,7 +257,7 @@
         # CLITestResult formats errors by giving them a big fat line, a title
         # made up of their 'label' and the name of the test, another different
         # big fat line, and then the actual error itself.
-        result = self.make_result()
+        result = self.make_result(fullresults=True)
         error = result._format_error('label', self, 'error text')
         expected = '%s%s: %s\n%s%s' % (
             result.sep1, 'label', self.id(), result.sep2, 'error text')
@@ -257,7 +267,7 @@
         # CLITestResult.addError outputs the given error immediately to the
         # stream.
         stream = StringIO()
-        result = self.make_result(stream)
+        result = self.make_result(stream, fullresults=True)
         error = self.make_exc_info()
         error_text = result._err_details_to_string(self, error)
         result.addError(self, error)
@@ -269,7 +279,7 @@
         # CLITestResult.addFailure outputs the given error immediately to the
         # stream.
         stream = StringIO()
-        result = self.make_result(stream)
+        result = self.make_result(stream, fullresults=True)
         error = self.make_exc_info()
         error_text = result._err_details_to_string(self, error)
         result.addFailure(self, error)
@@ -281,7 +291,7 @@
         # CLITestResult.addFailure outputs the given error handling non-ascii
         # characters.
         stream = StringIO()
-        result = self.make_result(stream)
+        result = self.make_result(stream, fullresults=True)
         class MyError(ValueError):
             def __unicode__(self):
                 return u'\u201c'

=== modified file 'testrepository/ui/cli.py'
--- testrepository/ui/cli.py	2012-03-29 10:58:30 +0000
+++ testrepository/ui/cli.py	2012-04-17 20:38:17 +0000
@@ -17,11 +17,13 @@
 from optparse import OptionParser
 import os
 import signal
+import subunit
 import sys
 
 from testtools.compat import unicode_output_stream
 
 from testrepository import ui
+from testrepository.results import TestResultFilter
 
 
 class CLITestResult(ui.BaseUITestResult):
@@ -71,7 +73,16 @@
         yield self._stdin
 
     def make_result(self, get_id, previous_run=None):
-        return CLITestResult(self, get_id, self._stdout, previous_run)
+        if getattr(self.options, 'subunit', False):
+            results = subunit.TestProtocolClient(self._stdout)
+        else:
+            results = CLITestResult(self, get_id, self._stdout, previous_run)
+
+        if not getattr(self.options, 'full_results', False):
+            # XXX: We want to *count* skips, but not show them.
+            filtered = TestResultFilter(results, filter_skip=False)
+            return filtered
+        return results
 
     def output_error(self, error_tuple):
         self._stderr.write(str(error_tuple[1]) + '\n')
@@ -136,7 +147,8 @@
             outputs.append('%s=%s' % (label, value))
         self._stdout.write('%s\n' % ', '.join(outputs))
 
-    def _format_summary(self, successful, tests, tests_delta, time, time_delta, values):
+    def _format_summary(self, successful, tests, tests_delta,
+                        time, time_delta, values):
         # We build the string by appending to a list of strings and then
         # joining trivially at the end. Avoids expensive string concatenation.
         summary = []
@@ -170,7 +182,8 @@
             a(')')
         return ''.join(summary)
 
-    def output_summary(self, successful, tests, tests_delta, time, time_delta, values):
+    def output_summary(self, successful, tests, tests_delta,
+                       time, time_delta, values):
         self._stdout.write(
             self._format_summary(
                 successful, tests, tests_delta, time, time_delta, values))