def process_tests(suite, process):
"""Given a nested disaster of [Lazy]Suites, traverse to the first level
that has setup or teardown, and do something to them.
If we were to traverse all the way to the leaves (the Tests)
indiscriminately and return them, when the runner later calls them, they'd
run without reference to the suite that contained them, so they'd miss
their class-, module-, and package-wide setup and teardown routines.
The nested suites form basically a double-linked tree, and suites will call
up to their containing suites to run their setups and teardowns, but it
would be hubris to assume that something you saw fit to setup or teardown
at the module level is less costly to repeat than DB fixtures. Also, those
sorts of setups and teardowns are extremely rare in our code. Thus, we
limit the granularity of bucketing to the first level that has setups or
teardowns.
:arg process: The thing to call once we get to a leaf or a test with setup
or teardown
"""
if (not hasattr(suite, '_tests') or
(hasattr(suite, 'hasFixtures') and suite.hasFixtures())):
# We hit a Test or something with setup, so do the thing. (Note that
# "fixtures" here means setup or teardown routines, not Django
# fixtures.)
process(suite)
else:
for t in suite._tests:
process_tests(t, process)
def _put_transaction_test_cases_last(self, test):
"""Reorder tests in the suite so TransactionTestCase-based tests come
last.
Django has a weird design decision wherein TransactionTestCase doesn't
clean up after itself. Instead, it resets the DB to a clean state only
at the *beginning* of each test:
https://docs.djangoproject.com/en/dev/topics/testing/?from=olddocs#
django. test.TransactionTestCase. Thus, Django reorders tests so
TransactionTestCases all come last. Here we do the same.
"I think it's historical. We used to have doctests also, adding cleanup
after each unit test wouldn't necessarily clean up after doctests, so
you'd have to clean on entry to a test anyway." was once uttered on
#django-dev.
"""
def filthiness(test):
"""Return a comparand based on whether a test is guessed to clean
up after itself.
Django's TransactionTestCase doesn't clean up the DB on teardown,
but it's hard to guess whether subclasses (other than TestCase) do.
We will assume they don't, unless they have a
``cleans_up_after_itself`` attr set to True. This is reasonable
because the odd behavior of TransactionTestCase is documented, so
subclasses should by default be assumed to preserve it.
Thus, things will get these comparands (and run in this order):
* 1: TestCase subclasses. These clean up after themselves.
* 1: TransactionTestCase subclasses with
cleans_up_after_itself=True. These include
FastFixtureTestCases. If you're using the
FixtureBundlingPlugin, it will pull the FFTCs out, reorder
them, and run them first of all.
* 2: TransactionTestCase subclasses. These leave a mess.
* 2: Anything else (including doctests, I hope). These don't care
about the mess you left, because they don't hit the DB or, if
they do, are responsible for ensuring that it's clean (as per
https://docs.djangoproject.com/en/dev/topics/testing/?from=
olddocs#writing-doctests)
"""
test_class = test.context
if is_subclass_at_all(test_class, TestCase) or (
is_subclass_at_all(test_class, TransactionTestCase)
and getattr(test_class, "cleans_up_after_itself", False)
):
return 1
return 2
flattened = []
process_tests(test, flattened.append)
flattened.sort(key=filthiness)
return ContextSuite(flattened)
def _put_transaction_test_cases_last(self, test):
"""Reorder tests in the suite so TransactionTestCase-based tests come
last.
Django has a weird design decision wherein TransactionTestCase doesn't
clean up after itself. Instead, it resets the DB to a clean state only
at the *beginning* of each test:
https://docs.djangoproject.com/en/dev/topics/testing/?from=olddocs#
django. test.TransactionTestCase. Thus, Django reorders tests so
TransactionTestCases all come last. Here we do the same.
"I think it's historical. We used to have doctests also, adding cleanup
after each unit test wouldn't necessarily clean up after doctests, so
you'd have to clean on entry to a test anyway." was once uttered on
#django-dev.
"""
def filthiness(test):
"""Return a comparand based on whether a test is guessed to clean
up after itself.
Django's TransactionTestCase doesn't clean up the DB on teardown,
but it's hard to guess whether subclasses (other than TestCase) do.
We will assume they don't, unless they have a
``cleans_up_after_itself`` attr set to True. This is reasonable
because the odd behavior of TransactionTestCase is documented, so
subclasses should by default be assumed to preserve it.
Thus, things will get these comparands (and run in this order):
* 1: TestCase subclasses. These clean up after themselves.
* 1: TransactionTestCase subclasses with
cleans_up_after_itself=True. These include
FastFixtureTestCases. If you're using the
FixtureBundlingPlugin, it will pull the FFTCs out, reorder
them, and run them first of all.
* 2: TransactionTestCase subclasses. These leave a mess.
* 2: Anything else (including doctests, I hope). These don't care
about the mess you left, because they don't hit the DB or, if
they do, are responsible for ensuring that it's clean (as per
https://docs.djangoproject.com/en/dev/topics/testing/?from=
olddocs#writing-doctests)
"""
test_class = test.context
if (is_subclass_at_all(test_class, TestCase) or
(is_subclass_at_all(test_class, TransactionTestCase) and
getattr(test_class, 'cleans_up_after_itself', False))):
return 1
return 2
flattened = []
process_tests(test, flattened.append)
flattened.sort(key=filthiness)
return ContextSuite(flattened)
def suite_sorted_by_fixtures(suite):
"""Flatten and sort a tree of Suites by the ``fixtures`` members of
their contexts.
Add ``_fb_should_setup_fixtures`` and
``_fb_should_teardown_fixtures`` attrs to each test class to advise
it whether to set up or tear down (respectively) the fixtures.
Return a Suite.
"""
bucketer = Bucketer()
process_tests(suite, bucketer.add)
# Lay the bundles of common-fixture-having test classes end to end
# in a single list so we can make a test suite out of them:
flattened = []
for ((fixtures, is_exempt),
fixture_bundle) in bucketer.buckets.items():
# Advise first and last test classes in each bundle to set up
# and tear down fixtures and the rest not to:
if fixtures and not is_exempt:
# Ones with fixtures are sure to be classes, which means
# they're sure to be ContextSuites with contexts.
# First class with this set of fixtures sets up:
first = fixture_bundle[0].context
first._fb_should_setup_fixtures = True
# Set all classes' 1..n should_setup to False:
for cls in fixture_bundle[1:]:
cls.context._fb_should_setup_fixtures = False
# Last class tears down:
last = fixture_bundle[-1].context
last._fb_should_teardown_fixtures = True
# Set all classes' 0..(n-1) should_teardown to False:
for cls in fixture_bundle[:-1]:
cls.context._fb_should_teardown_fixtures = False
flattened.extend(fixture_bundle)
flattened.extend(bucketer.remainder)
return ContextSuite(flattened)
def suite_sorted_by_fixtures(suite):
"""Flatten and sort a tree of Suites by the ``fixtures`` members of
their contexts.
Add ``_fb_should_setup_fixtures`` and
``_fb_should_teardown_fixtures`` attrs to each test class to advise
it whether to set up or tear down (respectively) the fixtures.
Return a Suite.
"""
bucketer = Bucketer()
process_tests(suite, bucketer.add)
# Lay the bundles of common-fixture-having test classes end to end
# in a single list so we can make a test suite out of them:
flattened = []
for ((fixtures, is_exempt),
fixture_bundle) in bucketer.buckets.iteritems():
# Advise first and last test classes in each bundle to set up
# and tear down fixtures and the rest not to:
if fixtures and not is_exempt:
# Ones with fixtures are sure to be classes, which means
# they're sure to be ContextSuites with contexts.
# First class with this set of fixtures sets up:
first = fixture_bundle[0].context
first._fb_should_setup_fixtures = True
# Set all classes' 1..n should_setup to False:
for cls in fixture_bundle[1:]:
cls.context._fb_should_setup_fixtures = False
# Last class tears down:
last = fixture_bundle[-1].context
last._fb_should_teardown_fixtures = True
# Set all classes' 0..(n-1) should_teardown to False:
for cls in fixture_bundle[:-1]:
cls.context._fb_should_teardown_fixtures = False
flattened.extend(fixture_bundle)
flattened.extend(bucketer.remainder)
return ContextSuite(flattened)
