carin_for_blue_button_test_kit 0.11.2 → 0.12.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7fe7e5322b59bb22f9fa5c80463d11519e3e5a5876c218abf7a8bfc327bd1fcc
-  data.tar.gz: f986c0b7057666bd549adbc88c11d4152a9771de3b9ad452be6c4bf7993b27cd
+  metadata.gz: 64361067f120249c1ee01c85806474242013e54242635f81b5f7cf2f2e0b1992
+  data.tar.gz: 796e6f5f879a90a7cb8e0fd885852f177d98fd88780c31590a7fc4090e0eecf5
 SHA512:
-  metadata.gz: fc631b79eae5409a1d3c530da8bb21eed74d4c4d7a7b1794f0516248a293cbaa96e0e4461ca155f0a24a0c94eed652308bba7f006e246b814648b81ad156a4f2
-  data.tar.gz: fed9f8456cd6fa043fca8d1b751d38921b20e711e90f564d0791bb9faf919df20c790e4cb7708d0f9e177507f21f8c527d8ca3906e18369f356ea4f3ba1e5def
+  metadata.gz: 80496d24d7473e13e90e9485f494454aa3a90b67047663cfb69298bb4e41f96c2c3800a31a6b099b4077d2a935e6da18475db91baabcf9cc69684857619b7eb4
+  data.tar.gz: 2d0e6083bf8e6e78292c69d3a6a6968ad680564cead0ba4f3bc34aeafaa4950bb834b2aab15070167cae3988790442b4039c1fd4f126ce8ca0b1b76dcc292c4f

data/lib/carin_for_blue_button_test_kit/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module CarinForBlueButtonTestKit
-  VERSION = '0.11.2'
+  VERSION = '0.12.1'
 end

data/lib/carin_for_blue_button_test_kit.rb

@@ -1,3 +1,4 @@
+require_relative 'inferno_requirements_tools/ext/inferno_core/runnable'
 require_relative 'carin_for_blue_button_test_kit/generated/v1.1.0/c4bb_test_suite'
 require_relative 'carin_for_blue_button_test_kit/generated/v2.0.0/c4bb_test_suite'
 require_relative 'carin_for_blue_button_test_kit/generated/v2.0.0-dev-nonfinancial/c4bb_test_suite'

data/lib/inferno_requirements_tools/ext/inferno_core/runnable.rb

@@ -0,0 +1,22 @@
+module Inferno
+  module DSL
+    # This module contains the DSL for defining child entities in the test
+    # definition framework.
+    module Runnable
+      # Set/Get the IDs of requirements verifed by this runnable
+      # Set with [] to clear the list
+      #
+      # @param requirements [Array<String>]
+      # @return [Array<String>] the requirement IDs
+      def verifies_requirements(*requirement_ids)
+        if requirement_ids.empty?
+          @requirement_ids || []
+        elsif requirement_ids == [[]]
+          @requirement_ids = []
+        else
+          @requirement_ids = requirement_ids
+        end
+      end
+    end
+  end
+end

data/lib/inferno_requirements_tools/tasks/collect_requirements.rb

@@ -0,0 +1,196 @@
+# frozen_string_literal: true
+
+require 'CSV'
+require 'roo'
+
+module InfernoRequirementsTools
+  module Tasks
+    # This class manages the collection of requirements details from
+    # requirements planning excel workbooks into a CSV representation.
+    # Currently splits out Requirements and Planned Not Tested Requirements
+    # into two separate files.
+    #
+    # The `run_check` method will check whether the previously generated file is up-to-date.
+    class CollectRequirements
+      # Update these constants based on the test kit.
+      TEST_KIT_ID = 'carin-for-blue-button-test-kit'
+      INPUT_SETS = ['hl7.fhir.us.carin-bb_2.0.0'].freeze
+
+      # Derivative constants
+      TEST_KIT_CODE_FOLDER = TEST_KIT_ID.gsub('-', '_')
+      INPUT_HEADERS = ['ID*', 'URL*', 'Requirement*', 'Conformance*', 'Actor*', 'Sub-Requirement(s)', 'Conditionality',
+                       'Verifiable?', 'Verifiability Details', 'Planning To Test?', 'Planning To Test Details'].freeze
+      REQUIREMENTS_OUTPUT_HEADERS = ['Req Set', 'ID', 'URL', 'Requirement', 'Conformance', 'Actor',
+                                     'Sub-Requirement(s)', 'Conditionality'].freeze
+      REQUIREMENTS_OUTPUT_FILE_NAME = "#{TEST_KIT_ID}_requirements.csv"
+      REQUIREMENTS_OUTPUT_FILE = File.join('lib', TEST_KIT_CODE_FOLDER, 'requirements',
+                                           REQUIREMENTS_OUTPUT_FILE_NAME).freeze
+      PLANNED_NOT_TESTED_OUTPUT_HEADERS = ['Req Set', 'ID', 'Reason', 'Details'].freeze
+      PLANNED_NOT_TESTED_OUTPUT_FILE_NAME = "#{TEST_KIT_ID}_out_of_scope_requirements.csv"
+      PLANNED_NOT_TESTED_OUTPUT_FILE = File.join('lib', TEST_KIT_CODE_FOLDER, 'requirements',
+                                                 PLANNED_NOT_TESTED_OUTPUT_FILE_NAME).freeze
+      BOM = "\xEF\xBB\xBF"
+
+      def input_file_map
+        @input_file_map ||= {}
+      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)
+        end
+      end
+
+      def new_requirements_csv
+        @new_requirements_csv ||=
+          CSV.generate do |csv|
+            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 do |header|
+                  row.has_key?(header) ? row[header] : row["#{header}*"]
+                end
+              end
+            end
+          end
+      end
+
+      def old_requirements_csv
+        @old_requirements_csv ||= File.read(REQUIREMENTS_OUTPUT_FILE)
+      end
+
+      def new_planned_not_tested_csv
+        @new_planned_not_tested_csv ||=
+          CSV.generate do |csv|
+            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']]
+              end
+            end
+          end
+      end
+
+      def old_planned_not_tested_csv
+        @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)
+
+        update_requirements = if File.exist?(REQUIREMENTS_OUTPUT_FILE)
+                                if old_requirements_csv == (BOM + new_requirements_csv)
+                                  puts "'#{REQUIREMENTS_OUTPUT_FILE_NAME}' file is up to date."
+                                  false
+                                else
+                                  puts 'Requirements set has changed.'
+                                  true
+                                end
+                              else
+                                puts "No existing #{REQUIREMENTS_OUTPUT_FILE_NAME}."
+                                true
+                              end
+        if update_requirements
+          puts "Writing to file #{REQUIREMENTS_OUTPUT_FILE}..."
+          File.write(REQUIREMENTS_OUTPUT_FILE, BOM + new_requirements_csv, encoding: Encoding::UTF_8)
+        end
+
+        udpate_planned_not_tested = if File.exist?(PLANNED_NOT_TESTED_OUTPUT_FILE)
+                                      if old_planned_not_tested_csv == (BOM + new_planned_not_tested_csv)
+                                        puts "'#{PLANNED_NOT_TESTED_OUTPUT_FILE_NAME}' file is up to date."
+                                        false
+                                      else
+                                        puts 'Planned Not Tested Requirements set has changed.'
+                                        true
+                                      end
+                                    else
+                                      puts "No existing #{PLANNED_NOT_TESTED_OUTPUT_FILE_NAME}."
+                                      true
+                                    end
+        if udpate_planned_not_tested
+          puts "Writing to file #{PLANNED_NOT_TESTED_OUTPUT_FILE}..."
+          File.write(PLANNED_NOT_TESTED_OUTPUT_FILE, BOM + new_planned_not_tested_csv, encoding: Encoding::UTF_8)
+        end
+
+        puts 'Done.'
+      end
+
+      def run_check(input_directory)
+        check_for_req_set_files(input_directory)
+
+        requirements_ok = if File.exist?(REQUIREMENTS_OUTPUT_FILE)
+                            if old_requirements_csv == (BOM + new_requirements_csv)
+                              puts "'#{REQUIREMENTS_OUTPUT_FILE_NAME}' file is up to date."
+                              true
+                            else
+                              puts "#{REQUIREMENTS_OUTPUT_FILE_NAME} file is out of date."
+                              false
+                            end
+                          else
+                            puts "No existing #{REQUIREMENTS_OUTPUT_FILE_NAME} file."
+                            false
+                          end
+
+        planned_not_tested_requirements_ok = if File.exist?(PLANNED_NOT_TESTED_OUTPUT_FILE)
+                                               if old_planned_not_tested_csv == (BOM + new_planned_not_tested_csv)
+                                                 puts "'#{PLANNED_NOT_TESTED_OUTPUT_FILE_NAME}' file is up to date."
+                                                 true
+                                               else
+                                                 puts "#{PLANNED_NOT_TESTED_OUTPUT_FILE_NAME} file is out of date."
+                                                 false
+                                               end
+                                             else
+                                               puts "No existing #{PLANNED_NOT_TESTED_OUTPUT_FILE_NAME} file."
+                                               false
+                                             end
+
+        return if planned_not_tested_requirements_ok && requirements_ok
+
+        puts <<~MESSAGE
+          Check Failed. To resolve, run:
+
+                bundle exec rake "requirements:collect_requirements[<input_directory>]"
+
+        MESSAGE
+        exit(1)
+      end
+    end
+  end
+end

data/lib/inferno_requirements_tools/tasks/map_requirements.rb

@@ -0,0 +1,253 @@
+# frozen_string_literal: true
+
+require 'CSV'
+require 'roo'
+require_relative '../ext/inferno_core/runnable'
+
+module InfernoRequirementsTools
+  module Tasks
+    # This class manages the mapping of IG requirements to test kit tests.
+    # It expects a CSV file in the repo at lib/carin_for_blue_button_test_kit/requirements/Requirements.csv
+    # This file must have a column with the header 'ID' which holds user-designated IDs for each requirement.
+    # These requirement IDs must map to the IDs specified in the test kit using `verifies_requirements`
+    #
+    # The `run` method generates a CSV file at lib/carin_for_blue_button_test_kit/requirements/Requirements_Coverage.csv.
+    # This file will be identical to the input spreadsheet, plus an additional column which holds a comma separated
+    # list of inferno test IDs that test each requirement. These test IDs are Inferno short form IDs that represent the
+    # position of the test within its group and suite. For example, the fifth test in the second group will have an ID
+    # of 2.05. This ID is also shown in the Inferno web UI.
+    # The output file is also sorted by requirement ID.
+    #
+    # The `run_check` method will check whether the previously generated file is up-to-date.
+    class MapRequirements
+      # Update these constants based on the test kit.
+      TEST_KIT_ID = 'carin-for-blue-button-test-kit'
+      TEST_SUITES = [CarinForBlueButtonTestKit::CARIN4BBV200::C4BBTestSuite].freeze # list of suite classes
+      SUITE_ID_TO_ACTOR_MAP = {
+        'c4bb_v200' => 'Health Plan'
+      }.freeze
+
+      # Derivative constants
+      TEST_KIT_CODE_FOLDER = TEST_KIT_ID.gsub('-', '_')
+      INPUT_HEADERS = ['Req Set', 'ID', 'URL', 'Requirement', 'Conformance', 'Actor', 'Sub-Requirement(s)',
+                       'Conditionality'].freeze
+      SHORT_ID_HEADER = 'Short ID(s)'
+      FULL_ID_HEADER = 'Full ID(s)'
+      INPUT_FILE_NAME = "#{TEST_KIT_ID}_requirements.csv"
+      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"
+      NOT_TESTED_FILE = File.join('lib', TEST_KIT_CODE_FOLDER, 'requirements', NOT_TESTED_FILE_NAME).freeze
+      OUTPUT_FILE_NAME = "#{TEST_KIT_ID}_requirements_coverage.csv"
+      OUTPUT_FILE_DIRECTORY = File.join('lib', TEST_KIT_CODE_FOLDER, 'requirements', 'generated').freeze
+      OUTPUT_FILE = File.join(OUTPUT_FILE_DIRECTORY, OUTPUT_FILE_NAME).freeze
+      BOM = "\xEF\xBB\xBF"
+
+      def input_rows
+        @input_rows ||=
+          CSV.parse(File.open(INPUT_FILE, 'r:bom|utf-8'), headers: true).map do |row|
+            row.to_h.slice(*INPUT_HEADERS)
+          end
+      end
+
+      def not_tested_requirements_map
+        @not_tested_requirements_map ||= load_not_tested_requirements
+      end
+
+      def load_not_tested_requirements
+        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|
+          row_hash = row.to_h
+          not_tested_requirements["#{row_hash['Req Set']}##{row_hash['ID']}"] = row_hash
+        end
+
+        not_tested_requirements
+      end
+
+      # Of the form:
+      # {
+      #     'req-id-1': [
+      #       { short_id: 'short-id-1', full_id: 'long-id-1', suite_id: 'suite-id-1' },
+      #       { short_id: 'short-id-2', full_id: 'long-id-2', suite_id: 'suite-id-2' }
+      #     ],
+      #     'req-id-2': [{ short_id: 'short-id-3', full_id: 'long-id-3', suite_id: 'suite-id-3' }],
+      #     ...
+      # }
+      def inferno_requirements_map
+        @inferno_requirements_map ||= TEST_SUITES.each_with_object({}) do |suite, requirements_map|
+          serialize_requirements(suite, 'suite', suite.id, requirements_map)
+          suite.groups.each do |group|
+            map_group_requirements(group, suite.id, requirements_map)
+          end
+        end
+      end
+
+      def new_csv
+        @new_csv ||=
+          CSV.generate 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
+              row_actor = row['Actor']
+              TEST_SUITES.each do |suite|
+                suite_actor = SUITE_ID_TO_ACTOR_MAP[suite.id]
+                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 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)
+                    row["#{suite.title} #{SHORT_ID_HEADER}"] = 'Not Tested'
+                    row["#{suite.title} #{FULL_ID_HEADER}"] = 'Not Tested'
+                  else
+                    row["#{suite.title} #{SHORT_ID_HEADER}"] = short_ids&.join(', ')
+                    row["#{suite.title} #{FULL_ID_HEADER}"] = full_ids&.join(', ')
+                  end
+                else
+                  row["#{suite.title} #{SHORT_ID_HEADER}"] = 'NA'
+                  row["#{suite.title} #{FULL_ID_HEADER}"] = 'NA'
+                end
+              end
+
+              csv << row.values
+            end
+          end
+      end
+
+      def input_requirement_ids
+        @input_requirement_ids ||= input_rows.map { |row| "#{row['Req Set']}##{row['ID']}" }
+      end
+
+      # 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
+      end
+
+      def old_csv
+        @old_csv ||= File.read(OUTPUT_FILE)
+      end
+
+      def run
+        unless File.exist?(INPUT_FILE)
+          puts "Could not find input file: #{INPUT_FILE}. Aborting requirements mapping..."
+          exit(1)
+        end
+
+        if unmatched_requirements_map.any?
+          puts "WARNING: The following requirements indicated in the test kit are not present in #{INPUT_FILE_NAME}"
+          output_requirements_map_table(unmatched_requirements_map)
+        end
+
+        if File.exist?(OUTPUT_FILE)
+          if old_csv == (BOM + new_csv)
+            puts "'#{OUTPUT_FILE_NAME}' file is up to date."
+            return
+          else
+            puts 'Requirements mapping has changed.'
+          end
+        else
+          puts "No existing #{OUTPUT_FILE_NAME}."
+        end
+
+        puts "Writing to file #{OUTPUT_FILE}..."
+        FileUtils.mkdir_p(OUTPUT_FILE_DIRECTORY)
+        File.write(OUTPUT_FILE, BOM + new_csv)
+        puts 'Done.'
+      end
+
+      def run_check
+        unless File.exist?(INPUT_FILE)
+          puts "Could not find input file: #{INPUT_FILE}. Aborting requirements mapping check..."
+          exit(1)
+        end
+
+        if unmatched_requirements_map.any?
+          puts "The following requirements indicated in the test kit are not present in #{INPUT_FILE_NAME}"
+          output_requirements_map_table(unmatched_requirements_map)
+        end
+
+        if File.exist?(OUTPUT_FILE)
+          if old_csv == (BOM + new_csv)
+            puts "'#{OUTPUT_FILE_NAME}' file is up to date."
+            return unless unmatched_requirements_map.any?
+          else
+            puts <<~MESSAGE
+              #{OUTPUT_FILE_NAME} file is out of date.
+              To regenerate the file, run:
+
+                  bundle exec rake requirements:map_requirements
+
+            MESSAGE
+          end
+        else
+          puts <<~MESSAGE
+            No existing #{OUTPUT_FILE_NAME} file.
+            To generate the file, run:
+
+                  bundle exec rake requirementss:map_requirements
+
+          MESSAGE
+        end
+
+        puts 'Check failed.'
+        exit(1)
+      end
+
+      def map_group_requirements(group, suite_id, requirements_map)
+        serialize_requirements(group, group.short_id, suite_id, requirements_map)
+        group.tests&.each { |test| serialize_requirements(test, test.short_id, suite_id, requirements_map) }
+        group.groups&.each { |subgroup| map_group_requirements(subgroup, suite_id, requirements_map) }
+      end
+
+      def serialize_requirements(runnable, short_id, suite_id, requirements_map)
+        runnable.verifies_requirements&.each do |requirement_id|
+          requirement_id_string = requirement_id.to_s
+
+          requirements_map[requirement_id_string] ||= []
+          requirements_map[requirement_id_string] << { short_id:, full_id: runnable.id, suite_id: }
+        end
+      end
+
+      # Output the requirements in the map like so:
+      #
+      # requirement_id | short_id   | full_id
+      # ---------------+------------+----------
+      # req-id-1       | short-id-1 | full-id-1
+      # req-id-2       | short-id-2 | full-id-2
+      def output_requirements_map_table(requirements_map)
+        headers = %w[requirement_id short_id full_id]
+        col_widths = headers.map(&:length)
+        col_widths[0] = [col_widths[0], requirements_map.keys.map(&:length).max].max
+        col_widths[1] = ([col_widths[1]] + requirements_map.values.flatten.map { |item| item[:short_id].length }).max
+        col_widths[2] = ([col_widths[2]] + requirements_map.values.flatten.map { |item| item[:full_id].length }).max
+        col_widths.map { |width| width + 3 }
+
+        puts [
+          headers[0].ljust(col_widths[0]),
+          headers[1].ljust(col_widths[1]),
+          headers[2].ljust(col_widths[2])
+        ].join(' | ')
+        puts col_widths.map { |width| '-' * width }.join('-+-')
+        requirements_map.each do |requirement_id, runnables|
+          runnables.each do |runnable|
+            puts [
+              requirement_id.ljust(col_widths[0]),
+              runnable[:short_id].ljust(col_widths[1]),
+              runnable[:full_id].ljust(col_widths[2])
+            ].join(' | ')
+          end
+        end
+        puts
+      end
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: carin_for_blue_button_test_kit
 version: !ruby/object:Gem::Version
-  version: 0.11.2
+  version: 0.12.1
 platform: ruby
 authors:
 - John Morrison
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-05 00:00:00.000000000 Z
+date: 2024-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: inferno_core
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.37
+        version: 0.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.37
+        version: 0.5.0
 - !ruby/object:Gem::Dependency
   name: smart_app_launch_test_kit
   requirement: !ruby/object:Gem::Requirement
@@ -663,6 +663,9 @@ files:
 - lib/carin_for_blue_button_test_kit/search_test_properties.rb
 - lib/carin_for_blue_button_test_kit/validation_test.rb
 - lib/carin_for_blue_button_test_kit/version.rb
+- lib/inferno_requirements_tools/ext/inferno_core/runnable.rb
+- lib/inferno_requirements_tools/tasks/collect_requirements.rb
+- lib/inferno_requirements_tools/tasks/map_requirements.rb
 homepage: https://github.com/inferno-framework/carin-for-blue-button-test-kit
 licenses:
 - Apache-2.0