sensu-extensions 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 921d30c624c871a29bdebaffbb2a6ad90e534c14
+  data.tar.gz: 65287442e82d713e383b0b029121ddfc37dfd4fe
+SHA512:
+  metadata.gz: 90ad3a3900709a313464058d508dd928fcb0197eebbb137e1977cd4e4d28ee7b77868963bff68929a783868fb813102be6357c6c292ba9079b72de69855fc5b6
+  data.tar.gz: 15e88aed2126991161ae87abaf0951692b5ddc220a7a761fe9dee9c0e1fd583b0e7d94379e30c562287c8a0d871e7528595171a2bcd68db3070e66c48162b944

data/.gitignore

@@ -0,0 +1,22 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,14 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.2
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - jruby
+notifications:
+  irc:
+    - "irc.freenode.net#sensu"
+addons:
+  code_climate:
+    repo_token: e2001d0db82d5835d76a70d025388fee457bd4243fda3e046097e9d6db28fe5d

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in sensu-extensions.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Heavy Water Operations, LLC.
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,28 @@
+# Sensu::Extensions
+
+[![Build Status](https://travis-ci.org/sensu/sensu-extensions.svg?branch=master)](https://travis-ci.org/sensu/sensu-extensions)
+
+[![Code Climate](https://codeclimate.com/github/sensu/sensu-extensions.png)](https://codeclimate.com/github/sensu/sensu-extensions)
+[![Code Climate Coverage](https://codeclimate.com/github/sensu/sensu-extensions/coverage.png)](https://codeclimate.com/github/sensu/sensu-extensions)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'sensu-extensions'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Documentation can be found [here](http://rubydoc.info/github/sensu/sensu-extensions/Sensu/Extensions).
+
+## Contributing
+
+1. [Fork it](https://github.com/sensu/sensu-extensions/fork)
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/lib/sensu/extensions.rb

@@ -0,0 +1,29 @@
+require "sensu/extensions/loader"
+
+module Sensu
+  module Extensions
+    # Load Sensu extensions.
+    #
+    # @param [Hash] options
+    # @option options [String] :extension_file to load.
+    # @option options [String] :extension_dir to load.
+    # @option options [Array] :extension_dirs to load.
+    # @return [Loader] a loaded instance of Loader.
+    def self.load(options={})
+      loader = Loader.new
+      if options[:extension_file]
+        loader.load_file(options[:extension_file])
+      end
+      if options[:extension_dir]
+        loader.load_directory(options[:extension_dir])
+      end
+      if options[:extension_dirs]
+        options[:extension_dirs].each do |directory|
+          loader.load_directory(directory)
+        end
+      end
+      loader.load_instances
+      loader
+    end
+  end
+end

data/lib/sensu/extensions/handlers/debug.rb

@@ -0,0 +1,19 @@
+require "sensu/extension"
+
+module Sensu
+  module Extension
+    class Debug < Handler
+      def name
+        "debug"
+      end
+
+      def description
+        "returns inspected event data"
+      end
+
+      def run(event)
+        yield event.inspect, 0
+      end
+    end
+  end
+end

data/lib/sensu/extensions/loader.rb

@@ -0,0 +1,135 @@
+require "sensu/extension"
+require "sensu/extensions/mutators/only_check_output"
+require "sensu/extensions/handlers/debug"
+
+module Sensu
+  module Extensions
+    class Loader
+      # @!attribute [r] warnings
+      #   @return [Array] loader warnings.
+      attr_reader :warnings
+
+      # @!attribute [r] loaded_files
+      #   @return [Array] loaded extension files.
+      attr_reader :loaded_files
+
+      def initialize
+        @warnings = []
+        @loaded_files = []
+        @extensions = {}
+        Extension::CATEGORIES.each do |category|
+          @extensions[category] = {}
+        end
+        self.class.create_category_methods
+      end
+
+      # Create extension category accessors and methods to test the
+      # existence of extensions. Called in initialize().
+      def self.create_category_methods
+        Extension::CATEGORIES.each do |category|
+          define_method(category) do
+            extension_category(category)
+          end
+          method_name = category.to_s.chop + "_exists?"
+          define_method(method_name.to_sym) do |name|
+            extension_exists?(category, name)
+          end
+        end
+      end
+
+      # Retrieve the extension object corresponding to a key, acting
+      # like a Hash object.
+      #
+      # @param key [Symbol]
+      # @return [Object] value for key.
+      def [](key)
+        @extensions[key]
+      end
+
+      # Retrieve all extension instances.
+      #
+      # @return [Array<object>] extensions.
+      def all
+        @extensions.map { |category, extensions|
+          extensions.map do |name, extension|
+            extension
+          end
+        }.flatten
+      end
+
+      # Load an extension from a file.
+      #
+      # @param [String] file path.
+      def load_file(file)
+        warning("loading extension file", :file => file)
+        begin
+          require File.expand_path(file)
+          @loaded_files << file
+        rescue ScriptError, StandardError => error
+          warning("failed to require extension", :file => file, :error => error)
+          warning("ignoring extension", :file => file)
+        end
+      end
+
+      # Load extensions from files in a directory. Files may be in
+      # nested directories.
+      #
+      # @param [String] directory path.
+      def load_directory(directory)
+        warning("loading extension files from directory", :directory => directory)
+        path = directory.gsub(/\\(?=\S)/, "/")
+        Dir.glob(File.join(path, "**/*.rb")).each do |file|
+          load_file(file)
+        end
+      end
+
+      # Load instances of the loaded extensions.
+      def load_instances
+        Extension::CATEGORIES.each do |category|
+          extension_type = category.to_s.chop
+          Extension.const_get(extension_type.capitalize).descendants.each do |klass|
+            extension = klass.new
+            @extensions[category][extension.name] = extension
+            warning("loaded extension", {
+              :type => extension_type,
+              :name => extension.name,
+              :description => extension.description
+            })
+          end
+        end
+      end
+
+      private
+
+      # Retrieve extension category definitions.
+      #
+      # @param [Symbol] category to retrive.
+      # @return [Array<Hash>] category definitions.
+      def extension_category(category)
+        @extensions[category].map do |name, extension|
+          extension.definition
+        end
+      end
+
+      # Check to see if an extension exists in a category.
+      #
+      # @param [Symbol] category to inspect for the extension.
+      # @param [String] name of extension.
+      # @return [TrueClass, FalseClass]
+      def extension_exists?(category, name)
+        @extensions[category].has_key?(name)
+      end
+
+      # Record a warning.
+      #
+      # @param message [String] warning message.
+      # @param data [Hash] warning context.
+      # @return [Array] current warnings.
+      def warning(message, data={})
+        @warnings << {
+          :message => message
+        }.merge(data)
+      end
+    end
+  end
+end

data/lib/sensu/extensions/mutators/only_check_output.rb

@@ -0,0 +1,19 @@
+require "sensu/extension"
+
+module Sensu
+  module Extension
+    class OnlyCheckOutput < Mutator
+      def name
+        "only_check_output"
+      end
+
+      def description
+        "returns check output"
+      end
+
+      def run(event)
+        yield event[:check][:output], 0
+      end
+    end
+  end
+end

data/sensu-extensions.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+
+Gem::Specification.new do |spec|
+  spec.name          = "sensu-extensions"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Sean Porter"]
+  spec.email         = ["portertech@gmail.com"]
+  spec.summary       = "The Sensu extension loader library"
+  spec.description   = "The Sensu extension loader library"
+  spec.homepage      = "https://github.com/sensu/sensu-extensions"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "sensu-em"
+  spec.add_dependency "sensu-extension"
+
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "codeclimate-test-reporter"
+end

data/spec/assets/extensions/error.rb

@@ -0,0 +1,17 @@
+module Sensu
+  module Extension
+    class ScriptError < Handler
+      def name
+        "error"
+      #end
+
+      def description
+        "error extension"
+      end
+
+      def run(event, &callback)
+        block.call(event, 0)
+      end
+    end
+  end
+end

data/spec/assets/extensions/test.rb

@@ -0,0 +1,17 @@
+module Sensu
+  module Extension
+    class Test < Handler
+      def name
+        "test"
+      end
+
+      def description
+        "test extension"
+      end
+
+      def run(event, &callback)
+        block.call(event, 0)
+      end
+    end
+  end
+end

data/spec/extensions_spec.rb

@@ -0,0 +1,46 @@
+require File.join(File.dirname(__FILE__), "helpers")
+require "sensu/extensions"
+
+describe "Sensu::Extensions" do
+  include Helpers
+
+  before do
+    @assets_dir = File.join(File.dirname(__FILE__), "assets")
+    @extension_dir = File.join(@assets_dir, "extensions")
+    @extension_file = File.join(@extension_dir, "test.rb")
+  end
+
+  it "can provide the extensions API" do
+    Sensu::Extensions.should respond_to(:load)
+  end
+
+  it "can provide an instance of Loader" do
+    extensions = Sensu::Extensions.load
+    extensions.should be_instance_of(Sensu::Extensions::Loader)
+    extensions.loaded_files.should be_empty
+  end
+
+  it "can load an extension from a file" do
+    extensions = Sensu::Extensions.load(:extension_file => @extension_file)
+    extensions.loaded_files.size.should eq(1)
+    extensions.handler_exists?("test").should be_true
+  end
+
+  it "can load extensions from a directory" do
+    extensions = Sensu::Extensions.load(:extension_dir => @extension_dir)
+    extensions.loaded_files.size.should eq(1)
+    extensions.handler_exists?("test").should be_true
+  end
+
+  it "can load extensions from one or more directories" do
+    extensions = Sensu::Extensions.load(:extension_dirs => [@extension_dir])
+    extensions.loaded_files.size.should eq(1)
+    extensions.handler_exists?("test").should be_true
+  end
+
+  it "can load the built-in extensions" do
+    extensions = Sensu::Extensions.load
+    extensions.mutator_exists?("only_check_output").should be_true
+    extensions.handler_exists?("debug").should be_true
+  end
+end

data/spec/handlers/debug_spec.rb

@@ -0,0 +1,24 @@
+require File.join(File.dirname(__FILE__), "..", "helpers")
+require "sensu/extensions/handlers/debug"
+
+describe "Sensu::Extension::Debug" do
+  include Helpers
+
+  before do
+    @extension = Sensu::Extension::Debug.new
+  end
+
+  it "can run, returning an inspected event data" do
+    event = {
+      :client => {},
+      :check => {
+        :output => "foo",
+        :status => 0
+      }
+    }
+    @extension.safe_run(event) do |output, status|
+      output.should eq(event.inspect)
+      status.should eq(0)
+    end
+  end
+end

data/spec/helpers.rb

@@ -0,0 +1,29 @@
+require "rspec"
+require "eventmachine"
+
+unless RUBY_VERSION < "1.9" || RUBY_PLATFORM =~ /java/
+  require "codeclimate-test-reporter"
+  CodeClimate::TestReporter.start
+end
+
+module Helpers
+  def timer(delay, &callback)
+    periodic_timer = EM::PeriodicTimer.new(delay) do
+      callback.call
+      periodic_timer.cancel
+    end
+  end
+
+  def async_wrapper(&callback)
+    EM.run do
+      timer(10) do
+        raise "test timed out"
+      end
+      callback.call
+    end
+  end
+
+  def async_done
+    EM.stop_event_loop
+  end
+end

data/spec/loader_spec.rb

@@ -0,0 +1,79 @@
+require File.join(File.dirname(__FILE__), "helpers")
+require "sensu/extensions/loader"
+
+describe "Sensu::Extensions::Loader" do
+  include Helpers
+
+  before do
+    @loader = Sensu::Extensions::Loader.new
+    @assets_dir = File.join(File.dirname(__FILE__), "assets")
+    @extension_dir = File.join(@assets_dir, "extensions")
+    @extension_file = File.join(@extension_dir, "test.rb")
+  end
+
+  it "can provide the extensions loader API" do
+    @loader.should respond_to(:load_file, :load_directory, :load_instances,
+                              :warnings, :loaded_files, :[], :all,
+                              :generics, :bridges, :checks, :mutators, :handlers)
+  end
+
+  it "can load an extension from a file" do
+    @loader.load_file(@extension_file)
+    @loader.warnings.size.should eq(1)
+    @loader.loaded_files.size.should eq(1)
+    @loader.loaded_files.first.should eq(File.expand_path(@extension_file))
+    extension = Sensu::Extension::Test.new
+    extension.should respond_to(:name, :description, :definition, :safe_run, :stop, :has_key?, :[])
+  end
+
+  it "can attempt to load an extension with a script error" do
+    script = File.join(@extension_dir, "error.rb")
+    @loader.load_file(script)
+    warnings = @loader.warnings
+    warnings.size.should eq(3)
+    messages = warnings.map do |warning|
+      warning[:message]
+    end
+    messages.should include("loading extension file")
+    messages.should include("ignoring extension")
+    @loader.loaded_files.should be_empty
+  end
+
+  it "can load extensions from a directory" do
+    @loader.load_directory(@extension_dir)
+    @loader.warnings.size.should eq(5)
+    @loader.loaded_files.size.should eq(1)
+    extension = Sensu::Extension::Test.new
+    extension.should respond_to(:name, :description, :definition, :safe_run, :stop, :has_key?, :[])
+  end
+
+  it "can attempt to load extensions from a nonexistent directory" do
+    @loader.load_directory("/tmp/bananaphone")
+    @loader.warnings.size.should eq(1)
+    @loader.loaded_files.should be_empty
+  end
+
+  it "can load instances of the built-in extensions and provide accessors" do
+    @loader.load_instances
+    @loader.handler_exists?("debug").should be_true
+    extension = @loader[:handlers]["debug"]
+    extension.should be_instance_of(Sensu::Extension::Debug)
+    extension.should respond_to(:name, :description, :definition, :safe_run, :stop, :has_key?, :[])
+    @loader.handlers.should include(extension.definition)
+    @loader.all.should include(extension)
+    @loader.mutator_exists?("only_check_output").should be_true
+  end
+
+  it "can load instances of the built-in and loaded extensions" do
+    @loader.load_file(@extension_file)
+    @loader.load_instances
+    @loader.handler_exists?("test").should be_true
+    extension = @loader[:handlers]["test"]
+    extension.should be_instance_of(Sensu::Extension::Test)
+    extension.should respond_to(:name, :description, :definition, :safe_run, :stop, :has_key?, :[])
+    @loader.handlers.should include(extension.definition)
+    @loader.all.should include(extension)
+    @loader.handler_exists?("debug").should be_true
+    @loader.mutator_exists?("only_check_output").should be_true
+  end
+end

data/spec/mutators/only_check_output_spec.rb

@@ -0,0 +1,24 @@
+require File.join(File.dirname(__FILE__), "..", "helpers")
+require "sensu/extensions/mutators/only_check_output"
+
+describe "Sensu::Extension::OnlyCheckOutput" do
+  include Helpers
+
+  before do
+    @extension = Sensu::Extension::OnlyCheckOutput.new
+  end
+
+  it "can run, returning only check output" do
+    event = {
+      :client => {},
+      :check => {
+        :output => "foo",
+        :status => 0
+      }
+    }
+    @extension.safe_run(event) do |output, status|
+      output.should eq("foo")
+      status.should eq(0)
+    end
+  end
+end

metadata

@@ -0,0 +1,153 @@
+--- !ruby/object:Gem::Specification
+name: sensu-extensions
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sean Porter
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sensu-em
+  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
+    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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  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: codeclimate-test-reporter
+  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'
+description: The Sensu extension loader library
+email:
+- portertech@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/sensu/extensions.rb
+- lib/sensu/extensions/handlers/debug.rb
+- lib/sensu/extensions/loader.rb
+- lib/sensu/extensions/mutators/only_check_output.rb
+- sensu-extensions.gemspec
+- spec/assets/extensions/error.rb
+- spec/assets/extensions/test.rb
+- spec/extensions_spec.rb
+- spec/handlers/debug_spec.rb
+- spec/helpers.rb
+- spec/loader_spec.rb
+- spec/mutators/only_check_output_spec.rb
+homepage: https://github.com/sensu/sensu-extensions
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: The Sensu extension loader library
+test_files:
+- spec/assets/extensions/error.rb
+- spec/assets/extensions/test.rb
+- spec/extensions_spec.rb
+- spec/handlers/debug_spec.rb
+- spec/helpers.rb
+- spec/loader_spec.rb
+- spec/mutators/only_check_output_spec.rb