fpm-cookery 0.32.0 → 0.33.0

data/lib/fpm/cookery/log/hiera.rb

@@ -0,0 +1,21 @@
+require 'hiera'
+require 'fpm/cookery/log'
+
+module FPM
+  module Cookery
+    module Log
+      module Hiera
+        extend SingleForwardable
+
+        # These are the methods that Hiera requires to be defined
+        def_delegators FPM::Cookery::Log, :warn, :debug
+
+        module_function
+
+        def suitable?
+          defined?(::FPM::Cookery) == "constant"
+        end
+      end
+    end
+  end
+end

data/lib/fpm/cookery/omnibus_packager.rb

@@ -1,5 +1,6 @@
 require 'fpm/cookery/packager'
 require 'fpm/cookery/facts'
+require 'fpm/cookery/exceptions'
 
 module FPM
   module Cookery
@@ -21,8 +22,9 @@ module FPM
           recipe_file = build_recipe_file_path(name)
           Log.info "Loading dependency recipe #{name} from #{recipe_file}"
           unless File.exists?(recipe_file)
-            Log.fatal "Cannot find a recipe for #{name} at #{recipe_file}"
-            exit 1
+            error_message = "Cannot find a recipe for #{name} at #{recipe_file}"
+            Log.fatal error_message
+            raise Error::ExecutionFailure, error_message
           end
 
           FPM::Cookery::Book.instance.load_recipe(recipe_file, config) do |dep_recipe|

data/lib/fpm/cookery/package/package.rb

@@ -33,6 +33,7 @@ module FPM
           @fpm.attributes[:rpm_group] = 'root'
           @fpm.attributes[:rpm_defattrfile] = '-'
           @fpm.attributes[:rpm_defattrdir] = '-'
+          @fpm.attributes[:rpm_dist] = recipe.rpm_dist.to_s if recipe.rpm_dist
           @fpm.attributes[:excludes] = recipe.exclude
 
           # Package type specific code should be called in package_setup.

data/lib/fpm/cookery/package/version.rb

@@ -16,7 +16,11 @@ module FPM
           :default => '-'
         }
 
-        attr_reader :version, :epoch, :revision
+        # fpm sets the default version in FPM::Command; since we bypass the
+        # command line interface, we need to set our own value.
+        DEFAULT_VERSION = '1.0'
+
+        attr_reader :epoch, :revision
 
         def initialize(recipe, target, config)
           @recipe = recipe
@@ -30,11 +34,16 @@ module FPM
           @config[:vendor] || @recipe.vendor
         end
 
+        def version
+          @version ||= DEFAULT_VERSION
+        end
+
         def revision_delimiter
           REVISION_DELIMITER[:default]
         end
 
         def vendor_delimiter
+          return @config[:vendor_delimiter] if @config[:vendor_delimiter]
           VENDOR_DELIMITER[@target.to_sym] || VENDOR_DELIMITER[:default]
         end
 
@@ -49,9 +58,7 @@ module FPM
         private
 
         def split_version(version)
-          epoch, version = version.split(':', 2)
-
-          version.nil? ? [epoch, nil] : [version, epoch]
+          (version || '').split(':', 2).reject(&:empty?).reverse
         end
       end
     end

data/lib/fpm/cookery/packager.rb

@@ -1,6 +1,7 @@
 #require 'digest/md5'
 #require 'fpm/cookery/recipe_inspector'
 require 'fpm/cookery/dependency_inspector'
+require 'fpm/cookery/exceptions'
 require 'fpm/cookery/utils'
 require 'fpm/cookery/source_integrity_check'
 require 'fpm/cookery/path'
@@ -57,10 +58,12 @@ module FPM
         Log.info("All dependencies installed!")
       end
 
+      def package_name
+        [recipe.name, recipe.version, recipe.revision].compact.join('-')
+      end
 
       def dispense
         env = ENV.to_hash
-        package_name = "#{recipe.name}-#{recipe.version}"
         platform = FPM::Cookery::Facts.platform
         target = FPM::Cookery::Facts.target
 
@@ -76,9 +79,7 @@ module FPM
 
         recipe.installing = false
 
-        if defined? recipe.source_handler()
-          source = recipe.source_handler
-
+        if (source = recipe.source_handler).fetchable?
           recipe.cachedir.mkdir
           Dir.chdir(recipe.cachedir) do
             recipe.run_lifecycle_hook(:before_source_download)
@@ -105,7 +106,7 @@ module FPM
   Filename:          #{check.filename}
 
                   __ERROR
-                  exit 1
+                  raise Error::ExecutionFailure, 'checksums do not match'
                 end #end checksum missing
               end #end check
             end #end checksum
@@ -114,7 +115,7 @@ module FPM
           recipe.builddir.mkdir
           Dir.chdir(recipe.builddir) do
             recipe.run_lifecycle_hook(:before_source_extraction)
-            extract_cookie = extract_cookie_name(package_name)
+            extract_cookie = extract_cookie_name
 
             # Do not extract source again because it might destroy changes
             # that have been made to the source. (like patches)
@@ -132,7 +133,7 @@ module FPM
             end
 
             # Make the path to the extracted source available in the recipe.
-            recipe.sourcedir = recipe.builddir(extracted_source)
+            recipe.sourcedir = extracted_source
             recipe.run_lifecycle_hook(:after_source_extraction, recipe.sourcedir)
 
             Log.info "Using source directory: #{extracted_source}"
@@ -148,7 +149,8 @@ module FPM
               else
                 recipe.run_lifecycle_hook(:before_build)
                 Log.info "Building in #{File.expand_path(extracted_source, recipe.builddir)}"
-                recipe.build and FileUtils.touch(build_cookie)
+                recipe.build
+                FileUtils.touch(build_cookie)
                 recipe.run_lifecycle_hook(:after_build)
               end
 
@@ -178,11 +180,11 @@ module FPM
         ENV.replace(env)
       end
 
-      def extract_cookie_name(name)
+      def extract_cookie_name(name = package_name)
         (recipe.builddir/".extract-cookie-#{name.gsub(/[^\w]/,'_')}").to_s
       end
 
-      def build_cookie_name(name)
+      def build_cookie_name(name = package_name)
         (recipe.builddir/".build-cookie-#{name.gsub(/[^\w]/,'_')}").to_s
       end
 
@@ -244,7 +246,7 @@ module FPM
           end
         end
 
-        exit(1) if error
+        raise Error::ExecutionFailure, 'failed to locate all scripts' if error
       end
     end
   end

data/lib/fpm/cookery/recipe.rb

@@ -1,12 +1,17 @@
+require 'erb'
 require 'forwardable'
 require 'fileutils'
+require 'json'
 require 'fpm/cookery/facts'
+require 'fpm/cookery/hiera'
+require 'fpm/cookery/inheritable_attr'
 require 'fpm/cookery/source'
 require 'fpm/cookery/source_handler'
 require 'fpm/cookery/utils'
 require 'fpm/cookery/path_helper'
 require 'fpm/cookery/environment'
 require 'fpm/cookery/lifecycle_hooks'
+require 'fpm/cookery/log'
 require 'fpm/cookery/package/cpan'
 require 'fpm/cookery/package/dir'
 require 'fpm/cookery/package/gem'
@@ -24,67 +29,42 @@ module FPM
       include FPM::Cookery::PathHelper
       include FPM::Cookery::LifecycleHooks
 
-      def self.attr_rw(*attrs)
-        attrs.each do |attr|
-          class_eval %Q{
-            def self.#{attr}(value = nil)
-              value.nil? ? @#{attr} : @#{attr} = value
-            end
-
-            def #{attr}
-              self.class.#{attr}
-            end
-          }
-        end
-      end
-
-      def self.inherited(klass)
-        super
-        # Apply class data inheritable pattern to @fpm_attributes
-        # class variable.
-        klass.instance_variable_set(:@fpm_attributes, self.fpm_attributes.dup)
-        klass.instance_variable_set(:@environment, self.environment.dup)
-      end
+      extend FPM::Cookery::InheritableAttr
 
-      def self.platforms(valid_platforms)
-        Array(valid_platforms).member?(self.platform) and block_given? ? yield : false
-      end
-
-      def self.architectures(archs)
-        Array(archs).member?(FPM::Cookery::Facts.arch) and block_given? ? yield : false
-      end
-
-      def self.attr_rw_list(*attrs)
-        attrs.each do |attr|
-          class_eval %Q{
-            def self.#{attr}(*list)
-              @#{attr} ||= []
-              @#{attr} << list
-              @#{attr}.flatten!
-              @#{attr}.uniq!
-              @#{attr}
-            end
-
-            def #{attr}
-              self.class.#{attr}
-            end
-          }
-        end
-      end
-
-      attr_rw :arch, :description, :homepage, :maintainer, :md5, :name,
+      attr_rw :arch, :description, :rpm_dist, :homepage, :maintainer, :md5, :name,
               :revision, :section, :sha1, :sha256, :spec, :vendor, :version,
               :pre_install, :post_install, :pre_uninstall, :post_uninstall,
               :license, :omnibus_package, :omnibus_dir, :chain_package,
               :default_prefix
 
-      attr_rw_list :build_depends, :config_files, :conflicts, :depends,
-                   :exclude, :patches, :provides, :replaces, :omnibus_recipes,
-                   :omnibus_additional_paths, :chain_recipes, :directories
+      attr_rw_list  :build_depends, :config_files, :conflicts, :depends,
+                    :exclude, :patches, :provides, :replaces, :omnibus_recipes,
+                    :omnibus_additional_paths, :chain_recipes,
+                    :directories
+
+      attr_rw_hash  :fpm_attributes, :environment
 
-      attr_reader :filename
+      attr_rw_path  :workdir, :tmp_root, :destdir, :builddir, :pkgdir,
+                    :cachedir, :datadir
 
       class << self
+        # Make sure that +Recipe+ classes responds to these methods, but issue
+        # an exception to inform the caller that they are expected to define
+        # them.
+        [:filename, :config].each do |m|
+          define_method m do
+            raise NotImplementedError, "`.#{__method__}' must be defined when recipe file is loaded"
+          end
+        end
+
+        def platforms(valid_platforms)
+          Array(valid_platforms).member?(self.platform) and block_given? ? yield : false
+        end
+
+        def architectures(archs)
+          Array(archs).member?(FPM::Cookery::Facts.arch) and block_given? ? yield : false
+        end
+
         def platform
           FPM::Cookery::Facts.platform
         end
@@ -93,48 +73,36 @@ module FPM
           (depends + build_depends).uniq
         end
 
-        # Supports both hash and argument assignment
-        #   fpm_attributes[:attr1] = xxxx
-        #   fpm_attributes :xxxx=>1, :yyyy=>2
-        def fpm_attributes(args=nil)
-          if args.is_a?(Hash)
-            @fpm_attributes.merge!(args)
-          end
-          @fpm_attributes
+        def workdir(path = nil)
+          (@workdir  ||= Path.new(filename).dirname)/path
         end
 
-        def environment
-          @environment
+        def tmp_root(path = nil)
+          (@tmp_root ||= config.tmp_root ? Path.new(config.tmp_root) : workdir)/path
+        end
+
+        def pkgdir(path = nil)
+          (@pkgdir ||= config.pkg_dir ? Path.new(config.pkg_dir) : workdir('pkg'))/path
+        end
+
+        def cachedir(path = nil)
+          (@cachedir ||= config.cache_dir ? Path.new(config.cache_dir) : workdir('cache'))/path
+        end
+
+        def datadir(path = nil)
+          (@datadir ||= config.data_dir ? Path.new(config.data_dir) : workdir('config'))/path
         end
-      end
-      @fpm_attributes = {}
-      @environment = FPM::Cookery::Environment.new
 
-      def initialize(filename, config)
-        @filename = Path.new(filename).expand_path
-        @config = config
+        def destdir(path = nil)
+          (@destdir ||= tmp_root('tmp-dest'))/path
+        end
 
-        @workdir = @filename.dirname
-        @tmp_root = @config.tmp_root ? Path.new(@config.tmp_root) : @workdir
-        @pkgdir = @config.pkg_dir && Path.new(@config.pkg_dir)
-        @cachedir = @config.cache_dir && Path.new(@config.cache_dir)
+        def builddir(path = nil)
+          (@builddir ||= tmp_root('tmp-build'))/path
+        end
       end
 
-      def workdir=(value)  @workdir  = Path.new(value) end
-      def tmp_root=(value) @tmp_root = Path.new(value) end
-      def destdir=(value)  @destdir  = Path.new(value) end
-      def builddir=(value) @builddir = Path.new(value) end
-      def pkgdir=(value)   @pkgdir   = Path.new(value) end
-      def cachedir=(value) @cachedir = Path.new(value) end
-
-      def workdir(path = nil)  @workdir/path                               end
-      def tmp_root(path = nil) @tmp_root/path                              end
-      def destdir(path = nil)  (@destdir  || tmp_root('tmp-dest'))/path    end
-      def builddir(path = nil) (@builddir || tmp_root('tmp-build'))/path   end
-      def pkgdir(path = nil)   (@pkgdir   || workdir('pkg'))/path         end
-      def cachedir(path = nil) (@cachedir || workdir('cache'))/path       end
-      def fpm_attributes() self.class.fpm_attributes end
-      def environment()        self.class.environment                      end
+      @environment = FPM::Cookery::Environment.new
 
       # Resolve dependencies from omnibus package.
       def depends_all
@@ -151,23 +119,60 @@ module FPM
 
         pkg_depends.flatten.uniq
       end
+
+      extend Forwardable
+      # Delegate to class methods
+      def_instance_delegators :'self.class', :config, :filename
     end
 
     class Recipe < BaseRecipe
+      attr_rw_list :source
+
       def input(config)
         FPM::Cookery::Package::Dir.new(self, config)
       end
 
-      def initialize(filename, config)
-        super(filename, config)
-        @source_handler = SourceHandler.new(Source.new(source, spec), cachedir, builddir)
+      def source_handler
+        @source_handler ||= SourceHandler.new(Source.new(source, spec), cachedir, builddir)
+      end
+
+      def initialize(defer_application = false)
+        # Note: this must be called prior to instantiating the +SourceHandler+,
+        # so that +source+ can be picked up if it is defined in a +Hiera+ #
+        # data file.
+        apply unless defer_application
+      end
+
+      def to_h
+        attr_registry.values.flatten.each_with_object({}) do |m, a|
+          a[m] = send(m) unless m == :attr_registry
+        end
+      end
+
+      def to_json
+        JSON.unparse(to_h)
+      end
+
+      def to_pretty_json
+        JSON.pretty_generate(to_h)
+      end
+
+      def template(format)
+        renderer = ERB.new(format, nil, '-')
+        renderer.result(binding)
+      rescue NameError, NoMethodError => e
+        message = "Error evaluating format string: no attribute `#{e.name}' for recipe"
+        Log.error message
+        raise Error::ExecutionFailure, message
       end
 
       class << self
         def source(source = nil, spec = {})
+          #puts "#=> SOURCE: #{@source.inspect}"
           return @source if source.nil?
           @source = source
           @spec = spec
+          @source
         end
         alias_method :url, :source
 
@@ -175,51 +180,108 @@ module FPM
           return @extracted_source if path.nil?
           @extracted_source = path
         end
-      end
 
-      def source
-        self.class.source
-      end
+        def hiera
+          if !defined?(@hiera) or @hiera.nil?
+            begin
+              @hiera = FPM::Cookery::Hiera::Instance.new(self, :config => hiera_config)
+            rescue StandardError => e
+              error_message = "Encountered error loading Hiera: #{e.message}"
+              Log.fatal error_message
+              raise Error::ExecutionFailure, error_message
+            end
+          end
+
+          @hiera
+        end
+
+        # Iterates over all of the +*_attrs+ class methods, calling the
+        # relevant setter methods for all attributes which return non-+nil+
+        # results for +.lookup+.
+        # Note: Hiera does not provide access to a structure that represents
+        # the merged contents of all data files; interaction with the data must
+        # go through one channel, the +.lookup+ method.  That is why we have to
+        # iterate over all of these attributes, rather than loading the data
+        # files into a hash and then calling only those methods for which a
+        # key-value pair is specified.
+        def apply
+          scalar_attrs.each  { |m| applicator(m) { |r| send(m, r) } }
+          list_attrs.each    { |m| applicator(m) { |r| send(m, *r) } }
+          hash_attrs.each    { |m| applicator(m) { |r| send(m).merge!(r) } }
+          path_attrs.each    { |m| applicator(m) { |r| send("#{m}=", r) } }
+        end
+
+        private
+        def hiera_hierarchy
+          hiera_hierarchy = (from_env = ENV['FPM_HIERARCHY']).nil? ? [] : from_env.split(':')
+          (hiera_hierarchy + [config.platform.to_s, config.target.to_s, 'common']).compact
+        end
+
+        def hiera_config
+          # Note: +Hiera.new+ takes either a hash of options (with the sole
+          # top-level key +:options+) or a string representing the path to a
+          # configuration file.  If the `--hiera-config' flag was seen, return
+          # that; otherwise, construct a hash of sane defaults.
+          config.hiera_config || {
+            :yaml       => { :datadir  => datadir.to_s },
+            :json       => { :datadir  => datadir.to_s },
+            :hierarchy  => hiera_hierarchy
+          }
+        end
 
-      def extracted_source
-        self.class.extracted_source
+        def applicator(method)
+          if (result = lookup(method)).nil?
+            Log.debug("No result for `#{method}'")
+            return
+          end
+
+          Log.debug("Setting `#{method}' to `#{result}'")
+          Proc.new.call(result)
+        end
       end
 
       def sourcedir=(sourcedir)
         @sourcedir = sourcedir
       end
 
-      attr_reader :source_handler, :sourcedir
+      attr_reader :sourcedir
 
       extend Forwardable
-      def_delegator :@source_handler, :local_path
+      def_instance_delegator :source_handler, :local_path
+
+      # Delegate to class methods
+      def_instance_delegators :'self.class', :source, :extracted_source,
+                              :hiera, :lookup, :apply
+
+      extend SingleForwardable
+      def_single_delegator :hiera, :lookup
     end
 
-    class RubyGemRecipe < BaseRecipe
+    class RubyGemRecipe < Recipe
       def input(config)
         FPM::Cookery::Package::Gem.new(self, config)
       end
     end
 
-    class NPMRecipe < BaseRecipe
+    class NPMRecipe < Recipe
       def input(config)
         FPM::Cookery::Package::NPM.new(self, config)
       end
     end
 
-    class PythonRecipe < BaseRecipe
+    class PythonRecipe < Recipe
       def input(config)
         FPM::Cookery::Package::Python.new(self, config)
       end
     end
 
-    class CPANRecipe < BaseRecipe
+    class CPANRecipe < Recipe
       def input(config)
         FPM::Cookery::Package::CPAN.new(self, config)
       end
     end
 
-    class PEARRecipe < BaseRecipe
+    class PEARRecipe < Recipe
       attr_rw :pear_package_name_prefix, :pear_channel, :pear_php_dir
 
       def input(config)
@@ -227,10 +289,11 @@ module FPM
       end
     end
 
-    class VirtualenvRecipe < BaseRecipe
+    class VirtualenvRecipe < Recipe
       attr_rw :virtualenv_pypi, :virtualenv_install_location, :virtualenv_fix_name,
               :virtualenv_pypi_extra_index_urls, :virtualenv_package_name_prefix,
               :virtualenv_other_files_dir
+
       def input(config)
         FPM::Cookery::Package::Virtualenv.new(self, config)
       end
@@ -238,7 +301,6 @@ module FPM
 
     # Helps packaging a directory of content
     class DirRecipe < Recipe
-
       def input(config)
         FPM::Cookery::Package::Dir.new(self, config)
       end