omnibus 5.4.0 → 5.5.0

data/lib/omnibus/cli.rb

@@ -14,8 +14,8 @@
 # limitations under the License.
 #
 
-require 'thor'
-require 'omnibus'
+require "thor"
+require "omnibus"
 require "ffi_yajl"
 
 module Omnibus
@@ -55,7 +55,7 @@ module Omnibus
       end
     end
 
-    map %w(-v --version) => 'version'
+    map %w{-v --version} => "version"
 
     #
     # Build an Omnibus project or software definition.
@@ -70,7 +70,7 @@ module Omnibus
       desc: "Use the given manifest when downloading software sources.",
       type: :string,
       default: nil
-    desc 'build PROJECT', 'Build the given Omnibus project'
+    desc "build PROJECT", "Build the given Omnibus project"
     def build(name)
       manifest = if @options[:use_manifest]
                    Omnibus::Manifest.from_file(@options[:use_manifest])
@@ -84,16 +84,15 @@ module Omnibus
       project.build
 
       if @options[:output_manifest]
-        FileUtils.mkdir_p('pkg')
-        File.open(::File.join('pkg', 'version-manifest.json'), 'w') do |f|
+        FileUtils.mkdir_p("pkg")
+        File.open(::File.join("pkg", "version-manifest.json"), "w") do |f|
           f.write(FFI_Yajl::Encoder.encode(project.built_manifest.to_hash))
         end
       end
     end
 
-
-    register(Command::ChangeLog, 'changelog', 'changelog [COMMAND]', 'Create and view changelogs')
-    CLI.tasks['changelog'].options = Command::ChangeLog.class_options
+    register(Command::ChangeLog, "changelog", "changelog [COMMAND]", "Create and view changelogs")
+    CLI.tasks["changelog"].options = Command::ChangeLog.class_options
 
     #
     # Generate a version manifest for the given project definition
@@ -114,14 +113,14 @@ module Omnibus
       type: :string
     method_option :architecture,
       desc: "The target architecture: x86, x64, powerpc. Defaults to the current architecture."
-    desc 'manifest PROJECT', 'Print a manifest for the given Omnibus project'
+    desc "manifest PROJECT", "Print a manifest for the given Omnibus project"
     def manifest(name)
       # Override ohai information
-      Ohai['os'] = @options[:os] if @options[:os]
-      Ohai['platform_family'] = @options[:platform_family] if @options[:platform_family]
-      Ohai['platform'] = @options[:platform] if @options[:platform]
-      Ohai['platform_version'] = @options[:platform_version] if @options[:platform_version]
-      Ohai['kernel']['machine'] = @options[:architecture] if @options[:architecture]
+      Ohai["os"] = @options[:os] if @options[:os]
+      Ohai["platform_family"] = @options[:platform_family] if @options[:platform_family]
+      Ohai["platform"] = @options[:platform] if @options[:platform]
+      Ohai["platform_version"] = @options[:platform_version] if @options[:platform_version]
+      Ohai["kernel"]["machine"] = @options[:architecture] if @options[:architecture]
       puts FFI_Yajl::Encoder.encode(Project.load(name).built_manifest.to_hash, pretty: true)
     end
 
@@ -130,36 +129,36 @@ module Omnibus
     #
     #   $ omnibus cache list
     #
-    register(Command::Cache, 'cache', 'cache [COMMAND]', 'Manage the cache')
-    CLI.tasks['cache'].options = Command::Cache.class_options
+    register(Command::Cache, "cache", "cache [COMMAND]", "Manage the cache")
+    CLI.tasks["cache"].options = Command::Cache.class_options
 
     #
     # Clean the Omnibus project.
     #
     #   $ omnibus clean chefdk
     #
-    register(Cleaner, 'clean', 'clean PROJECT', 'Clean the Omnibus project')
-    CLI.tasks['clean'].options = Cleaner.class_options
+    register(Cleaner, "clean", "clean PROJECT", "Clean the Omnibus project")
+    CLI.tasks["clean"].options = Cleaner.class_options
 
     #
     # Initialize a new Omnibus project.
     #
     #   $ omnibus new NAME
     #
-    register(Generator, 'new', 'new NAME', 'Initialize a new Omnibus project')
-    CLI.tasks['new'].options = Generator.class_options
+    register(Generator, "new", "new NAME", "Initialize a new Omnibus project")
+    CLI.tasks["new"].options = Generator.class_options
 
     #
     # List the Omnibus projects available from "here".
     #
     #   $ omnibus list
     #
-    desc 'list', 'List the Omnibus projects'
+    desc "list", "List the Omnibus projects"
     def list
       if Omnibus.projects.empty?
-        say('There are no Omnibus projects!')
+        say("There are no Omnibus projects!")
       else
-        say('Omnibus projects:')
+        say("Omnibus projects:")
         Omnibus.projects.sort.each do |project|
           say("  * #{project.name} (#{project.build_version})")
         end
@@ -171,15 +170,15 @@ module Omnibus
     #
     #   $ omnibus publish s3 pkg/*chef*
     #
-    register(Command::Publish, 'publish', 'publish [COMMAND]', 'Publish Omnibus packages to a backend')
-    CLI.tasks['publish'].options = Command::Publish.class_options
+    register(Command::Publish, "publish", "publish [COMMAND]", "Publish Omnibus packages to a backend")
+    CLI.tasks["publish"].options = Command::Publish.class_options
 
     #
     # Display version information.
     #
     #   $ omnibus version
     #
-    desc 'version', 'Display version information', hide: true
+    desc "version", "Display version information", hide: true
     def version
       say("Omnibus v#{Omnibus::VERSION}")
     end

data/lib/omnibus/compressor.rb

@@ -18,10 +18,10 @@ module Omnibus
   module Compressor
     include Logging
 
-    autoload :Base, 'omnibus/compressors/base'
-    autoload :DMG,  'omnibus/compressors/dmg'
-    autoload :Null, 'omnibus/compressors/null'
-    autoload :TGZ,  'omnibus/compressors/tgz'
+    autoload :Base, "omnibus/compressors/base"
+    autoload :DMG,  "omnibus/compressors/dmg"
+    autoload :Null, "omnibus/compressors/null"
+    autoload :TGZ,  "omnibus/compressors/tgz"
 
     #
     # Determine the best compressor for the current system. This method returns
@@ -36,9 +36,9 @@ module Omnibus
     # @return [~Compressor::Base]
     #
     def for_current_system(compressors)
-      family = Ohai['platform_family']
+      family = Ohai["platform_family"]
 
-      if family == 'mac_os_x'
+      if family == "mac_os_x"
         if compressors.include?(:dmg)
           return DMG
         end

data/lib/omnibus/compressors/base.rb

@@ -14,7 +14,7 @@
 # limitations under the License.
 #
 
-require 'fileutils'
+require "fileutils"
 
 module Omnibus
   class Compressor::Base < Packager::Base
@@ -31,7 +31,12 @@ module Omnibus
     #
     def initialize(project)
       @project  = project
-      @packager = project.packager
+
+      # There can now be multiple packagers per platform
+      # but windows is the only platform that uses multiple
+      # packagers and it does not use a compressor. So for now,
+      # we ignore this multi packaging reality in compressors
+      @packager = project.packagers_for_system[0]
     end
   end
 end

data/lib/omnibus/compressors/dmg.rb

@@ -30,7 +30,7 @@ module Omnibus
 
       # Copy support files
       support = create_directory("#{resources_dir}/.support")
-      copy_file(resource_path('background.png'), "#{support}/background.png")
+      copy_file(resource_path("background.png"), "#{support}/background.png")
     end
 
     build do
@@ -63,7 +63,7 @@ module Omnibus
     #
     def window_bounds(val = NULL)
       if null?(val)
-        @window_bounds || '100, 100, 750, 600'
+        @window_bounds || "100, 100, 750, 600"
       else
         @window_bounds = val
       end
@@ -85,7 +85,7 @@ module Omnibus
     #
     def pkg_position(val = NULL)
       if null?(val)
-        @pkg_position || '535, 50'
+        @pkg_position || "535, 50"
       else
         @pkg_position = val
       end
@@ -136,7 +136,7 @@ module Omnibus
     def create_writable_dmg
       log.info(log_key) { "Creating writable dmg" }
 
-      shellout! <<-EOH.gsub(/^ {8}/, '')
+      shellout! <<-EOH.gsub(/^ {8}/, "")
         hdiutil create \\
           -srcfolder "#{resources_dir}" \\
           -volname "#{volume_name}" \\
@@ -158,7 +158,7 @@ module Omnibus
       @device ||= Dir.chdir(staging_dir) do
         log.info(log_key) { "Attaching dmg as disk" }
 
-        cmd = shellout! <<-EOH.gsub(/^ {10}/, '')
+        cmd = shellout! <<-EOH.gsub(/^ {10}/, "")
           hdiutil attach \\
             -readwrite \\
             -noverify \\
@@ -178,10 +178,10 @@ module Omnibus
     def set_volume_icon
       log.info(log_key) { "Setting volume icon" }
 
-      icon = resource_path('icon.png')
+      icon = resource_path("icon.png")
 
       Dir.chdir(staging_dir) do
-        shellout! <<-EOH.gsub(/^ {10}/, '')
+        shellout! <<-EOH.gsub(/^ {10}/, "")
           # Generate the icns
           mkdir tmp.iconset
           sips -z 16 16     #{icon} --out tmp.iconset/icon_16x16.png
@@ -213,7 +213,7 @@ module Omnibus
     def prettify_dmg
       log.info(log_key) { "Making the dmg all pretty and stuff" }
 
-      render_template(resource_path('create_dmg.osascript.erb'),
+      render_template(resource_path("create_dmg.osascript.erb"),
         destination: "#{staging_dir}/create_dmg.osascript",
         variables: {
           volume_name:   volume_name,
@@ -224,7 +224,7 @@ module Omnibus
       )
 
       Dir.chdir(staging_dir) do
-        shellout! <<-EOH.gsub(/^ {10}/, '')
+        shellout! <<-EOH.gsub(/^ {10}/, "")
           osascript "#{staging_dir}/create_dmg.osascript"
         EOH
       end
@@ -239,7 +239,7 @@ module Omnibus
       log.info(log_key) { "Compressing dmg" }
 
       Dir.chdir(staging_dir) do
-        shellout! <<-EOH.gsub(/^ {10}/, '')
+        shellout! <<-EOH.gsub(/^ {10}/, "")
           chmod -Rf go-w /Volumes/#{volume_name}
           sync
           hdiutil detach "#{@device}"
@@ -263,7 +263,7 @@ module Omnibus
       log.info(log_key) { "Setting dmg icon" }
 
       Dir.chdir(staging_dir) do
-        shellout! <<-EOH.gsub(/^ {10}/, '')
+        shellout! <<-EOH.gsub(/^ {10}/, "")
           # Convert the png to an icon
           sips -i "#{resource_path('icon.png')}"
 
@@ -282,7 +282,7 @@ module Omnibus
     # @see Base#package_name
     def package_name
       extname = File.extname(packager.package_name)
-      packager.package_name.sub(extname, '.dmg')
+      packager.package_name.sub(extname, ".dmg")
     end
 
     # The path to the writable dmg on disk.

data/lib/omnibus/compressors/null.rb

@@ -19,7 +19,7 @@ module Omnibus
     id :null
 
     def package_name
-      ''
+      ""
     end
 
     def run!

data/lib/omnibus/compressors/tgz.rb

@@ -14,8 +14,8 @@
 # limitations under the License.
 #
 
-require 'rubygems/package'
-require 'zlib'
+require "rubygems/package"
+require "zlib"
 
 module Omnibus
   class Compressor::TGZ < Compressor::Base
@@ -51,11 +51,11 @@ module Omnibus
         @compression_level || Zlib::BEST_COMPRESSION
       else
         unless val.is_a?(Integer)
-          raise InvalidValue.new(:compression_level, 'be an Integer')
+          raise InvalidValue.new(:compression_level, "be an Integer")
         end
 
         unless val.between?(1, 9)
-          raise InvalidValue.new(:compression_level, 'be between 1-9')
+          raise InvalidValue.new(:compression_level, "be between 1-9")
         end
 
         @compression_level = val
@@ -85,7 +85,7 @@ module Omnibus
       contents = gzipped_tarball
 
       # Write the .tar.gz into the staging directory
-      File.open("#{staging_dir}/#{package_name}", 'wb') do |tgz|
+      File.open("#{staging_dir}/#{package_name}", "wb") do |tgz|
         while chunk = contents.read(1024)
           tgz.write(chunk)
         end
@@ -103,14 +103,14 @@ module Omnibus
     # @return [StringIO]
     #
     def tarball
-      tarfile = StringIO.new('')
+      tarfile = StringIO.new("")
       Gem::Package::TarWriter.new(tarfile) do |tar|
         path = "#{staging_dir}/#{packager.package_name}"
         name = packager.package_name
         mode = File.stat(path).mode
 
         tar.add_file(name, mode) do |tf|
-          File.open(path, 'rb') do |file|
+          File.open(path, "rb") do |file|
             tf.write(file.read)
           end
         end
@@ -128,7 +128,7 @@ module Omnibus
     # @return [StringIO]
     #
     def gzipped_tarball
-      gz = StringIO.new('')
+      gz = StringIO.new("")
       z = Zlib::GzipWriter.new(gz, compression_level)
       z.write(tarball.string)
       z.close

data/lib/omnibus/config.rb

@@ -14,7 +14,7 @@
 # limitations under the License.
 #
 
-require 'singleton'
+require "singleton"
 
 module Omnibus
   class Config
@@ -100,10 +100,10 @@ module Omnibus
     #
     # @return [String]
     default(:base_dir) do
-      if Ohai['platform'] == 'windows'
-        'C:/omnibus-ruby'
+      if Ohai["platform"] == "windows"
+        "C:/omnibus-ruby"
       else
-        '/var/cache/omnibus'
+        "/var/cache/omnibus"
       end
     end
 
@@ -111,39 +111,39 @@ module Omnibus
     # code will be cached.
     #
     # @return [String]
-    default(:cache_dir) { File.join(base_dir, 'cache') }
+    default(:cache_dir) { File.join(base_dir, "cache") }
 
     # The absolute path to the directory on the virtual machine where
     # git caching will occur and software's will be progressively cached.
     #
     # @return [String]
     default(:git_cache_dir) do
-      File.join(base_dir, 'cache', 'git_cache')
+      File.join(base_dir, "cache", "git_cache")
     end
 
     # The absolute path to the directory on the virtual machine where
     # source code will be downloaded.
     #
     # @return [String]
-    default(:source_dir) { File.join(base_dir, 'src') }
+    default(:source_dir) { File.join(base_dir, "src") }
 
     # The absolute path to the directory on the virtual machine where
     # software will be built.
     #
     # @return [String]
-    default(:build_dir) { File.join(base_dir, 'build') }
+    default(:build_dir) { File.join(base_dir, "build") }
 
     # The absolute path to the directory on the virtual machine where
     # packages will be constructed.
     #
     # @return [String]
-    default(:package_dir) { File.join(base_dir, 'pkg') }
+    default(:package_dir) { File.join(base_dir, "pkg") }
 
     # @deprecated Do not use this method.
     #
     # @return [String]
     default(:package_tmp) do
-      Omnibus.logger.deprecated('Config') do
+      Omnibus.logger.deprecated("Config") do
         "Config.package_tmp. This value is no longer used."
       end
     end
@@ -152,13 +152,13 @@ module Omnibus
     # DSL files.  This is relative to {#project_root}.
     #
     # @return [String]
-    default(:project_dir, 'config/projects')
+    default(:project_dir, "config/projects")
 
     # The relative path of the directory containing {Omnibus::Software}
     # DSL files.  This is relative {#project_root}.
     #
     # @return [String]
-    default(:software_dir, 'config/software')
+    default(:software_dir, "config/software")
 
     # The root directory in which to look for {Omnibus::Project} and
     # {Omnibus::Software} DSL files.
@@ -178,7 +178,7 @@ module Omnibus
     #
     # @return [true, false]
     default(:build_dmg) do
-      Omnibus.logger.deprecated('Config') do
+      Omnibus.logger.deprecated("Config") do
         "Config.build_dmg. This value is no longer part of the " \
         "config and is implied when defining a `compressor' block in the project."
       end
@@ -188,7 +188,7 @@ module Omnibus
     #
     # @return [String]
     default(:dmg_window_bounds) do
-      Omnibus.logger.deprecated('Config') do
+      Omnibus.logger.deprecated("Config") do
         "Config.dmg_window_bounds. This value is no longer part of the " \
         "config and should be defined in the `compressor' block in the project."
       end
@@ -199,7 +199,7 @@ module Omnibus
     #
     # @return [String]
     default(:dmg_pkg_position) do
-      Omnibus.logger.deprecated('Config') do
+      Omnibus.logger.deprecated("Config") do
         "Config.dmg_pkg_position. This value is no longer part of the " \
         "config and should be defined in the `compressor' block in the project."
       end
@@ -209,7 +209,7 @@ module Omnibus
     #
     # @return [true, false]
     default(:sign_pkg) do
-      Omnibus.logger.deprecated('Config') do
+      Omnibus.logger.deprecated("Config") do
         "Config.sign_pkg. This value is no longer part of the config and " \
         "should be defined in the `package' block in the project."
       end
@@ -219,7 +219,7 @@ module Omnibus
     #
     # @return [String]
     default(:signing_identity) do
-      Omnibus.logger.deprecated('Config') do
+      Omnibus.logger.deprecated("Config") do
         "Config.signing_identity. This value is no longer part of the " \
         "config and should be defined in the `package' block in the project."
       end
@@ -237,7 +237,7 @@ module Omnibus
     #
     # @return [true, false]
     default(:sign_rpm) do
-      Omnibus.logger.deprecated('Config') do
+      Omnibus.logger.deprecated("Config") do
         "Config.sign_rpm. This value is no longer part of the config and " \
         "should be defined in the `package' block in the project."
       end
@@ -247,7 +247,7 @@ module Omnibus
     #
     # @return [String]
     default(:rpm_signing_passphrase) do
-      Omnibus.logger.deprecated('Config') do
+      Omnibus.logger.deprecated("Config") do
         "Config.rpm_signing_passphrase. This value is no longer part of the " \
         "config and should be defined in the `package' block in the project."
       end
@@ -294,7 +294,7 @@ module Omnibus
     #
     # @return [String]
     default(:s3_region) do
-      'us-east-1'
+      "us-east-1"
     end
 
     # --------------------------------------------------
@@ -437,7 +437,7 @@ module Omnibus
     #
     # @return [Array<String>]
     default(:software_gems) do
-      ['omnibus-software']
+      ["omnibus-software"]
     end
 
     # Solaris linker mapfile to use, if needed
@@ -446,7 +446,7 @@ module Omnibus
     #
     # For example:
     #
-    #     /PATH/files/my_map_file 
+    #     /PATH/files/my_map_file
     #
     # @return [String, nil]
     default(:solaris_linker_mapfile, "files/mapfiles/solaris")
@@ -460,8 +460,8 @@ module Omnibus
     #
     # @return [:x86, :x64]
     default(:windows_arch) do
-      if Ohai['kernel']['machine'] == 'x86_64'
-        Omnibus.logger.deprecated('Config') do
+      if Ohai["kernel"]["machine"] == "x86_64"
+        Omnibus.logger.deprecated("Config") do
           "windows_arch is defaulting to :x86. In Omnibus 5, it will " \
           "default to :x64 if the machine architecture is x86_64. " \
           "If you would like to continue building 32 bit packages, please "\
@@ -502,13 +502,24 @@ module Omnibus
     #
     # @return [Integer]
     default(:workers) do
-      if Ohai['cpu'] && Ohai['cpu']['total']
-        Ohai['cpu']['total'].to_i + 1
+      if Ohai["cpu"] && Ohai["cpu"]["total"]
+        Ohai["cpu"]["total"].to_i + 1
       else
         3
       end
     end
 
+    # Fail the build or warn when build encounters a licensing warning.
+    #
+    # @return [true, false]
+    default(:fatal_licensing_warnings, false)
+
+    # Fail the build or warn when build encounters a transitive dependency
+    # licensing warning.
+    #
+    # @return [true, false]
+    default(:fatal_transitive_dependency_licensing_warnings, false)
+
     # --------------------------------------------------
     # @!endgroup
     #

data/lib/omnibus/core_extensions/open_uri.rb

@@ -1,4 +1,4 @@
-require 'open-uri'
+require "open-uri"
 
 module OpenURI
   class << self
@@ -13,7 +13,7 @@ module OpenURI
     def default_redirectable?(uri1, uri2)
       a, b = uri1.scheme.downcase, uri2.scheme.downcase
 
-      a == b || (a == 'http' && b == 'https')
+      a == b || (a == "http" && b == "https")
     end
     alias_method :redirectable?, :default_redirectable?
 
@@ -28,7 +28,7 @@ module OpenURI
     def unsafe_redirectable?(uri1, uri2)
       a, b = uri1.scheme.downcase, uri2.scheme.downcase
 
-      a == b || (a == 'http' && b == 'https') || (a == 'https' && b == 'http')
+      a == b || (a == "http" && b == "https") || (a == "https" && b == "http")
     end
 
     #

data/lib/omnibus/core_extensions.rb

@@ -1 +1 @@
-require 'omnibus/core_extensions/open_uri'
+require "omnibus/core_extensions/open_uri"

data/lib/omnibus/digestable.rb

@@ -14,9 +14,9 @@
 # limitations under the License.
 #
 
-require 'openssl'
-require 'pathname'
-require 'omnibus/logging'
+require "openssl"
+require "pathname"
+require "omnibus/logging"
 
 module Omnibus
   module Digestable
@@ -24,6 +24,7 @@ module Omnibus
     def self.included(other)
       other.send(:include, Logging)
     end
+
     #
     # Calculate the digest of the file at the given path. Files are read in
     # binary chunks to prevent Ruby from exploding.
@@ -78,7 +79,7 @@ module Omnibus
         relative = Pathname.new(filename).relative_path_from(Pathname.new(path))
 
         case ftype = File.ftype(filename)
-        when 'file'
+        when "file"
           update_with_string(digest, "#{ftype} #{relative}")
           update_with_file_contents(digest, filename)
         else

data/lib/omnibus/download_helpers.rb

@@ -14,8 +14,8 @@
 # limitations under the License.
 #
 
-require 'open-uri'
-require 'ruby-progressbar'
+require "open-uri"
+require "ruby-progressbar"
 
 module Omnibus
   module DownloadHelpers
@@ -25,6 +25,7 @@ module Omnibus
 
     module InstanceMethods
       private
+
       #
       # Downloads a from a given url to a given path using Ruby's
       # +OpenURI+ implementation.
@@ -62,8 +63,8 @@ module Omnibus
         if enable_progress_bar
           progress_bar = ProgressBar.create(
             output: $stdout,
-            format: '%e %B %p%% (%r KB/sec)',
-            rate_scale: ->(rate) { rate / 1024 },
+            format: "%e %B %p%% (%r KB/sec)",
+            rate_scale: ->(rate) { rate / 1024 }
           )
 
           options[:content_length_proc] = ->(total) {
@@ -71,7 +72,7 @@ module Omnibus
             progress_bar.total = total
           }
           options[:progress_proc] = ->(step) {
-            downloaded_amount = [step, reported_total].min
+            downloaded_amount = reported_total ? [step, reported_total].min : step
             progress_bar.progress = downloaded_amount
           }
         end
@@ -129,7 +130,7 @@ module Omnibus
           #
           # TL;DR - Do not let Ruby ungzip our file
           #
-          h['Accept-Encoding'] = 'identity'
+          h["Accept-Encoding"] = "identity"
         end
       end
     end