sensu-plugin 2.5.0 → 2.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 789c3f9cdd93f38450e3c7fa33a076570d17c3ba
-  data.tar.gz: e1e46b0ec50069844d69e447bfb5546928bdc887
+  metadata.gz: c15f38b4709b2ac89b59531eccfdc58d53ae6824
+  data.tar.gz: 5c165bc7759153d78948f0ee03093de67569cc41
 SHA512:
-  metadata.gz: 14d1e113b578a0690fcf0fd6f2512d8a2b146366e6c3e39b4fee4af11a024c66c4c4aa9312bcdc9bf0b10f50e020fcfebfddecd7a0dd3feb8aca64678ec1c368
-  data.tar.gz: 161a7ace2d9a55d2f47c0724e1fc3a9a3d66ac919763fac2a9f9bb453166487c9956d54621ede9c483d78fe51d1ac74f06db8b72384a31c762d71c2830ffaefc
+  metadata.gz: e689ee660aeaab03c13780cbda36c65e834ebc83ddc0e6361cd04fb0baf998027a74b576a5739afc4c4537025efae80e6302aefc12c3bdb370b4b35bbb95c694
+  data.tar.gz: 9b78540d2de31488f61911fa144e81091f3eaf447b6377ca5a35d8c01a3410864aa28a86bc0688cad13f00d18224ae3bce0268eb64219768bd08426a6ccbcb4f

data/lib/sensu-handler.rb

@@ -99,57 +99,6 @@ module Sensu
       exit 0
     end
 
-    # Override API settings (for testing purposes)
-    #
-    # @param api_settings [Hash]
-    # @return [Hash]
-    def api_settings=(api_settings)
-      @api_settings = api_settings
-    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
-      return @api_settings if @api_settings
-      if ENV['SENSU_API_URL']
-        uri = URI(ENV['SENSU_API_URL'])
-        ssl = uri.scheme == 'https' ? {} : nil
-        @api_settings = {
-          'ssl' => ssl,
-          'host' => uri.host,
-          'port' => uri.port,
-          'user' => uri.user,
-          'password' => uri.password
-        }
-      else
-        @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)
-      if api_settings.nil?
-        raise 'api.json settings not found.'
-      end
-      use_ssl = api_settings['ssl'].is_a?(Hash) ||
-                api_settings['host'].start_with?('https')
-      hostname = api_settings['host'].gsub(/https?:\/\//, '')
-      req = net_http_req_class(method).new(path)
-      if api_settings['user'] && api_settings['password']
-        req.basic_auth(api_settings['user'], api_settings['password'])
-      end
-      yield(req) if block_given?
-      res = Net::HTTP.start(hostname, api_settings['port'], use_ssl: use_ssl) do |http|
-        http.request(req)
-      end
-      res
-    end
-
     def filter_disabled
       bail 'alert disabled' if @event['check']['alert'] == false
     end

data/lib/sensu-plugin.rb

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

data/lib/sensu-plugin/utils.rb

@@ -2,7 +2,7 @@ require 'json'
 
 module Sensu
   module Plugin
-    module Utils
+    module Utils # rubocop:disable Metrics/ModuleLength
       def config_files
         if ENV['SENSU_LOADED_TEMPFILE'] && File.file?(ENV['SENSU_LOADED_TEMPFILE'])
           IO.read(ENV['SENSU_LOADED_TEMPFILE']).split(':')
@@ -46,6 +46,82 @@ module Sensu
         end
       end
 
+      # Override API settings (for testing purposes)
+      #
+      # @param api_settings [Hash]
+      # @return [Hash]
+      def api_settings=(api_settings)
+        @api_settings = api_settings
+      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
+        return @api_settings if @api_settings
+        if ENV['SENSU_API_URL']
+          uri = URI(ENV['SENSU_API_URL'])
+          ssl = uri.scheme == 'https' ? {} : nil
+          @api_settings = {
+            'ssl' => ssl,
+            'host' => uri.host,
+            'port' => uri.port,
+            'user' => uri.user,
+            'password' => uri.password
+          }
+        else
+          @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)
+        if api_settings.nil?
+          raise 'api.json settings not found.'
+        end
+        use_ssl = api_settings['ssl'].is_a?(Hash) ||
+                  api_settings['host'].start_with?('https')
+        hostname = api_settings['host'].gsub(/https?:\/\//, '')
+        req = net_http_req_class(method).new(path)
+        if api_settings['user'] && api_settings['password']
+          req.basic_auth(api_settings['user'], api_settings['password'])
+        end
+        yield(req) if block_given?
+        res = Net::HTTP.start(hostname, api_settings['port'], use_ssl: use_ssl) do |http|
+          http.request(req)
+        end
+        res
+      end
+
+      # Use API query parameters to paginate HTTP GET requests,
+      # iterating over the results until an empty set is returned.
+      #
+      # @param path [String]
+      # @param options [Hash]
+      # @return [Array]
+
+      def paginated_get(path, options = {})
+        limit = options.fetch('limit', 500)
+        offset = 0
+        results = []
+        loop do
+          query_path = "#{path}?limit=#{limit}&offset=#{offset}"
+          response = api_request(:GET, query_path)
+          unless response.is_a?(Net::HTTPOK)
+            unknown("Non-OK response from API query: #{get_uri(query_path)}")
+          end
+          data = JSON.parse(response.body)
+          break if data.empty?
+          results << data
+          offset += limit
+        end
+        results.flatten
+      end
+
       def deep_merge(hash_one, hash_two)
         merged = hash_one.dup
         hash_two.each do |key, value|

data/test/handle_api_request_test.rb

@@ -7,6 +7,22 @@ class TestHandleAPIRequest < MiniTest::Test
 
   Sensu::Handler.disable_autorun
 
+  def sample_check_result
+    {
+      client: 'sensu',
+      check: {
+        handler: 'keepalive',
+        name: 'keepalive',
+        issued: 1_534_373_016,
+        executed: 1_534_373_016,
+        output: 'Keepalive sent from client 4 seconds ago',
+        status: 0,
+        type: 'standard',
+        history: [0]
+      }
+    }
+  end
+
   def test_http_request
     stub_request(:get, 'http://127.0.0.1:4567/foo').to_return(status: 200, body: '', headers: {})
 
@@ -16,6 +32,24 @@ class TestHandleAPIRequest < MiniTest::Test
     assert_equal(response.code, '200')
   end
 
+  def test_http_paginated_get
+    stub_request(:get, 'http://127.0.0.1:4567/results?limit=1&offset=0')
+      .to_return(status: 200, headers: {}, body: JSON.dump([sample_check_result]))
+
+    stub_request(:get, 'http://127.0.0.1:4567/results?limit=1&offset=1')
+      .to_return(status: 200, headers: {}, body: JSON.dump([sample_check_result]))
+
+    stub_request(:get, 'http://127.0.0.1:4567/results?limit=1&offset=2')
+      .to_return(status: 200, headers: {}, body: JSON.dump([]))
+
+    handler = Sensu::Handler.new([])
+    response = handler.paginated_get('/results', 'limit' => 1)
+
+    # we expect the combined results to be an array containing two instances of the sample check result
+    combined_results = JSON.parse("[ #{JSON.dump(sample_check_result)} , #{JSON.dump(sample_check_result)} ]")
+    assert_equal(response, combined_results)
+  end
+
   def test_https_request
     stub_request(:get, 'https://127.0.0.1:4567/foo').to_return(status: 200, body: '', headers: {})
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sensu-plugin
 version: !ruby/object:Gem::Version
-  version: 2.5.0
+  version: 2.6.0
 platform: ruby
 authors:
 - Decklin Foster
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-03 00:00:00.000000000 Z
+date: 2018-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -141,19 +141,19 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.2.1
+rubygems_version: 2.6.11
 signing_key: 
 specification_version: 4
 summary: Sensu Plugins
 test_files:
-- test/handle_api_request_test.rb
-- test/handle_helper_test.rb
-- test/external_handler_test.rb
 - test/external_metric_test.rb
-- test/handle_filter_test.rb
+- test/handle_api_request_test.rb
 - test/external_check_test.rb
+- test/test_helper.rb
+- test/handle_filter_test.rb
+- test/handle_helper_test.rb
 - test/external_handler_argument_test.rb
-- test/cast_bool_value_test.rb
 - test/deep_merge_test.rb
+- test/cast_bool_value_test.rb
+- test/external_handler_test.rb
 - test/mutator_test.rb
-- test/test_helper.rb