flapjack 1.6.0rc2 → 1.6.0rc3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 77cf774d68b395a3d2c146b884788e5e71020479
-  data.tar.gz: 14de90365627b2362a59e6e0249861c4a070fc5c
+  metadata.gz: 5a219d75b1878de449c0a2735258b2962516b75b
+  data.tar.gz: 66d8c984b4204482680ffeaa711f540ab60c4297
 SHA512:
-  metadata.gz: ef929d2621508fde4072e9b3d66e1139315d581ed2e8304b503fe6e95b8669c82127ce9561e1ceea989b26686d015086a0a213d703341f3d81bf246b08cf87b0
-  data.tar.gz: 85d21013929b673fc3ca4e0b991c2c6decaec14b7819bd0e19f61186073a3382f0f3b698d2e91f37decdbed0344d3bfb08eeb9ffed3e2be8853dc9ac3093a176
+  metadata.gz: bb07615b716a155706165d2bec88ec020df60602ef75e45ae8c5911aca3032dc1e1b3198d7a9e972614ea166cc04adfc43d6fe3e94739594e74ad159d43c9912
+  data.tar.gz: 877f7c37d41c7068799a26012463f254b15c3bd1698ee66eca186f09a4ad317de6f9bf0cbfb446620f586bff2d088a8a9b68cf5c6e817207affd20ed10543d0d

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## Flapjack Changelog
 
+# 1.6.0rc3 - 2015-06-15
+- Chore/Bug?: SNS gateway improvements (@ali-graham)
+- Feature: add summary to rollup alerts #869 (@necula-01)
+- Bug: Fix notification rule regex matches #871 (@necula-01)
+
 # 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)

data/lib/flapjack/data/entity_check.rb

@@ -933,7 +933,10 @@ module Flapjack
         if @ack_hash.nil?
           sha1 = Digest::SHA1.new
           @ack_hash = Digest.hexencode(sha1.digest(@key))[0..7].downcase
-          @redis.hset("checks_by_hash", @ack_hash, @key)
+          @redis.multi do |r|
+            r.hset("checks_by_hash", @ack_hash, @key)
+            r.hset("check_hashes_by_id", @key, @ack_hash)
+          end
         end
         @ack_hash
       end

data/lib/flapjack/data/notification_rule.rb

@@ -121,37 +121,39 @@ module Flapjack
         Flapjack.dump_json(json_data)
       end
 
-      # entity names match?
+      # If the rule has any entities, then one of them must match the event's entity
       def match_entity?(event_id)
-        return false unless @entities
-        @entities.include?(event_id.split(':').first)
+        return true unless @entities && @entities.length > 0
+        event_entity = event_id.split(':').first
+        @entities.include?(event_entity)
       end
 
-      # entity names match regex?
+      # If the rule has any regex_entities, then all of them must match the
+      # event's entity
       def match_regex_entities?(event_id)
-        return false unless @regex_entities && @regex_entities.length > 0
-        entity = event_id.split(':').first
+        return true unless @regex_entities && @regex_entities.length > 0
+        event_entity = event_id.split(':').first
         matches = 0
         @regex_entities.each do |regex_entity|
-          matches += 1 if /#{regex_entity}/ === entity
+          matches += 1 if /#{regex_entity}/ === event_entity
         end
         matches >= @regex_entities.length
       end
 
-      # tags match?
+      # If the rule has any tags, then they must all be present in the
+      # event's tags
       def match_tags?(event_tags)
-        return false unless @tags && @tags.length > 0
+        return true unless @tags && @tags.length > 0
         @tags.subset?(event_tags)
       end
 
-      # regex_tags match?
+      # If the rule has any regex_tags, then they must all match at least
+      # one of the event's tags
       def match_regex_tags?(event_tags)
-        return false unless @regex_tags && @regex_tags.length > 0
+        return true unless @regex_tags && @regex_tags.length > 0
         matches = 0
-        event_tags.each do |event_tag|
-          @regex_tags.each do |regex_tag|
-            matches += 1 if /#{regex_tag}/ === event_tag
-          end
+        @regex_tags.each do |regex_tag|
+          matches += 1 if event_tags.any? { |event_tag| /#{regex_tag}/ === event_tag }
         end
         matches >= @regex_tags.length
       end

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 = @config["timestamp"] || DateTime.now.iso8601
+        timestamp = Time.at(alert.time).strftime('%Y-%m-%dT%H:%M:%SZ')
 
         address         = alert.address
         notification_id = alert.notification_id
@@ -118,7 +118,7 @@ module Flapjack
                  'SignatureVersion' => 2,
                  'SignatureMethod'  => 'HmacSHA256',
                  'Timestamp'        => timestamp,
-                 'AWSAccessKeyId'   => access_key}
+                 'AWSAccessKeyId'   => access_key.upcase}
 
         string_to_sign = self.class.string_to_sign('POST', hostname, "/", query)
 
@@ -145,7 +145,7 @@ module Flapjack
       end
 
       def self.get_signature(secret_key, string_to_sign)
-        signature = OpenSSL::HMAC.digest('sha256', secret_key, string_to_sign)
+        signature = OpenSSL::HMAC.digest(OpenSSL::Digest.new('sha256'), secret_key, string_to_sign)
 
         Base64.encode64(signature).strip
       end
@@ -153,10 +153,8 @@ module Flapjack
       def self.string_to_sign(method, host, uri, query)
         @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)}"
+          "#{URI.escape(key, @safe_re)}=#{URI.escape(query[key].to_s, @safe_re)}"
         }.join("&")
 
         [method.upcase,

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

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

data/lib/flapjack/gateways/email/rollup.html.erb

@@ -22,16 +22,19 @@
       <th>Entity</th>
       <th>State</th>
       <th>Duration</th>
+      <th>Summary</th>
     </tr>
 <%  @alert.rollup_alerts.sort_by {|entity_check, details| details['duration'] }.each do |rollup_alert| -%>
 <%    r_entity, r_check = rollup_alert[0].split(':', 2) -%>
 <%    state    = rollup_alert[1]['state'] -%>
 <%    duration = (ChronicDuration.output(rollup_alert[1]['duration'], :keep_zero => true) || '0 secs') -%>
+<%    summary = rollup_alert[1]['summary'] -%>
       <tr>
         <td><%= r_check %></td>
         <td><%= r_entity %></td>
         <td><%= ['ok'].include?(state) ? state.upcase : state.titleize %></td>
         <td><%= duration %></td>
+        <td><%= summary %></td>
       </tr>
 <%    end %>
   </tbody>

data/lib/flapjack/notifier.rb

@@ -119,7 +119,8 @@ module Flapjack
             last_change = ec.last_change
             memo[alert] = {
               'duration' => last_change ? (Time.now.to_i - last_change) : nil,
-              'state'    => ec.state
+              'state'    => ec.state,
+              'summary'  => ec.summary
             }
             memo
           end

data/lib/flapjack/version.rb

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

data/spec/lib/flapjack/data/notification_rule_spec.rb

@@ -16,7 +16,23 @@ describe Flapjack::Data::NotificationRule, :redis => true do
     {:contact_id         => '23',
      :tags               => ["database","physical"],
      :regex_tags         => [],
-     :entities           => ["foo-app-01.example.com"],
+     :entities           => ["foo-app-01.example.com", "foo-app-10.example.com"],
+     :regex_entities     => [],
+     :time_restrictions  => [ weekdays_8_18 ],
+     :unknown_media      => [],
+     :warning_media      => ["email"],
+     :critical_media     => ["sms", "email"],
+     :unknown_blackhole  => false,
+     :warning_blackhole  => false,
+     :critical_blackhole => false
+    }
+  }
+
+  let(:empty_rule_data) {
+    {:contact_id         => '23',
+     :tags               => [],
+     :regex_tags         => [],
+     :entities           => [],
      :regex_entities     => [],
      :time_restrictions  => [ weekdays_8_18 ],
      :unknown_media      => [],
@@ -33,7 +49,7 @@ describe Flapjack::Data::NotificationRule, :redis => true do
      :tags               => [],
      :regex_tags         => ["^data.*$","^(physical|bare_metal)$"],
      :entities           => [],
-     :regex_entities     => ["^foo-\S{3}-\d{2}.example.com$"],
+     :regex_entities     => ['^foo-\S{3}-\d{2}.example.com$','.*abc.*'],
      :time_restrictions  => [ weekdays_8_18 ],
      :unknown_media      => [],
      :warning_media      => ["email"],
@@ -52,6 +68,10 @@ describe Flapjack::Data::NotificationRule, :redis => true do
     Flapjack::Data::NotificationRule.add(rule_data, :redis => @redis)
   }
 
+  let(:existing_empty_rule) {
+    Flapjack::Data::NotificationRule.add(empty_rule_data, :redis => @redis)
+  }
+
   let(:existing_regex_rule) {
     Flapjack::Data::NotificationRule.add(regex_rule_data, :redis => @redis)
   }
@@ -100,25 +120,47 @@ describe Flapjack::Data::NotificationRule, :redis => true do
     rule = existing_rule
 
     expect(rule.match_entity?('foo-app-01.example.com')).to be true
+    expect(rule.match_entity?('foo-app-10.example.com')).to be true
     expect(rule.match_entity?('foo-app-02.example.com')).to be false
+
+    expect(existing_empty_rule.match_entity?('anything.example.com')).to be true
+  end
+
+  it "checks whether entity names match a regex" do
+    rule = existing_regex_rule
+
+    expect(rule.match_regex_entities?('foo-abc-01.example.com')).to be true
+    expect(rule.match_regex_entities?('foo-abc-99.example.com')).to be true
+    expect(rule.match_regex_entities?('foo-app-01.example.com')).to be false # does not match second regexp_entities
+    expect(rule.match_regex_entities?('foo-abc.example.com')).to be false
+    expect(rule.match_regex_entities?('bar-abc-01.example.com')).to be false
+
+    expect(existing_empty_rule.match_regex_entities?('anything.example.com')).to be true
   end
 
-  it "checks whether entity tags match" do
+  it "checks whether event tags match" do
     rule = existing_rule
 
     expect(rule.match_tags?(['database', 'physical'].to_set)).to be true
     expect(rule.match_tags?(['database', 'physical', 'beetroot'].to_set)).to be true
     expect(rule.match_tags?(['database'].to_set)).to be false
     expect(rule.match_tags?(['virtual'].to_set)).to be false
+    expect(rule.match_tags?([].to_set)).to be false
+
+    expect(existing_empty_rule.match_regex_entities?(['virtual'].to_set)).to be true
   end
 
-  it "checks whether entity tags match a regex" do
+  it "checks whether event tags match a regex" do
     rule = existing_regex_rule
 
     expect(rule.match_regex_tags?(['database', 'physical'].to_set)).to be true
     expect(rule.match_regex_tags?(['database', 'physical', 'beetroot'].to_set)).to be true
     expect(rule.match_regex_tags?(['database'].to_set)).to be false
+    expect(rule.match_regex_tags?(['database.physical'].to_set)).to be false # does not match second regex_tags
+    expect(rule.match_regex_tags?(['data1', 'data2'].to_set)).to be false # does not match second regex_tags
     expect(rule.match_regex_tags?(['virtual'].to_set)).to be false
+
+    expect(existing_empty_rule.match_regex_entities?(['virtual'].to_set)).to be true
   end
 
   it "checks if blackhole settings for a rule match a severity level" do

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

@@ -9,7 +9,7 @@ describe Flapjack::Gateways::AwsSns, :logger => true do
 
   let(:time) { Time.new(2013, 10, 31, 13, 45) }
 
-  let(:time_str) { Time.at(time).strftime('%-d %b %H:%M') }
+  let(:time_str) { Time.at(time.to_i).strftime('%Y-%m-%dT%H:%M:%SZ') }
 
   let(:config) { {'region' => 'us-east-1',
                   'access_key' => 'AKIAIOSFODNN7EXAMPLE',
@@ -39,7 +39,9 @@ describe Flapjack::Gateways::AwsSns, :logger => true do
                                      'AWSAccessKeyId'   => config['access_key'],
                                      'TopicArn'         => message['address'],
                                      'SignatureVersion' => '2',
-                                     'SignatureMethod'  => 'HmacSHA256'})).
+                                     'SignatureMethod'  => 'HmacSHA256',
+                                     'Signature'        => 'gxoUQ8qUYBQbqgf3XmbiSPZ8qTJZ9WyC81EKc67FY0g=',
+                                     'Timestamp'        => time_str})).
       to_return(:status => 200)
 
     EM.synchrony do
@@ -98,7 +100,7 @@ describe Flapjack::Gateways::AwsSns, :logger => true do
 
     let(:query) { {'TopicArn' => 'HelloWorld',
                    'Action' => 'Publish',
-                   'Message' => 'Hello World'} }
+                   'Message' => 'Hello ~ World'} }
 
     let(:string_to_sign) { Flapjack::Gateways::AwsSns.string_to_sign(method, host, uri, query) }
 
@@ -117,7 +119,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&Message=Hello%20World&TopicArn=HelloWorld")
+      expect(lines[3]).to eq("Action=Publish&Message=Hello%20~%20World&TopicArn=HelloWorld")
     end
 
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: flapjack
 version: !ruby/object:Gem::Version
-  version: 1.6.0rc2
+  version: 1.6.0rc3
 platform: ruby
 authors:
 - Lindsay Holmwood
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-14 00:00:00.000000000 Z
+date: 2015-06-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dante