omnibus 5.4.0 → 5.5.0

data/lib/omnibus/metadata.rb

@@ -14,7 +14,7 @@
 # limitations under the License.
 #
 
-require 'ffi_yajl'
+require "ffi_yajl"
 
 module Omnibus
   class Metadata
@@ -63,7 +63,7 @@ module Omnibus
           iteration:        project.build_iteration,
           license:          project.license,
           version_manifest: project.built_manifest.to_hash,
-          license_content:  File.exist?(project.license_file_path) ? File.read(project.license_file_path) : ''
+          license_content:  File.exist?(project.license_file_path) ? File.read(project.license_file_path) : "",
         }
 
         instance = new(package, data)
@@ -84,9 +84,9 @@ module Omnibus
         hash = FFI_Yajl::Parser.parse(data, symbolize_names: true)
 
          # Ensure Platform version has been truncated
-         if hash[:platform_version] && hash[:platform]
-           hash[:platform_version] = truncate_platform_version(hash[:platform_version], hash[:platform])
-         end
+        if hash[:platform_version] && hash[:platform]
+          hash[:platform_version] = truncate_platform_version(hash[:platform_version], hash[:platform])
+        end
 
         # Ensure an interation exists
         hash[:iteration] ||= 1
@@ -115,15 +115,15 @@ module Omnibus
       #
       def arch
         if windows? && windows_arch_i386?
-          'i386'
+          "i386"
         elsif solaris?
           if intel?
-            'i386'
+            "i386"
           elsif sparc?
-            'sparc'
+            "sparc"
           end
         else
-          Ohai['kernel']['machine']
+          Ohai["kernel"]["machine"]
         end
       end
 
@@ -134,7 +134,7 @@ module Omnibus
       #   the platform version
       #
       def platform_version
-        truncate_platform_version(Ohai['platform_version'], platform_shortname)
+        truncate_platform_version(Ohai["platform_version"], platform_shortname)
       end
 
       #
@@ -145,11 +145,11 @@ module Omnibus
       #
       def platform_shortname
         if rhel?
-          'el'
+          "el"
         elsif suse?
-          'sles'
+          "sles"
         else
-          Ohai['platform']
+          Ohai["platform"]
         end
       end
 
@@ -169,16 +169,16 @@ module Omnibus
       #
       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'
+        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'
+          platform_version.split(".").first
+        when "aix", "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'
+          platform_version.split(".")[0..1].join(".")
+        when "arch"
           # Arch Linux does not have a platform_version ohai attribute, it is rolling release (lsb_release -r)
-          'rolling'
-        when 'windows'
+          "rolling"
+        when "windows"
           # Windows has this really awesome "feature", where their version numbers
           # internally do not match the "marketing" name.
           #
@@ -197,23 +197,23 @@ module Omnibus
           # https://msdn.microsoft.com/en-us/library/windows/desktop/ms724832(v=vs.85).aspx
           #
           case platform_version
-          when '5.0.2195', '2000'   then '2000'
-          when '5.1.2600', 'xp'     then 'xp'
-          when '5.2.3790', '2003r2' then '2003r2'
-          when '6.0.6001', '2008'   then '2008'
-          when '6.1.7600', '7'      then '7'
-          when '6.1.7601', '2008r2' then '2008r2'
-          when '6.2.9200', '8'      then '8'
-          # The following `when` will never match since Windows 2012's platform
-          # version is the same as Windows 8. It's only here for completeness and
+          when "5.0.2195", "2000"   then "2000"
+          when "5.1.2600", "xp"     then "xp"
+          when "5.2.3790", "2003r2" then "2003r2"
+          when "6.0.6001", "2008"   then "2008"
+          when "6.1.7600", "7"      then "7"
+          when "6.1.7601", "2008r2" then "2008r2"
+          when "6.2.9200", "2012"   then "2012"
+          # The following `when` will never match since Windows 8's platform
+          # version is the same as Windows 2012. It's only here for completeness and
           # documentation.
-          when '6.2.9200', '2012'   then '2012'
-          when /6\.3\.\d+/, '8.1' then '8.1'
-          # The following `when` will never match since Windows 2012R2's platform
-          # version is the same as Windows 8.1. It's only here for completeness
+          when "6.2.9200", "8"      then "8"
+          when /6\.3\.\d+/, "2012r2" then "2012r2"
+          # The following `when` will never match since Windows 8.1's platform
+          # version is the same as Windows 2012R2. It's only here for completeness
           # and documentation.
-          when /6\.3\.\d+/, '2012r2' then '2012r2'
-          when /^10\.0/ then '10'
+          when /6\.3\.\d+/, "8.1" then "8.1"
+          when /^10\.0/ then "10"
           else
             raise UnknownPlatformVersion.new(platform, platform_version)
           end
@@ -267,7 +267,7 @@ module Omnibus
     # @return [true]
     #
     def save
-      File.open(path, 'w+')  do |f|
+      File.open(path, "w+") do |f|
         f.write(FFI_Yajl::Encoder.encode(to_hash, pretty: true))
       end
 

data/lib/omnibus/ohai.rb

@@ -14,16 +14,15 @@
 # limitations under the License.
 #
 
-require 'ohai'
+require "ohai"
 
 module Omnibus
   class Ohai
-    PLUGINS = [
-      'cpu',
-      'kernel',
-      'os',
-      'platform',
-    ].freeze
+    PLUGINS = %w{
+cpu
+kernel
+os
+platform}.freeze
 
     class << self
       def method_missing(m, *args, &block)

data/lib/omnibus/package.rb

@@ -14,7 +14,7 @@
 # limitations under the License.
 #
 
-require 'ffi_yajl'
+require "ffi_yajl"
 
 module Omnibus
   class Package

data/lib/omnibus/packager.rb

@@ -19,15 +19,16 @@ module Omnibus
     include Logging
     include Sugarable
 
-    autoload :Base,     'omnibus/packagers/base'
-    autoload :BFF,      'omnibus/packagers/bff'
-    autoload :DEB,      'omnibus/packagers/deb'
-    autoload :Makeself, 'omnibus/packagers/makeself'
-    autoload :MSI,      'omnibus/packagers/msi'
-    autoload :PKG,      'omnibus/packagers/pkg'
-    autoload :Solaris,  'omnibus/packagers/solaris'
-    autoload :IPS,      'omnibus/packagers/ips'
-    autoload :RPM,      'omnibus/packagers/rpm'
+    autoload :Base,     "omnibus/packagers/base"
+    autoload :BFF,      "omnibus/packagers/bff"
+    autoload :DEB,      "omnibus/packagers/deb"
+    autoload :Makeself, "omnibus/packagers/makeself"
+    autoload :MSI,      "omnibus/packagers/msi"
+    autoload :APPX,     "omnibus/packagers/appx"
+    autoload :PKG,      "omnibus/packagers/pkg"
+    autoload :Solaris,  "omnibus/packagers/solaris"
+    autoload :IPS,      "omnibus/packagers/ips"
+    autoload :RPM,      "omnibus/packagers/rpm"
 
     #
     # The list of Ohai platform families mapped to the respective packager
@@ -36,44 +37,52 @@ module Omnibus
     # @return [Hash<String, Class>]
     #
     PLATFORM_PACKAGER_MAP = {
-      'debian'   => DEB,
-      'fedora'   => RPM,
-      'suse'     => RPM,
-      'rhel'     => RPM,
-      'wrlinux'  => RPM,
-      'aix'      => BFF,
-      'solaris'  => Solaris,
-      'ips'      => IPS,
-      'windows'  => MSI,
-      'mac_os_x' => PKG,
+      "debian"   => DEB,
+      "fedora"   => RPM,
+      "suse"     => RPM,
+      "rhel"     => RPM,
+      "wrlinux"  => RPM,
+      "aix"      => BFF,
+      "solaris"  => Solaris,
+      "ips"      => IPS,
+      "windows"  => [MSI, APPX],
+      "mac_os_x" => PKG,
     }.freeze
 
     #
-    # Determine the packager for the current system. This method returns the
+    # Determine the packager(s) for the current system. This method returns the
     # class, not an instance of the class.
     #
     # @example
-    #   Packager.for_current_system #=> Packager::RPM
+    #   Packager.for_current_system #=> [Packager::RPM]
     #
-    # @return [~Packager::Base]
+    # @return [[~Packager::Base]]
     #
     def for_current_system
-      family = Ohai['platform_family']
-      version = Ohai['platform_version']
+      family = Ohai["platform_family"]
+      version = Ohai["platform_version"]
 
-      if family == 'solaris2' && Chef::Sugar::Constraints::Version.new(version).satisfies?('>= 5.11')
+      if family == "solaris2" && Chef::Sugar::Constraints::Version.new(version).satisfies?(">= 5.11")
         family = "ips"
-      elsif family == 'solaris2' && Chef::Sugar::Constraints::Version.new(version).satisfies?('>= 5.10')
+      elsif family == "solaris2" && Chef::Sugar::Constraints::Version.new(version).satisfies?(">= 5.10")
         family = "solaris"
       end
       if klass = PLATFORM_PACKAGER_MAP[family]
-        klass
+        package_types = klass.is_a?(Array) ? klass : [ klass ]
+
+        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]
+        end
+
+        package_types
       else
         log.warn(log_key) do
           "Could not determine packager for `#{family}', defaulting " \
           "to `makeself'!"
         end
-        Makeself
+        [Makeself]
       end
     end
     module_function :for_current_system

data/lib/omnibus/packagers/appx.rb

@@ -0,0 +1,86 @@
+#
+# Copyright 2016 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.
+# 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.
+#
+
+require "omnibus/packagers/windows_base"
+
+module Omnibus
+  class Packager::APPX < Packager::WindowsBase
+    id :appx
+
+    setup do
+      # Render the manifest
+      write_manifest_file
+
+      # Copy all the staging assets from vendored Omnibus into the resources
+      # directory.
+      FileSyncer.glob("#{Omnibus.source_root}/resources/#{id}/assets/*").each do |file|
+        copy_file(file, "#{project.install_dir}/#{File.basename(file)}")
+      end
+
+      # Copy all assets in the user's project directory - this may overwrite
+      # files copied in the previous step, but that's okay :)
+      FileSyncer.glob("#{resources_path}/assets/*").each do |file|
+        copy_file(file, "#{project.install_dir}/#{File.basename(file)}")
+      end
+    end
+
+    build do
+      # Pack the files with makeappx.exe, recursively generate fragment for
+      # project directory
+      Dir.chdir(staging_dir) do
+        appx_file = windows_safe_path(Config.package_dir, package_name)
+        shellout!(pack_command(appx_file))
+
+        if signing_identity
+          sign_package(appx_file)
+        end
+      end
+    end
+
+    # @see Base#package_name
+    def package_name
+      "#{project.package_name}-#{project.build_version}-#{project.build_iteration}.appx"
+    end
+
+    #
+    # Write the manifest file into the staging directory.
+    #
+    # @return [void]
+    #
+    def write_manifest_file
+      render_template(resource_path("AppxManifest.xml.erb"),
+        destination: "#{windows_safe_path(project.install_dir)}/AppxManifest.xml",
+        variables: {
+          name:            project.package_name,
+          friendly_name:   project.friendly_name,
+          version:         windows_package_version,
+          maintainer:      project.maintainer,
+          certificate_subject: certificate_subject,
+        }
+      )
+    end
+
+    #
+    # Get the shell command to run pack in order to create a
+    # an appx package
+    #
+    # @return [String]
+    #
+    def pack_command(appx_file)
+      "makeappx.exe pack /d \"#{windows_safe_path(project.install_dir)}\" /p #{appx_file}"
+    end
+  end
+end

data/lib/omnibus/packagers/base.rb

@@ -14,12 +14,13 @@
 # limitations under the License.
 #
 
-require 'fileutils'
+require "fileutils"
 
 module Omnibus
   class Packager::Base
     include Cleanroom
     include Digestable
+    include Instrumentation
     include Logging
     include NullArgumentable
     include Sugarable
@@ -98,12 +99,12 @@ module Omnibus
     # @return [Array<String>]
     #
     def exclusions
-      project.exclusions + %w(
+      project.exclusions + %w{
         **/.git
         **/.hg
         **/.svn
         **/.gitkeep
-      )
+      }
     end
 
     #
@@ -140,21 +141,23 @@ module Omnibus
       # Ensure the package directory exists
       create_directory(Config.package_dir)
 
-      # Run the setup and build sequences
-      instance_eval(&self.class.setup) if self.class.setup
-      instance_eval(&self.class.build) if self.class.build
-
-      # Render the metadata
-      Metadata.generate(package_path, project)
-
-      # Ensure the temporary directory is removed at the end of a successful
-      # run. Without removal, successful builds will "leak" in /tmp and cause
-      # increased disk usage.
-      #
-      # Instead of having this as an +ensure+ block, failed builds will persist
-      # this directory so developers can go poke around and figure out why the
-      # build failed.
-      remove_directory(staging_dir)
+      measure("Packaging time") do
+        # Run the setup and build sequences
+        instance_eval(&self.class.setup) if self.class.setup
+        instance_eval(&self.class.build) if self.class.build
+
+        # Render the metadata
+        Metadata.generate(package_path, project)
+
+        # Ensure the temporary directory is removed at the end of a successful
+        # run. Without removal, successful builds will "leak" in /tmp and cause
+        # increased disk usage.
+        #
+        # Instead of having this as an +ensure+ block, failed builds will persist
+        # this directory so developers can go poke around and figure out why the
+        # build failed.
+        remove_directory(staging_dir)
+      end
     end
 
     #

data/lib/omnibus/packagers/bff.rb

@@ -19,12 +19,12 @@ module Omnibus
     # @return [Hash]
     SCRIPT_MAP = {
       # Default Omnibus naming
-      preinst:  'Pre-installation Script',
-      postinst: 'Post-installation Script',
-      config:   'Configuration Script',
-      unconfig: 'Unconfiguration Script',
-      prerm:    'Pre_rm Script',
-      postrm:   'Unconfiguration Script',
+      preinst:  "Pre-installation Script",
+      postinst: "Post-installation Script",
+      config:   "Configuration Script",
+      unconfig: "Unconfiguration Script",
+      prerm:    "Pre_rm Script",
+      postrm:   "Unconfiguration Script",
     }.freeze
 
     id :bff
@@ -63,7 +63,7 @@ module Omnibus
     # @return [String]
     #
     def scripts_install_dir
-      File.expand_path(File.join(project.install_dir, 'embedded/share/installp'))
+      File.expand_path(File.join(project.install_dir, "embedded/share/installp"))
     end
 
     #
@@ -129,7 +129,6 @@ module Omnibus
     #   Unconfiguration Script: /path/script
     #
     def write_gen_template
-
       # Get a list of all files
       files = FileSyncer.glob("#{staging_dir}/**/*").reject do |path|
         # remove any files with spaces.
@@ -141,36 +140,36 @@ module Omnibus
       files.map! do |path|
         # If paths have colons or commas, rename them and add them to a post-install,
         # post-sysck renaming script ('config') which is created if needed
-        if path.match(/:|,/)
-          alt = path.gsub(/(:|,)/, '__')
+        if path =~ /:|,/
+          alt = path.gsub(/(:|,)/, "__")
           log.debug(log_key) { "Renaming #{path} to #{alt}" }
 
           File.rename(path, alt) if File.exists?(path)
 
           # Create a config script if needed based on resources/bff/config.erb
-          config_script_path = File.join(scripts_staging_dir, 'config')
+          config_script_path = File.join(scripts_staging_dir, "config")
           unless File.exists? config_script_path
-            render_template(resource_path('config.erb'),
+            render_template(resource_path("config.erb"),
               destination: "#{scripts_staging_dir}/config",
               variables: {
-                name: project.name
+                name: project.name,
               }
             )
           end
 
-          File.open(File.join(scripts_staging_dir, 'config'), 'a') do |file|
+          File.open(File.join(scripts_staging_dir, "config"), "a") do |file|
             file.puts "mv '#{alt.gsub(/^#{staging_dir}/, '')}' '#{path.gsub(/^#{staging_dir}/, '')}'"
           end
 
           path = alt
         end
 
-        path.gsub(/^#{staging_dir}/, '')
+        path.gsub(/^#{staging_dir}/, "")
       end
 
       # Create a map of scripts that exist to inject into the template
       scripts = SCRIPT_MAP.inject({}) do |hash, (script, installp_key)|
-        staging_path =  File.join(scripts_staging_dir, script.to_s)
+        staging_path = File.join(scripts_staging_dir, script.to_s)
 
         if File.file?(staging_path)
           hash[installp_key] = staging_path
@@ -180,8 +179,8 @@ module Omnibus
         hash
       end
 
-      render_template(resource_path('gen.template.erb'),
-        destination: File.join(staging_dir, 'gen.template'),
+      render_template(resource_path("gen.template.erb"),
+        destination: File.join(staging_dir, "gen.template"),
         variables: {
           name:           safe_base_package_name,
           install_dir:    project.install_dir,
@@ -194,7 +193,7 @@ module Omnibus
       )
 
       # 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')) }
+      log.debug(log_key) { "Rendered Template:\n" + File.read(File.join(staging_dir, "gen.template")) }
     end
 
     #
@@ -233,7 +232,7 @@ module Omnibus
       end
 
       # Copy the resulting package up to the package_dir
-      FileSyncer.glob(File.join(staging_dir, 'tmp/*.bff')).each do |bff|
+      FileSyncer.glob(File.join(staging_dir, "tmp/*.bff")).each do |bff|
         copy_file(bff, File.join(Config.package_dir, create_bff_file_name))
       end
 
@@ -258,7 +257,6 @@ module Omnibus
       "#{safe_base_package_name}-#{project.build_version}-#{project.build_iteration}.#{safe_architecture}.bff"
     end
 
-
     #
     # Return the BFF-ready base package name, converting any invalid characters to
     # dashes (+-+).
@@ -269,7 +267,7 @@ module Omnibus
       if project.package_name =~ /\A[a-z0-9\.\+\-]+\z/
         project.package_name.dup
       else
-        converted = project.package_name.downcase.gsub(/[^a-z0-9\.\+\-]+/, '-')
+        converted = project.package_name.downcase.gsub(/[^a-z0-9\.\+\-]+/, "-")
 
         log.warn(log_key) do
           "The `name' component of BFF package names can only include " \
@@ -293,7 +291,7 @@ module Omnibus
     # @return [String]
     #
     def bff_version
-      version = project.build_version.split(/[^\d]/)[0..2].join('.')
+      version = project.build_version.split(/[^\d]/)[0..2].join(".")
       "#{version}.#{project.build_iteration}"
     end
 
@@ -303,7 +301,7 @@ module Omnibus
     # @return [String]
     #
     def safe_architecture
-      Ohai['kernel']['machine']
+      Ohai["kernel"]["machine"]
     end
   end
 end