omnibus 6.0.25 → 7.0.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e008e08071c850bbd9e8021ce0eb22eb8415aaba92060de5380b399de8841fe
-  data.tar.gz: 0260e33da4bf4a91ad49e96d8e3c0f08f9f233b8e4eb58b40208c9e8e126b34b
+  metadata.gz: 426773f2a6ca96d0f7b36b5df60e01fb17b52bf747c2a19b040499e03737b20e
+  data.tar.gz: 8045d8e96683fafa5fcc1357d83701515ebbcd160d16743e1903c5fcb964284c
 SHA512:
-  metadata.gz: d8b30760147a6adf9919e3fce9e34c21d7b5045f6a646f02b4c3ad7f0e35f71ee8589697618088d938e701ead1336c4f93c02a96649ad8133d5d489b098d9ca9
-  data.tar.gz: 1a72c335607d61739ca95d8954f5b745fa990329e1cc3459460c479273d1345c8ca1c70197f1fd8ae4b5c361163108ebf1dabef69317a050d5f7b6ebe7a67664
+  metadata.gz: 427f1194c4141ff9ebd69a7bce99c2fb2f136a836e2fa3b99c842b3ae6d271698113027cf29ea25f7ac8a38a81b6448dd44a29faf2895e69f16ec537c0d789de
+  data.tar.gz: 7ae973fddc3895fc2bad09fa17316e5bc58aefb7cfa19efb4630fb44dd6a0d1e479715bde34b4d3195b560f704f5d1f47fe8543efe140913694e9723b20cd187

data/Gemfile

@@ -11,8 +11,9 @@ end
 group :debug do
   gem "pry"
   gem "pry-byebug"
-  gem "pry-stack_explorer"
+  gem "pry-stack_explorer", "~> 0.4.0" # 0.4 allows us to still test Ruby 2.5
 end
 
-# this brings in several fixes to rspec-json_expectations that are causing test failures
-gem "rspec-json_expectations", git: "https://github.com/tas50/rspec-json_expectations.git"
+if Gem::Version.new(RUBY_VERSION) < Gem::Version.new("2.5")
+  gem "ohai", "<15"
+end

data/README.md

@@ -1,9 +1,17 @@
 # ![Omnibus Icon](lib/omnibus/assets/README-logo.png) Omnibus
 
 [![Gem Version](http://img.shields.io/gem/v/omnibus.svg)][gem]
-[![Travis Build Status](http://img.shields.io/travis/chef/omnibus.svg?label=Travis%20CI)][travis]
+[![Build Status](https://badge.buildkite.com/446fd6049a9a5eeab50112aba117d3b7670ec085acb91f78dd.svg?branch=master)](https://buildkite.com/chef-oss/chef-omnibus-master-verify)
 [![AppVeyor Build Status](http://img.shields.io/appveyor/ci/chef/omnibus.svg?label=AppVeyor)][appveyor]
 
+**Umbrella Project**: [Chef Foundation](https://github.com/chef/chef-oss-practices/blob/master/projects/chef-foundation.md)
+
+**Project State**: [Active](https://github.com/chef/chef-oss-practices/blob/master/repo-management/repo-states.md#active)
+
+**Issues [Response Time Maximum](https://github.com/chef/chef-oss-practices/blob/master/repo-management/repo-states.md)**: 14 days
+
+**Pull Request [Response Time Maximum](https://github.com/chef/chef-oss-practices/blob/master/repo-management/repo-states.md)**: 14 days
+
 Easily create full-stack installers for your project across a variety of platforms.
 
 Seth Chisamore and Christopher Maier of CHEF gave an introductory talk on Omnibus at ChefConf 2013, entitled **Eat the Whole Bowl: Building a Full-Stack Installer with Omnibus**:
@@ -76,11 +84,19 @@ use_git_caching false
 # Enable S3 asset caching
 # ------------------------------
 use_s3_caching true
+s3_bucket      ENV['S3_BUCKET']
+
+# There are three ways to authenticate to the S3 bucket
+
+# 1. set `s3_access_key` and `s3_secret_key`
 s3_access_key  ENV['S3_ACCESS_KEY']
 s3_secret_key  ENV['S3_SECRET_KEY']
-# You can use the Shared Credentials files in place of the s3_access_key and s3_secret_key.
+
+# 2. set `s3_profile` to use an AWS profile in the Shared Credentials files
 #s3_profile    ENV['S3_PROFILE']
-s3_bucket      ENV['S3_BUCKET']
+
+# 3. set `s3_iam_role_arn` to use an AWS IAM role
+#s3_iam_role_arn    ENV['S3_IAM_ROLE_ARN']
 ```
 
 For more information, please see the [`Config` documentation](http://www.rubydoc.info/github/chef/omnibus/Omnibus/Config).
@@ -245,7 +261,7 @@ For all of these paths, **order matters**, so it is possible to depend on local
 $PWD/config/software/foo.rb
 /path/to/software/config/software/foo.rb
 /other/path/to/software/config/software/foo.rb
-/Users/sethvargo/.gems/.../my-comany-omnibus-software/config/software/foo.rb
+/Users/sethvargo/.gems/.../my-company-omnibus-software/config/software/foo.rb
 /Users/sethvargo/.gems/.../omnibus-software/config/software/foo.rb
 ```
 
@@ -265,7 +281,7 @@ This will output a JSON-formatted manifest containing the resolved version of ev
 
 Sometimes a platform has libraries that need to be whitelisted so the healthcheck can pass. The whitelist found in the [healthcheck](https://github.com/chef/omnibus/blob/master/lib/omnibus/health_check.rb) code comprises the minimal required for successful builds on supported platforms.
 
-To add your own whitelisted library, simply add the a regex to your software definition in your omnibus project as follows:
+To add your own whitelisted library, simply add a regex to your software definition in your omnibus project as follows:
 
 ```
 whitelist_file /libpcrecpp\.so\..+/
@@ -281,11 +297,11 @@ STATUS: _EXPERIMENTAL_
 
 `omnibus changelog generate` will generate a changelog for an omnibus project. This command currently assumes:
 
-- version-manifest.json is checked into the project root
-- the project is a git repository
-- each version is tagged with a SemVer compliant annotated tag
+- A version-manifest.json file is checked into the project root
+- The project is a git repository
+- Each version is tagged with a SemVer compliant annotated tag
 - Any git-based sources are checked out at ../COMPONENT_NAME
-- Any commit message line prepended with ChangeLog-Entry: should be added to the changelog.
+- Any commit message line prepended with ChangeLog-Entry: should be added to the changelog
 
 These assumptions _will_ change as we determine what works best for a number of our projects.
 

data/Rakefile

@@ -1,7 +1,7 @@
 require "bundler/gem_tasks"
 
 require "rspec/core/rake_task"
-[:unit, :functional].each do |type|
+%i{unit functional}.each do |type|
   RSpec::Core::RakeTask.new(type) do |t|
     t.pattern = "spec/#{type}/**/*_spec.rb"
     t.rspec_opts = [].tap do |a|

data/lib/omnibus/build_version_dsl.rb

@@ -134,6 +134,7 @@ module Omnibus
     def has_timestamp?(version)
       _ver, build_info = version.split("+")
       return false if build_info.nil?
+
       build_info.split(".").any? do |part|
         begin
           Time.strptime(part, Omnibus::BuildVersion::TIMESTAMP_FORMAT)

data/lib/omnibus/builder.rb

@@ -1,5 +1,5 @@
 #
-# Copyright 2012-2018, Chef Software Inc.
+# Copyright 2012-2019, Chef Software Inc.
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
 # you may not use this file except in compliance with the License.
@@ -235,7 +235,8 @@ module Omnibus
       clean_patch_path = patch_path
       if windows?
         clean_patch_path = Pathname.new(patch_path).relative_path_from(
-          Pathname.new(software.project_dir)).to_s
+          Pathname.new(software.project_dir)
+        ).to_s
       end
 
       if target
@@ -372,7 +373,7 @@ module Omnibus
     # @param (see #command)
     # @return (see #command)
     #
-    def appbundle(software_name, lockdir: nil, gem: nil, without: nil, **options)
+    def appbundle(software_name, lockdir: nil, gem: nil, without: nil, extra_bin_files: nil , **options)
       build_commands << BuildCommand.new("appbundle `#{software_name}'") do
         bin_dir            = "#{install_dir}/bin"
         appbundler_bin     = embedded_bin("appbundler")
@@ -385,6 +386,7 @@ module Omnibus
             if app_software.nil?
               raise "could not find software definition for #{software_name}, add a dependency to it, or pass a lockdir argument to appbundle command."
             end
+
             app_software.project_dir
           end
 
@@ -400,6 +402,8 @@ module Omnibus
         # get `--without` support, you will likely wind up going down a sad path).
         command << [ "--without", without.join(",") ] unless without.nil?
 
+        command << [ "--extra-bin-files", extra_bin_files.join(",") ] unless extra_bin_files.nil? || extra_bin_files.empty?
+
         # Ensure the main bin dir exists
         FileUtils.mkdir_p(bin_dir)
 
@@ -498,8 +502,7 @@ module Omnibus
         render_template(source_path,
           destination: dest,
           mode:        mode,
-          variables:   vars
-        )
+          variables:   vars)
       end
     end
     expose :erb
@@ -594,7 +597,7 @@ module Omnibus
     #
     def strip(path)
       regexp_ends = ".*(" + IGNORED_ENDINGS.map { |e| e.gsub(/\./, '\.') }.join("|") + ")$"
-      regexp_patterns = IGNORED_PATTERNS.map { |e| ".*" + e.gsub(/\//, '\/') + ".*" }.join("|")
+      regexp_patterns = IGNORED_PATTERNS.map { |e| ".*" + e.gsub(%r{/}, '\/') + ".*" }.join("|")
       regexp = regexp_ends + "|" + regexp_patterns
 
       # Do not actually care if strip runs on non-strippable file, as its a no-op.  Hence the `|| true` appended.
@@ -725,7 +728,7 @@ module Omnibus
     #       config.guess.to. Default: "."
     #     install [Array<Symbol>] parts of config.guess to copy.
     #       Default: [:config_guess, :config_sub]
-    def update_config_guess(target: ".", install: [:config_guess, :config_sub])
+    def update_config_guess(target: ".", install: %i{config_guess config_sub})
       build_commands << BuildCommand.new("update_config_guess `target: #{target} install: #{install.inspect}'") do
         config_guess_dir = "#{install_dir}/embedded/lib/config_guess"
         %w{config.guess config.sub}.each do |c|

data/lib/omnibus/changelog_printer.rb

@@ -8,9 +8,9 @@ module Omnibus
     end
 
     def print(new_version)
-      puts "## #{new_version} (#{Time.now.strftime('%Y-%m-%d')})"
+      puts "## #{new_version} (#{Time.now.strftime("%Y-%m-%d")})"
       print_changelog
-      if !diff.empty?
+      unless diff.empty?
         print_components
         puts ""
       end
@@ -23,7 +23,7 @@ module Omnibus
 
     def print_changelog(cl = changelog, indent = 0)
       cl.changelog_entries.each do |entry|
-        puts "#{' ' * indent}* #{entry.sub("\n", "\n  #{' ' * indent}")}\n"
+        puts "#{" " * indent}* #{entry.sub("\n", "\n  #{" " * indent}")}\n"
       end
     end
 
@@ -36,6 +36,7 @@ module Omnibus
 
     def print_new_components
       return if diff.added.empty?
+
       puts "New Components"
       diff.added.each do |entry|
         puts "* #{entry[:name]} (#{entry[:new_version]})"
@@ -45,10 +46,11 @@ module Omnibus
 
     def print_updated_components
       return if diff.updated.empty?
+
       puts "Updated Components"
       diff.updated.each do |entry|
         puts sprintf("* %s (%.8s -> %.8s)",
-                     entry[:name], entry[:old_version], entry[:new_version])
+          entry[:name], entry[:old_version], entry[:new_version])
         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}"))
@@ -60,6 +62,7 @@ module Omnibus
 
     def print_removed_components
       return if diff.removed.empty?
+
       puts "Removed Components"
       diff.removed.each do |entry|
         puts "* #{entry[:name]} (#{entry[:old_version]})"

data/lib/omnibus/cleaner.rb

@@ -48,16 +48,19 @@ module Omnibus
 
     def clean_package_dir
       return unless purge?
+
       FileSyncer.glob("#{Config.package_dir}/**/*").each(&method(:remove_file))
     end
 
     def clean_cache_dir
       return unless purge?
+
       FileSyncer.glob("#{Config.cache_dir}/**/*").each(&method(:remove_file))
     end
 
     def clean_install_dir
       return unless purge?
+
       remove_file(@project.install_dir)
     end
 

data/lib/omnibus/cli.rb

@@ -91,7 +91,7 @@ module Omnibus
       if @options[:output_manifest]
         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))
+          f.write(FFI_Yajl::Encoder.encode(project.built_manifest.to_hash, pretty: true))
         end
       end
     end

data/lib/omnibus/cli/changelog.rb

@@ -30,42 +30,42 @@ module Omnibus
     #   $ omnibus changelog generate
     #
     method_option :source_path,
-    desc: "Path to local checkout of git dependencies",
-    type: :string,
-    default: "../"
+      desc: "Path to local checkout of git dependencies",
+      type: :string,
+      default: "../"
 
     method_option :starting_manifest,
-    desc: "Path to version-manifest from the last version (we attempt to pull it from the git history if not given)",
-    type: :string
+      desc: "Path to version-manifest from the last version (we attempt to pull it from the git history if not given)",
+      type: :string
 
     method_option :ending_manifest,
-    desc: "Path to the version-manifest from the current version",
-    type: :string,
-    default: "version-manifest.json"
+      desc: "Path to the version-manifest from the current version",
+      type: :string,
+      default: "version-manifest.json"
 
     method_option :skip_components,
-    desc: "Don't include component changes in the changelog",
-    type: :boolean,
-    default: false
+      desc: "Don't include component changes in the changelog",
+      type: :boolean,
+      default: false
 
     method_option :major,
-    desc: "Bump the major version",
-    type: :boolean,
-    default: false
+      desc: "Bump the major version",
+      type: :boolean,
+      default: false
 
     method_option :minor,
-    desc: "Bump the minor version",
-    type: :boolean,
-    default: true
+      desc: "Bump the minor version",
+      type: :boolean,
+      default: true
 
     method_option :patch,
-    desc: "Bump the patch version",
-    type: :boolean,
-    default: false
+      desc: "Bump the patch version",
+      type: :boolean,
+      default: false
 
     method_option :version,
-    desc: "Explicit version for this changelog",
-    type: :string
+      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)
@@ -78,8 +78,8 @@ module Omnibus
              end
 
       Omnibus::ChangeLogPrinter.new(ChangeLog.new(starting_revision, ending_revision),
-                                    diff,
-                                    @options[:source_path]).print(new_version)
+        diff,
+        @options[:source_path]).print(new_version)
     end
 
     private

data/lib/omnibus/cli/publish.rb

@@ -26,10 +26,10 @@ module Omnibus
     #
     # @example JSON
     #   {
-    #     "ubuntu-10.04": [
-    #       "ubuntu-10.04",
-    #       "ubuntu-12.04",
-    #       "ubuntu-14.04"
+    #     "ubuntu-10.04-x86_64": [
+    #       "ubuntu-10.04-x86_64",
+    #       "ubuntu-12.04-x86_64",
+    #       "ubuntu-14.04-x86_64"
     #     ]
     #   }
     #
@@ -99,7 +99,7 @@ module Omnibus
       end
 
       klass.publish(pattern, options) do |package|
-        say("Published '#{package.name}' for #{package.metadata[:platform]}-#{package.metadata[:platform_version]}", :green)
+        say("Published '#{package.name}' for #{package.metadata[:platform]}-#{package.metadata[:platform_version]}-#{package.metadata[:arch]}", :green)
       end
     end
   end

data/lib/omnibus/compressor.rb

@@ -49,10 +49,10 @@ module Omnibus
       end
 
       if compressors.include?(:tgz)
-        return TGZ
+        TGZ
       else
         log.info(log_key) { "No compressor defined for `#{family}'." }
-        return Null
+        Null
       end
     end
     module_function :for_current_system

data/lib/omnibus/compressors/base.rb

@@ -30,7 +30,7 @@ module Omnibus
     # @param [Project] project
     #
     def initialize(project)
-      @project  = project
+      @project = project
 
       # There can now be multiple packagers per platform
       # but windows is the only platform that uses multiple

data/lib/omnibus/compressors/dmg.rb

@@ -43,6 +43,8 @@ module Omnibus
       prettify_dmg
       compress_dmg
       set_dmg_icon
+      verify_dmg
+      remove_writable_dmg
     end
 
     #
@@ -143,7 +145,8 @@ module Omnibus
           -fs HFS+ \\
           -fsargs "-c c=64,a=16,e=16" \\
           -size 512000k \\
-          "#{writable_dmg}"
+          "#{writable_dmg}" \\
+          -puppetstrings
       EOH
     end
 
@@ -159,6 +162,7 @@ module Omnibus
 
         cmd = shellout! <<-EOH.gsub(/^ {10}/, "")
           hdiutil attach \\
+            -puppetstrings \\
             -readwrite \\
             -noverify \\
             -noautoopen \\
@@ -230,8 +234,7 @@ module Omnibus
           pkg_name: packager.package_name,
           window_bounds: window_bounds,
           pkg_position: pkg_position,
-        }
-      )
+        })
 
       Dir.chdir(staging_dir) do
         shellout! <<-EOH.gsub(/^ {10}/, "")
@@ -254,13 +257,48 @@ module Omnibus
         shellout! <<-EOH.gsub(/^ {10}/, "")
           chmod -Rf go-w "/Volumes/#{volume_name}"
           sync
-          hdiutil detach "#{@device}"
+          hdiutil unmount "#{@device}"
+          # Give some time to the system so unmount dmg
+          sleep 5
+          hdiutil detach "#{@device}" &&  \
           hdiutil convert \\
             "#{writable_dmg}" \\
             -format UDZO \\
             -imagekey \\
             zlib-level=9 \\
-            -o "#{package_path}"
+            -o "#{package_path}" \\
+            -puppetstrings
+        EOH
+      end
+    end
+
+    #
+    # Verify checksum on created dmg.
+    #
+    # @return [void]
+    #
+    def verify_dmg
+      log.info(log_key) { "Verifying dmg" }
+
+      Dir.chdir(staging_dir) do
+        shellout! <<-EOH.gsub(/^ {10}/, "")
+          hdiutil verify \\
+            "#{package_path}" \\
+            -puppetstrings
+        EOH
+      end
+    end
+
+    #
+    # Remove writable dmg.
+    #
+    # @return [void]
+    #
+    def remove_writable_dmg
+      log.info(log_key) { "Removing writable dmg" }
+
+      Dir.chdir(staging_dir) do
+        shellout! <<-EOH.gsub(/^ {10}/, "")
           rm -rf "#{writable_dmg}"
         EOH
       end
@@ -277,10 +315,10 @@ module Omnibus
       Dir.chdir(staging_dir) do
         shellout! <<-EOH.gsub(/^ {10}/, "")
           # Convert the png to an icon
-          sips -i "#{resource_path('icon.png')}"
+          sips -i "#{resource_path("icon.png")}"
 
           # Extract the icon into its own resource
-          DeRez -only icns "#{resource_path('icon.png')}" > tmp.rsrc
+          DeRez -only icns "#{resource_path("icon.png")}" > tmp.rsrc
 
           # Append the icon reosurce to the DMG
           Rez -append tmp.rsrc -o "#{package_path}"