sensu-plugin 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2730e59c7a3b4d3dbc9d167d84a5ca0a7e428ae7
-  data.tar.gz: 4922478ec5392ab0efb0e41bfee2076c175aee7a
+  metadata.gz: 3e879511e4d506f0d50d2ecd328eb8cab2c99b35
+  data.tar.gz: 717ac6db50d476cb67dcc4268d0d00340117bf35
 SHA512:
-  metadata.gz: 76dd04a3e1c2819c4cff3daefbb1f6ffeb250820b8e7d3fcbfa9e9a4f467074b3b25839c3fc166cda4b6131743465bcb12946e8b2de033afb84391897fbe05a2
-  data.tar.gz: bfdf09aff3a445ffc1a9f94d21d46a28193812e633b8d0c91fb5354d0c3f3b07f50a347cfead92f7d06d6db1c910ac1e461e02d64d7e1ca9b9ee85a829a76703
+  metadata.gz: 4321bb33eb3f14d9a971372de91da411417ae352e4c52fd0f671ef71c31d6902f1940f97c9c987dc397a61770da5293aa6902cfccfe6ed03c88639b46ecbb1d9
+  data.tar.gz: 5876be24bccca229feafc5f250136fe81f3e4cc20651fef37ad5f09718415eaf2d76d2de3d684cb6a3a845813855a65d57185d7f438aaa575f92765aac77fabd

data/lib/sensu-handler.rb

@@ -24,14 +24,38 @@ module Sensu
       puts 'ignoring event -- no handler defined'
     end
 
-    # Filters exit the proccess if the event should not be handled.
-    # Implementation of the default filters is below.
 
+    # Filters exit the proccess if the event should not be handled.
+    #
+    # Filtering events is deprecated and will be removed in a future release.
+    #
     def filter
-      filter_disabled
-      filter_repeated
-      filter_silenced
-      filter_dependencies
+      if deprecated_filtering_enabled?
+        puts 'warning: event filtering in sensu-plugin is deprecated, see http://bit.ly/sensu-plugin'
+        filter_disabled
+        filter_silenced
+        filter_dependencies
+        if deprecated_occurrence_filtering_enabled?
+          puts 'warning: occurrence filtering in sensu-plugin is deprecated, see http://bit.ly/sensu-plugin'
+          filter_repeated
+        end
+      end
+    end
+
+    # Evaluates whether the event should be processed by any of the filter methods in
+    # this library. Defaults to true (i.e. deprecated filters are run by default.)
+    #
+    # @return [TrueClass, FalseClass]
+    def deprecated_filtering_enabled?
+      @event['check']['enable_deprecated_filtering'].nil? || @event['check']['enable_deprecated_filtering'] == true
+    end
+
+    # Evaluates whether the event should be processed by the filter_repeated method. Defaults to true (i.e.
+    # filter_repeated will filter events by default)
+    #
+    # @return [TrueClass, FalseClass]
+    def deprecated_occurrence_filtering_enabled?
+      @event['check']['enable_deprecated_occurrence_filtering'].nil? || @event['check']['enable_deprecated_occurrence_filtering'] == true
     end
 
     # This works just like Plugin::CLI's autorun.
@@ -79,18 +103,28 @@ module Sensu
       exit 0
     end
 
+    # Return a hash of API settings derived first from ENV['SENSU_API_URL'] if set,
+    # then Sensu config `api` scope if configured, and finally falling back to
+    # to ipv4 localhost address on default API port.
+    #
+    # @return [Hash]
     def api_settings
-      @api_settings ||= if ENV['SENSU_API_URL']
+      return @api_settings if @api_settings
+      case
+      when ENV['SENSU_API_URL']
         uri = URI(ENV['SENSU_API_URL'])
-        {
+        @api_settings = {
           'host' => uri.host,
           'port' => uri.port,
           'user' => uri.user,
           'password' => uri.password
         }
       else
-        settings['api']
+        @api_settings = settings['api'] || {}
+        @api_settings['host'] ||= '127.0.0.1'
+        @api_settings['port'] ||= 4567
       end
+      @api_settings
     end
 
     def api_request(method, path, &blk)
@@ -98,7 +132,7 @@ module Sensu
         raise "api.json settings not found."
       end
       domain = api_settings['host'].start_with?('http') ? api_settings['host'] : 'http://' + api_settings['host']
-      uri = URI("#{domain}:#{api_settings['port']}#{path}") 
+      uri = URI("#{domain}:#{api_settings['port']}#{path}")
       req = net_http_req_class(method).new(uri)
       if api_settings['user'] && api_settings['password']
         req.basic_auth(api_settings['user'], api_settings['password'])

data/lib/sensu-plugin.rb

@@ -1,6 +1,6 @@
 module Sensu
   module Plugin
-    VERSION = "1.3.0"
+    VERSION = "1.4.0"
     EXIT_CODES = {
       'OK'       => 0,
       'WARNING'  => 1,

data/lib/sensu-plugin/cli.rb

@@ -51,6 +51,7 @@ module Sensu
       end
 
       at_exit do
+        exit 3 if $!
         if @@autorun
           begin
             check = @@autorun.new

data/lib/sensu-plugin/utils.rb

@@ -1,3 +1,5 @@
+require 'json'
+
 module Sensu
   module Plugin
     module Utils
@@ -17,7 +19,7 @@ module Sensu
       end
 
       def settings
-        @settings ||= config_files.map {|f| load_config(f) }.reduce {|a, b| a.deep_merge(b) }
+        @settings ||= config_files.map {|f| load_config(f) }.reduce {|a, b| deep_merge(a, b) }
       end
 
       def read_event(file)
@@ -44,23 +46,21 @@ module Sensu
           Net::HTTP::Put
         end
       end
-    end
-  end
-end
-
-# Monkey Patching.
 
-class Array
-  def deep_merge(other_array, &merger)
-    concat(other_array).uniq
-  end
-end
-
-class Hash
-  def deep_merge(other_hash, &merger)
-    merger ||= proc do |key, old_value, new_value|
-      old_value.deep_merge(new_value, &merger) rescue new_value
+      def deep_merge(hash_one, hash_two)
+        merged = hash_one.dup
+        hash_two.each do |key, value|
+          merged[key] = case
+          when hash_one[key].is_a?(Hash) && value.is_a?(Hash)
+            deep_merge(hash_one[key], value)
+          when hash_one[key].is_a?(Array) && value.is_a?(Array)
+            hash_one[key].concat(value).uniq
+          else
+            value
+          end
+        end
+        merged
+      end
     end
-    merge(other_hash, &merger)
   end
 end

data/test/deep_merge_test.rb

@@ -0,0 +1,27 @@
+require 'test_helper'
+require 'sensu-plugin/utils'
+
+class TestDeepMerge < MiniTest::Test
+  include SensuPluginTestHelper
+  include Sensu::Plugin::Utils
+
+  def test_hash
+    merged = deep_merge({:a => "a"}, {:b => "b"})
+    assert(merged == {:a => "a", :b => "b"})
+  end
+
+  def test_nested_hash
+    merged = deep_merge({:a => {:b => "c"}}, {:a => {:d => "e"}})
+    assert(merged == {:a => {:b => "c", :d => "e"}})
+  end
+
+  def test_nested_array
+    merged = deep_merge({:a => ["b"]}, {:a => ["c"]})
+    assert(merged, {:a => ["b", "c"]})
+  end
+
+  def test_conflicting_types
+    merged = deep_merge({:a => {:b => "c"}}, {:a => ["d"]})
+    assert(merged, {:a => {:b => "c"}})
+  end
+end

data/test/external_check_test.rb

@@ -1,6 +1,6 @@
 require 'test_helper'
 
-class TestCheckExternal < MiniTest::Unit::TestCase
+class TestCheckExternal < MiniTest::Test
   include SensuPluginTestHelper
 
   def setup
@@ -51,4 +51,11 @@ class TestCheckExternal < MiniTest::Unit::TestCase
     output = run_script '--doesnotexist'
     assert $?.exitstatus == 1 && output.include?('doesnotexist') && output.include?('invalid option')
   end
+
+  def test_bad_require
+    set_script 'external/bad-require' # TODO better way to switch scripts?
+    output = run_script '2>&1'
+    assert_equal($?.exitstatus, 3)
+    assert_match(/LoadError/, output)
+  end
 end

data/test/external_handler_argument_test.rb

@@ -2,7 +2,7 @@ require 'rubygems'
 require 'minitest/autorun'
 require 'json'
 
-class TestHandlerArgumentExternal < MiniTest::Unit::TestCase
+class TestHandlerArgumentExternal < MiniTest::Test
   include SensuPluginTestHelper
 
   def test_default

data/test/external_handler_test.rb

@@ -1,7 +1,7 @@
 require 'test_helper'
 require 'json'
 
-class TestHandlerExternal < MiniTest::Unit::TestCase
+class TestHandlerExternal < MiniTest::Test
   include SensuPluginTestHelper
 
   def setup

data/test/external_metric_test.rb

@@ -1,6 +1,6 @@
 require 'test_helper'
 
-class TestMetricExternal < MiniTest::Unit::TestCase
+class TestMetricExternal < MiniTest::Test
   include SensuPluginTestHelper
 
   def setup
@@ -14,7 +14,7 @@ class TestMetricExternal < MiniTest::Unit::TestCase
 
 end
 
-class TestGraphiteMetricExternal < MiniTest::Unit::TestCase
+class TestGraphiteMetricExternal < MiniTest::Test
   include SensuPluginTestHelper
 
   def setup
@@ -28,7 +28,7 @@ class TestGraphiteMetricExternal < MiniTest::Unit::TestCase
 
 end
 
-class TestStatsdMetricExternal < MiniTest::Unit::TestCase
+class TestStatsdMetricExternal < MiniTest::Test
   include SensuPluginTestHelper
 
   def setup

data/test/handle_filter_test.rb

@@ -1,6 +1,6 @@
 require 'test_helper'
 
-class TestFilterExternal < MiniTest::Unit::TestCase
+class TestFilterExternal < MiniTest::Test
   include SensuPluginTestHelper
 
   def setup
@@ -113,4 +113,96 @@ class TestFilterExternal < MiniTest::Unit::TestCase
     assert_equal(0, $?.exitstatus)
     assert_match(/dependency event exists/, output)
   end
+
+  def filter_deprecation_string
+    'warning: event filtering in sensu-plugin is deprecated, see http://bit.ly/sensu-plugin'
+  end
+
+  def test_filter_deprecation_warning_exists_by_default
+    event = {
+      'client' => { 'name' => 'test' },
+      'check' => { 'name' => 'test', 'refresh' => 30 },
+      'occurrences' => 60,
+      'action' => 'create'
+    }
+    output = run_script_with_input(JSON.generate(event))
+    assert_equal(0, $?.exitstatus)
+    assert_match(/#{filter_deprecation_string}/, output)
+  end
+
+  def test_filter_deprecation_warning_exists_when_explicitly_enabled
+    event = {
+      'client' => { 'name' => 'test' },
+      'check' => { 'name' => 'test', 'refresh' => 30, 'enable_deprecated_filtering' => true },
+      'occurrences' => 60,
+      'action' => 'create'
+    }
+    output = run_script_with_input(JSON.generate(event))
+    assert_equal(0, $?.exitstatus)
+    assert_match(/#{filter_deprecation_string}/, output)
+  end
+
+  def test_filter_deprecation_warning_does_not_exist_when_explicitly_disabled
+    event = {
+      'client' => { 'name' => 'test' },
+      'check' => {
+        'name' => 'unfiltered test',
+        'refresh' => 30,
+        'enable_deprecated_filtering' => false
+      },
+      'occurrences' => 60,
+      'action' => 'create',
+    }
+    output = run_script_with_input(JSON.generate(event))
+    assert_equal(0, $?.exitstatus)
+    refute_match(/#{filter_deprecation_string}/, output)
+  end
+
+  def occurrence_filter_deprecation_string
+    'warning: occurrence filtering in sensu-plugin is deprecated, see http://bit.ly/sensu-plugin'
+  end
+
+  def test_occurrence_filter_deprecation_warning_exists_by_default
+    event = {
+      'client' => { 'name' => 'test' },
+      'check' => { 'name' => 'test', 'refresh' => 30 },
+      'occurrences' => 60,
+      'action' => 'create'
+    }
+    output = run_script_with_input(JSON.generate(event))
+    assert_equal(0, $?.exitstatus)
+    assert_match(/#{occurrence_filter_deprecation_string}/, output)
+  end
+
+  def test_occurrence_filter_deprecation_warning_exists_when_explicitly_enabled
+    event = {
+      'client' => { 'name' => 'test' },
+      'check' => {
+        'name' => 'test',
+        'refresh' => 30,
+        'enable_deprecated_occurrence_filtering' => true
+      },
+      'occurrences' => 60,
+      'action' => 'create'
+    }
+    output = run_script_with_input(JSON.generate(event))
+    assert_equal(0, $?.exitstatus)
+    assert_match(/#{occurrence_filter_deprecation_string}/, output)
+  end
+
+  def test_occurrence_filter_deprecation_warning_does_not_exist_when_explicitly_disabled
+    event = {
+      'client' => { 'name' => 'test' },
+      'check' => {
+        'name' => 'unfiltered test',
+        'refresh' => 30,
+        'enable_deprecated_occurrence_filtering' => false
+      },
+      'occurrences' => 60,
+      'action' => 'create',
+    }
+    output = run_script_with_input(JSON.generate(event))
+    assert_equal(0, $?.exitstatus)
+    refute_match(/#{occurrence_filter_deprecation_string}/, output)
+  end
 end

data/test/handle_helper_test.rb

@@ -1,6 +1,6 @@
 require 'test_helper'
 
-class TestHandleHelpers < MiniTest::Unit::TestCase
+class TestHandleHelpers < MiniTest::Test
   include SensuPluginTestHelper
 
   def setup

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sensu-plugin
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Decklin Foster
@@ -9,22 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-06-06 00:00:00.000000000 Z
+date: 2016-07-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<="
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 2.0.0
 - !ruby/object:Gem::Dependency
   name: mixlib-cli
   requirement: !ruby/object:Gem::Requirement
@@ -82,6 +82,7 @@ files:
 - lib/sensu-plugin/cli.rb
 - lib/sensu-plugin/metric/cli.rb
 - lib/sensu-plugin/utils.rb
+- test/deep_merge_test.rb
 - test/external_check_test.rb
 - test/external_handler_argument_test.rb
 - test/external_handler_test.rb
@@ -110,17 +111,18 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.3
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: Sensu Plugins
 test_files:
-- test/external_metric_test.rb
-- test/handle_helper_test.rb
+- test/deep_merge_test.rb
+- test/external_check_test.rb
 - test/external_handler_argument_test.rb
-- test/handle_filter_test.rb
 - test/external_handler_test.rb
+- test/external_metric_test.rb
+- test/handle_filter_test.rb
+- test/handle_helper_test.rb
 - test/mutator_test.rb
-- test/external_check_test.rb
 - test/test_helper.rb
 has_rdoc: false