davinci_pas_test_kit 0.12.0 → 0.12.2

data/lib/davinci_pas_test_kit/jobs/send_pas_subscription_notification.rb

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+require_relative '../tags'
+require_relative '../urls'
+require 'subscriptions_test_kit'
+
+module DaVinciPASTestKit
+  module Jobs
+    class SendPASSubscriptionNotification
+      include Sidekiq::Job
+      include SubscriptionsTestKit::SubscriptionsR5BackportR4Client::SubscriptionSimulationUtils
+      include URLs
+
+      # override the one from URLs
+      def suite_id
+        @notification_suite_id
+      end
+
+      sidekiq_options retry: false
+
+      def perform(test_run_id, test_session_id, result_id, notification_bearer_token, notification_json, resume_token,
+                  notification_suite_id)
+        @test_run_id = test_run_id
+        @test_session_id = test_session_id
+        @result_id = result_id
+        @notification_bearer_token = notification_bearer_token
+        @notification_json = notification_json
+        @resume_token = resume_token
+        @notification_suite_id = notification_suite_id
+
+        await_subscription_creation # NOTE: currently must exist - see PASClientPendedSubmitTest
+        sleep 1
+        return unless test_still_waiting?
+
+        sleep rand(5..10)
+        return unless test_still_waiting?
+
+        send_event_notification
+      end
+
+      def requests_repo
+        @requests_repo ||= Inferno::Repositories::Requests.new
+      end
+
+      def results_repo
+        @results_repo ||= Inferno::Repositories::Results.new
+      end
+
+      def subscription
+        @subscription ||= find_subscription(@test_session_id)
+      end
+
+      def subscription_notification_endpoint
+        subscription&.channel&.endpoint
+      end
+
+      def headers
+        @headers ||= subscription_headers.merge(content_type_header).merge(authorization_header)
+      end
+
+      def rest_hook_connection
+        @rest_hook_connection ||= Faraday.new(url: subscription_notification_endpoint, request: { open_timeout: 30 },
+                                              headers:)
+      end
+
+      def test_suite_connection
+        @test_suite_connection ||= Faraday.new(base_url)
+      end
+
+      def content_type_header
+        @content_type_header ||= { 'Content-Type' => actual_mime_type(subscription) }
+      end
+
+      def subscription_headers
+        @subscription_headers ||= subscription.channel&.header&.each_with_object({}) do |header, hash|
+          header_name, header_value = header.split(': ', 2)
+          hash[header_name] = header_value
+        end || {}
+      end
+
+      def authorization_header
+        @authorization_header ||=
+          @notification_bearer_token.present? ? { 'Authorization' => "Bearer #{@notification_bearer_token}" } : {}
+      end
+
+      def subscription_topic
+        @subscription_topic ||= subscription&.criteria
+      end
+
+      def subscription_full_url
+        @subscription_full_url ||= "#{fhir_subscription_url}/#{subscription.id}"
+      end
+
+      def test_still_waiting?
+        results_repo.find_waiting_result(test_run_id: @test_run_id)
+      end
+
+      def await_subscription_creation
+        sleep 0.5 until subscription.present? || !test_still_waiting?
+      end
+
+      def send_event_notification
+        event_json = derive_event_notification(@notification_json, subscription_full_url, subscription_topic, 1).to_json
+        response = send_notification(event_json)
+        persist_notification_request(response, [REST_HOOK_EVENT_NOTIFICATION_TAG])
+      end
+
+      def send_notification(request_body)
+        rest_hook_connection.post('', request_body)
+      rescue Faraday::Error => e
+        # Warning: This is a hack. If there is an error with the request such that we never get a response, we have
+        #          no clean way to persist that information for the Inferno test to check later. The solution here
+        #          is to persist the request anyway with a status of nil, using the error message as response body
+        Faraday::Response.new(response_body: e.message, url: rest_hook_connection.url_prefix.to_s)
+      end
+
+      def persist_notification_request(response, tags)
+        inferno_request_headers = headers.map { |name, value| { name:, value: } }
+        inferno_response_headers = response.headers&.map { |name, value| { name:, value: } }
+        requests_repo.create(
+          verb: 'POST',
+          url: response.env.url.to_s,
+          direction: 'outgoing',
+          status: response.status,
+          request_body: response.env.request_body,
+          response_body: response.env.response_body,
+          test_session_id: @test_session_id,
+          result_id: @result_id,
+          request_headers: inferno_request_headers,
+          response_headers: inferno_response_headers,
+          tags:
+        )
+      end
+    end
+  end
+end

data/lib/davinci_pas_test_kit/jobs/send_subscription_handshake.rb

@@ -0,0 +1,139 @@
+# frozen_string_literal: true
+
+require_relative '../tags'
+require 'subscriptions_test_kit'
+
+module DaVinciPASTestKit
+  module Jobs
+    class SendSubscriptionHandshake
+      include Sidekiq::Job
+      include SubscriptionsTestKit::SubscriptionsR5BackportR4Client::SubscriptionSimulationUtils
+
+      sidekiq_options retry: false
+
+      def perform(test_run_id, test_session_id, result_id, subscription_id, subscription_url, client_endpoint,
+                  bearer_token, notification_json, test_run_identifier, test_suite_base_url)
+        @test_run_id = test_run_id
+        @test_session_id = test_session_id
+        @result_id = result_id
+        @subscription_id = subscription_id
+        @subscription_url = subscription_url
+        @client_endpoint = client_endpoint
+        @bearer_token = bearer_token
+        @notification_json = notification_json.present? ? notification_json : default_notification_base_json
+        @test_run_identifier = test_run_identifier
+        @test_suite_base_url = test_suite_base_url
+
+        await_subscription_creation
+        sleep 1
+        return unless test_still_waiting?
+
+        send_handshake_notification
+        test_suite_connection.get(RESUME_PASS_PATH.delete_prefix('/'), { token: @test_run_identifier })
+      end
+
+      def default_notification_base_json
+        FHIR::Bundle.new(
+          timestamp: Time.now.utc.iso8601,
+          type: 'history',
+          entry: [
+            FHIR::Bundle::Entry.new(fullUrl: "urn:uuid:#{SecureRandom.uuid}",
+                                    resource: FHIR.from_contents(default_handshake_parameters_base_json))
+          ]
+        ).to_json
+      end
+
+      def default_handshake_parameters_base_json
+        '{ "parameter": [ { "name": "subscription", "valueReference": { "reference": "replace_with_subscription_ref" } }, { "name": "topic", "valueCanonical": "replace_with_topic_canonical" }, { "name": "status", "valueCode": "requested" }, { "name": "type", "valueCode": "handshake" }, { "name": "events-since-subscription-start", "valueString": "0" } ], "resourceType": "Parameters" }' # rubocop:disable Layout/LineLength
+      end
+
+      def requests_repo
+        @requests_repo ||= Inferno::Repositories::Requests.new
+      end
+
+      def results_repo
+        @results_repo ||= Inferno::Repositories::Results.new
+      end
+
+      def subscription
+        @subscription ||= find_subscription(@test_session_id)
+      end
+
+      def headers
+        @headers ||= subscription_headers.merge(content_type_header).merge(authorization_header)
+      end
+
+      def rest_hook_connection
+        @rest_hook_connection ||= Faraday.new(url: @client_endpoint, request: { open_timeout: 30 }, headers:)
+      end
+
+      def test_suite_connection
+        @test_suite_connection ||= Faraday.new(@test_suite_base_url)
+      end
+
+      def content_type_header
+        @content_type_header ||= { 'Content-Type' => actual_mime_type(subscription) }
+      end
+
+      def subscription_headers
+        return {} unless subscription.present?
+
+        @subscription_headers ||= subscription.channel&.header&.each_with_object({}) do |header, hash|
+          header_name, header_value = header.split(': ', 2)
+          hash[header_name] = header_value
+        end || {}
+      end
+
+      def subscription_topic
+        @subscription_topic ||= subscription&.criteria
+      end
+
+      def authorization_header
+        @authorization_header ||= @bearer_token.present? ? { 'Authorization' => "Bearer #{@bearer_token}" } : {}
+      end
+
+      def test_still_waiting?
+        results_repo.find_waiting_result(test_run_id: @test_run_id)
+      end
+
+      def await_subscription_creation
+        sleep 0.5 until subscription.present?
+      end
+
+      def send_handshake_notification
+        handshake_json = derive_handshake_notification(@notification_json, @subscription_url,
+                                                       subscription_topic).to_json
+        response = send_notification(handshake_json)
+        persist_notification_request(response, [REST_HOOK_HANDSHAKE_NOTIFICATION_TAG])
+        response
+      end
+
+      def send_notification(request_body)
+        rest_hook_connection.post('', request_body)
+      rescue Faraday::Error => e
+        # Warning: This is a hack. If there is an error with the request such that we never get a response, we have
+        #          no clean way to persist that information for the Inferno test to check later. The solution here
+        #          is to persist the request anyway with a status of nil, using the error message as response body
+        Faraday::Response.new(response_body: e.message, url: rest_hook_connection.url_prefix.to_s)
+      end
+
+      def persist_notification_request(response, tags)
+        inferno_request_headers = headers.map { |name, value| { name:, value: } }
+        inferno_response_headers = response.headers&.map { |name, value| { name:, value: } }
+        requests_repo.create(
+          verb: 'POST',
+          url: response.env.url.to_s,
+          direction: 'outgoing',
+          status: response.status,
+          request_body: response.env.request_body,
+          response_body: response.env.response_body,
+          test_session_id: @test_session_id,
+          result_id: @result_id,
+          request_headers: inferno_request_headers,
+          response_headers: inferno_response_headers,
+          tags:
+        )
+      end
+    end
+  end
+end

data/lib/davinci_pas_test_kit/pas_bundle_validation.rb

@@ -70,7 +70,7 @@ module DaVinciPASTestKit
     # referenced in the Claim resource are included in the bundle. It ensures that the first
     # entry in the Bundle is a Claim resource and additional entries are populated
     # with referenced resources, following the traversal of references.
-    # Duplicate resources are handled as required( appearing only once
+    # Duplicate resources are handled as required (appearing only once
     # in the bundle entry).
     def validate_pa_request_payload_structure(bundle, request_type)
       bundle_entry_resources = bundle.entry.map(&:resource)
@@ -171,7 +171,7 @@ module DaVinciPASTestKit
       bundle_entry = bundle.entry
 
       root_entry = bundle_entry.find do |entry|
-        entry.resource.resourceType == 'Claim' || entry.resource.resourceType == 'ClaimResponse'
+        ['Claim', 'ClaimResponse'].include?(entry.resource.resourceType)
       end
 
       if root_entry.present?
@@ -299,7 +299,7 @@ module DaVinciPASTestKit
     # Processes the profiles associated with a given instance in a FHIR bundle.
     # It adds the instance's profiles to the resource target profile map and handles recursive profile extraction.
     # The profiles collected here are possible profiles the given instance may conform to.
-    # The conformance validation will ensure that the resource is comformant to at least one of the target profiles.
+    # The conformance validation will ensure that the resource is conformant to at least one of the target profiles.
     # @param instance [Object] The instance whose profiles are to be processed.
     # @param bundle_entry [Array] The bundle.entry contents.
     # @param reference_element [Hash] The reference element related to the instance.
@@ -331,7 +331,9 @@ module DaVinciPASTestKit
     # @param bundle_entry [Array] The bundle.entry contents.
     # @param version [String] The IG version.
     def add_declared_profiles(instance, bundle_entry, version)
-      instance.resource&.meta&.profile&.each do |url|
+      return unless instance.resource.present?
+
+      instance.resource.meta&.profile&.each do |url|
         next if bundle_resources_target_profile_map[instance.fullUrl][:profile_urls].include?(url)
 
         bundle_resources_target_profile_map[instance.fullUrl][:profile_urls] << url
@@ -340,7 +342,7 @@ module DaVinciPASTestKit
     end
 
     # Adds a specific profile URL to an instance in the resource target profile map.
-    # It recursively processes the instance for further profilce extraction.
+    # It recursively processes the instance for further profile extraction.
     # @param instance [Object] The instance to which the profile URL is added.
     # @param profile_url [String] The profile URL to be added.
     # @param bundle_entry [Array] The bundle.entry contents.
@@ -453,7 +455,7 @@ module DaVinciPASTestKit
     # as required by the PAS IG.
     # @param target_resource [FHIR::Model] The FHIR resource to traverse and validate.
     # @param base_url [String] The server base url.
-    # @param resources_to_match [Array<FHIR:Bundel:Entry] The list of FHIR bundle entries to match references against.
+    # @param resources_to_match [Array<FHIR:Bundle:Entry] The list of FHIR bundle entries to match references against.
     def check_presence_of_referenced_resources(target_resource, base_url, resources_to_match)
       return if target_resource.blank?
 
@@ -462,11 +464,10 @@ module DaVinciPASTestKit
         return if ref.blank?
 
         absolute_ref = absolute_url(ref, base_url)
-        resource_type, resource_id = ref.split('/')
         matching_resources = resources_to_match.find_all { |res| res.fullUrl == absolute_ref }
 
         if matching_resources.length != 1
-          validation_error_messages << resource_shall_appear_once_message(resource_type, resource_id,
+          validation_error_messages << resource_shall_appear_once_message(absolute_ref,
                                                                           matching_resources.length)
         end
 
@@ -525,10 +526,10 @@ module DaVinciPASTestKit
     #
     # This method generates an error message when a referenced resource appears more than once
     # in a FHIR bundle, which is not allowed.
-    def resource_shall_appear_once_message(reference_resource_type, reference_resource_id, total_matches)
+    def resource_shall_appear_once_message(absolute_ref, total_matches)
       "
-        The referenced #{reference_resource_type}/#{reference_resource_id} resource
-        SHALL only appear once in the Bundle, but found #{total_matches}.
+        The referenced #{absolute_ref} resource
+        SHALL appear exactly once in the Bundle, but found #{total_matches}.
       "
     end
 

data/lib/davinci_pas_test_kit/requirements/davinci-pas-test-kit_out_of_scope_requirements.csv

@@ -0,0 +1,11 @@
+Req Set,ID,Reason,Details
+hl7.fhir.us.davinci-pas_2.0.1,12,Not Tested,Details of X12 messages will not be tested by Inferno.
+hl7.fhir.us.davinci-pas_2.0.1,13,Not Tested,Details of X12 messages will not be tested by Inferno.
+hl7.fhir.us.davinci-pas_2.0.1,14,Not Tested,Details of X12 messages will not be tested by Inferno.
+hl7.fhir.us.davinci-pas_2.0.1,15,Not Tested,Details of X12 messages will not be tested by Inferno.
+hl7.fhir.us.davinci-pas_2.0.1,96,Not Tested,Details of X12 messages will not be tested by Inferno.
+hl7.fhir.us.davinci-pas_2.0.1,108,Not Verifiable,The specification does not provide clear details on the indicated responses (unclear diagram)
+hl7.fhir.us.davinci-pas_2.0.1,109,Not Verifiable,The specification does not provide clear details on the indicated responses (unclear diagram)
+hl7.fhir.us.davinci-pas_2.0.1,124,Not Tested,The rules for determining matching claims are specified in a proprietary X12 specification.
+hl7.fhir.us.davinci-pas_2.0.1,132,Not Tested,How to request a subset of information is not detailed in the specification and lives in priopietary X12 specifications and mappings.
+hl7.fhir.us.davinci-pas_2.0.1,191,Not Tested,Details of payer business rules will not be tested by Inferno.