inferno_core 0.0.6 → 0.0.7

data/lib/inferno/dsl/runnable.rb

@@ -16,7 +16,7 @@ module Inferno
       # - add the subclass to the relevant repository when it is created
       # - copy the class instance variables from the superclass
       # - add a hook to the subclass so that its subclasses do the same
-      # @api private
+      # @private
       def self.extended(extending_class)
         super
         extending_class.extend Configurable
@@ -41,7 +41,7 @@ module Inferno
       # classes. When inheriting from a Runnable class, these class instance
       # variables need to be copied. Any child Runnable classes will themselves
       # need to be subclassed so that their parent can be updated.
-      # @api private
+      # @private
       def copy_instance_variables(subclass)
         instance_variables.each do |variable|
           next if [:@id, :@groups, :@tests, :@parent, :@children, :@test_count, :@config].include?(variable)
@@ -63,12 +63,13 @@ module Inferno
         end
       end
 
-      # @api private
+      # @private
       def add_self_to_repository
         repository.insert(self)
       end
 
       # An instance of the repository for the class using this module
+      # @private
       def repository
         nil
       end
@@ -76,7 +77,7 @@ module Inferno
       # This method defines a child entity. Classes using this module should
       # alias the method name they wish to use to define child entities to this
       # method.
-      # @api private
+      # @private
       def define_child(*args, &block)
         hash_args = process_args(args)
 
@@ -96,7 +97,7 @@ module Inferno
         klass
       end
 
-      # @api private
+      # @private
       def process_args(args)
         hash_args =
           if args[0].is_a? Hash
@@ -112,13 +113,13 @@ module Inferno
         hash_args
       end
 
-      # @api private
+      # @private
       def child_metadata(metadata = nil)
         @child_metadata = metadata if metadata
         @child_metadata
       end
 
-      # @api private
+      # @private
       def create_child_class(hash_args)
         superclass_id = hash_args.delete :from
 
@@ -131,7 +132,7 @@ module Inferno
         Class.new(superclass)
       end
 
-      # @api private
+      # @private
       def configure_child_class(klass, hash_args) # rubocop:disable Metrics/CyclomaticComplexity
         inputs.each do |name|
           next if klass.inputs.any? { |klass_input_name| klass_input_name == name }
@@ -177,11 +178,15 @@ module Inferno
         end
       end
 
-      # @api private
+      # @private
       def handle_child_definition_block(klass, &block)
         klass.class_eval(&block) if block_given?
       end
 
+      # Set/Get a runnable's id
+      #
+      # @param new_id [String,Symbol]
+      # @return [String,Symbol] the id
       def id(new_id = nil)
         return @id if new_id.nil? && @id.present?
 
@@ -197,12 +202,20 @@ module Inferno
         @id = "#{prefix}#{@base_id}"
       end
 
+      # Set/Get a runnable's title
+      #
+      # @param new_title [String]
+      # @return [String] the title
       def title(new_title = nil)
         return @title if new_title.nil?
 
         @title = new_title
       end
 
+      # Set/Get a runnable's description
+      #
+      # @param new_description [String]
+      # @return [String] the description
       def description(new_description = nil)
         return @description if new_description.nil?
 
@@ -239,7 +252,7 @@ module Inferno
 
       # Define outputs
       #
-      # @param output_lists [Symbol]
+      # @param output_list [Symbol]
       # @return [void]
       # @example
       #   output :patient_id, :bearer_token
@@ -250,30 +263,32 @@ module Inferno
         end
       end
 
-      # @api private
+      # @private
       def default_id
         to_s
       end
 
-      # @api private
+      # @private
       def inputs
         @inputs ||= []
       end
 
+      # @private
       def input_definitions
         config.inputs.slice(*inputs)
       end
 
+      # @private
       def output_definitions
         config.outputs.slice(*outputs)
       end
 
-      # @api private
+      # @private
       def outputs
         @outputs ||= []
       end
 
-      # @api private
+      # @private
       def child_types
         return [] if ancestors.include? Inferno::Entities::Test
         return [:groups] if ancestors.include? Inferno::Entities::TestSuite
@@ -281,7 +296,7 @@ module Inferno
         [:groups, :tests]
       end
 
-      # @api private
+      # @private
       def children
         @children ||= []
       end
@@ -292,7 +307,7 @@ module Inferno
         @validator_url = url
       end
 
-      # @api private
+      # @private
       def suite
         return self if ancestors.include? Inferno::Entities::TestSuite
 
@@ -329,8 +344,8 @@ module Inferno
       # @yield This method takes a block which must return the identifier
       #   defined when a test was set to wait for the test run that hit this
       #   route. The block has access to the `request` method which returns a
-      #   {Inferno::DSL::Request} object with the information for the incoming
-      #   request.
+      #   {Inferno::Entities::Request} object with the information for the
+      #   incoming request.
       def resume_test_route(method, path, &block)
         route_class = Class.new(ResumeTestRoute) do
           define_method(:test_run_identifier, &block)
@@ -357,10 +372,12 @@ module Inferno
         Inferno.routes << { method: method, path: path, handler: handler, suite: suite }
       end
 
+      # @private
       def test_count
         @test_count ||= children&.reduce(0) { |sum, child| sum + child.test_count } || 0
       end
 
+      # @private
       def required_inputs(prior_outputs = [])
         required_inputs = inputs.select do |input|
           !input_definitions[input][:optional] && !prior_outputs.include?(input)
@@ -371,6 +388,7 @@ module Inferno
         (required_inputs + children_required_inputs).flatten.uniq
       end
 
+      # @private
       def missing_inputs(submitted_inputs)
         submitted_inputs = [] if submitted_inputs.nil?
 

data/lib/inferno/entities/header.rb

@@ -2,13 +2,20 @@ module Inferno
   module Entities
     # A `Header` represents an HTTP request/response header
     #
-    # @attr_accessor [String] id of the header
-    # @attr_accessor [String] request_id index of the HTTP request
-    # @attr_accessor [String] name header name
-    # @attr_accessor [String] value header value
-    # @attr_accessor [String] type request/response
-    # @attr_accessor [Time] created_at
-    # @attr_accessor [Time] updated_at
+    # @!attribute id
+    #   @return [String] id of the header
+    # @!attribute request_id
+    #   @return [String] index of the HTTP request
+    # @!attribute name
+    #   @return [String] header name
+    # @!attribute value
+    #   @return [String] header value
+    # @!attribute type
+    #   @return [String] request/response
+    # @!attribute created_at
+    #   @return [Time]
+    # @!attribute updated_at
+    #   @return [Time]
     class Header < Entity
       ATTRIBUTES = [:id, :request_id, :name, :type, :value, :created_at, :updated_at].freeze
 

data/lib/inferno/entities/message.rb

@@ -2,14 +2,22 @@ module Inferno
   module Entities
     # A `Message` represents a message generated during a test.
     #
-    # @attr_accessor [String] id of the message
-    # @attr_accessor [String] index of the message. Used for ordering.
-    # @attr_accessor [String] result_id
-    # @attr_accessor [Inferno::Entities::Result] result
-    # @attr_accessor [String] type
-    # @attr_accessor [String] message
-    # @attr_accessor [Time] created_at
-    # @attr_accessor [Time] updated_at
+    # @!attribute id
+    #   @return [String] id of the message
+    # @!attribute index
+    #   @return [String] index of the message. Used for ordering.
+    # @!attribute result_id
+    #   @return [String]
+    # @!attribute result
+    #   @return [Inferno::Entities::Result]
+    # @!attribute type
+    #   @return [String]
+    # @!attribute message
+    #   @return [String]
+    # @!attribute created_at
+    #   @return [Time]
+    # @!attribute updated_at
+    #   @return [Time]
     class Message < Entity
       ATTRIBUTES = [:id, :index, :message, :result_id, :result, :type, :created_at, :updated_at].freeze
       TYPES = ['error', 'warning', 'info'].freeze

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_accessor [String] id of the request
-    # @attr_accessor [String] index of the request. Used for ordering.
-    # @attr_accessor [String] verb http verb
-    # @attr_accessor [String] url request url
-    # @attr_accessor [String] direction incoming/outgoing
-    # @attr_accessor [String] name name for the request
-    # @attr_accessor [String] status http response status code
-    # @attr_accessor [String] request_body body of the http request
-    # @attr_accessor [String] response_body body of the http response
-    # @attr_accessor [Array<Inferno::Entities::Header>] headers http
-    #   request/response headers
-    # @attr_accessor [String] result_id id of the result for this request
-    # @attr_accessor [String] test_session_id id of the test session for this request
-    # @attr_accessor [Time] created_at creation timestamp
-    # @attr_accessor [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,
@@ -94,7 +107,7 @@ module Inferno
         }
       end
 
-      # @api private
+      # @private
       def to_hash
         {
           id: id,
@@ -122,7 +135,7 @@ 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}"
@@ -143,7 +156,7 @@ module Inferno
           )
         end
 
-        # @api private
+        # @private
         def from_http_response(response, test_session_id:, direction: 'outgoing', name: nil)
           request_headers =
             response.env.request_headers
@@ -165,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,36 +3,43 @@ module Inferno
     # A `Result` represents the result of running a `Test`, `TestGroup`,
     # or `TestSuite`
     #
-    # @attr_accessor [String] id id of the session
-    # @attr_accessor [Time] created_at creation timestamp
-    # @attr_accessor [Time] updated_at update timestamp
-    # @attr_accessor [String] reference_type type of entity this result belongs
-    #   to (`Test`, `TestGroup`, or `TestSuite`)
-    # @attr_accessor [String, nil] test_id id of the `Test` this result belongs
-    #   to
-    # @attr_accessor [Test, nil] test the `Test` this result belongs to
-    # @attr_accessor [String, nil] test_group_id id of the `TestGroup` this
-    #   result belongs to
-    # @attr_accessor [TestGroup, nil] test_group the `TestGroup` this result
-    #   belongs to
-    # @attr_accessor [String, nil] test_suite_id id of the `TestSuite` this
-    #   result belongs to
-    # @attr_accessor [TestSuite, nil] test_suite the `TestSuite` this result
-    #   belongs to
-    # @attr_accessor [String] result the result (`pass`, `fail`, `skip`, `omit`,
-    #   `error`, `running`, `wait`, `cancel`)
-    # @attr_accessor [String] result_message summary message for this result
-    # @attr_accessor [String] test_run_id the `TestRun` this result belongs to
-    # @attr_accessor [String] test_session_id the `TestSession` this result
-    #   belongs to
-    # @attr_accessor [Array<Inferno::Entities::Message>] messages additional
-    #   messages for this result
-    # @attr_accessor [Array<Inferno::Entities::Request>] request_summaries
-    #   summaries of the requests associated with this result
-    # @attr_accessor [String] input_json JSON string of the inputs used for this
+    # @!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
-    # @attr_accessor [String] output_json JSON string of the outputs created by
-    #   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,

data/lib/inferno/entities/session_data.rb

@@ -3,12 +3,18 @@ module Inferno
     # `SessionData` represents a piece of saved state for a `TestSession`.
     # These are used to store test inputs and outputs.
     #
-    # @attr_accessor [String] id of the test input
-    # @attr_accessor [String] name
-    # @attr_accessor [String] value
-    # @attr_accessor [String] test_session_id
-    # @attr_accessor [Time] created_at
-    # @attr_accessor [Time] updated_at
+    # @!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
 

data/lib/inferno/entities/test.rb

@@ -15,12 +15,14 @@ module Inferno
       attr_accessor :result_message
       attr_reader :test_session_id, :scratch
 
+      # @private
       def initialize(**params)
         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
@@ -100,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)
@@ -109,6 +112,7 @@ module Inferno
         end
       end
 
+      # @private
       def respond_to_missing?(name, _include_private = false)
         self.class.parent&.new&.respond_to?(name)
       end
@@ -155,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?
 
@@ -163,6 +171,7 @@ module Inferno
 
         alias run block
 
+        # @private
         def default_id
           return name if name.present?
 
@@ -170,16 +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)
@@ -189,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_run.rb

@@ -2,12 +2,35 @@ module Inferno
   module Entities
     # A `TestRun` represents a request to execute an executable set of tests.
     #
-    # @attr_accessor [String] id of the test input
-    # @attr_accessor [String] test_session_id
-    # @attr_accessor [String] status
-    # @attr_accessor [String] test_suite_id
-    # @attr_accessor [String] test_group_id
-    # @attr_accessor [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 = [

data/lib/inferno/entities/test_session.rb

@@ -2,17 +2,23 @@ module Inferno
   module Entities
     # A `TestSession` represents an individual testing session.
     #
-    # @attr_accessor [String] id id of the session
-    # @attr_accessor [Time] created_at creation timestamp
-    # @attr_accessor [Time] updated_at update timestamp
-    # @attr_accessor [String] test_suite_id id of the `TestSuite` being run in
-    #   this session
-    # @attr_accessor [Inferno::Entities::TestSuite] test_suite the `TestSuite` being run in
-    #   this session
-    # @attr_accessor [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_accessor [Array<Inferno::Entities::TestResult>] results the
-    #   `TestResults` associated with this session
     class TestSession < Entity
       ATTRIBUTES = [:id, :created_at, :updated_at, :test_suite_id, :test_suite, :test_runs, :results].freeze