omnibus 3.0.0 → 3.1.0

data/lib/omnibus/reports.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.

data/lib/omnibus/{s3_cacher.rb → s3_cache.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.
@@ -17,37 +16,15 @@
 
 require 'fileutils'
 require 'uber-s3'
-require 'omnibus/fetchers'
 
 module Omnibus
-  module SoftwareS3URLs
-    class InsufficientSpecification < ArgumentError
-    end
-
-    def config
-      Omnibus.config
-    end
-
-    def url_for(software)
-      "http://#{config.s3_bucket}.s3.amazonaws.com/#{key_for_package(software)}"
-    end
-
-    private
-
-    def key_for_package(package)
-      package.name     || fail(InsufficientSpecification, "Software must have a name to cache it in S3 (#{package.inspect})")
-      package.version  || fail(InsufficientSpecification, "Software must set a version to cache it in S3 (#{package.inspect})")
-      package.checksum || fail(InsufficientSpecification, "Software must specify a checksum (md5) to cache it in S3 (#{package.inspect})")
-      "#{package.name}-#{package.version}-#{package.checksum}"
-    end
-  end
-
   class S3Cache
+    include Logging
     include SoftwareS3URLs
 
     def initialize
       unless config.s3_bucket && config.s3_access_key && config.s3_secret_key
-        fail InvalidS3Configuration.new(config.s3_bucket, config.s3_access_key, config.s3_secret_key)
+        raise InvalidS3Configuration.new(config.s3_bucket, config.s3_access_key, config.s3_secret_key)
       end
       @client = UberS3.new(
         access_key: config.s3_access_key,
@@ -57,10 +34,6 @@ module Omnibus
       )
     end
 
-    def log(msg)
-      puts "[S3 Cacher] #{msg}"
-    end
-
     def config
       Omnibus.config
     end
@@ -92,7 +65,10 @@ module Omnibus
         key = key_for_package(software)
         content = IO.read(software.project_file)
 
-        log "Uploading #{software.project_file} as #{config.s3_bucket}/#{key}"
+        log.info(log_key) do
+          "Uploading #{software.project_file} as #{config.s3_bucket}/#{key}"
+        end
+
         @client.store(key, content, access: :public_read, content_md5: software.checksum)
       end
     end
@@ -110,22 +86,24 @@ module Omnibus
     end
 
     def fetch(software)
-      log "Fetching #{software.name}"
+      log.info(log_key) { "Fetching #{software.name}" }
       fetcher = Fetcher.without_caching_for(software)
       if fetcher.fetch_required?
+        log.debug(log_key) { 'Updating cache' }
         fetcher.download
         fetcher.verify_checksum!
       else
-        log 'Cached copy up to date, skipping.'
+        log.debug(log_key) { 'Cached copy up to date, skipping.' }
       end
     end
 
     def bucket
       @bucket ||= begin
-        b = UberS3::Bucket.new(@client, @client.bucket)
-        # creating the bucket is idempotent, make sure it's created:
-        @client.connection.put('/')
-        b
+        if @client.exists?('/')
+          @client.bucket
+        else
+          @client.connection.put('/')
+        end
       end
     end
   end

data/lib/omnibus/software.rb

@@ -1,6 +1,5 @@
 #
-# Copyright:: Copyright (c) 2012 Opscode, Inc.
-# License:: Apache License, Version 2.0
+# Copyright 2012 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.
@@ -16,21 +15,18 @@
 #
 
 require 'digest/md5'
-require 'mixlib/shellout'
 require 'net/ftp'
 require 'net/http'
 require 'net/https'
 require 'uri'
 
-require 'omnibus/fetcher'
-require 'omnibus/builder'
-require 'omnibus/config'
-
 require 'fileutils'
 
 module Omnibus
   # Omnibus software DSL reader
   class Software
+    include Logging
+
     NULL_ARG = Object.new
     UNINITIALIZED = Object.new
 
@@ -90,7 +86,11 @@ module Omnibus
 
       @dependencies = []
       @whitelist_files = []
-      instance_eval(io, filename, 0)
+      instance_eval(io, filename)
+    end
+
+    def <=>(other)
+      self.name <=> other.name
     end
 
     # Retrieves the override_version
@@ -100,7 +100,11 @@ module Omnibus
     # @todo: can't we just use #version here or are we testing this against nil? somewhere and
     #        not using #overridden?
     def override_version
-      $stderr.puts 'The #override_version is DEPRECATED, please use #version or test with #overridden?'
+      log.deprecated(log_key) do
+        'Software#override_version. Please use #version or ' \
+        'test  with #overridden?'
+      end
+
       overrides[:version]
     end
 
@@ -126,7 +130,7 @@ module Omnibus
     # @return [String]
     def name(val = NULL_ARG)
       @name = val unless val.equal?(NULL_ARG)
-      @name || fail(MissingSoftwareConfiguration.new(name, 'name', 'libxslt'))
+      @name || raise(MissingSoftwareConfiguration.new(name, 'name', 'libxslt'))
     end
 
     # Sets the description of the software
@@ -188,7 +192,10 @@ module Omnibus
     #
     # @todo: remove this in favor of default_version
     def given_version
-      $stderr.puts "Getting the default version via #given_version is DEPRECATED, please use 'default_version'"
+      log.deprecated(log_key) do
+        'Software#given_version. Please use #default_version instead.'
+      end
+
       default_version
     end
 
@@ -214,7 +221,7 @@ module Omnibus
     def version(val = NULL_ARG)
       if block_given?
         if val.equal?(NULL_ARG)
-          fail 'block needs a version argument to apply against'
+          raise 'block needs a version argument to apply against'
         else
           if val == apply_overrides(:version)
             yield
@@ -222,7 +229,9 @@ module Omnibus
         end
       else
         unless val.equal?(NULL_ARG)
-          $stderr.puts "Setting the version via 'version' is DEPRECATED, please use 'default_version'"
+          log.deprecated(log_key) do
+            'Software#version. Please use #default_version instead.'
+          end
           @version = val
         end
       end
@@ -257,6 +266,15 @@ module Omnibus
       @project.build_version
     end
 
+    # Returns the version to be used in cache.
+    def version_for_cache
+      if fetcher
+        fetcher.version_for_cache || version
+      else
+        version
+      end
+    end
+
     # @todo Judging by existing usage, this should sensibly default to
     #   the name of the software, since that's what it effectively does down in #project_dir
     def relative_path(val)
@@ -270,7 +288,7 @@ module Omnibus
     #   implementation
     # @todo Why the caching of the URI?
     def source_uri
-      @source_uri ||= URI(@source[:url])
+      @source_uri ||= URI(source[:url])
     end
 
     # @param val [Boolean]
@@ -295,7 +313,7 @@ module Omnibus
     #   across two classes, one of which is a specific interface
     #   implementation
     def checksum
-      @source[:md5]
+      source[:md5]
     end
 
     # @todo Should this ever be legitimately used in the DSL?  It
@@ -335,8 +353,8 @@ module Omnibus
     # @todo It seems like this isn't used, and if it were, it should
     # probably be part of Opscode::Builder instead
     def max_build_jobs
-      if OHAI.cpu && OHAI.cpu[:total] && OHAI.cpu[:total].to_s =~ /^\d+$/
-        OHAI.cpu[:total].to_i + 1
+      if Ohai.cpu && Ohai.cpu[:total] && Ohai.cpu[:total].to_s =~ /^\d+$/
+        Ohai.cpu[:total].to_i + 1
       else
         3
       end
@@ -408,20 +426,20 @@ module Omnibus
     #
     # @return [String]
     def platform
-      OHAI.platform
+      Ohai.platform
     end
 
     # Return the architecture of the machine, as determined by Ohai.
     # @return [String] Either "sparc" or "intel", as appropriate
     # @todo Is this used?  Doesn't appear to be...
     def architecture
-      OHAI.kernel['machine'] =~ /sun/ ? 'sparc' : 'intel'
+      Ohai.kernel['machine'] =~ /sun/ ? 'sparc' : 'intel'
     end
 
     # Actually build the software package
     def build_me
       # Fetch the source
-      fetcher = fetch_me
+      @fetcher = fetch_me
 
       # Build if we need to
       if always_build?
@@ -433,6 +451,8 @@ module Omnibus
           execute_build(fetcher)
         end
       end
+
+      project.build_version_dsl.resolve(self)
       true
     end
 
@@ -454,6 +474,30 @@ module Omnibus
       fetcher
     end
 
+    # A PATH variable format string representing the current PATH with the
+    # project's embedded/bin directory prepended. The correct path separator
+    # for the platform is used to join the paths.
+    #
+    # @return [String]
+    def path_with_embedded
+      prepend_path("#{install_dir}/bin", "#{install_dir}/embedded/bin")
+    end
+
+    # A PATH variable format string representing the current PATH with the
+    # given path prepended. The correct path separator
+    # for the platform is used to join the paths.
+    #
+    # @param paths [String]
+    # @param paths [Array<String>]
+    # @return [String]
+    def prepend_path(*paths)
+      path_values = Array(paths)
+      path_values << ENV['PATH']
+
+      separator = File::PATH_SEPARATOR || ':'
+      path_values.join(separator)
+    end
+
     private
 
     # Apply overrides in the @overrides hash that mask instance variables
@@ -470,19 +514,21 @@ module Omnibus
       end
     end
 
-    # @todo What?!
-    # @todo It seems that this is not used... remove it
-    # @deprecated Use something else (?)
-    def command(*args)
-      fail 'Method Moved.'
+    # @todo Remove this in the next major release
+    def command(*)
+      log.deprecated(log_key) do
+        'Software#command. Please use something else.'
+      end
+
+      raise 'Method Moved.'
     end
 
     def execute_build(fetcher)
       fetcher.clean
       @builder.build
-      puts "[software:#{name}] caching build"
+      log.info(log_key) { 'Caching build' }
       Omnibus::InstallPathCache.new(install_dir, self).incremental
-      puts "[software:#{name}] has dirtied the cache"
+      log.info(log_key) { 'Dirtied the cache!' }
       project.dirty_cache = true
     end
 
@@ -491,5 +537,9 @@ module Omnibus
         f.print ''
       end
     end
+
+    def log_key
+      @log_key ||= "#{super}: #{name}"
+    end
   end
 end

data/lib/omnibus/software_s3_urls.rb

@@ -0,0 +1,50 @@
+#
+# 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 SoftwareS3URLs
+    class InsufficientSpecification < ArgumentError
+      def initialize(key, package)
+        @key, @package = key, package
+      end
+
+      def to_s
+        "Software must specify a #{@key} to cache it in S3 (#{@package})!"
+      end
+    end
+
+    def config
+      Omnibus.config
+    end
+
+    def url_for(software)
+      "http://#{config.s3_bucket}.s3.amazonaws.com/#{key_for_package(software)}"
+    end
+
+    private
+
+    def key_for_package(package)
+      return @key_for_package if @key_for_package
+
+      package.name     || raise(InsufficientSpecification.new(:name, package))
+      package.version  || raise(InsufficientSpecification.new(:version, package))
+      package.checksum || raise(InsufficientSpecification.new(:checksum, package))
+
+      @key_for_package = "#{package.name}-#{package.version}-#{package.checksum}"
+      @key_for_package
+    end
+  end
+end

data/lib/omnibus/sugar.rb

@@ -28,8 +28,6 @@ require 'chef/sugar/ruby'
 require 'chef/sugar/shell'
 require 'chef/sugar/vagrant'
 
-require 'omnibus/project'
-
 module Omnibus
   class Project
     private
@@ -39,7 +37,7 @@ module Omnibus
     # Omnibus project as if it were Chef. Otherwise, we would need to rewrite
     # all the DSL methods.
     def node
-      OHAI
+      Ohai
     end
   end
 end

data/lib/omnibus/util.rb

@@ -1,7 +1,5 @@
 #
-# Author:: Seth Chisamore (<schisamo@getchef.com>)
-# Copyright:: Copyright (c) 2013-2014 Chef Software, Inc.
-# License:: Apache License, Version 2.0
+# 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.
@@ -25,33 +23,28 @@ module Omnibus
   module Util
     # Shells out and runs +command+.
     #
-    # @overload shellout(command, opts={})
+    # @overload shellout(command, options = {})
     #   @param command [String]
-    #   @param opts [Hash] the options passed to the initializer of the
+    #   @param options [Hash] the options passed to the initializer of the
     #     +Mixlib::ShellOut+ instance.
-    # @overload shellout(command_fragments, opts={})
+    # @overload shellout(command_fragments, options = {})
     #   @param command [Array<String>] command argv as individual strings
-    #   @param opts [Hash] the options passed to the initializer of the
+    #   @param options [Hash] the options passed to the initializer of the
     #     +Mixlib::ShellOut+ instance.
     # @return [Mixlib::ShellOut] the underlying +Mixlib::ShellOut+ instance
     #   which which has +stdout+, +stderr+, +status+, and +exitstatus+
     #   populated with results of the command.
     #
-    def shellout(*command_fragments)
-      STDOUT.sync = true
-
-      opts = if command_fragments.last.kind_of?(Hash)
-               command_fragments.pop
-             else
-               {}
-             end
+    def shellout(*args)
+      options = args.last.kind_of?(Hash) ? args.pop : {}
 
       default_options = {
         live_stream: STDOUT,
         timeout: 7200, # 2 hours
         environment: {},
       }
-      cmd = Mixlib::ShellOut.new(*command_fragments, default_options.merge(opts))
+
+      cmd = Mixlib::ShellOut.new(*args, default_options.merge(options))
       cmd.run_command
       cmd
     end
@@ -64,10 +57,44 @@ module Omnibus
     # @raise [Mixlib::ShellOut::ShellCommandFailed] if +exitstatus+ is not in
     #   the list of +valid_exit_codes+.
     #
-    def shellout!(*command_fragments)
-      cmd = shellout(*command_fragments)
+    def shellout!(*args)
+      cmd = shellout(*args)
       cmd.error!
       cmd
     end
+
+    #
+    # Run a command in subshell, suppressing any output.
+    #
+    # @see (Util#shellout)
+    #
+    def quiet_shellout(*args)
+      options = args.last.kind_of?(Hash) ? args.pop : {}
+      options[:live_stream] = nil
+      args << options
+      shellout(*args)
+    end
+
+    #
+    # Run a command, suppressing any output, but raising an error if the
+    # command fails.
+    #
+    # @see (Util#shellout!)
+    #
+    def quiet_shellout!(*args)
+      options = args.last.kind_of?(Hash) ? args.pop : {}
+      options[:live_stream] = nil
+      args << options
+      shellout!(*args)
+    end
+
+    # Replaces path separators with alternative ones when needed.
+    #
+    # @param path [String]
+    # @return [String] given path with applied changes.
+    #
+    def windows_safe_path!(path)
+      path.gsub!(File::SEPARATOR, File::ALT_SEPARATOR) if File::ALT_SEPARATOR
+    end
   end
 end