davinci_crd_test_kit 0.14.1 → 0.14.2

data/lib/davinci_crd_test_kit/client/v2.2.1/crd_client_suite.rb

@@ -2,7 +2,8 @@ require_relative 'client_fhir_api_group'
 require_relative 'client_hooks_group'
 require_relative 'client_cross_hook_group'
 require_relative 'client_registration_group'
-require_relative 'client_long_running_hook_group'
+require_relative 'client_scenarios_group'
+require_relative 'client_attestations_group'
 require_relative '../endpoints/cds_services_discovery_handler'
 require_relative '../../cross_suite/tags'
 require_relative 'client_urls'
@@ -114,7 +115,6 @@ module DaVinciCRDTestKit
       CRD_MESSAGE_FILTERS = [
         /\A\S+: \S+: URL value '.*' does not resolve/,
         %r{This element is not allowed by the profile http://hl7\.org/fhir/tools/StructureDefinition/CDSHooksExtensions\|1\.1\.2},
-        /CDSHooksRequest.extension: Unrecognized property/,
         /No definition could be found for URL value/
       ].freeze
 
@@ -167,6 +167,21 @@ module DaVinciCRDTestKit
         end
       end
 
+      fhir_resource_validator :no_custom_extensions do
+        igs('hl7.fhir.us.davinci-crd#2.2.1')
+
+        validation_context do
+          snomedCT '731000124108' # explicit snomedCT expansion parameter
+          extensions [] # no extensions not in the spec
+        end
+
+        exclude_message do |message|
+          CRD_MESSAGE_FILTERS.any? do |match_template|
+            message.message.match?(match_template)
+          end
+        end
+      end
+
       suite_option :us_core_version,
                    title: 'US Core Version',
                    list_options: [
@@ -224,11 +239,12 @@ module DaVinciCRDTestKit
 
         group from: :crd_v221_client_registration
         group from: :crd_v221_client_hooks
+        group from: :crd_v221_client_scenarios
         group from: :crd_v221_client_cross_hook
-        group from: :crd_v221_client_long_running_hook
       end
 
       group from: :crd_v221_client_fhir_api
+      group from: :crd_v221_client_attestations
     end
   end
 end

data/lib/davinci_crd_test_kit/client/v2.2.1/cross_hook/client_card_must_support_coverage_information_test.rb

@@ -46,7 +46,7 @@ module DaVinciCRDTestKit
       end
 
       run do
-        loaded_requests = requests_to_analyze
+        loaded_requests = load_requests_for_cross_hook_analysis
         skip_if loaded_requests.blank?, 'No hook requests received.'
 
         sorted_cards = sorted_cards_from_requests(loaded_requests)

data/lib/davinci_crd_test_kit/client/v2.2.1/cross_hook/client_fhirpath_collection_as_comma_delimited_string_test.rb

@@ -1,6 +1,10 @@
+require_relative '../../cross_hook_helper'
+
 module DaVinciCRDTestKit
   module V221
     class ClientFHIRPathCollectionAsCommaDelimitedStringTest < Inferno::Test
+      include CrossHookHelper
+
       title 'Client correctly interprets collections when substituting FHIRPath results in prefetch templates'
       id :crd_v221_client_fhir_path_collection_as_comma_delimited_string
       description <<~DESCRIPTION
@@ -32,17 +36,6 @@ module DaVinciCRDTestKit
              'Perform more complex hook requests and re-run.'
       end
 
-      def find_completeness_tests
-        hooks_group = self.class.parent.parent.groups.find do |group|
-          group.id.to_s.include?('crd_v221_client_hooks')
-        end
-        hooks_group.groups.map do |group|
-          group.groups.flat_map(&:tests).find do |test|
-            test.id.to_s.include?('crd_v221_hook_request_prefetch_complete')
-          end
-        end.compact
-      end
-
       def completeness_tests_demonstrate_collection_token_substitution?(prefetch_completeness_tests)
         results_repo = Inferno::Repositories::Results.new
         results = results_repo.current_results_for_test_session_and_runnables(test_session_id,

data/lib/davinci_crd_test_kit/client/v2.2.1/cross_hook/client_hook_instances_unique_test.rb

@@ -1,11 +1,9 @@
-require_relative '../../tagged_request_load_helper'
 require_relative '../../multi_request_message_helper'
 require_relative '../../../cross_suite/tags'
 
 module DaVinciCRDTestKit
   module V221
     class ClientHookInstancesUniqueTest < Inferno::Test
-      include TaggedRequestLoadHelper
       include MultiRequestMessageHelper
 
       title 'Client does not reuse hookInstance values'
@@ -21,14 +19,8 @@ module DaVinciCRDTestKit
 
       verifies_requirements 'cds-hooks_3.0.0-ballot@25'
 
-      config(
-        options: {
-          crd_test_group: DUPLICATED_HOOK_INSTANCE_TAG
-        }
-      )
-
       run do
-        duplicated_hook_instance_requests = load_hook_requests
+        duplicated_hook_instance_requests = load_tagged_requests(DUPLICATED_HOOK_INSTANCE_TAG)
         reused_values = duplicated_hook_instance_requests.map.with_index do |request, request_index|
           request_body = parse_json_request_entity(request.request_body, 'Request body', request_index)
           next nil unless request_body.present?

data/lib/davinci_crd_test_kit/client/v2.2.1/cross_hook/client_location_address_propagation_test.rb

@@ -70,7 +70,11 @@ module DaVinciCRDTestKit
 
         message_prefix = "Parent of prefetched 'Location/#{root_id}'"
         add_message('error', "Location/#{location.id}: #{message_prefix} does not conform to the CRD Location profile.")
-        validator_response_details.each { |issue| add_message(issue.severity, "(#{message_prefix}) #{issue.message}") }
+        validator_response_details.each do |issue|
+          next if issue.filtered
+
+          add_message(issue.severity, "(#{message_prefix}) #{issue.message}")
+        end
       end
 
       def fetched_locations_checked_for_conformance
@@ -78,7 +82,7 @@ module DaVinciCRDTestKit
       end
 
       def loaded_requests
-        @loaded_requests ||= requests_to_analyze
+        @loaded_requests ||= load_requests_for_cross_hook_analysis
       end
 
       def prefetched_location_hash

data/lib/davinci_crd_test_kit/client/v2.2.1/cross_hook/client_prefetch_complete_and_subset_test.rb

@@ -1,10 +1,12 @@
 require_relative '../../tagged_request_load_helper'
+require_relative '../../cross_hook_helper'
 require_relative '../client_urls'
 
 module DaVinciCRDTestKit
   module V221
     class ClientPrefetchCompleteAndSubsetTest < Inferno::Test
       include TaggedRequestLoadHelper
+      include CrossHookHelper
 
       title 'Client can provide both the complete standard prefetch data set and a subset'
       id :crd_v221_client_prefetch_complete_and_subset
@@ -50,7 +52,7 @@ module DaVinciCRDTestKit
 
       run do
         subset_prefetch_requests, complete_prefetch_requests =
-          requests_to_analyze.partition { |request| request.url.include?(PREFETCH_SUBSET_PREFIX) }
+          load_requests_for_cross_hook_analysis.partition { |request| request.url.include?(PREFETCH_SUBSET_PREFIX) }
         completeness_tests = find_completeness_tests
         check_for_demonstration(subset_prefetch_requests, completeness_tests, :subset)
         check_for_demonstration(complete_prefetch_requests, completeness_tests, :complete)
@@ -59,17 +61,6 @@ module DaVinciCRDTestKit
                 'The client did not demonstrate both complete and subset prefetch capability. See Messages for details.'
       end
 
-      def find_completeness_tests
-        hooks_group = self.class.parent.parent.groups.find do |group|
-          group.id.to_s.include?('crd_v221_client_hooks')
-        end
-        hooks_group.groups.map do |group|
-          group.groups.flat_map(&:tests).find do |test|
-            test.id.to_s.include?('crd_v221_hook_request_prefetch_complete')
-          end
-        end.compact
-      end
-
       def check_for_demonstration(requests, completeness_tests, target_name)
         unless requests.present?
           add_message('error', "No requests made to the service endpoint requesting #{target_name} prefetch data.")

data/lib/davinci_crd_test_kit/client/v2.2.1/invocation/appointment_book_receive_request_test.rb

@@ -1,10 +1,8 @@
-require_relative '../client_urls'
+require_relative 'base_hook_invocation_receive_request_test'
 
 module DaVinciCRDTestKit
   module V221
-    class AppointmentBookReceiveRequestTest < Inferno::Test
-      include ClientURLs
-
+    class AppointmentBookReceiveRequestTest < BaseHookInvocationReceiveRequestTest
       id :crd_v221_appointment_book_request
       title 'Client invokes the appointment-book hook'
       description %(
@@ -19,16 +17,7 @@ module DaVinciCRDTestKit
         by the tester by clicking on the link in the "User Action Required" dialog (NOTE: after
         5 minutes the test will become inactive and unresponsive to anything except cancelation).
       )
-      config options: { accepts_multiple_requests: true }
 
-      input :cds_jwt_iss,
-            title: 'CRD JWT Issuer',
-            description: %(
-              Value of the `iss` claim that must be present in the JWT used to authorize the client's hook
-              request sent as the Bearer token in the `Authorization` header.
-              Run or re-run the "Registration" group to set or change this value.
-            ),
-            locked: true
       input :appointment_book_response_approach,
             title: 'Response generation approach for appointment-book',
             description: %(
@@ -60,34 +49,7 @@ module DaVinciCRDTestKit
             type: 'checkbox',
             default: ['coverage_information', 'external_reference', 'instructions'],
             optional: true,
-            options: {
-              list_options: [
-                {
-                  label: 'External Reference',
-                  value: 'external_reference'
-                },
-                {
-                  label: 'Instructions',
-                  value: 'instructions'
-                },
-                {
-                  label: 'Coverage Information',
-                  value: 'coverage_information'
-                },
-                {
-                  label: 'Request Form Completion',
-                  value: 'request_form_completion'
-                },
-                {
-                  label: 'Create/Update Coverage Information',
-                  value: 'create_update_coverage_info'
-                },
-                {
-                  label: 'Launch SMART Application',
-                  value: 'launch_smart_app'
-                }
-              ]
-            },
+            options: { list_options: RESPONSE_TYPE_OPTIONS },
             enable_when: { input_name: 'appointment_book_response_approach', value: 'mocked' }
       input :appointment_book_custom_response_template,
             title: 'Custom response template for appointment-book hook requests',
@@ -98,58 +60,15 @@ module DaVinciCRDTestKit
             type: 'textarea',
             optional: true,
             enable_when: { input_name: 'appointment_book_response_approach', value: 'custom' }
-      output :continuation_url
-
-      def configured_response_details
-        if appointment_book_response_approach == 'custom'
-          # rubocop:disable Layout/LineLength
-          'When responding, Inferno will evaluate the provided [custom response template](https://github.com/inferno-framework/davinci-crd-test-kit/wiki/Controlling-Simulated-Responses#tester-directed-custom-responses) ' \
-            'from the **Custom response template for appointment-book hook requests** input ' \
-            'against the incoming request to create a response.'
-          # rubocop:enable Layout/LineLength
 
-        else
-          # rubocop:disable Layout/LineLength
-          'When responding, Inferno will [mock](https://github.com/inferno-framework/davinci-crd-test-kit/wiki/Controlling-Simulated-Responses#mocked-responses) ' \
-            'the following response types using the incoming request: ' \
-            "\n            - #{selected_response_types_string}"
-          # rubocop:enable Layout/LineLength
-        end
-      end
+      private
 
-      def selected_response_types_string
-        if appointment_book_selected_response_types.present?
-          appointment_book_selected_response_types.join("\n            - ")
-        else
-          'Coverage Information' # primary hook default
-        end
+      def hook_key
+        'appointment_book'
       end
 
-      run do
-        identifier = cds_jwt_iss
-        continuation_url = "#{resume_pass_url}?token=#{identifier}"
-        output(continuation_url:)
-
-        wait(
-          identifier:,
-          message: %(
-            **Invoke the `appointment-book` hook**:
-
-            Invoke the appointment-book hook by sending requests to
-            one or both of the two Inferno simulated CRD servers:
-
-            - Complete Prefetch: `#{appointment_book_url}`
-            - Subset Prefetch: `#{appointment_book_prefetch_subset_url}`
-
-            For Inferno to recognize these requests and associate them with this session,
-            the authentication JWT sent as a Bearer token in the Authorization header
-            must have `#{cds_jwt_iss}` as the `iss` claim in the JWT payload.
-
-            #{configured_response_details}
-
-            [Click here](#{continuation_url}) when you have finished submitting requests.
-          )
-        )
+      def primary_hook?
+        true
       end
     end
   end

data/lib/davinci_crd_test_kit/client/v2.2.1/invocation/base_hook_invocation_receive_request_test.rb

@@ -0,0 +1,163 @@
+require_relative '../client_urls'
+require_relative '../../../cross_suite/cards_identification'
+
+module DaVinciCRDTestKit
+  module V221
+    class BaseHookInvocationReceiveRequestTest < Inferno::Test
+      include ClientURLs
+
+      RESPONSE_TYPE_OPTIONS = [
+        {
+          label: 'External Reference (card)',
+          value: 'external_reference'
+        },
+        {
+          label: 'Instructions (card)',
+          value: 'instructions'
+        },
+        {
+          label: 'Coverage Information (systemAction)',
+          value: 'coverage_information'
+        },
+        {
+          label: 'Request Form Completion (card)',
+          value: 'request_form_completion'
+        },
+        {
+          label: 'Create/Update Coverage Information (card)',
+          value: 'create_update_coverage_info'
+        },
+        {
+          label: 'Launch SMART Application (card)',
+          value: 'launch_smart_app'
+        }
+      ].freeze
+
+      ORDER_RESPONSE_TYPE_OPTIONS = (RESPONSE_TYPE_OPTIONS + [
+        {
+          label: 'Propose Alternate Request (card)',
+          value: 'propose_alternate_request'
+        },
+        {
+          label: 'Additional Orders as Companions/Prerequisites (card)',
+          value: 'companions_prerequisites'
+        }
+      ]).freeze
+
+      config options: { accepts_multiple_requests: true }
+
+      input :cds_jwt_iss,
+            title: 'CRD JWT Issuer',
+            description: %(
+              Value of the `iss` claim that must be present in the JWT used to authorize the client's hook
+              request sent as the Bearer token in the `Authorization` header.
+              Run or re-run the "Registration" group to set or change this value.
+            ),
+            locked: true
+      output :continuation_url
+
+      def hook_key
+        raise NotImplementedError, "#{self.class} must implement #hook_key"
+      end
+
+      def primary_hook?
+        raise NotImplementedError, "#{self.class} must implement #primary_hook?"
+      end
+
+      def hook_slug
+        hook_key.to_s.tr('_', '-')
+      end
+
+      def response_approach
+        send(:"#{hook_key}_response_approach")
+      end
+
+      def selected_response_types
+        send(:"#{hook_key}_selected_response_types")
+      end
+
+      def configured_response_details
+        if response_approach == 'custom'
+          # rubocop:disable Layout/LineLength
+          'When responding, Inferno will evaluate the provided [custom response template](https://github.com/inferno-framework/davinci-crd-test-kit/wiki/Controlling-Simulated-Responses#tester-directed-custom-responses) ' \
+            "from the **Custom response template for #{hook_slug} hook requests** input " \
+            'against the incoming request to create a response.'
+        else
+          'When responding, Inferno will [mock](https://github.com/inferno-framework/davinci-crd-test-kit/wiki/Controlling-Simulated-Responses#mocked-responses) ' \
+            'the following response types using the incoming request: ' \
+            "\n            - #{selected_response_types_string}"
+          # rubocop:enable Layout/LineLength
+        end
+      end
+
+      def selected_response_types_string
+        response_types =
+          if selected_response_types.present?
+            selected_response_types
+          else
+            # matches the hook's default response type
+            primary_hook? ? [DaVinciCRDTestKit::CardsIdentification::COVERAGE_INFORMATION_RESPONSE_TYPE] : [DaVinciCRDTestKit::CardsIdentification::INSTRUCTIONS_RESPONSE_TYPE]
+          end.map do |response_type|
+            if response_type == DaVinciCRDTestKit::CardsIdentification::COVERAGE_INFORMATION_RESPONSE_TYPE
+              "#{response_type}_action"
+            else
+              "#{response_type}_card"
+            end
+          end
+
+        format_responded_response_types(response_types)
+      end
+
+      def format_responded_response_types(response_types)
+        response_types
+          .map do |response_type|
+            DaVinciCRDTestKit::CardsIdentification.humanize_response_type(response_type)
+              .sub('Card', '(card)')
+              .sub('Action', '(systemAction)')
+          end.join("\n            - ")
+      end
+
+      def invoke_heading
+        "Invoke the `#{hook_slug}` hook"
+      end
+
+      def invoke_intro
+        "Invoke #{hook_slug} hook by sending requests to one or both of the two Inferno simulated CRD servers:"
+      end
+
+      def complete_prefetch_url
+        send(:"#{hook_key}_url")
+      end
+
+      def subset_prefetch_url
+        send(:"#{hook_key}_prefetch_subset_url")
+      end
+
+      run do
+        identifier = cds_jwt_iss
+        continuation_url = "#{resume_pass_url}?token=#{identifier}"
+        output(continuation_url:)
+
+        wait(
+          identifier:,
+          message: %(
+            **#{invoke_heading}**:
+
+            #{invoke_intro}
+
+            - Complete Prefetch: `#{complete_prefetch_url}`
+            - Subset Prefetch: `#{subset_prefetch_url}`
+
+            For Inferno to recognize these requests and associate them with this session,
+            the authentication JWT sent as a Bearer token in the Authorization header
+            must have `#{cds_jwt_iss}` as the `iss` claim in the JWT payload.
+
+            #{configured_response_details}
+
+            [Click here](#{continuation_url}) when you have finished submitting requests.
+          )
+        )
+      end
+    end
+  end
+end

data/lib/davinci_crd_test_kit/client/v2.2.1/invocation/cross_hooks_receive_request_test.rb

@@ -0,0 +1,97 @@
+require_relative 'base_hook_invocation_receive_request_test'
+
+module DaVinciCRDTestKit
+  module V221
+    class CrossHooksReceiveRequestTest < BaseHookInvocationReceiveRequestTest
+      id :crd_v221_cross_hooks_request
+      title 'Client invokes any hook'
+      description %(
+        During this test, Inferno will wait while the client makes one or more [hook](https://hl7.org/fhir/us/davinci-crd/2.2.1/en/hooks.html)
+        requests against Inferno's simulated CRD servers. Inferno will respond
+        based on the response configuration provided when running the test.
+        For more details on how Inferno's simulated CRD servers behave during
+        hook invocation see the [simulated CRD server](https://github.com/inferno-framework/davinci-crd-test-kit/wiki/Client-Details#crd-server-simulation)
+        documentation.
+
+        Inferno will pause and wait for inbound requests until told explicitly to continue
+        by the tester by clicking on the link in the "User Action Required" dialog (NOTE: after
+        5 minutes the test will become inactive and unresponsive to anything except cancelation).
+      )
+
+      input :cross_hooks_response_approach,
+            title: 'Response generation approach for all hooks',
+            description: %(
+              Determines how Inferno will generate response for all
+              hook invocations.
+            ),
+            type: 'radio',
+            default: 'mocked',
+            options: {
+              list_options: [
+                {
+                  label: 'Create simple mocks based on selected response types',
+                  value: 'mocked'
+                },
+                {
+                  label: 'Generate responses based on a tester-provided template',
+                  value: 'custom'
+                }
+              ]
+            }
+      input :cross_hooks_selected_response_types,
+            title: 'Response types to return from all hook requests',
+            description: %(
+              Select the CRD response types that the simulated Inferno CRD server will [mock](https://github.com/inferno-framework/davinci-crd-test-kit/wiki/Controlling-Simulated-Responses#mocked-responses)
+              when responding to hook invocations. If no types are selected, Inferno will mock and return
+              a [Coverage Information](https://hl7.org/fhir/us/davinci-crd/2.2.1/en/cards.html#coverage-information-response-type)
+              response.
+            ),
+            type: 'checkbox',
+            default: ['coverage_information', 'external_reference', 'instructions'],
+            optional: true,
+            options: { list_options: ORDER_RESPONSE_TYPE_OPTIONS },
+            enable_when: { input_name: 'cross_hooks_response_approach', value: 'mocked' }
+      input :cross_hooks_custom_response_template,
+            title: 'Custom response template for all hook requests',
+            description: %(
+              Provide a [custom response template](https://github.com/inferno-framework/davinci-crd-test-kit/wiki/Controlling-Simulated-Responses#tester-directed-custom-responses)
+              in JSON form for Inferno to use when responding to hook invocations.
+            ),
+            type: 'textarea',
+            optional: true,
+            enable_when: { input_name: 'cross_hooks_response_approach', value: 'custom' }
+
+      private
+
+      def hook_key
+        'cross_hooks'
+      end
+
+      def hook_slug
+        'all'
+      end
+
+      def primary_hook?
+        true
+      end
+
+      def invoke_heading
+        'Invoke any hook'
+      end
+
+      def invoke_intro
+        "Invoke any hook by sending requests to\n            " \
+          "one or both of the two Inferno simulated CRD servers\n            " \
+          'discoverable at the following endpoints:'
+      end
+
+      def complete_prefetch_url
+        discovery_url
+      end
+
+      def subset_prefetch_url
+        prefetch_subset_discovery_url
+      end
+    end
+  end
+end