sensu-plugins-rspec 0.0.1.alpha.3 → 0.0.1.alpha.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9c2fccfcf3ebb4a3dcf5961c832e36d6696ddf26
-  data.tar.gz: c4332f1aeb0cd53e9c6462c57a5548f3240c62f9
+  metadata.gz: 691e9d04d8b81e7606ce89ed1fc90845d0fa78d0
+  data.tar.gz: 93d743ebd2837b3b820cf990d0368d1f02ae378e
 SHA512:
-  metadata.gz: 17a852636807d900b7cb2b340fba6da785d6d8d76d5ffda6a3f63c51f10644452b48067b109d606f42171be23813b2d0ba71e1b29a352b8de2753815c642a609
-  data.tar.gz: 5fdb12daf09837d2d07966b6d2f2a3475abfb9e1c50e3d4b2658165df75d2aba9c306de91d67f1fe424bca4bc98574611d96302695e330abbf7c406fe79ddfe5
+  metadata.gz: 60a3abf9d667c0ba24089d5d85a7c0fe5bc0d2caf2788fa85509c583a4ec77d1101881fe8a0605c4bb45a5525ea490bade3a6ddb8230d8298a615b7a35bfef53
+  data.tar.gz: 2e0c9e5e5e8935977e525b5efba9fdea217cc743848a178761570769fa872c5a78bc7f268749a7a78588b7ae098d22498171b9fea7605bc40eea37e555e53e34

data/CHANGELOG.md

@@ -12,3 +12,6 @@
 #### 0.0.1.alpha.3
 
 * pin all runtime dependencies
+* fix rubocop issues
+* add new version modules
+* add new bump and version rake tasks

data/README.md

@@ -47,7 +47,7 @@ You can also download the key from /certs/ within each repository.
 
 #### Bundler
 
-Add *sensu-plugins-disk-checks* to your Gemfile and run `bundle install` or `bundle update`
+Add *sensu-plugins-rspec* to your Gemfile and run `bundle install` or `bundle update`
 
 #### Chef
 

data/bin/check-test-suite.rb

@@ -0,0 +1,189 @@
+#!/usr/bin/env ruby
+#  encoding: UTF-8
+#  check-test-suite
+#
+#  DESCRIPTION:
+#    This plugin attempts to run rspec and return the results of the run to the handler.
+#
+#    When a run begins, it creates a file cache that it will reference on the next run to
+#      prevent false positives from being returned to the handler. If the run fails a particular
+#      codebase twice, then it will return critical to the handler, not on the first fail.
+#
+#  OUTPUT:
+#    plain text
+#
+#  PLATFORMS:
+#    Linux
+#
+#  DEPENDENCIES:
+#    gem: sensu-plugin
+#    gem: json
+#    gem: rspec
+#    gem: fileutils
+#
+#  USAGE:
+#    Recommended usage:
+#      sudo /opt/sensu/embedded/bin/ruby /etc/sensu/plugins/check-test-suite.rb -p codebase1,codebase2,codebase3 -b /path/to/codebase's/ruby
+#
+#  NOTES:
+#    codebase should be a full path to the root of the codebase (current folder ideally)
+#    sudo is preferred but may not be necessary
+#      Depending on your test suite, the sensu user may not have write permissions to the directories where the code is to deal with things like coverage gem)
+#    The codebases must be managed through git to be effective, the check relies on being able to find the commits in the filesystem.
+#
+#  LICENSE:
+#    Louis Alridge louis@socialcentiv.com (loualrid@gmail.com)
+#    Released under the same terms as Sensu (the MIT license); see LICENSE
+#    for details.
+
+require 'json'
+require 'rspec'
+require 'fileutils'
+require 'sensu-plugin/check/cli'
+
+#
+# CheckTestSuite Class
+#
+class CheckTestSuite < Sensu::Plugin::Check::CLI
+  option :paths,
+         description: 'Paths to run the tests, comma delimited',
+         short: '-p PATHS',
+         long: '--path PATHS'
+
+  option :ruby_bin,
+         description: 'Location of ruby bin, it is highly recommended to use the rvm gemset ruby if utilizing rvm',
+         short: '-b ruby',
+         long: '--ruby-bin ruby',
+         default: 'ruby'
+
+  option :environment_variables,
+         description: 'Optional additional environmental variables to pass to ruby and/or rspec',
+         short: '-e aws_access_key_id=XXX',
+         long: '--env-var aws_access_key_id=XXX',
+         required: false
+
+  option :test_suite,
+         description: 'Test suite to test against, defaults to rspec',
+         short: '-t SUITE',
+         long: '--test-suite SUITE',
+         default: 'rspec'
+
+  option :suite_arguments,
+         description: 'Optional args to pass to rspec, defaults to --fail-fast. Enclose args in quotes or else the plugin will error',
+         short: '-a "RSPEC_ARGS"',
+         long: '--args "RSPEC_ARGS"',
+         default: '--fail-fast'
+
+  option :gem_home,
+         description: 'Attempts to utilize the bundle stored in vendor/bundle. Cookbooks not using the standard gem location will need to set this',
+         short: '-d GEM_HOME',
+         long: '--gem-home GEM_HOME',
+         default: 'vendor/bundle'
+
+  def initialize_file_cache(branch, commit)
+    commit_file_directory = "/var/log/sensu/check-test-suite-#{ branch }"
+
+    FileUtils.mkdir_p commit_file_directory
+
+    write_file_cache_message "#{ commit_file_directory }/#{ commit }", 'verified'
+  end
+
+  def write_file_cache_message(location, message)
+    if !File.exist?(location)
+      File.open(location, 'w') { |f| f.write(message) }
+    else
+      File.open(location, 'a') { |f| f.puts(message) }
+    end
+  end
+
+  def run #rubocop:disable all
+    full_start       = Time.now
+    tests            = {}
+    successful_tests = {}
+
+    final_gem_home = config[:gem_home]
+
+    config[:paths].split(',').each do |path|
+      start       = Time.now
+      tests[path] = {}
+
+      tests[path]['commit'] = `/bin/readlink #{ path }`.split('/').last.chomp.strip
+      tests[path]['branch'] = `cd #{ path } && /usr/bin/git branch -r --contains #{ tests[path]['commit'] }`.split("\n").last.chomp.strip.split('origin/').last
+
+      initialize_file_cache tests[path]['branch'], tests[path]['commit']
+
+      commit_file = "/var/log/sensu/check-test-suite-#{ tests[path]['branch'] }/#{ tests[path]['commit'] }"
+
+      next if File.exist?(commit_file) && File.read(commit_file).include?('successful')
+
+      if config[:gem_home] == 'vendor/bundle'
+        target_ruby = ''
+        target_rubies = Dir.entries("#{ path }/#{ config[:gem_home] }/ruby").select { |item| item =~ /(\d+\.\d+\.\d+)/ }
+
+        target_rubies.each do |ruby|
+          target_rubies.each do |other_ruby|
+            target_ruby = if ruby != other_ruby
+                            ruby if Gem::Version.new(ruby) > Gem::Version.new(other_ruby)
+                          elsif target_rubies.count == 1
+                            ruby
+                          end
+          end
+        end
+
+        final_gem_home = `/bin/readlink #{ path }`.chomp.strip + "/#{ config[:gem_home] }/ruby/#{ target_ruby }"
+      end
+
+      ENV['GEM_HOME'] = final_gem_home
+      test_suite_args = [
+        "cd #{ path };",
+        "#{ config[:environment_variables] } #{config[:ruby_bin]} -S #{ config[:test_suite] }",
+        "#{ config[:suite_arguments] } --failure-exit-code 2"
+      ]
+
+      tests[path]['test_suite_out']  = `#{ test_suite_args.join(' ') }`
+      tests[path]['runtime']         = Time.now - start
+      tests[path]['exitstatus']      = $CHILD_STATUS.exitstatus
+      tests[path]['commit']          = `/bin/readlink #{ path }`.split('/').last
+      target_branch                  = `cd #{ path } && /usr/bin/git branch -r --contains #{ tests[path]['commit'] }`
+      tests[path]['branch']          = target_branch.split("\n").last.chomp.strip.split('origin/').last
+      tests[path]['metadata']        = `cd #{ path } && /usr/bin/git show #{ tests[path]['commit'] }`
+
+      case tests[path]['exitstatus']
+      when 2
+        test_suite_lines = tests[path]['test_suite_out'].split("\n")
+        test_suite_out_fail_line = test_suite_lines.index(test_suite_lines.select { |line| line.include?('Failures:') }.first)
+
+        write_file_cache_message commit_file, 'failure'
+
+        # To eliminate false positives, we run a failing suite twice before sending the response
+        next if File.read(commit_file).scan(/failure/).count < 2
+
+        critical_out = [
+          "CRITICAL! Rspec returned failed tests for #{ tests[path]['branch'] }!",
+          "#{ tests[path]['metadata'] }#{ test_suite_lines[test_suite_out_fail_line..(test_suite_lines.count)].join("\n") }",
+          "Error'd in #{ tests[path]['runtime'] } seconds."
+        ]
+
+        critical critical_out.join("\n\n")
+      when 0
+        successful_tests[path] = tests[path]
+
+        write_file_cache_message commit_file, 'successful'
+
+        if config[:paths].split(',').length == 1
+          ok "OK! Rspec returned no failed tests for #{ tests[path]['branch'] }.\n\n#{ tests[path]['metadata'] }\n\nCompleted in #{ tests[path]['runtime'] }"
+        end
+      else
+        unknown "Strange exit status detected for rspec on #{ tests[path]['branch'] }.\n\n#{ tests[path]['test_suite_out'] }"
+      end
+    end
+
+    successful_branches = []
+
+    successful_tests.each_pair { |_key, hash| successful_branches << hash['branch'] }
+
+    ok "OK! Rspec returned no failed tests for #{ successful_branches.join(', ') }.\nCompleted in #{ full_start - Time.now } seconds."
+  rescue StandardError => e
+    critical "Error message: #{ e }\n#{ e.backtrace.join("\n") }"
+  end
+end

data/lib/sensu-plugins-rspec.rb

@@ -1,7 +1,15 @@
+
+require 'sensu-plugins-rspec/version'
+
+# Load the defaults
+
 #
-# Set gem version
+# Default class
 #
-module SensuPluginsRspec
-  # Gem version
-  VERSION = '0.0.1.alpha.3'
+module SensuPluginsRSpec
+  class << self
+  end
+
+  class << self
+  end
 end

data/lib/sensu-plugins-rspec/version.rb

@@ -0,0 +1,28 @@
+require 'json'
+
+# encoding: utf-8
+module SensuPluginsRSpec
+  # This defines the version of the gem
+  module Version
+    MAJOR = 0
+    MINOR = 0
+    PATCH = 1
+
+    VER_STRING = [MAJOR, MINOR, PATCH, 'alpha.4'].compact.join('.')
+
+    NAME   = 'sensu-plugins-rspec'
+    BANNER = "#{NAME} v%s"
+
+    module_function
+
+    def version
+      format(BANNER, VER_STRING)
+    end
+
+    def json_version
+      {
+          'version' => VER_STRING
+      }.to_json
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sensu-plugins-rspec
 version: !ruby/object:Gem::Version
-  version: 0.0.1.alpha.3
+  version: 0.0.1.alpha.4
 platform: ruby
 authors:
 - Yieldbot, Inc. and contributors
@@ -30,7 +30,7 @@ cert_chain:
   8sHuVruarogxxKPBzlL2is4EUb6oN/RdpGx2l4254+nyR+abg//Ed27Ym0PkB4lk
   HP0m8WSjZmFr109pE/sVsM5jtOCvogyujQOjNVGN4gz1wwPr
   -----END CERTIFICATE-----
-date: 2015-03-06 00:00:00.000000000 Z
+date: 2015-04-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sensu-plugin
@@ -50,58 +50,64 @@ dependencies:
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: 1.8.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.8'
+        version: 1.8.2
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.2'
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.1'
+        version: '3.2'
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.2.0
 - !ruby/object:Gem::Dependency
   name: codeclimate-test-reporter
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '0.4'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: 0.17.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.17'
+        version: 0.17.0
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -186,10 +192,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.10'
-description: Checks for RSpec test completion and status
+description: Sensu plugins for working with RSpec
 email: "<sensu-users@googlegroups.com>"
-executables:
-- check-rspec.rb
+executables: []
 extensions: []
 extra_rdoc_files: []
 files:
@@ -197,11 +202,16 @@ files:
 - LICENSE
 - README.md
 - bin/check-rspec.rb
+- bin/check-test-suite.rb
 - lib/sensu-plugins-rspec.rb
+- lib/sensu-plugins-rspec/version.rb
 homepage: https://github.com/sensu-plugins/sensu-plugins-rspec
 licenses:
 - MIT
-metadata: {}
+metadata:
+  maintainer: ''
+  development_status: active
+  production_status: unstable - testing recommended
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -221,5 +231,6 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: Checks for RSpec test completion and status
+summary: Sensu plugins for working with RSpec
 test_files: []
+has_rdoc: