[PPHA-186] Use ruff for linting

In order to allow linting inside the docker container, create a
"development" docker stage and run lint and test task via poetry.

The same command can be used between CI and local

Author: Themitchell

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

@@ -56,6 +56,7 @@ jobs:
         uses: actions/checkout@v4
       - name: "Run linting"
         run: |
+          cp .env.example .env
           make test-lint
       - name: "Save the linting result"
         run: |

Dockerfile

@@ -11,7 +11,13 @@ RUN npm run compile
 FROM python:3.13.5-alpine3.21 AS python_base
 
 ENV PYTHONDONTWRITEBYTECODE=1 \
-    PYTHONUNBUFFERED=1
+    PYTHONUNBUFFERED=1 \
+    VIRTUAL_ENV=/app/.venv \
+    PATH="/app/.venv/bin:$PATH" \
+    USER=app
+
+RUN addgroup --gid 1000 --system ${USER} \
+    && adduser --uid 1000 --system ${USER} --ingroup ${USER}
 
 FROM python_base AS builder
 
@@ -26,15 +32,21 @@ COPY pyproject.toml poetry.lock ./
 RUN pip install poetry
 RUN poetry install --without dev --no-root && rm -rf $POETRY_CACHE_DIR
 
+FROM builder AS development
 
-FROM python_base
+USER ${USER}
+WORKDIR /app
 
-ENV VIRTUAL_ENV=/app/.venv \
-    PATH="/app/.venv/bin:$PATH" \
-    USER=app
+COPY --chown=${USER}:${USER} . .
 
-RUN addgroup --gid 1000 --system ${USER} \
-    && adduser --uid 1000 --system ${USER} --ingroup ${USER}
+USER root
+
+RUN chown ${USER}:${USER} .
+RUN poetry install
+
+USER ${USER}
+
+FROM python_base
 
 USER ${USER}
 WORKDIR /app

docker-compose.yml

@@ -2,16 +2,17 @@
 
 services:
   web:
-    build: .
+    build:
+      context: .
+      dockerfile: Dockerfile
+      target: development
     command: python manage.py runserver 0.0.0.0:8000
     ports:
       - "8000:8000"
     env_file:
       - .env
     depends_on:
       - db
-    volumes:
-      - ./lung_cancer_screening:/app/lung_cancer_screening
     restart: unless-stopped
 
   asset_builder:

makefiles/dev.mk

@@ -1,32 +1,34 @@
 .PHONY: dev-run dev-up dev-down dev-logs dev-shell dev-migrate dev-makemigrations dev-clean dev-test
 
+DOCKER_COMPOSE_CMD = docker compose
+
 dev-build:
-	docker-compose build
+	$(DOCKER_COMPOSE_CMD) build
 
 dev-run:
-	docker-compose up --build
+	$(DOCKER_COMPOSE_CMD) up --build
 
 dev-up:
-	docker-compose up -d --build
+	$(DOCKER_COMPOSE_CMD) up -d --build
 
 dev-down:
-	docker-compose down
+	$(DOCKER_COMPOSE_CMD) down
 
 dev-logs:
-	docker-compose logs -f
+	$(DOCKER_COMPOSE_CMD) logs -f
 
 dev-shell:
-	docker-compose run web sh
+	$(DOCKER_COMPOSE_CMD) run web sh
 
 dev-migrate:
-	docker-compose run --rm web python manage.py migrate
+	$(DOCKER_COMPOSE_CMD) run --rm web python manage.py migrate
 
 dev-makemigrations:
-	docker-compose run --rm web python manage.py makemigrations
+	$(DOCKER_COMPOSE_CMD) run --rm web python manage.py makemigrations
 
 dev-clean:
-	docker-compose down -v --remove-orphans
-	docker system prune -f
+	$(DOCKER_COMPOSE_CMD) down -v --remove-orphans
+	$(DOCKER_COMPOSE_CMD) system prune -f
 
 dev-test:
-	docker-compose run --rm web python manage.py test
+	$(DOCKER_COMPOSE_CMD) run --rm web python manage.py test

poetry.lock

@@ -16,6 +16,9 @@ dependencies = [
 [tool.poetry]
 package-mode = false
 
+[tool.poetry.group.dev.dependencies]
+ruff = "^0.12.5"
+
 [build-system]
 requires = ["poetry-core>=2.0.0,<3.0.0"]
 build-backend = "poetry.core.masonry.api"

pyproject.toml

@@ -0,0 +1,20 @@
+#!/bin/bash
+
+set -euo pipefail
+
+cd "$(git rev-parse --show-toplevel)"
+
+# This file is for you! Edit it to call your unit test suite. Note that the same
+# file will be called if you run it locally as if you run it on CI.
+
+# Replace the following line with something like:
+#
+#   rubocop
+#   python manage.py lint
+#   npm run lint
+#
+# or whatever is appropriate to your project. You should *only* run your fast
+# tests from here. If you want to run other test suites, see the predefined
+# tasks in scripts/lint.mk.
+
+docker compose run --rm web poetry run ruff check lung_cancer_screening

scripts/tests/lint.sh

@@ -17,4 +17,4 @@ cd "$(git rev-parse --show-toplevel)"
 # tests from here. If you want to run other test suites, see the predefined
 # tasks in scripts/test.mk.
 
-docker compose run web python manage.py test
+docker compose run web poetry run python manage.py test