fpm-cookery 0.3.0 → 0.4.0

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+# v0.4.0 (2011-10-28)
+* Add svn source handler. (lusis)
+* Framework for alternate source handlers. (lusis)
+* Add .zip support to the curl source handler.
+* Detect package target based on the platform.
+* Allow platform specific options. (like dependencies) (lusis)
+* Add platform (operating system) detection. (lusis)
+
 # v0.3.0 (2011-10-25)
 * Select vendor string delimiter based on the package target. (lusis)
 * Add pre/post install/uninstall script support. (lusis)

data/fpm-cookery.gemspec

@@ -22,4 +22,5 @@ Gem::Specification.new do |s|
   s.add_development_dependency "minitest"
   s.add_development_dependency "rake"
   s.add_runtime_dependency "fpm"
+  s.add_runtime_dependency "facter"
 end

data/lib/fpm/cookery/cli.rb

@@ -21,6 +21,11 @@ module FPM
           @target = o
         end
 
+        options.on("-p PLATFORM", "--platform PLATFORM",
+                  "Set the target platform. (centos, ubuntu, debian)") do |o|
+          @platform = o
+        end
+
         # Parse flags and such, remainder is all non-option args.
         remainder = options.parse(argv)
 
@@ -55,17 +60,28 @@ module FPM
           exit 1
         end
 
-        if @target.nil?
-          # TODO(sissel): Detect platform, try to guess @target?
-          @target = "deb"
-          puts "No --target given, assuming #{@target}"
-        end
-
         # Default action is "package"
         if @actions.empty?
           @actions = ["package"]
           puts "No actions given, assuming 'package'"
         end
+
+        # Override the detected platform.
+        if @platform
+          FPM::Cookery::Facts.platform = @platform
+        end
+
+        if @target
+          FPM::Cookery::Facts.target = @target
+        end
+
+        if FPM::Cookery::Facts.target.nil?
+          STDERR.puts "No target given and we're unable to detect your platform"
+          exit 1
+        end
+
+        puts "Platform: #{FPM::Cookery::Facts.platform}"
+        puts "Target:   #{FPM::Cookery::Facts.target}"
       end
 
       def run
@@ -75,7 +91,7 @@ module FPM
 
         FPM::Cookery::Book.load_recipe(@filename) do |recipe|
           packager = FPM::Cookery::Packager.new(recipe)
-          packager.target = @target
+          packager.target = FPM::Cookery::Facts.target.to_s
 
           @actions.each do |action|
             case action

data/lib/fpm/cookery/facts.rb

@@ -0,0 +1,30 @@
+require 'facter'
+
+module FPM
+  module Cookery
+    class Facts
+      def self.platform
+        @platform ||= Facter.fact(:operatingsystem).value.downcase.to_sym
+      end
+
+      def self.platform=(value)
+        @platform = value.downcase.to_sym
+      end
+
+      def self.target
+        @target ||= case platform
+                    when :centos, :redhat, :fedora then :rpm
+                    when :debian, :ubuntu          then :deb
+                    end
+      end
+
+      def self.target=(value)
+        @target = value.to_sym
+      end
+
+      def self.reset!
+        instance_variables.each {|v| instance_variable_set(v, nil) }
+      end
+    end
+  end
+end

data/lib/fpm/cookery/packager.rb

@@ -42,25 +42,27 @@ module FPM
         Dir.chdir(recipe.cachedir) do
           source.fetch
 
-          SourceIntegrityCheck.new(recipe).tap do |check|
-            if check.checksum_missing?
-              STDERR.puts <<-__WARN
-WARNING: Recipe does not provide a checksum. (sha256, sha1 or md5)
-------------------------------------------------------------------
-Digest:   #{check.digest}
-Checksum: #{check.checksum_actual}
-Filename: #{check.filename}
-              __WARN
-            elsif check.error?
-              STDERR.puts <<-__ERROR
-ERROR: Integrity check failed!
-------------------------------
-Digest:            #{check.digest}
-Checksum expected: #{check.checksum_expected}
-Checksum actual:   #{check.checksum_actual}
-Filename:          #{check.filename}
-              __ERROR
-              exit 1
+          if source.checksum?
+            SourceIntegrityCheck.new(recipe).tap do |check|
+              if check.checksum_missing?
+                STDERR.puts <<-__WARN
+  WARNING: Recipe does not provide a checksum. (sha256, sha1 or md5)
+  ------------------------------------------------------------------
+  Digest:   #{check.digest}
+  Checksum: #{check.checksum_actual}
+  Filename: #{check.filename}
+                __WARN
+              elsif check.error?
+                STDERR.puts <<-__ERROR
+  ERROR: Integrity check failed!
+  ------------------------------
+  Digest:            #{check.digest}
+  Checksum expected: #{check.checksum_expected}
+  Checksum actual:   #{check.checksum_actual}
+  Filename:          #{check.filename}
+                __ERROR
+                exit 1
+              end
             end
           end
         end

data/lib/fpm/cookery/recipe.rb

@@ -1,5 +1,6 @@
 require 'forwardable'
 require 'fileutils'
+require 'fpm/cookery/facts'
 require 'fpm/cookery/source_handler'
 require 'fpm/cookery/utils'
 require 'fpm/cookery/path_helper'
@@ -25,6 +26,10 @@ module FPM
         end
       end
 
+      def self.platforms(valid_platforms)
+        Array(valid_platforms).member?(self.platform) and block_given? ? yield : false
+      end
+
       def self.attr_rw_list(*attrs)
         attrs.each do |attr|
           class_eval %Q{
@@ -57,6 +62,10 @@ module FPM
           @spec = spec
         end
         alias_method :url, :source
+
+        def platform
+          FPM::Cookery::Facts.platform
+        end
       end
 
       def source

data/lib/fpm/cookery/source_handler/curl.rb

@@ -4,6 +4,10 @@ module FPM
   module Cookery
     class SourceHandler
       class Curl < FPM::Cookery::SourceHandler::Template
+
+        NAME = :curl
+        CHECKSUM = true
+
         def fetch
           unless local_path.exist?
             Dir.chdir(cachedir) do
@@ -18,6 +22,8 @@ module FPM
             case local_path.extname
             when '.bz2', '.gz', '.tgz'
               safesystem('tar', 'xf', local_path)
+            when '.zip'
+              safesystem('unzip', '-d', local_path.basename('.zip'), local_path)
             end
           end
           extracted_source

data/lib/fpm/cookery/source_handler/svn.rb

@@ -0,0 +1,54 @@
+require 'fpm/cookery/source_handler/template'
+
+module FPM
+  module Cookery
+    class SourceHandler
+      class Svn < FPM::Cookery::SourceHandler::Template
+
+        CHECKSUM = false
+        NAME = :svn
+
+        def fetch
+          # TODO(lusis) - implement some caching using 'svn info'?
+          Dir.chdir(cachedir) do
+            svn(url, local_path)
+          end
+          local_path
+        end
+
+        def extract
+          Dir.chdir(builddir) do
+            safesystem('cp', '-Rp', local_path, '.')
+          end
+          extracted_source
+        end
+
+        private
+        def svn(url, path)
+          @options.has_key?(:revision) ? revision=@options[:revision] : revision='HEAD'
+          safesystem('svn', 'export', '--force', '-q', '-r', revision, url, path)
+        end
+
+        def extracted_source
+          entries = Dir['*'].select {|dir| File.directory?(dir) }
+
+          case entries.size
+          when 0
+            raise "Empty checkout! (#{local_path})"
+          when 1
+            entries.first
+          else
+            ext = Path.new(url).extname
+            dir = local_path.basename(ext)
+
+            if File.exist?(dir)
+              dir
+            else
+              raise "Could not find source directory for #{local_path.basename}"
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/fpm/cookery/source_handler/template.rb

@@ -6,13 +6,18 @@ module FPM
       class Template
         include FPM::Cookery::Utils
 
-        attr_reader :url, :options, :cachedir, :builddir
+        NAME = :template
+        CHECKSUM = true
+
+        attr_reader :url, :options, :cachedir, :builddir, :has_checksum, :name
 
         def initialize(source_url, options, cachedir, builddir)
           @url = source_url
           @options = options
           @cachedir = cachedir
           @builddir = builddir
+          @has_checksum = self.class::CHECKSUM
+          @name = self.class::NAME
         end
 
         def fetch
@@ -23,6 +28,10 @@ module FPM
           raise "#{self}#extract not implemented!"
         end
 
+        def checksum?
+          @has_checksum
+        end
+
         def local_path
           @local_path ||= cachedir/(options[:as] || File.basename(url))
         end

data/lib/fpm/cookery/source_handler.rb

@@ -1,26 +1,44 @@
 require 'forwardable'
 require 'fpm/cookery/source_handler/curl'
+require 'fpm/cookery/source_handler/svn'
 
 module FPM
   module Cookery
     class SourceHandler
+      DEFAULT_HANDLER = :curl
+
       extend Forwardable
-      def_delegators :@handler, :fetch, :extract, :local_path
+      def_delegators :@handler, :fetch, :extract, :local_path, :checksum?
 
       def initialize(source_url, options, cachedir, builddir)
+        # The reason for these checks is related to the test cases
+        # Test cases for individual recipe attributes
+        # are not setting spec before hand (due to delegation chain?)
+        # Additionally, one test actually has options being sent as a String
+        if ( options.nil? || options.class == String || options.has_key?(:with) == false)
+          @source_provider = DEFAULT_HANDLER
+        else
+          @source_provider = options[:with]
+        end
         @source_url = source_url
         @options = options
         @cachedir = cachedir
         @builddir = builddir
-        @handler = get_source_handler
+        @handler = get_source_handler(@source_provider)
       end
 
       private
-      def get_source_handler
-        case @source_url.to_s
-        when 'NONE YET'
-        else
-          SourceHandler::Curl.new(@source_url, @options, @cachedir, @builddir)
+      def get_source_handler(provider)
+        klass = handler_to_class(provider)
+        klass.new(@source_url, @options, @cachedir, @builddir)
+      end
+
+      def handler_to_class(provider)
+        begin
+          self.class.const_get(provider.to_s.capitalize)
+        rescue NameError
+          STDERR.puts "Specified provider #{provider} does not exist."
+          exit(1)
         end
       end
     end

data/lib/fpm/cookery/version.rb

@@ -1,5 +1,5 @@
 module FPM
   module Cookery
-    VERSION = '0.3.0'
+    VERSION = '0.4.0'
   end
 end

data/recipes/redis/recipe.rb

@@ -1,10 +1,13 @@
 class Redis < FPM::Cookery::Recipe
   homepage 'http://redis.io'
-  source   'http://redis.googlecode.com/files/redis-2.2.5.tar.gz'
-  md5      'fe6395bbd2cadc45f4f20f6bbe05ed09'
+  # different source methods
+  #source   'https://github.com/antirez/redis/trunk', :with => :svn
+  #source   'https://github.com/antirez/redis/trunk', :with => :svn, :revision => '2400'
+  source    'http://redis.googlecode.com/files/redis-2.4.2.tar.gz'
+  md5      'c4b0b5e4953a11a503cb54cf6b09670e'
 
   name     'redis-server'
-  version  '2.2.5'
+  version  '2.4.2'
 #  revision '0' # => redis-server-2.2.5+fpm1
 
   description 'An advanced key-value store.'

data/spec/facts_spec.rb

@@ -0,0 +1,77 @@
+require 'spec_helper'
+require 'ostruct'
+require 'fpm/cookery/facts'
+
+describe "Facts" do
+  before do
+    FPM::Cookery::Facts.reset!
+  end
+
+  describe "platform" do
+    before do
+      Facter.class_eval do
+        def self.fact(v)
+          v == :operatingsystem ? OpenStruct.new(:value => 'CentOS') : nil
+        end
+      end
+    end
+
+    it "is using Facter to autodetect the platform" do
+      FPM::Cookery::Facts.platform.must_equal :centos
+    end
+
+    it "can be set" do
+      FPM::Cookery::Facts.platform = 'CentOS'
+      FPM::Cookery::Facts.platform.must_equal :centos
+    end
+  end
+
+  describe "target" do
+    describe "with platform CentOS" do
+      it "returns rpm" do
+        FPM::Cookery::Facts.platform = 'CentOS'
+        FPM::Cookery::Facts.target.must_equal :rpm
+      end
+    end
+
+    describe "with platform RedHat" do
+      it "returns rpm" do
+        FPM::Cookery::Facts.platform = 'RedHat'
+        FPM::Cookery::Facts.target.must_equal :rpm
+      end
+    end
+
+    describe "with platform Fedora" do
+      it "returns rpm" do
+        FPM::Cookery::Facts.platform = 'Fedora'
+        FPM::Cookery::Facts.target.must_equal :rpm
+      end
+    end
+
+    describe "with platform Debian" do
+      it "returns rpm" do
+        FPM::Cookery::Facts.platform = 'Debian'
+        FPM::Cookery::Facts.target.must_equal :deb
+      end
+    end
+
+    describe "with platform Ubuntu" do
+      it "returns rpm" do
+        FPM::Cookery::Facts.platform = 'Ubuntu'
+        FPM::Cookery::Facts.target.must_equal :deb
+      end
+    end
+
+    describe "with an unknown platform" do
+      it "returns nil" do
+        FPM::Cookery::Facts.platform = '___X___'
+        FPM::Cookery::Facts.target.must_equal nil
+      end
+    end
+
+    it "can be set" do
+      FPM::Cookery::Facts.target = 'rpm'
+      FPM::Cookery::Facts.target.must_equal :rpm
+    end
+  end
+end

data/spec/recipe_spec.rb

@@ -2,6 +2,8 @@ require 'spec_helper'
 require 'fpm/cookery/recipe'
 
 class TestRecipe < FPM::Cookery::Recipe
+  NAME = :test_recipe
+  CHECKSUM = true
 end
 
 describe "Recipe" do
@@ -72,6 +74,8 @@ describe "Recipe" do
   spec_recipe_attribute(:name, 'redis')
   spec_recipe_attribute(:revision, 12)
   spec_recipe_attribute(:section, 'lang')
+  # NOTE(lusis)
+  # see comment in `SourceHandler#initialize` r.e. options as `String`
   spec_recipe_attribute(:spec, {:foo => true})
   spec_recipe_attribute(:vendor, 'myvendor')
   spec_recipe_attribute(:version, '1.2')
@@ -174,6 +178,56 @@ describe "Recipe" do
     end
   end
 
+  describe ".platforms" do
+    describe "with a list of platforms" do
+      it "allows platform specific settings" do
+        klass.class_eval do
+          def self.platform; :ubuntu; end
+
+          vendor 'a'
+
+          platforms [:centos, :ubuntu] do
+            vendor 'b'
+          end
+        end
+
+        klass.new(__FILE__).vendor.must_equal 'b'
+      end
+    end
+
+    describe "with a single platform" do
+      it "allows platform specific settings" do
+        klass.class_eval do
+          def self.platform; :ubuntu; end
+
+          vendor 'a'
+
+          platforms :ubuntu do
+            vendor 'b'
+          end
+        end
+
+        klass.new(__FILE__).vendor.must_equal 'b'
+      end
+    end
+
+    describe "without a matching platform" do
+      it "does not set platform specific stuff" do
+        klass.class_eval do
+          def self.platform; :centos; end
+
+          vendor 'a'
+
+          platforms :ubuntu do
+            vendor 'b'
+          end
+        end
+
+        klass.new(__FILE__).vendor.must_equal 'a'
+      end
+    end
+  end
+
 
   #############################################################################
   # Directories

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fpm-cookery
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-25 00:00:00.000000000 Z
+date: 2011-10-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fpm
-  requirement: &71291120 !ruby/object:Gem::Requirement
+  requirement: &84112030 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *71291120
+  version_requirements: *84112030
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &71290880 !ruby/object:Gem::Requirement
+  requirement: &84111800 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *71290880
+  version_requirements: *84111800
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &71290650 !ruby/object:Gem::Requirement
+  requirement: &84127950 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *71290650
+  version_requirements: *84127950
 - !ruby/object:Gem::Dependency
   name: fpm
-  requirement: &71290430 !ruby/object:Gem::Requirement
+  requirement: &84127720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,18 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *71290430
+  version_requirements: *84127720
+- !ruby/object:Gem::Dependency
+  name: facter
+  requirement: &84127470 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *84127470
 description: A tool for building software packages with fpm.
 email:
 - bernd@tuneafish.de
@@ -74,12 +85,14 @@ files:
 - lib/fpm/cookery/book.rb
 - lib/fpm/cookery/book_hook.rb
 - lib/fpm/cookery/cli.rb
+- lib/fpm/cookery/facts.rb
 - lib/fpm/cookery/packager.rb
 - lib/fpm/cookery/path.rb
 - lib/fpm/cookery/path_helper.rb
 - lib/fpm/cookery/recipe.rb
 - lib/fpm/cookery/source_handler.rb
 - lib/fpm/cookery/source_handler/curl.rb
+- lib/fpm/cookery/source_handler/svn.rb
 - lib/fpm/cookery/source_handler/template.rb
 - lib/fpm/cookery/source_integrity_check.rb
 - lib/fpm/cookery/utils.rb
@@ -87,6 +100,7 @@ files:
 - recipes/nodejs/recipe.rb
 - recipes/redis/recipe.rb
 - recipes/redis/redis-server.init.d
+- spec/facts_spec.rb
 - spec/fixtures/test-source-1.0.tar.gz
 - spec/path_helper_spec.rb
 - spec/path_spec.rb