omnibus 3.2.2 → 4.0.0.beta.1

data/lib/omnibus/fetchers/path_fetcher.rb

@@ -14,54 +14,96 @@
 # limitations under the License.
 #
 
+require 'fileutils'
+
 module Omnibus
-  # Fetcher implementation for projects on the filesystem
   class PathFetcher < Fetcher
-
-    include Digestable
-
-    def initialize(software)
-      @name = software.name
-      @source = software.source
-      @project_dir = software.project_dir
-      @version = software.version
-      super
+    #
+    # Fetch if the local directory checksum is different than the path directory
+    # checksum.
+    #
+    # @return [true, false]
+    #
+    def fetch_required?
+      target_shasum != destination_shasum
     end
 
-    def description
-      <<-EOH.gsub(/^ {8}/, '').strip
-        source path:    #{@source[:path]}
-        local location: #{@project_dir}
-      EOH
+    #
+    # The version identifier for this path. This is computed using the path
+    # on disk to the source and the recursive shasum of that path on disk.
+    #
+    # @return [String]
+    #
+    def version_guid
+      "path:#{source_path}"
     end
 
-    def rsync
-      if Ohai['platform'] == 'windows'
-        # Robocopy's return code is 1 if it succesfully copies over the
-        # files and 0 if the files are already existing at the destination
-        sync_cmd = "robocopy #{@source[:path]}\\ #{@project_dir}\\ /MIR /S"
-        shellout!(sync_cmd, returns: [0, 1])
+    #
+    # Clean the given path by removing the project directory.
+    #
+    # @return [true, false]
+    #   true if the directory was cleaned, false otherwise
+    #
+    def clean
+      if File.exist?(project_dir)
+        log.info(log_key) { "Cleaning project directory `#{project_dir}'" }
+        FileUtils.rm_rf(project_dir)
+        fetch
+        true
       else
-        sync_cmd = "rsync --delete -a #{@source[:path]}/ #{@project_dir}/"
-        shellout!(sync_cmd)
+        false
       end
     end
 
-    def clean
-      # Here, clean will do the same as fetch: reset source to pristine state
-      rsync
-    end
-
+    #
+    # Fetch any new files by copying them to the +project_dir+.
+    #
+    # @return [void]
+    #
     def fetch
-      rsync
+      log.info(log_key) { "Copying from `#{source_path}'" }
+
+      create_required_directories
+      FileSyncer.sync(source_path, project_dir)
     end
 
+    #
+    # The version for this item in the cache. The is the shasum of the directory
+    # on disk.
+    #
+    # @return [String]
+    #
     def version_for_cache
-      @version_for_cache ||= digest_directory(@project_dir, :sha256)
+      "path:#{source_path}|shasum:#{target_shasum}"
     end
 
-    def fetch_required?
-      true
+    private
+
+    #
+    # The path on disk to pull the files from.
+    #
+    # @return [String]
+    #
+    def source_path
+      source[:path]
+    end
+
+    #
+    # The shasum of the directory **inside** the project.
+    #
+    # @return [String]
+    #
+    def target_shasum
+      @target_shasum ||= digest_directory(project_dir, :sha256)
+    end
+
+    #
+    # The shasum of the directory **outside** of the project.
+    #
+    # @return [String]
+    #
+    def destination_shasum
+      @destination_shasum ||= digest_directory(source_path, :sha256)
     end
   end
 end

data/lib/omnibus/file_syncer.rb

@@ -0,0 +1,149 @@
+#
+# 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.
+#
+
+require 'fileutils'
+
+module Omnibus
+  module FileSyncer
+    extend self
+
+    # Files to be ignored during a directory globbing
+    IGNORED_FILES = %w(. ..).freeze
+
+    #
+    # Glob across the given pattern, accounting for dotfiles, removing Ruby's
+    # dumb idea to include +'.'+ and +'..'+ as entries.
+    #
+    # @param [String] pattern
+    #   the path or glob pattern to get all files from
+    #
+    # @return [Array<String>]
+    #   the list of all files
+    #
+    def glob(pattern)
+      Dir.glob(pattern, File::FNM_DOTMATCH).sort.reject do |file|
+        basename = File.basename(file)
+        IGNORED_FILES.include?(basename)
+      end
+    end
+
+    #
+    # Copy the files from +source+ to +destination+, while removing any files
+    # in +destination+ that are not present in +source+.
+    #
+    # The method accepts an optional +:exclude+ parameter to ignore files and
+    # folders that match the given pattern(s). Note the exclude pattern behaves
+    # on paths relative to the given source. If you want to exclude a nested
+    # directory, you will need to use something like +**/directory+.
+    #
+    # @raise ArgumentError
+    #   if the +source+ parameter is not a directory
+    #
+    # @param [String] source
+    #   the path on disk to sync from
+    # @param [String] destination
+    #   the path on disk to sync to
+    #
+    # @option options [String, Array<String>] :exclude
+    #   a file, folder, or globbing pattern of files to ignore when syncing
+    #
+    # @return [true]
+    #
+    def sync(source, destination, options = {})
+      unless File.directory?(source)
+        raise ArgumentError, "`source' must be a directory, but was a " \
+          "`#{File.ftype(source)}'! If you just want to sync a file, use " \
+          "the `copy' method instead."
+      end
+
+      # Reject any files that match the excludes pattern
+      excludes = Array(options[:exclude]).map do |exclude|
+        [exclude, "#{exclude}/*"]
+      end.flatten
+
+      source_files = glob(File.join(source, '**/*'))
+      source_files = source_files.reject do |source_file|
+        basename = relative_path_for(source_file, source)
+        excludes.any? { |exclude| File.fnmatch?(exclude, basename, File::FNM_DOTMATCH) }
+      end
+
+      # Ensure the destination directory exists
+      FileUtils.mkdir_p(destination) unless File.directory?(destination)
+
+      # Copy over the filtered source files
+      source_files.each do |source_file|
+        relative_path = relative_path_for(source_file, source)
+
+        # Create the parent directory
+        parent = File.join(destination, File.dirname(relative_path))
+        FileUtils.mkdir_p(parent) unless File.directory?(parent)
+
+        case File.ftype(source_file).to_sym
+        when :directory
+          FileUtils.mkdir_p("#{destination}/#{relative_path}")
+        when :link
+          target = File.readlink(source_file)
+
+          Dir.chdir(destination) do
+            FileUtils.ln_sf(target, "#{destination}/#{relative_path}")
+          end
+        when :file
+          FileUtils.cp(source_file, "#{destination}/#{relative_path}")
+        else
+          raise RuntimeError,
+            "Unknown file type: `File.ftype(source_file)' at `#{source_file}'!"
+        end
+      end
+
+      # Remove any files in the destination that are not in the source files
+      destination_files = glob("#{destination}/**/*")
+
+      # Calculate the relative paths of files so we can compare to the
+      # source.
+      relative_source_files = source_files.map do |file|
+        relative_path_for(file, source)
+      end
+      relative_destination_files = destination_files.map do |file|
+        relative_path_for(file, destination)
+      end
+
+      # Remove any extra files that are present in the destination, but are
+      # not in the source list
+      extra_files = relative_destination_files - relative_source_files
+      extra_files.each do |file|
+        FileUtils.rm_rf(File.join(destination, file))
+      end
+
+      true
+    end
+
+    private
+
+    #
+    # The relative path of the given +path+ to the +parent+.
+    #
+    # @param [String] path
+    #   the path to get relative with
+    # @param [String] parent
+    #   the parent where the path is contained (hopefully)
+    #
+    # @return [String]
+    #
+    def relative_path_for(path, parent)
+      Pathname.new(path).relative_path_from(Pathname.new(parent)).to_s
+    end
+  end
+end

data/lib/omnibus/generator.rb

@@ -35,10 +35,43 @@ module Omnibus
       type: :string,
       default: '.'
 
+    class_option :bff_assets,
+      desc: 'Generate AIX bff assets',
+      type: :boolean,
+      default: false
+
+    class_option :deb_assets,
+      desc: 'Generate Debian deb assets',
+      type: :boolean,
+      default: false
+
+    class_option :dmg_assets,
+      desc: 'Generate Mac OS X dmg assets',
+      type: :boolean,
+      default: false
+
+    class_option :makeself_assets,
+      desc: 'Generate makeself assets',
+      type: :boolean,
+      default: false
+
+    class_option :msi_assets,
+      desc: 'Generate Windows MSI assets',
+      type: :boolean,
+      default: false
+
+    class_option :pkg_assets,
+      desc: 'Generate Mac OS X pkg assets',
+      type: :boolean,
+      default: false
+
+    class_option :rpm_assets,
+      desc: 'Generate RHEL/CentOS rpm assets',
+      type: :boolean,
+      default: false
+
     class << self
-      #
-      # Set the source root for Thor.
-      #
+      # Set the source root for Thor
       def source_root
         File.expand_path('../generator_files', __FILE__)
       end
@@ -52,13 +85,11 @@ module Omnibus
     end
 
     def create_project_definition
-      template('project.rb.erb', "#{target}/config/projects/#{name}.rb", template_options)
+      template('config/projects/project.rb.erb', "#{target}/config/projects/#{name}.rb", template_options)
     end
 
     def create_example_software_definitions
-      template('software/c-example.rb.erb', "#{target}/config/software/c-example.rb", template_options)
-      template('software/erlang-example.rb.erb', "#{target}/config/software/erlang-example.rb", template_options)
-      template('software/ruby-example.rb.erb', "#{target}/config/software/ruby-example.rb", template_options)
+      template('config/software/zlib.rb.erb', "#{target}/config/software/#{name}-zlib.rb", template_options)
     end
 
     def create_kitchen_files
@@ -68,43 +99,74 @@ module Omnibus
     end
 
     def create_package_scripts
-      %w(makeselfinst preinst prerm postinst postrm).each do |package_script|
+      %w(preinst prerm postinst postrm).each do |package_script|
         script_path = "#{target}/package-scripts/#{name}/#{package_script}"
         template("package_scripts/#{package_script}.erb", script_path, template_options)
 
-        # #nsure the package script is executable
+        # Ensure the package script is executable
         chmod(script_path, 0755)
       end
     end
 
-    def create_pkg_assets
-      template('mac_pkg/license.html.erb', "#{target}/files/mac_pkg/Resources/license.html", template_options)
-      template('mac_pkg/welcome.html.erb', "#{target}/files/mac_pkg/Resources/welcome.html", template_options)
-      copy_file('mac_pkg/background.png', "#{target}/files/mac_pkg/Resources/background.png")
+    def create_bff_assets
+      return unless options[:bff_assets]
+
+      copy_file(resource_path('bff/gen.template.erb'), "#{target}/resources/bff/gen.template.erb")
+      copy_file(resource_path('bff/postinstall.sh'), "#{target}/resources/bff/postinstall.sh")
+      copy_file(resource_path('bff/unpostinstall.sh'), "#{target}/resources/bff/unpostinstall.sh")
+    end
+
+    def create_deb_assets
+      return unless options[:deb_assets]
+
+      copy_file(resource_path('deb/conffiles.erb'), "#{target}/resources/deb/conffiles.erb")
+      copy_file(resource_path('deb/control.erb'), "#{target}/resources/deb/control.erb")
+      copy_file(resource_path('deb/md5sums.erb'), "#{target}/resources/deb/md5sums.erb")
     end
 
     def create_dmg_assets
-      copy_file('mac_dmg/background.png', "#{target}/files/mac_dmg/Resources/background.png")
-      copy_file('mac_dmg/icon.png', "#{target}/files/mac_dmg/Resources/icon.png")
+      return unless options[:dmg_assets]
+
+      copy_file(resource_path('dmg/background.png'), "#{target}/resources/dmg/background.png")
+      copy_file(resource_path('dmg/icon.png'), "#{target}/resources/dmg/icon.png")
+    end
+
+    def create_makeself_assets
+      return unless options[:makeself_assets]
+
+      copy_file(resource_path('makeself/post_extract.sh.erb'), "#{target}/resources/makeself/post_extract.sh.erb")
     end
 
-    def create_windows_assets
-      # These ERB files are actually rendered as ERB files on the target system
-      # because the parameters are resolved at the build time for localization
-      # and parameters files.
-      copy_file('windows_msi/localization-en-us.wxl.erb', "#{target}/files/windows_msi/Resources/localization-en-us.wxl.erb")
-      copy_file('windows_msi/parameters.wxi.erb', "#{target}/files/windows_msi/Resources/parameters.wxi.erb")
+    def create_msi_assets
+      return unless options[:msi_assets]
 
-      template('windows_msi/source.wxs.erb', "#{target}/files/windows_msi/Resources/source.wxs", template_options)
+      copy_file(resource_path('msi/localization-en-us.wxl.erb'), "#{target}/resources/msi/localization-en-us.wxl.erb")
+      copy_file(resource_path('msi/parameters.wxi.erb'), "#{target}/resources/msi/parameters.wxi.erb")
+      copy_file(resource_path('msi/source.wxs.erb'), "#{target}/resources/msi/source.wxs.erb")
 
-      copy_file('windows_msi/assets/LICENSE.rtf', "#{target}/files/windows_msi/Resources/assets/LICENSE.rtf")
-      copy_file('windows_msi/assets/banner_background.bmp', "#{target}/files/windows_msi/Resources/assets/banner_background.bmp")
-      copy_file('windows_msi/assets/dialog_background.bmp', "#{target}/files/windows_msi/Resources/assets/dialog_background.bmp")
-      copy_file('windows_msi/assets/project.ico', "#{target}/files/windows_msi/Resources/assets/project.ico")
-      copy_file('windows_msi/assets/project_16x16.ico', "#{target}/files/windows_msi/Resources/assets/project_16x16.ico")
-      copy_file('windows_msi/assets/project_32x32.ico', "#{target}/files/windows_msi/Resources/assets/project_32x32.ico")
+      copy_file(resource_path('msi/assets/LICENSE.rtf'), "#{target}/resources/msi/assets/LICENSE.rtf")
+      copy_file(resource_path('msi/assets/banner_background.bmp'), "#{target}/resources/msi/assets/banner_background.bmp")
+      copy_file(resource_path('msi/assets/dialog_background.bmp'), "#{target}/resources/msi/assets/dialog_background.bmp")
+      copy_file(resource_path('msi/assets/project.ico'), "#{target}/resources/msi/assets/project.ico")
+      copy_file(resource_path('msi/assets/project_16x16.ico'), "#{target}/resources/msi/assets/project_16x16.ico")
+      copy_file(resource_path('msi/assets/project_32x32.ico'), "#{target}/resources/msi/assets/project_32x32.ico")
     end
 
+    def create_pkg_assets
+      return unless options[:pkg_assets]
+
+      copy_file(resource_path('pkg/background.png'), "#{target}/resources/pkg/background.png")
+      copy_file(resource_path('pkg/license.html.erb'), "#{target}/resources/pkg/license.html.erb")
+      copy_file(resource_path('pkg/welcome.html.erb'), "#{target}/resources/pkg/welcome.html.erb")
+    end
+
+    def create_rpm_assets
+      return unless options[:rpm_assets]
+
+      copy_file(resource_path('rpm/rpmmacros.erb'), "#{target}/resources/rpm/rpmmacros.erb")
+      copy_file(resource_path('rpm/signing.erb'), "#{target}/resources/rpm/signing.erb")
+      copy_file(resource_path('rpm/spec.erb'), "#{target}/resources/rpm/spec.erb")
+    end
     private
 
     #
@@ -122,10 +184,19 @@ module Omnibus
     # @return [Hash]
     #
     def template_options
-      @template_options ||= {
-        name: name,
-        install_dir: "/opt/#{name}",
-      }
+      @template_options ||= { name: name }
+    end
+
+    #
+    # The path to a vendored resource within Omnibus.
+    #
+    # @param [String, Array<String>] args
+    #   the sub-path to get
+    #
+    # @return [String]
+    #
+    def resource_path(*args)
+      Omnibus.source_root.join('resources', *args).to_s
     end
   end
 end