Add test, lint and format tasks to Makefile.

Author: brunns

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

@@ -40,6 +40,10 @@ jobs:
     steps:
       - name: "Checkout code"
         uses: actions/checkout@v4
+      - name: "Set up Python"
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.13'
       - name: "Run unit test suite"
         run: |
           make test-unit
@@ -53,6 +57,10 @@ jobs:
     steps:
       - name: "Checkout code"
         uses: actions/checkout@v4
+      - name: "Set up Python"
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.13'
       - name: "Run linting"
         run: |
           make test-lint
@@ -67,6 +75,10 @@ jobs:
     steps:
       - name: "Checkout code"
         uses: actions/checkout@v4
+      - name: "Set up Python"
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.13'
       - name: "Run test coverage check"
         run: |
           make test-coverage

.gitignore

@@ -14,6 +14,7 @@
 
 .direnv
 node_modules/
+openapitools.json
 bin/
 dist/
 build/
@@ -35,5 +36,6 @@ env
 poetry.lock
 package-lock.json
 test-report.xml
+.coverage
 
 localstack_data/

Makefile

@@ -22,7 +22,14 @@ install: install-node install-python .git/hooks/pre-commit
 #Run the npm linting script (specified in package.json). Used to check the syntax and formatting of files.
 lint:
 	npm run lint
-	find . -name '*.py' -not -path '**/.venv/*' | xargs poetry run flake8
+	poetry run ruff format . --check
+	poetry run ruff check .
+	poetry run pyright
+
+
+format: ## Format and fix code
+	poetry run ruff format .
+	poetry run ruff check . --fix-only
 
 #Creates the fully expanded OAS spec in json
 publish: clean
@@ -36,7 +43,8 @@ _dist_include="pytest.ini poetry.lock poetry.toml pyproject.toml Makefile build/
 # Example CI/CD targets are: dependencies, build, publish, deploy, clean, etc.
 
 dependencies: # Install dependencies needed to build and test the project @Pipeline
-	# TODO: Implement installation of your project dependencies
+	pip install --user pipx
+	pipx install poetry
 
 build: # Build the project artefact @Pipeline
 	# TODO: Implement the artefact build step
@@ -51,6 +59,8 @@ config:: # Configure development environment (main) @Configuration
 	# TODO: Use only 'make' targets that are specific to this project, e.g. you may not need to install Node.js
 	make _install-dependencies
 
+precommit: lint test ## Pre-commit tasks
+
 # ==============================================================================
 
 ${VERBOSE}.SILENT: \

pyproject.toml

@@ -40,3 +40,20 @@ aiohttp = "^3.7.3"
 awscli = "^1.29.29"
 awscli-local = "^0.22.0"
 pyhamcrest = "^2.1.0"
+factory-boy = "^3.3.3"
+pyright = "^1.1.394"
+
+[tool.ruff]
+line-length = 120
+exclude = ["docs/", "scripts/"]
+
+[tool.ruff.lint]
+select = ["ALL"]
+ignore = ["COM812", "D"]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/*" = ["ANN", "INP", "S101"]
+
+[tool.pyright]
+include = ["src/"]
+pythonVersion = "3.13"

scripts/tests/integration.sh

@@ -0,0 +1,21 @@
+#!/bin/bash
+
+set -euo pipefail
+
+cd "$(git rev-parse --show-toplevel)"
+
+# This file is for you! Edit it to call your integration 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:
+#
+#   rails test:integration
+#   python manage.py test
+#   npm run test
+#
+# 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/test.mk.
+
+make dependencies install-python
+poetry run pytest tests/integration/ --durations=10 --cov-report term-missing --cov src

scripts/tests/unit.sh

@@ -17,4 +17,5 @@ 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.
 
-echo "Unit tests are not yet implemented. See scripts/tests/unit.sh for more."
+make dependencies install-python
+poetry run pytest tests/unit/ --durations=10 --cov-report term-missing --cov src

tests/.gitkeep …/eligibility_signposting_api/__init__.pytests/.gitkeep renamed to src/eligibility_signposting_api/__init__.py tests/.gitkeep renamed to src/eligibility_signposting_api/__init__.py

@@ -0,0 +1,8 @@
+from flask import Flask
+
+app = Flask(__name__)
+
+
+@app.route("/")
+def hello_world() -> str:
+    return "<p>Hello, World!</p>"

src/eligibility_signposting_api/app.py

@@ -0,0 +1,8 @@
+def test_something():
+    # Given
+
+    # When
+    actual = 1
+
+    # Then
+    assert actual == 1

tests/integration/test_goes_here.py

@@ -0,0 +1,8 @@
+def test_something():
+    # Given
+
+    # When
+    actual = 1
+
+    # Then
+    assert actual == 1