eli-176 adding an 'example' serving proxy which leverages Prisms 'example' and 'code' params

.gitignore

@@ -30,13 +30,15 @@ __pycache__/
 .venv/
 
 smoketest-report.xml
-env
+.env
 .dir-locals.el
 *.pyc
 */package-lock.json
 test-report.xml
 .coverage
 
 localstack_data/
+sandbox/specification/*
 /volume/*
 /coverage.xml
+/specification/tmp/*

Makefile

@@ -10,7 +10,6 @@ install-python:
 #Installs dependencies using npm.
 install-node:
 	npm install --legacy-peer-deps
-	cd sandbox && npm install --legacy-peer-deps
 
 #Configures Git Hooks, which are scripts that run given a specified event.
 .git/hooks/pre-commit:
@@ -34,8 +33,9 @@ format: ## Format and fix code
 #Creates the fully expanded OAS spec in json
 publish: clean
 	mkdir -p build
+	mkdir -p sandbox/specification
 	npm run publish 2> /dev/null
-
+	cp build/eligibility-signposting-api.json sandbox/specification/eligibility-signposting-api.json
 #Files to loop over in release
 _dist_include="pytest.ini poetry.lock poetry.toml pyproject.toml Makefile build/. tests"
 
@@ -48,9 +48,6 @@ dependencies: # Install dependencies needed to build and test the project @Pipel
 build: # Build lambda in dist
 	poetry build-lambda -vv
 
-publish: # Publish the project artefact @Pipeline
-	# TODO: Implement the artefact publishing step
-
 deploy: # Deploy the project artefact to the target environment @Pipeline
 	# TODO: Implement the artefact deployment step
 

README.md

@@ -16,8 +16,11 @@ The software will only be used for signposting an individual to an appropriate s
   - [Setup](#setup)
     - [Prerequisites](#prerequisites)
     - [Configuration](#configuration)
+      - [Environment variables](#environment-variables)
   - [Usage](#usage)
     - [Testing](#testing)
+  - [Sandbox](#sandbox)
+  - [Conflict with yanai](#conflict-with-yanai)
   - [Design](#design)
     - [Diagrams](#diagrams)
     - [Modularity](#modularity)
@@ -88,6 +91,10 @@ make precommit
 
 There are `make` tasks for you to configure to run your tests.  Run `make test` to see how they work.  You should be able to use the same entry points for local development as in your CI pipeline.
 
+## Sandbox
+
+There is a minimalist sandbox environment in `/sandbox` with an accompanying README with instructions on how to run it locally.
+
 ## Conflict with yanai
 
 If you have previously built [yanai](https://nhsd-confluence.digital.nhs.uk/pages/viewpage.action?pageId=48826732), which is the platform we use to supply data to this project, that uses an old version of localstack that does not support our Python version. We have pinned the correct version here and yanai have their version pinned as well so it should work fine, but sometimes issues can arise - if so then removing the docker image can solve that, before then rebuilding.

pyproject.toml

@@ -86,7 +86,7 @@ log_date_format = "%Y-%m-%d %H:%M:%S"
 [tool.coverage.run]
 relative_files = true
 branch = true
-source = ["src"]
+source = ["src", "sandbox"]
 
 [tool.coverage.report]
 show_missing = true

sandbox/Dockerfile

@@ -1,11 +1,38 @@
-FROM node:12
+# First Stage: Build Proxy service
+FROM python:3.13-alpine AS deps
 
-COPY . /sandbox
+# Install poetry
+RUN pip install poetry
 
-WORKDIR /sandbox
+# Install python dependencies in /.venv
+COPY pyproject.toml poetry.lock ./
+RUN poetry config virtualenvs.in-project true && poetry install --no-root
 
-RUN npm install
+FROM deps AS runtime
 
-EXPOSE 9000
+# Copy virtual env from python-deps stage
+COPY --from=deps /.venv /.venv
+ENV PATH="/.venv/bin:$PATH"
+
+# Create and switch to a new user
+RUN addgroup -S appgroup && \
+    adduser -S appuser -G appgroup && \
+    mkdir /home/appuser/app
+WORKDIR /home/appuser/app
+USER appuser
 
-CMD ["npm", "start"]
+# Install application into container
+COPY app.py __init__.py /home/appuser/app/
+# Copy supervisord configuration
+COPY supervisord.conf /etc/supervisord.conf
+# Install Prism
+USER root
+RUN apk add --no-cache nodejs npm && \
+    npm install --ignore-scripts -g @stoplight/prism-cli && \
+    apk add --no-cache supervisor
+
+# Expose ports
+EXPOSE 9000
+ENV UPSTREAM_HOST=http://localhost:5000
+# Run supervisord
+CMD ["supervisord", "-c", "/etc/supervisord.conf"]

sandbox/HealthStatusEndpoint.json

@@ -0,0 +1,21 @@
+{
+    "/_status": {
+      "get": {
+        "operationId": "healthcheck",
+        "summary": "healthcheck endpoint",
+        "responses": {
+          "200": {
+            "description": "Successful Operation",
+            "content": {
+              "application/text": {
+                "schema": {
+                  "type": "string"
+                },
+                "example": "OK"
+              }
+            }
+          }
+        }
+      }
+  }
+  }

sandbox/Makefile

@@ -1,11 +1,18 @@
 SHELL := /bin/bash
 dirname := $(notdir $(patsubst %/,%,$(CURDIR)))
+project_name = eligibility-signposting-api
 
 list:
 	@grep '^[^#[:space:]].*:' Makefile
 
 build:
-	docker build .
+	docker-compose -f docker-compose.yaml build
+
+up: build
+	docker-compose -f docker-compose.yaml up -d
+
+down:
+	docker-compose -f docker-compose.yaml down
 
 clean:
 	rm -rf ./node_modules
@@ -16,8 +23,11 @@ install:
 update:
 	npm update
 
+spec:
+	mkdir -p specification
+	make -C .. publish
+
 test:
-	NODE_ENV=test npx mocha --reporter spec
+	UPSTREAM_HOST=test poetry run pytest
 
-test-report:
-	NODE_ENV=test npx mocha --reporter mocha-junit-reporter --reporter-options mochaFile=../../reports/tests/$(dirname).xml || true
+.PHONY: build run spec test

sandbox/README.md

@@ -0,0 +1,34 @@
+# Sandbox environment
+
+The sandbox environment uses:
+
+* [OpenAPI Generator CLI](https://github.com/OpenAPITools/openapi-generator-cli) to validate the specification and convert it from .yaml to .json for use in the sandbox.
+* [Prism](https://stoplight.io/open-source/prism) as a mock server.
+* A flask proxy to allow us to inject specific examples based on request attributes.
+
+## Developer instructions
+
+Run the following command to start the sandbox environment:
+
+```bash
+make spec
+make up
+```
+
+This will start the sandbox environment on localhost port 5000.
+
+```bash
+make down
+```
+
+This will stop the sandbox environment.
+
+### Example curl calls
+
+patient 0000000001 is a patient eligible and bookable for a Flu vaccination.
+
+```bash
+ curl -X GET "http://0.0.0.0:9000/eligibility?patient=0000000001" -H "Accept: application/json" -H "Authorization: Bearer sdvsd"
+```
+
+See [app.py](app.py) for more examples.