Modernize Test Suite and Improve Tests

.gitignore

@@ -14,6 +14,7 @@ build/
 coverage
 coverage.data
 .coverage
+htmlcov/
 
 # junk
 .DS_Store

Containerfile

@@ -23,6 +23,7 @@ RUN pip install --no-cache-dir -r /tmp/requirements.txt
 
 # Copy the application code to the container
 COPY src /app
+COPY pytest.ini /app/pytest.ini
 WORKDIR /app
 
 # Run collectstatic to gather static files

Makefile

@@ -1,4 +1,4 @@
-.PHONY: test-env test test-clean build gcp-push gcp-restart gcp-deploy
+.PHONY: test-env test test-coverage test-coverage-html test-clean build gcp-push gcp-restart gcp-deploy
 
 # Build the container image
 build:
@@ -32,7 +32,15 @@ test-env:
 
 # Run tests in a clean container environment
 test: test-env test-clean
-	podman-compose run --rm test
+	podman-compose run --rm test pytest
+
+# Run tests with coverage report
+test-coverage: test-env test-clean
+	podman-compose run --rm test pytest --cov=sa_api_v2 --cov-report=term-missing
+
+# Run tests with HTML coverage report (outputs to htmlcov/)
+test-coverage-html: test-env test-clean
+	podman-compose run --rm test pytest --cov=sa_api_v2 --cov-report=html
 
 # Just clean up containers
 test-clean:

compose.yml

@@ -13,8 +13,8 @@ services:
     environment:
       - REDIS_URL=redis://redis:6379/0
     depends_on:
-      db: {"condition": "service_healthy"}
-      redis: {"condition": "service_healthy"}
+      db: { "condition": "service_healthy" }
+      redis: { "condition": "service_healthy" }
     restart: "no"
 
   web:
@@ -27,9 +27,9 @@ services:
     ports:
       - "8000:8000"
     depends_on:
-      db: {"condition": "service_healthy"}
-      redis: {"condition": "service_healthy"}
-      init: {"condition": "service_completed_successfully"}
+      db: { "condition": "service_healthy" }
+      redis: { "condition": "service_healthy" }
+      init: { "condition": "service_completed_successfully" }
 
   worker:
     build:
@@ -41,22 +41,24 @@ services:
       C_FORCE_ROOT: "true"
       REDIS_URL: "redis://redis:6379/0"
     depends_on:
-      db: {"condition": "service_healthy"}
-      redis: {"condition": "service_healthy"}
-      init: {"condition": "service_completed_successfully"}
+      db: { "condition": "service_healthy" }
+      redis: { "condition": "service_healthy" }
+      init: { "condition": "service_completed_successfully" }
 
   test:
-    build:
-      context: .
-      dockerfile: Containerfile
-    command: python3 manage.py test .
+    image: shareabouts-api
+    command: pytest
     env_file: .env
     environment:
       - REDIS_URL=redis://redis:6379/0
+    volumes:
+      - ./htmlcov:/app/htmlcov
+      - ./src:/app
+      - ./pytest.ini:/app/pytest.ini
     depends_on:
-      db: {"condition": "service_healthy"}
-      redis: {"condition": "service_healthy"}
-      init: {"condition": "service_completed_successfully"}
+      db: { "condition": "service_healthy" }
+      redis: { "condition": "service_healthy" }
+      init: { "condition": "service_completed_successfully" }
 
   db:
     image: postgis/postgis:15-3.3
@@ -67,7 +69,7 @@ services:
     ports:
       - "15432:5432"
     healthcheck:
-      test: [ "CMD-SHELL","psql -U postgres -d shareabouts -c \"SELECT ST_Buffer( ST_SetSRID('POINT(0 0)'::GEOMETRY, 4326), 1) AS geom ;\""]
+      test: [ "CMD-SHELL", "psql -U postgres -d shareabouts -c \"SELECT ST_Buffer( ST_SetSRID('POINT(0 0)'::GEOMETRY, 4326), 1) AS geom ;\"" ]
       interval: 10s
       timeout: 5s
       retries: 5
@@ -80,4 +82,4 @@ services:
       test: [ "CMD", "redis-cli", "ping" ]
       interval: 10s
       timeout: 5s
-      retries: 5
+      retries: 5

pytest.ini

@@ -0,0 +1,4 @@
+[pytest]
+DJANGO_SETTINGS_MODULE = project.settings
+python_files = tests.py test_*.py *_tests.py
+addopts = --reuse-db --nomigrations

requirements.txt

@@ -45,6 +45,10 @@ prompt-toolkit==3.0.43
 psycopg==3.1.17
 psycopg-binary==3.1.17
 pycparser==2.21
+pytest==7.4.4
+pytest-cov==4.1.0
+pytest-django==4.7.0
+pytest-xdist==3.5.0
 PyJWT==2.8.0
 python-dateutil==2.8.2
 python-social-auth==0.2.21

src/sa_api_v2/renderers.py

@@ -51,7 +51,7 @@ class GeoJSONRenderer(JSONRenderer):
     """
 
     media_type = 'application/json'
-    format = 'json'
+    format = 'geojson'
     geometry_field = 'geometry'
     id_field = 'id'