VED-1013 Part 2: Add status and ping tests to new automation test framework (#1133)

Author: dlzhry2nhs

tests/e2e_automation/.env.example

@@ -31,6 +31,8 @@ callback_url=https://oauth.pstmn.io/v1/callback
 S3_env=internal-qa
 aws_profile_name={your-aws-profile}
 ## Id/Secret values - please contact Dev or Test team to get these values
+STATUS_API_KEY=
+AWS_DOMAIN_NAME=
 Postman_Auth_client_Id=
 Postman_Auth_client_Secret=
 RAVS_client_Id=

tests/e2e_automation/README.md

@@ -31,6 +31,8 @@ This directory contains End-to-end Automation Tests for the Immunisation FHIR AP
     ```
     username
     scope
+    STATUS_API_KEY
+    AWS_DOMAIN_NAME
     Postman_Auth_client_Id
     Postman_Auth_client_Secret
     RAVS_client_Id

tests/e2e_automation/features/APITests/status.feature

@@ -0,0 +1,23 @@
+@Status_feature @functional
+Feature: Get the API status
+
+@smoke @sandbox @supplier_name_Postman_Auth
+Scenario: Verify that the /ping endpoint works
+    When I send a request to the ping endpoint
+    Then The request will be successful with the status code '200'
+
+@smoke @sandbox @supplier_name_Postman_Auth
+Scenario: Verify that the /status endpoint works
+    When I send a request to the status endpoint
+    Then The request will be successful with the status code '200'
+    And The status response will contain a passing healthcheck
+
+@smoke @supplier_name_Postman_Auth
+Scenario: Verify that clients cannot make a direct connection without mTLS to AWS backend
+    When I send a direct request to the AWS backend
+    Then The request is rejected
+
+@smoke @supplier_name_Postman_Auth
+Scenario: Verify that unauthenticated clients cannot get a successful response from the API
+    When I send an unauthenticated request to the API
+    Then The request will be unsuccessful with the status code '401'

tests/e2e_automation/features/APITests/steps/test_status_steps.py

@@ -0,0 +1,54 @@
+import os
+
+import pytest
+import requests
+from pytest_bdd import scenarios, then, when
+from utilities.context import ScenarioContext
+from utilities.http_requests_session import http_requests_session
+
+scenarios("APITests/status.feature")
+
+CONNECTION_ABORTED_ERROR_MSG = "<ExceptionInfo ConnectionError(ProtocolError('Connection aborted.', RemoteDisconnected('Remote end closed connection without response'))) tblen=6>"
+
+
+@when("I send a request to the ping endpoint")
+def send_request_to_ping_endpoint(context: ScenarioContext) -> None:
+    context.response = http_requests_session.get(context.baseUrl + "/_ping")
+
+
+@when("I send a request to the status endpoint")
+def send_request_status_endpoint(context: ScenarioContext) -> None:
+    # Let exception be raised if expected env var is not present
+    status_api_key: str = os.environ["STATUS_API_KEY"]
+    context.response = http_requests_session.get(context.baseUrl + "/_status", headers={"apikey": status_api_key})
+
+
+@when("I send a direct request to the AWS backend")
+def send_request_to_aws_backend(context: ScenarioContext) -> None:
+    # Let exception be raised if expected env var is not present
+    aws_domain_name: str = os.environ["AWS_DOMAIN_NAME"]
+    backend_status_url = aws_domain_name + "/status"
+
+    with pytest.raises(requests.exceptions.ConnectionError) as e:
+        requests.get(backend_status_url)
+
+    context.response = str(e)
+
+
+@when("I send an unauthenticated request to the API")
+def send_unauthenticated_request_to_api(context: ScenarioContext) -> None:
+    context.response = http_requests_session.get(context.baseUrl + "/Immunization")
+
+
+@then("The status response will contain a passing healthcheck")
+def check_status_response_healthy(context: ScenarioContext) -> None:
+    status_response = context.response.json()
+    assertion_failure_msg = f"Status response assertions failed. Res: {status_response}"
+
+    assert status_response.get("status") == "pass", assertion_failure_msg
+    assert status_response.get("checks", {}).get("healthcheck", {}).get("status") == "pass", assertion_failure_msg
+
+
+@then("The request is rejected")
+def check_the_direct_req_is_rejected(context: ScenarioContext) -> None:
+    assert context.response == CONNECTION_ABORTED_ERROR_MSG, f"got unexpected mTLS error msg: {context.response}"

tests/e2e_automation/pytest.ini

@@ -9,13 +9,14 @@ addopts = --alluredir output/allure-results
 markers =
     allure.suite: Assigns test to a suite in Allure reports
     Create_Feature: tag for create feature tests    
-    Search_Feature: tag for search feature tests    
+    Search_Feature: tag for search feature tests  
     Delete_Feature: tag for delete feature tests
+    Read_Feature: tag for read feature tests
+    Status_Feature: tag for status feature tests
     Update_Feature: tag for update feature tests
     Create_Batch_Feature: tag for create batch feature tests
     Update_Batch_Feature: tag for update batch feature tests
     Delete_Batch_Feature: tag for delete batch feature tests
-    Read_Feature: tag for read feature tests
     Delete_cleanUp: tag for scenarios that require cleanup after execution
     delete_cleanup_batch: tag for batch scenarios that require cleanup after execution
     patient_id_OldNHS: tag for old NHS patient ID scenarios