omnibus 6.1.7 → 8.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d4a888a9f24e116ea9364773eebf3c9711652623d1000822c0c8f04287cce310
-  data.tar.gz: bdea1d386922a7c85654c318fba2746667fe63025d55f491e95d520efab04ee5
+  metadata.gz: 2d82119c178b28f06df2bcd81c54b97ffbbe8b16b072021e3c86297e7ba76b9c
+  data.tar.gz: 0fd1477fe37432ec09256c115243b1a06eaa62911b741ba8a2dec730b9b8e42b
 SHA512:
-  metadata.gz: b18ba881c3f75e78829b1b112e7a8679d4be330daf7b707a8ac39058d25c65dc55c9d009159edd8a70500c35617e49c4ea3a1713865f213a139dc35fe14c8da9
-  data.tar.gz: 6f3f9ac8e6ef23fb3a10a093a9ca30367b115f9296bfaee37c9af2d3740a37a5d650cc2e4c464bebcaf32bd2db49eacd57dd1df9c303c57449247dc598725877
+  metadata.gz: 534731ae9d91c9b9108cb63e6bacf731817ae8e01a80d22615e93787e50ba148c4e7919934879c2b7bdf1bda51586cbe488648dc3c6c31b9d3684f489602fd02
+  data.tar.gz: 37bbc008548ed0ab0a1d20f958a81a19de17c47da4176ca263587cf11bfb6bffc31c50691d76ea9304e2c22223becfa1afa79de6682e32f8fe9f07d63e8ddd6e

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

@@ -25,8 +25,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 +45,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 +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).
@@ -135,7 +143,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 +261,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 +315,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 +331,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/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
@@ -134,13 +134,12 @@ 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)
-          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
@@ -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
@@ -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
 
@@ -500,8 +502,7 @@ module Omnibus
         render_template(source_path,
           destination: dest,
           mode:        mode,
-          variables:   vars
-        )
+          variables:   vars)
       end
     end
     expose :erb
@@ -596,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.
@@ -727,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

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

@@ -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
@@ -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