flapjack 1.6.0rc3 → 1.6.0rc4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5a219d75b1878de449c0a2735258b2962516b75b
-  data.tar.gz: 66d8c984b4204482680ffeaa711f540ab60c4297
+  metadata.gz: ebb781f375968f6795459525d4eb476949f19905
+  data.tar.gz: 8b942f1c504d9bdd0ea8e3460c217c0fa1fc7167
 SHA512:
-  metadata.gz: bb07615b716a155706165d2bec88ec020df60602ef75e45ae8c5911aca3032dc1e1b3198d7a9e972614ea166cc04adfc43d6fe3e94739594e74ad159d43c9912
-  data.tar.gz: 877f7c37d41c7068799a26012463f254b15c3bd1698ee66eca186f09a4ad317de6f9bf0cbfb446620f586bff2d088a8a9b68cf5c6e817207affd20ed10543d0d
+  metadata.gz: f73ba9354de97136e8b49e9980e83e49687c4007b7881583e34a48ad9d252277c27b2c3c205c6f1c115647509b5b4161d0720ce9c6a403cb8db23d98f1b963b1
+  data.tar.gz: f6d5980dbd819dac313aaa7b1faaabaae3eb682ce88cc0aab05f17a0c09d030b00121703b20d3584d100a893c776112feee6bc281b73be872db51611d1eb26ba

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 ## Flapjack Changelog
 
+# 1.6.0rc4 - 2015-07-09
+- Feature: slack webhook gateway #881 (@mcqueenorama, @ali-graham)
+- Bug: sns gateway debugging and improvements (but still broken) #879 (@ali-graham, @jessereynolds)
+
+## Notes:
+- the SNS gateway signature calculation has been broken since v1.5.0 or earlier. See [#829](https://github.com/flapjack/flapjack/issues/829)
+
 # 1.6.0rc3 - 2015-06-15
 - Chore/Bug?: SNS gateway improvements (@ali-graham)
 - Feature: add summary to rollup alerts #869 (@necula-01)

data/etc/flapjack_config.yaml.example

@@ -40,6 +40,7 @@ production:
     email_queue: email_notifications
     sms_queue: sms_notifications
     sms_nexmo_queue: sms_nexmo_notifications
+    slack_queue: slack_notifications
     sms_twilio_queue: sms_twilio_notifications
     sns_queue: sns_notifications
     jabber_queue: jabber_notifications
@@ -102,6 +103,21 @@ production:
       #templates:
       #  rollup.text: '/etc/flapjack/templates/sms/rollup.text.erb'
       #  alert.text: '/etc/flapjack/templates/sms/alert.text.erb'
+    # Sends notifications via Slack
+    slack:
+      enabled: no
+      queue: slack_notifications
+      account_sid: "webhookbot"
+      endpoint: "https://hooks.slack.com/services/xxx/yyy/"
+      auth_token: "zzzzz"
+      from: ""
+      logger:
+        level: INFO
+        syslog_errors: yes
+      # location of custom alert templates
+      #templates:
+      #  rollup.text: '/etc/flapjack/templates/slack/rollup.text.erb'
+      #  alert.text: '/etc/flapjack/templates/slack/alert.text.erb'
     # Sends SMS notifications via Twilio
     sms_twilio:
       enabled: no
@@ -113,7 +129,6 @@ production:
         level: INFO
         syslog_errors: yes
       # location of custom alert templates
-      # location of custom alert templates
       #templates:
       #  rollup.text: '/etc/flapjack/templates/sms_twilio/rollup.text.erb'
       #  alert.text: '/etc/flapjack/templates/sms_twilio/alert.text.erb'

data/lib/flapjack/data/contact.rb

@@ -24,6 +24,7 @@ module Flapjack
       ALL_MEDIA  = [
         'email',
         'sms',
+        'slack',
         'sms_twilio',
         'sms_nexmo',
         'jabber',
@@ -391,8 +392,8 @@ module Flapjack
         @redis.zadd("contact_alerting_checks:#{self.id}:media:#{media}", Time.now.to_i, event_id)
       end
 
-      def remove_alerting_check_for_media(media, check)
-        @redis.zrem("contact_alerting_checks:#{self.id}:media:#{media}", check)
+      def remove_alerting_check_for_media(media, event_id)
+        @redis.zrem("contact_alerting_checks:#{self.id}:media:#{media}", event_id)
       end
 
       # removes any checks that are in ok, scheduled or unscheduled maintenance,

data/lib/flapjack/gateways/aws_sns.rb

@@ -60,7 +60,7 @@ module Flapjack
         endpoint = "http://#{hostname}/"
         access_key = @config["access_key"]
         secret_key = @config["secret_key"]
-        timestamp = Time.at(alert.time).strftime('%Y-%m-%dT%H:%M:%SZ')
+        timestamp = Time.at(alert.time).utc.strftime('%Y-%m-%dT%H:%M:%SZ')
 
         address         = alert.address
         notification_id = alert.notification_id
@@ -145,7 +145,7 @@ module Flapjack
       end
 
       def self.get_signature(secret_key, string_to_sign)
-        signature = OpenSSL::HMAC.digest(OpenSSL::Digest.new('sha256'), secret_key, string_to_sign)
+        signature = OpenSSL::HMAC.digest('sha256', secret_key, string_to_sign)
 
         Base64.encode64(signature).strip
       end

data/lib/flapjack/gateways/slack.rb

@@ -0,0 +1,127 @@
+#!/usr/bin/env ruby
+
+require 'em-synchrony'
+require 'em-synchrony/em-http'
+require 'active_support/inflector'
+
+require 'flapjack/redis_pool'
+
+require 'flapjack/data/alert'
+require 'flapjack/utility'
+
+module Flapjack
+  module Gateways
+    class Slack
+
+      include Flapjack::Utility
+
+      def initialize(opts = {})
+        @config = opts[:config]
+        @logger = opts[:logger]
+        @redis_config = opts[:redis_config] || {}
+        @redis = Flapjack::RedisPool.new(:config => @redis_config, :size => 1, :logger => @logger)
+
+        @logger.info("starting")
+        @logger.debug("new slack gateway pikelet with the following options: #{@config.inspect}")
+
+        @sent = 0
+      end
+
+      def stop
+        @logger.info("stopping")
+        @should_quit = true
+
+        redis_uri = @redis_config[:path] ||
+          "redis://#{@redis_config[:host] || '127.0.0.1'}:#{@redis_config[:port] || '6379'}/#{@redis_config[:db] || '0'}"
+        shutdown_redis = EM::Hiredis.connect(redis_uri)
+        shutdown_redis.rpush(@config['queue'], Flapjack.dump_json('notification_type' => 'shutdown'))
+      end
+
+      def start
+        queue = @config['queue']
+
+        until @should_quit
+          begin
+            @logger.debug("slack gateway is going into blpop mode on #{queue}")
+            alert = Flapjack::Data::Alert.next(queue, :redis => @redis, :logger => @logger)
+            deliver(alert) unless alert.nil?
+          rescue => e
+            @logger.error "Error generating or dispatching Slack message: #{e.class}: #{e.message}\n" +
+              e.backtrace.join("\n")
+          end
+        end
+      end
+
+      def deliver(alert)
+        account_sid = @config["account_sid"]
+        endpoint    = @config["endpoint"]
+        icon_emoji  = @config["icon_emoji"] || ':ghost:'
+
+        channel         = "##{alert.address}"
+        channel         = '#general' if (channel.size == 1)
+        notification_id = alert.notification_id
+        message_type    = alert.rollup ? 'rollup' : 'alert'
+
+        slack_template_erb, slack_template =
+          load_template(@config['templates'], message_type, 'text',
+                        File.join(File.dirname(__FILE__), 'slack'))
+
+        @alert  = alert
+        bnd     = binding
+
+        begin
+          message = slack_template_erb.result(bnd).chomp
+        rescue => e
+          @logger.error "Error while executing the ERB for an sms: " +
+            "ERB being executed: #{slack_template}"
+          raise
+        end
+
+        errors = []
+
+        [
+         [endpoint, "Slack endpoint is missing"],
+         [account_sid, "Slack account_sid is missing"]
+        ].each do |val_err|
+
+          next unless val_err.first.nil? || (val_err.first.respond_to?(:empty?) && val_err.first.empty?)
+          errors << val_err.last
+        end
+
+        unless errors.empty?
+          errors.each {|err| @logger.error err }
+          return
+        end
+
+        payload = Flapjack.dump_json(
+          'channel'    => channel,
+          'username'   => account_sid,
+          'text'       => message,
+          'icon_emoji' => icon_emoji
+        )
+        @logger.debug "payload: #{payload.inspect}"
+
+        http = EM::HttpRequest.new("#{endpoint}").post(:body => {'payload' => payload})
+
+        @logger.debug "server response: #{http.response}"
+
+        status = (http.nil? || http.response_header.nil?) ? nil : http.response_header.status
+        if (status >= 200) && (status <= 206)
+          @sent += 1
+          alert.record_send_success!
+          @logger.debug "Sent message via Slack, response status is #{status}, " +
+            "notification_id: #{notification_id}"
+        else
+          @logger.error "Failed to send message via Slack, response status is #{status}, " +
+            "notification_id: #{notification_id}"
+        end
+      rescue => e
+        @logger.error "Error generating or delivering sms to #{alert.address}: #{e.class}: #{e.message}"
+        @logger.error e.backtrace.join("\n")
+        raise
+      end
+
+    end
+  end
+end
+

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

@@ -0,0 +1,6 @@
+<% summary = @alert.summary -%>
+<%= @alert.type_sentence_case %>: '<%= @alert.check %>' on <%= @alert.entity -%>
+<% unless ['acknowledgement', 'test'].include?(@alert.notification_type) -%>
+ is <%= @alert.state_title_case -%>
+<% end -%>
+ at <%= Time.at(@alert.time).strftime('%-d %b %H:%M') %><%= (summary.nil? || summary.empty?) ? '' : ", #{summary}" -%>

data/lib/flapjack/gateways/slack/rollup.text.erb

@@ -0,0 +1,2 @@
+<%= @alert.type_sentence_case %>: <%= @alert.rollup_states_summary -%>
+ (<%= @alert.rollup_states_detail_text(:max_checks_per_state => 3) -%>)

data/lib/flapjack/gateways/web/public/js/modules/contact.js

@@ -279,7 +279,7 @@
     initialize: function(options) {
       var context = this;
 
-      _.each(['email', 'sms', 'sms_twilio', 'sms_nexmo', 'sns', 'jabber'], function(type) {
+      _.each(['email', 'sms', 'slack', 'sms_twilio', 'sms_nexmo', 'sns', 'jabber'], function(type) {
         var medium = context.collection.find(function(cm) {
           return cm.get('type') == type;
         });
@@ -334,6 +334,7 @@
       template_values['labels'] = {
         'email'      : 'Email',
         'sms'        : 'SMS (MessageNet)',
+        'slack'      : 'Slack',
         'sms_twilio' : 'SMS (Twilio)',
         'sms_nexmo'  : 'SMS (Nexmo)',
         'sns'        : 'SMS (Amazon SNS)',

data/lib/flapjack/notifier.rb

@@ -15,6 +15,7 @@ require 'flapjack/utility'
 
 require 'flapjack/gateways/email'
 require 'flapjack/gateways/sms_messagenet'
+require 'flapjack/gateways/slack'
 require 'flapjack/gateways/sms_twilio'
 require 'flapjack/gateways/sms_nexmo'
 require 'flapjack/gateways/aws_sns'

data/lib/flapjack/pikelet.rb

@@ -23,6 +23,7 @@ require 'flapjack/gateways/oobetet'
 require 'flapjack/gateways/pagerduty'
 require 'flapjack/gateways/email'
 require 'flapjack/gateways/sms_messagenet'
+require 'flapjack/gateways/slack'
 require 'flapjack/gateways/sms_twilio'
 require 'flapjack/gateways/sms_nexmo'
 require 'flapjack/gateways/aws_sns'
@@ -104,6 +105,7 @@ module Flapjack
                       'oobetet'    => Flapjack::Gateways::Oobetet,
                       'email'      => Flapjack::Gateways::Email,
                       'sms'        => Flapjack::Gateways::SmsMessagenet,
+                      'slack'      => Flapjack::Gateways::Slack,
                       'sms_twilio' => Flapjack::Gateways::SmsTwilio,
                       'sms_nexmo'  => Flapjack::Gateways::SmsNexmo,
                       'sns'        => Flapjack::Gateways::AwsSns}

data/lib/flapjack/version.rb

@@ -1,5 +1,5 @@
 #!/usr/bin/env ruby
 
 module Flapjack
-  VERSION = "1.6.0rc3"
+  VERSION = "1.6.0rc4"
 end

data/spec/lib/flapjack/data/contact_spec.rb

@@ -22,8 +22,8 @@ describe Flapjack::Data::Contact, :redis => true do
      :tags               => Set.new([]),
      :time_restrictions  => [],
      :unknown_media      => [],
-     :warning_media      => ['email', 'sms', 'sms_twilio', 'sms_nexmo', 'jabber', 'pagerduty', 'sns'],
-     :critical_media     => ['email', 'sms', 'sms_twilio', 'sms_nexmo', 'jabber', 'pagerduty', 'sns'],
+     :warning_media      => ['email', 'sms', 'slack', 'sms_twilio', 'sms_nexmo', 'jabber', 'pagerduty', 'sns'],
+     :critical_media     => ['email', 'sms', 'slack', 'sms_twilio', 'sms_nexmo', 'jabber', 'pagerduty', 'sns'],
      :unknown_blackhole  => false,
      :warning_blackhole  => false,
      :critical_blackhole => false}

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

@@ -7,9 +7,9 @@ describe Flapjack::Gateways::AwsSns, :logger => true do
 
   let(:redis) { double('redis') }
 
-  let(:time) { Time.new(2013, 10, 31, 13, 45) }
+  let(:time_int) { 1383252300 }
 
-  let(:time_str) { Time.at(time.to_i).strftime('%Y-%m-%dT%H:%M:%SZ') }
+  let(:time_str) { '2013-10-31T20:45:00Z' }
 
   let(:config) { {'region' => 'us-east-1',
                   'access_key' => 'AKIAIOSFODNN7EXAMPLE',
@@ -24,7 +24,7 @@ describe Flapjack::Gateways::AwsSns, :logger => true do
                    'summary'            => 'smile',
                    'last_state'         => 'problem',
                    'last_summary'       => 'frown',
-                   'time'               => time.to_i,
+                   'time'               => time_int,
                    'address'            => 'arn:aws:sns:us-east-1:698519295917:My-Topic',
                    'event_id'           => 'example.com:ping',
                    'id'                 => '123456789',
@@ -34,13 +34,21 @@ describe Flapjack::Gateways::AwsSns, :logger => true do
                 }
 
   it "sends an SMS message" do
+    # bad, bad, bad...
+    t = double('time')
+    ut  = double('utc_time')
+    expect(ut).to receive(:strftime).with('%Y-%m-%dT%H:%M:%SZ').and_return(time_str)
+    expect(t).to receive(:utc).and_return(ut)
+    expect(t).to receive(:strftime).with('%-d %b %H:%M').and_return('31 Oct 20:45')
+    expect(Time).to receive(:at).with(time_int).twice.and_return(t)
+
     req = stub_request(:post, "http://sns.us-east-1.amazonaws.com/").
       with(:query => hash_including({'Action'           => 'Publish',
                                      'AWSAccessKeyId'   => config['access_key'],
                                      'TopicArn'         => message['address'],
                                      'SignatureVersion' => '2',
                                      'SignatureMethod'  => 'HmacSHA256',
-                                     'Signature'        => 'gxoUQ8qUYBQbqgf3XmbiSPZ8qTJZ9WyC81EKc67FY0g=',
+                                     'Signature'        => '5fWqhmDrZQkQfP7wsxWDdQjzV0BLwm6cZNrNqZ+W/ok=',
                                      'Timestamp'        => time_str})).
       to_return(:status => 200)
 

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

@@ -0,0 +1,71 @@
+require 'spec_helper'
+require 'flapjack/gateways/slack'
+
+describe Flapjack::Gateways::Slack, :logger => true do
+
+  let(:lock) { double(Monitor) }
+
+  let(:redis) { double('redis') }
+
+  let(:config) { {'account_sid' => 'flapslack',
+                  'endpoint'    => 'https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX'
+                 }
+               }
+
+  let(:time) { Time.new(2013, 10, 31, 13, 45) }
+
+  let(:time_str) { Time.at(time).strftime('%-d %b %H:%M') }
+
+  let(:message) { {'notification_type'  => 'recovery',
+                   'contact_first_name' => 'John',
+                   'contact_last_name'  => 'Smith',
+                   'state'              => 'ok',
+                   'summary'            => 'smile',
+                   'last_state'         => 'problem',
+                   'last_summary'       => 'frown',
+                   'time'               => time.to_i,
+                   'address'            => 'general',
+                   'event_id'           => 'example.com:ping',
+                   'id'                 => '123456789',
+                   'duration'           => 55,
+                   'state_duration'     => 23
+                  }
+                }
+
+  it "sends a Slack message" do
+    payload_json = Flapjack.dump_json(
+      'channel'    => '#general',
+      'username'   => 'flapslack',
+      'text'       => "Recovery: 'ping' on example.com is OK at #{time_str}, smile",
+      'icon_emoji' => ':ghost:'
+    )
+
+    req = stub_request(:post, config['endpoint']).
+      with(:body => {'payload' => payload_json}).
+      to_return(:status => 200)
+
+    EM.synchrony do
+      expect(Flapjack::RedisPool).to receive(:new).and_return(redis)
+
+      alert = Flapjack::Data::Alert.new(message, :logger => @logger)
+      slack = Flapjack::Gateways::Slack.new(:config => config, :logger => @logger)
+      slack.deliver(alert)
+      EM.stop
+    end
+    expect(req).to have_been_requested
+  end
+
+  it "does not send a Slack message with an invalid config" do
+    EM.synchrony do
+      expect(Flapjack::RedisPool).to receive(:new).and_return(redis)
+
+      alert = Flapjack::Data::Alert.new(message, :logger => @logger)
+      slack = Flapjack::Gateways::Slack.new(:config => config.reject {|k, v| k == 'endpoint'}, :logger => @logger)
+      slack.deliver(alert)
+      EM.stop
+    end
+
+    expect(WebMock).not_to have_requested(:post, config['endpoint'])
+  end
+
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flapjack
 version: !ruby/object:Gem::Version
-  version: 1.6.0rc3
+  version: 1.6.0rc4
 platform: ruby
 authors:
 - Lindsay Holmwood
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-15 00:00:00.000000000 Z
+date: 2015-07-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dante
@@ -469,6 +469,9 @@ files:
 - lib/flapjack/gateways/oobetet.rb
 - lib/flapjack/gateways/pagerduty.rb
 - lib/flapjack/gateways/pagerduty/alert.text.erb
+- lib/flapjack/gateways/slack.rb
+- lib/flapjack/gateways/slack/alert.text.erb
+- lib/flapjack/gateways/slack/rollup.text.erb
 - lib/flapjack/gateways/sms_messagenet.rb
 - lib/flapjack/gateways/sms_messagenet/alert.text.erb
 - lib/flapjack/gateways/sms_messagenet/rollup.text.erb
@@ -576,6 +579,7 @@ files:
 - spec/lib/flapjack/gateways/jsonapi_spec.rb
 - spec/lib/flapjack/gateways/oobetet_spec.rb
 - spec/lib/flapjack/gateways/pagerduty_spec.rb
+- spec/lib/flapjack/gateways/slack_spec.rb
 - spec/lib/flapjack/gateways/sms_messagenet_spec.rb
 - spec/lib/flapjack/gateways/sms_nexmo_spec.rb
 - spec/lib/flapjack/gateways/sms_twilio_spec.rb
@@ -700,6 +704,7 @@ test_files:
 - spec/lib/flapjack/gateways/jsonapi_spec.rb
 - spec/lib/flapjack/gateways/oobetet_spec.rb
 - spec/lib/flapjack/gateways/pagerduty_spec.rb
+- spec/lib/flapjack/gateways/slack_spec.rb
 - spec/lib/flapjack/gateways/sms_messagenet_spec.rb
 - spec/lib/flapjack/gateways/sms_nexmo_spec.rb
 - spec/lib/flapjack/gateways/sms_twilio_spec.rb