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'
5.6k Jan 01, 2023
3.8k Jan 01, 2023
6 Feb 14, 2022
10 Jan 08, 2023
35 Dec 02, 2022
205 Dec 26, 2022
2 Jan 05, 2022
672 Dec 22, 2022
169 Jan 06, 2023
913 Dec 28, 2022
133 Jan 05, 2023
138 Dec 28, 2022
1 Sep 08, 2022
3.7k Jan 02, 2023
5 Feb 19, 2022
814 Dec 26, 2022
408 Jan 08, 2023
1.6k Jan 06, 2023
72 Dec 05, 2022
909 Dec 26, 2022