davinci_crd_test_kit 0.13.0 → 0.14.1

data/lib/davinci_crd_test_kit/client/v2.2.1/verify_request/hook_request_prefetch_profiles_test.rb

@@ -0,0 +1,55 @@
+require_relative '../../../cross_suite/prefetch_profile_validation'
+require_relative '../../tagged_request_load_helper'
+require_relative '../../multi_request_message_helper'
+
+module DaVinciCRDTestKit
+  module V221
+    class HookRequestPrefetchProfilesTest < Inferno::Test
+      include PrefetchProfileValidation
+      include DaVinciCRDTestKit::TaggedRequestLoadHelper
+      include DaVinciCRDTestKit::MultiRequestMessageHelper
+
+      id :crd_v221_hook_request_prefetch_profiles
+      title 'Prefetched resources conform to the required CRD profiles'
+      description %(
+        The [CDS service discovery response `prefetch` field](https://cds-hooks.hl7.org/2026Jan/en/#response)
+        contains key/value pairs describing additional information needed to render a response. Each key is a
+        string that describes the type of data being requested and the corresponding
+        value is a FHIR query (read or search) that will return the desired scope.
+        See the [Prefetch Template](https://cds-hooks.hl7.org/2026Jan/en/#prefetch-template)
+        section for more information about the format of `prefetch` templates.
+
+        [The CRD IG requires client support for prefetch](https://hl7.org/fhir/us/davinci-crd/2.2.1/en/foundation.html#prefetch)
+        including that the provided resources, which are part of the data included in the hook invocation,
+        [conform to the appropriate CRD profile](https://hl7.org/fhir/us/davinci-crd/2.2.1/en/hooks.html#ci-c-hook-21).
+
+        During this test, Inferno will verify that each FHIR resources found under the `prefetch`
+        field of each request body conforms to the appropriate CRD profile.
+      )
+
+      verifies_requirements 'hl7.fhir.us.davinci-crd_2.2.1@hook-21', 'hl7.fhir.us.davinci-crd_2.2.1@prof-3',
+                            'hl7.fhir.us.davinci-crd_2.2.1@prof-4', 'hl7.fhir.us.davinci-crd_2.2.1@prof-5',
+                            'hl7.fhir.us.davinci-crd_2.2.1@prof-6', 'hl7.fhir.us.davinci-crd_2.2.1@prof-7',
+                            'hl7.fhir.us.davinci-crd_2.2.1@prof-8', 'hl7.fhir.us.davinci-crd_2.2.1@prof-9',
+                            'hl7.fhir.us.davinci-crd_2.2.1@prof-10', 'hl7.fhir.us.davinci-crd_2.2.1@prof-11',
+                            'hl7.fhir.us.davinci-crd_2.2.1@prof-12'
+      run do
+        hook_requests = load_hook_requests
+
+        skip_if hook_requests.blank?, "No #{hook_name} hook requests received."
+
+        hook_requests.each_with_index do |request, request_index|
+          hook_request = parse_json_request_entity(request.request_body, 'Request body',
+                                                   request_index)
+          next unless hook_request.present?
+          next unless hook_request.key?('prefetch')
+
+          check_prefetch_profiles(hook_request['prefetch'], request_index)
+        end
+
+        assert_no_error_messages("#{requests_with_errors_prefix}Prefetched data not conformant to CRD profiles. " \
+                                 'See Messages for details.')
+      end
+    end
+  end
+end

data/lib/davinci_crd_test_kit/client/v2.2.1/verify_request/hook_request_requested_version_test.rb

@@ -0,0 +1,54 @@
+require_relative '../../multi_request_message_helper'
+require_relative '../../tagged_request_load_helper'
+
+module DaVinciCRDTestKit
+  module V221
+    class HookRequestRequestedVersionTest < Inferno::Test
+      include DaVinciCRDTestKit::MultiRequestMessageHelper
+      include DaVinciCRDTestKit::TaggedRequestLoadHelper
+
+      id :crd_v221_hook_request_requested_version
+      title 'Hook requests contains the CRD version extension'
+      description %(
+        Inferno's CRD service supports multiple versions of CRD, so [clients are required](https://hl7.org/fhir/us/davinci-crd/2.2.1/en/conformancedetails.html#ci-c-dev-3)
+        to specify the requested version using the `davinci-crd.requestedVersion` extension on each request.
+
+        During this test, Inferno will verify that the body of each hook request contains
+        the `davinci-crd.requestedVersion` extension with the correct value: "2.2".
+      )
+
+      verifies_requirements 'cds-hooks_3.0.0-ballot@214', 'hl7.fhir.us.davinci-crd_2.2.1@dev-3-A',
+                            'hl7.fhir.us.davinci-crd_2.2.1@dev-12'
+
+      run do
+        hook_requests = load_hook_requests
+
+        skip_if hook_requests.blank?, "No #{hook_name} hook requests received."
+
+        hook_requests.each_with_index do |request, request_index|
+          request_body = parse_json_request_entity(request.request_body, 'Request body', request_index)
+          next unless request_body.present?
+
+          requested_version = request_body.dig('extension', 'davinci-crd.requestedVersion')
+          if requested_version.blank?
+            add_request_message('error', "Required extension 'davinci-crd.requestedVersion' is not present.",
+                                request_index)
+          elsif !requested_version.is_a?(String)
+            add_request_message('error',
+                                "For extension 'davinci-crd.requestedVersion' expected a String, " \
+                                "got #{requested_version.class}",
+                                request_index)
+          elsif requested_version != '2.2'
+            add_request_message('error',
+                                "For extension 'davinci-crd.requestedVersion' expected '2.2', " \
+                                "got '#{requested_version}'",
+                                request_index)
+          end
+        end
+
+        assert_no_error_messages("#{requests_with_errors_prefix}Requested version extension not populated properly. " \
+                                 'See Messages for details.')
+      end
+    end
+  end
+end

data/lib/davinci_crd_test_kit/client/v2.2.1/verify_request/hook_request_secured_transport_test.rb

@@ -0,0 +1,48 @@
+require_relative '../../multi_request_message_helper'
+require_relative '../../tagged_request_load_helper'
+
+module DaVinciCRDTestKit
+  module V221
+    class HookRequestSecuredTransportTest < Inferno::Test
+      include DaVinciCRDTestKit::MultiRequestMessageHelper
+      include DaVinciCRDTestKit::TaggedRequestLoadHelper
+
+      id :crd_v221_hook_request_secured_transport
+      title 'Hook request interactions use TLS'
+      description %(
+        During this test, Inferno will verify that
+        requests made by both the client and Inferno's simulated CRD servers are made against
+        TLS-secured endpoints using the `https` protocol.
+      )
+      verifies_requirements 'cds-hooks_3.0.0-ballot@2', 'cds-hooks_3.0.0-ballot@168', 'cds-hooks_3.0.0-ballot@172',
+                            'hl7.fhir.us.davinci-crd_2.2.1@sec-2'
+
+      run do
+        hook_requests = load_hook_requests
+
+        skip_if hook_requests.blank?, "No #{hook_name} hook requests received."
+
+        hook_requests.each_with_index do |request, request_index|
+          unless request.url.starts_with?('https')
+            add_request_message('error',
+                                "Inferno's simulated CRD server must use the https " \
+                                'protocol (TLS). Run this suite on a host that uses TLS.',
+                                request_index)
+          end
+
+          # check that the fhirServer endpoint uses https
+          request_body = parse_json_request_entity(request.request_body, 'Request body', request_index)
+          next unless request_body.present?
+          next unless request_body['fhirServer'].present? && !request_body['fhirServer'].starts_with?('https')
+
+          add_request_message('error',
+                              'The `fhirServer` provided in the request must use the https protocol (TLS).',
+                              request_index)
+        end
+
+        assert_no_error_messages("#{requests_with_errors_prefix}Interactions not secured using TLS. " \
+                                 'See Messages for details.')
+      end
+    end
+  end
+end

data/lib/davinci_crd_test_kit/client/v2.2.1/verify_response/client_display_cards_attest.rb

@@ -0,0 +1,75 @@
+require_relative '../client_urls'
+require_relative '../../../cross_suite/cards_identification'
+require_relative '../../tagged_request_load_helper'
+
+module DaVinciCRDTestKit
+  module V221
+    class ClientCardDisplayAttest < Inferno::Test
+      include ClientURLs
+      include CardsIdentification
+      include DaVinciCRDTestKit::TaggedRequestLoadHelper
+
+      id :crd_v221_card_display_attest_test
+      title 'Client displays returned decision support details to the user'
+      description %(
+        During this test, the tester will confirm that the received cards and actions in the
+        hook responses have been displayed or otherwise made available to users of the client system
+        in an appopriate way that allows for consideration and action if warranted.
+      )
+      attestation
+
+      def responded_card_types
+        list_card_types_in_requests(requests)
+      end
+
+      def format_responded_response_types
+        responded_card_types
+          .map do |response_type|
+          response_type_string =
+            response_type.split('_')
+              .map(&:capitalize)
+              .join(' ')
+              .prepend('- ')
+              .sub('Smart', 'SMART')
+              .sub('Create Update', 'Create/Update')
+              .sub('Companions Prerequisites', 'Companions/Prerequisites')
+              .sub('Card', '(card)')
+              .sub('Action', '(systemAction)')
+          response_type_string
+        end
+          .join("\n")
+      end
+
+      output :attest_true_url
+      output :attest_false_url
+
+      run do
+        load_hook_requests
+        skip_if responded_card_types.blank?, 'No responses sent to the client.'
+
+        identifier = SecureRandom.hex(32)
+        attest_true_url = "#{resume_pass_url}?token=#{identifier}"
+        attest_false_url = "#{resume_fail_url}?token=#{identifier}"
+        output(attest_true_url:)
+        output(attest_false_url:)
+        wait(
+          identifier:,
+          message: <<~MESSAGE
+            **Card Display Attestation**:
+
+            I attest that the following CRD response types returned by Inferno's simulated
+            CRD servers were processed by the client system and displayed or otherwise made
+            available to users of the client system in an appropriate way that allows for
+            consideration and action if warranted:
+
+            #{format_responded_response_types}
+
+            [Click here](#{attest_true_url}) if the above statement is **true**.
+
+            [Click here](#{attest_false_url}) if the above statement is **false**.
+          MESSAGE
+        )
+      end
+    end
+  end
+end

data/lib/davinci_crd_test_kit/client/v2.2.1/verify_response/hook_response_support_coverage_information_test.rb

@@ -0,0 +1,30 @@
+require_relative '../../../cross_suite/cards_identification'
+require_relative '../../tagged_request_load_helper'
+
+module DaVinciCRDTestKit
+  module V221
+    class ClientHookResponseSupportCoverageInformationTest < Inferno::Test
+      include CardsIdentification
+      include TaggedRequestLoadHelper
+
+      title 'Client supports the Coverage Information response type on this hook'
+      id :crd_v221_client_hook_response_support_coverage_information
+      description <<~DESCRIPTION
+        During this test, Inferno will verify that the client demonstrated support for the [Coverage Information](https://hl7.org/fhir/us/davinci-crd/2.2.1/en/cards.html#coverage-information)
+        response type. At least one hook invocation performed during this group must have returned a Coverage Information action.
+
+        If this test fails, adjust the [cards returned by Inferno's simulated CRD server](https://github.com/inferno-framework/davinci-crd-test-kit/wiki/Controlling-Simulated-Responses)
+        and/or the hook requests made by the client during this group such that a Coverage Information action is returned.
+      DESCRIPTION
+
+      run do
+        hook_requests = load_hook_requests
+        skip_if hook_requests.blank?, "No #{hook_name} hook requests received."
+
+        sorted_cards = sorted_cards_from_requests(hook_requests)
+        assert sorted_cards['actions'][COVERAGE_INFORMATION_RESPONSE_TYPE].present?,
+               "Support for the Coverage Information response type not demonstrated for the #{hook_name} hook."
+      end
+    end
+  end
+end

data/lib/davinci_crd_test_kit/client/v2.2.1/verify_response/inferno_response_validation.rb

@@ -0,0 +1,77 @@
+require_relative '../../../cross_suite/cards_validation'
+require_relative '../../../cross_suite/response_logical_model_validation'
+require_relative '../../tagged_request_load_helper'
+
+module DaVinciCRDTestKit
+  module V221
+    class InfernoResponseValidationTest < Inferno::Test
+      include CardsValidation
+      include ResponseLogicalModelValidation
+      include DaVinciCRDTestKit::TaggedRequestLoadHelper
+
+      title 'Hook responses have the correct structure and content'
+      description %(
+        During this test, Inferno will verify that each hook response built by Inferno's simulated CRD servers
+        and returned to the client conforms to CDS Hooks and CRD requirements. These responses must be conformant
+        for the client to demonstrate its ability to accept and process valid CRD responses.
+
+        If this test fails when the tester provided a custom response template, adjust the
+        provided template and the submitted requests so that the response built by Inferno
+        is conformant. If this test fails when Inferno mocked the response based on selected
+        card types, first ensure that the client's request is conformant. If the request is conformant
+        but Inferno's response(s) are still not conformant, please report this failure to the
+        Inferno team via [GitHub Issues](https://github.com/inferno-framework/davinci-crd-test-kit/issues).
+        For more details on how Inferno builds responses, see the
+        [Controlling Simulated Responses](https://github.com/inferno-framework/davinci-crd-test-kit/wiki/Controlling-Simulated-Responses)
+        section of the [CRD Test Kit Wiki](https://github.com/inferno-framework/davinci-crd-test-kit/wiki).
+      )
+      id :crd_v221_inferno_response_validation
+      simulation_verification
+
+      verifies_requirements 'cds-hooks_3.0.0-ballot@3', 'cds-hooks_3.0.0-ballot@222', 'cds-hooks_3.0.0-ballot@223',
+                            'cds-hooks_3.0.0-ballot@224'
+
+      input :custom_response_template, optional: true
+
+      def response_label(index = nil)
+        response_type = (custom_response_template.present? ? 'Custom built' : 'Mocked')
+        "#{response_type} response#{" #{index}" if index.present?}"
+      end
+
+      def validate_card_summaries(cards)
+        return unless cards.is_a?(Array)
+
+        cards.each { |card| card_summary_check(card) if card.is_a?(Hash) }
+      end
+
+      run do
+        load_hook_requests
+
+        skip_if request.blank?, "No #{response_label.downcase}s to verify."
+
+        entity_validated = false
+        requests.each_with_index do |request, index|
+          response_hash = JSON.parse(request.response_body)
+          request_hash = JSON.parse(request.request_body)
+
+          next unless response_hash['cards'].present? || response_hash['systemActions'].present?
+
+          entity_validated = true
+          validate_card_summaries(response_hash['cards'])
+          perform_response_logical_model_validation(response_hash['cards'],
+                                                    response_hash['systemActions'],
+                                                    request_hash,
+                                                    index,
+                                                    '2.2.1')
+        rescue JSON::ParserError
+          next
+        end
+
+        skip_if !entity_validated,
+                "No #{response_label.downcase} cards or system actions to verify returned by Inferno."
+
+        no_error_validation("Invalid Inferno #{response_label.downcase}(s). See Messages for details.")
+      end
+    end
+  end
+end

data/lib/davinci_crd_test_kit/cross_suite/base_urls.rb

@@ -0,0 +1,20 @@
+module DaVinciCRDTestKit
+  RESUME_PASS_PATH = '/resume_pass'.freeze
+  RESUME_FAIL_PATH = '/resume_fail'.freeze
+
+  # base url, plus other shared ones such as resume urls
+  # suite_id must be defined
+  module BaseURLs
+    def inferno_base_url
+      @inferno_base_url ||= "#{Inferno::Application['base_url']}/custom/#{suite_id}"
+    end
+
+    def resume_pass_url
+      @resume_pass_url ||= inferno_base_url + RESUME_PASS_PATH
+    end
+
+    def resume_fail_url
+      @resume_fail_url ||= inferno_base_url + RESUME_FAIL_PATH
+    end
+  end
+end