diff options
author | GitLab Bot <gitlab-bot@gitlab.com> | 2020-05-20 14:34:42 +0000 |
---|---|---|
committer | GitLab Bot <gitlab-bot@gitlab.com> | 2020-05-20 14:34:42 +0000 |
commit | 9f46488805e86b1bc341ea1620b866016c2ce5ed (patch) | |
tree | f9748c7e287041e37d6da49e0a29c9511dc34768 /spec/services/alert_management | |
parent | dfc92d081ea0332d69c8aca2f0e745cb48ae5e6d (diff) | |
download | gitlab-ce-9f46488805e86b1bc341ea1620b866016c2ce5ed.tar.gz |
Add latest changes from gitlab-org/gitlab@13-0-stable-ee
Diffstat (limited to 'spec/services/alert_management')
3 files changed, 354 insertions, 0 deletions
diff --git a/spec/services/alert_management/create_alert_issue_service_spec.rb b/spec/services/alert_management/create_alert_issue_service_spec.rb new file mode 100644 index 00000000000..62afe777165 --- /dev/null +++ b/spec/services/alert_management/create_alert_issue_service_spec.rb @@ -0,0 +1,152 @@ +# frozen_string_literal: true + +require 'spec_helper' + +RSpec.describe AlertManagement::CreateAlertIssueService do + let_it_be(:user) { create(:user) } + let_it_be(:project) { create(:project) } + let_it_be(:payload) do + { + 'annotations' => { + 'title' => 'Alert title' + }, + 'startsAt' => '2020-04-27T10:10:22.265949279Z', + 'generatorURL' => 'http://8d467bd4607a:9090/graph?g0.expr=vector%281%29&g0.tab=1' + } + end + let_it_be(:generic_alert, reload: true) { create(:alert_management_alert, :triggered, project: project, payload: payload) } + let_it_be(:prometheus_alert) { create(:alert_management_alert, :triggered, :prometheus, project: project, payload: payload) } + let(:alert) { generic_alert } + let(:created_issue) { Issue.last! } + + describe '#execute' do + subject(:execute) { described_class.new(alert, user).execute } + + before do + allow(user).to receive(:can?).and_call_original + allow(user).to receive(:can?) + .with(:create_issue, project) + .and_return(can_create) + end + + shared_examples 'creating an alert' do + it 'creates an issue' do + expect { execute }.to change { project.issues.count }.by(1) + end + + it 'returns a created issue' do + expect(execute.payload).to eq(issue: created_issue) + end + + it 'has a successful status' do + expect(execute).to be_success + end + + it 'updates alert.issue_id' do + execute + + expect(alert.reload.issue_id).to eq(created_issue.id) + end + + it 'sets issue author to the current user' do + execute + + expect(created_issue.author).to eq(user) + end + end + + context 'when a user is allowed to create an issue' do + let(:can_create) { true } + + before do + project.add_developer(user) + end + + it 'checks permissions' do + execute + expect(user).to have_received(:can?).with(:create_issue, project) + end + + context 'when the alert is prometheus alert' do + let(:alert) { prometheus_alert } + + it_behaves_like 'creating an alert' + end + + context 'when the alert is generic' do + let(:alert) { generic_alert } + + it_behaves_like 'creating an alert' + end + + context 'when issue cannot be created' do + let(:alert) { prometheus_alert } + + before do + # set invalid payload for Prometheus alert + alert.update!(payload: {}) + end + + it 'has an unsuccessful status' do + expect(execute).to be_error + expect(execute.message).to eq('invalid alert') + end + end + + context 'when alert cannot be updated' do + before do + # invalidate alert + too_many_hosts = Array.new(AlertManagement::Alert::HOSTS_MAX_LENGTH + 1) { |_| 'host' } + alert.update_columns(hosts: too_many_hosts) + end + + it 'responds with error' do + expect(execute).to be_error + expect(execute.message).to eq('Hosts hosts array is over 255 chars') + end + end + + context 'when alert already has an attached issue' do + let!(:issue) { create(:issue, project: project) } + + before do + alert.update!(issue_id: issue.id) + end + + it 'does not create yet another issue' do + expect { execute }.not_to change(Issue, :count) + end + + it 'responds with error' do + expect(execute).to be_error + expect(execute.message).to eq(_('An issue already exists')) + end + end + + context 'when alert_management_create_alert_issue feature flag is disabled' do + before do + stub_feature_flags(alert_management_create_alert_issue: false) + end + + it 'responds with error' do + expect(execute).to be_error + expect(execute.message).to eq(_('You have no permissions')) + end + end + end + + context 'when a user is not allowed to create an issue' do + let(:can_create) { false } + + it 'checks permissions' do + execute + expect(user).to have_received(:can?).with(:create_issue, project) + end + + it 'responds with error' do + expect(execute).to be_error + expect(execute.message).to eq(_('You have no permissions')) + end + end + end +end diff --git a/spec/services/alert_management/process_prometheus_alert_service_spec.rb b/spec/services/alert_management/process_prometheus_alert_service_spec.rb new file mode 100644 index 00000000000..73f9f103902 --- /dev/null +++ b/spec/services/alert_management/process_prometheus_alert_service_spec.rb @@ -0,0 +1,136 @@ +# frozen_string_literal: true + +require 'spec_helper' + +RSpec.describe AlertManagement::ProcessPrometheusAlertService do + let_it_be(:project) { create(:project) } + + describe '#execute' do + subject { described_class.new(project, nil, payload).execute } + + context 'when alert payload is valid' do + let(:parsed_alert) { Gitlab::Alerting::Alert.new(project: project, payload: payload) } + let(:payload) do + { + 'status' => status, + 'labels' => { + 'alertname' => 'GitalyFileServerDown', + 'channel' => 'gitaly', + 'pager' => 'pagerduty', + 'severity' => 's1' + }, + 'annotations' => { + 'description' => 'Alert description', + 'runbook' => 'troubleshooting/gitaly-down.md', + 'title' => 'Alert title' + }, + 'startsAt' => '2020-04-27T10:10:22.265949279Z', + 'endsAt' => '2020-04-27T10:20:22.265949279Z', + 'generatorURL' => 'http://8d467bd4607a:9090/graph?g0.expr=vector%281%29&g0.tab=1', + 'fingerprint' => 'b6ac4d42057c43c1' + } + end + + context 'when Prometheus alert status is firing' do + let(:status) { 'firing' } + + context 'when alert with the same fingerprint already exists' do + let!(:alert) { create(:alert_management_alert, :resolved, project: project, fingerprint: parsed_alert.gitlab_fingerprint) } + + context 'when status can be changed' do + it 'changes status to triggered' do + expect { subject }.to change { alert.reload.triggered? }.to(true) + end + end + + context 'when status change did not succeed' do + before do + allow(AlertManagement::Alert).to receive(:for_fingerprint).and_return([alert]) + allow(alert).to receive(:trigger).and_return(false) + end + + it 'writes a warning to the log' do + expect(Gitlab::AppLogger).to receive(:warn).with( + message: 'Unable to update AlertManagement::Alert status to triggered', + project_id: project.id, + alert_id: alert.id + ) + + subject + end + end + + it { is_expected.to be_success } + end + + context 'when alert does not exist' do + context 'when alert can be created' do + it 'creates a new alert' do + expect { subject }.to change { AlertManagement::Alert.where(project: project).count }.by(1) + end + end + + context 'when alert cannot be created' do + let(:errors) { double(messages: { hosts: ['hosts array is over 255 chars'] })} + let(:am_alert) { instance_double(AlertManagement::Alert, save: false, errors: errors) } + + before do + allow(AlertManagement::Alert).to receive(:new).and_return(am_alert) + end + + it 'writes a warning to the log' do + expect(Gitlab::AppLogger).to receive(:warn).with( + message: 'Unable to create AlertManagement::Alert', + project_id: project.id, + alert_errors: { hosts: ['hosts array is over 255 chars'] } + ) + + subject + end + end + + it { is_expected.to be_success } + end + end + + context 'when Prometheus alert status is resolved' do + let(:status) { 'resolved' } + let!(:alert) { create(:alert_management_alert, project: project, fingerprint: parsed_alert.gitlab_fingerprint) } + + context 'when status can be changed' do + it 'resolves an existing alert' do + expect { subject }.to change { alert.reload.resolved? }.to(true) + end + end + + context 'when status change did not succeed' do + before do + allow(AlertManagement::Alert).to receive(:for_fingerprint).and_return([alert]) + allow(alert).to receive(:resolve).and_return(false) + end + + it 'writes a warning to the log' do + expect(Gitlab::AppLogger).to receive(:warn).with( + message: 'Unable to update AlertManagement::Alert status to resolved', + project_id: project.id, + alert_id: alert.id + ) + + subject + end + end + + it { is_expected.to be_success } + end + end + + context 'when alert payload is invalid' do + let(:payload) { {} } + + it 'responds with bad_request' do + expect(subject).to be_error + expect(subject.http_status).to eq(:bad_request) + end + end + end +end diff --git a/spec/services/alert_management/update_alert_status_service_spec.rb b/spec/services/alert_management/update_alert_status_service_spec.rb new file mode 100644 index 00000000000..b287d0d1614 --- /dev/null +++ b/spec/services/alert_management/update_alert_status_service_spec.rb @@ -0,0 +1,66 @@ +# frozen_string_literal: true + +require 'spec_helper' + +describe AlertManagement::UpdateAlertStatusService do + let(:project) { alert.project } + let_it_be(:user) { build(:user) } + + let_it_be(:alert, reload: true) do + create(:alert_management_alert, :triggered) + end + + let(:service) { described_class.new(alert, user, new_status) } + + describe '#execute' do + shared_examples 'update failure' do |error_message| + it 'returns an error' do + expect(response).to be_error + expect(response.message).to eq(error_message) + expect(response.payload[:alert]).to eq(alert) + end + + it 'does not update the status' do + expect { response }.not_to change { alert.status } + end + end + + let(:new_status) { Types::AlertManagement::StatusEnum.values['ACKNOWLEDGED'].value } + let(:can_update) { true } + + subject(:response) { service.execute } + + before do + allow(user).to receive(:can?) + .with(:update_alert_management_alert, project) + .and_return(can_update) + end + + it 'returns success' do + expect(response).to be_success + expect(response.payload[:alert]).to eq(alert) + end + + it 'updates the status' do + expect { response }.to change { alert.acknowledged? }.to(true) + end + + context 'when user has no permissions' do + let(:can_update) { false } + + include_examples 'update failure', _('You have no permissions') + end + + context 'with no status' do + let(:new_status) { nil } + + include_examples 'update failure', _('Invalid status') + end + + context 'with unknown status' do + let(:new_status) { -1 } + + include_examples 'update failure', _('Invalid status') + end + end +end |