gofer 0.5.0 → 0.6.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ODJiNjE3ZGEwZmNhZmI4ZTE4ZDdjOWE5M2YzY2EyZmYxYmM3ODZmNQ==
+  data.tar.gz: !binary |-
+    Y2E3MzlkMTliYWNlM2E4ZGRlYjFmOTU0MWYwNjYzOTUyMmZlNDkyOQ==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    MDY1NWQ4Nzg4NGNjODFhOGU0MDk5M2NlODkyYzg2YWRhNGEyOWNkM2E2MDgz
+    MzQ5ZjE5MDI2MTk3Y2ZkZmRiMmFhYzc2YWNkOTE2NDY4ZGFlNWRhMjU2NzEx
+    ZWQ4YmZhN2ZkOGE5NzQ0YzEwMzkwNGU3OTQ4NWY4MzM2MDZhOTI=
+  data.tar.gz: !binary |-
+    NzBjNzdiMDQxYTZjOGJhZmIxNzAwNGY5NWMxYWM5Mjk2YTIyMGViZTQ1ZDFh
+    ZjQzZGRlZDdmYWNkYjc4ZDNiYmNlMDQ3NDEwZGMwZmE1NTU1Y2U2ZjU4ZThk
+    YWNjZjkyZjJlNDU3ODgwN2I3YzU0Nzg1ZDI4NmVmMjVjMjMzMGI=

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 # Revision History
 
+### v0.6.0
+
+  * Add `Gofer::ClusterError` to encapsulate errors encountered during clustered runs
+  * Add support for `stdin` option on `Gofer::Host#run`
+
 ### v0.5.0
 
   * Deprecate legacy arguments in Gofer::Host.new

data/README.md

@@ -1,6 +1,7 @@
 # Gofer!
 
-[![Code Climate](https://codeclimate.com/github/mipearson/gofer.png)](https://codeclimate.com/github/mipearson/gofer)
+[![Code Climate](https://codeclimate.com/github/mipearson/gofer.png)](https://codeclimate.com/github/mipearson/gofer) [![Gem Version](https://badge.fury.io/rb/gofer.png)](http://badge.fury.io/rb/gofer) [![Dependency Status](https://gemnasium.com/mipearson/gofer.png)](https://gemnasium.com/mipearson/gofer)
+
 
 **Gofer** is a set of wrappers around the Net::SSH suite of tools to enable consistent access to remote systems.
 
@@ -66,6 +67,12 @@ puts response.stderr  # will print "goodbye\n"
 puts response.output  # will print "hello\ngoodbye\n"
 ```
 
+### Send input
+
+``` ruby
+h.run "sed 's/foo/bar/' 1>&2\n", :stdin => "hello foo\n" # response will be "hello bar"
+```
+
 ### Prefix output
 
 ``` ruby
@@ -84,7 +91,7 @@ h.quiet = true                                   # never print stdout
 ### Run the same commands on multiple hosts
 
 ``` ruby
-cluster = Gopher::Cluster.new
+cluster = Gofer::Cluster.new
 cluster << Gofer::Host.new('my.host.com', 'ubuntu', :keys => ['key.pem'], :output_prefix => "   my")
 cluster << Gofer::Host.new('other.host.com', 'ubuntu', :keys => ['key.pem'], :output_prefix => "other")
 
@@ -102,6 +109,17 @@ host.run("rake migrations")
 # Inspect the results from each host
 results = cluster.run "echo hostname"
 puts results.values.join(", ") # will print "my.host.com, other.host.com"
+
+# Capture exceptions from each host
+begin
+  cluster.run "rake deploy"
+rescue Gofer::ClusterError => e
+  e.errors.each do |host, exception|
+    $stderr.puts "Failed on #{host} with #{exception}, rolling back ..."
+    host.run "rake rollback"
+  end
+  raise e
+end
 ```
 
 ## Testing

data/lib/gofer.rb

@@ -3,6 +3,7 @@ require 'gofer/response'
 require 'gofer/host_error'
 require 'gofer/host'
 require 'gofer/cluster'
+require 'gofer/cluster_error'
 require 'gofer/version'
 
 # See Gofer::Host or Gofer::Cluster

data/lib/gofer/cluster.rb

@@ -88,15 +88,23 @@ module Gofer
     # +_in+ queue, and writes values to the +_out+ queue for syncronisation.
     def threaded(meth, *args)
       _in = run_queue
-      length = run_queue.length
+      length = _in.length
       _out = Queue.new
       results = {}
-      (0...concurrency).map do
+      errors = {}
+      results_semaphore = Mutex.new
+      errors_semaphore = Mutex.new
+      concurrency.times do
         Thread.new do
           loop do
             host = _in.pop(false) rescue Thread.exit
 
-            results[host] = host.send(meth, *args)
+            begin
+              result = host.send(meth, *args)
+              results_semaphore.synchronize { results[host] = result }
+            rescue Exception => e
+              errors_semaphore.synchronize { errors[host] = e }
+            end
             _out << true
           end
         end
@@ -106,7 +114,11 @@ module Gofer
         _out.pop
       end
 
-      results
+      if errors.size > 0
+        raise Gofer::ClusterError.new(errors)
+      else
+        results
+      end
     end
 
     def run_queue

data/lib/gofer/cluster_error.rb

@@ -0,0 +1,13 @@
+module Gofer
+  # Error(s) encountered performing a Gofer command on a cluster of hosts
+  class ClusterError < Exception
+
+    # Exception instances by host
+    attr_reader :errors
+
+    def initialize errors={}
+      @errors = errors
+      super errors.values.map(&:to_s).join(', ')
+    end
+  end
+end

data/lib/gofer/host.rb

@@ -62,6 +62,7 @@ module Gofer
     # +quiet+:: Don't print +stdout+, can also be set with +quiet=+ on the instance
     # +quiet_stderr+:: Don't print +stderr+
     # +capture_exit_status+:: Don't raise an error on a non-zero exit status
+    # +stdin+:: Send a string on +stdin+ then close the file
     def run command, opts={}
       opts[:quiet] = quiet unless opts.include?(:quiet)
       opts[:output_prefix] = @output_prefix

data/lib/gofer/ssh_wrapper.rb

@@ -65,6 +65,11 @@ module Gofer
             channel.close # Necessary or backgrounded processes will 'hang' the channel
           end
 
+          if opts[:stdin]
+            channel.send_data(opts[:stdin])
+            channel.eof!
+          end
+
         end
       end
 

data/lib/gofer/version.rb

@@ -1,3 +1,3 @@
 module Gofer # :nodoc:
-  VERSION = "0.5.0"
+  VERSION = "0.6.0"
 end

data/spec/gofer/cluster_spec.rb

@@ -15,7 +15,7 @@ describe Gofer::Cluster do
   after(:all) { clean_tmpdir }
 
   it "should run commands in parallel" do
-    results = @cluster.run("ruby -e 'puts Time.now.to_f; sleep 0.1; puts Time.now.to_f'")
+    results = @cluster.run("bash -l -c \"ruby -e 'puts Time.now.to_f; sleep 0.1; puts Time.now.to_f'\"")
 
     res1 = results[@host1].stdout.lines.to_a
     res2 = results[@host2].stdout.lines.to_a
@@ -25,7 +25,7 @@ describe Gofer::Cluster do
 
   it "should respect max_concurrency" do
     @cluster.max_concurrency = 1
-    results = @cluster.run("ruby -e 'puts Time.now.to_f; sleep 0.1; puts Time.now.to_f'")
+    results = @cluster.run("bash -l -c \"ruby -e 'puts Time.now.to_f; sleep 0.1; puts Time.now.to_f'\"")
 
     res1 = results[@host1].stdout.lines.to_a
     res2 = results[@host2].stdout.lines.to_a
@@ -33,6 +33,17 @@ describe Gofer::Cluster do
     expect(res2[0].to_f).to be >= res1[1].to_f
   end
 
+  it "should encapsulate errors in a Gofer::ClusterError container exception" do
+    expect { @cluster.run("false") }.to raise_error(Gofer::ClusterError)
+    begin
+      @cluster.run "false"
+    rescue Gofer::ClusterError => e
+      expect(e.errors.keys.length).to eq(2)
+      expect(e.errors[@host1]).to be_a(Gofer::HostError)
+      expect(e.errors[@host2]).to be_a(Gofer::HostError)
+    end
+  end
+
   # TODO: Make this a custom matcher?
   def results_should_eq expected, &block
     results = block.call

data/spec/gofer/host_spec.rb

@@ -83,6 +83,10 @@ describe Gofer::Host do
         @combined.should eq "derp: foobar\nderp: baz\n"
       end
 
+      it "should process stdin when stdin is set" do
+        @host.run "sed 's/foo/baz/'", :stdin => "foobar", :quiet => false
+        @stdout.should eq "derp: bazbar\n"
+      end
     end
 
     it "should error if a command returns a non-zero response" do

metadata

@@ -1,59 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: gofer
 version: !ruby/object:Gem::Version
-  prerelease:
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors:
 - Michael Pearson
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-06-07 00:00:00.000000000 Z
+date: 2013-10-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ssh
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 2.0.23
-    none: false
-  requirement: !ruby/object:Gem::Requirement
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 2.0.23
-    none: false
-  prerelease: false
-  type: :runtime
 - !ruby/object:Gem::Dependency
   name: net-scp
-  version_requirements: !ruby/object:Gem::Requirement
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.0.4
-    none: false
-  requirement: !ruby/object:Gem::Requirement
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 1.0.4
-    none: false
-  prerelease: false
-  type: :runtime
-description: |2
+description: ! '
 
   Gofer provides a flexible and reliable model for performing tasks on remote
+
   server using Net::SSH
+
+'
 email:
 - mipearson@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
+- .gitignore
 - CHANGELOG.md
 - Gemfile
 - README.md
@@ -61,6 +59,7 @@ files:
 - gofer.gemspec
 - lib/gofer.rb
 - lib/gofer/cluster.rb
+- lib/gofer/cluster_error.rb
 - lib/gofer/host.rb
 - lib/gofer/host_error.rb
 - lib/gofer/response.rb
@@ -73,29 +72,26 @@ files:
 - test.sh
 homepage: https://github.com/mipearson/gofer
 licenses: []
-post_install_message:
+metadata: {}
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: !binary |-
-        MA==
-  none: false
+      version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ! '>='
     - !ruby/object:Gem::Version
-      version: !binary |-
-        MA==
-  none: false
+      version: '0'
 requirements: []
-rubyforge_project:
-rubygems_version: 1.8.24
-signing_key:
-specification_version: 3
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
 summary: run commands on remote servers using SSH
 test_files:
 - spec/gofer/cluster_spec.rb