Changeset 149 for trunk/test

Timestamp:

12/31/07 13:14:18 (3 years ago)

Author:

akaihola

Message:

[test] Completed the test.simple.run_tests_until_fail() utility.

Files:

• trunk/test/simple.py (modified) (4 diffs)

trunk/test/simple.py

@@ +1 @@
+__doc__ = """
+In your settings, use
+
+  TEST_RUNNER = 'ambidjangolib.test.simple.run_tests_until_fail'
+
+to make `manage.py test` stop after the first test suite with failures, and
+only show the first failing test in the suite.
+"""
+
+
 from unittest import \
      TestSuite, TextTestRunner, _TextTestResult, defaultTestLoader
-from django.test._doctest import DocTestSuite, REPORT_ONLY_FIRST_FAILURE
+from django.test import _doctest as doctest
 from django.conf import settings
+from django.db import transaction
 from django.db.models import get_app, get_apps
-from django.test.utils import setup_test_environment, teardown_test_environment
-from django.test.utils import create_test_db, destroy_test_db
+from django.test.utils import \
+     setup_test_environment, teardown_test_environment, \
+     create_test_db, destroy_test_db
 from django.test.simple import build_test, get_tests, doctestOutputChecker
 from django.test.testcases import DocTestRunner
 
 
+class DocTestRunner(doctest.DocTestRunner):
+    """
+    Replacement for django.test.testcases.DocTestRunner which unfortunately
+    overrides any supplied `optionflags=` kwarg with only `doctest.ELLIPSIS`.
+    We need to pass on optionflags.
+    """
+    def __init__(self, *args, **kwargs):
+        doctest.DocTestRunner.__init__(self, *args, **kwargs)
+        self.optionflags |= doctest.ELLIPSIS
+        # Django's original has `=` instead of `|=` here
+
+    def report_unexpected_exception(self, out, test, example, exc_info):
+        doctest.DocTestRunner.report_unexpected_exception(self, out, test,
+                                                          example, exc_info)
+        # Rollback, in case of database errors. Otherwise they'd have
+        # side effects on other tests.
+        transaction.rollback_unless_managed()
+
+
 def _add_tests_for_module(suite, module):
+    """
+    Repeated code from inside `build_suite()` is refactored here.
+    """
     # Load unit and doctests in the given module. If module has a suite()
     # method, use it. Otherwise build the test suite ourselves.
@@ -18 +52 @@
         suite.addTest(defaultTestLoader.loadTestsFromModule(module))
         try:
-            suite.addTest(DocTestSuite(module,
-                                       checker=doctestOutputChecker,
-                                       runner=DocTestRunner,
-                                       optionflags=REPORT_ONLY_FIRST_FAILURE))
+            suite.addTest(doctest.DocTestSuite(
+                module,
+                checker=doctestOutputChecker,
+                runner=DocTestRunner,
+                optionflags=doctest.REPORT_ONLY_FIRST_FAILURE))
         except ValueError:
             # No doc tests in models.py
@@ -28 +63 @@
 
 def build_suite(app_module):
-    "Create a complete Django test suite for the provided application module"
+    """
+    Create a complete Django test suite for the provided application module.
+
+    This overrides Django's original `django.test.simple.build_suite()` because
+    we need to pass the `REPORT_ONLY_FIRST_FAILURE` option flag to
+    `DocTestSuite` instances.
+    """
     suite = TestSuite()
 
     _add_tests_for_module(suite, app_module)
 
-    # Check to see if a separate 'tests' module exists parallel to the 
+    # Check to see if a separate 'tests' module exists parallel to the
     # models module
     test_module = get_tests(app_module)
@@ -77 +118 @@
     Stops the tests at the first failure and returns 1.  If all test pass,
     returns 0.
+
+    Also displays only the first failure in the failing test suite.
     """
     setup_test_environment()