sensu-plugins-meta 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: af92cbbb28bc9c17d4c90d229e2f1eab8a0c5617
+  data.tar.gz: 45eda5fef6a258e566fc306ee2aeea01a7628c80
+SHA512:
+  metadata.gz: ffe171614f4e544d4f0cac8401111db348ffa9caeb89898ad8acc549cf1fbec5c2b8fb921b8df52ea000ad4d8ae155ee232ef92707611a79040ff7fc9b5996ae
+  data.tar.gz: d1b8e0ed0d5a47faa17804e2abf2a2442020f38f4e3cb9f997b5f3eae064340af33580129e718528c597574fe3fdae3b64875ee82437793dd3ec2d4d19856929

data/CHANGELOG.md

@@ -0,0 +1,14 @@
+# Change Log
+This project adheres to [Semantic Versioning](http://semver.org/).
+
+This CHANGELOG follows the format listed at [Keep A Changelog](http://keepachangelog.com/)
+
+## [Unreleased]
+### Added
+
+## [0.1.0] - 2017-03-07
+### Added
+- Initial release
+
+[Unreleased]: https://github.com/socrata-platform/sensu-plugins-meta/compare/0.1.0...HEAD
+[0.1.0]: https://github.com/socrata-platform/sensu-plugins-meta/tree/v0.1.0

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2017 Sensu-Plugins
+
+MIT License
+
+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,56 @@
+Sensu Plugins Meta
+==================
+
+[![Build Status](https://img.shields.io/travis/socrata-platform/sensu-plugins-meta.svg)][travis]
+[![Gem Version](https://img.shields.io/gem/v/sensu-plugins-meta.svg)][rubygems]
+[![Code Climate](https://img.shields.io/codeclimate/github/socrata-platform/sensu-plugins-meta.svg)][codeclimate]
+[![Test Coverage](https://img.shields.io/coveralls/socrata-platform/sensu-plugins-meta.svg)][coveralls]
+[![Dependency Status](https://gemnasium.com/socrata-platform/sensu-plugins-meta.svg)][gemnasium]
+
+[travis]: https://travis-ci.org/socrata-platform/sensu-plugins-meta
+[rubygems]: https://rubygems.org/gems/sensu-plugins-meta
+[codeclimate]: https://codeclimate.com/github/socrata-platform/sensu-plugins-meta
+[coveralls]: https://coveralls.io/r/socrata-platform/sensu-plugins-meta
+[gemnasium]: https://gemnasium.com/socrata-platform/sensu-plugins-meta
+
+Functionality
+-------------
+
+This Sensu plugin can be used to run another plugin multiple times as one
+batch check.
+
+Files
+-----
+
+* bin/check-meta-ruby.rb
+
+Usage
+-----
+
+The `check-meta-ruby.rb` script requires another Sensu plugin to run and a JSON
+array of options to run it with. The JSON can be provided either as a string:
+
+    check-meta-ruby.rb -c /opt/sensu/embedded/bin/check-http.rb \
+      -j '[{"url": "http://pants.com/"}, {"url": "https://www.google.com"}]'
+
+...or as a path to a file:
+
+    check-meta-ruby.rb -c /opt/sensu/embedded/bin/check-http.rb \
+      -j /etc/sensu/http_checks.json
+
+If a full path is not provided for the Sensu plugin file, an attempt will be
+made to find it relative to the `check-meta-ruby.rb` file.
+
+Installation
+------------
+
+[Installation and Setup](http://sensu-plugins.io/docs/installation_instructions.html)
+
+Notes
+-----
+
+The Ruby check makes certain assumptions about the plugin it's being asked to
+run:
+
+* It must be a child of the `Sensu::Plugin::Check::CLI` class
+* It must be the only Sensu check defined in the configured plugin file

data/bin/check-meta-ruby.rb

@@ -0,0 +1,256 @@
+#!/usr/bin/env ruby
+# encoding: utf-8
+# frozen_string_literal: false
+#
+#   check-meta-ruby.rb
+#
+# DESCRIPTION:
+#   Give this check a file with another Sensu check and a JSON config and it
+#   will dispatch threads to run that check multiple times and batch up the
+#   results.
+#
+# OUTPUT:
+#   plain text
+#
+# PLATFORMS:
+#   Linux
+#
+# DEPENDENCIES:
+#   gem: sensu-plugin
+#
+# USAGE:
+#   Run a check multiple times using a JSON config file:
+#
+#     check-meta-ruby.rb -c check-http.rb -j /etc/sensu/http_checks.json
+#
+#   Run a check multiple times using an inline JSON config string:
+#
+#     check-meta-ruby.rb -c check-http.rb -j '[
+#       {"host": "pants.com", "port": 80}, {"host": "google.com", "port": 443}
+#     ]'
+#
+# NOTES:
+#
+# LICENSE:
+#   Copyright 2017, Socrata, Inc <sysadmin@socrata.com>
+#
+#   Released under the same terms as Sensu (the MIT license); see LICENSE
+#   for details.
+#
+
+require 'json'
+require 'sensu-plugin/check/cli'
+
+#
+# Check Meta
+#
+class CheckMetaRuby < Sensu::Plugin::Check::CLI
+  option :check,
+         short: '-c CHECK_SCRIPT',
+         long: '--check CHECK_SCRIPT',
+         description: 'The Sensu Ruby check to run multiple times',
+         required: true
+
+  option :json_config,
+         short: '-j CONFIG_STRING_OR_PATH',
+         long: '--json-config CONFIG_STRING_OR_PATH',
+         description: 'A JSON config string or path to a config file',
+         required: true
+
+  #
+  # Import the check we want to run and dispatch threads for every instance of
+  # it. Once all threads are complete, batch the results and return any
+  # non-ok status messages.
+  #
+  def run
+    require File.expand_path("../#{config[:check]}", $PROGRAM_NAME)
+
+    threads.each(&:join)
+
+    puts status_information unless status_information.empty?
+    summarize!
+  end
+
+  #
+  # Send all the information about this run to stdout and exit with the
+  # appropriate status.
+  #
+  def summarize!
+    %i(critical warning unknown).each do |status|
+      send(status, summary) unless results[status].empty?
+    end
+    ok(summary)
+  end
+
+  #
+  # Construct a string of the results of all the subchecks that have been run
+  # and not returned okay.
+  #
+  # @return [String] a long string of all the non-ok subcheck statuses
+  #
+  def status_information
+    %i(unknown warning critical).map do |status|
+      results[status].map { |result| "#{status.upcase}: #{result}" }
+    end.flatten.compact.join("\n")
+  end
+
+  #
+  # Construct the final summary message for our metacheck output.
+  #
+  # @return [String] a summary status of all the checks that have been run
+  #
+  def summary
+    "Results: #{results[:critical].size} critical, " \
+      "#{results[:warning].size} warning, " \
+      "#{results[:unknown].size} unknown, #{results[:ok].size} ok"
+  end
+
+  #
+  # Find and patch the Sensu check class that was imported from the
+  # config[:check] file. Some assumptions are made here that will hopefully
+  # usually be valid.
+  #
+  #   * The check is a child of Sensu::Plugin::Check::CLI
+  #   * The check and we are the only check classes in Ruby's object space
+  #
+  def check_class
+    @check_class ||= begin
+      c = ObjectSpace.each_object(Class).find do |klass|
+        klass < Sensu::Plugin::Check::CLI && \
+          klass != self.class && \
+          !klass.ancestors.include?(self.class)
+      end
+      patch_class!(c)
+      c
+    end
+  end
+
+  #
+  # Patch a Sensu check class so it saves its output instead of sending it
+  # to stdout. Otherwise the threading screws up the rendering.
+  #
+  # @param klass [Sensu::Plugin::Check::CLI] the check class to patch
+  #
+  def patch_class!(klass)
+    klass.class_eval do
+      #
+      # Make the check status accessible as a reader method.
+      #
+      attr_reader :status
+
+      #
+      # Patch the output method so it returns the output string instead of
+      # sending it to stdout.
+      #
+      def output(msg = @message)
+        @output ||= self.class.check_name + (msg ? ": #{msg}" : '')
+      end
+    end
+  end
+
+  #
+  # Work through the array generated from our JSON config and return an array
+  # of corresponding thread objects.
+  #
+  #
+  # @return [Array<Thread>] an array of threads to run
+  #
+  def threads
+    parsed_config.map { |check_opts| thread_for(check_opts) }
+  end
+
+  #
+  # Return a parsed and symbolized version of our JSON config.
+  #
+  # @return [Hash] the metacheck config
+  #
+  def parsed_config
+    @parsed_config ||= begin
+                         JSON.parse(config[:json_config], symbolize_names: true)
+                       rescue JSON::ParserError
+                         JSON.parse(File.read(config[:json_config]),
+                                    symbolize_names: true)
+                       end
+  end
+
+  #
+  # Build a new thread object for a given set of check options. The options
+  # will be parsed into the command line arguments for the check, e.g.
+  #
+  #   {
+  #     host: 'example.com',
+  #     port: 443,
+  #     c: /etc/config.conf,
+  #     do_something: nil
+  #   }
+  #
+  # will get translated into the CLI arguments:
+  #
+  #   --host example.com --port 443 -c /etc/config.conf --do-something
+  #
+  # @param check_opts [Hash] a hash of switches and their values.
+  #
+  def thread_for(check_opts)
+    Thread.new do
+      chk = check_class.new(check_args_for(check_opts))
+      run_check!(chk)
+    end
+  end
+
+  #
+  # Accept and run a given sub-check object, catch its resultant status and
+  # output, and preserve that data for later processing.
+  #
+  # @param chk [Sensu::Plugin::Check::CLI] a Sensu check object
+  #
+  def run_check!(chk)
+    chk.run
+  rescue SystemExit => e
+    results[exit_statuses[e.status]] << chk.output
+  rescue StandardError => e
+    # Though an argument could be made to treat other exceptions as
+    # critical instead of unknown.
+    results[:unknown] << e.to_s
+  end
+
+  #
+  # Invert Sensu's exit codes hash so it's an array of exit codes to statuses,
+  # downcased and symbolized, e.g. exit_status[0] => :ok.
+  #
+  # @return [Array<Symbol>] an inverted index of Sensu exit codes and statues
+  #
+  def exit_statuses
+    Sensu::Plugin::EXIT_CODES.each_with_object([]) do |(status, code), arr|
+      arr[code] = status.downcase.to_sym
+    end
+  end
+
+  #
+  # Construct the arg values for a check call based on a given set of options.
+  # Adhere to the following rules:
+  #
+  #   * A single character option translates to "-o arg"
+  #   * A >1 character option translates to "--option arg"
+  #   * An option with a nil value translates to "--option"
+  #
+  # @param check_opts [Hash] a hash of check flags and values (or nil)
+  #
+  # @return [Array<String>] the correct argv for the given check options
+  #
+  def check_args_for(check_opts)
+    check_opts.each_with_object([]) do |(k, v), arr|
+      arr << (k.length == 1 ? "-#{k}" : "--#{k.to_s.tr('_', '-')}")
+      arr << v.to_s unless v.nil?
+    end
+  end
+
+  #
+  # Set up an object-level hash of result arrays so we can save the output
+  # from every check thread.
+  #
+  # @return [Hash] A hash of Sensu statuses => check output messages
+  #
+  def results
+    @results ||= { ok: [], warning: [], critical: [], unknown: [] }
+  end
+end

data/lib/sensu_plugins_meta.rb

@@ -0,0 +1,4 @@
+# encoding: utf-8
+# frozen_string_literal: false
+
+require 'sensu_plugins_meta/version'

data/lib/sensu_plugins_meta/version.rb

@@ -0,0 +1,11 @@
+# encoding: utf-8
+# frozen_string_literal: false
+
+module SensuPluginsMeta
+  module Version
+    MAJOR = 0
+    MINOR = 1
+    PATCH = 0
+    VER_STRING = [MAJOR, MINOR, PATCH].compact.join('.')
+  end
+end

metadata

@@ -0,0 +1,267 @@
+--- !ruby/object:Gem::Specification
+name: sensu-plugins-meta
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Sensu-Plugins and contributors
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-03-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: sensu-plugin
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: simplecov-console
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: github-markup
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.0'
+- !ruby/object:Gem::Dependency
+  name: redcarpet
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.2'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.47'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.47'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: test-kitchen
+  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: kitchen-vagrant
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: kitchen-docker
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.6'
+description: This plugin provides a way to call other check plugins multiple times
+  as a single check.
+email: "<sensu-users@googlegroups.com>"
+executables:
+- check-meta-ruby.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- CHANGELOG.md
+- LICENSE
+- README.md
+- bin/check-meta-ruby.rb
+- lib/sensu_plugins_meta.rb
+- lib/sensu_plugins_meta/version.rb
+homepage: https://github.com/sensu-plugins/sensu-plugins-meta
+licenses:
+- MIT
+metadata:
+  maintainer: sensu-plugin
+  development_status: active
+  production_status: unstable - testing recommended
+  release_draft: 'false'
+  release_prerelease: 'false'
+post_install_message: You can use the embedded Ruby by setting EMBEDDED_RUBY=true
+  in /etc/default/sensu
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Sensu plugins for batching multiple checks as one
+test_files: []