naplug 1.9.0 → 1.10.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2d6003ce6c362663bf1d5f692ba2a4409951167e4ed6c0396e96ea42058ffb1e
+  data.tar.gz: 20eade85d4b26153fafe22c5b23ee56d919cfdfddf934f007e029bcb145cdc66
+SHA512:
+  metadata.gz: ab5a24e2f158e5aadd13d0f3a06754a51e695cc995bfc1bcbfa1e47f4caa1380f3287b200b6508cfbd96e376830201122741feecc76a63b4b960d4a22a22e3d5
+  data.tar.gz: e0855f074375141e46acb067b9b1a94f44b15111bde193bdee9d76c664b0bffe00b4a4bcfc6648fc258656ddc014c5492148028f07c3003f194601a75a766623

data/README.md

@@ -1,8 +1,10 @@
 # Naplug [![Gem Version](https://badge.fury.io/rb/naplug.png)](http://badge.fury.io/rb/naplug)
 
-*Naplug* is a [Nagios plugin](http://nagiosplug.sourceforge.net/developer-guidelines.html) library for Ruby focused on plugin internals: organization, status, performance data, output and exit code handling. It contains (but does not include by default) functionality related to option and argument parsing, allowing plugin developers to use [any of the many fine CLI tools available](https://www.ruby-toolbox.com/categories/CLI_Option_Parsers) for this purpose. It aims to ease the task of writing Nagios plugins in Ruby and _handling the paperwork_, allowing the plugin developer to concentrate on the test logic of the plugin. Some of internal implementation is largely modeled after the very excellent [Worlkflow](https://github.com/geekq/workflow) library.
+**Naplug** is a [Nagios plugin](http://nagiosplug.sourceforge.net/developer-guidelines.html) library for Ruby focused on plugin internals: organization, status, performance data, output and exit code handling. It contains (but does not include by default) functionality related to option and argument parsing, allowing plugin developers the choice to use the built-in parser or [any of the many other fine CLI tools available](https://www.ruby-toolbox.com/categories/CLI_Option_Parsers) for this purpose. 
 
-*Naplug* allows plugins to contain other plugins (referred to as *plugs*), which are a useful abstraction to break up significant tasks that the plugin as a whole must perform in order to determine the state of a service or host. The status and output of these plugs is thus used to determine the overall status of the plugin and build the output depending on said status.
+**Naplug** aims to ease the task of writing Nagios plugins in Ruby by _handling the paperwork_, allowing the plugin developer to concentrate on the test logic of the plugin. Some of the internal implementation is largely modeled after the very excellent [Worlkflow](https://github.com/geekq/workflow) library.
+
+**Naplug** allows plugins to contain other plugins (referred to as *plugs*), which are a useful abstraction to break up significant tasks that the plugin as a whole must perform in order to determine the state of a service or host. The status and output of these plugs is thus used to determine the overall status of the plugin and build the output depending on said status.
 
 While *Naplug* handles the nitty-gritty of Nagios plugins, it is important to have familiarity with the [Nagios Plugin Developer Guidelines](http://nagiosplug.sourceforge.net/developer-guidelines.html).
 
@@ -15,20 +17,20 @@ While *Naplug* handles the nitty-gritty of Nagios plugins, it is important to ha
 
 Naplug approaches Nagios plugins as Ruby classes (note that `plugin` is a reserved keyword at both the class and instance levels). To use *Naplug*, install the gem and:
 
-    #!/usr/bin/end ruby -rubygems
+    #!/usr/bin/env ruby
     require 'naplug'
     
     class MyPlugin
       include Naplug
       plugin do |p|
-        ...
+        ... <do plugin work> ...
       end  
     end
     
     MyPlugin.new.exec!
+
     
-    
-All examples will omit the `require`s for readability.
+All examples in this document will omit the `require` for readability.
  
 A very simple plugin that always returns an OK status:
     
@@ -44,7 +46,7 @@ A very simple plugin that always returns an OK status:
 
     AlwaysOkPlugin.new.exec!
 
-In the above example, a new class `AlwaysOkPlugin` is defined (the class name is arbitrary), and within this class, a plugin is created, which performs some work to set the status and output of the plugin. Once the class is defined, a new instance of the plugin is created and executed. The `exec!` method executes the plugin, evaluates status, produces correctly formatted output, and exits with the appropriate exit code:
+In the above example, a new class, `AlwaysOkPlugin`, is defined (the class name is arbitrary), and within this class, a plugin is created, which performs some work to set the status and output of the plugin. Once the class is defined, a new instance of the plugin is created and executed. The `exec!` method executes the plugin, evaluates status, produces correctly formatted output, and exits with the appropriate exit code:
 
     naplug@plugin:~: alwaysok 
     OK: Optimism level: 100%
@@ -577,7 +579,7 @@ A helper is however built-in, and uses the small and very flexible [*trollop*] l
       
     end
     
-Naplug does change the behavior of *Trollop* so that when arguments generate an error, these are handled correctly as a plugin (producing an `UNKNOWN` status).
+Naplug does change the behavior of *Trollop* so that when arguments generate an error, these are handled correctly as a plugin (producing an `UNKNOWN` status).r
 
 # Futures
 

data/examples/perfdata_multiplug

@@ -4,13 +4,12 @@ lib = File.expand_path(File.dirname(__FILE__) + '/../lib')
 $LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
 
 require 'naplug'
-require 'awesome_print'
 
 class PerfDataPlugPlugin
 
   include Naplug
 
-  plugin :p do |p|
+  plugin :p, :benchmark => true do |p|
 
     plugin :p1 do |p1|
       p1.status.ok!

data/examples/perfdata_uniplug

@@ -5,7 +5,6 @@ $LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
 
 require 'rubygems'
 require 'naplug'
-#require 'awesome_print'
 
 class PerfDataPlugin
 

data/lib/naplug.rb

@@ -11,7 +11,9 @@
 #--
 # Naplug::ClassMethods and Naplug::InstanceMethods
 
+require 'naplug/meta'
 require 'naplug/plugin'
+require 'naplug/helpers/grokkers'
 
 module Naplug
 
@@ -19,19 +21,28 @@ module Naplug
 
   module ClassMethods
 
+    include Naplug::Helpers::Grokkers
+
     # @!scope class
 
     # @!attribute [r] plugins
     #   @return [Hash<Symbol, Plugin>] metaplugins
-    attr_reader :plugins
+    attr_reader :plugins, :_time
 
     # Create a metaplugin (which basically contains a tag and a block)
     # @param tag [Symbol] the plugin tag
     # @return [Plugin] a metaplugin
     def plugin(*tagmeta, &block)
       tag, meta = tagmeta_grok tagmeta
+      @metas = Hash.new unless @metas
+      @metas[tag] = Meta.new meta.merge :meta => true
       @plugins = Hash.new unless @plugins
       @plugins[tag] = create_metaplugin tag, meta, block
+      @_time = { :start => Time.now } #  if m[:benchmark]
+    end
+
+    def meta(m)
+      @_time = { :start => Time.now } #  if m[:benchmark]
     end
 
     # A list of plugin tags
@@ -48,28 +59,7 @@ module Naplug
         define_method "#{tag}".to_sym  do; @plugins[tag];  end    # <tag> methods for quick access to plugins
         define_method "#{tag}!".to_sym do; self.exec! tag; end    # <tag>! methods to involke exec! on a given plugin
       end
-      Plugin.new tag, block, meta.merge({ :parent => self })
-    end
-
-    def tagmeta_grok(tagmeta)
-      case tagmeta.size
-        when 0
-          [:main, {}]
-        when 1
-          case tagmeta[0]
-            when Symbol
-              [tagmeta[0], {}]
-            when Hash
-              [:main,tagmeta[0]]
-            else
-              raise Naplug::Error, 'ArgumentError on Naplug#plugin'
-          end
-        when 2
-          raise Naplug::Error, 'ArgumentError on Naplug#plugin' unless tagmeta[0].is_a? Symbol and tagmeta[1].is_a? Hash
-          tagmeta[0..1]
-        else
-          raise Naplug::Error, 'ArgumentError on Naplug#plugin'
-      end
+      Plugin.new tag, block, meta.merge(:parent => self, :meta => true)
     end
 
   end
@@ -120,8 +110,11 @@ module Naplug
     # Execute, evaluate and exit the plugin according to the plugin status, outputting the plugin's text output (and performance data, if applicable)
     # @param tag [Symbol] a plugin tag
     def exec!(tag = default_plugin.tag)
-      exec tag
-      eval tag
+      t = Benchmark.realtime do
+        exec tag
+        eval tag
+      end
+    #  @plugins[tag].perfdata! "monitoring.#{File.basename($0)}.#{tag}", t if @plugins[tag].meta.benchmark
       exit tag
     end
 
@@ -158,12 +151,7 @@ module Naplug
 
     # @return [Array<PerformanceData>] a list of performance data objects
     def perfdata(tag = default_plugin.tag)
-      plugin = @plugins[tag]
-      if plugin.has_plugins?
-        plugin.plugins.values.select { |plug| plug.perfdata }.map { |plug| plug.perfdata }
-      else
-        plugin.perfdata ? [plugin.perfdata] : []
-      end
+      @plugins[tag].perfdata(:deep).flatten.select { |pd| pd}
     end
 
     private
@@ -188,7 +176,7 @@ module Naplug
 
     def plugins!
       self.class.plugins.each do |tag,plugin|
-        @plugins[tag] = Plugin.new tag, plugin.block, {}
+        @plugins[tag] = Plugin.new tag, plugin.block, plugin.meta.to_h.merge(:meta => false)
       end
     end
 

data/lib/naplug/helpers/grokkers.rb

@@ -0,0 +1,29 @@
+module Naplug
+
+  module Helpers
+
+    module Grokkers
+
+      def tagmeta_grok(tagmeta)
+        case tagmeta.size
+          when 0
+            [:main, {}]
+          when 1
+            case tagmeta[0]
+              when Symbol
+                [tagmeta[0], {}]
+              when Hash
+                [:main,tagmeta[0]]
+              else
+                raise Naplug::Error, 'ArgumentError on Naplug#plugin'
+            end
+          when 2
+            raise Naplug::Error, 'ArgumentError on Naplug#plugin' unless tagmeta[0].is_a? Symbol and tagmeta[1].is_a? Hash
+            tagmeta[0..1]
+          else
+            raise Naplug::Error, 'ArgumentError on Naplug#plugin'
+        end
+      end
+    end
+  end
+end

data/lib/naplug/meta.rb

@@ -0,0 +1,45 @@
+require 'benchmark'
+
+module Naplug
+
+  class Meta
+
+    DEFAULT = { :debug => false, :state => true, :description => '', :parent => nil, :benchmark => nil, :meta => true }
+    OPTIONS = DEFAULT.keys
+
+    def initialize(meta = DEFAULT)
+      validate meta
+      @meta = DEFAULT.merge meta
+      @meta[:benchmark] = Benchmark::Tms.new if @meta[:benchmark]
+    end
+
+    OPTIONS.each do |option|
+      define_method option do
+        @meta[option]
+      end
+      define_method "#{option}!".to_sym do |m|
+        @meta[option] = m
+      end
+    end
+
+    def to_h
+      @meta
+    end
+
+    private
+
+    def validate(meta)
+      invalid_options = meta.keys - OPTIONS
+      raise Naplug::Error, "invalid meta option(s): #{invalid_options.join(', ')}" if invalid_options.any?
+
+      # benchmark is allowed to be nil, false, true, or a Benchmark::Tms object
+      case meta[:benchmark]
+        when nil, true, false, Benchmark::Tms
+          true
+        else
+          raise Naplug::Error, "invalid benchmark metadata: #{meta[:benchmark].class.to_s}"
+        end
+    end
+  end
+
+end

data/lib/naplug/output.rb

@@ -22,7 +22,7 @@ module Naplug
     def to_s(output = :text_output)
       case output
         when :text_output then @text_output
-        when :long_text   then @long_text.joing "\n"
+        when :long_text   then @long_text.join "\n"
         else nil
       end
     end

data/lib/naplug/plugin.rb

@@ -1,30 +1,27 @@
 require 'ostruct'
 
+require 'naplug/meta'
 require 'naplug/status'
 require 'naplug/output'
 require 'naplug/performancedata'
+require 'naplug/helpers/grokkers'
 
 module Naplug
 
   class Plugin
 
-    attr_reader :block, :plugins, :tag, :meta
+    include Naplug::Helpers::Grokkers
 
-    class DuplicatePlugin < StandardError; end
-
-    DEFAULT_META = { :debug => false, :enabled => true }
-    VALID_META_OPTIONS = [ :debug, :state, :description, :parent ]
+    attr_reader :block, :plugins, :tag
 
     def initialize(tag, block, meta)
-      validate_meta_options meta
-
       @tag = tag
       @block = block
       @plugins = Hash.new
 
       @_args = Hash.new
       @_data = OpenStruct.new :status => Status.new, :output => Output.new, :payload => nil, :perfdata => nil
-      @_meta = OpenStruct.new DEFAULT_META.merge meta
+      @_meta = Meta.new meta
 
       begin
         instance_eval &block
@@ -36,29 +33,8 @@ module Naplug
 
     end
 
-    # @return [True, False] true if this plugin is a metaplugin, false otherwise
-    def is_meta?
-      @_meta.status
-    end
-
-    # enable execution of the plugin; metaplugins are always enabled
-    def enable!
-      is_meta? ? nil : @_meta.enabled = true
-    end
-
-    # disable execution of the plugin; metaplugins cannot be disabled
-    def disable!
-      is_meta? ? nil : @_meta.enabled = false
-    end
-
-    # true when plugin is enabled; false otherwise
-    def is_enabled?
-      @_meta.enabled
-    end
-
-    # true when the plugin is disabled; false otherwise
-    def is_disabled?
-      not @_meta.enabled
+    def meta
+      @_meta
     end
 
     def parent
@@ -102,8 +78,13 @@ module Naplug
     end
 
     # returns the performance data of the plugin as a PerformanceData object
-    def perfdata
-      @_data.perfdata
+    def perfdata(mode = nil)
+      case mode
+        when :deep
+          plugins.values.map { |p| p.perfdata :deep }.push @_data.perfdata
+        else
+          @_data.perfdata
+      end
     end
 
     def perfdata!(label,value,f = {})
@@ -157,7 +138,7 @@ module Naplug
 
     def plugin(*tagmeta, &block)
       tag,meta = tagmeta_grok(tagmeta)
-      raise DuplicatePlugin, "duplicate definition of #{tag}" if @plugins.key? tag
+      raise Naplug::Error, "duplicate definition of #{tag}" if @plugins.key? tag
       @plugins[tag] = Plugin.new tag, block, meta.merge({ :parent => self })
       self.define_singleton_method tag do
         @plugins[tag]
@@ -168,33 +149,5 @@ module Naplug
       @_meta.debug
     end
 
-    def tagmeta_grok(tagmeta)
-      case tagmeta.size
-        when 0
-          [:main, {}]
-        when 1
-          case tagmeta[0]
-            when Symbol
-              [tagmeta[0], {}]
-            when Hash
-              [:main,tagmeta[0]]
-            else
-              raise Naplug::Error, 'ArgumentError on Naplug#plugin'
-          end
-        when 2
-          raise Naplug::Error, 'ArgumentError on Naplug#plugin' unless tagmeta[0].is_a? Symbol and tagmeta[1].is_a? Hash
-          tagmeta[0..1]
-        else
-          raise Naplug::Error, 'ArgumentError on Naplug#plugin'
-      end
-    end
-
-    def validate_meta_options(options)
-      invalid_options = options.keys - VALID_META_OPTIONS
-      if invalid_options.any?
-        raise ArgumentError, "invalid meta option(s): #{invalid_options.join(', ')}"
-      end
-    end
-
   end
 end

data/lib/naplug/version.rb

@@ -1,3 +1,3 @@
 module Naplug
-  VERSION = '1.9.0'
+  VERSION = '1.10.1'
 end

metadata

@@ -1,32 +1,23 @@
 --- !ruby/object:Gem::Specification
 name: naplug
 version: !ruby/object:Gem::Version
-  version: 1.9.0
-  prerelease: 
+  version: 1.10.1
 platform: ruby
 authors:
 - Gerardo López-Fernádez
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-27 00:00:00.000000000 Z
+date: 2018-04-17 00:00:00.000000000 Z
 dependencies: []
-description: ! 'A Ruby library for Nagios plugins '
+description: 'A Ruby library for Nagios plugins '
 email: gerir@evernote.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- lib/naplug/about.rb
-- lib/naplug/helpers/cli.rb
-- lib/naplug/helpers/json_thresholds.rb
-- lib/naplug/helpers.rb
-- lib/naplug/output.rb
-- lib/naplug/performancedata.rb
-- lib/naplug/plugin.rb
-- lib/naplug/status.rb
-- lib/naplug/version.rb
-- lib/naplug.rb
+- LICENSE
+- README.md
 - examples/almostalwaysok
 - examples/dupplugin
 - examples/exception
@@ -41,32 +32,40 @@ files:
 - examples/perfdata_uniplug
 - examples/status
 - examples/u_alwaysunknown
-- LICENSE
-- README.md
+- lib/naplug.rb
+- lib/naplug/about.rb
+- lib/naplug/helpers.rb
+- lib/naplug/helpers/cli.rb
+- lib/naplug/helpers/grokkers.rb
+- lib/naplug/helpers/json_thresholds.rb
+- lib/naplug/meta.rb
+- lib/naplug/output.rb
+- lib/naplug/performancedata.rb
+- lib/naplug/plugin.rb
+- lib/naplug/status.rb
+- lib/naplug/version.rb
 homepage: https://github.com/gerirgaudi/naplug
 licenses:
 - Apache License, Version 2.0
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.3.5
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.7.6
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A Ruby library for Nagios plugins
 test_files: []
-has_rdoc: