django-rdtwt
(Run Django Tests With Testcontainers)
This targets users who wish to forget setting up a database for tests. There's no manually starting up Docker compose or local database with this.
Note:
See: Altering settings at runtime: Django documentation
This test runner changes default database host and port dynamically, because it's quite hard to know database host before-hand in dynamic environments, for example some CI/CD runners.
Still this just works and is quite simple, that's why I haven't spent that much time investigating alternative solutions.
Installation
-
Add rdtwt to your INSTALLED_APPS setting like this
INSTALLED_APPS = [ ... 'rdtwt', ]
-
Run tests with rdtwt runner,
python manage.py test --testrunner=rdtwt.runner.PostgresDiscoverRunner
Though what I really suggest is to put following in your test settings.
# RDTWT SETTINGS
RDTWT_POSTGRESQL_IMAGE = 'postgres:14.1'
TEST_RUNNER = 'rdtwt.runner.PostgresDiscoverRunner'
This makes sure that tests run against the PostgreSQL version defined by you. It also adds up to the test confidence, at least they aren't flaky because of database version changing without your knowledge.
Example:
Defining all available options.
# Database
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.postgresql',
'NAME': 'postgres',
'USER': 'postgres',
'PASSWORD': 'postgres',
'HOST': '127.0.0.1',
'PORT': '5432'
}
}
# RDTWT SETTINGS
RDTWT_POSTGRESQL_IMAGE = 'postgres:14.1'
TEST_RUNNER = 'rdtwt.runner.PostgresDiscoverRunner'
RDTWT_POSTGRESQL_USER = 'postgres'
RDTWT_POSTGRESQL_PASSWORD = 'postgres'
RDTWT_POSTGRESQL_NAME = 'postgres'
2 Dec 19, 2022
2 Dec 06, 2021
811 Dec 01, 2022
31 Aug 09, 2022
3 Jul 03, 2021
34.2k Jan 04, 2023
4 May 20, 2022
116 Dec 15, 2022
205 Dec 26, 2022
1 Nov 19, 2021
3 Mar 11, 2022
133 Jan 05, 2023
45 Nov 16, 2022
2.7k Jan 07, 2023
85 Oct 25, 2021
4.8k Jan 03, 2023
2.1k Dec 31, 2022
2 Jan 05, 2022