Welcome to mirror list, hosted at ThFree Co, Russian Federation.

alert_recovery_shared_examples.rb « alert_processing « alert_management « services « shared_examples « support « spec - gitlab.com/gitlab-org/gitlab-foss.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
blob: 86e7da5bcbe4b97780e351ff126980bc7228ca6e (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
# frozen_string_literal: true

# This shared_example requires the following variables:
# - `alert`, the alert to be resolved
RSpec.shared_examples 'resolves an existing alert management alert' do
  it 'sets the end time and status' do
    expect(Gitlab::AppLogger).not_to receive(:warn)

    expect { subject }
      .to change { alert.reload.resolved? }.to(true)
      .and change { alert.ended_at.present? }.to(true)

    expect(subject).to be_success
  end
end

# This shared_example requires the following variables:
# - `alert`, the alert not to be updated
RSpec.shared_examples 'does not change the alert end time' do
  specify do
    expect { subject }.not_to change { alert.reload.ended_at }
  end
end

# This shared_example requires the following variables:
# - `project`, expected project for an incoming alert
# - `service`, a service which includes AlertManagement::AlertProcessing
# - `alert` (optional), the alert which should fail to resolve. If not
#             included, the log is expected to correspond to a new alert
RSpec.shared_examples 'writes a warning to the log for a failed alert status update' do
  before do
    allow(service).to receive(:alert).and_call_original
    allow(service).to receive_message_chain(:alert, :resolve).and_return(false)
  end

  specify do
    expect(Gitlab::AppLogger).to receive(:warn).with(
      message: 'Unable to update AlertManagement::Alert status to resolved',
      project_id: project.id,
      alert_id: alert ? alert.id : (last_alert_id + 1)
    )

    # Failure to resolve a recovery alert is not a critical failure
    expect(subject).to be_success
  end

  private

  def last_alert_id
    AlertManagement::Alert.connection
      .select_value("SELECT nextval('#{AlertManagement::Alert.sequence_name}')")
  end
end

RSpec.shared_examples 'processes recovery alert' do
  context 'seen for the first time' do
    let(:alert) { AlertManagement::Alert.last }

    include_examples 'processes never-before-seen recovery alert'
  end

  context 'for an existing alert with the same fingerprint' do
    let_it_be(:gitlab_fingerprint) { Digest::SHA1.hexdigest(fingerprint) }

    context 'which is triggered' do
      let_it_be(:alert) { create(:alert_management_alert, :triggered, project: project, fingerprint: gitlab_fingerprint, monitoring_tool: source) }

      it_behaves_like 'resolves an existing alert management alert'
      it_behaves_like 'creates expected system notes for alert', :recovery_alert, :resolve_alert
      it_behaves_like 'sends alert notification emails if enabled'
      it_behaves_like 'closes related incident if enabled'
      it_behaves_like 'writes a warning to the log for a failed alert status update'

      it_behaves_like 'does not create an alert management alert'
      it_behaves_like 'does not process incident issues'
      it_behaves_like 'does not add an alert management alert event'
    end

    context 'which is ignored' do
      let_it_be(:alert) { create(:alert_management_alert, :ignored, project: project, fingerprint: gitlab_fingerprint, monitoring_tool: source) }

      it_behaves_like 'resolves an existing alert management alert'
      it_behaves_like 'creates expected system notes for alert', :recovery_alert, :resolve_alert
      it_behaves_like 'sends alert notification emails if enabled'
      it_behaves_like 'closes related incident if enabled'
      it_behaves_like 'writes a warning to the log for a failed alert status update'

      it_behaves_like 'does not create an alert management alert'
      it_behaves_like 'does not process incident issues'
      it_behaves_like 'does not add an alert management alert event'
    end

    context 'which is acknowledged' do
      let_it_be(:alert) { create(:alert_management_alert, :acknowledged, project: project, fingerprint: gitlab_fingerprint, monitoring_tool: source) }

      it_behaves_like 'resolves an existing alert management alert'
      it_behaves_like 'creates expected system notes for alert', :recovery_alert, :resolve_alert
      it_behaves_like 'sends alert notification emails if enabled'
      it_behaves_like 'closes related incident if enabled'
      it_behaves_like 'writes a warning to the log for a failed alert status update'

      it_behaves_like 'does not create an alert management alert'
      it_behaves_like 'does not process incident issues'
      it_behaves_like 'does not add an alert management alert event'
    end

    context 'which is resolved' do
      let_it_be(:alert) { create(:alert_management_alert, :resolved, project: project, fingerprint: gitlab_fingerprint, monitoring_tool: source) }

      include_examples 'processes never-before-seen recovery alert'
    end
  end
end