omnibus 2.0.2 → 3.0.0

data/lib/omnibus/library.rb

@@ -27,7 +27,24 @@ module Omnibus
     end
 
     def component_added(component)
-      @components << component unless @components.include?(component)
+      unless @components.find { |c| c.name == component.name }
+        @components << component
+      end
+    end
+
+    def build_order
+      head = []
+      tail = []
+      @components.each do |component|
+        if head.length == 0
+          head << component
+        elsif @project.dependencies.include?(component.name)
+          tail << component
+        else
+          head << component
+        end
+      end
+      [head, tail].flatten
     end
 
     def version_map

data/lib/omnibus/packagers/base.rb

@@ -0,0 +1,228 @@
+#
+# 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 'fileutils'
+require 'forwardable'
+require 'omnibus/util'
+
+module Omnibus
+  class Packager::Base
+    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 install_path
+    #   @return (see Project#install_path)
+    def_delegator :@project, :install_path, :install_path
+
+    # !@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
+
+    # The commands/steps to setup the file system.
+    def self.setup(&block)
+      if block_given?
+        @setup = block
+      else
+        @setup
+      end
+    end
+
+    # The commands/steps to validate any arguments.
+    def self.validate(&block)
+      if block_given?
+        @validate = block
+      else
+        @validate
+      end
+    end
+
+    # The commands/steps to build the package.
+    def self.build(&block)
+      if block_given?
+        @build = block
+      else
+        @build || fail(AbstractMethod.new("#{self.class.name}.build"))
+      end
+    end
+
+    # The commands/steps to cleanup any temporary files/directories.
+    def self.clean(&block)
+      if block_given?
+        @clean = block
+      else
+        @clean
+      end
+    end
+
+    # Create a new packager object.
+    #
+    # @param [Project] project
+    def initialize(project)
+      @project = project
+    end
+
+    #
+    # Generation methods
+    # ------------------------------
+
+    # Create a directory at the given +path+.
+    #
+    # @param [String] path
+    def create_directory(path)
+      FileUtils.mkdir_p(path)
+      path
+    end
+
+    # Remove the directory at the given +path+.
+    #
+    # @param [String] path
+    def remove_directory(path)
+      FileUtils.rm_rf(path)
+    end
+
+    # Purge the directory of all contents.
+    #
+    # @param [String] path
+    def purge_directory(path)
+      remove_directory(path)
+      create_directory(path)
+    end
+
+    # Copy the +source+ file to the +destination+.
+    #
+    # @param [String] source
+    # @param [String] destination
+    def copy_file(source, destination)
+      FileUtils.cp(source, destination)
+      destination
+    end
+
+    # Remove the file at the given path.
+    #
+    # @param [String] pah
+    def remove_file(path)
+      FileUtils.rm_f(path)
+    end
+
+    # Execute the command using shellout!
+    #
+    # @param [String] command
+    def execute(command)
+      shellout!(command,  timeout: 3600, cwd: staging_dir)
+    end
+
+    #
+    # Validations
+    # ------------------------------
+
+    # Validate the presence of a file.
+    #
+    # @param [String] path
+    def assert_presence!(path)
+      fail MissingAsset.new(path) unless File.exist?(path)
+    end
+
+    # Execute this packager by running the following phases in order:
+    #
+    #   - setup
+    #   - validate
+    #   - build
+    #   - clean
+    #
+    def run!
+      instance_eval(&self.class.validate) if self.class.validate
+      instance_eval(&self.class.setup)    if self.class.setup
+      instance_eval(&self.class.build)    if self.class.build
+      instance_eval(&self.class.clean)    if self.class.clean
+    end
+
+    # The ending name of this package on disk. +Omnibus::Project+ uses this to
+    # generate metadata about the package after it is built.
+    #
+    # @return [String]
+    def package_name
+      fail AbstractMethod.new("#{self.class.name}#package_name")
+    end
+
+    private
+
+    # The path to the directory where we can throw staged files.
+    #
+    # @return [String]
+    def staging_dir
+      File.expand_path("#{project.package_tmp}/#{underscore_name}")
+    end
+
+    # The path to a local resource on disk.
+    #
+    # @param [String]
+    #   the name or path of the resource
+    # @return [String]
+    def resource(path)
+      File.expand_path("#{resources_path}/#{path}")
+    end
+
+    # The path to all the resources on the local file system.
+    #
+    # @return [String]
+    def resources_path
+      File.expand_path("#{project.files_path}/#{underscore_name}/Resources")
+    end
+
+    # The underscored equivalent of this class. This is mostly used by file
+    # paths.
+    #
+    # @return [String]
+    def underscore_name
+      @underscore_name ||= self.class.name
+        .split('::')
+        .last
+        .gsub(/([A-Z]+)([A-Z][a-z])/, '\1_\2')
+        .gsub(/([a-z\d])([A-Z])/, '\1_\2')
+        .tr('-', '_')
+        .downcase
+    end
+  end
+end

data/lib/omnibus/packagers/mac_dmg.rb

@@ -0,0 +1,215 @@
+#
+# 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.
+#
+
+module Omnibus
+  class Packager::MacDmg < Packager::Base
+    attr_reader :packager
+
+    validate do
+      assert_presence!(resource('background.png'))
+      assert_presence!(resource('icon.png'))
+    end
+
+    setup do
+      create_directory(dmg_stage)
+      copy_assets_to_dmg
+    end
+
+    build do
+      copy_assets_to_dmg
+      create_writable_dmg
+      attach_dmg
+      set_volume_icon
+      prettify_dmg
+      compress_dmg
+      set_dmg_icon
+    end
+
+    clean do
+      remove_file("#{staging_dir}/tmp.icns")
+      remove_file("#{staging_dir}/tmp.rsrc")
+    end
+
+    #
+    # Create a new DMG packager.
+    #
+    # @param [Packager::MacPkg] mac_packager
+    #
+    def initialize(mac_packager)
+      @packager = mac_packager
+      super(mac_packager.project)
+    end
+
+    #
+    # Copy the assets in the local omnibus project into a staging folder that
+    # will soon become our writable dmg.
+    #
+    def copy_assets_to_dmg
+      # Copy the compiled pkg into the dmg
+      copy_file(packager.final_pkg, "#{dmg_stage}/#{project.name}.pkg")
+
+      # Copy support files
+      support = create_directory("#{dmg_stage}/.support")
+      copy_file(resource('background.png'), "#{support}/background.png")
+    end
+
+    #
+    # Create a writable dmg we can put assets on.
+    #
+    def create_writable_dmg
+      execute <<-EOH.gsub(/^ {8}/, '')
+        hdiutil create \\
+          -srcfolder "#{dmg_stage}" \\
+          -volname "#{project.name}" \\
+          -fs HFS+ \\
+          -fsargs "-c c=64,a=16,e=16" \\
+          -format UDRW \\
+          -size 512000k \\
+          "#{writable_dmg}"
+      EOH
+    end
+
+    #
+    # Attach the dmg, storing a reference to the device for later use.
+    #
+    def attach_dmg
+      @device = execute(<<-EOH.gsub(/^ {8}/, '')).stdout.strip
+        hdiutil attach \\
+          -readwrite \\
+          -noverify \\
+          -noautoopen \\
+          "#{writable_dmg}" | egrep '^/dev/' | sed 1q | awk '{print $1}'
+      EOH
+    end
+
+    #
+    # Create the icon for the volume using sips.
+    #
+    def set_volume_icon
+      execute <<-EOH.gsub(/^ {8}/, '')
+        # Generate the icns
+        mkdir tmp.iconset
+        sips -z 16 16     #{resource('icon.png')} --out tmp.iconset/icon_16x16.png
+        sips -z 32 32     #{resource('icon.png')} --out tmp.iconset/icon_16x16@2x.png
+        sips -z 32 32     #{resource('icon.png')} --out tmp.iconset/icon_32x32.png
+        sips -z 64 64     #{resource('icon.png')} --out tmp.iconset/icon_32x32@2x.png
+        sips -z 128 128   #{resource('icon.png')} --out tmp.iconset/icon_128x128.png
+        sips -z 256 256   #{resource('icon.png')} --out tmp.iconset/icon_128x128@2x.png
+        sips -z 256 256   #{resource('icon.png')} --out tmp.iconset/icon_256x256.png
+        sips -z 512 512   #{resource('icon.png')} --out tmp.iconset/icon_256x256@2x.png
+        sips -z 512 512   #{resource('icon.png')} --out tmp.iconset/icon_512x512.png
+        sips -z 1024 1024 #{resource('icon.png')} --out tmp.iconset/icon_512x512@2x.png
+        iconutil -c icns tmp.iconset
+
+        # Copy it over
+        cp tmp.icns "/Volumes/#{project.name}/.VolumeIcon.icns"
+
+        # Source the icon
+        SetFile -a C "/Volumes/#{project.name}"
+      EOH
+    end
+
+    #
+    # Use Applescript to setup the DMG with pretty logos and colors.
+    #
+    def prettify_dmg
+      execute <<-EOH.gsub(/ ^{8}/, '')
+        echo '
+           tell application "Finder"
+             tell disk "'#{project.name}'"
+               open
+               set current view of container window to icon view
+               set toolbar visible of container window to false
+               set statusbar visible of container window to false
+               set the bounds of container window to {#{project.config[:dmg_window_bounds]}}
+               set theViewOptions to the icon view options of container window
+               set arrangement of theViewOptions to not arranged
+               set icon size of theViewOptions to 72
+               set background picture of theViewOptions to file ".support:'background.png'"
+               delay 5
+               set position of item "'#{project.name}.pkg'" of container window to {#{project.config[:dmg_pkg_position]}}
+               update without registering applications
+               delay 5
+             end tell
+           end tell
+        ' | osascript
+      EOH
+    end
+
+    #
+    # Compress the dmg using hdiutil and zlib.
+    #
+    def compress_dmg
+      execute <<-EOH.gsub(/ ^{8}/, '')
+        chmod -Rf go-w /Volumes/#{project.name}
+        sync
+        hdiutil detach "#{@device}"
+        hdiutil convert \\
+          "#{writable_dmg}" \\
+          -format UDZO \\
+          -imagekey zlib-level=9 \\
+          -o "#{final_dmg}"
+        rm -rf "#{writable_dmg}"
+      EOH
+    end
+
+    #
+    # Set the dmg icon to our custom icon.
+    #
+    def set_dmg_icon
+      execute <<-EOH.gsub(/^ {8}/, '')
+        # Convert the png to an icon
+        sips -i "#{resource('icon.png')}"
+
+        # Extract the icon into its own resource
+        DeRez -only icns "#{resource('icon.png')}" > tmp.rsrc
+
+        # Append the icon reosurce to the DMG
+        Rez -append tmp.rsrc -o "#{final_dmg}"
+
+        # Source the icon
+        SetFile -a C "#{final_dmg}"
+      EOH
+    end
+
+    # @see Base#package_name
+    def package_name
+      "#{name}-#{version}-#{iteration}.dmg"
+    end
+
+    # The path to the folder that we should stage.
+    #
+    # @return [String]
+    def dmg_stage
+      File.expand_path("#{staging_dir}/dmg")
+    end
+
+    # The path to the writable dmg on disk.
+    #
+    # @return [String]
+    def writable_dmg
+      File.expand_path("#{staging_dir}/#{name}-writable.dmg")
+    end
+
+    # The path where the final dmg will be produced.
+    #
+    # @return [String]
+    def final_dmg
+      File.expand_path("#{project.package_dir}/#{name}-#{version}-#{iteration}.dmg")
+    end
+  end
+end