powcloud-sprinkle 0.3.0

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/console

@@ -0,0 +1,8 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/sprinkle.rb'}"
+puts "Loading sprinkle gem"
+exec "#{irb} #{libs} --simple-prompt"

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,265 @@
+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 'transferring files' do
+
+    before do
+      @source = 'source'
+			@dest   = 'dest'
+      @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 calling upload' 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.transfer @name, @source, @dest, @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
+
+  describe 'generated transfer' do
+    before do
+      @source   = 'source'
+			@dest     = 'dest'
+      @roles    = %w( app )
+      @name     = 'name'
+
+      @cap = create_cap do; recipes 'deploy'; end
+      @cap.config.stub!(:upload).and_return
+    end
+
+    it 'should call upload with the source and destination via :scp' do
+      @cap.config.should_receive(:upload).with(@source, @dest, :via => :scp, :recursive => true).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.transfer @name, @source, @dest, @roles
+    end
+  end
+
+  describe 'generated transfer when recursive is false' do
+    before do
+      @source   = 'source'
+			@dest     = 'dest'
+      @roles    = %w( app )
+      @name     = 'name'
+
+      @cap = create_cap do; recipes 'deploy'; end
+      @cap.config.stub!(:upload).and_return
+    end
+
+    it 'should call upload with the source and destination via :scp' do
+      @cap.config.should_receive(:upload).with(@source, @dest, :via => :scp, :recursive => false).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.transfer @name, @source, @dest, @roles, false
+    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

data/spec/sprinkle/deployment_spec.rb

@@ -0,0 +1,80 @@
+require File.dirname(__FILE__) + '/../spec_helper'
+
+describe Sprinkle::Deployment do
+  include Sprinkle::Deployment
+  
+  def create_deployment(&block)
+    deployment do
+      delivery :capistrano, &block
+      
+      source do
+        prefix '/usr/local'
+      end
+    end
+  end
+
+  describe 'when created' do
+
+    it 'should be invalid without a block descriptor' do
+      lambda { deployment }.should raise_error
+    end
+
+    it 'should be invalid without a delivery method' do
+      lambda { @deployment = deployment do; end }.should raise_error
+    end
+
+    it 'should optionally accept installer defaults' do 
+      @deployment = create_deployment
+      @deployment.should respond_to(:source)
+    end
+    
+    it 'should provide installer defaults as a proc when requested' do 
+      @deployment = create_deployment
+      @deployment.defaults[:source].class.should == Proc
+    end
+    
+  end 
+  
+  describe 'delivery specification' do
+    
+    before do
+      @actor = mock(Sprinkle::Actors::Capistrano)
+      Sprinkle::Actors::Capistrano.stub!(:new).and_return(@actor)
+    end
+
+    it 'should automatically instantiate the delivery type' do 
+      @deployment = create_deployment
+      @deployment.style.should == @actor
+    end
+
+    it 'should optionally accept a block to pass to the actor' do
+      lambda { @deployment = create_deployment }.should_not raise_error
+    end
+
+    describe 'with a block' do
+
+      it 'should pass the block to the actor for configuration' do
+        @deployment = create_deployment do; recipes 'deploy'; end
+      end
+
+    end
+  end
+  
+  describe 'when processing policies' do 
+    
+    before do 
+      @policy = mock(Policy, :process => true)
+      POLICIES = [ @policy ]
+      @deployment = create_deployment
+    end
+    
+    it 'should apply all policies, passing itself as the deployment context' do
+      @policy.should_receive(:process).with(@deployment).and_return
+    end
+    
+    after do
+      @deployment.process
+    end
+  end
+
+end