omnibus 3.2.2 → 4.0.0.beta.1

data/lib/omnibus/core_extensions.rb

@@ -0,0 +1 @@
+require 'omnibus/core_extensions/open_uri'

data/lib/omnibus/core_extensions/open_uri.rb

@@ -0,0 +1,58 @@
+require 'open-uri'
+
+module OpenURI
+  class << self
+    #
+    # The is a bug in Ruby's implementation of OpenURI that prevents redirects
+    # from HTTP -> HTTPS. That should totally be a valid redirect, so we
+    # override that method here and call it a day.
+    #
+    # Note: this does NOT permit HTTPS -> HTTP redirects, as that would be a
+    # major security hole in the fabric of space-time!
+    #
+    def default_redirectable?(uri1, uri2)
+      a, b = uri1.scheme.downcase, uri2.scheme.downcase
+
+      a == b || (a == 'http' && b == 'https')
+    end
+    alias_method :redirectable?, :default_redirectable?
+
+    #
+    # Permit all redirects.
+    #
+    # Note: this DOES permit HTTP -> HTTP redirects, and that is a major
+    # security hole!
+    #
+    # @return [true]
+    #
+    def unsafe_redirectable?(uri1, uri2)
+      a, b = uri1.scheme.downcase, uri2.scheme.downcase
+
+      a == b || (a == 'http' && b == 'https') || (a == 'https' && b == 'http')
+    end
+
+    #
+    # Override the default open_uri method to search for our custom option to
+    # permit unsafe redirects.
+    #
+    # @example
+    #   open('http://example.com', allow_unsafe_redirects: true)
+    #
+    alias_method :original_open_uri, :open_uri
+    def open_uri(name, *rest, &block)
+      options = rest.find { |arg| arg.is_a?(Hash) } || {}
+
+      if options.delete(:allow_unsafe_redirects)
+        class << self
+          alias_method :redirectable?, :unsafe_redirectable?
+        end
+      end
+
+      original_open_uri(name, *rest, &block)
+    ensure
+      class << self
+        alias_method :redirectable?, :default_redirectable?
+      end
+    end
+  end
+end

data/lib/omnibus/digestable.rb

@@ -15,6 +15,7 @@
 #
 
 require 'digest'
+require 'pathname'
 
 module Omnibus
   module Digestable
@@ -63,13 +64,18 @@ module Omnibus
     def digest_directory(path, type = :md5)
       digest = digest_from_type(type)
 
-      Dir.glob("#{path}/**/*").each do |filename|
+      FileSyncer.glob("#{path}/**/*").each do |filename|
+        # Calculate the filename relative to the given path. Since directories
+        # are SHAed according to their filepath, two difference directories on
+        # disk would have different SHAs even if they had the same content.
+        relative = Pathname.new(filename).relative_path_from(Pathname.new(path))
+
         case ftype = File.ftype(filename)
         when 'file'
-          update_with_string(digest, "#{ftype} #{filename}")
+          update_with_string(digest, "#{ftype} #{relative}")
           update_with_file_contents(digest, filename)
         else
-          update_with_string(digest, "#{ftype} #{filename}")
+          update_with_string(digest, "#{ftype} #{relative}")
         end
       end
 

data/lib/omnibus/exceptions.rb

@@ -15,199 +15,112 @@
 #
 
 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 Error < RuntimeError; end
 
-  class MissingAsset < Error
+  class NoPackageFile < 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:
+Could not locate or access the package at the given path:
 
-        #{@package_path}
-      """
+    #{@path}
+EOH
     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
+    def initialize(path)
+      @path = path
     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}'
+      <<-EOH
+Could not locate or access the package metadata file at the given path:
 
-      """
+    #{@path}
+EOH
     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
+  class MissingRequiredAttribute < Error
+    def initialize(instance, name, sample = '<VALUE>')
+      @instance, @name, @sample = instance, name, sample
+      @class = instance.class.name.split('::').last
     end
 
     def to_s
-      """
-      You are attempting to build software #{@sofware_name}, but have not specified
-      a value for '#{@parameter_name}'!
+      <<-EOH
+Missing required attribute `#{@name}' for #{@class}. You must
+specify a value for `#{@name}' in your DSL file:
 
-      Please add code similar to the following to your software DSL file:
+    #{@name} #{@sample.inspect}
 
-         #{@parameter_name} '#{@sample_value}'
+Or set the value on the object:
 
-      """
+    #{@class.downcase}.#{@name}(#{@sample.inspect})
+EOH
     end
   end
 
   class MissingPatch < Error
-    def initialize(patch_name, search_paths)
-      @patch_name, @search_paths = patch_name, search_paths
+    def initialize(name, search_paths)
+      @name, @search_paths = 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:
+      <<-EOH
+Attempting to apply the patch `#{@name}', but it was not found at any of the
+following locations:
 
-      #{@search_paths.join("\n      ")}
-      """
+#{@search_paths.map { |path| "    #{path}" }.join("\n")}
+EOH
     end
   end
 
   class MissingTemplate < Error
-    def initialize(template_name, search_paths)
-      @template_name, @search_paths = template_name, search_paths
+    def initialize(template, search_paths)
+      @template, @search_paths = template, search_paths
     end
 
     def to_s
-      """
-      Attempting to evaluate the template #{@template_name}, but it was not
-      found at any of the following locations:
+      <<-EOH
+Attempting to evaluate the template `#{@name}', but it was not found at any of
+the following locations:
 
-      #{@search_paths.join("\n      ")}
-      """
+#{@search_paths.map { |path| "    #{path}" }.join("\n")}
+EOH
     end
   end
 
-  class MissingProjectDependency < Error
-    def initialize(name, directories)
-      @name, @directories = name, directories
+  class MissingProject < Error
+    def initialize(name)
+      @name = name
+      @possible_paths = Omnibus.possible_paths_for(Config.project_dir)
     end
 
     def to_s
       <<-EOH
-I could not find a software named `#{@name}' in any of the sources:
+I could not find a project named `#{@name}' in any of the project locations:"
 
-    #{@directories.join("\n      ")}
+#{@possible_paths.map { |path| "    #{path}"}.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
+  class MissingSoftware < Error
+    def initialize(name)
+      @name = name
+      @possible_paths = Omnibus.possible_paths_for(Config.software_dir)
     end
 
     def to_s
       <<-EOH
-I could not find a publisher named #{@backend}. Valid publishers are:
+I could not find a software named `#{@name}' in any of the software locations:"
 
-    #{@backends.join("\n    ")}
-
-Please make sure you have spelled everything correctly and try again. If this
-error persists, please open an issue on GitHub.
+#{@possible_paths.map { |path| "    #{path}"}.join("\n")}
 EOH
     end
   end
@@ -219,27 +132,11 @@ EOH
 
     def to_s
       <<-EOH
-I could not load the '#{@name}' gem. Please make sure the gem is installed on
+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
@@ -251,7 +148,7 @@ EOH
 
     def to_s
       <<-EOH
-Software must specify a #{@key} to cache it in S3 (#{@package})!
+Software must specify a `#{@key}; to cache it in S3 (#{@package})!
 EOH
     end
   end
@@ -260,7 +157,7 @@ EOH
     #
     # @param [Symbol] source
     #   the source method that received an invalid value
-    # @Param [String] message
+    # @param [String] message
     #   the message about why the value is invalid
     #
     def initialize(source, message)
@@ -270,7 +167,7 @@ EOH
 
     def to_s
       <<-EOH
-Invalid value for #{@source}. Expected #{@source} to #{@message}!
+Invalid value for `#{@source}'. Expected #{@source} to #{@message}!
 EOH
     end
   end
@@ -317,33 +214,77 @@ EOH
     end
   end
 
-  class MissingBuildBlock < Error
-    def initialize(software)
-      @software = software
-    end
+  class ChecksumMismatch < Error
+    def initialize(software, expected, actual)
+      super <<-EOH
+Verification for #{software.name} failed due to a checksum mismatch:
 
-    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:
+    expected: #{expected}
+    actual:   #{actual}
 
-    build do
-      # Build steps here
-    end
-      EOH
+This added security check is used to prevent MITM attacks when downloading the
+remote file. If you have updated the version or URL for the download, you will
+also need to update the checksum value. You can find the checksum value on the
+software publisher's website.
+EOH
     end
   end
 
-  class MissingSoftwareSourceURI < Error
-    def initialize(software)
-      @software = software
+  class CommandFailed < Error
+    def initialize(cmd)
+      status = cmd.exitstatus
+
+      if cmd.environment.nil? || cmd.environment.empty?
+        env = nil
+      else
+        env = cmd.environment.sort.map { |k,v| "#{k}=#{v}" }.join(' ')
+      end
+
+      command = cmd.command
+      command_with_env = [env, command].compact.join(' ')
+
+      stdout = cmd.stdout.empty? ? '(nothing)' : cmd.stdout.strip
+      stderr = cmd.stderr.empty? ? '(nothing)' : cmd.stderr.strip
+
+      super <<-EOH
+The following shell command exited with status #{status}:
+
+    $ #{command_with_env}
+
+Output:
+
+    #{stdout}
+
+Error:
+
+    #{stderr}
+EOH
     end
+  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.
+  class CommandTimeout < Error
+    def initialize(cmd)
+      status = cmd.exitstatus
+
+      if cmd.environment.nil? || cmd.environment.empty?
+        env = nil
+      else
+        env = cmd.environment.sort.map { |k,v| "#{k}=#{v}" }.join(' ')
+      end
+
+      command = cmd.command
+      command_with_env = [env, command].compact.join(' ')
+
+      timeout = cmd.timeout.to_s.reverse.gsub(/...(?=.)/,'\&,').reverse
+
+      super <<-EOH
+The following shell command timed out at #{timeout} seconds:
+
+    $ #{command_with_env}
+
+Please increase the `:timeout' value or run the command manually to make sure it
+is completing successfully. Sometimes it is common for a command to wait for
+user input.
 EOH
     end
   end