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 Aug 07, 2022
950 Dec 26, 2022
1 Dec 22, 2021
1.7k Jan 01, 2023
4 Dec 23, 2022
1.2k Jan 07, 2023
167 Oct 18, 2022
5 Nov 15, 2022
476 Dec 01, 2022
295 Mar 20, 2022
997 Dec 24, 2022
4 Jan 15, 2022
1 Sep 28, 2021
2 Oct 20, 2021
5.2k Jan 09, 2023
16 Oct 20, 2022
12 Jun 04, 2022
1 Nov 10, 2021
1.6k Jan 06, 2023
909 Dec 26, 2022