crafterm-sprinkle 0.1.5 → 0.1.6

data/lib/sprinkle/version.rb

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

data/spec/sprinkle/actors/capistrano_spec.rb

@@ -99,6 +99,8 @@ describe Sprinkle::Actors::Capistrano do
 
       @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
@@ -108,9 +110,27 @@ describe Sprinkle::Actors::Capistrano do
     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
+      @cap.process @name, @commands, @roles unless @testing_errors
     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

data/spec/sprinkle/installers/apt_spec.rb

@@ -22,10 +22,6 @@ describe Sprinkle::Installers::Apt do
       @installer.packages.should == ['gcc', 'gdb', 'g++']
     end
 
-  end
-
-  describe 'when created for dependencies only install' do
-
     it 'should remove options from packages list' do
       @installer = create_apt 'ruby', :dependencies_only => true
       @installer.packages.should == [ 'ruby' ]
@@ -62,7 +58,7 @@ describe Sprinkle::Installers::Apt do
   describe 'during dependencies only installation' do
 
     before do
-      @installer = create_apt 'ruby', :dependencies_only => true
+      @installer = create_apt('ruby') { dependencies_only true }
       @install_commands = @installer.send :install_commands
     end
 

data/spec/sprinkle/installers/gem_spec.rb

@@ -69,7 +69,7 @@ describe Sprinkle::Installers::Gem do
       end
 
     end
-
+    
   end
 
 end

data/spec/sprinkle/installers/installer_spec.rb

@@ -53,37 +53,10 @@ describe Sprinkle::Installers::Installer do
   end
 
   describe 'during configuration' do
-
-    before do
-      @default = Proc.new { }
-      @defaults = { :installer => @default }
-      @deployment.stub!(:defaults).and_return(@defaults)
-    end
-
-    it 'should be configurable via external defaults' do
+    # We just check to make sure it has the Sprinkle::Configurable method
+    it 'should be configurable' do
       @installer.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(:installer).and_return(@default)
-    end
-
-    it 'should configure the installer delivery mechansim' do
-      @installer.should_receive(:instance_eval)
-    end
-
-    it 'should maintain an options hash set arbitrarily via method missing' do
-      @installer.instance_eval do
-        hsv 'gts'
-      end
-      @installer.hsv.should == 'gts'
-    end
-
-    after do
-      @installer.defaults(@deployment)
-    end
-
   end
 
   describe 'during installation' do
@@ -114,6 +87,59 @@ describe Sprinkle::Installers::Installer do
         @delivery.should_receive(:process).with(@package.name, @sequence, @roles)
       end
     end
+    
+    describe "with a pre command" do
+      
+      def create_installer_with_pre_command(cmd="")
+        installer = Sprinkle::Installers::Installer.new @package do
+          pre :install, cmd
+          
+          def install_commands
+            ["installer"]
+          end          
+        end
+        
+        installer.stub!(:puts).and_return
+        installer.delivery = @delivery
+        installer
+      end
+      before do
+        @installer = create_installer_with_pre_command('run')
+      end
+      describe "string commands" do
+        it "should insert the pre command for the specific package in the installation process" do
+          @installer.send(:install_sequence).should == [ 'run', 'installer' ]
+        end
+      end      
+      describe "blocks as commands" do
+        before(:each) do          
+          @installer = Sprinkle::Installers::Installer.new @package do
+            pre :install do
+              %w(a b c)
+            end
+
+            def install_commands
+              ["installer"]
+            end          
+          end
+
+          @installer.stub!(:puts).and_return
+          @installer.delivery = @delivery
+        end
+        it "should be able to store a block if it's the pre command" do
+          @installer.send(:install_sequence).should == [ "a", "b", "c", 'installer' ]
+        end
+      end
+      describe "blocks as commands" do
+        before(:each) do
+          @array = ["a", "b"]
+          @installer = create_installer_with_pre_command(@array)
+        end
+        it "should be able to store a block if it's the pre command" do
+          @installer.send(:install_sequence).should == [ @array, 'installer' ].flatten
+        end
+      end
+    end
 
     after do
       @installer.process(@roles)

data/spec/sprinkle/package_spec.rb

@@ -26,6 +26,16 @@ describe Sprinkle::Package do
     }.should change { pre_count }.by(1)
 CODE
   end
+  
+  # More of Mitchell's meta-programming to dry up specs.
+  def create_package_with_blank_verify(n = 1)
+    eval(<<CODE)
+    @pkg = package @name do
+      gem 'gem'
+      #{"verify 'stuff happens' do; end\n" * n}
+    end
+CODE
+  end
 
   describe 'when created' do
 
@@ -221,8 +231,105 @@ CODE
       end
 
     end
+    
+    describe 'with verifications' do
+      before do
+        @pkg = create_package_with_blank_verify(3)
+        @pkg.installer = @installer
+        @installer.stub!(:defaults)
+        @installer.stub!(:process)
+      end
+      
+      describe 'with forcing' do
+        before do
+          # Being explicit
+          Sprinkle::OPTIONS[:force] = true
+        end
+        
+        it 'should process verifications only once' do
+          @pkg.should_receive(:process_verifications).once
+          @pkg.process(@deployment, @roles)
+        end
+        
+        after do
+          # Being explicit
+          Sprinkle::OPTIONS[:force] = false
+        end
+      end
+      
+      describe 'without forcing' do
+        before do
+          # Being explicit
+          Sprinkle::OPTIONS[:force] = false
+        end
+        
+        it 'should process verifications twice' do
+          @pkg.should_receive(:process_verifications).once.with(@deployment, @roles, true).and_raise(Sprinkle::VerificationFailed.new(@pkg, ''))
+          @pkg.should_receive(:process_verifications).once.with(@deployment, @roles).and_raise(Sprinkle::VerificationFailed.new(@pkg, ''))
+        end
+        
+        it 'should continue with installation if pre-verification fails' do
+          @pkg.should_receive(:process_verifications).twice.and_raise(Sprinkle::VerificationFailed.new(@pkg, ''))
+          @installer.should_receive(:defaults)
+          @installer.should_receive(:process)
+        end
+        
+        it 'should only process verifications once and should not process installer if verifications succeed' do
+          @pkg.should_receive(:process_verifications).once.and_return(nil)
+          @installer.should_not_receive(:defaults)
+          @installer.should_not_receive(:process)
+        end
+        
+        after do
+          begin
+            @pkg.process(@deployment, @roles)
+          rescue Sprinkle::VerificationFailed => e; end
+        end
+      end
+    end
 
   end
+  
+  describe 'when processing verifications' do
+    before do
+      @deployment = mock(Sprinkle::Deployment)
+      @roles = [ :app, :db ]
+      @installer = mock(Sprinkle::Installers::Installer, :defaults => true, :process => true)
+      @pkg = create_package_with_blank_verify(3)
+      @pkg.installer = @installer
+      @installer.stub!(:defaults)
+      @installer.stub!(:process)
+      @logger = mock(ActiveSupport::BufferedLogger, :debug => true, :debug? => true)
+      @logger.stub!(:info)
+    end
+    
+    it 'should request _each_ verification to configure itself against the deployment context' do
+      @pkg.verifications.each do |v|
+        v.should_receive(:defaults).with(@deployment).once
+        v.stub!(:process)
+      end
+    end
+
+    it 'should request _each_ verification to process' do
+      @pkg.verifications.each do |v|
+        v.stub!(:defaults)
+        v.should_receive(:process).with(@roles).once
+      end
+    end
+    
+    it 'should enter a log info event to notify user whats happening' do
+      @pkg.verifications.each do |v|
+        v.stub!(:defaults)
+        v.stub!(:process)
+      end
+      
+      @pkg.should_receive(:logger).once.and_return(@logger)
+    end
+    
+    after do
+      @pkg.process_verifications(@deployment, @roles)
+    end
+  end
 
   describe 'hierarchies' do
 
@@ -281,5 +388,35 @@ CODE
     end
 
   end
+  
+  describe 'with verifications' do    
+    it 'should create a Sprinkle::Verification object for the verify block' do
+      Sprinkle::Verify.should_receive(:new).once
+      
+      create_package_with_blank_verify
+    end
+    
+    it 'should create multiple Sprinkle::Verification objects for multiple verify blocks' do
+      Sprinkle::Verify.should_receive(:new).twice
+      
+      create_package_with_blank_verify(2)
+    end
+    
+    it 'should add each Sprinkle::Verificaton object to the @verifications array' do
+      @pkg = create_package_with_blank_verify(3)
+      @pkg.verifications.length.should eql(3)
+    end
+    
+    it 'should initialize Sprinkle::Verification with the package name, description, and block' do
+      Sprinkle::Verify.should_receive(:new) do |pkg, desc|
+        pkg.name.should eql(@name)
+        desc.should eql('stuff happens')
+      end
+      
+      # We do a should_not raise_error because if a block was NOT passed, an error
+      # is raised. This is specced in verification_spec.rb
+      lambda { create_package_with_blank_verify }.should_not raise_error
+    end
+  end
 
 end

data/spec/sprinkle/verify_spec.rb

@@ -0,0 +1,160 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Sprinkle::Verify do
+  before do
+    @name = :package
+    @package = package @name do
+      gem 'nonexistent'
+      verify 'moo' do
+        # Check a file exists
+        has_file 'my_file.txt'
+        
+        # Check a directory exists
+        has_directory 'mydir'
+        
+        # Check a symlink exists
+        has_symlink 'mypointer'
+        
+        # Check a symlink points to a certain file
+        has_symlink 'mypointer', 'myfile'
+        
+        # Check if an executable exists
+        has_executable '/usr/bin/ruby'
+        
+        # Check if a global executable exists (in PATH)
+        has_executable 'rails'
+        
+        # Check for a process
+        has_process 'httpd'
+        
+        # Check that ruby can include files
+        ruby_can_load 'a', 'b', 'c'
+        
+        # Check that a gem exists
+        has_gem 'rails'
+        has_gem 'rails', '2.1.0'
+      end
+    end
+    @verification = @package.verifications[0]
+    @delivery = mock(Sprinkle::Deployment, :process => true)
+    @verification.delivery = @delivery
+  end
+  
+  describe 'when created' do
+    it 'should raise error without a block' do
+      lambda { Verify.new(nil, '') }.should raise_error
+    end
+  end
+  
+  describe 'with checks' do
+    it 'should do a "test -f" on the has_file check' do
+      @verification.commands.should include('test -f my_file.txt')
+    end
+    
+    it 'should do a "test -d" on the has_directory check' do
+      @verification.commands.should include('test -d mydir')
+    end
+    
+    it 'should do a "test -L" to check something is a symbolic link' do
+      @verification.commands.should include('test -L mypointer')
+    end
+    
+    it 'should do a test equality to check a symlink points to a specific file' do
+      @verification.commands.should include("test 'myfile' = `readlink mypointer`")
+    end
+    
+    it 'should do a "test -x" to check for an executable' do
+      @verification.commands.should include("test -x /usr/bin/ruby")
+    end
+    
+    it 'should test the "which" command to look for a global executable' do
+      @verification.commands.should include('[ -n "`echo \`which rails\``" ]')
+    end
+    
+    it 'should test the process list to find a process' do
+      @verification.commands.should include("ps aux | grep 'httpd' | grep -v grep")
+    end
+    
+    it 'should check if ruby can include a, b, c' do
+      @verification.commands.should include("ruby -e \"require 'rubygems';require 'a';require 'b';require 'c'\"")
+    end
+    
+    it 'should check that a ruby gem is installed' do
+      @verification.commands.should include("sudo gem list | grep -e '^rails (.*.*)$'")
+      @verification.commands.should include("sudo gem list | grep -e '^rails (.*2\\.1\\.0.*)$'")
+    end
+  end
+  
+  describe 'with configurations' do
+    # Make sure it includes Sprinkle::Configurable
+    it 'should respond to configurable methods' do
+      @verification.should respond_to(:defaults)
+    end
+    
+    it 'should default padding option to 4' do
+      @verification.padding.should eql(4)
+    end
+  end
+  
+  describe 'with process' do
+    it 'should raise an error when no delivery mechanism is set' do
+      @verification.instance_variable_set(:@delivery, nil)
+      lambda { @verification.process([]) }.should raise_error
+    end
+    
+    describe 'when not testing' do
+      before do
+        # To be explicit
+        Sprinkle::OPTIONS[:testing] = false
+      end
+      
+      it 'should call process on the delivery with the correct parameters' do
+        @delivery.should_receive(:process).with(@name, @verification.commands, [:app], true).once.and_return(true)
+        @verification.process([:app])
+      end
+      
+      it 'should raise Sprinkle::VerificationFailed exception when commands fail' do
+        @delivery.should_receive(:process).once.and_return(false)
+        lambda { @verification.process([:app]) }.should raise_error(Sprinkle::VerificationFailed) do |error|
+          error.package.should eql(@package)
+          error.description.should eql('moo')
+        end
+      end
+    end
+    
+    describe 'when testing' do
+      before do
+        Sprinkle::OPTIONS[:testing] = true
+        @logger = mock(ActiveSupport::BufferedLogger, :debug => true, :debug? => true)
+      end
+      
+      it 'should not call process on the delivery' do
+        @delivery.should_not_receive(:process)
+      end
+
+      it 'should print the install sequence to the console' do
+        @verification.should_receive(:logger).twice.and_return(@logger)
+      end
+      
+      after do
+        @verification.process([:app])
+        Sprinkle::OPTIONS[:testing] = false
+      end
+    end
+  end
+  
+  describe 'with registering new verification modules' do
+    module MyModule
+      def rawr; end
+    end
+    
+    it 'should not respond to rawr initially' do
+      @verification.should_not respond_to(:rawr)
+    end
+    
+    it 'should respond to rawr after registering the module' do
+      Sprinkle::Verify.register(MyModule)
+      @verification.should respond_to(:rawr)
+    end
+  end
+end