omnibus 1.3.0 → 2.0.0.rc1

data/lib/omnibus/library.rb

@@ -1,5 +1,5 @@
 #
-# Copyright:: Copyright (c) 2012 Opscode, Inc.
+# Copyright:: Copyright (c) 2012-2014 Chef Software, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -19,7 +19,6 @@ module Omnibus
   #
   # Used to generate the manifest of all software components with versions
   class Library
-
     attr_reader :components
 
     def initialize(project)
@@ -32,31 +31,31 @@ module Omnibus
     end
 
     def version_map
-      @components.inject({}) {|map, component|
-        map[component.name] = if component.given_version
-                                {:version       => component.version,
-                                 :given_version => component.given_version,
-                                 :overridden    => component.overridden?,
-                                 :version_guid  => component.version_guid}
+      @components.reduce({}) do |map, component|
+        map[component.name] = if component.default_version
+                                {
+                                  version: component.version,
+                                  default_version: component.default_version,
+                                  overridden: component.overridden?,
+                                  version_guid: component.version_guid,
+                                }
                               else
                                 ## Components without a version are
                                 ## pieces of the omnibus project
                                 ## itself, and so don't really fit
                                 ## with the concept of overrides
-                                v = {:version => @project.build_version}
+                                v = { version: @project.build_version }
                                 if @project.build_version.respond_to?(:git_sha)
                                   v[:version_guid] = "git:#{@project.build_version.git_sha}"
                                 end
                                 v
                               end
         map
-      }
+      end
     end
 
     def select(*args, &block)
       @components.select(*args, &block)
     end
   end
-
 end
-

data/lib/omnibus/overrides.rb

@@ -2,8 +2,7 @@ require 'pp'
 
 module Omnibus
   module Overrides
-
-    DEFAULT_OVERRIDE_FILE_NAME = "omnibus.overrides"
+    DEFAULT_OVERRIDE_FILE_NAME = 'omnibus.overrides'
 
     # Parses a file of override information into a Hash.
     #
@@ -18,17 +17,17 @@ module Omnibus
     # @return [Hash, nil]
     def self.parse_file(file)
       if file
-        File.readlines(file).inject({}) do |acc, line|
+        File.readlines(file).reduce({}) do |acc, line|
           info = line.split
 
           unless info.count == 2
-            raise ArgumentError, "Invalid overrides line: '#{line.chomp}'"
+            fail ArgumentError, "Invalid overrides line: '#{line.chomp}'"
           end
 
           package, version = info
 
           if acc[package]
-            raise ArgumentError, "Multiple overrides present for '#{package}' in overrides file #{file}!"
+            fail ArgumentError, "Multiple overrides present for '#{package}' in overrides file #{file}!"
           end
 
           acc[package] = version
@@ -56,14 +55,13 @@ module Omnibus
       overrides = parse_file(file)
 
       if overrides
-        puts "********************************************************************************"
+        puts '********************************************************************************'
         puts "Using Overrides from #{Omnibus::Overrides.resolve_override_file}"
         pp overrides
-        puts "********************************************************************************"
+        puts '********************************************************************************'
       end
 
       overrides || {}
     end
-
   end
 end

data/lib/omnibus/package_release.rb

@@ -1,5 +1,5 @@
 #
-# Copyright:: Copyright (c) 2012 Opscode, Inc.
+# Copyright:: Copyright (c) 2012-2014 Chef Software, Inc.
 # License:: Apache License, Version 2.0
 #
 # Licensed under the Apache License, Version 2.0 (the "License");
@@ -26,7 +26,6 @@ require 'uber-s3'
 
 module Omnibus
   class PackageRelease
-
     attr_reader :package_path
     attr_reader :access_policy
 
@@ -36,16 +35,16 @@ module Omnibus
     # @yield callback triggered by successful upload. Allows users of this
     #   class to add UI feedback.
     # @yieldparam s3_object_key [String] the S3 key of the uploaded object.
-    def initialize(package_path, opts={:access=>:private}, &block)
+    def initialize(package_path, opts = { access: :private }, &block)
       @package_path = package_path
       @metadata = nil
       @s3_client = nil
 
       @after_upload = if block_given?
-        block
-      else
-        lambda { |item_key| nil }
-      end
+                        block
+                      else
+                        ->(item_key) { nil }
+                      end
 
       # sets @access_policy
       handle_opts(opts)
@@ -62,9 +61,9 @@ module Omnibus
     def release
       validate_config!
       validate_package!
-      s3_client.store(metadata_key, metadata_json, :access => access_policy)
+      s3_client.store(metadata_key, metadata_json, access: access_policy)
       uploaded(metadata_key)
-      s3_client.store(package_key, package_content, :access => access_policy, :content_md5 => md5)
+      s3_client.store(package_key, package_content, access: access_policy, content_md5: md5)
       uploaded(package_key)
     end
 
@@ -81,11 +80,11 @@ module Omnibus
     end
 
     def platform_path
-      File.join(metadata["platform"], metadata["platform_version"], metadata["arch"])
+      File.join(metadata['platform'], metadata['platform_version'], metadata['arch'])
     end
 
     def md5
-      metadata["md5"]
+      metadata['md5']
     end
 
     def metadata
@@ -106,9 +105,9 @@ module Omnibus
 
     def validate_package!
       if !File.exist?(package_path)
-        raise NoPackageFile.new(package_path)
+        fail NoPackageFile.new(package_path)
       elsif !File.exist?(package_metadata_path)
-        raise NoPackageMetadataFile.new(package_metadata_path)
+        fail NoPackageMetadataFile.new(package_metadata_path)
       else
         true
       end
@@ -119,16 +118,16 @@ module Omnibus
         true
       else
         err = InvalidS3ReleaseConfiguration.new(s3_bucket, s3_access_key, s3_secret_key)
-        raise err
+        fail err
       end
     end
 
     def s3_client
       @s3_client ||= UberS3.new(
-        :access_key => s3_access_key,
-        :secret_access_key => s3_secret_key,
-        :bucket => s3_bucket,
-        :adaper => :net_http
+        access_key: s3_access_key,
+        secret_access_key: s3_secret_key,
+        bucket: s3_bucket,
+        adaper: :net_http,
       )
     end
 
@@ -151,13 +150,12 @@ module Omnibus
     def handle_opts(opts)
       access_policy = opts[:access]
       if access_policy.nil?
-        raise ArgumentError, "options to #{self.class} must specify `:access' (given: #{opts.inspect})"
-      elsif not [:private, :public_read].include?(access_policy)
-        raise ArgumentError, "option `:access' must be one of `[:private, :public_read]' (given: #{access_policy.inspect})"
+        fail ArgumentError, "options to #{self.class} must specify `:access' (given: #{opts.inspect})"
+      elsif ![:private, :public_read].include?(access_policy)
+        fail ArgumentError, "option `:access' must be one of `[:private, :public_read]' (given: #{access_policy.inspect})"
       else
         @access_policy = access_policy
       end
     end
-
   end
 end

data/lib/omnibus/packagers/mac_pkg.rb

@@ -0,0 +1,285 @@
+#
+# Copyright:: Copyright (c) 2014 Chef Software, Inc.
+# License:: Apache License, Version 2.0
+#
+# 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 '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 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}.pkg"
+      end
+
+      def identifier
+        project.mac_pkg_identifier ||
+          "test.#{sanitized_maintainer}.pkg.#{sanitized_name}"
+      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
+
+      # 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
+
+      # @return [String] Filesystem path where the Distribution file is written.
+      def distribution_staging_path
+        File.join(staging_dir, 'Distribution')
+      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
+
+      # 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
+
+      # 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
+
+      def sanitized_name
+        name.gsub(/[^[:alnum:]]/, '').downcase
+      end
+
+      def sanitized_maintainer
+        project.maintainer.gsub(/[^[:alnum:]]/, '').downcase
+      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
+
+      # @return [String] path to the license file
+      def license_file_path
+        File.join(mac_pkg_files_path, 'license.html')
+      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
+
+      # 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
+
+      def shellout_opts
+        {
+          timeout: 3600,
+          cwd: staging_dir,
+        }
+      end
+    end
+  end
+end