subscriptions_test_kit 0.9.2 → 0.9.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4aa07a6d63da9348618f7c9d28443c743ff8669b25e5304c2d572370d7eb457c
-  data.tar.gz: 28ca4154cb6b064fd6c7d5cb7dd47f9b6c68a5eef051214e091152517971979e
+  metadata.gz: 5a807454f459add0f7fd19401c70a5a3c190c5003c375c0b4eefe1e4103c8410
+  data.tar.gz: e284a813940aed69d0cfb3dffef7f1ab034c2fbf799182fe5b200d7edcb1285d
 SHA512:
-  metadata.gz: 756cebdf92654e1115f752c127e68c41052259087c781a665f9f286f4eaecb48bd10996cba20d6e0cfce1c287e3779be0a401e6a8f297b94bc40952e9686c013
-  data.tar.gz: d8146e70aae224a33f534f05b54282d96bdc62742d5710d3f6e30260d480ec52efd9396a98090800756611640cf66bbe695b7322c1f650eb47be3fb5e729afb3
+  metadata.gz: 248c63937da747106d20cbb41dbfd80728de783757a322160882d651ef7f43c30b4192fdf83f036803ef8e50eae082348284fcd30c3e537ae99385df080baf68
+  data.tar.gz: 89d5e860a4fa25b362d5a5d55054ec729dfd4395aa09d453bf71123c7b381120a0510509ad6fea2803665931ccd515c844f652442c1c6b8965b58a4fc6f6a0d6

data/lib/inferno_requirements_tools/tasks/collect_requirements.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'CSV'
+require 'csv'
 require 'roo'
 
 module InfernoRequirementsTools
@@ -52,22 +52,26 @@ module InfernoRequirementsTools
       PLANNED_NOT_TESTED_OUTPUT_FILE =
         File.join('lib', TEST_KIT_CODE_FOLDER, 'requirements', PLANNED_NOT_TESTED_OUTPUT_FILE_NAME).freeze
 
-      def input_file_map
-        @input_file_map ||= {}
+      def available_input_worksheets
+        @available_input_worksheets ||= Dir.glob(File.join(@input_directory, '*.xlsx')).reject { |f| f.include?('~$') }
       end
 
-      def input_rows
-        @input_rows ||= {}
-      end
-
-      def input_rows_for_set(req_set_id)
-        input_rows[req_set_id] = extract_input_rows_for_set(req_set_id) unless input_rows.has_key?(req_set_id)
-        input_rows[req_set_id]
-      end
-
-      def extract_input_rows_for_set(req_set_id)
-        CSV.parse(Roo::Spreadsheet.open(input_file_map[req_set_id]).sheet('Requirements').to_csv, headers: true).map do |row|
-          row.to_h.slice(*INPUT_HEADERS)
+      # Of the form:
+      # {
+      #   req_set_id_1: [row1, row2, row 3, ...],
+      #   req_set_id_2: [row1, row2, row 3, ...]
+      # }
+      def input_requirement_sets
+        @input_requirement_sets ||= INPUT_SETS.each_with_object({}) do |req_set_id, hash|
+          req_set_file = available_input_worksheets.find { |worksheet_file| worksheet_file.include?(req_set_id) }
+
+          hash[req_set_id] =
+            unless req_set_file.nil?
+              CSV.parse(Roo::Spreadsheet.open(req_set_file).sheet('Requirements').to_csv,
+                        headers: true).map do |row|
+                row.to_h.slice(*INPUT_HEADERS)
+              end
+            end
         end
       end
 
@@ -76,12 +80,11 @@ module InfernoRequirementsTools
           CSV.generate(+"\xEF\xBB\xBF") do |csv| # start with an unnecessary BOM to make viewing in excel easier
             csv << REQUIREMENTS_OUTPUT_HEADERS
 
-            INPUT_SETS.each do |req_set_id|
-              input_rows = input_rows_for_set(req_set_id)
-              input_rows.each do |row| # NOTE: use row order from source file
-                row['Req Set'] = req_set_id
-
-                csv << REQUIREMENTS_OUTPUT_HEADERS.map { |header| row.key?(header) ? row[header] : row["#{header}*"]}
+            input_requirement_sets.each do |req_set_id, input_rows|
+              input_rows.each do |input_row| # NOTE: use row order from source file
+                csv << REQUIREMENTS_OUTPUT_HEADERS.map do |header|
+                  header == 'Req Set' ? req_set_id : input_row[header] || input_row["#{header}*"]
+                end
               end
             end
           end
@@ -96,19 +99,13 @@ module InfernoRequirementsTools
           CSV.generate(+"\xEF\xBB\xBF") do |csv| # start with an unnecessary BOM to make viewing in excel easier
             csv << PLANNED_NOT_TESTED_OUTPUT_HEADERS
 
-            INPUT_SETS.each do |req_set_id|
-              input_rows = input_rows_for_set(req_set_id)
-              input_rows.each do |row| # note: use row order from source file
-                not_verifiable = row['Verifiable?']&.downcase == 'no' || row['Verifiable?']&.downcase == 'false'
-                not_tested = row['Planning To Test?']&.downcase == 'no' || row['Planning To Test?']&.downcase == 'false'
-                next unless not_verifiable || not_tested
-
-                csv << [
-                  req_set_id,
-                  row['ID*'],
-                  not_verifiable ? 'Not Verifiable' : 'Not Tested',
-                  not_verifiable ? row['Verifiability Details'] : row['Planning To Test Details']
-                ]
+            input_requirement_sets.each do |req_set_id, input_rows|
+              input_rows.each do |row|
+                if spreadsheet_value_falsy?(row['Verifiable?'])
+                  csv << [req_set_id, row['ID*'], 'Not Verifiable', row['Verifiability Details']]
+                elsif spreadsheet_value_falsy?(row['Planning To Test?'])
+                  csv << [req_set_id, row['ID*'], 'Not Tested', row['Planning To Test Details']]
+                end
               end
             end
           end
@@ -118,22 +115,9 @@ module InfernoRequirementsTools
         @old_planned_not_tested_csv ||= File.read(PLANNED_NOT_TESTED_OUTPUT_FILE)
       end
 
-      def check_for_req_set_files(input_directory)
-        available_worksheets = Dir.glob(File.join(input_directory, '*.xlsx')).reject { |f| f.include?('~$') }
-
-        INPUT_SETS.each do |req_set_id|
-          req_set_file = available_worksheets&.find { |worksheet_file| worksheet_file.include?(req_set_id) }
-
-          if req_set_file&.empty?
-            puts "Could not find input file for set #{req_set_id} in directory #{input_directory}. Aborting requirements collection..."
-            exit(1)
-          end
-          input_file_map[req_set_id] = req_set_file
-        end
-      end
-
       def run(input_directory)
-        check_for_req_set_files(input_directory)
+        @input_directory = input_directory
+        check_presence_of_input_files
 
         update_requirements =
           if File.exist?(REQUIREMENTS_OUTPUT_FILE)
@@ -177,7 +161,8 @@ module InfernoRequirementsTools
       end
 
       def run_check(input_directory)
-        check_for_req_set_files(input_directory)
+        @input_directory = input_directory
+        check_presence_of_input_files
 
         requirements_ok =
           if File.exist?(REQUIREMENTS_OUTPUT_FILE)
@@ -217,6 +202,22 @@ module InfernoRequirementsTools
         MESSAGE
         exit(1)
       end
+
+      def check_presence_of_input_files
+        input_requirement_sets.each do |req_set_id, rows|
+          next unless rows.nil?
+
+          puts %(
+            Could not find input file for set #{req_set_id} in directory #{input_directory}. Aborting requirements
+            collection..."
+          )
+          exit(1)
+        end
+      end
+
+      def spreadsheet_value_falsy?(str)
+        str&.downcase == 'no' || str&.downcase == 'false'
+      end
     end
   end
 end

data/lib/inferno_requirements_tools/tasks/requirements_coverage.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require 'CSV'
+require 'csv'
 require_relative '../ext/inferno_core/runnable'
 
 module InfernoRequirementsTools
@@ -51,12 +51,15 @@ module InfernoRequirementsTools
       INPUT_FILE = File.join('lib', TEST_KIT_CODE_FOLDER, 'requirements', INPUT_FILE_NAME).freeze
       NOT_TESTED_FILE_NAME = "#{TEST_KIT_ID}_out_of_scope_requirements.csv".freeze
       NOT_TESTED_FILE = File.join('lib', TEST_KIT_CODE_FOLDER, 'requirements', NOT_TESTED_FILE_NAME).freeze
+      OUTPUT_HEADERS = INPUT_HEADERS + TEST_SUITES.flat_map do |suite|
+                                         ["#{suite.title} #{SHORT_ID_HEADER}", "#{suite.title} #{FULL_ID_HEADER}"]
+                                       end
       OUTPUT_FILE_NAME = "#{TEST_KIT_ID}_requirements_coverage.csv".freeze
       OUTPUT_FILE = File.join('lib', TEST_KIT_CODE_FOLDER, 'requirements', 'generated', OUTPUT_FILE_NAME).freeze
 
       def input_rows
         @input_rows ||=
-          CSV.parse(File.open(INPUT_FILE, "r:bom|utf-8"), headers: true).map do |row|
+          CSV.parse(File.open(INPUT_FILE, 'r:bom|utf-8'), headers: true).map do |row|
             row.to_h.slice(*INPUT_HEADERS)
           end
       end
@@ -66,12 +69,12 @@ module InfernoRequirementsTools
       end
 
       def load_not_tested_requirements
-        return {} unless File.exists?(NOT_TESTED_FILE)
+        return {} unless File.exist?(NOT_TESTED_FILE)
 
         not_tested_requirements = {}
-        CSV.parse(File.open(NOT_TESTED_FILE, "r:bom|utf-8"), headers: true).each do |row|
+        CSV.parse(File.open(NOT_TESTED_FILE, 'r:bom|utf-8'), headers: true).each do |row|
           row_hash = row.to_h
-          not_tested_requirements[ "#{row_hash['Req Set']}@#{row_hash['ID']}"] = row_hash
+          not_tested_requirements["#{row_hash['Req Set']}@#{row_hash['ID']}"] = row_hash
         end
 
         not_tested_requirements
@@ -95,26 +98,24 @@ module InfernoRequirementsTools
         end
       end
 
+      # rubocop:disable Metrics/CyclomaticComplexity
       def new_csv
         @new_csv ||=
           CSV.generate(+"\xEF\xBB\xBF") do |csv|
-            output_headers = TEST_SUITES.each_with_object(INPUT_HEADERS.dup) do |suite, headers|
-              headers << "#{suite.title} #{SHORT_ID_HEADER}"
-              headers << "#{suite.title} #{FULL_ID_HEADER}"
-            end
-
-            csv << output_headers
-            input_rows.each do |row| # note: use row order from source file
+            csv << OUTPUT_HEADERS
+            input_rows.each do |row| # NOTE: use row order from source file
               next if row['Conformance'] == 'DEPRECATED' # filter out deprecated rows
-              row_actor = row['Actor']
+
               TEST_SUITES.each do |suite|
                 suite_actor = SUITE_ID_TO_ACTOR_MAP[suite.id]
-                if row_actor&.include?(suite_actor)
+                if row['Actor']&.include?(suite_actor)
                   set_and_req_id = "#{row['Req Set']}@#{row['ID']}"
-                  suite_requirement_items = inferno_requirements_map[set_and_req_id]&.filter { |item| item[:suite_id] == suite.id}
+                  suite_requirement_items = inferno_requirements_map[set_and_req_id]&.filter do |item|
+                    item[:suite_id] == suite.id
+                  end
                   short_ids = suite_requirement_items&.map { |item| item[:short_id] }
                   full_ids = suite_requirement_items&.map { |item| item[:full_id] }
-                  if short_ids.blank? && not_tested_requirements_map.has_key?(set_and_req_id)
+                  if short_ids.blank? && not_tested_requirements_map.key?(set_and_req_id)
                     row["#{suite.title} #{SHORT_ID_HEADER}"] = 'Not Tested'
                     row["#{suite.title} #{FULL_ID_HEADER}"] = 'Not Tested'
                   else
@@ -131,6 +132,7 @@ module InfernoRequirementsTools
             end
           end
       end
+      # rubocop:enable Metrics/CyclomaticComplexity
 
       def input_requirement_ids
         @input_requirement_ids ||= input_rows.map { |row| "#{row['Req Set']}@#{row['ID']}" }
@@ -138,9 +140,7 @@ module InfernoRequirementsTools
 
       # The requirements present in Inferno that aren't in the input spreadsheet
       def unmatched_requirements_map
-        @unmatched_requirements_map ||= inferno_requirements_map.filter do |requirement_id, _|
-          !input_requirement_ids.include?(requirement_id)
-        end
+        @unmatched_requirements_map ||= inferno_requirements_map.except(*input_requirement_ids)
       end
 
       def old_csv
@@ -233,6 +233,8 @@ module InfernoRequirementsTools
       # ---------------+------------+----------
       # req-id-1       | short-id-1 | full-id-1
       # req-id-2       | short-id-2 | full-id-2
+      #
+      # rubocop:disable Metrics/CyclomaticComplexity
       def output_requirements_map_table(requirements_map)
         headers = %w[requirement_id short_id full_id]
         col_widths = headers.map(&:length)
@@ -258,6 +260,7 @@ module InfernoRequirementsTools
         end
         puts
       end
+      # rubocop:enable Metrics/CyclomaticComplexity
     end
   end
 end

data/lib/subscriptions_test_kit/common/notification_conformance_verification.rb

@@ -32,9 +32,11 @@ module SubscriptionsTestKit
 
       unless subscription_status_entry.request.present? &&
              (
-               subscription_id ?
-                 subscription_status_entry.request.url.end_with?("Subscription/#{subscription_id}/$status") :
+               if subscription_id
+                 subscription_status_entry.request.url.end_with?("Subscription/#{subscription_id}/$status")
+               else
                  subscription_status_entry.request.url.match?(%r{Subscription/[^/]+/\$status\z})
+               end
              )
 
         add_message('error',
@@ -148,8 +150,14 @@ module SubscriptionsTestKit
     end
 
     def check_bundle_entry_reference(bundle_entries, reference)
+      check_full_url = reference.start_with?('urn:')
+
       referenced_entry = bundle_entries.find do |entry|
-        reference.include?("#{entry.resource.resourceType}/#{entry.resource.id}")
+        if check_full_url
+          reference == entry.fullUrl
+        else
+          reference.include?("#{entry.resource.resourceType}/#{entry.resource.id}")
+        end
       end
       referenced_entry.present?
     end
@@ -224,15 +232,6 @@ module SubscriptionsTestKit
           resource in the entry.resource element.))
     end
 
-    def subscription_criteria(subscription)
-      return unless subscription['_criteria']
-
-      criteria_extension = subscription['_criteria']['extension'].find do |ext|
-        ext['url'].ends_with?('/backport-filter-criteria')
-      end
-      criteria_extension['valueString'].split('?').first
-    end
-
     def empty_event_notification_verification(notification_bundle)
       assert_valid_json(notification_bundle)
       bundle = FHIR.from_contents(notification_bundle)

data/lib/subscriptions_test_kit/common/subscription_conformance_verification.rb

@@ -37,6 +37,13 @@ module SubscriptionsTestKit
       end
     end
 
+    def valid_url?(url)
+      uri = URI.parse(url)
+      uri.is_a?(URI::HTTP) && !uri.host.nil?
+    rescue URI::InvalidURIError
+      false
+    end
+
     def subscription_verification(subscription_resource)
       assert_valid_json(subscription_resource)
       subscription = JSON.parse(subscription_resource)
@@ -46,6 +53,11 @@ module SubscriptionsTestKit
         The `type` field on the Subscription resource must be set to `rest-hook`, the `#{subscription_channel['type']}`
         channel type is unsupported.))
 
+      unless subscription['criteria'].present? && valid_url?(subscription['criteria'])
+        add_message('error', %(
+                    'The `criteria` field SHALL be populated and contain the canonical URL for the Subscription Topic.'
+                    ))
+      end
       subscription_resource = FHIR.from_contents(subscription.to_json)
       assert_resource_type('Subscription', resource: subscription_resource)
       assert_valid_resource(resource: subscription_resource,
@@ -77,8 +89,8 @@ module SubscriptionsTestKit
           Added the Authorization header field with a Bearer token set to #{access_token} to the `header` field on the
           Subscription resource in order to connect successfully with the Inferno subscription channel.
         ))
-        subscription['header'] = [] unless subscription['header'].present?
-        subscription['header'].append("Authorization: Bearer #{access_token}")
+        subscription_channel['header'] = [] unless subscription_channel['header'].present?
+        subscription_channel['header'].append("Authorization: Bearer #{access_token}")
       end
       subscription['channel'] = subscription_channel
       subscription

data/lib/subscriptions_test_kit/docs/samples/Subscription_empty.json

@@ -11,7 +11,7 @@
     "_criteria" : {
       "extension" : [{
         "url" : "http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria",
-        "valueString" : "Encounter?patient=Patient/123"
+        "valueString" : "Encounter.patient=Patient/123"
       }]
     },
     "channel" : {

data/lib/subscriptions_test_kit/docs/samples/Subscription_full-resource.json

@@ -11,7 +11,7 @@
     "_criteria" : {
       "extension" : [{
         "url" : "http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria",
-        "valueString" : "Encounter?patient=Patient/123"
+        "valueString" : "Encounter.patient=Patient/123"
       }]
     },
     "channel" : {

data/lib/subscriptions_test_kit/docs/samples/Subscription_id-only.json

@@ -12,7 +12,7 @@
     "_criteria" : {
       "extension" : [{
         "url" : "http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-filter-criteria",
-        "valueString" : "Encounter?patient=Patient/123"
+        "valueString" : "Encounter.patient=Patient/123"
       }]
     },
     "channel" : {

data/lib/subscriptions_test_kit/docs/subscriptions_r5_backport_r4_client_suite_description.md

@@ -117,4 +117,7 @@ Specific limitations to highlight include
   [provide feedback](https://github.com/inferno-framework/subscriptions-test-kit/issues) to that effect.
 - Inferno does not test delivery error handling and recovery scenarios, including
   the optional `$events` API and event numbering details.
-- Inferno does not support sending heartbeat notifications.
+- Inferno does not support sending heartbeat notifications.
+- Inferno does not verify that the shape and content of notifications are appropriate for the triggering
+  Subscription because those details, e.g., the resource types that can be a focus of the notification, 
+  are defined within the SubscriptionTopic which is not available in FHIR R4.

data/lib/subscriptions_test_kit/docs/subscriptions_r5_backport_r4_server_suite_description.md

@@ -167,4 +167,7 @@ Specific limitations to highlight include
   If there is a channel type that you would like to see verified, please 
   [provide feedback](https://github.com/inferno-framework/subscriptions-test-kit/issues) to that effect.
 - Inferno does not test delivery error handling and recovery scenarios, including
-  the optional `$events` API and event numbering details.
+  the optional `$events` API and event numbering details.
+- Inferno does not verify that the shape and content of notifications are appropriate for the triggering
+  Subscription because those details, e.g., the resource types that can be a focus of the notification, 
+  are defined within the SubscriptionTopic which is not available in FHIR R4.

data/lib/subscriptions_test_kit/endpoints/subscription_create_endpoint.rb

@@ -32,7 +32,7 @@ module SubscriptionsTestKit
       existing_subscription_request = requests.find { |r| r.status == 201 }
       if existing_subscription_request.present?
         subscription_hash = JSON.parse(existing_subscription_request.response_body)
-        error_text = 'Inferno only supports one subscription per test run. Subscription already created with '\
+        error_text = 'Inferno only supports one subscription per test run. Subscription already created with ' \
                      "ID #{subscription_hash['id']}"
         response.body = operation_outcome('error', 'business-rule', error_text).to_json
         return
@@ -74,10 +74,14 @@ module SubscriptionsTestKit
         return operation_outcome('error', 'value', 'channel.endpoint is not recognized as a conformant URL')
       end
 
-      heartbeat_period = subscription.channel&.extension&.find do |e|
+      heartbeat_period = find_heartbeat_period(subscription)
+      operation_outcome('error', 'not-supported', 'heartbeatPeriod is not supported') unless heartbeat_period.nil?
+    end
+
+    def find_heartbeat_period(subscription)
+      subscription&.channel&.extension&.find do |e|
         e.url == 'http://hl7.org/fhir/uv/subscriptions-backport/StructureDefinition/backport-heartbeat-period'
       end
-      operation_outcome('error', 'not-supported', 'heartbeatPeriod is not supported') unless heartbeat_period.nil?
     end
 
     def valid_url?(url)

data/lib/subscriptions_test_kit/endpoints/subscription_status_endpoint.rb

@@ -30,28 +30,30 @@ module SubscriptionsTestKit
           return
         end
 
-        id_params = params&.parameter&.filter { |p| p.name == 'id' }
-
-        if id_params&.any? && id_params&.none? { |p| p.valueString == subscription.id }
+        unless subscription_params_match?(params)
           not_found
           return
-        else
-          status_params = params&.parameter&.filter { |p| p.name == 'status' }
-          subscription_status = determine_subscription_status_code(subscription.id)
-          if status_params&.any? && status_params.none? { |p| p.valueString == subscription_status }
-            not_found
-            return
-          end
         end
       end
 
       notification_json = notification_bundle_input(result)
       subscription_url = "#{base_subscription_url}/#{subscription.id}"
+      subscription_topic = subscription.criteria
       status_code = determine_subscription_status_code(subscription_id)
       event_count = determine_event_count(test_run.test_session_id)
       response.status = 200
-      response.body = derive_status_bundle(notification_json, subscription_url, status_code, event_count,
-                                           request.url).to_json
+      response.body = derive_status_bundle(notification_json, subscription_url, subscription_topic, status_code,
+                                           event_count, request.url).to_json
+    end
+
+    def subscription_params_match?(params)
+      id_params = find_params(params, 'id')
+
+      return false if id_params&.any? && id_params&.none? { |p| p.valueString == subscription.id }
+
+      status_params = find_params(params, 'status')
+      subscription_status = determine_subscription_status_code(subscription.id)
+      status_params.nil? || status_params.none? || status_params.any { p.valueString == subscription_status }
     end
 
     def tags
@@ -63,8 +65,12 @@ module SubscriptionsTestKit
       response.body = operation_outcome('error', 'not-found').to_json
     end
 
+    def find_params(params, name)
+      params&.parameter&.filter { |p| p.name == name }
+    end
+
     def base_subscription_url
-      request.url.sub(%r{(#{Regexp.escape(FHIR_SUBSCRIPTION_PATH)}).*}, '\1')
+      request.url.sub(/(#{Regexp.escape(FHIR_SUBSCRIPTION_PATH)}).*/, '\1')
     end
   end
 end

data/lib/subscriptions_test_kit/jobs/send_subscription_notifications.rb

@@ -74,6 +74,10 @@ module SubscriptionsTestKit
         @authorization_header ||= @bearer_token.present? ? { 'Authorization' => "Bearer #{@bearer_token}" } : {}
       end
 
+      def subscription_topic
+        @subscription_topic ||= subscription&.criteria
+      end
+
       def test_still_waiting?
         results_repo.find_waiting_result(test_run_id: @test_run_id)
       end
@@ -83,14 +87,15 @@ module SubscriptionsTestKit
       end
 
       def send_handshake_notification
-        handshake_json = derive_handshake_notification(@notification_json, @subscription_url).to_json
+        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])
         resume_inferno_test unless response.status == 200
       end
 
       def send_event_notification
-        event_json = derive_event_notification(@notification_json, @subscription_url, 1).to_json
+        event_json = derive_event_notification(@notification_json, @subscription_url, subscription_topic, 1).to_json
         response = send_notification(event_json)
         persist_notification_request(response, [REST_HOOK_EVENT_NOTIFICATION_TAG])
       end