omnibus 2.0.2 → 3.0.0

data/lib/omnibus/packagers/mac_pkg.rb

@@ -15,275 +15,151 @@
 # limitations under the License.
 #
 
-require 'forwardable'
-require 'fileutils'
-require 'omnibus/util'
-
 module Omnibus
-  module Packagers
-    # Builds a Mac OS X "product" package (.pkg extension)
-    #
-    # Mac OS X packages are built in two stages. First, files are packaged up
-    # into one or more "component" .pkg files (MacPkg only supports making a
-    # single component). This is done with `pkgbuild`. Next the component(s)
-    # are combined into a single "product" package, using `productbuild`. It is
-    # this container package that can have custom branding (background image)
-    # and a license. It can also allow for user customization of which
-    # component packages to install, but MacPkg does not expose this feature.
-    class MacPkg
-      include Util
-
-      extend Forwardable
-
-      # The Omnibus::Project instance that we're packaging.
-      attr_reader :project
-
-      # !@method name
-      #   @return (see Project#name)
-      def_delegator :@project, :name
-
-      # !@method version
-      #   @return (see Project#build_version)
-      def_delegator :@project, :build_version, :version
-
-      # !@method iteration
-      #   @return (see Project#iteration)
-      def_delegator :@project, :iteration, :iteration
-
-      # !@method identifier
-      #   @return (see Project#mac_pkg_identifier)
-      def_delegator :@project, :mac_pkg_identifier, :identifier
-
-      # !@method pkg_root
-      #   @return (see Project#install_path)
-      def_delegator :@project, :install_path, :pkg_root
-
-      # !@method install_location
-      #   @return (see Project#install_path)
-      def_delegator :@project, :install_path, :install_location
-
-      # !@method scripts
-      #   @return (see Project#package_scripts_path)
-      def_delegator :@project, :package_scripts_path, :scripts
-
-      # !@method files_path
-      #   @return (see Project#files_path)
-      def_delegator :@project, :files_path
-
-      # !@method package_dir
-      #   @return (see Project#package_dir)
-      def_delegator :@project, :package_dir
-
-      # @param project [Project] the omnibus project to package.
-      def initialize(project)
-        @project = project
-      end
-
-      # Build the package.
-      def build
-        # Ensure the omnibus project repo contains the stuff we need.
-        validate_omnibus_project!
-
-        # create the staging dir for intermediate build products, if needed.
-        setup_staging_dir!
-
-        # build the component package
-        build_component_pkg
-
-        # build the product package
-        build_product_pkg
-      end
-
-      # Verifies that the #required_files are present in the
-      # omnibus project repo.
-      # @return [true] if required files are present.
-      # @raise [MissingMacPkgResource] if anything is missing.
-      def validate_omnibus_project!
-        missing_files = required_files.select { |f| !File.exist?(f) }
-        if missing_files.empty?
-          true # all good
-        else
-          fail MissingMacPkgResource.new(missing_files)
-        end
-      end
-
-      # Nukes and re-creates the staging_dir
-      # @return [void]
-      def setup_staging_dir!
-        FileUtils.rm_rf(staging_dir)
-        FileUtils.mkdir_p(staging_dir)
-      end
-
-      def build_component_pkg
-        shellout!(*pkgbuild_command, shellout_opts)
-      end
-
-      def build_product_pkg
-        generate_distribution
-        shellout!(*productbuild_command, shellout_opts)
-      end
-
-      # The argv for a pkgbuild command that will build the component package.
-      # The resulting package is only an intermediate build product. It can be
-      # installed with the mac installer, but doesn't contain the data needed
-      # to customize the installer UI.
-      # @return [Array<String>] argv for the pkgbuild command.
-      def pkgbuild_command
-        %W(
-          pkgbuild
-          --identifier #{identifier}
-          --version #{version}
-          --scripts #{scripts}
-          --root #{pkg_root}
-          --install-location #{install_location}
-          #{component_pkg_name}
-        )
-      end
-
-      # The argv for a productbuild command that will build the product package.
-      # The generated package is the final build product that you ship to end
-      # users.
-      # @return [Array<String>] argv for the productbuild command
-      def productbuild_command
-        %W(
-          productbuild
-          --distribution #{distribution_staging_path}
-          --resources #{mac_pkg_files_path}
-          #{product_pkg_path}
-        )
-      end
-
-      # Writes the Distribution file to the staging area.
-      # @return [void]
-      def generate_distribution
-        File.open(distribution_staging_path, File::RDWR | File::CREAT | File::EXCL, 0600) do |file|
-          file.print(distribution)
-        end
-      end
-
-      # The name of the (only) component package.
-      # @return [String] the filename of the component .pkg file to create.
-      def component_pkg_name
-        "#{name}-core.pkg"
-      end
-
-      # The basename of the end-result package (that will be distributed to
-      # users).
-      #
-      # Project uses this to generate metadata about the package after its
-      # built.
-      #
-      # @return [String] the basename of the package file
-      def package_name
-        "#{name}-#{version}-#{iteration}.pkg"
-      end
-
-      def identifier
-        project.mac_pkg_identifier ||
-          "test.#{sanitized_maintainer}.pkg.#{sanitized_name}"
-      end
+  # Builds a Mac OS X "product" package (.pkg extension)
+  #
+  # Mac OS X packages are built in two stages. First, files are packaged up
+  # into one or more "component" .pkg files (MacPkg only supports making a
+  # single component). This is done with `pkgbuild`. Next the component(s)
+  # are combined into a single "product" package, using `productbuild`. It is
+  # this container package that can have custom branding (background image)
+  # and a license. It can also allow for user customization of which
+  # component packages to install, but MacPkg does not expose this feature.
+  class Packager::MacPkg < Packager::Base
+    validate do
+      assert_presence!(resource('background.png'))
+      assert_presence!(resource('license.html'))
+      assert_presence!(resource('welcome.html'))
+    end
 
-      # Internally in this class we want to call this the "product package" so
-      # we can be unambiguous and consistent.
-      alias_method :product_pkg_name, :package_name
+    setup do
+      purge_directory(install_path)
+      purge_directory(staging_dir)
+      purge_directory(project.package_dir)
+    end
 
-      # The full path where the product package was/will be written.
-      #
-      # @return [String] Path to the packge file.
-      def product_pkg_path
-        File.join(package_dir, product_pkg_name)
-      end
+    build do
+      build_component_pkg
+      generate_distribution
+      build_product_pkg
 
-      # @return [String] Filesystem path where the Distribution file is written.
-      def distribution_staging_path
-        File.join(staging_dir, 'Distribution')
+      if project.config[:build_dmg]
+        Packager::MacDmg.new(self).run!
       end
+    end
 
-      # Generates the content of the Distribution file, which is used by
-      # productbuild to select the component packages to include in the product
-      # package. Also includes information used to customize the UI of the Mac
-      # OS X installer.
-      # @return [String] Distribution file content (XML)
-      def distribution
-        <<-END_DISTRIBTION
-<?xml version="1.0" standalone="no"?>
-<installer-gui-script minSpecVersion="1">
-    <title>#{name.capitalize}</title>
-    <background file="background.png" alignment="bottomleft" mime-type="image/png"/>
-    <welcome file="welcome.html" mime-type="text/html"/>
-    <license file="license.html" mime-type="text/html"/>
-
-    <!-- Generated by productbuild - - synthesize -->
-    <pkg-ref id="#{identifier}"/>
-    <options customize="never" require-scripts="false"/>
-    <choices-outline>
-        <line choice="default">
-            <line choice="#{identifier}"/>
-        </line>
-    </choices-outline>
-    <choice id="default"/>
-    <choice id="#{identifier}" visible="false">
-        <pkg-ref id="#{identifier}"/>
-    </choice>
-    <pkg-ref id="#{identifier}" version="#{version}" onConclusion="none">#{component_pkg_name}</pkg-ref>
-</installer-gui-script>
-        END_DISTRIBTION
-      end
+    clean do
+      # There is nothing to cleanup
+    end
 
-      # A directory where intermediate build products are stored.
-      # @return [String] Path to the directory
-      def staging_dir
-        File.join(project.package_tmp, 'mac-pkg')
-      end
+    # @see Base#package_name
+    def package_name
+      "#{name}-#{version}-#{iteration}.pkg"
+    end
 
-      # A list of the files that will be used to customize the "product" package.P
-      # @return [Array<String>] paths to the required files.
-      def required_files
-        [
-          background_png_path,
-          license_file_path,
-          welcome_file_path,
-        ]
-      end
+    # The full path where the product package was/will be written.
+    #
+    # @return [String] Path to the packge file.
+    def final_pkg
+      File.expand_path("#{project.package_dir}/#{package_name}")
+    end
 
-      def sanitized_name
-        name.gsub(/[^[:alnum:]]/, '').downcase
-      end
+    #
+    # Construct the intermediate build product. It can be installed with the
+    # Installer.app, but doesn't contain the data needed to customize the
+    # installer UI.
+    #
+    def build_component_pkg
+      execute <<-EOH.gsub(/^ {8}/, '')
+        pkgbuild \\
+          --identifier "#{identifier}" \\
+          --version "#{version}" \\
+          --scripts "#{scripts}" \\
+          --root "#{install_path}" \\
+          --install-location "#{install_path}" \\
+          "#{component_pkg}"
+      EOH
+    end
 
-      def sanitized_maintainer
-        project.maintainer.gsub(/[^[:alnum:]]/, '').downcase
+    #
+    # Write the Distribution file to the staging area. This method generates the
+    # content of the Distribution file, which is used by +productbuild+ to
+    # select the component packages to include in the product package.
+    #
+    # It also includes information used to customize the UI of the Mac OS X
+    # installer.
+    #
+    def generate_distribution
+      File.open(distribution_file, 'w', 0600) do |file|
+        file.puts <<-EOH.gsub(/^ {10}/, '')
+          <?xml version="1.0" standalone="no"?>
+          <installer-gui-script minSpecVersion="1">
+              <title>#{name.capitalize}</title>
+              <background file="background.png" alignment="bottomleft" mime-type="image/png"/>
+              <welcome file="welcome.html" mime-type="text/html"/>
+              <license file="license.html" mime-type="text/html"/>
+
+              <!-- Generated by productbuild - - synthesize -->
+              <pkg-ref id="#{identifier}"/>
+              <options customize="never" require-scripts="false"/>
+              <choices-outline>
+                  <line choice="default">
+                      <line choice="#{identifier}"/>
+                  </line>
+              </choices-outline>
+              <choice id="default"/>
+              <choice id="#{identifier}" visible="false">
+                  <pkg-ref id="#{identifier}"/>
+              </choice>
+              <pkg-ref id="#{identifier}" version="#{version}" onConclusion="none">#{component_pkg}</pkg-ref>
+          </installer-gui-script>
+        EOH
       end
+    end
 
-      # The path to the directory inside the omnibus project's repo where the
-      # pkg resource files are.
-      # @return [String] path to the Resources directory
-      def mac_pkg_files_path
-        File.join(files_path, 'mac_pkg', 'Resources')
-      end
+    #
+    # Construct the product package. The generated package is the final build
+    # product that is shipped to end users.
+    #
+    def build_product_pkg
+      execute <<-EOH.gsub(/^ {8}/, '')
+        productbuild \\
+          --distribution "#{distribution_file}" \\
+          --resources "#{resources_path}" \\
+          "#{final_pkg}"
+      EOH
+    end
 
-      # @return [String] path to the license file
-      def license_file_path
-        File.join(mac_pkg_files_path, 'license.html')
-      end
+    # The identifier for this mac package (the com.whatever.thing.whatever).
+    # This is a configurable project value, but a default value is calculated if
+    # one is not given.
+    #
+    # @return [String]
+    def identifier
+      @identifier ||= project.mac_pkg_identifier ||
+        "test.#{sanitize(project.maintainer)}.pkg.#{sanitize(project.name)}"
+    end
 
-      # @return [String] path to the background image for the product package.
-      def background_png_path
-        File.join(mac_pkg_files_path, 'background.png')
-      end
+    # Filesystem path where the Distribution XML file is written.
+    #
+    # @return [String]
+    def distribution_file
+      File.expand_path("#{staging_dir}/Distribution")
+    end
 
-      # Path to the welcome file. This is the content that's displayed on the
-      # first screen of the installer.
-      # @return [String] path to the welcome file
-      def welcome_file_path
-        File.join(mac_pkg_files_path, 'welcome.html')
-      end
+    # The name of the (only) component package.
+    #
+    # @return [String] the filename of the component .pkg file to create.
+    def component_pkg
+      "#{name}-core.pkg"
+    end
 
-      def shellout_opts
-        {
-          timeout: 3600,
-          cwd: staging_dir,
-        }
-      end
+    # Sanitize the given string for the package identifier.
+    #
+    # @param [String]
+    # @return [String]
+    def sanitize(string)
+      string.gsub(/[^[:alnum:]]/, '').downcase
     end
   end
 end

data/lib/omnibus/project.rb

@@ -19,7 +19,6 @@ require 'omnibus/artifact'
 require 'omnibus/exceptions'
 require 'omnibus/library'
 require 'omnibus/util'
-require 'omnibus/packagers/mac_pkg'
 require 'time'
 
 module Omnibus
@@ -32,12 +31,12 @@ module Omnibus
   # @todo: Reorder DSL methods to fit in the same YARD group
   # @todo: Generate the DSL methods via metaprogramming... they're all so similar
   class Project
-    include Rake::DSL
     include Util
 
     NULL_ARG = Object.new
 
     attr_reader :library
+    attr_accessor :dirty_cache
 
     # Convenience method to initialize a Project from a DSL file.
     #
@@ -71,11 +70,71 @@ module Omnibus
       @extra_package_files = []
       @dependencies = []
       @runtime_dependencies = []
+      @dirty_cache = false
       instance_eval(io, filename)
       validate
 
       @library = Omnibus::Library.new(self)
-      render_tasks
+    end
+
+    def build_me
+      FileUtils.mkdir_p(config.package_dir)
+      FileUtils.mkdir_p('pkg')
+
+      if OHAI.platform == 'windows'
+        shellout!("rmdir #{install_path} /s /q")
+      else
+        shellout!("rm -rf #{install_path}/*")
+      end
+
+      library.build_order.each do |software|
+        software.build_me
+      end
+      health_check_me
+      package_me
+    end
+
+    def health_check_me
+      if OHAI.platform == 'windows'
+        puts 'Skipping health check on windows...'
+      else
+        # build a list of all whitelist files from all project dependencies
+        whitelist_files = library.components.map { |component| component.whitelist_files }.flatten
+        Omnibus::HealthCheck.run(install_path, whitelist_files)
+      end
+    end
+
+    def package_me
+      package_types.each do |pkg_type|
+        if pkg_type == 'makeself'
+          run_makeself
+        elsif pkg_type == 'msi'
+          run_msi
+        elsif pkg_type == 'bff'
+          run_bff
+        elsif pkg_type == 'pkgmk'
+          run_pkgmk
+        elsif pkg_type == 'mac_pkg'
+          run_mac_package_build
+        elsif pkg_type == 'mac_dmg'
+          # noop, since the dmg creation is handled by the packager
+        else # pkg_type == "fpm"
+          run_fpm(pkg_type)
+        end
+
+        render_metadata(pkg_type)
+
+        if OHAI.platform == 'windows'
+          cp_cmd = "xcopy #{config.package_dir}\\*.msi pkg\\ /Y"
+        elsif OHAI.platform == 'aix'
+          cp_cmd = "cp #{config.package_dir}/*.bff pkg/"
+        else
+          cp_cmd = "cp #{config.package_dir}/* pkg/"
+        end
+        shell = Mixlib::ShellOut.new(cp_cmd)
+        shell.run_command
+        shell.error!
+      end
     end
 
     # Ensures that certain project information has been set
@@ -123,7 +182,7 @@ module Omnibus
     #   before being subsequently retrieved (i.e., an install_path
     #   must be set in order to build a project)
     def install_path(val = NULL_ARG)
-      @install_path = val unless val.equal?(NULL_ARG)
+      @install_path = File.expand_path(val) unless val.equal?(NULL_ARG)
       @install_path || fail(MissingProjectConfiguration.new('install_path', '/opt/chef'))
     end
 
@@ -249,14 +308,13 @@ module Omnibus
       @mac_pkg_identifier
     end
 
-    # Set or retrieve the +{deb/rpm/solaris}-user+ fpm argument. Defaults
-    # to +root+ if not otherwise set.
+    # Set or retrieve the {deb/rpm/solaris}-user fpm argument.
     #
     # @param val [String]
     # @return [String]
     def package_user(val = NULL_ARG)
       @pkg_user = val unless val.equal?(NULL_ARG)
-      @pkg_user ||= 'root'
+      @pkg_user
     end
 
     # Set or retrieve the full overrides hash for all software being overridden.  Calling it as
@@ -279,14 +337,13 @@ module Omnibus
       @overrides[name]
     end
 
-    # Set or retrieve the +{deb/rpm/solaris}-group+ fpm argument. Defaults
-    # to +root+ if not otherwise set.
+    # Set or retrieve the {deb/rpm/solaris}-group fpm argument.
     #
     # @param val [String]
     # @return [String]
     def package_group(val = NULL_ARG)
       @pkg_group = val unless val.equal?(NULL_ARG)
-      @pkg_group ||= 'root'
+      @pkg_group
     end
 
     # Add an Omnibus software dependency.
@@ -461,7 +518,7 @@ module Omnibus
     end
 
     # The directory where packages are written when created. Delegates to
-    # #config. The delegation allows Packagers (like Packagers::MacPkg) to
+    # #config. The delegation allows Packagers (like Packager::MacPkg) to
     # define the implementation rather than using the global config everywhere.
     #
     # @return [String] path to the package directory.
@@ -484,25 +541,22 @@ module Omnibus
     # If specific types cannot be determined, default to `["makeself"]`.
     #
     # @return [Array<(String)>]
-    #
-    # @todo Why does this only ever return a single-element array,
-    #   instead of just a string, or symbol?
     def package_types
       case platform_family
       when 'debian'
-        ['deb']
+        %w(deb)
       when 'fedora', 'rhel'
-        ['rpm']
+        %w(rpm)
       when 'aix'
-        ['bff']
+        %w(bff)
       when 'solaris2'
-        ['pkgmk']
+        %w(pkgmk)
       when 'windows'
-        ['msi']
+        %w(msi)
       when 'mac_os_x'
-        ['mac_pkg']
+        %w(mac_pkg mac_dmg)
       else
-        ['makeself']
+        %w(makeself)
       end
     end
 
@@ -561,10 +615,13 @@ module Omnibus
     def render_metadata(pkg_type)
       basename = output_package(pkg_type)
       pkg_path = "#{config.package_dir}/#{basename}"
+
+      # Don't generate metadata for packages that haven't been created.
+      # TODO: Fix this and make it betterer
+      return unless File.exist?(pkg_path)
+
       artifact = Artifact.new(pkg_path, [platform_tuple], version: build_version)
       metadata = artifact.flat_metadata
-      metadata['name'] = name
-      metadata['homepage'] = homepage
       File.open("#{pkg_path}.metadata.json", 'w+') do |f|
         f.print(JSON.pretty_generate(metadata))
       end
@@ -583,7 +640,10 @@ module Omnibus
       when 'pkgmk'
         "#{package_name}-#{build_version}-#{iteration}.solaris"
       when 'mac_pkg'
-        Packagers::MacPkg.new(self).package_name
+        Packager::MacPkg.new(self).package_name
+      when 'mac_dmg'
+        pkg = Packager::MacPkg.new(self)
+        Packager::MacDmg.new(pkg).package_name
       else # fpm
         require "fpm/package/#{pkg_type}"
         pkg = FPM::Package.types[pkg_type].new
@@ -705,12 +765,15 @@ module Omnibus
       end
 
       command_and_opts << " --replaces #{@replaces}" if @replaces
-      command_and_opts << install_path
 
+      # All project files must be appended to the command "last", but before
+      # the final install path
       @extra_package_files.each do |files|
         command_and_opts << files
       end
 
+      # Install path must be the final entry in the command
+      command_and_opts << install_path
       command_and_opts
     end
 
@@ -835,7 +898,7 @@ PSTAMP=#{`hostname`.chomp + Time.now.utc.iso8601}
     end
 
     def run_mac_package_build
-      Packagers::MacPkg.new(self).build
+      Packager::MacPkg.new(self).run!
     end
 
     # Runs the necessary command to make a package with fpm. As a side-effect,
@@ -863,74 +926,5 @@ PSTAMP=#{`hostname`.chomp + Time.now.utc.iso8601}
 
       shellout!(command, cmd_options)
     end
-
-    # Dynamically generate Rake tasks to build projects and all the software they depend on.
-    #
-    # @note Much Rake magic ahead!
-    #
-    # @return void
-    def render_tasks
-      directory config.package_dir
-      directory 'pkg'
-
-      namespace :projects do
-        namespace @name do
-
-          package_types.each do |pkg_type|
-            dep_tasks = @dependencies.map { |dep| "software:#{dep}" }
-            dep_tasks << config.package_dir
-            dep_tasks << 'health_check'
-
-            desc "package #{@name} into a #{pkg_type}"
-            task pkg_type => dep_tasks do
-              if pkg_type == 'makeself'
-                run_makeself
-              elsif pkg_type == 'msi'
-                run_msi
-              elsif pkg_type == 'bff'
-                run_bff
-              elsif pkg_type == 'pkgmk'
-                run_pkgmk
-              elsif pkg_type == 'mac_pkg'
-                run_mac_package_build
-              else # pkg_type == "fpm"
-                run_fpm(pkg_type)
-              end
-
-              render_metadata(pkg_type)
-
-            end
-          end
-
-          task 'copy' => package_types do
-            if OHAI.platform == 'windows'
-              cp_cmd = "xcopy #{config.package_dir}\\*.msi pkg\\ /Y"
-            elsif OHAI.platform == 'aix'
-              cp_cmd = "cp #{config.package_dir}/*.bff pkg/"
-            else
-              cp_cmd = "cp #{config.package_dir}/* pkg/"
-            end
-            shell = Mixlib::ShellOut.new(cp_cmd)
-            shell.run_command
-            shell.error!
-          end
-          task 'copy' => 'pkg'
-
-          desc "run the health check on the #{@name} install path"
-          task 'health_check' do
-            if OHAI.platform == 'windows'
-              puts 'Skipping health check on windows...'
-            else
-              # build a list of all whitelist files from all project dependencies
-              whitelist_files = library.components.map { |component| component.whitelist_files }.flatten
-              Omnibus::HealthCheck.run(install_path, whitelist_files)
-            end
-          end
-        end
-
-        desc "package #{@name}"
-        task @name => "#{@name}:copy"
-      end
-    end
   end
 end