Merge lp:~jtv/maas-test/fix-setup-error-reporting into lp:maas-test

[Jeroen T. Vermeulen]

Fix breakage when reporting errors during the main script's test setup.

We were using an undocumented trick to show a test's full docstring as part of its description, and it broke when no test was running at the time of the error. There is a documented way: override shortDescription() on the test case.

This won't scale trivially to multiple test cases, but we can cross that bridge when we get to it. A mix-in base class would do it, or a decorator, or just repeating the one-liner with a brief docstring, or patching up the test runner.

(Also, we no longer use the command counter in TestMAAS. That moved into the KVMFixture.)

Jeroen

[Julian Edwards (julian-edwards)]

review: Approve

=== modified file 'maastest/main.py'
--- maastest/main.py	2013-11-07 16:05:06 +0000
+++ maastest/main.py	2013-11-12 04:43:07 +0000
@@ -14,7 +14,6 @@
     "main",
     ]
 
-import itertools
 import logging
 import sys
 import unittest
@@ -27,10 +26,6 @@
 
 class TestMAAS(testtools.TestCase, testresources.ResourcedTestCase):
 
-    def __init__(self, *args, **kwargs):
-        super(TestMAAS, self).__init__(*args, **kwargs)
-        self.command_count = itertools.count(1)
-
     @classmethod
     def setUpClass(cls):
         # TODO: series and architecture should be script parameters.
@@ -43,6 +38,18 @@
         cls.machine.cleanUp()
         super(TestMAAS, cls).tearDownClass()
 
+    def shortDescription(self):
+        """Overridable from `unittest`: Describe the ongoing test.
+
+        By default this shows the first line of the test's docstring (if
+        available), but this `TestCase` is basically our UI so we want full,
+        user-friendly docstrings.
+        """
+        # Cribbed from unittest2.TestCase.  The difference is that we return
+        # the whole docstring, instead of just the first line.
+        # Future maintainers beware: the docstring may also be None.
+        return self._testMethodDoc
+
     # XXX 2013-11-07 gmb bug=897190:
     #     This exists because of the above bug in testtools, which means
     #     that fixture details don't get included with the TestCase
@@ -66,13 +73,6 @@
         self.assertEqual(0, retcode)
 
 
-class TextTestResult(unittest.runner.TextTestResult):
-    """A TextTestResult which displays the test's docstrings."""
-
-    def getDescription(self, test):
-        return getattr(test.__class__, test._testMethodName).__doc__
-
-
 def main(args=None):
     # TODO: control the order in which the tests are run.  By default
     # the tests are run in alphabetical order and we should use the order
@@ -82,8 +82,7 @@
         level=logging.DEBUG, stream=output_stream, format="%(message)s")
     suite = unittest.TestLoader().loadTestsFromTestCase(TestMAAS)
     runner = unittest.TextTestRunner(
-        stream=output_stream, verbosity=2, descriptions=False,
-        resultclass=TextTestResult)
+        stream=output_stream, verbosity=2, descriptions=False)
     runner.run(suite)