auser-sprinkle 0.1.5

data/CREDITS

@@ -0,0 +1,16 @@
+= CREDITS
+
+Many thanks to the following people who have submitted ideas, patches, helped with testing
+and/or generally provided support to Sprinke, I really appreciate your help:
+
+Kristin Baumann    (http://crafterm.net/kristin/blog/)
+Ben Schwarz        (http://germanforblack.com/)
+Jim Freeze         (http://www.artima.com/rubycs/articles/ruby_as_dslP.html)
+Matthew Tanase     (http://www.slicehost.com)
+Jared Kuolt        (http://www.slicehost.com)
+Jamis Buck         (http://www.capify.org)
+Matt Allen         (http://blog.allen.com.au)
+Eric Hodel         (http://blog.segment7.net)
+Pete Yandell       (http://notahat.com)
+Adam Meehan        (http://duckpunching.com)
+Mitchell Hashimoto (http://mitchellhashimoto.com)

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2008-03-11
+
+* 1 major enhancement:
+  * Initial release

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Marcus Crafter
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Manifest.txt

@@ -0,0 +1,67 @@
+CREDITS
+History.txt
+MIT-LICENSE
+Manifest.txt
+README.rdoc
+Rakefile
+bin/sprinkle
+config/hoe.rb
+config/requirements.rb
+examples/merb/deploy.rb
+examples/rails/README
+examples/rails/deploy.rb
+examples/rails/packages/database.rb
+examples/rails/packages/essential.rb
+examples/rails/packages/rails.rb
+examples/rails/packages/search.rb
+examples/rails/packages/server.rb
+examples/rails/rails.rb
+examples/sprinkle/sprinkle.rb
+lib/sprinkle.rb
+lib/sprinkle/actors/capistrano.rb
+lib/sprinkle/actors/vlad.rb
+lib/sprinkle/configurable.rb
+lib/sprinkle/deployment.rb
+lib/sprinkle/extensions/arbitrary_options.rb
+lib/sprinkle/extensions/array.rb
+lib/sprinkle/extensions/blank_slate.rb
+lib/sprinkle/extensions/dsl_accessor.rb
+lib/sprinkle/extensions/string.rb
+lib/sprinkle/extensions/symbol.rb
+lib/sprinkle/installers/apt.rb
+lib/sprinkle/installers/gem.rb
+lib/sprinkle/installers/installer.rb
+lib/sprinkle/installers/rake.rb
+lib/sprinkle/installers/rpm.rb
+lib/sprinkle/installers/source.rb
+lib/sprinkle/package.rb
+lib/sprinkle/policy.rb
+lib/sprinkle/script.rb
+lib/sprinkle/verifiers/directory.rb
+lib/sprinkle/verifiers/executable.rb
+lib/sprinkle/verifiers/file.rb
+lib/sprinkle/verifiers/symlink.rb
+lib/sprinkle/verify.rb
+lib/sprinkle/version.rb
+script/destroy
+script/generate
+spec/spec.opts
+spec/spec_helper.rb
+spec/sprinkle/actors/capistrano_spec.rb
+spec/sprinkle/deployment_spec.rb
+spec/sprinkle/extensions/array_spec.rb
+spec/sprinkle/extensions/string_spec.rb
+spec/sprinkle/installers/apt_spec.rb
+spec/sprinkle/installers/gem_spec.rb
+spec/sprinkle/installers/installer_spec.rb
+spec/sprinkle/installers/rpm_spec.rb
+spec/sprinkle/installers/source_spec.rb
+spec/sprinkle/package_spec.rb
+spec/sprinkle/policy_spec.rb
+spec/sprinkle/script_spec.rb
+spec/sprinkle/sprinkle_spec.rb
+spec/sprinkle/verify_spec.rb
+sprinkle.gemspec
+tasks/deployment.rake
+tasks/environment.rake
+tasks/rspec.rake

data/README.rdoc

@@ -0,0 +1,224 @@
+= SPRINKLE
+
+http://redartisan.com/2008/5/27/sprinkle-intro
+http://github.com/crafterm/sprinkle
+
+== DESCRIPTION:
+
+Sprinkle is a software provisioning tool you can use to build remote servers with, after the base operating
+system has been installed. For example, to install a Rails or Merb stack on a brand new slice directly after
+its been created.
+
+Properties of packages such as their name, type, dependencies, etc, and what packages apply to what machines
+is described via a domain specific language that Sprinkle executes (in fact one of the aims of Sprinkle is to
+define as concisely as possible a language for installing software).
+
+An example package description follows:
+
+    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"
+      requires :ruby_dependencies
+      
+      verify do
+        has_file '/usr/bin/ruby'
+      end
+    end
+
+This defines a package called 'ruby', that uses the source based installer to build Ruby 1.8.6 from source,
+installing the package 'ruby_dependencies' beforehand. Additionally, the package verifies it was installed
+correctly by verifying the file '/usr/bin/ruby' exists after installation. If this verification fails, the
+sprinkle script will gracefully stop.
+
+Reasonable defaults are set by sprinkle, such as the install prefix, download area, etc, but can be customized
+globally or per package (see below for an example).
+
+Since packages come in many forms (eg. gems, pre-compiled debs, compressed source tar.gz, etc), Sprinkle supports
+many different installer types, giving you the most amount of flexibility of how you'd like software installed.
+New installer types can be added into the system easily.
+
+For example, you could install Rails via gems, nginx via source, and mysql via APT, while retaining the flexibility
+of changing installer types as software is updated upstream.
+
+Sprinkle also supports dependencies between packages, allowing you specify pre-requisites that need to be
+installed in order.
+
+Packages can be grouped into polices to define several packages that should be installed together.
+
+An example policy:
+
+    policy :rails, :roles => :app do
+      requires :rails, :version => '2.1.0'
+      requires :appserver
+      requires :database
+      requires :webserver
+    end
+
+This defines a policy called Rails, that applies to machines of role :app. The policy includes the packages
+rails (version 2.1.0), appserver, database and webserver.
+
+appserver, database and webserver can be virtual packages, where the user will be prompted for selection if
+multiple choices for the virtual package exist.
+
+Sprinkle is architected to be extendable in many ways, one of those areas is in its deployment of commands to
+remote hosts. Currently Sprinkle supports the use of Capistrano or Vlad to issue commands on remote hosts via ssh,
+but could also be extended to use any other command transport mechanism or be used to simply issue installation
+commands on the local system.
+
+An full example Sprinkle deployment script for deploying Rails (via gems), MySQL (via APT), and Apache (via source):
+
+    # Sprinkle Rails deployment script
+    #
+    # This is an example Sprinkle script, configured to install Rails from gems, Apache and Ruby 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
+    #
+    #  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
+    #
+    # Policies
+    #
+    #  Names a group of packages (optionally with versions) that apply to a particular set of roles.
+    #
+    # 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).
+
+    # 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"
+      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 :mysql, :provides => :database do
+      description 'MySQL Database'
+      apt %w( mysql-server mysql-client )
+    end
+
+    package :apache, :provides => :webserver do
+      description 'Apache 2 HTTP Server'
+      version '2.2.9'
+      source "http://apache.wildit.net.au/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
+
+    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
+
+    package :mongrel do
+      description 'Mongrel Application Server'
+      gem 'mongrel'
+      version '1.1.5'
+    end
+
+    package :mongrel_cluster, :provides => :appserver do
+      description 'Cluster Management for Mongrel'
+      gem 'mongrel_cluster' # :source => 'http://gems.github.com/' for alternate gem server
+      version '1.0.5'
+      requires :mongrel
+    end
+
+    # Policies
+
+    # Associates the rails policy to the application servers. Contains rails, and surrounding
+    # packages. Note, appserver, database and webserver 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
+    end
+
+    # Deployment
+
+    # Configures sprinkle 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'           # where all source packages will be configured to install
+        archives '/usr/local/sources'   # where all source packages will be downloaded to
+        builds   '/usr/local/build'     # where all source packages will be built
+      end
+
+    end
+
+Please see the examples directory for more complete examples of Sprinkle deployment scripts.
+
+Sprinkle is a work in progress and I'm excited to hear if anyone finds it useful - please feel free to
+comment, ask any questions, or send in any ideas, patches, bugs. All most welcome.
+
+Marcus Crafter <crafterm@redartisan.com>
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Marcus Crafter <crafterm@redartisan.com>
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/bin/sprinkle

@@ -0,0 +1,86 @@
+#!/usr/bin/env ruby
+#
+#  Created on 2008-3-11.
+#  Copyright (c) 2008. All rights reserved.
+
+begin
+  require 'rubygems'
+rescue LoadError
+  # no rubygems to load, so we fail silently
+end
+
+require 'optparse'
+
+# NOTE: the option -p/--path= is given as an example, and should probably be replaced in your application.
+
+OPTIONS = {}
+MANDATORY_OPTIONS = %w( path )
+
+parser = OptionParser.new do |opts|
+  opts.banner = <<BANNER
+Sprinkle
+========
+
+http://github.com/crafterm/sprinkle
+
+Sprinkle is a software provisioning tool you can use to build remote servers with. eg. to
+install a Rails or Merb stack on a brand new slice directly after its been created. It uses
+a Ruby based domain specific language to describe packages and policies to determine what
+should be installed on particular systems.
+
+Please see http://github.com/crafterm/sprinkle/tree/master/README.txt for more information.
+
+Usage
+=====
+
+$> #{File.basename($0)} [options]
+
+Options are:
+BANNER
+  opts.separator ""
+  opts.on("-s", "--script=PATH", String,
+          "Path to a sprinkle script to run") { |OPTIONS[:path]| }
+  opts.on("-t", "--test",
+          "Process but don't perform any actions") { |OPTIONS[:testing]| }
+  opts.on("-v", "--verbose",
+          "Verbose output") { |OPTIONS[:verbose]| }
+  opts.on("-c", "--cloud",
+          "Show powder cloud, ie. package hierarchy and installation order") { |OPTIONS[:cloud]| }
+  opts.on("-f", "--force",
+          "Force installation of all packages even if it is detected that it has been previously installed") { |OPTIONS[:force]| }
+  opts.on("-h", "--help",
+          "Show this help message.") { puts opts; exit }
+  opts.parse!(ARGV)
+
+  if MANDATORY_OPTIONS && MANDATORY_OPTIONS.find { |option| OPTIONS[option.to_sym].nil? }
+    puts opts; exit
+  end
+end
+
+def force_mode(options)
+  Sprinkle::OPTIONS[:force] = OPTIONS[:force] || false
+end
+
+def operation_mode(options)
+  Sprinkle::OPTIONS[:testing] = OPTIONS[:testing] || false
+end
+
+def powder_cloud(options)
+  Sprinkle::OPTIONS[:cloud] = OPTIONS[:cloud] || false
+end
+
+def log_level(options)
+  Object.logger.level = ActiveSupport::BufferedLogger::Severity::DEBUG if options[:verbose]
+end
+
+require 'sprinkle'
+
+powder = OPTIONS[:path]
+raise "Sprinkle script is not readable: #{powder}" unless File.readable?(powder)
+
+force_mode(OPTIONS)
+operation_mode(OPTIONS)
+powder_cloud(OPTIONS)
+log_level(OPTIONS)
+
+Sprinkle::Script.sprinkle File.read(powder), powder

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",
+    "--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'