jsierles-sprinkle 0.1.9

data/config/hoe.rb

@@ -0,0 +1,70 @@
+require 'sprinkle/version'
+
+AUTHOR = 'Marcus Crafter'  # can also be an array of Authors
+EMAIL = "crafterm@redartisan.com"
+DESCRIPTION = "Ruby DSL based software provisioning tool"
+GEM_NAME = 'sprinkle' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'sprinkle' # The unix name for your project
+HOMEPATH = "http://#{RUBYFORGE_PROJECT}.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/#{RUBYFORGE_PROJECT}"
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "unknown"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil 
+# UNCOMMENT IF REQUIRED: 
+# REV = `svn info`.each {|line| if line =~ /^Revision:/ then k,v = line.split(': '); break v.chomp; else next; end} rescue nil
+VERS = Sprinkle::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'sprinkle documentation',
+    "--opname", "index.html",
+    "--line-numbers", 
+    "--main", "README.txt",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps 
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' } 
+    @extra_deps
+  end 
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.developer(AUTHOR, EMAIL)
+  p.description = DESCRIPTION
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+  
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.extra_deps = [ ['activesupport', '>= 2.0.2'], ['highline', '>= 1.4.0'], ['capistrano', '>= 2.2.0'] ]     # An array of rubygem dependencies [name, version], e.g. [ ['active_support', '>= 1.3.1'] ]
+
+  #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  
+end
+
+CHANGES = hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+hoe.rsync_args = '-av --delete --ignore-errors'

data/config/requirements.rb

@@ -0,0 +1,17 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))
+
+require 'sprinkle'

data/examples/packages/build_essential.rb

@@ -0,0 +1,9 @@
+## Special package, anything that defines a 'source' package means build-essential should be installed for Ubuntu
+
+package :build_essential do
+  description 'Build tools'
+  apt 'build-essential' do
+    # Update the sources and upgrade the lists before we build essentials
+    pre :install, ['aptitude update', 'aptitude safe-upgrade', 'aptitude full-upgrade']
+  end
+end

data/examples/packages/databases/mysql.rb

@@ -0,0 +1,13 @@
+package :mysql, :provides => :database do
+  description 'MySQL Database'
+  apt %w( mysql-server mysql-client libmysqlclient15-dev )
+end
+
+package :mysql_ruby_driver do
+  description 'Ruby MySQL database driver'
+  gem 'mysql'
+  
+  verify do
+    ruby_can_load 'mysql'
+  end
+end

data/examples/packages/databases/sqlite3.rb

@@ -0,0 +1,16 @@
+# Packages to install sqlite3 and the sqlite3 ruby driver.
+package :sqlite3, :provides => :database do
+  description 'SQLite3 database'
+  apt 'sqlite3'
+end
+
+package :sqlite3_ruby_driver do
+  description 'Ruby SQLite3 library.'
+  apt 'libsqlite3-dev libsqlite3-ruby1.8'
+  
+  requires :rubygems
+  
+  verify do
+    ruby_can_load 'sqlite3'
+  end
+end

data/examples/packages/phusion.rb

@@ -0,0 +1,55 @@
+# Contains software created by Phusion.nl which is Ruby Enterprise Edition
+# and mod_rails
+
+package :ruby_enterprise do
+  description 'Ruby Enterprise Edition'
+  version '1.8.6-20080810'
+  source 'http://rubyforge.org/frs/download.php/41040/ruby-enterprise-1.8.6-20080810.tar.gz' do
+    custom_install 'echo -en "\n\n\n\n" | ./installer'
+    
+    # Modify the passenger conf file to point to REE
+    post :install, 'sed -i "s|^PassengerRuby [/a-zA-Z0-9.]*$|PassengerRuby /opt/ruby-enterprise-1.8.6-20080810/bin/ruby|" /etc/apache2/extras/passenger.conf'
+  
+    # Restart apache
+    post :install, '/etc/init.d/apache2 restart'
+  end
+  
+  verify do
+    has_directory '/opt/ruby-enterprise-1.8.6-20080810'
+    has_executable '/opt/ruby-enterprise-1.8.6-20080810/bin/ruby'
+  end
+  
+  requires :apache
+  requires :passenger
+end
+
+package :passenger, :provides => :appserver do
+  description 'Phusion Passenger (mod_rails)'
+  gem 'passenger' do
+    post :install, 'echo -en "\n\n\n\n" | passenger-install-apache2-module'
+    
+    # Create the passenger conf file
+    post :install, 'mkdir /etc/apache2/extras'
+    post :install, 'touch /etc/apache2/extras/passenger.conf'
+    post :install, "echo 'Include /etc/apache2/extras/passenger.conf' >> /etc/apache2/apache2.conf"
+    
+    [%q(LoadModule passenger_module /usr/lib/ruby/gems/1.8/gems/passenger-2.0.3/ext/apache2/mod_passenger.so),
+    %q(PassengerRoot /usr/lib/ruby/gems/1.8/gems/passenger-2.0.3),
+    %q(PassengerRuby /usr/bin/ruby1.8),
+    %q(RailsEnv development)].each do |line|
+      post :install, "echo '#{line}' >> /etc/apache2/extras/passenger.conf"
+    end
+    
+    # Restart apache to note changes
+    post :install, '/etc/init.d/apache2 restart'
+  end
+  
+  verify do
+    has_file '/etc/apache2/extras/passenger.conf'
+    has_file '/usr/lib/ruby/gems/1.8/gems/passenger-2.0.3/ext/apache2/mod_passenger.so'
+    has_directory '/usr/lib/ruby/gems/1.8/gems/passenger-2.0.3'
+  end
+  
+  requires :apache
+  requires :apache2_prefork_dev
+end

data/examples/packages/ruby/rails.rb

@@ -0,0 +1,9 @@
+package :rails do
+  description 'Ruby on Rails'
+  gem 'rails'
+  version '2.1.0'
+  
+  verify do
+    has_executable 'rails'
+  end
+end

data/examples/packages/ruby/ruby.rb

@@ -0,0 +1,17 @@
+package :ruby do
+  description 'Ruby Virtual Machine'
+  version '1.8.6'
+  apt %q(ruby1.8-dev ruby1.8 ri1.8 rdoc1.8 irb1.8 libreadline-ruby1.8 libruby1.8 libopenssl-ruby) do
+    post :install, [%q(ln -s /usr/bin/ruby1.8 /usr/bin/ruby),
+    %q(ln -s /usr/bin/ri1.8 /usr/bin/ri),
+    %q(ln -s /usr/bin/rdoc1.8 /usr/bin/rdoc),
+    %q(ln -s /usr/bin/irb1.8 /usr/bin/irb)]
+  end
+  
+  verify 'binaries' do
+    has_file '/usr/bin/ruby1.8'
+    has_file '/usr/bin/ri1.8'
+    has_file '/usr/bin/rdoc1.8'
+    has_file '/usr/bin/irb1.8'
+  end
+end

data/examples/packages/ruby/rubygems.rb

@@ -0,0 +1,17 @@
+package :rubygems do
+  description 'Ruby Gems Package Management System'
+  version '1.2.0'
+  source "http://rubyforge.org/frs/download.php/38646/rubygems-#{version}.tgz" do
+    custom_install 'ruby setup.rb'
+    post :install, 'ln -s /usr/bin/gem1.8 /usr/bin/gem'
+    post :install, 'gem update'
+    post :install, 'gem update --system'
+  end
+  
+  verify 'binary' do
+    has_file '/usr/bin/gem1.8'
+    has_symlink '/usr/bin/gem', '/usr/bin/gem1.8'
+  end
+  
+  requires :ruby
+end

data/examples/packages/scm/git.rb

@@ -0,0 +1,11 @@
+package :git, :provides => :scm do
+  description 'Git Distributed Version Control'
+  version '1.5.6.3'
+  source "http://kernel.org/pub/software/scm/git/git-#{version}.tar.gz"
+  requires :git_dependencies
+end
+
+package :git_dependencies do
+  description 'Git Build Dependencies'
+  apt 'git', :dependencies_only => true
+end

data/examples/packages/scm/subversion.rb

@@ -0,0 +1,4 @@
+package :subversion, :provides => :scm do
+  description 'Subversion Version Control'
+  apt 'subversion'
+end

data/examples/packages/servers/apache.rb

@@ -0,0 +1,15 @@
+package :apache, :provides => :webserver do
+  description 'Apache2 web server.'
+  apt 'apache2 apache2.2-common apache2-mpm-prefork apache2-utils libexpat1 ssl-cert' do
+    post :install, 'a2enmod rewrite'
+  end
+  
+  verify do
+    has_process 'apache2'
+  end
+end
+
+package :apache2_prefork_dev do
+  description 'A dependency required by some packages.'
+  apt 'apache2-prefork-dev'
+end

data/examples/rails/README

@@ -0,0 +1,15 @@
+= Example Rails Spinkle Deployment Script
+
+The following example shows how you can provision Rails and associated packages onto a remote server (or set of servers).
+
+== Usage:
+
+$> sprinkle -s rails.rb
+
+or in test mode:
+
+$> sprinkle -t -s rails.rb
+
+== Information
+
+For more information, please see: http://github.com/crafterm/sprinkle/tree/master/README.txt

data/examples/rails/deploy.rb

@@ -0,0 +1,2 @@
+set :user, 'root'
+role :app, 'yourhost.com', :primary => true

data/examples/rails/packages/database.rb

@@ -0,0 +1,9 @@
+package :mysql, :provides => :database do
+  description 'MySQL Database'
+  apt %w( mysql-server mysql-client )
+end
+
+package :mysql_driver do
+  description 'Ruby MySQL database driver'
+  gem 'mysql'
+end

data/examples/rails/packages/essential.rb

@@ -0,0 +1,9 @@
+## Special package, anything that defines a 'source' package means build-essential should be installed for Ubuntu
+
+package :build_essential do
+  description 'Build tools'
+  apt 'build-essential' do
+    # Update the sources and upgrade the lists before we build essentials
+    pre :install, 'apt-get update'
+  end
+end

data/examples/rails/packages/rails.rb

@@ -0,0 +1,28 @@
+## Defines available packages
+
+package :ruby do
+  description 'Ruby Virtual Machine'
+  version '1.8.6'
+  source "ftp://ftp.ruby-lang.org/pub/ruby/1.8/ruby-#{version}-p111.tar.gz" # implicit :style => :gnu
+  requires :ruby_dependencies
+end
+
+package :ruby_dependencies do
+  description 'Ruby Virtual Machine Build Dependencies'
+  apt %w( bison zlib1g-dev libssl-dev libreadline5-dev libncurses5-dev file )
+end
+
+package :rubygems do
+  description 'Ruby Gems Package Management System'
+  version '1.2.0'
+  source "http://rubyforge.org/frs/download.php/38646/rubygems-#{version}.tgz" do
+    custom_install 'ruby setup.rb'
+  end
+  requires :ruby
+end
+
+package :rails do
+  description 'Ruby on Rails'
+  gem 'rails'
+  version '2.1.0'
+end

data/examples/rails/packages/scm.rb

@@ -0,0 +1,11 @@
+package :git, :provides => :scm do
+  description 'Git Distributed Version Control'
+  version '1.5.6.3'
+  source "http://kernel.org/pub/software/scm/git/git-#{version}.tar.gz"
+  requires :git_dependencies
+end
+
+package :git_dependencies do
+  description 'Git Build Dependencies'
+  apt 'git', :dependencies_only => true
+end

data/examples/rails/packages/search.rb

@@ -0,0 +1,11 @@
+package :sphinx, :provides => :search do
+  description 'MySQL full text search engine'
+  version '0.9.8-rc2'
+  source "http://www.sphinxsearch.com/downloads/sphinx-#{version}.tar.gz"
+  requires :mysql_dev
+end
+
+package :mysql_dev do
+  description 'MySQL Database development package'
+  apt %w( libmysqlclient15-dev )
+end

data/examples/rails/packages/server.rb

@@ -0,0 +1,28 @@
+package :mongrel do
+  description 'Mongrel Application Server'
+  gem 'mongrel'
+  version '1.1.4'
+end
+
+package :mongrel_cluster, :provides => :appserver do
+  description 'Cluster Management for Mongrel'
+  gem 'mongrel_cluster'
+  version '1.0.5'
+  requires :mongrel
+end
+
+package :apache, :provides => :webserver do
+  description 'Apache 2 HTTP Server'
+  version '2.2.9'
+  source "http://www.apache.org/dist/httpd/httpd-#{version}.tar.bz2" do
+    enable %w( mods-shared=all proxy proxy-balancer proxy-http rewrite cache headers ssl deflate so )
+    prefix "/opt/local/apache2-#{version}"
+    post :install, 'install -m 755 support/apachectl /etc/init.d/apache2', 'update-rc.d -f apache2 defaults'
+  end
+  requires :apache_dependencies
+end
+
+package :apache_dependencies do
+  description 'Apache 2 HTTP Server Build Dependencies'
+  apt %w( openssl libtool mawk zlib1g-dev libssl-dev )
+end

data/examples/rails/rails.rb

@@ -0,0 +1,73 @@
+#!/usr/bin/env sprinkle -s
+
+# Annotated Example Sprinkle Rails deployment script
+#
+# This is an example Sprinkle script configured to install Rails from gems, Apache, Ruby,
+# Sphinx and Git from source, and mysql and Git dependencies from apt on an Ubuntu system.
+#
+# Installation is configured to run via capistrano (and an accompanying deploy.rb recipe script).
+# Source based packages are downloaded and built into /usr/local on the remote system.
+#
+# A sprinkle script is separated into 3 different sections. Packages, policies and deployment:
+
+
+# Packages (separate files for brevity)
+#
+#  Defines the world of packages as we know it. Each package has a name and
+#  set of metadata including its installer type (eg. apt, source, gem, etc). Packages can have
+#  relationships to each other via dependencies.
+
+require 'packages/essential'
+require 'packages/rails'
+require 'packages/database'
+require 'packages/server'
+require 'packages/search'
+require 'packages/scm'
+
+
+# Policies
+#
+#  Names a group of packages (optionally with versions) that apply to a particular set of roles:
+#
+#   Associates the rails policy to the application servers. Contains rails, and surrounding
+#   packages. Note, appserver, database, webserver and search are all virtual packages defined above.
+#   If there's only one implementation of a virtual package, it's selected automatically, otherwise
+#   the user is requested to select which one to use.
+
+policy :rails, :roles => :app do
+  requires :rails, :version => '2.1.0'
+  requires :appserver
+  requires :database
+  requires :webserver
+  requires :search
+  requires :scm
+end
+
+
+# Deployment
+#
+#  Defines script wide settings such as a delivery mechanism for executing commands on the target
+#  system (eg. capistrano), and installer defaults (eg. build locations, etc):
+#
+#   Configures spinkle to use capistrano for delivery of commands to the remote machines (via
+#   the named 'deploy' recipe). Also configures 'source' installer defaults to put package gear
+#   in /usr/local
+
+deployment do
+
+  # mechanism for deployment
+  delivery :capistrano do
+    recipes 'deploy'
+  end
+
+  # source based package installer defaults
+  source do
+    prefix   '/usr/local'
+    archives '/usr/local/sources'
+    builds   '/usr/local/build'
+  end
+
+end
+
+# End of script, given the above information, Spinkle will apply the defined policy on all roles using the
+# deployment settings specified.