portertech-sensu-extensions 1.12.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '097e4f73c1cc85a6de27331b0331c0ad2f826d42a51bd2c1d1f10850ed48361a'
+  data.tar.gz: c6015b1aa38fb3252e6b9adf1fff31b5ff31a07c5aac79a29458aa8a1a60a5c6
+SHA512:
+  metadata.gz: a8901e92240c60e1a1f590ad774246653a5d9001bd1ab1f493246fe21fddc76803f5831a7a280f45caca7d9716effc66dbe405a15298a5660dc12f4fea121857
+  data.tar.gz: 1c314c095c97380a464032d264931cac8d85d5ce72e824ad07ea0f79d982ce3fd06c686180d5dcc1c39d4aaf1e4779961c120eddf5977d0aec4817ad63dd5769

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)
+![Gem Version](https://img.shields.io/gem/v/sensu-extensions.svg)
+![MIT Licensed](https://img.shields.io/github/license/sensu/sensu.svg)
+
+## 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
+
+0. By contributing to this project you agree to abide by the [code of conduct](https://sensuapp.org/conduct).
+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/lib/sensu/extensions/constants.rb

@@ -0,0 +1,8 @@
+module Sensu
+  module Extensions
+    unless defined?(Sensu::Extensions::GEM_PREFIX)
+      # Sensu Extension Rubygem prefix.
+      GEM_PREFIX = "sensu-extensions-".freeze
+    end
+  end
+end

data/lib/sensu/extensions/loader.rb

@@ -0,0 +1,209 @@
+gem "sensu-extensions-occurrences", "1.2.0"
+gem "sensu-extensions-check-dependencies", "1.1.0"
+gem "sensu-extensions-json", "1.0.0"
+gem "sensu-extensions-ruby-hash", "1.0.0"
+gem "sensu-extensions-only-check-output", "1.0.0"
+gem "sensu-extensions-debug", "1.0.0"
+gem "sensu-extensions-deregistration", "1.0.0"
+
+require "sensu/extension"
+require "sensu/extensions/constants"
+require "sensu/extensions/occurrences"
+require "sensu/extensions/check-dependencies"
+require "sensu/extensions/json"
+require "sensu/extensions/ruby-hash"
+require "sensu/extensions/only-check-output"
+require "sensu/extensions/debug"
+require "sensu/extensions/deregistration"
+
+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
+
+      # @!attribute [r] loaded_gems
+      #   @return [Array] loaded extension gems.
+      attr_reader :loaded_gems
+
+      def initialize
+        @warnings = []
+        @loaded_files = []
+        @loaded_gems = []
+        @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 { |name, extension|
+            extension
+          }.uniq
+        }.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 an extension from a Rubygem.
+      #
+      # @param [String] gem name.
+      def load_gem(raw_gem, version=nil)
+        warning("loading extension gem", :gem => raw_gem, :version => version)
+        begin
+          gem(raw_gem, version) if version
+          if raw_gem.start_with?(GEM_PREFIX)
+            lib = raw_gem.sub(/^#{GEM_PREFIX}/, "")
+            require_path = "sensu/extensions/#{lib}"
+          else
+            require_path = raw_gem
+          end
+          warning("requiring extension gem", :require => require_path)
+          require require_path
+          @loaded_gems << raw_gem
+        rescue ScriptError, StandardError => error
+          warning("failed to require extension", {
+            :gem => raw_gem,
+            :version => version,
+            :error => error
+          })
+          warning("ignoring extension", :gem => raw_gem)
+        end
+      end
+
+      # Load instances of the loaded extensions.
+      #
+      # @param [String] sensu service to load extensions for.
+      def load_instances(service=nil)
+        service ||= sensu_service_name
+        categories_to_load(service).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
+            if extension.name_alias
+              @extensions[category][extension.name_alias] = extension
+            end
+            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 { |name, extension|
+          extension.definition
+        }.uniq
+      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
+
+      # Retrieve Sensu service name.
+      #
+      # @return [String] service name.
+      def sensu_service_name
+        File.basename($0).split("-").last
+      end
+
+      # Determine which extension categories to load for the given
+      # sensu service.
+      #
+      # @param [String] sensu service to load extensions for.
+      # @return [Array] extension categories.
+      def categories_to_load(service)
+        case service
+        when "client"
+          [:checks]
+        when "server"
+          Extension::CATEGORIES.reject { |category| category == :checks }
+        else
+          Extension::CATEGORIES
+        end
+      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.rb

@@ -0,0 +1,48 @@
+require "sensu/extensions/loader"
+
+module Sensu
+  module Extensions
+    class << self
+      # 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.
+      # @option options [Hash] :extensions to load (gems).
+      # @return [Loader] a loaded instance of Loader.
+      def 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
+        if options[:extensions]
+          options[:extensions].each do |name, details|
+            gem_name = details[:gem] || "#{GEM_PREFIX}#{name}"
+            @loader.load_gem(gem_name, details[:version])
+          end
+        end
+        @loader.load_instances
+        @loader
+      end
+
+      # Retrieve the current loaded extensions loader or load one up
+      # if there isn't one. Note: We may need to add a mutex for
+      # thread safety.
+      #
+      # @param [Hash] options to pass to load().
+      # @return [Loader] instance of a loaded loader.
+      def get(options={})
+        @loader || load(options)
+      end
+    end
+  end
+end

data/sensu-extensions.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+
+Gem::Specification.new do |spec|
+  spec.name          = "portertech-sensu-extensions"
+  spec.version       = "1.12.0"
+  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         = Dir.glob("lib/**/*") + %w[sensu-extensions.gemspec README.md LICENSE.txt]
+  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 "portertech-sensu-json", ">= 2.2.1"
+  spec.add_dependency "sensu-logger"
+  spec.add_dependency "sensu-settings"
+  spec.add_dependency "sensu-extension"
+  spec.add_dependency "sensu-extensions-occurrences", "1.2.0"
+  spec.add_dependency "sensu-extensions-check-dependencies", "1.1.0"
+  spec.add_dependency "sensu-extensions-json", "1.0.0"
+  spec.add_dependency "sensu-extensions-ruby-hash", "1.0.0"
+  spec.add_dependency "sensu-extensions-only-check-output", "1.0.0"
+  spec.add_dependency "sensu-extensions-debug", "1.0.0"
+  spec.add_dependency "sensu-extensions-deregistration", "1.0.0"
+
+  spec.add_development_dependency "bundler", "~> 2.4"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "sensu-extensions-system-profile", "1.0.0"
+  spec.add_development_dependency "bouncy-castle-java" if RUBY_PLATFORM =~ /java/
+end

metadata

@@ -0,0 +1,259 @@
+--- !ruby/object:Gem::Specification
+name: portertech-sensu-extensions
+version: !ruby/object:Gem::Version
+  version: 1.12.0
+platform: ruby
+authors:
+- Sean Porter
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2023-10-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: portertech-sensu-json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 2.2.1
+- !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
+    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-extensions-occurrences
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+- !ruby/object:Gem::Dependency
+  name: sensu-extensions-check-dependencies
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+- !ruby/object:Gem::Dependency
+  name: sensu-extensions-json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: sensu-extensions-ruby-hash
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: sensu-extensions-only-check-output
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: sensu-extensions-debug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: sensu-extensions-deregistration
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+- !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: sensu-extensions-system-profile
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+description: The Sensu extension loader library
+email:
+- portertech@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- lib/sensu/extensions.rb
+- lib/sensu/extensions/constants.rb
+- lib/sensu/extensions/loader.rb
+- sensu-extensions.gemspec
+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: []
+rubygems_version: 3.4.10
+signing_key:
+specification_version: 4
+summary: The Sensu extension loader library
+test_files: []