sensu-extensions 1.0.0 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4f57126991763e89e26528b447af7a360ef8dc68
-  data.tar.gz: 0544fed9f3a43312082531cf59db8ddae44f2fc0
+  metadata.gz: e4bc92d117b837c89057ba3c0dec38b2bd76db80
+  data.tar.gz: f3fc9a6727262dca6e5d84991e767d0e5c91fdcb
 SHA512:
-  metadata.gz: 12db8e2e16ac764b716d58f2745c067c8b7550f66dbd7de5397ca76be5855c7de2f0140cccff865ddcf2a657d0f539778dca3a3721485f9b8a350ab48018303d
-  data.tar.gz: 330bff41a52ef0283f81fc47623d7b2c5b746e702132f4a97dd9aa7c00f55ef400d2326feca48c8d512a55ab8313aebc2fd8fd4c9963f5c06a1f8dfd97151bb7
+  metadata.gz: 9cfeb24e06c88fb9966a8f882a70a5554bc92b33e9fd42986585a140890a9ac567cb36674fde37e147f6ba8019552edf09753bc9e59bc735dad71fd66b6e19a5
+  data.tar.gz: fb778e2d246b5764e37d25142b85a23ead28bd2001f5b40461b2e426d645e85d41248264bd5fdf1d3c23cdf589f7491f85b7927a17188a6163710a0c5ae1327e

data/lib/sensu/extensions/filters/attributes.rb

@@ -0,0 +1,71 @@
+require "sensu/extension"
+
+module Sensu
+  module Sandbox
+    def self.eval(eval_string, value=nil)
+      result = Proc.new do
+        $SAFE = (RUBY_VERSION < "2.1.0" ? 4 : 3)
+        Kernel.eval(eval_string)
+      end
+      result.call
+    end
+  end
+
+  module Extension
+    class Attributes < Filter
+      def name
+        "attributes"
+      end
+
+      def description
+        "filters events using event attributes"
+      end
+
+      def run(event, options)
+        status = filter_event?(options[:filter_name], event) ? 0 : 1
+        yield "", status
+      end
+
+      def eval_attribute_value(raw_eval_string, value)
+        begin
+          eval_string = raw_eval_string.gsub(/^eval:(\s+)?/, "")
+          !!Sandbox.eval(eval_string, value)
+        rescue => error
+          @logger.error("filter attribute eval error", {
+            :raw_eval_string => raw_eval_string,
+            :value => value,
+            :error => error.to_s
+          })
+          false
+        end
+      end
+
+      def attributes_match?(hash_one, hash_two)
+        hash_one.all? do |key, value_one|
+          value_two = hash_two[key]
+          case
+          when value_one == value_two
+            true
+          when value_one.is_a?(Hash) && value_two.is_a?(Hash)
+            attributes_match?(value_one, value_two)
+          when value_one.is_a?(String) && value_one.start_with?("eval:")
+            eval_attribute_value(value_one, value_two)
+          else
+            false
+          end
+        end
+      end
+
+      def filter_event?(filter_name, event)
+        if @settings.filter_exists?(filter_name)
+          filter = @settings[:filters][filter_name]
+          matched = attributes_match?(filter[:attributes], event)
+          filter[:negate] ? matched : !matched
+        else
+          @logger.error("unknown filter", :filter_name => filter_name)
+          false
+        end
+      end
+    end
+  end
+end

data/sensu-extensions.gemspec

@@ -2,7 +2,7 @@
 
 Gem::Specification.new do |spec|
   spec.name          = "sensu-extensions"
-  spec.version       = "1.0.0"
+  spec.version       = "1.1.0"
   spec.authors       = ["Sean Porter"]
   spec.email         = ["portertech@gmail.com"]
   spec.summary       = "The Sensu extension loader library"
@@ -16,11 +16,16 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "sensu-em"
+  spec.add_dependency "sensu-logger"
+  spec.add_dependency "sensu-settings"
   spec.add_dependency "sensu-extension"
+
   spec.add_dependency "multi_json"
 
   spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "uuidtools"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
-  spec.add_development_dependency "codeclimate-test-reporter"
+  spec.add_development_dependency "bouncy-castle-java" if RUBY_PLATFORM =~ /java/
+  spec.add_development_dependency "codeclimate-test-reporter" unless RUBY_VERSION < "1.9"
 end

data/spec/assets/config.json

@@ -0,0 +1,11 @@
+{
+    "filters": {
+        "production": {
+            "attributes": {
+                "client": {
+                    "environment": "production"
+                }
+            }
+        }
+    }
+}

data/spec/extensions_spec.rb

@@ -54,6 +54,7 @@ describe "Sensu::Extensions" do
 
   it "can load the built-in extensions" do
     extensions = Sensu::Extensions.load
+    expect(extensions.filter_exists?("attributes")).to be(true)
     expect(extensions.mutator_exists?("json")).to be(true)
     expect(extensions.mutator_exists?("ruby_hash")).to be(true)
     expect(extensions.mutator_exists?("only_check_output")).to be(true)

data/spec/filters/attributes_spec.rb

@@ -0,0 +1,53 @@
+require File.join(File.dirname(__FILE__), "..", "helpers")
+require "sensu/extensions/filters/attributes"
+
+describe "Sensu::Extension::Attributes" do
+  include Helpers
+
+  before do
+    @extension = Sensu::Extension::Attributes.new
+    @extension.logger = logger
+    @extension.settings = settings
+  end
+
+  it "can determine if filter attributes match an event" do
+    attributes = {
+      :occurrences => 1
+    }
+    event = event_template
+    expect(@extension.attributes_match?(attributes, event)).to be(true)
+    event[:occurrences] = 2
+    expect(@extension.attributes_match?(attributes, event)).to be(false)
+    attributes[:occurrences] = "eval: value == 1 || value % 60 == 0"
+    event[:occurrences] = 1
+    expect(@extension.attributes_match?(attributes, event)).to be(true)
+    event[:occurrences] = 2
+    expect(@extension.attributes_match?(attributes, event)).to be(false)
+    event[:occurrences] = 120
+    expect(@extension.attributes_match?(attributes, event)).to be(true)
+  end
+
+  it "can run, filtering an event with a nonexistent filter" do
+    event = event_template
+    options = {:filter_name => "nonexistent"}
+    @extension.safe_run(event, options) do |output, status|
+      expect(output).to eq("")
+      expect(status).to eq(1)
+    end
+  end
+
+  it "can run, filtering an event with a filter" do
+    event = event_template
+    event[:client][:environment] = "development"
+    options = {:filter_name => "production"}
+    @extension.safe_run(event, options) do |output, status|
+      expect(output).to eq("")
+      expect(status).to eq(0)
+      event[:client][:environment] = "production"
+      @extension.safe_run(event, options) do |output, status|
+        expect(output).to eq("")
+        expect(status).to eq(1)
+      end
+    end
+  end
+end

data/spec/helpers.rb

@@ -1,5 +1,8 @@
 require "rspec"
 require "eventmachine"
+require "sensu/logger"
+require "sensu/settings"
+require "uuidtools"
 
 unless RUBY_VERSION < "1.9" || RUBY_PLATFORM =~ /java/
   require "codeclimate-test-reporter"
@@ -26,4 +29,52 @@ module Helpers
   def async_done
     EM.stop_event_loop
   end
+
+  def logger
+    Sensu::Logger.get(:log_level => :fatal)
+  end
+
+  def settings
+    asset_dir = File.join(File.dirname(__FILE__), "assets")
+    config_file = File.join(asset_dir, "config.json")
+    Sensu::Settings.get(:config_file => config_file)
+  end
+
+  def epoch
+    Time.now.to_i
+  end
+
+  def client_template
+    {
+      :name => "i-424242",
+      :address => "127.0.0.1",
+      :subscriptions => [
+        "test"
+      ]
+    }
+  end
+
+  def check_template
+    {
+      :name => "test",
+      :command => "echo WARNING && exit 1",
+      :issued => epoch
+    }
+  end
+
+  def event_template
+    client = client_template
+    client[:timestamp] = epoch
+    check = check_template
+    check[:output] = "WARNING"
+    check[:status] = 1
+    check[:history] = [1]
+    {
+      :id => UUIDTools::UUID.random_create.to_s,
+      :client => client,
+      :check => check,
+      :occurrences => 1,
+      :action => :create
+    }
+  end
 end

data/spec/loader_spec.rb

@@ -79,6 +79,7 @@ describe "Sensu::Extensions::Loader" do
     expect(@loader.all).to include(extension)
     expect(@loader.handler_exists?("debug")).to be(true)
     expect(@loader.mutator_exists?("only_check_output")).to be(true)
+    expect(@loader.filter_exists?("attributes")).to be(true)
   end
 
   it "can load specific extension categories for a sensu client" do
@@ -92,6 +93,7 @@ describe "Sensu::Extensions::Loader" do
     @loader.load_instances("server")
     expect(@loader.handler_exists?("debug")).to be(true)
     expect(@loader.mutator_exists?("only_check_output")).to be(true)
+    expect(@loader.filter_exists?("attributes")).to be(true)
     expect(@loader.check_exists?("mock_check")).to be(false)
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: sensu-extensions
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.0
 platform: ruby
 authors:
 - Sean Porter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-12 00:00:00.000000000 Z
+date: 2014-12-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sensu-em
@@ -24,6 +24,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: sensu-logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sensu-settings
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: sensu-extension
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +94,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: uuidtools
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -122,16 +164,19 @@ files:
 - README.md
 - Rakefile
 - lib/sensu/extensions.rb
+- lib/sensu/extensions/filters/attributes.rb
 - lib/sensu/extensions/handlers/debug.rb
 - lib/sensu/extensions/loader.rb
 - lib/sensu/extensions/mutators/json.rb
 - lib/sensu/extensions/mutators/only_check_output.rb
 - lib/sensu/extensions/mutators/ruby_hash.rb
 - sensu-extensions.gemspec
+- spec/assets/config.json
 - spec/assets/extensions/error.rb
 - spec/assets/extensions/mock_check.rb
 - spec/assets/extensions/test.rb
 - spec/extensions_spec.rb
+- spec/filters/attributes_spec.rb
 - spec/handlers/debug_spec.rb
 - spec/helpers.rb
 - spec/loader_spec.rb
@@ -158,15 +203,17 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.0
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: The Sensu extension loader library
 test_files:
+- spec/assets/config.json
 - spec/assets/extensions/error.rb
 - spec/assets/extensions/mock_check.rb
 - spec/assets/extensions/test.rb
 - spec/extensions_spec.rb
+- spec/filters/attributes_spec.rb
 - spec/handlers/debug_spec.rb
 - spec/helpers.rb
 - spec/loader_spec.rb