Add Sandbox check GitHub Action

.dependabot/config.yml

@@ -1,5 +1,11 @@
 version: 1
 update_configs:
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    groups:
+      github-action-dependencies:
+        patterns:
+          - "*"
   - package_manager: "javascript"
     directory: "/"
     update_schedule: "live"

.github/workflows/sandbox-checks.yaml

@@ -0,0 +1,25 @@
+name: Sandbox Check
+on: pull_request
+jobs:
+  sandbox-check:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Install poetry
+        run: pipx install poetry
+      - uses: actions/setup-python@v5
+        with:
+          python-version: '3.8'
+          cache: 'poetry'
+      - name: Install dependencies
+        run: make install
+        working-directory: ./sandbox
+      - name: Check Sandbox Formatting
+        run: make check-format
+      - name: Run Sandbox Linting
+        run: make lint
+        working-directory: ./sandbox
+      - name: Run Sandbox Unit Tests
+        run: make test
+        working-directory: ./sandbox

Makefile

@@ -18,9 +18,11 @@ 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:
-# TODO: Python linting
 	find . -name '*.py' -not -path '**/.venv/*' | xargs poetry run flake8
 
+format:
+	find . -name '*.py' -not -path '**/.venv/*' | xargs poetry run black --check
+
 #Removes build/ + dist/ directories
 clean:
 	rm -rf build

sandbox/Dockerfile

@@ -6,7 +6,7 @@ WORKDIR /sandbox
 
 RUN pip install poetry
 
-RUN poetry install --only sandbox
+RUN poetry install --without dev
 
 EXPOSE 9000
 

sandbox/Makefile

@@ -2,14 +2,23 @@ SHELL := /bin/bash
 dirname := $(notdir $(patsubst %/,%,$(CURDIR)))
 
 install:
-	poetry install
+	poetry install --no-root
 
 list:
 	@grep '^[^#[:space:]].*:' Makefile
 
 build:
 	docker build -t validate-relationships-service-api-sandbox .
 
+check-format:
+	poetry run black --check .
+
+format:
+	poetry run black .
+
+lint:
+	poetry run flake8 .
+
 start:
 	poetry run flask --app api.app:app run -p 9000
 

sandbox/api/app.py

@@ -1,8 +1,10 @@
-from flask import Flask
-from .utils import get_response
-from logging import getLogger, basicConfig, INFO
+from logging import INFO, basicConfig, getLogger
 from typing import Union
 
+from flask import Flask, request
+
+from .utils import get_response
+
 app = Flask(__name__)
 basicConfig(level=INFO, format="%(asctime)s - %(message)s")
 logger = getLogger(__name__)
@@ -17,7 +19,19 @@ def related_persons() -> Union[dict, tuple]:
     """
 
     try:
-        return get_response("./api/responses/RelatedPerson_identifier_and_patient.json")
+        if not request.args.get("identifier"):
+            print(f"Args not found: {request.args}")
+            return {"error": "Missing required parameter 'identifier'"}, 400
+
+        if request.args.get("identifier") and request.args.get("patient"):
+            return get_response(
+                "./api/responses/RelatedPerson_identifier_and_patient.json"
+            )
+        elif request.args.get("identifier"):
+            return get_response("./api/responses/RelatedPerson.json")
+        else:
+            raise Exception("Invalid request")
+
     except Exception as e:
         logger.error(e)
-        return {"error": "Internal Server Error"}, 500
+        return {"error": "Sandbox Internal Server Error"}, 500

sandbox/api/tests/test_app.py

@@ -0,0 +1,22 @@
+from unittest.mock import MagicMock, patch
+
+import pytest
+
+from ..app import app
+
+
+@pytest.fixture()
+def client() -> object:
+    """Create a test client for the app."""
+    return app.test_client()
+
+
+@patch("sandbox.api.app.get_response")
+def test_related_person(mock_get_response: MagicMock, client: object) -> None:
+    """"""
+    # Arrange
+    mock_get_response.return_value = {"data": "mocked"}
+    # Act
+    client.get("/RelatedPerson?identifier=1234")
+    # Assert
+    mock_get_response.assert_called_once_with("./api/responses/RelatedPerson.json")

sandbox/poetry.toml

@@ -0,0 +1,2 @@
+[virtualenvs]
+in-project = true

sandbox/pyproject.toml

@@ -7,10 +7,8 @@ package-mode = false
 
 [tool.poetry.dependencies]
 python = "^3.8"
-
-[tool.poetry.group.sandbox.dependencies]
-flask = "^3.0.2"
 gunicorn = "^21.2.0"
+flask = "^3.0.2"
 
 [tool.poetry.dev-dependencies]
 flake8 = "^3.7.9"

scripts/pre-commit

@@ -1,2 +1,2 @@
 #!/bin/sh
-make lint
+make format lint

tests/test_endpoints.py

@@ -3,6 +3,7 @@
 https://github.com/NHSDigital/pytest-nhsd-apim/blob/main/tests/test_examples.py
 for more ideas on how to test the authorization of your API.
 """
+
 import requests
 import pytest
 from os import getenv
@@ -20,9 +21,11 @@ def test_wait_for_ping(nhsd_apim_proxy_url):
     resp = requests.get(f"{nhsd_apim_proxy_url}/_ping")
     deployed_commitId = resp.json().get("commitId")
 
-    while (deployed_commitId != getenv('SOURCE_COMMIT_ID')
-            and retries <= 30
-            and resp.status_code == 200):
+    while (
+        deployed_commitId != getenv("SOURCE_COMMIT_ID")
+        and retries <= 30
+        and resp.status_code == 200
+    ):
         resp = requests.get(f"{nhsd_apim_proxy_url}/_ping")
         deployed_commitId = resp.json().get("commitId")
         retries += 1
@@ -32,7 +35,7 @@ def test_wait_for_ping(nhsd_apim_proxy_url):
     elif retries >= 30:
         pytest.fail("Timeout Error - max retries")
 
-    assert deployed_commitId == getenv('SOURCE_COMMIT_ID')
+    assert deployed_commitId == getenv("SOURCE_COMMIT_ID")
 
 
 @pytest.mark.smoketest
@@ -47,14 +50,20 @@ def test_status(nhsd_apim_proxy_url, status_endpoint_auth_headers):
 @pytest.mark.smoketest
 def test_wait_for_status(nhsd_apim_proxy_url, status_endpoint_auth_headers):
     retries = 0
-    resp = requests.get(f"{nhsd_apim_proxy_url}/_status", headers=status_endpoint_auth_headers)
+    resp = requests.get(
+        f"{nhsd_apim_proxy_url}/_status", headers=status_endpoint_auth_headers
+    )
     deployed_commitId = resp.json().get("commitId")
 
-    while (deployed_commitId != getenv('SOURCE_COMMIT_ID')
-            and retries <= 30
-            and resp.status_code == 200
-            and resp.json().get("version")):
-        resp = requests.get(f"{nhsd_apim_proxy_url}/_status", headers=status_endpoint_auth_headers)
+    while (
+        deployed_commitId != getenv("SOURCE_COMMIT_ID")
+        and retries <= 30
+        and resp.status_code == 200
+        and resp.json().get("version")
+    ):
+        resp = requests.get(
+            f"{nhsd_apim_proxy_url}/_status", headers=status_endpoint_auth_headers
+        )
         deployed_commitId = resp.json().get("commitId")
         retries += 1
 
@@ -65,7 +74,7 @@ def test_wait_for_status(nhsd_apim_proxy_url, status_endpoint_auth_headers):
     elif not resp.json().get("version"):
         pytest.fail("version not found")
 
-    assert deployed_commitId == getenv('SOURCE_COMMIT_ID')
+    assert deployed_commitId == getenv("SOURCE_COMMIT_ID")
 
 
 @pytest.mark.nhsd_apim_authorization({"access": "application", "level": "level0"})