fpm-cookery 0.0.1

data/.gitignore

@@ -0,0 +1,8 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+cache/
+pkg/
+tmp-build/
+tmp-dest/

data/CHANGELOG.md

@@ -0,0 +1,2 @@
+# v0.0.1
+* Initial gem release.

data/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gemspec

data/README.md

@@ -0,0 +1,159 @@
+# fpm-cookery - For building software
+
+A tool for building software packages with
+[fpm](https://github.com/jordansissel/fpm).
+
+The [fpm](https://github.com/jordansissel/fpm) project is really nice for
+building operating system packages like `.deb` and `.rpm`. But it only helps
+you to create the packages and doesn't help you with actually building the
+software.
+
+__fpm-cookery__ provides an infrastructure to automatically build software
+based on recipes. It's heavily inspired and borrows code from the great
+[homebrew](https://github.com/mxcl/homebrew) and
+[brew2deb](https://github.com/tmm1/brew2deb) projects.
+The [OpenBSD Ports System](http://www.openbsd.org/faq/ports/index.html) is
+probably another source of inspiration since I've been working with that for
+quite some time
+
+It is using __fpm__ to create the actual packages.
+
+## Why?
+
+Building operating system packages for Debian/Ubuntu and RedHat using the
+official process and tools is pretty annoying if you just want some custom
+packages. Jordan's [fpm](https://github.com/jordansissel/fpm) removes the
+biggest hurdle by providing a simple command line tool to build packages
+for different operating systems.
+
+Before you can use __fpm__ to create the package, you have to build the software,
+though. In the past I've been using some shell scripts and Makefiles to
+automate this task.
+
+Then I discovered Aman's [brew2deb](https://github.com/tmm1/brew2deb) which is
+actually [homebrew](https://github.com/mxcl/homebrew) with some modifications
+to make it work on Linux. (only Debian/Ubuntu for now) Since __homebrew__ was
+designed for Mac OS X, I thought it would be nice to have a "native" Linux
+tool for the job.
+
+__fpm-cookery__ is my attempt to build such a tool.
+
+## Features
+
+* Download of the source archives. (via __curl(1)__)
+* Recipes to describe and execute the software build.
+  (e.g. configure, make, make install)
+* Sandboxed builds.
+* Package creation via __fpm__.
+* Standalone recipe trees/books/you name it. No need to put the recipes into
+  the __fpm-cookery__ source tree.
+
+## Upcoming Features
+
+* Apply custom patches.
+* Dependency checking.
+* Recipe validation.
+* Integrity checks for downloaded archives.
+* More source types. (git, svn, ...)
+* Progress output and logging.
+* Make package output type configurable. (deb, rpm)
+* Extend recipe features and build/install helpers.
+* Configuration file. (for stuff like vendor and maintainer)
+* Options for the `fpm-cook` command.
+* Manpage for the `fpm-cook` command.
+
+## 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.
+
+    $ ruby bin/fpm-cook recipes/redis/recipe.rb clean
+    $ ruby bin/fpm-cook recipes/redis/recipe.rb
+
+Or change into the recipe directory.
+
+    $ 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.
+
+## Status
+
+It can build the included `recipes/redis/recipe.rb` and
+`recipes/nodejs/recipe.rb` recipes. (both imported from __brew2deb__)
+See __CAVEATS__ for an incomplete list of missing stuff.
+
+## Example Recipe
+
+The following is an example recipe. I have some more in my recipe collection
+[over here](https://github.com/bernd/fpm-recipes).
+
+```ruby
+    class Redis < FPM::Cookery::Recipe
+      homepage 'http://redis.io'
+      source   'http://redis.googlecode.com/files/redis-2.2.5.tar.gz'
+      md5      'fe6395bbd2cadc45f4f20f6bbe05ed09'
+
+      name     'redis-server'
+      version  '2.2.5'
+      revision '1'
+
+      description 'An advanced key-value store.'
+
+      conflicts 'redis-server'
+
+      config_files '/etc/redis/redis.conf'
+
+      def build
+        make
+
+        inline_replace 'redis.conf' do |s|
+          s.gsub! 'daemonize no', 'daemonize yes'
+        end
+      end
+
+      def install
+        # make :install, 'DESTDIR' => destdir
+
+        var('lib/redis').mkdir
+
+        %w(run log/redis).each {|p| var(p).mkdir }
+
+        bin.install ['src/redis-server', 'src/redis-cli']
+
+        etc('redis').install 'redis.conf'
+        etc('init.d').install 'redis-server.init.d' => 'redis-server'
+      end
+    end
+```
+
+## CAVEATS
+
+* At the moment, there's only a small subset of the __homebrew__ DSL implemented.
+* No recipe documentation and API documentation yet.
+* No recipe validation yet.
+* No dependency validation yet.
+* No integrity check of the downloaded archives yet.
+* 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
+
+__fpm-cookery__ borrows lots of __ideas__ and also __code__ from the
+[homebrew](https://github.com/mxcl/homebrew) and
+[brew2deb](https://github.com/tmm1/brew2deb) projects. Both projects don't
+have any licensing information included in their repositories. So licensing
+is still an open question for now.
+
+## How To Contribute
+
+* I'd love to hear if you like it, hate it, use it and if you have suggestions
+  and/or problems.
+* Send pull requests. (hugs for topic branches and tests)
+* Have fun!

data/Rakefile

@@ -0,0 +1,10 @@
+require 'rake/testtask'
+require 'bundler/gem_tasks'
+
+Rake::TestTask.new do |t|
+  t.pattern = "spec/*_spec.rb"
+  t.libs << 'spec'
+  t.verbose = false
+end
+
+task :default => :test

data/bin/fpm-cook

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+
+require 'fpm/cookery/cli'
+
+FPM::Cookery::CLI.new(ARGV).run

data/fpm-cookery.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "fpm/cookery/version"
+
+Gem::Specification.new do |s|
+  s.name        = "fpm-cookery"
+  s.version     = FPM::Cookery::VERSION
+  s.authors     = ["Bernd Ahlers"]
+  s.email       = ["bernd@tuneafish.de"]
+  s.homepage    = ""
+  s.summary     = %q{A tool for building software packages with fpm.}
+  s.description = %q{A tool for building software packages with fpm.}
+
+  s.rubyforge_project = "fpm-cookery"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "fpm"
+  s.add_development_dependency "minitest"
+  s.add_runtime_dependency "fpm"
+end

data/lib/fpm/cookery/book.rb

@@ -0,0 +1,16 @@
+module FPM
+  module Cookery
+    class Book
+      # Load the given file and instantiate an object. Wrap the class in an
+      # anonymous module to avoid namespace cluttering. (see Kernel.load)
+      def self.load_recipe(filename, &callback)
+        Kernel.load(filename, true)
+        callback.call(@recipe.new(filename))
+      end
+
+      def self.loaded_recipe(klass)
+        @recipe = klass
+      end
+    end
+  end
+end

data/lib/fpm/cookery/book_hook.rb

@@ -0,0 +1,17 @@
+require 'fpm/cookery/book'
+
+module FPM
+  module Cookery
+    module BookHook
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        def inherited(klass)
+          FPM::Cookery::Book.loaded_recipe(klass)
+        end
+      end
+    end
+  end
+end

data/lib/fpm/cookery/cli.rb

@@ -0,0 +1,35 @@
+require 'fpm/cookery/book_hook'
+require 'fpm/cookery/recipe'
+require 'fpm/cookery/packager'
+
+module FPM
+  module Cookery
+    class CLI
+      def initialize(argv)
+        @argv = argv
+      end
+
+      def run
+        filename = @argv.find {|arg| arg =~ /\.rb$/ and File.exists?(arg) }
+        filename ||= File.expand_path('recipe.rb')
+
+        unless File.exists?(filename)
+          STDERR.puts 'No recipe.rb found in the current directory, abort.'
+          exit 1
+        end
+
+        FPM::Cookery::Recipe.send(:include, FPM::Cookery::BookHook)
+
+        FPM::Cookery::Book.load_recipe(filename) do |recipe|
+          packager = FPM::Cookery::Packager.new(recipe)
+
+          if @argv.include?('clean')
+            packager.cleanup
+          else
+            packager.dispense
+          end
+        end
+      end
+    end
+  end
+end

data/lib/fpm/cookery/packager.rb

@@ -0,0 +1,155 @@
+#require 'digest/md5'
+#require 'fpm/cookery/recipe_inspector'
+#require 'fpm/cookery/dependency_inspector'
+require 'fpm/cookery/utils'
+
+module FPM
+  module Cookery
+    class Packager
+      include FPM::Cookery::Utils
+
+      attr_reader :recipe, :config
+
+      def initialize(recipe, config = {})
+        @recipe = recipe
+        @config = config
+      end
+
+      def cleanup
+        FileUtils.rm_rf(recipe.builddir)
+        FileUtils.rm_rf(recipe.destdir)
+      end
+
+      def dispense
+        env = ENV.to_hash
+
+        # RecipeInspector.verify!(recipe)
+        # DependencyInspector.verify!(recipe.depends, recipe.build_depends)
+
+        recipe.installing = false
+
+        source = recipe.source_handler
+
+        recipe.cachedir.mkdir
+        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
+        end
+
+        recipe.builddir.mkdir
+        Dir.chdir(recipe.builddir) do
+          extracted_source = source.extract
+
+          Dir.chdir(extracted_source) do
+            #Source::Patches.new(recipe.patches).apply!
+
+            build_cookie = build_cookie_name("#{recipe.name}-#{recipe.version}")
+
+            if File.exists?(build_cookie)
+              STDERR.puts 'Skipping build (`cook clean` to rebuild)'
+            else
+              recipe.build and FileUtils.touch(build_cookie)
+            end
+
+            FileUtils.rm_rf(recipe.destdir)
+            recipe.destdir.mkdir
+
+            begin
+              recipe.installing = true
+              recipe.install
+            ensure
+              recipe.installing = false
+            end
+          end
+        end
+
+        build_package(recipe, config)
+      ensure
+        # Make sure we reset the environment.
+        ENV.replace(env)
+      end
+
+      def build_cookie_name(name)
+        (recipe.builddir/".build-cookie-#{name.gsub(/[^\w]/,'_')}").to_s
+      end
+
+      def build_package(recipe, config)
+        recipe.pkgdir.mkdir
+        Dir.chdir(recipe.pkgdir) do
+          epoch, ver = recipe.version.split(':', 2)
+          if ver.nil?
+            ver, epoch = epoch, nil
+          end
+
+          # Build a version including vendor and revision.
+          vendor = config[:vendor] || recipe.vendor
+          vendor_rev = "#{vendor}#{recipe.revision}"
+          version = [ver, vendor_rev].join('+')
+
+          maintainer = recipe.maintainer || begin
+            username = `git config --get user.name`.strip
+            useremail = `git config --get user.email`.strip
+            raise 'Set maintainer name/email via `git config --global user.name <name>`' if username.empty?
+            "#{username} <#{useremail}>"
+          end
+
+          opts = [
+            '-n', recipe.name,
+            '-v', version,
+            '-t', 'deb',
+            '-s', 'dir',
+            '--url', recipe.homepage || recipe.url,
+            '-C', recipe.destdir,
+            '--maintainer', maintainer,
+            '--category', recipe.section || 'optional',
+          ]
+
+          opts += [
+            '--epoch', epoch
+          ] if epoch
+
+          opts += [
+            '--description', recipe.description.strip
+          ] if recipe.description
+
+          opts += [
+            '--architecture', recipe.arch.to_s
+          ] if recipe.arch
+
+#          if self.postinst
+#            postinst_file = Tempfile.open('postinst')
+#            postinst_file.puts(postinst)
+#            chmod 0755, postinst_file.path
+#            postinst_file.close
+#            opts += ['--post-install', postinst_file.path]
+#          end
+#          if self.postrm
+#            postrm_file = Tempfile.open('postrm')
+#            postrm_file.puts(postrm)
+#            chmod 0755, postrm_file.path
+#            postrm_file.close
+#            opts += ['--post-uninstall', postrm_file.path]
+#          end
+
+          %w[ depends exclude provides replaces conflicts config_files ].each do |type|
+            if recipe.send(type).any?
+              recipe.send(type).each do |dep|
+                opts += ["--#{type.gsub('_','-')}", dep]
+              end
+            end
+          end
+
+          opts << '.'
+
+          STDERR.puts ['fpm', opts].flatten.inspect
+          safesystem(*['fpm', opts].flatten)
+        end
+      end
+    end
+  end
+end