sensu-plugin 2.6.1 → 2.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b1dfcce5f32c8ed80fd9da0ff34dfac0b6b3a999
-  data.tar.gz: 19da9ae23b0a0706f05c84ffb50ad4415433c383
+  metadata.gz: 3933344846102d33bd69622c4134b3a53c687cce
+  data.tar.gz: 1cd15f9096d8e72250b667d425317739f30a0ed3
 SHA512:
-  metadata.gz: 3eb2f697572579bf4af26638f38a1e849ca873150412ccff731f6f770f4342b5d98919c4b7bc6bcd0a9c488c938ebd67e042bfd143dcc3c157084a6a7cf4789a
-  data.tar.gz: 0bb69e9bb18ddf8eaea85f5f07643ff45cc230b4ca2510e84814c20dd7b1f87f52c6ea524cd62d5f7a06c11b2f835d90dcb45d8338e25780455cadb592ff7c62
+  metadata.gz: 4205c698be3548741f7942566b00453ed58c3f3550d5dc51a98644ec6fcca092f2a0b418baa95c463d4d84123344260cd5a85ecbccfcb0d8ab182f534a2a70d7
+  data.tar.gz: 591c9f4bce7d7e178c2bb6c5f99e7e2682625f56f9efb5b663661b2beb4a665ede9f9a130cb3133db1e0d9795e0f3686d6fc616dd97c05ad34ae968129d29bf6

data/lib/sensu-handler.rb

@@ -9,6 +9,10 @@ module Sensu
   class Handler
     include Sensu::Plugin::Utils
     include Mixlib::CLI
+    option :map_v2_event_into_v1,
+           description: 'Enable 2.x to 1.4 event mapping. Alternatively set envvar SENSU_MAP_V2_EVENT_INTO_V1=1.',
+           boolean:     true,
+           long:        '--map-v2-event-into-v1'
 
     attr_accessor :argv
 
@@ -73,6 +77,14 @@ module Sensu
       if @@autorun
         handler = @@autorun.new
         handler.read_event(STDIN)
+
+        TRUTHY_VALUES = %w[1 t true yes y].freeze
+        automap = ENV['SENSU_MAP_V2_EVENT_INTO_V1'].to_s.downcase
+
+        if handler.config[:map_v2_event_into_v1] || TRUTHY_VALUES.include?(automap)
+          new_event = handler.map_v2_event_into_v1
+          handler.event = new_event
+        end
         handler.filter
         handler.handle
       end

data/lib/sensu-mutator.rb

@@ -34,6 +34,10 @@ module Sensu
   class Mutator
     include Sensu::Plugin::Utils
     include Mixlib::CLI
+    option :map_v2_event_into_v1,
+           description: 'Enable 2.x to 1.4 event mapping. Alternatively set envvar SENSU_MAP_V2_EVENT_INTO_V1=1.',
+           boolean:     true,
+           long:        '--map-v2-event-into-v1'
 
     attr_accessor :argv
 
@@ -67,6 +71,15 @@ module Sensu
       return unless @@autorun
       mutator = @@autorun.new
       mutator.read_event(STDIN)
+
+      TRUTHY_VALUES = %w[1 t true yes y].freeze
+      automap = ENV['SENSU_MAP_V2_EVENT_INTO_V1'].to_s.downcase
+
+      if mutator.config[:map_v2_event_into_v1] || TRUTHY_VALUES.include?(automap)
+        new_event = mutator.map_v2_event_into_v1
+        mutator.event = new_event
+      end
+
       mutator.mutate
       mutator.dump
     end

data/lib/sensu-plugin.rb

@@ -1,6 +1,6 @@
 module Sensu
   module Plugin
-    VERSION = '2.6.1'.freeze
+    VERSION = '2.7.0'.freeze
     EXIT_CODES = {
       'OK'       => 0,
       'WARNING'  => 1,

data/lib/sensu-plugin/utils.rb

@@ -23,6 +23,14 @@ module Sensu
         @settings ||= config_files.map { |f| load_config(f) }.reduce { |a, b| deep_merge(a, b) }
       end
 
+      def event
+        @event
+      end
+
+      def event=(value)
+        @event = value
+      end
+
       def read_event(file)
         @event = ::JSON.parse(file.read)
         @event['occurrences'] ||= 1
@@ -33,6 +41,92 @@ module Sensu
         exit 0
       end
 
+      ##
+      #  Helper method to convert Sensu 2.0 event into Sensu 1.4 event
+      #    This is here to help keep Sensu Plugin community handlers working
+      #    until they natively support 2.0
+      #    Takes 2.0 event json object as argument
+      #    Returns event with 1.4 mapping included
+      #
+      #    Note:
+      #      The 1.4 mapping overwrites some attributes so the resulting event cannot
+      #      be used in a 2.0 workflow. The top level boolean attribute "v2_event_mapped_into_v1"
+      #      will be set to true as a hint to indicate this is a mapped event object.
+      #
+      ##
+      def map_v2_event_into_v1(orig_event = nil)
+        orig_event ||= @event
+
+        # return orig_event if already mapped
+        return orig_event if orig_event['v2_event_mapped_into_v1']
+
+        # Deep copy of orig_event
+        event = Marshal.load(Marshal.dump(orig_event))
+
+        # Trigger mapping code if enity exists and client does not
+        client_missing = event['client'].nil? || event['client'].empty?
+        if event.key?('entity') && client_missing
+          ##
+          # create the client hash from the entity hash
+          ##
+          event['client'] = event['entity']
+
+          ##
+          # Fill in missing client attributes
+          ##
+          event['client']['name']        ||= event['entity']['id']
+          event['client']['subscribers'] ||= event['entity']['subscriptions']
+
+          ##
+          # Fill in renamed check attributes expected in 1.4 event
+          #   subscribers, source
+          ##
+          event['check']['subscribers'] ||= event['check']['subscriptions']
+          event['check']['source'] ||= event['check']['proxy_entity_id']
+
+          ##
+          # Mimic 1.4 event action based on 2.0 event state
+          #  action used in logs and fluentd plugins handlers
+          ##
+          action_state_mapping = {
+            'flapping' => 'flapping',
+            'passing' => 'resolve',
+            'failing' => 'create'
+          }
+
+          state = event['check']['state'] || 'unknown::2.0_event'
+
+          # Attempt to map 2.0 event state to 1.4 event action
+          event['action'] ||= action_state_mapping[state.downcase]
+          # Fallback action is 2.0 event state
+          event['action'] ||= state
+
+          ##
+          # Mimic 1.4 event history based on 2.0 event history
+          #  Note: This overwrites the same history attribute
+          #    2.x history is an array of hashes, each hash includes status
+          #    1.x history is an array of statuses
+          ##
+          if event['check']['history']
+            # Let's save the original history
+            history_v2 = Marshal.load(Marshal.dump(event['check']['history']))
+            event['check']['history_v2'] = history_v2
+            legacy_history = []
+            event['check']['history'].each do |h|
+              legacy_history << h['status'].to_i.to_s || '3'
+            end
+            event['check']['history'] = legacy_history
+          end
+
+          ##
+          # Setting flag indicating this function has already been called
+          ##
+          event['v2_event_mapped_into_v1'] = true
+        end
+        # return the updated event
+        event
+      end
+
       def net_http_req_class(method)
         case method.to_s.upcase
         when 'GET'

data/test/handle_2to1_test.rb

@@ -0,0 +1,18 @@
+require 'test_helper'
+require 'English'
+
+class TestHandle2to1 < MiniTest::Test
+  include SensuPluginTestHelper
+
+  def setup
+    set_script 'external/handle-2to1 --map-v2-event-into-v1'
+  end
+
+  def test_2to1_enabled
+    event = JSON.parse(fixture('basic_v2_event.json').read)
+    expected = "test_entity : test_check : test_proxy : test_output : 4 : create : sub1|sub2|sub3 : sub1^sub2^sub3 : 01230\n"
+    output = run_script_with_input(JSON.generate(event))
+    assert_equal(0, $CHILD_STATUS.exitstatus)
+    assert_match(expected, output)
+  end
+end

data/test/mutator_2to1_test.rb

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+require 'English'
+
+require 'test_helper'
+
+# Simple Heper to test mutator
+class TestMutatorHelpers < MiniTest::Test
+  include SensuPluginTestHelper
+  def test_base_2to1_mutator
+    set_script 'external/mutator-trivial --map-v2-event-into-v1'
+    event = JSON.parse(fixture('basic_v2_event.json').read)
+    output = run_script_with_input(JSON.generate(event))
+    assert_equal(0, $CHILD_STATUS.exitstatus)
+    assert_equal(event['entity']['id'], JSON.parse(output)['client']['name'])
+  end
+
+  def test_external_2to1_mutator
+    set_script 'external/mutator-helpers --map-v2-event-into-v1'
+    event = JSON.parse(fixture('basic_v2_event.json').read)
+    output = run_script_with_input(JSON.generate(event))
+    assert_equal(0, $CHILD_STATUS.exitstatus)
+    assert_equal(true, JSON.parse(output)['mutated'])
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sensu-plugin
 version: !ruby/object:Gem::Version
-  version: 2.6.1
+  version: 2.7.0
 platform: ruby
 authors:
 - Decklin Foster
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-28 00:00:00.000000000 Z
+date: 2018-09-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -116,9 +116,11 @@ files:
 - test/external_handler_argument_test.rb
 - test/external_handler_test.rb
 - test/external_metric_test.rb
+- test/handle_2to1_test.rb
 - test/handle_api_request_test.rb
 - test/handle_filter_test.rb
 - test/handle_helper_test.rb
+- test/mutator_2to1_test.rb
 - test/mutator_test.rb
 - test/test_helper.rb
 homepage: https://github.com/sensu-plugins/sensu-plugin
@@ -152,7 +154,9 @@ test_files:
 - test/test_helper.rb
 - test/handle_filter_test.rb
 - test/handle_helper_test.rb
+- test/handle_2to1_test.rb
 - test/external_handler_argument_test.rb
+- test/mutator_2to1_test.rb
 - test/deep_merge_test.rb
 - test/cast_bool_value_test.rb
 - test/external_handler_test.rb