omnibus 3.1.0 → 3.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6f254e32b62632576547008173adf8f36379a0e5
-  data.tar.gz: b70de72741324c2e54d43ec75b96ffac86d87ae1
+  metadata.gz: 47494584e1a03e4d60e11d7e184ef6fdacfb3fcf
+  data.tar.gz: 6afbd1c06cb80f127ed9d1ef153e6cc66e41a41f
 SHA512:
-  metadata.gz: caafe9673d611c76b973ef63fffc557cc103d28881207b971a31fd7db59e15e3056df5e188b5010a334a1a3d9901ac7ac893803cfd9e9638b6eea69f65fc81a5
-  data.tar.gz: e16d7149c5e098e47ee46791590f94fd7b3e510e8bec736aa4d89b0cfbd24fe00fb29a4aa29ede52aef2b99b91c950f38b4314a138fd4e8408b78475427d2391
+  metadata.gz: 909e063a81130bc42ddcda0ec238276768b40a12089b26e9ef98ae422ab1ec19cc2b9a888964ef22930d7ce77293dfd2696d4dd8b8d9a2a8ec617d8c88e38f1f
+  data.tar.gz: 627dbb3379bf4642618770455455a977cdf7256c6d97c0e88d50ec999defc77ad532616cb782fe41295fc227613ee672df82718e1b530b837623ac6b5f33e19b

data/CHANGELOG.md

@@ -1,6 +1,19 @@
 Omnibus Ruby CHANGELOG
 ======================
 
+v3.1.1 (May 20, 2014)
+---------------------
+- Update project generators to use new APIs. The old project generators created a project that issued deprecation warnings!
+- Stream build output to the debug logger. Specifying `--log-level debug` now includes **all** the build output as if you had run the command manually.
+- Deprecate the `OMNIBUS_APPEND_TIMESTAMP` environment variable in favor of the command line flag. This is only a deprecation, but the `OMNIBUS_APPEND_TIMESTAMP` will be removed in the next major release.
+- Fix a bug in `windows_safe_path` to always return a string
+- Add a `Config.base_dir` configuration value for easy tuning
+- Remove the use of `Omnibus.root` in `BuildVersion#initializer`. This removes the many deprecation warnings that print on each software load.
+- Output the current command in debug output when shelling out
+- Output the current environment in debug output when shelling out
+- Change the information that is displayed at different log levels with respect to shelling out. In `warn` mode, Omnibus will only display warnings/deprecations; you will not see any build commands or output. In `info` mode, Omnibus will display the commands and environment that are being used; you will not see the output from the build (unless it fails). In `debug` mode, Omnibus will display the commands, environment, and output (livestream) from commands.
+
+
 v3.1.0 (May 14, 2014)
 -------------------------
 ### New Features

data/features/commands/_deprecated.feature

@@ -44,3 +44,23 @@ Feature: Backwards-compatible deprecated commands
       """
       The project generator has been renamed to 'omnibus new'. Please use 'omnibus new' in the future.
       """
+
+  Scenario: When OMNIBUS_APPEND_TIMESTAMP is given (true)
+    * I set the environment variables to:
+      | variable                 | value |
+      | OMNIBUS_APPEND_TIMESTAMP | true  |
+    * I run `omnibus build hamlet`
+    * the output should contain:
+      """
+      The environment variable 'OMNIBUS_APPEND_TIMESTAMP' is deprecated. Please use '--override append_timestamp:true' instead.
+      """
+
+  Scenario: When OMNIBUS_APPEND_TIMESTAMP is given (false)
+    * I set the environment variables to:
+      | variable                 | value |
+      | OMNIBUS_APPEND_TIMESTAMP | false  |
+    * I run `omnibus build hamlet`
+    * the output should contain:
+      """
+      The environment variable 'OMNIBUS_APPEND_TIMESTAMP' is deprecated. Please use '--override append_timestamp:false' instead.
+      """

data/lib/omnibus/build_version.rb

@@ -62,7 +62,7 @@ module Omnibus
     # Create a new BuildVersion
     #
     # @param [String] path      Path from which to read git version information
-    def initialize(path = Omnibus.root)
+    def initialize(path = Omnibus.project_root)
       @path = path
     end
 
@@ -79,12 +79,9 @@ module Omnibus
     #
     #     MAJOR.MINOR.PATCH-PRERELEASE+TIMESTAMP.git.COMMITS_SINCE.GIT_SHA
     #
-    # By default, a timestamp is incorporated into the build component
-    # of version string (see
-    # {Omnibus::BuildVersion::TIMESTAMP_FORMAT}).  This can be
-    # disabled by setting the environment variable
-    # `OMNIBUS_APPEND_TIMESTAMP` to a "falsey" value (e.g. "false",
-    # "f", "no", "n", "0")
+    # By default, a timestamp is incorporated into the build component of
+    # version string (see {Omnibus::BuildVersion::TIMESTAMP_FORMAT}). This
+    # option is configurable via the {Omnibus::Config}.
     #
     # @example 11.0.0-alpha.1+20121218164140.git.207.694b062
     # @return [String]
@@ -114,7 +111,9 @@ module Omnibus
       # variable to a 'falsey' value (ie false, f, no, n or 0).
       #
       # format: YYYYMMDDHHMMSS example: 20130131123345
-      build_version_items << build_start_time.strftime(TIMESTAMP_FORMAT) if append_timestamp?
+      if Config.append_timestamp
+        build_version_items << build_start_time.strftime(TIMESTAMP_FORMAT)
+      end
 
       # We'll append the git describe information unless we are sitting right
       # on an annotated tag.
@@ -144,7 +143,7 @@ module Omnibus
     # @return [String]
     def git_describe
       @git_describe ||= begin
-        cmd = quiet_shellout('git describe --tags', cwd: @path)
+        cmd = shellout('git describe --tags', cwd: @path)
 
         if cmd.exitstatus == 0
           cmd.stdout.chomp
@@ -288,18 +287,5 @@ module Omnibus
       version_regexp = /^(\d+)\.(\d+)\.(\d+)/
       version_regexp.match(git_describe)[1..3]
     end
-
-    #
-    # @todo Remove this environment variable madness and just use the CLI
-    #
-    def append_timestamp?
-      if ENV['OMNIBUS_APPEND_TIMESTAMP'] && (ENV['OMNIBUS_APPEND_TIMESTAMP'] =~ (/^(false|f|no|n|0)$/i))
-        false
-      elsif ENV['OMNIBUS_APPEND_TIMESTAMP'] && (ENV['OMNIBUS_APPEND_TIMESTAMP'] =~ (/^(true|t|yes|y|1)$/i))
-        true
-      else
-        Omnibus::Config.append_timestamp
-      end
-    end
   end
 end

data/lib/omnibus/builder.rb

@@ -251,7 +251,7 @@ module Omnibus
         cwd: project_dir,
         timeout: 5400,
       }
-      options[:live_stream] = STDOUT if ENV['DEBUG']
+      options[:live_stream] = log.live_stream(:debug)
       if cmd_args.last.is_a? Hash
         cmd_options = cmd_args.last
         cmd_args[cmd_args.size - 1] = options.merge(cmd_options)

data/lib/omnibus/cli/deprecated.rb

@@ -23,8 +23,25 @@
 module Omnibus
   class Command::Base
     class << self
+      include Util
+
       alias_method :old_dispatch, :dispatch
       def dispatch(m, args, options, config)
+        # Handle OMNIBUS_APPEND_TIMESTAMP environment
+        if ENV.key?('OMNIBUS_APPEND_TIMESTAMP')
+          value = ENV.delete('OMNIBUS_APPEND_TIMESTAMP')
+
+          if truthy?(value)
+            warn("The environment variable 'OMNIBUS_APPEND_TIMESTAMP' is deprecated. Please use '--override append_timestamp:true' instead.")
+            args += %(--override append_timestamp:true)
+          elsif falsey?(value)
+            warn("The environment variable 'OMNIBUS_APPEND_TIMESTAMP' is deprecated. Please use '--override append_timestamp:false' instead.")
+            args += %(--override append_timestamp:false)
+          else
+            raise "Unknown value for OMNIBUS_APPEND_TIMESTAMP: #{value.inspect}!"
+          end
+        end
+
         # Handle old --timestamp
         if args.include?('--timestamp') || args.include?('-t')
           warn("The '--timestamp' option has been deprecated! Please use '--override append_timestamp:true' instead.")

data/lib/omnibus/config.rb

@@ -25,19 +25,26 @@ module Omnibus
   #   it out twice, which I'm doing now for benefit of viewers of the Yard docs.
   class Config
     extend Mixlib::Config
+    extend Util
 
-    # Converts a given path to a platform specific path based on windows or
-    # linux.
-    def self.platformize_omnibus_path(path)
+    # @!group Directory Configuration Parameters
+
+    # @!attribute [rw] base_dir
+    #   The "base" directory where Omnibus will store it's data. Other paths are
+    #   dynamically constructed from this value.
+    #
+    #   Defaults to `"C:\omnibus-ruby"` on Windows
+    #   Defaults to `"/var/cache/omnibus"` on other platforms
+    #
+    #   @return [String]
+    default(:base_dir) do
       if Ohai.platform == 'windows'
-        File.join('C:\\omnibus-ruby', path).gsub(File::SEPARATOR, File::ALT_SEPARATOR)
+        'C:\\omnibus-ruby'
       else
-        File.join('/var/cache/omnibus', path)
+        '/var/cache/omnibus'
       end
     end
 
-    # @!group Directory Configuration Parameters
-
     # @!attribute [rw] cache_dir
     #   The absolute path to the directory on the virtual machine where
     #   code will be cached.
@@ -45,7 +52,7 @@ module Omnibus
     #   Defaults to `"/var/cache/omnibus/cache"`.
     #
     #   @return [String]
-    default(:cache_dir) { platformize_omnibus_path('cache') }
+    default(:cache_dir) { windows_safe_path(base_dir, 'cache') }
 
     # @!attribute [rw] install_path_cache_dir
     #   The absolute path to the directory on the virtual machine where
@@ -54,7 +61,7 @@ module Omnibus
     #   Defaults to `"/var/cache/omnibus/cache/install_path"`.
     #
     #   @return [String]
-    default(:install_path_cache_dir) { platformize_omnibus_path('cache/install_path') }
+    default(:install_path_cache_dir) { windows_safe_path(base_dir, 'cache', 'install_path') }
 
     # @!attribute [rw] source_dir
     #   The absolute path to the directory on the virtual machine where
@@ -63,7 +70,7 @@ module Omnibus
     #   Defaults to `"/var/cache/omnibus/src"`.
     #
     #   @return [String]
-    default(:source_dir) { platformize_omnibus_path('src') }
+    default(:source_dir) { windows_safe_path(base_dir, 'src') }
 
     # @!attribute [rw] build_dir
     #   The absolute path to the directory on the virtual machine where
@@ -72,7 +79,7 @@ module Omnibus
     #   Defaults to `"/var/cache/omnibus/build"`.
     #
     #   @return [String]
-    default(:build_dir) { platformize_omnibus_path('build') }
+    default(:build_dir) { windows_safe_path(base_dir, 'build') }
 
     # @!attribute [rw] package_dir
     #   The absolute path to the directory on the virtual machine where
@@ -81,7 +88,7 @@ module Omnibus
     #   Defaults to `"/var/cache/omnibus/pkg"`.
     #
     #   @return [String]
-    default(:package_dir) { platformize_omnibus_path('pkg') }
+    default(:package_dir) { windows_safe_path(base_dir, 'pkg') }
 
     # @!attribute [rw] package_tmp
     #   The absolute path to the directory on the virtual machine where
@@ -92,7 +99,7 @@ module Omnibus
     #   Defaults to `"/var/cache/omnibus/pkg-tmp"`.
     #
     #   @return [String]
-    default(:package_tmp) { platformize_omnibus_path('pkg-tmp') }
+    default(:package_tmp) { windows_safe_path(base_dir, 'pkg-tmp') }
 
     # @!attribute [rw] project_dir
     #   The relative path of the directory containing {Omnibus::Project}

data/lib/omnibus/fetchers/git_fetcher.rb

@@ -44,7 +44,7 @@ module Omnibus
     def clean
       if existing_git_clone?
         log.info(log_key) { 'Cleaning existing build' }
-        quiet_shellout!('git clean -fdx', cwd: project_dir)
+        shellout!('git clean -fdx', cwd: project_dir)
       end
     rescue Exception => e
       ErrorReporter.new(e, self).explain("Failed to clean git repository '#{@source[:git]}'")
@@ -91,12 +91,12 @@ module Omnibus
 
     def clone
       log.info(log_key) { 'Cloning the source from git' }
-      quiet_shellout!("git clone #{@source[:git]} #{project_dir}")
+      shellout!("git clone #{@source[:git]} #{project_dir}")
     end
 
     def checkout
       sha_ref = target_revision
-      quiet_shellout!("git checkout #{sha_ref}", cwd: project_dir)
+      shellout!("git checkout #{sha_ref}", cwd: project_dir)
     end
 
     def fetch_updates
@@ -107,7 +107,7 @@ module Omnibus
       fetch_cmd = "git fetch origin && " \
                   "git fetch origin --tags && " \
                   "git reset --hard #{target_revision}"
-      quiet_shellout!(fetch_cmd, cwd: project_dir)
+      shellout!(fetch_cmd, cwd: project_dir)
     end
 
     def existing_git_clone?
@@ -121,7 +121,7 @@ module Omnibus
     def current_revision
       return @current_rev if @current_rev
 
-      cmd = quiet_shellout!('git rev-parse HEAD', cwd: project_dir)
+      cmd = shellout!('git rev-parse HEAD', cwd: project_dir)
       stdout = cmd.stdout
 
       @current_rev = sha_hash?(stdout) ? stdout : nil
@@ -148,7 +148,7 @@ module Omnibus
       # allows us to return the SHA of the tagged commit for annotated
       # tags. We take care to only return exact matches in
       # process_remote_list.
-      cmd = quiet_shellout!("git ls-remote origin #{ref}*", cwd: project_dir)
+      cmd = shellout!("git ls-remote origin #{ref}*", cwd: project_dir)
       commit_ref = process_remote_list(cmd.stdout, ref)
 
       unless commit_ref

data/lib/omnibus/fetchers/net_fetcher.rb

@@ -187,7 +187,7 @@ module Omnibus
       when Proc
         cmd.call
       when String
-        quiet_shellout!(cmd)
+        shellout!(cmd)
       else
         raise "Don't know how to extract command for #{cmd.class} class"
       end

data/lib/omnibus/fetchers/path_fetcher.rb

@@ -37,10 +37,10 @@ module Omnibus
         # Robocopy's return code is 1 if it succesfully copies over the
         # files and 0 if the files are already existing at the destination
         sync_cmd = "robocopy #{@source[:path]}\\ #{@project_dir}\\ /MIR /S"
-        quiet_shellout!(sync_cmd, returns: [0, 1])
+        shellout!(sync_cmd, returns: [0, 1])
       else
         sync_cmd = "rsync --delete -a #{@source[:path]}/ #{@project_dir}/"
-        quiet_shellout!(sync_cmd)
+        shellout!(sync_cmd)
       end
     end
 

data/lib/omnibus/generator_files/omnibus.rb.example.erb

@@ -13,6 +13,12 @@
 # project configuration to build at +./local/omnibus/build+ instead of
 # +<%= config[:install_path] %>+
 #
+# Uncomment this line to change the default base directory to "local"
+# -------------------------------------------------------------------
+# base_dir './local'
+#
+# Alternatively you can tune the individual values
+# ------------------------------------------------
 # cache_dir              './local/omnibus/cache'
 # install_path_cache_dir './local/omnibus/cache/install_path'
 # source_dir             './local/omnibus/src'

data/lib/omnibus/generator_files/project.rb.erb

@@ -4,7 +4,7 @@ maintainer 'CHANGE ME'
 homepage 'CHANGEME.com'
 
 install_path    '<%= config[:install_path] %>'
-build_version   Omnibus::BuildVersion.new.semver
+build_version   Omnibus::BuildVersion.semver
 build_iteration 1
 
 # creates required build directories

data/lib/omnibus/generator_files/software/c-example.rb.erb

@@ -6,7 +6,7 @@
 #  https://github.com/opscode/omnibus-software/tree/master/config/software
 #
 name "c-example"
-version "1.0.0"
+default_version "1.0.0"
 
 dependency "zlib"
 dependency "openssl"

data/lib/omnibus/generator_files/software/erlang-example.rb.erb

@@ -6,7 +6,7 @@
 #  https://github.com/opscode/omnibus-software/tree/master/config/software
 #
 name "erlang-example"
-version "1.0.0"
+default_version "1.0.0"
 
 dependency "erlang"
 dependency "rebar"

data/lib/omnibus/generator_files/software/ruby-example.rb.erb

@@ -6,7 +6,7 @@
 #  https://github.com/opscode/omnibus-software/tree/master/config/software
 #
 name "ruby-example"
-version "1.0.0"
+default_version "1.0.0"
 
 dependency "ruby"
 dependency "rubygems"

data/lib/omnibus/install_path_cache.rb

@@ -39,7 +39,7 @@ module Omnibus
     # Creates the full path if it does not exist already
     def create_cache_path
       FileUtils.mkdir_p(File.dirname(cache_path))
-      quiet_shellout!("git --git-dir=#{cache_path} init -q") unless cache_path_exists?
+      shellout!("git --git-dir=#{cache_path} init -q") unless cache_path_exists?
       true
     end
 
@@ -74,20 +74,20 @@ module Omnibus
     # Create an incremental install path cache for the software step
     def incremental
       create_cache_path
-      quiet_shellout!(%Q(git --git-dir=#{cache_path} --work-tree=#{@install_path} add -A -f))
+      shellout!(%Q(git --git-dir=#{cache_path} --work-tree=#{@install_path} add -A -f))
       begin
-        quiet_shellout!(%Q(git --git-dir=#{cache_path} --work-tree=#{@install_path} commit -q -m "Backup of #{tag}"))
+        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
-      quiet_shellout!(%Q(git --git-dir=#{cache_path} --work-tree=#{@install_path} tag -f "#{tag}"))
+      shellout!(%Q(git --git-dir=#{cache_path} --work-tree=#{@install_path} tag -f "#{tag}"))
     end
 
     def restore
       create_cache_path
-      cmd = quiet_shellout(%Q(git --git-dir=#{cache_path} --work-tree=#{@install_path} tag -l "#{tag}"))
+      cmd = shellout(%Q(git --git-dir=#{cache_path} --work-tree=#{@install_path} tag -l "#{tag}"))
 
       restore_me = false
       cmd.stdout.each_line do |line|
@@ -95,7 +95,7 @@ module Omnibus
       end
 
       if restore_me
-        quiet_shellout!(%Q(git --git-dir=#{cache_path} --work-tree=#{@install_path} checkout -f "#{tag}"))
+        shellout!(%Q(git --git-dir=#{cache_path} --work-tree=#{@install_path} checkout -f "#{tag}"))
         true
       else
         false

data/lib/omnibus/logger.rb

@@ -32,6 +32,18 @@ module Omnibus
       raise "'#{level.inspect}' does not appear to be a valid log level!"
     end
 
+    #
+    # The live stream for this logger.
+    #
+    # @param [Symbol] level
+    #
+    # @return [LiveStream]
+    #
+    def live_stream(level = :debug)
+      @live_streams ||= {}
+      @live_streams[level.to_sym] ||= LiveStream.new(self, level)
+    end
+
     private
 
     def format_message(severity, _datetime, progname, msg)
@@ -43,5 +55,66 @@ module Omnibus
 
       "#{left.rjust(30)}#{msg}\n"
     end
+
+    #
+    # This is a magical wrapper around the logger that chunks data to not look
+    # like absolute shit.
+    #
+    class LiveStream
+      #
+      # Create a new LiveStream logger.
+      #
+      # @param [Logger] log
+      #   the logger object responsible for logging
+      # @param [Symbol] level
+      #   the log level
+      #
+      def initialize(log, level = :debug)
+        @log = log
+        @level = level
+        @buffer = ''
+      end
+
+      #
+      # The live stream operator must respond to <<.
+      #
+      # @param [String] data
+      #
+      def <<(data)
+        log_lines(data)
+      end
+
+      private
+
+      #
+      # Log the lines in the data, keeping the "rest" in the buffer.
+      #
+      # @param [String] data
+      #
+      def log_lines(data)
+        if (leftover = @buffer)
+          @buffer = nil
+          log_lines(leftover + data)
+        else
+          if (newline_index = data.index("\n"))
+            line = data.slice!(0...newline_index)
+            data.slice!(0)
+            log_line(line)
+            log_lines(data)
+          else
+            @buffer = data
+          end
+        end
+      end
+
+      #
+      # Log an individual line.
+      #
+      # @param [String] data
+      #
+      def log_line(data)
+        @log.public_send(@level) { data }
+      end
+    end
   end
 end

data/lib/omnibus/project.rb

@@ -226,8 +226,7 @@ module Omnibus
     #   must be set in order to build a project)
     def install_path(val = NULL_ARG)
       unless val.equal?(NULL_ARG)
-        @install_path = File.expand_path(val)
-        windows_safe_path!(@install_path)
+        @install_path = windows_safe_path(val)
       end
       @install_path || raise(MissingProjectConfiguration.new('install_path', '/opt/chef'))
     end

data/lib/omnibus/util.rb

@@ -17,10 +17,19 @@
 require 'mixlib/shellout'
 
 module Omnibus
-  #
-  # @author Seth Chisamore (<schisamo@getchef.com>)
-  #
   module Util
+    #
+    # The default shellout options.
+    #
+    # @return [Hash]
+    #
+    SHELLOUT_OPTIONS = {
+      live_stream: Omnibus.logger.live_stream(:debug),
+      timeout: 7200, # 2 hours
+      environment: {},
+    }.freeze
+
+    #
     # Shells out and runs +command+.
     #
     # @overload shellout(command, options = {})
@@ -37,14 +46,20 @@ module Omnibus
     #
     def shellout(*args)
       options = args.last.kind_of?(Hash) ? args.pop : {}
+      options = SHELLOUT_OPTIONS.merge(options)
+
+      # Log any environment options given
+      unless options[:environment].empty?
+        Omnibus.logger.info { 'Environment:' }
+        options[:environment].each do |key, value|
+          Omnibus.logger.info { "  #{key.to_s.upcase}=#{value.inspect}" }
+        end
+      end
 
-      default_options = {
-        live_stream: STDOUT,
-        timeout: 7200, # 2 hours
-        environment: {},
-      }
+      # Log the actual command
+      Omnibus.logger.info { "$ #{args.join(' ')}" }
 
-      cmd = Mixlib::ShellOut.new(*args, default_options.merge(options))
+      cmd = Mixlib::ShellOut.new(*args, options)
       cmd.run_command
       cmd
     end
@@ -63,38 +78,33 @@ module Omnibus
       cmd
     end
 
+    # Return true if the given value appears to be "truthy".
     #
-    # 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)
+    # @param [#to_s] value
+    def truthy?(value)
+      value && value.to_s =~ /^(true|t|yes|y|1)$/i
     end
 
+    # Return true if the given value appears to be "falsey".
     #
-    # 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)
+    # @param [#to_s] value
+    def falsey?(value)
+      value && value.to_s =~ /^(false|f|no|n|0)$/i
     end
 
-    # Replaces path separators with alternative ones when needed.
-    #
-    # @param path [String]
-    # @return [String] given path with applied changes.
+    # @param [Array<String>] pieces
+    #   the pieces of the path to join and fix
+    # @return [String]
+    #   the path with applied changes
     #
-    def windows_safe_path!(path)
-      path.gsub!(File::SEPARATOR, File::ALT_SEPARATOR) if File::ALT_SEPARATOR
+    def windows_safe_path(*pieces)
+      path = File.expand_path(File.join(*pieces))
+
+      if File::ALT_SEPARATOR
+        path.gsub(File::SEPARATOR, File::ALT_SEPARATOR)
+      else
+        path
+      end
     end
   end
 end

data/lib/omnibus/version.rb

@@ -15,5 +15,5 @@
 #
 
 module Omnibus
-  VERSION = '3.1.0'
+  VERSION = '3.1.1'
 end

data/spec/unit/build_version_spec.rb

@@ -139,56 +139,24 @@ module Omnibus
       describe 'appending a timestamp' do
         let(:git_describe) { '11.0.0-alpha-3-207-g694b062' }
 
-        it 'appends a timestamp by default' do
-          expect(build_version.semver).to match(/11.0.0-alpha.3\+#{today_string}[0-9]+.git.207.694b062/)
-        end
-
-        describe "ENV['OMNIBUS_APPEND_TIMESTAMP'] is set" do
-          ['true', 't', 'yes', 'y', 1].each do |truthy|
-            context "to #{truthy}" do
-              before { stub_env('OMNIBUS_APPEND_TIMESTAMP', truthy) }
-
-              it 'appends a timestamp' do
-                expect(build_version.semver).to match(/11.0.0-alpha.3\+#{today_string}[0-9]+.git.207.694b062/)
-              end
-            end
-          end
-
-          ['false', 'f', 'no', 'n', 0].each do |falsey|
-            context "to #{falsey}" do
-              before { stub_env('OMNIBUS_APPEND_TIMESTAMP', falsey) }
-
-              it 'does not append a timestamp' do
-                expect(build_version.semver).to match(/11.0.0-alpha.3\+git.207.694b062/)
-              end
-            end
+        context 'by default' do
+          it 'appends a timestamp' do
+            expect(build_version.semver).to match(/11.0.0-alpha.3\+#{today_string}[0-9]+.git.207.694b062/)
           end
         end
 
-        describe 'Config.append_timestamp is set' do
-          context 'is true' do
-            before { Config.stub(:append_timestamp).and_return(true) }
+        context 'when Config.append_timestamp is true' do
+          before { Config.stub(:append_timestamp).and_return(true) }
 
-            it 'appends a timestamp' do
-              expect(build_version.semver).to match(/11.0.0-alpha.3\+#{today_string}[0-9]+.git.207.694b062/)
-            end
-          end
-
-          context 'is false' do
-            before { Config.stub(:append_timestamp).and_return(false) }
-            it 'does not append a timestamp' do
-              expect(build_version.semver).to match(/11.0.0-alpha.3\+git.207.694b062/)
-            end
+          it 'appends a timestamp' do
+            expect(build_version.semver).to match(/11.0.0-alpha.3\+#{today_string}[0-9]+.git.207.694b062/)
           end
         end
 
-        describe 'both are set' do
-          before do
-            stub_env('OMNIBUS_APPEND_TIMESTAMP', 'false')
-            Config.stub(:append_timestamp).and_return(true)
-          end
+        context 'when Config.append_timestamp is false' do
+          before { Config.stub(:append_timestamp).and_return(false) }
 
-          it "prefers the value from ENV['OMNIBUS_APPEND_TIMESTAMP']" do
+          it 'does not append a timestamp' do
             expect(build_version.semver).to match(/11.0.0-alpha.3\+git.207.694b062/)
           end
         end
@@ -236,7 +204,7 @@ module Omnibus
 
       it 'runs `git describe` at an alternate path' do
         expect(build_version).to receive(:shellout)
-          .with('git describe --tags', live_stream: nil, cwd: path)
+          .with('git describe --tags', cwd: path)
           .and_return(double('ouput', stdout: git_describe, exitstatus: 0))
         build_version.git_describe
       end

data/spec/unit/config_spec.rb

@@ -6,9 +6,26 @@ module Omnibus
       expect(described_class).to be_a(Mixlib::Config)
     end
 
+    it 'extends Util' do
+      expect(described_class).to be_a(Util)
+    end
+
     before do
+      # Don't expand paths on the build system. Otherwise, you will end up with
+      # paths like +\\Users\\you\\Development\\omnibus-ruby\\C:\\omnibus-ruby+
+      # when testing on "other" operating systems
+      File.stub(:expand_path) { |arg| arg }
+
+      # Make sure we have a clean config
+      described_class.reset
+
+      # Prevent Ohai from running
+      Ohai.stub(:platform).and_return('linux')
+    end
+
+    after do
+      # Make sure future tests are clean
       described_class.reset
-      stub_ohai(platform: 'linux')
     end
 
     shared_examples 'a configurable' do |id, default|
@@ -21,6 +38,7 @@ module Omnibus
       end
     end
 
+    include_examples 'a configurable', :base_dir, '/var/cache/omnibus'
     include_examples 'a configurable', :cache_dir, '/var/cache/omnibus/cache'
     include_examples 'a configurable', :install_path_cache_dir, '/var/cache/omnibus/cache/install_path'
     include_examples 'a configurable', :source_dir, '/var/cache/omnibus/src'
@@ -46,10 +64,13 @@ module Omnibus
 
     context 'on Windows' do
       before do
-        stub_ohai(platform: 'windows')
+        Ohai.stub(:platform).and_return('windows')
+
+        # This is not defined on Linuxy Rubies
         stub_const('File::ALT_SEPARATOR', '\\')
       end
 
+      include_examples 'a configurable', :base_dir, 'C:\\omnibus-ruby'
       include_examples 'a configurable', :cache_dir, 'C:\\omnibus-ruby\\cache'
       include_examples 'a configurable', :install_path_cache_dir, 'C:\\omnibus-ruby\\cache\\install_path'
       include_examples 'a configurable', :source_dir, 'C:\\omnibus-ruby\\src'
@@ -57,5 +78,16 @@ module Omnibus
       include_examples 'a configurable', :package_dir, 'C:\\omnibus-ruby\\pkg'
       include_examples 'a configurable', :package_tmp, 'C:\\omnibus-ruby\\pkg-tmp'
     end
+
+    context 'when base_dir is changed' do
+      before { described_class.base_dir = '/foo/bar' }
+
+      include_examples 'a configurable', :cache_dir, '/foo/bar/cache'
+      include_examples 'a configurable', :install_path_cache_dir, '/foo/bar/cache/install_path'
+      include_examples 'a configurable', :source_dir, '/foo/bar/src'
+      include_examples 'a configurable', :build_dir, '/foo/bar/build'
+      include_examples 'a configurable', :package_dir, '/foo/bar/pkg'
+      include_examples 'a configurable', :package_tmp, '/foo/bar/pkg-tmp'
+    end
   end
 end

data/spec/unit/install_path_cache_spec.rb

@@ -105,7 +105,7 @@ module Omnibus
           .and_return(false)
         expect(FileUtils).to receive(:mkdir_p)
           .with(File.dirname(ipc.cache_path))
-        expect(ipc).to receive(:quiet_shellout!)
+        expect(ipc).to receive(:shellout!)
           .with("git --git-dir=#{cache_path} init -q")
         ipc.create_cache_path
       end
@@ -117,7 +117,7 @@ module Omnibus
         allow(File).to receive(:directory?)
           .with(File.dirname(ipc.cache_path))
           .and_return(true)
-        expect(ipc).to_not receive(:quiet_shellout!)
+        expect(ipc).to_not receive(:shellout!)
           .with("git --git-dir=#{cache_path} init -q")
         ipc.create_cache_path
       end
@@ -125,7 +125,7 @@ module Omnibus
 
     describe '#incremental' do
       before(:each) do
-        allow(ipc).to receive(:quiet_shellout!)
+        allow(ipc).to receive(:shellout!)
         allow(ipc).to receive(:create_cache_path)
       end
 
@@ -135,19 +135,19 @@ module Omnibus
       end
 
       it 'adds all the changes to git' do
-        expect(ipc).to receive(:quiet_shellout!)
+        expect(ipc).to receive(:shellout!)
           .with("git --git-dir=#{cache_path} --work-tree=#{install_path} add -A -f")
         ipc.incremental
       end
 
       it 'commits the backup for the software' do
-        expect(ipc).to receive(:quiet_shellout!)
+        expect(ipc).to receive(:shellout!)
           .with(%Q(git --git-dir=#{cache_path} --work-tree=#{install_path} commit -q -m "Backup of #{ipc.tag}"))
         ipc.incremental
       end
 
       it 'tags the software backup' do
-        expect(ipc).to receive(:quiet_shellout!)
+        expect(ipc).to receive(:shellout!)
           .with(%Q(git --git-dir=#{cache_path} --work-tree=#{install_path} tag -f "#{ipc.tag}"))
         ipc.incremental
       end
@@ -164,10 +164,10 @@ module Omnibus
       end
 
       before(:each) do
-        allow(ipc).to receive(:quiet_shellout)
+        allow(ipc).to receive(:shellout)
           .with(%Q(git --git-dir=#{cache_path} --work-tree=#{install_path} tag -l "#{ipc.tag}"))
           .and_return(tag_cmd)
-        allow(ipc).to receive(:quiet_shellout!)
+        allow(ipc).to receive(:shellout!)
           .with(%Q(git --git-dir=#{cache_path} --work-tree=#{install_path} checkout -f "#{ipc.tag}"))
         allow(ipc).to receive(:create_cache_path)
       end
@@ -178,10 +178,10 @@ module Omnibus
       end
 
       it 'checks for a tag with the software and version, and if it finds it, checks it out' do
-        expect(ipc).to receive(:quiet_shellout)
+        expect(ipc).to receive(:shellout)
           .with(%Q(git --git-dir=#{cache_path} --work-tree=#{install_path} tag -l "#{ipc.tag}"))
           .and_return(tag_cmd)
-        expect(ipc).to receive(:quiet_shellout!)
+        expect(ipc).to receive(:shellout!)
           .with(%Q(git --git-dir=#{cache_path} --work-tree=#{install_path} checkout -f "#{ipc.tag}"))
         ipc.restore
       end
@@ -190,10 +190,10 @@ module Omnibus
         let(:git_tag_output) { "\n" }
 
         it 'does nothing' do
-          expect(ipc).to receive(:quiet_shellout)
+          expect(ipc).to receive(:shellout)
             .with(%Q(git --git-dir=#{cache_path} --work-tree=#{install_path} tag -l "#{ipc.tag}"))
             .and_return(tag_cmd)
-          expect(ipc).to_not receive(:quiet_shellout!)
+          expect(ipc).to_not receive(:shellout!)
             .with(%Q(git --git-dir=#{cache_path} --work-tree=#{install_path} checkout -f "#{ipc.tag}"))
           ipc.restore
         end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: omnibus
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.1.1
 platform: ruby
 authors:
 - Chef Software, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-05-14 00:00:00.000000000 Z
+date: 2014-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef-sugar