omnibus 1.3.0 → 2.0.0.rc1

data/lib/omnibus/reports.rb

@@ -1,5 +1,5 @@
 #
-# Copyright:: Copyright (c) 2012 Opscode, Inc.
+# Copyright:: Copyright (c) 2012-2014 Chef Software, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -16,11 +16,9 @@
 #
 
 module Omnibus
-
   module Reports
     extend self
 
-
     PADDING = 3
 
     # Determine how wide a column should be, taking into account both
@@ -28,7 +26,7 @@ module Omnibus
     # will be stored in the column, the width is 0 (i.e., nothing
     # should be printed, not even the column header)
     def column_width(items, column_name)
-      widest_item = items.max{|a,b| a.size <=> b.size}
+      widest_item = items.max { |a, b| a.size <=> b.size }
       if widest_item
         widest = (widest_item.size >= column_name.size) ? widest_item : column_name
         widest.size + PADDING
@@ -38,14 +36,13 @@ module Omnibus
     end
 
     def non_nil_values(hashes, selector_key)
-      hashes.map{|v| v[selector_key]}.compact
+      hashes.map { |v| v[selector_key] }.compact
     end
 
     def pretty_version_map(project)
-      out = ""
+      out = ''
       version_map = project.library.version_map
 
-
       # Pull out data to print out
       versions = non_nil_values(version_map.values, :version)
       guids = non_nil_values(version_map.values, :version_guid)
@@ -53,25 +50,23 @@ module Omnibus
       # We only want the versions that have truly been overridden;
       # because we want to output a column only if something was
       # overridden, but nothing if no packages were changed
-      overridden_versions = non_nil_values(version_map.values.select{|v| v[:overridden]},
-                                           :given_version)
-
+      overridden_versions = non_nil_values(version_map.values.select { |v| v[:overridden] }, :default_version)
 
       # Determine how wide the printed table columns need to be
-      name_width = column_width(version_map.keys, "Component")
-      version_width = column_width(versions, "Installed Version")
-      guid_width = column_width(guids, "Version GUID")
-      override_width = column_width(overridden_versions, "Overridden From")
+      name_width = column_width(version_map.keys, 'Component')
+      version_width = column_width(versions, 'Installed Version')
+      guid_width = column_width(guids, 'Version GUID')
+      override_width = column_width(overridden_versions, 'Overridden From')
 
       total_width = name_width + version_width + guid_width + override_width
-      divider = "-" * total_width
+      divider = '-' * total_width
 
       # Print out the column headers
-      out << "Component".ljust(name_width)
-      out << "Installed Version".ljust(version_width)
-      out << "Version GUID".ljust(guid_width)
+      out << 'Component'.ljust(name_width)
+      out << 'Installed Version'.ljust(version_width)
+      out << 'Version GUID'.ljust(guid_width)
       # Only print out column if something was overridden
-      out << "Overridden From".ljust(override_width) if override_width > 0
+      out << 'Overridden From'.ljust(override_width) if override_width > 0
       out << "\n"
       out << divider << "\n"
 
@@ -80,20 +75,17 @@ module Omnibus
         version = version_map[name][:version]
         version_guid = version_map[name][:version_guid]
 
-        given_version = version_map[name][:given_version]
+        default_version = version_map[name][:default_version]
         overridden = version_map[name][:overridden]
 
         out << "#{name}".ljust(name_width)
         out << version.to_s.ljust(version_width)
         out << version_guid.to_s.ljust(guid_width) if version_guid
         # Only print out column if something was overridden
-        out << given_version.ljust(override_width) if overridden
+        out << default_version.ljust(override_width) if overridden
         out << "\n"
       end
       out
     end
-
   end
-
-
 end

data/lib/omnibus/s3_cacher.rb

@@ -1,5 +1,5 @@
 #
-# Copyright:: Copyright (c) 2012 Opscode, Inc.
+# Copyright:: Copyright (c) 2012-2014 Chef Software, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -20,10 +20,7 @@ require 'uber-s3'
 require 'omnibus/fetchers'
 
 module Omnibus
-
-
   module SoftwareS3URLs
-
     class InsufficientSpecification < ArgumentError
     end
 
@@ -38,27 +35,25 @@ module Omnibus
     private
 
     def key_for_package(package)
-      package.name     or raise InsufficientSpecification, "Software must have a name to cache it in S3 (#{package.inspect})"
-      package.version  or raise InsufficientSpecification, "Software must set a version to cache it in S3 (#{package.inspect})"
-      package.checksum or raise InsufficientSpecification, "Software must specify a checksum (md5) to cache it in S3 (#{package.inspect})"
+      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 SoftwareS3URLs
 
     def initialize
       unless 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)
+        fail InvalidS3Configuration.new(config.s3_bucket, config.s3_access_key, config.s3_secret_key)
       end
       @client = UberS3.new(
-        :access_key         => config.s3_access_key,
-        :secret_access_key  => config.s3_secret_key,
-        :bucket             => config.s3_bucket,
-        :adaper             => :net_http
+        access_key: config.s3_access_key,
+        secret_access_key: config.s3_secret_key,
+        bucket: config.s3_bucket,
+        adapter: :net_http,
       )
     end
 
@@ -72,7 +67,7 @@ module Omnibus
 
     def list
       existing_keys = list_by_key
-      tarball_software.select {|s| existing_keys.include?(key_for_package(s))}
+      tarball_software.select { |s| existing_keys.include?(key_for_package(s)) }
     end
 
     def list_by_key
@@ -81,12 +76,12 @@ module Omnibus
 
     def missing
       already_cached = list_by_key
-      tarball_software.delete_if {|s| already_cached.include?(key_for_package(s))}
+      tarball_software.delete_if { |s| already_cached.include?(key_for_package(s)) }
     end
 
     def tarball_software
       Omnibus.projects.map do |project|
-        project.library.select {|s| s.source && s.source.key?(:url)}
+        project.library.select { |s| s.source && s.source.key?(:url) }
       end.flatten
     end
 
@@ -98,7 +93,7 @@ module Omnibus
         content = IO.read(software.project_file)
 
         log "Uploading #{software.project_file} as #{config.s3_bucket}/#{key}"
-        @client.store(key, content, :access => :public_read, :content_md5 => software.checksum)
+        @client.store(key, content, access: :public_read, content_md5: software.checksum)
       end
     end
 
@@ -121,7 +116,7 @@ module Omnibus
         fetcher.download
         fetcher.verify_checksum!
       else
-        log "Cached copy up to date, skipping."
+        log 'Cached copy up to date, skipping.'
       end
     end
 
@@ -129,10 +124,9 @@ module Omnibus
       @bucket ||= begin
         b = UberS3::Bucket.new(@client, @client.bucket)
         # creating the bucket is idempotent, make sure it's created:
-        @client.connection.put("/")
+        @client.connection.put('/')
         b
       end
     end
-
   end
 end

data/lib/omnibus/software.rb

@@ -29,12 +29,12 @@ require 'omnibus/config'
 require 'rake'
 
 module Omnibus
-
   # Omnibus software DSL reader
   class Software
     include Rake::DSL
 
     NULL_ARG = Object.new
+    UNINITIALIZED = Object.new
 
     # It appears that this is not used
     attr_reader :builder
@@ -49,18 +49,20 @@ module Omnibus
 
     attr_reader :project
 
-    attr_reader :given_version
-    attr_reader :override_version
+    attr_reader :version
+
+    attr_reader :overrides
+
     attr_reader :whitelist_files
 
-    def self.load(filename, project, overrides={})
-      new(IO.read(filename), filename, project, overrides)
+    def self.load(filename, project, repo_overrides = {})
+      new(IO.read(filename), filename, project, repo_overrides)
     end
 
     # @param io [String]
     # @param filename [String]
     # @param project [???] Is this a string or an Omnibus::Project?
-    # @param overrides [Hash]
+    # @param repo_overrides [Hash]
     #
     # @see Omnibus::Overrides
     #
@@ -70,9 +72,9 @@ module Omnibus
     #   project, and override hash directly?  That is, why io AND a
     #   filename, if the filename can always get you the contents you
     #   need anyway?
-    def initialize(io, filename, project, overrides={})
-      @given_version    = nil
-      @override_version = nil
+    def initialize(io, filename, project, repo_overrides = {})
+      @version          = nil
+      @overrides        = UNINITIALIZED
       @name             = nil
       @description      = nil
       @source           = nil
@@ -81,25 +83,58 @@ module Omnibus
       @source_config    = filename
       @project          = project
       @always_build     = false
+      @repo_overrides   = repo_overrides
 
       # Seems like this should just be Builder.new(self) instead
       @builder = NullBuilder.new(self)
 
-      @dependencies = Array.new
-      @whitelist_files = Array.new
+      @dependencies = []
+      @whitelist_files = []
       instance_eval(io, filename, 0)
 
-      # Set override information after the DSL file has been consumed
-      @override_version = overrides[name]
-
       render_tasks
     end
 
-    def name(val=NULL_ARG)
+    # Retrieves the override_version
+    #
+    # @return [Hash]
+    #
+    # @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?'
+      overrides[:version]
+    end
+
+    # Retrieves the repo-level and project-level overrides for the software.
+    #
+    # @return [Hash]
+    def overrides
+      # deliberately not providing a setter since that feels like a shotgun pointed at a foot
+      if @overrides == UNINITIALIZED
+        # lazily initialized because we need the 'name' to be parsed first
+        @overrides = {}
+        @overrides = project.overrides[name.to_sym].dup if project.overrides[name.to_sym]
+        if @repo_overrides[name]
+          @overrides[:version] = @repo_overrides[name]
+        end
+      end
+      @overrides
+    end
+
+    # Sets or retreives the name of the software
+    #
+    # @param val [String] name of the Software
+    # @return [String]
+    def name(val = NULL_ARG)
       @name = val unless val.equal?(NULL_ARG)
-      @name
+      @name || fail(MissingSoftwareConfiguration.new(name, 'name', 'libxslt'))
     end
 
+    # Sets the description of the software
+    #
+    # @param val [String] description of the Software
+    # @return [void]
     def description(val)
       @description = val
     end
@@ -125,7 +160,7 @@ module Omnibus
     #
     # @param val [Array<String>] a list of names of Software components
     # @return [Array<String>]
-    def dependencies(val=NULL_ARG)
+    def dependencies(val = NULL_ARG)
       @dependencies = val unless val.equal?(NULL_ARG)
       @dependencies
     end
@@ -140,19 +175,60 @@ module Omnibus
     #
     # @todo Consider changing this to accept two arguments instead
     # @todo This should throw an error if an invalid key is given, or
-    #   if more than one pair is given, or if no source value is ever
-    #   set.
-    def source(val=NULL_ARG)
-      @source = val unless val.equal?(NULL_ARG)
-      @source
+    #   if more than one pair is given
+    def source(val = NULL_ARG)
+      unless val.equal?(NULL_ARG)
+        @source ||= {}
+        @source.merge!(val)
+      end
+      apply_overrides(:source)
     end
 
-    # Set a version from a software descriptor file, or receive the
-    # effective version, taking into account any override information
-    # (if set)
-    def version(val=NULL_ARG)
-      @given_version = val unless val.equal?(NULL_ARG)
-      @override_version || @given_version
+    # Retieve the default_version of the software
+    #
+    # @return [String]
+    #
+    # @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'"
+      default_version
+    end
+
+    # Set or retieve the default_version of the software to build
+    #
+    # @param val [String]
+    # @return [String]
+    def default_version(val = NULL_ARG)
+      @version = val unless val.equal?(NULL_ARG)
+      @version
+    end
+
+    # Evaluate a block only if the version matches.
+    #
+    # Note that passing only a string without a block will set the default_version but this
+    # behavior is deprecated and will be removed, use the default_version method instead.
+    #
+    # @param val [String] version of the software.
+    # @param block [Proc] block to run if the version we are building matches the argument.
+    # @return [void]
+    #
+    # @todo remove deprecated setting of version
+    def version(val = NULL_ARG)
+      if block_given?
+        if val.equal?(NULL_ARG)
+          fail 'block needs a version argument to apply against'
+        else
+          if val == apply_overrides(:version)
+            yield
+          end
+        end
+      else
+        unless val.equal?(NULL_ARG)
+          $stderr.puts "Setting the version via 'version' is DEPRECATED, please use 'default_version'"
+          @version = val
+        end
+      end
+      apply_overrides(:version)
     end
 
     # Add an Omnibus software dependency.
@@ -169,7 +245,8 @@ module Omnibus
     #
     # @return [Boolean]
     def overridden?
-      @override_version && (@override_version != @given_version)
+      # note: using instance variables to bypass accessors that enforce overrides
+      @overrides.key?(:version) && (@overrides[:version] != @version)
     end
 
     # @todo see comments on {Omnibus::Fetcher#without_caching_for}
@@ -312,12 +389,12 @@ module Omnibus
       path = project_path.dup
       # split the path and remmove and empty strings
       if platform == 'windows'
-        path.sub!(":", "")
-        parts = path.split("\\") - [""]
-        parts.join("_")
+        path.sub!(':', '')
+        parts = path.split('\\') - ['']
+        parts.join('_')
       else
-        parts = path.split("/") - [""]
-        parts.join("_")
+        parts = path.split('/') - ['']
+        parts.join('_')
       end
     end
 
@@ -351,16 +428,30 @@ module Omnibus
     # @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
 
     private
 
+    # Apply overrides in the @overrides hash that mask instance variables
+    # that are set by parsing the DSL
+    #
+    def apply_overrides(attr)
+      val = instance_variable_get(:"@#{attr}")
+      if val.is_a?(Hash) || overrides[attr].is_a?(Hash)
+        val ||= {}
+        override = overrides[attr] || {}
+        val.merge(override)
+      else
+        overrides[attr] || val
+      end
+    end
+
     # @todo What?!
     # @todo It seems that this is not used... remove it
     # @deprecated Use something else (?)
     def command(*args)
-      raise "Method Moved."
+      fail 'Method Moved.'
     end
 
     def execute_build(fetcher)
@@ -371,71 +462,70 @@ module Omnibus
 
     def render_tasks
       namespace "projects:#{@project.name}" do
-      namespace :software do
-        fetcher = Fetcher.for(self)
-
-        #
-        # set up inter-project dependencies
-        #
-        (@dependencies - [@name]).uniq.each do |dep|
-          task @name => dep
-          file manifest_file => manifest_file_from_name(dep)
-        end
+        namespace :software do
+          fetcher = Fetcher.for(self)
+
+          #
+          # set up inter-project dependencies
+          #
+          (@dependencies - [@name]).uniq.each do |dep|
+            task @name => dep
+            file manifest_file => manifest_file_from_name(dep)
+          end
 
-        directory source_dir
-        directory cache_dir
-        directory build_dir
-        directory project_dir
-        namespace @name do
-          task :fetch => [ build_dir, source_dir, cache_dir, project_dir ] do
-            if !File.exists?(fetch_file) || fetcher.fetch_required?
-              # force build to run if we need to do an updated fetch
-              fetcher.fetch
-              touch fetch_file
+          directory source_dir
+          directory cache_dir
+          directory build_dir
+          directory project_dir
+          namespace @name do
+            task fetch: [build_dir, source_dir, cache_dir, project_dir] do
+              if !File.exists?(fetch_file) || fetcher.fetch_required?
+                # force build to run if we need to do an updated fetch
+                fetcher.fetch
+                touch fetch_file
+              end
             end
-          end
 
-          task :build => :fetch do
-            if !always_build? && uptodate?(manifest_file, [fetch_file])
-              # if any direct deps have been built for any reason, we will need to
-              # clean/build ourselves
-              (@dependencies - [@name]).uniq.each do |dep|
-                unless uptodate?(manifest_file, [manifest_file_from_name(dep)])
-                  execute_build(fetcher)
-                  break
+            task build: :fetch do
+              if !always_build? && uptodate?(manifest_file, [fetch_file])
+                # if any direct deps have been built for any reason, we will need to
+                # clean/build ourselves
+                (@dependencies - [@name]).uniq.each do |dep|
+                  unless uptodate?(manifest_file, [manifest_file_from_name(dep)])
+                    execute_build(fetcher)
+                    break
+                  end
                 end
-              end
 
-            else
-              # if fetch has occurred, or the component is configured to
-              # always build, do a clean and build.
-              execute_build(fetcher)
+              else
+                # if fetch has occurred, or the component is configured to
+                # always build, do a clean and build.
+                execute_build(fetcher)
+              end
             end
           end
-        end
 
-        #
-        # make the manifest file dependent on the latest file in the
-        # source tree in order to shrink the multi-thousand-node
-        # dependency graph that Rake was generating
-        #
-        latest_file = FileList["#{project_dir}/**/*"].sort { |a,b|
-          File.mtime(a) <=> File.mtime(b)
-        }.last
+          #
+          # make the manifest file dependent on the latest file in the
+          # source tree in order to shrink the multi-thousand-node
+          # dependency graph that Rake was generating
+          #
+          latest_file = FileList["#{project_dir}/**/*"].sort do |a, b|
+            File.mtime(a) <=> File.mtime(b)
+          end.last
 
-        file manifest_file => (file latest_file)
+          file manifest_file => (file latest_file)
 
-        file fetch_file => "#{name}:fetch"
-        file manifest_file => "#{name}:build"
+          file fetch_file => "#{name}:fetch"
+          file manifest_file => "#{name}:build"
 
-        file fetch_file => (file @source_config)
-        file manifest_file => (file fetch_file)
+          file fetch_file => (file @source_config)
+          file manifest_file => (file fetch_file)
 
-        desc "fetch and build #{@name} for #{@project.name}"
-        task @name => manifest_file
-      end
+          desc "fetch and build #{@name} for #{@project.name}"
+          task @name => manifest_file
+        end
       end
     end
-
   end
 end

data/lib/omnibus/util.rb

@@ -1,6 +1,6 @@
 #
-# Author:: Seth Chisamore (<schisamo@opscode.com>)
-# Copyright:: Copyright (c) 2013 Opscode, Inc.
+# Author:: Seth Chisamore (<schisamo@getchef.com>)
+# Copyright:: Copyright (c) 2013-2014 Chef Software, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -20,26 +20,38 @@ require 'mixlib/shellout'
 
 module Omnibus
   #
-  # @author Seth Chisamore (<schisamo@opscode.com>)
+  # @author Seth Chisamore (<schisamo@getchef.com>)
   #
   module Util
     # Shells out and runs +command+.
     #
-    # @param command [String]
-    # @param opts [Hash] the options passed to the initializer of the
-    #   +Mixlib::ShellOut+ instance.
+    # @overload shellout(command, opts={})
+    #   @param command [String]
+    #   @param opts [Hash] the options passed to the initializer of the
+    #     +Mixlib::ShellOut+ instance.
+    # @overload shellout(command_fragments, opts={})
+    #   @param command [Array<String>] command argv as individual strings
+    #   @param opts [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, opts={})
+    def shellout(*command_fragments)
       STDOUT.sync = true
+
+      opts = if command_fragments.last.kind_of?(Hash)
+               command_fragments.pop
+             else
+               {}
+             end
+
       default_options = {
-        :live_stream => STDOUT,
-        :timeout => 7200, # 2 hours
-        :environment => {}
+        live_stream: STDOUT,
+        timeout: 7200, # 2 hours
+        environment: {},
       }
-      cmd = Mixlib::ShellOut.new(command, default_options.merge(opts))
+      cmd = Mixlib::ShellOut.new(*command_fragments, default_options.merge(opts))
       cmd.run_command
       cmd
     end
@@ -52,8 +64,8 @@ module Omnibus
     # @raise [Mixlib::ShellOut::ShellCommandFailed] if +exitstatus+ is not in
     #   the list of +valid_exit_codes+.
     #
-    def shellout!(command, opts={})
-      cmd = shellout(command, opts)
+    def shellout!(*command_fragments)
+      cmd = shellout(*command_fragments)
       cmd.error!
       cmd
     end

data/lib/omnibus/version.rb

@@ -1,5 +1,5 @@
 #
-# Copyright:: Copyright (c) 2012 Opscode, Inc.
+# Copyright:: Copyright (c) 2012-2014 Chef Software, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -16,5 +16,5 @@
 #
 
 module Omnibus
-  VERSION = "1.3.0"
+  VERSION = '2.0.0.rc1'
 end