averell23-watchdogger 0.1.4 → 0.1.5

data/lib/dog_log.rb

@@ -8,8 +8,12 @@ class DogLog # :nodoc:
     # Set the log file and severity. This will reset the current logger,
     # but should not usually be called on an active log.
     def setup(logfile, severity)
-      @logfile = logfile
-      @severity = severity.is_a?(Fixnum) ? severity : Logger.const_get(severity.upcase)
+      @logfile = logfile || STDERR
+      @severity = if(severity)
+        severity.is_a?(Fixnum) ? severity : Logger.const_get(severity.upcase)
+      else
+        Logger::DEBUG
+      end
       if(@logger)
         assit_fail('Resetting logfile')
         @logger.close if(@logger.respond_to?(:close))
@@ -22,10 +26,8 @@ class DogLog # :nodoc:
     # If nothing is configured, we log to STDERR by default
     def logger
       @logger ||= begin
-        @logfile ||= STDERR
-        severity = @severity || Logger::DEBUG
         logger = Logger.new(get_log_io, 3)
-        logger.level = severity
+        logger.level = @severity
         logger
       end
     end

data/lib/watchdogger.rb

@@ -24,9 +24,9 @@ module WatchDogger # :nodoc:
     # Initializes the watchdog system, sets up the log. In addition to the configured
     # Watchers and WatcherActions, the system can take the following arguments:
     #
-    #   log_level     - The log level for the system log. This will apply to all log messages
-    #   logfile       - The log file for the system. Defaults to STDOUT
-    #   interval      - The watch interval in seconds. Defaults to 60
+    #  [*log_level*] The log level for the system log. This will apply to all log messages
+    #  [*logfile*] The log file for the system. Defaults to STDOUT
+    #  [*interval*] The watch interval in seconds. Defaults to 60
     def init_system(options)
       # First setup the logging options
       @log_level = options.get_value(:log_level)

data/lib/watcher/base.rb

@@ -6,20 +6,22 @@ module Watcher
   # trouble). Each watcher will have one or more actions attached that will be called if the
   # watched condition is triggered.
   #
+  # =Options
+  #
   # Each watcher will accept the following options, which are handled by the superclass:
   #
-  #   severity  - Severity of the event. Each time the event is triggered, the watcher will
-  #               add this value to the internal "severity". If the internal severity reaches
-  #               100, the action is triggered. This means that with a severity of 100 the
-  #               action is run each time the watcher triggers. With a severity of 1, it is
-  #               only executed every 100th time. The global mechanism will reset the
-  #               severity once the action is triggered. The watcher class may decide
-  #               to reset the severity also on other occasions. Default: 100
+  # [*severity*] Severity of the event. Each time the event is triggered, the watcher will
+  #              add this value to the internal "severity". If the internal severity reaches
+  #              100, the action is triggered. This means that with a severity of 100 the
+  #              action is run each time the watcher triggers. With a severity of 1, it is
+  #              only executed every 100th time. The global mechanism will reset the
+  #              severity once the action is triggered. The watcher class may decide
+  #              to reset the severity also on other occasions. Default: 100
   #   
-  #   actions   - The actions that should be executed when the watcher triggers. These 
-  #               are names of actions that have been set up previously. (Required)
+  # [*actions*] The actions that should be executed when the watcher triggers. These 
+  #             are names of actions that have been set up previously. (Required)
   #  
-  #   warn_actions - Additional actions that are executed if the watcher triggers, but the 
+  # [*warn_actions*] Additional actions that are executed if the watcher triggers, but the 
   #                  severity for a real action is not yet reached.
   #
   # Each watcher object must respond to the #watch_it! method. It must check the watched condition
@@ -37,22 +39,28 @@ module Watcher
        action_config = configuration.get_value(:actions)
        raise(ArgumentError, "No actions passed to watcher.") unless(action_config)
        if(action_config.is_a?(Array))
-         action_config.each { |ac| actions << ac }
+         action_config.each { |ac| add_action_to(actions, ac) }
        else
          assit(action_config.is_a?(String) || action_config.is_a?(Symbol))
-         actions << action_config
+         add_action_to(actions, action_config)
        end
        warn_config = configuration.get_value(:warn_actions)
        if(warn_config.is_a?(Array))
-         warn_config.each { |ac| warn_actions << ac }
+         warn_config.each { |ac| add_action_to(warn_actions, ac) }
        elsif(warn_config)
          assit_kind_of(String, warn_config)
-         warn_actions << warn_config
+         add_action_to(warn_actions, warn_config)
        end
      end
 
      private
 
+     # Adds the given action to the array, if it exists
+     def add_action_to(ary, action)
+       raise(NameError, "Action does not exist: #{action}") unless(WatcherAction.has_action?(action))
+       ary << action
+     end
+
      # Checks the trigger and does everything to call the actions connected to this watcher
      def do_watch!
        @current_severity ||= 0

data/lib/watcher/http_watcher.rb

@@ -3,13 +3,14 @@ require 'net/http'
 module Watcher
   
   # Checks an http connection if it is active and returns the expected results.
-  # Options for this watcher:
+  #
+  # =Options
   # 
-  #   url           - The URL to query (required)
-  #   response      - The response code that is expected from the operation
-  #   content_match - A regular expression that is matched against the result.
+  # [*url*] The URL to query (required)
+  # [*response*] The response code that is expected from the operation
+  # [*content_match*] A regular expression that is matched against the result.
   #                   The watcher fails if the expression doesn't match
-  #   timeout       - The timeout for the connection attempt. Defaults to 10 sec
+  # [*timeout*] The timeout for the connection attempt. Defaults to 10 sec
   # 
   # If neither response nor content_match are given, the watcher will expect a 
   # 200 OK response from the server.

data/lib/watcher/log_watcher.rb

@@ -9,13 +9,11 @@ module Watcher
   # 
   # = Options
   # 
-  #   logfile       - The log file to watch (required)
-  #   match         - A regular expression against which the log file will be matched (required)
-  #   reopen_after  - A number indicating after how many "unchanged" checks the file will
-  #                   be reopened. Defaults to 10.
-  #   interval_first, interval_max are the start and the max value for waiting on an unchanged
-  #   log file. They default to 60 (1 minute) and 300 (5 minutes). The log file will
-  #   be considered stale and reopened after max_value * 3.
+  # [*logfile*] The log file to watch (required)
+  # [*match*] A regular expression against which the log file will be matched (required)
+  # [*interval_first, interval_max*] The start and the max value for waiting on an unchanged
+  #                                  log file. They default to 60 (1 minute) and 300 (5 minutes). 
+  #                                  The log file will be considered stale and reopened after max_value * 3.
   #
   # = Warning
   # 

data/lib/watcher_action.rb

@@ -29,6 +29,11 @@ module WatcherAction
       dog_log.error('Action Handler') { "Could not execute #{name}: #{e.message} (Registered actions: #{registered_actions.keys.join(', ')})" }
       false
     end
+    
+    # Checks if the given action exists
+    def has_action?(name)
+      registered_actions[name.to_sym] != nil
+    end
   
     private
     

data/lib/watcher_action/htpost.rb

@@ -2,11 +2,11 @@ module WatcherAction
   
   # This action posts the event to a given URL. It may use plain HTTP Authentication
   #
-  # Options for this Action:
+  # = Options
   # 
-  #   url          - The URL to post the information to (required)
-  #   user         - The user for HTTP Authentication (optional)
-  #   pass         - The password for HTTP Authentication.
+  # [*url*] The URL to post the information to (required)
+  # [*user*] The user for HTTP Authentication (optional)
+  # [*pass*] The password for HTTP Authentication.
   class Htpost
     
     def initialize(options)

data/lib/watcher_action/kill_process.rb

@@ -1,10 +1,11 @@
 module WatcherAction
   
   # Kills the process with the given PID.
-  # Options: 
   #
-  #  pidfile    - The file containing the process id
-  #  signal     - The signal to send to the process. Defaults to KILL
+  # =Options
+  #
+  # [*pidfile*] The file containing the process id
+  # [*signal*] The signal to send to the process. Defaults to KILL
   class KillProcess
     
     def initialize(config)

data/lib/watcher_action/log_action.rb

@@ -3,11 +3,12 @@ require 'logger'
 module WatcherAction
   
   # Logs the event information to the standard log file
-  # Options:
   #
-  #  format - A format string that will receive the timestamp, watcher name and 
-  #           event message (in that order) as parameters (default message if not given)
-  #  severity - The severity of the log message (default: warn)
+  # =Options
+  #
+  # [*format*] A format string that will receive the timestamp, watcher name and 
+  #            event message (in that order) as parameters (default message if not given)
+  # [*severity*] The severity of the log message (default: warn)
   class LogAction
     
     def initialize(options)

data/lib/watcher_action/meta_action.rb

@@ -0,0 +1,27 @@
+module WatcherAction
+  
+  # An action to call other actions. This can be used to "aggregate" combinations of
+  # actions that should always go together, so that the same combinations do
+  # not have to repeated multiple times
+  #
+  # = Options
+  # 
+  # [*actions*] A list of the actions that should be executed. (required)
+  class MetaAction
+    
+    def initialize(config)
+      actions = config.get_value(:actions, false)
+      if(actions.is_a?(Array))
+        @actions = actions
+      else
+        @actions = [ actions ]
+      end
+    end
+    
+    def execute(event)
+      @actions.each { |ac| WatcherAction.run_action(ac, event) }
+    end
+    
+  end
+  
+end

data/lib/watcher_action/send_mail.rb

@@ -7,20 +7,20 @@ module WatcherAction
   # fancy features (you may want to do that handling externally) and will only
   # use unencrypted smtp network connections.
   # 
-  # Options for this action:
+  # =Options
   #
-  #   to             - Email address to which to send the message. May be a list. (required)
-  #   sender         - Email address of the person sending the mail (required)
-  #   subject        - Subject of the message. You can put %s for the event message. (defaults if not set)
-  #   body           - Body of the email message. If set to 'xml', it will include an
-  #                    XML representation of the event. If not set, it will default
-  #                    to a sensible description of the event. You can include the
-  #                    event's message as for the subject
-  #   server         - Address or name of the mail server to use (required)
-  #   port           - Port to connect to (default: 25)
-  #   user           - Mail server user name
-  #   pass           - Mail server password
-  #   authentication - Authentication method (default: plain)
+  # [*to*] Email address to which to send the message. May be a list. (required)
+  # [*sender*] Email address of the person sending the mail (required)
+  # [*subject*] Subject of the message. You can put %s for the event message. (defaults if not set)
+  # [*body*] Body of the email message. If set to 'xml', it will include an
+  #          XML representation of the event. If not set, it will default
+  #          to a sensible description of the event. You can include the
+  #          event's message as for the subject
+  # [*server*] Address or name of the mail server to use (defaults to localhost)
+  # [*port*] Port to connect to (default: 25)
+  # [*user*] Mail server user name
+  # [*pass*] Mail server password
+  # [*authentication*] Authentication method (default: plain)
   class SendMail
     
     def initialize(config)
@@ -28,7 +28,7 @@ module WatcherAction
       @sender = config.get_value(:sender, false)
       @subject = config.get_value(:subject, "Watchdogger triggered: %s")
       @body = config.get_value(:body)
-      @server = config.get_value(:server, false)
+      @server = config.get_value(:server, 'localhost')
       @port = config.get_value(:port, '25')
       @user = config.get_value(:user)
       @pass = config.get_value(:pass)
@@ -38,7 +38,7 @@ module WatcherAction
     def execute(event)
       msg = RMail::Message.new
       msg.header.to = @mail_to
-      receipient = msg.header.to.split(',').first
+      receipient = msg.header.to.to_s.split(',').first
       msg.header.from = @sender
       msg.header.subject = @subject % [event.message]
       if(@body.to_s == 'xml')

data/test/meta_action_test.rb

@@ -0,0 +1,20 @@
+require File.join(File.dirname(__FILE__), 'test_helper')
+
+class MetaActionTest < Test::Unit::TestCase
+  
+  def setup
+    clear_registered
+    WatcherAction.register('child1', { :type => 'dummy_action' })
+    WatcherAction.register('child2', { :type => 'dummy_action' })
+    @meta = WatcherAction::MetaAction.new(:actions => ['child1', 'child2'])
+  end
+  
+  def test_simple
+    assert_equal(nil, action_status('child1'))
+    assert_equal(nil, action_status('child2'))
+    @meta.execute(WatcherEvent.new)
+    assert_equal(true, action_status('child1'))
+    assert_equal(true, action_status('child2'))
+  end
+  
+end

data/test/test_helper.rb

@@ -3,4 +3,44 @@ require 'test/unit'
 
 require File.join(File.dirname(__FILE__), '..', 'lib', 'watchdogger')
 
-DogLog.setup('tmp.log', Logger::DEBUG)
+DogLog.setup('tmp.log', Logger::DEBUG)
+
+module Watcher
+  class DummyWatcher < Watcher::Base
+    def initialize(config)
+      @watchit = config[:watchit]
+    end
+    def watch_it!
+      @watchit
+    end
+    
+  end
+end
+
+module WatcherAction
+  class DummyAction
+    def initialize(config)
+    end
+    def execute(event)
+      @executed = true
+      raise(Exception) unless(event.is_a?(WatcherEvent))
+      raise(ArgumentError, "Boom!")
+    end
+  end
+end
+
+# Add some methods to the test case class
+class Test::Unit::TestCase # :nodoc:
+  private
+  
+  def action_status(name)
+    action = WatcherAction.instance_variable_get(:@registered_actions).get_value(name)
+    action.instance_variable_get(:@executed)
+  end
+  
+  def clear_registered
+    Watcher.instance_variable_set(:@registered_watchers, nil)
+    WatcherAction.instance_variable_set(:@registered_actions, nil)
+  end
+  
+end

data/test/watchdogger_test.rb

@@ -1,34 +1,9 @@
 require File.join(File.dirname(__FILE__), 'test_helper')
 
-module Watcher
-  class DummyWatcher < Watcher::Base
-    def initialize(config)
-      @watchit = config[:watchit]
-    end
-    def watch_it!
-      @watchit
-    end
-    
-  end
-end
-
-module WatcherAction
-  class DummyAction
-    def initialize(config)
-    end
-    def execute(event)
-      @executed = true
-      raise(Exception) unless(event.is_a?(WatcherEvent))
-      raise(ArgumentError, "Boom!")
-    end
-  end
-end
-
 class WatchdoggerTest < Test::Unit::TestCase
   
   def setup
-    Watcher.instance_variable_set(:@registered_watchers, nil)
-    WatcherAction.instance_variable_set(:@registered_actions, nil)
+   clear_registered
     WatcherAction.register('default', { :type => 'dummy_action' })
     WatcherAction.register('log_action', { 'type' => :log_action })
     Watcher.register('dummy', { :type => 'dummy_watcher', 'actions' => [ :default, :log_action ] })
@@ -85,10 +60,4 @@ class WatchdoggerTest < Test::Unit::TestCase
     assert_equal(true, action_status('default'))
   end
   
-  private
-  
-  def action_status(name)
-    action = WatcherAction.instance_variable_get(:@registered_actions).get_value(name)
-    action.instance_variable_get(:@executed)
-  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: averell23-watchdogger
 version: !ruby/object:Gem::Version 
-  version: 0.1.4
+  version: 0.1.5
 platform: ruby
 authors: 
 - Daniel Hahn
@@ -85,12 +85,14 @@ files:
 - lib/watcher_action/htpost.rb
 - lib/watcher_action/kill_process.rb
 - lib/watcher_action/log_action.rb
+- lib/watcher_action/meta_action.rb
 - lib/watcher_action/send_mail.rb
 - lib/watcher_action.rb
 - lib/watcher_event.rb
 - test/http_watcher_test.rb
 - test/kill_process_test.rb
 - test/log_watcher_test.rb
+- test/meta_action_test.rb
 - test/test_helper.rb
 - test/watchdogger_test.rb
 - bin/watchdogger