fpm-cookery 0.0.1 → 0.1.0

data/.autotest

@@ -0,0 +1,21 @@
+require 'autotest/restart'
+
+Autotest.add_hook :initialize do |at|
+  at.testlib = 'minitest/autorun'
+  at.order = :natural
+  at.libs = '.:lib:spec'
+
+  at.clear_mappings
+
+  at.add_mapping(%r{^spec/.*_spec\.rb$}) do |filename, _|
+    filename
+  end
+
+  at.add_mapping(%r{^lib/(.*)\.rb$}) do |_, m|
+    ["spec/#{m[1].gsub('fpm/cookery/', '')}_spec.rb"]
+  end
+
+  at.add_mapping(%r{^spec/spec_helper\.rb$}) do
+    at.files_matching %r{^spec/.*_spec\.rb$}
+  end
+end

data/CHANGELOG.md

@@ -1,2 +1,6 @@
-# v0.0.1
+# v0.1.0 (2011-10-18)
+* Add `with_trueprefix` path helper.
+* Add and enable source integrity check.
+
+# v0.0.1 (2011-10-11)
 * Initial gem release.

data/README.md

@@ -64,21 +64,18 @@ __fpm-cookery__ is my attempt to build such a tool.
 
 ## Getting Started
 
-Since there is no gem available yet, you have to clone the repository to
-your local machine and run the following to build a recipe.
+__fpm-cookery__ is available as a gem.
 
-    $ ruby bin/fpm-cook recipes/redis/recipe.rb clean
-    $ ruby bin/fpm-cook recipes/redis/recipe.rb
+	$ gem install fpm-cookery
 
-Or change into the recipe directory.
+Create a recipe directory or change into an existing recipe tree.
 
-    $ export PATH="$PWD/bin:$PATH"
     $ cd recipes/redis
     $ fpm-cook clean
     $ fpm-cook
 
-You can run the included test suite with `rake test`. This needs the __rake__
-and __minitest__ gems.
+You can install the development dependencies with `bundle install` and run
+the included test suite with `rake test`.
 
 ## Status
 
@@ -140,7 +137,6 @@ The following is an example recipe. I have some more in my recipe collection
 * No support for patches yet.
 * Only simple source/url types (via curl) for now.
 * No real logging output yet.
-* No gem on rubygems.org yet.
 * Pretty new and not well tested.
 
 ## Credits

data/fpm-cookery.gemspec

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

data/lib/fpm/cookery/packager.rb

@@ -2,6 +2,7 @@
 #require 'fpm/cookery/recipe_inspector'
 #require 'fpm/cookery/dependency_inspector'
 require 'fpm/cookery/utils'
+require 'fpm/cookery/source_integrity_check'
 
 module FPM
   module Cookery
@@ -34,11 +35,27 @@ module FPM
         Dir.chdir(recipe.cachedir) do
           source.fetch
 
-          #check = Source::IntegrityCheck.new(source.filename, recipe.md5, Digest::MD5)
-
-          #if check.error?
-            # check.actual, check.expected, check.filename, check.digest
-          #end
+          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
 
         recipe.builddir.mkdir

data/lib/fpm/cookery/path_helper.rb

@@ -23,7 +23,7 @@ module FPM
       end
 
       def bin(path = nil)     prefix/'bin'/path            end
-      def doc(path = nil)     prefix/'share/doc'/path/name end
+      def doc(path = nil)     prefix/'share/doc'/path      end
       def include(path = nil) prefix/'include'/path        end
       def info(path = nil)    prefix/'share/info'/path     end
       def lib(path = nil)     prefix/'lib'/path            end
@@ -40,6 +40,21 @@ module FPM
       def sbin(path = nil)    prefix/'sbin'/path           end
       def share(path = nil)   prefix/'share'/path          end
 
+      # Return real paths for the scope of the given block.
+      #
+      # prefix('usr') # => /../software/tmp-dest/usr
+      #
+      # with_trueprefix do
+      #   prefix('usr') # => /usr
+      # end
+      def with_trueprefix
+        old_value = installing
+        self.installing = false
+        yield
+      ensure
+        self.installing = old_value
+      end
+
       private
       def current_pathname_for(dir)
         installing? ? destdir/dir : Path.new("/#{dir}")

data/lib/fpm/cookery/recipe.rb

@@ -1,3 +1,4 @@
+require 'forwardable'
 require 'fileutils'
 require 'fpm/cookery/source_handler'
 require 'fpm/cookery/utils'
@@ -43,7 +44,7 @@ module FPM
       end
 
       attr_rw :arch, :description, :homepage, :maintainer, :md5, :name,
-              :revision, :section, :spec, :vendor, :version
+              :revision, :section, :sha1, :sha256, :spec, :vendor, :version
 
       attr_rw_list :build_depends, :config_files, :conflicts, :depends,
                    :exclude, :patches, :provides, :replaces
@@ -72,6 +73,9 @@ module FPM
 
       attr_reader :filename, :source_handler
 
+      extend Forwardable
+      def_delegator :@source_handler, :local_path
+
       def workdir=(value)  @workdir  = Path.new(value) end
       def destdir=(value)  @destdir  = Path.new(value) end
       def builddir=(value) @builddir = Path.new(value) end

data/lib/fpm/cookery/source_integrity_check.rb

@@ -0,0 +1,72 @@
+require 'digest/sha1'
+
+module FPM
+  module Cookery
+    class SourceIntegrityCheck
+      attr_reader :checksum_expected, :checksum_actual, :filename, :digest
+
+      def initialize(recipe)
+        @recipe = recipe
+        @error = false
+        @filename = recipe.local_path
+        @digest = nil
+        @checksum_expected = nil
+        @checksum_actual = nil
+        verify!
+      end
+
+      def error?
+        @error
+      end
+
+      def checksum_missing?
+        checksum_expected.nil?
+      end
+
+      private
+      def verify!
+        digest, checksum = get_checksum
+
+        @digest = digest
+        @checksum_expected = checksum
+        @checksum_actual = build_checksum(digest)
+
+        unless digest
+          @error = true
+          @digest = :sha256
+          @checksum_actual = build_checksum(@digest)
+        end
+
+        if @checksum_expected.to_s != @checksum_actual.to_s
+          @error = true
+        end
+      end
+
+      def get_checksum
+        type = [:sha256, :sha1, :md5].find do |digest|
+          @recipe.respond_to?(digest) and
+          @recipe.send(digest) and
+          !@recipe.send(digest).empty?
+        end
+
+        [type, @recipe.send(type)]
+      rescue TypeError
+        [nil, nil]
+      end
+
+      def build_checksum(type)
+        return unless type
+
+        digest = Digest.const_get(type.to_s.upcase).new
+
+        File.open(@recipe.local_path, 'r') do |file|
+          while chunk = file.read(4096)
+            digest.update(chunk)
+          end
+        end
+
+        digest.hexdigest
+      end
+    end
+  end
+end

data/lib/fpm/cookery/version.rb

@@ -1,5 +1,5 @@
 module FPM
   module Cookery
-    VERSION = '0.0.1'
+    VERSION = '0.1.0'
   end
 end

data/spec/path_helper_spec.rb

@@ -0,0 +1,116 @@
+require 'spec_helper'
+require 'fpm/cookery/path_helper'
+
+describe "PathHelper" do
+  class PathTest
+    include FPM::Cookery::PathHelper
+
+    def destdir; FPM::Cookery::Path.new('/tmp/dest') end
+  end
+
+  let(:helper) { PathTest.new }
+
+  describe "path helper methods" do
+    [ ['prefix', '/usr'],
+      ['etc', '/etc'],
+      ['var', '/var'],
+      ['bin', '/usr/bin'],
+      ['doc', '/usr/share/doc'],
+      ['include', '/usr/include'],
+      ['info', '/usr/share/info'],
+      ['lib', '/usr/lib'],
+      ['libexec', '/usr/libexec'],
+      ['man', '/usr/share/man'],
+      ['man1', '/usr/share/man/man1'],
+      ['man2', '/usr/share/man/man2'],
+      ['man3', '/usr/share/man/man3'],
+      ['man4', '/usr/share/man/man4'],
+      ['man5', '/usr/share/man/man5'],
+      ['man6', '/usr/share/man/man6'],
+      ['man7', '/usr/share/man/man7'],
+      ['man8', '/usr/share/man/man8'],
+      ['sbin', '/usr/sbin'],
+      ['share', '/usr/share'] ].each do |m|
+
+      name, path = m
+
+      describe "##{name}" do
+        context "without an argument" do
+          it "returns #{path}" do
+            helper.send(name).to_s.must_equal path
+          end
+        end
+
+        context "with an argument" do
+          it "adds the argument to the path" do
+            helper.send(name, 'foo/bar').to_s.must_equal "#{path}/foo/bar"
+          end
+        end
+
+        context "with a nil argument" do
+          it "does not add anything to the path" do
+            helper.send(name, nil).to_s.must_equal path
+          end
+        end
+
+        context "with installing set to true" do
+          before { helper.installing = true}
+
+          it "adds the destdir as prefix" do
+            helper.send(name, 'blah').to_s.must_equal "#{helper.destdir}#{path}/blah"
+          end
+        end
+      end
+    end
+  end
+
+  describe "#installing?" do
+    context "with installing set to true" do
+      before { helper.installing = true}
+
+      it "returns true" do
+        helper.installing?.must_equal true
+      end
+    end
+
+    context "with installing set to false" do
+      before { helper.installing = false }
+
+      it "returns true" do
+        helper.installing?.must_equal false
+      end
+    end
+  end
+
+  describe "#with_trueprefix" do
+    context "with installing set to true" do
+      before { helper.installing = true }
+
+      specify "prefix returns /" do
+        helper.with_trueprefix do
+          helper.prefix.to_s.must_equal '/usr'
+        end
+      end
+
+      it "will restore the previous installing value" do
+        helper.with_trueprefix {}
+        helper.installing.must_equal true
+      end
+    end
+
+    context "with installing set to false" do
+      before { helper.installing = false}
+
+      specify "prefix returns /" do
+        helper.with_trueprefix do
+          helper.prefix.to_s.must_equal '/usr'
+        end
+      end
+
+      it "will restore the previous installing value" do
+        helper.with_trueprefix {}
+        helper.installing.must_equal false
+      end
+    end
+  end
+end

data/spec/recipe_spec.rb

@@ -66,6 +66,8 @@ describe "Recipe" do
   spec_recipe_attribute(:description, 'A nice program.')
   spec_recipe_attribute(:homepage, 'http://example.com')
   spec_recipe_attribute(:maintainer, 'John Doe <john@example.com>')
+  spec_recipe_attribute(:sha256, '123456789abcdef')
+  spec_recipe_attribute(:sha1, '123456789abcdef')
   spec_recipe_attribute(:md5, '123456789abcdef')
   spec_recipe_attribute(:name, 'redis')
   spec_recipe_attribute(:revision, 12)
@@ -158,6 +160,16 @@ describe "Recipe" do
     end
   end
 
+  describe "#local_path" do
+    it "returns the path to the local source file" do
+      klass.class_eval do
+        source 'http://example.com/foo-1.0.tar.gz'
+      end
+
+      File.basename(klass.new(__FILE__).local_path.to_s).must_equal 'foo-1.0.tar.gz'
+    end
+  end
+
 
   #############################################################################
   # Directories

data/spec/source_integrity_check_spec.rb

@@ -0,0 +1,176 @@
+require 'spec_helper'
+require 'fpm/cookery/source_integrity_check'
+require 'fpm/cookery/recipe'
+
+class TestRecipe < FPM::Cookery::Recipe
+  source 'http://example.com/foo.tar.gz'
+end
+
+describe "SourceIntegrityCheck" do
+  let(:recipe) { TestRecipe.new(__FILE__) }
+  let(:check) { FPM::Cookery::SourceIntegrityCheck.new(recipe) }
+
+  before do
+    recipe.source_handler.instance_eval do
+      def local_path
+        fixture_path('test-source-1.0.tar.gz')
+      end
+    end
+  end
+
+  describe "without any checksum defined" do
+    describe "#error?" do
+      it "returns true" do
+        check.error?.must_equal true
+      end
+    end
+
+    describe "#checksum_missing?" do
+      it "returns true" do
+        check.checksum_missing?.must_equal true
+      end
+    end
+
+    it "has checksum_expected set to nil" do
+      check.checksum_expected.must_equal nil
+    end
+
+    it "has checksum_actual set to the sha256 checksum" do
+      check.checksum_actual.must_equal '285a6b8098ecc9040ece8f621e37c20edba39545c5d195c4894f410ed9d44b22'
+    end
+
+    it "has filename set" do
+      check.filename.must_equal fixture_path('test-source-1.0.tar.gz')
+    end
+
+    it "has digest set to nil" do
+      check.digest.must_equal :sha256
+    end
+  end
+
+  describe "with a correct sha256 checksum defined" do
+    describe "#error?" do
+      it "returns false" do
+        def recipe.sha256
+          '285a6b8098ecc9040ece8f621e37c20edba39545c5d195c4894f410ed9d44b22'
+        end
+
+        check.error?.must_equal false
+      end
+    end
+  end
+
+  describe "with a wrong sha256 checksum defined" do
+    before do
+      def recipe.sha256
+        'xxxx6b8098ecc9040ece8f621e37c20edba39545c5d195c4894f410ed9d44b22'
+      end
+    end
+
+    describe "#error?" do
+      it "returns true" do
+        check.error?.must_equal true
+      end
+    end
+
+    it "has checksum_expected set to the expected checksum" do
+      check.checksum_expected.must_equal 'xxxx6b8098ecc9040ece8f621e37c20edba39545c5d195c4894f410ed9d44b22'
+    end
+
+    it "has checksum_actual set to the actual checksum" do
+      check.checksum_actual.must_equal '285a6b8098ecc9040ece8f621e37c20edba39545c5d195c4894f410ed9d44b22'
+    end
+
+    it "has filename set" do
+      check.filename.must_equal fixture_path('test-source-1.0.tar.gz')
+    end
+
+    it "has digest set to :sha256" do
+      check.digest.must_equal :sha256
+    end
+  end
+
+  describe "with a correct sha1 checksum defined" do
+    describe "#error?" do
+      it "returns false" do
+        def recipe.sha1
+          'dd4a8575c60f8122c30d21dfeed9f23f64948bf7'
+        end
+
+        check.error?.must_equal false
+      end
+    end
+  end
+
+  describe "with a wrong sha1 checksum defined" do
+    before do
+      def recipe.sha1
+        'xxxx8575c60f8122c30d21dfeed9f23f64948bf7'
+      end
+    end
+
+    describe "#error?" do
+      it "returns true" do
+        check.error?.must_equal true
+      end
+    end
+
+    it "has checksum_expected set to the expected checksum" do
+      check.checksum_expected.must_equal 'xxxx8575c60f8122c30d21dfeed9f23f64948bf7'
+    end
+
+    it "has checksum_actual set to the actual checksum" do
+      check.checksum_actual.must_equal 'dd4a8575c60f8122c30d21dfeed9f23f64948bf7'
+    end
+
+    it "has filename set" do
+      check.filename.must_equal fixture_path('test-source-1.0.tar.gz')
+    end
+
+    it "has digest set to :sha1" do
+      check.digest.must_equal :sha1
+    end
+  end
+
+  describe "with a correct md5 checksum defined" do
+    describe "#error?" do
+      it "returns false" do
+        def recipe.md5
+          'd8f1330c3d1cec72287b88b2a6c1bc91'
+        end
+
+        check.error?.must_equal false
+      end
+    end
+  end
+
+  describe "with a wrong md5 checksum defined" do
+    before do
+      def recipe.md5
+        'xxxx330c3d1cec72287b88b2a6c1bc91'
+      end
+    end
+
+    describe "#error?" do
+      it "returns true" do
+        check.error?.must_equal true
+      end
+    end
+
+    it "has checksum_expected set to the expected checksum" do
+      check.checksum_expected.must_equal 'xxxx330c3d1cec72287b88b2a6c1bc91'
+    end
+
+    it "has checksum_actual set to the actual checksum" do
+      check.checksum_actual.must_equal 'd8f1330c3d1cec72287b88b2a6c1bc91'
+    end
+
+    it "has filename set" do
+      check.filename.must_equal fixture_path('test-source-1.0.tar.gz')
+    end
+
+    it "has digest set to :md5" do
+      check.digest.must_equal :md5
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -1,2 +1,11 @@
 require 'minitest/autorun'
 require 'minitest/pride'
+
+def fixture_path(file)
+  File.expand_path("../fixtures/#{file}", __FILE__)
+end
+
+# For my rspec poisoned brain. ;)
+module Kernel
+  alias_method :context, :describe
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: fpm-cookery
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-11 00:00:00.000000000 Z
+date: 2011-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: fpm
-  requirement: &78016810 !ruby/object:Gem::Requirement
+  requirement: &82604870 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *78016810
+  version_requirements: *82604870
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &78016600 !ruby/object:Gem::Requirement
+  requirement: &82604340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,21 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *78016600
+  version_requirements: *82604340
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &82603770 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *82603770
 - !ruby/object:Gem::Dependency
   name: fpm
-  requirement: &78016360 !ruby/object:Gem::Requirement
+  requirement: &82603240 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +54,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *78016360
+  version_requirements: *82603240
 description: A tool for building software packages with fpm.
 email:
 - bernd@tuneafish.de
@@ -52,6 +63,7 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- .autotest
 - .gitignore
 - CHANGELOG.md
 - Gemfile
@@ -69,13 +81,17 @@ files:
 - lib/fpm/cookery/source_handler.rb
 - lib/fpm/cookery/source_handler/curl.rb
 - lib/fpm/cookery/source_handler/template.rb
+- lib/fpm/cookery/source_integrity_check.rb
 - lib/fpm/cookery/utils.rb
 - lib/fpm/cookery/version.rb
 - recipes/nodejs/recipe.rb
 - recipes/redis/recipe.rb
 - recipes/redis/redis-server.init.d
+- spec/fixtures/test-source-1.0.tar.gz
+- spec/path_helper_spec.rb
 - spec/path_spec.rb
 - spec/recipe_spec.rb
+- spec/source_integrity_check_spec.rb
 - spec/spec_helper.rb
 homepage: ''
 licenses: []