flapjack_configurator 1.0.0

data/spec/functional/configuration_contact_notification_media_spec.rb

@@ -0,0 +1,73 @@
+require_relative '../spec_helper.rb'
+require_relative 'config_test_common.rb'
+
+TestCommon.setup_config_test('notification_media') do |rspec_obj, test_config|
+  # Table defining which media attributes should be used for each test contact
+  test_attr_table = {
+    nmt_baseline_inheritence:
+      { pagerduty: { subdomain: :baseline, token: :baseline, service_key: :baseline },
+        email:     { interval: :baseline, rollup_threshold: :baseline, address: :baseline },
+        jabber:    { interval: :baseline, rollup_threshold: :baseline, address: :baseline } },
+    nmt_default_partial_inheritance:
+      { pagerduty: { subdomain: :defaults, token: :baseline, service_key: :baseline },
+        email:     { interval: :defaults, rollup_threshold: :baseline, address: :defaults },
+        jabber:    { interval: :defaults, rollup_threshold: :baseline, address: :defaults } },
+    nmt_default_full_inheritance:
+      { pagerduty: { subdomain: :defaults, token: :defaults, service_key: :defaults },
+        email:     { interval: :defaults, rollup_threshold: :defaults, address: :defaults },
+        jabber:    { interval: :defaults, rollup_threshold: :defaults, address: :defaults } },
+    nmt_partial_contacts:
+      { pagerduty: { subdomain: :contact, token: :baseline, service_key: :baseline },
+        email:     { interval: :baseline, rollup_threshold: :baseline, address: :contact },
+        jabber:    { interval: :baseline, rollup_threshold: :baseline, address: :contact } },
+    nmt_full_contacts:
+      { pagerduty: { subdomain: :contact, token: :contact, service_key: :contact },
+        email:     { interval: :contact, rollup_threshold: :contact, address: :contact },
+        jabber:    { interval: :contact, rollup_threshold: :contact, address: :contact } },
+    nmt_real_world:
+      { pagerduty: { subdomain: :contact, token: :baseline, service_key: :baseline },
+        email:     { interval: :defaults, rollup_threshold: :defaults, address: :contact },
+        jabber:    { interval: :defaults, rollup_threshold: :defaults, address: :contact } }
+  }
+
+  test_attr_table.each do |test_contact, contact_attr_table|
+    rspec_obj.describe "#{test_contact} notification_media" do
+      it 'should only have media from the config' do
+        contact_rules = @test_diner.diner.contacts(test_contact)[0][:links][:media]
+        expect(contact_rules - contact_attr_table.keys.map { |media| "#{test_contact}_#{media}" }).to eq([])
+      end
+
+      contact_attr_table.each do |media, media_attr_table|
+        describe "#{media} media" do
+          before :all do
+            # Pagerduty is handled as a special case by (bolted onto) the API
+            @api_media = case media
+                         when :pagerduty
+                           @test_diner.diner.pagerduty_credentials(test_contact)[0]
+                         else
+                           @test_diner.diner.media("#{test_contact}_#{media}")[0]
+                         end
+          end
+
+          it 'should be associated to the contact' do
+            expect(@api_media[:links][:contacts][0]).to eql(test_contact.to_s)
+          end
+
+          media_attr_table.each do |media_attr, attr_source|
+            test_value = case attr_source
+                         when :baseline
+                           test_config['baseline_options']['notification_media'][media.to_s][media_attr.to_s]
+                         when :defaults
+                           test_config['contacts'][test_contact.to_s]['notification_media']['defaults'][media_attr.to_s]
+                         when :contact
+                           test_config['contacts'][test_contact.to_s]['notification_media'][media.to_s][media_attr.to_s]
+                         end
+            it "should use the #{attr_source} attribute for #{media_attr}" do
+              expect(@api_media[media_attr]).to eql(test_value)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/functional/configuration_contact_notification_rules_spec.rb

@@ -0,0 +1,58 @@
+require_relative '../spec_helper.rb'
+require_relative 'config_test_common.rb'
+
+TestCommon.setup_config_test('notification_rules') do |rspec_obj, test_config|
+  # Table defining which media attributes should be used for each test contact
+  test_attr_table = {
+    nrt_baseline_inheritence:
+      { rules_1: { warning_media: :baseline, critical_media: :baseline },
+        rules_2: { warning_media: :baseline, critical_media: :baseline } },
+    nrt_default_partial_inheritance:
+      { rules_1: { unknown_media: :defaults, warning_media: :defaults, critical_media: :baseline },
+        rules_2: { unknown_media: :defaults, warning_media: :defaults, critical_media: :baseline } },
+    nrt_default_full_inheritance:
+      { rules_1: { unknown_media: :defaults, warning_media: :defaults, critical_media: :defaults },
+        rules_2: { unknown_media: :defaults, warning_media: :defaults, critical_media: :defaults } },
+    nrt_partial_contacts:
+      { rules_1: { unknown_media: :defaults, warning_media: :contact, critical_media: :contact },
+        rules_2: { unknown_media: :defaults, warning_media: :defaults, critical_media: :baseline } },
+    nrt_full_contacts:
+      { rules_1: { unknown_media: :contact, warning_media: :contact, critical_media: :contact },
+        rules_2: { unknown_media: :contact, warning_media: :contact, critical_media: :contact } }
+  }
+
+  test_attr_table.each do |test_contact, contact_attr_table|
+    rspec_obj.describe "#{test_contact} notification_rules" do
+      it 'should only have rules from the config' do
+        contact_rules = @test_diner.diner.contacts(test_contact)[0][:links][:notification_rules]
+        expect(contact_rules - contact_attr_table.keys.map { |rule| "#{test_contact}_#{rule}" }).to eq([])
+      end
+
+      contact_attr_table.each do |rule, rules_attr_table|
+        describe "#{rule} rules" do
+          before :all do
+            @api_rules = @test_diner.diner.notification_rules("#{test_contact}_#{rule}")[0]
+          end
+
+          it 'should be associated to the contact' do
+            expect(@api_rules[:links][:contacts][0]).to eql(test_contact.to_s)
+          end
+
+          rules_attr_table.each do |rules_attr, attr_source|
+            test_value = case attr_source
+                         when :baseline
+                           test_config['baseline_options']['notification_rules'][rule.to_s][rules_attr.to_s]
+                         when :defaults
+                           test_config['contacts'][test_contact.to_s]['notification_rules']['defaults'][rules_attr.to_s]
+                         when :contact
+                           test_config['contacts'][test_contact.to_s]['notification_rules'][rule.to_s][rules_attr.to_s]
+                         end
+            it "should use the #{attr_source} attribute for #{rules_attr}" do
+              expect(@api_rules[rules_attr]).to eql(test_value)
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/spec/functional/configuration_contact_removal_spec.rb

@@ -0,0 +1,83 @@
+require_relative '../spec_helper.rb'
+require_relative 'config_test_common.rb'
+
+TestCommon.setup_test do |rspec_obj|
+  rspec_obj.describe 'object removal' do
+    before :all do
+      # Load flapjack with test entities
+      fail 'Failed to create test entities' unless @test_diner.diner.create_entities(Array.new(100) { |c| { name: "testentity-#{c}", id: "testentity-#{c}" } })
+      @test_config = TestCommon.load_config('obj_removal_setup')
+      # Load Flapjack with the things
+      FlapjackConfigurator.configure_flapjack(@test_config, @test_container.api_url, @logger, true)
+    end
+
+    # Because I don't trust anything and we're testing absence
+    describe 'pretest sanity' do
+      # The test sets up two contacts the same way
+      %w(loaded_test removal_test).each do |contact_name|
+        describe "#{contact_name} contact" do
+          before :all do
+            @api_contact_links = @test_diner.diner.contacts(contact_name)[0][:links]
+          end
+
+          [:entities, :media, :notification_rules].each do |thing|
+            it "has #{thing}s linked to it" do
+              # media is 2, notification_rules has 2, entities has 101 or so
+              expect(@api_contact_links[thing].length).to be >= 2
+            end
+          end
+
+          # special case...
+          it 'has pagerduty linked to it' do
+            expect(@test_diner.diner.pagerduty_credentials(contact_name)).not_to be_nil
+          end
+        end
+      end
+    end
+
+    describe 'operation' do
+      before :all do
+        # Strip down the config
+        #
+        # Delete the test delete contact
+        @test_config['contacts'].delete('removal_test')
+        # Delete things from the loaded test
+        @test_config['contacts']['loaded_test'].delete('entities')
+        @test_config['contacts']['loaded_test']['notification_media'] = {}
+        # Leave the default notification rule to prevent false failures from Flapjack adding a default
+        @test_config['contacts']['loaded_test']['notification_rules'].delete('rule1')
+        @test_config['contacts']['loaded_test']['notification_rules'].delete('rule2')
+      end
+
+      it 'returns true as changes are made' do
+        expect(FlapjackConfigurator.configure_flapjack(@test_config, @test_container.api_url, @logger, true)).to eql(true)
+      end
+
+      it 'deletes the removal_test contact' do
+        expect(@test_diner.diner.contacts('removal_test')).to be_nil
+      end
+
+      # Wording is getting contrived...
+      describe 'against the loaded_test user' do
+        before :all do
+          @api_contact_links = @test_diner.diner.contacts('loaded_test')[0][:links]
+        end
+
+        [:entities, :media].each do |thing|
+          it "removes the #{thing}s" do
+            expect(@api_contact_links[thing]).to eql([])
+          end
+        end
+
+        it 'removes all but the default notification rule' do
+          expect(@api_contact_links[:notification_rules]).to eql(%w(loaded_test_default))
+        end
+
+        # special case...
+        it 'removes the pagerduty credentials' do
+          expect(@test_diner.diner.pagerduty_credentials('loaded_test')).to eql([])
+        end
+      end
+    end
+  end
+end

data/spec/functional/test_configs/changes/attributes.yaml

@@ -0,0 +1,24 @@
+# Changed attributes write
+---
+
+contacts:
+  attribute_test:
+    details:
+      first_name: ChangedTestFirstName
+      last_name: ChangedTestLastName
+      email: changed.test.contact.email@example.com
+      timezone: CST6CDT
+
+    notification_media: {}
+    notification_rules: {}
+
+  # Write two contacts to check for crosstalk
+  attribute_test2:
+    details:
+      first_name: ChangedTest2FirstName
+      last_name: ChangedTest2LastName
+      email: changedtest2.contact.email@example.com
+      timezone: PST8PDT
+
+    notification_media: {}
+    notification_rules: {}

data/spec/functional/test_configs/changes/notification_media.yaml

@@ -0,0 +1,155 @@
+# Changed notification_media test config
+# Intentionally big to hit many scenarios
+---
+baseline_options:
+  notification_media:
+    pagerduty:
+      subdomain: BaselinePDSubdomain2
+      token: BaselinePDToken2
+      service_key: BaselinePDServiceKey2
+      interval: 2100
+      rollup_threshold: 210
+
+    email:
+      address: baseline.address@example2.foo
+      interval: 2102
+      rollup_threshold: 211
+
+    jabber:
+      address: baseline_room@jabber.example2.foo
+      interval: 2103
+      rollup_threshold: 212
+
+contacts:
+  # nmt: Notification media test
+  nmt_baseline_inheritence:
+    details:
+      first_name: TestFirstName
+      last_name: TestLastName
+      email: test.contact.email@example.com
+      timezone: MST7MDT
+    notification_rules:
+      defaults: {}
+
+    notification_media:
+      pagerduty: {}
+      email: {}
+      jabber: {}
+      
+  nmt_default_partial_inheritance:
+    details:
+      first_name: TestFirstName
+      last_name: TestLastName
+      email: test.contact.email@example.com
+      timezone: MST7MDT
+    notification_rules:
+      defaults: {}
+
+    notification_media:
+      defaults:
+        address:   default_address2@example.foo
+        subdomain: DefaultPDSubdomain2
+        interval:  2200
+
+      pagerduty: {}
+      email: {}
+      jabber: {}
+
+  nmt_default_full_inheritance:
+    details:
+      first_name: TestFirstName
+      last_name: TestLastName
+      email: test.contact.email@example.com
+      timezone: MST7MDT
+    notification_rules:
+      defaults: {}
+
+    notification_media:
+      defaults:
+        subdomain: DefaultPDSubdomain2
+        token: DefaultPDToken2
+        service_key: DefaultPDServiceKey2
+        address: default.address@example2.foo
+        interval: 300
+        rollup_threshold: 30
+
+      pagerduty: {}
+      email: {}
+      jabber: {}
+
+  nmt_partial_contacts:
+    details:
+      first_name: TestFirstName
+      last_name: TestLastName
+      email: test.contact.email@example.com
+      timezone: MST7MDT
+    notification_rules:
+      defaults: {}
+
+    notification_media:
+      pagerduty:
+        subdomain: ContactPDSubdomain2
+
+      email:
+        address: contact.address@example2.com
+
+      jabber:
+        address: contact_room@jabber.example2.com
+
+  nmt_full_contacts:
+    details:
+      first_name: TestFirstName
+      last_name: TestLastName
+      email: test.contact.email@example.com
+      timezone: MST7MDT
+    notification_rules:
+      defaults: {}
+
+    notification_media:
+      defaults:
+        subdomain: DefaultPDSubdomain2
+        token: DefaultPDToken2
+        service_key: DefaultPDServiceKey2
+        address: default.address@example2.foo
+        interval: 2300
+        rollup_threshold: 230
+
+      pagerduty:
+        token: ContactPDToken2
+        service_key: ContactPDServiceKey2
+        subdomain: ContactPDSubdomain2
+        interval: 2400
+        rollup_threshold: 240
+
+      email:
+        address: contact.address@example2.com
+        interval: 2401
+        rollup_threshold: 241
+
+      jabber:
+        address: contact_room@jabber.example2.com
+        interval: 2402
+        rollup_threshold: 242
+
+  nmt_real_world:
+    details:
+      first_name: TestFirstName
+      last_name: TestLastName
+      email: test.contact.email@example.com
+      timezone: MST7MDT
+    notification_rules:
+      defaults: {}
+
+    notification_media:
+      defaults:
+        interval: 2500
+        rollup_threshold: 250
+
+      pagerduty:
+        subdomain: ContactPDSubdomain22
+
+      email:
+        address: contact.address22@example.com
+
+      jabber:
+        address: contact_room22@jabber.example.com

data/spec/functional/test_configs/changes/notification_rules.yaml

@@ -0,0 +1,143 @@
+# Initial test config
+# Intentionally big to hit many scenarios
+---
+baseline_options:
+  notification_rules:
+    rules_1:
+      warning_media:
+        - basechengedthing1
+        - basechengedthing2
+      critical_media:
+        - basechengedthing3
+        - basechengedthing4
+
+    rules_2:
+      warning_media:
+        - basechengedthing5
+        - basechengedthing6
+      critical_media:
+        - basechengedthing7
+        - basechengedthing8
+
+contacts:
+  # nrt: Notification media test
+  nrt_baseline_inheritence:
+    details:
+      first_name: TestFirstName
+      last_name: TestLastName
+      email: test.contact.email@example.com
+      timezone: MST7MDT
+    notification_media: {}
+
+    notification_rules:
+      rules_1: {}
+      rules_2: {}
+
+  nrt_default_partial_inheritance:
+    details:
+      first_name: TestFirstName
+      last_name: TestLastName
+      email: test.contact.email@example.com
+      timezone: MST7MDT
+    notification_media: {}
+
+    notification_rules:
+      defaults:
+        warning_media:
+          - defaultchengedthing1
+          - defaultchengedthing2
+        unknown_media:
+          - defaultchengedthing3
+          - defaultchengedthing4
+
+      rules_1: {}
+      rules_2: {}
+          
+  nrt_default_full_inheritance:
+    details:
+      first_name: TestFirstName
+      last_name: TestLastName
+      email: test.contact.email@example.com
+      timezone: MST7MDT
+    notification_media: {}
+
+    notification_rules:
+      defaults:
+        critical_media:
+          - defaultchengedthing5
+          - defaultchengedthing6
+        warning_media:
+          - defaultchengedthing7
+          - defaultchengedthing8
+        unknown_media:
+          - defaultchengedthing9
+          - defaultchengedthing10
+
+      rules_1: {}
+      rules_2: {}
+
+  nrt_partial_contacts:
+    details:
+      first_name: TestFirstName
+      last_name: TestLastName
+      email: test.contact.email@example.com
+      timezone: MST7MDT
+    notification_media: {}
+
+    notification_rules:
+      defaults:
+        warning_media:
+          - defaultchengedthing11
+          - defaultchengedthing12
+        unknown_media:
+          - defaultchengedthing13
+          - defaultchengedthing14
+
+      rules_1:
+        warning_media:
+          - contactchengedthing1
+          - contactchengedthing2
+        critical_media:
+          - contactchengedthing3
+          - contactchengedthing4
+
+      rules_2: {}
+
+  nrt_full_contacts:
+    details:
+      first_name: TestFirstName
+      last_name: TestLastName
+      email: test.contact.email@example.com
+      timezone: MST7MDT
+    notification_media: {}
+
+    notification_rules:
+      defaults:
+        warning_media:
+          - defaultchengedthing15
+          - defaultchengedthing16
+        unknown_media:
+          - defaultchengedthing17
+          - defaultchengedthing18
+
+      rules_1:
+        warning_media:
+          - contactchengedthing5
+          - contactchengedthing6
+        critical_media:
+          - contactchengedthing7
+          - contactchengedthing8
+        unknown_media:
+          - contactchengedthing9
+          - contactchengedthing10
+
+      rules_2:
+        warning_media:
+          - contactchengedthing11
+          - contactchengedthing12
+        critical_media:
+          - contactchengedthing13
+          - contactchengedthing14
+        unknown_media:
+          - contactchengedthing15
+          - contactchengedthing16