auser-sprinkle 0.1.5

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/merb/deploy.rb

@@ -0,0 +1,5 @@
+set :application, "application"
+
+role :app, "yourhost.com"
+role :web, "yourhost.com"
+role :db,  "yourhost.com", :primary => true

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,6 @@
+## 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'
+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/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,71 @@
+#!/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 and
+# Sphinx from source, and mysql 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'
+
+
+# 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
+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.rb

@@ -0,0 +1,28 @@
+require 'rubygems'
+require 'active_support'
+
+# Use active supports auto load mechanism
+Dependencies.load_paths << File.dirname(__FILE__)
+
+# Configure active support to log auto-loading of dependencies
+#Dependencies::RAILS_DEFAULT_LOGGER = Logger.new($stdout)
+#Dependencies.log_activity = true
+
+# Load up extensions to existing classes
+Dir[File.dirname(__FILE__) + '/sprinkle/extensions/*.rb'].each { |e| require e }
+# Load up the verifiers so they can register themselves
+Dir[File.dirname(__FILE__) + '/sprinkle/verifiers/*.rb'].each { |e| require e }
+
+# Configuration options
+module Sprinkle
+  OPTIONS = { :testing => false, :verbose => false, :force => false }
+end
+
+# Define a logging target and understand packages, policies and deployment DSL
+class Object
+  include Sprinkle::Package, Sprinkle::Policy, Sprinkle::Deployment
+
+  def logger
+    @@__log__ ||= ActiveSupport::BufferedLogger.new($stdout, ActiveSupport::BufferedLogger::Severity::INFO)
+  end
+end

data/lib/sprinkle/actors/capistrano.rb

@@ -0,0 +1,89 @@
+require 'capistrano/cli'
+
+module Sprinkle
+  module Actors
+    class Capistrano
+      attr_accessor :config, :loaded_recipes
+
+      def initialize(&block)
+        @config = ::Capistrano::Configuration.new
+        @config.logger.level = Sprinkle::OPTIONS[:verbose] ? ::Capistrano::Logger::INFO : ::Capistrano::Logger::IMPORTANT
+        @config.set(:password) { ::Capistrano::CLI.password_prompt }
+        if block
+          self.instance_eval &block
+        else
+          @config.load 'deploy' # normally in the config directory for rails
+        end
+      end
+
+      def recipes(script)
+        @loaded_recipes ||= []
+        @config.load script
+        @loaded_recipes << script
+      end
+
+      def process(name, commands, roles, suppress_and_return_failures = false)
+        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/vlad.rb

@@ -0,0 +1,39 @@
+module Sprinkle
+  module Actors
+    class Vlad
+      require 'vlad'
+      attr_accessor :loaded_recipes
+
+      def initialize(&block)
+        self.instance_eval &block if block
+      end
+
+      def script(name)
+        @loaded_recipes ||= []
+        self.load name
+        @loaded_recipes << script
+      end
+
+      def process(name, commands, roles, suppress_and_return_failures = false)
+        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,24 @@
+module Sprinkle
+  module Configurable
+    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
+  end
+end

data/lib/sprinkle/deployment.rb

@@ -0,0 +1,33 @@
+module Sprinkle
+  module Deployment
+    def deployment(&block)
+      @deployment = Deployment.new(&block)
+    end
+
+    class Deployment
+      attr_accessor :style, :defaults
+
+      def initialize(&block)
+        @defaults = {}
+        self.instance_eval(&block)
+        raise 'No delivery mechanism defined' unless @style
+      end
+
+      def delivery(type, &block)
+        @style = Actors.const_get(type.to_s.titleize).new &block
+      end
+
+      def method_missing(sym, *args, &block)
+        @defaults[sym] = block
+      end
+
+      def respond_to?(sym); !!@defaults[sym]; end
+
+      def process
+        POLICIES.each do |policy|
+          policy.process(self)
+        end
+      end
+    end
+  end
+end