omnibus 5.4.0 → 5.5.0

data/lib/omnibus/builder.rb

@@ -14,10 +14,10 @@
 # limitations under the License.
 #
 
-require 'fileutils'
-require 'mixlib/shellout'
-require 'ostruct'
-require 'pathname'
+require "fileutils"
+require "mixlib/shellout"
+require "ostruct"
+require "pathname"
 
 module Omnibus
   class Builder
@@ -111,37 +111,41 @@ module Omnibus
 
       make = options.delete(:bin) ||
         # Prefer gmake on non-windows environments.
-        if !windows? && Omnibus.which('gmake')
+        if !windows? && Omnibus.which("gmake")
           env = options.delete(:env) || {}
-          env = { 'MAKE' => 'gmake' }.merge(env)
+          env = { "MAKE" => "gmake" }.merge(env)
           options[:env] = env
-          'gmake'
+          "gmake"
         else
-          'make'
+          "make"
         end
 
       options[:in_msys_bash] = true
-      make_cmd = ([make] + args).join(' ').strip
+      make_cmd = ([make] + args).join(" ").strip
       command(make_cmd, options)
     end
     expose :make
 
     # Run a prexisting "./configure" script that was generated by autotools.
     # On windows, this will run configure within an msys bash shell with
-    # the given arguments. --host is also set on your behalf based on
+    # the given arguments. --build is also set on your behalf based on
     # windows_arch. A default prefix of "#{install_bin}/embedded" is
-    # appended.
+    # appended. It is important to set --build rather than --host because
+    # by default, --build also sets --host but it doesn't trigger
+    # "cross-compilation" mode in most configure scripts. Triggering this mode
+    # can confuse certain software projects like Ruby which depend on the
+    # build platform in its mkmf scripts.
     #
     # @example With no arguments
     #   configure
     # On POSIX systems, this results in:
     #   ./configure --prefix=/path/to/embedded
     # On Windows 64-bit, this results in:
-    #   ./configure --host=x86_64-w64-mingw32 --prefix=C:/path/to/embedded
+    #   ./configure --build=x86_64-w64-mingw32 --prefix=C:/path/to/embedded
     # Note that the windows case uses a windows compabile path with forward
     # slashes - not an msys path. Ensure that the final Makefile is happy
     # with this and doesn't perform path gymnastics on it. Don't pass
-    # \\ paths unless you particularly enjoy discovering exactly home many
+    # \\ paths unless you particularly enjoy discovering exactly how many
     # times configure and the Makefile it generates sends your path back
     # and forth through bash/sh, mingw32 native binaries and msys binaries
     # and how many backslashes it takes for you to quit software development.
@@ -162,20 +166,25 @@ module Omnibus
     def configure(*args)
       options = args.last.is_a?(Hash) ? args.pop : {}
 
-      configure = options.delete(:bin) || './configure'
+      configure = options.delete(:bin) || "./configure"
       configure_cmd = [configure]
 
-      # Pass the host platform as well. msys is configured for 32-bits even
-      # if the actual installed compiler has 64-bit support.
-      configure_cmd << '--host=x86_64-w64-mingw32' if windows? && !windows_arch_i386?
+      # Pass the host platform as well. Different versions of config.guess
+      # arrive at differently terrible wild ass guesses for what MSYSTEM=MINGW64
+      # means. This can be anything from x86_64-pc-mingw64 to i686-pc-mingw32
+      # which doesn't even make any sense...
+      if windows?
+        platform = windows_arch_i386? ? "i686-w64-mingw32" : "x86_64-w64-mingw32"
+        configure_cmd << "--build=#{platform}"
+      end
 
       # Accept a prefix override if provided. Can be set to '' to suppress
       # this functionality.
       prefix = options.delete(:prefix) || "#{install_dir}/embedded"
-      configure_cmd << "--prefix=#{prefix}" if prefix && prefix != ''
+      configure_cmd << "--prefix=#{prefix}" if prefix && prefix != ""
 
       configure_cmd.concat args
-      configure_cmd = configure_cmd.join(' ').strip
+      configure_cmd = configure_cmd.join(" ").strip
 
       options[:in_msys_bash] = true
       command(configure_cmd, options)
@@ -212,7 +221,7 @@ module Omnibus
       plevel = options.delete(:plevel) || 1
       target = options.delete(:target)
 
-      locations, patch_path = find_file('config/patches', source)
+      locations, patch_path = find_file("config/patches", source)
 
       unless patch_path
         raise MissingPatch.new(source, locations)
@@ -288,7 +297,7 @@ module Omnibus
     #
     def ruby(command, options = {})
       build_commands << BuildCommand.new("ruby `#{command}'") do
-        bin = embedded_bin('ruby')
+        bin = embedded_bin("ruby")
         shellout!("#{bin} #{command}", options)
       end
     end
@@ -305,7 +314,7 @@ module Omnibus
     #
     def gem(command, options = {})
       build_commands << BuildCommand.new("gem `#{command}'") do
-        bin = embedded_bin('gem')
+        bin = embedded_bin("gem")
         shellout!("#{bin} #{command}", options)
       end
     end
@@ -325,7 +334,7 @@ module Omnibus
     #
     def bundle(command, options = {})
       build_commands << BuildCommand.new("bundle `#{command}'") do
-        bin = embedded_bin('bundle')
+        bin = embedded_bin("bundle")
         shellout!("#{bin} #{command}", options)
       end
     end
@@ -354,7 +363,7 @@ module Omnibus
         end
 
         bin_dir            = "#{install_dir}/bin"
-        appbundler_bin     = embedded_bin('appbundler')
+        appbundler_bin     = embedded_bin("appbundler")
 
         # Ensure the main bin dir exists
         FileUtils.mkdir_p(bin_dir)
@@ -376,7 +385,7 @@ module Omnibus
     #
     def rake(command, options = {})
       build_commands << BuildCommand.new("rake `#{command}'") do
-        bin = embedded_bin('rake')
+        bin = embedded_bin("rake")
         shellout!("#{bin} #{command}", options)
       end
     end
@@ -400,7 +409,7 @@ module Omnibus
     # @param (see #command)
     # @return (see #command)
     #
-    def block(name = '<Dynamic Ruby block>', &proc)
+    def block(name = "<Dynamic Ruby block>", &proc)
       build_commands << BuildCommand.new(name, &proc)
     end
     expose :block
@@ -442,7 +451,7 @@ module Omnibus
       raise "Missing required option `:source'!" unless source
       raise "Missing required option `:dest'!"   unless dest
 
-      locations, source_path = find_file('config/templates', source)
+      locations, source_path = find_file("config/templates", source)
 
       unless source_path
         raise MissingTemplate.new(source, locations)
@@ -454,7 +463,7 @@ module Omnibus
         render_template(source_path,
           destination: dest,
           mode:        mode,
-          variables:   vars,
+          variables:   vars
         )
       end
     end
@@ -556,7 +565,7 @@ module Omnibus
         Dir.chdir(software.project_dir) do
           files = FileSyncer.glob(source)
           if files.empty?
-            log.warn(log_key) {"no matched files for glob #{command}"}
+            log.warn(log_key) { "no matched files for glob #{command}" }
           else
             files.each do |file|
               FileUtils.cp_r(file, destination, options)
@@ -585,7 +594,7 @@ module Omnibus
         Dir.chdir(software.project_dir) do
           files = FileSyncer.glob(source)
           if files.empty?
-            log.warn(log_key) {"no matched files for glob #{command}"}
+            log.warn(log_key) { "no matched files for glob #{command}" }
           else
             files.each do |file|
               FileUtils.mv(file, destination, options)
@@ -614,7 +623,7 @@ module Omnibus
         Dir.chdir(software.project_dir) do
           files = FileSyncer.glob(source)
           if files.empty?
-            log.warn(log_key) {"no matched files for glob #{command}"}
+            log.warn(log_key) { "no matched files for glob #{command}" }
           else
             files.each do |file|
               FileUtils.ln_s(file, destination, options)
@@ -689,9 +698,9 @@ module Omnibus
     # @return [void]
     #
     def build
-      log.info(log_key) { 'Starting build' }
+      log.info(log_key) { "Starting build" }
       shasum # ensure shashum is calculated before build since the build can alter the shasum
-      log.internal(log_key) { "Cached builder checksum before build: #{shasum}"}
+      log.internal(log_key) { "Cached builder checksum before build: #{shasum}" }
       if software.overridden?
         log.info(log_key) do
           "Version overridden from #{software.default_version} to "\
@@ -705,7 +714,7 @@ module Omnibus
         end
       end
 
-      log.info(log_key) { 'Finished build' }
+      log.info(log_key) { "Finished build" }
     end
 
     #
@@ -744,14 +753,6 @@ module Omnibus
 
     private
 
-    def embedded_bin(bin)
-      windows_safe_path("#{install_dir}/embedded/bin/#{bin}")
-    end
-
-    def embedded_msys_bin(bin)
-      windows_safe_path("#{install_dir}/embedded/msys/1.0/bin/#{bin}")
-    end
-
     #
     # The **in-order** list of {BuildCommand} for this builder.
     #
@@ -796,23 +797,11 @@ module Omnibus
       options = { cwd: software.project_dir }.merge(options)
 
       if options.delete(:in_msys_bash) && windows?
-        # The command needs to be run within an msys bash environment.
-        # TODO: Eventually, have command search through "build time dependencies"
-        # for bash instead.
-        bash_bin = embedded_msys_bin('bash.exe')
-        unless File.exist?(bash_bin)
-          # Fallback to just looking at the embedded_bin directory in case
-          # we're using devkit or older chef-dk.
-          bash_bin = embedded_bin('bash.exe')
-          unless File.exist?(bash_bin)
-            bash_bin = "bash.exe"
-          end
-        end
         # Mixlib will handle escaping characters for cmd but our command might
         # contain '. For now, assume that won't happen because I don't know
         # whether this command is going to be played via cmd or through
         # ProcessCreate.
-        command_string = "\"#{bash_bin}\" -c \'#{command_string}\'"
+        command_string = "bash -c \'#{command_string}\'"
       end
 
       # Set the log level to :info so users will see build commands
@@ -862,7 +851,7 @@ module Omnibus
       exceptions = [CommandFailed, CommandTimeout]
 
       begin
-        block.call
+        yield
       rescue *exceptions => e
         if tries <= 0
           raise e
@@ -907,12 +896,12 @@ module Omnibus
     def with_clean_env(&block)
       original = ENV.to_hash
 
-      ENV.delete('_ORIGINAL_GEM_PATH')
-      ENV.delete_if { |k,_| k.start_with?('BUNDLE_') }
-      ENV.delete_if { |k,_| k.start_with?('GEM_') }
-      ENV.delete_if { |k,_| k.start_with?('RUBY') }
+      ENV.delete("_ORIGINAL_GEM_PATH")
+      ENV.delete_if { |k, _| k.start_with?("BUNDLE_") }
+      ENV.delete_if { |k, _| k.start_with?("GEM_") }
+      ENV.delete_if { |k, _| k.start_with?("RUBY") }
 
-      block.call
+      yield
     ensure
       ENV.replace(original.to_hash)
     end

data/lib/omnibus/changelog.rb

@@ -1,11 +1,11 @@
-require 'omnibus/git_repository'
+require "omnibus/git_repository"
 
 module Omnibus
   class ChangeLog
     CHANGELOG_TAG = "ChangeLog-Entry"
 
     attr_reader :end_ref
-    def initialize(start_ref=nil, end_ref="HEAD", git_repo=GitRepository.new('./'))
+    def initialize(start_ref = nil, end_ref = "HEAD", git_repo = GitRepository.new("./"))
       @start_ref = start_ref
       @end_ref = end_ref
       @git_repo = git_repo

data/lib/omnibus/changelog_printer.rb

@@ -1,7 +1,7 @@
 module Omnibus
   class ChangeLogPrinter
 
-    def initialize(changelog, diff, source_path="../")
+    def initialize(changelog, diff, source_path = "../")
       @changelog = changelog
       @diff = diff
       @source_path = source_path
@@ -21,7 +21,7 @@ module Omnibus
 
     attr_reader :changelog, :diff, :source_path
 
-    def print_changelog(cl=changelog, indent=0)
+    def print_changelog(cl = changelog, indent = 0)
       cl.changelog_entries.each do |entry|
         puts "#{' ' * indent}* #{entry.sub("\n", "\n  #{' ' * indent}")}\n"
       end
@@ -49,8 +49,8 @@ module Omnibus
       diff.updated.each do |entry|
         puts sprintf("* %s (%.8s -> %.8s)",
                      entry[:name], entry[:old_version], entry[:new_version])
-        repo_path = ::File.join(source_path, entry[:name])
-        if entry[:source_type] == 'git' && ::File.directory?("#{repo_path}/.git")
+        repo_path = ::File.join(source_path, entry[:name].to_s)
+        if entry[:source_type] == :git && ::File.directory?("#{repo_path}/.git")
           cl = ChangeLog.new(entry[:old_version], entry[:new_version], GitRepository.new("#{repo_path}"))
           print_changelog(cl, 2)
         end

data/lib/omnibus/cleaner.rb

@@ -14,7 +14,7 @@
 # limitations under the License.
 #
 
-require 'thor'
+require "thor"
 
 module Omnibus
   class Cleaner < Thor::Group
@@ -23,13 +23,13 @@ module Omnibus
     namespace :clean
 
     argument :name,
-      banner: 'NAME',
-      desc: 'The name of the Omnibus project',
+      banner: "NAME",
+      desc: "The name of the Omnibus project",
       type: :string,
       required: true
 
     class_option :purge,
-      desc: 'Purge the packages and caches',
+      desc: "Purge the packages and caches",
       type: :boolean,
       default: false
 

data/lib/omnibus/cli/base.rb

@@ -27,7 +27,7 @@ module Omnibus
         # argument and blows up...
         if args.length > 1 && !(args & Thor::HELP_MAPPINGS).empty?
           args = args - Thor::HELP_MAPPINGS
-          args.insert(-2, 'help')
+          args.insert(-2, "help")
         end
 
         super
@@ -45,8 +45,8 @@ module Omnibus
       end
 
       # Do not load the Omnibus config if we are asking for help or the version
-      if %w(help version).include?(config[:current_command].name)
-        log.debug(log_key) { 'Skipping Omnibus loading (detected help or version)' }
+      if %w{help version}.include?(config[:current_command].name)
+        log.debug(log_key) { "Skipping Omnibus loading (detected help or version)" }
         return
       end
 
@@ -55,16 +55,16 @@ module Omnibus
         Omnibus.load_configuration(@options[:config])
       else
         if @options[:config] == Omnibus::DEFAULT_CONFIG
-          log.debug(log_key) { 'Config file not given - using defaults' }
+          log.debug(log_key) { "Config file not given - using defaults" }
         else
           raise "The given config file '#{@options[:config]}' does not exist!"
         end
       end
 
       @options[:override].each do |key, value|
-        if %w(true false nil).include?(value)
+        if %w{true false nil}.include?(value)
           log.debug(log_key) { "Detected #{value.inspect} should be an object" }
-          value = { 'true' => true, 'false' => false, 'nil' => nil }[value]
+          value = { "true" => true, "false" => false, "nil" => nil }[value]
         end
 
         if value =~ /\A[[:digit:]]+\Z/
@@ -76,25 +76,25 @@ module Omnibus
           log.debug(log_key) { "Setting Config.#{key} = #{value.inspect}" }
           Config.send(key, value)
         else
-          log.debug (log_key){ "Skipping option '#{key}' - not a config option" }
+          log.debug (log_key) { "Skipping option '#{key}' - not a config option" }
         end
       end
     end
 
     class_option :config,
-      desc: 'Path to the Omnibus config file',
-      aliases: '-c',
+      desc: "Path to the Omnibus config file",
+      aliases: "-c",
       type: :string,
       default: Omnibus::DEFAULT_CONFIG
     class_option :log_level,
-      desc: 'The log level',
-      aliases: '-l',
+      desc: "The log level",
+      aliases: "-l",
       type: :string,
       enum: Logger::LEVELS.map(&:downcase),
-      default: 'info'
+      default: "info"
     class_option :override,
-      desc: 'Override one or more Omnibus config options',
-      aliases: '-o',
+      desc: "Override one or more Omnibus config options",
+      aliases: "-o",
       type: :hash,
       default: {}
 
@@ -102,7 +102,7 @@ module Omnibus
     # Hide the default help task to encourage people to use +-h+ instead of
     # Thor's dumb way of asking for help.
     #
-    desc 'help [COMMAND]', 'Show help output', hide: true
+    desc "help [COMMAND]", "Show help output", hide: true
     def help(*)
       super
     end

data/lib/omnibus/cli/cache.rb

@@ -23,14 +23,14 @@ module Omnibus
     #
     #   $ omnibus cache existing
     #
-    desc 'existing', 'List software packages which exist in the cache'
+    desc "existing", "List software packages which exist in the cache"
     def existing
       result = S3Cache.list
 
       if result.empty?
-        say('There are no packages in the cache!')
+        say("There are no packages in the cache!")
       else
-        say('The following packages are in the cache:')
+        say("The following packages are in the cache:")
         result.each do |software|
           say("  * #{software.name}-#{software.version}")
         end
@@ -42,14 +42,14 @@ module Omnibus
     #
     #   $ omnibus cache list
     #
-    desc 'list', 'List all cached files (by S3 key)'
+    desc "list", "List all cached files (by S3 key)"
     def list
       result = S3Cache.keys
 
       if result.empty?
-        say('There is nothing in the cache!')
+        say("There is nothing in the cache!")
       else
-        say('Cached files (by S3 key):')
+        say("Cached files (by S3 key):")
         result.each do |key|
           say("  * #{key}")
         end
@@ -61,14 +61,14 @@ module Omnibus
     #
     #   $ omnibus cache missing
     #
-    desc 'missing', 'Lists software packages that are required but not yet cached'
+    desc "missing", "Lists software packages that are required but not yet cached"
     def missing
       result = S3Cache.missing
 
       if result.empty?
-        say('There are no missing packages in the cache.')
+        say("There are no missing packages in the cache.")
       else
-        say('The following packages are missing from the cache:')
+        say("The following packages are missing from the cache:")
         result.each do |software|
           say("  * #{software.name}-#{software.version}")
         end
@@ -80,9 +80,9 @@ module Omnibus
     #
     #   $ omnibus cache fetch
     #
-    desc 'fetch', 'Fetches missing software packages locally'
+    desc "fetch", "Fetches missing software packages locally"
     def fetch
-      say('Fetching missing packages...')
+      say("Fetching missing packages...")
       S3Cache.fetch_missing
     end
 
@@ -91,9 +91,9 @@ module Omnibus
     #
     #   $ omnibus cache populate
     #
-    desc 'populate', 'Populate the S3 Cache'
+    desc "populate", "Populate the S3 Cache"
     def populate
-      say('Populating the cache...')
+      say("Populating the cache...")
       S3Cache.populate
     end
   end

data/lib/omnibus/cli/changelog.rb

@@ -14,11 +14,11 @@
 # limitations under the License.
 #
 
-require 'omnibus/changelog'
-require 'omnibus/changelog_printer'
-require 'omnibus/manifest_diff'
-require 'omnibus/semantic_version'
-require 'ffi_yajl'
+require "omnibus/changelog"
+require "omnibus/changelog_printer"
+require "omnibus/manifest_diff"
+require "omnibus/semantic_version"
+require "ffi_yajl"
 
 module Omnibus
   class Command::ChangeLog < Command::Base
@@ -67,8 +67,8 @@ module Omnibus
     desc: "Explicit version for this changelog",
     type: :string
 
-    desc 'generate [START] [END]', 'Generate a changelog for a new release'
-    def generate(start_ref=nil, end_ref=nil)
+    desc "generate [START] [END]", "Generate a changelog for a new release"
+    def generate(start_ref = nil, end_ref = nil)
       @start_ref = start_ref
       @end_ref = end_ref
       diff = if @options[:skip_components]
@@ -108,7 +108,6 @@ module Omnibus
       Omnibus::Manifest.from_hash(FFI_Yajl::Parser.parse(local_git_repo.file_at_revision("version-manifest.json", rev)))
     end
 
-
     def new_version
       if @options[:version]
         @options[:version]
@@ -143,7 +142,7 @@ module Omnibus
       @end_ref ||= if @options[:ending_manifest]
                      new_manifest.build_git_revision
                    else
-                     'HEAD'
+                     "HEAD"
                    end
     end
   end

data/lib/omnibus/cli/publish.rb

@@ -34,11 +34,11 @@ module Omnibus
     #   }
     #
     class_option :platform_mappings,
-      desc: 'The optional platform mappings JSON file to publish with',
+      desc: "The optional platform mappings JSON file to publish with",
       type: :string
 
     class_option :version_manifest,
-      desc: 'Path to the version-manifest.json file to publish with',
+      desc: "Path to the version-manifest.json file to publish with",
       type: :string
 
     #
@@ -48,14 +48,14 @@ module Omnibus
     #
     method_option :acl,
       type: :string,
-      desc: 'The accessibility of the uploaded packages',
-      enum: %w(public private),
-      default: 'private'
+      desc: "The accessibility of the uploaded packages",
+      enum: %w{public private},
+      default: "private"
     method_option :region,
       type: :string,
-      desc: 'The region in which the bucket is located',
-      default: 'us-east-1'
-    desc 's3 BUCKET PATTERN', 'Publish to an S3 bucket'
+      desc: "The region in which the bucket is located",
+      default: "us-east-1"
+    desc "s3 BUCKET PATTERN", "Publish to an S3 bucket"
     def s3(bucket, pattern)
       options[:bucket] = bucket
       publish(S3Publisher, pattern, options)
@@ -68,16 +68,15 @@ module Omnibus
     #
     method_option :build_record,
       type: :boolean,
-      desc: 'Optionally create an Artifactory build record for the published artifacts',
+      desc: "Optionally create an Artifactory build record for the published artifacts",
       default: true
     method_option :properties,
       type: :hash,
-      desc: 'Properites to attach to published artifacts',
+      desc: "Properites to attach to published artifacts",
       default: {}
-    desc 'artifactory REPOSITORY PATTERN', 'Publish to an Artifactory instance'
+    desc "artifactory REPOSITORY PATTERN", "Publish to an Artifactory instance"
     def artifactory(repository, pattern)
-
-      Omnibus.logger.deprecated('ArtifactoryPublisher') do
+      Omnibus.logger.deprecated("ArtifactoryPublisher") do
         "The `--version-manifest' option has been deprecated. Version manifest data is now part of the `*.metadata.json' file"
       end if options[:version_manifest]