Persist coverage reports to host

Author: Themitchell

.github/workflows/stage-2-test.yaml

@@ -44,10 +44,11 @@ jobs:
         run: |
           cp .env.example .env
           make test-unit
-      - name: "Save the result of fast test suite"
-        run: |
-          docker cp lung_cancer_screening-web:/tmp/coverage.xml ./coverage.xml
-
+      - name: "Upload coverage report to artifacts"
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage.xml
+          path: coverage.xml
 
   test-lint:
     name: "Linting"
@@ -90,6 +91,10 @@ jobs:
         uses: actions/checkout@v6
         with:
           fetch-depth: 0 # Full history is needed to improving relevancy of reporting
+      - name: Download coverage report
+        uses: actions/download-artifact@v4
+        with:
+          name: coverage.xml
       - name: "Perform static analysis"
         uses: ./.github/actions/perform-static-analysis
         with:

.gitignore

@@ -22,3 +22,4 @@ lung_cancer_screening/assets/compiled/*
 tests/TEST-*.xml
 node_modules
 .coverage
+coverage.xml

docker-compose.yml

@@ -7,6 +7,7 @@ services:
       dockerfile: Dockerfile
       target: development
     command: python manage.py runserver 0.0.0.0:8000
+    user: "${UID}:${GID}"
     ports:
       - "8000:8000"
     env_file:

pyproject.toml

@@ -38,12 +38,13 @@ build-backend = "poetry.core.masonry.api"
 paths = ["tests/features"]
 
 [tool.coverage.run]
+relative_files = true
 omit = [
   "*/migrations/*",
   "*/tests/*",
   "manage.py"
 ]
-data_file = "/tmp/.coverage"
+data_file = ".coverage"
 
 [tool.coverage.xml]
-output = "/tmp/coverage.xml"
+output = "coverage.xml"

scripts/config/sonar-scanner.properties

@@ -5,5 +5,5 @@ sonar.qualitygate.wait=true
 sonar.sourceEncoding=UTF-8
 sonar.sources=.
 
-#sonar.python.coverage.reportPaths=.coverage/coverage.xml
+sonar.python.coverage.reportPaths=coverage.xml
 #sonar.[javascript|typescript].lcov.reportPaths=.coverage/lcov.info

scripts/reports/perform-static-analysis.sh

@@ -48,6 +48,7 @@ function run-sonar-scanner-in-docker() {
   # shellcheck disable=SC1091
   source ./scripts/docker/docker.lib.sh
 
+  ls -lah
   # shellcheck disable=SC2155
   local image=$(name=sonarsource/sonar-scanner-cli docker-get-image-version-and-pull)
   docker run --rm --platform linux/amd64 \

scripts/tests/unit.sh

@@ -33,7 +33,7 @@ else
   TEST_MODULE=""
 fi
 
-docker compose run --rm --remove-orphans web sh -c \
+UID=$(id -u) GID=$(id -u) docker compose run --rm --remove-orphans web sh -c \
     "echo 'Running unit tests...' && \
     poetry run coverage run manage.py test $TEST_MODULE $TAG \
     --settings=lung_cancer_screening.settings_test \