sprinkle 0.5.1.1 → 0.5.2

data/CHANGELOG.md

@@ -0,0 +1,15 @@
+*   Sprinkle `sudo_cmd` and Capistrino should work together instead of getting in each others way
+    
+    When using the capistrano actor `sudo_cmd` will now use the capistrano
+    generated sudo command and therefore automatically deal with password
+    prompts, etc.  This should fix hangs when installers try to call `sudo` on 
+    the other side of a pipe operation and capistrano can not recognize the
+    password prompt.
+
+*   Sprinkle executable should return an error code if there was a failure
+
+    *Michael Nigh*
+    
+*   verify of local actor was never returning false so installers would never be executed
+
+    *Edgars Beigarts*

data/lib/sprinkle/actors/actor.rb

@@ -15,6 +15,8 @@ module Sprinkle
     # * install (installer, roles, options)
     # * verify (verifier, roles, options)
     # * servers_for_role? (roles)
+    # * sudo?
+    # * sudo_command
     #
     # Hopefully these methods are kind of fairly obvious.  They should return true
     # to indicate success and false to indicate failure.
@@ -35,6 +37,19 @@ module Sprinkle
         raise "you must define install"
       end
       
+      # an actor must define this and let the installers know if it plans
+      # to try and add sudo to all of their commands or not since some
+      # installers might need to handle sudo their own special way
+      def sudo?
+        raise "you must define sudo?"
+      end
+      
+      # if an installer needs to call sudo this is the command the actor
+      # would prefer the installers to use
+      def sudo_command
+        raise "you must define sudo_command"
+      end
+      
       def verify(*args)
         raise "you must define verify"
       end

data/lib/sprinkle/actors/capistrano.rb

@@ -38,6 +38,14 @@ module Sprinkle
         end
       end
       
+      def sudo?
+        @config.fetch(:run_method, :sudo) == :sudo
+      end
+      
+      def sudo_command
+        @config.sudo
+      end
+      
       # Determines if there are any servers for the given roles
       def servers_for_role?(roles)
         roles=Array(roles)
@@ -79,13 +87,15 @@ module Sprinkle
       end
       
       def verify(verifier, roles, opts = {}) #:nodoc:
-        process(verifier.package.name, verifier.commands, roles, 
-          :suppress_and_return_failures => true)
+        process(verifier.package.name, verifier.commands, roles)
+      rescue ::Capistrano::CommandError
+        return false
       end
             
       def process(name, commands, roles, opts = {}) #:nodoc:
         inst=@installer
         @log_recorder = log_recorder = Sprinkle::Utility::LogRecorder.new
+        commands = commands.map {|x| rewrite_command(x)}
         define_task(name, roles) do
           via = fetch(:run_method, :sudo)
           commands.each do |command|
@@ -110,6 +120,17 @@ module Sprinkle
 			
       private
             
+        # rip out any double sudos from the beginning of the command
+        def rewrite_command(cmd)
+          return cmd if cmd.is_a?(Symbol)
+          via = @config.fetch(:run_method, :sudo)
+          if via == :sudo and cmd =~ /^#{sudo_command}/
+            cmd.gsub(/^#{sudo_command}\s?/,"")
+          else
+            cmd
+          end
+        end
+        
         def raise_error(e)
           details={:command => @log_recorder.command, :code => "??", 
             :message => e.message,
@@ -120,11 +141,7 @@ module Sprinkle
       
         def run_task(task, opts={})
           run(task)
-          return true
-        rescue ::Capistrano::CommandError => e
-          return false if opts[:suppress_and_return_failures]
-          # Reraise error if we're not suppressing it
-          raise
+          true
         end
 
         # REVISIT: can we set the description somehow?

data/lib/sprinkle/actors/local.rb

@@ -24,6 +24,9 @@ module Sprinkle
         true
       end
       
+      def sudo?; false; end
+      def sudo_command; nil; end
+      
       def install(installer, roles, opts = {}) #:nodoc:
         # all local installer cares about is the commands
         @installer = installer
@@ -35,7 +38,10 @@ module Sprinkle
       end
       
       def verify(verifier, roles, opts = {}) #:nodoc:
-        process(verifier.package.name, verifier.commands, roles, :suppress_and_return_failures => true)
+        process(verifier.package.name, verifier.commands, roles)
+        true
+      rescue LocalCommandError
+        false
       end
       
     protected
@@ -44,15 +50,14 @@ module Sprinkle
         @log_recorder = Sprinkle::Utility::LogRecorder.new
         commands.each do |command|
           if command == :RECONNECT
-            return true
+            res = 0
           elsif command == :TRANSFER
             res = transfer(@installer.sourcepath, @installer.destination, roles,
               :recursive => @installer.options[:recursive])
-            raise LocalCommandError if res != 0
           else
             res = run_command command
-            raise LocalCommandError if res != 0 and not opts[:suppress_and_return_failures]
           end
+          raise LocalCommandError if res != 0
         end
         return true
       end

data/lib/sprinkle/actors/ssh.rb

@@ -88,9 +88,17 @@ module Sprinkle
       end
 
       # Set this to true to prepend 'sudo' to every command.
-      def use_sudo(value)
+      def use_sudo(value=true)
         @options[:use_sudo] = value
       end
+      
+      def sudo?
+        @options[:use_sudo]
+      end
+      
+      def sudo_command
+        "sudo"
+      end
 
       def setup_gateway #:nodoc:
         @gateway ||= Net::SSH::Gateway.new(@options[:gateway], @options[:user]) if @options[:gateway]
@@ -104,8 +112,9 @@ module Sprinkle
         @verifier = verifier
         # issue all the verification steps in a single SSH command
         commands=[verifier.commands.join(" && ")]
-        process(verifier.package.name, commands, roles, 
-          :suppress_and_return_failures => true)
+        process(verifier.package.name, commands, roles)
+      rescue SSHCommandFailure => e
+        false
       ensure
         @verifier = nil
       end
@@ -126,9 +135,7 @@ module Sprinkle
         end
       
         def process(name, commands, roles, opts = {}) #:nodoc:
-          opts.reverse_merge!(:suppress_and_return_failures => false)
           setup_gateway
-          @suppress = opts[:suppress_and_return_failures]
           r=execute_on_role(commands, roles)
           logger.debug green "process returning #{r}"
           return r
@@ -143,10 +150,10 @@ module Sprinkle
         end
         
         def prepare_commands(commands)
-          return commands unless @options[:use_sudo]
+          return commands unless sudo?
           commands.map do |command| 
             next command if command.is_a?(Symbol)
-            command.match(/^sudo/) ? command : "sudo #{command}"
+            command.match(/^#{sudo_command}/) ? command : "#{sudo_command} #{command}"
           end
         end
         
@@ -166,13 +173,9 @@ module Sprinkle
             @log_recorder.reset cmd
             res = ssh(session, cmd)
             if res != 0 
-              if @suppress
-                return false
-              else
-                fail=SSHCommandFailure.new
-                fail.details = @log_recorder.hash.merge(:hosts => host)
-                raise fail, "#{cmd} failed with error code #{res[:code]}"
-              end
+              fail=SSHCommandFailure.new
+              fail.details = @log_recorder.hash.merge(:hosts => host)
+              raise fail, "#{cmd} failed with error code #{res[:code]}"
             end
           end
           true

data/lib/sprinkle/actors/vlad.rb

@@ -27,6 +27,15 @@ module Sprinkle
         raise "The vlad actor needs a maintainer.  "+
         "Please file an issue on github.com/sprinkle-tool/sprinkle if you can help."
       end
+      
+      def sudo?
+        # TODO
+        raise
+      end
+      
+      def sudo_command
+        "sudo"
+      end
 
       # Defines a script file which will be included by vlad. Use these
       # script files to set vlad specific configurations. Multiple scripts
@@ -66,7 +75,7 @@ module Sprinkle
       protected
       
       def process(name, commands, roles, opts ={}) #:nodoc:
-        commands = commands.map{|x| "sudo #{x}"} if use_sudo
+        commands = commands.map{|x| "#{sudo_command} #{x}"} if sudo?
         commands = commands.join(' && ')
         puts "executing #{commands}"
         task = remote_task(task_sym(name), :roles => roles) { run commands }
@@ -75,7 +84,7 @@ module Sprinkle
       
       def process_with_transfer(name, commands, roles, opts ={}) #:nodoc:
         raise "cant do non recursive file transfers, sorry" if opts[:recursive] == false
-        commands = commands.map{|x| x == :TRANSFER : x ? "sudo #{x}" } if use_sudo
+        commands = commands.map{|x| x == :TRANSFER ? x : "sudo #{x}" } if sudo?
         i = commands.index(:TRANSFER)
         before = commands.first(i).join(" && ")
         after = commands.last(commands.size-i+1).join(" && ")

data/lib/sprinkle/deployment.rb

@@ -80,10 +80,10 @@ module Sprinkle
         end
       rescue Sprinkle::Errors::RemoteCommandFailure => e
         e.print_summary
-        exit
+        exit 1
       rescue Sprinkle::Errors::TransferFailure => e
         e.print_summary
-        exit
+        exit 2
       ensure
         # do any cleanup our actor may need to close network sockets, etc
         @style.teardown if @style.respond_to?(:teardown)        

data/lib/sprinkle/installers/installer.rb

@@ -80,11 +80,11 @@ module Sprinkle
       end
             
       def sudo_cmd
-        "sudo " if sudo?
+        return "#{@delivery.try(:sudo_command) || "sudo"} " if sudo?
       end
 
       def sudo?
-        options[:sudo] or package.sudo?
+        options[:sudo] or package.sudo? or @delivery.try(:sudo?)
       end
 
       def escape_shell_arg(str)

data/lib/sprinkle/installers/runner.rb

@@ -34,7 +34,7 @@ module Sprinkle
       protected
         
         def install_commands #:nodoc:
-          sudo_cmd ? 
+          sudo? ? 
             @cmds.map { |cmd| "#{sudo_cmd}#{cmd}"} :
             @cmds
         end

data/lib/sprinkle/installers/yum.rb

@@ -16,6 +16,12 @@ module Sprinkle
     #   package :magic_beans do
     #     yum "magic_beans", "magic_sauce"
     #   end
+    #
+    # To install a specific version just add that version after the name
+    #
+    #   package :magic_beans do
+    #     yum "magic_beans-3.0" 
+    #   end
     class Yum < PackageInstaller
 
       auto_api

data/lib/sprinkle/package.rb

@@ -222,78 +222,66 @@ module Sprinkle
           v.process(roles)
         end
       end
-      
-      def dependencies
-        @dependencies.map {|a,b| a }
-      end
-      
+                  
       def requires(*packages)
-        opts = packages.extract_options!
-        packages.each do |pack|
-          @dependencies << [pack, opts]
-        end
+        add_dependencies packages, :dependencies
       end
 
       def recommends(*packages)
-        opts = packages.extract_options!
-        packages.each do |pack|
-          @recommends << [pack, opts]
-        end
-        @recommends.map {|a,b| a }
+        add_dependencies packages, :recommends
       end
 
       def optional(*packages)
-        opts = packages.extract_options!
-        packages.each do |pack|
-          @optional << [pack, opts]
-        end
-        @optional.map {|a,b| a }
+        add_dependencies packages, :optional
       end
-
+      
+      def dependencies
+        @dependencies.map {|a,b| a }
+      end
+      
       def tree(depth = 1, &block)
         packages = []
-
-        @recommends.each do |dep, config|
-          package = PACKAGES[dep]
-          next unless package # skip missing recommended packages as they're allowed to not exist
-          package=package.instance(config)
-          block.call(self, package, depth) if block
-          packages << package.tree(depth + 1, &block)
-        end
-
-        @dependencies.each do |dep, config|
-          package = PACKAGES[dep]
-          package = select_package(dep, package) if package.is_a? Array
-          
-          raise "Package definition not found for key: #{dep}" unless package
-          package = package.instance(config)
-          block.call(self, package, depth) if block
-          packages << package.tree(depth + 1, &block)
-        end
-
+        packages << tree_for_packages(@recommends, :depth => depth, &block)
+        packages << tree_for_packages(@dependencies, :depth => depth, :required => true, &block)
         packages << self
-
-        @optional.each do |dep, config|
-          package = PACKAGES[dep]
-          next unless package # skip missing optional packages as they're allow to not exist
-          package = package.instance(config)
-          block.call(self, package, depth) if block
-          packages << package.tree(depth + 1, &block)
-        end
-
+        packages << tree_for_packages(@optional, :depth => depth, &block)
         packages
       end
 
       def to_s; @name; end
       
-      protected
+    protected
       
       def install(i)
         @installers << i
         i
       end
 
-      private
+    private
+      
+      def add_dependencies(packages, kind)
+        opts = packages.extract_options!
+        depends = instance_variable_get("@#{kind}")
+        packages.each do |pack|
+          depends << [pack, opts]
+        end
+        depends.map {|a,b| a }
+      end
+      
+      def tree_for_packages(packages, opts={}, &block)
+        depth = opts[:depth]
+        tree = []
+        packages.each do |dep, config|
+          package = PACKAGES[dep]
+          raise "Package definition not found for key: #{dep}" if not package and opts[:required]
+          next unless package # skip missing recommended packages as they're allowed to not exist
+          package = select_package(dep, package) if package.is_a? Array
+          package = package.instance(config)
+          block.call(self, package, depth) if block
+          tree << package.tree(depth + 1, &block)
+        end
+        tree
+      end
       
         def cloud_info(message)
           logger.info(message) if Sprinkle::OPTIONS[:cloud] or logger.debug?

data/lib/sprinkle/version.rb

@@ -1,3 +1,3 @@
 module Sprinkle
-  Version = "0.5.1.1"
+  Version = "0.5.2"
 end

data/spec/sprinkle/actors/capistrano_spec.rb

@@ -89,6 +89,30 @@ describe Sprinkle::Actors::Capistrano do
     end
 
   end
+  
+  describe 'verifications' do
+    
+    before do
+      @commands = %w( op1 op2 )
+      @roles    = %w( app )
+      @package = stub(:name => "name")
+      @cap = create_cap 
+      @verifier = stub(:package => @package, :commands => ["op1", "op2"])
+    end
+    
+    it "should return true if successful" do
+      @cap.stub!(:run).and_return
+      res = @cap.verify(@verifier, @roles)
+      res.should == true
+    end
+    
+    it "should return false if there was an error" do
+      @cap.stub!(:run).and_raise(::Capistrano::CommandError)
+      res = @cap.verify(@verifier, @roles)
+      res.should == false
+    end
+    
+  end
 
   describe 'processing commands' do
 
@@ -102,6 +126,14 @@ describe Sprinkle::Actors::Capistrano do
       
       @testing_errors = false
     end
+    
+    it "should strip excessive occurrences of sudo" do
+      # pretend the package or installer has also added sudo
+      @commands =["sudo op1"]
+      @cap.stub(:sudo_command).and_return("sudo")
+      @cap.unstub!(:run)
+      @cap.config.should_receive(:invoke_command).with('op1', :via => :sudo).ordered.and_return
+    end
 
     it 'should dynamically create a capistrano task containing the commands' do
       @cap.config.should_receive(:task).and_return
@@ -118,17 +150,6 @@ describe Sprinkle::Actors::Capistrano do
       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
@@ -141,6 +162,7 @@ describe Sprinkle::Actors::Capistrano do
       @source = 'source'
 			@dest   = 'dest'
       @roles    = %w( app )
+      @commands = [:TRANSFER]
       @name     = 'name'
 
       @cap = create_cap do; recipes 'deploy'; end
@@ -167,17 +189,6 @@ describe Sprinkle::Actors::Capistrano do
       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 @package.name, @installer.install_sequence, @roles
     end
@@ -191,12 +202,12 @@ describe Sprinkle::Actors::Capistrano do
       @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)
+      @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 run the supplied commands' do

data/spec/sprinkle/actors/local_spec.rb

@@ -33,13 +33,18 @@ describe Sprinkle::Actors::Local do
       @verifier.commands += ["test","test"]
       @roles    = %w( app )
       @name     = 'name'
-
-      @local.stub!(:run_command).and_return(0)
+    end
+    
+    it 'should return false when verification fails' do
+      @local.stub!(:run_command).and_return(1)
+      res = @local.verify @verifier, @roles
+      res.should == false
     end
 
     it 'should run the commands on the local system' do
-      @local.should_receive(:run_command).twice.and_return
-      @local.verify @verifier, @roles
+      @local.stub!(:run_command).and_return(0)
+      res = @local.verify @verifier, @roles
+      res.should == true
     end
     
   end

data/spec/sprinkle/installers/apt_spec.rb

@@ -73,7 +73,8 @@ describe Sprinkle::Installers::Apt do
     end
 
     it 'should install a specific version if defined' do
-      pending
+      @installer = create_apt 'ruby=2'
+      @installer.send(:install_sequence).should == [ %(env DEBCONF_TERSE='yes' DEBIAN_PRIORITY='critical' DEBIAN_FRONTEND=noninteractive apt-get --force-yes -qyu install ruby=2)]
     end
 
   end

data/spec/sprinkle/installers/brew_spec.rb

@@ -47,8 +47,6 @@ describe Sprinkle::Installers::Brew do
       @installer.send(:install_sequence).should == [ 'op1', %(brew install ruby), 'op2' ]
     end
 
-    it 'should install a specific version if defined'
-
   end
   
   # describe 'during dependencies only installation' do

data/spec/sprinkle/installers/installer_spec.rb

@@ -7,7 +7,8 @@ describe Sprinkle::Installers::Installer do
     @package = mock(Sprinkle::Package, :name => 'package')
     @empty = Proc.new { }
     @sequence = ['op1', 'op2']
-    @delivery = mock(Sprinkle::Deployment, :process => true, :install => true)
+    @delivery = mock(Sprinkle::Deployment, :process => true, :install => true, 
+      :sudo_command => "sudo")
     @installer = create_installer
     @installer.delivery = @delivery
     @roles = []
@@ -102,6 +103,12 @@ describe Sprinkle::Installers::Installer do
         @installer.delivery = @delivery
       end
       
+      it "should use sudo command from actor" do
+        @installer.delivery = mock(Sprinkle::Deployment, :process => true, :install => true, 
+          :sudo_command => "sudo -p blah")
+        @installer.sudo_cmd.should =~ /sudo -p blah /  
+      end
+      
       it "should know it uses sudo" do
         @installer.sudo?.should == true
       end

data/spec/sprinkle/installers/rpm_spec.rb

@@ -47,9 +47,6 @@ describe Sprinkle::Installers::Rpm do
       @installer.send(:install_sequence).should == [ 'op1', 'rpm -Uvh ruby', 'op2' ]
     end
 
-    it 'should specify a non interactive mode to the apt installer' do
-      pending
-    end
     it 'should install a specific version if defined' do
       pending
     end

data/spec/sprinkle/installers/yum_spec.rb

@@ -43,7 +43,8 @@ describe Sprinkle::Installers::Yum do
     end
 
     it 'should install a specific version if defined' do
-      pending
+      @installer = create_rpm 'ruby-2.0' 
+      @installer.send(:install_sequence).should == [ 'yum install ruby-2.0 -y' ]
     end
 
   end

data/sprinkle.gemspec

@@ -1,4 +1,5 @@
 require "./lib/sprinkle/version"
+require 'date'
 
 Gem::Specification.new do |s|
   s.name = "sprinkle"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sprinkle
 version: !ruby/object:Gem::Version
-  version: 0.5.1.1
+  version: 0.5.2
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-04-27 00:00:00.000000000 Z
+date: 2013-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -134,6 +134,7 @@ extra_rdoc_files:
 files:
 - .gitignore
 - .travis.yml
+- CHANGELOG.md
 - CREDITS
 - Gemfile
 - Gemfile.lock