flapjack 0.7.5 → 0.7.6

data/CHANGELOG.md

@@ -1,7 +1,11 @@
 ## Flapjack Changelog
 
+# 0.7.6 - 2013-05-20
+- Bug: Problems with email notifications (no name, text part missing fields) gh-158 (@ali-graham)
+
 # 0.7.5 - 2013-05-20
 - Bug: Removal of contact media via POST /contacts is not working gh-175 (@ali-graham)
+
 # 0.7.4 - 2013-05-16
 - Bug: Event counter values are strings, not integers gh-173 (@auxesis)
 

data/lib/flapjack/data/notification.rb

@@ -18,6 +18,11 @@ module Flapjack
         contacts = opts[:contacts]
         return [] if contacts.nil?
         @messages ||= contacts.collect {|contact|
+
+           # TODO don't include messages here if the contact doesn't have
+           # the medium enabled or has blackholed at this level -- this
+           # will simplify the executive logic
+
           contact.media.keys.inject([]) { |ret, mk|
             m = Flapjack::Data::Message.for_contact(:contact => contact)
             m.notification = self

data/lib/flapjack/gateways/email/alert.html.haml

@@ -11,7 +11,7 @@
       padding: 4px;
     }
 
-%p= "Hi #{@contact_first_name},"
+%p Hi #{@contact_first_name}
 
 %p Monitoring has detected the following:
 
@@ -20,7 +20,7 @@
     %tr
       %td
         %strong Entity
-      %td= @entity
+      %td= @entity_name
     %tr
       %td
         %strong Check

data/lib/flapjack/gateways/email/alert.text.erb

@@ -2,7 +2,7 @@ Hi <%= @contact_first_name %>,
 
 Monitoring has detected the following:
 
-Entity: <%= @entity %>
+Entity: <%= @entity_name %>
 Check: <%= @check %>
 State: <%= @state %>
 Summary: <%= @summary %>

data/lib/flapjack/gateways/email.rb

@@ -27,16 +27,20 @@ module Flapjack
         def perform(notification)
           @logger.debug "Woo, got a notification to send out: #{notification.inspect}"
 
-          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']
+          @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_name, @check        = notification['event_id'].split(':')
 
           entity_check = Flapjack::Data::EntityCheck.for_event_id(notification['event_id'],
             :redis => ::Resque.redis)
 
+          @in_unscheduled_maintenance = entity_check.in_scheduled_maintenance?
+          @in_scheduled_maintenance   = entity_check.in_unscheduled_maintenance?
+
           headline_map = {'problem'         => 'Problem: ',
                           'recovery'        => 'Recovery: ',
                           'acknowledgement' => 'Acknowledgement: ',
@@ -44,12 +48,10 @@ module Flapjack
                           'unknown'         => ''
                          }
 
-          headline = headline_map[notification_type] || ''
-
-          subject = "#{headline}'#{entity_check.check}' on #{entity_check.entity_name}"
-          subject += " is #{state.upcase}" unless ['acknowledgement', 'test'].include?(notification_type)
+          headline = headline_map[@notification_type] || ''
 
-          notification['subject'] = subject
+          @subject = "#{headline}'#{@check}' on #{@entity_name}"
+          @subject += " is #{@state.upcase}" unless ['acknowledgement', 'test'].include?(@notification_type)
 
           begin
             host = @smtp_config ? @smtp_config['host'] : nil
@@ -61,10 +63,11 @@ module Flapjack
             m_reply_to = m_from
             m_to       = notification['address']
 
-            mail = prepare_email(notification,
-                    :from => m_from, :to => m_to,
-                    :in_scheduled_maintenance   => entity_check.in_scheduled_maintenance?,
-                    :in_unscheduled_maintenance => entity_check.in_unscheduled_maintenance?)
+          @logger.debug("sending Flapjack::Notification::Email " +
+            "#{notification['id']} to: #{m_to} subject: #{@subject}")
+
+            mail = prepare_email(:subject  => @subject,
+                    :from => m_from, :to => m_to)
 
             email = EM::P::SmtpClient.send(
               :from     => m_from,
@@ -97,22 +100,7 @@ module Flapjack
 
     private
 
-      def self.prepare_email(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(':')
-        @in_unscheduled_maintenance = opts[:in_unscheduled_maintenance]
-        @in_scheduled_maintenance   = opts[:in_scheduled_maintenance]
-
-        m_subject  = notification['subject']
-
-        @logger.debug("sending Flapjack::Notification::Email " +
-          "#{notification['id']} to: #{opts[:to]} subject: #{m_subject}")
+      def self.prepare_email(opts = {})
 
         text_template = ERB.new(File.read(File.dirname(__FILE__) +
           '/email/alert.text.erb'))
@@ -121,17 +109,18 @@ module Flapjack
           '/email/alert.html.haml'))
 
         mail_scope = self
+        bnd = binding
 
         # this part is the only use of the mail gem -- maybe this can be done
         # using standard library calls instead?
         mail = Mail.new do
           from     opts[:from]
           to       opts[:to]
-          subject  m_subject
+          subject  opts[:subject]
           reply_to opts[:from]
 
           text_part do
-            body text_template.result(binding)
+            body text_template.result(bnd)
           end
 
           html_part do

data/lib/flapjack/version.rb

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
 
 module Flapjack
-  VERSION = "0.7.5"
+  VERSION = "0.7.6"
 end

data/spec/lib/flapjack/gateways/email_spec.rb

@@ -1,6 +1,47 @@
 require 'spec_helper'
 require 'flapjack/gateways/email'
 
-describe Flapjack::Gateways::Email do
+describe Flapjack::Gateways::Email, :logger => true do
+
+  before(:each) do
+    Flapjack::Gateways::Email.instance_variable_set('@config', {})
+    Flapjack::Gateways::Email.instance_variable_set('@logger', @logger)
+    Flapjack::Gateways::Email.start
+  end
+
+  it "sends a mail with text and html parts" do
+    email = mock('email')
+
+    entity_check = mock(Flapjack::Data::EntityCheck)
+    entity_check.should_receive(:in_scheduled_maintenance?).and_return(false)
+    entity_check.should_receive(:in_unscheduled_maintenance?).and_return(false)
+
+    redis = mock('redis')
+    ::Resque.should_receive(:redis).and_return(redis)
+
+    Flapjack::Data::EntityCheck.should_receive(:for_event_id).
+      with('example.com:ping', :redis => redis).and_return(entity_check)
+
+    # TODO better checking of what gets passed here
+    EM::P::SmtpClient.should_receive(:send).with(
+      hash_including(:host    => 'localhost',
+                     :port    => 25)).and_return(email)
+
+    response = mock(response)
+    response.should_receive(:"respond_to?").with(:code).and_return(true)
+    response.should_receive(:code).and_return(250)
+
+    EM::Synchrony.should_receive(:sync).with(email).and_return(response)
+
+    notification = {'notification_type'   => 'recovery',
+                    'contact_first_name'  => 'John',
+                    'contact_last_name'   => 'Smith',
+                    'state'               => 'ok',
+                    'summary'             => 'smile',
+                    'time'                => Time.now.to_i,
+                    'event_id'            => 'example.com:ping'}
+
+    Flapjack::Gateways::Email.perform(notification)
+  end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flapjack
 version: !ruby/object:Gem::Version
-  version: 0.7.5
+  version: 0.7.6
   prerelease: 
 platform: ruby
 authors:
@@ -553,7 +553,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4158008018986153398
+      hash: -549406373323108870
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -562,7 +562,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 4158008018986153398
+      hash: -549406373323108870
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23