Opened 5 years ago
Closed 5 years ago
#30010 closed New feature (fixed)
Add support for running the test suite through docker with docker-compose
| Reported by: | Tom Forbes | Owned by: | Tom Forbes |
|---|---|---|---|
| Component: | Testing framework | Version: | dev |
| Severity: | Normal | Keywords: | |
| Cc: | Triage Stage: | Accepted | |
| Has patch: | yes | Needs documentation: | no |
| Needs tests: | no | Patch needs improvement: | no |
| Easy pickings: | no | UI/UX: | no |
Description (last modified by )
As per a discussion on the developers mailing list, I would like to propose adding docker-compose support to Django.
Right now running the test suite across different databases is annoying at best, and is a pain point for new developers wishing to join the project. With a relatively small number of changes we can add a docker-compose definition to the Django project itself which will allow anyone to quickly run tests across any supported Python/database version.
One option is to add this to runtests.py, i.e runtests.py --docker. I do not think this is a good approach as there are a large ecosystem of tools that already work with docker, including editors, CLI tools and shells, which will not work with runtests.py.
I've already done most of the work for this in django-docker-box. We would need to copy the docker-compose.yml file as well as the Dockerfile, and add documentation.
Getting this to work with Oracle would require more work and I believe it can be done as a future ticket.
In django-docker-box I've had to create specific settings files for each backend. I can't see a way around not including this in core as well, perhaps under a tests/settings/docker/ subdirectory?
Change History (13)
comment:1 by , 5 years ago
| Description: | modified (diff) |
|---|
comment:2 by , 5 years ago
| Needs documentation: | set |
|---|---|
| Triage Stage: | Unreviewed → Accepted |
comment:4 by , 5 years ago
| Has patch: | set |
|---|
comment:5 by , 5 years ago
| Needs documentation: | unset |
|---|
comment:6 by , 5 years ago
| Owner: | changed from to |
|---|---|
| Status: | new → assigned |
comment:7 by , 5 years ago
| Patch needs improvement: | set |
|---|
I'm marking this Patch needs improvement since there are comments/issues on the PR and in the django-docker-box repo.
There's an ongoing discussion thread on django-docker-box which seems to be home to the conversation currently.
comment:8 by , 5 years ago
FYI, there is an official Docker image for Oracle now. I added it to the wiki too, seealso: https://code.djangoproject.com/wiki/OracleTestSetup
comment:13 by , 5 years ago
| Resolution: | → fixed |
|---|---|
| Status: | assigned → closed |
Using django-docker-box is now documented and we moved it into Django org.
Accepting on the basis that I've used Tom's
django-docker-boxextensively since I learned about it and it greatly simplified my testing setup.I assume it would help speeding up initial contributor setup as well.