trevorturk-sprinkle 0.2.2

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.

data/examples/sprinkle/sprinkle.rb

@@ -0,0 +1,38 @@
+#!/usr/bin/env sprinkle -c -s
+
+# Example of the simplest Sprinkle script to install a single gem on a remote host. This
+# particular script assumes that rubygems (and ruby, etc) are already installed on the remote
+# host. To see a larger example of installing an entire ruby, rubygems, gem stack from source,
+# please see the rails example.
+
+# Packages, only sprinkle is defined in this world
+
+package :sprinkle do
+  description 'Sprinkle Provisioning Tool'
+  gem 'crafterm-sprinkle' do
+    source 'http://gems.github.com' # use alternate gem server
+    #repository '/opt/local/gems'   # specify an alternate local gem repository
+  end
+end
+
+
+# Policies, sprinkle policy requires only the sprinkle gem
+
+policy :sprinkle, :roles => :app do
+  requires :sprinkle
+end
+
+
+# Deployment settings
+
+deployment do
+
+  # use vlad for deployment
+  delivery :vlad do
+    role :app, 'yourhost.com'
+  end
+
+end
+
+# End of script, given the above information, Spinkle will apply the defined policy on all roles using the
+# deployment settings specified.

data/lib/sprinkle/actors/actors.rb

@@ -0,0 +1,17 @@
+#--
+# The only point of this file is to give RDoc a definition for
+# Sprinkle::Actors. This file in production is never actually included
+# since ActiveSupport only on-demand loads classes which are needed
+# and this module is never explicitly needed.
+#++
+
+module Sprinkle
+  # An actor is a method of command delivery to a remote machine. It is the
+  # layer between sprinkle and the SSH connection to run commands. This gives
+  # you the flexibility to define custom actors, for whatever purpose you need.
+  #
+  # 99% of the time, however, the two built-in actors Sprinkle::Actors::Capistrano
+  # and Sprinkle::Actors::Vlad will be enough.
+  module Actors
+  end
+end

data/lib/sprinkle/actors/capistrano.rb

@@ -0,0 +1,124 @@
+require 'capistrano/cli'
+
+module Sprinkle
+  module Actors
+    # = Capistrano Delivery Method
+    #
+    # Capistrano is one of the delivery method options available out of the
+    # box with Sprinkle. If you have the capistrano gem install, you may use
+    # this delivery. The only configuration option available, and which is 
+    # mandatory to include is +recipes+. An example:
+    #
+    #   deployment do
+    #     delivery :capistrano do
+    #       recipes 'deploy'
+    #     end
+    #   end
+    #
+    # Recipes is given a list of files which capistrano will include and load.
+    # These recipes are mainly to set variables such as :user, :password, and to 
+    # set the app domain which will be sprinkled. 
+    class Capistrano
+      attr_accessor :config, :loaded_recipes #:nodoc:
+
+      def initialize(&block) #:nodoc:
+        @config = ::Capistrano::Configuration.new
+        @config.logger.level = Sprinkle::OPTIONS[:verbose] ? ::Capistrano::Logger::INFO : ::Capistrano::Logger::IMPORTANT
+        @config.set(:password) { ::Capistrano::CLI.password_prompt }
+        
+        @config.set(:_sprinkle_actor, self)
+        
+        def @config.recipes(script)
+          _sprinkle_actor.recipes(script)
+        end
+        
+        if block
+          @config.instance_eval &block
+        else
+          @config.load 'deploy' # normally in the config directory for rails
+        end
+      end
+
+      # Defines a recipe file which will be included by capistrano. Use these
+      # recipe files to set capistrano specific configurations. Default recipe
+      # included is "deploy." But if any other recipe is specified, it will
+      # include that instead. Multiple recipes may be specified through multiple
+      # recipes calls, an example:
+      #
+      #   deployment do
+      #     delivery :capistrano do
+      #       recipes 'deploy'
+      #       recipes 'magic_beans'
+      #     end
+      #   end
+      def recipes(script)
+        @loaded_recipes ||= []
+        @config.load script
+        @loaded_recipes << script
+      end
+
+      def process(name, commands, roles, suppress_and_return_failures = false) #:nodoc:
+        define_task(name, roles) do
+          via = fetch(:run_method, :sudo)
+          commands.each do |command|
+            invoke_command command, :via => via
+          end
+        end
+        
+        begin
+          run(name)
+          return true
+        rescue ::Capistrano::CommandError => e
+          return false if suppress_and_return_failures
+          
+          # Reraise error if we're not suppressing it
+          raise
+        end
+      end
+
+      private
+
+        # REVISIT: can we set the description somehow?
+        def define_task(name, roles, &block)
+          @config.task task_sym(name), :roles => roles, &block
+        end
+
+        def run(task)
+          @config.send task_sym(task)
+        end
+
+        def task_sym(name)
+          "install_#{name.to_task_name}".to_sym
+        end
+    end
+  end
+end
+
+
+=begin
+
+# channel: the SSH channel object used for this response
+# stream: either :err or :out, for stderr or stdout responses
+# output: the text that the server is sending, might be in chunks
+run "apt-get update" do |channel, stream, output|
+   if output =~ /Are you sure?/
+     answer = Capistrano::CLI.ui.ask("Are you sure: ")
+     channel.send_data(answer + "\n")
+   else
+     # allow the default callback to be processed
+     Capistrano::Configuration.default_io_proc.call[channel, stream, output]
+   end
+ end
+
+
+
+ You can tell subversion to use a different username+password by
+ setting a couple variables:
+    set :svn_username, "my svn username"
+    set :svn_password, "my svn password"
+ If you don't want to set the password explicitly in your recipe like
+ that, you can make capistrano prompt you for it like this:
+    set(:svn_password) { Capistrano::CLI.password_prompt("Subversion
+ password: ") }
+ - Jamis
+=end

data/lib/sprinkle/actors/local.rb

@@ -0,0 +1,30 @@
+module Sprinkle
+  module Actors
+    # = Local Delivery Method
+    #
+    # This actor implementation performs any given commands on your local system, as
+    # opposed to other implementations that generally run commands on a remote system
+    # via the network.
+    #
+    # This is useful if you'd like to use Sprinkle to provision your local machine. 
+    # To enable this actor, in your Sprinkle script specify the :local delivery mechanism. 
+    #
+    #   deployment do
+    #     delivery :local
+    #   end
+    #
+    # Note, your local machine will be assumed to be a member of all roles when applying policies
+    #
+    class Local
+      
+      def process(name, commands, roles, suppress_and_return_failures = false) #:nodoc:
+        commands.each do |command|
+          system command
+          return false if $?.to_i != 0
+        end
+        return true
+      end
+      
+    end
+  end
+end

data/lib/sprinkle/actors/ssh.rb

@@ -0,0 +1,81 @@
+require 'net/ssh/gateway'
+
+module Sprinkle
+  module Actors
+    class Ssh
+      attr_accessor :options
+
+      def initialize(options = {}, &block) #:nodoc:
+        @options = options.update(:user => 'root')
+        self.instance_eval &block if block
+      end
+
+      def roles(roles)
+        @options[:roles] = roles
+      end
+      
+      def gateway(gateway)
+        @options[:gateway] = gateway
+      end
+      
+      def user(user)
+        @options[:user] = user
+      end
+      
+      def process(name, commands, roles, suppress_and_return_failures = false)
+        return process_with_gateway(name, commands, roles) if gateway_defined?
+        process_direct(name, commands, roles)
+      end
+      
+      protected
+      
+        def process_with_gateway(name, commands, roles)
+          on_gateway do |gateway|
+            Array(roles).each { |role| execute_on_role(commands, role, gateway) }
+          end
+        end
+        
+        def process_direct(name, commands, roles)
+          Array(roles).each { |role| execute_on_role(commands, role) }
+        end
+        
+        def execute_on_role(commands, role, gateway = nil)
+          hosts = @options[:roles][role]
+          Array(hosts).each { |host| execute_on_host(commands, host, gateway) }
+        end
+        
+        def execute_on_host(commands, host, gateway = nil)
+          if gateway # SSH connection via gateway
+            gateway.ssh(host, @options[:user]) do |ssh|
+              execute_on_connection(commands, ssh)
+            end
+          else # direct SSH connection
+            Net::SSH.start(host, @options[:user]) do |ssh|
+              execute_on_connection(commands, ssh)
+            end
+          end
+        end
+        
+        def execute_on_connection(commands, connection)
+          Array(commands).each do |command|
+            connection.exec! command do |ch, stream, data|
+              logger.send((stream == :stderr ? 'error' : 'debug'), data)
+            end
+          end
+        end
+
+      private
+      
+        def gateway_defined?
+          !! @options[:gateway]
+        end
+        
+        def on_gateway(&block)
+          gateway = Net::SSH::Gateway.new(@options[:gateway], @options[:user])
+          block.call gateway
+        ensure
+          gateway.shutdown!
+        end
+    end
+  end
+end

data/lib/sprinkle/actors/vlad.rb

@@ -0,0 +1,65 @@
+module Sprinkle
+  module Actors
+    # = Vlad Delivery Method
+    #
+    # Vlad is one of the delivery method options available out of the
+    # box with Sprinkle. If you have the vlad the deployer gem install, you 
+    # may use this delivery. The only configuration option available, and 
+    # which is mandatory to include is +script+. An example:
+    #
+    #   deployment do
+    #     delivery :vlad do
+    #       script 'deploy'
+    #     end
+    #   end
+    #
+    # script is given a list of files which capistrano will include and load.
+    # These recipes are mainly to set variables such as :user, :password, and to 
+    # set the app domain which will be sprinkled.
+    class Vlad
+      require 'vlad'
+      attr_accessor :loaded_recipes #:nodoc:
+
+      def initialize(&block) #:nodoc:
+        self.instance_eval &block if block
+      end
+
+      # Defines a script file which will be included by vlad. Use these
+      # script files to set vlad specific configurations. Multiple scripts
+      # may be specified through multiple script calls, an example:
+      #
+      #   deployment do
+      #     delivery :vlad do
+      #       script 'deploy'
+      #       script 'magic_beans'
+      #     end
+      #   end
+      def script(name)
+        @loaded_recipes ||= []
+        self.load name
+        @loaded_recipes << script
+      end
+
+      def process(name, commands, roles, suppress_and_return_failures = false) #:nodoc:
+        commands = commands.join ' && ' if commands.is_a? Array
+        t = remote_task(task_sym(name), :roles => roles) { run commands }
+        
+        begin
+          t.invoke
+          return true
+        rescue ::Vlad::CommandFailedError => e
+          return false if suppress_and_return_failures
+          
+          # Reraise error if we're not suppressing it
+          raise
+        end
+      end
+
+      private
+
+        def task_sym(name)
+          "install_#{name.to_task_name}".to_sym
+        end
+    end
+  end
+end

data/lib/sprinkle/configurable.rb

@@ -0,0 +1,31 @@
+module Sprinkle
+  #--
+  # TODO: Possible documentation?
+  #++
+  module Configurable #:nodoc:
+    attr_accessor :delivery
+    
+    def defaults(deployment)
+      defaults = deployment.defaults[self.class.name.split(/::/).last.downcase.to_sym]
+      self.instance_eval(&defaults) if defaults
+      @delivery = deployment.style
+    end
+    
+    def assert_delivery
+      raise 'Unknown command delivery target' unless @delivery
+    end
+    
+    def method_missing(sym, *args, &block)
+      unless args.empty? # mutate if not set
+        @options ||= {}
+        @options[sym] = *args unless @options[sym]
+      end
+
+      @options[sym] || @package.send(sym, *args, &block) # try the parents options if unknown
+    end
+    
+    def option?(sym)
+      !@options[sym].nil?
+    end
+  end
+end