flapjack 0.6.39 → 0.6.40

data/lib/flapjack/jabber.rb

@@ -18,6 +18,7 @@ require 'yajl/json_gem'
 
 require 'flapjack/data/entity_check'
 require 'flapjack/pikelet'
+require 'flapjack/redis_pool'
 require 'flapjack/utility'
 require 'flapjack/version'
 
@@ -25,7 +26,7 @@ module Flapjack
 
   class Jabber < Blather::Client
 
-    include Flapjack::Pikelet
+    include Flapjack::GenericPikelet
     include Flapjack::Utility
 
     log = Logger.new(STDOUT)
@@ -33,14 +34,26 @@ module Flapjack
     log.level = Logger::INFO
     Blather.logger = log
 
-    def initialize
-      super
+    alias_method :generic_bootstrap, :bootstrap
+    alias_method :generic_cleanup,   :cleanup
+
+    def bootstrap(opts = {})
+      generic_bootstrap(opts)
+
+      @redis_config = opts[:redis_config]
+      @redis = Flapjack::RedisPool.new(:config => @redis_config, :size => 1)
+
       @buffer = []
       @hostname = Socket.gethostname
     end
 
+    def cleanup
+      @redis.empty! if @redis
+      @redis_handler.empty! if @redis_handler
+      generic_cleanup
+    end
+
     def setup
-      @redis = build_redis_connection_pool
       @flapjack_jid = Blather::JID.new((@config['jabberid'] || 'flapjack') + '/' + @hostname)
 
       super(@flapjack_jid, @config['password'], @config['server'], @config['port'].to_i)
@@ -79,8 +92,8 @@ module Flapjack
 
     # Join the MUC Chat room after connecting.
     def on_ready(stanza)
-      return if should_quit?
-      @redis_handler ||= build_redis_connection_pool
+      return if should_quit? && @shutting_down
+      @redis_handler ||= Flapjack::RedisPool.new(:config => @redis_config, :size => 1)
       @connected_at = Time.now.to_i
       logger.info("Jabber Connected")
       if @config['rooms'] && @config['rooms'].length > 0
@@ -150,6 +163,8 @@ module Flapjack
       when command =~ /^help$/
         msg  = "commands: \n"
         msg += "  ACKID <id> <comment> [duration: <time spec>] \n"
+        msg += "  find entities matching /pattern/ \n"
+        msg += "  test notifications for <entity>[:<check>] \n"
         msg += "  identify \n"
         msg += "  help \n"
 
@@ -162,6 +177,43 @@ module Flapjack
         msg += "System CPU Time: #{t.stime}\n"
         msg += `uname -a`.chomp + "\n"
 
+      when command =~ /^test notifications for\s+([a-z0-9-]+)(:(.+))?$/i
+        entity_name = $1
+        check_name  = $3 ? $3 : 'test'
+
+        msg = "so you want me to test notifications for entity: #{entity_name}, check: #{check_name} eh? ... well OK!"
+
+        entity = Flapjack::Data::Entity.find_by_name(entity_name, :redis => @redis_handler)
+        if entity
+          summary = "Testing notifications to all contacts interested in entity: #{entity.name}, check: #{check_name}"
+
+          entity_check = Flapjack::Data::EntityCheck.for_entity(entity, check_name, :redis => @redis_handler)
+          puts entity_check.inspect
+          entity_check.test_notifications('summary' => summary)
+
+        else
+          msg = "yeah, no i can't see #{entity_name} in my systems"
+        end
+
+      when command =~ /^(find )?entities matching\s+\/(.*)\/.*$/i
+        pattern = $2.chomp.strip
+        entity_list = Flapjack::Data::Entity.find_all_name_matching(pattern, :redis => @redis_handler)
+        max_showable = 30
+        number_found = entity_list.length
+        entity_list = entity_list[0..(max_showable - 1)] if number_found > max_showable
+
+        case
+        when number_found == 0
+          msg = "found no entities matching /#{pattern}/"
+        when number_found == 1
+          msg = "found #{number_found} entity matching /#{pattern}/ ... \n"
+        when number_found > max_showable
+          msg = "showing first #{max_showable} of #{number_found} entities found matching /#{pattern}/\n"
+        else
+          msg = "found #{number_found} entities matching /#{pattern}/ ... \n"
+        end
+        msg += entity_list.join(', ') unless entity_list.empty?
+
       when command =~ /^(.*)/
         words = $1
         msg   = "what do you mean, '#{words}'? Type 'help' for a list of acceptable commands."
@@ -172,7 +224,7 @@ module Flapjack
     end
 
     def on_groupchat(stanza)
-      return if should_quit?
+      return if should_quit? && @shutting_down
       logger.debug("groupchat message received: #{stanza.inspect}")
 
       if stanza.body =~ /^flapjack:\s+(.*)/
@@ -191,7 +243,7 @@ module Flapjack
     end
 
     def on_chat(stanza)
-      return if should_quit?
+      return if should_quit? && @shutting_down
       logger.debug("chat message received: #{stanza.inspect}")
 
       if stanza.body =~ /^flapjack:\s+(.*)/
@@ -213,7 +265,7 @@ module Flapjack
 
     # returning true to prevent the reactor loop from stopping
     def on_disconnect(stanza)
-      return true if should_quit?
+      return true if should_quit? && @shutting_down
       logger.warn("jabbers disconnected! reconnecting in 1 second ...")
       EventMachine::Timer.new(1) do
         connect # Blather::Client.connect
@@ -256,7 +308,7 @@ module Flapjack
       queue = @config['queue']
       events = {}
 
-      until should_quit?
+      until should_quit? && @shutting_down
 
         # FIXME: should also check if presence has been established in any group chat rooms that are
         # configured before starting to process events, otherwise the first few may get lost (send
@@ -265,11 +317,12 @@ module Flapjack
           logger.debug("jabber is connected so commencing blpop on #{queue}")
           events[queue] = @redis.blpop(queue, 0)
           event         = Yajl::Parser.parse(events[queue][1])
-          type          = event['notification_type']
+          type          = event['notification_type'] || 'unknown'
           logger.debug('jabber notification event received')
           logger.debug(event.inspect)
           if 'shutdown'.eql?(type)
             if should_quit?
+              @shutting_down = true
               EventMachine::Synchrony.next_tick do
                 # get delays without the next_tick
                 close # Blather::Client.close
@@ -284,14 +337,30 @@ module Flapjack
 
             logger.debug("processing jabber notification address: #{address}, event: #{entity}:#{check}, state: #{state}, summary: #{summary}")
 
-            ack_str = event['event_count'] && !state.eql?('ok') && !'acknowledgement'.eql?(type) ?
+            ack_str =
+              event['event_count'] &&
+              !state.eql?('ok') &&
+              !'acknowledgement'.eql?(type) &&
+              !'test'.eql?(type) ?
               "::: flapjack: ACKID #{event['event_count']} " : ''
 
-            maint_str = (type && 'acknowledgement'.eql?(type)) ?
-              "has been acknowledged, unscheduled maintenance created for #{duration}" :
+            type = 'unknown' unless type
+
+            maint_str = case type
+            when 'acknowledgement'
+              "has been acknowledged, unscheduled maintenance created for #{duration}"
+            when 'test'
+              ''
+            else
               "is #{state.upcase}"
+            end
+
+            # FIXME - should probably put all the message composition stuff in one place so
+            # the logic isn't duplicated in each notification channel.
+            # TODO - templatise the messages so they can be customised without changing core code
+            headline = "test".eql?(type.downcase) ? "TEST NOTIFICATION" : type.upcase
 
-            msg = "#{type.upcase} #{ack_str}::: \"#{check}\" on #{entity} #{maint_str} ::: #{summary}"
+            msg = "#{headline} #{ack_str}::: \"#{check}\" on #{entity} #{maint_str} ::: #{summary}"
 
             chat_type = :chat
             chat_type = :groupchat if @config['rooms'] && @config['rooms'].include?(address)
@@ -307,9 +376,6 @@ module Flapjack
 
       count_timer.cancel
       keepalive_timer.cancel
-
-      @redis.empty! if @redis
-      @redis_handler.empty! if @redis_handler
     end
 
   end

data/lib/flapjack/notification/email.rb

@@ -5,47 +5,76 @@ require 'erb'
 require 'haml'
 require 'socket'
 
+require 'flapjack/pikelet'
 require 'flapjack/data/entity_check'
-require 'flapjack/notification/common'
 
 module Flapjack
   module Notification
 
     class Email
-      extend Flapjack::Notification::Common
-
-      def self.dispatch(notification, opts = {})
-        notification_type  = notification['notification_type']
-        contact_first_name = notification['contact_first_name']
-        contact_last_name  = notification['contact_last_name']
-        state              = notification['state']
-        summary            = notification['summary']
-        time               = notification['time']
-        entity, check      = notification['event_id'].split(':')
-
-        entity_check = Flapjack::Data::EntityCheck.for_event_id(notification['event_id'],
-          :redis => opts[:redis])
-
-        headline_map = {'problem'         => 'Problem: ',
-                        'recovery'        => 'Recovery: ',
-                        'acknowledgement' => 'Acknowledgement: ',
-                        'unknown'         => ''
-                       }
-
-        headline = headline_map[notification_type] || ''
-
-        subject = "#{headline}'#{check}' on #{entity}"
-        subject += " is #{state.upcase}" unless notification_type == 'acknowledgement'
-
-        notification['subject'] = subject
-        opts[:logger].debug "Flapjack::Notification::Email#dispatch is calling Flapjack::Notification::Mailer.sender, notification_id: #{notification['id']}"
-        sender_opts = {:logger => opts[:logger],
-                       :in_scheduled_maintenance   => entity_check.in_scheduled_maintenance?,
-                       :in_unscheduled_maintenance => entity_check.in_unscheduled_maintenance?
-                      }
-
-        mail = prepare_email(notification, sender_opts)
-        mail.deliver!
+
+      extend Flapjack::ResquePikelet
+
+      class << self
+
+        alias_method :orig_bootstrap, :bootstrap
+
+        # See https://github.com/mikel/mail/blob/master/lib/mail/mail.rb#L53
+        # & https://github.com/mikel/mail/blob/master/spec/mail/configuration_spec.rb
+        # for details of configuring mail gem. defaults to SMTP, localhost, port 25
+        def bootstrap(opts = {})
+          return if @bootstrapped
+
+          sc = opts[:config].delete('smtp_config')
+
+          if sc
+            smtp_config = sc.keys.inject({}) do |ret,obj|
+                ret[obj.to_sym] = sc[obj]
+                ret
+            end
+
+            Mail.defaults {
+              delivery_method :smtp, {:enable_starttls_auto => false}.merge(smtp_config)
+            }
+          end
+          orig_bootstrap(opts)
+        end
+
+        def perform(notification)
+          @logger.debug "Woo, got a notification to send out: #{notification.inspect}"
+          opts = {:logger => @logger}
+
+          notification_type  = notification['notification_type']
+          contact_first_name = notification['contact_first_name']
+          contact_last_name  = notification['contact_last_name']
+          state              = notification['state']
+          summary            = notification['summary']
+          time               = notification['time']
+          entity, check      = notification['event_id'].split(':')
+
+          entity_check = Flapjack::Data::EntityCheck.for_event_id(notification['event_id'],
+            :redis => ::Resque.redis)
+
+          headline_map = {'problem'         => 'Problem: ',
+                          'recovery'        => 'Recovery: ',
+                          'acknowledgement' => 'Acknowledgement: ',
+                          'test'            => 'Test Notification: ',
+                          'unknown'         => ''
+                         }
+
+          headline = headline_map[notification_type] || ''
+
+          subject = "#{headline}'#{check}' on #{entity}"
+          subject += " is #{state.upcase}" unless ['acknowledgement', 'test'].include?(notification_type)
+
+          notification['subject'] = subject
+
+          mail = prepare_email(notification, :logger => @logger,
+                  :in_scheduled_maintenance   => entity_check.in_scheduled_maintenance?,
+                  :in_unscheduled_maintenance => entity_check.in_unscheduled_maintenance?)
+          mail.deliver!
+        end
+
       end
 
     private
@@ -54,7 +83,7 @@ module Flapjack
 
         logger = opts[:logger]
 
-        # not useing socket and gethostname as that doesn't give you a fqdn.
+        # not using socket and gethostname as that doesn't give you a fqdn.
         # see the facter issue: https://projects.puppetlabs.com/issues/3898
         fqdn       = `/bin/hostname -f`.chomp
         m_from     = "flapjack@#{fqdn}"
@@ -64,7 +93,8 @@ module Flapjack
         m_to       = notification['address']
         m_subject  = notification['subject']
 
-        logger.debug("Flapjack::Notification::Mailer #{notification['id']} to: #{m_to} subject: #{m_subject}")
+        logger.debug("sending Flapjack::Notification::Email " +
+          "#{notification['id']} to: #{m_to} subject: #{m_subject}")
 
         @notification_type  = notification['notification_type']
         @contact_first_name = notification['contact_first_name']

data/lib/flapjack/notification/sms.rb

@@ -1,39 +1,51 @@
 #!/usr/bin/env ruby
 
+require 'flapjack/pikelet'
 require 'flapjack/notification/sms/messagenet'
 
 module Flapjack
   module Notification
 
     class Sms
-      extend Flapjack::Notification::Common
-
-      def self.dispatch(notification, opts = {})
-        notification_type  = notification['notification_type']
-        contact_first_name = notification['contact_first_name']
-        contact_last_name  = notification['contact_last_name']
-        state              = notification['state']
-        summary            = notification['summary']
-        time               = notification['time']
-        entity, check      = notification['event_id'].split(':')
-
-        headline_map = {'problem'         => 'PROBLEM: ',
-                        'recovery'        => 'RECOVERY: ',
-                        'acknowledgement' => 'ACK: ',
-                        'unknown'         => '',
-                        ''                => '',
-                       }
-
-        headline = headline_map[notification_type] || ''
-
-        message = "#{headline}'#{check}' on #{entity}"
-        message += " is #{state.upcase}" unless notification_type == 'acknowledgement'
-        message += " at #{Time.at(time).strftime('%-d %b %H:%M')}, #{summary}"
-
-        notification['message'] = message
-        Flapjack::Notification::Sms::Messagenet.sender(notification,
-          :logger => opts[:logger],
-          :config => Flapjack::Notification::Sms.class_variable_get('@@config'))
+
+      extend Flapjack::ResquePikelet
+
+      class << self
+
+        def perform(notification)
+          @logger.debug "Woo, got a notification to send out: #{notification.inspect}"
+          dispatch(notification, :logger => @logger, :redis => ::Resque.redis)
+        end
+
+        def dispatch(notification, opts = {})
+          notification_type  = notification['notification_type']
+          contact_first_name = notification['contact_first_name']
+          contact_last_name  = notification['contact_last_name']
+          state              = notification['state']
+          summary            = notification['summary']
+          time               = notification['time']
+          entity, check      = notification['event_id'].split(':')
+
+          headline_map = {'problem'         => 'PROBLEM: ',
+                          'recovery'        => 'RECOVERY: ',
+                          'acknowledgement' => 'ACK: ',
+                          'test'            => 'TEST NOTIFICATION: ',
+                          'unknown'         => '',
+                          ''                => '',
+                         }
+
+          headline = headline_map[notification_type] || ''
+
+          message = "#{headline}'#{check}' on #{entity}"
+          message += " is #{state.upcase}" unless ['acknowledgement', 'test'].include?(notification_type)
+          message += " at #{Time.at(time).strftime('%-d %b %H:%M')}, #{summary}"
+
+          notification['message'] = message
+          Flapjack::Notification::Sms::Messagenet.sender(notification,
+            :logger => opts[:logger],
+            :config => Flapjack::Notification::Sms.instance_variable_get('@config'))
+        end
+
       end
 
     end

data/lib/flapjack/oobetet.rb

@@ -16,7 +16,7 @@ module Flapjack
 
   class Oobetet < Blather::Client
 
-    include Flapjack::Pikelet
+    include Flapjack::GenericPikelet
     include Flapjack::Utility
 
     log = Logger.new(STDOUT)

data/lib/flapjack/pagerduty.rb

@@ -1,44 +1,50 @@
 #!/usr/bin/env ruby
 
-require 'eventmachine'
-# the redis/synchrony gems need to be required in this particular order, see
-# the redis-rb README for details
-require 'hiredis'
 require 'em-synchrony'
 require 'em-synchrony/em-http'
-require 'redis/connection/synchrony'
-require 'redis'
 
 require 'yajl/json_gem'
 
 require 'flapjack/data/entity_check'
 require 'flapjack/data/global'
 require 'flapjack/pikelet'
+require 'flapjack/redis_pool'
 
 module Flapjack
 
   class Pagerduty
 
-    include Flapjack::Pikelet
+    include Flapjack::GenericPikelet
 
     PAGERDUTY_EVENTS_API_URL   = 'https://events.pagerduty.com/generic/2010-04-15/create_event.json'
     SEM_PAGERDUTY_ACKS_RUNNING = 'sem_pagerduty_acks_running'
 
-    def setup
-      @redis = build_redis_connection_pool
+    alias_method :generic_bootstrap, :bootstrap
+    alias_method :generic_cleanup,   :cleanup
+
+    def bootstrap(opts = {})
+      generic_bootstrap(opts)
+
+      @redis_config = opts[:redis_config]
+      @redis = Flapjack::RedisPool.new(:config => @redis_config, :size => 1)
+
       logger.debug("New Pagerduty pikelet with the following options: #{@config.inspect}")
 
       @pagerduty_acks_started = nil
     end
 
+    def cleanup
+      @redis.empty! if @redis
+      @redis_timer.empty! if @redis_timer
+      generic_cleanup
+    end
+
     def add_shutdown_event(opts = {})
       return unless redis = opts[:redis]
       redis.rpush(@config['queue'], JSON.generate('notification_type' => 'shutdown'))
     end
 
     def main
-      setup
-
       logger.debug("pagerduty gateway - commencing main method")
       raise "Can't connect to the pagerduty API" unless test_pagerduty_connection
 
@@ -47,7 +53,7 @@ module Flapjack
       @redis.del(SEM_PAGERDUTY_ACKS_RUNNING)
 
       acknowledgement_timer = EM::Synchrony.add_periodic_timer(10) do
-        @redis_timer ||= build_redis_connection_pool
+        @redis_timer ||= Flapjack::RedisPool.new(:config => @redis_config, :size => 1)
         find_pagerduty_acknowledgements_if_safe
       end
 
@@ -67,6 +73,8 @@ module Flapjack
           summary       = event['summary']
           address       = event['address']
 
+          headline = type.upcase
+
           case type.downcase
           when 'acknowledgement'
             maint_str      = "has been acknowledged"
@@ -77,6 +85,10 @@ module Flapjack
           when 'recovery'
             maint_str      = "is #{state.upcase}"
             pagerduty_type = "resolve"
+          when 'test'
+            maint_str      = ""
+            pagerduty_type = "trigger"
+            headline       = "TEST NOTIFICATION"
           end
 
           message = "#{type.upcase} - \"#{check}\" on #{entity} #{maint_str} - #{summary}"
@@ -91,9 +103,6 @@ module Flapjack
       end
 
       acknowledgement_timer.cancel
-
-      @redis.empty! if @redis
-      @redis_timer.empty! if @redis_timer
     end
 
     # considering this as part of the public API -- exposes it for testing.