Exception: Bolt::Error

Inherits:

RuntimeError

• Object
• RuntimeError
• Bolt::Error

Defined in:

lib/bolt/error.rb

Direct Known Subclasses

ApplyError, ApplyInventory::InvalidFunctionCall, CLIError, ContainerFailure, FileError, FutureTimeoutError, InvalidParallelResult, InvalidPlanResult, Inventory::Inventory::WildcardError, Inventory::ValidationError, Inventory::WildcardError, NoImplementationError, Node::BaseError, PAL::PALError, PAL::YamlPlan::Step::StepError, PAL::YamlPlan::Transpiler::ConvertError, ParallelFailure, ParseError, PlanFailure, Plugin::PluginError, Plugin::Puppetdb::FactLookupError, PuppetDBError, PuppetError, PuppetfileError, RunFailure, UnknownTransportError, ValidationError, BoltServer::FileCache::Error, BoltServer::Plugin::PluginNotSupported, BoltServer::RequestError

Instance Attribute Summary

• #details ⇒ Object readonly

  Returns the value of attribute details.

• #error_code ⇒ Object readonly

  Returns the value of attribute error_code.

• #issue_code ⇒ Object readonly

  Returns the value of attribute issue_code.

• #kind ⇒ Object readonly

  Returns the value of attribute kind.

Class Method Summary

• .unknown_plan(plan) ⇒ Object
• .unknown_task(task) ⇒ Object

Instance Method Summary

• #add_filelineno(details) ⇒ Object
• #initialize(msg, kind, details = nil, issue_code = nil) ⇒ Error constructor

  A new instance of Error.

• #msg ⇒ Object
• #to_h ⇒ Object
• #to_json(opts = nil) ⇒ Object
• #to_puppet_error ⇒ Object

Constructor Details

#initialize(msg, kind, details = nil, issue_code = nil) ⇒ Error

Returns a new instance of Error.

# File 'lib/bolt/error.rb', line 9

def initialize(msg, kind, details = nil, issue_code = nil)
  super(msg)
  @kind = kind
  @issue_code = issue_code
  @details = details || {}
  @error_code ||= 1
end

Instance Attribute Details

#details ⇒ Object (readonly)

Returns the value of attribute details.

# File 'lib/bolt/error.rb', line 7

def details
  @details
end

#error_code ⇒ Object (readonly)

Returns the value of attribute error_code.

# File 'lib/bolt/error.rb', line 7

def error_code
  @error_code
end

#issue_code ⇒ Object (readonly)

Returns the value of attribute issue_code.

# File 'lib/bolt/error.rb', line 7

def issue_code
  @issue_code
end

#kind ⇒ Object (readonly)

Returns the value of attribute kind.

# File 'lib/bolt/error.rb', line 7

def kind
  @kind
end

Class Method Details

.unknown_plan(plan) ⇒ Object

# File 'lib/bolt/error.rb', line 49

def self.unknown_plan(plan)
  command = Bolt::Util.powershell? ? "Get-BoltPlan" : "bolt plan show"
  new(
    "Could not find a plan named '#{plan}'. For a list of available plans, run '#{command}'.",
    'bolt/unknown-plan'
  )
end

.unknown_task(task) ⇒ Object

# File 'lib/bolt/error.rb', line 41

def self.unknown_task(task)
  command = Bolt::Util.powershell? ? "Get-BoltTask" : "bolt task show"
  new(
    "Could not find a task named '#{task}'. For a list of available tasks, run '#{command}'.",
    'bolt/unknown-task'
  )
end

Instance Method Details

#add_filelineno(details) ⇒ Object

# File 'lib/bolt/error.rb', line 29

def add_filelineno(details)
  @details.merge!(details) unless @details['file']
end

#msg ⇒ Object

# File 'lib/bolt/error.rb', line 17

def msg
  message
end

#to_h ⇒ Object

# File 'lib/bolt/error.rb', line 21

def to_h
  h = { 'kind' => kind,
        'msg' => message,
        'details' => details }
  h['issue_code'] = issue_code if issue_code
  h
end

#to_json(opts = nil) ⇒ Object

# File 'lib/bolt/error.rb', line 33

def to_json(opts = nil)
  to_h.to_json(opts)
end

#to_puppet_error ⇒ Object

# File 'lib/bolt/error.rb', line 37

def to_puppet_error
  Puppet::DataTypes::Error.from_asserted_hash(to_h)
end