inferno_core 0.3.3 → 0.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 884936b347ee4892198605b7ae408f3889e74bed0a4e33b6ec2a5ee7ed3adcd9
-  data.tar.gz: b0e30f11313a6a5b690e96a08fdb083ba9d85b94b512ec105fce75631802f0cb
+  metadata.gz: 2f0cad7d368810c89ee2571e1f8aa6705d6b74b1ad058b8f179269a7705c2df7
+  data.tar.gz: 7f1ab19849ca3454f536b06963df78abc91c5dc7cbde24e796338836cd081e10
 SHA512:
-  metadata.gz: 13b145c224d9b762b2ae8019048d6775dea2bd0ce47abcb3450959e3148224a523914eaf06b480a25d1a065c449e32b9c64ed83056118b611e8be2c4d9640755
-  data.tar.gz: 78a7bd5437739a2e1e7384dc500d46a99c8795f03638023839fdf4c24131fcc9a6ba8ca1ec507cd0b0bd559d8c9741e07ce2c6e3b04954b72bf6ba4ce7158805
+  metadata.gz: b7ff909be62d859f3a0755f787fb8d893edaadffd16cc70dd18f47cfe0184b2ec82330a7f51a02617c4b8afb6710e3282492a9a2f23cf82e37650548cbd9dd4b
+  data.tar.gz: 5832f7eb12e90626ebd9ca84e945a3afc631e5d63d024381548ed7c3fc373ff85ca9ea34533a79eefedb7e8ab8d80d65229d2fffd180c7d289586528b29dfb03

data/lib/inferno/apps/web/controllers/test_runs/create.rb

@@ -11,8 +11,8 @@ module Inferno
 
           PARAMS = [:test_session_id, :test_suite_id, :test_group_id, :test_id].freeze
 
-          def verify_runnable(runnable, inputs)
-            missing_inputs = runnable&.missing_inputs(inputs)
+          def verify_runnable(runnable, inputs, selected_suite_options)
+            missing_inputs = runnable&.missing_inputs(inputs, selected_suite_options)
             user_runnable = runnable&.user_runnable?
             raise Inferno::Exceptions::RequiredInputsNotFound, missing_inputs if missing_inputs&.any?
             raise Inferno::Exceptions::NotUserRunnableException unless user_runnable
@@ -26,7 +26,7 @@ module Inferno
                   &.last
 
               if input.nil?
-                Inferno::Application['logger'].warning(
+                Inferno::Application['logger'].warn(
                   "Unknown input `#{input_params[:name]}` for #{test_run.runnable.id}: #{test_run.runnable.title}"
                 )
                 next
@@ -51,7 +51,11 @@ module Inferno
               return
             end
 
-            verify_runnable(repo.build_entity(create_params(params)).runnable, params[:inputs])
+            verify_runnable(
+              repo.build_entity(create_params(params)).runnable,
+              params[:inputs],
+              test_session.suite_options
+            )
 
             test_run = repo.create(create_params(params).merge(status: 'queued'))
 

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

@@ -3,9 +3,12 @@ module Inferno
     module Controllers
       module TestSessions
         class Create < Controller
-          PARAMS = [:test_suite_id].freeze
+          PARAMS = [:test_suite_id, :suite_options].freeze
+
+          def call(raw_params)
+            params = raw_params.to_h
+            params.merge!(JSON.parse(request.body.string).symbolize_keys) unless request.body.string.blank?
 
-          def call(params)
             session = repo.create(create_params(params))
 
             repo.apply_preset(session.id, params[:preset_id]) if params[:preset_id].present?
@@ -21,7 +24,7 @@ module Inferno
           end
 
           def create_params(params)
-            params.to_h.slice(*PARAMS)
+            params.slice(*PARAMS)
           end
         end
       end

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

@@ -51,6 +51,11 @@ module Inferno
             send(route[:method], path, to: route[:handler])
           end
         end
+
+        Inferno::Repositories::TestSuites.all.map { |suite| "/#{suite.id}" }.each do |suite_path|
+          Application['logger'].info("Registering suite route: #{suite_path}")
+          get suite_path, to: ->(_env) { [200, {}, [client_page]] }
+        end
       end
     end
   end

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

@@ -6,9 +6,13 @@ module Inferno
       class Input < Serializer
         identifier :name
 
-        field :label, if: :field_present?
+        field :title, if: :field_present?
         field :description, if: :field_present?
-        field :required, if: :field_present?
+        field :type, if: :field_present?
+        field :default, if: :field_present?
+        field :optional, if: :field_present?
+        field :options, if: :field_present?
+        field :locked, if: :field_present?
         field :value, if: :field_present?
       end
     end

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

@@ -0,0 +1,13 @@
+module Inferno
+  module Web
+    module Serializers
+      class SuiteOption < Serializer
+        identifier :id
+        field :title, if: :field_present?
+        field :description, if: :field_present?
+        field :list_options, if: :field_present?
+        field :value, if: :field_present?
+      end
+    end
+  end
+end

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

@@ -7,7 +7,10 @@ module Inferno
         field :short_id
         field :title
         field :short_title
-        field :available_inputs, name: :inputs, extractor: HashValueExtractor, blueprint: Input
+        field :inputs do |test, options|
+          suite_options = options[:suite_options]
+          Input.render_as_hash(test.available_inputs(suite_options).values)
+        end
         field :output_definitions, name: :outputs, extractor: HashValueExtractor
         field :description
         field :short_description

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

@@ -15,9 +15,18 @@ module Inferno
         field :user_runnable?, name: :user_runnable
         field :optional?, name: :optional
 
-        association :groups, name: :test_groups, blueprint: TestGroup
-        association :tests, blueprint: Test
-        field :available_inputs, name: :inputs, extractor: HashValueExtractor, blueprint: Input
+        field :test_groups do |group, options|
+          suite_options = options[:suite_options]
+          TestGroup.render_as_hash(group.groups(suite_options), suite_options: suite_options)
+        end
+        field :tests do |group, options|
+          suite_options = options[:suite_options]
+          Test.render_as_hash(group.tests(suite_options), suite_options: suite_options)
+        end
+        field :inputs do |group, options|
+          suite_options = options[:suite_options]
+          Input.render_as_hash(group.available_inputs(suite_options).values)
+        end
         field :output_definitions, name: :outputs, extractor: HashValueExtractor
       end
     end

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

@@ -1,3 +1,4 @@
+require_relative 'suite_option'
 require_relative 'test_suite'
 
 module Inferno
@@ -7,10 +8,11 @@ module Inferno
         identifier :id
 
         field :test_suite_id
+        association :suite_options, blueprint: SuiteOption
 
-        association :test_suite, blueprint: TestSuite, view: :full
-        # association :test_runs, blueprint: TestRun
-        # association :results, blueprint: Result
+        field :test_suite do |session, _options|
+          TestSuite.render_as_hash(session.test_suite, view: :full, suite_options: session.suite_options)
+        end
       end
     end
   end

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

@@ -11,14 +11,22 @@ module Inferno
           field :input_instructions
           field :test_count
           field :version
+          field :links
+          association :suite_options, blueprint: SuiteOption
           association :presets, view: :summary, blueprint: Preset
         end
 
         view :full do
           include_view :summary
-          association :groups, name: :test_groups, blueprint: TestGroup
+          field :test_groups do |suite, options|
+            suite_options = options[:suite_options]
+            TestGroup.render_as_hash(suite.groups(suite_options), suite_options: suite_options)
+          end
           field :configuration_messages
-          field :available_inputs, name: :inputs, extractor: HashValueExtractor, blueprint: Input
+          field :inputs do |suite, options|
+            suite_options = options[:suite_options]
+            Input.render_as_hash(suite.available_inputs(suite_options).values)
+          end
         end
       end
     end

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

@@ -11,7 +11,7 @@ Inferno::Application.boot(:db) do
 
     config_path = File.expand_path('database.yml', File.join(Dir.pwd, 'config'))
     config_contents = ERB.new(File.read(config_path)).result
-    config = YAML.safe_load(config_contents)[ENV['APP_ENV']]
+    config = YAML.safe_load(config_contents)[ENV.fetch('APP_ENV', nil)]
       .merge(logger: Inferno::Application['logger'])
     connection_attempts_remaining = ENV.fetch('MAX_DB_CONNECTION_ATTEMPTS', '10').to_i
     connection_retry_delay = ENV.fetch('DB_CONNECTION_RETRY_DELAY', '5').to_i

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

@@ -4,7 +4,7 @@ Inferno::Application.boot(:presets) do
   init do
     use :suites
 
-    files_to_load = Dir.glob(File.join(Dir.pwd, 'config', 'presets', '*.json'))
+    files_to_load = Dir.glob(['config/presets/*.json', 'config/presets/*.json.erb'])
     files_to_load.map! { |path| File.realpath(path) }
     presets_repo = Inferno::Repositories::Presets.new
 

data/lib/inferno/config/boot.rb

@@ -4,4 +4,4 @@ ENV['APP_ENV'] ||= 'development'
 
 root_path = Dir.pwd
 
-Dotenv.load(File.join(root_path, '.env'), File.join(root_path, ".env.#{ENV['APP_ENV']}"))
+Dotenv.load(File.join(root_path, '.env'), File.join(root_path, ".env.#{ENV.fetch('APP_ENV', nil)}"))

data/lib/inferno/db/migrations/007_add_suite_options.rb

@@ -0,0 +1,5 @@
+Sequel.migration do
+  change do
+    add_column :test_sessions, :suite_options, String, text: true, size: 255
+  end
+end

data/lib/inferno/db/schema.rb

@@ -9,6 +9,7 @@ Sequel.migration do
       String :test_suite_id, :size=>255, :null=>false
       DateTime :created_at, :null=>false
       DateTime :updated_at, :null=>false
+      String :suite_options, :text=>true
       
       primary_key [:id]
     end

data/lib/inferno/dsl/configurable.rb

@@ -16,7 +16,7 @@ module Inferno
 
         @config.apply(new_configuration)
 
-        children.each { |child| child.config(new_configuration) }
+        all_children.each { |child| child.config(new_configuration) }
 
         @config
       end

data/lib/inferno/dsl/fhir_client.rb

@@ -1,4 +1,5 @@
 require_relative 'request_storage'
+require_relative 'tcp_exception_handler'
 
 module Inferno
   module DSL
@@ -40,6 +41,7 @@ module Inferno
         klass.extend ClassMethods
         klass.extend Forwardable
         klass.include RequestStorage
+        klass.include TCPExceptionHandler
 
         klass.def_delegators 'self.class', :profile_url, :validator_url
       end
@@ -73,11 +75,13 @@ module Inferno
       # @return [Inferno::Entities::Request]
       def fhir_operation(path, body: nil, client: :default, name: nil, headers: {})
         store_request_and_refresh_token(fhir_client(client), name) do
-          operation_headers = fhir_client(client).fhir_headers
-          operation_headers.merge!('Content-Type' => 'application/fhir+json') if body.present?
-          operation_headers.merge!(headers) if headers.present?
+          tcp_exception_handler do
+            operation_headers = fhir_client(client).fhir_headers
+            operation_headers.merge!('Content-Type' => 'application/fhir+json') if body.present?
+            operation_headers.merge!(headers) if headers.present?
 
-          fhir_client(client).send(:post, path, body, operation_headers)
+            fhir_client(client).send(:post, path, body, operation_headers)
+          end
         end
       end
 
@@ -89,8 +93,10 @@ module Inferno
       # @return [Inferno::Entities::Request]
       def fhir_get_capability_statement(client: :default, name: nil)
         store_request_and_refresh_token(fhir_client(client), name) do
-          fhir_client(client).conformance_statement
-          fhir_client(client).reply
+          tcp_exception_handler do
+            fhir_client(client).conformance_statement
+            fhir_client(client).reply
+          end
         end
       end
 
@@ -104,7 +110,9 @@ module Inferno
       # @return [Inferno::Entities::Request]
       def fhir_read(resource_type, id, client: :default, name: nil)
         store_request_and_refresh_token(fhir_client(client), name) do
-          fhir_client(client).read(fhir_class_from_resource_type(resource_type), id)
+          tcp_exception_handler do
+            fhir_client(client).read(fhir_class_from_resource_type(resource_type), id)
+          end
         end
       end
 
@@ -126,8 +134,10 @@ module Inferno
           end
 
         store_request_and_refresh_token(fhir_client(client), name) do
-          fhir_client(client)
-            .search(fhir_class_from_resource_type(resource_type), { search: search })
+          tcp_exception_handler do
+            fhir_client(client)
+              .search(fhir_class_from_resource_type(resource_type), { search: search })
+          end
         end
       end
 
@@ -141,7 +151,9 @@ module Inferno
       # @return [Inferno::Entities::Request]
       def fhir_delete(resource_type, id, client: :default, name: nil)
         store_request('outgoing', name) do
-          fhir_client(client).destroy(fhir_class_from_resource_type(resource_type), id)
+          tcp_exception_handler do
+            fhir_client(client).destroy(fhir_class_from_resource_type(resource_type), id)
+          end
         end
       end
 

data/lib/inferno/dsl/fhir_validation.rb

@@ -1,5 +1,4 @@
 require_relative '../ext/fhir_models'
-
 module Inferno
   module DSL
     # This module contains the methods needed to configure a validator to
@@ -39,13 +38,16 @@ module Inferno
       # Find a particular validator. Looks through a runnable's parents up to
       # the suite to find a validator with a particular name
       def find_validator(validator_name)
-        self.class.find_validator(validator_name)
+        self.class.find_validator(validator_name, suite_options)
       end
 
       class Validator
+        attr_reader :requirements
+
         # @private
-        def initialize(&block)
+        def initialize(requirements = nil, &block)
           instance_eval(&block)
+          @requirements = requirements
         end
 
         # @private
@@ -115,7 +117,7 @@ module Inferno
 
           outcome = FHIR::OperationOutcome.new(JSON.parse(validate(resource, profile_url)))
 
-          message_hashes = outcome.issue&.map { |issue| message_hash_from_issue(issue) } || []
+          message_hashes = outcome.issue&.map { |issue| message_hash_from_issue(issue, resource) } || []
 
           message_hashes.concat(additional_validation_messages(resource, profile_url))
 
@@ -132,10 +134,10 @@ module Inferno
         end
 
         # @private
-        def message_hash_from_issue(issue)
+        def message_hash_from_issue(issue, resource)
           {
             type: issue_severity(issue),
-            message: issue_message(issue)
+            message: issue_message(issue, resource)
           }
         end
 
@@ -152,14 +154,16 @@ module Inferno
         end
 
         # @private
-        def issue_message(issue)
+        def issue_message(issue, resource)
           location = if issue.respond_to?(:expression)
                        issue.expression&.join(', ')
                      else
                        issue.location&.join(', ')
                      end
 
-          "#{location}: #{issue&.details&.text}"
+          location_prefix = resource.id ? "#{resource.resourceType}/#{resource.id}" : resource.resourceType
+
+          "#{location_prefix}: #{location}: #{issue&.details&.text}"
         end
 
         # Post a resource to the validation service for validating.
@@ -198,14 +202,33 @@ module Inferno
         #
         # @param name [Symbol] the name of the validator, only needed if you are
         #   using multiple validators
-        def validator(name = :default, &block)
-          fhir_validators[name] = Inferno::DSL::FHIRValidation::Validator.new(&block)
+        # @param required_suite_options [Hash] suite options that must be
+        #   selected in order to use this validator
+        def validator(name = :default, required_suite_options: nil, &block)
+          current_validators = fhir_validators[name] || []
+
+          new_validator = Inferno::DSL::FHIRValidation::Validator.new(required_suite_options, &block)
+
+          current_validators.reject! { |validator| validator.requirements == required_suite_options }
+          current_validators << new_validator
+
+          fhir_validators[name] = current_validators
         end
 
         # Find a particular validator. Looks through a runnable's parents up to
         # the suite to find a validator with a particular name
-        def find_validator(validator_name)
-          validator = fhir_validators[validator_name] || parent&.find_validator(validator_name)
+        def find_validator(validator_name, selected_suite_options = nil)
+          validators = fhir_validators[validator_name] ||
+                       Array.wrap(parent&.find_validator(validator_name, selected_suite_options))
+
+          validator =
+            if selected_suite_options.present?
+              validators.find do |possible_validator|
+                possible_validator.requirements.nil? || selected_suite_options >= possible_validator.requirements
+              end
+            else
+              validators.first
+            end
 
           raise Exceptions::ValidatorNotFoundException, validator_name if validator.nil?
 

data/lib/inferno/dsl/http_client.rb

@@ -1,4 +1,7 @@
+require 'faraday_middleware'
+
 require_relative 'request_storage'
+require_relative 'tcp_exception_handler'
 
 module Inferno
   module DSL
@@ -31,6 +34,7 @@ module Inferno
       def self.included(klass)
         klass.extend ClassMethods
         klass.include RequestStorage
+        klass.include TCPExceptionHandler
       end
 
       # Return a previously defined HTTP client
@@ -44,7 +48,9 @@ module Inferno
         definition = self.class.http_client_definitions[client]
         return nil if definition.nil?
 
-        http_clients[client] = HTTPClientBuilder.new.build(self, definition)
+        tcp_exception_handler do
+          http_clients[client] = HTTPClientBuilder.new.build(self, definition)
+        end
       end
 
       # @private
@@ -65,18 +71,28 @@ module Inferno
       # @return [Inferno::Entities::Request]
       def get(url = '', client: :default, name: nil, **options)
         store_request('outgoing', name) do
-          client = http_client(client)
-
-          if client
-            client.get(url, nil, options[:headers])
-          elsif url.match?(%r{\Ahttps?://})
-            Faraday.get(url, nil, options[:headers])
-          else
-            raise StandardError, 'Must use an absolute url or define an HTTP client with a base url'
+          tcp_exception_handler do
+            client = http_client(client)
+
+            if client
+              client.get(url, nil, options[:headers])
+            elsif url.match?(%r{\Ahttps?://})
+              connection.get(url, nil, options[:headers])
+            else
+              raise StandardError, 'Must use an absolute url or define an HTTP client with a base url'
+            end
           end
         end
       end
 
+      # @private
+      def connection
+        Faraday.new do |f|
+          f.request :url_encoded
+          f.use FaradayMiddleware::FollowRedirects
+        end
+      end
+
       # Perform an HTTP POST request
       #
       # @param url [String] if this request is using a defined client, this will
@@ -91,14 +107,16 @@ module Inferno
       # @return [Inferno::Entities::Request]
       def post(url = '', body: nil, client: :default, name: nil, **options)
         store_request('outgoing', name) do
-          client = http_client(client)
-
-          if client
-            client.post(url, body, options[:headers])
-          elsif url.match?(%r{\Ahttps?://})
-            Faraday.post(url, body, options[:headers])
-          else
-            raise StandardError, 'Must use an absolute url or define an HTTP client with a base url'
+          tcp_exception_handler do
+            client = http_client(client)
+
+            if client
+              client.post(url, body, options[:headers])
+            elsif url.match?(%r{\Ahttps?://})
+              connection.post(url, body, options[:headers])
+            else
+              raise StandardError, 'Must use an absolute url or define an HTTP client with a base url'
+            end
           end
         end
       end
@@ -114,14 +132,16 @@ module Inferno
       # @return [Inferno::Entities::Request]
       def delete(url = '', client: :default, name: :nil, **options)
         store_request('outgoing', name) do
-          client = http_client(client)
-
-          if client
-            client.delete(url, nil, options[:headers])
-          elsif url.match?(%r{\Ahttps?://})
-            Faraday.delete(url, nil, options[:headers])
-          else
-            raise StandardError, 'Must use an absolute url or define an HTTP client with a base url'
+          tcp_exception_handler do
+            client = http_client(client)
+
+            if client
+              client.delete(url, nil, options[:headers])
+            elsif url.match?(%r{\Ahttps?://})
+              connection.delete(url, nil, options[:headers])
+            else
+              raise StandardError, 'Must use an absolute url or define an HTTP client with a base url'
+            end
           end
         end
       end
@@ -151,17 +171,19 @@ module Inferno
         end
 
         store_request('outgoing', name) do
-          client = http_client(client)
-
-          if client
-            response = client.get(url, nil, options[:headers]) { |req| req.options.on_data = collector }
-          elsif url.match?(%r{\Ahttps?://})
-            response = Faraday.get(url, nil, options[:headers]) { |req| req.options.on_data = collector }
-          else
-            raise StandardError, 'Must use an absolute url or define an HTTP client with a base url'
+          tcp_exception_handler do
+            client = http_client(client)
+
+            if client
+              response = client.get(url, nil, options[:headers]) { |req| req.options.on_data = collector }
+            elsif url.match?(%r{\Ahttps?://})
+              response = connection.get(url, nil, options[:headers]) { |req| req.options.on_data = collector }
+            else
+              raise StandardError, 'Must use an absolute url or define an HTTP client with a base url'
+            end
+            response.env.body = streamed.join
+            response
           end
-          response.env.body = streamed.join
-          response
         end
       end
 

data/lib/inferno/dsl/http_client_builder.rb

@@ -1,3 +1,5 @@
+require 'faraday_middleware'
+
 module Inferno
   module DSL
     # This module contains the HTTP DSL available to test writers.
@@ -12,7 +14,10 @@ module Inferno
         params = { url: url }
         params.merge!(headers: headers) if headers
 
-        Faraday.new(params)
+        Faraday.new(params) do |f|
+          f.request :url_encoded
+          f.use FaradayMiddleware::FollowRedirects
+        end
       end
 
       # Define the base url for an HTTP client. A string or symbol can be