Update: [AEA-4443] - Better validator tests (#223)

## Summary

- Routine Change

### Details

- use full examples for validator tests
- add back in poetry.lock so we get consistent dependencies

Author: anthony-nhs

.gitignore

@@ -251,6 +251,3 @@ node_modules
 # VSCODE specific
 .vscode
 vscode
-
-# poetry.lock
-poetry.lock

features/eps_fhir/validator.feature

@@ -1,5 +1,6 @@
 @eps_fhir @smoke @regression @blocker @validator
 @allure.tms:https://nhsd-jira.digital.nhs.uk/browse/AEA-4895
+@allure.tms:https://jsondiff.tooliverse.io/
 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
@@ -15,7 +16,7 @@ Feature: I can call the validator endpoint
     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
+  Scenario: I can call the validator endpoint with valid fhir with x-show-validation-warnings set to unset
     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
@@ -27,3 +28,33 @@ Feature: I can call the validator endpoint
     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
+
+  Scenario: I can call the validator endpoint with missing dosage instructions message
+    Given I am an authorised prescriber
+    When I make a request with file missing_dosage_instructions/request.json to the eps_fhir validator endpoint
+    Then the response indicates a bad request
+    And the validator response matches missing_dosage_instructions/response.json
+
+  Scenario: I can call the validator endpoint with missing dispense request quantity message
+    Given I am an authorised prescriber
+    When I make a request with file missing_dispense_request_quantity/request.json to the eps_fhir validator endpoint
+    Then the response indicates a bad request
+    And the validator response matches missing_dispense_request_quantity/response.json
+
+  Scenario: I can call the validator endpoint with missing medication message
+    Given I am an authorised prescriber
+    When I make a request with file missing_medication/request.json to the eps_fhir validator endpoint
+    Then the response indicates a bad request
+    And the validator response matches missing_medication/response.json
+
+  Scenario: I can call the validator endpoint with too many medication requests message
+    Given I am an authorised prescriber
+    When I make a request with file too_many_medication_requests/request.json to the eps_fhir validator endpoint
+    Then the response indicates a bad request
+    And the validator response matches too_many_medication_requests/response.json
+
+  Scenario: I can call the validator endpoint with unknown endorsement message
+    Given I am an authorised prescriber
+    When I make a request with file unknown_endorsement/request.json to the eps_fhir validator endpoint
+    Then the response indicates a bad request
+    And the validator response matches unknown_endorsement/response.json

features/eps_fhir_dispensing/validator.feature

@@ -1,5 +1,6 @@
 @eps_fhir_dispensing @smoke @regression @validator
 @allure.tms:https://nhsd-jira.digital.nhs.uk/browse/AEA-4895
+@allure.tms:https://jsondiff.tooliverse.io/
 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
@@ -27,3 +28,33 @@ Feature: I can call the validator endpoint
     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
+
+  Scenario: I can call the validator endpoint with missing dosage instructions message
+    Given I am an authorised prescriber
+    When I make a request with file missing_dosage_instructions/request.json to the eps_fhir_dispensing validator endpoint
+    Then the response indicates a bad request
+    And the validator response matches missing_dosage_instructions/response.json
+
+  Scenario: I can call the validator endpoint with missing dispense request quantity message
+    Given I am an authorised prescriber
+    When I make a request with file missing_dispense_request_quantity/request.json to the eps_fhir_dispensing validator endpoint
+    Then the response indicates a bad request
+    And the validator response matches missing_dispense_request_quantity/response.json
+
+  Scenario: I can call the validator endpoint with missing medication message
+    Given I am an authorised prescriber
+    When I make a request with file missing_medication/request.json to the eps_fhir_dispensing validator endpoint
+    Then the response indicates a bad request
+    And the validator response matches missing_medication/response.json
+
+  Scenario: I can call the validator endpoint with too many medication requests message
+    Given I am an authorised prescriber
+    When I make a request with file too_many_medication_requests/request.json to the eps_fhir_dispensing validator endpoint
+    Then the response indicates a bad request
+    And the validator response matches too_many_medication_requests/response.json
+
+  Scenario: I can call the validator endpoint with unknown endorsement message
+    Given I am an authorised prescriber
+    When I make a request with file unknown_endorsement/request.json to the eps_fhir_dispensing validator endpoint
+    Then the response indicates a bad request
+    And the validator response matches unknown_endorsement/response.json

features/eps_fhir_prescribing/validator.feature

@@ -1,5 +1,6 @@
 @eps_fhir_prescribing @smoke @regression @validator
 @allure.tms:https://nhsd-jira.digital.nhs.uk/browse/AEA-4895
+@allure.tms:https://jsondiff.tooliverse.io/
 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
@@ -27,3 +28,33 @@ Feature: I can call the validator endpoint
     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
+
+  Scenario: I can call the validator endpoint with missing dosage instructions message
+    Given I am an authorised prescriber
+    When I make a request with file missing_dosage_instructions/request.json to the eps_fhir_prescribing validator endpoint
+    Then the response indicates a bad request
+    And the validator response matches missing_dosage_instructions/response.json
+
+  Scenario: I can call the validator endpoint with missing dispense request quantity message
+    Given I am an authorised prescriber
+    When I make a request with file missing_dispense_request_quantity/request.json to the eps_fhir_prescribing validator endpoint
+    Then the response indicates a bad request
+    And the validator response matches missing_dispense_request_quantity/response.json
+
+  Scenario: I can call the validator endpoint with missing medication message
+    Given I am an authorised prescriber
+    When I make a request with file missing_medication/request.json to the eps_fhir_prescribing validator endpoint
+    Then the response indicates a bad request
+    And the validator response matches missing_medication/response.json
+
+  Scenario: I can call the validator endpoint with too many medication requests message
+    Given I am an authorised prescriber
+    When I make a request with file too_many_medication_requests/request.json to the eps_fhir_prescribing validator endpoint
+    Then the response indicates a bad request
+    And the validator response matches too_many_medication_requests/response.json
+
+  Scenario: I can call the validator endpoint with unknown endorsement message
+    Given I am an authorised prescriber
+    When I make a request with file unknown_endorsement/request.json to the eps_fhir_prescribing validator endpoint
+    Then the response indicates a bad request
+    And the validator response matches unknown_endorsement/response.json

features/steps/eps_api_steps.py

@@ -17,6 +17,7 @@
 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
+from jycm.jycm import YouchamaJsonDiffer
 
 
 @given("I successfully prepare and sign a prescription")
@@ -185,6 +186,13 @@ def i_make_a_request_to_the_validator_endpoint(
     call_validator(context, product, show_validation, validate_body)
 
 
+@when("I make a request with file {filename} to the {product} validator endpoint")
+def i_make_a_request_to_the_validator_endpoint_with_file(context, filename, product):
+    with open(f"messages/examples/{filename}") as f:
+        validate_body = json.load(f)
+    call_validator(context, product, "unset", json.dumps(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)
@@ -208,3 +216,16 @@ def validator_response_has_error_issue_with_diagnostic(context, diagnostic):
         for p in json_response["issue"]
     )
     assert_that(actual_issue_count).is_equal_to(1)
+
+
+@then("the validator response matches {filename}")
+def validator_response_matches_file(context, filename):
+    with open(f"messages/examples/{filename}") as f:
+        expected_response = json.load(f)
+    json_response = json.loads(context.response.content)
+    # create the YouChaMa (ycm) json diff class with expected and actual response
+    ycm = YouchamaJsonDiffer(expected_response, json_response)
+    # get the differences
+    diff_result = ycm.get_diff()
+    # and there should be none
+    assert_that(diff_result).is_equal_to({"just4vis:pairs": []})