Merge lp:~allenap/commandant/test-failures-updated-bzrlib-possibly into lp:commandant

[Gavin Panella]

Be more forgiving of test output that may vary as a result of changes in dependencies.

The ordering of the standard --quiet and --verbose flags, for example, seems to have changed, possibly as a result of changes in bzrlib. This detail is irrelevant in the tests, however, so testtools.matchers.DocTestMatches is used to test output with more flexibility.

[Jamu Kakar (jkakar)]

I got a bunch of test failures here:

[ERROR]
Traceback (most recent call last):
Failure: testtools.testresult.real._StringException: ValueError: TestCase.setUp was not called. Have you upcalled all the way up the hierarchy from your setUp? e.g. Call super(HelpCommandTest, self).setUp() from your setUp().

commandant.tests.test_builtins.HelpCommandTest.test_run_commands
commandant.tests.test_builtins.HelpCommandTest.test_run_commands_with_custom_help_help_topic
commandant.tests.test_builtins.HelpCommandTest.test_run_commands_with_custom_help_topic
commandant.tests.test_builtins.HelpCommandTest.test_run_commands_without_docstring
commandant.tests.test_builtins.HelpCommandTest.test_run_hidden_commands
commandant.tests.test_builtins.HelpCommandTest.test_run_hidden_commands_without_hidden_commands
commandant.tests.test_builtins.HelpCommandTest.test_run_many_commands
commandant.tests.test_builtins.HelpCommandTest.test_run_topics
commandant.tests.test_builtins.HelpCommandTest.test_run_topics_ignores_custom_command_help
commandant.tests.test_builtins.HelpCommandTest.test_run_topics_with_custom_help_topic
commandant.tests.test_builtins.HelpCommandTest.test_run_topics_with_custom_underscore_help_topic
commandant.tests.test_builtins.HelpCommandTest.test_run_with_custom_help_text
commandant.tests.test_builtins.HelpCommandTest.test_run_with_custom_help_text_trims_trailing_whitespace
commandant.tests.test_builtins.HelpCommandTest.test_run_with_custom_topic
commandant.tests.test_builtins.HelpCommandTest.test_run_with_custom_topic_strips_whitespace
commandant.tests.test_builtins.HelpCommandTest.test_run_with_hidden_commands
commandant.tests.test_builtins.HelpCommandTest.test_run_with_python_command_topic
commandant.tests.test_builtins.HelpCommandTest.test_run_with_python_command_without_docstring
commandant.tests.test_builtins.HelpCommandTest.test_run_with_stock_help_text
commandant.tests.test_builtins.HelpCommandTest.test_run_with_unknown_command_or_topic_name
===============================================================================
[ERROR]
Traceback (most recent call last):
Failure: testtools.testresult.real._StringException: ValueError: TestCase.setUp was not called. Have you upcalled all the way up the hierarchy from your setUp? e.g. Call super(CommandHelpTopicTest, self).setUp() from your setUp().

commandant.tests.test_help_topics.CommandHelpTopicTest.test_get_help_contents
commandant.tests.test_help_topics.CommandHelpTopicTest.test_instantiate
===============================================================================
[ERROR]
Traceback (most recent call last):
Failure: testtools.testresult.real._StringException: ValueError: TestCase.setUp was not called. Have you upcalled all the way up the hierarchy from your setUp? e.g. Call super(CustomCommandHelpTopicTest, self).setUp() from your setUp().

commandant.tests.test_help_topics.CustomCommandHelpTopicTest.test_get_help_contents
-------------------------------------------------------------------------------
Ran 83 tests in 0.437s

FAILED (errors=23, successes=60)
make: *** [check] Error 1

I've fixed this by adding a new commandant.testing.basic.CommandantTestCase
class that calls the setUp...

=== modified file 'commandant/tests/test_builtins.py'
--- commandant/tests/test_builtins.py	2010-06-12 13:58:13 +0000
+++ commandant/tests/test_builtins.py	2012-09-05 18:28:21 +0000
@@ -17,11 +17,15 @@
 
 """Unit tests for L{commandant.builtins}."""
 
+import doctest
 import os
+from textwrap import dedent
 
 from bzrlib.commands import Command
 
 from testresources import ResourcedTestCase
+from testtools import TestCase
+from testtools.matchers import DocTestMatches
 
 from commandant import __version__
 from commandant.builtins import (
@@ -71,7 +75,7 @@
             self.command.outf.getvalue().startswith("test 42.3.17\n"))
 
 
-class HelpCommandTest(ResourcedTestCase):
+class HelpCommandTest(ResourcedTestCase, TestCase):
     """Tests for L{cmd_help}."""
 
     resources = [("factory", CommandFactoryResource())]
@@ -177,10 +181,13 @@
 
         self.factory.create_command("fake-command", cmd_fake_command)
         self.command.run(topic="commands")
-        self.assertEquals(self.command.outf.getvalue(), """\
-fake-command  
-help          Show help about a command or topic.
-""")
+        expected = dedent("""\
+            fake-command
+            help          Show help about a command or topic.
+            """)
+        self.assertThat(
+            self.command.outf.getvalue(),
+            DocTestMatches(expected, doctest.NORMALIZE_WHITESPACE))
 
     def test_run_commands_with_custom_help_topic(self):
         """
@@ -375,19 +382,21 @@
 
         self.factory.create_command("test-command", cmd_test_command)
         self.command.run(topic="test-command")
-        self.assertEquals(self.command.outf.getvalue(), """\
-Purpose: A test command.
-Usage:   commandant test-command
-
-Options:
-  --usage        Show usage message and options.
-  -v, --verbose  Display more information.
-  -q, --quiet    Only display errors and warnings.
-  -h, --help     Show help message.
-
-Description:
-  This is the help text for this test command.
-""")
+        expected = dedent("""\
+            Purpose: A test command.
+            Usage:   commandant test-command
+
+            Options:
+              --usage        Show usage message and options.
+              ...
+              -h, --help     Show help message.
+
+            Description:
+              This is the help text for this test command.
+            """)
+        self.assertThat(
+            self.command.outf.getvalue(),
+            DocTestMatches(expected, doctest.ELLIPSIS))
 
     def test_run_with_python_command_without_docstring(self):
         """

=== modified file 'commandant/tests/test_controller.py'
--- commandant/tests/test_controller.py	2010-06-12 13:58:13 +0000
+++ commandant/tests/test_controller.py	2012-09-05 18:28:21 +0000
@@ -138,8 +138,13 @@
         self.controller.install_bzrlib_hooks()
         self.controller.register_command("fake-command", FakeArgumentCommand)
         self.controller.run(["fake-command", "test-arg"])
-        self.assertEquals(sys.stdout.getvalue(),
-                          "((), {'test_arg': 'test-arg'})")
+        # The argument value is sometimes be coerced into a unicode
+        # string. Could this be a change in bzrlib?
+        self.assertIn(
+            sys.stdout.getvalue(), (
+                "((), {'test_arg': 'test-arg'})",
+                "((), {'test_arg': u'test-arg'})",
+                ))
 
     def test_register_help_topic(self):
         """

=== modified file 'commandant/tests/test_help_topics.py'
--- commandant/tests/test_help_topics.py	2010-06-12 13:58:13 +0000
+++ commandant/tests/test_help_topics.py	2012-09-05 18:28:21 +0000
@@ -17,10 +17,13 @@
 
 """Unit tests for L{commandant.help_topics}."""
 
+import doctest
 import os
-from unittest import TestCase
+from textwrap import dedent
 
 from testresources import ResourcedTestCase
+from testtools import TestCase
+from testtools.matchers import DocTestMatches
 
 from commandant.help_topics import (
     HelpTopic, DocstringHelpTopic, FileHelpTopic, CommandHelpTopic)
@@ -98,7 +101,7 @@
             "the help topic.")
 
 
-class CommandHelpTopicTest(ResourcedTestCase):
+class CommandHelpTopicTest(ResourcedTestCase, TestCase):
     """Tests for L{CommandHelpTopic}."""
 
     resources = [("factory", CommandFactoryResource())]
@@ -122,23 +125,23 @@
         help_topic = CommandHelpTopic(command)
         help_topic.controller = self.factory.controller
         self.assertEquals(help_topic.get_summary(), "Summary text.")
-        self.assertEquals(help_topic.get_text() + "\n", """\
-Purpose: Summary text.
-Usage:   commandant fake-command
-
-Options:
-  --usage        Show usage message and options.
-  -v, --verbose  Display more information.
-  -q, --quiet    Only display errors and warnings.
-  -h, --help     Show help message.
-
-Description:
-  Long descriptive text that
-  spans multiples lines.
-""")
-
-
-class CustomCommandHelpTopicTest(ResourcedTestCase):
+        expected = dedent("""\
+            Purpose: Summary text.
+            Usage:   commandant fake-command
+
+            Options:
+              ...
+
+            Description:
+              Long descriptive text that
+              spans multiples lines.
+            """)
+        self.assertThat(
+            help_topic.get_text() + "\n",
+            DocTestMatches(expected, doctest.ELLIPSIS))
+
+
+class CustomCommandHelpTopicTest(ResourcedTestCase, TestCase):
     """Tests for L{CommandHelpTopic} with custom program details."""
 
     resources = [("factory", CommandFactoryResource("test-program"))]
@@ -153,17 +156,17 @@
         help_topic = CommandHelpTopic(command)
         help_topic.controller = self.factory.controller
         self.assertEquals(help_topic.get_summary(), "Summary text.")
-        self.assertEquals(help_topic.get_text() + "\n", """\
-Purpose: Summary text.
-Usage:   test-program fake-command
-
-Options:
-  --usage        Show usage message and options.
-  -v, --verbose  Display more information.
-  -q, --quiet    Only display errors and warnings.
-  -h, --help     Show help message.
-
-Description:
-  Long descriptive text that
-  spans multiples lines.
-""")
+        expected = dedent("""\
+            Purpose: Summary text.
+            Usage:   test-program fake-command
+
+            Options:
+              ...
+
+            Description:
+              Long descriptive text that
+              spans multiples lines.
+            """)
+        self.assertThat(
+            help_topic.get_text() + "\n",
+            DocTestMatches(expected, doctest.ELLIPSIS))