2019-10-12 21:52:04 +05:30
|
|
|
# frozen_string_literal: true
|
|
|
|
|
2021-09-04 01:27:46 +05:30
|
|
|
RSpec.shared_examples "chat integration" do |integration_name|
|
2019-02-15 15:39:39 +05:30
|
|
|
describe "Associations" do
|
|
|
|
it { is_expected.to belong_to :project }
|
|
|
|
it { is_expected.to have_one :service_hook }
|
|
|
|
end
|
|
|
|
|
|
|
|
describe "Validations" do
|
2021-09-04 01:27:46 +05:30
|
|
|
context "when integration is active" do
|
2019-02-15 15:39:39 +05:30
|
|
|
before do
|
|
|
|
subject.active = true
|
|
|
|
end
|
|
|
|
|
|
|
|
it { is_expected.to validate_presence_of(:webhook) }
|
2021-09-30 23:02:18 +05:30
|
|
|
it_behaves_like "issue tracker integration URL attribute", :webhook
|
2019-02-15 15:39:39 +05:30
|
|
|
end
|
|
|
|
|
2021-09-04 01:27:46 +05:30
|
|
|
context "when integration is inactive" do
|
2019-02-15 15:39:39 +05:30
|
|
|
before do
|
|
|
|
subject.active = false
|
|
|
|
end
|
|
|
|
|
|
|
|
it { is_expected.not_to validate_presence_of(:webhook) }
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2019-07-31 22:56:46 +05:30
|
|
|
describe '.supported_events' do
|
|
|
|
it 'does not support deployment_events' do
|
|
|
|
expect(described_class.supported_events).not_to include('deployment')
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2019-02-15 15:39:39 +05:30
|
|
|
describe "#execute" do
|
|
|
|
let(:user) { create(:user) }
|
|
|
|
let(:project) { create(:project, :repository) }
|
|
|
|
let(:webhook_url) { "https://example.gitlab.com/" }
|
|
|
|
|
|
|
|
before do
|
|
|
|
allow(subject).to receive_messages(
|
|
|
|
project: project,
|
|
|
|
project_id: project.id,
|
|
|
|
service_hook: true,
|
|
|
|
webhook: webhook_url
|
|
|
|
)
|
|
|
|
|
|
|
|
WebMock.stub_request(:post, webhook_url)
|
|
|
|
end
|
|
|
|
|
2021-09-04 01:27:46 +05:30
|
|
|
shared_examples "triggered #{integration_name} integration" do |branches_to_be_notified: nil|
|
2019-12-04 20:38:33 +05:30
|
|
|
before do
|
|
|
|
subject.branches_to_be_notified = branches_to_be_notified if branches_to_be_notified
|
|
|
|
end
|
|
|
|
|
2021-09-04 01:27:46 +05:30
|
|
|
it "calls #{integration_name} API" do
|
2021-04-17 20:07:23 +05:30
|
|
|
result = subject.execute(sample_data)
|
2019-02-15 15:39:39 +05:30
|
|
|
|
2021-04-17 20:07:23 +05:30
|
|
|
expect(result).to be(true)
|
|
|
|
expect(WebMock).to have_requested(:post, webhook_url).once.with { |req|
|
|
|
|
json_body = Gitlab::Json.parse(req.body).with_indifferent_access
|
|
|
|
expect(json_body).to include(payload)
|
|
|
|
}
|
2019-02-15 15:39:39 +05:30
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2021-09-04 01:27:46 +05:30
|
|
|
shared_examples "untriggered #{integration_name} integration" do |branches_to_be_notified: nil|
|
2019-12-04 20:38:33 +05:30
|
|
|
before do
|
|
|
|
subject.branches_to_be_notified = branches_to_be_notified if branches_to_be_notified
|
|
|
|
end
|
|
|
|
|
2021-09-04 01:27:46 +05:30
|
|
|
it "does not call #{integration_name} API" do
|
2019-12-04 20:38:33 +05:30
|
|
|
result = subject.execute(sample_data)
|
|
|
|
|
2021-04-17 20:07:23 +05:30
|
|
|
expect(result).to be(false)
|
|
|
|
expect(WebMock).not_to have_requested(:post, webhook_url)
|
2019-12-04 20:38:33 +05:30
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2019-02-15 15:39:39 +05:30
|
|
|
context "with push events" do
|
|
|
|
let(:sample_data) do
|
|
|
|
Gitlab::DataBuilder::Push.build_sample(project, user)
|
|
|
|
end
|
|
|
|
|
2021-09-04 01:27:46 +05:30
|
|
|
it_behaves_like "triggered #{integration_name} integration"
|
2019-02-15 15:39:39 +05:30
|
|
|
|
2020-01-01 13:55:28 +05:30
|
|
|
it "specifies the webhook when it is configured", if: defined?(client) do
|
2019-02-15 15:39:39 +05:30
|
|
|
expect(client).to receive(:new).with(client_arguments).and_return(double(:chat_service).as_null_object)
|
|
|
|
|
|
|
|
subject.execute(sample_data)
|
|
|
|
end
|
|
|
|
|
2019-12-04 20:38:33 +05:30
|
|
|
context "with default branch" do
|
2019-02-15 15:39:39 +05:30
|
|
|
let(:sample_data) do
|
2019-12-04 20:38:33 +05:30
|
|
|
Gitlab::DataBuilder::Push.build(project: project, user: user, ref: project.default_branch)
|
2019-02-15 15:39:39 +05:30
|
|
|
end
|
|
|
|
|
2019-12-04 20:38:33 +05:30
|
|
|
context "when only default branch are to be notified" do
|
2021-09-04 01:27:46 +05:30
|
|
|
it_behaves_like "triggered #{integration_name} integration", branches_to_be_notified: "default"
|
2019-12-04 20:38:33 +05:30
|
|
|
end
|
2019-02-15 15:39:39 +05:30
|
|
|
|
2019-12-04 20:38:33 +05:30
|
|
|
context "when only protected branches are to be notified" do
|
2021-09-04 01:27:46 +05:30
|
|
|
it_behaves_like "untriggered #{integration_name} integration", branches_to_be_notified: "protected"
|
2019-12-04 20:38:33 +05:30
|
|
|
end
|
2019-02-15 15:39:39 +05:30
|
|
|
|
2019-12-04 20:38:33 +05:30
|
|
|
context "when default and protected branches are to be notified" do
|
2021-09-04 01:27:46 +05:30
|
|
|
it_behaves_like "triggered #{integration_name} integration", branches_to_be_notified: "default_and_protected"
|
2019-02-15 15:39:39 +05:30
|
|
|
end
|
|
|
|
|
2019-12-04 20:38:33 +05:30
|
|
|
context "when all branches are to be notified" do
|
2021-09-04 01:27:46 +05:30
|
|
|
it_behaves_like "triggered #{integration_name} integration", branches_to_be_notified: "all"
|
2019-12-04 20:38:33 +05:30
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
context "with protected branch" do
|
|
|
|
before do
|
|
|
|
create(:protected_branch, project: project, name: "a-protected-branch")
|
|
|
|
end
|
|
|
|
|
|
|
|
let(:sample_data) do
|
|
|
|
Gitlab::DataBuilder::Push.build(project: project, user: user, ref: "a-protected-branch")
|
|
|
|
end
|
|
|
|
|
|
|
|
context "when only default branch are to be notified" do
|
2021-09-04 01:27:46 +05:30
|
|
|
it_behaves_like "untriggered #{integration_name} integration", branches_to_be_notified: "default"
|
2019-12-04 20:38:33 +05:30
|
|
|
end
|
|
|
|
|
|
|
|
context "when only protected branches are to be notified" do
|
2021-09-04 01:27:46 +05:30
|
|
|
it_behaves_like "triggered #{integration_name} integration", branches_to_be_notified: "protected"
|
2019-12-04 20:38:33 +05:30
|
|
|
end
|
2019-02-15 15:39:39 +05:30
|
|
|
|
2019-12-04 20:38:33 +05:30
|
|
|
context "when default and protected branches are to be notified" do
|
2021-09-04 01:27:46 +05:30
|
|
|
it_behaves_like "triggered #{integration_name} integration", branches_to_be_notified: "default_and_protected"
|
2019-12-04 20:38:33 +05:30
|
|
|
end
|
|
|
|
|
|
|
|
context "when all branches are to be notified" do
|
2021-09-04 01:27:46 +05:30
|
|
|
it_behaves_like "triggered #{integration_name} integration", branches_to_be_notified: "all"
|
2019-12-04 20:38:33 +05:30
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
context "with neither default nor protected branch" do
|
|
|
|
let(:sample_data) do
|
|
|
|
Gitlab::DataBuilder::Push.build(project: project, user: user, ref: "a-random-branch")
|
|
|
|
end
|
|
|
|
|
|
|
|
context "when only default branch are to be notified" do
|
2021-09-04 01:27:46 +05:30
|
|
|
it_behaves_like "untriggered #{integration_name} integration", branches_to_be_notified: "default"
|
2019-12-04 20:38:33 +05:30
|
|
|
end
|
|
|
|
|
|
|
|
context "when only protected branches are to be notified" do
|
2021-09-04 01:27:46 +05:30
|
|
|
it_behaves_like "untriggered #{integration_name} integration", branches_to_be_notified: "protected"
|
2019-12-04 20:38:33 +05:30
|
|
|
end
|
|
|
|
|
|
|
|
context "when default and protected branches are to be notified" do
|
2021-09-04 01:27:46 +05:30
|
|
|
it_behaves_like "untriggered #{integration_name} integration", branches_to_be_notified: "default_and_protected"
|
2019-12-04 20:38:33 +05:30
|
|
|
end
|
|
|
|
|
|
|
|
context "when all branches are to be notified" do
|
2021-09-04 01:27:46 +05:30
|
|
|
it_behaves_like "triggered #{integration_name} integration", branches_to_be_notified: "all"
|
2019-02-15 15:39:39 +05:30
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
context "with issue events" do
|
|
|
|
let(:opts) { { title: "Awesome issue", description: "please fix" } }
|
|
|
|
let(:sample_data) do
|
2021-09-30 23:02:18 +05:30
|
|
|
service = Issues::CreateService.new(project: project, current_user: user, params: opts, spam_params: nil)
|
2019-02-15 15:39:39 +05:30
|
|
|
issue = service.execute
|
|
|
|
service.hook_data(issue, "open")
|
|
|
|
end
|
|
|
|
|
2021-09-04 01:27:46 +05:30
|
|
|
it_behaves_like "triggered #{integration_name} integration"
|
2019-02-15 15:39:39 +05:30
|
|
|
end
|
|
|
|
|
|
|
|
context "with merge events" do
|
|
|
|
let(:opts) do
|
|
|
|
{
|
|
|
|
title: "Awesome merge_request",
|
|
|
|
description: "please fix",
|
|
|
|
source_branch: "feature",
|
|
|
|
target_branch: "master"
|
|
|
|
}
|
|
|
|
end
|
|
|
|
|
|
|
|
let(:sample_data) do
|
2021-06-08 01:23:25 +05:30
|
|
|
service = MergeRequests::CreateService.new(project: project, current_user: user, params: opts)
|
2019-02-15 15:39:39 +05:30
|
|
|
merge_request = service.execute
|
|
|
|
service.hook_data(merge_request, "open")
|
|
|
|
end
|
|
|
|
|
|
|
|
before do
|
|
|
|
project.add_developer(user)
|
|
|
|
end
|
|
|
|
|
2021-09-04 01:27:46 +05:30
|
|
|
it_behaves_like "triggered #{integration_name} integration"
|
2019-02-15 15:39:39 +05:30
|
|
|
end
|
|
|
|
|
|
|
|
context "with wiki page events" do
|
|
|
|
let(:opts) do
|
|
|
|
{
|
|
|
|
title: "Awesome wiki_page",
|
|
|
|
content: "Some text describing some thing or another",
|
|
|
|
format: "md",
|
|
|
|
message: "user created page: Awesome wiki_page"
|
|
|
|
}
|
|
|
|
end
|
2020-10-24 23:57:45 +05:30
|
|
|
|
2020-05-24 23:13:21 +05:30
|
|
|
let(:wiki_page) { create(:wiki_page, wiki: project.wiki, **opts) }
|
2019-02-15 15:39:39 +05:30
|
|
|
let(:sample_data) { Gitlab::DataBuilder::WikiPage.build(wiki_page, user, "create") }
|
|
|
|
|
2021-09-04 01:27:46 +05:30
|
|
|
it_behaves_like "triggered #{integration_name} integration"
|
2019-02-15 15:39:39 +05:30
|
|
|
end
|
|
|
|
|
|
|
|
context "with note events" do
|
|
|
|
let(:sample_data) { Gitlab::DataBuilder::Note.build(note, user) }
|
|
|
|
|
|
|
|
context "with commit comment" do
|
|
|
|
let(:note) do
|
|
|
|
create(:note_on_commit,
|
|
|
|
author: user,
|
|
|
|
project: project,
|
|
|
|
commit_id: project.repository.commit.id,
|
|
|
|
note: "a comment on a commit")
|
|
|
|
end
|
|
|
|
|
2021-09-04 01:27:46 +05:30
|
|
|
it_behaves_like "triggered #{integration_name} integration"
|
2019-02-15 15:39:39 +05:30
|
|
|
end
|
|
|
|
|
|
|
|
context "with merge request comment" do
|
|
|
|
let(:note) do
|
|
|
|
create(:note_on_merge_request, project: project, note: "merge request note")
|
|
|
|
end
|
|
|
|
|
2021-09-04 01:27:46 +05:30
|
|
|
it_behaves_like "triggered #{integration_name} integration"
|
2019-02-15 15:39:39 +05:30
|
|
|
end
|
|
|
|
|
|
|
|
context "with issue comment" do
|
|
|
|
let(:note) do
|
|
|
|
create(:note_on_issue, project: project, note: "issue note")
|
|
|
|
end
|
|
|
|
|
2021-09-04 01:27:46 +05:30
|
|
|
it_behaves_like "triggered #{integration_name} integration"
|
2019-02-15 15:39:39 +05:30
|
|
|
end
|
|
|
|
|
|
|
|
context "with snippet comment" do
|
|
|
|
let(:note) do
|
|
|
|
create(:note_on_project_snippet, project: project, note: "snippet note")
|
|
|
|
end
|
|
|
|
|
2021-09-04 01:27:46 +05:30
|
|
|
it_behaves_like "triggered #{integration_name} integration"
|
2019-02-15 15:39:39 +05:30
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
context "with pipeline events" do
|
|
|
|
let(:pipeline) do
|
|
|
|
create(:ci_pipeline,
|
|
|
|
project: project, status: status,
|
|
|
|
sha: project.commit.sha, ref: project.default_branch)
|
|
|
|
end
|
2020-10-24 23:57:45 +05:30
|
|
|
|
2019-02-15 15:39:39 +05:30
|
|
|
let(:sample_data) { Gitlab::DataBuilder::Pipeline.build(pipeline) }
|
|
|
|
|
|
|
|
context "with failed pipeline" do
|
|
|
|
let(:status) { "failed" }
|
|
|
|
|
2021-09-04 01:27:46 +05:30
|
|
|
it_behaves_like "triggered #{integration_name} integration"
|
2019-02-15 15:39:39 +05:30
|
|
|
end
|
|
|
|
|
|
|
|
context "with succeeded pipeline" do
|
|
|
|
let(:status) { "success" }
|
|
|
|
|
|
|
|
context "with default notify_only_broken_pipelines" do
|
2021-09-04 01:27:46 +05:30
|
|
|
it "does not call #{integration_name} API" do
|
2019-02-15 15:39:39 +05:30
|
|
|
result = subject.execute(sample_data)
|
|
|
|
|
|
|
|
expect(result).to be_falsy
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
context "when notify_only_broken_pipelines is false" do
|
|
|
|
before do
|
|
|
|
subject.notify_only_broken_pipelines = false
|
|
|
|
end
|
|
|
|
|
2021-09-04 01:27:46 +05:30
|
|
|
it_behaves_like "triggered #{integration_name} integration"
|
2019-02-15 15:39:39 +05:30
|
|
|
end
|
|
|
|
end
|
|
|
|
|
2019-12-04 20:38:33 +05:30
|
|
|
context "with default branch" do
|
|
|
|
let(:sample_data) do
|
|
|
|
Gitlab::DataBuilder::Push.build(project: project, user: user, ref: project.default_branch)
|
2019-02-15 15:39:39 +05:30
|
|
|
end
|
|
|
|
|
2019-12-04 20:38:33 +05:30
|
|
|
context "when only default branch are to be notified" do
|
2021-09-04 01:27:46 +05:30
|
|
|
it_behaves_like "triggered #{integration_name} integration", branches_to_be_notified: "default"
|
2019-12-04 20:38:33 +05:30
|
|
|
end
|
2019-02-15 15:39:39 +05:30
|
|
|
|
2019-12-04 20:38:33 +05:30
|
|
|
context "when only protected branches are to be notified" do
|
2021-09-04 01:27:46 +05:30
|
|
|
it_behaves_like "untriggered #{integration_name} integration", branches_to_be_notified: "protected"
|
2019-12-04 20:38:33 +05:30
|
|
|
end
|
2019-02-15 15:39:39 +05:30
|
|
|
|
2019-12-04 20:38:33 +05:30
|
|
|
context "when default and protected branches are to be notified" do
|
2021-09-04 01:27:46 +05:30
|
|
|
it_behaves_like "triggered #{integration_name} integration", branches_to_be_notified: "default_and_protected"
|
2019-02-15 15:39:39 +05:30
|
|
|
end
|
|
|
|
|
2019-12-04 20:38:33 +05:30
|
|
|
context "when all branches are to be notified" do
|
2021-09-04 01:27:46 +05:30
|
|
|
it_behaves_like "triggered #{integration_name} integration", branches_to_be_notified: "all"
|
2019-12-04 20:38:33 +05:30
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
context "with protected branch" do
|
|
|
|
before do
|
|
|
|
create(:protected_branch, project: project, name: "a-protected-branch")
|
|
|
|
end
|
|
|
|
|
|
|
|
let(:sample_data) do
|
|
|
|
Gitlab::DataBuilder::Push.build(project: project, user: user, ref: "a-protected-branch")
|
|
|
|
end
|
|
|
|
|
|
|
|
context "when only default branch are to be notified" do
|
2021-09-04 01:27:46 +05:30
|
|
|
it_behaves_like "untriggered #{integration_name} integration", branches_to_be_notified: "default"
|
2019-12-04 20:38:33 +05:30
|
|
|
end
|
|
|
|
|
|
|
|
context "when only protected branches are to be notified" do
|
2021-09-04 01:27:46 +05:30
|
|
|
it_behaves_like "triggered #{integration_name} integration", branches_to_be_notified: "protected"
|
2019-12-04 20:38:33 +05:30
|
|
|
end
|
|
|
|
|
|
|
|
context "when default and protected branches are to be notified" do
|
2021-09-04 01:27:46 +05:30
|
|
|
it_behaves_like "triggered #{integration_name} integration", branches_to_be_notified: "default_and_protected"
|
2019-12-04 20:38:33 +05:30
|
|
|
end
|
|
|
|
|
|
|
|
context "when all branches are to be notified" do
|
2021-09-04 01:27:46 +05:30
|
|
|
it_behaves_like "triggered #{integration_name} integration", branches_to_be_notified: "all"
|
2019-12-04 20:38:33 +05:30
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
context "with neither default nor protected branch" do
|
|
|
|
let(:sample_data) do
|
|
|
|
Gitlab::DataBuilder::Push.build(project: project, user: user, ref: "a-random-branch")
|
|
|
|
end
|
|
|
|
|
|
|
|
context "when only default branch are to be notified" do
|
2021-09-04 01:27:46 +05:30
|
|
|
it_behaves_like "untriggered #{integration_name} integration", branches_to_be_notified: "default"
|
2019-12-04 20:38:33 +05:30
|
|
|
end
|
|
|
|
|
|
|
|
context "when only protected branches are to be notified" do
|
2021-09-04 01:27:46 +05:30
|
|
|
it_behaves_like "untriggered #{integration_name} integration", branches_to_be_notified: "protected"
|
2019-12-04 20:38:33 +05:30
|
|
|
end
|
|
|
|
|
|
|
|
context "when default and protected branches are to be notified" do
|
2021-09-04 01:27:46 +05:30
|
|
|
it_behaves_like "untriggered #{integration_name} integration", branches_to_be_notified: "default_and_protected"
|
2019-12-04 20:38:33 +05:30
|
|
|
end
|
2019-02-15 15:39:39 +05:30
|
|
|
|
2019-12-04 20:38:33 +05:30
|
|
|
context "when all branches are to be notified" do
|
2021-09-04 01:27:46 +05:30
|
|
|
it_behaves_like "triggered #{integration_name} integration", branches_to_be_notified: "all"
|
2019-02-15 15:39:39 +05:30
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|
|
|
|
end
|