omnibus 3.1.1 → 3.2.0.rc.1

data/lib/omnibus/digestable.rb

@@ -0,0 +1,131 @@
+#
+# Copyright 2012-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.
+#
+
+require 'digest'
+
+module Omnibus
+  module Digestable
+    #
+    # Calculate the digest of the file at the given path. Files are read in
+    # binary chunks to prevent Ruby from exploding.
+    #
+    # @param [String] path
+    #   the path of the file to digest
+    # @param [Symbol] type
+    #   the type of digest to use
+    #
+    # @return [String]
+    #   the hexdigest of the file at the path
+    #
+    def digest(path, type = :md5)
+      digest = digest_from_type(type)
+
+      update_with_file_contents(digest, path)
+      digest.hexdigest
+    end
+
+    #
+    # Calculate the digest of a directory at the given path. Each file in the
+    # directory is read in binary chunks to prevent excess memory usage.
+    # Filesystem entries of all types are included in the digest, including
+    # directories, links, and sockets. The contents of non-file entries are
+    # represented as:
+    #
+    #   $type $path
+    #
+    # while the contents of regular files are represented as:
+    #
+    #   file $path
+    #
+    # and then appended by the binary contents of the file/
+    #
+    # @param [String] path
+    #   the path of the directory to digest
+    # @param [Symbol] type
+    #   the type of digest to use
+    #
+    # @return [String]
+    #   the hexdigest of the directory
+    #
+    def digest_directory(path, type = :md5)
+      digest = digest_from_type(type)
+
+      Dir.glob("#{path}/**/*").each do |filename|
+        case ftype = File.ftype(filename)
+        when 'file'
+          update_with_string(digest, "#{ftype} #{filename}")
+          update_with_file_contents(digest, filename)
+        else
+          update_with_string(digest, "#{ftype} #{filename}")
+        end
+      end
+
+      digest.hexdigest
+    end
+
+    private
+
+    #
+    # Create a new instance of the {Digest} class that corresponds to the given
+    # type.
+    #
+    # @param [#to_s] type
+    #   the type of digest to use
+    #
+    # @return [~Digest]
+    #   an instance of the digest class
+    #
+    def digest_from_type(type)
+      id = type.to_s.upcase
+      instance = Digest.const_get(id).new
+    end
+
+    #
+    # Update the digest with the given contents of the file, reading in small
+    # chunks to reduce memory. This method will update the given +digest+
+    # parameter, but returns nothing.
+    #
+    # @param [Digest] digest
+    #   the digest to update
+    # @param [String] filename
+    #   the path to the file on disk to read
+    #
+    # @return [void]
+    #
+    def update_with_file_contents(digest, filename)
+      File.open(filename) do |io|
+        while (chunk = io.read(1024 * 8))
+          digest.update(chunk)
+        end
+      end
+    end
+
+    #
+    # Update the digest with the given string. This method will update the given
+    # +digest+ parameter, but returns nothing.
+    #
+    # @param [Digest] digest
+    #   the digest to update
+    # @param [String] string
+    #   the string to read
+    #
+    # @return [void]
+    #
+    def update_with_string(digest, string)
+      digest.update(string)
+    end
+  end
+end

data/lib/omnibus/exceptions.rb

@@ -15,7 +15,10 @@
 #
 
 module Omnibus
-  class AbstractMethod < RuntimeError
+  class Error < RuntimeError
+  end
+
+  class AbstractMethod < Error
     def initialize(signature)
       @signature = signature
     end
@@ -25,7 +28,7 @@ module Omnibus
     end
   end
 
-  class ProjectNotFound < RuntimeError
+  class ProjectNotFound < Error
     def initialize(name)
       @name = name
     end
@@ -34,15 +37,15 @@ module Omnibus
       out = "I could not find an Omnibus project named '#{@name}'! "
       out << "Valid projects are:\n"
 
-      Omnibus.project_names.sort.each do |project_name|
-        out << "  * #{project_name}\n"
+      Omnibus.projects.sort.each do |project|
+        out << "  * #{project.name}\n"
       end
 
       out.strip
     end
   end
 
-  class MissingAsset < RuntimeError
+  class MissingAsset < Error
     def initialize(path)
       @path = path
     end
@@ -52,37 +55,7 @@ module Omnibus
     end
   end
 
-  class InvalidS3Configuration < RuntimeError
-    def initialize(s3_bucket, s3_access_key, s3_secret_key)
-      @s3_bucket, @s3_access_key, @s3_secret_key = s3_bucket, s3_access_key, s3_secret_key
-    end
-
-    def to_s
-      <<-EOH
-One or more required S3 configuration values is missing.
-
-Your effective configuration was the following:
-
-    s3_bucket     #{@s3_bucket.inspect}
-    s3_access_key #{@s3_access_key.inspect}
-    s3_secret_key #{@s3_secret_key.inspect}
-
-If you truly do want S3 caching, you should add values similar to the following
-in your Omnibus config file:
-
-    s3_bucket     ENV['S3_BUCKET_NAME']
-    s3_access_key ENV['S3_ACCESS_KEY']
-    s3_secret_key ENV['S3_SECRET_KEY']
-
-Note that you are not required to use environment variables as illustrated (and
-the ones listed have no special significance in Omnibus), but it is encouraged
-to prevent spread of sensitive information and inadvertent check-in of same to
-version control systems.
-      EOH
-    end
-  end
-
-  class BadReplacesLine < RuntimeError
+  class BadReplacesLine < Error
     def to_s
       <<-EOH
 The `replaces` project DSL statement should never equal the `package_name` or
@@ -103,7 +76,7 @@ should never use the replaces line.
     end
   end
 
-  class NoPackageFile < RuntimeError
+  class NoPackageFile < Error
     def initialize(package_path)
       @package_path = package_path
     end
@@ -117,7 +90,7 @@ should never use the replaces line.
     end
   end
 
-  class NoPackageMetadataFile < RuntimeError
+  class NoPackageMetadataFile < Error
     def initialize(package_metadata_path)
       @package_metadata_path = package_metadata_path
     end
@@ -131,41 +104,9 @@ should never use the replaces line.
     end
   end
 
-  class InvalidS3ReleaseConfiguration < RuntimeError
-    def initialize(s3_bucket, s3_access_key, s3_secret_key)
-      @s3_bucket, @s3_access_key, @s3_secret_key = s3_bucket, s3_access_key, s3_secret_key
-    end
-
-    def to_s
-      """
-      One or more required S3 configuration values is missing.
-
-      Your effective configuration was the following:
-
-          release_s3_bucket     => #{@s3_bucket.inspect}
-          release_s3_access_key => #{@s3_access_key.inspect}
-          release_s3_secret_key => #{@s3_secret_key.inspect}
-
-      To release a package to S3, add the following values to your
-      config file:
-
-          release_s3_bucket      ENV['S3_BUCKET_NAME']
-          release_s3_access_key  ENV['S3_ACCESS_KEY']
-          release_s3_secret_key  ENV['S3_SECRET_KEY']
-
-      Note that you are not required to use environment variables as
-      illustrated (and the ones listed have no special significance in
-      Omnibus), but it is encouraged to prevent spread of sensitive
-      information and inadvertent check-in of same to version control
-      systems.
-
-      """
-    end
-  end
-
   # Raise this error if a needed Project configuration value has not
   # been set.
-  class MissingProjectConfiguration < RuntimeError
+  class MissingProjectConfiguration < Error
     def initialize(parameter_name, sample_value)
       @parameter_name, @sample_value = parameter_name, sample_value
     end
@@ -185,7 +126,7 @@ should never use the replaces line.
 
   # Raise this error if a needed Software configuration value has not
   # been set.
-  class MissingSoftwareConfiguration < RuntimeError
+  class MissingSoftwareConfiguration < Error
     def initialize(software_name, parameter_name, sample_value)
       @software_name, @parameter_name, @sample_value = software_name, parameter_name, sample_value
     end
@@ -203,7 +144,7 @@ should never use the replaces line.
     end
   end
 
-  class MissingPatch < RuntimeError
+  class MissingPatch < Error
     def initialize(patch_name, search_paths)
       @patch_name, @search_paths = patch_name, search_paths
     end
@@ -218,7 +159,7 @@ should never use the replaces line.
     end
   end
 
-  class MissingTemplate < RuntimeError
+  class MissingTemplate < Error
     def initialize(template_name, search_paths)
       @template_name, @search_paths = template_name, search_paths
     end
@@ -233,21 +174,160 @@ should never use the replaces line.
     end
   end
 
-  class MissingProjectDependency < RuntimeError
-    def initialize(dep_name, search_paths)
-      @dep_name, @search_paths = dep_name, search_paths
+  class MissingProjectDependency < Error
+    def initialize(name, directories)
+      @name, @directories = name, directories
     end
 
     def to_s
-      """
-      Attempting to load the project dependency '#{@dep_name}', but it was
-      not found at any of the following locations:
+      <<-EOH
+I could not find a software named `#{@name}' in any of the sources:
 
-      #{@search_paths.join("\n      ")}
-      """
+    #{@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 UnresolvableGitReference < RuntimeError
+  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_family it does not know how to
+  # build/check/handle.
+  #
+  class UnknownPlatformFamily < Error
+    def initialize(family)
+      @family = family
+    end
+
+    def to_s
+      <<-EOH
+Unknown platform family `#{@family}'!
+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
 end