trevorturk-sprinkle 0.2.2

data/lib/sprinkle/script.rb

@@ -0,0 +1,23 @@
+module Sprinkle
+  # = Programmatically Run Sprinkle
+  #
+  # Sprinkle::Script gives you a way to programatically run a given
+  # sprinkle script. 
+  class Script
+    # Run a given sprinkle script. This method is <b>blocking</b> so
+    # it will not return until the sprinkling is complete or fails.
+    #--
+    # FIXME: Improve documentation, possibly notify user how to tell
+    # if a sprinkling failed.
+    #++
+    def self.sprinkle(script, filename = '__SCRIPT__')
+      powder = new
+      powder.instance_eval script, filename
+      powder.sprinkle
+    end
+
+    def sprinkle #:nodoc:
+      @deployment.process if @deployment
+    end
+  end
+end

data/lib/sprinkle/verifiers/directory.rb

@@ -0,0 +1,16 @@
+module Sprinkle
+  module Verifiers
+    # = Directory Verifier
+    #
+    # Defines a verify which can be used to test the existence of a 
+    # directory.
+    module Directory
+      Sprinkle::Verify.register(Sprinkle::Verifiers::Directory)
+      
+      # Tests that the directory <tt>dir</tt> exists.
+      def has_directory(dir)
+        @commands << "test -d #{dir}"
+      end
+    end
+  end
+end

data/lib/sprinkle/verifiers/executable.rb

@@ -0,0 +1,36 @@
+module Sprinkle
+  module Verifiers
+    # = Executable Verifier
+    #
+    # Contains a verifier to check the existance of an executable
+    # script on your server.
+    # 
+    # == Example Usage
+    #
+    # First, absolute path to an executable:
+    #
+    #   verify { has_executable '/usr/special/secret/bin/scipt' }
+    #
+    # Second, a global executable which would be available anywhere on the
+    # command line:
+    #
+    #   verify { has_executable 'grep' }
+    module Executable
+      Sprinkle::Verify.register(Sprinkle::Verifiers::Executable)
+      
+      # Checks if <tt>path</tt> is an executable script. This verifier is "smart" because
+      # if the path contains a forward slash '/' then it assumes you're checking an 
+      # absolute path to an executable. If no '/' is in the path, it assumes you're
+      # checking for a global executable that would be available anywhere on the command line.
+      def has_executable(path)
+        # Be smart: If the path includes a forward slash, we're checking
+        # an absolute path. Otherwise, we're checking a global executable
+        if path.include?('/')
+          @commands << "test -x #{path}"
+        else
+          @commands << "[ -n \"`echo \\`which #{path}\\``\" ]"
+        end
+      end
+    end
+  end
+end

data/lib/sprinkle/verifiers/file.rb

@@ -0,0 +1,26 @@
+module Sprinkle
+  module Verifiers
+    # = File Verifier
+    #
+    # Contains a verifier to check the existance of a file.
+    # 
+    # == Example Usage
+    #
+    #   verify { has_file '/etc/apache2/apache2.conf' }
+    #
+    #   verify { file_contains '/etc/apache2/apache2.conf', 'mod_gzip'}
+    #
+    module File
+      Sprinkle::Verify.register(Sprinkle::Verifiers::File)
+      
+      # Checks to make sure <tt>path</tt> is a file on the remote server.
+      def has_file(path)
+        @commands << "test -f #{path}"
+      end
+      
+      def file_contains(path, text)
+        @commands << "grep '#{text}' #{path}"
+      end
+    end
+  end
+end

data/lib/sprinkle/verifiers/process.rb

@@ -0,0 +1,21 @@
+module Sprinkle
+  module Verifiers
+    # = Process Verifier
+    #
+    # Contains a verifier to check that a process is running.
+    # 
+    # == Example Usage
+    #
+    #   verify { has_process 'httpd' }
+    #
+    module Process
+      Sprinkle::Verify.register(Sprinkle::Verifiers::Process)
+      
+      # Checks to make sure <tt>process</tt> is a process running
+      # on the remote server.
+      def has_process(process)
+        @commands << "ps aux | grep '#{process}' | grep -v grep"
+      end
+    end
+  end
+end

data/lib/sprinkle/verifiers/ruby.rb

@@ -0,0 +1,25 @@
+module Sprinkle
+  module Verifiers
+    # = Ruby Verifiers
+    #
+    # The verifiers in this module are ruby specific. 
+    module Ruby
+      Sprinkle::Verify.register(Sprinkle::Verifiers::Ruby)
+      
+      # Checks if ruby can require the <tt>files</tt> given. <tt>rubygems</tt>
+      # is always included first.
+      def ruby_can_load(*files)
+        # Always include rubygems first
+        files = files.unshift('rubygems').collect { |x| "require '#{x}'" }
+        
+        @commands << "ruby -e \"#{files.join(';')}\""
+      end
+      
+      # Checks if a gem exists by calling "sudo gem list" and grepping against it.
+      def has_gem(name, version=nil)
+        version = version.nil? ? '' : version.gsub('.', '\.')
+        @commands << "sudo gem list | grep -e '^#{name} (.*#{version}.*)$'"
+      end
+    end
+  end
+end

data/lib/sprinkle/verifiers/symlink.rb

@@ -0,0 +1,30 @@
+module Sprinkle
+  module Verifiers
+    # = Symlink Verifier
+    #
+    # Contains a verifier to check the existance of a symbolic link.
+    # 
+    # == Example Usage
+    #
+    # First, checking for the existence of a symlink:
+    #
+    #   verify { has_symlink '/usr/special/secret/pointer' }
+    #
+    # Second, checking that the symlink points to a specific place:
+    #
+    #   verify { has_symlink '/usr/special/secret/pointer', '/usr/local/realfile' }
+    module Symlink
+      Sprinkle::Verify.register(Sprinkle::Verifiers::Symlink)
+      
+      # Checks that <tt>symlink</tt> is a symbolic link. If <tt>file</tt> is 
+      # given, it checks that <tt>symlink</tt> points to <tt>file</tt>
+      def has_symlink(symlink, file = nil)
+        if file.nil?
+          @commands << "test -L #{symlink}"
+        else
+          @commands << "test '#{file}' = `readlink #{symlink}`"
+        end
+      end
+    end
+  end
+end

data/lib/sprinkle/verify.rb

@@ -0,0 +1,114 @@
+module Sprinkle
+  # = Verification Methods
+  #
+  # As documented in Sprinkle::Package, you may define a block on a package
+  # which verifies that a package was installed correctly. If this verification
+  # block fails, Sprinkle will stop the script gracefully, raising the error.
+  # 
+  # In addition to checking post install if it was successfully, verification
+  # blocks are also ran before an install to see if a package is <em>already</em>
+  # installed. If this is the case, the package is skipped and Sprinkle continues
+  # with the next package. This behavior can be overriden by setting the -f flag on
+  # the sprinkle script or setting Sprinkle::OPTIONS[:force] to true if you're
+  # using sprinkle programmatically. 
+  #
+  # == An Example
+  #
+  # The following verifies that rails was installed correctly be checking to see
+  # if the 'rails' command is available on the command line:
+  #
+  #   package :rails do
+  #     gem 'rails'
+  #     
+  #     verify do
+  #       has_executable 'rails'
+  #     end
+  #   end
+  #
+  # == Available Verifiers
+  #
+  # There are a variety of available methods for use in the verification block.
+  # The standard methods are defined in the Sprinkle::Verifiers module, so see
+  # their corresponding documentation.
+  #
+  # == Custom Verifiers
+  # 
+  # If you feel that the built-in verifiers do not offer a certain aspect of
+  # verification which you need, you may create your own verifier! Simply wrap
+  # any method in a module which you want to use:
+  #
+  #   module MagicBeansVerifier
+  #     def has_magic_beans(sauce)
+  #       @commands << '[ -z "`echo $' + sauce + '`"]'
+  #     end
+  #   end
+  #
+  # The method can append as many commands as it wishes to the @commands array. 
+  # These commands will be run on the remote server and <b>MUST</b> give an
+  # exit status of 0 if successful or other if unsuccessful.
+  #
+  # To register your verifier, call the register method on Sprinkle::Verify:
+  #
+  #   Sprinle::Verify.register(MagicBeansVerifier)
+  #
+  # And now you may use it like any other verifier:
+  #
+  #   package :magic_beans do
+  #     gem 'magic_beans'
+  #     
+  #     verify { has_magic_beans('ranch') }
+  #   end
+  class Verify
+    include Sprinkle::Configurable
+    attr_accessor :package, :description, :commands #:nodoc:
+    
+    class <<self
+      # Register a verification module
+      def register(new_module)
+        class_eval { include new_module }
+      end
+    end
+    
+    def initialize(package, description = '', &block) #:nodoc:
+      raise 'Verify requires a block.' unless block
+      
+      @package = package
+      @description = description
+      @commands = []
+      @options ||= {}
+      @options[:padding] = 4
+      
+      self.instance_eval(&block)
+    end
+    
+    def process(roles, pre = false) #:nodoc:
+      assert_delivery
+      
+      description = @description.empty? ? @package.name : @description
+      
+      if logger.debug?
+        logger.debug "#{@package.name}#{description} verification sequence: #{@commands.join('; ')} for roles: #{roles}\n"
+      end
+      
+      unless Sprinkle::OPTIONS[:testing]
+        logger.info "#{" " * @options[:padding]}--> Verifying #{description}..."
+        
+        unless @delivery.process(@package.name, @commands, roles, true)
+          # Verification failed, halt sprinkling gracefully.
+          raise Sprinkle::VerificationFailed.new(@package, description)
+        end
+      end
+    end
+  end
+  
+  class VerificationFailed < Exception #:nodoc:
+    attr_accessor :package, :description
+    
+    def initialize(package, description)
+      super("Verifying #{package.name}#{description} failed.")
+      
+      @package = package
+      @description = description
+    end
+  end
+end

data/lib/sprinkle/version.rb

@@ -0,0 +1,9 @@
+module Sprinkle #:nodoc:
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 2
+    TINY  = 2
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/lib/sprinkle.rb

@@ -0,0 +1,32 @@
+require 'rubygems'
+require 'active_support'
+
+# Use active supports auto load mechanism
+ActiveSupport::Dependencies.load_paths << File.dirname(__FILE__)
+
+# Configure active support to log auto-loading of dependencies
+#ActiveSupport::Dependencies::RAILS_DEFAULT_LOGGER = Logger.new($stdout)
+#ActiveSupport::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
+
+# Object is extended to give the package, policy, and deployment methods. To
+# read about each method, see the corresponding module which is included.
+#--
+# Define a logging target and understand packages, policies and deployment DSL
+#++
+class Object
+  include Sprinkle::Package, Sprinkle::Policy, Sprinkle::Deployment
+
+  def logger # :nodoc:
+    @@__log__ ||= ActiveSupport::BufferedLogger.new($stdout, ActiveSupport::BufferedLogger::Severity::INFO)
+  end
+end

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/spec/spec.opts

@@ -0,0 +1 @@
+--colour

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+begin
+  require 'spec'
+rescue LoadError
+  require 'rubygems'
+  gem 'rspec'
+  require 'spec'
+end
+
+$:.unshift(File.dirname(__FILE__) + '/../lib')
+require 'sprinkle'
+
+module Kernel
+  def logger
+    @@__log_file__ ||= StringIO.new
+    @@__log__ = ActiveSupport::BufferedLogger.new @@__log_file__
+  end
+end

data/spec/sprinkle/actors/capistrano_spec.rb

@@ -0,0 +1,170 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe Sprinkle::Actors::Capistrano do
+
+  before do
+    @recipes = 'deploy'
+    @cap = ::Capistrano::Configuration.new
+    ::Capistrano::Configuration.stub!(:new).and_return(@cap)
+    @cap.stub!(:load).and_return
+  end
+
+  def create_cap(&block)
+    Sprinkle::Actors::Capistrano.new &block
+  end
+
+  describe 'when created' do
+
+    it 'should create a new capistrano object' do
+      ::Capistrano::Configuration.should_receive(:new).and_return(@cap)
+      create_cap
+    end
+
+    describe 'when verbose' do
+
+      before do
+        Sprinkle::OPTIONS[:verbose] = true
+      end
+
+      it 'should set verbose logging on the capistrano object' do
+        @cap = create_cap
+        @cap.config.logger.level.should == ::Capistrano::Logger::INFO
+      end
+
+    end
+
+    describe 'when not verbose' do
+
+      before do
+        Sprinkle::OPTIONS[:verbose] = false
+      end
+
+      it 'should set quiet logging on the capistrano object' do
+        @cap = create_cap
+        @cap.config.logger.level.should == ::Capistrano::Logger::IMPORTANT
+      end
+
+    end
+
+    describe 'with a block' do
+
+      before do
+        @actor = create_cap do
+          recipes 'cool gear' # default is deploy
+        end
+      end
+
+      it 'should evaluate the block against the actor instance' do
+        @actor.loaded_recipes.should include('cool gear')
+      end
+
+    end
+
+    describe 'without a block' do
+
+      it 'should automatically load the default capistrano configuration' do
+        @cap.should_receive(:load).with('deploy').and_return
+      end
+
+      after do
+        @actor = create_cap
+      end
+
+    end
+
+  end
+
+  describe 'recipes' do
+
+    it 'should add the recipe location to an internal store' do
+      @cap = create_cap do
+        recipes 'deploy'
+      end
+      @cap.loaded_recipes.should == [ @recipes ]
+    end
+
+    it 'should load the given recipe' do
+      @cap.should_receive(:load).with(@recipes).and_return
+      create_cap
+    end
+
+  end
+
+  describe 'processing commands' do
+
+    before do
+      @commands = %w( op1 op2 )
+      @roles    = %w( app )
+      @name     = 'name'
+
+      @cap = create_cap do; recipes 'deploy'; end
+      @cap.stub!(:run).and_return
+      
+      @testing_errors = false
+    end
+
+    it 'should dynamically create a capistrano task containing the commands' do
+      @cap.config.should_receive(:task).and_return
+    end
+
+    it 'should invoke capistrano task after creation' do
+      @cap.should_receive(:run).with(@name).and_return
+    end
+    
+    it 'should raise capistrano errors when suppressing parameter is not set' do
+      @testing_errors = true
+      
+      @cap.should_receive(:run).and_raise(::Capistrano::CommandError)
+      lambda { @cap.process @name, @commands, @roles }.should raise_error(::Capistrano::CommandError)
+    end
+    
+    it 'should not raise errors and instead return false when suppressing parameter is set' do
+      @testing_errors = true
+      
+      @cap.should_receive(:run).and_raise(::Capistrano::CommandError)
+      
+      value = nil
+      lambda { value = @cap.process(@name, @commands, @roles, true) }.should_not raise_error(::Capistrano::CommandError)
+      
+      value.should_not be
+    end
+
+    after do
+      @cap.process @name, @commands, @roles unless @testing_errors
+    end
+
+  end
+
+  describe 'generated task' do
+
+    before do
+      @commands = %w( op1 op2 )
+      @roles    = %w( app )
+      @name     = 'name'
+
+      @cap = create_cap do; recipes 'deploy'; end
+      @cap.config.stub!(:fetch).and_return(:sudo)
+      @cap.config.stub!(:invoke_command).and_return
+    end
+
+    it 'should use sudo to invoke commands when so configured' do
+      @cap.config.should_receive(:fetch).with(:run_method, :sudo).and_return(:sudo)
+    end
+
+    it 'should run the supplied commands' do
+      @cap.config.should_receive(:invoke_command).with('op1', :via => :sudo).ordered.and_return
+      @cap.config.should_receive(:invoke_command).with('op2', :via => :sudo).ordered.and_return
+    end
+
+    it 'should be applicable for the supplied roles' do
+      @cap.stub!(:run).and_return
+      @cap.config.should_receive(:task).with(:install_name, :roles => @roles).and_return
+    end
+
+    after do
+      @cap.process @name, @commands, @roles
+    end
+
+  end
+
+end

data/spec/sprinkle/actors/local_spec.rb

@@ -0,0 +1,29 @@
+require File.dirname(__FILE__) + '/../../spec_helper'
+
+describe Sprinkle::Actors::Local do
+
+  before do
+    @local = Sprinkle::Actors::Local.new
+  end
+
+  describe 'when processing commands' do
+
+    before do
+      @commands = %w( op1 op2 )
+      @roles    = %w( app )
+      @name     = 'name'
+    
+      @local.stub!(:system).and_return
+    end
+
+    it 'should run the commands on the local system' do
+      @local.should_receive(:system).twice.and_return
+    end
+    
+    after do
+      @local.process @name, @commands, @roles
+    end
+
+  end
+
+end

data/spec/sprinkle/configurable_spec.rb

@@ -0,0 +1,46 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Sprinkle::Configurable do
+  module MyPrefix
+    class Configurable
+      include Sprinkle::Configurable
+    end
+  end
+  
+  before do
+    @configurable = MyPrefix::Configurable.new
+    @default = Proc.new { }
+    @defaults = { :configurable => @default }
+    @deployment.stub!(:defaults).and_return(@defaults)
+    @deployment.stub!(:style)
+  end
+
+  it 'should be configurable via external defaults' do
+    @configurable.should respond_to(:defaults)
+  end
+
+  it 'should select the defaults for the particular concrete installer class' do
+    @deployment.should_receive(:defaults).and_return(@defaults)
+    @defaults.should_receive(:[]).with(:configurable).and_return(@default)
+  end
+
+  it 'should configure the installer delivery mechansim' do
+    @configurable.should_receive(:instance_eval)
+  end
+
+  it 'should maintain an options hash set arbitrarily via method missing' do
+    @configurable.instance_eval do
+      hsv 'gts'
+    end
+    @configurable.hsv.should == 'gts'
+  end
+  
+  it 'should allow the delivery instance variable to be accessed' do
+    @configurable.delivery = "string"
+    @configurable.instance_variable_get(:@delivery).should eql("string")
+  end
+
+  after do
+    @configurable.defaults(@deployment)
+  end
+end