sensu-plugin 2.7.1 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: dd73011f9e09701dae37acf92846db48b9d6bc8a
-  data.tar.gz: a2dab9e73f163a33d420f1d6cf9763fbdc31d292
+  metadata.gz: 9d5b33d233fbb2d5f7713bd9f56f534611a06ff5
+  data.tar.gz: db3da41917254f47c0f3ce0a43e55137178847b2
 SHA512:
-  metadata.gz: a9bb902bbb73531bc60e79f118aca7e74e0d3e624cdd33c62ea0a80e0cef57e94c9eba6e1c5918cd7b8a2fd82a5967bb27de976ea5099fba9fc442be7eb70d6b
-  data.tar.gz: 106c26cae499cb1ea42265b7c62882ffdd50d64011331d50958f85bf3c09ac528d8c9d80d9a077738b2c6253a49f1200ef770470e5ec81c269852a8d1fd3e318
+  metadata.gz: 2cf4e4376598660f9af91a1c99f2484b40c8c642309d9261024b2a5cef672e8b804d0f179b8ee4e994ef7be800fc9198cd8a1cd2ca725f00a2142f5ddbcc3bdf
+  data.tar.gz: cce62ca82e559153d8f8190276696676a22691a73500524b483ec32ddbef660711cb65b167ba71542d29b3dcd7a9df782129cf5492cd67712be2a7e44d6b8770

data/bin/mutator-sensu-go-into-ruby.rb

@@ -0,0 +1,11 @@
+#!/usr/bin/env ruby
+
+require 'sensu-mutator'
+
+class Helper < Sensu::Mutator
+  def mutate
+    STDERR.puts 'WARNING: mutator-sensu-go-into-ruby.rb is meant for primarily for development.'
+    STDERR.puts 'Please update your handlers to be compatible with Sensu Go events.'
+    @event = map_go_event_into_ruby
+  end
+end

data/lib/sensu-handler.rb

@@ -9,10 +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.',
+    option :map_go_event_into_ruby,
+           description: 'Enable Sensu Go to Sensu Ruby event mapping. Alternatively set envvar SENSU_MAP_GO_EVENT_INTO_RUBY=1.',
            boolean:     true,
-           long:        '--map-v2-event-into-v1'
+           long:        '--map-go-event-into-ruby'
 
     attr_accessor :argv
 
@@ -79,10 +79,10 @@ module Sensu
         handler.read_event(STDIN)
 
         TRUTHY_VALUES = %w[1 t true yes y].freeze
-        automap = ENV['SENSU_MAP_V2_EVENT_INTO_V1'].to_s.downcase
+        automap = ENV['SENSU_MAP_GO_EVENT_INTO_RUBY'].to_s.downcase
 
-        if handler.config[:map_v2_event_into_v1] || TRUTHY_VALUES.include?(automap)
-          new_event = handler.map_v2_event_into_v1
+        if handler.config[:map_go_event_into_ruby] || TRUTHY_VALUES.include?(automap)
+          new_event = handler.map_go_event_into_ruby
           handler.event = new_event
         end
         handler.filter

data/lib/sensu-mutator.rb

@@ -34,10 +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.',
+    option :map_go_event_into_ruby,
+           description: 'Enable Sensu Go to Sensu Ruby event mapping. Alternatively set envvar SENSU_MAP_GO_EVENT_INTO_RUBY=1.',
            boolean:     true,
-           long:        '--map-v2-event-into-v1'
+           long:        '--map-go-event-into-ruby'
 
     attr_accessor :argv
 
@@ -73,10 +73,10 @@ module Sensu
       mutator.read_event(STDIN)
 
       TRUTHY_VALUES = %w[1 t true yes y].freeze
-      automap = ENV['SENSU_MAP_V2_EVENT_INTO_V1'].to_s.downcase
+      automap = ENV['SENSU_MAP_GO_EVENT_INTO_RUBY'].to_s.downcase
 
-      if mutator.config[:map_v2_event_into_v1] || TRUTHY_VALUES.include?(automap)
-        new_event = mutator.map_v2_event_into_v1
+      if mutator.config[:map_go_event_into_ruby] || TRUTHY_VALUES.include?(automap)
+        new_event = mutator.map_go_event_into_ruby
         mutator.event = new_event
       end
 

data/lib/sensu-plugin.rb

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

data/lib/sensu-plugin/utils.rb

@@ -42,23 +42,26 @@ module Sensu
       end
 
       ##
-      #  Helper method to convert Sensu 2.0 event into Sensu 1.4 event
+      #  Helper method to convert Sensu Go event into Sensu Ruby 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
+      #    until they natively support Go events
+      #    Takes Go event json object as argument
+      #    Returns event with Sensu Ruby 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"
+      #      The Sensu Ruby mapping overwrites some attributes so the resulting event cannot
+      #      be used in a Sensu Go workflow. The top level boolean attribute "go_event_mapped_into_ruby"
       #      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)
+      def map_go_event_into_ruby(orig_event = nil, map_annotation = nil)
         orig_event ||= @event
 
+        map_annotation ||= ENV['SENSU_MAP_ANNOTATION'] if ENV['SENSU_MAP_ANNOTATION']
+        map_annotation ||= 'sensu.io.json_attributes'
+
         # return orig_event if already mapped
-        return orig_event if orig_event['v2_event_mapped_into_v1']
+        return orig_event if orig_event['go_event_mapped_into_ruby']
 
         # Deep copy of orig_event
         event = Marshal.load(Marshal.dump(orig_event))
@@ -74,18 +77,38 @@ module Sensu
           ##
           # 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
+          #  Map entity metadata into client attributes
+          #  Note this is potentially destructive as it may overwrite existing client attributes.
+          ##
+          if event['entity'].key?('metadata')
+            ##
+            #  Map metadata annotation 'name' to client name attribute
+            ##
+            event['client']['name'] ||= event['entity']['metadata']['name']
+
+            ##
+            #  Map special metadata annotation defined in map_annotation as json string and convert to client attributes
+            #  Note this is potentially destructive as it may overwrite existing client attributes.
+            ##
+            if event['entity']['metadata'].key?('annotations') && event['entity']['metadata']['annotations'].key?(map_annotation)
+              json_hash = JSON.parse(event['entity']['metadata']['annotations'][map_annotation])
+              event['client'].update(json_hash)
+            end
+          end
+
+          ##
+          # Fill in renamed check attributes expected in Sensu Ruby event
           #   subscribers, source
           ##
           event['check']['subscribers'] ||= event['check']['subscriptions']
-          event['check']['source'] ||= event['check']['proxy_entity_id']
+          event['check']['source'] ||= event['check']['proxy_entity_name']
 
           ##
-          # Mimic 1.4 event action based on 2.0 event state
+          # Mimic Sensu Ruby event action based on Go event state
           #  action used in logs and fluentd plugins handlers
           ##
           action_state_mapping = {
@@ -94,23 +117,23 @@ module Sensu
             'failing' => 'create'
           }
 
-          state = event['check']['state'] || 'unknown::2.0_event'
+          state = event['check']['state'] || 'unknown::go_event'
 
-          # Attempt to map 2.0 event state to 1.4 event action
+          # Attempt to map Go event state to Sensu Ruby event action
           event['action'] ||= action_state_mapping[state.downcase]
-          # Fallback action is 2.0 event state
+          # Fallback action is Go event state
           event['action'] ||= state
 
           ##
-          # Mimic 1.4 event history based on 2.0 event history
+          # Mimic Sensu Ruby event history based on Go 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
+          #    Go history is an array of hashes, each hash includes status
+          #    Sensu Ruby 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
+            original_history = Marshal.load(Marshal.dump(event['check']['history']))
+            event['check']['original_history'] = original_history
             legacy_history = []
             event['check']['history'].each do |h|
               legacy_history << h['status'].to_i.to_s || '3'
@@ -118,10 +141,29 @@ module Sensu
             event['check']['history'] = legacy_history
           end
 
+          ##
+          #  Map check metadata into client attributes
+          #  Note this is potentially destructive as it may overwrite existing check attributes.
+          ##
+          if event['check'].key?('metadata')
+            ##
+            #  Map metadata annotation 'name' to client name attribute
+            ##
+            event['check']['name'] ||= event['check']['metadata']['name']
+
+            ##
+            #  Map special metadata annotation defined in map_annotation as json string and convert to check attributes
+            #  Note this is potentially destructive as it may overwrite existing check attributes.
+            ##
+            if event['check']['metadata'].key?('annotations') && event['check']['metadata']['annotations'].key?(map_annotation)
+              json_hash = JSON.parse(event['check']['metadata']['annotations'][map_annotation])
+              event['check'].update(json_hash)
+            end
+          end
           ##
           # Setting flag indicating this function has already been called
           ##
-          event['v2_event_mapped_into_v1'] = true
+          event['go_event_mapped_into_ruby'] = true
         end
         # return the updated event
         event

data/test/handle_go_to_1_test.rb

@@ -0,0 +1,18 @@
+require 'test_helper'
+require 'English'
+
+class TestHandleGoto1 < MiniTest::Test
+  include SensuPluginTestHelper
+
+  def setup
+    set_script 'external/handle-go-to-ruby --map-go-event-into-ruby'
+  end
+
+  def test_go_to_ruby_enabled
+    event = JSON.parse(fixture('basic_go_event.json').read)
+    expected = "test_entity : top_value : test_check : test_proxy : test_output : 4 : create : sub1|sub2|sub3 : sub1^sub2^sub3 : potato : 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_go_to_1_test.rb

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+require 'English'
+
+require 'test_helper'
+
+# Simple Heper to test mutator
+class TestMutatorHelpers < MiniTest::Test
+  include SensuPluginTestHelper
+  def test_base_go_to_1_mutator
+    set_script 'external/mutator-trivial --map-go-event-into-ruby'
+    event = JSON.parse(fixture('basic_go_event.json').read)
+    output = run_script_with_input(JSON.generate(event))
+    assert_equal(0, $CHILD_STATUS.exitstatus)
+    assert_equal(event['entity']['metadata']['name'], JSON.parse(output)['client']['name'])
+    assert_equal('top_value', JSON.parse(output)['client']['top'])
+    assert_equal('nested01_value', JSON.parse(output)['client']['test_json']['nested01'])
+    assert_equal('nested02_value', JSON.parse(output)['client']['test_json']['nested02'])
+  end
+
+  def test_external_go_to_1_mutator
+    set_script 'external/mutator-helpers --map-go-event-into-ruby'
+    event = JSON.parse(fixture('basic_go_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.7.1
+  version: 3.0.0
 platform: ruby
 authors:
 - Decklin Foster
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-01-08 00:00:00.000000000 Z
+date: 2018-12-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -29,16 +29,16 @@ dependencies:
   name: mixlib-cli
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: 1.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.5'
+        version: 1.5.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -99,10 +99,12 @@ description: Plugins and helper libraries for Sensu, a monitoring framework
 email:
 - decklin@red-bean.com
 - portertech@gmail.com
-executables: []
+executables:
+- mutator-sensu-go-into-ruby.rb
 extensions: []
 extra_rdoc_files: []
 files:
+- bin/mutator-sensu-go-into-ruby.rb
 - lib/sensu-handler.rb
 - lib/sensu-mutator.rb
 - lib/sensu-plugin.rb
@@ -116,11 +118,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_go_to_1_test.rb
 - test/handle_helper_test.rb
-- test/mutator_2to1_test.rb
+- test/mutator_go_to_1_test.rb
 - test/mutator_test.rb
 - test/test_helper.rb
 homepage: https://github.com/sensu-plugins/sensu-plugin
@@ -153,11 +155,11 @@ test_files:
 - test/external_check_test.rb
 - test/test_helper.rb
 - test/handle_filter_test.rb
+- test/mutator_go_to_1_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
+- test/handle_go_to_1_test.rb
 - test/mutator_test.rb

data/test/handle_2to1_test.rb

@@ -1,18 +0,0 @@
-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

@@ -1,24 +0,0 @@
-#!/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