module Berkshelf class BerkshelfError < StandardError class << self # @param [Integer] code def status_code(code) define_method(:status_code) { code } define_singleton_method(:status_code) { code } end end alias_method :message, :to_s end class DeprecatedError < BerkshelfError; status_code(10); end class InternalError < BerkshelfError; status_code(99); end class ArgumentError < InternalError; end class AbstractFunction < InternalError def to_s 'Function must be implemented on includer' end end class BerksfileNotFound < BerkshelfError; status_code(100); end class NoVersionForConstraints < BerkshelfError; status_code(101); end class DuplicateLocationDefined < BerkshelfError; status_code(102); end class CookbookNotFound < BerkshelfError; status_code(103); end class GitError < BerkshelfError status_code(104) # @param [#to_s] stderr # the error that came from stderr def initialize(stderr) @stderr = stderr.to_s end # A common header for all git errors. The #to_s method should # use this before outputting any specific errors. # # @return [String] def header 'An error occurred during Git execution:' end def to_s [ header, "", " " + @stderr.to_s.split("\n").map(&:strip).join("\n "), "" ].join("\n") end end class AmbiguousGitRef < GitError def initialize(ref) @ref = ref end def to_s [ header, "", " Ambiguous Git ref: '#{@ref}'", "", ].join("\n") end end class InvalidGitRef < GitError def initialize(ref) @ref = ref end def to_s [ header, "", " Invalid Git ref: '#{@ref}'", "", ].join("\n") end end class DuplicateDependencyDefined < BerkshelfError; status_code(105); end class NoSolutionError < BerkshelfError status_code(106) attr_reader :demands # @param [Array] demands def initialize(demands) @demands = demands end def to_s "Unable to find a solution for demands: #{demands.join(', ')}" end end class CookbookSyntaxError < BerkshelfError; status_code(107); end class InvalidGitURI < BerkshelfError status_code(110) # @param [String] uri def initialize(uri) @uri = uri end def to_s "'#{@uri}' is not a valid Git URI" end end class UnknownGitHubProtocol < BerkshelfError status_code(110) # @param [String] protocol def initialize(protocol) @protocol = protocol end def to_s "'#{@protocol}' is not supported for the 'github' location key - please use 'git' instead" end end class GitNotFound < BerkshelfError status_code(110) def to_s 'Could not find a Git executable in your path - please add it and try again' end end class ConstraintNotSatisfied < BerkshelfError; status_code(111); end class BerksfileReadError < BerkshelfError status_code(113) # @param [#status_code] original_error def initialize(original_error) @original_error = original_error @error_message = original_error.to_s @error_backtrace = original_error.backtrace end def status_code @original_error.respond_to?(:status_code) ? @original_error.status_code : 113 end alias_method :original_backtrace, :backtrace def backtrace Array(@error_backtrace) + Array(original_backtrace) end def to_s [ "An error occurred while reading the Berksfile:", "", " #{@error_message}", ].join("\n") end end class MismatchedCookbookName < BerkshelfError status_code(114) # @param [Berkshelf::Dependency] dependency # the dependency with the expected name # @param [Berkshelf::CachedCookbook] cached_cookbook # the cached_cookbook with the mismatched name def initialize(dependency, cached_cookbook) @dependency = dependency @cached_cookbook = cached_cookbook end def to_s [ "In your Berksfile, you have:", "", " cookbook '#{@dependency.name}'", "", "But that cookbook is actually named '#{@cached_cookbook.cookbook_name}'", "", "This can cause potentially unwanted side-effects in the future", "", "NOTE: If you don't explicitly set the `name` attribute in the metadata, the name of the directory will be used!", ].join("\n") end end class InvalidConfiguration < BerkshelfError status_code(115) def initialize(errors) @errors = errors end def to_s [ 'Invalid configuration:', @errors.map { |key, errors| errors.map { |error| " #{key} #{error}" } }, ].join("\n") end end class ConfigExists < BerkshelfError; status_code(116); end class ConfigurationError < BerkshelfError; status_code(117); end class InsufficientPrivledges < BerkshelfError; status_code(119); end class DependencyNotFound < BerkshelfError; status_code(120); end class ValidationFailed < BerkshelfError; status_code(121); end class InvalidVersionConstraint < BerkshelfError; status_code(122); end class CommunitySiteError < BerkshelfError; status_code(123); end class CookbookValidationFailure < BerkshelfError status_code(124) # @param [Berkshelf::Location] location # the location (or any subclass) raising this validation error # @param [Berkshelf::CachedCookbook] cached_cookbook # the cached_cookbook that does not satisfy the constraint def initialize(dependency, cached_cookbook) @dependency = dependency @cached_cookbook = cached_cookbook end def to_s "The cookbook downloaded for #{@dependency} did not satisfy the constraint." end end class ClientKeyFileNotFound < BerkshelfError; status_code(125); end class UploadFailure < BerkshelfError; end class FrozenCookbook < UploadFailure; status_code(126); end class OutdatedDependency < BerkshelfError status_code(128) # @param [Berkshelf::Dependency] locked_dependency # the locked dependency # @param [Berkshelf::Dependency] dependency # the dependency that is outdated def initialize(locked_dependency, dependency) @locked_dependency = locked_dependency @dependency = dependency end def to_s "Berkshelf could not find compatible versions for cookbook '#{@dependency.name}':\n" + " In Berksfile:\n" + " #{@dependency.name} (#{@dependency.version_constraint})\n\n" + " In Berksfile.lock:\n" + " #{@locked_dependency.name} (#{@locked_dependency.locked_version})\n\n" + "Try running `berks update #{@dependency.name}, which will try to find '#{@dependency.name}' matching " + "'#{@dependency.version_constraint}'." end end class EnvironmentNotFound < BerkshelfError status_code(129) def initialize(environment_name) @environment_name = environment_name end def to_s "The environment '#{@environment_name}' does not exist" end end class ChefConnectionError < BerkshelfError status_code(130) def to_s 'There was an error connecting to the Chef Server' end end class UnknownCompressionType < BerkshelfError status_code(131) def initialize(destination) @destination = destination end def to_s "The file at '#{@destination}' is not a known compression type" end end # Raised when a cookbook or its recipes contain a space or invalid # character in the path. # # @param [Berkshelf::CachedCookbook] cookbook # the cookbook that failed validation # @param [Array<#to_s>] files # the list of files that were not valid class InvalidCookbookFiles < BerkshelfError status_code(132) def initialize(cookbook, files) @cookbook = cookbook @files = files end def to_s [ "The cookbook '#{@cookbook.cookbook_name}' has invalid filenames:", "", " " + @files.map(&:to_s).join("\n "), "", "Please note, spaces are not a valid character in filenames", ].join("\n") end end # Raised when a CachedCookbook has a license file that isn't allowed # by the Berksfile. # # @param [Berkshelf::CachedCookbook] cookbook # the cookbook that failed license validation class LicenseNotAllowed < BerkshelfError status_code(133) def initialize(cookbook) @cookbook = cookbook end def to_s msg = "'#{@cookbook.cookbook_name}' has a license of '#{@cookbook.metadata.license}', but" msg << " '#{@cookbook.metadata.license}' is not in your list of allowed licenses" msg end end class LicenseNotFound < BerkshelfError status_code(134) attr_reader :license def initialize(license) @license = license end def to_s "Unknown license: '#{license}'\n" + "Available licenses: #{Berkshelf::CookbookGenerator::LICENSES.join(', ')}" end end # Raised when a cookbook or its recipes contain a space or invalid # character in the path. class ConfigNotFound < BerkshelfError status_code(135) # @param [String] type # the type of config that was not found (Berkshelf, Chef, etc) # @param [#to_s] path # the path to the specified Chef config that did not exist def initialize(type, path) @type = type.to_s @path = path end def to_s "No #{@type.capitalize} config file found at: '#{@path}'!" end end class LockfileParserError < BerkshelfError status_code(136) # @param [String] lockfile # the path to the Lockfile # @param [~Exception] original # the original exception class def initialize(lockfile, original) @lockfile = Pathname.new(lockfile.to_s).basename.to_s @original = original end def to_s "Error reading the Berkshelf lockfile `#{@lockfile}` (#{@original.class})" end end class InvalidSourceURI < BerkshelfError status_code(137) attr_reader :reason def initialize(url, reason = nil) @url = url @reason = reason end def to_s msg = "'#{@url}' is not a valid Berkshelf source URI." msg + " #{reason}." unless reason.nil? end end class DuplicateDemand < BerkshelfError; status_code(138); end end