gofer 0.2.6 → 0.3.0

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    MWQwYzJjNDA5ZGZiOGQ3MDRkYWFhYmRhNGQ4MmZlNmM5OGU5MmY0OQ==
+  data.tar.gz: !binary |-
+    MTcwYTIwZDJjZWZlOGZhYWI5OTZjOWQ4NzUzM2NmYTBhNTU0YjhiMA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NmM0OTY3MjQ4ZDZjYjkxZDNlY2M0OTdlMzMyNmFkODA4N2Q5OTkzMzUyNGQ2
+    OWNiYjNkOTNjN2NlMDg2MDNiYTUwODEyMjUyYTFlNDg3OGNiNDE1YjI4NTNh
+    ZTJkMDlmMzcyMmMzZDI0NGEyZGQ3ZTc2Yzg3NzA4MTFkYjIyOGM=
+  data.tar.gz: !binary |-
+    ZDE5ODhmYmM5NzEwZjg4MjA5YzRmYTE5ZTcxMzgzN2NmYjRkYjExMTBmMWQ1
+    NzgwYjc4OTBhYjM2YTBhZjk3ODRhYzExMzFiMzU0NDYwYTUwNGEwYzcwNDcy
+    NGNmODY4NDY4MzY0YWIxNGI2YTNhMzFiZTFiYzE5N2Y1OTBhNDI=

data/.gitignore

@@ -4,3 +4,4 @@
 Gemfile.lock
 pkg/*
 doc
+.ruby-version

data/README.md

@@ -14,82 +14,118 @@
 
 ### Instantiation
 
-    h = Gofer::Host.new('my.host.com', 'ubuntu', :keys => ['key.pem'])
+``` ruby
+h = Gofer::Host.new('my.host.com', 'ubuntu', :keys => ['key.pem'])
+```
 
 ### Run a command
 
-    h.run "sudo stop mysqld"
+``` ruby
+h.run "sudo stop mysqld"
+```
 
 ### Copy some files
 
-    h.upload 'file', 'remote_file'
-    h.download 'remote_dir', 'dir'
+``` ruby
+h.upload 'file', 'remote_file'
+h.download 'remote_dir', 'dir'
+```
 
 ### Interact with the filesystem
 
-    if h.exist?('remote_directory')
-      h.run "rm -rf 'remote_directory'"
-    end
+``` ruby
+if h.exist?('remote_directory')
+  h.run "rm -rf 'remote_directory'"
+end
+
+h.write("a string buffer", 'a_remote_file')
+puts h.read('a_remote_file')
+puts h.ls('a_remote_dir').join(", ")
+```
 
-    h.write("a string buffer", 'a_remote_file')
-    puts h.read('a_remote_file')
-    puts h.ls('a_remote_dir').join(", ")
-    
 ### Respond to command errors
 
-    h.run "false" # this will raise an error
-    response = h.run "false", :capture_exit_status => true # this won't ...
-    puts response.exit_status # and will make the exit status available
+``` ruby
+h.run "false" # this will raise an error
+response = h.run "false", :capture_exit_status => true # this won't ...
+puts response.exit_status # and will make the exit status available
+```
 
 ### Capture output
 
-    response = h.run "echo hello; echo goodbye 1>&2\n"
-    puts response         # will print "hello\n"
-    puts response.stdout  # will also print "hello\n"
-    puts response.stderr  # will print "goodbye\n"
-    puts response.output  # will print "hello\ngoodbye\n"
+``` ruby
+response = h.run "echo hello; echo goodbye 1>&2\n"
+puts response         # will print "hello\n"
+puts response.stdout  # will also print "hello\n"
+puts response.stderr  # will print "goodbye\n"
+puts response.output  # will print "hello\ngoodbye\n"
+```
 
 ### Suppress output
 
-    h.run "echo noisy", :quiet => true               # don't print stdout
-    h.run "echo noisier 1>&2", :quiet_stderr => true # don't print stderr
-    h.quiet = true                                   # never print stdout
+``` ruby
+h.run "echo noisy", :quiet => true               # don't print stdout
+h.run "echo noisier 1>&2", :quiet_stderr => true # don't print stderr
+h.quiet = true                                   # never print stdout
+```
 
 ### Run multiple commands
-    
-    response = h.run_multiple(['echo hello', 'echo goodbye'], :quiet => true)
-    puts response.stdout # will print "hello\ngoodbye\n"
-    
+
+``` ruby
+response = h.run_multiple(['echo hello', 'echo goodbye'], :quiet => true)
+puts response.stdout # will print "hello\ngoodbye\n"
+```
+
+### Run the same commands on multiple hosts
+
+``` 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.run do |c|
+    c.run("hostname") # This will run on both hosts at once
+end
+
+cluster.run(:max_concurrency => 1) do |c|
+    c.run("sudo /etc/init.d/apache2 restart") # This will run on one machine at a time
+end
+```
+
 ## Planned Features
 
-    # 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
+``` 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`
 
 ## 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
+
+  * 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
 
 ## License
 
 (The MIT License)
 
-Copyright (c) 2011 Michael Pearson
+Copyright (c) 2011-13 Michael Pearson
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/lib/gofer.rb

@@ -1,8 +1,9 @@
 require 'gofer/ssh_wrapper'
 require 'gofer/response'
 require 'gofer/host'
+require 'gofer/cluster'
 require 'gofer/version'
 
 # See Gofer::Host
 module Gofer
-end
+end

data/lib/gofer/cluster.rb

@@ -0,0 +1,73 @@
+require 'thread'
+
+module Gofer
+  class Cluster
+    attr_reader :hosts
+    attr_accessor :max_concurrency
+    def initialize(parties=[])
+      @hosts = []
+      @max_concurrency = nil
+
+      parties.each do |i|
+        self << i
+      end
+    end
+
+    def <<(other)
+      case other
+      when Cluster
+        other.hosts.each do |host|
+          @hosts << host
+        end
+      when Host
+        @hosts << other
+      end
+    end
+
+    def run(opts={}, &block)
+      concurrency = opts[:max_concurrency] || max_concurrency || hosts.length
+      block.call(ClusterCommandRunner.new(hosts, concurrency))
+    end
+
+    class ClusterCommandRunner
+      def initialize(hosts, concurrency)
+        @concurrency = concurrency
+        @hosts = hosts
+      end
+
+      # Spawn +concurrency+ worker threads, each of which pops work off the
+      # +_in+ queue, and writes values to the +_out+ queue for syncronisation.
+      def run(cmd, opts={})
+        _in = run_queue
+        length = run_queue.length
+        _out = Queue.new
+        results = {}
+        (0...@concurrency).map do
+          Thread.new do
+            loop do
+              host = _in.pop(false) rescue Thread.exit
+
+              results[host] = host.run(cmd, opts)
+              _out << true
+            end
+          end
+        end
+
+        length.times do
+          _out.pop
+        end
+
+        return results
+      end
+
+      def run_queue
+        Queue.new.tap do |q|
+          @hosts.each do |h|
+            q << h
+          end
+        end
+      end
+    end
+
+  end
+end

data/lib/gofer/response.rb

@@ -1,9 +1,9 @@
 module Gofer
 
-  # Response container for the various outputs from Gofer::Host#run  
+  # Response container for the various outputs from Gofer::Host#run
   class Response < String
     attr_reader :stdout, :stderr, :output, :exit_status
-    
+
     def initialize (_stdout, _stderr, _output, _exit_status)
       super _stdout
       @stdout = _stdout
@@ -12,4 +12,4 @@ module Gofer
       @exit_status = _exit_status
     end
   end
-end
+end

data/lib/gofer/ssh_wrapper.rb

@@ -13,7 +13,7 @@ module Gofer
     def run command, opts={}
       ssh_execute(ssh, command, opts)
     end
-    
+
     def read_file path
       scp.download! path
     end
@@ -27,12 +27,12 @@ module Gofer
     end
 
     private
-  
+
     def ssh
       @ssh ||= Net::SSH.start(*@net_ssh_args)
     end
-    
-    def scp 
+
+    def scp
       @scp ||= Net::SCP.new(ssh)
     end
 
@@ -40,7 +40,7 @@ module Gofer
       stdout, stderr, output = '', '', ''
       exit_code = 0
       ssh.open_channel do |channel|
-        
+
         channel.exec(command) do |ch, success|
           unless success
             raise "Couldn't execute command #{command} (ssh channel failure)"
@@ -63,7 +63,7 @@ module Gofer
             exit_code = data.read_long
             channel.close # Necessary or backgrounded processes will 'hang' the channel
           end
-          
+
         end
       end
 

data/lib/gofer/version.rb

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

data/spec/gofer/integration_spec.rb

@@ -202,4 +202,44 @@ describe Gofer do
       end
     end
   end
+
+  describe :cluster do
+    it "should run commands in parallel" 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 do |c|
+        c.run "date '+%s%N'; sleep 1; date '+%s%N'"
+      end
+
+      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'"
+      end
+
+      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,68 +1,56 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: gofer
-version: !ruby/object:Gem::Version 
-  hash: 27
-  prerelease: 
-  segments: 
-  - 0
-  - 2
-  - 6
-  version: 0.2.6
+version: !ruby/object:Gem::Version
+  version: 0.3.0
 platform: ruby
-authors: 
+authors:
 - Michael Pearson
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2012-08-29 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2013-05-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: net-ssh
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 33
-        segments: 
-        - 2
-        - 0
-        - 23
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 2.0.23
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: net-scp
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 31
-        segments: 
-        - 1
-        - 0
-        - 4
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.0.23
+- !ruby/object:Gem::Dependency
+  name: net-scp
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
         version: 1.0.4
   type: :runtime
-  version_requirements: *id002
-description: |
-  
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.4
+description: ! '
+
   Gofer provides a flexible and reliable model for performing tasks on remote
+
   server using Net::SSH
 
-email: 
+'
+email:
 - mipearson@gmail.com
 executables: []
-
 extensions: []
-
 extra_rdoc_files: []
-
-files: 
+files:
 - .gitignore
 - Gemfile
 - HISTORY.md
@@ -70,6 +58,7 @@ files:
 - Rakefile
 - gofer.gemspec
 - lib/gofer.rb
+- lib/gofer/cluster.rb
 - lib/gofer/host.rb
 - lib/gofer/response.rb
 - lib/gofer/ssh_wrapper.rb
@@ -78,37 +67,27 @@ files:
 - spec/spec_helper.rb
 homepage: https://github.com/mipearson/gofer
 licenses: []
-
+metadata: {}
 post_install_message: 
 rdoc_options: []
-
-require_paths: 
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-required_rubygems_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.17
+rubygems_version: 2.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: run commands on remote servers using SSH
-test_files: 
+test_files:
 - spec/gofer/integration_spec.rb
 - spec/spec_helper.rb