santoku 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: fb52db36d32657b634327f65e244f02cb9994390
-  data.tar.gz: 132f2d8bb28bb26773bbec2a4c19bbcec0c6639f
+  metadata.gz: 5f3e96b1ed8dc6727e9a6fd000c91a9da0acdae3
+  data.tar.gz: b9585d19579e422da3546ae537a9bd9928d038a1
 SHA512:
-  metadata.gz: ee647aa900f3d34521211f176c34a0ee9f717bc722974e811f04a7de15c08060cb7d2320b2885cbfdfa3cdf2462d3e668d95215ba4f0ff3c14313133b95b2507
-  data.tar.gz: 55a051ddb3cb0379f983bef058bdd6d41e7637f8e39a783ae853d0d658c3681f73bf9f5093519a892f9ff1d2e6813bec9326760f5621a07a26b13bf187a6f339
+  metadata.gz: 7ff6d526ff71e412d737016f40de087cc6c876538f64fe612d80dd4935060190551818c8aa799ec524824977f15760ea40504d8f0e497c85a8a0d8fa44a7d0f8
+  data.tar.gz: 09373c8a5bc4d426e5ead8018e47119b871a99f26b03481ff7a43d6163804f9212c2099746ddeeb482c85c1c05ae110a4192f59d1b24dcb8a62127e7e8c4b079

data/README.md

@@ -1,11 +1,55 @@
-santoku
+Santoku
 =======
 
-Parrallel ssh commands over chef servers with rspec-like output
+Parrallel ssh commands over chef servers with rspec-like output. Santoku uses the exit codes of a command to determine whether it qualifies as a success or failure.
 
-install
-=======
+Installation
+============
+
+## Requirements
+
+ * Ruby 1.9.3+
+ * [Knife configuration file](http://docs.opscode.com/config_rb_knife.html)
 
-This is just a proof of concept for now. Install with:
+Install the gem:
 
     gem install santoku
+
+Usage
+=====
+
+`santoku test COMMAND [QUERY]` or `santoku -t COMMAND [QUERY]`
+
+## Test command
+
+Test if a given command returns 0 on all nodes:
+
+  santoku -t 'test -d /foo/bar/'
+
+Test if a given command **does not** return 0 on nodes:
+
+  santoku -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:
+
+  santoku -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)):
+
+  santoku -t 'test -f /etc/apache2/conf.d/ssl' 'recipe:apache AND listen_ports:443'
+
+### Note
+
+Santoku 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
+ * santoku 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/santoku) for this.

data/lib/santoku/ssh.rb

@@ -3,8 +3,8 @@ class Santoku
     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 = ""
+      stdout_data = ''
+      stderr_data = ''
       exit_code = nil
 
       ssh.open_channel do |channel|
@@ -20,7 +20,7 @@ class Santoku
             stderr_data+=data
           end
 
-          channel.on_request("exit-status") do |ch,data|
+          channel.on_request('exit-status') do |ch,data|
             exit_code = data.read_long
           end
         end

data/santoku.gemspec

@@ -1,8 +1,8 @@
 Gem::Specification.new do |spec|
   spec.name = 'santoku'
-  spec.version = '0.0.6'
+  spec.version = '0.0.7'
   spec.executables << 'santoku'
-  spec.date = '2013-11-17'
+  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']

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: santoku
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - Steven De Coeyer
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-17 00:00:00.000000000 Z
+date: 2013-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: chef
@@ -122,7 +122,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.0.14
 signing_key: 
 specification_version: 4
 summary: Parrallel ssh commands over chef servers with rspec-like output