inferno_core 0.6.11 → 0.6.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b899985c0f229c1f91aa9218d09f9f502ed315c537398edc911e989cbe61c6a8
-  data.tar.gz: '08cca457d4bb79bdb70487a14fa07f8274dac19faae5623bedef8797541e993b'
+  metadata.gz: a7e5f22313a778dd7b70ba70eae9513bda158a7c0cd6beba9a2d195b3a37f077
+  data.tar.gz: 8e7d6155fad17e00ccc48257853f4df2cc816d0965cc0b18a50515bbd26d343f
 SHA512:
-  metadata.gz: 36b765180f9d7168c91238e1c7a63e8cc281f3a795f068e3d6ddb317d419d90dc2401585b8fde37e3d27c0c82fda9ef66dba3c6bd96201f1dafa9d3be301b53f
-  data.tar.gz: d83ffd4c0fec0cf1d3621a7f563c9d369d671bfce5f11c9bdcac9f287c5918a3c37f3ff340cd3429b4dbb1e96e9daa936ce50fe4bd889420cb66c0a41020a777
+  metadata.gz: 56b26537ac370a6b475ab33895ad91e3d5cf5ff588cd3fa5be979c6e250e5aa703a76c093ea46c787ecd2c4f061f1f55e39c43ba245219618c18b9a44e522f3e
+  data.tar.gz: a1549f23c6e8c501286bc490c6821be19da1a730b950a497bdd7a2c7d61c392090e0ac1603f251e4d033abedbc4457e1dfcbf7ecac5bcfcd875392e7125ca4ef

data/lib/inferno/apps/cli/evaluate.rb

@@ -27,10 +27,11 @@ module Inferno
 
         ig_path = absolute_path_with_home_expansion(ig_path)
         data_path = absolute_path_with_home_expansion(data_path) if data_path
+        config_path = absolute_path_with_home_expansion(options[:config]) if options[:config]
 
         Dir.chdir(tmpdir) do
           Migration.new.run(Logger::FATAL) # Hide migration output for evaluator
-          evaluate(ig_path, data_path, options)
+          evaluate(ig_path, data_path, config_path, options)
         end
       ensure
         system("#{services_base_command} down #{services_names}")
@@ -57,14 +58,14 @@ module Inferno
       end
 
       # @see Inferno::CLI::Main#evaluate
-      def evaluate(ig_path, data_path, options)
+      def evaluate(ig_path, data_path, config_path, options)
         # NOTE: repositories is required here rather than at the top of the file because
         # the tree of requires means that this file and its requires get required by every CLI app.
         # Sequel::Model, used in some repositories, fetches the table schema at instantiation.
         # This breaks the `migrate` task by fetching a table before the task runs/creates it.
         require_relative '../../repositories'
 
-        validate_args(ig_path, data_path)
+        validate_args(ig_path, data_path, config_path)
         ig = Inferno::Repositories::IGs.new.find_or_load(ig_path)
 
         check_ig_version(ig)
@@ -80,17 +81,17 @@ module Inferno
 
         evaluator = Inferno::DSL::FHIREvaluation::Evaluator.new(ig, validator)
 
-        config = Inferno::DSL::FHIREvaluation::Config.new
+        config = Inferno::DSL::FHIREvaluation::Config.new(config_path)
         results = evaluator.evaluate(data, config)
         output_results(results, options[:output])
       end
 
-      def validate_args(ig_path, data_path)
+      def validate_args(ig_path, data_path, config_path)
         raise 'A path to an IG is required!' unless ig_path
 
-        return unless data_path && (!File.directory? data_path)
+        raise "Provided path '#{data_path}' is not a directory" if data_path && (!File.directory? data_path)
 
-        raise "Provided path '#{data_path}' is not a directory"
+        raise "Provided path '#{config_path}' does not exist" if config_path && (!File.exist? config_path)
       end
 
       def check_ig_version(ig)

data/lib/inferno/apps/cli/main.rb

@@ -6,8 +6,8 @@ require_relative 'services'
 require_relative 'suite'
 require_relative 'suites'
 require_relative 'new'
-require_relative '../../version'
 require_relative 'execute'
+require_relative '../../version'
 
 module Inferno
   module CLI
@@ -34,6 +34,9 @@ module Inferno
 
         # Loads the us core ig and evaluate the data included in the IG's example folder, with results redirected to outcome.json as an OperationOutcome
         `bundle exec inferno evaluate ./uscore.tgz --output outcome.json`
+
+        # Loads the us core ig and evaluate the data included in the IG's example folder using a custom configuration file
+        `bundle exec inferno evaluate ./uscore.tgz --config ./custom_config.yml`
       LONGDESC
       # TODO: Add options below as arguments
       option :data_path,
@@ -45,6 +48,10 @@ module Inferno
              aliases: ['-o'],
              type: :string,
              desc: 'Export evaluation result to outcome.json as an OperationOutcome'
+      option :config,
+             aliases: ['-c'],
+             type: :string,
+             desc: 'Path to a custom configuration file'
       def evaluate(ig_path)
         Evaluate.new.run(ig_path, options[:data_path], options)
       end
@@ -92,6 +99,10 @@ module Inferno
 
       desc 'suites', 'List available test suites'
       def suites
+        ENV['NO_DB'] = 'true'
+
+        require_relative '../../../inferno'
+
         Suites.new.run
       end
 

data/lib/inferno/apps/cli/requirements.rb

@@ -1,3 +1,4 @@
+require_relative 'requirements_coverage_checker'
 require_relative 'requirements_exporter'
 
 module Inferno
@@ -23,6 +24,54 @@ module Inferno
         ENV['NO_DB'] = 'true'
         RequirementsExporter.new.run_check
       end
+
+      desc 'coverage [TEST_SUITE_ID]',
+           "Check whether all of a test suite's requirements are tested. If no test suite id is provided, " \
+           'all test suites in the current test kit will be checked.'
+      long_desc <<~LONGDESC
+        Check whether all of the requirements declared by a test suite are
+        tested by the tests in the test suite
+      LONGDESC
+      def coverage(test_suite_id = nil)
+        ENV['NO_DB'] = 'true'
+
+        require_relative '../../../inferno'
+
+        Inferno::Application.start(:requirements)
+
+        if test_suite_id.present?
+          RequirementsCoverageChecker.new(test_suite_id).run
+        else
+          Inferno::Repositories::TestSuites.all.each do |test_suite|
+            if Object.const_source_location(test_suite.to_s).first.start_with? Dir.pwd
+              RequirementsCoverageChecker.new(test_suite.id).run
+            end
+          end
+        end
+      end
+
+      desc 'check_coverage [TEST_SUITE_ID]',
+           'Check whether the coverage CSV files are up to date'
+      long_desc <<~LONGDESC
+        Check whether the coverage CSV files are up to date
+      LONGDESC
+      def check_coverage(test_suite_id = nil)
+        ENV['NO_DB'] = 'true'
+
+        require_relative '../../../inferno'
+
+        Inferno::Application.start(:requirements)
+
+        if test_suite_id.present?
+          RequirementsCoverageChecker.new(test_suite_id).run_check
+        else
+          Inferno::Repositories::TestSuites.all.each do |test_suite|
+            if Object.const_source_location(test_suite.to_s).first.start_with? Dir.pwd
+              RequirementsCoverageChecker.new(test_suite.id).run_check
+            end
+          end
+        end
+      end
     end
   end
 end

data/lib/inferno/apps/cli/requirements_coverage_checker.rb

@@ -0,0 +1,238 @@
+require_relative 'requirements_exporter'
+
+module Inferno
+  module CLI
+    class RequirementsCoverageChecker
+      attr_accessor :test_suite_id, :test_suite
+
+      def initialize(test_suite_id)
+        self.test_suite_id = test_suite_id
+        self.test_suite = Inferno::Repositories::TestSuites.new.find(test_suite_id)
+      end
+
+      def short_id_header
+        "#{test_suite.title} Short ID(s)"
+      end
+
+      def full_id_header
+        "#{test_suite.title} Full ID(s)"
+      end
+
+      def output_headers
+        [
+          *(RequirementsExporter::REQUIREMENTS_OUTPUT_HEADERS - ['Sub-Requirement(s)']),
+          short_id_header,
+          full_id_header
+        ]
+      end
+
+      def test_kit_name
+        local_test_kit_gem.name
+      end
+
+      def base_requirements_folder
+        RequirementsExporter.new.base_requirements_folder
+      end
+
+      def output_folder
+        @output_folder ||= File.join(base_requirements_folder, 'generated')
+      end
+
+      def output_file_name
+        "#{test_suite_id}_requirements_coverage.csv"
+      end
+
+      def output_file_path
+        @output_file_path ||= File.join(output_folder, output_file_name)
+      end
+
+      def suite_requirements
+        @suite_requirements ||=
+          Inferno::Repositories::Requirements.new.requirements_for_suite(test_suite_id)
+      end
+
+      def tested_requirement_ids
+        @tested_requirement_ids ||= test_suite.all_verified_requirements
+      end
+
+      def suite_runnables
+        @suite_runnables ||= [test_suite] + test_suite.all_descendants
+      end
+
+      def untested_requirements
+        @untested_requirements ||= []
+      end
+
+      def new_csv # rubocop:disable Metrics/CyclomaticComplexity
+        @new_csv ||=
+          CSV.generate(+"\xEF\xBB\xBF") do |csv|
+            csv << output_headers
+
+            suite_requirements.each do |requirement|
+              if requirement.not_tested_reason.present?
+                long_ids = 'NA'
+                short_ids = 'NA'
+              else
+                runnables_for_requirement =
+                  suite_runnables.select { |runnable| runnable.verifies_requirements.include? requirement.id }
+                long_ids = runnables_for_requirement&.map(&:id)&.join(', ')
+                short_ids =
+                  runnables_for_requirement
+                    &.map { |runnable| runnable < Inferno::Entities::TestSuite ? 'suite' : runnable.short_id }
+                    &.join(', ')
+              end
+
+              untested_requirements << runnables_for_requirement if runnables_for_requirement.blank?
+
+              row = [
+                requirement.requirement_set,
+                requirement.id.delete_prefix("#{requirement.requirement_set}@"),
+                requirement.url,
+                requirement.requirement,
+                requirement.conformance,
+                requirement.actor,
+                requirement.conditionality,
+                requirement.not_tested_reason,
+                requirement.not_tested_details,
+                short_ids,
+                long_ids
+              ]
+
+              csv << row
+            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_requirement_ids
+        @unmatched_requirement_ids ||=
+          tested_requirement_ids - suite_requirements.map(&:id)
+      end
+
+      def unmatched_requirement_rows
+        unmatched_requirement_ids.flat_map do |requirement_id|
+          runnables_for_requirement =
+            suite_runnables.select { |runnable| runnable.verifies_requirements.include? requirement_id }
+
+          runnables_for_requirement.map do |runnable|
+            [requirement_id, runnable.short_id, runnable.id]
+          end
+        end
+      end
+
+      def old_csv
+        @old_csv ||= File.read(output_file_path)
+      end
+
+      def run
+        unless test_suite.present?
+          puts "Could not find test suite: #{test_suite_id}. Aborting requirements coverage generation..."
+          exit(1)
+        end
+
+        puts
+
+        if unmatched_requirement_ids.present?
+          puts "WARNING: The following requirements indicated in the test suite #{test_suite_id} are not present in " \
+               "the suite's requirement sets:"
+          output_requirements_map_table(unmatched_requirement_rows)
+        end
+
+        if File.exist?(output_file_path)
+          if old_csv == new_csv
+            puts "'#{output_file_name}' file is up to date."
+            return
+          else
+            puts 'Requirements coverage has changed.'
+          end
+        else
+          puts "No existing #{output_file_name}."
+        end
+
+        puts "Writing to file #{output_file_path}..."
+        FileUtils.mkdir_p(output_folder)
+        File.write(output_file_path, new_csv)
+        puts 'Done.'
+      end
+
+      def run_check
+        unless test_suite.present?
+          puts "Could not find test suite: #{test_suite_id}. Aborting requirements coverage generation..."
+          exit(1)
+        end
+
+        puts
+
+        if unmatched_requirement_ids.any?
+          puts "WARNING: The following requirements indicated in the test suite #{test_suite_id} are not present in " \
+               "the suite's requirement sets:"
+          output_requirements_map_table(unmatched_requirement_rows)
+        end
+
+        if File.exist?(output_file_path)
+          if old_csv == new_csv
+            puts "'#{output_file_name}' file is up to date."
+            return unless unmatched_requirement_ids.present?
+          else
+            puts <<~MESSAGE
+              #{output_file_name} file is out of date.
+              To regenerate the file, run:
+
+                  bundle exec inferno requirements coverage
+
+            MESSAGE
+          end
+        else
+          puts <<~MESSAGE
+            No existing #{output_file_name} file.
+            To generate the file, run:
+
+                  bundle exec inferno requirements coverage
+
+          MESSAGE
+        end
+
+        puts 'Check failed.'
+        exit(1)
+      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_rows)
+        headers = %w[requirement_id short_id full_id]
+        col_widths = headers.map(&:length)
+        col_widths[0] = [col_widths[0], *requirements_rows.map { |row| row[0].length }].max
+        col_widths[1] = [col_widths[1], *requirements_rows.map { |row| row[1].length }].max
+        col_widths[2] = [col_widths[2], *requirements_rows.map { |row| row[2].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('-+-')
+        output_requirements_map_table_contents(requirements_rows, col_widths)
+      end
+
+      def output_requirements_map_table_contents(requirements_rows, col_widths)
+        requirements_rows.each do |requirements_row|
+          puts [
+            requirements_row[0].ljust(col_widths[0]),
+            requirements_row[1].ljust(col_widths[1]),
+            requirements_row[2].ljust(col_widths[2])
+          ].join(' | ')
+        end
+      end
+    end
+  end
+end

data/lib/inferno/apps/cli/suite.rb

@@ -15,6 +15,9 @@ module Inferno
       option :filename, banner: '<filename>', aliases: [:f]
       def input_template(suite_id)
         ENV['NO_DB'] = 'true'
+
+        require_relative '../../../inferno'
+
         SuiteInputTemplate.new.run(suite_id, options)
       end
 
@@ -24,6 +27,9 @@ module Inferno
       LONGDESC
       def describe(suite_id)
         ENV['NO_DB'] = 'true'
+
+        require_relative '../../../inferno'
+
         Inferno::Application.start(:suites)
 
         suite = Inferno::Repositories::TestSuites.new.find(suite_id)
@@ -59,6 +65,9 @@ module Inferno
       LONGDESC
       def lock_short_ids(suite_id)
         ENV['NO_DB'] = 'true'
+
+        require_relative '../../../inferno'
+
         Inferno::Application.start(:suites)
 
         suite = Inferno::Repositories::TestSuites.new.find(suite_id)

data/lib/inferno/apps/web/controllers/test_sessions/results/io_value.rb

@@ -0,0 +1,68 @@
+module Inferno
+  module Web
+    module Controllers
+      module TestSessions
+        module Results
+          class IoValue < Controller
+            include Import[
+              test_sessions_repo: 'inferno.repositories.test_sessions',
+              results_repo: 'inferno.repositories.results'
+            ]
+
+            def handle(req, res)
+              test_session_id = req.params[:id]
+              result_id = req.params[:result_id]
+              type = req.params[:type]
+              name = req.params[:name]
+
+              unless %w[inputs outputs].include?(type)
+                res.status = 400
+                res.body = { error: 'Invalid I/O type. Must be "inputs" or "outputs".' }.to_json
+                return
+              end
+
+              test_session_results = results_repo.current_results_for_test_session(test_session_id)
+              result = test_session_results.find { |r| r.id == result_id }
+
+              if result.nil?
+                res.status = 404
+                res.body = { error: "Result '#{result_id}' not found for test session '#{test_session_id}'." }.to_json
+                return
+              end
+
+              entry = result_io_by_name(result, type, name)
+              value = entry&.dig('value')
+
+              if value.blank?
+                res.status = 404
+                res.body = { error: "#{type.singularize.capitalize} '#{name}' not found or missing value." }.to_json
+                return
+              end
+
+              res.body = value.is_a?(Hash) ? value.to_json : value
+              res.content_type = content_type_for(value)
+            end
+
+            private
+
+            def result_io_by_name(result, io_type, name)
+              result.public_send(io_type)
+                .find { |item| item['name'] == name }
+            end
+
+            def content_type_for(value)
+              return 'application/json' if value.is_a?(Hash)
+
+              trimmed = value&.strip
+
+              return 'application/json' if trimmed&.start_with?('{', '[')
+              return 'application/xml' if trimmed&.start_with?('<') && trimmed.end_with?('>')
+
+              'text/plain'
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/inferno/apps/web/router.rb

@@ -34,6 +34,9 @@ module Inferno
           get '/:id/results',
               to: Inferno::Web::Controllers::TestSessions::Results::Index,
               as: :results
+          get '/:id/results/:result_id/io/:type/:name',
+              to: Inferno::Web::Controllers::TestSessions::Results::IoValue,
+              as: :result_io_value
           get '/:id/session_data',
               to: Inferno::Web::Controllers::TestSessions::SessionData::Index
           put '/:id/session_data/apply_preset',

data/lib/inferno/apps/web/serializers/result.rb

@@ -21,11 +21,11 @@ module Inferno
         field :optional?, name: :optional
 
         field :inputs do |result, _options|
-          result.input_json.present? ? JSON.parse(result.input_json) : []
+          result.handle_large_io('inputs')
         end
 
         field :outputs do |result, _options|
-          result.output_json.present? ? JSON.parse(result.output_json) : []
+          result.handle_large_io('outputs')
         end
 
         association :messages, blueprint: Message, if: :field_present?

data/lib/inferno/dsl/fhir_client.rb

@@ -52,7 +52,11 @@ module Inferno
       # @see Inferno::DSL::FHIRClientBuilder
       def fhir_client(client = :default)
         fhir_clients[client] ||=
-          FHIRClientBuilder.new.build(self, self.class.fhir_client_definitions[client])
+          FHIRClientBuilder.new.build(self, find_fhir_client_definition(client))
+      end
+
+      def find_fhir_client_definition(client)
+        self.class.find_fhir_client_definition(client)
       end
 
       # @private
@@ -443,6 +447,10 @@ module Inferno
           @fhir_client_definitions ||= {}
         end
 
+        def find_fhir_client_definition(client)
+          fhir_client_definitions[client] || parent&.find_fhir_client_definition(client)
+        end
+
         # Define a FHIR client to be used by a Runnable.
         #
         # @param name [Symbol] a name used to reference this particular client

data/lib/inferno/dsl/http_client.rb

@@ -46,7 +46,7 @@ module Inferno
       def http_client(client = :default)
         return http_clients[client] if http_clients[client]
 
-        definition = self.class.http_client_definitions[client]
+        definition = find_http_client_definition(client)
         return nil if definition.nil?
 
         tcp_exception_handler do
@@ -54,6 +54,10 @@ module Inferno
         end
       end
 
+      def find_http_client_definition(client)
+        self.class.find_http_client_definition(client)
+      end
+
       # @private
       def http_clients
         @http_clients ||= {}
@@ -196,6 +200,10 @@ module Inferno
           @http_client_definitions ||= {}
         end
 
+        def find_http_client_definition(client)
+          http_client_definitions[client] || parent&.find_http_client_definition(client)
+        end
+
         # Define a HTTP client to be used by a Runnable.
         #
         # @param name [Symbol] a name used to reference this particular client

data/lib/inferno/dsl/runnable.rb

@@ -39,6 +39,7 @@ module Inferno
       # @private
       VARIABLES_NOT_TO_COPY = [
         :@id, # New runnable will have a different id
+        :@database_id, # New runnable will have a different database_id
         :@parent, # New runnable unlikely to have the same parent
         :@all_children, # New subclasses have to be made for each child
         :@test_count, # Needs to be recalculated
@@ -164,22 +165,6 @@ module Inferno
           klass.output output_name
         end
 
-        new_fhir_client_definitions = klass.instance_variable_get(:@fhir_client_definitions) || {}
-        fhir_client_definitions.each do |name, definition|
-          next if new_fhir_client_definitions.include? name
-
-          new_fhir_client_definitions[name] = definition.dup
-        end
-        klass.instance_variable_set(:@fhir_client_definitions, new_fhir_client_definitions)
-
-        new_http_client_definitions = klass.instance_variable_get(:@http_client_definitions) || {}
-        http_client_definitions.each do |name, definition|
-          next if new_http_client_definitions.include? name
-
-          new_http_client_definitions[name] = definition.dup
-        end
-        klass.instance_variable_set(:@http_client_definitions, new_http_client_definitions)
-
         klass.config(config)
 
         klass.all_children.select!(&:required?) if hash_args.delete(:exclude_optional)
@@ -210,20 +195,20 @@ module Inferno
       def id(new_id = nil)
         return @id if new_id.nil? && @id.present?
 
-        prefix =
-          if parent
-            "#{parent.id}-"
-          else
-            ''
-          end
-
+        prefix = parent ? "#{parent.id}-" : ''
         @base_id = new_id || @base_id || default_id
+        @id = "#{prefix}#{@base_id}"
 
-        final_id = "#{prefix}#{@base_id}"
+        if @id.length > 255
+          hash = Digest::SHA1.hexdigest(@id)[0...10]
+          @database_id = "#{@id[0...244]}-#{hash}"
+        end
 
-        raise Exceptions::InvalidRunnableIdException, final_id if final_id.length > 255
+        @id
+      end
 
-        @id = final_id
+      def database_id
+        @database_id ||= id
       end
 
       # Set/Get a runnable's title
@@ -571,10 +556,10 @@ module Inferno
       end
 
       # @private
-      def all_requirements(suite_options = [])
-        children(suite_options).flat_map do |child|
-          child.verifies_requirements + child.all_requirements(suite_options)
-        end
+      def all_verified_requirements(suite_options = [])
+        verifies_requirements + children(suite_options).flat_map do |child|
+          child.all_verified_requirements(suite_options)
+        end.uniq
       end
 
       # @private