sporf 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d2a07ae3b91c942e61941a54de255b29cd4c00ea
+  data.tar.gz: 6c871094b1711edd72f04bbea81e7ce669571baa
+SHA512:
+  metadata.gz: 81648b6af255eda4967006276fadd8eb7e1d373cf521d1060c06c7f21c4fe430576fe15fefbf062a710627c9ce250e9f025c7e118a4cae3a5f2ffbffabb89b0b
+  data.tar.gz: f1c3ac76ba1e250fcba9b0c9ab294b8d7ad70b22ec57746783e719ad031e057e39306b6f1b202ad75ae0efe91c81e69ab470ab7b54f221619cf74dc9dabd4a95

data/.gitignore

@@ -0,0 +1,2 @@
+*.gem
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE

@@ -0,0 +1,20 @@
+The MIT License (MIT)
+
+Copyright (c) 2013 Openminds BVBA
+
+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,55 @@
+Sporf
+=======
+
+Parrallel ssh commands over chef servers with rspec-like output. sporf uses the exit codes of a command to determine whether it qualifies as a success or failure.
+
+Installation
+============
+
+## Requirements
+
+ * Ruby 1.9.3+
+ * [Knife configuration file](http://docs.opscode.com/config_rb_knife.html)
+
+Install the gem:
+
+    gem install sporf
+
+Usage
+=====
+
+`sporf test COMMAND [QUERY]` or `sporf -t COMMAND [QUERY]`
+
+## Test command
+
+Test if a given command returns 0 on all nodes:
+
+  sporf -t 'test -d /foo/bar/'
+
+Test if a given command **does not** return 0 on nodes:
+
+  sporf -t 'php -i | grep -i memcached' --invert
+
+Test if a given command returns 0 on all nodes, also print out the STDOUT of successfull commands:
+
+  sporf -t 'cat /etc/apache2/conf.d/ssl' --print-success
+
+Test if a given command returns 0, scoped on certain nodes (with [knife search syntax](http://docs.opscode.com/knife_search.html)):
+
+  sporf -t 'test -f /etc/apache2/conf.d/ssl' 'recipe:apache AND listen_ports:443'
+
+### Note
+
+sporf is not meant to modify server configurations, only to test how a server replies on a given (non-destructive) command. Use with caution.
+
+To-do
+=====
+
+ * Make the output truly RSpec compatible, so we can use RSpec formatters
+ * Stop forcing root user, system user (with sudo) should also work
+ * sporf should not be limited to Chef (main reason this isn't a knife plugin)
+
+Contributing
+============
+
+Bug reports, feature requests and test implementations are more than welcome. Please use [our Github account](https://github.com/openminds/sporf) for this.

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/bin/sporf

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+require 'sporf'
+require 'rubygems'
+require 'thor'
+
+class SporfCommand < Thor
+  map '-t' => :test
+
+  desc 'test COMMAND [QUERY]', 'Execute command on nodes, scoped on the given query if query is given. Query syntax should be the same as `knife search` syntax.'
+  option :invert, type: :boolean, desc: 'invert matched results', default: false
+  option :timeout, type: :numeric, desc: 'timeout interval per ssh connection (default: 15)', default: 15
+  option :'print-success', type: :boolean, desc: 'prints output of successful commands', default: false
+  def test(command, query='name:*')
+    Sporf.test(command, query, options[:timeout], options[:'print-success'], options[:invert])
+  end
+end
+
+SporfCommand.start

data/lib/sporf.rb

@@ -0,0 +1,25 @@
+require 'peach'
+
+require 'sporf/chef'
+require 'sporf/helpers'
+require 'sporf/printers'
+require 'sporf/sporf'
+require 'sporf/ssh'
+
+class Sporf
+  class << self
+    def test command, query, timeout_interval, verbose_success, invert
+      @command = command
+      @query = query
+      @timeout_interval = timeout_interval
+      @verbose_success = verbose_success
+      @invert = invert
+
+      knife_search(@query).peach(5) do |fqdn|
+        execute_query fqdn
+      end
+
+      print_summary
+    end
+  end
+end

data/lib/sporf/chef.rb

@@ -0,0 +1,16 @@
+require 'chef/knife'
+
+class Sporf
+  class << self
+    def knife_search query
+      # Monkey patch Chef::Knife::UI to hide stdout
+      Chef::Knife::UI.class_eval do
+        def stdout
+          @stdout_hack ||= ::File.new('/dev/null', 'w')
+        end
+      end
+
+      Chef::Knife.run(['search', 'node', query]).map { |node| node[:fqdn] }
+    end
+  end
+end

data/lib/sporf/helpers.rb

@@ -0,0 +1,40 @@
+require 'sporf/printers'
+
+class Sporf
+  class << self
+    def failed(reason)
+      failed_output_stream.push reason
+      print_fail
+    end
+
+    def succeeded(reason)
+      success_output_stream.push reason
+      print_success
+    end
+
+    def timed_out(reason)
+      timeout_output_stream.push reason
+      print_timeout
+    end
+
+    def timeout_output_stream
+      @timeout_output_stream ||= Array.new
+    end
+
+    def failed_output_stream
+      @failed_output_stream ||= Array.new
+    end
+
+    def success_output_stream
+      @success_output_stream ||= Array.new
+    end
+
+    def verbose_success?
+      @verbose_success
+    end
+
+    def invert?
+      @invert
+    end
+  end
+end

data/lib/sporf/printers.rb

@@ -0,0 +1,49 @@
+require 'colorize'
+
+class Sporf
+  class << self
+    def print_fail
+      print 'F'.red
+    end
+
+    def print_success
+      print '.'.green
+    end
+
+    def print_timeout
+      print '*'.yellow
+    end
+
+    def print_timeout_stream
+      timeout_output_stream.each do |output|
+        puts output.yellow
+      end
+    end
+
+    def print_failed_stream
+      failed_output_stream.each do |output|
+        puts output.red
+      end
+    end
+
+    def print_success_stream
+      success_output_stream.each do |output|
+        puts output.green
+      end
+    end
+
+    def print_summary
+      print "\n"
+      print_timeout_stream
+      print_failed_stream
+      print_success_stream if verbose_success?
+
+      puts "\n---------------------------------------\n"
+
+      puts "#{'Success'.green}: #{success_output_stream.count}"
+      puts "#{'Timed out or does not resolve'.yellow}: #{timeout_output_stream.count}"
+      puts "#{'Failed'.red}: #{failed_output_stream.count}"
+      puts "#{'Total'.blue}: #{success_output_stream.count + timeout_output_stream.count + failed_output_stream.count}"
+    end
+  end
+end

data/lib/sporf/sporf.rb

@@ -0,0 +1,30 @@
+require 'net/ssh'
+
+class Sporf
+  class << self
+    def execute_query fqdn
+      begin
+        timeout @timeout_interval do
+          Net::SSH.start(fqdn, 'root', paranoid: false, forward_agent: true) do |ssh|
+            output = ssh_exec!(ssh, @command)
+            parse_output output, fqdn
+          end
+        end
+      rescue TimeoutError, Errno::ETIMEDOUT, SocketError, Errno::EHOSTUNREACH => e
+        timed_out "#{fqdn}: #{e.message}"
+      rescue Exception => e
+        timed_out "#{fqdn}: #{e.inspect}"
+      end
+    end
+
+    def parse_output output, fqdn
+      if output[2] == 0 && !invert?
+        succeeded "#{fqdn}: #{output[0]}"
+      elsif output[2] != 0 && invert?
+        succeeded "#{fqdn} returned #{output[2]}: #{output[1]} #{output[0]}"
+      else
+        failed "#{fqdn} returned #{output[2]}: #{output[1]} #{output[0]}"
+      end
+    end
+  end
+end

data/lib/sporf/ssh.rb

@@ -0,0 +1,32 @@
+class Sporf
+  class << self
+    def ssh_exec!(ssh, command)
+      # I am not awesome enough to have made this method myself
+      # Originally submitted by 'flitzwald' over here: http://stackoverflow.com/a/3386375
+      stdout_data = ''
+      stderr_data = ''
+      exit_code = nil
+
+      ssh.open_channel do |channel|
+        channel.exec(command) do |ch, success|
+          unless success
+            abort "FAILED: couldn't execute command (ssh.channel.exec)"
+          end
+          channel.on_data do |ch,data|
+            stdout_data+=data
+          end
+
+          channel.on_extended_data do |ch,type,data|
+            stderr_data+=data
+          end
+
+          channel.on_request('exit-status') do |ch,data|
+            exit_code = data.read_long
+          end
+        end
+      end
+      ssh.loop
+      [stdout_data, stderr_data, exit_code]
+    end
+  end
+end

data/santoku.gemspec

@@ -0,0 +1,19 @@
+Gem::Specification.new do |spec|
+  spec.name = 'sporf'
+  spec.version = '0.0.1'
+  spec.executables << 'sporf'
+  spec.date = '2013-11-26'
+  spec.summary = 'Parrallel ssh commands over chef servers with rspec-like output'
+  spec.description = 'A gem to perform command over parallel ssh connections on multiple chef serverspec. Output is rspec-like.'
+  spec.authors = ['Steven De Coeyer', 'Jeroen Jacobs']
+  spec.email = 'tech@openminds.be'
+  spec.files = `git ls-files`.split($\)
+  spec.homepage = 'https://github.com/openminds/sporf'
+  spec.license = 'MIT'
+
+  spec.add_dependency 'chef', '~> 11.0'
+  spec.add_dependency 'colorize'
+  spec.add_dependency 'net-ssh'
+  spec.add_dependency 'peach'
+  spec.add_dependency 'thor'
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: sporf
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Steven De Coeyer
+- Jeroen Jacobs
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-11-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: chef
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '11.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '11.0'
+- !ruby/object:Gem::Dependency
+  name: colorize
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: net-ssh
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: peach
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: thor
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: A gem to perform command over parallel ssh connections on multiple chef
+  serverspec. Output is rspec-like.
+email: tech@openminds.be
+executables:
+- sporf
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/sporf
+- lib/sporf.rb
+- lib/sporf/chef.rb
+- lib/sporf/helpers.rb
+- lib/sporf/printers.rb
+- lib/sporf/sporf.rb
+- lib/sporf/ssh.rb
+- santoku.gemspec
+homepage: https://github.com/openminds/sporf
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Parrallel ssh commands over chef servers with rspec-like output
+test_files: []