rdeshpande-crow 0.1.0

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Rohan Deshpande
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,7 @@
+= crow
+
+Description goes here.
+
+== Copyright
+
+Copyright (c) 2009 Rohan Deshpande. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,56 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "crow"
+    gem.summary = %Q{helper for ssh+ruby scripts}
+    gem.email = "rohan.deshpande@gmail.com"
+    gem.homepage = "http://github.com/rdeshpande/crow"
+    gem.authors = ["Rohan Deshpande"]
+
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "crow #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:minor: 1
+:patch: 0
+:major: 0

data/lib/crow.rb

@@ -0,0 +1,117 @@
+require 'rubygems'
+require 'net/ssh'
+require 'net/ssh/gateway'
+require 'singleton'
+
+class Crow
+
+  STRFTIME_STRING = "%F %T"
+
+  attr_accessor :commands, :current_host, :gateway, :logfile, :threads, :user
+
+  include Singleton
+
+  def initialize(opts = {})
+    @commands = []
+    @threads = []
+    @user = Crow.get_user
+    @gateway = opts[:gateway]
+    Crow.set_logfile(opts[:logfile])
+  end
+
+  def Crow.get_user
+    return ENV['USER'].strip
+  end
+
+  # Exception handling must occur here
+  #
+  def Crow.go!
+    begin
+      instance.threads.each do |thread|
+        thread.join
+      end
+    rescue SocketError => e
+      puts "ERROR: attempting to connect to #{instance.current_host}:"
+      puts "#{e.class}: #{e.to_s}"
+      puts e.backtrace
+      exit
+    end
+  end
+
+  def Crow.log(host, output, direction, logfile)
+    msg = "#{timestamp} (#{direction} :: #{host}) #{output}"
+    puts msg
+    if logfile
+      logfile.write("#{msg.strip}\n")
+    end
+  end
+
+  def Crow.log_receive(host, data, logfile = nil)
+    Crow.log(host, data, 'in', logfile)
+  end
+
+  def Crow.log_send(host, command, logfile = nil)
+    Crow.log(host, command, 'out', logfile)
+  end
+
+  def Crow.run(command)
+    instance.commands << command
+  end
+
+  def Crow.on_hosts(hosts, &block)
+    instance.commands = []
+    yield
+    if hosts == 'localhost'
+      instance.threads << Thread.new { run_local(instance.commands) }
+    else
+      hosts.to_a.each do |host|
+        instance.threads << Thread.new { ssh(host, instance.commands) }
+      end
+    end
+    go!
+    if instance.logfile && File.pipe?(instance.logfile)
+      instance.logfile.close
+    end
+  end
+
+  def Crow.run_local(commands)
+    commands.each do |cmd|
+      Crow.log_send('localhost', cmd, instance.logfile)
+      IO.popen(cmd) do |io|
+        Crow.log_receive('localhost', io.read, instance.logfile)
+      end
+    end
+  end
+
+  def Crow.set_gateway(host)
+    instance.gateway = host
+  end
+
+  def Crow.set_logfile(filename)
+    if filename
+      instance.logfile = File.new(filename, 'w+')
+      return true
+    end
+    return false
+  end
+
+  def Crow.ssh(host, commands)
+    instance.current_host = host
+    ssh = nil
+    if instance.gateway.nil? || (host == instance.gateway)
+      ssh = Net::SSH.start(host, instance.user)
+    else
+      gateway = Net::SSH::Gateway.new(instance.gateway, instance.user)
+      ssh = gateway.ssh(host, instance.user)
+    end
+    commands.each do |cmd|
+      ssh.exec!(cmd, host, instance.logfile)
+    end
+    ssh.close
+  end
+
+  def Crow.timestamp
+    return "[#{Time.now.strftime(STRFTIME_STRING)}]"
+  end
+
+end

data/lib/ssh.rb

@@ -0,0 +1,47 @@
+# Override the default Net::SSH::Connection::Sesssion#exec to log to Hustler
+#
+module Net
+  module SSH
+    module Connection
+      class Session
+
+        attr_accessor :current_host
+
+        def exec(command, host, logfile = nil, &block)
+          Crow.log_send(host, command, logfile)
+          open_channel do |channel|
+            channel.exec(command) do |ch, success|
+              raise "could not execute command: #{command.inspect}" unless success
+
+              channel.on_data do |ch2, data|
+                Crow.log_receive(host, data, logfile)
+              end
+
+              channel.on_extended_data do |ch2, type, data|
+                $stderr.print(data)
+              end
+            end
+          end
+        end
+
+        # Same as #exec, except this will block until the command finishes. Also,
+        # if a block is not given, this will return all output (stdout and stderr)
+        # as a single string.
+        #
+        #   matches = ssh.exec!("grep something /some/files")
+        def exec!(command, host, logfile = nil, &block)
+          block ||= Proc.new do |ch, type, data|
+            ch[:result] ||= ""
+            ch[:result] << data
+          end
+
+          channel = exec(command, host, logfile, &block)
+          channel.wait
+
+          return channel[:result]
+        end
+
+      end
+    end
+  end
+end

data/test/host_test.rb

@@ -0,0 +1,10 @@
+require 'test_helper'
+
+class HostTest < Test::Unit::TestCase
+
+  def test_should_set_gateway
+    Crow.set_gateway('qaweb1')
+    assert_equal(Crow.instance.gateway, 'qaweb1')
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,2 @@
+require 'test/unit'
+require File.join(File.dirname(__FILE__), '..', 'lib', 'crow')

metadata

@@ -0,0 +1,62 @@
+--- !ruby/object:Gem::Specification 
+name: rdeshpande-crow
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- Rohan Deshpande
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-04-25 00:00:00 -07:00
+default_executable: 
+dependencies: []
+
+description: 
+email: rohan.deshpande@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION.yml
+- lib/crow.rb
+- lib/ssh.rb
+- test/host_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/rdeshpande/crow
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: helper for ssh+ruby scripts
+test_files: 
+- test/host_test.rb
+- test/test_helper.rb