inferno_core 0.0.3 → 0.0.7

data/lib/inferno/entities/request.rb

@@ -2,21 +2,34 @@ module Inferno
   module Entities
     # A `Request` represents a request and response issued during a test.
     #
-    # @attr_reader [String] id of the request
-    # @attr_reader [String] index of the request. Used for ordering.
-    # @attr_reader [String] verb http verb
-    # @attr_reader [String] url request url
-    # @attr_reader [String] direction incoming/outgoing
-    # @attr_reader [String] name name for the request
-    # @attr_reader [String] status http response status code
-    # @attr_reader [String] request_body body of the http request
-    # @attr_reader [String] response_body body of the http response
-    # @attr_reader [Array<Inferno::Entities::Header>] headers http
-    #   request/response headers
-    # @attr_reader [String] result_id id of the result for this request
-    # @attr_reader [String] test_session_id id of the test session for this request
-    # @attr_reader [Time] created_at creation timestamp
-    # @attr_reader [Time] updated_at update timestamp
+    # @!attribute id
+    #   @return [String] id of the request
+    # @!attribute index
+    #   @return [String] index of the request. Used for ordering.
+    # @!attribute verb
+    #   @return [String] http verb
+    # @!attribute url
+    #   @return [String] request url
+    # @!attribute direction
+    #   @return [String] incoming/outgoing
+    # @!attribute name
+    #   @return [String] name for the request
+    # @!attribute status
+    #   @return [String] http response status code
+    # @!attribute request_body
+    #   @return [String] body of the http request
+    # @!attribute response_body
+    #   @return [String] body of the http response
+    # @!attribute headers
+    #   @return [Array<Inferno::Entities::Header>] http request/response headers
+    # @!attribute result_id
+    #   @return [String] id of the result for this request
+    # @!attribute test_session_id
+    #   @return [String] id of the test session for this request
+    # @!attribute created_at
+    #   @return [Time] creation timestamp
+    # @!attribute updated_at
+    #   @return [Time] update timestamp
     class Request < Entity
       ATTRIBUTES = [
         :id, :index, :verb, :url, :direction, :name, :status,
@@ -36,12 +49,17 @@ module Inferno
         @headers = params[:headers]&.map { |header| header.is_a?(Hash) ? Header.new(header) : header } || []
       end
 
+      # @return [Hash<String, String>]
+      def query_parameters
+        Addressable::URI.parse(url).query_values || {}
+      end
+
       # Find a response header
       #
       # @param name [String] the header name
       # @return [Inferno::Entities::RequestHeader, nil]
       def response_header(name)
-        response_headers.find { |header| header.name == name.downcase }
+        response_headers.find { |header| header.name.casecmp(name).zero? }
       end
 
       # Find a request header
@@ -49,7 +67,7 @@ module Inferno
       # @param name [String] the header name
       # @return [Inferno::Entities::RequestHeader, nil]
       def request_header(name)
-        request_headers.find { |header| header.name == name.downcase }
+        request_headers.find { |header| header.name.casecmp(name).zero? }
       end
 
       # All of the request headers
@@ -89,7 +107,7 @@ module Inferno
         }
       end
 
-      # @api private
+      # @private
       def to_hash
         {
           id: id,
@@ -117,7 +135,28 @@ module Inferno
       end
 
       class << self
-        # @api private
+        # @private
+        def from_rack_env(env, name: nil)
+          rack_request = env['router.request'].rack_request
+          url = "#{rack_request.base_url}#{rack_request.path}"
+          url += "?#{rack_request.query_string}" if rack_request.query_string.present?
+          request_headers =
+            env
+              .select { |key, _| key.start_with? 'HTTP_' }
+              .transform_keys { |key| key.delete_prefix('HTTP_').tr('_', '-').downcase }
+              .map { |header_name, value| Header.new(name: header_name, value: value, type: 'request') }
+
+          new(
+            verb: rack_request.request_method.downcase,
+            url: url,
+            direction: 'incoming',
+            name: name,
+            request_body: rack_request.body.string,
+            headers: request_headers
+          )
+        end
+
+        # @private
         def from_http_response(response, test_session_id:, direction: 'outgoing', name: nil)
           request_headers =
             response.env.request_headers
@@ -139,7 +178,7 @@ module Inferno
           )
         end
 
-        # @api private
+        # @private
         def from_fhir_client_reply(reply, test_session_id:, direction: 'outgoing', name: nil)
           request = reply.request
           response = reply.response

data/lib/inferno/entities/result.rb

@@ -3,32 +3,49 @@ module Inferno
     # A `Result` represents the result of running a `Test`, `TestGroup`,
     # or `TestSuite`
     #
-    # @attr_reader [String] id id of the session
-    # @attr_reader [Time] created_at creation timestamp
-    # @attr_reader [Time] updated_at update timestamp
-    # @attr_reader [String] reference_type type of entity this result belongs to
-    #   (`Test`, `TestGroup`, or `TestSuite`)
-    # @attr_reader [String, nil] test_id id of the `Test` this result belongs to
-    # @attr_reader [Test, nil] test the `Test` this result belongs to
-    # @attr_reader [String, nil] test_group_id id of the `TestGroup` this result belongs to
-    # @attr_reader [TestGroup, nil] test_group the `TestGroup` this result belongs to
-    # @attr_reader [String, nil] test_suite_id id of the `TestSuite` this result belongs to
-    # @attr_reader [TestSuite, nil] test_suite the `TestSuite` this result belongs to
-    # @attr_reader [String] result the result (`pass`, `fail`, `skip`, `omit`,
-    #   `error`, `running`, `wait`, `cancel`)
-    # @attr_reader [String] result_message summary message for this result
-    # @attr_reader [String] test_run_id the `TestRun` this result belongs to
-    # @attr_reader [String] test_session_id the `TestSession` this result
-    #   belongs to
-    # @attr_reader [Array<Inferno::Entities::Message>] messages additional
-    #   messages for this result
-    # @attr_reader [Array<Inferno::Entities::Request>] request_summaries
-    #   summaries of the requests associated with this result
+    # @!attribute id
+    #   @return [String] id of the session
+    # @!attribute created_at
+    #   @return [Time] creation timestamp
+    # @!attribute updated_at
+    #   @return [Time] update timestamp
+    # @!attribute test_id
+    #   @return [String, nil] id of the `Test` this result belongs to
+    # @!attribute test
+    #   @return [Test, nil] the `Test` this result belongs to
+    # @!attribute test_group_id
+    #   @return [String, nil] id of the `TestGroup` this result belongs to
+    # @!attribute test_group
+    #   @return [TestGroup, nil] the `TestGroup` this result belongs to
+    # @!attribute test_suite_id
+    #   @return [String, nil] id of the `TestSuite` this result belongs to
+    # @!attribute test_suite
+    #   @return [TestSuite, nil] the `TestSuite` this result belongs to
+    # @!attribute result
+    #   @return [String] the result (`pass`, `fail`, `skip`, `omit`, `error`,
+    #   `running`, `wait`, `cancel`)
+    # @!attribute result_message
+    #   @return [String] summary message for this result
+    # @!attribute test_run_id
+    #   @return [String] the `TestRun` this result belongs to
+    # @!attribute test_session_id
+    #   @return [String] the `TestSession` this result belongs to
+    # @!attribute messages
+    #   @return [Array<Inferno::Entities::Message>] additional messages for this
+    #   result
+    # @!attribute requests
+    #   @return [Array<Inferno::Entities::Request>] summaries of the requests
+    #   associated with this result
+    # @!attribute input_json
+    #   @return [String] JSON string of the inputs used for this result
+    # @!attribute output_json
+    #   @return [String] JSON string of the outputs created by this result
     class Result < Entity
       ATTRIBUTES = [
         :id, :created_at, :updated_at, :test_id, :test, :test_group_id,
         :test_group, :test_suite_id, :test_suite, :test_run_id,
-        :test_session_id, :result, :result_message, :messages, :requests
+        :test_session_id, :result, :result_message, :messages, :requests,
+        :input_json, :output_json
       ].freeze
       RESULT_OPTIONS = ['cancel', 'wait', 'running', 'error', 'fail', 'skip', 'omit', 'pass'].freeze
 
@@ -41,9 +58,15 @@ module Inferno
         @requests = (params[:requests] || []).map { |request| Request.new(request) }
       end
 
+      # @return [Inferno::Entities::Test, Inferno::Entities::TestGroup, Inferno::Entities::TestSuite]
       def runnable
         test || test_group || test_suite
       end
+
+      # @return [Boolean]
+      def waiting?
+        result == 'wait'
+      end
     end
   end
 end

data/lib/inferno/entities/session_data.rb

@@ -0,0 +1,39 @@
+module Inferno
+  module Entities
+    # `SessionData` represents a piece of saved state for a `TestSession`.
+    # These are used to store test inputs and outputs.
+    #
+    # @!attribute id
+    #   @return [String] id of the test input
+    # @!attribute name
+    #   @return [String]
+    # @!attribute value
+    #   @return [String]
+    # @!attribute test_session_id
+    #   @return [String]
+    # @!attribute created_at
+    #   @return [Time]
+    # @!attribute updated_at
+    #   @return [Time]
+    class SessionData < Entity
+      ATTRIBUTES = [:id, :name, :value, :test_session_id, :created_at, :updated_at].freeze
+
+      include Inferno::Entities::Attributes
+
+      def initialize(params)
+        super(params, ATTRIBUTES)
+      end
+
+      def to_hash
+        {
+          id: id,
+          name: name,
+          value: value,
+          test_session_id: test_session_id,
+          created_at: created_at,
+          updated_at: updated_at
+        }
+      end
+    end
+  end
+end

data/lib/inferno/entities/test.rb

@@ -1,28 +1,34 @@
 require_relative '../dsl'
 require_relative '../repositories/tests'
+require_relative '../utils/markdown_formatter'
+require 'pry'
 
 module Inferno
   module Entities
     class Test
       extend Forwardable
       include DSL
+      include Inferno::Utils::MarkdownFormatter
 
       def_delegators 'self.class', :title, :id, :block, :inputs, :outputs
 
       attr_accessor :result_message
-      attr_reader :inputs, :test_session_id
+      attr_reader :test_session_id, :scratch
 
+      # @private
       def initialize(**params)
-        @inputs = params[:inputs]
+        params[:inputs]&.each { |key, value| instance_variable_set("@#{key}", value) }
+        @scratch = params[:scratch]
         @test_session_id = params[:test_session_id]
       end
 
+      # @private
       def messages
         @messages ||= []
       end
 
       def add_message(type, message)
-        messages << { type: type.to_s, message: message }
+        messages << { type: type.to_s, message: format_markdown(message) }
       end
 
       # Set output values. Once set, these values will be available to any
@@ -33,11 +39,21 @@ 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
         end
       end
 
+      # @api private
+      # A hash containing outputs that have been set during execution and need
+      # to be persisted. A test may not always update all outputs, so this is
+      # used to prevent overwriting an output with nil when it wasn't updated.
+      def outputs_to_persist
+        @outputs_to_persist ||= {}
+      end
+
       # Add an informational message to the results of a test. If passed a
       # block, a failed assertion will become an info message and test execution
       # will continue.
@@ -86,6 +102,7 @@ module Inferno
         add_message('warning', e.message)
       end
 
+      # @private
       def method_missing(name, *args, &block)
         parent_instance = self.class.parent&.new
         if parent_instance.respond_to?(name)
@@ -95,6 +112,7 @@ module Inferno
         end
       end
 
+      # @private
       def respond_to_missing?(name, _include_private = false)
         self.class.parent&.new&.respond_to?(name)
       end
@@ -102,15 +120,24 @@ module Inferno
       class << self
         # Define inputs for this Test
         #
-        # @param inputs [Symbol]
+        # @param name [Symbol] name of the input
+        # @param other_names [Symbol] array of symbols if specifying multiple inputs
+        # @param input_definition [Hash] options for input such as type, description, or title
+        # @option input_definition [String] :title Human readable title for input
+        # @option input_definition [String] :description Description for the input
+        # @option input_definition [String] :type 'text' | 'textarea'
         # @return [void]
         # @example
-        #   input :patient_id, :bearer_token
-        def input(*input_definitions)
+        #   input :patientid, title: 'Patient ID', description: 'The ID of the patient being searched for'
+        # @example
+        #   input :textarea, title: 'Textarea Input Example', type: 'textarea'
+        def input(name, *other_names, **input_definition)
           super
 
-          input_definitions.each do |input|
-            attr_reader input
+          if other_names.present?
+            [name, *other_names].each { |input| attr_reader input }
+          else
+            attr_reader name
           end
         end
 
@@ -132,6 +159,10 @@ module Inferno
           Inferno::Repositories::Tests.new
         end
 
+        # Set/Get the block that is executed when a Test is run
+        #
+        # @param block [Proc]
+        # @return [Proc] the block that is executed when a Test is run
         def block(&block)
           return @block unless block_given?
 
@@ -140,6 +171,7 @@ module Inferno
 
         alias run block
 
+        # @private
         def default_id
           return name if name.present?
 
@@ -147,12 +179,19 @@ module Inferno
           "Test#{suffix}"
         end
 
+        # @private
         def reference_hash
           {
             test_id: id
           }
         end
 
+        # @private
+        def test_count
+          1
+        end
+
+        # @private
         def method_missing(name, *args, &block)
           parent_instance = parent&.new
           if parent_instance.respond_to?(name)
@@ -162,6 +201,7 @@ module Inferno
           end
         end
 
+        # @private
         def respond_to_missing?(name, _include_private = false)
           parent&.new&.respond_to?(name)
         end

data/lib/inferno/entities/test_group.rb

@@ -79,6 +79,14 @@ module Inferno
             test_group_id: id
           }
         end
+
+        def run_as_group(value = true) # rubocop:disable Style/OptionalBooleanParameter
+          @run_as_group = value
+        end
+
+        def run_as_group?
+          @run_as_group || false
+        end
       end
     end
   end

data/lib/inferno/entities/test_run.rb

@@ -2,13 +2,37 @@ module Inferno
   module Entities
     # A `TestRun` represents a request to execute an executable set of tests.
     #
-    # @attr_reader [String] id of the test input
-    # @attr_reader [String] test_session_id
-    # @attr_reader [String] status
-    # @attr_reader [String] test_suite_id
-    # @attr_reader [String] test_group_id
-    # @attr_reader [String] test_id
+    # @!attribute id
+    #   @return [String] id of the test run
+    # @!attribute created_at
+    #   @return [Time] creation timestamp
+    # @!attribute updated_at
+    #   @return [Time] update timestamp
+    # @!attribute test_session_id
+    #   @return [String]
+    # @!attribute status
+    #   @return [String]
+    # @!attribute test_id
+    #   @return [String, nil] id of the `Test` this result belongs to
+    # @!attribute test
+    #   @return [Test, nil] the `Test` this result belongs to
+    # @!attribute test_group_id
+    #   @return [String, nil] id of the `TestGroup` this result belongs to
+    # @!attribute test_group
+    #   @return [TestGroup, nil] the `TestGroup` this result belongs to
+    # @!attribute test_suite_id
+    #   @return [String, nil] id of the `TestSuite` this result belongs to
+    # @!attribute test_suite
+    #   @return [TestSuite, nil] the `TestSuite` this result belongs to
+    # @!attribute inputs
+    #   @return [Array<Hash>]
+    # @!attribute results
+    #   @return [Array<Inferno::Entities::Result>]
+    # @!attribute identifier
+    #   @return [String, nil] identfier for a waiting `TestRun`
+    # @!attribute wait_timeout
     class TestRun < Entity
+      STATUS_OPTIONS = ['queued', 'running', 'waiting', 'done'].freeze
       ATTRIBUTES = [
         :id,
         :test_session_id,
@@ -21,6 +45,8 @@ module Inferno
         :test_suite,
         :inputs,
         :results,
+        :identifier,
+        :wait_timeout,
         :created_at,
         :updated_at
       ].freeze
@@ -47,6 +73,10 @@ module Inferno
         super.merge(test_session: test_session).compact
       end
 
+      def test_count
+        @test_count ||= runnable.test_count
+      end
+
       private
 
       def load_runnable

data/lib/inferno/entities/test_session.rb

@@ -2,19 +2,25 @@ module Inferno
   module Entities
     # A `TestSession` represents an individual testing session.
     #
-    # @attr_reader [String] id id of the session
-    # @attr_reader [Time] created_at creation timestamp
-    # @attr_reader [Time] updated_at update timestamp
-    # @attr_reader [String] test_suite_id id of the `TestSuite` being run in
-    #   this session
-    # @attr_reader [Inferno::Entities::TestSuite] test_suite the `TestSuite` being run in
-    #   this session
-    # @attr_reader [Array<Inferno::Entities::TestRun>] test_runs the `TestRuns`
+    # @!attribute id
+    #   @return [String] id of the session
+    # @!attribute created_at
+    #   @return [Time] creation timestamp
+    # @!attribute updated_at
+    #   @return [Time] update timestamp
+    # @!attribute test_suite_id
+    #   @return [String] id of the `TestSuite` being run in this session
+    # @!attribute test_suite
+    #   @return [Inferno::Entities::TestSuite] the `TestSuite` being run in this
+    #   session
+    # @!attribute test_runs
+    #   @return [Array<Inferno::Entities::TestRun>] the `TestRuns` associated
+    #   with this session
+    # @!attribute results
+    #   @return [Array<Inferno::Entities::TestResult>] the `TestResults`
     #   associated with this session
-    # @attr_reader [Array<Inferno::Entities::TestResult>] test_results the
-    #   `TestResults` associated with this session
     class TestSession < Entity
-      ATTRIBUTES = [:id, :created_at, :updated_at, :test_suite_id, :test_suite, :test_runs, :test_results].freeze
+      ATTRIBUTES = [:id, :created_at, :updated_at, :test_suite_id, :test_suite, :test_runs, :results].freeze
 
       include Inferno::Entities::Attributes
 

data/lib/inferno/entities.rb

@@ -4,9 +4,9 @@ require_relative 'entities/header'
 require_relative 'entities/message'
 require_relative 'entities/request'
 require_relative 'entities/result'
+require_relative 'entities/session_data'
 require_relative 'entities/test'
 require_relative 'entities/test_group'
-require_relative 'entities/test_input'
 require_relative 'entities/test_run'
 require_relative 'entities/test_session'
 require_relative 'entities/test_suite'

data/lib/inferno/exceptions.rb

@@ -27,6 +27,18 @@ module Inferno
       end
     end
 
+    class WaitException < TestResultException
+      def result
+        'wait'
+      end
+    end
+
+    class CancelException < TestResultException
+      def result
+        'cancel'
+      end
+    end
+
     class ParentNotLoadedException < RuntimeError
       def initialize(klass, id)
         super("No #{klass.name.demodulize} found with id '#{id}'")
@@ -38,5 +50,17 @@ module Inferno
         super("No '#{validator_name}' validator found")
       end
     end
+
+    class RequiredInputsNotFound < RuntimeError
+      def initialize(missing_inputs)
+        super("Missing the following required inputs: #{missing_inputs.join(', ')}")
+      end
+    end
+
+    class NotUserRunnableException < RuntimeError
+      def initialize
+        super('The chosen runnable must be run as part of a group')
+      end
+    end
   end
 end

data/lib/inferno/jobs/execute_test_run.rb

@@ -0,0 +1,14 @@
+module Inferno
+  module Jobs
+    class ExecuteTestRun
+      include Sidekiq::Worker
+
+      def perform(test_run_id)
+        test_run = Inferno::Repositories::TestRuns.new.find(test_run_id)
+        test_session = Inferno::Repositories::TestSessions.new.find(test_run.test_session_id)
+
+        TestRunner.new(test_session: test_session, test_run: test_run).start
+      end
+    end
+  end
+end

data/lib/inferno/jobs/resume_test_run.rb

@@ -0,0 +1,14 @@
+module Inferno
+  module Jobs
+    class ResumeTestRun
+      include Sidekiq::Worker
+
+      def perform(test_run_id)
+        test_run = Inferno::Repositories::TestRuns.new.find(test_run_id)
+        test_session = Inferno::Repositories::TestSessions.new.find(test_run.test_session_id)
+
+        TestRunner.new(test_session: test_session, test_run: test_run, resume: true).start
+      end
+    end
+  end
+end

data/lib/inferno/jobs.rb

@@ -0,0 +1,16 @@
+require 'sidekiq'
+
+require_relative 'jobs/execute_test_run'
+require_relative 'jobs/resume_test_run'
+
+module Inferno
+  module Jobs
+    def self.perform(job_klass, *params)
+      if Application['async_jobs']
+        job_klass.perform_async(*params)
+      else
+        job_klass.new.perform(*params)
+      end
+    end
+  end
+end