omnibus 3.0.0 → 3.1.0

data/lib/omnibus/install_path_cache.rb

@@ -1,6 +1,5 @@
 #
-# Copyright:: Copyright (c) 2014 Chef Software, Inc.
-# License:: Apache License, Version 2.0
+# 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.
@@ -15,8 +14,6 @@
 # limitations under the License.
 #
 
-require 'omnibus/util'
-require 'omnibus/config'
 require 'fileutils'
 require 'digest'
 
@@ -25,7 +22,7 @@ module Omnibus
     include Util
 
     def initialize(install_path, software)
-      @install_path = install_path
+      @install_path = install_path.sub(/^([A-Za-z]:)/, '') # strip drive letter on Windows
       @software = software
     end
 
@@ -42,14 +39,13 @@ module Omnibus
     # Creates the full path if it does not exist already
     def create_cache_path
       FileUtils.mkdir_p(File.dirname(cache_path))
-      shellout!("git --git-dir=#{cache_path} init -q") unless cache_path_exists?
+      quiet_shellout!("git --git-dir=#{cache_path} init -q") unless cache_path_exists?
       true
     end
 
     # Computes the tag for this cache entry
     def tag
       name = @software.name
-      version = @software.version
 
       # Accumulate an array of all the software projects that come before
       # the name and version we are tagging. So if you have
@@ -69,26 +65,29 @@ module Omnibus
       # build params invalidate cache.
       dep_string = IO.read(@software.source_config) + dep_string
       digest = Digest::SHA256.hexdigest(dep_string)
+
+      version = @software.version_for_cache
+
       "#{name}-#{version}-#{digest}"
     end
 
     # Create an incremental install path cache for the software step
     def incremental
       create_cache_path
-      shellout!("git --git-dir=#{cache_path} --work-tree=#{@install_path} add -A -f")
+      quiet_shellout!(%Q(git --git-dir=#{cache_path} --work-tree=#{@install_path} add -A -f))
       begin
-        shellout!("git --git-dir=#{cache_path} --work-tree=#{@install_path} commit -q -m 'Backup of #{tag}'")
+        quiet_shellout!(%Q(git --git-dir=#{cache_path} --work-tree=#{@install_path} commit -q -m "Backup of #{tag}"))
       rescue Mixlib::ShellOut::ShellCommandFailed => e
         if e.message !~ /nothing to commit/
           raise
         end
       end
-      shellout!("git --git-dir=#{cache_path} --work-tree=#{@install_path} tag -f '#{tag}'")
+      quiet_shellout!(%Q(git --git-dir=#{cache_path} --work-tree=#{@install_path} tag -f "#{tag}"))
     end
 
     def restore
       create_cache_path
-      cmd = shellout("git --git-dir=#{cache_path} --work-tree=#{@install_path} tag -l #{tag}")
+      cmd = quiet_shellout(%Q(git --git-dir=#{cache_path} --work-tree=#{@install_path} tag -l "#{tag}"))
 
       restore_me = false
       cmd.stdout.each_line do |line|
@@ -96,7 +95,7 @@ module Omnibus
       end
 
       if restore_me
-        shellout!("git --git-dir=#{cache_path} --work-tree=#{@install_path} checkout -f '#{tag}'")
+        quiet_shellout!(%Q(git --git-dir=#{cache_path} --work-tree=#{@install_path} checkout -f "#{tag}"))
         true
       else
         false

data/lib/omnibus/library.rb

@@ -1,6 +1,5 @@
 #
-# Copyright:: Copyright (c) 2012-2014 Chef Software, Inc.
-# License:: Apache License, Version 2.0
+# 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.
@@ -19,6 +18,14 @@ module Omnibus
   #
   # Used to generate the manifest of all software components with versions
   class Library
+    # The list of Omnibus::Software definitions. This is populated by calling
+    # #component_added during code loading. The list is expected to be sorted
+    # in a valid order according to project and software dependencies, but this
+    # class does not verify that condition.
+    #
+    # @see Omnibus.expand_software
+    # @return [Array<Omnibus::Software>] the software components in optimized
+    #   order.
     attr_reader :components
 
     def initialize(project)
@@ -26,19 +33,39 @@ module Omnibus
       @project = project
     end
 
+    # Callback method that should be called each time an Omnibus::Software
+    # definition file is loaded.
+    #
+    # @param component [Omnibus::Software]
+    # @return [void]
     def component_added(component)
       unless @components.find { |c| c.name == component.name }
         @components << component
       end
     end
 
+    # The order in which each Software component should be built. The order is
+    # based on the order of #components, optimized to move top-level
+    # dependencies later in the build order to make the git caching feature
+    # more effective. It is assumed that #components is already sorted in a
+    # valid dependency order. The optimization works as follows:
+    #
+    # 1. The first component is assumed to be a preparation step that needs to
+    # run first, so it is not moved.
+    # 2. If a component is a top-level dependency of the project AND no other
+    # software depends on it, it is shifted to last in the optimized order.
+    # 3. If none of the above conditions are met, the order of that component
+    # is unchanged.
+    #
+    # @return [Array<Omnibus::Software>] the software components in optimized
+    #   order.
     def build_order
       head = []
       tail = []
       @components.each do |component|
         if head.length == 0
           head << component
-        elsif @project.dependencies.include?(component.name)
+        elsif @project.dependencies.include?(component.name) && @components.none? { |c| c.dependencies.include?(component.name) }
           tail << component
         else
           head << component

data/lib/omnibus/logger.rb

@@ -0,0 +1,47 @@
+require 'logger'
+
+module Omnibus
+  class Logger < ::Logger
+    def initialize(logdev = $stdout, *)
+      super
+      @level = Logger::WARN
+    end
+
+    #
+    # Print a deprecation warning.
+    #
+    # @see (Logger#add)
+    #
+    def deprecated(progname = nil, &block)
+      if level <= WARN
+        add(WARN, 'DEPRECATED: ' + (block ? yield : progname), progname)
+      end
+    end
+
+    #
+    # Set the log lever for this logger instance.
+    #
+    # @example
+    #   logger.level = :info
+    #
+    # @param [Symbol] level
+    #
+    def level=(level)
+      @level = ::Logger.const_get(level.to_s.upcase)
+    rescue NameError
+      raise "'#{level.inspect}' does not appear to be a valid log level!"
+    end
+
+    private
+
+    def format_message(severity, _datetime, progname, msg)
+      left = if progname
+               "[#{progname}] #{severity[0]} | "
+             else
+               "#{severity[0]} | "
+             end
+
+      "#{left.rjust(30)}#{msg}\n"
+    end
+  end
+end

data/lib/omnibus/logging.rb

@@ -0,0 +1,60 @@
+#
+# Copyright 2013-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
+  module Logging
+    def self.included(base)
+      base.send(:include, InstanceMethods)
+      base.send(:extend,  ClassMethods)
+    end
+
+    module ClassMethods
+      private
+
+      #
+      # A helpful DSL method for logging an action.
+      #
+      # @return [Logger]
+      #
+      def log
+        Omnibus.logger
+      end
+
+      #
+      # The key to log with.
+      #
+      # @return [String]
+      #
+      def log_key
+        @log_key ||= name.split('::')[1..-1].join('::')
+      end
+    end
+
+    module InstanceMethods
+      private
+
+      # @see (ClassMethods#log)
+      def log
+        self.class.send(:log)
+      end
+
+      # @see (ClassMethods#log_key)
+      def log_key
+        self.class.send(:log_key)
+      end
+    end
+  end
+end

data/lib/omnibus/null_builder.rb

@@ -0,0 +1,23 @@
+#
+# 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 NullBuilder < Builder
+    def build
+      log.info(log_key) { "Nothing to build for #{name}" }
+    end
+  end
+end

data/lib/omnibus/ohai.rb

@@ -0,0 +1,70 @@
+#
+# 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 'ohai'
+
+module Omnibus
+  class Ohai
+    class << self
+      def method_missing(m, *args, &block)
+        ohai.send(m, *args, &block)
+      end
+
+      private
+
+      def ohai
+        return @ohai if @ohai
+
+        @ohai = ::Ohai::System.new
+        @ohai.require_plugin('os')
+        @ohai.require_plugin('platform')
+        @ohai.require_plugin('linux/cpu') if @ohai.os == 'linux'
+        @ohai.require_plugin('kernel')
+        @ohai
+      end
+    end
+  end
+end
+
+module Omnibus
+  class OhaiWithWarning < Ohai
+    include Logging
+
+    class << self
+      def method_missing(m, *args, &block)
+        bad_boy = caller[2]
+
+        unless warned[bad_boy]
+          log.deprecated('OHAI') do
+            "OHAI constant. Please use Ohai instead: #{bad_boy}"
+          end
+          warned[bad_boy] = true
+        end
+
+        Ohai.send(m, *args, &block)
+      end
+
+      def warned
+        @warned ||= {}
+      end
+    end
+  end
+end
+
+#
+# @todo remove in the next major release
+#
+OHAI = Omnibus::OhaiWithWarning

data/lib/omnibus/overrides.rb

@@ -1,67 +1,88 @@
+#
+# 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.
+#
+
 require 'pp'
 
 module Omnibus
   module Overrides
+    include Logging
+
     DEFAULT_OVERRIDE_FILE_NAME = 'omnibus.overrides'
 
-    # Parses a file of override information into a Hash.
-    #
-    # Each line of the file must be of the form
-    #
-    #
-    #     <package_name> <version>
-    #
-    # where the two pieces of data are separated by whitespace.
-    #
-    # @param file [String] the path to an overrides file
-    # @return [Hash, nil]
-    def self.parse_file(file)
-      if file
-        File.readlines(file).reduce({}) do |acc, line|
-          info = line.split
+    class << self
+      # Parses a file of override information into a Hash.
+      #
+      # Each line of the file must be of the form
+      #
+      #
+      #     <package_name> <version>
+      #
+      # where the two pieces of data are separated by whitespace.
+      #
+      # @param file [String] the path to an overrides file
+      # @return [Hash, nil]
+      def parse_file(file)
+        if file
+          File.readlines(file).reduce({}) do |acc, line|
+            info = line.split
 
-          unless info.count == 2
-            fail ArgumentError, "Invalid overrides line: '#{line.chomp}'"
-          end
+            unless info.count == 2
+              raise ArgumentError, "Invalid overrides line: '#{line.chomp}'"
+            end
 
-          package, version = info
+            package, version = info
 
-          if acc[package]
-            fail ArgumentError, "Multiple overrides present for '#{package}' in overrides file #{file}!"
-          end
+            if acc[package]
+              raise ArgumentError, "Multiple overrides present for '#{package}' in overrides file #{file}!"
+            end
 
-          acc[package] = version
-          acc
+            acc[package] = version
+            acc
+          end
+        else
+          nil
         end
-      else
-        nil
       end
-    end
 
-    # Return the full path to an overrides file, or +nil+ if no such
-    # file exists.
-    def self.resolve_override_file
-      file = ENV['OMNIBUS_OVERRIDE_FILE'] || DEFAULT_OVERRIDE_FILE_NAME
-      path = File.expand_path(file)
-      File.exist?(path) ? path : nil
-    end
+      # Return the full path to an overrides file, or +nil+ if no such
+      # file exists.
+      def resolve_override_file
+        file = ENV['OMNIBUS_OVERRIDE_FILE'] || DEFAULT_OVERRIDE_FILE_NAME
+        path = File.expand_path(file)
+        File.exist?(path) ? path : nil
+      end
 
-    # Return a hash of override information.  If no such information
-    # can be found, the hash will be empty
-    #
-    # @return [Hash]
-    def self.overrides
-      file = resolve_override_file
-      overrides = parse_file(file)
+      # Return a hash of override information.  If no such information
+      # can be found, the hash will be empty
+      #
+      # @return [Hash]
+      def overrides
+        file = resolve_override_file
+        overrides = parse_file(file)
 
-      if overrides
-        puts '********************************************************************************'
-        puts "Using Overrides from #{Omnibus::Overrides.resolve_override_file}"
-        pp overrides
-        puts '********************************************************************************'
-      end
+        if overrides
+          log.info(log_key) do
+            out = "Using overrides from #{resolve_override_file}\n"
+            out << overrides.pretty_inspect
+            out
+          end
+        end
 
-      overrides || {}
+        overrides || {}
+      end
     end
   end
 end