Merge branch 'develop' into feature/eema1-NRL-936-custodianTypeMatchIntegrationTests

Author: eesa456

.github/workflows/persistent-environment.yml

@@ -233,7 +233,10 @@ jobs:
         run: terraform -chdir=terraform/infrastructure apply tfplan
 
       - name: Smoke Test
-        run: make ENV=${{ inputs.environment }} test-smoke-internal
+        run: |
+          account=$(echo '${{ inputs.environment }}' | cut -d '-' -f1)
+          make ENV=${account} truststore-pull-client
+          make ENV=${{ inputs.environment }} test-smoke-internal
 
   activate-stack:
     name: Activate - ${{ inputs.environment }}
@@ -318,12 +321,12 @@ jobs:
 
       - name: "Smoke Test"
         run: |
-          make ENV=${{ inputs.environment }} test-smoke-external
+          make ENV=${{ inputs.environment }} test-smoke-public
 
   rollback-stack:
     name: Rollback - ${{ inputs.environment }}
     needs: [post-release-verify]
-    if: ${{ needs.post-release-verify.result == 'failure' }}
+    if: always() && ( needs.post-release-verify.result == 'failure' )
     runs-on: [self-hosted, ci]
     environment: ${{ inputs.environment }}
 

.github/workflows/rollback-stack.yml

@@ -64,4 +64,4 @@ jobs:
 
       - name: "Smoke Test"
         run: |
-          make ENV=${{ inputs.environment }} test-smoke-external
+          make ENV=${{ inputs.environment }} test-smoke-public

Makefile

@@ -1,14 +1,14 @@
 
 .EXPORT_ALL_VARIABLES:
 .NOTPARALLEL:
-.ONESHELL:
 .PHONY: *
 
 MAKEFLAGS := --no-print-directory
 SHELL := /bin/bash
 
 DIST_PATH ?= ./dist
 TEST_ARGS ?= --cov --cov-report=term-missing
+SMOKE_TEST_ARGS ?=
 FEATURE_TEST_ARGS ?= ./tests/features --format progress2
 TF_WORKSPACE_NAME ?= $(shell terraform -chdir=terraform/infrastructure workspace show)
 ENV ?= dev
@@ -76,25 +76,45 @@ build-api-packages: ./api/consumer/* ./api/producer/*
 
 test: check-warn ## Run the unit tests
 	@echo "Running unit tests"
-	pytest -m "not integration and not legacy and not smoke" --ignore=mi $(TEST_ARGS)
+	pytest --ignore=tests/smoke $(TEST_ARGS)
 
 test-features-integration: check-warn ## Run the BDD feature tests in the integration environment
+	@echo "Running feature tests in the integration environment ${TF_WORKSPACE_NAME}"
+	behave --define="integration_test=true" \
+		--define="env=$(TF_WORKSPACE_NAME)" \
+		--define="account_name=$(ENV)" \
+		--define="use_shared_resources=${USE_SHARED_RESOURCES}" \
+		$(FEATURE_TEST_ARGS)
+
+test-features-integration-report: check-warn ## Run the BDD feature tests in the integration environment and generate allure report therafter
+	@echo "Cleaning previous Allure results and reports"
+	rm -rf ./allure-results
+	rm -rf ./allure-report
 	@echo "Running feature tests in the integration environment"
 	behave --define="integration_test=true" \
 		--define="env=$(TF_WORKSPACE_NAME)" \
 		--define="account_name=$(ENV)" \
 		--define="use_shared_resources=${USE_SHARED_RESOURCES}" \
 		$(FEATURE_TEST_ARGS)
+	@echo "Generating Allure report"
+	allure generate ./allure-results -o ./allure-report --clean
+	@echo "Opening Allure report"
+	allure open ./allure-report
 
 test-smoke-internal: check-warn ## Run the smoke tests against the internal environment
-	@echo "Running smoke tests against the internal environment"
-	#ENV=$(TF_WORKSPACE_NAME) SMOKE_TEST_MODE=mtls pytest ./tests/smoke $(SMOKE_TEST_ARGS)
-	@echo "Skipping internal smoke tests (not yet implemented)"
-
-test-smoke-external: check-warn ## Run the smoke tests for the external access points
-	@echo "Running smoke tests for the external access points"
-	#ENV=$(ENV) SMOKE_TEST_MODE=apigee pytest ./tests/smoke $(SMOKE_TEST_ARGS)
-	@echo "Skipping external smoke tests (not yet implemented)"
+	@echo "Running smoke tests against the internal environment ${TF_WORKSPACE_NAME}"
+	TEST_ENVIRONMENT_NAME=$(ENV) \
+	TEST_STACK_NAME=$(TF_WORKSPACE_NAME) \
+	TEST_STACK_DOMAIN=$(shell terraform -chdir=terraform/infrastructure output -raw domain 2>/dev/null) \
+	TEST_CONNECT_MODE="internal" \
+		pytest ./tests/smoke/scenarios/* $(SMOKE_TEST_ARGS)
+
+test-smoke-public: check-warn ## Run the smoke tests for the external access points
+	@echo "Running smoke tests for the public endpoints ${ENV}"
+	TEST_ENVIRONMENT_NAME=$(ENV) \
+	TEST_STACK_NAME=$(TF_WORKSPACE_NAME) \
+	TEST_CONNECT_MODE="public" \
+		pytest ./tests/smoke/scenarios/* $(SMOKE_TEST_ARGS)
 
 test-performance-prepare:
 	mkdir -p $(DIST_PATH)
@@ -138,6 +158,10 @@ get-s3-perms: check-warn ## Get s3 permissions for an environment
 	@echo "Creating new Lambda NRLF permissions layer zip"
 	./scripts/add-perms-to-lambda.sh $(DIST_PATH)
 
+set-smoketest-perms: check-warn ## Set the permissions for the smoke tests
+	@echo "Setting permissions for smoke tests of env=$(ENV) stack=$(TF_WORKSPACE_NAME)...."
+	poetry run python scripts/set_smoketest_permissions.py $(ENV) $(TF_WORKSPACE_NAME) $(ENV)
+
 truststore-build-all: check-warn ## Build all truststore resources
 	@./scripts/truststore.sh build-all
 

README.md

@@ -283,6 +283,28 @@ To run the feature integration tests:
 $ make test-features-integration
 ```
 
+### Smoke testing
+
+For smoke tests, you need to have deployed your infrastructure (using Terraform).
+
+Before the first run of the smoke tests, you need to set the required permissions in your deployment. You can do this by running:
+
+```
+$ make set-smoketest-perms
+```
+
+To run the internal smoke tests against your stack, do this:
+
+```
+$ make test-smoke-internal
+```
+
+To run the smoke tests against the public access endpoints (via APIGEE proxies), do this:
+
+```
+$ make test-smoke-public
+```
+
 ## API Documentation
 
 If the API changes, the API documentation needs to be updated in the appropriate API repo. This is done by making changes to the API specification `.yaml` files in each repo.

api/consumer/countDocumentReference/tests/test_count_document_reference.py

@@ -10,6 +10,7 @@
     create_headers,
     create_mock_context,
     create_test_api_gateway_event,
+    default_response_headers,
 )
 
 
@@ -26,7 +27,11 @@ def test_count_document_reference_happy_path(repository: DocumentPointerReposito
     result = handler(event, create_mock_context())  # type: ignore
     body = result.pop("body")
 
-    assert result == {"statusCode": "200", "headers": {}, "isBase64Encoded": False}
+    assert result == {
+        "statusCode": "200",
+        "headers": default_response_headers(),
+        "isBase64Encoded": False,
+    }
 
     parsed_body = json.loads(body)
     assert parsed_body == {"resourceType": "Bundle", "type": "searchset", "total": 0}
@@ -38,7 +43,11 @@ def test_count_document_reference_happy_path(repository: DocumentPointerReposito
     result = handler(event, create_mock_context())  # type: ignore
     body = result.pop("body")
 
-    assert result == {"statusCode": "200", "headers": {}, "isBase64Encoded": False}
+    assert result == {
+        "statusCode": "200",
+        "headers": default_response_headers(),
+        "isBase64Encoded": False,
+    }
 
     parsed_body = json.loads(body)
     assert parsed_body == {"resourceType": "Bundle", "type": "searchset", "total": 1}
@@ -50,7 +59,11 @@ def test_count_document_reference_missing_nhs_number():
     result = handler(event, create_mock_context())  # type: ignore
     body = result.pop("body")
 
-    assert result == {"statusCode": "400", "headers": {}, "isBase64Encoded": False}
+    assert result == {
+        "statusCode": "400",
+        "headers": default_response_headers(),
+        "isBase64Encoded": False,
+    }
 
     parsed_body = json.loads(body)
     assert parsed_body == {
@@ -86,7 +99,11 @@ def test_count_document_reference_invalid_nhs_number():
     result = handler(event, create_mock_context())  # type: ignore
     body = result.pop("body")
 
-    assert result == {"statusCode": "400", "headers": {}, "isBase64Encoded": False}
+    assert result == {
+        "statusCode": "400",
+        "headers": default_response_headers(),
+        "isBase64Encoded": False,
+    }
 
     parsed_body = json.loads(body)
     assert parsed_body == {

api/consumer/readDocumentReference/tests/test_read_document_reference_consumer.py

@@ -10,6 +10,7 @@
     create_headers,
     create_mock_context,
     create_test_api_gateway_event,
+    default_response_headers,
 )
 
 
@@ -28,7 +29,11 @@ def test_read_document_reference_happy_path(repository: DocumentPointerRepositor
     result = handler(event, create_mock_context())
     body = result.pop("body")
 
-    assert result == {"statusCode": "200", "headers": {}, "isBase64Encoded": False}
+    assert result == {
+        "statusCode": "200",
+        "headers": default_response_headers(),
+        "isBase64Encoded": False,
+    }
 
     parsed_body = json.loads(body)
     assert parsed_body == doc_ref.dict(exclude_none=True)
@@ -44,7 +49,11 @@ def test_read_document_reference_not_found(repository: DocumentPointerRepository
     result = handler(event, create_mock_context())
     body = result.pop("body")
 
-    assert result == {"statusCode": "404", "headers": {}, "isBase64Encoded": False}
+    assert result == {
+        "statusCode": "404",
+        "headers": default_response_headers(),
+        "isBase64Encoded": False,
+    }
 
     parsed_body = json.loads(body)
     assert parsed_body == {
@@ -74,7 +83,11 @@ def test_read_document_reference_missing_id():
     result = handler(event, create_mock_context())
     body = result.pop("body")
 
-    assert result == {"statusCode": "400", "headers": {}, "isBase64Encoded": False}
+    assert result == {
+        "statusCode": "400",
+        "headers": default_response_headers(),
+        "isBase64Encoded": False,
+    }
 
     parsed_body = json.loads(body)
     assert parsed_body == {
@@ -118,7 +131,7 @@ def test_read_document_reference_unauthorised_for_type(
 
     assert result == {
         "statusCode": "403",
-        "headers": {},
+        "headers": default_response_headers(),
         "isBase64Encoded": False,
     }
 
@@ -163,7 +176,7 @@ def test_document_reference_invalid_json(repository: DocumentPointerRepository):
 
     assert result == {
         "statusCode": "500",
-        "headers": {},
+        "headers": default_response_headers(),
         "isBase64Encoded": False,
     }
 

api/consumer/searchDocumentReference/tests/test_search_document_reference_consumer.py

@@ -10,6 +10,7 @@
     create_headers,
     create_mock_context,
     create_test_api_gateway_event,
+    default_response_headers,
 )
 
 
@@ -30,7 +31,11 @@ def test_search_document_reference_happy_path(repository: DocumentPointerReposit
     result = handler(event, create_mock_context())
     body = result.pop("body")
 
-    assert result == {"statusCode": "200", "headers": {}, "isBase64Encoded": False}
+    assert result == {
+        "statusCode": "200",
+        "headers": default_response_headers(),
+        "isBase64Encoded": False,
+    }
 
     parsed_body = json.loads(body)
 
@@ -68,7 +73,11 @@ def test_search_document_reference_happy_path_with_custodian(
     result = handler(event, create_mock_context())
     body = result.pop("body")
 
-    assert result == {"statusCode": "200", "headers": {}, "isBase64Encoded": False}
+    assert result == {
+        "statusCode": "200",
+        "headers": default_response_headers(),
+        "isBase64Encoded": False,
+    }
 
     parsed_body = json.loads(body)
     assert parsed_body == {
@@ -105,7 +114,11 @@ def test_search_document_reference_happy_path_with_type(
     result = handler(event, create_mock_context())
     body = result.pop("body")
 
-    assert result == {"statusCode": "200", "headers": {}, "isBase64Encoded": False}
+    assert result == {
+        "statusCode": "200",
+        "headers": default_response_headers(),
+        "isBase64Encoded": False,
+    }
 
     parsed_body = json.loads(body)
     assert parsed_body == {
@@ -135,7 +148,11 @@ def test_search_document_reference_no_results(repository: DocumentPointerReposit
     result = handler(event, create_mock_context())
     body = result.pop("body")
 
-    assert result == {"statusCode": "200", "headers": {}, "isBase64Encoded": False}
+    assert result == {
+        "statusCode": "200",
+        "headers": default_response_headers(),
+        "isBase64Encoded": False,
+    }
 
     parsed_body = json.loads(body)
     assert parsed_body == {
@@ -162,7 +179,11 @@ def test_search_document_reference_missing_nhs_number(
     result = handler(event, create_mock_context())
     body = result.pop("body")
 
-    assert result == {"statusCode": "400", "headers": {}, "isBase64Encoded": False}
+    assert result == {
+        "statusCode": "400",
+        "headers": default_response_headers(),
+        "isBase64Encoded": False,
+    }
 
     parsed_body = json.loads(body)
     assert parsed_body == {
@@ -202,7 +223,11 @@ def test_search_document_reference_invalid_nhs_number(
     result = handler(event, create_mock_context())
     body = result.pop("body")
 
-    assert result == {"statusCode": "400", "headers": {}, "isBase64Encoded": False}
+    assert result == {
+        "statusCode": "400",
+        "headers": default_response_headers(),
+        "isBase64Encoded": False,
+    }
 
     parsed_body = json.loads(body)
     assert parsed_body == {
@@ -241,7 +266,11 @@ def test_search_document_reference_invalid_type(repository: DocumentPointerRepos
     result = handler(event, create_mock_context())
     body = result.pop("body")
 
-    assert result == {"statusCode": "400", "headers": {}, "isBase64Encoded": False}
+    assert result == {
+        "statusCode": "400",
+        "headers": default_response_headers(),
+        "isBase64Encoded": False,
+    }
 
     parsed_body = json.loads(body)
     assert parsed_body == {
@@ -285,7 +314,11 @@ def test_search_document_reference_invalid_json(repository: DocumentPointerRepos
     result = handler(event, create_mock_context())
     body = result.pop("body")
 
-    assert result == {"statusCode": "500", "headers": {}, "isBase64Encoded": False}
+    assert result == {
+        "statusCode": "500",
+        "headers": default_response_headers(),
+        "isBase64Encoded": False,
+    }
 
     parsed_body = json.loads(body)
     assert parsed_body == {