davinci_crd_test_kit 0.10.0 → 0.11.0

data/lib/davinci_crd_test_kit/server_tests/instructions_card_received_test.rb

@@ -1,8 +1,10 @@
 require_relative '../test_helper'
+require_relative '../server_hook_helper'
 
 module DaVinciCRDTestKit
   class InstructionsCardReceivedTest < Inferno::Test
     include DaVinciCRDTestKit::TestHelper
+    include DaVinciCRDTestKit::ServerHookHelper
 
     title 'Valid Instructions cards received'
     id :crd_valid_instructions_card_received
@@ -15,14 +17,10 @@ module DaVinciCRDTestKit
     input :valid_cards
     optional
 
-    def hook_name
-      config.options[:hook_name]
-    end
-
     run do
       parsed_cards = parse_json(valid_cards)
       instructions_card = parsed_cards.find { |card| card['links'].blank? && card['suggestions'].blank? }
-      assert instructions_card, 'Hook response did not contain an Instructions card.'
+      assert instructions_card, "#{tested_hook_name} hook response did not contain an Instructions card."
     end
   end
 end

data/lib/davinci_crd_test_kit/server_tests/launch_smart_app_card_validation_test.rb

@@ -1,8 +1,10 @@
 require_relative '../test_helper'
+require_relative '../server_hook_helper'
 
 module DaVinciCRDTestKit
   class LaunchSmartAppCardValidationTest < Inferno::Test
     include DaVinciCRDTestKit::TestHelper
+    include DaVinciCRDTestKit::ServerHookHelper
 
     title 'Valid Launch SMART Application cards received'
     id :crd_launch_smart_app_card_validation
@@ -21,10 +23,6 @@ module DaVinciCRDTestKit
     optional
     input :valid_cards_with_links
 
-    def hook_name
-      config.options[:hook_name]
-    end
-
     run do
       parsed_cards = parse_json(valid_cards_with_links)
       external_reference_cards = parsed_cards.select do |card|
@@ -32,7 +30,8 @@ module DaVinciCRDTestKit
         links.present? && links.all? { |link| link['type'] == 'smart' }
       end
 
-      skip_if external_reference_cards.blank?, "#{hook_name} hook response does not contain any Launch SMART App cards."
+      skip_if external_reference_cards.blank?,
+              "#{tested_hook_name} hook response does not contain any Launch SMART App cards."
     end
   end
 end

data/lib/davinci_crd_test_kit/server_tests/propose_alternate_request_card_validation_test.rb

@@ -1,10 +1,12 @@
 require_relative '../test_helper'
 require_relative '../suggestion_actions_validation'
+require_relative '../server_hook_helper'
 
 module DaVinciCRDTestKit
   class ProposeAlternateRequestCardValidationTest < Inferno::Test
     include DaVinciCRDTestKit::TestHelper
     include DaVinciCRDTestKit::SuggestionActionsValidation
+    include DaVinciCRDTestKit::ServerHookHelper
 
     title 'Valid Propose Alternate Request cards received'
     id :crd_propose_alternate_request_card_validation
@@ -24,10 +26,6 @@ module DaVinciCRDTestKit
       VisionPrescription
     ].freeze
 
-    def hook_name
-      config.options[:hook_name]
-    end
-
     def check_action_type(actions, action_type)
       actions&.any? do |action|
         action['type'] == action_type && action_resource_type_check(action, EXPECTED_RESOURCE_TYPES)
@@ -51,7 +49,7 @@ module DaVinciCRDTestKit
       proposed_alternate_cards = parsed_cards.filter { |card| propose_alternate_request_card?(card) }
 
       skip_if proposed_alternate_cards.blank?,
-              "#{hook_name} hook response does not contain a Propose Alternate Request card."
+              "#{tested_hook_name} hook response does not contain a Propose Alternate Request card."
 
       proposed_alternate_cards.each do |card|
         card['suggestions'].each do |suggestion|

data/lib/davinci_crd_test_kit/server_tests/service_call_test.rb

@@ -1,5 +1,10 @@
+require_relative '../server_hook_helper'
+require_relative '../tags'
+
 module DaVinciCRDTestKit
   class ServiceCallTest < Inferno::Test
+    include ServerHookHelper
+
     title 'Submit user-defined service requests'
     id :crd_service_call_test
     description %(
@@ -18,11 +23,17 @@ module DaVinciCRDTestKit
       The test is deemed successful if the CRD server returns a 200 HTTP response for all requests.
     )
     input_order :base_url, :encryption_method, :jwks_kid
-    input :base_url, :service_ids
+    input :base_url
+    input :service_ids,
+          description: %(
+            If blank, Inferno will attempt to infer the service id to use by finding a service entry in the
+            Discovery response for the target hook. If it cannot be inferred, the tests will be skipped.
+          ),
+          optional: true
     input :service_request_bodies,
           optional: true,
           type: 'textarea',
-          description: 'Provide a list of request bodies send multiple requests. e.g. [json_body_1, json_body_2]'
+          description: 'To send multiple requests, provide as a JSON list, e.g., [json_body_1, json_body_2].'
     input :encryption_method,
           title: 'JWT Signing Algorithm',
           description: <<~DESCRIPTION,
@@ -50,10 +61,7 @@ module DaVinciCRDTestKit
             Defaults to the first JWK in the list if no kid is supplied.
           DESCRIPTION
           optional: true
-
-    def hook_name
-      config.options[:hook_name]
-    end
+    output :invoked_hook
 
     run do
       discovery_url = "#{base_url.chomp('/')}/cds-services"
@@ -62,7 +70,12 @@ module DaVinciCRDTestKit
       assert_valid_json(service_request_bodies)
 
       payloads = [JSON.parse(service_request_bodies)].flatten
-      service_id = service_ids.split(', ').first.strip
+      skip_if tested_hook_name == ANY_HOOK_TAG && payloads.length != 1,
+              'The *Demonstrate a Hook Invocation* test supports only one request body.'
+      invoked_hook = identify_hook(payloads)
+      service_id = target_service_id(service_ids, invoked_hook)
+      skip_if service_id.blank?, "No service id provided or discovered for the #{invoked_hook} hook"
+
       service_endpoint = "#{discovery_url}/#{service_id}"
       token = JwtHelper.build(
         aud: service_endpoint,
@@ -74,9 +87,11 @@ module DaVinciCRDTestKit
       headers = { 'Content-type' => 'application/json', 'Authorization' => "Bearer #{token}" }
 
       payloads.each do |payload|
-        post(service_endpoint, body: payload.to_json, headers:, tags: [hook_name])
+        post(service_endpoint, body: payload.to_json, headers:, tags: [tested_hook_name])
       end
 
+      output(invoked_hook:)
+
       requests.each do |request|
         assert_response_status(200, request:)
         assert_valid_json(request.response_body)

data/lib/davinci_crd_test_kit/server_tests/service_request_context_validation_test.rb

@@ -1,10 +1,12 @@
 require_relative '../server_hook_request_validation'
 require_relative '../test_helper'
+require_relative '../server_hook_helper'
 
 module DaVinciCRDTestKit
   class ServiceRequestContextValidationTest < Inferno::Test
     include DaVinciCRDTestKit::ServerHookRequestValidation
     include DaVinciCRDTestKit::TestHelper
+    include DaVinciCRDTestKit::ServerHookHelper
 
     title 'All service requests contain valid context'
     id :crd_service_request_context_validation
@@ -12,16 +14,12 @@ module DaVinciCRDTestKit
       This test verifies that all service requests `context` field is valid and contains all the
       required fields.
     )
-    input :contexts
-
-    def hook_name
-      config.options[:hook_name]
-    end
+    input :contexts, :invoked_hook
 
     run do
       parsed_contexts = parse_json(contexts)
       parsed_contexts.each do |context|
-        hook_request_context_check(context, hook_name)
+        hook_request_context_check(context, invoked_hook)
       end
 
       no_error_validation('Some contexts are not valid.')

data/lib/davinci_crd_test_kit/server_tests/service_request_optional_fields_validation_test.rb

@@ -1,8 +1,10 @@
 require_relative '../server_hook_request_validation'
+require_relative '../server_hook_helper'
 
 module DaVinciCRDTestKit
   class ServiceRequestOptionalFieldsValidationTest < Inferno::Test
     include DaVinciCRDTestKit::ServerHookRequestValidation
+    include DaVinciCRDTestKit::ServerHookHelper
 
     title 'All service requests contain optional fields'
     id :crd_service_request_optional_fields_validation
@@ -15,13 +17,9 @@ module DaVinciCRDTestKit
     )
     optional
 
-    def hook_name
-      config.options[:hook_name]
-    end
-
     run do
-      load_tagged_requests(hook_name)
-      skip_if requests.empty?, "No #{hook_name} request was made in a previous test as expected."
+      load_tagged_requests(tested_hook_name)
+      skip_if requests.empty?, "No #{tested_hook_name} request was made in a previous test as expected."
 
       requests.each_with_index do |request, index|
         @request_number = index + 1

data/lib/davinci_crd_test_kit/server_tests/service_request_required_fields_validation_test.rb

@@ -1,7 +1,10 @@
 require_relative '../server_hook_request_validation'
+require_relative '../server_hook_helper'
+
 module DaVinciCRDTestKit
   class ServiceRequestRequiredFieldsValidationTest < Inferno::Test
     include DaVinciCRDTestKit::ServerHookRequestValidation
+    include DaVinciCRDTestKit::ServerHookHelper
 
     title 'All service requests contain required fields'
     id :crd_service_request_required_fields_validation
@@ -11,15 +14,12 @@ module DaVinciCRDTestKit
       `hook`, `hookInstance`, and `context`. Furthermore, the test checks for the conditional presence of the
       `fhirServer` field if `fhirAuthorization` is included.
     )
+    input :invoked_hook
     output :contexts
 
-    def hook_name
-      config.options[:hook_name]
-    end
-
     run do
-      load_tagged_requests(hook_name)
-      skip_if requests.empty?, "No #{hook_name} request was made in a previous test as expected."
+      load_tagged_requests(tested_hook_name)
+      skip_if requests.empty?, "No #{tested_hook_name} request was made in a previous test as expected."
       contexts = []
       requests.each_with_index do |request, index|
         @request_number = index + 1
@@ -27,7 +27,7 @@ module DaVinciCRDTestKit
         next if request_body.blank?
 
         contexts << request_body['context'] if request_body['context'].is_a?(Hash)
-        hook_request_required_fields_check(request_body, hook_name)
+        hook_request_required_fields_check(request_body, invoked_hook)
       end
 
       output contexts: contexts.to_json

data/lib/davinci_crd_test_kit/server_tests/service_response_validation_test.rb

@@ -1,8 +1,10 @@
 require_relative '../cards_validation'
+require_relative '../server_hook_helper'
 
 module DaVinciCRDTestKit
   class ServiceResponseValidationTest < Inferno::Test
     include DaVinciCRDTestKit::CardsValidation
+    include DaVinciCRDTestKit::ServerHookHelper
 
     title 'All service responses contain valid cards and optional systemActions'
     id :crd_service_response_validation
@@ -14,14 +16,11 @@ module DaVinciCRDTestKit
       Each card must contain the following required fields: `summary`, `indicator`, and `source`.
       The required fields must have a valid data structure.
     )
+    input :invoked_hook
     output :valid_cards, :valid_system_actions
 
     SYSTEM_ACTIONS_HOOK_NAMES = ['appointment-book', 'order-sign'].freeze
 
-    def hook_name
-      config.options[:hook_name]
-    end
-
     def valid_cards
       @valid_cards ||= []
     end
@@ -39,9 +38,9 @@ module DaVinciCRDTestKit
     end
 
     def perform_system_actions_validation(system_actions, response_index)
-      if SYSTEM_ACTIONS_HOOK_NAMES.include?(hook_name) && system_actions.nil?
+      if SYSTEM_ACTIONS_HOOK_NAMES.include?(invoked_hook) && system_actions.nil?
         msg = "Server response #{response_index + 1} did not have `systemActions` field." \
-              "Must be present for #{hook_name}."
+              "Must be present for #{invoked_hook}."
         add_message('error', msg)
       end
       return if system_actions.nil?
@@ -54,8 +53,8 @@ module DaVinciCRDTestKit
     end
 
     run do
-      load_tagged_requests(hook_name)
-      skip_if requests.blank?, "No #{hook_name} request was made in a previous test as expected."
+      load_tagged_requests(tested_hook_name)
+      skip_if requests.blank?, "No #{tested_hook_name} request was made in a previous test as expected."
       successful_requests = requests.select { |request| request.status == 200 }
       skip_if successful_requests.empty?, 'All service requests were unsuccessful.'
 

data/lib/davinci_crd_test_kit/tags.rb

@@ -5,4 +5,6 @@ module DaVinciCRDTestKit
   ORDER_DISPATCH_TAG = 'order-dispatch'.freeze
   ORDER_SELECT_TAG = 'order-select'.freeze
   ORDER_SIGN_TAG = 'order-sign'.freeze
+  DISCOVERY_TAG = 'cds_discovery'.freeze
+  ANY_HOOK_TAG = 'any_hook'.freeze
 end

data/lib/davinci_crd_test_kit/version.rb

@@ -1,3 +1,4 @@
 module DaVinciCRDTestKit
-  VERSION = '0.10.0'.freeze
+  VERSION = '0.11.0'.freeze
+  LAST_UPDATED = '2025-02-25'.freeze # TODO: update next release
 end

data/lib/davinci_crd_test_kit.rb

@@ -1,2 +1,3 @@
+require_relative 'davinci_crd_test_kit/metadata'
 require_relative 'davinci_crd_test_kit/crd_server_suite'
 require_relative 'davinci_crd_test_kit/crd_client_suite'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: davinci_crd_test_kit
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Stephen MacVicar
@@ -10,7 +10,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-11-06 00:00:00.000000000 Z
+date: 2025-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: inferno_core
@@ -18,42 +18,42 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.6.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.0
+        version: 0.6.4
 - !ruby/object:Gem::Dependency
   name: smart_app_launch_test_kit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.1
+        version: 0.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.1
+        version: 0.5.0
 - !ruby/object:Gem::Dependency
   name: tls_test_kit
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.1
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.1
+        version: 0.3.0
 description: DaVinci CRD Test Kit
 email:
 - inferno@groups.mitre.org
@@ -62,6 +62,10 @@ extensions: []
 extra_rdoc_files: []
 files:
 - LICENSE
+- config/presets/inferno_crd_client_suite.json.erb
+- config/presets/inferno_crd_server_suite.json.erb
+- config/presets/ri_crd_request_generator.json.erb
+- config/presets/ri_crd_server.json.erb
 - lib/davinci_crd_test_kit.rb
 - lib/davinci_crd_test_kit/card_responses/companions_prerequisites.json
 - lib/davinci_crd_test_kit/card_responses/create_update_coverage_information.json
@@ -107,17 +111,22 @@ files:
 - lib/davinci_crd_test_kit/crd_server_suite.rb
 - lib/davinci_crd_test_kit/ext/inferno_core/runnable.rb
 - lib/davinci_crd_test_kit/hook_request_field_validation.rb
+- lib/davinci_crd_test_kit/igs/.keep
+- lib/davinci_crd_test_kit/igs/davinci-crd-2.0.1.tgz
 - lib/davinci_crd_test_kit/jwks.rb
 - lib/davinci_crd_test_kit/jwt_helper.rb
+- lib/davinci_crd_test_kit/metadata.rb
 - lib/davinci_crd_test_kit/mock_service_response.rb
 - lib/davinci_crd_test_kit/routes/cds-services.json
 - lib/davinci_crd_test_kit/routes/cds_services_discovery_handler.rb
 - lib/davinci_crd_test_kit/routes/hook_request_endpoint.rb
 - lib/davinci_crd_test_kit/routes/jwk_set_endpoint_handler.rb
 - lib/davinci_crd_test_kit/server_appointment_book_group.rb
+- lib/davinci_crd_test_kit/server_demonstrate_hook_response_group.rb
 - lib/davinci_crd_test_kit/server_discovery_group.rb
 - lib/davinci_crd_test_kit/server_encounter_discharge_group.rb
 - lib/davinci_crd_test_kit/server_encounter_start_group.rb
+- lib/davinci_crd_test_kit/server_hook_helper.rb
 - lib/davinci_crd_test_kit/server_hook_request_validation.rb
 - lib/davinci_crd_test_kit/server_hooks_group.rb
 - lib/davinci_crd_test_kit/server_order_dispatch_group.rb
@@ -153,6 +162,7 @@ homepage: https://github.com/inferno-framework/davinci-crd-test-kit
 licenses:
 - Apache-2.0
 metadata:
+  inferno_test_kit: 'true'
   homepage_uri: https://github.com/inferno-framework/davinci-crd-test-kit
   source_code_uri: https://github.com/inferno-framework/davinci-crd-test-kit
 post_install_message:
@@ -163,14 +173,14 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 3.1.2
+      version: 3.3.6
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
+rubygems_version: 3.5.22
 signing_key:
 specification_version: 4
 summary: DaVinci CRD Test Kit