#
# Copyright 2014 Chef Software, Inc.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
#

module Omnibus
  class Error < RuntimeError
  end

  class AbstractMethod < Error
    def initialize(signature)
      @signature = signature
    end

    def to_s
      "'#{@signature}' is an abstract method and must be overridden!"
    end
  end

  class ProjectNotFound < Error
    def initialize(name)
      @name = name
    end

    def to_s
      out = "I could not find an Omnibus project named '#{@name}'! "
      out << "Valid projects are:\n"

      Omnibus.projects.sort.each do |project|
        out << "  * #{project.name}\n"
      end

      out.strip
    end
  end

  class MissingAsset < Error
    def initialize(path)
      @path = path
    end

    def to_s
      "Missing asset! '#{@path}' is not present on disk."
    end
  end

  class BadReplacesLine < Error
    def to_s
      <<-EOH
The `replaces` project DSL statement should never equal the `package_name` or
`name` of a project. The `replaces` option should only be used when you have
published an artifact under one name and then later renamed the packages that
you are publishing and you must obsolete the old package name. For example this
is used, correctly, in chef-client builds:

    name 'chef'
    replaces 'chef-full'

The RPMs and debs which were originally published were named "chef-full" and
this was later renamed, and in order to upgrade the (very old) "chef-full"
packages the new "chef" packages needed to know to uninstall any "chef-full"
packages that were found. Projects which have never been renamed, however,
should never use the replaces line.
      EOH
    end
  end

  class NoPackageFile < Error
    def initialize(package_path)
      @package_path = package_path
    end

    def to_s
      """
      Cannot locate or access the package at the given path:

        #{@package_path}
      """
    end
  end

  class NoPackageMetadataFile < Error
    def initialize(package_metadata_path)
      @package_metadata_path = package_metadata_path
    end

    def to_s
      """
      Cannot locate or access the package metadata file at the given path:

        #{@package_metadata_path}
      """
    end
  end

  # Raise this error if a needed Project configuration value has not
  # been set.
  class MissingProjectConfiguration < Error
    def initialize(parameter_name, sample_value)
      @parameter_name, @sample_value = parameter_name, sample_value
    end

    def to_s
      """
      You are attempting to build a project, but have not specified
      a value for '#{@parameter_name}'!

      Please add code similar to the following to your project DSL file:

         #{@parameter_name} '#{@sample_value}'

      """
    end
  end

  # Raise this error if a needed Software configuration value has not
  # been set.
  class MissingSoftwareConfiguration < Error
    def initialize(software_name, parameter_name, sample_value)
      @software_name, @parameter_name, @sample_value = software_name, parameter_name, sample_value
    end

    def to_s
      """
      You are attempting to build software #{@sofware_name}, but have not specified
      a value for '#{@parameter_name}'!

      Please add code similar to the following to your software DSL file:

         #{@parameter_name} '#{@sample_value}'

      """
    end
  end

  class MissingPatch < Error
    def initialize(patch_name, search_paths)
      @patch_name, @search_paths = patch_name, search_paths
    end

    def to_s
      """
      Attempting to apply the patch #{@patch_name}, but it was not
      found at any of the following locations:

      #{@search_paths.join("\n      ")}
      """
    end
  end

  class MissingTemplate < Error
    def initialize(template_name, search_paths)
      @template_name, @search_paths = template_name, search_paths
    end

    def to_s
      """
      Attempting to evaluate the template #{@template_name}, but it was not
      found at any of the following locations:

      #{@search_paths.join("\n      ")}
      """
    end
  end

  class MissingProjectDependency < Error
    def initialize(name, directories)
      @name, @directories = name, directories
    end

    def to_s
      <<-EOH
I could not find a software named `#{@name}' in any of the sources:

    #{@directories.join("\n      ")}
EOH
    end
  end

  class UnresolvableGitReference < Error
  end

  class UnknownPublisher < Error
    def initialize(backend)
      @backend  = backend
      @backends = Omnibus.constants
                    .map(&:to_s)
                    .select { |const| const.to_s =~ /^(.+)Publisher$/ }
                    .sort
    end

    def to_s
      <<-EOH
I could not find a publisher named #{@backend}. Valid publishers are:

    #{@backends.join("\n    ")}

Please make sure you have spelled everything correctly and try again. If this
error persists, please open an issue on GitHub.
EOH
    end
  end

  class GemNotInstalled < Error
    def initialize(name)
      @name = name
    end

    def to_s
      <<-EOH
I could not load the '#{@name}' gem. Please make sure the gem is installed on
your local system by running `gem install #{@name}`, or by adding the following
to your Gemfile:

    gem '#{@name}'

EOH
    end
  end

  class MissingConfigOption < Error
    def initialize(key, example_value = "'...'")
      @key, @example_value = key, example_value
    end

    def to_s
      <<-EOH
The Omnibus configuration is missing the required configuration option
'#{@key}'. Please define it in your Omnibus config:

  #{@key} #{@example_value}
EOH
    end
  end

  class OldMetadata < Error
    def initialize(path)
      @path = path
    end

    def to_s
      <<-EOH
The metadata at '#{@path}'
was generated by an older version of Omnibus. Please regenerate the package with
this version of Omnibus and retry.
EOH
    end
  end

  class InsufficientSpecification < Error
    def initialize(key, package)
      @key, @package = key, package
    end

    def to_s
      <<-EOH
Software must specify a #{@key} to cache it in S3 (#{@package})!
EOH
    end
  end

  class InvalidValue < Error
    #
    # @param [Symbol] source
    #   the source method that received an invalid value
    # @Param [String] message
    #   the message about why the value is invalid
    #
    def initialize(source, message)
      @source  = source
      @message = message
    end

    def to_s
      <<-EOH
Invalid value for #{@source}. Expected #{@source} to #{@message}!
EOH
    end
  end

  #
  # Raised when Omnibus encounters a platform it does not know how to
  # build/check/handle.
  #
  class UnknownPlatform < Error
    def initialize(platform)
      @platform = platform
    end

    def to_s
      <<-EOH
Unknown platform `#{@platform}'!
I do not know how to proceed!"
EOH
    end
  end

  #
  # Raised when Omnibus encounters a platform_version it does not know how to
  # build/check/handle.
  #
  class UnknownPlatformVersion < Error
    def initialize(platform, version)
      @platform, @version = platform, version
    end

    def to_s
      <<-EOH
Unknown platform version `#{@version}' for #{@platform}!
I do not know how to proceed!"
EOH
    end
  end

  class HealthCheckFailed < Error
    def to_s
      <<-EOH
The health check failed! Please see above for important information.
EOH
    end
  end

  class MissingBuildBlock < Error
    def initialize(software)
      @software = software
    end

    def to_s
      <<-EOH
The software definition `#{@software.name}' does not define a build block. In
order to build the software, you must define a build block like:

    build do
      # Build steps here
    end
      EOH
    end
  end

  class MissingSoftwareSourceURI < Error
    def initialize(software)
      @software = software
    end

    def to_s
      <<-EOH
The software `#{@software.name}' does not declare a `source' attribute which is
a URL. This is not a required attribute, but you are attempting to access
another attribute or method that requires a `source' (URI) is defined.
EOH
    end
  end
end