module Inferno::DSL::Results

This module contains methods to set test results.

Public Instance Methods

cancel(message = '') click to toggle source

Halt execution of the current test. This provided for testing purposes and should not be used in real tests.

@param message [String] @api private

# File lib/inferno/dsl/results.rb, line 98
def cancel(message = '')
  raise Exceptions::CancelException, message
end
identifier(identifier = nil) click to toggle source
# File lib/inferno/dsl/results.rb, line 85
def identifier(identifier = nil)
  @identifier ||= identifier
end
omit(message = '') click to toggle source

Halt execution of the current test and mark it as omitted.

@param message [String]

# File lib/inferno/dsl/results.rb, line 40
def omit(message = '')
  raise Exceptions::OmitException, message
end
omit_if(test, message = '') click to toggle source

Halt execution of the current test and mark it as omitted if a condition is true.

@param test [Boolean] @param message [String]

# File lib/inferno/dsl/results.rb, line 49
def omit_if(test, message = '')
  raise Exceptions::OmitException, message if test
end
pass(message = '') click to toggle source

Halt execution of the current test and mark it as passed.

@param message [String]

# File lib/inferno/dsl/results.rb, line 8
def pass(message = '')
  raise Exceptions::PassException, message
end
pass_if(test, message = '') click to toggle source

Halt execution of the current test and mark it as passed if a condition is true.

@param test [Boolean] @param message [String]

# File lib/inferno/dsl/results.rb, line 17
def pass_if(test, message = '')
  raise Exceptions::PassException, message if test
end
skip(message = '') click to toggle source

Halt execution of the current test and mark it as skipped.

@param message [String]

# File lib/inferno/dsl/results.rb, line 24
def skip(message = '')
  raise Exceptions::SkipException, message
end
skip_if(test, message = '') click to toggle source

Halt execution of the current test and mark it as skipped if a condition is true.

@param test [Boolean] @param message [String]

# File lib/inferno/dsl/results.rb, line 33
def skip_if(test, message = '')
  raise Exceptions::SkipException, message if test
end
wait(identifier:, message: '', timeout: 300) click to toggle source

Halt execution of the current test and wait for execution to resume.

@see Inferno::DSL::Runnable#resume_test_route @example

resume_test_route :get, '/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

@param identifier [String] An identifier which can uniquely identify

this test run based on an incoming request. This is necessary so that
the correct test run can be resumed.

@param message [String] @param timeout [Integer] Number of seconds to wait for an incoming

request
# File lib/inferno/dsl/results.rb, line 78
def wait(identifier:, message: '', timeout: 300)
  identifier(identifier)
  wait_timeout(timeout)

  raise Exceptions::WaitException, message
end
wait_timeout(timeout = nil) click to toggle source
# File lib/inferno/dsl/results.rb, line 89
def wait_timeout(timeout = nil)
  @wait_timeout ||= timeout
end