# frozen_string_literal: true require 'bolt/util' module Bolt class Error < RuntimeError attr_reader :kind, :details, :issue_code, :error_code def initialize(msg, kind, details = nil, issue_code = nil) super(msg) @kind = kind @issue_code = issue_code @details = details || {} @error_code ||= 1 end def msg message end def to_h h = { 'kind' => kind, 'msg' => message, 'details' => details } h['issue_code'] = issue_code if issue_code h end def add_filelineno(details) @details.merge!(details) unless @details['file'] end def to_json(opts = nil) to_h.to_json(opts) end def to_puppet_error Puppet::DataTypes::Error.from_asserted_hash(to_h) end 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 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 end class CLIError < Bolt::Error def initialize(msg) super(msg, "bolt/cli-error") end end class ContainerFailure < Bolt::Error attr_reader :result def initialize(result) details = { 'value' => result.value, 'object' => result.object } message = "Plan aborted: Running container '#{result.object}' failed." super(message, 'bolt/container-failure', details) @result = result @error_code = 2 end end class RunFailure < Bolt::Error attr_reader :result_set def initialize(result_set, action, object = nil) details = { 'action' => action, 'object' => object, 'result_set' => result_set } object_msg = " '#{object}'" if object message = "Plan aborted: #{action}#{object_msg} failed on #{result_set.error_set.length} target" message += "s" unless result_set.error_set.length == 1 super(message, 'bolt/run-failure', details) @result_set = result_set @error_code = 2 end end class ApplyFailure < RunFailure def initialize(result_set) super(result_set, 'apply', 'catalog') @kind = 'bolt/apply-failure' end def to_s result_set.select(&:error_hash).map { |result| result.error_hash['msg'] }.join("\n") end end class FutureTimeoutError < Bolt::Error def initialize(name, timeout) details = { 'future' => name } message = "Future '#{name}' timed out after #{timeout} seconds." super(message, 'bolt/future-timeout-error', details) end end class ParallelFailure < Bolt::Error def initialize(results, failed_indices) details = { 'action' => 'parallelize', 'failed_indices' => failed_indices, 'results' => results } message = "Plan aborted: parallel block failed on #{failed_indices.length} target" message += "s" unless failed_indices.length == 1 super(message, 'bolt/parallel-failure', details) @error_code = 2 end end class PlanFailure < Error def initialize(*args) super(*args) @error_code = 2 end end # This class is used to treat a Puppet Error datatype as a ruby error outside PAL class PuppetError < Error def self.from_error(err) new(err.msg, err.kind, err.details, err.issue_code) end end class PuppetfileError < Error def initialize(err) super("Failed to sync modules from the Puppetfile: #{err}", 'bolt/puppetfile-error') end end class ApplyError < Error def initialize(target, msg) super("Apply failed to compile for #{target}: #{msg}", 'bolt/apply-error') end end class ParseError < Error def initialize(msg) super(msg, 'bolt/parse-error') end end class InvalidPlanResult < Error def initialize(plan_name, result_str) super("Plan #{plan_name} returned an invalid result: #{result_str}", 'bolt/invalid-plan-result', { 'plan_name' => plan_name, 'result_string' => result_str }) end end class InvalidParallelResult < Error def initialize(result_str, file, line) super("Background block returned an invalid result: #{result_str}", 'bolt/invalid-plan-result', { 'file' => file, 'line' => line, 'result_string' => result_str }) end end class ValidationError < Bolt::Error def initialize(msg) super(msg, 'bolt/validation-error') end end class FileError < Bolt::Error def initialize(msg, path) super(msg, 'bolt/file-error', { "path" => path }) end end end