[NDR-321] Update make file & E2E test readme #993

megan-bower4 · 2026-01-13T15:08:38Z

Overview

Jira ticket: NDR-321

Description

Update to the makefile so it is easier to read, and gives a nicer error message when WORKSPACE isn't provided as a parameter to the fhir e2e tests.

Updated the E2E test readme also.

Context

When a new member of PDM ran the E2E tests from scratch they noted some readme improvements that would be helpful. These changes should ensure anyone can pick up the readme and run the E2E tests from scratch.

Checklist

Tasks for all changes:

1. I have linked this PR to its Jira ticket.
2. I have run git pre-commits.
3. I have added and/or updated relevant tests.
4. I have updated relevant documentation.
5. I have considered the cross-team impact (and have PR approval from both Core & Demographics if necessary).
6. I have successfully deployed this change to a sandbox and witnessed unit and e2e tests passing:
- 6a. Deploy - Sandbox - workflow run
- 6b. SANDBOX Full- Deploy feature branch to sandbox - workflow run

megan-bower4 · 2026-01-13T15:09:28Z

lambdas/tests/e2e/README.md

 | Environment Variable | Description                                                                                                                       |
 | -------------------- | --------------------------------------------------------------------------------------------------------------------------------- |
 | `NDR_API_KEY`          | The API key required to authenticate requests to the NDR API. API Gateway → API Keys for associated env e.g. ndr-dev_apim-api-key |
-| `NDR_API_ENDPOINT`     | The URI string used to connect to the NDR API.                                                                                    |


This is now constructed within the data helper class so no longer required to set.

megan-bower4 · 2026-01-13T15:15:38Z

lambdas/tests/e2e/helpers/data_helper.py

    def build_env(self, table_name, bucket_name):
        if not self.workspace:
-            raise ValueError("WORKSPACE environment variable is missing or empty.")
+            raise ValueError("AWS_WORKSPACE environment variable is missing or empty.")


Updated to reflect the variable name it is expecting from line 22

tim-knight-nhs · 2026-01-13T16:18:13Z

Makefile


-test-fhir-api-e2e: ## Runs FHIR API E2E tests. Usage: make test-fhir-api-e2e WORKSPACE=<workspace> CONTAINER=<true|false>
+test-fhir-api-e2e: ## Runs Core FHIR API E2E tests. Usage: make test-fhir-api-e2e WORKSPACE=<workspace> CONTAINER=<true|false>
+	@[ -n "$(WORKSPACE)" ] || { \


There's a pattern used quite frequently in other NHS projects that ensure variables are defined.

See the 'guard' wildcard function in https://github.com/NHSDigital/patient-data-manager/blob/72276ae131dff065a2f9b9157fe812fec4bf707d/Makefile#L16

Your function could then be defined with
test-fhir-api-e2e: guard-WORKSPACE ## Comments
Assuming it wouldn't break your awk! :)

jameslinnell · 2026-01-15T09:00:34Z

lambdas/tests/e2e/README.md


 ## 🔧 Available Make Commands

+If you are not using the dev container you **must** run `make env` before running the E2E tests. This sets up your venv and any required dependencies.


Should we be suggesting this? It's just the whole point of a dev container is that everyone uses it. I can only see very rare cases where it shouldn't be being used and if so that person should be able to work things out for themselves.

This ticket was from before the dev container was added and Charlie was struggling to run the E2E tests straight off the bat as the instructions were missing this step (the main purpose of this ticket was to add this instruction specifically).

And the dev container is still optional, even if preferred, so we should be keeping documentation up to date for how to run tests outside of it. This readme references instructions for both dev container and not already.

jameslinnell · 2026-01-15T09:00:59Z

lambdas/tests/e2e/README.md

 # 🧪 End-to-End Testing Setup

-These tests focus on the features of the NDR. This will serve as a blended suite of integration and end-to-end (E2E) tests, with the aim to validate API functionality and snapshot comparisons.
+These tests serve as a blended suite of integration and end-to-end (E2E) tests to validate FHIR API functionality and snapshot comparisons.


If I'm being really pedantic, these are not integration tests.

jameslinnell · 2026-01-15T09:03:54Z

lambdas/tests/e2e/README.md

 ## 🌍 Required Environment Variables

-In order to execute the E2E tests without mTLS (i.e. `make test-api-e2e`) you will need to ensure the following environment variables are set. You can export them in your shell configuration file (`~/.zshrc` or `~/.bashrc`) or **temporarily** add them to the `conftest.py`:
+In order to execute the Lloyd George API E2E tests (i.e. `make test-api-e2e`) you will need to ensure the following environment variables are set. You can export them in your shell configuration file (`~/.zshrc` or `~/.bashrc`) or equivalently your aws-vault session if using the dev container. Or **temporarily** add them to the `conftest.py`, but do not commit these:


Probably not for this ticket. But I feel like the "make test-api-e2e" command should be renamed to "make test-fhir-api-e2e-lg" and the PDM/Core to "make test-fhir-e2e-core"

Yes I agree, I'll write up a new ticket for it!

jameslinnell · 2026-01-15T09:05:36Z

Makefile


-help: ## This is a help message
-	@grep -E --no-filename '^[a-zA-Z-]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-42s\033[0m %s\n", $$1, $$2}'
+help: ## Show available targets and usage.


jameslinnell · 2026-01-15T09:06:10Z

Makefile

 	./scripts/aws/download-api-certs.sh $(WORKSPACE)

-test-api-e2e:
+test-api-e2e: ## Runs LG FHIR API E2E tests. See readme for required environment variables. Usage: make test-api-e2e CONTAINER=<true|false>


yeah, see what I said earlier about renaming these make commands.

github-actions · 2026-01-15T13:03:09Z

Code security issues found

View full details here.

sonarqubecloud · 2026-01-15T13:06:12Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

megan-bower4 had a problem deploying to development January 13, 2026 15:08 — with GitHub Actions Failure

megan-bower4 changed the title ~~NDR-321 Update make file & E2E test readme~~ [NDR-321] Update make file & E2E test readme Jan 13, 2026

megan-bower4 commented Jan 13, 2026

View reviewed changes

megan-bower4 had a problem deploying to development January 13, 2026 15:24 — with GitHub Actions Failure

megan-bower4 marked this pull request as ready for review January 13, 2026 15:26

megan-bower4 requested review from a team as code owners January 13, 2026 15:26

megan-bower4 requested a review from AndyFlintAnswerDigital January 13, 2026 15:26

megan-bower4 temporarily deployed to development January 13, 2026 15:51 — with GitHub Actions Inactive

megan-bower4 temporarily deployed to development January 13, 2026 15:52 — with GitHub Actions Inactive

megan-bower4 temporarily deployed to development January 13, 2026 15:53 — with GitHub Actions Inactive

megan-bower4 temporarily deployed to development January 13, 2026 15:54 — with GitHub Actions Inactive

tim-knight-nhs reviewed Jan 13, 2026

View reviewed changes

megan-bower4 had a problem deploying to development January 13, 2026 16:36 — with GitHub Actions Failure

tim-knight-nhs previously approved these changes Jan 13, 2026

View reviewed changes

jameslinnell reviewed Jan 15, 2026

View reviewed changes

megan-bower4 dismissed tim-knight-nhs’s stale review via c8e2f5a January 15, 2026 12:56

megan-bower4 had a problem deploying to development January 15, 2026 12:56 — with GitHub Actions Failure

megan-bower4 added 4 commits January 15, 2026 13:01

NDR-321 Update make file & E2E test readme

9fe34df

NDR-321 Fix markdown errors

824521c

NDR-321 Use guard functionality in makefile

82a76e9

NDR-321 Update readme

89fc94c

megan-bower4 force-pushed the NDR-321 branch from c8e2f5a to 89fc94c Compare January 15, 2026 13:02

megan-bower4 had a problem deploying to development January 15, 2026 13:02 — with GitHub Actions Failure


		## 🔧 Available Make Commands

		If you are not using the dev container you must run `make env` before running the E2E tests. This sets up your venv and any required dependencies.

[NDR-321] Update make file & E2E test readme #993

Are you sure you want to change the base?

[NDR-321] Update make file & E2E test readme #993

Conversation

megan-bower4 commented Jan 13, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Overview

Description

Context

Checklist

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Jan 15, 2026

Code security issues found

Uh oh!

sonarqubecloud bot commented Jan 15, 2026

Quality Gate passed

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

megan-bower4 commented Jan 13, 2026 •

edited

Loading