weave 1.0.1 → 1.0.2.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 10111ae444944741cc9e41736156eb73073e68af
-  data.tar.gz: bfe973e6737f3a1be9504ba87943d6b925df5422
+  metadata.gz: 4c11f2751ec38a419142cd0f20bfab5a12f42393
+  data.tar.gz: e078add354738f1f22b85c12c01817e83349ca02
 SHA512:
-  metadata.gz: 13a82c664f62f0eda334080ca5e74788f2ab209ccd64ee3e2b4111df7442cd8693dc09c6792c3567642ab774310afffef3ad9ba9238208c2e8865bf189bd3ebf
-  data.tar.gz: 4cfe4a410fcb8af2533490d4c6aac398876c2e7129a900daa5237e8ef4a467bc2eb4000e108e5a22b291849846b52387c1b055256c637b2d61954277b162c25e
+  metadata.gz: d86352f8c23e2b51dd8f64ffbe91b5f5e8da46452442656b24dd07cec4e0ee5600958179f70685ef2244184424b5425b7ec064b7be7d0b69b0cc07eb7f2ea561
+  data.tar.gz: 824967f7cd66565084c8376899abd1379ef10a222e309603435f224f3edbfb0e692fb054ee5ae2c03d46e3e952ed2997947b67dad285c49469a0bfaba0857253

data/lib/weave.rb

@@ -1,5 +1,6 @@
 require "net/ssh"
 require "thread"
+require "timeout"
 
 module Weave
   DEFAULT_THREAD_POOL_SIZE = 10
@@ -143,47 +144,71 @@ module Weave
     # command terminated via a signal or with a non-zero exit status. Otherwise (the default), these will
     # cause a `Weave::Error` to be raised.
     #
+    # The option `:timeout`, if provided, specifies the number of seconds to allow the command to execute
+    # before timing it out. If this happens, the output is unchanged (but in most cases, this will be an error
+    # as your process was killed by a signal from the pseudo-tty Weave allocates for it on the remote host).
+    # If the command is timed out, the result hash also has `:timed_out => true` (is is `false` otherwise).
+    #
     # @param [Hash] options the output options
     # @option options [Symbol] :output the output format
+    # @option options [Symbol] :continue_on_failure whether to raise an exception if the command exits with a
+    #     non-zero exit status or because of a signal
+    # @option options[Symbol] :timeout if given, how many seconds to give the command before timing it out
     def run(command, options = {})
       options[:output] ||= :pretty
       @connection ||= Net::SSH.start(@host, @user)
       result = options[:output] == :capture ? { :stdout => "", :stderr => "" } : {}
+      result[:timed_out] = false
       @connection.open_channel do |channel|
-        channel.exec(command) do |_, success|
-          unless success
-            raise Error, "Could not run ssh command: #{command}"
-          end
+        channel.request_pty do |ch, success|
+          raise Error, "Error requesting pty" unless success
+          ch.exec(command) do |_, succ|
+            unless succ
+              raise Error, "Could not run ssh command: #{command}"
+            end
 
-          channel.on_data do |_, data|
-            append_or_print_output(result, data, :stdout, options)
-          end
+            ch.on_data do |_, data|
+              append_or_print_output(result, data, :stdout, options)
+            end
 
-          channel.on_extended_data do |_, type, data|
-            next unless type == 1
-            append_or_print_output(result, data, :stderr, options)
-          end
+            ch.on_extended_data do |_, type, data|
+              next unless type == 1
+              append_or_print_output(result, data, :stderr, options)
+            end
 
-          channel.on_request("exit-status") do |_, data|
-            code = data.read_long
-            unless code.zero? || options[:continue_on_failure]
-              raise Error, "[#{@host}] command finished with exit status #{code}: #{command}"
+            ch.on_request("exit-status") do |_, data|
+              code = data.read_long
+              unless code.zero? || options[:continue_on_failure]
+                raise Error, "[#{@host}] command finished with exit status #{code}: #{command}"
+              end
+              result[:exit_code] = code
             end
-            result[:exit_code] = code
-          end
 
-          channel.on_request("exit-signal") do |_, data|
-            signal = data.read_long
-            unless options[:continue_on_failure]
-              signal_name = Signal.list.invert[signal]
-              signal_message = signal_name ? "#{signal} (#{signal_name})" : "#{signal}"
-              raise Error, "[#{@host}] command received signal #{signal_message}: #{command}"
+            ch.on_request("exit-signal") do |_, data|
+              signal = data.read_long
+              unless options[:continue_on_failure]
+                signal_name = Signal.list.invert[signal]
+                signal_message = signal_name ? "#{signal} (#{signal_name})" : "#{signal}"
+                raise Error, "[#{@host}] command received signal #{signal_message}: #{command}"
+              end
+              result[:exit_signal] = signal
             end
-            result[:exit_signal] = signal
           end
         end
       end
-      @connection.loop(0.05)
+      if options[:timeout].nil?
+        @connection.loop(0.05)
+      else
+        begin
+          Timeout.timeout(options[:timeout]) do
+            @connection.loop(0.05)
+          end
+        rescue Timeout::Error
+          @connection.close
+          @connection = nil
+          result[:timed_out] = true
+        end
+      end
       result
     end
 
@@ -207,7 +232,7 @@ module Weave
 
     # @private
     def self.user_and_host(host_string)
-      user, at, host = host_string.rpartition("@")
+      user, _, host = host_string.rpartition("@")
       if [user, host].any? { |part| part.nil? || part.empty? }
         raise "Bad hostname (needs to be of the form user@host): #{host_string}"
       end

data/lib/weave/version.rb

@@ -1,3 +1,3 @@
 module Weave
-  VERSION = "1.0.1"
+  VERSION = "1.0.2.beta1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: weave
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2.beta1
 platform: ruby
 authors:
 - Caleb Spare
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-16 00:00:00.000000000 Z
+date: 2014-01-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ssh
@@ -116,9 +116,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - '>'
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.0.3