omnibus 3.2.2 → 4.0.0.beta.1

data/lib/omnibus/cleaner.rb

@@ -35,27 +35,25 @@ module Omnibus
 
     def initialize(*)
       super
-
-      @project = Omnibus.project(name)
-      raise ProjectNotFound.new(name) unless @project
+      @project = Project.load(name)
     end
 
     def clean_source_dir
-      Dir.glob("#{Config.source_dir}/**/*").each(&method(:remove_file))
+      FileSyncer.glob("#{Config.source_dir}/**/*").each(&method(:remove_file))
     end
 
     def clean_build_dir
-      Dir.glob("#{Config.build_dir}/**/*").each(&method(:remove_file))
+      FileSyncer.glob("#{Config.build_dir}/**/*").each(&method(:remove_file))
     end
 
     def clean_package_dir
       return unless purge?
-      Dir.glob("#{Config.package_dir}/**/*").each(&method(:remove_file))
+      FileSyncer.glob("#{Config.package_dir}/**/*").each(&method(:remove_file))
     end
 
     def clean_cache_dir
       return unless purge?
-      Dir.glob("#{Config.cache_dir}/**/*").each(&method(:remove_file))
+      FileSyncer.glob("#{Config.cache_dir}/**/*").each(&method(:remove_file))
     end
 
     def clean_install_dir

data/lib/omnibus/cli.rb

@@ -61,12 +61,9 @@ module Omnibus
     #
     #   $ omnibus build chefdk
     #
-    # @todo Support regular expressions (+$ omnibus build chef*+)
-    #
     desc 'build PROJECT', 'Build the given Omnibus project'
     def build(name)
-      project = Omnibus.project(name)
-      raise ProjectNotFound.new(name) unless project
+      project = Project.load(name)
 
       say("Building #{project.name} #{project.build_version}...")
       project.build_me

data/lib/omnibus/cli/base.rb

@@ -46,16 +46,16 @@ module Omnibus
 
       # Do not load the Omnibus config if we are asking for help or the version
       if %w(help version).include?(config[:current_command].name)
-        log.debug { 'Skipping Omnibus loading (detected help or version)' }
+        log.debug(log_key) { 'Skipping Omnibus loading (detected help or version)' }
         return
       end
 
       if File.exist?(@options[:config])
-        log.info { "Using config from '#{@options[:config]}'" }
+        log.info(log_key) { "Using config from '#{@options[:config]}'" }
         Omnibus.load_configuration(@options[:config])
       else
         if @options[:config] == Omnibus::DEFAULT_CONFIG
-          log.debug { 'Config file not given - using defaults' }
+          log.debug(log_key) { 'Config file not given - using defaults' }
         else
           raise "The given config file '#{@options[:config]}' does not exist!"
         end
@@ -63,25 +63,22 @@ module Omnibus
 
       @options[:override].each do |key, value|
         if %w(true false nil).include?(value)
-          log.debug { "Detected #{value.inspect} should be an object" }
+          log.debug(log_key) { "Detected #{value.inspect} should be an object" }
           value = { 'true' => true, 'false' => false, 'nil' => nil }[value]
         end
 
         if value =~ /\A[[:digit:]]+\Z/
-          log.debug { "Detected #{value.inspect} should be an integer" }
+          log.debug(log_key) { "Detected #{value.inspect} should be an integer" }
           value = value.to_i
         end
 
         if Config.respond_to?(key)
-          log.debug { "Setting Config.#{key} = #{value.inspect}" }
+          log.debug(log_key) { "Setting Config.#{key} = #{value.inspect}" }
           Config.send(key, value)
         else
-          log.debug { "Skipping option '#{key}' - not a config option" }
+          log.debug (log_key){ "Skipping option '#{key}' - not a config option" }
         end
       end
-
-      log.debug { 'Processing Omnibus configuration...' }
-      Omnibus.process_configuration
     end
 
     class_option :config,
@@ -93,8 +90,8 @@ module Omnibus
       desc: 'The log level',
       aliases: '-l',
       type: :string,
-      enum: %w(fatal error warn info debug),
-      lazy_default: 'info'
+      enum: Logger::LEVELS.map(&:downcase),
+      default: 'info'
     class_option :override,
       desc: 'Override one or more Omnibus config options',
       aliases: '-o',
@@ -111,7 +108,3 @@ module Omnibus
     end
   end
 end
-
-# Include the deprecations from previous versions of Omnibus. This should be
-# removed in the next major version of Omnibus.
-require_relative 'deprecated'

data/lib/omnibus/compressor.rb

@@ -0,0 +1,60 @@
+#
+# Copyright 2014 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.
+#
+
+module Omnibus
+  module Compressor
+    include Logging
+
+    autoload :Base, 'omnibus/compressors/base'
+    autoload :DMG,  'omnibus/compressors/dmg'
+    autoload :Null, 'omnibus/compressors/null'
+    autoload :TGZ,  'omnibus/compressors/tgz'
+
+    #
+    # Determine the best compressor for the current system. This method returns
+    # the class, not an instance of the class.
+    #
+    # @example
+    #   Compressor.for_current_system([:dmg, :tgz]) #=> Packager::DMG
+    #
+    # @param [Array<Symbol>] compressors
+    #   the list of configured compressors
+    #
+    # @return [~Compressor::Base]
+    #
+    def for_current_system(compressors)
+      family = Ohai['platform_family']
+
+      if family == 'mac_os_x'
+        if compressors.include?(:dmg)
+          return DMG
+        end
+
+        if compressors.include?(:tgz)
+          return TGZ
+        end
+      end
+
+      if compressors.include?(:tgz)
+        return TGZ
+      else
+        log.info(log_key) { "No compressor defined for `#{family}'." }
+        return Null
+      end
+    end
+    module_function :for_current_system
+  end
+end

data/{spec/data/complicated/config/software/version-manifest.rb → lib/omnibus/compressors/base.rb}

@@ -1,6 +1,5 @@
 #
-# Copyright:: Copyright (c) 2012-2014 Chef Software, Inc.
-# License:: Apache License, Version 2.0
+# Copyright 2014 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.
@@ -15,18 +14,24 @@
 # limitations under the License.
 #
 
-name "version-manifest"
-description "generates a version manifest file"
+require 'fileutils'
 
-build do
-  block do
-    project_name = project.name
-    project_build_version = project.build_version
+module Omnibus
+  class Compressor::Base < Packager::Base
+    # The {Project} instance that we are compressing
+    attr_reader :project
 
-    File.open("#{install_dir}/version-manifest.txt", "w") do |f|
-      f.puts "#{project_name} #{project_build_version}"
-      f.puts ""
-      f.puts Omnibus::Reports.pretty_version_map(project)
+    # The {Packager::Base} instance that produced the compressed file
+    attr_reader :packager
+
+    #
+    # Create a new compressor object from the given packager.
+    #
+    # @param [Project] project
+    #
+    def initialize(project)
+      @project  = project
+      @packager = project.packager
     end
   end
 end

data/lib/omnibus/compressors/dmg.rb

@@ -0,0 +1,312 @@
+#
+# Copyright 2014 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.
+#
+
+module Omnibus
+  class Compressor::DMG < Compressor::Base
+    id :dmg
+
+    setup do
+      # Clean any previously mounted disks
+      clean_disks
+
+      # Create the resources directory
+      create_directory(resources_dir)
+
+      # Copy the compiled pkg into the dmg
+      copy_file(packager.package_path, "#{resources_dir}/")
+
+      # Copy support files
+      support = create_directory("#{resources_dir}/.support")
+      copy_file(resource_path('background.png'), "#{support}/background.png")
+    end
+
+    build do
+      create_writable_dmg
+      attach_dmg
+      # Give some time to the system so attached dmg shows up in Finder
+      sleep 5
+      set_volume_icon
+      prettify_dmg
+      compress_dmg
+      set_dmg_icon
+    end
+
+    #
+    # @!group DSL methods
+    # --------------------------------------------------
+
+    #
+    # Set or return the starting x,y and ending x,y positions for the created
+    # DMG window.
+    #
+    # @example
+    #   window_bounds "100, 100, 750, 600"
+    #
+    # @param [String] val
+    #   the DMG window bounds
+    #
+    # @return [String]
+    #   the DMG window bounds
+    #
+    def window_bounds(val = NULL)
+      if null?(val)
+        @window_bounds || '100, 100, 750, 600'
+      else
+        @window_bounds = val
+      end
+    end
+    expose :window_bounds
+
+    #
+    # Set or return the starting x,y position where the .pkg file should live
+    # in the DMG window.
+    #
+    # @example
+    #   pkg_position "535, 50"
+    #
+    # @param [String] val
+    #   the PKG position inside the DMG
+    #
+    # @return [String]
+    #   the PKG position inside the DMG
+    #
+    def pkg_position(val = NULL)
+      if null?(val)
+        @pkg_position || '535, 50'
+      else
+        @pkg_position = val
+      end
+    end
+    expose :pkg_position
+
+    #
+    # @!endgroup
+    # --------------------------------------------------
+
+    #
+    # The path where the MSI resources will live.
+    #
+    # @return [String]
+    #
+    def resources_dir
+      File.expand_path("#{staging_dir}/Resources")
+    end
+
+    #
+    # Cleans any previously left over mounted disks.
+    #
+    # We are trying to detach disks that look like:
+    #
+    #   /dev/disk1s1 on /Volumes/chef (hfs, local, nodev, nosuid, read-only, noowners, quarantine, mounted by serdar)
+    #   /dev/disk2s1 on /Volumes/chef 1 (hfs, local, nodev, nosuid, read-only, noowners, quarantine, mounted by serdar)
+    #
+    # @return [void]
+    #
+    def clean_disks
+      log.info(log_key) { "Cleaning previously mounted disks" }
+
+      existing_disks = shellout!("mount | grep /Volumes/#{volume_name} | awk '{print $1}'")
+      existing_disks.stdout.lines.each do |existing_disk|
+        existing_disk.chomp!
+
+        Omnibus.logger.debug(log_key) do
+          "Detaching disk `#{existing_disk}' before starting dmg packaging."
+        end
+
+        shellout!("hdiutil detach '#{existing_disk}'")
+      end
+    end
+
+    #
+    # Create a writable dmg we can put assets on.
+    #
+    def create_writable_dmg
+      log.info(log_key) { "Creating writable dmg" }
+
+      shellout! <<-EOH.gsub(/^ {8}/, '')
+        hdiutil create \\
+          -srcfolder "#{resources_dir}" \\
+          -volname "#{volume_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.
+    #
+    # @return [String]
+    #   the name of the attached device
+    #
+    def attach_dmg
+      @device ||= Dir.chdir(staging_dir) do
+        log.info(log_key) { "Attaching dmg as disk" }
+
+        cmd = shellout! <<-EOH.gsub(/^ {10}/, '')
+          hdiutil attach \\
+            -readwrite \\
+            -noverify \\
+            -noautoopen \\
+            "#{writable_dmg}" | egrep '^/dev/' | sed 1q | awk '{print $1}'
+        EOH
+
+        cmd.stdout.strip
+      end
+    end
+
+    #
+    # Create the icon for the volume using sips.
+    #
+    # @return [void]
+    #
+    def set_volume_icon
+      log.info(log_key) { "Setting volume icon" }
+
+      icon = resource_path('icon.png')
+
+      Dir.chdir(staging_dir) do
+        shellout! <<-EOH.gsub(/^ {10}/, '')
+          # Generate the icns
+          mkdir tmp.iconset
+          sips -z 16 16     #{icon} --out tmp.iconset/icon_16x16.png
+          sips -z 32 32     #{icon} --out tmp.iconset/icon_16x16@2x.png
+          sips -z 32 32     #{icon} --out tmp.iconset/icon_32x32.png
+          sips -z 64 64     #{icon} --out tmp.iconset/icon_32x32@2x.png
+          sips -z 128 128   #{icon} --out tmp.iconset/icon_128x128.png
+          sips -z 256 256   #{icon} --out tmp.iconset/icon_128x128@2x.png
+          sips -z 256 256   #{icon} --out tmp.iconset/icon_256x256.png
+          sips -z 512 512   #{icon} --out tmp.iconset/icon_256x256@2x.png
+          sips -z 512 512   #{icon} --out tmp.iconset/icon_512x512.png
+          sips -z 1024 1024 #{icon} --out tmp.iconset/icon_512x512@2x.png
+          iconutil -c icns tmp.iconset
+
+          # Copy it over
+          cp tmp.icns "/Volumes/#{volume_name}/.VolumeIcon.icns"
+
+          # Source the icon
+          SetFile -a C "/Volumes/#{volume_name}"
+        EOH
+      end
+    end
+
+    #
+    # Use Applescript to setup the DMG with pretty logos and colors.
+    #
+    # @return [void]
+    #
+    def prettify_dmg
+      log.info(log_key) { "Making the dmg all pretty and stuff" }
+
+      render_template(resource_path('create_dmg.osascript.erb'),
+        destination: "#{staging_dir}/create_dmg.osascript",
+        variables: {
+          volume_name:   volume_name,
+          pkg_name:      packager.package_name,
+          window_bounds: window_bounds,
+          pkg_position:  pkg_position,
+        }
+      )
+
+      Dir.chdir(staging_dir) do
+        shellout! <<-EOH.gsub(/^ {10}/, '')
+          osascript "#{staging_dir}/create_dmg.osascript"
+        EOH
+      end
+    end
+
+    #
+    # Compress the dmg using hdiutil and zlib.
+    #
+    # @return [void]
+    #
+    def compress_dmg
+      log.info(log_key) { "Compressing dmg" }
+
+      Dir.chdir(staging_dir) do
+        shellout! <<-EOH.gsub(/^ {10}/, '')
+          chmod -Rf go-w /Volumes/#{volume_name}
+          sync
+          hdiutil detach "#{@device}"
+          hdiutil convert \\
+            "#{writable_dmg}" \\
+            -format UDZO \\
+            -imagekey \\
+            zlib-level=9 \\
+            -o "#{final_dmg}"
+          rm -rf "#{writable_dmg}"
+        EOH
+      end
+    end
+
+    #
+    # Set the dmg icon to our custom icon.
+    #
+    # @return [void]
+    #
+    def set_dmg_icon
+      log.info(log_key) { "Setting dmg icon" }
+
+      Dir.chdir(staging_dir) do
+        shellout! <<-EOH.gsub(/^ {10}/, '')
+          # Convert the png to an icon
+          sips -i "#{resource_path('icon.png')}"
+
+          # Extract the icon into its own resource
+          DeRez -only icns "#{resource_path('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
+    end
+
+    # @see Base#package_name
+    def package_name
+      "#{project.name}-#{project.build_version}-#{project.build_iteration}.dmg"
+    end
+
+    # The path to the writable dmg on disk.
+    #
+    # @return [String]
+    def writable_dmg
+      File.expand_path("#{staging_dir}/#{project.name}-writable.dmg")
+    end
+
+    # The path where the final dmg will be produced.
+    #
+    # @return [String]
+    def final_dmg
+      dmg_name = packager.package_name.sub('.pkg', '.dmg')
+      File.expand_path("#{Config.package_dir}/#{dmg_name}")
+    end
+
+    #
+    # The name of the volume to create. By defauly, this is the project's
+    # friendly name.
+    #
+    # @return [String]
+    #
+    def volume_name
+      project.friendly_name
+    end
+  end
+end