inferno_core 0.4.8 → 0.4.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e9fb2c95aa9d590f9c05ceb25a236f0552ae2a94e91c49de3a116dbe970e62de
-  data.tar.gz: e81873f6d4c4a4b620fa2831298ce089567d07df5e2ca93b70cec127c2f67fbf
+  metadata.gz: 79e59753922bf1c5a06e2603a27f267e6b75aed91d46b5531b2ecffcf13a95a8
+  data.tar.gz: 318edf53524ede718e5331b9ec4eb626537553cd0d88ff2df3a4237dc83c2f3e
 SHA512:
-  metadata.gz: b5195ed44f0fb45fa7688e5dd3f4c74cc5012a689205cf39f27ab08a1ca25713cc4ce7a2c1351a281c311b38e38c28b72b5e09cf1771f88a220ebd6735ff87fd
-  data.tar.gz: 96b4316208dd689aad2e1205ac29c15e452d0086f72bbe1dff8ee349eccf5c579165bf7610196dfdb1cfcd2e959ad8d536e2978d8a00c60e598551a619447a34
+  metadata.gz: 6ab836f245a7172c320405d75649be9ab8281b9d7e9520818b160f75aecdac21a7a94aa8d91f9337361475e27560260b36896e7ee5c7f7f6b749123e4b75f4a4
+  data.tar.gz: 3c1f9dbd1209817b38114a609a20c4e6cca27c89743d7c91a8fe954be70a4450112ee72f07ceabf7e9e9c40a8140e7990a6280b70625f71596d8aa0b0ee2b569

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

@@ -18,12 +18,25 @@ module Inferno
       end
 
       desc 'start', 'Start Inferno'
+      option :watch,
+             default: false,
+             type: :boolean,
+             desc: 'Automatically restart Inferno when a file is changed.'
       def start
+        command = 'foreman start --env=/dev/null'
         if `gem list -i foreman`.chomp == 'false'
-          puts "You must install foreman with 'gem install foreman' prior to running inferno."
+          puts "You must install foreman with 'gem install foreman' prior to running Inferno."
         end
 
-        system 'foreman start --env=/dev/null'
+        if options[:watch]
+          if `gem list -i rerun`.chomp == 'false'
+            puts "You must install 'rerun' with 'gem install rerun' to restart on file changes."
+          end
+
+          command = "rerun \"#{command}\" --background"
+        end
+
+        system command
       end
 
       desc 'suites', 'List available test suites'

data/lib/inferno/apps/web/controllers/test_sessions/client_show.rb

@@ -0,0 +1,40 @@
+module Inferno
+  module Web
+    module Controllers
+      module TestSessions
+        class ClientShow < Controller
+          config.default_response_format = :html
+
+          CLIENT_PAGE =
+            ERB.new(
+              File.read(
+                File.join(
+                  Inferno::Application.root, 'lib', 'inferno', 'apps', 'web', 'index.html.erb'
+                )
+              )
+            ).result.freeze
+
+          def handle(req, res)
+            test_session_id = req.params[:id]
+            test_suite_id = req.params[:test_suite_id]
+
+            test_session = repo.find(test_session_id)
+            halt 404 if test_session.nil?
+
+            if test_suite_id.blank? || test_suite_id != test_session.test_suite_id
+              test_suite_id = test_session.test_suite_id
+
+              res.redirect_to "#{Inferno::Application['base_url']}/#{test_suite_id}/#{test_session_id}"
+            end
+
+            test_suite = Inferno::Repositories::TestSuites.new.find(test_suite_id)
+
+            halt 404 if test_suite.nil?
+
+            res.body = CLIENT_PAGE
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -53,7 +53,6 @@ module Inferno
       # Should not need Content-Type header but GitHub Codespaces will not work without them.
       # This could be investigated and likely removed if addressed properly elsewhere.
       get '/', to: ->(_env) { [200, { 'Content-Type' => 'text/html' }, [client_page]] }
-      get '/test_sessions/:id', to: ->(_env) { [200, { 'Content-Type' => 'text/html' }, [client_page]] }
 
       Inferno.routes.each do |route|
         cleaned_id = route[:suite].id.gsub(/[^a-zA-Z\d\-._~]/, '_')
@@ -70,6 +69,9 @@ module Inferno
         Application['logger'].info("Registering suite route: #{suite_path}")
         get suite_path, to: ->(_env) { [200, {}, [client_page]] }
       end
+
+      get '/test_sessions/:id', to: Inferno::Web::Controllers::TestSessions::ClientShow, as: :client_session_show
+      get '/:test_suite_id/:id', to: Inferno::Web::Controllers::TestSessions::ClientShow, as: :client_suite_session_show
     end
 
     Router = # rubocop:disable Naming/ConstantName

data/lib/inferno/config/boot/suites.rb

@@ -2,6 +2,10 @@ Inferno::Application.boot(:suites) do
   init do
     use :logging
 
+    require 'inferno/entities/test'
+    require 'inferno/entities/test_group'
+    require 'inferno/entities/test_suite'
+
     files_to_load = Dir.glob(File.join(Dir.pwd, 'lib', '*.rb'))
 
     if ENV['LOAD_DEV_SUITES'].present?

data/lib/inferno/dsl/assertions.rb

@@ -12,6 +12,7 @@ module Inferno
       # @param test a value whose truthiness will determine whether the
       #   assertion passes or fails
       # @param message [String] failure message
+      # @return [void]
       def assert(test, message = '')
         raise Exceptions::AssertionException, message unless test
       end
@@ -21,12 +22,15 @@ module Inferno
         "Unexpected response status: expected #{Array.wrap(expected).join(', ')}, but received #{received}"
       end
 
-      # Check an response's status
+      # Check a response's status
       #
       # @param status [Integer, Array<Integer>] a single integer or an array of
       #   integer status codes
+      # @param request [Inferno::Entities::Request]
       # @param response [Hash]
-      def assert_response_status(status, response: self.response)
+      # @return [void]
+      def assert_response_status(status, request: self.request, response: nil)
+        response ||= request&.response
         assert Array.wrap(status).include?(response[:status]), bad_response_status_message(status, response[:status])
       end
 
@@ -44,6 +48,7 @@ module Inferno
       #   assert_resource_type(:capability_statement)
       #   assert_resource_type('CapabilityStatement')
       #   assert_resource_type(FHIR::CapabilityStatement)
+      # @return [void]
       def assert_resource_type(resource_type, resource: self.resource)
         resource_type_name = normalize_resource_type(resource_type)
 
@@ -61,8 +66,10 @@ module Inferno
       # @param resource [FHIR::Model]
       # @param profile_url [String] url of the profile to validate against,
       #   defaults to validating against the base FHIR resource
-      def assert_valid_resource(resource: self.resource, profile_url: nil)
-        assert resource_is_valid?(resource:, profile_url:),
+      # @param validator [Symbol] the name of the validator to use
+      # @return [void]
+      def assert_valid_resource(resource: self.resource, profile_url: nil, validator: :default)
+        assert resource_is_valid?(resource:, profile_url:, validator:),
                invalid_resource_message(profile_url)
       end
 
@@ -93,6 +100,7 @@ module Inferno
       #       'Condition': nil
       #     }
       #   )
+      # @return [void]
       def assert_valid_bundle_entries(bundle: resource, resource_types: {})
         assert_resource_type('Bundle', resource: bundle)
 
@@ -148,6 +156,7 @@ module Inferno
       #
       # @param maybe_json_string [String]
       # @param message [String] extra failure message
+      # @return [void]
       def assert_valid_json(maybe_json_string, message = '')
         assert JSON.parse(maybe_json_string)
       rescue JSON::ParserError
@@ -158,15 +167,18 @@ module Inferno
       #
       # @param uri [String]
       # @param message [String] custom failure message
+      # @return [void]
       def assert_valid_http_uri(uri, message = '')
         error_message = message.presence || "\"#{uri}\" is not a valid URI"
         assert uri =~ /\A#{URI::DEFAULT_PARSER.make_regexp(['http', 'https'])}\z/, error_message
       end
 
-      # Check the Content-Type header of a response
+      # Check the Content-Type header of a response. This assertion will fail if
+      # the response's content type does not begin with the provided type.
       #
       # @param type [String]
       # @param request [Inferno::Entities::Request]
+      # @return [void]
       def assert_response_content_type(type, request: self.request)
         header = request.response_header('Content-Type')
         assert header.present?, no_content_type_message

data/lib/inferno/dsl/configurable.rb

@@ -6,6 +6,7 @@ module Inferno
     # configuration provides a way to modify test behavior at boot time.
     #
     # The main features enabled by configuration are:
+    #
     # - Modifying the properties of a runnable's inputs. This could include
     #   locking a particular input, making a particular input optional/required,
     #   or changing an input's value.
@@ -81,6 +82,7 @@ module Inferno
       # will be applied to the runnable and all of its children.
       #
       # @param new_configuration [Hash]
+      # @return [Inferno::DSL::Configurable::Configuration]
       def config(new_configuration = {})
         @config ||= Configuration.new
 

data/lib/inferno/dsl/fhir_client.rb

@@ -243,6 +243,7 @@ module Inferno
         # @param block a block to configure the client
         # @see Inferno::FHIRClientBuilder Documentation for the client
         #   configuration DSL
+        # @return [void]
         def fhir_client(name = :default, &block)
           fhir_client_definitions[name] = block
         end

data/lib/inferno/dsl/fhir_validation.rb

@@ -99,7 +99,8 @@ module Inferno
             .select { |message| message.is_a? Hash }
         end
 
-        # Filter out unwanted validation messages
+        # Filter out unwanted validation messages. Any messages for which the
+        # block evalutates to a truthy value will be excluded.
         #
         # @example
         #   validator do

data/lib/inferno/dsl/http_client.rb

@@ -198,6 +198,7 @@ module Inferno
         # @param block a block to configure the client
         # @see Inferno::HTTPClientBuilder Documentation for the client
         #   configuration DSL
+        # @return [void]
         def http_client(name = :default, &block)
           http_client_definitions[name] = block
         end

data/lib/inferno/dsl/input_output_handling.rb

@@ -47,7 +47,7 @@ module Inferno
       # @param identifier [Symbol] identifier for the output
       # @param other_identifiers [Symbol] array of symbols if specifying multiple outputs
       # @param output_definition [Hash] options for output
-      # @option output_definition [String] :type text | textarea | oauth_credentials
+      # @option output_definition [String] :type text, textarea, or oauth_credentials
       # @return [void]
       # @example
       #   output :patient_id, :condition_id, :observation_id

data/lib/inferno/dsl/request_storage.rb

@@ -89,6 +89,7 @@ module Inferno
         # Specify the named requests made by a test
         #
         # @param identifiers [Symbol] one or more request identifiers
+        # @return [void]
         def makes_request(*identifiers)
           named_requests_made.concat(identifiers).uniq!
           identifiers.each do |identifier|
@@ -99,6 +100,7 @@ module Inferno
         # Specify the name for a request received by a test
         #
         # @param identifier [Symbol]
+        # @return [void]
         def receives_request(identifier)
           config.add_request(identifier)
           @incoming_request_name = identifier
@@ -112,6 +114,7 @@ module Inferno
         # Specify the named requests used by a test
         #
         # @param identifiers [Symbol] one or more request identifiers
+        # @return [void]
         def uses_request(*identifiers)
           named_requests_used.concat(identifiers).uniq!
           identifiers.each do |identifier|

data/lib/inferno/dsl/results.rb

@@ -5,6 +5,7 @@ module Inferno
       # Halt execution of the current test and mark it as passed.
       #
       # @param message [String]
+      # @return [void]
       def pass(message = '')
         raise Exceptions::PassException, message
       end
@@ -14,6 +15,7 @@ module Inferno
       #
       # @param test [Boolean]
       # @param message [String]
+      # @return [void]
       def pass_if(test, message = '')
         raise Exceptions::PassException, message if test
       end
@@ -21,6 +23,7 @@ module Inferno
       # Halt execution of the current test and mark it as skipped.
       #
       # @param message [String]
+      # @return [void]
       def skip(message = '')
         raise Exceptions::SkipException, message
       end
@@ -30,6 +33,7 @@ module Inferno
       #
       # @param test [Boolean]
       # @param message [String]
+      # @return [void]
       def skip_if(test, message = '')
         raise Exceptions::SkipException, message if test
       end
@@ -37,6 +41,7 @@ module Inferno
       # Halt execution of the current test and mark it as omitted.
       #
       # @param message [String]
+      # @return [void]
       def omit(message = '')
         raise Exceptions::OmitException, message
       end
@@ -46,6 +51,7 @@ module Inferno
       #
       # @param test [Boolean]
       # @param message [String]
+      # @return [void]
       def omit_if(test, message = '')
         raise Exceptions::OmitException, message if test
       end
@@ -75,6 +81,7 @@ module Inferno
       # @param message [String]
       # @param timeout [Integer] Number of seconds to wait for an incoming
       #   request
+      # @return [void]
       def wait(identifier:, message: '', timeout: 300)
         identifier(identifier)
         wait_timeout(timeout)

data/lib/inferno/dsl/runnable.rb

@@ -268,7 +268,6 @@ module Inferno
       #
       # @param optional [Boolean]
       # @return [void]
-      #
       def optional(optional = true) # rubocop:disable Style/OptionalBooleanParameter
         @optional = optional
       end
@@ -347,6 +346,7 @@ module Inferno
       #   route. The block has access to the `request` method which returns a
       #   {Inferno::Entities::Request} object with the information for the
       #   incoming request.
+      # @return [void]
       def resume_test_route(method, path, &block)
         route_class = Class.new(ResumeTestRoute) do |klass|
           klass.singleton_class.instance_variable_set(:@test_run_identifier_block, block)
@@ -368,6 +368,7 @@ module Inferno
       #   compatible object (e.g. a `Proc` object, a [Sinatra
       #   app](http://sinatrarb.com/)) as described in the [Hanami Router
       #   documentation.](https://github.com/hanami/router/tree/f41001d4c3ee9e2d2c7bb142f74b43f8e1d3a265#mount-rack-applications)
+      # @return [void]
       def route(method, path, handler)
         Inferno.routes << { method:, path:, handler:, suite: }
       end
@@ -414,6 +415,7 @@ module Inferno
       #   group from: :ig_v2_group do
       #     required_suite_options ig_version: 'ig_v2'
       #   end
+      # @return [void]
       def required_suite_options(suite_option_requirements)
         @suite_option_requirements =
           suite_option_requirements.map do |key, value|
@@ -436,6 +438,7 @@ module Inferno
         end
       end
 
+      # @private
       def inspect
         non_dynamic_ancestor = ancestors.find { |ancestor| !ancestor.to_s.start_with? '#' }
         "#<#{non_dynamic_ancestor}".tap do |inspect_string|

data/lib/inferno/entities/request.rb

@@ -58,29 +58,29 @@ module Inferno
       # Find a response header
       #
       # @param name [String] the header name
-      # @return [Inferno::Entities::RequestHeader, nil]
+      # @return [Inferno::Entities::Header, nil]
       def response_header(name)
         response_headers.find { |header| header.name.casecmp(name).zero? }
       end
 
       # Find a request header
       #
-      # @param name [String] the header name
-      # @return [Inferno::Entities::RequestHeader, nil]
+      # @param name [String] the header name.
+      # @return [Inferno::Entities::Header, nil]
       def request_header(name)
         request_headers.find { |header| header.name.casecmp(name).zero? }
       end
 
       # All of the request headers
       #
-      # @return [Array<Inferno::Entities::RequestHeader>]
+      # @return [Array<Inferno::Entities::Header>]
       def request_headers
         headers.select(&:request?)
       end
 
       # All of the response headers
       #
-      # @return [Array<Inferno::Entities::RequestHeader>]
+      # @return [Array<Inferno::Entities::Header>]
       def response_headers
         headers.select(&:response?)
       end
@@ -131,7 +131,7 @@ module Inferno
 
       # Return the FHIR resource from the response body.
       #
-      # @return [FHIR::Model]
+      # @return [FHIR::Model, nil]
       def resource
         FHIR.from_contents(response_body)
       end

data/lib/inferno/entities/test.rb

@@ -28,6 +28,11 @@ module Inferno
         @messages ||= []
       end
 
+      # Add a message to the result.
+      #
+      # @param type [String] error, warning, or info
+      # @param message [String]
+      # @return [void]
       def add_message(type, message)
         messages << { type: type.to_s, message: format_markdown(message) }
       end
@@ -40,7 +45,6 @@ module Inferno
       # @example
       #   output(patient_id: '5', bearer_token: 'ABC')
       def output(outputs)
-        # TODO: update to track outputs that need to be updated
         outputs.each do |key, value|
           send("#{key}=", value)
           outputs_to_persist[key] = value
@@ -158,6 +162,7 @@ module Inferno
           end
         end
 
+        # @private
         def repository
           Inferno::Repositories::Tests.new
         end

data/lib/inferno/entities/test_group.rb

@@ -28,6 +28,7 @@ module Inferno
       end
 
       class << self
+        # @private
         def repository
           Inferno::Repositories::TestGroups.new
         end
@@ -53,12 +54,14 @@ module Inferno
         # Methods to configure Inferno::DSL::Runnable
 
         # Add a child group
+        # @return [void]
         def group(...)
           child_metadata(group_metadata)
           define_child(...)
         end
 
         # Add a test
+        # @return [void]
         def test(...)
           child_metadata(test_metadata)
           define_child(...)
@@ -108,6 +111,7 @@ module Inferno
         # UI, and this group must be run as a group.
         #
         # @param value [Boolean]
+        # @return [void]
         def run_as_group(value = true) # rubocop:disable Style/OptionalBooleanParameter
           @run_as_group = value
         end

data/lib/inferno/entities/test_session.rb

@@ -40,7 +40,7 @@ module Inferno
 
         self.suite_options ||= []
 
-        test_suite.suite_options&.each do |option|
+        test_suite&.suite_options&.each do |option|
           if suite_options.none? { |selected_option| selected_option.id == option.id }
             suite_options << DSL::SuiteOption.new(id: option.id, value: option.list_options.first[:value])
           end

data/lib/inferno/entities/test_suite.rb

@@ -28,6 +28,7 @@ module Inferno
           @default_group
         end
 
+        # @private
         def repository
           Inferno::Repositories::TestSuites.new
         end
@@ -44,6 +45,7 @@ module Inferno
         # Methods to configure Inferno::DSL::Runnable
 
         # Add a child group
+        # @return [void]
         def group(...)
           child_metadata(group_metadata)
           define_child(...)
@@ -93,6 +95,7 @@ module Inferno
         # @yieldreturn [Array<Hash>] An array of message hashes containing the
         #   keys `:type` and `:message`. Type options are `info`, `warning`, and
         #   `error`.
+        # @return [void]
         def check_configuration(&block)
           @check_configuration_block = block
         end
@@ -134,6 +137,7 @@ module Inferno
         #   group from: :ig_v2_group do
         #     required_suite_options ig_version: 'ig_v2'
         #   end
+        # @return [void]
         def suite_option(identifier, **option_params)
           suite_options << DSL::SuiteOption.new(option_params.merge(id: identifier))
         end

data/lib/inferno/ext/fhir_models.rb

@@ -27,7 +27,7 @@ end
 module InfernoJson
   def from_json(json)
     resource = super(json)
-    resource.source_text = json
+    resource&.source_text = json
     resource
   end
 end
@@ -37,7 +37,7 @@ end
 module InfernoXml
   def from_xml(xml)
     resource = super(xml)
-    resource.source_text = xml
+    resource&.source_text = xml
     resource
   end
 end