Auto start/stop postgres w/ tox (ansible#632)

Author: bhavenst

.github/workflows/ci.yml

@@ -48,7 +48,7 @@ jobs:
           python-version: ${{ matrix.tests.python-version }}
 
       - name: Install tox
-        run: pip${{ matrix.tests.python-version }} install tox
+        run: pip${{ matrix.tests.python-version }} install tox tox-docker
 
       - name: Run tox
         run: |

docker-compose.yml

@@ -1,17 +1,10 @@
 ---
 services:
   postgres:
-    image: "postgres:15"
+    build:
+      context: tools/dev_postgres
+      dockerfile: Dockerfile
     container_name: dab_postgres
-    environment:
-      POSTGRES_DB: dab_db
-      POSTGRES_USER: dab
-      POSTGRES_PASSWORD: dabing
-    healthcheck:
-      test: ["CMD", "pg_isready", "-U", "dab", "-d", "dab_db"]
-      interval: 10s
-      timeout: 5s
-      retries: 5
     ports:
       - "55432:5432"
 

docs/testing.md

@@ -6,6 +6,13 @@ All tests for django-ansible-base are located in `test_app/tests`. The directory
 
 ## Running tests
 
+### Requirements
+Ensure you have the needed python dependencies installed (either in your system or a virtual env):
+```
+pip install -r requirements/requirements_dev.txt
+```
+
+### Run
 To run the test suite locally you can use tox. By default, with no arguments, tox will attempt to run the tests in various version of python. To run a specific version you can add the `-e` parameter like:
 ```
 tox -e 311
@@ -14,11 +21,8 @@ tox -e 311
 ### Test database
 
 Tests require PostgreSQL running in order to pass.
-Running PostgreSQL can be done by running `make postgres` in the root of your django-ansible-base clone.
-This will create a detached/daemonized PostgreSQL container called `dab_postgres`.
 
-If all goes according to plan, tox should automatically kill the container after the tests run.
-However, if you stop tox early or otherwise need to manually kill the container, you can run `make stop-postgres`.
+tox will automatically create/start and stop/destroy the postgres container.  If you want the container to remain after test execution, add **--docker-dont-stop=db**.
 
 ## Checking code coverage locally
 

pyproject.toml

@@ -109,7 +109,8 @@ legacy_tox_ini = """
         -r{toxinidir}/requirements/requirements_all.txt
         -r{toxinidir}/requirements/requirements_dev.txt
     allowlist_externals = sh
-    commands = sh -c 'make postgres && pytest -n auto --cov=. --cov-report=xml:coverage.xml --cov-report=html --cov-report=json --cov-branch --junit-xml=django-ansible-base-test-results.xml {env:ANSIBLE_BASE_PYTEST_ARGS} {env:ANSIBLE_BASE_TEST_DIRS:test_app/tests} {posargs}'
+    commands = pytest -n auto --cov=. --cov-report=xml:coverage.xml --cov-report=html --cov-report=json --cov-branch --junit-xml=django-ansible-base-test-results.xml {env:ANSIBLE_BASE_PYTEST_ARGS} {env:ANSIBLE_BASE_TEST_DIRS:test_app/tests} {posargs}
+    docker = db
 
     [testenv:check]
     deps =
@@ -123,6 +124,11 @@ legacy_tox_ini = """
     setenv =
         DJANGO_SETTINGS_MODULE = test_app.sqlite3settings
 
+    [docker:db]
+    dockerfile = {toxinidir}/tools/dev_postgres/Dockerfile
+    expose =
+        DB_PORT=5432/tcp
+
     [testenv:flake8]
     deps =
         flake8

requirements/requirements_dev.txt

@@ -7,6 +7,7 @@ djangorestframework
 django-split-settings
 ipython
 tox
+tox-docker
 typeguard
 pytest
 pytest-asyncio

tools/dev_postgres/Dockerfile

@@ -0,0 +1,9 @@
+FROM postgres:15
+
+ENV POSTGRES_DB=dab_db
+ENV POSTGRES_USER=dab
+ENV POSTGRES_PASSWORD=dabing
+
+EXPOSE 5432
+
+HEALTHCHECK --interval=10s --timeout=5s --retries=5 CMD ["pg_isready", "-U", "$${POSTGRES_USER}", "-d", "$${POSTGRES_DB}"]