Exception: Kitchen::StandardError

Inherits:

StandardError

• Object
• StandardError
• Kitchen::StandardError

Includes:

Error

Defined in:

lib/kitchen/errors.rb

Overview

Base exception class from which all Kitchen exceptions derive. This class nests an exception when this class is re-raised from a rescue block.

Direct Known Subclasses

ClientError, StateFileLoadError, TransientFailure, UserError

Instance Attribute Summary

• #original ⇒ ::StandardError readonly

  The original (wrapped) exception.

Instance Method Summary

• #initialize(msg, original = $ERROR_INFO) ⇒ StandardError constructor

  Creates a new StandardError exception which optionally wraps an original exception if given or detected by checking the ‘$!` global variable.

Methods included from Error

formatted_backtrace, formatted_exception, formatted_trace, warn_on_stderr

Constructor Details

#initialize(msg, original = $ERROR_INFO) ⇒ StandardError

Creates a new StandardError exception which optionally wraps an original exception if given or detected by checking the ‘$!` global variable.

Parameters:

• msg (String) —

  exception message

• original (::StandardError) (defaults to: $ERROR_INFO) —

  an original exception which will be wrapped (default: ‘$ERROR_INFO`)

# File 'lib/kitchen/errors.rb', line 126

def initialize(msg, original = $ERROR_INFO)
  super(msg)
  @original = original
end

Instance Attribute Details

#original ⇒ ::StandardError (readonly)

Returns the original (wrapped) exception.

Returns:

• (::StandardError) —

  the original (wrapped) exception

# File 'lib/kitchen/errors.rb', line 118

def original
  @original
end