Merge remote-tracking branch 'origin/main' into feature/eja-eli-173-create-postman-collection-automagically

Author: eddalmond1

.github/workflows/stage-4-acceptance.yaml

@@ -130,6 +130,28 @@ jobs:
       - name: "Save result"
         run: |
           echo "Nothing to save"
+      - name: Upload Integration Test Results
+        if: always()
+        uses: actions/upload-artifact@v4
+        with:
+          name: integration-test-results
+          path: integration-test-results.xml
+      - name: Gather Integration Test Summaries
+        if: always()
+        uses: actions/download-artifact@v4
+        with:
+          path: summary
+          pattern: ci-summary-*
+          merge-multiple: true
+      - name: Integration Test Report
+        if: always()
+        uses: phoenix-actions/test-reporting@v15
+        with:
+          name: Integration Test Summary
+          path: integration-test-results.xml
+          reporter: java-junit
+          output-to: step-summary
+
   test-accessibility:
     name: "Accessibility test"
     runs-on: ubuntu-latest

.gitignore

@@ -30,17 +30,18 @@ __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
 /lines-of-code-report*
-/specification/tmp
 /specification/postman
 /sandbox/specification/*
+/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"
 

README.md

@@ -16,8 +16,10 @@ 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)
   - [Creating a Postman collection](#creating-a-postman-collection)
   - [Design](#design)
@@ -66,7 +68,15 @@ The following software packages, or their equivalents, are expected to be instal
 
 ### Configuration
 
-None so far!
+#### Environment variables
+
+| Variable                | Default                 | Description                                                                                                                                                            |
+|-------------------------|-------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `DYNAMODB_ENDPOINT`     | `http://localhost:4566` | Endpoint for the app to access DynamoDB                                                                                                                                |
+| `AWS_REGION`            | `eu-west-1`             | AWS Region                                                                                                                                                             |
+| `AWS_ACCESS_KEY`        | `dummy_key`             | AWS Access Key                                                                                                                                                         |
+| `AWS_SECRET_ACCESS_KEY` | `dummy_secret`          | AWS Secret Access Key                                                                                                                                                  |
+| `LOG_LEVEL`             | `WARNING`               | Logging level. Must be one of `DEBUG`, `INFO`, `WARNING`, `ERROR` or `CRITICAL` as per [Logging Levels](https://docs.python.org/3/library/logging.html#logging-levels) |
 
 ## Usage
 
@@ -82,6 +92,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.