cast-ssh 0.1.1

checksums.yaml

@@ -0,0 +1,15 @@
+---
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    ZmRlOTFjNjZiMjViMDFjODExYWI2NTIzOTUyZDYzZmNhZTliNWZmMQ==
+  data.tar.gz: !binary |-
+    MDJhMmNlYjU4MDYwOTU3OGVmYjU2NTBmZWIyOWJkNzhkMTdmZTQ3MA==
+!binary "U0hBNTEy":
+  metadata.gz: !binary |-
+    NDVjY2MyM2Q5NDQ3NzdmZDZjODNmMTk3YjJjNWMwZDNhN2QxMmY1NzA3YmY5
+    YTk1ZmRmZGFiZDNlN2JlOTczYjIwNmE3MmE4NTA4ZjE2ZjE5Y2NjMDEyNDY4
+    MTc4OGQzZjJiOGJlYjI3MWNjOGIyNjQyMzU5NWVjNTA3MWQyNDc=
+  data.tar.gz: !binary |-
+    Yjg2OGUxZTMzOGFhMmI5Yzc5ZjY1OTJkODhlMGJiMDViMTA1YmEwMGY0ZDQ4
+    N2QxNmI0NDUwZTUwOWJhZDUyMWNkODk0NjgzYjFlNTE3ODY0YmEzM2RlOTY3
+    ZWY1MDgxYTE0OWE4ZWM2YWMwMDNlYTYwNTVjNzYwNDE3OTcxOGU=

data/.rspec

@@ -0,0 +1,2 @@
+--colour
+

data/.travis.yml

@@ -0,0 +1,10 @@
+language: ruby
+rvm:
+  - rbx-18mode
+  - rbx-19mode
+  - jruby-18mode
+  - jruby-19mode
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - ruby-head

data/Gemfile

@@ -0,0 +1,6 @@
+source :rubygems
+
+gem 'peach'
+gem 'trollop'
+
+gemspec

data/LICENSE.md

@@ -0,0 +1,7 @@
+Copyright (C) 2013 Peter Bakkum
+
+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.md

@@ -0,0 +1,78 @@
+# Cast
+
+This is a Ruby gem that executes remote commands via ssh on groups of servers defined in a YAML file.
+
+### Setup
+
+Grab the gem:
+
+    gem install cast-ssh
+  
+Create your group file at ~/.cast.yml, like this:
+
+    group1:
+    - host1
+    - host2
+    - host3
+    
+    group2:
+    - host1
+    - host4
+    - host5
+    
+Run commands in your shell:
+
+    cast group1 echo test
+    cast group1,group2 sudo whoami
+    cast -s group1,host4 df -h
+    
+The output from the second command will look something like this:
+
+    [cast] loading groups from ~/.cast.yml
+    [cast] running ssh host1 'sudo whoami'
+    [cast] running ssh host2 'sudo whoami'
+    [cast] running ssh host3 'sudo whoami'
+    [cast] running ssh host4 'sudo whoami'
+    [cast] running ssh host5 'sudo whoami'
+    [host3] root
+    [host1] root
+    [host2] root
+    [host5] root
+    [host4] root
+
+Note that the commands are run in parallel, so the output may be out of order.
+
+### Options
+
+           --serial, -s:   Execute commands serially, rather than in parallel over the group                         
+        --delay, -d <f>:   Delay in seconds between execution of serial commands (switches to serial mode if defined)
+    --groupfile, -g <s>:   YAML file of server groups (default: ~/.cast.yml)                                         
+             --list, -l:   Print out contents of groupfile without executing command                                 
+         --clusters, -c:   Print out only groupnames without executing command                                       
+          --version, -v:   Print version and exit                                                                    
+             --help, -h:   Show this message  
+             
+### API
+
+You can also access the same functionality from within Ruby. The following methods are available:
+
+* __Cast::remote__ host, cmd
+
+  Run a remote command on the given host, sending output to stdout.
+
+* __Cast::local__ cmd, prefix = nil -> int
+
+  Run a command locally, printing stdout and stderr from the command. Returns the process' return value.
+
+* __Cast::log__ msg, source = 'cast', stream = $stdout
+
+  Log a message through the Cast mutex using the given prefix and stream. Output will look like "[prefix] msg". The prefix box will be left out if the argument is nil.
+
+* __Cast::load_groups__ file -> Hash
+
+  Load Cast groups from the given file, returning them as a hash.
+
+* __Cast::expand_groups__ cmdgroups, groups = @@groups -> Array
+
+  Takes an array of groups and hosts, and expands the groups into their constituents given the input group hash. If no hash is given, use the value loaded most recently in load_groups. Returns an array of hostnames.
+  

data/bin/cast

@@ -0,0 +1,58 @@
+#!/usr/bin/env ruby
+
+require 'cast'
+require 'trollop'
+
+p = Trollop::Parser.new do
+  version "cast #{Cast::VERSION} (c) Peter Bakkum"
+  banner <<-EOS
+Cast executes remote commands via ssh on servers or groups of servers, as defined by ~/.cast.yml
+
+Usage:
+       cast [options] <servers/groups> <command>
+
+Examples:
+       cast hadoop_cluster df
+       cast -s hadoop_cluster,machine1,machine2 whoami
+
+Your group file (~/.cast.yml by default) should be proper YAML and look like this:
+
+groupname:
+- host1
+- host2
+- host3
+
+Command Line Options:
+ 
+EOS
+
+  opt :serial, 'Execute commands serially, rather than in parallel over the group', :short => 's'
+  opt :delay, 'Delay in seconds between execution of serial commands (switches to serial mode if defined)', :type => :float
+  opt :groupfile, 'YAML file of server groups', :default => Cast::DEFAULTGROUPS, :short => 'g'
+  opt :list, 'Print out contents of groupfile without executing command', :short => 'l'
+  opt :clusters, 'Print out only groupnames without executing command', :short => 'c'
+end
+
+opt = Trollop::with_standard_exception_handling p do
+  opt = p.parse ARGV
+  raise Trollop::HelpNeeded if ARGV.size < 2 && !opt[:list] && !opt[:clusters]
+  opt
+end
+
+groups = Cast::load_groups opt[:groupfile]
+
+if opt[:list]
+  puts YAML::dump(groups)
+  exit
+end
+
+if opt[:clusters]
+  puts groups.keys.join("\n")
+  exit
+end
+
+cmd = ARGV[1..-1].join(' ')
+hosts = Cast::expand_groups ARGV[0].split(','), groups
+
+Cast::run hosts, cmd, opt[:serial], opt[:delay]
+

data/cast.gemspec

@@ -0,0 +1,25 @@
+# encoding: utf-8
+require File.expand_path("../lib/cast.rb", __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.add_development_dependency 'mocha'
+  gem.add_development_dependency 'autotest-standalone'
+
+  gem.authors = ["Peter Bakkum"]
+  gem.bindir = 'bin'
+  gem.description = %q{Execute remote commands via ssh on groups of machines}
+  gem.email = ['pbb7c@virginia.edu']
+  gem.executables = ['cast']
+  gem.extra_rdoc_files = ['LICENSE.md', 'README.md']
+  gem.files = Dir['LICENSE.md', 'README.md', 'cast.gemspec', 'Gemfile', '.rspec', '.travis.yml', 'lib/**/*', 'bin/*', 'spec/**/*']
+  gem.homepage = 'http://github.com/bakks/cast'
+  gem.name = 'cast-ssh'
+  gem.rdoc_options = ["--charset=UTF-8"]
+  gem.require_paths = ['lib']
+  gem.required_rubygems_version = Gem::Requirement.new(">= 1.3.6")
+  gem.summary = %q{Execute remote commands via ssh on groups of machines}
+  gem.test_files = Dir['spec/**/*']
+  gem.version = Cast::VERSION
+  gem.license = 'MIT'
+end
+

data/lib/cast.rb

@@ -0,0 +1,118 @@
+require 'thread'
+require 'open3'
+require 'yaml'
+require 'peach'
+
+STDOUT.sync = true
+STDERR.sync = true
+
+module Cast
+  VERSION = '0.1.1'
+  DEFAULTGROUPS = '~/.cast.yml'
+
+  @@mux = Mutex.new
+  @@pids = []
+  @@groups = nil
+
+  def self.log msg, source = 'cast', stream = $stdout
+    @@mux.synchronize do
+      prefix = "[#{source}] " unless source == nil
+      stream.puts "#{prefix}#{msg}"
+    end
+  end
+
+  def self.load_groups groupfile
+    file = File.expand_path groupfile
+    exists = File.exists? file
+    @@groups ||= {}
+
+    if !exists
+      raise "could not find #{groupfile}" if groupfile != DEFAULTGROUPS
+      log "no group file found at #{groupfile}"
+    else
+      log "loading groups from #{groupfile}"
+      @@groups = YAML.load_file file
+    end
+
+    return @@groups
+  end
+
+  def self.expand_groups cmdgroups, groups = @@groups
+    hosts = []
+    cmdgroups.each do |group|
+      if groups.include? group
+        hosts += groups[group]
+      else
+        hosts << group
+      end
+    end
+
+    return hosts.uniq
+  end
+
+  def self.run hosts, cmd, serial = false, delay = nil
+    if serial or delay
+      hosts.each_with_index do |host, i|
+        remote host, cmd
+        if delay and i < hosts.size - 1
+          log "delay for #{delay} seconds"
+          sleep delay
+        end
+      end
+    else
+      hosts.peach { |host| remote host, cmd }
+    end
+  end
+
+  def self.remote host, cmd
+    fullcmd = "ssh #{host} '#{cmd}'"
+    log "running #{fullcmd}"
+    local fullcmd, host
+  end
+
+  def self.local cmd, prefix = nil
+    r = nil
+
+    Open3.popen3 cmd do |stdin, stdout, stderr, wait_thr|
+      @@pids << wait_thr[:pid]
+
+      stdin.close
+
+      while true
+        streams = []
+        streams << stdout if stdout
+        streams << stderr if stderr
+        break unless streams.size > 0
+
+        ios = IO.select streams
+
+        ios.first.each do |stream|
+          if stream == stdout
+            line = stream.gets
+            if line == nil
+              stdout = nil
+              next
+            end
+            log line, prefix
+
+          elsif stream == stderr
+            line = stream.gets
+            if line == nil
+              stderr = nil
+              next
+            end
+            log line, prefix, $stderr
+
+          else raise "unrecognized stream #{stream}"
+          end
+
+        end
+      end
+
+      r = wait_thr.value
+    end
+
+    return r
+  end
+
+end

data/spec/lib/cast/cast_spec.rb

@@ -0,0 +1,38 @@
+require 'spec_helper'
+
+describe Cast do
+  it 'should load groups' do
+    groups = Cast::load_groups 'spec/test.yml'
+    groups.size.should == 2
+    groups['group1'].size.should == 3
+    groups['group1'][0].should == 'host1'
+  end
+
+  it 'should expand groups' do
+    groups = Cast::load_groups 'spec/test.yml'
+    hosts = Cast::expand_groups ['group1'], groups
+    hosts.size.should == 3
+    hosts[0].should == 'host1'
+    hosts[1].should == 'host2'
+    hosts[2].should == 'host3'
+
+    hosts = Cast::expand_groups ['group1', 'group2']
+    hosts.size.should == 5
+    hosts[0].should == 'host1'
+    hosts[1].should == 'host2'
+    hosts[2].should == 'host3'
+    hosts[3].should == 'host4'
+    hosts[4].should == 'host5'
+
+    hosts = Cast::expand_groups ['host10', 'group1', 'host11', 'group2']
+    hosts.size.should == 7
+    hosts[0].should == 'host10'
+    hosts[1].should == 'host1'
+    hosts[2].should == 'host2'
+    hosts[3].should == 'host3'
+    hosts[4].should == 'host11'
+    hosts[5].should == 'host4'
+    hosts[6].should == 'host5'
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rubygems'
+require 'rspec'
+require 'mocha/api'
+require 'cast'
+
+RSpec.configure do |config|
+  config.mock_with :mocha
+  config.fail_fast = true
+end
+

data/spec/test.yml

@@ -0,0 +1,10 @@
+group1:
+- host1
+- host2
+- host3
+
+group2:
+- host1
+- host4
+- host5
+

metadata

@@ -0,0 +1,91 @@
+--- !ruby/object:Gem::Specification
+name: cast-ssh
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Peter Bakkum
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-03-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: autotest-standalone
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Execute remote commands via ssh on groups of machines
+email:
+- pbb7c@virginia.edu
+executables:
+- cast
+extensions: []
+extra_rdoc_files:
+- LICENSE.md
+- README.md
+files:
+- LICENSE.md
+- README.md
+- cast.gemspec
+- Gemfile
+- .rspec
+- .travis.yml
+- lib/cast.rb
+- bin/cast
+- spec/lib/cast/cast_spec.rb
+- spec/spec_helper.rb
+- spec/test.yml
+homepage: http://github.com/bakks/cast
+licenses:
+- MIT
+metadata: {}
+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'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Execute remote commands via ssh on groups of machines
+test_files:
+- spec/lib/cast/cast_spec.rb
+- spec/spec_helper.rb
+- spec/test.yml
+has_rdoc: