Streamline Docker setup and run tests via Docker

Author: tobiasmcnulty

.dockerignore

@@ -0,0 +1,16 @@
+# Copied from .gitignore
+__pycache__
+data
+*.pyc
+*.db
+locale/*/LC_MESSAGES/django.mo
+*/locale/*/LC_MESSAGES/django.mo
+.sass-cache/
+.coverage
+.direnv
+.envrc
+djangoproject/cache
+djangoproject/static/css/*.map
+djangoproject/static/css/*.css
+# Additional ignores for Docker
+.git/

.github/workflows/docker-test-build.yml

@@ -25,10 +25,21 @@ jobs:
             - name: Checkout repository
               uses: actions/checkout@v4
 
+            - name: Set up Docker Compose
+              uses: docker/setup-compose-action@v1
+
             - name: Test docker image build (local development)
               uses: docker/build-push-action@v6
               with:
                   context: .
                   push: false
                   build-args: |
                       REQ_FILE=requirements/${{ matrix.req_file }}
+
+            - if: matrix.req_file == 'tests.txt'
+              name: Run the tests via Docker
+              run: |
+                  docker compose up -d db
+                  # Wait for Postgres to be ready
+                  docker compose exec db sh -c 'until pg_isready ; do sleep 1; done'
+                  docker compose run --rm web make ci

Makefile

@@ -30,3 +30,10 @@ test:
 
 watch-scss:
 	watchmedo shell-command --patterns=*.scss --recursive --command="make compile-scss-debug" $(SCSS)
+
+reset-local-db:
+	python -m manage flush --no-input
+	python -m manage loaddata dev_sites
+	python -m manage loaddata doc_releases
+	python -m manage loaddata dashboard_production_metrics
+	python -m manage update_metrics

README.rst

@@ -354,12 +354,26 @@ Running Locally with Docker
 
     docker compose up
 
-3. View the site at http://localhost:8000/
-
-4. Run the tests::
+3. Run the tests::
 
     docker compose run --rm web python -m manage test
 
+4. Load the sample / local dev data::
+
+    docker compose run --rm web make reset-local-db
+
+   If preferred, refer to the "Install and run locally from a virtual environment"
+   for more granular management commands to load specific data sets.
+
+5. View the site at http://www.djangoproject.localhost:8000/
+   or http://dashboard.djangoproject.localhost:8000/.
+
+6. For docs, download the documentation (takes awhile)::
+
+    docker compose exec -it web python -m manage update_docs
+
+7. View the docs at http://docs.djangoproject.localhost:8000/.
+
 Pre-commit checks
 -----------------
 

docker-compose.yml

@@ -42,4 +42,9 @@ services:
             timeout: 10s
             retries: 10
         volumes:
-            - ./initdb/tracdb.sql:/docker-entrypoint-initdb.d/tracdb.sql
+            # Mount the Postgres initialization scripts
+            - ./docker-entrypoint-initdb.d:/docker-entrypoint-initdb.d
+            # This file contains the initial Trac database schema, but needs
+            # to be loaded into the database manually (via 02_trac_schema.sh)
+            # since it applies to the trac database, not the main Django database.
+            - ./tracdb/trac.sql:/trac.sql

initdb/tracdb.sql renamed to docker-entrypoint-initdb.d/01_trac_db.sql

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+PGPASSWORD=secret psql --username=code.djangoproject --dbname=code.djangoproject < /trac.sql

docker-entrypoint-initdb.d/02_trac_schema.sh

@@ -1,17 +1,7 @@
 #!/bin/sh
 
-python -m manage flush --no-input
-PGPASSWORD=secret psql --host db --port 5432 --username=code.djangoproject --dbname=code.djangoproject < tracdb/trac.sql
 python -m manage migrate
 make compile-scss # must come before collectstatic
 python -m manage collectstatic --no-input --clear
-python -m manage loaddata dev_sites
-python -m manage loaddata doc_releases
-# git config --global url."https://".insteadOf git://
-# python -m manage update_docs
-python -m manage loaddata dashboard_production_metrics
-# python -m manage loaddata dashboard_example_data
-python -m manage update_metrics
-#python -m manage update_index
 
 exec "$@"