506 lines
20 KiB
Python
506 lines
20 KiB
Python
"""
|
|
Tests for django test runner
|
|
"""
|
|
import unittest
|
|
from unittest import mock
|
|
|
|
from admin_scripts.tests import AdminScriptTestCase
|
|
|
|
from django import db
|
|
from django.conf import settings
|
|
from django.core.exceptions import ImproperlyConfigured
|
|
from django.core.management import call_command
|
|
from django.core.management.base import SystemCheckError
|
|
from django.test import TransactionTestCase, skipUnlessDBFeature
|
|
from django.test.runner import DiscoverRunner
|
|
from django.test.testcases import connections_support_transactions
|
|
from django.test.utils import (
|
|
captured_stderr, dependency_ordered, get_unique_databases_and_mirrors,
|
|
)
|
|
|
|
from .models import B, Person, Through
|
|
|
|
|
|
class DependencyOrderingTests(unittest.TestCase):
|
|
|
|
def test_simple_dependencies(self):
|
|
raw = [
|
|
('s1', ('s1_db', ['alpha'])),
|
|
('s2', ('s2_db', ['bravo'])),
|
|
('s3', ('s3_db', ['charlie'])),
|
|
]
|
|
dependencies = {
|
|
'alpha': ['charlie'],
|
|
'bravo': ['charlie'],
|
|
}
|
|
|
|
ordered = dependency_ordered(raw, dependencies=dependencies)
|
|
ordered_sigs = [sig for sig, value in ordered]
|
|
|
|
self.assertIn('s1', ordered_sigs)
|
|
self.assertIn('s2', ordered_sigs)
|
|
self.assertIn('s3', ordered_sigs)
|
|
self.assertLess(ordered_sigs.index('s3'), ordered_sigs.index('s1'))
|
|
self.assertLess(ordered_sigs.index('s3'), ordered_sigs.index('s2'))
|
|
|
|
def test_chained_dependencies(self):
|
|
raw = [
|
|
('s1', ('s1_db', ['alpha'])),
|
|
('s2', ('s2_db', ['bravo'])),
|
|
('s3', ('s3_db', ['charlie'])),
|
|
]
|
|
dependencies = {
|
|
'alpha': ['bravo'],
|
|
'bravo': ['charlie'],
|
|
}
|
|
|
|
ordered = dependency_ordered(raw, dependencies=dependencies)
|
|
ordered_sigs = [sig for sig, value in ordered]
|
|
|
|
self.assertIn('s1', ordered_sigs)
|
|
self.assertIn('s2', ordered_sigs)
|
|
self.assertIn('s3', ordered_sigs)
|
|
|
|
# Explicit dependencies
|
|
self.assertLess(ordered_sigs.index('s2'), ordered_sigs.index('s1'))
|
|
self.assertLess(ordered_sigs.index('s3'), ordered_sigs.index('s2'))
|
|
|
|
# Implied dependencies
|
|
self.assertLess(ordered_sigs.index('s3'), ordered_sigs.index('s1'))
|
|
|
|
def test_multiple_dependencies(self):
|
|
raw = [
|
|
('s1', ('s1_db', ['alpha'])),
|
|
('s2', ('s2_db', ['bravo'])),
|
|
('s3', ('s3_db', ['charlie'])),
|
|
('s4', ('s4_db', ['delta'])),
|
|
]
|
|
dependencies = {
|
|
'alpha': ['bravo', 'delta'],
|
|
'bravo': ['charlie'],
|
|
'delta': ['charlie'],
|
|
}
|
|
|
|
ordered = dependency_ordered(raw, dependencies=dependencies)
|
|
ordered_sigs = [sig for sig, aliases in ordered]
|
|
|
|
self.assertIn('s1', ordered_sigs)
|
|
self.assertIn('s2', ordered_sigs)
|
|
self.assertIn('s3', ordered_sigs)
|
|
self.assertIn('s4', ordered_sigs)
|
|
|
|
# Explicit dependencies
|
|
self.assertLess(ordered_sigs.index('s2'), ordered_sigs.index('s1'))
|
|
self.assertLess(ordered_sigs.index('s4'), ordered_sigs.index('s1'))
|
|
self.assertLess(ordered_sigs.index('s3'), ordered_sigs.index('s2'))
|
|
self.assertLess(ordered_sigs.index('s3'), ordered_sigs.index('s4'))
|
|
|
|
# Implicit dependencies
|
|
self.assertLess(ordered_sigs.index('s3'), ordered_sigs.index('s1'))
|
|
|
|
def test_circular_dependencies(self):
|
|
raw = [
|
|
('s1', ('s1_db', ['alpha'])),
|
|
('s2', ('s2_db', ['bravo'])),
|
|
]
|
|
dependencies = {
|
|
'bravo': ['alpha'],
|
|
'alpha': ['bravo'],
|
|
}
|
|
|
|
with self.assertRaises(ImproperlyConfigured):
|
|
dependency_ordered(raw, dependencies=dependencies)
|
|
|
|
def test_own_alias_dependency(self):
|
|
raw = [
|
|
('s1', ('s1_db', ['alpha', 'bravo']))
|
|
]
|
|
dependencies = {
|
|
'alpha': ['bravo']
|
|
}
|
|
|
|
with self.assertRaises(ImproperlyConfigured):
|
|
dependency_ordered(raw, dependencies=dependencies)
|
|
|
|
# reordering aliases shouldn't matter
|
|
raw = [
|
|
('s1', ('s1_db', ['bravo', 'alpha']))
|
|
]
|
|
|
|
with self.assertRaises(ImproperlyConfigured):
|
|
dependency_ordered(raw, dependencies=dependencies)
|
|
|
|
|
|
class MockTestRunner:
|
|
def __init__(self, *args, **kwargs):
|
|
pass
|
|
|
|
|
|
MockTestRunner.run_tests = mock.Mock(return_value=[])
|
|
|
|
|
|
class ManageCommandTests(unittest.TestCase):
|
|
|
|
def test_custom_test_runner(self):
|
|
call_command('test', 'sites',
|
|
testrunner='test_runner.tests.MockTestRunner')
|
|
MockTestRunner.run_tests.assert_called_with(('sites',))
|
|
|
|
def test_bad_test_runner(self):
|
|
with self.assertRaises(AttributeError):
|
|
call_command('test', 'sites', testrunner='test_runner.NonexistentRunner')
|
|
|
|
def test_time_recorded(self):
|
|
with captured_stderr() as stderr:
|
|
call_command('test', '--timing', 'sites', testrunner='test_runner.tests.MockTestRunner')
|
|
self.assertIn('Total run took', stderr.getvalue())
|
|
|
|
|
|
class CustomTestRunnerOptionsSettingsTests(AdminScriptTestCase):
|
|
"""
|
|
Custom runners can add command line arguments. The runner is specified
|
|
through a settings file.
|
|
"""
|
|
def setUp(self):
|
|
super().setUp()
|
|
settings = {
|
|
'TEST_RUNNER': '\'test_runner.runner.CustomOptionsTestRunner\'',
|
|
}
|
|
self.write_settings('settings.py', sdict=settings)
|
|
|
|
def test_default_options(self):
|
|
args = ['test', '--settings=test_project.settings']
|
|
out, err = self.run_django_admin(args)
|
|
self.assertNoOutput(err)
|
|
self.assertOutput(out, '1:2:3')
|
|
|
|
def test_default_and_given_options(self):
|
|
args = ['test', '--settings=test_project.settings', '--option_b=foo']
|
|
out, err = self.run_django_admin(args)
|
|
self.assertNoOutput(err)
|
|
self.assertOutput(out, '1:foo:3')
|
|
|
|
def test_option_name_and_value_separated(self):
|
|
args = ['test', '--settings=test_project.settings', '--option_b', 'foo']
|
|
out, err = self.run_django_admin(args)
|
|
self.assertNoOutput(err)
|
|
self.assertOutput(out, '1:foo:3')
|
|
|
|
def test_all_options_given(self):
|
|
args = ['test', '--settings=test_project.settings', '--option_a=bar',
|
|
'--option_b=foo', '--option_c=31337']
|
|
out, err = self.run_django_admin(args)
|
|
self.assertNoOutput(err)
|
|
self.assertOutput(out, 'bar:foo:31337')
|
|
|
|
|
|
class CustomTestRunnerOptionsCmdlineTests(AdminScriptTestCase):
|
|
"""
|
|
Custom runners can add command line arguments when the runner is specified
|
|
using --testrunner.
|
|
"""
|
|
def setUp(self):
|
|
super().setUp()
|
|
self.write_settings('settings.py')
|
|
|
|
def test_testrunner_option(self):
|
|
args = [
|
|
'test', '--testrunner', 'test_runner.runner.CustomOptionsTestRunner',
|
|
'--option_a=bar', '--option_b=foo', '--option_c=31337'
|
|
]
|
|
out, err = self.run_django_admin(args, 'test_project.settings')
|
|
self.assertNoOutput(err)
|
|
self.assertOutput(out, 'bar:foo:31337')
|
|
|
|
def test_testrunner_equals(self):
|
|
args = [
|
|
'test', '--testrunner=test_runner.runner.CustomOptionsTestRunner',
|
|
'--option_a=bar', '--option_b=foo', '--option_c=31337'
|
|
]
|
|
out, err = self.run_django_admin(args, 'test_project.settings')
|
|
self.assertNoOutput(err)
|
|
self.assertOutput(out, 'bar:foo:31337')
|
|
|
|
def test_no_testrunner(self):
|
|
args = ['test', '--testrunner']
|
|
out, err = self.run_django_admin(args, 'test_project.settings')
|
|
self.assertIn('usage', err)
|
|
self.assertNotIn('Traceback', err)
|
|
self.assertNoOutput(out)
|
|
|
|
|
|
class Ticket17477RegressionTests(AdminScriptTestCase):
|
|
def setUp(self):
|
|
super().setUp()
|
|
self.write_settings('settings.py')
|
|
|
|
def test_ticket_17477(self):
|
|
"""'manage.py help test' works after r16352."""
|
|
args = ['help', 'test']
|
|
out, err = self.run_manage(args)
|
|
self.assertNoOutput(err)
|
|
|
|
|
|
class SQLiteInMemoryTestDbs(TransactionTestCase):
|
|
available_apps = ['test_runner']
|
|
databases = {'default', 'other'}
|
|
|
|
@unittest.skipUnless(all(db.connections[conn].vendor == 'sqlite' for conn in db.connections),
|
|
"This is an sqlite-specific issue")
|
|
def test_transaction_support(self):
|
|
# Assert connections mocking is appropriately applied by preventing
|
|
# any attempts at calling create_test_db on the global connection
|
|
# objects.
|
|
for connection in db.connections.all():
|
|
create_test_db = mock.patch.object(
|
|
connection.creation,
|
|
'create_test_db',
|
|
side_effect=AssertionError("Global connection object shouldn't be manipulated.")
|
|
)
|
|
create_test_db.start()
|
|
self.addCleanup(create_test_db.stop)
|
|
for option_key, option_value in (
|
|
('NAME', ':memory:'), ('TEST', {'NAME': ':memory:'})):
|
|
tested_connections = db.ConnectionHandler({
|
|
'default': {
|
|
'ENGINE': 'django.db.backends.sqlite3',
|
|
option_key: option_value,
|
|
},
|
|
'other': {
|
|
'ENGINE': 'django.db.backends.sqlite3',
|
|
option_key: option_value,
|
|
},
|
|
})
|
|
with mock.patch('django.test.utils.connections', new=tested_connections):
|
|
other = tested_connections['other']
|
|
DiscoverRunner(verbosity=0).setup_databases()
|
|
msg = (
|
|
"DATABASES setting '%s' option set to sqlite3's ':memory:' value "
|
|
"shouldn't interfere with transaction support detection." % option_key
|
|
)
|
|
# Transaction support is properly initialized for the 'other' DB.
|
|
self.assertTrue(other.features.supports_transactions, msg)
|
|
# And all the DBs report that they support transactions.
|
|
self.assertTrue(connections_support_transactions(), msg)
|
|
|
|
|
|
class DummyBackendTest(unittest.TestCase):
|
|
def test_setup_databases(self):
|
|
"""
|
|
setup_databases() doesn't fail with dummy database backend.
|
|
"""
|
|
tested_connections = db.ConnectionHandler({})
|
|
with mock.patch('django.test.utils.connections', new=tested_connections):
|
|
runner_instance = DiscoverRunner(verbosity=0)
|
|
old_config = runner_instance.setup_databases()
|
|
runner_instance.teardown_databases(old_config)
|
|
|
|
|
|
class AliasedDefaultTestSetupTest(unittest.TestCase):
|
|
def test_setup_aliased_default_database(self):
|
|
"""
|
|
setup_databases() doesn't fail when 'default' is aliased
|
|
"""
|
|
tested_connections = db.ConnectionHandler({
|
|
'default': {
|
|
'NAME': 'dummy'
|
|
},
|
|
'aliased': {
|
|
'NAME': 'dummy'
|
|
}
|
|
})
|
|
with mock.patch('django.test.utils.connections', new=tested_connections):
|
|
runner_instance = DiscoverRunner(verbosity=0)
|
|
old_config = runner_instance.setup_databases()
|
|
runner_instance.teardown_databases(old_config)
|
|
|
|
|
|
class SetupDatabasesTests(unittest.TestCase):
|
|
|
|
def setUp(self):
|
|
self.runner_instance = DiscoverRunner(verbosity=0)
|
|
|
|
def test_setup_aliased_databases(self):
|
|
tested_connections = db.ConnectionHandler({
|
|
'default': {
|
|
'ENGINE': 'django.db.backends.dummy',
|
|
'NAME': 'dbname',
|
|
},
|
|
'other': {
|
|
'ENGINE': 'django.db.backends.dummy',
|
|
'NAME': 'dbname',
|
|
}
|
|
})
|
|
|
|
with mock.patch('django.db.backends.dummy.base.DatabaseWrapper.creation_class') as mocked_db_creation:
|
|
with mock.patch('django.test.utils.connections', new=tested_connections):
|
|
old_config = self.runner_instance.setup_databases()
|
|
self.runner_instance.teardown_databases(old_config)
|
|
mocked_db_creation.return_value.destroy_test_db.assert_called_once_with('dbname', 0, False)
|
|
|
|
def test_setup_test_database_aliases(self):
|
|
"""
|
|
The default database must be the first because data migrations
|
|
use the default alias by default.
|
|
"""
|
|
tested_connections = db.ConnectionHandler({
|
|
'other': {
|
|
'ENGINE': 'django.db.backends.dummy',
|
|
'NAME': 'dbname',
|
|
},
|
|
'default': {
|
|
'ENGINE': 'django.db.backends.dummy',
|
|
'NAME': 'dbname',
|
|
}
|
|
})
|
|
with mock.patch('django.test.utils.connections', new=tested_connections):
|
|
test_databases, _ = get_unique_databases_and_mirrors()
|
|
self.assertEqual(
|
|
test_databases,
|
|
{
|
|
('', '', 'django.db.backends.dummy', 'test_dbname'): (
|
|
'dbname',
|
|
['default', 'other'],
|
|
),
|
|
},
|
|
)
|
|
|
|
def test_destroy_test_db_restores_db_name(self):
|
|
tested_connections = db.ConnectionHandler({
|
|
'default': {
|
|
'ENGINE': settings.DATABASES[db.DEFAULT_DB_ALIAS]["ENGINE"],
|
|
'NAME': 'xxx_test_database',
|
|
},
|
|
})
|
|
# Using the real current name as old_name to not mess with the test suite.
|
|
old_name = settings.DATABASES[db.DEFAULT_DB_ALIAS]["NAME"]
|
|
with mock.patch('django.db.connections', new=tested_connections):
|
|
tested_connections['default'].creation.destroy_test_db(old_name, verbosity=0, keepdb=True)
|
|
self.assertEqual(tested_connections['default'].settings_dict["NAME"], old_name)
|
|
|
|
def test_serialization(self):
|
|
tested_connections = db.ConnectionHandler({
|
|
'default': {
|
|
'ENGINE': 'django.db.backends.dummy',
|
|
},
|
|
})
|
|
with mock.patch('django.db.backends.dummy.base.DatabaseWrapper.creation_class') as mocked_db_creation:
|
|
with mock.patch('django.test.utils.connections', new=tested_connections):
|
|
self.runner_instance.setup_databases()
|
|
mocked_db_creation.return_value.create_test_db.assert_called_once_with(
|
|
verbosity=0, autoclobber=False, serialize=True, keepdb=False
|
|
)
|
|
|
|
def test_serialized_off(self):
|
|
tested_connections = db.ConnectionHandler({
|
|
'default': {
|
|
'ENGINE': 'django.db.backends.dummy',
|
|
'TEST': {'SERIALIZE': False},
|
|
},
|
|
})
|
|
with mock.patch('django.db.backends.dummy.base.DatabaseWrapper.creation_class') as mocked_db_creation:
|
|
with mock.patch('django.test.utils.connections', new=tested_connections):
|
|
self.runner_instance.setup_databases()
|
|
mocked_db_creation.return_value.create_test_db.assert_called_once_with(
|
|
verbosity=0, autoclobber=False, serialize=False, keepdb=False
|
|
)
|
|
|
|
|
|
@skipUnlessDBFeature('supports_sequence_reset')
|
|
class AutoIncrementResetTest(TransactionTestCase):
|
|
"""
|
|
Creating the same models in different test methods receive the same PK
|
|
values since the sequences are reset before each test method.
|
|
"""
|
|
|
|
available_apps = ['test_runner']
|
|
|
|
reset_sequences = True
|
|
|
|
def _test(self):
|
|
# Regular model
|
|
p = Person.objects.create(first_name='Jack', last_name='Smith')
|
|
self.assertEqual(p.pk, 1)
|
|
# Auto-created many-to-many through model
|
|
p.friends.add(Person.objects.create(first_name='Jacky', last_name='Smith'))
|
|
self.assertEqual(p.friends.through.objects.first().pk, 1)
|
|
# Many-to-many through model
|
|
b = B.objects.create()
|
|
t = Through.objects.create(person=p, b=b)
|
|
self.assertEqual(t.pk, 1)
|
|
|
|
def test_autoincrement_reset1(self):
|
|
self._test()
|
|
|
|
def test_autoincrement_reset2(self):
|
|
self._test()
|
|
|
|
|
|
class EmptyDefaultDatabaseTest(unittest.TestCase):
|
|
def test_empty_default_database(self):
|
|
"""
|
|
An empty default database in settings does not raise an ImproperlyConfigured
|
|
error when running a unit test that does not use a database.
|
|
"""
|
|
tested_connections = db.ConnectionHandler({'default': {}})
|
|
with mock.patch('django.db.connections', new=tested_connections):
|
|
connection = tested_connections[db.utils.DEFAULT_DB_ALIAS]
|
|
self.assertEqual(connection.settings_dict['ENGINE'], 'django.db.backends.dummy')
|
|
connections_support_transactions()
|
|
|
|
|
|
class RunTestsExceptionHandlingTests(unittest.TestCase):
|
|
def test_run_checks_raises(self):
|
|
"""
|
|
Teardown functions are run when run_checks() raises SystemCheckError.
|
|
"""
|
|
with mock.patch('django.test.runner.DiscoverRunner.setup_test_environment'), \
|
|
mock.patch('django.test.runner.DiscoverRunner.setup_databases'), \
|
|
mock.patch('django.test.runner.DiscoverRunner.build_suite'), \
|
|
mock.patch('django.test.runner.DiscoverRunner.run_checks', side_effect=SystemCheckError), \
|
|
mock.patch('django.test.runner.DiscoverRunner.teardown_databases') as teardown_databases, \
|
|
mock.patch('django.test.runner.DiscoverRunner.teardown_test_environment') as teardown_test_environment:
|
|
runner = DiscoverRunner(verbosity=0, interactive=False)
|
|
with self.assertRaises(SystemCheckError):
|
|
runner.run_tests(['test_runner_apps.sample.tests_sample.TestDjangoTestCase'])
|
|
self.assertTrue(teardown_databases.called)
|
|
self.assertTrue(teardown_test_environment.called)
|
|
|
|
def test_run_checks_raises_and_teardown_raises(self):
|
|
"""
|
|
SystemCheckError is surfaced when run_checks() raises SystemCheckError
|
|
and teardown databases() raises ValueError.
|
|
"""
|
|
with mock.patch('django.test.runner.DiscoverRunner.setup_test_environment'), \
|
|
mock.patch('django.test.runner.DiscoverRunner.setup_databases'), \
|
|
mock.patch('django.test.runner.DiscoverRunner.build_suite'), \
|
|
mock.patch('django.test.runner.DiscoverRunner.run_checks', side_effect=SystemCheckError), \
|
|
mock.patch('django.test.runner.DiscoverRunner.teardown_databases', side_effect=ValueError) \
|
|
as teardown_databases, \
|
|
mock.patch('django.test.runner.DiscoverRunner.teardown_test_environment') as teardown_test_environment:
|
|
runner = DiscoverRunner(verbosity=0, interactive=False)
|
|
with self.assertRaises(SystemCheckError):
|
|
runner.run_tests(['test_runner_apps.sample.tests_sample.TestDjangoTestCase'])
|
|
self.assertTrue(teardown_databases.called)
|
|
self.assertFalse(teardown_test_environment.called)
|
|
|
|
def test_run_checks_passes_and_teardown_raises(self):
|
|
"""
|
|
Exceptions on teardown are surfaced if no exceptions happen during
|
|
run_checks().
|
|
"""
|
|
with mock.patch('django.test.runner.DiscoverRunner.setup_test_environment'), \
|
|
mock.patch('django.test.runner.DiscoverRunner.setup_databases'), \
|
|
mock.patch('django.test.runner.DiscoverRunner.build_suite'), \
|
|
mock.patch('django.test.runner.DiscoverRunner.run_checks'), \
|
|
mock.patch('django.test.runner.DiscoverRunner.teardown_databases', side_effect=ValueError) \
|
|
as teardown_databases, \
|
|
mock.patch('django.test.runner.DiscoverRunner.teardown_test_environment') as teardown_test_environment:
|
|
runner = DiscoverRunner(verbosity=0, interactive=False)
|
|
with self.assertRaises(ValueError):
|
|
# Suppress the output when running TestDjangoTestCase.
|
|
with mock.patch('sys.stderr'):
|
|
runner.run_tests(['test_runner_apps.sample.tests_sample.TestDjangoTestCase'])
|
|
self.assertTrue(teardown_databases.called)
|
|
self.assertFalse(teardown_test_environment.called)
|