net-ssh-simple 1.3.2 → 1.4.0

data/README.rdoc

@@ -57,21 +57,7 @@ Net::SSH::Simple is a simple wrapper around Net::SSH and Net::SCP.
  s.scp_dl 'example3.com', '/tmp/remote_foo', '/tmp/local_bar'
  s.close
 
-=== Handling a Timeout
 
- require 'net/ssh/simple'
-
- # Hint: Set timeout=0 to disable, default is 60
- begin
-   Net::SSH::Simple.sync({:timeout => 5}) do
-     ssh('example1.com', 'sleep 1')  # I will (probably) succeed!
-     ssh('example2.com', 'sleep 60') # I will fail :(
-   end
- rescue Net::SSH::Simple::Error => e
-   puts e.result.timed_out #=> true
- end
-
-  
 == Documentation
 
 See {Net::SSH::Simple}[http://rubydoc.info/gems/net-ssh-simple/Net/SSH/Simple] for more examples and full API.

data/lib/net/ssh/simple/core.rb

@@ -157,20 +157,6 @@ module Net
     #   end
     #
     # @example
-    #   # Timeout handling
-    #   #
-    #   # Note: The timeout applies to each command independently.
-    #   # Hint: Set timeout=0 to disable, default is 60
-    #   begin
-    #     Net::SSH::Simple.sync({:timeout => 5}) do
-    #       ssh('example1.com', 'sleep 1')  # I will (probably) succeed!
-    #       ssh('example2.com', 'sleep 60') # I will fail :(
-    #     end
-    #   rescue Net::SSH::Simple::Error => e
-    #     puts e.result.timed_out #=> true
-    #   end
-    #
-    # @example
     #   # Using the SCP progress callback
     #   Net::SSH::Simple.sync do
     #     scp_ul 'example1.com', '/tmp/local_foo', '/tmp/remote_bar' do |sent, total|
@@ -459,7 +445,17 @@ module Net
       #  the max number of packets to process before rekeying
       #
       # @option opts [Integer] :timeout (60)
-      #  connection timeout. this is enforced by Net::SSH::Simple.
+      #   maximum idle time before a connection will time out (0 = disable).
+      #
+      # @option opts [Integer] :operation_timeout (3600)
+      #   maximum time before aborting an operation (0 = disable).
+      #   you may use this to guard against run-away processes.
+      #
+      # @option opts [Integer] :close_timeout (5)
+      #  grace-period on close before the connection will be terminated forcefully
+      #  (0 = terminate immediately).
+      #
+      # @option opts [String] :user
       #
       # @option opts [String] :user
       #  the username to log in as
@@ -482,26 +478,31 @@ module Net
         with_session(host, opts) do |session|
           @result = Result.new(
             { :op => :ssh, :host => host, :cmd => cmd, :start_at => Time.new,
-              :opts => opts, :stdout => '', :stderr => '', :success => nil 
+              :last_event_at => Time.new, :opts => opts, :stdout => '', :stderr => '',
+              :success => nil 
             } )
 
           channel = session.open_channel do |chan|
             chan.exec cmd do |ch, success|
               @result[:success] = success
               ch.on_data do |c, data|
+                @result[:last_event_at] = Time.new
                 r = block.call(:stdout, ch, data) if block
                 @result[:stdout] += data.to_s unless r == :no_append
               end
               ch.on_extended_data do |c, type, data|
+                @result[:last_event_at] = Time.new
                 r = block.call(:stderr, ch, data) if block
                 @result[:stderr] += data.to_s unless r == :no_append
               end
               ch.on_request('exit-status') do |c, data|
+                @result[:last_event_at] = Time.new
                 exit_code = data.read_long
                 block.call(:exit_code, ch, exit_code) if block
                 @result[:exit_code] = exit_code
               end
               ch.on_request('exit-signal') do |c, data|
+                @result[:last_event_at] = Time.new
                 exit_signal = data.read_string
                 r = block.call(:exit_signal, ch, exit_signal) if block
                 @result[:exit_signal] = exit_signal
@@ -513,7 +514,7 @@ module Net
               block.call(:start, ch, nil) if block
             end
           end
-          channel.wait
+          wait_for_channel session, channel, @result, opts[:timeout]
           @result[:finish_at] = Time.new
           block.call(:finish, channel, nil) if block
           @result
@@ -561,18 +562,34 @@ module Net
       # 
       def close
         Thread.current[:ssh_simple_sessions].values.each do |session|
-          session.close
+          begin
+            Timeout.timeout(@opts[:close_timeout] || 5) { session.close }
+          rescue => e
+            begin
+              session.shutdown!
+            rescue
+            end
+          end
         end
         @result
       end
 
+
       private
-      def with_session(host, opts={:timeout => 60}, &block)
+      EXTRA_OPTS = [:operation_timeout, :close_timeout]
+
+      def with_session(host, opts={}, &block)
+        opts[:timeout] ||= 60
+        opts[:timeout] = 2**32 if opts[:timeout] == 0
+        opts[:operation_timeout] ||= 3600
+        opts[:operation_timeout] = 2**32 if opts[:operation_timeout] == 0
+        opts[:close_timeout] ||= 5
         begin
-          Timeout.timeout(opts[:timeout]) do
+          net_ssh_opts = opts.reject{|k,v| EXTRA_OPTS.include? k }
+          Timeout.timeout(opts[:operation_timeout]) do
             session = Thread.current[:ssh_simple_sessions][host.hash] \
                     = Thread.current[:ssh_simple_sessions][host.hash] \
-                   || Net::SSH.start(*[host, opts[:user], opts])
+                   || Net::SSH.start(*[host, opts[:user], net_ssh_opts])
             block.call(session)
           end
         rescue => e
@@ -585,10 +602,20 @@ module Net
         end
       end
 
+      def wait_for_channel(session, channel, result, timeout)
+        session.loop(1) do
+          if timeout < Time.now - result[:last_event_at]
+            raise Timeout::Error, 'idle timeout'
+          end
+          channel.active?
+        end
+      end
+
       def scp(mode, host, src, dst, opts={}, &block)
         @result = Result.new(
           { :op => :scp, :host => host, :opts => opts, :cmd => :scp_dl,
-            :start_at => Time.new, :src => src, :dst  => dst, :success => false
+            :last_event_at => Time.new, :start_at => Time.new, 
+            :src => src, :dst  => dst, :success => false
           } )
         with_session(host, opts) do |session|
           lt = 0
@@ -596,9 +623,10 @@ module Net
             @result[:name] ||= name
             @result[:total] ||= total
             @result[:sent] = sent
+            @result[:last_event_at] = Time.new
             block.call(sent, total) unless block.nil?
           end
-          channel.wait
+          wait_for_channel session, channel, @result, opts[:timeout]
           @result[:finish_at] = Time.new
           @result[:success] = @result[:sent] == @result[:total]
           @result
@@ -634,6 +662,7 @@ module Net
       # @attr [String] cmd Shell command (SSH only)
       # @attr [Time] start_at Operation start timestamp
       # @attr [Time] finish_at Operation finish timestamp
+      # @attr [Time] last_event_at Timestamp of last activity
       # @attr [Boolean] timed_out Set to true if the operation timed out
       # @attr [String] stdout Output to stdout (SSH only)
       # @attr [String] stderr Output to stderr (SSH only)

data/lib/net/ssh/simple/version.rb

@@ -1,7 +1,7 @@
 module Net
   module SSH
     class Simple
-      VERSION = "1.3.2"
+      VERSION = "1.4.0"
     end
   end
 end

data/spec/net-ssh-simple.rb

@@ -42,10 +42,57 @@ describe Net::SSH::Simple do
       end
     end
 
-    it "enforces timeout" do
+    it "enforces idle timeout" do
       raised = false
       begin
         r = Net::SSH::Simple.ssh('localhost', 'sleep 60', {:timeout => 1})
+      rescue => e
+        raised = true
+        e.to_s.should match /^idle timeout @ .*/
+        e.result.op == :ssh
+        e.result.timed_out.should == true
+      end
+      raised.should == true
+    end
+
+    it "enforces operation timeout on ssh" do
+      raised = false
+      begin
+        r = Net::SSH::Simple.ssh('localhost', 'while true; do echo "buh"; sleep 1; done', {:operation_timeout => 2})
+      rescue => e
+        raised = true
+        e.to_s.should match /^execution expired @ .*/
+        e.result.op == :ssh
+        e.result.timed_out.should == true
+      end
+      raised.should == true
+    end
+
+    it "enforces operation timeout on scp_ul" do
+      raised = false
+      begin
+        r = Net::SSH::Simple.scp_ul('localhost', '/tmp/ssh_test_in0',
+                                    '/tmp/ssh_test_out0', {:operation_timeout=>1}) \
+        do |sent,total|
+          sleep 5
+        end
+      rescue => e
+        raised = true
+        e.to_s.should match /^execution expired @ .*/
+        e.result.op == :ssh
+        e.result.timed_out.should == true
+      end
+      raised.should == true
+    end
+
+    it "enforces operation timeout on scp_dl" do
+      raised = false
+      begin
+        r = Net::SSH::Simple.scp_dl('localhost', '/tmp/ssh_test_in0',
+                                    '/tmp/ssh_test_out0', {:operation_timeout=>1}) \
+        do |sent,total|
+          sleep 5
+        end
       rescue => e
         raised = true
         e.to_s.should match /^execution expired @ .*/
@@ -59,6 +106,10 @@ describe Net::SSH::Simple do
       Net::SSH::Simple.ssh('localhost', 'sleep 2', {:timeout => 0})
     end
 
+    it "interprets operation_timeout=0 as no timeout" do
+      Net::SSH::Simple.ssh('localhost', 'sleep 2', {:operation_timeout => 0})
+    end
+
     it "fails gently" do
       raised = false
       begin
@@ -182,6 +233,13 @@ describe Net::SSH::Simple do
     it "returns a result" do
       Net::SSH::Simple.sync do
         ssh('localhost', 'true').success.should == true
+        # see coverage-report to see if session#shutdown! was exercised
+      end
+    end
+
+    it "force closes" do
+      Net::SSH::Simple.sync({:close_timeout => true}) do
+        ssh('localhost', 'true').success.should == true
       end
     end
 
@@ -317,7 +375,7 @@ describe Net::SSH::Simple do
     end
 
     it "handles signals" do
-      victim = Net::SSH::Simple.async do
+      victim = Net::SSH::Simple.async({:timeout => 10}) do
         begin
           ssh('localhost', 'sleep 1020304157')
         rescue => e
@@ -325,12 +383,14 @@ describe Net::SSH::Simple do
         end
       end
 
-      killer = Net::SSH::Simple.async do
+      killer = Net::SSH::Simple.async({:operation_timeout => 5}) do
+        sleep 1 while 0 != ssh('localhost', "pgrep -f 'sleep 1020304157'").exit_code
         ssh('localhost', "pkill -f 'sleep 1020304157'")
       end
 
       k = killer.value
       k.success.should == true
+      k.exit_code.should == 0
 
       v = victim.value
       v.to_s.should match /Killed by SIGTERM @ .*/
@@ -610,7 +670,8 @@ describe Net::SSH::Simple do
         end
       end
 
-      killer = Net::SSH::Simple.async do
+      killer = Net::SSH::Simple.async({:operation_timeout => 5}) do
+        sleep 1 while 0 != ssh('localhost', "pgrep -f 'sleep 1020304157'").exit_code
         ssh('localhost', "pkill -f 'sleep 1020304157'")
       end
 
@@ -649,10 +710,12 @@ describe Net::SSH::Simple do
         end
       end
 
-      killer = Net::SSH::Simple.async do
+      killer = Net::SSH::Simple.async({:operation_timeout => 5}) do
+        sleep 1 while 0 != ssh('localhost', "pgrep -f 'sleep 1020304157'").exit_code
         ssh('localhost', "pkill -f 'sleep 1020304157'")
       end
 
+
       k = killer.value
       k.success.should == true
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: net-ssh-simple
 version: !ruby/object:Gem::Version
-  version: 1.3.2
+  version: 1.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-10-26 00:00:00.000000000Z
+date: 2011-10-28 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ssh
-  requirement: &14644940 !ruby/object:Gem::Requirement
+  requirement: &9197060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: 2.1.4
   type: :runtime
   prerelease: false
-  version_requirements: *14644940
+  version_requirements: *9197060
 - !ruby/object:Gem::Dependency
   name: net-scp
-  requirement: &14643240 !ruby/object:Gem::Requirement
+  requirement: &9194900 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 1.0.4
   type: :runtime
   prerelease: false
-  version_requirements: *14643240
+  version_requirements: *9194900
 - !ruby/object:Gem::Dependency
   name: blockenspiel
-  requirement: &14642340 !ruby/object:Gem::Requirement
+  requirement: &9193640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,10 +43,10 @@ dependencies:
         version: 0.4.3
   type: :runtime
   prerelease: false
-  version_requirements: *14642340
+  version_requirements: *9193640
 - !ruby/object:Gem::Dependency
   name: hashie
-  requirement: &14641260 !ruby/object:Gem::Requirement
+  requirement: &9192620 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: 1.1.0
   type: :runtime
   prerelease: false
-  version_requirements: *14641260
+  version_requirements: *9192620
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &14630380 !ruby/object:Gem::Requirement
+  requirement: &9191660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 0.9.2.2
   type: :development
   prerelease: false
-  version_requirements: *14630380
+  version_requirements: *9191660
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &14629180 !ruby/object:Gem::Requirement
+  requirement: &9180700 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *14629180
+  version_requirements: *9180700
 - !ruby/object:Gem::Dependency
   name: cover_me
-  requirement: &14628240 !ruby/object:Gem::Requirement
+  requirement: &9179600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,7 +87,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *14628240
+  version_requirements: *9179600
 description: Net::SSH::Simple is a simple wrapper around Net::SSH and Net::SCP.
 email:
 - moe@busyloop.net
@@ -124,7 +124,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -3101248032376322476
+      hash: 2108785634158212741
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.10