omnibus 5.4.0 → 5.5.0

data/lib/omnibus/software.rb

@@ -14,9 +14,9 @@
 # limitations under the License.
 #
 
-require 'fileutils'
-require 'uri'
-require 'omnibus/manifest_entry'
+require "fileutils"
+require "uri"
+require "omnibus/manifest_entry"
 
 module Omnibus
   class Software
@@ -76,6 +76,7 @@ module Omnibus
     include Logging
     include NullArgumentable
     include Sugarable
+    include Util
 
     attr_reader :manifest
 
@@ -91,7 +92,7 @@ module Omnibus
     #
     # @return [Software]
     #
-    def initialize(project, filepath = nil, manifest=nil)
+    def initialize(project, filepath = nil, manifest = nil)
       unless project.is_a?(Project)
         raise ArgumentError,
           "`project' must be a kind of `Omnibus::Project', but was `#{project.class.inspect}'!"
@@ -108,10 +109,10 @@ module Omnibus
 
     def manifest_entry
       @manifest_entry ||= if manifest
-                            log.info(log_key) {"Using user-supplied manifest entry for #{name}"}
+                            log.info(log_key) { "Using user-supplied manifest entry for #{name}" }
                             manifest.entry_for(name)
                           else
-                            log.info(log_key) {"Resolving manifest entry for #{name}"}
+                            log.info(log_key) { "Resolving manifest entry for #{name}" }
                             to_manifest_entry
                           end
     end
@@ -156,7 +157,7 @@ module Omnibus
     #
     def name(val = NULL)
       if null?(val)
-        @name || raise(MissingRequiredAttribute.new(self, :name, 'libxslt'))
+        @name || raise(MissingRequiredAttribute.new(self, :name, "libxslt"))
       else
         @name = val
       end
@@ -183,7 +184,6 @@ module Omnibus
     end
     expose :description
 
-
     #
     # Sets the maintainer of the software.  Currently this is for
     # human consumption only and the tool doesn't do anything with it.
@@ -352,7 +352,7 @@ module Omnibus
     #
     def license(val = NULL)
       if null?(val)
-        @license || 'Unspecified'
+        @license || "Unspecified"
       else
         @license = val
       end
@@ -379,6 +379,26 @@ module Omnibus
     end
     expose :license_file
 
+    #
+    # Skip collecting licenses of transitive dependencies for this software
+    #
+    # @example
+    #   skip_transitive_dependency_licensing true
+    #
+    # @param [Boolean] val
+    #   set or reset transitive dependency license collection
+    #
+    # @return [Boolean]
+    #
+    def skip_transitive_dependency_licensing(val = NULL)
+      if null?(val)
+        @skip_transitive_dependency_licensing || false
+      else
+        @skip_transitive_dependency_licensing = val
+      end
+    end
+    expose :skip_transitive_dependency_licensing
+
     #
     # Evaluate a block only if the version matches.
     #
@@ -400,10 +420,29 @@ module Omnibus
       if block_given?
         if val.equal?(NULL)
           raise InvalidValue.new(:version,
-            'pass a block when given a version argument')
+            "pass a block when given a version argument")
         else
           if val == final_version
-            block.call
+            #
+            # Unfortunately we need to make a specific logic here for license files.
+            # We support multiple calls `license_file` and we support overriding the
+            # license files inside a version block. We can not differentiate whether
+            # `license_file` is being called from a version block or not. So we need
+            # to check if the license files are being overridden during the call to
+            # block.
+            #
+            # If so we use the new set, otherwise we restore the old license files.
+            #
+            current_license_files = @license_files
+            @license_files = []
+
+            yield
+
+            new_license_files = @license_files
+
+            if new_license_files.empty?
+              @license_files = current_license_files
+            end
           end
         end
       end
@@ -465,7 +504,7 @@ module Omnibus
     #
     def relative_path(val = NULL)
       if null?(val)
-        @relative_path || '.'
+        @relative_path || "."
       else
         @relative_path = val
       end
@@ -572,8 +611,6 @@ module Omnibus
     #
     # Supported options:
     #    :aix => :use_gcc    force using gcc/g++ compilers on aix
-    #    :bfd_flags => true   the default build targets for windows based on
-    #       the current platform architecture are added ARFLAGS and RCFLAGS.
     #
     # @param [Hash] env
     # @param [Hash] opts
@@ -584,7 +621,7 @@ module Omnibus
       env ||= {}
       opts ||= {}
       compiler_flags =
-        case Ohai['platform']
+        case Ohai["platform"]
         when "aix"
           {
             "CC" => "xlc_r -q64",
@@ -601,7 +638,7 @@ module Omnibus
             "CFLAGS" => "-I#{install_dir}/embedded/include -O2",
           }
         when "solaris2"
-          if platform_version.satisfies?('<= 5.10')
+          if platform_version.satisfies?("<= 5.10")
             solaris_flags = {
               # this override is due to a bug in libtool documented here:
               # http://lists.gnu.org/archive/html/bug-libtool/2005-10/msg00004.html
@@ -609,7 +646,7 @@ module Omnibus
               "LDFLAGS" => "-R#{install_dir}/embedded/lib -L#{install_dir}/embedded/lib -static-libgcc",
               "CFLAGS" => "-I#{install_dir}/embedded/include",
             }
-          elsif platform_version.satisfies?('>= 5.11')
+          elsif platform_version.satisfies?(">= 5.11")
             solaris_flags = {
               "CC" => "gcc -m64 -static-libgcc",
               "LDFLAGS" => "-Wl,-rpath,#{install_dir}/embedded/lib -L#{install_dir}/embedded/lib -static-libgcc",
@@ -623,25 +660,21 @@ module Omnibus
             "CFLAGS" => "-I#{install_dir}/embedded/include -O2",
           }
           # Enable gcc version 4.9 if it is available
-          if (Ohai['os_version'].to_i <= 903000) && which('gcc49')
-            freebsd_flags.merge!(
-              "CC" => "gcc49",
-              "CXX" => "g++49",
-            )
+          if (Ohai["os_version"].to_i <= 903000) && which("gcc49")
+            freebsd_flags["CC"] = "gcc49"
+            freebsd_flags["CXX"] = "g++49"
           end
           # Clang became the default compiler in FreeBSD 10+
-          if Ohai['os_version'].to_i >= 1000024
-            freebsd_flags.merge!(
-              "CC" => "clang",
-              "CXX" => "clang++",
-            )
+          if Ohai["os_version"].to_i >= 1000024
+            freebsd_flags["CC"] = "clang"
+            freebsd_flags["CXX"] = "clang++"
           end
           freebsd_flags
         when "windows"
           arch_flag = windows_arch_i386? ? "-m32" : "-m64"
           opt_flag = windows_arch_i386? ? "-march=i686" : "-march=x86-64"
           {
-            "LDFLAGS" => "-L#{install_dir}/embedded/lib #{arch_flag}",
+            "LDFLAGS" => "-L#{install_dir}/embedded/lib #{arch_flag} -fno-lto",
             # We do not wish to enable SSE even though we target i686 because
             # of a stack alignment issue with some libraries. We have not
             # exactly ascertained the cause but some compiled library/binary
@@ -651,7 +684,13 @@ module Omnibus
             # soon as gcc emits aligned SSE xmm register spills which generate
             # GPEs and terminate the application very rudely with very little
             # to debug with.
-            "CFLAGS" => "-I#{install_dir}/embedded/include #{arch_flag} -O3 #{opt_flag}"
+            #
+            # TODO: This was true of our old TDM gcc 4.7 compilers. Is it still
+            # true with mingw-w64?
+            #
+            # XXX: Temporarily turning -O3 into -O2 -fno-lto to work around some
+            # weird linker issues.
+            "CFLAGS" => "-I#{install_dir}/embedded/include #{arch_flag} -O2 -fno-lto #{opt_flag}",
           }
         else
           {
@@ -660,18 +699,6 @@ module Omnibus
           }
         end
 
-      # There are some weird, misbehaving makefiles on windows that hate ARFLAGS because it
-      # replaces the "rcs" flags in some build steps.  So we provide this flag behind an
-      # optional flag.
-      if opts[:bfd_flags] && windows?
-        bfd_target = windows_arch_i386? ? "pe-i386" : "pe-x86-64"
-        compiler_flags.merge!(
-          {
-            "RCFLAGS" => "--target=#{bfd_target}",
-            "ARFLAGS" => "--target=#{bfd_target}",
-          }
-        )
-      end
       # merge LD_RUN_PATH into the environment.  most unix distros will fall
       # back to this if there is no LDFLAGS passed to the linker that sets
       # the rpath.  the LDFLAGS -R or -Wl,-rpath will override this, but in
@@ -680,30 +707,26 @@ module Omnibus
       # better.  in that case LD_RUN_PATH will probably survive whatever
       # edits the configure script does
       extra_linker_flags = {
-        "LD_RUN_PATH" => "#{install_dir}/embedded/lib"
+        "LD_RUN_PATH" => "#{install_dir}/embedded/lib",
       }
 
       if solaris2?
         ld_options = "-R#{install_dir}/embedded/lib"
 
-        if platform_version.satisfies?('<= 5.10')
+        if platform_version.satisfies?("<= 5.10")
           # in order to provide compatibility for earlier versions of libc on solaris 10,
           # we need to specify a mapfile that restricts the version of system libraries
           # used. See http://docs.oracle.com/cd/E23824_01/html/819-0690/chapter5-1.html
           # for more information
           # use the mapfile if it exists, otherwise ignore it
           mapfile_path = File.expand_path(Config.solaris_linker_mapfile, Config.project_root)
-          ld_options  << " -M #{mapfile_path}" if File.exist?(mapfile_path)
+          ld_options << " -M #{mapfile_path}" if File.exist?(mapfile_path)
         end
 
         # solaris linker can also use LD_OPTIONS, so we throw the kitchen sink against
         # the linker, to find every way to make it use our rpath. This is also required
         # to use the aforementioned mapfile.
-        extra_linker_flags.merge!(
-          {
-            "LD_OPTIONS" => ld_options
-          }
-        )
+        extra_linker_flags["LD_OPTIONS"] = ld_options
       end
 
       env.merge(compiler_flags).
@@ -711,10 +734,10 @@ module Omnibus
         # always want to favor pkg-config from embedded location to not hose
         # configure scripts which try to be too clever and ignore our explicit
         # CFLAGS and LDFLAGS in favor of pkg-config info
-        merge({"PKG_CONFIG_PATH" => "#{install_dir}/embedded/lib/pkgconfig"}).
+        merge({ "PKG_CONFIG_PATH" => "#{install_dir}/embedded/lib/pkgconfig" }).
         # Set default values for CXXFLAGS and CPPFLAGS.
-        merge('CXXFLAGS' => compiler_flags['CFLAGS']).
-        merge('CPPFLAGS' => compiler_flags['CFLAGS'])
+        merge("CXXFLAGS" => compiler_flags["CFLAGS"]).
+        merge("CPPFLAGS" => compiler_flags["CFLAGS"])
     end
     expose :with_standard_compiler_flags
 
@@ -724,19 +747,30 @@ module Omnibus
     # for the platform is used to join the paths.
     #
     # @param [Hash] env
-    # @param [Hash] opts
-    #   :msys => true  add the embedded msys path if building on windows.
     #
     # @return [Hash]
     #
-    def with_embedded_path(env = {}, opts = {})
+    def with_embedded_path(env = {})
       paths = ["#{install_dir}/bin", "#{install_dir}/embedded/bin"]
-      paths << "#{install_dir}/embedded/msys/1.0/bin" if opts[:msys] && windows?
       path_value = prepend_path(paths)
       env.merge(path_key => path_value)
     end
     expose :with_embedded_path
 
+    #
+    # Returns the platform safe full path under embedded/bin directory to the
+    # given binary
+    #
+    # @param [String] bin
+    #   Name of the binary under embedded/bin
+    #
+    # @return [String]
+    #
+    def embedded_bin(bin)
+      windows_safe_path("#{install_dir}/embedded/bin/#{bin}")
+    end
+    expose :embedded_bin
+
     #
     # A PATH variable format string representing the current PATH with the
     # given path prepended. The correct path separator
@@ -750,7 +784,7 @@ module Omnibus
       path_values = Array(paths)
       path_values << ENV[path_key]
 
-      separator = File::PATH_SEPARATOR || ':'
+      separator = File::PATH_SEPARATOR || ":"
       path_values.join(separator)
     end
     expose :prepend_path
@@ -807,7 +841,7 @@ module Omnibus
                                    described_version: version,
                                    locked_version: Fetcher.resolve_version(version, source),
                                    locked_source: source,
-                                   license: license
+                                   license: license,
       })
     end
 
@@ -928,18 +962,18 @@ module Omnibus
     # Returns the version to be used in cache.
     def version_for_cache
       @version_for_cache ||= if fetcher.version_for_cache
-        fetcher.version_for_cache
-      elsif version
-        version
-      else
-        log.warn(log_key) do
-          "No version given! This is probably a bad thing. I am going to " \
-          "assume the version `0.0.0', but that is most certainly not your " \
-          "desired behavior. If git caching seems off, this is probably why."
-        end
-
-        '0.0.0'
-      end
+                               fetcher.version_for_cache
+                             elsif version
+                               version
+                             else
+                               log.warn(log_key) do
+                                 "No version given! This is probably a bad thing. I am going to " \
+                                 "assume the version `0.0.0', but that is most certainly not your " \
+                                 "desired behavior. If git caching seems off, this is probably why."
+                               end
+
+                               "0.0.0"
+                             end
     end
 
     #
@@ -961,7 +995,7 @@ module Omnibus
     #
     def fetcher
       @fetcher ||=
-        if source_type == :url && File.basename(source[:url], '?*').end_with?(*NetFetcher::ALL_EXTENSIONS)
+        if source_type == :url && File.basename(source[:url], "?*").end_with?(*NetFetcher::ALL_EXTENSIONS)
           Fetcher.fetcher_class_for_source(self.source).new(manifest_entry, fetch_dir, build_dir)
         else
           Fetcher.fetcher_class_for_source(self.source).new(manifest_entry, project_dir, build_dir)
@@ -994,25 +1028,33 @@ module Omnibus
     # be restored (if the tag does not exist), the actual build steps are
     # executed.
     #
+    # @param [Array<#execute_pre_build, #execute_post_build>] build_wrappers
+    #   Build wrappers inject behavior before or after the software is built.
+    #   They can be any object that implements `#execute_pre_build` and
+    #   `#execute_post_build`, taking this Software as an argument. Note that
+    #   these callbacks are only triggered when the software actually gets
+    #   built; if the build is skipped by the git cache, the callbacks DO NOT
+    #   run.
+    #
     # @return [true]
     #
-    def build_me
+    def build_me(build_wrappers = [])
       if Config.use_git_caching
         if project.dirty?
           log.info(log_key) do
             "Building because `#{project.culprit.name}' dirtied the cache"
           end
-          execute_build
+          execute_build(build_wrappers)
         elsif git_cache.restore
           log.info(log_key) { "Restored from cache" }
         else
           log.info(log_key) { "Could not restore from cache" }
-          execute_build
+          execute_build(build_wrappers)
           project.dirty!(self)
         end
       else
         log.debug(log_key) { "Forcing build because git caching is off" }
-        execute_build
+        execute_build(build_wrappers)
       end
 
       project.build_version_dsl.resolve(self)
@@ -1064,7 +1106,7 @@ module Omnibus
         if filepath && File.exist?(filepath)
           update_with_file_contents(digest, filepath)
         else
-          update_with_string(digest, '<DYNAMIC>')
+          update_with_string(digest, "<DYNAMIC>")
         end
 
         digest.hexdigest
@@ -1097,10 +1139,10 @@ module Omnibus
       # modify ENV['Path'] then it ignores that.  So, we scan ENV and returns the first
       # one that we find.
       #
-      if Ohai['platform'] == 'windows'
+      if Ohai["platform"] == "windows"
         ENV.keys.grep(/\Apath\Z/i).first
       else
-        'PATH'
+        "PATH"
       end
     end
 
@@ -1108,7 +1150,7 @@ module Omnibus
     # Apply overrides in the @overrides hash that mask instance variables
     # that are set by parsing the DSL
     #
-    def apply_overrides(attr, override=overrides[attr])
+    def apply_overrides(attr, override = overrides[attr])
       val = instance_variable_get(:"@#{attr}")
       if val.is_a?(Hash) || override.is_a?(Hash)
         val ||= {}
@@ -1135,15 +1177,23 @@ module Omnibus
     # Actually build this software, executing the steps provided in the
     # {#build} block and dirtying the cache.
     #
+    # @param [Array<#execute_pre_build, #execute_post_build>] build_wrappers
+    #   Build wrappers inject behavior before or after the software is built.
+    #   They can be any object that implements `#execute_pre_build` and
+    #   `#execute_post_build`
+    #
     # @return [void]
     #
-    def execute_build
+    def execute_build(build_wrappers)
       fetcher.clean
+
+      build_wrappers.each { |wrapper| wrapper.execute_pre_build(self) }
       builder.build
+      build_wrappers.each { |wrapper| wrapper.execute_post_build(self) }
 
       if Config.use_git_caching
         git_cache.incremental
-        log.info(log_key) { 'Dirtied the cache' }
+        log.info(log_key) { "Dirtied the cache" }
       end
     end
 

data/lib/omnibus/sugarable.rb

@@ -14,15 +14,15 @@
 # limitations under the License.
 #
 
-require 'chef/sugar/architecture'
-require 'chef/sugar/cloud'
-require 'chef/sugar/constraints'
-require 'chef/sugar/ip'
-require 'chef/sugar/platform'
-require 'chef/sugar/platform_family'
-require 'chef/sugar/ruby'
-require 'chef/sugar/shell'
-require 'chef/sugar/vagrant'
+require "chef/sugar/architecture"
+require "chef/sugar/cloud"
+require "chef/sugar/constraints"
+require "chef/sugar/ip"
+require "chef/sugar/platform"
+require "chef/sugar/platform_family"
+require "chef/sugar/ruby"
+require "chef/sugar/shell"
+require "chef/sugar/vagrant"
 
 module Omnibus
   module Sugarable
@@ -42,7 +42,7 @@ module Omnibus
         end
 
         # Make all the common "sugars" available in the cleanroom (DSL)
-         Omnibus::Sugar.instance_methods.each do |instance_method|
+        Omnibus::Sugar.instance_methods.each do |instance_method|
           base.send(:expose, instance_method)
         end
       end

data/lib/omnibus/templating.rb

@@ -14,7 +14,7 @@
 # limitations under the License.
 #
 
-require 'erb'
+require "erb"
 
 module Omnibus
   module Templating
@@ -40,7 +40,7 @@ module Omnibus
     #   the list of variables to pass to the template
     #
     def render_template(source, options = {})
-      destination = options.delete(:destination) || source.chomp('.erb')
+      destination = options.delete(:destination) || source.chomp(".erb")
 
       mode      = options.delete(:mode) || 0644
       variables = options.delete(:variables) || {}
@@ -52,7 +52,7 @@ module Omnibus
           "Unknown option(s): #{options.keys.map(&:inspect).join(', ')}"
       end
 
-      template = ERB.new(File.read(source), nil, '-')
+      template = ERB.new(File.read(source), nil, "-")
 
       struct =
         if variables.empty?
@@ -61,9 +61,9 @@ module Omnibus
           Struct.new(*variables.keys).new(*variables.values)
         end
 
-      result   = template.result(struct.instance_eval { binding })
+      result = template.result(struct.instance_eval { binding })
 
-      File.open(destination, 'w', mode) do |file|
+      File.open(destination, "w", mode) do |file|
         file.write(result)
       end
 

data/lib/omnibus/thread_pool.rb

@@ -15,7 +15,7 @@
 # limitations under the License.
 #
 
-require 'thread'
+require "thread"
 
 module Omnibus
   class ThreadPool

data/lib/omnibus/util.rb

@@ -14,7 +14,7 @@
 # limitations under the License.
 #
 
-require 'mixlib/shellout'
+require "mixlib/shellout"
 
 module Omnibus
   module Util
@@ -67,9 +67,9 @@ module Omnibus
 
       # Log any environment options given
       unless options[:environment].empty?
-        log.public_send(log_level, log_key)  { 'Environment:' }
+        log.public_send(log_level, log_key) { "Environment:" }
         options[:environment].sort.each do |key, value|
-          log.public_send(log_level, log_key)  { "  #{key}=#{value.inspect}" }
+          log.public_send(log_level, log_key) { "  #{key}=#{value.inspect}" }
         end
       end
 
@@ -77,7 +77,7 @@ module Omnibus
       log.public_send(log_level, log_key) { "$ #{args.join(' ')}" }
 
       cmd = Mixlib::ShellOut.new(*args, options)
-      cmd.environment['HOME'] = '/tmp' unless ENV['HOME']
+      cmd.environment["HOME"] = "/tmp" unless ENV["HOME"]
       cmd.run_command
       cmd
     end
@@ -202,7 +202,7 @@ module Omnibus
       FileUtils.mkdir_p(File.dirname(path))
 
       if block
-        File.open(path, 'wb') { |f| f.write(block.call) }
+        File.open(path, "wb") { |f| f.write(yield) }
       else
         FileUtils.touch(path)
       end

data/lib/omnibus/version.rb

@@ -15,5 +15,5 @@
 #
 
 module Omnibus
-  VERSION = '5.4.0'
+  VERSION = "5.5.0"
 end