weave 0.0.2 → 0.1.0

data/examples/parallel-console.rb

@@ -5,7 +5,7 @@ require "weave"
 
 usage = <<-EOS
 Usage:
-  $ ./parallel-ssh user@host1 user@host2 ...
+  $ ruby parallel-console.rb user@host1 user@host2 ...
 EOS
 
 abort usage if ARGV.empty?
@@ -13,12 +13,20 @@ abort usage if ARGV.empty?
 $stty_state = `stty -g`.chomp
 $pool = Weave.connect(ARGV)
 
-while command = Readline.readline(">>> ", true)
+prompt = ">>> "
+while command = Readline.readline(prompt, true)
+  prompt = ">>> "
   break unless command # ctrl-D
   command.chomp!
   next if command.empty?
   break if ["exit", "quit"].include? command
-  $pool.execute { run command }
+  bad_exit = false
+  $pool.execute do
+    result = run(command, :continue_on_failure => true)
+    bad_exit = result[:exit_code] && result[:exit_code] != 0
+    bad_exit ||= result[:exit_signal]
+  end
+  prompt = "!!! " if bad_exit
 end
 
 $pool.disconnect!

data/lib/weave.rb

@@ -4,6 +4,9 @@ require "thread"
 module Weave
   DEFAULT_THREAD_POOL_SIZE = 10
 
+  # A Weave error.
+  class Error < StandardError; end
+
   # @private
   COLORS = { :red => 1, :green => 2 }
 
@@ -14,6 +17,9 @@ module Weave
   #
   # @see ConnectionPool#execute
   def self.connect(host_list, options = {}, &block)
+    unless host_list.is_a? Array
+      raise Weave::Error, "Must pass an array for host_list. Received: #{host_list.inspect}"
+    end
     pool = ConnectionPool.new(host_list)
     if block_given?
       pool.execute(options, &block)
@@ -60,24 +66,26 @@ module Weave
     # Run a command over the connection pool. The block is evaluated in the context of LazyConnection.
     #
     # @param [Hash] options the various knobs
+    # @option options [Array] :args the arguments to pass through to the block when it runs.
     # @option options [Fixnum] :num_threads the number of concurrent threads to use to process this command.
     #     Defaults to `DEFAULT_THREAD_POOL_SIZE`.
     # @option options [Boolean] :serial whether to process the command for each connection one at a time.
     # @option options [Fixnum] :batch_by if set, group the connections into batches of no more than this value
     #     and fully process each batch before starting the next one.
     def execute(options = {}, &block)
+      args = options[:args] || []
       options[:num_threads] ||= DEFAULT_THREAD_POOL_SIZE
       if options[:serial]
-        @connections.each_key { |host| @connections[host].self_eval &block }
+        @connections.each_key { |host| @connections[host].self_eval args, &block }
       elsif options[:batch_by]
         @connections.each_key.each_slice(options[:batch_by]) do |batch|
           Weave.with_thread_pool(batch, options[:num_threads]) do |host, mutex|
-            @connections[host].self_eval mutex, &block
+            @connections[host].self_eval args, mutex, &block
           end
         end
       else
         Weave.with_thread_pool(@connections.keys, options[:num_threads]) do |host, mutex|
-          @connections[host].self_eval mutex, &block
+          @connections[host].self_eval args, mutex, &block
         end
       end
     end
@@ -106,37 +114,84 @@ module Weave
       @mutex = NilMutex
     end
 
+    # A thread-safe wrapper around Kernel.puts.
+    def puts(*args) @mutex.synchronize { Kernel.puts(*args) } end
+
     # Run a command on this connection. This will open a connection if it's not already connected. The way the
     # output is presented is determined by the option `:output`. The default, `:output => :pretty`, prints
     # each line of output with the name of the host and whether the output is stderr or stdout. If `:output =>
     # :raw`, then the output will be passed as is directly back to `STDERR` or `STDOUT` as appropriate. If
-    # `:output => :capture`, then this method returns the output in a hash of the form
-    # `{ :stdout => [...], :stderr => [...] }`.
+    # `:output => :capture`, then this method puts the output into the result hash as
+    # `{ :stdout => "...", :stderr => "..." }`.
+    #
+    # The result of this method is a hash containing either `:exit_code` (if the command exited normally) or
+    # `:exit_signal` (if the command exited due to a signal). It also has `:stdout` and `:stderr` strings, if
+    # `option[:output]` was set to `:capture`.
+    #
+    # If the option `:continue_on_failure` is set to true, then this method will continue as normal if the
+    # command terminated via a signal or with a non-zero exit status. Otherwise (the default), these will
+    # cause a `Weave::Error` to be raised.
     #
     # @param [Hash] options the output options
     # @option options [Symbol] :output the output format
     def run(command, options = {})
       options[:output] ||= :pretty
       @connection ||= Net::SSH.start(@host, @user)
-      output = { :stderr => [], :stdout => [] }
-      @connection.exec(command) do |channel, stream, data|
-        case options[:output]
-        when :capture
-          output[stream] << data
-        when :raw
-          out_stream = stream == :stdout ? STDOUT : STDERR
-          out_stream.print data
-        else
-          stream_colored = case stream
-                           when :stdout then Weave.color_string("out", :green)
-                           when :stderr then Weave.color_string("err", :red)
-                           end
-          lines = data.split("\n").map { |line| "[#{stream_colored}|#{host}] #{line}" }.join("\n")
-            @mutex.synchronize { puts lines }
+      result = options[:output] == :capture ? { :stdout => "", :stderr => "" } : {}
+      @connection.open_channel do |channel|
+        channel.exec(command) do |_, success|
+          unless success
+            raise Error, "Could not run ssh command: #{command}"
+          end
+
+          channel.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
+
+          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}"
+            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}"
+            end
+            result[:exit_signal] = signal
+          end
         end
       end
-      @connection.loop(0.1)
-      (options[:output] == :capture) ? output : nil
+      @connection.loop(0.05)
+      result
+    end
+
+    # @private
+    def append_or_print_output(result, data, stream, options)
+      case options[:output]
+      when :capture
+        result[stream] << data
+      when :raw
+        out_stream = stream == :stdout ? STDOUT : STDERR
+        out_stream.print data
+      else
+        stream_colored = case stream
+                         when :stdout then Weave.color_string("out", :green)
+                         when :stderr then Weave.color_string("err", :red)
+                         end
+        lines = data.split("\n").map { |line| "[#{stream_colored}|#{host}] #{line}" }.join("\n")
+        puts lines
+      end
     end
 
     # @private
@@ -149,9 +204,9 @@ module Weave
     end
 
     # @private
-    def self_eval(mutex = nil, &block)
+    def self_eval(args, mutex = nil, &block)
       @mutex = mutex || NilMutex
-      instance_eval &block
+      instance_exec(*args, &block)
       @mutex = NilMutex
     end
 

data/lib/weave/version.rb

@@ -1,3 +1,3 @@
 module Weave
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/test/integrations/sanity_test.rb

@@ -6,6 +6,7 @@ require "weave"
 class SanityTest < Scope::TestCase
   TEST_HOSTS = [1, 2].map { |i| "weave#{i}" }
   ROOT_AT_TEST_HOSTS = TEST_HOSTS.map { |host| "root@#{host}" }
+  SINGLE_TEST_HOST = ["root@#{TEST_HOSTS[0]}"]
 
   setup_once do
     # Make sure the machines are up.
@@ -36,6 +37,18 @@ class SanityTest < Scope::TestCase
       end
     end
 
+    should "raise an exception when a command exits with non-zero exit status." do
+      assert_raises(Weave::Error) do
+        Weave.connect(SINGLE_TEST_HOST) { run("cd noexist", :output => :capture) }
+      end
+
+      results = {}
+      Weave.connect(SINGLE_TEST_HOST) do
+        results = run("exit 123", :output => :capture, :continue_on_failure => true)
+      end
+      assert_equal 123, results[:exit_code]
+    end
+
     context "in serial" do
       should "run some commands in the expected order" do
         output = []

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: weave
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-17 00:00:00.000000000 Z
+date: 2013-02-10 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ssh
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70237392577060 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,15 +21,10 @@ dependencies:
         version: 2.2.0
   type: :runtime
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: 2.2.0
+  version_requirements: *70237392577060
 - !ruby/object:Gem::Dependency
   name: vagrant
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70237392576560 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -37,15 +32,10 @@ dependencies:
         version: 1.0.5
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ~>
-      - !ruby/object:Gem::Version
-        version: 1.0.5
+  version_requirements: *70237392576560
 - !ruby/object:Gem::Dependency
   name: scope
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70237392576180 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -53,15 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70237392576180
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70237392575720 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -69,15 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70237392575720
 - !ruby/object:Gem::Dependency
   name: yard
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70237392575300 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -85,15 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70237392575300
 - !ruby/object:Gem::Dependency
   name: redcarpet
-  requirement: !ruby/object:Gem::Requirement
+  requirement: &70237392574880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -101,12 +76,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+  version_requirements: *70237392574880
 description: Simple parallel ssh.
 email:
 - cespare@gmail.com
@@ -148,7 +118,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
 summary: Simple parallel ssh.