omnibus 5.5.0 → 5.6.0

data/lib/omnibus/health_check.rb

@@ -15,6 +15,7 @@
 #
 
 require "omnibus/sugarable"
+require "omnibus/whitelist"
 begin
   require "pedump"
 rescue LoadError
@@ -28,179 +29,6 @@ module Omnibus
     include Util
     include Sugarable
 
-    WHITELIST_LIBS = [
-      /ld-linux/,
-      /libc\.so/,
-      /libcrypt\.so/,
-      /libdl/,
-      /libfreebl\d\.so/,
-      /libgcc_s\.so/,
-      /libm\.so/,
-      /libnsl\.so/,
-      /libpthread/,
-      /libresolv\.so/,
-      /librt\.so/,
-      /libstdc\+\+\.so/,
-      /libutil\.so/,
-      /linux-vdso.+/,
-      /linux-gate\.so/,
-    ].freeze
-
-    ARCH_WHITELIST_LIBS = [
-      /libc\.so/,
-      /libcrypt\.so/,
-      /libdb-5\.3\.so/,
-      /libdl\.so/,
-      /libffi\.so/,
-      /libgdbm\.so/,
-      /libm\.so/,
-      /libnsl\.so/,
-      /libpthread\.so/,
-      /librt\.so/,
-      /libutil\.so/,
-    ].freeze
-
-    AIX_WHITELIST_LIBS = [
-      /libpthread\.a/,
-      /libpthreads\.a/,
-      /libdl.a/,
-      /librtl\.a/,
-      /libc\.a/,
-      /libcrypt\.a/,
-      /unix$/,
-    ].freeze
-
-    SOLARIS_WHITELIST_LIBS = [
-      /libaio\.so/,
-      /libavl\.so/,
-      /libcrypt_[di]\.so/,
-      /libcrypto.so/,
-      /libcurses\.so/,
-      /libdoor\.so/,
-      /libgen\.so/,
-      /libmd5\.so/,
-      /libmd\.so/,
-      /libmp\.so/,
-      /libresolv\.so/,
-      /libscf\.so/,
-      /libsec\.so/,
-      /libsocket\.so/,
-      /libssl.so/,
-      /libthread.so/,
-      /libuutil\.so/,
-      /libkstat\.so/,
-      # solaris 11 libraries:
-      /libc\.so\.1/,
-      /libm\.so\.2/,
-      /libdl\.so\.1/,
-      /libnsl\.so\.1/,
-      /libpthread\.so\.1/,
-      /librt\.so\.1/,
-      /libcrypt\.so\.1/,
-      /libgdbm\.so\.3/,
-      /libgcc_s\.so\.1/,
-      /libcryptoutil\.so\.1/,
-      /libucrypto\.so\.1/,
-      /libz\.so\.1/, # while we package our own libz, this get dragged along from Solaris 11's libelf library for some reason...
-      /libelf\.so\.1/,
-      /libssp\.so\.0/,
-      # solaris 9 libraries:
-      /libm\.so\.1/,
-      /libc_psr\.so\.1/,
-      /s9_preload\.so\.1/,
-    ].freeze
-
-    SMARTOS_WHITELIST_LIBS = [
-      /libm.so/,
-      /libpthread.so/,
-      /librt.so/,
-      /libsocket.so/,
-      /libdl.so/,
-      /libnsl.so/,
-      /libgen.so/,
-      /libmp.so/,
-      /libmd.so/,
-      /libc.so/,
-      /libgcc_s.so/,
-      /libstdc\+\+\.so/,
-      /libcrypt.so/,
-    ].freeze
-
-    MAC_WHITELIST_LIBS = [
-      /libobjc\.A\.dylib/,
-      /libSystem\.B\.dylib/,
-      /CoreFoundation/,
-      /CoreServices/,
-      /Tcl$/,
-      /Cocoa$/,
-      /Carbon$/,
-      /IOKit$/,
-      /Tk$/,
-      /libutil\.dylib/,
-      /libffi\.dylib/,
-      /libncurses\.5\.4\.dylib/,
-      /libiconv/,
-      /libstdc\+\+\.6\.dylib/,
-      /libc\+\+\.1\.dylib/,
-    ].freeze
-
-    FREEBSD_WHITELIST_LIBS = [
-      /libc\.so/,
-      /libgcc_s\.so/,
-      /libcrypt\.so/,
-      /libm\.so/,
-      /librt\.so/,
-      /libthr\.so/,
-      /libutil\.so/,
-      /libelf\.so/,
-      /libkvm\.so/,
-      /libprocstat\.so/,
-      /libmd\.so/,
-    ].freeze
-
-    IGNORED_ENDINGS = %w{
-      .[ch]
-      .e*rb
-      .gemspec
-      .gitignore
-      .h*h
-      .java
-      .js
-      .json
-      .lock
-      .log
-      .lua
-      .md
-      .mkd
-      .out
-      .pl
-      .pm
-      .png
-      .py[oc]*
-      .r*html
-      .rdoc
-      .ri
-      .sh
-      .sql
-      .toml
-      .ttf
-      .txt
-      .xml
-      .yml
-      Gemfile
-      LICENSE
-      README
-      Rakefile
-      VERSION
-    }.freeze
-
-    IGNORED_PATTERNS = %w{
-      /share/doc/
-      /share/postgresql/
-      /share/terminfo/
-      /terminfo/
-    }.freeze
-
     class << self
       # @see (HealthCheck#new)
       def run!(project)

data/lib/omnibus/licensing.rb

@@ -18,6 +18,7 @@ require "uri"
 require "fileutils"
 require "omnibus/download_helpers"
 require "license_scout/collector"
+require "license_scout/reporter"
 require "license_scout/options"
 
 module Omnibus
@@ -144,9 +145,9 @@ module Omnibus
     #
     def execute_post_build(software)
       collect_licenses_for(software)
-
       unless software.skip_transitive_dependency_licensing
         collect_transitive_dependency_licenses_for(software)
+        check_transitive_dependency_licensing_errors_for(software)
       end
     end
 
@@ -393,7 +394,7 @@ module Omnibus
     #
     def local?(license)
       u = URI(license)
-      return u.scheme.nil?
+      u.scheme.nil?
     end
 
     #
@@ -439,12 +440,14 @@ 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"
       end
 
       warnings_to_raise.flatten!
       raise LicensingError.new(warnings_to_raise) unless warnings_to_raise.empty?
     end
 
+    # 0. Translate all transitive dependency licensing issues into omnibus warnings
     # 1. Parse all the licensing information for all software from 'cache_dir'
     # 2. Merge and drop the duplicates
     # 3. Add these licenses to the main manifest, to be merged with the main
@@ -498,21 +501,22 @@ module Omnibus
       # the build completes we will process these license files but we need to
       # perform this step after build, before git_cache to be able to operate
       # correctly with the git_cache.
-      license_output_dir = File.join(cache_dir, software.name)
 
       collector = LicenseScout::Collector.new(
-        software.project.name,
+        software.name,
         software.project_dir,
-        license_output_dir,
+        license_output_dir(software),
         LicenseScout::Options.new(
           environment: software.with_embedded_path,
-          ruby_bin: software.embedded_bin("ruby")
+          ruby_bin: software.embedded_bin("ruby"),
+          manual_licenses: software.dependency_licenses
         )
       )
 
       begin
+        # We do not automatically collect dependency licensing information when
+        # skip_transitive_dependency_licensing is set on the software.
         collector.run
-        collector.issue_report.each { |i| transitive_dependency_licensing_warning(i) }
       rescue LicenseScout::Exceptions::UnsupportedProjectType => e
         # Looks like this project is not supported by LicenseScout. Either the
         # language and the dependency manager used by the project is not
@@ -527,18 +531,53 @@ the list of supported languages and dependency managers. If this project does \
 not have any transitive dependencies, consider setting \
 'skip_transitive_dependency_licensing' to 'true' in order to correct this error.
 EOH
+        # If we got here, we need to fail now so we don't take a git
+        # cache snapshot, or else the software build could be restored
+        # from cache without fixing the license issue.
+        raise_if_warnings_fatal!
       rescue LicenseScout::Exceptions::Error => e
         transitive_dependency_licensing_warning(<<-EOH)
 Can not automatically detect licensing information for '#{software.name}' using \
 license_scout. Error is: '#{e}'
 EOH
+        # If we got here, we need to fail now so we don't take a git
+        # cache snapshot, or else the software build could be restored
+        # from cache without fixing the license issue.
+        raise_if_warnings_fatal!
       rescue Exception => e
+        # This catch all exception handling is here in order not to fail builds
+        # until license_scout gets more stable. As we are adding support for more
+        # and more dependency managers we discover unhandled edge cases which
+        # requires us to have this. Remove this once license_scout is stable.
         transitive_dependency_licensing_warning(<<-EOH)
 Unexpected error while running license_scout for '#{software.name}': '#{e}'
 EOH
+        # If we got here, we need to fail now so we don't take a git
+        # cache snapshot, or else the software build could be restored
+        # from cache without fixing the license issue.
+        raise_if_warnings_fatal!
       end
     end
 
+    # Checks transitive dependency licensing errors for the given software
+    def check_transitive_dependency_licensing_errors_for(software)
+      reporter = LicenseScout::Reporter.new(license_output_dir(software))
+      begin
+        reporter.report.each { |i| transitive_dependency_licensing_warning(i) }
+      rescue LicenseScout::Exceptions::InvalidOutputReport => e
+        transitive_dependency_licensing_warning(<<-EOH)
+Licensing output report at '#{license_output_dir(software)}' has errors:
+#{e}
+EOH
+      end
+      raise_if_warnings_fatal!
+    end
+
+    # The directory to store the licensing information for the given software
+    def license_output_dir(software)
+      File.join(cache_dir, software.name)
+    end
+
     # Collect the license files for the software.
     def collect_licenses_for(software)
       return nil if software.license == :project_license
@@ -594,6 +633,7 @@ EOH
       "APL-1.0",       # Adaptive Public License
       "Apache-2.0",    # Apache License 2.0
       "APSL-2.0",      # Apple Public Source License
+      "Artistic-1.0",  # Artistic license 1.0
       "Artistic-2.0",  # Artistic license 2.0
       "AAL",           # Attribution Assurance Licenses
       "BSD-3-Clause",  # BSD 3-Clause "New" or "Revised" License
@@ -677,6 +717,7 @@ EOH
       "Oracle-Binary", # http://www.oracle.com/technetwork/java/javase/terms/license/index.html
       "OpenSSL",       # https://www.openssl.org/source/license.html
       "Chef-MLSA",     # https://www.chef.io/online-master-agreement/
+      "Perl-5",        # http://dev.perl.org/licenses/
     ].freeze
   end
 

data/lib/omnibus/manifest.rb

@@ -18,9 +18,9 @@ require "ffi_yajl"
 
 module Omnibus
   class Manifest
-    class InvalidManifestFormat < Exception; end
-    class NotAManifestEntry < Exception; end
-    class MissingManifestEntry < Exception; end
+    class InvalidManifestFormat < RuntimeError; end
+    class NotAManifestEntry < RuntimeError; end
+    class MissingManifestEntry < RuntimeError; end
 
     include Logging
 
@@ -128,8 +128,6 @@ module Omnibus
       from_hash(hash)
     end
 
-    private
-
     #
     # Utility function to convert a Hash with String keys to a Hash
     # with Symbol keys, recursively.

data/lib/omnibus/manifest_entry.rb

@@ -38,7 +38,7 @@ module Omnibus
 
     def ==(other)
       if other.is_a?(ManifestEntry)
-        (self.to_hash == other.to_hash) && (self.name == other.name)
+        (to_hash == other.to_hash) && (name == other.name)
       end
     end
   end

data/lib/omnibus/metadata.rb

@@ -167,12 +167,13 @@ module Omnibus
       #   the platform shortname. this might be an Ohai-returned platform or
       #   platform family but it also might be a shortname like `el`
       #
+      # rubocop:disable Lint/DuplicateCaseCondition
       def truncate_platform_version(platform_version, platform)
         case platform
         when "centos", "debian", "el", "fedora", "freebsd", "omnios", "pidora", "raspbian", "rhel", "sles", "suse", "smartos", "nexus", "ios_xr"
           # Only want MAJOR (e.g. Debian 7, OmniOS r151006, SmartOS 20120809T221258Z)
           platform_version.split(".").first
-        when "aix", "gentoo", "mac_os_x", "openbsd", "slackware", "solaris2", "opensuse", "ubuntu"
+        when "aix", "alpine", "gentoo", "mac_os_x", "openbsd", "slackware", "solaris2", "opensuse", "ubuntu"
           # Only want MAJOR.MINOR (e.g. Mac OS X 10.9, Ubuntu 12.04)
           platform_version.split(".")[0..1].join(".")
         when "arch"

data/lib/omnibus/packager.rb

@@ -26,6 +26,7 @@ module Omnibus
     autoload :MSI,      "omnibus/packagers/msi"
     autoload :APPX,     "omnibus/packagers/appx"
     autoload :PKG,      "omnibus/packagers/pkg"
+    autoload :PKGSRC,   "omnibus/packagers/pkgsrc"
     autoload :Solaris,  "omnibus/packagers/solaris"
     autoload :IPS,      "omnibus/packagers/ips"
     autoload :RPM,      "omnibus/packagers/rpm"
@@ -47,6 +48,7 @@ module Omnibus
       "ips"      => IPS,
       "windows"  => [MSI, APPX],
       "mac_os_x" => PKG,
+      "smartos"  => PKGSRC,
     }.freeze
 
     #
@@ -73,7 +75,7 @@ module Omnibus
         if package_types.include?(APPX) &&
             !Chef::Sugar::Constraints::Version.new(version).satisfies?(">= 6.2")
           log.warn(log_key) { "APPX generation is only supported on Windows versions 2012 and above" }
-          package_types = package_types - [APPX]
+          package_types -= [APPX]
         end
 
         package_types

data/lib/omnibus/packagers/appx.rb

@@ -52,7 +52,7 @@ module Omnibus
 
     # @see Base#package_name
     def package_name
-      "#{project.package_name}-#{project.build_version}-#{project.build_iteration}.appx"
+      "#{project.package_name}-#{project.build_version}-#{project.build_iteration}-#{Config.windows_arch}.appx"
     end
 
     #
@@ -68,7 +68,7 @@ module Omnibus
           friendly_name:   project.friendly_name,
           version:         windows_package_version,
           maintainer:      project.maintainer,
-          certificate_subject: certificate_subject,
+          certificate_subject: certificate_subject.gsub('"', """),
         }
       )
     end
@@ -80,7 +80,7 @@ module Omnibus
     # @return [String]
     #
     def pack_command(appx_file)
-      "makeappx.exe pack /d \"#{windows_safe_path(project.install_dir)}\" /p #{appx_file}"
+      "makeappx.exe pack /d \"#{windows_safe_path(project.install_dir)}\" /o /p #{appx_file}"
     end
   end
 end

data/lib/omnibus/packagers/base.rb

@@ -180,6 +180,15 @@ module Omnibus
       @staging_dir ||= Dir.mktmpdir(project.package_name)
     end
 
+    #
+    # Helper method to produce staging paths
+    #
+    # @return [String]
+    #
+    def staging_dir_path(file_name)
+      File.join(staging_dir, file_name)
+    end
+
     #
     # @!group Resource methods
     # --------------------------------------------------

data/lib/omnibus/packagers/bff.rb

@@ -131,9 +131,9 @@ module Omnibus
     def write_gen_template
       # Get a list of all files
       files = FileSyncer.glob("#{staging_dir}/**/*").reject do |path|
-        # remove any files with spaces.
-        if path =~ /[[:space:]]/
-          log.warn(log_key) { "Skipping packaging '#{path}' file due to whitespace in filename" }
+        # remove any files with spaces or braces.
+        if path =~ /[[:space:]{}]/
+          log.warn(log_key) { "Skipping packaging '#{path}' file due to whitespace or braces in filename" }
           true
         end
       end
@@ -226,9 +226,7 @@ module Omnibus
       # 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