New: [AEA-4985] - add validator tests (#219)

## Summary

- Routine Change

### Details

- add tests for validator in fhir facade

Author: anthony-nhs

features/eps_fhir/validator.feature

@@ -0,0 +1,29 @@
+@eps_fhir @smoke @regression @blocker @validator
+@allure.tms:https://nhsd-jira.digital.nhs.uk/browse/AEA-4895
+Feature: I can call the validator endpoint
+
+  Scenario: I can call the validator endpoint with valid fhir with x-show-validation-warnings set to false
+    Given I am an authorised prescriber
+    When I make a valid request to the eps_fhir validator endpoint with show validation set to false
+    Then the response indicates a success
+    And the validator response has 1 information issue
+
+  Scenario: I can call the validator endpoint with valid fhir with x-show-validation-warnings set to true
+    Given I am an authorised prescriber
+    When I make a valid request to the eps_fhir validator endpoint with show validation set to true
+    Then the response indicates a bad request
+    And the validator response has many information issue
+    And the validator response has 0 error issue
+
+  Scenario: I can call the validator endpoint with valid fhir with x-show-validation-warnings set to false
+    Given I am an authorised prescriber
+    When I make a valid request to the eps_fhir validator endpoint with show validation set to unset
+    Then the response indicates a success
+    And the validator response has 1 information issue
+
+  Scenario: I can call the validator endpoint with invalid fhir
+    Given I am an authorised prescriber
+    When I make a invalid request to the eps_fhir validator endpoint with show validation set to false
+    Then the response indicates a bad request
+    And the validator response has many error issue
+    And the validator response has error with diagnostic containing Failed to parse JSON encoded FHIR content

features/eps_fhir_dispensing/validator.feature

@@ -0,0 +1,29 @@
+@eps_fhir_dispensing @smoke @regression @validator
+@allure.tms:https://nhsd-jira.digital.nhs.uk/browse/AEA-4895
+Feature: I can call the validator endpoint
+
+  Scenario: I can call the validator endpoint with valid fhir with x-show-validation-warnings set to false
+    Given I am an authorised dispenser
+    When I make a valid request to the eps_fhir_dispensing validator endpoint with show validation set to false
+    Then the response indicates a success
+    And the validator response has 1 information issue
+
+  Scenario: I can call the validator endpoint with valid fhir with x-show-validation-warnings set to true
+    Given I am an authorised dispenser
+    When I make a valid request to the eps_fhir_dispensing validator endpoint with show validation set to true
+    Then the response indicates a bad request
+    And the validator response has many information issue
+    And the validator response has 0 error issue
+
+  Scenario: I can call the validator endpoint with valid fhir with x-show-validation-warnings set to unset
+    Given I am an authorised dispenser
+    When I make a valid request to the eps_fhir_dispensing validator endpoint with show validation set to unset
+    Then the response indicates a success
+    And the validator response has 1 information issue
+
+  Scenario: I can call the validator endpoint with invalid fhir
+    Given I am an authorised dispenser
+    When I make a invalid request to the eps_fhir_dispensing validator endpoint with show validation set to false
+    Then the response indicates a bad request
+    And the validator response has many error issue
+    And the validator response has error with diagnostic containing Failed to parse JSON encoded FHIR content

features/eps_fhir_prescribing/validator.feature

@@ -0,0 +1,29 @@
+@eps_fhir_prescribing @smoke @regression @validator
+@allure.tms:https://nhsd-jira.digital.nhs.uk/browse/AEA-4895
+Feature: I can call the validator endpoint
+
+  Scenario: I can call the validator endpoint with valid fhir with x-show-validation-warnings set to false
+    Given I am an authorised prescriber
+    When I make a valid request to the eps_fhir_prescribing validator endpoint with show validation set to false
+    Then the response indicates a success
+    And the validator response has 1 information issue
+
+  Scenario: I can call the validator endpoint with valid fhir with x-show-validation-warnings set to true
+    Given I am an authorised prescriber
+    When I make a valid request to the eps_fhir_prescribing validator endpoint with show validation set to true
+    Then the response indicates a bad request
+    And the validator response has many information issue
+    And the validator response has 0 error issue
+
+  Scenario: I can call the validator endpoint with valid fhir with x-show-validation-warnings set to false
+    Given I am an authorised prescriber
+    When I make a valid request to the eps_fhir_prescribing validator endpoint with show validation set to unset
+    Then the response indicates a success
+    And the validator response has 1 information issue
+
+  Scenario: I can call the validator endpoint with invalid fhir
+    Given I am an authorised prescriber
+    When I make a invalid request to the eps_fhir_prescribing validator endpoint with show validation set to false
+    Then the response indicates a bad request
+    And the validator response has many error issue
+    And the validator response has error with diagnostic containing Failed to parse JSON encoded FHIR content

features/steps/common_steps.py

@@ -34,6 +34,13 @@ def indicate_record_created(context):
     common.the_expected_response_code_is_returned(context, 201)
 
 
+@then("the response indicates a bad request")
+def indicate_bad_request_response(context):
+    if "sandbox" in context.config.userdata["env"].lower():
+        return
+    common.the_expected_response_code_is_returned(context, 400)
+
+
 @then("I can see the version information in the response")
 def i_see_version_in_response(context):
     response = context.response.json()

features/steps/eps_api_steps.py

@@ -12,9 +12,11 @@
     release_signed_prescription,
     return_prescription,
     withdraw_dispense_notification,
+    call_validator,
 )
 from methods.shared.common import assert_that, get_auth
 from utils.random_nhs_number_generator import generate_single
+from messages.eps_fhir.prescription import Prescription
 
 
 @given("I successfully prepare and sign a prescription")
@@ -166,3 +168,43 @@ def i_can_see_an_informational_operation_outcome_in_the_response(context):
     assert_that(json_response["resourceType"]).is_equal_to("OperationOutcome")
     assert_that(json_response["issue"][0]["code"]).is_equal_to("informational")
     assert_that(json_response["issue"][0]["severity"]).is_equal_to("information")
+
+
+@when(
+    "I make a {validity} request to the {product} validator endpoint with show validation set to {show_validation}"
+)
+def i_make_a_request_to_the_validator_endpoint(
+    context, validity, product, show_validation
+):
+    if validity == "valid":
+        context.nhs_number = generate_single()
+        context.nomination_code = "0004"
+        validate_body = Prescription(context).body
+    else:
+        validate_body = "foo"
+    call_validator(context, product, show_validation, validate_body)
+
+
+@then("the validator response has {expected_issue_count} {issue_type} issue")
+def validator_response_has_n_issues_of_type(context, expected_issue_count, issue_type):
+    json_response = json.loads(context.response.content)
+    assert_that(json_response["resourceType"]).is_equal_to("OperationOutcome")
+    actual_issue_count = sum(
+        p["severity"] == issue_type for p in json_response["issue"]
+    )
+    if expected_issue_count == "many":
+        assert_that(actual_issue_count).is_greater_than(0)
+    else:
+        assert_that(int(expected_issue_count)).is_equal_to(actual_issue_count)
+
+
+@then("the validator response has error with diagnostic containing {diagnostic}")
+def validator_response_has_error_issue_with_diagnostic(context, diagnostic):
+    json_response = json.loads(context.response.content)
+    assert_that(json_response["resourceType"]).is_equal_to("OperationOutcome")
+    print(f"expected diagnostic: {diagnostic}")
+    actual_issue_count = sum(
+        p["severity"] == "error" and diagnostic in p["diagnostics"]
+        for p in json_response["issue"]
+    )
+    assert_that(actual_issue_count).is_equal_to(1)

methods/api/eps_api_methods.py

@@ -110,3 +110,24 @@ def return_prescription(context):
 
     context.return_body = Return(context).body
     post(data=context.return_body, url=url, context=context, headers=headers)
+
+
+def call_validator(context, product, show_validation, validate_body):
+    if product == "eps_fhir_dispensing":
+        base_url = context.eps_fhir_dispensing_base_url
+    elif product == "eps_fhir_prescribing":
+        base_url = context.eps_fhir_prescribing_base_url
+    else:
+        base_url = context.eps_fhir_base_url
+    url = f"{base_url}/FHIR/R4/$validate"
+    if show_validation == "false" or show_validation == "true":
+        additional_headers = {
+            "Content-Type": "application/json",
+            "x-show-validation-warnings": show_validation,
+        }
+    else:
+        additional_headers = {"Content-Type": "application/json"}
+    headers = get_headers(context, additional_headers)
+
+    context.validate_body = validate_body
+    post(data=context.validate_body, url=url, context=context, headers=headers)