dpkg-tools 0.3.3 → 0.3.4

data/CHANGES

@@ -1,3 +1,14 @@
+== Version 0.3.4
+
+2008-06-25: Lots of bugfixing, some small refinements.
+
+* Added mickey-mouse usage instructions to README (http://dpkg-tools.lighthouseapp.com/projects/12374/tickets/2)
+* dpkg-etc was copying its payload to the wrong place, fixing which revealed a worse underlying bad-assumption caused problem. (http://dpkg-tools.lighthouseapp.com/projects/12374/tickets/8)
+* Fixed bug with dependency requirements handling which was causing dependencies without version requirements to explode when being written to the control file (http://dpkg-tools.lighthouseapp.com/projects/12374/tickets/7)
+* Fixed typos in the various deb.yml templates (http://dpkg-tools.lighthouseapp.com/projects/12374/tickets/6)
+* Added shebang to dpkg-etc postinst template (http://dpkg-tools.lighthouseapp.com/projects/12374/tickets/4)
+* Refactored DpkgTools::Package::Builder and subclasses to fix problems with builder creation (http://dpkg-tools.lighthouseapp.com/projects/12374/tickets/1)
+
 == Version 0.3.3
 
 2008-06-06: Initial Rubyforge release, lots of rough edges around the process (and the software)

data/README

@@ -15,3 +15,29 @@ Or, the gem can be downloaded from http://rubyforge.org/projects/dpkg-tools/.
 The source is available from Github: http://github.com/fidothe/dpkg-tools/, and bugs, requests and other queries can be filed at http://dpkg-tools.lighthouseapp.com/. You can clone the public Git repo with:
 
   git clone git://github.com/fidothe/dpkg-tools.git
+
+= How to use it
+
+dpkg-tools comes with three utilities, to create packages from three different kinds of things. <tt>dpkg-gem</tt> makes it easy to generate .debs from local and remote rubygems. <tt>dpkg-etc</tt> makes it easy to create packages of configuration files. Finally, <tt>dpkg-rails</tt> makes it easy to package up Rails apps.
+
+== <tt>dpkg-gem</tt>
+
+  dpkg-gem {gem_name} 
+  
+This will grab the gem _gem_name_ from Rubyforge, along with all its dependencies, and create package directories for all of them. All you need to do then is run <tt>dpkg-buildpackage</tt> from inside the directory and you're away.
+
+  dpkg-gem --from-gem /path/to/rubygem.gem
+  
+Will do the same for a local .gem file.
+
+== <tt>dpkg-etc</tt>
+
+  dpkg-etc /path/to/package/dir
+  
+Will take a directory and drop in the scaffolding needed to make it a configuration package. Configuration files go in /path/to/package/dir/etc, and dpkg-tools makes <tt>dpkg-buildpackage</tt> know what to do...
+
+== <tt>dpkg-rails</tt>
+
+  dpkg-rails /path/to/rails/app
+  
+Will add the necessary configuration files and rake tasks to a Rails app so that a base deployment package can be generated with <tt>dpkg-buildpackage</tt>. Installing that package prepares a machine with a Mongrel cluster setup plus Apache 2's mod_proxy_balancer, allowing adding developer SSH keys for simple Capistrano deployment (tasks for that are generated too).

data/lib/dpkg-tools/command_line.rb

@@ -20,7 +20,8 @@ module DpkgTools
             
             # Another typical switch to print the version.
             opts.on_tail("--version", "Show version") do
-              err.puts DpkgTools::Version.STRING
+              require 'dpkg-tools/version'
+              err.puts DpkgTools::Version::STRING
               exit
             end
           end
@@ -57,7 +58,8 @@ module DpkgTools
             
             # Another typical switch to print the version.
             opts.on_tail("--version", "Show version") do
-              err.puts DpkgTools::Version.STRING
+              require 'dpkg-tools/version'
+              err.puts DpkgTools::Version::STRING
               exit
             end
           end
@@ -110,7 +112,8 @@ module DpkgTools
 
             # Another typical switch to print the version.
             opts.on_tail("--version", "Show version") do
-              err.puts DpkgTools::Version.STRING
+              require 'dpkg-tools/version'
+              err.puts DpkgTools::Version::STRING
               exit
             end
           end

data/lib/dpkg-tools/package/builder.rb

@@ -4,6 +4,19 @@ require 'rake'
 module DpkgTools
   module Package
     class Builder
+      class << self
+        def from_path(path_to_app)
+          data = data_class.new(path_to_app)
+          self.new(data)
+        end
+        
+        # Should be overridden by subclasses to return the specific 
+        # DpkgTools::Package::Data subclass they want to use
+        def data_class
+          DpkgTools::Package::Data
+        end
+      end
+      
       include DpkgTools::Package::FSMethods
       
       attr_reader :data, :config

data/lib/dpkg-tools/package/data.rb

@@ -40,19 +40,22 @@ module DpkgTools
         def process_dependencies_by_type(dependencies, dependency_type, suffix = nil)
           processed_dependencies = []
           if dependencies.has_key?(dependency_type)
-            unless dependencies[dependency_type].kind_of?(Array) || dependencies[dependency_type].nil?
+            dependencies_to_process = dependencies[dependency_type]
+            unless dependencies_to_process.kind_of?(Array) || dependencies_to_process.nil?
               raise DebYAMLParseError, "dependencies: #{dependency_type}: is not a list of items!"
             end
-            unless dependencies[dependency_type].nil?
-              dependencies[dependency_type].each do |dependency|
+            unless dependencies_to_process.nil?
+              dependencies_to_process.each do |dependency|
                 name = dependency.kind_of?(Hash) ? dependency.keys.first : dependency
                 requirements = dependency.kind_of?(Hash) ? dependency.values.first : nil
                 unless requirements.kind_of?(Array) || requirements.kind_of?(String) || requirements.nil?
                   raise DebYAMLParseError, "The #{dependency_type} dependency #{name}'s version requirements MUST be either a list of items, or a single item!"
                 end
                 requirements = [requirements] if requirements.kind_of?(String)
-                requirements.collect! { |req| yield(req) } if block_given?
-                processed_dependencies << {:name => "#{name}#{"-"+ suffix unless suffix.nil?}", :requirements => requirements}
+                requirements.collect! { |req| yield(req) } if block_given? && !requirements.nil?
+                processed_dependency = {:name => "#{name}#{"-"+ suffix unless suffix.nil?}"}
+                processed_dependency[:requirements] = requirements unless requirements.nil?
+                processed_dependencies << processed_dependency
               end
             end
           end

data/lib/dpkg-tools/package/etc/builder.rb

@@ -2,6 +2,12 @@ module DpkgTools
   module Package
     module Etc
       class Builder < DpkgTools::Package::Builder
+        class << self
+          def data_class
+            DpkgTools::Package::Etc::Data
+          end
+        end
+        
         def config_options
           {:base_path => data.base_path}
         end
@@ -11,7 +17,16 @@ module DpkgTools
         end
         
         def install_package_files
-          FileUtils.cp_r(config.base_path + '/etc', config.etc_install_path)
+          etc_path = config.base_path + '/etc'
+          files_to_install = Dir[etc_path + '/**/*']
+          files_to_install = Hash[*(files_to_install.collect {|fp| [fp, fp[(etc_path.size)..-1]]}).flatten]
+          files_to_install.each do |source_path, target_path|
+            if File.file?(source_path)
+              target_path = config.etc_install_path + target_path
+              FileUtils.mkdir_p(File.dirname(target_path))
+              FileUtils.install(source_path, target_path, :mode => 0644, :verbose => true)
+            end
+          end
         end
       end
     end

data/lib/dpkg-tools/package/gem/setup.rb

@@ -3,8 +3,13 @@ require 'zlib'
 require 'rubygems/package'
 require 'rubygems/specification'
 require 'rubygems/remote_fetcher'
+begin
+  require 'rubygems/remote_installer'
+rescue LoadError => e
+  puts "Ignoring LoadError due to too-new Rubygems package :-("
+end
 
-require File.join(File.dirname(__FILE__), 'gem_format')
+require 'dpkg-tools/package/gem/gem_format'
 
 module DpkgTools
   module Package

data/lib/dpkg-tools/package/rails/builder.rb

@@ -8,9 +8,8 @@ module DpkgTools
     module Rails
       class Builder < DpkgTools::Package::Builder
         class << self
-          def from_path(path_to_app)
-            data = Data.new(path_to_app)
-            self.new(data)
+          def data_class
+            DpkgTools::Package::Rails::Data
           end
         end
         

data/lib/dpkg-tools/package/rails/data.rb

@@ -11,7 +11,7 @@ module DpkgTools
             YAML.load_file(File.join(base_path, 'config', filename)) if File.exist?(File.join(base_path, 'config', filename))
           end
           
-          def base_deps
+          def base_package_deps
             [{:name => 'mysql-client'}, {:name => 'mysql-server'}, {:name => 'apache2'}, 
              {:name => 'ruby', :requirements => ['>= 1.8.2']}]
           end

data/lib/dpkg-tools/package/rake.rb

@@ -70,18 +70,24 @@ module DpkgTools
         
         # dpkg-tools rake tasks
         namespace :dpkg do
-          namespace :setup do
-            desc <<-EOD
-              Reset any files generated during initial setup to their pristine state.
-              Any of those files modified by you will be moved to <file_name>.bak first.
-              Identical files won't be touched.
-            EOD
-            task :reset do
-              setup = create_setup
-              setup.reset_maintainer_script_templates
-              setup.reset_control_files
-              setup.reset_package_resource_files
-            end
+          desc <<-EOD
+            Reset any files generated during initial setup to their pristine state.
+            Any of those files modified by you will be moved to <file_name>.bak first.
+            Identical files won't be touched.
+          EOD
+          task :reset do
+            setup = create_setup
+            setup.reset_maintainer_script_templates
+            setup.reset_control_files
+            setup.reset_package_resource_files
+          end
+          desc <<-EOD
+            Regenerate the control files.
+            Any of those files modified by you will be moved to <file_name>.bak first.
+          EOD
+          task :control do
+            setup = create_setup
+            setup.reset_control_files
           end
         end
       end

data/lib/dpkg-tools/version.rb

@@ -3,10 +3,10 @@ module DpkgTools #:nodoc:
     unless defined? MAJOR
       MAJOR  = 0
       MINOR  = 3
-      TINY   = 3
+      TINY   = 4
       RELEASE_CANDIDATE = nil
       
-      BUILD_TIME = "2008-06-06T12:49:00+01:00"
+      BUILD_TIME = "2008-06-25T11:26:00+01:00"
       
       STRING = [MAJOR, MINOR, TINY].join('.')
       TAG = "REL_#{[MAJOR, MINOR, TINY, RELEASE_CANDIDATE].compact.join('_')}".upcase.gsub(/\.|-/, '_')

data/resources/etc/changelog.yml

@@ -0,0 +1,22 @@
+# A Debian Changelog gets generated from this list of change blocks.
+# date, version, and changes are required fields.
+# 
+# Date should contain an ISO8601/RFC3339-formatted date-time string
+#
+# Version should be the version number of the package that this change
+# applies to
+#
+# Changes is a list of changes. Each item should be a YAML string or block. 
+# (You don't need more than one item, but you do need to structure it as a 
+# list)
+# 
+# You can use rake dpkg:new_change to add a new item to the top of this file
+# it will fill in Date and Version for you.
+- date: "2008-04-16T12:00:00+00:00"
+  version: "1.0.1"
+  changes:
+    - Changes!
+    - > 
+      More changes!
+      
+      Split across several lines!

data/resources/etc/deb.yml

@@ -0,0 +1,23 @@
+# The name MUST follow the conventions of Debian package naming,
+# since we use the name to make a Debian package...
+# Basically, lowercase letters, numbers and hyphend are fine
+# everything else is verboten:
+# http://www.debian.org/doc/debian-policy/ch-controlfields.html#s-f-Package
+name: "configuration-package"
+# Version is used for creating the package too. Version strings 
+# of the format X.Y.Z are used: 1.0, 1.0.1, etc. FYI, 1.1.5 is a 
+# LOWER version number than 1.10 - 1.10 is equivalent to 1.10.0
+version: "1.0"
+license: "(c) Matt Patterson, 2007"
+summary: "Package description (mandatory)"
+# To add dependencies, follow this pattern:
+#
+# dependencies:
+#   gem:
+#     - rspec: ">= 1.0.8"
+#     - redcloth: 
+#       - ">= 1.0.0"
+#       - "< 2.0.0"
+#   package:
+#     - mysql-client
+#     - mysql-server

data/resources/etc/postinst.erb

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+# steps to perform AFTER package installation go here

data/resources/etc/prerm.erb

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+# steps to perform BEFORE package removal go here

data/resources/gem/gems_to_deps.yml

@@ -0,0 +1,45 @@
+mysql: "libmysqlclient-dev"
+# There are a couple of ways of notating deps. All the possible ways are detailed below... 
+# 
+# 1) Single dep for a specific version
+# mysql: 
+#   2.7: "libmysqlclient-dev"
+#
+# mysql: 
+#   2.6: "libmysqlclient-dev"
+#   2.7: "libmysqlclient-dev"
+#
+# 2) a list of deps for a specific version
+# mysql: 
+#   2.7: 
+#     - "libmysqlclient-dev"
+#     - "other-dep"
+#
+# mysql: 
+#   2.6: 
+#     - "libmysqlclient-dev"
+#   2.7: 
+#     - "libmysqlclient-dev"
+#     - "other-dep"
+#
+# 3) lists of deps and single deps for versions
+# mysql: 
+#   2.6: "libmysqlclient-dev"
+#   2.7: 
+#     - "libmysqlclient-dev"
+#     - "other-dep"
+# 
+# 4) generic deps (with specific versions having a different list)
+# mysql: 
+#   all: 
+#     - "libmysqlclient-dev"
+#     - "other-dep"
+#   2.7: "libmysqlclient-dev"
+# 
+# 5) single generic dep only
+# mysql: "libmysqlclient-dev"
+# 
+# 6) list of generic deps
+# mysql: 
+#   - "libmysqlclient-dev"
+#   - "other-dep"

data/resources/rails/apache.conf.erb

@@ -0,0 +1,19 @@
+<Proxy balancer://mongrel_cluster>
+<% mongrel_ports.each do |port| -%>
+  BalancerMember http://127.0.0.1:<%= port %>
+<% end -%>
+</Proxy>
+
+<VirtualHost *:80>
+  ServerAdmin webskivvy@reprocessed.org
+  ServerName <%= server_name %>
+<% server_aliases.each do |server_alias| -%>
+  ServerAlias <%= server_alias %>
+<% end -%>
+  
+  ProxyPass / balancer://mongrel_cluster/
+  ProxyPassReverse / balancer://mongrel_cluster
+  
+  ErrorLog /var/log/<%= name %>/apache2/error.log
+  CustomLog /var/log/<%= name %>/apache2/access.log combined
+</VirtualHost>

data/resources/rails/deb.yml

@@ -0,0 +1,37 @@
+# The name MUST follow the conventions of Debian package naming,
+# since we use the name to make a Debian package...
+# Basically, lowercase letters, numbers and hyphend are fine
+# everything else is verboten. 
+name: "rails-app"
+# Version is used for creating the package too. Version strings 
+# of the format X.Y.Z are used: 1.0, 1.0.1, etc. FYI, 1.1.5 is a 
+# LOWER version number than 1.10 - 1.10 is equivalent to 1.10.0
+version: "1.0"
+license: "(c) Matt Patterson, 2007"
+summary: "App description (mandatory)"
+server_name: "reprocessed.org"
+server_aliases: 
+  - "www.reprocessed.org"
+# The values in mongrel_cluster are used to create a mongrel_cluster.yml file
+# with values for log_file, cwd, and pid_file created for you
+# You should edit values here and avoid editing mongrel_cluster.yml
+mongrel_cluster:
+  port: "8000"
+  environment: production
+  address: 127.0.0.1
+  servers: 3
+# To add dependencies, follow this pattern:
+# By default, most of the things you'll need are added for you
+# without you having to add them here:
+# Rails, Rake, MySQL client & server, Apache 2.2, mod_proxy_balancer,
+# Mongrel, mongrel_cluster
+#
+# dependencies:
+#   gem:
+#     - rspec: ">= 1.0.8"
+#     - redcloth: 
+#       - ">= 1.0.0"
+#       - "< 2.0.0"
+#   package:
+#     - mysql-client
+#     - mysql-server

data/resources/rails/deploy.rb

@@ -0,0 +1,51 @@
+require 'rubygems'
+require 'dpkg-tools'
+
+set :user, DpkgTools::Package::Rails.cap.user
+set :application, DpkgTools::Package::Rails.cap.application
+set :repository,  "set your repository location here"
+
+set :deploy_via, :copy
+set :deploy_to, DpkgTools::Package::Rails.cap.deploy_to
+
+# If you aren't using Subversion to manage your source code, specify
+# your SCM below:
+# set :scm, :subversion
+
+role :app, "your app-server here"
+role :web, "your web-server here"
+role :db,  "your db-server here", :primary => true
+
+namespace :deploy do
+  desc <<-DESC
+    Restarts your application. This works by calling the /etc/init.d script for the 
+    app, with 'restart' as an option.
+    
+    This will (and should) be invoked via sudo as the `app' user.
+  DESC
+  task :restart, :roles => :app, :except => { :no_release => true } do
+    sudo "/etc/init.d/#{application} restart"
+  end
+  
+  desc <<-DESC
+    Restarts your application. This works by calling the /etc/init.d script for the 
+    app, with 'restart' as an option.
+  
+    This will (and should) be invoked via sudo as the `app' user.
+  DESC
+  task :start, :roles => :app do
+    sudo "/etc/init.d/#{application} start"
+  end
+
+  desc <<-DESC
+    Restarts your application. This works by calling the /etc/init.d script for the 
+    app, with 'restart' as an option.
+  
+    This will (and should) be invoked via sudo as the `app' user.
+  DESC
+  task :stop, :roles => :app do
+    sudo "/etc/init.d/#{application} stop"
+  end
+end
+
+

data/resources/rails/logrotate.conf.erb

@@ -0,0 +1,15 @@
+/var/log/<%= name %>/apache2/*.log {
+        weekly
+        missingok
+        rotate 52
+        compress
+        delaycompress
+        notifempty
+        create 640 root adm
+        sharedscripts
+        postrotate
+                if [ -f /var/run/apache2.pid ]; then
+                        /etc/init.d/apache2 restart > /dev/null
+                fi
+        endscript
+}

data/resources/rails/mongrel_cluster.yml

@@ -0,0 +1,7 @@
+cwd: config/mongrel_cluster.yml
+log_file: log/mongrel.log
+port: "8000"
+environment: production
+address: 127.0.0.1
+pid_file: /var/run/app-name
+servers: 3

data/resources/rails/mongrel_cluster_init.erb

@@ -0,0 +1,53 @@
+#!/bin/bash
+#
+# Copyright (c) 2007 Bradley Taylor, bradley@railsmachine.com
+# Modified by Matt Patterson for dpkg-tools
+# 
+# mongrel_cluster       Startup script for Mongrel clusters.
+#
+# chkconfig: - 85 15
+# description: mongrel_cluster manages multiple Mongrel processes for use \
+#              behind a load balancer.
+#              
+
+CONF_DIR=<%= conf_dir_path %>
+CONF_FILE=$CONF_DIR/mongrel_cluster.yml
+PID_DIR=<%= pidfile_dir_path %>
+USER=<%= username %>
+
+RETVAL=0
+
+# Gracefully exit if the controller is missing.
+which mongrel_cluster_ctl >/dev/null || exit 0
+
+# Go no further if config file is missing.
+[ -f "$CONF_DIR/mongrel_cluster.yml" ] || exit 0
+
+case "$1" in
+    start)
+      # Create pid directory
+      mkdir -p $PID_DIR
+      chown $USER:$USER $PID_DIR
+
+      mongrel_rails cluster::start -C $CONF_FILE
+      RETVAL=$?
+  ;;
+    stop)
+      mongrel_rails cluster::stop -C $CONF_FILE
+      RETVAL=$?
+  ;;
+    restart)
+      mongrel_rails cluster::restart -C $CONF_FILE
+      RETVAL=$?
+  ;;
+    status)
+      mongrel_rails cluster::status -C $CONF_FILE
+      RETVAL=$?
+  ;;
+    *)
+      echo "Usage: mongrel_cluster {start|stop|restart|status}"
+      exit 1
+  ;;
+esac      
+
+exit $RETVAL

data/resources/rails/postinst.erb

@@ -0,0 +1,63 @@
+#!/bin/bash -e
+
+# Fix permission on the .ssh dir
+chown -R <%= name %>:<%= name %> "<%= app_install_path %>/.ssh"
+
+# Add the correct /etc/sudoers entries, or modify the existing one (if it's there)
+# remove any existing one
+SUDOERS=`sed -e '/^# #Package <%= name %> START#/, /^# #Package <%= name %> STOP#/ d' /etc/sudoers`
+
+SUDOERS_TMP=`mktemp` || exit 1
+
+# append the string
+cat <<EOS > $SUDOERS_TMP
+$SUDOERS
+# #Package <%= name %> START# Autogenerated by dpkg-tools for this package, will be overwritten by package maintainer scripts
+<%= user %>      ALL = NOPASSWD: <%= init_script_path %> start, <%= init_script_path %>  stop, <%= init_script_path %>  restart
+# #Package <%= name %> STOP# Autogenerated section stops
+EOS
+
+# check the syntax of the sudoers string
+visudo -cf $SUDOERS_TMP
+if [ $? -ne 0 ]; then
+	rm -f $SUDOERS_TMP
+	exit 1
+fi
+
+# rewrite /etc/sudoers
+cat $SUDOERS_TMP > /etc/sudoers
+if [ $? -ne 0 ]; then
+	rm -f $SUDOERS_TMP
+	exit 1
+fi
+
+# nuke the tmpfile
+rm -f $SUDOERS_TMP
+
+# Make the app's DB
+mysql -u root <<EOT
+<% if database_configurations['test'] -%>
+CREATE DATABASE \`<%= database_configurations['test']['database'] %>\`;
+GRANT ALL PRIVILEGES ON \`<%= database_configurations['test']['database'] %>\`.* TO \`<%= database_configurations['test']['username'] %>\`@localhost;
+<% end -%>
+<% if database_configurations['production'] -%>
+CREATE DATABASE \`<%= database_configurations['production']['database'] %>\`;
+GRANT ALL PRIVILEGES ON \`<%= database_configurations['production']['database'] %>\`.* TO \`<%= database_configurations['test']['username'] %>\`@localhost;
+<% end -%>
+EOT
+
+# invoke update-rc.d to get the app's init script loaded
+update-rc.d "<%= name %>" defaults 85 15
+
+# enable apache's mod_proxy_balancer and the http proxy protocol handler
+a2enmod proxy_balancer
+a2enmod proxy_http
+
+# enable the apache config we just installed
+a2ensite <%= name %>
+
+# restart apache
+invoke-rc.d apache2 force-reload
+
+# N.B. we don't spawn mongrels here - that's done through capistrano
+

data/resources/rails/postrm.erb

@@ -0,0 +1,38 @@
+#!/bin/bash -e
+
+# invoke update-rc.d to get the app's init script loaded
+update-rc.d "<%= name %>" remove
+
+# stop apache attempting to proxy for us
+a2dissite "<%= name %>"
+invoke-rc.d apache2 force-reload
+
+# Remove the app's user if it's there
+if getent passwd "<%= name %>" >/dev/null; then
+	# Removing system user: <%= name %>.
+	deluser "<%= name %>"  >/dev/null
+fi
+
+# Remove the group for the app if it's there
+if getent group "<%= name %>" >/dev/null; then
+	# Removing system group for the app: <%= name %>.
+	delgroup --system "<%= name %>" >/dev/null
+fi
+
+# remove the chunk of sudoers
+SUDOERS_TMP=`mktemp` || exit 1
+sed -e '/^# #Package <%= name %> START#/, /^# #Package <%= name %> STOP#/ d' /etc/sudoers > $SUDOERS_TMP
+
+# check the syntax of the sudoers string
+visudo -cf $SUDOERS_TMP
+if [ $? -ne 0 ]; then
+	rm -f $SUDOERS_TMP
+	exit 1
+fi
+
+# rewrite /etc/sudoers
+cat $SUDOERS_TMP > /etc/sudoers
+if [ $? -ne 0 ]; then
+	rm -f $SUDOERS_TMP
+	exit 1
+fi