crafterm-sprinkle 0.2.2 → 0.2.3

data/CREDITS

@@ -19,3 +19,8 @@ Jorgen Orehøj Erichsen (http://blog.erichsen.net)
 Joshua Sierles         (http://diluvia.net)
 Julian Russell         (http://github.com/plusplus)
 Dave (Gassto)          (http://github.com/gassto)
+Bodaniel Jeanes        (http://bjeanes.github.com)
+Jacob Harris           (http://open.nytimes.com)
+Justin Pease           (http://jit.nuance9.com)
+Tobias Lütke           (http://blog.leetsoft.com)
+Josh Reynolds          (http://github.com/jreynolds)

data/Manifest.txt

@@ -54,7 +54,13 @@ lib/sprinkle/installers/push_text.rb
 lib/sprinkle/installers/rake.rb
 lib/sprinkle/installers/rpm.rb
 lib/sprinkle/installers/source.rb
+lib/sprinkle/installers/transfer.rb
 lib/sprinkle/installers/yum.rb
+lib/sprinkle/installers/freebsd_pkg.rb
+lib/sprinkle/installers/openbsd_pkg.rb
+lib/sprinkle/installers/opensolaris_pkg.rb
+lib/sprinkle/installers/bsd_port.rb
+lib/sprinkle/installers/mac_port.rb
 lib/sprinkle/package.rb
 lib/sprinkle/policy.rb
 lib/sprinkle/script.rb
@@ -89,6 +95,10 @@ spec/sprinkle/installers/rake_spec.rb
 spec/sprinkle/installers/rpm_spec.rb
 spec/sprinkle/installers/source_spec.rb
 spec/sprinkle/installers/yum_spec.rb
+spec/sprinkle/installers/openbsd_pkg_spec.rb
+spec/sprinkle/installers/freebsd_pkg_spec.rb
+spec/sprinkle/installers/bsd_port_spec.rb
+spec/sprinkle/installers/mac_port_spec.rb
 spec/sprinkle/package_spec.rb
 spec/sprinkle/policy_spec.rb
 spec/sprinkle/script_spec.rb

data/bin/sprinkle

@@ -73,7 +73,7 @@ def log_level(options)
   Object.logger.level = ActiveSupport::BufferedLogger::Severity::DEBUG if options[:verbose]
 end
 
-require 'sprinkle'
+require File.dirname(__FILE__) + '/../lib/sprinkle'
 
 powder = OPTIONS[:path]
 raise "Sprinkle script is not readable: #{powder}" unless File.readable?(powder)

data/lib/sprinkle/actors/capistrano.rb

@@ -25,8 +25,15 @@ module Sprinkle
         @config = ::Capistrano::Configuration.new
         @config.logger.level = Sprinkle::OPTIONS[:verbose] ? ::Capistrano::Logger::INFO : ::Capistrano::Logger::IMPORTANT
         @config.set(:password) { ::Capistrano::CLI.password_prompt }
+        
+        @config.set(:_sprinkle_actor, self)
+        
+        def @config.recipes(script)
+          _sprinkle_actor.recipes(script)
+        end
+        
         if block
-          self.instance_eval &block
+          @config.instance_eval &block
         else
           @config.load 'deploy' # normally in the config directory for rails
         end
@@ -69,6 +76,22 @@ module Sprinkle
         end
       end
 
+			def transfer(name, source, destination, roles, recursive = true, suppress_and_return_failures = false)
+        define_task(name, roles) do
+          upload source, destination, :via => :scp, :recursive => recursive
+        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?

data/lib/sprinkle/actors/local.rb

@@ -25,6 +25,13 @@ module Sprinkle
         return true
       end
       
+			def transfer(name, source, destination, roles, recursive = true, suppress_and_return_failures = false)
+				if recursive
+					flags = "-R "
+				end
+				
+				system "cp #{flags}#{source} #{destination}"
+			end
     end
   end
 end

data/lib/sprinkle/actors/ssh.rb

@@ -1,4 +1,5 @@
 require 'net/ssh/gateway'
+require 'net/scp'
 
 module Sprinkle
   module Actors
@@ -26,7 +27,12 @@ module Sprinkle
         return process_with_gateway(name, commands, roles) if gateway_defined?
         process_direct(name, commands, roles)
       end
-      
+
+      def transfer(name, source, destination, roles, recursive = true, suppress_and_return_failures = false)
+        return transfer_with_gateway(name, source, destination, roles, recursive) if gateway_defined?
+        transfer_direct(name, source, destination, roles, recursive)
+      end
+			
       protected
       
         def process_with_gateway(name, commands, roles)
@@ -39,10 +45,25 @@ module Sprinkle
           Array(roles).each { |role| execute_on_role(commands, role) }
         end
         
+        def transfer_with_gateway(name, source, destination, roles, recursive)
+          on_gateway do |gateway|
+            Array(roles).each { |role| transfer_to_role(source, destination, role, recursive, gateway) }
+          end
+        end
+        
+        def transfer_direct(name, source, destination, roles, recursive)
+          Array(roles).each { |role| transfer_to_role(source, destination, role, recursive) }
+        end
+
         def execute_on_role(commands, role, gateway = nil)
           hosts = @options[:roles][role]
           Array(hosts).each { |host| execute_on_host(commands, host, gateway) }
         end
+
+        def transfer_to_role(source, destination, role, gateway = nil)
+          hosts = @options[:roles][role]
+          Array(hosts).each { |host| transfer_to_host(source, destination, host, gateway) }
+        end
         
         def execute_on_host(commands, host, gateway = nil)
           if gateway # SSH connection via gateway
@@ -64,6 +85,23 @@ module Sprinkle
           end
         end
 
+        def transfer_to_host(source, destination, host, recursive, gateway = nil)
+          if gateway # SSH connection via gateway
+            gateway.ssh(host, @options[:user]) do |ssh|
+              transfer_on_connection(source, destination, recursive, ssh)
+            end
+          else # direct SSH connection
+            Net::SSH.start(host, @options[:user]) do |ssh|
+              transfer_on_connection(source, destination, recursive, ssh)
+            end
+          end
+        end
+        
+        def transfer_on_connection(source, destination, recursive, connection)
+					scp = Net::SCP.new(connection)
+					scp.upload! source, destination, :recursive => recursive
+        end
+
       private
       
         def gateway_defined?

data/lib/sprinkle/actors/vlad.rb

@@ -50,6 +50,19 @@ module Sprinkle
         rescue ::Vlad::CommandFailedError => e
           return false if suppress_and_return_failures
           
+          # Reraise error if we're not suppressing it
+          raise
+        end
+      end
+
+			# Sorry, all transfers are recursive
+      def transfer(name, source, destination, roles, recursive = true, suppress_and_return_failures = false) #:nodoc:
+        begin
+					rsync source, destination
+          return true
+        rescue ::Vlad::CommandFailedError => e
+          return false if suppress_and_return_failures
+          
           # Reraise error if we're not suppressing it
           raise
         end

data/lib/sprinkle/deployment.rb

@@ -52,7 +52,7 @@ module Sprinkle
       # the actor. For more information on what configuration options are
       # available, view the corresponding Sprinkle::Actors page.
       def delivery(type, &block) #:doc:
-        @style = Actors.const_get(type.to_s.titleize).new &block
+        @style = ("Sprinkle::Actors::" + type.to_s.titleize).constantize.new &block
       end
 
       def method_missing(sym, *args, &block) #:nodoc:

data/lib/sprinkle/installers/gem.rb

@@ -54,6 +54,7 @@ module Sprinkle
           cmd << " --source #{source}" if source
           cmd << " --install-dir #{repository}" if option?(:repository)
           cmd << " --no-rdoc --no-ri" unless option?(:build_docs)
+          cmd << " --http-proxy #{http_proxy}" if option?(:http_proxy)
           cmd << " -- #{build_flags}" if option?(:build_flags)
           cmd
         end

data/lib/sprinkle/installers/push_text.rb

@@ -37,7 +37,7 @@ module Sprinkle
       protected
 
         def install_commands #:nodoc:
-          "echo '#{@text}' |#{'sudo' if option?(:sudo)} tee -a #{@path}"
+          "echo -e '#{@text.gsub("\n", '\n')}' |#{'sudo' if option?(:sudo)} tee -a #{@path}"
         end
 
     end

data/lib/sprinkle/installers/source.rb

@@ -46,16 +46,26 @@ module Sprinkle
     #   package :magic_beans do
     #     source 'http://magicbeansland.com/latest-1.1.1.tar.gz' do
     #       prefix    '/usr/local'
-    #       
+    #
     #       pre :prepare { 'echo "Here we go folks."' }
     #       post :extract { 'echo "I believe..."' }
     #       pre :build { 'echo "Cross your fingers!"' }
     #     end
     #   end
     #
+    # Fourth, specifying a custom archive name because the downloaded file name
+    # differs from the source URL:
+    #
+    #   package :gitosis do
+    #     source 'http://github.com/crafterm/sprinkle/tarball/master' do
+    #       custom_archive 'crafterm-sprinkle-518e33c835986c03ec7ae8ea88c657443b006f28.tar.gz'
+    #     end
+    #   end
+    #
     # As you can see, setting options is as simple as creating a
     # block and calling the option as a method with the value as 
     # its parameter.
+
     class Source < Installer
       attr_accessor :source #:nodoc:
 
@@ -143,7 +153,7 @@ module Sprinkle
         end
 
         def extract_command #:nodoc:
-          case @source
+          case archive_name
           when /(tar.gz)|(tgz)$/
             'tar xzf'
           when /(tar.bz2)|(tb2)$/
@@ -158,7 +168,7 @@ module Sprinkle
         end
 
         def archive_name #:nodoc:
-          name = @source.split('/').last
+          name = @options[:custom_archive] || @source.split('/').last
           raise "Unable to determine archive name for source: #{source}, please update code knowledge" unless name
           name
         end
@@ -168,12 +178,12 @@ module Sprinkle
         end
 
         def base_dir #:nodoc:
-          if @source.split('/').last =~ /(.*)\.(tar\.gz|tgz|tar\.bz2|tb2)/
+          if archive_name.split('/').last =~ /(.*)\.(tar\.gz|tgz|tar\.bz2|tar|tb2)/
             return $1
           end
           raise "Unknown base path for source archive: #{@source}, please update code knowledge"
         end
-        
+
     end
   end
 end

data/lib/sprinkle/package.rb

@@ -168,16 +168,24 @@ module Sprinkle
       
       def rake(name, options = {}, &block)
         @installer = Sprinkle::Installers::Rake.new(self, name, options, &block)        
+      end    
+      
+      def noop(&block)
+        @installer = Sprinkle::Installers::Noop.new(self, name, options, &block)        
       end
       
       def push_text(text, path, options = {}, &block)
         @installer = Sprinkle::Installers::PushText.new(self, text, path, options, &block)
       end
-      
-      def verify(description = '', &block)
-        @verifications << Sprinkle::Verify.new(self, description, &block)
+
+			def transfer(source, destination, options = {}, &block)
+				@installer = Sprinkle::Installers::Transfer.new(self, source, destination, options, &block)
       end
 
+      def verify(description = '', &block)
+        @verifications << Sprinkle::Verify.new(self, description, &block)
+      end  
+      
       def process(deployment, roles)
         return if meta_package?
         

data/lib/sprinkle/version.rb

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

data/spec/sprinkle/actors/capistrano_spec.rb

@@ -135,6 +135,51 @@ describe Sprinkle::Actors::Capistrano do
 
   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
@@ -167,4 +212,54 @@ describe Sprinkle::Actors::Capistrano do
 
   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/installers/gem_spec.rb

@@ -5,7 +5,7 @@ describe Sprinkle::Installers::Gem do
   before do
     @gem = 'rails'
     @version = '2.0.2'
-    @options = { :source => 'http://gems.github.com/', :repository => '/tmp/gems', :build_flags => '--build_flag=foo' }
+    @options = { :source => 'http://gems.github.com/', :repository => '/tmp/gems', :build_flags => '--build_flag=foo', :http_proxy => 'http://proxy:8080' }
   end
 
   def create_gem(gem, version = nil, options = {}, &block)
@@ -39,6 +39,10 @@ describe Sprinkle::Installers::Gem do
       @installer.build_flags.should == @options[:build_flags]
     end
 
+    it 'should optionally store the http proxy' do
+      @installer.http_proxy.should == @options[:http_proxy]
+    end
+    
   end
 
   describe 'during installation' do
@@ -86,6 +90,18 @@ describe Sprinkle::Installers::Gem do
       
     end
     
+    describe 'with http proxy' do
+      
+      before do
+        @installer = create_gem @gem, nil, :http_proxy => 'http://proxy:8080'
+      end
+      
+      it 'should install with defined build flags' do
+        @installer.send(:install_commands).should == "gem install #{@gem} --no-rdoc --no-ri --http-proxy http://proxy:8080"
+      end
+      
+    end
+    
   end
 
 end

data/spec/sprinkle/installers/push_text_spec.rb

@@ -36,7 +36,7 @@ describe Sprinkle::Installers::PushText do
     end
 
     it 'should automatically insert pre/post commands for the specified package' do
-      @installer.send(:install_sequence).should == [ 'op1', "echo 'another-hair-brained-idea' | tee -a /dev/mind/late-night", 'op2' ]
+      @installer.send(:install_sequence).should == [ 'op1', "echo -e 'another-hair-brained-idea' | tee -a /dev/mind/late-night", 'op2' ]
     end
 
   end
@@ -48,7 +48,7 @@ describe Sprinkle::Installers::PushText do
     end
     
     it "should invoke the push installer with sudo" do
-      @install_commands.should =~ /echo 'I\'m a special user' | sudo tee -a \/dev\/mind\/the-day-after/
+      @install_commands.should =~ /echo -e 'I\'m a special user' | sudo tee -a \/dev\/mind\/the-day-after/
     end
   end
 

data/spec/sprinkle/installers/source_spec.rb

@@ -161,6 +161,20 @@ describe Sprinkle::Installers::Source do
       )
     end
 
+    describe 'with a custom archive definition' do
+      before do
+        @installer.options[:custom_archive] = 'super-foo.tar'
+      end
+
+      it 'should install the source from the custom archive' do
+        @installer.send(:extract_commands).first.should =~ /super-foo/
+        @installer.send(:configure_commands).first.should =~ /super-foo/
+        @installer.send(:build_commands).first.should =~ /super-foo/
+        @installer.send(:install_commands).first.should =~ /super-foo/
+      end
+
+    end
+
     describe 'during a customized install' do
 
       before do
@@ -174,7 +188,7 @@ describe Sprinkle::Installers::Source do
       it 'should store the custom install commands' do
         @installer.options[:custom_install].should == 'ruby setup.rb'
       end
-      
+
       it 'should identify as having a custom install command' do
         @installer.should be_custom_install
       end
@@ -190,25 +204,25 @@ describe Sprinkle::Installers::Source do
       it 'should install the source using a custom installation command' do
         @installer.send(:custom_install_commands).first.should =~ /ruby setup.rb/
       end
-      
+
       it 'should be run relative to the source build area' do
         @installer.send(:custom_install_commands).first.should =~ %r{cd /usr/builds/ruby-1.8.6-p111}
       end
-      
+
       describe 'with a customized directory' do
-        
+
         before do
           @installer.options[:custom_dir] = 'test'
         end
-        
+
         it 'should install the source from the custom dir path' do
           @installer.send(:custom_install_commands).first.should =~ /test/
         end
-        
+
         it 'should store the custom build dir path' do
           @installer.options[:custom_dir].should == 'test'
         end
-        
+
       end
 
     end

data/sprinkle.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = %q{sprinkle}
-  s.version = "0.2.2"
+  s.version = "0.2.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Marcus Crafter", "Mitchell Hashimoto"]

data/tasks/deployment.rake

@@ -21,6 +21,9 @@ task :check_version do
   end
 end
 
+task :clobber_rcov do
+end
+
 desc 'Install the package as a gem, without generating documentation(ri/rdoc)'
 task :install_gem_no_doc => [:clean, :package] do
   sh "#{'sudo ' unless Hoe::WINDOZE }gem install pkg/*.gem --no-rdoc --no-ri"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: crafterm-sprinkle
 version: !ruby/object:Gem::Version 
-  version: 0.2.2
+  version: 0.2.3
 platform: ruby
 authors: 
 - Marcus Crafter