omnibus 6.0.25 → 7.0.12

data/lib/omnibus/config.rb

@@ -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/fetchers/git_fetcher.rb

@@ -276,6 +276,7 @@ module Omnibus
       unless commit_ref
         raise UnresolvableGitReference.new(ref)
       end
+
       commit_ref
     end
 

data/lib/omnibus/fetchers/net_fetcher.rb

@@ -31,7 +31,7 @@ module Omnibus
     ALL_EXTENSIONS = WIN_7Z_EXTENSIONS + TAR_EXTENSIONS
 
     # Digest types used for verifying file checksums
-    DIGESTS = [:sha512, :sha256, :sha1, :md5].freeze
+    DIGESTS = %i{sha512 sha256 sha1 md5}.freeze
 
     #
     # A fetch is required if the downloaded_file (such as a tarball) does not
@@ -314,8 +314,7 @@ module Omnibus
     #
     # @return [[String]]
     #
-    def extract_command
-    end
+    def extract_command; end
 
     #
     # Primitively determine whether we should use gtar or tar to untar a file.

data/lib/omnibus/file_syncer.rb

@@ -56,13 +56,13 @@ module Omnibus
     #
     def all_files_under(source, options = {})
       excludes = Array(options[:exclude]).map do |exclude|
-        [exclude, "#{exclude}/*"]
+        [exclude, "#{exclude}/**"]
       end.flatten
 
       source_files = glob(File.join(source, "**/*"))
       source_files = source_files.reject do |source_file|
         basename = relative_path_for(source_file, source)
-        excludes.any? { |exclude| File.fnmatch?(exclude, basename, File::FNM_DOTMATCH) }
+        excludes.any? { |exclude| File.fnmatch?(exclude, basename, File::FNM_DOTMATCH | File::FNM_PATHNAME) }
       end
     end
 

data/lib/omnibus/generator.rb

@@ -90,6 +90,7 @@ module Omnibus
 
     def create_example_software_definitions
       template("config/software/zlib.rb.erb", "#{target}/config/software/#{name}-zlib.rb", template_options)
+      template("config/software/preparation.rb.erb", "#{target}/config/software/preparation.rb", template_options)
     end
 
     def create_kitchen_files

data/lib/omnibus/generator_files/Gemfile.erb

@@ -16,6 +16,6 @@ group :development do
   gem 'berkshelf'
 
   # Use Test Kitchen with Vagrant for converging the build environment
-  gem 'test-kitchen',
-  gem 'kitchen-vagrant',
+  gem 'test-kitchen'
+  gem 'kitchen-vagrant'
 end

data/lib/omnibus/generator_files/README.md.erb

@@ -47,8 +47,8 @@ $ bin/omnibus clean <%= config[:name] %> --purge
 ### Publish
 
 Omnibus has a built-in mechanism for releasing to a variety of "backends", such
-as Amazon S3. You must set the proper credentials in your `omnibus.rb` config
-file or specify them via the command line.
+as Amazon S3. You must set the proper credentials in your
+[`omnibus.rb`](omnibus.rb) config file or specify them via the command line.
 
 ```shell
 $ bin/omnibus publish path/to/*.deb --backend s3
@@ -82,37 +82,40 @@ version of every software definition.
 
 Kitchen-based Build Environment
 -------------------------------
-Every Omnibus project ships will a project-specific
-[Berksfile](https://docs.chef.io/berkshelf.html) that will allow you to build your omnibus projects on all of the projects listed
-in the `.kitchen.yml`. You can add/remove additional platforms as needed by
-changing the list found in the `.kitchen.yml` `platforms` YAML stanza.
+Every Omnibus project ships with a project-specific
+[Berksfile](https://docs.chef.io/berkshelf.html) that will allow you to build
+your omnibus projects on all of the platforms listed in the
+[`.kitchen.yml`](.kitchen.yml). You can add/remove additional platforms as
+needed by changing the list found in the [`.kitchen.yml`](.kitchen.yml)
+`platforms` YAML stanza.
 
 This build environment is designed to get you up-and-running quickly. However,
-there is nothing that restricts you to building on other platforms. Simply use
-the [omnibus cookbook](https://github.com/chef-cookbooks/omnibus) to setup
-your desired platform and execute the build steps listed above.
+there is nothing that restricts you from building on other platforms. Simply use
+the [omnibus cookbook](https://github.com/chef-cookbooks/omnibus) to setup your
+desired platform and execute the build steps listed above.
 
 The default build environment requires Test Kitchen and VirtualBox for local
 development. Test Kitchen also exposes the ability to provision instances using
 various cloud providers like AWS, DigitalOcean, or OpenStack. For more
 information, please see the [Test Kitchen documentation](https://kitchen.ci/).
 
-Once you have tweaked your `.kitchen.yml` (or `.kitchen.local.yml`) to your
-liking, you can bring up an individual build environment using the `kitchen`
-command.
+Once you have tweaked your [`.kitchen.yml`](.kitchen.yml) (or
+[`.kitchen.local.yml`](.kitchen.local.yml)) to your liking, you can bring up an
+individual build environment using the `kitchen` command.
+
 
 ```shell
-$ bin/kitchen converge ubuntu-1204
+$ bin/kitchen converge ubuntu-1804
 ```
 
 Then login to the instance and build the project as described in the Usage
 section:
 
 ```shell
-$ bundle exec kitchen login ubuntu-1204
+$ bin/kitchen login ubuntu-1804
+[vagrant@ubuntu...] $ .  load-omnibus-toolchain.sh
 [vagrant@ubuntu...] $ cd <%= config[:name] %>
 [vagrant@ubuntu...] $ bundle install
-[vagrant@ubuntu...] $ ...
 [vagrant@ubuntu...] $ bin/omnibus build <%= config[:name] %>
 ```
 

data/lib/omnibus/generator_files/config/projects/project.rb.erb

@@ -21,8 +21,5 @@ dependency "preparation"
 # <%= config[:name] %> dependencies/components
 # dependency "somedep"
 
-# Version manifest file
-dependency "version-manifest"
-
 exclude "**/.git"
 exclude "**/bundler/git"

data/lib/omnibus/generator_files/config/software/preparation.rb.erb

@@ -0,0 +1,30 @@
+#
+# Copyright <%= Time.now.year %> YOUR NAME
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+
+name "preparation"
+description "the steps required to prepare the build"
+default_version "1.0.0"
+
+license :project_license
+skip_transitive_dependency_licensing true
+
+build do
+  block do
+    touch "#{install_dir}/embedded/lib/.gitkeep"
+    touch "#{install_dir}/embedded/bin/.gitkeep"
+    touch "#{install_dir}/bin/.gitkeep"
+  end
+end

data/lib/omnibus/generator_files/omnibus.rb.erb

@@ -31,10 +31,11 @@
 # Enable S3 asset caching
 # ------------------------------
 # use_s3_caching true
-# s3_access_key  ENV['AWS_ACCESS_KEY_ID']
-# s3_secret_key  ENV['AWS_SECRET_ACCESS_KEY']
-# s3_profile     ENV['AWS_S3_PROFILE']
-# s3_bucket      ENV['AWS_S3_BUCKET']
+# s3_access_key    ENV['AWS_ACCESS_KEY_ID']
+# s3_secret_key    ENV['AWS_SECRET_ACCESS_KEY']
+# s3_profile       ENV['AWS_S3_PROFILE']
+# s3_iam_role_arn  ENV['S3_IAM_ROLE_ARN']
+# s3_bucket        ENV['AWS_S3_BUCKET']
 
 # Customize compiler bits
 # ------------------------------

data/lib/omnibus/health_check.rb

@@ -331,7 +331,7 @@ module Omnibus
     #
     def health_check_ldd
       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
 
       current_library = nil

data/lib/omnibus/licensing.rb

@@ -130,8 +130,7 @@ module Omnibus
     #
     # @return [void]
     #
-    def execute_pre_build(software)
-    end
+    def execute_pre_build(software); end
 
     # Callback that gets called by Software#build_me after the build is done.
     # Invokes license copying for the given software. This ensures that
@@ -246,7 +245,7 @@ module Omnibus
 
         out << "This product bundles #{name} #{version},\n"
         out << "which is available under a \"#{license}\" License.\n"
-        if !license_files.empty?
+        unless license_files.empty?
           out << "For details, see:\n"
           license_files.each do |license_file|
             out << "#{license_package_location(name, license_file)}\n"
@@ -440,7 +439,7 @@ module Omnibus
 
       if Config.fatal_transitive_dependency_licensing_warnings && !transitive_dependency_licensing_warnings.empty?
         warnings_to_raise << transitive_dependency_licensing_warnings
-        warnings_to_raise << "If you are encountering missing license or missing license file errors for **transitive** dependencies, you can provide overrides for the missing information at https://github.com/chef/license_scout/blob/master/lib/license_scout/overrides.rb#L93"
+        warnings_to_raise << "If you are encountering missing license or missing license file errors for **transitive** dependencies, you can provide overrides for the missing information at https://github.com/chef/license_scout/blob/1-stable/lib/license_scout/overrides.rb#L93. \n Promote license_scout to Rubygems with `/expeditor promote chef/license_scout:1-stable X.Y.Z` in slack."
       end
 
       warnings_to_raise.flatten!

data/lib/omnibus/logger.rb

@@ -102,6 +102,7 @@ module Omnibus
     #
     def add(severity, progname, &block)
       return true if io.nil? || severity < level
+
       message = format_message(severity, progname, yield)
       MUTEX.synchronize { io.write(message) }
       true
@@ -138,7 +139,7 @@ module Omnibus
       else
         left = "#{format_severity(severity)} | "
       end
-      "#{left.rjust(LEFT)}#{Time.now.iso8601()} | #{message}\n"
+      "#{left.rjust(LEFT)}#{Time.now.iso8601} | #{message}\n"
     end
 
     #

data/lib/omnibus/manifest.rb

@@ -44,7 +44,7 @@ module Omnibus
     end
 
     def add(name, entry)
-      if ! entry.is_a? Omnibus::ManifestEntry
+      unless entry.is_a? Omnibus::ManifestEntry
         raise NotAManifestEntry, "#{entry} is not an Omnibus:ManifestEntry"
       end
 

data/lib/omnibus/metadata.rb

@@ -83,7 +83,7 @@ module Omnibus
         data = File.read(path_for(package))
         hash = FFI_Yajl::Parser.parse(data, symbolize_names: true)
 
-         # Ensure Platform version has been truncated
+        # Ensure Platform version has been truncated
         if hash[:platform_version] && hash[:platform]
           hash[:platform_version] = truncate_platform_version(hash[:platform_version], hash[:platform])
         end
@@ -176,7 +176,7 @@ module Omnibus
         when "aix", "alpine", "mac_os_x", "openbsd", "slackware", "solaris2", "opensuse", "opensuseleap", "ubuntu", "amazon"
           # Only want MAJOR.MINOR (e.g. Mac OS X 10.9, Ubuntu 12.04)
           platform_version.split(".")[0..1].join(".")
-        when "arch", "gentoo"
+        when "arch", "gentoo", "kali"
           # Arch Linux / Gentoo do not have a platform_version ohai attribute, they are rolling release (lsb_release -r)
           "rolling"
         when "windows"

data/lib/omnibus/packagers/appx.rb

@@ -69,8 +69,7 @@ module Omnibus
           version: windows_package_version,
           maintainer: project.maintainer,
           certificate_subject: certificate_subject.gsub('"', """),
-        }
-      )
+        })
     end
 
     #

data/lib/omnibus/packagers/base.rb

@@ -142,6 +142,7 @@ module Omnibus
       unless val.is_a?(TrueClass) || val.is_a?(FalseClass)
         raise InvalidValue.new(:skip_packager, "be TrueClass or FalseClass")
       end
+
       @skip_package ||= val
     end
     expose :skip_packager

data/lib/omnibus/packagers/bff.rb

@@ -153,12 +153,11 @@ module Omnibus
               destination: "#{scripts_staging_dir}/config",
               variables: {
                 name: project.name,
-              }
-            )
+              })
           end
 
           File.open(File.join(scripts_staging_dir, "config"), "a") do |file|
-            file.puts "mv '#{alt.gsub(/^#{staging_dir}/, '')}' '#{path.gsub(/^#{staging_dir}/, '')}'"
+            file.puts "mv '#{alt.gsub(/^#{staging_dir}/, "")}' '#{path.gsub(/^#{staging_dir}/, "")}'"
           end
 
           path = alt
@@ -189,8 +188,7 @@ module Omnibus
           description: project.description,
           files: files,
           scripts: scripts,
-        }
-      )
+        })
 
       # Print the full contents of the rendered template file for mkinstallp's use
       log.debug(log_key) { "Rendered Template:\n" + File.read(File.join(staging_dir, "gen.template")) }
@@ -214,19 +212,19 @@ module Omnibus
       # we will chown from 'project' on, rather than 'project/dir', which leaves
       # project owned by the build user (which is incorrect)
       # First - let's find out who we are.
-      shellout!("sudo chown -Rh 0:0 #{File.join(staging_dir, project.install_dir.match(/^\/?(\w+)/).to_s)}")
+      shellout!("sudo chown -Rh 0:0 #{File.join(staging_dir, project.install_dir.match(%r{^/?(\w+)}).to_s)}")
       log.info(log_key) { "Creating .bff file" }
 
       # Since we want the owner to be root, we need to sudo the mkinstallp
       # command, otherwise it will not have access to the previously chowned
       # directory.
-      shellout!("sudo /usr/sbin/mkinstallp -d #{staging_dir} -T #{File.join(staging_dir, 'gen.template')}")
+      shellout!("sudo /usr/sbin/mkinstallp -d #{staging_dir} -T #{File.join(staging_dir, "gen.template")}")
 
       # Print the full contents of the inventory file generated by mkinstallp
       # from within the staging_dir's .info folder (where control files for the
       # packaging process are kept.)
       log.debug(log_key) do
-        "With .inventory file of:\n" + File.read("#{File.join( staging_dir, '.info', "#{safe_base_package_name}.inventory" )}")
+        "With .inventory file of:\n" + File.read("#{File.join( staging_dir, ".info", "#{safe_base_package_name}.inventory" )}")
       end
 
       # Copy the resulting package up to the package_dir

data/lib/omnibus/packagers/deb.rb

@@ -207,7 +207,7 @@ module Omnibus
       if null?(val)
         @compression_type || :gzip
       else
-        unless val.is_a?(Symbol) && [:gzip, :xz, :none].member?(val)
+        unless val.is_a?(Symbol) && %i{gzip xz none}.member?(val)
           raise InvalidValue.new(:compression_type, "be a Symbol (:gzip, :xz, or :none)")
         end
 
@@ -261,7 +261,7 @@ module Omnibus
         @compression_strategy
       else
         unless val.is_a?(Symbol) &&
-            [:filtered, :huffman, :rle, :fixed, :extreme].member?(val)
+            %i{filtered huffman rle fixed extreme}.member?(val)
           raise InvalidValue.new(:compression_strategy, "be a Symbol (:filtered, "\
                                                         ":huffman, :rle, :fixed, or :extreme)")
         end
@@ -320,8 +320,7 @@ module Omnibus
           conflicts: project.conflicts,
           replaces: project.replaces,
           dependencies: project.runtime_dependencies,
-        }
-      )
+        })
     end
 
     #
@@ -336,8 +335,7 @@ module Omnibus
         destination: File.join(debian_dir, "conffiles"),
         variables: {
           config_files: project.config_files,
-        }
-      )
+        })
     end
 
     #
@@ -380,8 +378,7 @@ module Omnibus
         destination: File.join(debian_dir, "md5sums"),
         variables: {
           md5sums: hash,
-        }
-      )
+        })
     end
 
     #
@@ -421,7 +418,7 @@ module Omnibus
     #
     # @return [void]
     def sign_deb_file
-      if !signing_passphrase
+      unless signing_passphrase
         log.info(log_key) { "Signing not enabled for .deb file" }
         return
       end
@@ -447,7 +444,7 @@ module Omnibus
             # Create signature (as +root+)
             gpg_command =  "#{gpg} --armor --sign --detach-sign"
             gpg_command << " --local-user '#{project.maintainer}'"
-            gpg_command << " --homedir #{ENV['HOME']}/.gnupg" # TODO: Make this configurable
+            gpg_command << " --homedir #{ENV["HOME"]}/.gnupg" # TODO: Make this configurable
             ## pass the +signing_passphrase+ via +STDIN+
             gpg_command << " --batch --no-tty"
             ## Check `gpg` for the compatibility/need of pinentry-mode

data/lib/omnibus/packagers/ips.rb

@@ -209,8 +209,7 @@ module Omnibus
         destination: transform_file,
         variables: {
           pathdir: project.install_dir.split("/")[1],
-        }
-      )
+        })
     end
 
     #
@@ -242,8 +241,7 @@ module Omnibus
       render_template_content(resource_path(symlinks_file),
         {
           projectdir: project.install_dir,
-        }
-      )
+        })
     end
 
     #
@@ -262,8 +260,7 @@ module Omnibus
           description: project.description,
           summary: project.friendly_name,
           arch: safe_architecture,
-        }
-      )
+        })
 
       # Append the contents of symlinks_file if it exists
       if symlinks_file