Module: Inferno::DSL::Runnable

Included in:
Entities::TestGroup, Entities::TestSuite
Defined in:
lib/inferno/dsl/runnable.rb

Overview

This module contains the DSL for defining child entities in the test definition framework.

Instance Attribute Summary collapse

Instance Method Summary collapse

Instance Attribute Details

#parent ⇒ Object

Returns the value of attribute parent.



12
13
14
 
# File 'lib/inferno/dsl/runnable.rb', line 12

def parent
  @parent
end

#suite_option_requirements ⇒ Object (readonly)

Returns the value of attribute suite_option_requirements.



13
14
15
 
# File 'lib/inferno/dsl/runnable.rb', line 13

def suite_option_requirements
  @suite_option_requirements
end

Instance Method Details

#block(&block) ⇒ Proc Also known as: run

Set/Get the block that is executed when a runnable is run

Parameters:

  • block (Proc)

Returns:

  • (Proc) —

    the block that is executed when a runnable is run



321
322
323
324
325
 
# File 'lib/inferno/dsl/runnable.rb', line 321

def block(&block)
  return @block unless block_given?

  @block = block
end

#database_id ⇒ Object 



210
211
212
 
# File 'lib/inferno/dsl/runnable.rb', line 210

def database_id
  @database_id ||= id
end

#deep_dup(value) ⇒ Object

Recursively duplicate arrays/hashes to prevent them from being shared across different runnables



53
54
55
56
57
58
59
60
61
 
# File 'lib/inferno/dsl/runnable.rb', line 53

def deep_dup(value)
  if value.is_a? Array
    value.map { |element| deep_dup(element) }
  elsif value.is_a? Hash
    value.transform_values { |element| deep_dup(element) }
  else
    value.dup
  end
end

#description(new_description = nil) ⇒ String

Set/Get a runnable’s description

Parameters:

  • new_description (String) (defaults to: nil)

Returns:

  • (String) —

    the description



238
239
240
241
242
 
# File 'lib/inferno/dsl/runnable.rb', line 238

def description(new_description = nil)
  return @description if new_description.nil?

  @description = format_markdown(new_description)
end

#id(new_id = nil) ⇒ String, Symbol

Set/Get a runnable’s id

Parameters:

  • new_id (String, Symbol) (defaults to: nil)

Returns:

  • (String, Symbol) —

    the id



195
196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/inferno/dsl/runnable.rb', line 195

def id(new_id = nil)
  return @id if new_id.nil? && @id.present?

  prefix = parent ? "#{parent.id}-" : ''
  @base_id = new_id || @base_id || default_id
  @id = "#{prefix}#{@base_id}"

  if @id.length > 255
    hash = Digest::SHA1.hexdigest(@id)[0...10]
    @database_id = "#{@id[0...244]}-#{hash}"
  end

  @id
end

#input_instructions(new_input_instructions = nil) ⇒ String

Set/Get a runnable’s input instructions

Parameters:

  • new_input_instructions (String) (defaults to: nil)

Returns:

  • (String) —

    the input instructions



258
259
260
261
262
 
# File 'lib/inferno/dsl/runnable.rb', line 258

def input_instructions(new_input_instructions = nil)
  return @input_instructions if new_input_instructions.nil?

  @input_instructions = format_markdown(new_input_instructions)
end

#optional(optional = true) ⇒ void

This method returns an undefined value.

Mark as optional. Tests are required by default.

Parameters:

  • optional (Boolean) (defaults to: true) 


283
284
285
 
# File 'lib/inferno/dsl/runnable.rb', line 283

def optional(optional = true) # rubocop:disable Style/OptionalBooleanParameter
  @optional = optional
end

#optional? ⇒ Boolean

The test or group is optional if true

Returns:

  • (Boolean) 


301
302
303
 
# File 'lib/inferno/dsl/runnable.rb', line 301

def optional?
  !!@optional
end

#remove(id_to_remove) ⇒ Object

Remove a child test/group

Examples:

test from: :test1
test from: :test2
test from: :test3

remove :test2

Parameters:

  • id_to_remove (Symbol, String) 


537
538
539
540
541
 
# File 'lib/inferno/dsl/runnable.rb', line 537

def remove(id_to_remove)
  removed = children.select { |child| child.id.to_s.end_with? id_to_remove.to_s }
  children.reject! { |child| child.id.to_s.end_with? id_to_remove.to_s }
  removed.each(&:remove_self_from_repository)
end

#reorder(child_id, new_index) ⇒ Object

Move a child test/group to a new position within the children list.

Examples:

reorder(:test3, 1) # Moves `test3` to index 1

Parameters:

  • child_id (Symbol, String) —

    The ID of the child to be moved.

  • new_index (Integer) —

    The new position for the child.

Raises:



485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
 
# File 'lib/inferno/dsl/runnable.rb', line 485

def reorder(child_id, new_index)
  index = children.find_index { |child| child.id.to_s.end_with? child_id.to_s }
  raise Exceptions::RunnableChildNotFoundException.new(child_id, self) unless index

  unless new_index.between?(0, children.length - 1)
    Inferno::Application[:logger].error <<~ERROR
      Error trying to reorder children for #{self}:
      new_index #{new_index} for #{child_id} is out of range
      (must be between 0 and #{children.length - 1})
    ERROR
    return
  end

  child = children.delete_at(index)
  children.insert(new_index, child)
end

#replace(id_to_replace, replacement_id) {|Inferno::TestGroup, Inferno::Test| ... } ⇒ Object

Replace a child test/group

Examples:

replace :test2, :test4 do
  id :new_test_id
  config(...)
end

Parameters:

  • id_to_replace (Symbol, String) —

    The ID of the child to be replaced.

  • replacement_id (Symbol, String) —

    The global ID of the group/test that will take the place of the child being replaced.

Yields:

Raises:



514
515
516
517
518
519
520
521
522
523
524
525
526
 
# File 'lib/inferno/dsl/runnable.rb', line 514

def replace(id_to_replace, replacement_id, &)
  index = children.find_index { |child| child.id.to_s.end_with? id_to_replace.to_s }
  raise Exceptions::RunnableChildNotFoundException.new(id_to_replace, self) unless index

  if children[index] < Inferno::TestGroup
    group(from: replacement_id, &)
  else
    test(from: replacement_id, &)
  end

  remove(id_to_replace)
  children.insert(index, children.pop)
end

#required(required = true) ⇒ void

This method returns an undefined value.

Mark as required

Tests are required by default. This method is provided to make an existing optional test required.

Parameters:

  • required (Boolean) (defaults to: true) 


294
295
296
 
# File 'lib/inferno/dsl/runnable.rb', line 294

def required(required = true) # rubocop:disable Style/OptionalBooleanParameter
  @optional = !required
end

#required? ⇒ Boolean

The test or group is required if true

Returns:

  • (Boolean) 


308
309
310
 
# File 'lib/inferno/dsl/runnable.rb', line 308

def required?
  !optional?
end

#required_suite_options(suite_option_requirements) ⇒ void

This method returns an undefined value.

Set/get suite options required for this runnable to be executed.

Examples:

suite_option :ig_version,
            list_options: [
              {
                label: 'IG v1',
                value: 'ig_v1'
              },
              {
                label: 'IG v2',
                value: 'ig_v2'
              }
            ]

group from: :ig_v1_group,
      required_suite_options: { ig_version: 'ig_v1' }

group from: :ig_v2_group do
  required_suite_options ig_version: 'ig_v2'
end

Parameters:

  • suite_option_requirements (Hash) 


471
472
473
474
475
476
 
# File 'lib/inferno/dsl/runnable.rb', line 471

def required_suite_options(suite_option_requirements)
  @suite_option_requirements =
    suite_option_requirements.map do |key, value|
      DSL::SuiteOption.new(id: key, value:)
    end
end

#resume_test_route(method, path, tags: [], result: 'pass') { ... } ⇒ void

This method returns an undefined value.

Create a route which will resume a test run when a request is received

Examples:

resume_test_route :get, '/launch', tags: ['launch'] do
  request.query_parameters['iss']
end

test do
  input :issuer
  receives_request :launch

  run do
    wait(
      identifier: issuer,
      message: "Wating to receive a request with an issuer of #{issuer}"
    )
  end
end

Parameters:

  • method (Symbol) —

    the HTTP request type (:get, :post, etc.) for the incoming request

  • path (String) —

    the path for this request. The route will be served with a prefix of /custom/TEST_SUITE_ID to prevent path conflicts. Any of the path options available in Hanami Router can be used here.

  • tags (Array<String>) (defaults to: []) —

    a list of tags to assign to the request

  • result (String) (defaults to: 'pass') —

    the result for the waiting test. Must be one of: ‘pass’, ‘fail’, ‘skip’, ‘omit’, ‘cancel’

Yields:

  • 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 Entities::Request object with the information for the incoming request.

See Also:



382
383
384
385
386
387
388
389
390
 
# File 'lib/inferno/dsl/runnable.rb', line 382

def resume_test_route(method, path, tags: [], result: 'pass', &block)
  route_class = Class.new(ResumeTestRoute) do |klass|
    klass.singleton_class.instance_variable_set(:@test_run_identifier_block, block)
    klass.singleton_class.instance_variable_set(:@tags, tags)
    klass.singleton_class.instance_variable_set(:@result, result)
  end

  route(method, path, route_class)
end

#route(method, path, handler) ⇒ void

This method returns an undefined value.

Create a route to handle a request

Parameters:

  • method (Symbol) —

    the HTTP request type (:get, :post, etc.) for the incoming request. :all will accept all HTTP request types.

  • path (String) —

    the path for this request. The route will be served with a prefix of /custom/TEST_SUITE_ID to prevent path conflicts. Any of the path options available in Hanami Router can be used here.

  • handler (#call) —

    the route handler. This can be any Rack compatible object (e.g. a Proc object, a Sinatra app) as described in the Hanami Router documentation.



424
425
426
 
# File 'lib/inferno/dsl/runnable.rb', line 424

def route(method, path, handler)
  Inferno.routes << { method:, path:, handler:, suite: }
end

#short_description(new_short_description = nil) ⇒ String

Set/Get a runnable’s short one-sentence description

Parameters:

  • new_short_description (String) (defaults to: nil)

Returns:

  • (String) —

    the one-sentence description



248
249
250
251
252
 
# File 'lib/inferno/dsl/runnable.rb', line 248

def short_description(new_short_description = nil)
  return @short_description if new_short_description.nil?

  @short_description = format_markdown(new_short_description)
end

#short_title(new_short_title = nil) ⇒ String

Set/Get a runnable’s short title

Parameters:

  • new_short_title (String) (defaults to: nil)

Returns:

  • (String) —

    the short title



228
229
230
231
232
 
# File 'lib/inferno/dsl/runnable.rb', line 228

def short_title(new_short_title = nil)
  return @short_title if new_short_title.nil?

  @short_title = new_short_title
end

#suite_endpoint(method, path, endpoint_class) ⇒ void

This method returns an undefined value.

Create an endpoint to receive incoming requests during a Test Run.

Examples:

suite_endpoint :post, '/my_suite_endpoint', MySuiteEndpoint

Parameters:

  • method (Symbol) —

    the HTTP request type (:get, :post, etc.) for the incoming request

  • path (String) —

    the path for this request. The route will be served with a prefix of /custom/TEST_SUITE_ID to prevent path conflicts. Any of the path options available in Hanami Router can be used here.

  • a (Class) —

    subclass of Inferno::DSL::SuiteEndpoint

See Also:



406
407
408
 
# File 'lib/inferno/dsl/runnable.rb', line 406

def suite_endpoint(method, path, endpoint_class)
  route(method, path, endpoint_class)
end

#title(new_title = nil) ⇒ String

Set/Get a runnable’s title

Parameters:

  • new_title (String) (defaults to: nil)

Returns:

  • (String) —

    the title



218
219
220
221
222
 
# File 'lib/inferno/dsl/runnable.rb', line 218

def title(new_title = nil)
  return @title if new_title.nil?

  @title = new_title
end

#verifies_requirements(*requirement_ids) ⇒ Array<String>

Set/Get the IDs of requirements verified by this runnable Set with [] to clear the list

Parameters:

  • requirements (Array<String>)

Returns:

  • (Array<String>) —

    the requirement IDs



269
270
271
272
273
274
275
276
277
 
# File 'lib/inferno/dsl/runnable.rb', line 269

def verifies_requirements(*requirement_ids)
  if requirement_ids.empty?
    @requirement_ids || []
  elsif requirement_ids == [[]]
    @requirement_ids = []
  else
    @requirement_ids = requirement_ids
  end
end