ELI-578 Integration test to check if consumer has campaign mappings

Author: Karthikeyannhs

src/eligibility_signposting_api/common/api_error_response.py

@@ -143,3 +143,11 @@ def log_and_generate_response(
     fhir_error_code=FHIRSpineErrorCode.ACCESS_DENIED,
     fhir_display_message="Access has been denied to process this request.",
 )
+
+CONSUMER_HAS_NO_CAMPAIGN_MAPPING = APIErrorResponse(
+    status_code=HTTPStatus.FORBIDDEN,
+    fhir_issue_code=FHIRIssueCode.FORBIDDEN,
+    fhir_issue_severity=FHIRIssueSeverity.ERROR,
+    fhir_error_code=FHIRSpineErrorCode.ACCESS_DENIED,
+    fhir_display_message="Access has been denied to process this request.",
+)

src/eligibility_signposting_api/services/eligibility_services.py

@@ -20,6 +20,10 @@ class InvalidQueryParamError(Exception):
     pass
 
 
+class NoPermittedCampaignsError(Exception):
+    pass
+
+
 @service
 class EligibilityService:
     def __init__(
@@ -70,4 +74,4 @@ def __collect_permitted_campaign_configs(
                 campaign for campaign in campaign_configs if campaign.id in permitted_campaign_ids
             ]
             return permitted_campaign_configs
-        return []
+        raise NoPermittedCampaignsError

src/eligibility_signposting_api/views/eligibility.py

@@ -11,12 +11,16 @@
 
 from eligibility_signposting_api.audit.audit_context import AuditContext
 from eligibility_signposting_api.audit.audit_service import AuditService
-from eligibility_signposting_api.common.api_error_response import NHS_NUMBER_NOT_FOUND_ERROR
+from eligibility_signposting_api.common.api_error_response import (
+    CONSUMER_HAS_NO_CAMPAIGN_MAPPING,
+    NHS_NUMBER_NOT_FOUND_ERROR,
+)
 from eligibility_signposting_api.common.request_validator import validate_request_params
 from eligibility_signposting_api.config.constants import CONSUMER_ID, URL_PREFIX
 from eligibility_signposting_api.model.consumer_mapping import ConsumerId
 from eligibility_signposting_api.model.eligibility_status import Condition, EligibilityStatus, NHSNumber, Status
 from eligibility_signposting_api.services import EligibilityService, UnknownPersonError
+from eligibility_signposting_api.services.eligibility_services import NoPermittedCampaignsError
 from eligibility_signposting_api.views.response_model import eligibility_response
 from eligibility_signposting_api.views.response_model.eligibility_response import ProcessedSuggestion
 
@@ -48,9 +52,11 @@ def check_eligibility(
     nhs_number: NHSNumber, eligibility_service: Injected[EligibilityService], audit_service: Injected[AuditService]
 ) -> ResponseReturnValue:
     logger.info("checking nhs_number %r in %r", nhs_number, eligibility_service, extra={"nhs_number": nhs_number})
+
+    query_params = _get_or_default_query_params()
+    consumer_id = _get_consumer_id_from_headers()
+
     try:
-        query_params = _get_or_default_query_params()
-        consumer_id = _get_consumer_id_from_headers()
         eligibility_status = eligibility_service.get_eligibility_status(
             nhs_number,
             query_params["includeActions"],
@@ -60,6 +66,8 @@ def check_eligibility(
         )
     except UnknownPersonError:
         return handle_unknown_person_error(nhs_number)
+    except NoPermittedCampaignsError:
+        return handle_no_permitted_campaigns_for_the_consumer_error(consumer_id)
     else:
         response: eligibility_response.EligibilityResponse = build_eligibility_response(eligibility_status)
         AuditContext.write_to_firehose(audit_service)
@@ -112,6 +120,13 @@ def handle_unknown_person_error(nhs_number: NHSNumber) -> ResponseReturnValue:
     )
 
 
+def handle_no_permitted_campaigns_for_the_consumer_error(consumer_id: ConsumerId) -> ResponseReturnValue:
+    diagnostics = f"Consumer ID '{consumer_id}' was not recognised by the Eligibility Signposting API"
+    return CONSUMER_HAS_NO_CAMPAIGN_MAPPING.log_and_generate_response(
+        log_message=diagnostics, diagnostics=diagnostics, location_param="id"
+    )
+
+
 def build_eligibility_response(eligibility_status: EligibilityStatus) -> eligibility_response.EligibilityResponse:
     """Return an object representing the API response we are going to send, given an evaluation of the person's
     eligibility."""

tests/integration/in_process/test_eligibility_endpoint.py

@@ -324,23 +324,6 @@ def test_actionable_with_and_rule(
             ),
         )
 
-    def test_empty_response_when_no_campaign_mapped_to_consumer(
-        self,
-        client: FlaskClient,
-        persisted_person: NHSNumber,
-        campaign_config: CampaignConfig,  # noqa: ARG002
-        consumer_mapping: ConsumerMapping,  # noqa: ARG002
-    ):
-        # Given
-        consumer_id_not_having_mapping = "23-jo4hn-ce4na"
-        headers = {"nhs-login-nhs-number": str(persisted_person), CONSUMER_ID: consumer_id_not_having_mapping}
-
-        # When
-        response = client.get(f"/patient-check/{persisted_person}?includeActions=Y", headers=headers)
-
-        # Then
-        assert_that(response, is_response().with_status_code(HTTPStatus.NOT_FOUND))
-
 
 class TestVirtualCohortResponse:
     def test_not_eligible_by_rule_when_only_virtual_cohort_is_present(
@@ -840,3 +823,23 @@ def test_not_actionable_and_check_response_when_rule_mapper_is_given(
                 )
             ),
         )
+
+
+class TestEligibilityResponseWhenConsumerHasNoMapping:
+    def test_empty_response_when_no_campaign_mapped_for_the_consumer(
+        self,
+        client: FlaskClient,
+        persisted_person: NHSNumber,
+        campaign_config: CampaignConfig,  # noqa: ARG002
+        consumer_mapping: ConsumerMapping,  # noqa: ARG002
+        secretsmanager_client: BaseClient,  # noqa: ARG002
+    ):
+        # Given
+        consumer_id_not_having_mapping = "23-jo4hn-ce4na"
+        headers = {"nhs-login-nhs-number": str(persisted_person), CONSUMER_ID: consumer_id_not_having_mapping}
+
+        # When
+        response = client.get(f"/patient-check/{persisted_person}?includeActions=Y", headers=headers)
+
+        # Then
+        assert_that(response, is_response().with_status_code(HTTPStatus.FORBIDDEN))