Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* Removed references to `django-box` from README. The `django-box` repository was archived over 5 years ago and many people coming to this now will have no idea what Vagrant or VirtualBox even are. * Removed obsolete configuration for Travis CI. Travis CI was used when GitHub Actions was still very new and had limited support. Since then, Travis CI became less tolerant of open source projects and runtimes increased significantly. GitHub Actions provides much more flexibility and can be looked into as a replacement for this matrix of tests. * Removed obsolete configuration for Azure Pipelines. This looks incomplete and was likely considered as an alternative to Travis CI at some point. We should look into GitHub Actions as a replacement for running a matrix of tests. * Removed obsolete script for pushing images to Docker Hub. Ownership of the repository for images on Docker Hub is likely in the hands of the original author rather than the Django project itself. In addition, we should probably look at making use of the GitHub Container Repository instead which will be easier to manage and control. * Removed broken support for Oracle Database. We will be able to support Oracle again now that they have started publishing container images themselves via their own repository. It's easier to remove this broken support and start again, however, as - aside from using a very old version of Oracle Database - this approach required many hacks. * Removed obsolete version attribute from compose file. This raises a warning when running `docker compose`, so remove it. * Removed obsolete `GEOIP_PATH` setting. Django now bundles test Maxmind GeoIP and GeoLite databases which means that this setting - and a manual download of these databases - is no longer required. * Removed unused `PIP_CACHE_VOLUME` environment variable. Unused since 9c8e95f. * Renamed docker and compose files. Instead of `docker-compose.yml`, rename to `compose.yml` as supported by the Compose Specification. Also rename to `Containerfile` instead of using `Dockerfile` to be more tool-agnostic. It would be good to also support Podman if and when it supports all of the features we require. * Consolidated settings into a single file. Most settings are exactly the same, so by dynamically generating the `DATABASES` setting we can ensure greater consistency and reduce the maintenance required. The `TEST_RUNNER` and `TEST_OUTPUT_DIR` settings have been hidden behind an `XUNIT` environment variable. These are typically only useful in CI, specifically on Jenkins, suppress some output, and do not support various features such as debugging SQL output and test durations. * Preferred "PostgreSQL" over "Postgres". All other database use the full name, so do the same for PostgreSQL. * Grouped and reordered services in compose file. Grouped services and commands by type and ordered alphabetically within each section. * Removed obsolete entrypoint for MySQL. The MySQL native password authentication plugin is obsolete. * Extracted common compose configuration for services. This allow us to apply configuration consistently and reduce duplication. * Enforced single instance for backend services. And also ensure that they restart unless explicitly stopped. * Replaced `wait-for-it.sh` script with compose healthchecks. This integrates better with compose commands with feedback on service health. Note that this doesn't yet introduce healthchecks for selenium nodes as we'll be switching over to Selenium Grid in a future commit which works slightly differently and the current setup doesn't seem to work correctly. * Fixed indentation of compose file. * Improved name of memcached services. * Fixed MySQL to use the same credentials as other databases. Prior to this MySQL and MariaDB were creating a "django" user, but were using "root" because the user didn't have the appropriate permissions. Fixing that brings the credentials used in line with PostgreSQL. * Fixed support for Selenium using Selenium Grid. Also reintroduces healthchecks. * Optimized services for testing. This disables various features in databases and attempts to reduce disk writes such that testing is as fast as possible. * Reinstated support for Oracle database. This is now using the images provided by Oracle in their own container registry. * Added GIS support for MariaDB. * Added support for Redis cache backend. Ensures that tests can be run for the cache backend for Redis. * Added support for running Selenium with Edge. * Enabled cache backends for GIS tests. There's not much reason why these need to be disabled. * Created improved folder structure under `/django`. Use the top-level `/django` folder as a place to copy files and mount volumes. The Django source code will now be mounted to `/django/source` and any generated output, e.g. coverage, will be output to a mounted volume at `/django/output`. It is also no longer necessary to specify the `DJANGO_PATH` environment variable if you have your Django respository checked out alongside this one, e.g. ``` ~/Sources ├── django └── django-docker-box ``` If you keep your source elsewhere, then the default of `../django` can still be overridden using `DJANGO_PATH`. Currently the Django sources are mounted read-write. This is due to various tools that are currently configured to write output into the source tree, e.g. coverage. In addition, some tests may write files to the source tree instead of a temporary location. Hopefully we can gradually address these issues and then move to mounting the source tree read-only instead. This commit also sets up the Django source tree as an additional context instead of the default context. This will allow including files from this repository during the image build but also sets up sourcing requirements files from the source tree which will be crucial to improving the container file. * Extracted packages into separate files. It's much easier to maintain a list of packages to install in a separate file. We can also get the packages required to build the documentation from the requirements file in the Django source tree. * Changed user name in container from `test` to `django`. * Modernized and optimized container file. Use modern syntax including heredocs, cache mounts, etc. Also merge the requirements files to reduce to a single install command. * Switched to `uv` for installing packages. * Added a basic entrypoint script. This will be expanded in future for enabling coverage, etc. * Added a `LICENSE` file. * Added some labels to the container image. * Updated to use Debian Bookworm. Also update some packages to install the dev packages. These will install the correct runtime libraries and keeps this maintainable - the version numbers in the package names can change with each distro update, so using the dev package avoids manual updates. * Added support for running with PyPy. * Enforced color output when running in CI. Ensure that we'll get colored output when running in GitHub Actions. * Updated `.editorconfig`. * Replaced `flake8` with `pre-commit`. Using `pre-commit` makes it easier to run all linters with the versions pinned by Django. Also add `black` as a dependency so that migrations which are created when using these images will be formatted. * Added linting tools and workflow for this repository. * Added more entries to `.gitignore` file. * Reordered entries in the `.env` file. * Updated the charset for MariaDB/MySQL. Recently this was updated to use `utf8mb4` for Django 5.2 * Removed stale container image cache location. Hopefully we'll reinstate this in the future, but make use of GitHub Container Registry. It'll be easier to maintain and we should be able to publish all versions on a regular basis from a GitHub Actions workflow. * Reworked commands for building documentation, etc. * Bumped database versions to those supported on Django main. * Removed reference to `${PWD}` from `compose.yaml`. This isn't necessary - we can just use the current directory as there is a lot of other stuff already doing that. Using `${PWD}` makes using this on Windows more awkward as this environment variable is undefined by default. * Reworked documentation in `README.md`. Add much more guidance on using the tools within this repository.
- Loading branch information
