add end to end testing and environment setup

Author: cameronhargreaves1-nhs

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

@@ -143,6 +143,51 @@ jobs:
           DATABASE_USER: postgres
           DATABASE_HOST: localhost
 
+  notifications-end-to-end-test:
+    needs: test
+    if: needs.test.outputs.notifications-changed == 'true'
+    name: 'Notifications End to End Tests'
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+
+    services:
+      postgres:
+        image: postgres:17.4-alpine3.21
+        ports:
+          - 5432:5432
+        env:
+          POSTGRES_PASSWORD: postgres
+        options: >-
+          --health-cmd pg_isready
+          --health-interval 10s
+          --health-timeout 5s
+          --health-retries 5
+
+      steps:
+      - name: 'Checkout code'
+        uses: actions/checkout@v5
+
+      - name: Install poetry
+        run: pipx install poetry
+
+      - name: Set up Python
+        uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c
+        with:
+          python-version: '${{inputs.python_version}}'
+          cache: poetry
+          cache-dependency-path: ./poetry.lock
+
+      - name: Install dependencies
+        run: make dependencies
+
+      - name: 'Run notifications end to end test suite'
+        run: make test-end-to-end
+        env:
+          DATABASE_NAME: postgres
+          DATABASE_PASSWORD: postgres
+          DATABASE_USER: postgres
+          DATABASE_HOST: localhost
+
   frontend-integration-test:
     needs: test
     if: needs.test.outputs.frontend-changed == 'true'

Makefile

@@ -44,7 +44,7 @@ help: # Print help @Others
 test: test-unit test-ui test-lint # Run all tests @Testing
 
 test-unit: # Run unit tests @Testing
-	poetry run pytest -m 'not system' --ignore manage_breast_screening/notifications/tests/dependencies --ignore manage_breast_screening/notifications/tests/integration --cov --cov-report term-missing:skip-covered
+	poetry run pytest -m 'not system' --ignore manage_breast_screening/notifications/tests/dependencies --ignore manage_breast_screening/notifications/tests/integration --ignore manage_breast_screening/notifications/tests/end_to_end --cov --cov-report term-missing:skip-covered
 	npm test -- --coverage
 
 test-lint: # Lint files @Testing
@@ -63,6 +63,9 @@ test-ui: # Run UI tests @Testing
 test-integration:
 	cd manage_breast_screening/notifications && ./tests/integration/run.sh
 
+test-end-to-end:
+	cd manage_breast_screening/notifications && ./tests/end_to_end/run.sh
+
 run: manage_breast_screening/config/.env # Start the development server @Development
 	poetry run ./manage.py runserver
 

manage_breast_screening/notifications/compose.yml

@@ -12,6 +12,7 @@ services:
     profiles:
       - development
       - integration
+      - end_to_end
 
   mesh-sandbox:
     build:
@@ -34,6 +35,7 @@ services:
     profiles:
       - development
       - integration
+      - end_to_end
     volumes:
       - ./store/mailboxes.jsonl:/app/mesh_sandbox/store/data/mailboxes.jsonl:ro
       - ./store/workflows.jsonl:/app/mesh_sandbox/store/data/workflows.jsonl:ro
@@ -46,6 +48,8 @@ services:
     profiles:
       - development
       - integration
+      - end_to_end
+
     ports:
       - '8888:8888'
     healthcheck:
@@ -64,3 +68,4 @@ services:
         condition: service_healthy
     profiles:
       - integration
+      - end_to_end

manage_breast_screening/notifications/tests/end_to_end/run.sh

@@ -0,0 +1,5 @@
+docker compose --profile end-to-end run test-dependencies sleep 0.1
+poetry run pytest $(dirname "$(realpath $0)")
+test_exit_code=$?
+docker compose --profile end-to-end down --volumes --remove-orphans
+exit $test_exit_code

manage_breast_screening/notifications/tests/end_to_end/test_get_from_mesh_and_send_message_batch.py

@@ -0,0 +1,60 @@
+import uuid
+from datetime import datetime
+from unittest.mock import patch
+
+import pytest
+
+from manage_breast_screening.notifications.management.commands.create_appointments import (
+    Command as CreateAppointmentsCommand,
+)
+from manage_breast_screening.notifications.management.commands.send_message_batch import (
+    Command as SendMessageBatchCommand,
+)
+from manage_breast_screening.notifications.management.commands.store_mesh_messages import (
+    Command as StoreMeshMessagesCommand,
+)
+from manage_breast_screening.notifications.tests.integration.helpers import Helpers
+
+
+@patch("manage_breast_screening.notifications.services.api_client.jwt.encode")
+class TestEndToEnd:
+    @pytest.fixture(autouse=True)
+    def setup(self, monkeypatch):
+        monkeypatch.setenv("MESH_BASE_URL", "http://localhost:8700")
+        monkeypatch.setenv("MESH_CLIENT_PASSWORD", "password")
+        monkeypatch.setenv("MESH_CLIENT_SHARED_KEY", "TestKey")
+        monkeypatch.setenv("MESH_INBOX_NAME", "X26ABC1")
+
+        monkeypatch.setenv(
+            "BLOB_STORAGE_CONNECTION_STRING", Helpers().azurite_connection_string()
+        )
+        monkeypatch.setenv("BLOB_CONTAINER_NAME", "nbss-appoinments-data")
+
+        monkeypatch.setenv(
+            "NHS_NOTIFY_API_MESSAGE_BATCH_URL", "http://localhost:8888/message/batch"
+        )
+        monkeypatch.setenv("API_OAUTH_TOKEN_URL", "http://localhost:8888/token")
+        monkeypatch.setenv("API_OAUTH_API_KEY", "a1b2c3d4")
+        monkeypatch.setenv("API_OAUTH_API_KID", "test-1")
+
+        monkeypatch.setenv("PRIVATE_KEY", "test-key")
+
+    @pytest.mark.django_db
+    def test_get_from_mesh_and_send_message_batch(self, mock_jwt_encode):
+        helpers = Helpers()
+        test_file_1 = helpers.get_test_file_path("ABC_20241202091221_APPT_106.dat")
+        test_file_2 = helpers.get_test_file_path("ABC_20241202091321_APPT_107.dat")
+        helpers.add_file_to_mesh_mailbox(test_file_1)
+        helpers.add_file_to_mesh_mailbox(test_file_2)
+
+        store_mesh_messages = StoreMeshMessagesCommand()
+        store_mesh_messages.handle()
+
+        today_dirname = datetime.today().strftime("%Y-%m-%d")
+        CreateAppointmentsCommand().handle(**{"date_str": today_dirname})
+
+        routing_plan = str(uuid.uuid4())
+        send_message_batch = SendMessageBatchCommand()
+        send_message_batch.handle(**{"routing_plan_id": routing_plan})
+
+        # do we want to perform the failed message batch command here? or save that for another test?