flapjack 1.6.0rc1 → 1.6.0rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1a5aa06a9caf7b8c5b81d7b5b5245f8b623cda1b
-  data.tar.gz: 5d10f49f09e6ab9e87da21537d80add6409708a8
+  metadata.gz: 77cf774d68b395a3d2c146b884788e5e71020479
+  data.tar.gz: 14de90365627b2362a59e6e0249861c4a070fc5c
 SHA512:
-  metadata.gz: e4d57fdb2ee84f2a56118808d390fcea5087ca7b68c36c4588d8a352d490d98cccba536509606189524515800fd0b559a6b30dfeb2ab7ccc552a035dad5cd9a5
-  data.tar.gz: fe92aeefa1f66b21d690d7902f775b175a1d95fc09ae601107bd8aad5fbcfe28d784be65f561387b7c5192c87f45b4d9b52e8457cd935b226606c14f37b73dcf
+  metadata.gz: ef929d2621508fde4072e9b3d66e1139315d581ed2e8304b503fe6e95b8669c82127ce9561e1ceea989b26686d015086a0a213d703341f3d81bf246b08cf87b0
+  data.tar.gz: 85d21013929b673fc3ca4e0b991c2c6decaec14b7819bd0e19f61186073a3382f0f3b698d2e91f37decdbed0344d3bfb08eeb9ffed3e2be8853dc9ac3093a176

data/CHANGELOG.md

@@ -1,6 +1,10 @@
 ## Flapjack Changelog
 
-# 1.6.0 - 2015-05-13
+# 1.6.0rc2 - 2015-05-14
+- Bug: Fix SNS query encoding and subject length #867 (@ali-graham, @xcxsxvx)
+- Chore: improve debug logging in pagerduty when looking for acks e44abd5 (@jessereynolds)
+
+# 1.6.0rc1 - 2015-05-13
 - Feature: use token authentication for pagerduty gateway #831 (@alperkokmen)
 - Feature: expose failure delays in web UI #849 (@jessereynolds)
 - Bug: performance improvement - fix usage of KEYS command for entity check names c57d3a5 (@ali-graham)

data/lib/flapjack/gateways/aws_sns.rb

@@ -66,7 +66,11 @@ module Flapjack
         notification_id = alert.notification_id
         message_type    = alert.rollup ? 'rollup' : 'alert'
 
-        sms_template_erb, sms_template =
+        aws_sns_subject_template_erb, aws_sns_subject_template =
+          load_template(@config['templates'], "#{message_type}_subject",
+                        'text', File.join(File.dirname(__FILE__), 'aws_sns'))
+
+        aws_sns_template_erb, aws_sns_template =
           load_template(@config['templates'], message_type, 'text',
                         File.join(File.dirname(__FILE__), 'aws_sns'))
 
@@ -74,10 +78,14 @@ module Flapjack
         bnd     = binding
 
         begin
-          message = sms_template_erb.result(bnd).chomp
+          erb_to_be_executed = aws_sns_subject_template
+          subject = aws_sns_subject_template_erb.result(bnd).chomp
+
+          erb_to_be_executed = aws_sns_template
+          message = aws_sns_template_erb.result(bnd).chomp
         rescue => e
-          @logger.error "Error while executing the ERB for an sms: " +
-            "ERB being executed: #{sms_template}"
+          @logger.error "Error while executing the ERB for an AWS SNS message: " +
+            "ERB being executed: #{erb_to_be_executed}"
           raise
         end
 
@@ -102,7 +110,8 @@ module Flapjack
           return
         end
 
-        query = {'Subject'          => message,
+        query = {'Subject'          => (subject.length > 100) ?
+                                       subject[0..99].gsub(/...$/, '...') : subject,
                  'TopicArn'         => address,
                  'Message'          => message,
                  'Action'           => 'Publish',
@@ -142,12 +151,18 @@ module Flapjack
       end
 
       def self.string_to_sign(method, host, uri, query)
-        query = query.sort_by { |key, value| key }
+        @safe_re ||= Regexp.new("[^#{URI::PATTERN::UNRESERVED}]")
+
+        # we should possibly escape the keys as well, but they are less
+        # likely to have problematic characters
+        encoded_query = query.keys.sort.collect {|key|
+          "#{key}=#{URI.escape(query[key].to_s, @safe_re)}"
+        }.join("&")
 
         [method.upcase,
          host.downcase,
          uri,
-         URI.encode_www_form(query)
+         encoded_query
         ].join("\n")
       end
 

data/lib/flapjack/gateways/aws_sns/alert_subject.text.erb

@@ -0,0 +1,4 @@
+<%= @alert.type_sentence_case %>: '<%= @alert.check %>' on <%= @alert.entity -%>
+<% unless ['acknowledgement', 'test'].include?(@alert.notification_type) -%>
+ is <%= @alert.state_title_case -%>
+<% end -%>

data/lib/flapjack/gateways/aws_sns/rollup_subject.text.erb

@@ -0,0 +1 @@
+<%= @alert.type_sentence_case %>: <%= @alert.rollup_states_summary -%>

data/lib/flapjack/gateways/pagerduty.rb

@@ -174,11 +174,16 @@ module Flapjack
       end
 
       def find_pagerduty_acknowledgements
-        @logger.debug("looking for acks in pagerduty for unack'd problems")
-
         unacknowledged_failing_checks = Flapjack::Data::EntityCheck.unacknowledged_failing(:redis => @redis)
+        if unacknowledged_failing_checks.empty?
+          @logger.debug("skipping looking for acks in pagerduty as there are no unacknowledged failing checks")
+          return nil
+        else
+          @logger.debug("looking for acks in pagerduty for unack'd problems")
+        end
 
-        @logger.debug "found unacknowledged failing checks as follows: " + unacknowledged_failing_checks.join(', ')
+        @logger.debug "found #{unacknowledged_failing_checks.length} unacknowledged failing checks as follows: " +
+          unacknowledged_failing_checks.map {|c| "#{c.entity_name}:#{c.check}"}.join(', ')
 
         unacknowledged_failing_checks.each do |entity_check|
 

data/lib/flapjack/version.rb

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

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

@@ -53,6 +53,28 @@ describe Flapjack::Gateways::AwsSns, :logger => true do
     expect(req).to have_been_requested
   end
 
+  it 'truncates an overly long subject when sending' do
+    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',
+                                     'Subject'          => "Recovery: '#{'1234567890' * 8}123456..."})).
+      to_return(:status => 200)
+
+    EM.synchrony do
+      expect(Flapjack::RedisPool).to receive(:new).and_return(redis)
+
+      long_event_id = "example.com:#{'1234567890' * 10}"
+      alert = Flapjack::Data::Alert.new(message.merge('event_id' => long_event_id), :logger => @logger)
+      aws_sns = Flapjack::Gateways::AwsSns.new(:config => config, :logger => @logger)
+      aws_sns.deliver(alert)
+      EM.stop
+    end
+    expect(req).to have_been_requested
+  end
+
   it "does not send an SMS message with an invalid config" do
     EM.synchrony do
       expect(Flapjack::RedisPool).to receive(:new).and_return(redis)
@@ -75,7 +97,8 @@ describe Flapjack::Gateways::AwsSns, :logger => true do
     let(:uri) { '/' }
 
     let(:query) { {'TopicArn' => 'HelloWorld',
-                  'Action' => 'Publish'} }
+                   'Action' => 'Publish',
+                   'Message' => 'Hello World'} }
 
     let(:string_to_sign) { Flapjack::Gateways::AwsSns.string_to_sign(method, host, uri, query) }
 
@@ -94,7 +117,7 @@ describe Flapjack::Gateways::AwsSns, :logger => true do
     end
 
     it 'should put the encoded, sorted query-string on the fourth line' do
-      expect(lines[3]).to eq("Action=Publish&TopicArn=HelloWorld")
+      expect(lines[3]).to eq("Action=Publish&Message=Hello%20World&TopicArn=HelloWorld")
     end
 
   end

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

@@ -142,9 +142,9 @@ describe Flapjack::Gateways::Pagerduty, :logger => true do
     })
 
     entity_check = double('entity_check')
-    expect(entity_check).to receive(:check).exactly(1).times.and_return('PING')
+    expect(entity_check).to receive(:check).exactly(2).times.and_return('PING')
     expect(entity_check).to receive(:contacts).and_return([contact])
-    expect(entity_check).to receive(:entity_name).exactly(1).times.and_return('foo-app-01.bar.net')
+    expect(entity_check).to receive(:entity_name).exactly(2).times.and_return('foo-app-01.bar.net')
     expect(entity_check).to receive(:in_unscheduled_maintenance?).exactly(1).times.and_return(false)
     expect(entity_check).to receive(:failed?).exactly(1).times.and_return(true)
     expect(Flapjack::Data::Event).to receive(:create_acknowledgement).with('foo-app-01.bar.net', 'PING',

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flapjack
 version: !ruby/object:Gem::Version
-  version: 1.6.0rc1
+  version: 1.6.0rc2
 platform: ruby
 authors:
 - Lindsay Holmwood
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-13 00:00:00.000000000 Z
+date: 2015-05-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dante
@@ -442,7 +442,9 @@ files:
 - lib/flapjack/filters/unscheduled_maintenance.rb
 - lib/flapjack/gateways/aws_sns.rb
 - lib/flapjack/gateways/aws_sns/alert.text.erb
+- lib/flapjack/gateways/aws_sns/alert_subject.text.erb
 - lib/flapjack/gateways/aws_sns/rollup.text.erb
+- lib/flapjack/gateways/aws_sns/rollup_subject.text.erb
 - lib/flapjack/gateways/email.rb
 - lib/flapjack/gateways/email/alert.html.erb
 - lib/flapjack/gateways/email/alert.text.erb