elsewhere 0.5 → 0.6

data/README.md

@@ -13,8 +13,12 @@ r.commands << "source /etc/profile"
 r.commands << "cd ~/current"
 r.commands << "rake do:something:useful"
 
+#fails silently
 r.execute
 
+#raises exception on nonzero status codes
+r.execute!
+
 => { "www.example.com" => "results from data stream"}
 ```
 

data/elsewhere.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   s.version     = Elsewhere::VERSION
   s.authors     = ["Bill Chapman"]
   s.email       = ["bchapman@academicmanagement.com"]
-  s.homepage    = ""
+  s.homepage    = "https://github.com/byllc/elsewhere"
   s.summary     = %q{ Simple wrapper for Net SSH to run a list of commands remotely }
   s.description = %q{ Yet another way to run stuff remotely }
 

data/lib/elsewhere/remote_run.rb

@@ -1,18 +1,18 @@
 module Elsewhere
 
-# Execute commands on a remote server
-# I know capistrano already does this
-# This was abstracted from a more specific solution that we already had in place and I thought it was worth sharing
-# 
-# Usage:
-#
-#   r = RemoteRun.new("hostname","username")
-#   r.commands << "source /etc/profile"
-#   r.commands << "cd ~/current"
-#   r.commands << "rake extractor:run cas=3 users=12550"
-# 
-#   r.execute
-#
+  # Execute commands on a remote server
+  # I know capistrano already does this
+  # This was abstracted from a more specific solution that we already had in place and I thought it was worth sharing
+  # 
+  # Usage:
+  #
+  #   r = RemoteRun.new("hostname","username")
+  #   r.commands << "source /etc/profile"
+  #   r.commands << "cd ~/current"
+  #   r.commands << "rake extractor:run cas=3 users=12550"
+  # 
+  #   r.execute
+  #
   require 'net/ssh' 
   require 'net/ssh/gateway'
   require 'yaml'
@@ -21,7 +21,7 @@ module Elsewhere
     #TODO: move to remote_run/exceptions.rb when we gemify this
     class RemoteRunError < StandardError; end
     
-    attr_accessor :hosts, :gateway_address, :gateway_user, :commands
+    attr_accessor :hosts, :user, :gateway_address, :gateway_user, :commands
     
     def initialize(hosts,user, options={})
       @hosts        = [hosts].flatten #accept a single host or an array of hosts 
@@ -31,6 +31,14 @@ module Elsewhere
       @commands     = []
     end
     
+    def add_command
+      @commands << command
+    end
+    
+    def remove_command command
+      @commands.delete(command.strip)
+    end
+    
     #expects the config file to be formatted as yaml as follows
     #environment:
     #  group:
@@ -53,18 +61,23 @@ module Elsewhere
       end
     end
     
-    def ssh_wrapper(host,command)
+    def ssh_wrapper(host,command,raise_exceptions)
        output = nil
        Net::SSH.start(host, @user) do |ssh|
-         output = execute_over_ssh(ssh,command)
+         output = execute_over_ssh(ssh,command,raise_exceptions)
        end
        output
     end
     
+    #run all items and raise an exception if exit_code is nonzero
+    def execute!(joined_by = " && ")
+      execute( joined_by, true )
+    end
+    
     # Run all of the items in the commands hash
     # The joined_by paramenter dictates how to join the commands before execution
     # Returns: A hash of the responses for each specified host 
-    def execute(joined_by = " && ") 
+    def execute(joined_by = " && ", raise_exceptions=false) 
       run_me = @commands.join(joined_by)
       output = {}
       
@@ -72,30 +85,54 @@ module Elsewhere
         gateway_wrapper.ssh(host, @user, {:forward_agent => true}) do |gateway|
           @hosts.uniq.each do |h|
             gateway.ssh(host, options[:gateway_user], {:forward_agent => true}) do |ssh|
-              output[h] = execute_over_ssh(ssh, run_me)
+              output[h] = execute_over_ssh(ssh, run_me,raise_exceptions)
             end
           end
         end
       else
-         @hosts.uniq.each{ |h| output[h] = ssh_wrapper(h,run_me) }
+         @hosts.uniq.each{ |h| output[h] = ssh_wrapper(h,run_me,raise_exceptions) }
       end
       
       return output
     end
     
-    #execute the given commend for the Net::SSH instance 
+    #execute the given command set for the Net::SSH instance 
     #return the data or raise an error depending on which stream is returned
-    def execute_over_ssh(ssh,command)
-      stdout = ""
-      ssh.exec!(command) do |channel,stream,data|
-         case stream
-         when :stderr
-           raise RemoteRunError, data 
-         else
-           stdout = data 
-         end
-       end
-       return stdout
+    def execute_over_ssh(ssh,command,raise_exceptions)
+      stdout    = ""
+      stderr    = ""
+      exit_code = nil
+      channel = ssh.open_channel do |channel|
+        
+        channel.exec(command) do |channel, success|
+          channel.on_data do |ch,data|
+            stdout = data
+          end
+          
+          channel.on_extended_data do |ch, type, data|
+            stderr = data
+          end
+          
+          channel.on_close do |ch|
+            #when channel closes
+            #TODO: Implement callback here
+          end
+          
+          channel.on_request "exit-status" do |channel, data|
+            exit_code = data.read_long
+          end
+          
+        end
+      end
+      
+      ssh.loop
+      
+      #we want to raise any non zero exit codes
+      unless ( exit_code == 0 && raise_exceptions )
+        raise RemoteRunError, "#{stderr} - Exit Code: #{exit_code}"
+      else
+        return stdout
+      end
     end
   
   
@@ -103,9 +140,11 @@ module Elsewhere
 end
 
 if __FILE__ == $0
-  host = ""
-  user = ""
-  r = RemoteRun.new(host,user)
-  r.commands << "ls"
+  host = "wa-app-q0"
+  user = "wa-current"
+  r = Elsewhere::RemoteRun.new(host,user)
+  r.commands << "source /etc/profile"
+  r.commands << "cd ~/current"
+  r.commands << "bundle exec rake --trace transformer:run cas=3 queue=solo remote_run_id=1 ddcid=2013 exit=true RAILS_ENV=qa"
   puts r.execute
 end

data/lib/elsewhere/version.rb

@@ -1,3 +1,3 @@
 module Elsewhere
-  VERSION = "0.5"
+  VERSION = "0.6"
 end

data/tests/test_config.yml

@@ -0,0 +1,10 @@
+test:
+  test_group:
+    host: www.example.com
+    user: test_user
+  test_group_with_gateway:
+    host: www.example.com
+    user: test_user
+    gateway:
+      host: www.examplegateway.com
+      user: test_user

data/tests/test_remote_run.rb

@@ -0,0 +1,34 @@
+require 'minitest/autorun'
+require 'elsewhere'
+
+class TestRemoteRun < MiniTest::Unit::TestCase
+  
+  def setup
+    @user         = "test_user"
+    @hosts        = %w{ www.example.com }
+    @gateway      = "www.examplegateway.com"
+    @gateway_user = "test_user"
+    
+    @config = Dir.pwd + "/tests/test_config.yml"
+    @remote_run = Elsewhere::RemoteRun.initialize_from_config(@config, 'test', 'test_group')
+    @remote_run_with_gateway = Elsewhere::RemoteRun.initialize_from_config(@config, 'test', 'test_group_with_gateway')
+    
+  end
+  
+  def test_hosts_are_set_from_initialized_config
+    assert_equal @hosts , @remote_run.hosts
+  end
+  
+  def test_user_is_set_from_initialized_config
+    assert_equal @user, @remote_run.user
+  end
+  
+  def test_gateway_is_set_from_initialized_config
+    assert_equal @gateway, @remote_run_with_gateway.gateway_address
+  end
+  
+  def test_gateway_user_is_set_from_initialized_config
+    assert_equal @gateway_user, @remote_run_with_gateway.gateway_user 
+  end
+  
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: elsewhere
 version: !ruby/object:Gem::Version
-  version: '0.5'
+  version: '0.6'
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-01 00:00:00.000000000Z
+date: 2012-05-08 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &2160742620 !ruby/object:Gem::Requirement
+  requirement: &2168858640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2160742620
+  version_requirements: *2168858640
 - !ruby/object:Gem::Dependency
   name: net-ssh
-  requirement: &2160742200 !ruby/object:Gem::Requirement
+  requirement: &2168858200 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2160742200
+  version_requirements: *2168858200
 - !ruby/object:Gem::Dependency
   name: net-ssh-gateway
-  requirement: &2160741780 !ruby/object:Gem::Requirement
+  requirement: &2168857760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,7 +43,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2160741780
+  version_requirements: *2168857760
 description: ! ' Yet another way to run stuff remotely '
 email:
 - bchapman@academicmanagement.com
@@ -59,7 +59,9 @@ files:
 - lib/elsewhere.rb
 - lib/elsewhere/remote_run.rb
 - lib/elsewhere/version.rb
-homepage: ''
+- tests/test_config.yml
+- tests/test_remote_run.rb
+homepage: https://github.com/byllc/elsewhere
 licenses: []
 post_install_message: 
 rdoc_options: []
@@ -79,7 +81,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: elsewhere
-rubygems_version: 1.8.10
+rubygems_version: 1.8.17
 signing_key: 
 specification_version: 3
 summary: Simple wrapper for Net SSH to run a list of commands remotely