serverspec-runner 0.1.8 → 0.2.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ec59c8a9e9610ae3bb2e6666409ff2c1c3d04661
-  data.tar.gz: 28f8e6263c2ec3ac773d6a75de7ea1e57151b15a
+  metadata.gz: deb6b6b88775846ef3f209bde2980e2941af4f86
+  data.tar.gz: c31f9fa20adbc3e2ead705ef3f2ffb0c45f034ad
 SHA512:
-  metadata.gz: 7328503d1082c0f901922514368a75c97554632aa29a25781cc2a565db4e65ca1e00a86587d551523b6055cb7c9a82352dde8bd4da6715857106f4fc7d61a630
-  data.tar.gz: c8484c391ea579961f4915413f3342de60b129a19eae66e51beca36b203008bafc5c7f3efeb4a2dae2adeb625194bab0c08a19e9f19b578446f66717e08ae8b7
+  metadata.gz: 4e774ddd841a66cc479f81b6f9c2973aa0dfe5e75c46a40cc5943ecabce0ec881fca0bd5a7064eb6e372846f9e05bfb07d081aaacb8e4703cc40f0fa0e547603
+  data.tar.gz: 26a1ce6ae5f55017bff20eee4ed9c1fc2faf04cd7192a40148dfd362e3c4db941666aba7bce9beea06a5d96cf206e135bed204bf317c162b282fe43badd5fc65

data/README.md

@@ -59,66 +59,110 @@ For example. You write serverspec code like this.
 
 ```
 describe "nginx" do
-  describe "check install" do
-    describe package('nginx') do
-      it { should be_installed }
-    end
-  end
-    
+
   describe "check running" do
     describe process('nginx') do
       it { should be_running }
     end
   end
-    
-  describe "check process" do
-    describe process('nginx') do
-      it { should be_enabled }
-    end
-  end
 
-  describe "worker_connection:1024" do
-    describe file('/etc/nginx/nginx.conf') do
-      it { should contain "worker_connections 1024;" }
-    end
-  end
-
-  describe "logrotate interval" do
-    describe file('/etc/logrotate.d/nginx') do
-      it { should contain "rotate 14" }
-    end
+  describe file('/etc/logrotate.d/nginx') do
+    it { should be_file }
+    it { should contain "rotate 14" }
   end
 end
 ```
 
 You can get the following outputs.
 
+* serverspec-runner -t aa  : asci-art table(default)
 ```
-+------------------------------------------+
-|description                      | result |
-+------------------------------------------+
-|example@anyhost-01(172.30.4.131) |        |
-|  nginx check install            | OK     |
-|  nginx check running            | NG     |
-|  nginx check process            | OK     |
-|  nginx worker_connection:1024   | OK     |
-|  nginx logrotate interval       | NG     |
-|example@anyhost-02(172.30.4.171) |        |
-|  nginx check install            | OK     |
-|  nginx check running            | NG     |
-|  nginx check process            | OK     |
-|  nginx worker_connection:1024   | OK     |
-|  nginx logrotate interval       | NG     |
-+------------------------------------------+
++-------------------------------------------+
+|description                       | result |
++-------------------------------------------+
+|example@anyhost-01(192.168.11.1)  |        |
+|  nginx                           |        |
+|    check running                 |        |
+|      Process "nginx"             |        |
+|        should be running         |   OK   |
+|    File "/etc/logrotate.d/nginx" |        |
+|      should be file              |   OK   |
+|      should contain "rotate 14"  |   OK   |
+|example@anyhost-02(192.168.11.2)  |        |
+|  nginx                           |        |
+|    check running                 |        |
+|      Process "nginx"             |        |
+|        should be running         |   OK   |
+|    File "/etc/logrotate.d/nginx" |        |
+|      should be file              |   OK   |
+|      should contain "rotate 14"  |   NG   |
++-------------------------------------------+
+```
+
+* serverspec-runner -t mkd : markdown table format
+```
+|description                       | result |
+|:---------------------------------|:------:|
+|example@anyhost-01(192.168.11.1)  |        |
+|  nginx                           |        |
+|    check running                 |        |
+|      Process "nginx"             |        |
+|        should be running         |   OK   |
+|    File "/etc/logrotate.d/nginx" |        |
+|      should be file              |   OK   |
+|      should contain "rotate 14"  |   OK   |
+|example@anyhost-02(192.168.11.2)  |        |
+|  nginx                           |        |
+|    check running                 |        |
+|      Process "nginx"             |        |
+|        should be running         |   OK   |
+|    File "/etc/logrotate.d/nginx" |        |
+|      should be file              |   OK   |
+|      should contain "rotate 14"  |   NG   |
+```
+
+this example parsed for markdown to that(use -e long option)
 
+|description                                                      | result |
+|:----------------------------------------------------------------|:------:|
+|example@anyhost-01(192.168.11.1)                                 |        |
+|  nginx check running Process "nginx" should be running          |   OK   |
+|  nginx File "/etc/logrotate.d/nginx" should be file             |   OK   |
+|  nginx File "/etc/logrotate.d/nginx" should contain "rotate 14" |   OK   |
+|example@anyhost-01(192.168.11.2)                                 |        |
+|  nginx check running Process "nginx" should be running          |   OK   |
+|  nginx File "/etc/logrotate.d/nginx" should be file             |   OK   |
+|  nginx File "/etc/logrotate.d/nginx" should contain "rotate 14" |   NG   |
+
+* serverspec-runner -t bool : only 'ok' or 'ng' result string.t
+You can use for cluster monitoring system health.
+
+```
+ng
 ```
 
-You can use -e option and choose following outputs.
+* serverspec-runner -t csv : CSV file format
+You can get result CSV format output and can use redirect to file.
 
-* aa  : asci-art table(default)
-* mkd : markdown table format
-* csv : CSV file format
-* bool: only 'ok' or 'ng' result string.
+```
+description,,,,,result
+example@anyhost-01(192.168.11.1),,,,,
+,nginx,,,,
+,,check running,,,
+,,,Process "nginx",,
+,,,,should be running,OK
+,,File "/etc/logrotate.d/nginx",,,
+,,,should be file,,OK
+,,,should contain "rotate 14",,OK
+example@anyhost-02(192.168.11.2),,,,,
+,nginx,,,,
+,,check running,,,
+,,,Process "nginx",,
+,,,,should be running,OK
+,,File "/etc/logrotate.d/nginx",,,
+,,,should be file,,OK
+,,,should contain "rotate 14",,NG
+```
 
 For more detail. You can see from `serverspec-runner -h` command.
 

data/Rakefile

@@ -23,7 +23,7 @@ namespace :spec do
   ENV['result_csv'] = ENV['result_csv'] || './_serverspec_result.csv'
   csv_file = ENV['result_csv']
   CSV.open(csv_file, 'w') { |w| w << ['description', 'result'] }
-  ENV['explain'] = ENV['explain'] || "long"
+  ENV['explain'] = ENV['explain'] || "short"
   ENV['tableformat'] = ENV['tableformat'] || "aa"
   ENV['scenario'] = ENV['scenario'] || "./scenario.yml"
 
@@ -56,10 +56,11 @@ namespace :spec do
 
     if abs_node.kind_of?(Hash)
       abs_node.keys.each do |n|
-        path <<  '::' unless path.empty?
-        path << n.to_s
-        path = gen_exec_plan(abs_node, n, path, ssh_options, tasks, platform)
+        path.push(n.to_s)
+        gen_exec_plan(abs_node, n, path, ssh_options, tasks, platform)
       end
+
+      path.pop
     elsif abs_node.kind_of?(Array)
       abs_node.each do |host_alias|
         if platform.include?(host_alias.to_sym)
@@ -70,12 +71,11 @@ namespace :spec do
         end
 
         platform[host_alias.to_sym][:ssh_opts].each { |k, v| ssh_options[k.to_sym] = v } if platform[host_alias.to_sym].include?(:ssh_opts)
-
-        tasks << "#{path}::#{host_alias}"
+        tasks << "#{path.join('::')}::#{host_alias}"
       end
-    end
 
-    return path
+      path.pop
+    end
   end
 
   def exec_tasks(parent, node, real_path, platform)
@@ -85,18 +85,16 @@ namespace :spec do
     else
       abs_node = parent[node]
     end
-    
+
     if abs_node.kind_of?(Hash)
       abs_node.keys.each do |n|
-        real_path << n
-        real_path = exec_tasks(abs_node, n, real_path, platform)
+        real_path.push(n)
+        exec_tasks(abs_node, n, real_path, platform)
       end
+
+      real_path.pop
     elsif abs_node.kind_of?(Array)
-      task_path = ''
-      real_path.map.each do |p|
-        task_path << '::' unless task_path.empty?
-        task_path << p
-      end
+      task_path = "#{real_path.join('::')}"
 
       abs_node.each do |host_alias|
         desc "Run serverspec to #{task_path}@#{host_alias}"
@@ -116,10 +114,8 @@ namespace :spec do
         end
       end
 
-      return []
+      real_path.pop
     end
-
-    return real_path
   end
 
   if !Dir.exists?(ENV['specpath'])
@@ -171,7 +167,7 @@ namespace :spec do
   end
 
   tasks = []
-  gen_exec_plan(nil, scenarios, '', ssh_options, tasks, platform)
+  gen_exec_plan(nil, scenarios, [], ssh_options, tasks, platform)
 
   task :stdout do
 
@@ -184,8 +180,16 @@ namespace :spec do
 
       puts ret
     elsif ENV['tableformat'] == 'csv'
+
+      maxrows = 0
       CSV.foreach(csv_file) do |r|
-        puts "#{r[0].strip}#{r[1].empty? ? '': ','}#{r[1]}"
+        maxrows = r[2].to_i if r[2].to_i > maxrows
+      end
+      maxrows += 1 # host row
+
+      CSV.foreach(csv_file) do |r|
+        pad_comma = ',' * (maxrows - r[0].split(',').length)
+        puts "#{r[0]}#{pad_comma},#{r[1]}"
       end
     else
       maxlen = 0
@@ -193,9 +197,9 @@ namespace :spec do
         n =  r[0].each_char.map{|c| c.bytesize == 1 ? 1 : 2}.reduce(0, &:+)
         maxlen = n if n > maxlen
       end
-  
+
       pad_spaces = 4
-  
+
       spacer = nil
       if ENV['tableformat'] == 'mkd'
         spacer = "|:" + ("-" * maxlen) + "|:" + ("-" * "result".length) + ":|"
@@ -207,19 +211,22 @@ namespace :spec do
       is_header = true
       CSV.foreach(csv_file) do |r|
         n =  r[0].each_char.map{|c| c.bytesize == 1 ? 1 : 2}.reduce(0, &:+)
-        pad_mid = (" " * (maxlen - n)) + " | "
-        pad_tail = (" " * ("result".length - r[1].length)) + " |"
 
         if r[1] == 'OK'
           s_effect = "\e[32m"
           e_effect = "\e[m"
+          r[1] = '  ' + r[1]
         elsif  r[1] == 'NG'
           s_effect = "\e[31m"
           e_effect = "\e[m"
+          r[1] = '  ' + r[1]
         end
-        
+
+        pad_mid = (" " * (maxlen - n)) + " | "
+        pad_tail = (" " * ("result".length - r[1].length)) + " |"
+
         puts "|#{s_effect}#{r[0]}#{e_effect}#{pad_mid}#{s_effect}#{r[1]}#{e_effect}#{pad_tail}"
-  
+
         if is_header
           puts spacer
           is_header = false

data/bin/serverspec-runner

@@ -12,12 +12,11 @@ opts = GetoptLong.new(
   ["--scenario",     "-s", GetoptLong::REQUIRED_ARGUMENT],
   ["--specroot",     "-r", GetoptLong::REQUIRED_ARGUMENT],
   ["--ssh_options",  "-o", GetoptLong::REQUIRED_ARGUMENT],
-  ["--result_csv",   "-c", GetoptLong::REQUIRED_ARGUMENT],
   ["--explain",      "-e", GetoptLong::REQUIRED_ARGUMENT],
   ["--tableformat",  "-t", GetoptLong::REQUIRED_ARGUMENT],
   ["--help",         "-h", GetoptLong::NO_ARGUMENT],
   ["--tmpdir",       "-1", GetoptLong::REQUIRED_ARGUMENT],
-  ["--task",         "-2", GetoptLong::REQUIRED_ARGUMENT]
+  ["--tasks",        "-T", GetoptLong::REQUIRED_ARGUMENT]
 )
 
 opts.each do |opt, arg|
@@ -28,24 +27,22 @@ opts.each do |opt, arg|
     ENV['specroot'] = arg
   when '--ssh_options'
     ENV['ssh_options'] = arg
-  when '--result_csv'
-    ENV['result_csv'] = arg
   when '--explain'
     ENV['explain'] = arg
   when '--tableformat'
     ENV['tableformat'] = arg
   when '--tmpdir'
     ENV['tmpdir'] = arg
-  when '--task'
+  when '--tasks'
     raketask += "::" + arg
   else
     puts "Usage: serverspec-runner (options)"
     puts "-s, --scenario     SCENARIO_FILE        path to scenario yml file"
     puts "-r, --specroot     SPEC_ROOT            path to spec tests root dir"
     puts "-o, --ssh_options  SSH_OPTIONS_FILE     path to ssh options yml file"
-    puts "-c, --result_csv   RESULT_CSV_FILE      path to result csv file"
-    puts "-e, --explain      (short|long)         specify result explain length(default: long)"
+    puts "-e, --explain      (short|long)         specify result explain length(default: short)"
     puts "-t, --tableformat  (aa|mkd|csv|bool)    specify result table type(default: aa)"
+    puts "-T, --tasks                             display the tasks with descriptions(exec rake -T)"
     puts "-h, --help                              show help"
     exit 0
   end

data/lib/serverspec-runner/version.rb

@@ -1,3 +1,3 @@
 module ServerspecRunner
-  VERSION = "0.1.8"
+  VERSION = "0.2.3"
 end

data/spec/example/default.rb

@@ -1,10 +1,28 @@
 require "#{File.dirname(__FILE__)}/../spec_helper"
 
-describe "example" do
+describe package('httpd'), :if => os[:family] == 'redhat' do
+  it { should be_installed }
+end
+
+describe package('apache2'), :if => os[:family] == 'ubuntu' do
+  it { should be_installed }
+end
+
+describe service('httpd'), :if => os[:family] == 'redhat' do
+  it { should be_enabled }
+  it { should be_running }
+end
+
+describe service('apache2'), :if => os[:family] == 'ubuntu' do
+  it { should be_enabled }
+  it { should be_running }
+end
+
+describe service('org.apache.httpd'), :if => os[:family] == 'darwin' do
+  it { should be_enabled }
+  it { should be_running }
+end
 
-  describe "hostname実行" do
-    describe command("hostname") do
-      it { eq 0 }
-    end
-  end
+describe port(80) do
+  it { should be_listening }
 end

data/spec/spec_helper.rb

@@ -9,6 +9,17 @@ ssh_opts_default = YAML.load_file(ENV['ssh_options'])
 csv_path = ENV['result_csv']
 explains = []
 results = []
+row_num = []
+spacer_char = '  ' unless ENV['tableformat'] == 'csv'
+spacer_char = ',' if ENV['tableformat'] == 'csv'
+
+def get_example_desc(example_group, descriptions)
+
+  descriptions << example_group[:description]
+  return descriptions if example_group[:parent_example_group] == nil
+
+  get_example_desc(example_group[:parent_example_group], descriptions)
+end
 
 RSpec.configure do |c|
 
@@ -48,6 +59,8 @@ RSpec.configure do |c|
     set :backend, :exec
   end
 
+  prev_desc_hierarchy = nil
+
   c.before(:suite) do
     entity_host = (((ENV['TARGET_HOST'] != ENV['TARGET_SSH_HOST']) && (ENV['TARGET_SSH_HOST'] != nil)) ? "(#{ENV['TARGET_SSH_HOST']})" : "")
     puts "\e[33m"
@@ -56,32 +69,42 @@ RSpec.configure do |c|
 
     explains << "#{role_name}@#{ENV['TARGET_HOST']}#{entity_host}"
     results << ""
+    row_num << 1
   end
 
   c.after(:each) do
+
     if ENV['explain'] == 'long'
-      explains << "  " + example.metadata[:full_description] + (RSpec::Matchers.generated_description || '')
+      explains << spacer_char + example.metadata[:full_description] + (RSpec::Matchers.generated_description || '')
+      results << (self.example.exception ? 'NG' : 'OK')
+      row_num << 1
     else
 
-      second_depth = self.example.metadata.depth - 3
-      h = self.example.metadata
-
-      second_depth.times do |i|
-        h = h[:example_group]
+      spacer = ''
+      desc_hierarchy = get_example_desc(self.example.metadata[:example_group], []).reverse
+      desc_hierarchy.each_with_index do |ex, i|
+        spacer += spacer_char
+
+        if prev_desc_hierarchy != nil && prev_desc_hierarchy.length > i && prev_desc_hierarchy[i] == desc_hierarchy[i]
+        else
+          explains << spacer + ex
+          results << ''
+          row_num << i + 1
+        end
       end
 
-      second_desc = h[:description]
-      first_desc = h[:example_group][:description]
+      explains << spacer + spacer_char + RSpec::Matchers.generated_description
+      results << (self.example.exception ? 'NG' : 'OK')
+      row_num << desc_hierarchy.length + 1
 
-      explains << "  " + first_desc + " " + second_desc
+      prev_desc_hierarchy = desc_hierarchy
     end
-    results << (self.example.exception ? 'NG' : 'OK')
   end
 
   c.after(:suite) do
     CSV.open(csv_path, 'a') do |writer|
       explains.each_with_index do |v, i|
-        writer << [v, results[i]]
+        writer << [v, results[i], row_num[i]]
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: serverspec-runner
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.2.3
 platform: ruby
 authors:
 - hiracy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-10 00:00:00.000000000 Z
+date: 2014-10-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: serverspec