davinci_crd_test_kit 0.14.0 → 0.14.2

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

data/lib/davinci_crd_test_kit/client/v2.2.1/invocation/encounter_discharge_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 EncounterDischargeReceiveRequestTest < Inferno::Test
-      include ClientURLs
-
+    class EncounterDischargeReceiveRequestTest < BaseHookInvocationReceiveRequestTest
       id :crd_v221_encounter_discharge_request
       title 'Client invokes the encounter-discharge hook'
       description %(
@@ -20,16 +18,6 @@ module DaVinciCRDTestKit
         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 :encounter_discharge_response_approach,
             title: 'Response generation approach for encounter-discharge',
             description: %(
@@ -61,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: 'encounter_discharge_response_approach', value: 'mocked' }
       input :encounter_discharge_custom_response_template,
             title: 'Custom response template for encounter-discharge hook requests',
@@ -99,58 +60,15 @@ module DaVinciCRDTestKit
             type: 'textarea',
             optional: true,
             enable_when: { input_name: 'encounter_discharge_response_approach', value: 'custom' }
-      output :continuation_url
-
-      def configured_response_details
-        if encounter_discharge_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 encounter-discharge 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 encounter_discharge_selected_response_types.present?
-          encounter_discharge_selected_response_types.join("\n            - ")
-        else
-          'Instructions' # secondary hook default
-        end
+      def hook_key
+        'encounter_discharge'
       end
 
-      run do
-        identifier = cds_jwt_iss
-        continuation_url = "#{resume_pass_url}?token=#{identifier}"
-        output(continuation_url:)
-
-        wait(
-          identifier:,
-          message: %(
-            **Invoke the `encounter-discharge` hook**:
-
-            Invoke the encounter-discharge hook by sending requests to
-            one or both of the two Inferno simulated CRD servers:
-
-            - Complete Prefetch: `#{encounter_discharge_url}`
-            - Subset Prefetch: `#{encounter_discharge_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?
+        false
       end
     end
   end

data/lib/davinci_crd_test_kit/client/v2.2.1/invocation/encounter_start_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 EncounterStartReceiveRequestTest < Inferno::Test
-      include ClientURLs
-
+    class EncounterStartReceiveRequestTest < BaseHookInvocationReceiveRequestTest
       id :crd_v221_encounter_start_request
       title 'Client invokes the encounter-start hook'
       description %(
@@ -20,16 +18,6 @@ module DaVinciCRDTestKit
         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 :encounter_start_response_approach,
             title: 'Response generation approach for encounter-start',
             description: %(
@@ -61,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: 'encounter_start_response_approach', value: 'mocked' }
       input :encounter_start_custom_response_template,
             title: 'Custom response template for encounter-start hook requests',
@@ -99,58 +60,15 @@ module DaVinciCRDTestKit
             type: 'textarea',
             optional: true,
             enable_when: { input_name: 'encounter_start_response_approach', value: 'custom' }
-      output :continuation_url
-
-      def configured_response_details
-        if encounter_start_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 encounter-start 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 encounter_start_selected_response_types.present?
-          encounter_start_selected_response_types.join("\n            - ")
-        else
-          'Instructions' # secondary hook default
-        end
+      def hook_key
+        'encounter_start'
       end
 
-      run do
-        identifier = cds_jwt_iss
-        continuation_url = "#{resume_pass_url}?token=#{identifier}"
-        output(continuation_url:)
-
-        wait(
-          identifier:,
-          message: %(
-            **Invoke the `encounter-start` hook**:
-
-            Invoke the encounter-start hook by sending requests to
-            one or both of the two Inferno simulated CRD servers:
-
-            - Complete Prefetch: `#{encounter_start_url}`
-            - Subset Prefetch: `#{encounter_start_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?
+        false
       end
     end
   end

data/lib/davinci_crd_test_kit/client/v2.2.1/invocation/order_dispatch_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 OrderDispatchReceiveRequestTest < Inferno::Test
-      include ClientURLs
-
+    class OrderDispatchReceiveRequestTest < BaseHookInvocationReceiveRequestTest
       id :crd_v221_order_dispatch_request
       title 'Client invokes the order-dispatch hook'
       description %(
@@ -20,16 +18,6 @@ module DaVinciCRDTestKit
         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 :order_dispatch_response_approach,
             title: 'Response generation approach for order-dispatch',
             description: %(
@@ -61,42 +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'
-                },
-                {
-                  label: 'Propose Alternate Request',
-                  value: 'propose_alternate_request'
-                },
-                {
-                  label: 'Additional Orders as Companions/Prerequisites',
-                  value: 'companions_prerequisites'
-                }
-              ]
-            },
+            options: { list_options: ORDER_RESPONSE_TYPE_OPTIONS },
             enable_when: { input_name: 'order_dispatch_response_approach', value: 'mocked' }
       input :order_dispatch_custom_response_template,
             title: 'Custom response template for order-dispatch hook requests',
@@ -107,58 +60,15 @@ module DaVinciCRDTestKit
             type: 'textarea',
             optional: true,
             enable_when: { input_name: 'order_dispatch_response_approach', value: 'custom' }
-      output :continuation_url
 
-      def configured_response_details
-        if order_dispatch_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 order-dispatch hook requests** input ' \
-            'against the incoming request to create a response.'
-          # rubocop:enable Layout/LineLength
+      private
 
-        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
+      def hook_key
+        'order_dispatch'
       end
 
-      def selected_response_types_string
-        if order_dispatch_selected_response_types.present?
-          order_dispatch_selected_response_types.join("\n            - ")
-        else
-          'Coverage Information' # primary hook default
-        end
-      end
-
-      run do
-        identifier = cds_jwt_iss
-        continuation_url = "#{resume_pass_url}?token=#{identifier}"
-        output(continuation_url:)
-
-        wait(
-          identifier:,
-          message: %(
-            **Invoke the `order-dispatch` hook**:
-
-            Invoke the order-dispatch hook by sending requests to
-            one or both of the two Inferno simulated CRD servers:
-
-            - Complete Prefetch: `#{order_dispatch_url}`
-            - Subset Prefetch: `#{order_dispatch_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