gofer 0.3.0 → 0.3.1

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    MWQwYzJjNDA5ZGZiOGQ3MDRkYWFhYmRhNGQ4MmZlNmM5OGU5MmY0OQ==
+    ZWNlZjlhNDIyYjAyMDAxMWMwNTRiMmFlN2ZjMjk4NGYzYmU4NDRlMQ==
   data.tar.gz: !binary |-
-    MTcwYTIwZDJjZWZlOGZhYWI5OTZjOWQ4NzUzM2NmYTBhNTU0YjhiMA==
+    YzA2ZmJkNGUzY2U5NmQwN2I4YTRmODIwMmY5OTJiOTk1ZmZjNjdmZQ==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    NmM0OTY3MjQ4ZDZjYjkxZDNlY2M0OTdlMzMyNmFkODA4N2Q5OTkzMzUyNGQ2
-    OWNiYjNkOTNjN2NlMDg2MDNiYTUwODEyMjUyYTFlNDg3OGNiNDE1YjI4NTNh
-    ZTJkMDlmMzcyMmMzZDI0NGEyZGQ3ZTc2Yzg3NzA4MTFkYjIyOGM=
+    ZTBmYWFhOGEwODAzMzZhNGVhNWJmOTMyNDQ0N2FjMDc5ZjkwZjI3OWU2YmQx
+    ZjZkYTZlZmQ3MWYyMGE0MWFlM2FkODFjNTI1ZjE0MGMzYjY3MTEwMzc5ZGFk
+    OGQyYTZkZmE0OWQ3NjgzN2ExYmIxMTBkZjliZDE2YzM2ZWNmMTQ=
   data.tar.gz: !binary |-
-    ZDE5ODhmYmM5NzEwZjg4MjA5YzRmYTE5ZTcxMzgzN2NmYjRkYjExMTBmMWQ1
-    NzgwYjc4OTBhYjM2YTBhZjk3ODRhYzExMzFiMzU0NDYwYTUwNGEwYzcwNDcy
-    NGNmODY4NDY4MzY0YWIxNGI2YTNhMzFiZTFiYzE5N2Y1OTBhNDI=
+    MzU4MGRhMmM1ZWNlNWE4MWFiNzZkMmViZjk1MTNiYjJmMDI1ZmZjODM4NGM3
+    NGM3YjNhOTUzYmEyYjEwYjRiZGYyN2E2ZWRmM2E0YWEyMzdiOTQ1NTYyMWUz
+    M2Q4M2U4M2Q0YmVlYmZhYTVmMDJkMzA1MGUyYTMyNzM3YzE5NjM=

data/{HISTORY.md → CHANGELOG.md}

@@ -1,4 +1,18 @@
 # Revision History
+
+### v0.3.1
+
+ * Prefix stderr/stdout per host with `:output_prefix`
+
+### v0.3.0
+
+ * Add cluster support via `Gofer::Cluster` (@rich0h)
+
+### v0.2.6 30/08/2012
+
+ * Preserve options on file upload/download
+ * Include host & server response in `Gofer::HostError` exceptions
+
 ### v0.2.5 02/06/2011
 
  * `#exists?` -> `#exist?` to be consistent with `File.exist?`
@@ -6,7 +20,7 @@
 ### v0.2.4 24/05/2011
 
  * Add `:quiet` as an option on `Gofer::Host` instantiation
- 
+
 ### v0.2.3 21/05/2011
 
  * Add `write` command to `Gofer::Host`
@@ -14,7 +28,7 @@
 ### v0.2.2 10/05/20011
 
  * Add `run_multiple` method to `Gofer::Host`
- 
+
 ### v0.2.1 08/05/2011
 
  * Add `quiet=` to Host instance to allow setting quiet to be the default.
@@ -22,7 +36,7 @@
 ### v0.2.0 03/05/2011
 
  * Flip ordering of username/hostname on instantiation to match that of `Net::SSH`
- 
+
 ### v0.1.2 03/05/2011
 
  * Pass through `Gofer::Host` instantiation options straight through to `Net::SSH`.
@@ -35,7 +49,7 @@
 
  * Replace string return from run with a 'response' object
  * Removed 'within' functionality - will be replaced by 'open' later
- 
+
 ### v0.0.1 03/04/2011
 
  * Initial release

data/README.md

@@ -61,6 +61,13 @@ puts response.stderr  # will print "goodbye\n"
 puts response.output  # will print "hello\ngoodbye\n"
 ```
 
+### Prefix output
+
+``` ruby
+h.output_prefix = 'apollo'        # or set :output_prefix on instantiation
+h.run "echo hello; echo goodbye"  # prints apollo: hello\napollo: goodbye
+```
+
 ### Suppress output
 
 ``` ruby
@@ -80,8 +87,8 @@ puts response.stdout # will print "hello\ngoodbye\n"
 
 ``` ruby
 cluster = Gopher::Cluster.new
-cluster << Gofer::Host.new('my.host.com', 'ubuntu', :keys => ['key.pem'])
-cluster << Gofer::Host.new('other.host.com', 'ubuntu', :keys => ['key.pem'])
+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")
 
 cluster.run do |c|
     c.run("hostname") # This will run on both hosts at once
@@ -92,34 +99,24 @@ cluster.run(:max_concurrency => 1) do |c|
 end
 ```
 
-## Planned Features
-
-``` ruby
-# constant connection (no reconnect for each action)
-Gofer::Host.new(...).open do |h|
-  h.run( ... )
-end
-
-# overriding defaults
-h.set :quiet => true
-h.set :capture_exit_status => false
-
-# Local system usage, too:
-Gofer::Localhost.new.run "hostname" # > my.macbook.com
-```
-
 ## Testing
 
   * Ensure that your user can ssh as itself to localhost using the key in `~/.ssh/id_rsa`.
   * Run `rspec spec` or `bundle install && rake spec`
 
+## Contributing
+
+Contributions should be via pull request. Please add tests and a note in the
+`README.md` for new functionality. Please use 1.8.7-compatiable syntax.
+
 ## TODO
 
   * ls, exists?, directory? should use sftp if available rather than shell commands
-  * wrap STDOUT with host prefix for easy identification of system output
   * Deal with timeouts/disconnects on persistent connections
-  * CHANGELOG.md
   * Release 1.0 & use Semver
+  * Ensure RDodc is complete & up to date, link to rdoc.info from README
+  * Add unit tests, bring in Travis.ci
+  * Local system usage (eg `Gofer::Localhost.new.run "hostname"`)
 
 ## License
 

data/lib/gofer/host.rb

@@ -13,13 +13,14 @@ module Gofer
   class Host
 
     attr_reader :hostname
-    attr_accessor :quiet
+    attr_accessor :quiet, :output_prefix
 
     # Create a new Host connection
     #
     # Options:
     #
     # +quiet+:: Don't print stdout output from +run+ commands
+    # +output_prefix+:: Prefix each line of stdout to differentiate multiple host output
     # All other+opts+ is passed through directly to Net::SSH.start
     # See http://net-ssh.github.com/ssh/v2/api/index.html for valid arguments.
     def initialize _hostname, username, opts={}
@@ -31,6 +32,7 @@ module Gofer
       end
 
       @quiet = opts.delete(:quiet)
+      @output_prefix = opts.delete(:output_prefix)
 
       # support legacy identity_file argument
       if opts[:identity_file]
@@ -55,6 +57,7 @@ module Gofer
     # +capture_exit_status+:: Don't raise an error on a non-zero exit status
     def run command, opts={}
       opts[:quiet] = quiet unless opts.include?(:quiet)
+      opts[:output_prefix] = @output_prefix
       response = @ssh.run command, opts
       if !opts[:capture_exit_status] && response.exit_status != 0
         raise HostError.new(self, response, "Command #{command} failed with exit status #{@ssh.last_exit_status}")

data/lib/gofer/ssh_wrapper.rb

@@ -8,6 +8,7 @@ module Gofer
 
     def initialize *args
       @net_ssh_args = args
+      @at_start_of_line = true
     end
 
     def run command, opts={}
@@ -49,14 +50,14 @@ module Gofer
           channel.on_data do |ch, data|  # stdout
             stdout += data
             output += data
-            $stdout.print data unless opts[:quiet]
+            $stdout.print wrap_output(data, opts[:output_prefix]) unless opts[:quiet]
           end
 
           channel.on_extended_data do |ch, type, data|
             next unless type == 1 # only handle stderr
             stderr += data
             output += data
-            $stderr.print data unless opts[:quiet_stderr]
+            $stderr.print wrap_output(data, opts[:output_prefix]) unless opts[:quiet_stderr]
           end
 
           channel.on_request("exit-status") do |ch, data|
@@ -70,5 +71,16 @@ module Gofer
       ssh.loop
       Gofer::Response.new(stdout, stderr, output, exit_code)
     end
+
+    def wrap_output output, prefix
+      return output unless prefix
+
+      output = "#{prefix}: " + output if @at_start_of_line
+
+      @at_start_of_line = output.end_with?("\n")
+
+      output.gsub(/\n(.)/, "\n#{prefix}: \\1")
+    end
+
   end
 end

data/lib/gofer/version.rb

@@ -1,3 +1,3 @@
 module Gofer # :nodoc:
-  VERSION = "0.3.0"
+  VERSION = "0.3.1"
 end

data/spec/gofer/integration_spec.rb

@@ -29,6 +29,14 @@ describe Gofer do
     end
   end
 
+  def with_captured_output
+    @stdout = ''
+    @stderr = ''
+    @combined = ''
+    $stdout.stub!( :write ) { |*args| @stdout.<<( *args ); @combined.<<( *args )}
+    $stderr.stub!( :write ) { |*args| @stderr.<<( *args ); @combined.<<( *args )}
+  end
+
   before :all do
     @host = Gofer::Host.new(HOSTNAME, USERNAME, :keys => [IDENTITY_FILE], :quiet => true)
     @tmpdir = raw_ssh("mktemp -d /tmp/gofertest.XXXXX").chomp
@@ -86,6 +94,35 @@ describe Gofer do
       it_should_behave_like "an output capturer"
     end
 
+
+    it "should print stdout responses if quiet is false" do
+      $stdout.should_receive(:write).with "stdout\n"
+      @host.run "echo stdout", :quiet => false
+    end
+
+    it "should print stderr responses if quiet_stderr is false" do
+      $stderr.should_receive(:write).with "stderr\n"
+      @host.run "echo stderr 1>&2", :quiet_stderr => false
+    end
+
+    context "with a host output prefix" do
+      before do
+        @host.output_prefix = "derp"
+        with_captured_output
+      end
+      it "should prefix each line of the stdout and stderr responses with the output prefix" do
+        @host.run "echo stdout; echo stdout2; echo stderr 1>&2; echo stderr2 1>&2", :quiet => false, :quiet_stderr => false
+        @stdout.should eq "derp: stdout\nderp: stdout2\n"
+        @stderr.should eq "derp: stderr\nderp: stderr2\n"
+      end
+
+      it "should not prefix if the output is not actually on a new line" do
+        @host.run "echo -n foo; echo bar; echo baz; ", :quiet => false
+        @combined.should eq "derp: foobar\nderp: baz\n"
+      end
+
+    end
+
     it "should error if a command returns a non-zero response" do
       lambda {@host.run "false"}.should raise_error(/failed with exit status/)
       begin
@@ -204,42 +241,35 @@ describe Gofer do
   end
 
   describe :cluster do
-    it "should run commands in parallel" do
-      cluster = Gofer::Cluster.new
+    before do
+      @cluster = Gofer::Cluster.new
       # Cheat and use the same host repeatedly
-      host1 = Gofer::Host.new(HOSTNAME, USERNAME, :keys => [IDENTITY_FILE], :quiet => true)
-      host2 = Gofer::Host.new(HOSTNAME, USERNAME, :keys => [IDENTITY_FILE], :quiet => true)
-      cluster << host1
-      cluster << host2
+      @host1 = Gofer::Host.new(HOSTNAME, USERNAME, :keys => [IDENTITY_FILE], :quiet => true)
+      @host2 = Gofer::Host.new(HOSTNAME, USERNAME, :keys => [IDENTITY_FILE], :quiet => true)
+      @cluster << @host1
+      @cluster << @host2
+    end
 
-      results = cluster.run do |c|
-        c.run "date '+%s%N'; sleep 1; date '+%s%N'"
+    it "should run commands in parallel" do
+      results = @cluster.run do |c|
+        c.run "ruby -e 'puts Time.now.to_f; sleep 0.1; puts Time.now.to_f'"
       end
 
-      res1 = results[host1].stdout.lines.to_a
-      res2 = results[host2].stdout.lines.to_a
+      res1 = results[@host1].stdout.lines.to_a
+      res2 = results[@host2].stdout.lines.to_a
 
       expect(res1[1].to_f).to be > res2[0].to_f
-
     end
 
     it "should respect max_concurrency" do
-      cluster = Gofer::Cluster.new
-      # Cheat and use the same host repeatedly
-      host1 = Gofer::Host.new(HOSTNAME, USERNAME, :keys => [IDENTITY_FILE], :quiet => true)
-      host2 = Gofer::Host.new(HOSTNAME, USERNAME, :keys => [IDENTITY_FILE], :quiet => true)
-      cluster << host1
-      cluster << host2
-
-      results = cluster.run(:max_concurrency => 1) do |c|
-        c.run "date '+%s%N'; sleep 1; date '+%s%N'"
+      results = @cluster.run(:max_concurrency => 1) do |c|
+        c.run "ruby -e 'puts Time.now.to_f; sleep 0.1; puts Time.now.to_f'"
       end
 
-      res1 = results[host1].stdout.lines.to_a
-      res2 = results[host2].stdout.lines.to_a
+      res1 = results[@host1].stdout.lines.to_a
+      res2 = results[@host2].stdout.lines.to_a
 
       expect(res2[0].to_f).to be >= res1[1].to_f
-
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: gofer
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Michael Pearson
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-23 00:00:00.000000000 Z
+date: 2013-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: net-ssh
@@ -52,8 +52,8 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- CHANGELOG.md
 - Gemfile
-- HISTORY.md
 - README.md
 - Rakefile
 - gofer.gemspec