omnibus 6.1.9 → 8.0.15

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13c799a70980298bd1b9a949570129950948678e848013b5cc45e9c16163eed4
-  data.tar.gz: f674f27153dd215d6718e988b6d4bc7b8c30e3b3b00e3b89aaffbab1c14a7bdd
+  metadata.gz: 585e2c596ef1c84a2e679f73503cc00480fe5ef7484c35febaa0c3f9591d1cb2
+  data.tar.gz: 0d05d3f29a6d5e596f0e0e27c3077dda52f6f0a263d7481ce1ef3372a2aa07b4
 SHA512:
-  metadata.gz: 7bd5732c6df36ef63dff1bf783117fe40eb49934209e41fe4f5b9f03e64998a3f69e30d86183b4b70d9f9780682a8641bb1bde8c229213be53b69f30d6267259
-  data.tar.gz: 74bbdef1a133d657e75853a0a44ee3eea4dc461bc8fda2a52c5623656e0a289f1c40ba9906da8179686e3998354a088d5e2410dfe6b2519c41f45823613317c6
+  metadata.gz: 337957c5a64cd387614afd55193a739b5e668857f7858c5ef5665f77e7a8dc58709e94c04a6d497ee32502b37045b6089adea9b4f0e4991e0b93fd80218007e5
+  data.tar.gz: 66b99392d12b7a3c5757300b57243e856c7f0c67a132ebc39b4a74df84a03f5a6711903ae88325e8270c9930218147b93d53b3c83e1984ab48875f92a6f367d5

data/Gemfile

@@ -13,7 +13,3 @@ group :debug do
   gem "pry-byebug"
   gem "pry-stack_explorer"
 end
-
-if Gem::Version.new(RUBY_VERSION) < Gem::Version.new("2.5")
-  gem "ohai", "<15"
-end

data/README.md

@@ -16,7 +16,6 @@ Easily create full-stack installers for your project across a variety of platfor
 
 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**:
 
-- [Video](http://www.youtube.com/watch?v=q8iJAntXCNY)
 - [Slides](https://speakerdeck.com/schisamo/eat-the-whole-bowl-building-a-full-stack-installer-with-omnibus)
 
 This project is managed by the CHEF Release Engineering team. For more information on the Release Engineering team's contribution, triage, and release process, please consult the [CHEF Release Engineering OSS Management Guide](https://docs.google.com/a/opscode.com/document/d/1oJB0vZb_3bl7_ZU2YMDBkMFdL-EWplW1BJv_FXTUOzg/edit).
@@ -25,8 +24,7 @@ This project is managed by the CHEF Release Engineering team. For more informati
 
 Omnibus is designed to run with a minimal set of prerequisites. You will need the following:
 
-- Ruby 2.4+
-- Bundler
+- Ruby 2.6+
 
 ## Get Started
 
@@ -46,10 +44,11 @@ $ omnibus new $MY_PROJECT_NAME
 
 This will generate a complete project skeleton in the directory `omnibus-$MY_PROJECT_NAME`
 
+By default this will make a directory called `omnibus-$MY_PROJECT_NAME` assuming you're keeping your omnibus config separate from the repo. However, keeping it *in* your repo is a common practice, so feel to rename this directory to `omnibus` and place it in the top level of your projects source repo.
+
 ```bash
 $ cd omnibus-$MY_PROJECT_NAME
 $ bundle install --binstubs
-$ bin/omnibus build $MY_PROJECT_NAME
 ```
 
 More details can be found in the generated project's README file.
@@ -84,11 +83,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).
@@ -135,7 +142,7 @@ DSL Method        | Description
 `package`         | Invoke a packager-specific DSL
 `compress`        | Invoke a compressor-specific DSL
 
-By default a timestamp is appended to the build_version. You can turn this behavior off by setting `append_timestamp` to `false` in your configuration file or using `--override append_timestamp:false` at the command line.
+By default a timestamp is appended to the build_version. You can turn this behavior off by setting `append_timestamp` to `false` in your `omnibus.rb` or using `--override append_timestamp:false` at the command line.
 
 For more information, please see the [`Project` documentation](http://www.rubydoc.info/github/chef/omnibus/Omnibus/Project).
 
@@ -253,12 +260,46 @@ 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
 ```
 
 The first instance of `foo.rb` that is encountered will be used. Please note that **local** (vendored) softare definitions take precedence!
 
+## Building
+
+Once you've created your package and software definitions you can build with:
+
+```shell
+./bin/omnibus build $MY_PACKAGE_NAME
+```
+
+However there are several caveats to be aware of:
+
+1. You will almost certainly want to uncomment the `base_dir` in `omnibus.rb`,
+or at the very least change `cache_dir` and `build_dir` as otherwise it'll try
+to use `/var/cache/omnibus` and `/opt/$MY_PROJECT_NAME`, requiring root.
+1. The default configuration created for you references a lot of things
+that are in the default config that come from the `omnibus-software` gem.
+So you want to use those you'll need to either uncomment it in the `Gemfile`,
+or fork it, and then reference your own
+1. If this is a ruby project and you want binstubs in `/opt/$project/bin`, you
+will either need to use [appbundler](https://github.com/chef/appbundler), or
+you will need to have a post install step to create those binstubs.
+    - Side note, appbundler requires that you include your Gemfile and gemspec
+      in your gem.
+    - Also, needs to be in your Gemfile for you to use it, as it also must
+      be in the resulting gem.
+1. If you specify an override of the version of the `ruby`, you will also need
+to override `rubygems` and `bundler` to match the versions in that version of
+`ruby` or you'll get failures around bundler version mismatches.
+
+The build command above will of course build on your local host thus being
+specific to the OS and base system you are on. But the skeleten setup by
+`omnibus new` already setup kitchen for you so that it's easy to build for
+a variety of OSes, See the `README.md` in your generated omnibus directory
+for details.
+
 ## Version Manifest
 
 Git-based software definitions may specify branches as their default_version. In this case, the exact git revision to use will be determined at build-time unless a project override (see below) or external version manifest is used. To generate a version manifest use the `omnibus manifest` command:
@@ -273,7 +314,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\..+/
@@ -289,11 +330,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/bin/omnibus

@@ -4,7 +4,7 @@
 # https://twitter.com/mitchellh/status/283014103189053442
 Signal.trap("INT") { exit 1 }
 
-$:.push File.expand_path("../../lib", __FILE__)
+$:.push File.expand_path("../lib", __dir__)
 $stdout.sync = true
 
 require "omnibus/cli"

data/lib/omnibus.rb

@@ -17,7 +17,7 @@
 require "omnibus/core_extensions"
 
 require "cleanroom"
-require "pathname"
+require "pathname" unless defined?(Pathname)
 
 require "omnibus/digestable"
 require "omnibus/exceptions"
@@ -208,7 +208,7 @@ module Omnibus
     # @return [Pathname]
     #
     def source_root
-      @source_root ||= Pathname.new(File.expand_path("../..", __FILE__))
+      @source_root ||= Pathname.new(File.expand_path("..", __dir__))
     end
 
     #

data/lib/omnibus/build_version.rb

@@ -14,7 +14,7 @@
 # limitations under the License.
 #
 
-require "time"
+require "time" unless defined?(Time.zone_offset)
 
 module Omnibus
   # Provides methods for generating Omnibus project build version

data/lib/omnibus/build_version_dsl.rb

@@ -14,7 +14,7 @@
 # limitations under the License.
 #
 
-require "time"
+require "time" unless defined?(Time.zone_offset)
 
 module Omnibus
   class BuildVersionDSL
@@ -136,12 +136,10 @@ module Omnibus
       return false if build_info.nil?
 
       build_info.split(".").any? do |part|
-        begin
-          Time.strptime(part, Omnibus::BuildVersion::TIMESTAMP_FORMAT)
-          true
-        rescue ArgumentError
-          false
-        end
+        Time.strptime(part, Omnibus::BuildVersion::TIMESTAMP_FORMAT)
+        true
+      rescue ArgumentError
+        false
       end
     end
 

data/lib/omnibus/builder.rb

@@ -14,10 +14,10 @@
 # limitations under the License.
 #
 
-require "fileutils"
-require "mixlib/shellout"
-require "ostruct"
-require "pathname"
+require "fileutils" unless defined?(FileUtils)
+require "mixlib/shellout" unless defined?(Mixlib::ShellOut)
+require "ostruct" unless defined?(OpenStruct)
+require "pathname" unless defined?(Pathname)
 require "omnibus/whitelist"
 
 module Omnibus

data/lib/omnibus/cleaner.rb

@@ -14,7 +14,7 @@
 # limitations under the License.
 #
 
-require "thor"
+require "thor" unless defined?(Thor)
 
 module Omnibus
   class Cleaner < Thor::Group

data/lib/omnibus/cli.rb

@@ -14,9 +14,9 @@
 # limitations under the License.
 #
 
-require "thor"
+require "thor" unless defined?(Thor)
 require "omnibus"
-require "ffi_yajl"
+require "ffi_yajl" unless defined?(FFI_Yajl)
 
 module Omnibus
   class CLI < Command::Base

data/lib/omnibus/cli/changelog.rb

@@ -18,7 +18,7 @@ require "omnibus/changelog"
 require "omnibus/changelog_printer"
 require "omnibus/manifest_diff"
 require "omnibus/semantic_version"
-require "ffi_yajl"
+require "ffi_yajl" unless defined?(FFI_Yajl)
 
 module Omnibus
   class Command::ChangeLog < Command::Base

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

@@ -14,7 +14,7 @@
 # limitations under the License.
 #
 
-require "fileutils"
+require "fileutils" unless defined?(FileUtils)
 
 module Omnibus
   class Compressor::Base < Packager::Base
@@ -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

@@ -259,8 +259,11 @@ module Omnibus
           sync
           hdiutil unmount "#{@device}"
           # Give some time to the system so unmount dmg
-          sleep 5
-          hdiutil detach "#{@device}" &&  \
+          ATTEMPTS=1
+          until [ $ATTEMPTS -eq 6 ] || hdiutil detach "#{@device}"; do
+            sleep 10
+            echo Attempt number $(( ATTEMPTS++ ))
+          done
           hdiutil convert \\
             "#{writable_dmg}" \\
             -format UDZO \\

data/lib/omnibus/compressors/tgz.rb

@@ -14,8 +14,8 @@
 # limitations under the License.
 #
 
-require "rubygems/package"
-require "zlib"
+require "rubygems/package" unless defined?(Gem::Package)
+require "zlib" unless defined?(Zlib)
 
 module Omnibus
   class Compressor::TGZ < Compressor::Base

data/lib/omnibus/config.rb

@@ -14,7 +14,7 @@
 # limitations under the License.
 #
 
-require "singleton"
+require "singleton" unless defined?(Singleton)
 
 module Omnibus
   class Config
@@ -285,7 +285,7 @@ module Omnibus
     #
     # @return [String, nil]
     default(:s3_access_key) do
-      if s3_profile
+      if s3_profile || s3_iam_role_arn
         nil
       else
         raise MissingRequiredAttribute.new(self, :s3_access_key, "'ABCD1234'")
@@ -296,7 +296,7 @@ module Omnibus
     #
     # @return [String, nil]
     default(:s3_secret_key) do
-      if s3_profile
+      if s3_profile || s3_iam_role_arn
         nil
       else
         raise MissingRequiredAttribute.new(self, :s3_secret_key, "'EFGH5678'")
@@ -308,6 +308,11 @@ module Omnibus
     # @return [String, nil]
     default(:s3_profile, nil)
 
+    # The AWS IAM role arn to use with S3 caching.
+    #
+    # @return [String, nil]
+    default(:s3_iam_role_arn, nil)
+
     # The region of the S3 bucket you want to cache software artifacts in.
     # Defaults to 'us-east-1'
     #
@@ -455,6 +460,11 @@ module Omnibus
     # @return [String, nil]
     default(:publish_s3_profile, nil)
 
+    # The AWS IAM role arn to use with S3 publisher.
+    #
+    # @return [String, nil]
+    default(:publish_s3_iam_role_arn, nil)
+
     # Directory pattern for the S3 publisher.
     # Interpolation of metadata keys is supported.
     #

data/lib/omnibus/core_extensions/open_uri.rb

@@ -1,4 +1,4 @@
-require "open-uri"
+require "open-uri" unless defined?(OpenURI)
 
 module OpenURI
   class << self

data/lib/omnibus/digestable.rb

@@ -14,8 +14,8 @@
 # limitations under the License.
 #
 
-require "openssl"
-require "pathname"
+require "openssl" unless defined?(OpenSSL)
+require "pathname" unless defined?(Pathname)
 require "omnibus/logging"
 
 module Omnibus

data/lib/omnibus/download_helpers.rb

@@ -14,7 +14,7 @@
 # limitations under the License.
 #
 
-require "open-uri"
+require "open-uri" unless defined?(OpenURI)
 require "ruby-progressbar"
 
 module Omnibus
@@ -77,7 +77,11 @@ module Omnibus
           end
         end
 
-        file = open(from_url, options)
+        if RUBY_VERSION.to_f < 2.7
+          file = open(from_url, options)
+        else
+          file = URI.open(from_url, options)
+        end
         # This is a temporary file. Close and flush it before attempting to copy
         # it over.
         file.close

data/lib/omnibus/fetchers/file_fetcher.rb

@@ -14,7 +14,7 @@
 # limitations under the License.
 #
 
-require "fileutils"
+require "fileutils" unless defined?(FileUtils)
 
 module Omnibus
   class FileFetcher < Fetcher

data/lib/omnibus/fetchers/net_fetcher.rb

@@ -14,7 +14,7 @@
 # limitations under the License.
 #
 
-require "fileutils"
+require "fileutils" unless defined?(FileUtils)
 require "omnibus/download_helpers"
 
 module Omnibus

data/lib/omnibus/fetchers/path_fetcher.rb

@@ -14,7 +14,7 @@
 # limitations under the License.
 #
 
-require "fileutils"
+require "fileutils" unless defined?(FileUtils)
 
 module Omnibus
   class PathFetcher < Fetcher