diff options
Diffstat (limited to 'spec/services/alert_management/alerts/update_service_spec.rb')
-rw-r--r-- | spec/services/alert_management/alerts/update_service_spec.rb | 227 |
1 files changed, 167 insertions, 60 deletions
diff --git a/spec/services/alert_management/alerts/update_service_spec.rb b/spec/services/alert_management/alerts/update_service_spec.rb index e185e67c5cf..91b02325bad 100644 --- a/spec/services/alert_management/alerts/update_service_spec.rb +++ b/spec/services/alert_management/alerts/update_service_spec.rb @@ -2,11 +2,12 @@ require 'spec_helper' -describe AlertManagement::Alerts::UpdateService do +RSpec.describe AlertManagement::Alerts::UpdateService do let_it_be(:user_with_permissions) { create(:user) } + let_it_be(:other_user_with_permissions) { create(:user) } let_it_be(:user_without_permissions) { create(:user) } - let_it_be(:alert, reload: true) { create(:alert_management_alert) } - let_it_be(:project) { alert.project } + let_it_be(:project) { create(:project) } + let_it_be(:alert, reload: true) { create(:alert_management_alert, :triggered, project: project) } let(:current_user) { user_with_permissions } let(:params) { {} } @@ -15,119 +16,225 @@ describe AlertManagement::Alerts::UpdateService do before_all do project.add_developer(user_with_permissions) + project.add_developer(other_user_with_permissions) end describe '#execute' do + shared_examples 'does not add a todo' do + specify { expect { response }.not_to change(Todo, :count) } + end + + shared_examples 'does not add a system note' do + specify { expect { response }.not_to change(Note, :count) } + end + + shared_examples 'adds a system note' do + specify { expect { response }.to change { alert.reload.notes.count }.by(1) } + end + + shared_examples 'error response' do |message| + it_behaves_like 'does not add a todo' + it_behaves_like 'does not add a system note' + + it 'has an informative message' do + expect(response).to be_error + expect(response.message).to eq(message) + end + end + subject(:response) { service.execute } context 'when the current_user is nil' do let(:current_user) { nil } - it 'results in an error' do - expect(response).to be_error - expect(response.message).to eq('You have no permissions') - end + it_behaves_like 'error response', 'You have no permissions' end - context 'when user does not have permission to update alerts' do + context 'when current_user does not have permission to update alerts' do let(:current_user) { user_without_permissions } - it 'results in an error' do - expect(response).to be_error - expect(response.message).to eq('You have no permissions') - end + it_behaves_like 'error response', 'You have no permissions' end context 'when no parameters are included' do - it 'results in an error' do - expect(response).to be_error - expect(response.message).to eq('Please provide attributes to update') - end + it_behaves_like 'error response', 'Please provide attributes to update' end - context 'when an error occures during update' do + context 'when an error occurs during update' do let(:params) { { title: nil } } - it 'results in an error' do - expect { response }.not_to change { alert.reload.notes.count } - expect(response).to be_error - expect(response.message).to eq("Title can't be blank") - end + it_behaves_like 'error response', "Title can't be blank" end - context 'when a model attribute is included without assignees' do - let(:params) { { title: 'This is an updated alert.' } } + shared_examples 'title update' do + it_behaves_like 'does not add a todo' + it_behaves_like 'does not add a system note' it 'updates the attribute' do original_title = alert.title - expect { response }.to change { alert.title }.from(original_title).to(params[:title]) + expect { response }.to change { alert.title }.from(original_title).to(expected_title) expect(response).to be_success end + end - it 'skips adding a todo' do - expect { response }.not_to change(Todo, :count) - end + context 'when a model attribute is included without assignees' do + let(:params) { { title: 'This is an updated alert.' } } + let(:expected_title) { params[:title] } + + it_behaves_like 'title update' + end + + context 'when alert is resolved and another existing open alert' do + let!(:alert) { create(:alert_management_alert, :resolved, project: project) } + let!(:existing_alert) { create(:alert_management_alert, :triggered, project: project) } + + let(:params) { { title: 'This is an updated alert.' } } + let(:expected_title) { params[:title] } + + it_behaves_like 'title update' end context 'when assignees are included' do - let(:params) { { assignees: [user_with_permissions] } } + shared_examples 'adds a todo' do + let(:assignee) { expected_assignees.first } - after do - alert.assignees = [] + specify do + expect { response }.to change { assignee.reload.todos.count }.by(1) + expect(assignee.todos.last.author).to eq(current_user) + end end - it 'assigns the user' do - expect { response }.to change { alert.reload.assignees }.from([]).to(params[:assignees]) - expect(response).to be_success + shared_examples 'successful assignment' do + it_behaves_like 'adds a system note' + it_behaves_like 'adds a todo' + + after do + alert.assignees = [] + end + + specify do + expect { response }.to change { alert.reload.assignees }.from([]).to(expected_assignees) + expect(response).to be_success + end + end + + let(:expected_assignees) { params[:assignees] } + + context 'when the assignee is the current user' do + let(:params) { { assignees: [current_user] } } + + it_behaves_like 'successful assignment' end - it 'creates a system note for the assignment' do - expect { response }.to change { alert.reload.notes.count }.by(1) + context 'when the assignee has read permissions' do + let(:params) { { assignees: [other_user_with_permissions] } } + + it_behaves_like 'successful assignment' end - it 'adds a todo' do - expect { response }.to change { Todo.where(user: user_with_permissions).count }.by(1) + context 'when the assignee does not have read permissions' do + let(:params) { { assignees: [user_without_permissions] } } + + it_behaves_like 'error response', 'Assignee has no permissions' end - context 'when current user is not the assignee' do - let(:assignee_user) { create(:user) } - let(:params) { { assignees: [assignee_user] } } + context 'when user is already assigned' do + let(:params) { { assignees: [user_with_permissions] } } - it 'skips adding todo for assignee without permission to read alert' do - expect { response }.not_to change(Todo, :count) + before do + alert.assignees << user_with_permissions end - context 'when assignee has read permission' do - before do - project.add_developer(assignee_user) - end + it_behaves_like 'does not add a system note' + # TODO: We should not add another todo in this scenario + it_behaves_like 'adds a todo' + end - it 'adds a todo' do - response + context 'with multiple users included' do + let(:params) { { assignees: [user_with_permissions, user_without_permissions] } } + let(:expected_assignees) { [user_with_permissions] } - expect(Todo.first.author).to eq(current_user) - end + it_behaves_like 'successful assignment' + end + end + + context 'when a status is included' do + let(:params) { { status: new_status } } + let(:new_status) { AlertManagement::Alert::STATUSES[:acknowledged] } + + it 'successfully changes the status' do + expect { response }.to change { alert.acknowledged? }.to(true) + expect(response).to be_success + expect(response.payload[:alert]).to eq(alert) + end + + it_behaves_like 'adds a system note' + + context 'with unknown status' do + let(:new_status) { -1 } + + it_behaves_like 'error response', 'Invalid status' + end + + context 'with resolving status' do + let(:new_status) { AlertManagement::Alert::STATUSES[:resolved] } + + it 'changes the status' do + expect { response }.to change { alert.resolved? }.to(true) + end + + it "resolves the current user's related todos" do + todo = create(:todo, :pending, target: alert, user: current_user, project: alert.project) + + expect { response }.to change { todo.reload.state }.from('pending').to('done') + end + end + + context 'with an opening status and existing open alert' do + let_it_be(:alert) { create(:alert_management_alert, :resolved, :with_fingerprint, project: project) } + let_it_be(:existing_alert) { create(:alert_management_alert, :triggered, fingerprint: alert.fingerprint, project: project) } + let_it_be(:url) { Gitlab::Routing.url_helpers.details_project_alert_management_path(project, existing_alert) } + let_it_be(:link) { ActionController::Base.helpers.link_to(_('alert'), url) } + + let(:message) do + "An #{link} with the same fingerprint is already open. " \ + 'To change the status of this alert, resolve the linked alert.' end - context 'when current_user is nil' do - let(:current_user) { nil } + it_behaves_like 'does not add a todo' + it_behaves_like 'does not add a system note' + + it 'has an informative message' do + expect(response).to be_error + expect(response.message).to eq(message) + end - it 'skips adding todo if current_user is nil' do - project.add_developer(assignee_user) + context 'fingerprints are blank' do + let_it_be(:alert) { create(:alert_management_alert, :resolved, project: project, fingerprint: nil) } + let_it_be(:existing_alert) { create(:alert_management_alert, :triggered, fingerprint: alert.fingerprint, project: project) } - expect { response }.not_to change(Todo, :count) + it 'successfully changes the status' do + expect { response }.to change { alert.acknowledged? }.to(true) + expect(response).to be_success + expect(response.payload[:alert]).to eq(alert) end + + it_behaves_like 'adds a system note' end end - context 'with multiple users included' do - let(:params) { { assignees: [user_with_permissions, user_without_permissions] } } + context 'two existing closed alerts' do + let_it_be(:alert) { create(:alert_management_alert, :resolved, :with_fingerprint, project: project) } + let_it_be(:existing_alert) { create(:alert_management_alert, :resolved, fingerprint: alert.fingerprint, project: project) } - it 'assigns the first permissioned user' do - expect { response }.to change { alert.reload.assignees }.from([]).to([user_with_permissions]) + it 'successfully changes the status' do + expect { response }.to change { alert.acknowledged? }.to(true) expect(response).to be_success + expect(response.payload[:alert]).to eq(alert) end + + it_behaves_like 'adds a system note' end end end |