summaryrefslogtreecommitdiff
path: root/spec/lib/gitlab/memory/watchdog/configuration_spec.rb
blob: 38a39f6a33a7b0dea5036d27c2f06d551b63467f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
# frozen_string_literal: true

require 'fast_spec_helper'
require_dependency 'gitlab/cluster/lifecycle_events'

RSpec.describe Gitlab::Memory::Watchdog::Configuration do
  subject(:configuration) { described_class.new }

  describe '#initialize' do
    it 'initialize monitors' do
      expect(configuration.monitors).to be_an_instance_of(described_class::MonitorStack)
    end
  end

  describe '#handler' do
    context 'when handler is not set' do
      it 'defaults to NullHandler' do
        expect(configuration.handler).to be(Gitlab::Memory::Watchdog::NullHandler.instance)
      end
    end
  end

  describe '#logger' do
    context 'when logger is not set, defaults to stdout logger' do
      it 'defaults to Logger' do
        expect(configuration.logger).to be_an_instance_of(::Gitlab::Logger)
      end
    end
  end

  describe '#sleep_time_seconds' do
    context 'when sleep_time_seconds is not set' do
      it 'defaults to SLEEP_TIME_SECONDS' do
        expect(configuration.sleep_time_seconds).to eq(described_class::DEFAULT_SLEEP_TIME_SECONDS)
      end
    end
  end

  describe '#monitors' do
    context 'when monitors are configured to be used' do
      let(:payload1) do
        {
          message: 'monitor_1_text',
          memwd_max_strikes: 5,
          memwd_cur_strikes: 0
        }
      end

      let(:payload2) do
        {
          message: 'monitor_2_text',
          memwd_max_strikes: 0,
          memwd_cur_strikes: 1
        }
      end

      let(:monitor_class_1) do
        Struct.new(:threshold_violated, :payload) do
          def call
            { threshold_violated: !!threshold_violated, payload: payload || {} }
          end

          def self.name
            'Monitor1'
          end
        end
      end

      let(:monitor_class_2) do
        Struct.new(:threshold_violated, :payload) do
          def call
            { threshold_violated: !!threshold_violated, payload: payload || {} }
          end

          def self.name
            'Monitor2'
          end
        end
      end

      context 'when two different monitor class are configured' do
        shared_examples 'executes monitors and returns correct results' do
          it 'calls each monitor and returns correct results', :aggregate_failures do
            payloads = []
            thresholds = []
            strikes = []
            monitor_names = []

            configuration.monitors.call_each do |result|
              payloads << result.payload
              thresholds << result.threshold_violated?
              strikes << result.strikes_exceeded?
              monitor_names << result.monitor_name
            end

            expect(payloads).to eq([payload1, payload2])
            expect(thresholds).to eq([false, true])
            expect(strikes).to eq([false, true])
            expect(monitor_names).to eq([:monitor1, :monitor2])
          end
        end

        context 'when monitors are configured inline' do
          before do
            configuration.monitors.push monitor_class_1, false, { message: 'monitor_1_text' }, max_strikes: 5
            configuration.monitors.push monitor_class_2, true, { message: 'monitor_2_text' }, max_strikes: 0
          end

          include_examples 'executes monitors and returns correct results'
        end

        context 'when monitors are configured in a block' do
          before do
            configuration.monitors do |stack|
              stack.push monitor_class_1, false, { message: 'monitor_1_text' }, max_strikes: 5
              stack.push monitor_class_2, true, { message: 'monitor_2_text' }, max_strikes: 0
            end
          end

          include_examples 'executes monitors and returns correct results'
        end
      end

      context 'when same monitor class is configured twice' do
        before do
          configuration.monitors.push monitor_class_1, max_strikes: 1
          configuration.monitors.push monitor_class_1, max_strikes: 1
        end

        it 'calls same monitor only once' do
          expect do |b|
            configuration.monitors.call_each(&b)
          end.to yield_control.once
        end
      end
    end
  end
end