omnibus 3.2.2 → 4.0.0.beta.1

data/lib/omnibus/ohai.rb

@@ -16,27 +16,6 @@
 
 require 'ohai'
 
-class Mash
-  #
-  # @todo Remove in the next major release
-  #
-  # Ohai 7 removed the ability to access Ohai attributes via dot notation. This
-  # temporary monkey patch provides the ability for users to still use the old
-  # dot notation, while printing out a deprecation error.
-  #
-  def method_missing(m, *args, &block)
-    if key?(m)
-      Omnibus.logger.deprecated('Ohai') do
-        "Ohai.#{m}. Please use Ohai['#{m}'] instead."
-      end
-
-      fetch(m)
-    else
-      super
-    end
-  end
-end
-
 module Omnibus
   class Ohai
     PLUGINS = [
@@ -59,33 +38,3 @@ module Omnibus
     end
   end
 end
-
-module Omnibus
-  class OhaiWithWarning < Ohai
-    include Logging
-
-    class << self
-      def method_missing(m, *args, &block)
-        bad_boy = caller[2]
-
-        unless warned[bad_boy]
-          log.deprecated('OHAI') do
-            "OHAI constant. Please use Ohai instead: #{bad_boy}"
-          end
-          warned[bad_boy] = true
-        end
-
-        Ohai.send(m, *args, &block)
-      end
-
-      def warned
-        @warned ||= {}
-      end
-    end
-  end
-end
-
-#
-# @todo remove in the next major release
-#
-OHAI = Omnibus::OhaiWithWarning

data/lib/omnibus/package.rb

@@ -18,235 +18,11 @@ require 'json'
 
 module Omnibus
   class Package
-    class Metadata
-      class << self
-        #
-        # Generate a +metadata.json+ from the given package and data hash.
-        #
-        # @param [Package] package
-        #   the package for this metadata
-        # @param [Hash] data
-        #   the hash of attributes to set in the metadata
-        #
-        # @return [String]
-        #   the path where the metadata was saved on disk
-        #
-        def generate(package, data = {})
-          data = {
-            basename:         package.name,
-            md5:              package.md5,
-            sha1:             package.sha1,
-            sha256:           package.sha256,
-            sha512:           package.sha512,
-            platform:         platform_shortname,
-            platform_version: platform_version,
-            arch:             arch,
-          }.merge(data)
-
-          instance = new(package, data)
-          instance.save
-          instance.path
-        end
-
-        #
-        # Load the metadata from disk.
-        #
-        # @param [Package] package
-        #   the package for this metadata
-        #
-        # @return [Metadata]
-        #
-        def for_package(package)
-          data = File.read(path_for(package))
-          hash = JSON.parse(data, symbolize_names: true)
-
-           # Ensure Platform version has been truncated
-           if hash[:platform_version] && hash[:platform]
-             hash[:platform_version] = truncate_platform_version(hash[:platform_version], hash[:platform])
-           end
-
-          # Ensure an interation exists
-          hash[:iteration] ||= 1
-
-          new(package, hash)
-        rescue Errno::ENOENT
-          raise NoPackageMetadataFile.new(package.path)
-        end
-
-        #
-        # The metadata path that corresponds to the package.
-        #
-        # @param [Package] package
-        #   the package for this metadata
-        #
-        # @return [String]
-        #
-        def path_for(package)
-          "#{package.path}.metadata.json"
-        end
-
-        #
-        # The architecture for this machine, as reported from Ohai.
-        #
-        # @return [String]
-        #
-        def arch
-          Ohai['kernel']['machine']
-        end
-
-        #
-        # Platform version to be used in package metadata.
-        #
-        # @return [String]
-        #   the platform version
-        #
-        def platform_version
-          truncate_platform_version(Ohai['platform_version'], platform_shortname)
-        end
-
-        #
-        # Platform name to be used when creating metadata for the artifact.
-        # rhel/centos become "el", all others are just platform
-        #
-        # @return [String]
-        #   the platform family short name
-        #
-        def platform_shortname
-          if Ohai['platform_family'] == 'rhel'
-            'el'
-          else
-            Ohai['platform']
-          end
-        end
-
-        private
-
-        #
-        # On certain platforms we don't care about the full MAJOR.MINOR.PATCH platform
-        # version. This method will properly truncate the version down to a more human
-        # friendly version. This version can also be thought of as a 'marketing'
-        # version.
-        #
-        # @param [String] platform_version
-        #   the platform version to truncate
-        # @param [String] platform_shortname
-        #   the platform shortname. this might be an Ohai-returned platform or
-        #   platform family but it also might be a shortname like `el`
-        #
-        def truncate_platform_version(platform_version, platform)
-          case platform
-          when 'centos', 'debian', 'el', 'fedora', 'freebsd', 'rhel', 'sles'
-            # Only want MAJOR (e.g. Debian 7)
-            platform_version.split('.').first
-          when 'aix', 'arch', 'gentoo', 'mac_os_x', 'openbsd', 'slackware', 'solaris2', 'suse', 'ubuntu'
-            # Only want MAJOR.MINOR (e.g. Mac OS X 10.9, Ubuntu 12.04)
-            platform_version.split('.')[0..1].join('.')
-          when 'omnios', 'smartos'
-            # Only want MAJOR (e.g OmniOS r151006, SmartOS 20120809T221258Z)
-            platform_version.split('.').first
-          when 'windows'
-            # Windows has this really awesome "feature", where their version numbers
-            # internally do not match the "marketing" name.
-            #
-            # Definitively computing the Windows marketing name actually takes more
-            # than the platform version. Take a look at the following file for the
-            # details:
-            #
-            #   https://github.com/opscode/chef/blob/master/lib/chef/win32/version.rb
-            #
-            # As we don't need to be exact here the simple mapping below is based on:
-            #
-            #  http://www.jrsoftware.org/ishelp/index.php?topic=winvernotes
-            #
-            case platform_version
-            when '5.0.2195', '2000'   then '2000'
-            when '5.1.2600', 'xp'     then 'xp'
-            when '5.2.3790', '2003r2' then '2003r2'
-            when '6.0.6001', '2008'   then '2008'
-            when '6.1.7600', '7'      then '7'
-            when '6.1.7601', '2008r2' then '2008r2'
-            when '6.2.9200', '8'      then '8'
-            # The following `when` will never match since Windows 2012's platform
-            # version is the same as Windows 8. It's only here for completeness and
-            # documentation.
-            when '6.2.9200', '2012'   then '2012'
-            when /6\.3\.\d+/, '8.1' then '8.1'
-            # The following `when` will never match since Windows 2012R2's platform
-            # version is the same as Windows 8.1. It's only here for completeness
-            # and documentation.
-            when /6\.3\.\d+/, '2012r2' then '2012r2'
-            else
-              raise UnknownPlatformVersion.new(platform, platform_version)
-            end
-          else
-            raise UnknownPlatform.new(platform)
-          end
-        end
-      end
-
-      #
-      # Create a new metadata object for the given package and hash data.
-      #
-      # @param [Package] package
-      #   the package for this metadata
-      # @param [Hash] data
-      #   the hash of attributes to set in the metadata
-      #
-      def initialize(package, data = {})
-        @package = package
-        @data    = data.dup.freeze
-      end
-
-      #
-      # Helper for accessing the information inside the metadata hash.
-      #
-      # @return [Object]
-      #
-      def [](key)
-        @data[key]
-      end
-
-      #
-      # The name of this metadata file.
-      #
-      # @return [String]
-      #
-      def name
-        @name ||= File.basename(path)
-      end
-
-      #
-      # @see (Metadata.path_for)
-      #
-      def path
-        @path ||= self.class.path_for(@package)
-      end
-
-      #
-      # Save the file to disk.
-      #
-      # @return [true]
-      #
-      def save
-        File.open(path, 'w+')  do |f|
-          f.write(to_json)
-        end
-
-        true
-      end
-
-      #
-      # The JSON representation of this metadata.
-      #
-      # @return [String]
-      #
-      def to_json
-        JSON.pretty_generate(@data)
-      end
-    end
-
     include Digestable
 
+    #
+    # @return [String]
+    #
     attr_reader :path
 
     #
@@ -318,7 +94,7 @@ module Omnibus
     #
     # The parsed contents of the metadata.
     #
-    # @raise [NoPackageMetadataFile] if the {metadata} does not exist
+    # @raise [NoPackageMetadataFile] if the {#metadata} does not exist
     # @raise [JSON::ParserError] if the JSON is not valid
     #
     # @return [Hash<Symbol, String>]

data/lib/omnibus/packager.rb

@@ -0,0 +1,71 @@
+#
+# 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 Packager
+    include Logging
+
+    autoload :Base,     'omnibus/packagers/base'
+    autoload :BFF,      'omnibus/packagers/bff'
+    autoload :DEB,      'omnibus/packagers/deb'
+    autoload :Makeself, 'omnibus/packagers/makeself'
+    autoload :MSI,      'omnibus/packagers/msi'
+    autoload :PKG,      'omnibus/packagers/pkg'
+    autoload :Solaris,  'omnibus/packagers/solaris'
+    autoload :RPM,      'omnibus/packagers/rpm'
+
+    #
+    # The list of Ohai platform families mapped to the respective packager
+    # class.
+    #
+    # @return [Hash<String, Class>]
+    #
+    PLATFORM_PACKAGER_MAP = {
+      'debian'   => DEB,
+      'fedora'   => RPM,
+      'rhel'     => RPM,
+      'aix'      => BFF,
+      'solaris2' => Solaris,
+      'windows'  => MSI,
+      'mac_os_x' => PKG,
+    }.freeze
+
+    #
+    # Determine the packager for the current system. This method returns the
+    # class, not an instance of the class.
+    #
+    # @example
+    #   Packager.for_current_system #=> Packager::RPM
+    #
+    # @return [~Packager::Base]
+    #
+    def for_current_system
+      family = Ohai['platform_family']
+
+      if klass = PLATFORM_PACKAGER_MAP[family]
+        klass
+      else
+        log.warn(log_key) do
+          "Could not determine packager for `#{family}', defaulting " \
+          "to `makeself'!"
+        end
+
+        Makeself
+      end
+    end
+    module_function :for_current_system
+  end
+end

data/lib/omnibus/packagers/base.rb

@@ -15,247 +15,189 @@
 #
 
 require 'fileutils'
-require 'forwardable'
-require 'erb'
 
 module Omnibus
   class Packager::Base
+    include Cleanroom
+    include Digestable
     include Logging
+    include NullArgumentable
+    include Templating
     include Util
 
-    extend Forwardable
-
-    # The Omnibus::Project instance that we're packaging.
+    # The {Project} instance that we are packaging
     attr_reader :project
 
-    # The commands/steps to setup the file system.
-    def self.setup(&block)
-      if block_given?
-        @setup = block
-      else
-        @setup
+    class << self
+      #
+      # Set the unique of this packager.
+      #
+      # @see {#id}
+      #
+      # @param [Symbol] name
+      #   the id
+      #
+      def id(name)
+        class_eval <<-EOH, __FILE__, __LINE__
+          def id
+            :#{name}
+          end
+        EOH
       end
-    end
 
-    # The commands/steps to validate any arguments.
-    def self.validate(&block)
-      if block_given?
-        @validate = block
-      else
-        @validate
+      # The commands/steps use to setup the filesystem.
+      def setup(&block)
+        block ? @setup = block : @setup
       end
-    end
 
-    # The commands/steps to build the package.
-    def self.build(&block)
-      if block_given?
-        @build = block
-      else
-        @build || raise(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
+      # The commands/steps to build the package.
+      def build(&block)
+        block ? @build = block : @build
       end
     end
 
+    #
     # Create a new packager object.
     #
     # @param [Project] project
+    #
     def initialize(project)
       @project = project
     end
 
-    # Hacky way to get around the fact that older versions of Omnibus used to
-    # delegate magical methods to this DSL.
-    #
-    # @deprecated Use +project+ methods instead
-    def method_missing(m, *args, &block)
-      if project.respond_to?(m)
-        log.deprecated("#{log_key}##{m}") { "#{m}. Please use project.#{m} instead." }
-        project.send(m, *args, &block)
-      else
-        super
-      end
-    end
-
-    # @deprecated
-    def version
-      log.deprecated("#{log_key}#version") { 'version. Please use project.build_version instead.' }
-      project.build_version
-    end
-
     #
-    # Generation methods
-    # ------------------------------
-
-    # Create a directory at the given +path+.
+    # The unique identifier for this class - this is used in file paths and
+    # packager searching, so please do not change unless you know what you are
+    # doing!
     #
-    # @param [String] path
-    def create_directory(path)
-      FileUtils.mkdir_p(path)
-      path
-    end
-
-    # Remove the directory at the given +path+.
+    # @abstract Subclasses should define the +id+ attribute.
     #
-    # @param [String] path
-    def remove_directory(path)
-      FileUtils.rm_rf(path)
-    end
-
-    # Purge the directory of all contents.
+    # @return [Symbol]
     #
-    # @param [String] path
-    def purge_directory(path)
-      remove_directory(path)
-      create_directory(path)
+    def id
+      raise NotImplementedError
     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.
+    # The ending name of this package on disk. This method is used to generate
+    # metadata about the package after it is built.
     #
-    # @param [String] pah
-    def remove_file(path)
-      FileUtils.rm_f(path)
-    end
-
-    # Copy the +source+ directory to the +destination+.
+    # @abstract
     #
-    # @param [String] source
-    # @param [String] destination
-    def copy_directory(source, destination)
-      FileUtils.cp_r(Dir["#{source}/*"], destination)
-    end
-
-    # Execute the command using shellout!
+    # @return [String]
     #
-    # @param [String] command
-    def execute(command, options = {})
-      options.merge! timeout: 3600, cwd: staging_dir
-      shellout!(command,  options)
-    end
-
-    # Render an erb template at +source_path+ to +destination_path+ if
-    # given. Otherwise template is rendered next to +source_path+
-    # by removing the 'erb' extension of the template
-    #
-    # @param [String] source_path
-    # @param [String] destination_path
-    def render_template(source_path, destination_path = nil)
-      return unless source_path.end_with?('.erb')
-
-      destination_path = source_path.chomp('.erb') if destination_path.nil?
-
-      File.open(source_path) do |file|
-        erb = ERB.new(file.read)
-        File.open(destination_path, 'w') do |out|
-          out.write(erb.result(binding))
-        end
-
-        remove_file(source_path)
-      end
+    def package_name
+      raise NotImplementedError
     end
 
     #
-    # Validations
-    # ------------------------------
-
-    # Validate the presence of a file.
+    # The list of files to exclude when syncing files. This comes from the list
+    # of project exclusions and includes "common" SCM directories (like +.git+).
+    #
+    # @return [Array<String>]
     #
-    # @param [String] path
-    def assert_presence!(path)
-      raise MissingAsset.new(path) unless File.exist?(path)
+    def exclusions
+      project.exclusions + %w(
+        **/.git
+        **/.hg
+        **/.svn
+        **/.gitkeep
+      )
     end
 
+    #
     # Execute this packager by running the following phases in order:
     #
     #   - setup
-    #   - validate
     #   - build
-    #   - clean
     #
     def run!
-      instance_eval(&self.class.setup)    if self.class.setup
-      instance_eval(&self.class.validate) if self.class.validate
-      instance_eval(&self.class.build)    if self.class.build
-      instance_eval(&self.class.clean)    if self.class.clean
+      # Ensure the package directory exists
+      create_directory(Config.package_dir)
+
+      # Run the setup and build sequences
+      instance_eval(&self.class.setup) if self.class.setup
+      instance_eval(&self.class.build) if self.class.build
+
+      # Render the metadata
+      Metadata.generate(package_path, project)
+
+      # Ensure the temporary directory is removed at the end of a successful
+      # run. Without removal, successful builds will "leak" in /tmp and cause
+      # increased disk usage.
+      #
+      # Instead of having this as an +ensure+ block, failed builds will persist
+      # this directory so developers can go poke around and figure out why the
+      # build failed.
+      remove_directory(staging_dir)
     end
 
-    # The ending name of this package on disk. +Omnibus::Project+ uses this to
-    # generate metadata about the package after it is built.
+    #
+    # The path to the rendered package on disk. This is calculated by
+    # combining the {Config#package_dir} with the name of the package, as
+    # calculated by one of the subclasses.
     #
     # @return [String]
-    def package_name
-      raise AbstractMethod.new("#{self.class.name}#package_name")
+    #
+    def package_path
+      File.join(Config.package_dir, package_name)
     end
 
-    private
-
-    # The path to the directory where we can throw staged files.
+    #
+    # The path to the staging dir on disk.
     #
     # @return [String]
+    #
     def staging_dir
-      File.expand_path("#{Config.package_tmp}/#{underscore_name}")
+      @staging_dir ||= Dir.mktmpdir(project.name)
     end
 
-    # The path to the directory where the packager resources are
-    # copied into from source.
     #
-    # @return [String]
-    def staging_resources_path
-      File.expand_path("#{staging_dir}/Resources")
-    end
+    # @!group Resource methods
+    # --------------------------------------------------
 
-    # The path to a resource in staging directory.
     #
-    # @param [String]
-    #   the name or path of the resource
-    # @return [String]
-    def resource(path)
-      File.expand_path(File.join(staging_resources_path, path))
+    # The preferred path to a resource on disk with the given +name+. This
+    # method will perform an "intelligent" search for a resource by first
+    # looking in the local project expected {#resources_path}, and then falling
+    # back to Omnibus' files.
+    #
+    # @example When the resource exists locally
+    #   resource_path("spec.erb") #=> "/path/to/project/resources/rpm/spec.erb"
+    #
+    # @example When the resource does not exist locally
+    #   resource_path("spec.erb") #=> "/omnibus-x.y.z/resources/rpm/spec.erb"
+    #
+    # @param [String] name
+    #   the name of the resource on disk to find
+    #
+    def resource_path(name)
+      local = File.join(resources_path, name)
+
+      if File.exist?(local)
+        log.info(log_key) { "Using local resource `#{name}' from `#{local}'" }
+        local
+      else
+        log.debug(log_key) { "Using vendored resource `#{name}'" }
+        Omnibus.source_root.join("resources/#{id}/#{name}").to_s
+      end
     end
 
-    # The path to all the resources on the packager source.
-    # Uses `resources_path` if specified in the project otherwise
-    # uses the project root set in global config.
+    #
+    # The path where this packager's resources reside on disk. This is the
+    # given {Project#resources_path} combined with the packager's {#id}.
+    #
+    # @example RPM packager
+    #   resources_path #=> "/path/to/project/resources/rpm"
     #
     # @return [String]
+    #
     def resources_path
-      base_path = if project.resources_path
-                    project.resources_path
-                  else
-                    project.files_path
-                  end
-
-      File.expand_path(File.join(base_path, underscore_name, 'Resources'))
+      File.expand_path("#{project.resources_path}/#{id}")
     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
+    # @!endgroup
+    # --------------------------------------------------
   end
 end