subscriptions_test_kit 0.9.1 → 0.9.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b454299711c0f4302d2ad697d80a0328b991b8038f11438924e2fd7f31b19410
-  data.tar.gz: b76603067163a9e869f856e5b8ea65dcad6f89c9341d1b9849840e4d963f9bb0
+  metadata.gz: ad5fae1148d468463f60e61a0e7c273b90eac5294b1c8d19b588288d3d53ca77
+  data.tar.gz: 62507f2c4a5cc9e39c1906bbb10032d1baa00b8ec33055762016c5ce2d22722c
 SHA512:
-  metadata.gz: 0070d84e30ddf1c66830d58b2ce17a3ad1c4bb3a5936b94103d0eca599fc99ef539b62decf0be64037f25c8b43f031f057a7a9b956921d86d8bc4a1ac6e2b67f
-  data.tar.gz: 80889129d6e02d53797466a4b4efa95e55eb03b75bb838f9a340d12be7c4bbb6855bca05aafcf54b7fb1ee3370642624117f887fe55ee9b5a88cc6a8e48f9f8d
+  metadata.gz: bad58bc3cdcb1c451bcb28f5dfbe8a5492e5cc8fff49b00f99d35d93588cec7936feeedee3c24984d6c1090ade8f92b35da4c89d83fd8036586f539cd0296ad7
+  data.tar.gz: f26d5875e051b95b24dabc7f45cdba4b9bda8631f76f022aa1e753569e89be8fd264b052ac9662855023c2f685ad9b4ac5473732b8d7538b32d7a2db819e2e6b

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',

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,18 +30,9 @@ 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
 
@@ -54,6 +45,16 @@ module SubscriptionsTestKit
                                            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
       [SUBSCRIPTION_STATUS_TAG]
     end
@@ -63,8 +64,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