davinci_crd_test_kit 0.13.0 → 0.14.0

data/lib/davinci_crd_test_kit/server_tests/service_call_test.rb

@@ -1,101 +0,0 @@
-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 %(
-      This test initiates POST request(s) to a specified CDS Service using the JSON body list provided by the user.
-      As indicated in the [CDS Hooks specification section on Calling a CDS Service](https://cds-hooks.hl7.org/2.0/#calling-a-cds-service),
-      the service endpoint is constructed by appending the individual service id to the CDS Service base URL,
-      following the format `{baseUrl}/cds-services/{service.id}`.
-
-      If running this group only, the user will need to provide the `service.id` to call the specified service.
-      Otherwise, the `service.id` is derived from the CDS Services that are retrieved through a query to the
-      discovery endpoint.
-
-      The test will be skipped if the CRD server does not host a CDS Service corresponding to the hook that
-      is being tested.
-
-      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
-    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: '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,
-            CDS Hooks recommends ES384 and RS384 for JWT signature verification.
-            Select which method to use.
-          DESCRIPTION
-          type: 'radio',
-          options: {
-            list_options: [
-              {
-                label: 'ES384',
-                value: 'ES384'
-              },
-              {
-                label: 'RS384',
-                value: 'RS384'
-              }
-            ]
-          }
-    input :jwks_kid,
-          title: 'CDS Services JWKS kid',
-          description: <<~DESCRIPTION,
-            The key ID of the JWKS private key to use for signing the JWTs when invoking a CDS service endpoint
-            requiring authentication.
-            Defaults to the first JWK in the list if no kid is supplied.
-          DESCRIPTION
-          optional: true
-    output :invoked_hook
-
-    run do
-      discovery_url = "#{base_url.chomp('/')}/cds-services"
-      skip_if service_request_bodies.blank?,
-              'Request body not provided, skipping test.'
-      assert_valid_json(service_request_bodies)
-
-      payloads = [JSON.parse(service_request_bodies)].flatten
-      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,
-        iss: inferno_base_url,
-        jku: "#{inferno_base_url}/jwks.json",
-        kid: jwks_kid,
-        encryption_method:
-      )
-      headers = { 'Content-type' => 'application/json', 'Authorization' => "Bearer #{token}" }
-
-      payloads.each do |payload|
-        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)
-      end
-    end
-  end
-end

data/lib/davinci_crd_test_kit/server_tests/service_request_context_validation_test.rb

@@ -1,28 +0,0 @@
-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
-    description %(
-      This test verifies that all service requests `context` field is valid and contains all the
-      required fields.
-    )
-    input :contexts, :invoked_hook
-
-    run do
-      parsed_contexts = parse_json(contexts)
-      parsed_contexts.each do |context|
-        hook_request_context_check(context, invoked_hook)
-      end
-
-      no_error_validation('Some contexts are not valid.')
-    end
-  end
-end

data/lib/davinci_crd_test_kit/server_tests/service_request_optional_fields_validation_test.rb

@@ -1,37 +0,0 @@
-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
-    description %(
-      This optional test reviews the user-submitted CRD service requests for the presence of optional fields:
-      `fhirAuthorization` and `prefetch`.
-
-      The test will not fail if these optional fields are missing from a service request; instead, it generates an
-      informational message.
-    )
-    optional
-
-    run do
-      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
-        request_body = json_parse(request.request_body)
-        if request_body.blank?
-          add_message('error', "#{request_number}Hook request body cannot be empty.")
-          next
-        end
-
-        hook_request_optional_fields_check(request_body)
-      end
-      no_error_validation('Some service requests have invalid optional fields.')
-    end
-  end
-end

data/lib/davinci_crd_test_kit/server_tests/service_request_required_fields_validation_test.rb

@@ -1,38 +0,0 @@
-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
-    description %(
-      This test validates all CRD service requests provided by the user, ensuring each includes all required fields
-      specified in the [CDS Hooks spec section on Calling a CDS Service](https://cds-hooks.hl7.org/2.0/#calling-a-cds-service):
-      `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
-
-    run do
-      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
-        request_body = json_parse(request.request_body)
-        next if request_body.blank?
-
-        contexts << request_body['context'] if request_body['context'].is_a?(Hash)
-        hook_request_required_fields_check(request_body, invoked_hook)
-      end
-
-      output contexts: contexts.to_json
-
-      no_error_validation('Some service requests made are not valid.')
-    end
-  end
-end

data/lib/davinci_crd_test_kit/server_tests/service_response_validation_test.rb

@@ -1,81 +0,0 @@
-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
-    description %(
-      As per the [CDS Hooks spec section on CDS Service Response](https://cds-hooks.hl7.org/2.0/#cds-service-response),
-      a successful server's response to a service request must be a JSON object containing a `cards` array.
-      It must also contain a `systemActions` array for `appointment-book` and `order-sign` hook.
-
-      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', 'order-dispatch'].freeze
-
-    def valid_cards
-      @valid_cards ||= []
-    end
-
-    def valid_system_actions
-      @valid_system_actions ||= []
-    end
-
-    def system_actions_check(system_actions)
-      system_actions.each do |action|
-        current_error_count = messages.count { |msg| msg[:type] == 'error' }
-        action_fields_validation(action)
-        valid_system_actions << action if current_error_count == messages.count { |msg| msg[:type] == 'error' }
-      end
-    end
-
-    def perform_system_actions_validation(system_actions, response_index)
-      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 #{invoked_hook}."
-        add_message('error', msg)
-      end
-      return if system_actions.nil?
-
-      unless system_actions.is_a?(Array)
-        add_message('error', "`systemActions` of server response #{response_index + 1} is not an array.")
-        return
-      end
-      system_actions_check(system_actions)
-    end
-
-    run do
-      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.'
-
-      info do
-        unsuccessful_count = (requests - successful_requests).length
-        assert unsuccessful_count.zero?, "#{unsuccessful_count} out of #{requests.length} requests were unsuccessful"
-      end
-
-      successful_requests.each_with_index do |request, index|
-        service_response = JSON.parse(request.response_body)
-        perform_cards_validation(service_response['cards'], index)
-
-        perform_system_actions_validation(service_response['systemActions'], index)
-      rescue JSON::ParserError
-        add_message('error', "Invalid JSON: server response #{index + 1} is not a valid JSON.")
-      end
-
-      output valid_system_actions: valid_system_actions.to_json
-      output valid_cards: valid_cards.to_json
-
-      no_error_validation('Some service responses are not valid. Check messages for issues found.')
-    end
-  end
-end

data/lib/davinci_crd_test_kit/tags.rb

@@ -1,10 +0,0 @@
-module DaVinciCRDTestKit
-  APPOINTMENT_BOOK_TAG = 'appointment-book'.freeze
-  ENCOUNTER_START_TAG = 'encounter-start'.freeze
-  ENCOUNTER_DISCHARGE_TAG = 'encounter-discharge'.freeze
-  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/urls.rb

@@ -1,52 +0,0 @@
-module DaVinciCRDTestKit
-  APPOINTMENT_BOOK_PATH = '/cds-services/appointment-book-service'.freeze
-  ENCOUNTER_START_PATH = '/cds-services/encounter-start-service'.freeze
-  ENCOUNTER_DISCHARGE_PATH = '/cds-services/encounter-discharge-service'.freeze
-  ORDER_DISPATCH_PATH = '/cds-services/order-dispatch-service'.freeze
-  ORDER_SELECT_PATH = '/cds-services/order-select-service'.freeze
-  ORDER_SIGN_PATH = '/cds-services/order-sign-service'.freeze
-  RESUME_PASS_PATH = '/resume_pass'.freeze
-  RESUME_FAIL_PATH = '/resume_fail'.freeze
-
-  module URLs
-    def base_url
-      @base_url ||= "#{Inferno::Application['base_url']}/custom/#{suite_id}"
-    end
-
-    def appointment_book_url
-      @appointment_book_url ||= base_url + APPOINTMENT_BOOK_PATH
-    end
-
-    def encounter_start_url
-      @encounter_start_url ||= base_url + ENCOUNTER_START_PATH
-    end
-
-    def encounter_discharge_url
-      @encounter_discharge_url ||= base_url + ENCOUNTER_DISCHARGE_PATH
-    end
-
-    def order_dispatch_url
-      @order_dispatch_url ||= base_url + ORDER_DISPATCH_PATH
-    end
-
-    def order_select_url
-      @order_select_url ||= base_url + ORDER_SELECT_PATH
-    end
-
-    def order_sign_url
-      @order_sign_url ||= base_url + ORDER_SIGN_PATH
-    end
-
-    def resume_pass_url
-      @resume_pass_url ||= base_url + RESUME_PASS_PATH
-    end
-
-    def resume_fail_url
-      @resume_fail_url ||= base_url + RESUME_FAIL_PATH
-    end
-
-    def suite_id
-      self.class.suite.id
-    end
-  end
-end