From 079a75088e482c5c32cbe8b4606584256284316b Mon Sep 17 00:00:00 2001 From: blackst0ne Date: Wed, 7 Nov 2018 09:12:02 +1100 Subject: [PATCH] Refactor specs --- .../project_services/discord_service_spec.rb | 233 +---------------- .../hangouts_chat_service_spec.rb | 238 +---------------- .../models/chat_service_spec.rb | 242 ++++++++++++++++++ .../models/project_services_spec.rb | 9 - 4 files changed, 253 insertions(+), 469 deletions(-) create mode 100644 spec/support/shared_examples/models/chat_service_spec.rb delete mode 100644 spec/support/shared_examples/models/project_services_spec.rb diff --git a/spec/models/project_services/discord_service_spec.rb b/spec/models/project_services/discord_service_spec.rb index 99c2ada7ad8..52e2314b080 100644 --- a/spec/models/project_services/discord_service_spec.rb +++ b/spec/models/project_services/discord_service_spec.rb @@ -3,234 +3,9 @@ require "spec_helper" describe DiscordService do - describe "Associations" do - it { is_expected.to belong_to :project } - it { is_expected.to have_one :service_hook } - end - - describe "Validations" do - context "when service is active" do - before do - subject.active = true - end - - it { is_expected.to validate_presence_of(:webhook) } - it_behaves_like "issue tracker service URL attribute", :webhook - end - - context "when service is inactive" do - before do - subject.active = false - end - - it { is_expected.not_to validate_presence_of(:webhook) } - end - end - - 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 - - context "with push events" do - let(:sample_data) do - Gitlab::DataBuilder::Push.build_sample(project, user) - end - - it_behaves_like "Interacts with external service", "Discord", content_key: :content - - it "specifies the webhook when it is configured" do - expect(Discordrb::Webhooks::Client).to receive(:new).with(url: webhook_url).and_return(double(:discord_service).as_null_object) - - subject.execute(sample_data) - end - - context "with not default branch" do - let(:sample_data) do - Gitlab::DataBuilder::Push.build(project, user, nil, nil, "not-the-default-branch") - end - - context "when notify_only_default_branch enabled" do - before do - subject.notify_only_default_branch = true - end - - it "does not call the Discord Webhooks API" do - result = subject.execute(sample_data) - - expect(result).to be_falsy - end - end - - context "when notify_only_default_branch disabled" do - before do - subject.notify_only_default_branch = false - end - - it_behaves_like "Interacts with external service", "Discord", content_key: :content - end - end - end - - context "with issue events" do - let(:opts) { { title: "Awesome issue", description: "please fix" } } - let(:sample_data) do - service = Issues::CreateService.new(project, user, opts) - issue = service.execute - service.hook_data(issue, "open") - end - - it_behaves_like "Interacts with external service", "Discord", content_key: :content - 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 - service = MergeRequests::CreateService.new(project, user, opts) - merge_request = service.execute - service.hook_data(merge_request, "open") - end - - before do - project.add_developer(user) - end - - it_behaves_like "Interacts with external service", "Discord", content_key: :content - 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 - let(:wiki_page) { create(:wiki_page, wiki: project.wiki, attrs: opts) } - let(:sample_data) { Gitlab::DataBuilder::WikiPage.build(wiki_page, user, "create") } - - it_behaves_like "Interacts with external service", "Discord", content_key: :content - 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 - - it_behaves_like "Interacts with external service", "Discord", content_key: :content - end - - context "with merge request comment" do - let(:note) do - create(:note_on_merge_request, project: project, note: "merge request note") - end - - it_behaves_like "Interacts with external service", "Discord", content_key: :content - end - - context "with issue comment" do - let(:note) do - create(:note_on_issue, project: project, note: "issue note") - end - - it_behaves_like "Interacts with external service", "Discord", content_key: :content - end - - context "with snippet comment" do - let(:note) do - create(:note_on_project_snippet, project: project, note: "snippet note") - end - - it_behaves_like "Interacts with external service", "Discord", content_key: :content - 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 - let(:sample_data) { Gitlab::DataBuilder::Pipeline.build(pipeline) } - - context "with failed pipeline" do - let(:status) { "failed" } - - it_behaves_like "Interacts with external service", "Discord", content_key: :content - end - - context "with succeeded pipeline" do - let(:status) { "success" } - - context "with default notify_only_broken_pipelines" do - it "does not call Discord Webhooks API" do - 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 - - it_behaves_like "Interacts with external service", "Discord", content_key: :content - end - end - - context "with not default branch" do - let(:pipeline) do - create(:ci_pipeline, project: project, status: "failed", ref: "not-the-default-branch") - end - - context "when notify_only_default_branch enabled" do - before do - subject.notify_only_default_branch = true - end - - it "does not call the Discord Webhooks API" do - result = subject.execute(sample_data) - - expect(result).to be_falsy - end - end - - context "when notify_only_default_branch disabled" do - before do - subject.notify_only_default_branch = false - end - - it_behaves_like "Interacts with external service", "Discord", content_key: :content - end - end - end + it_behaves_like "chat service", "Hangouts Chat" do + let(:client) { Discordrb::Webhooks::Client } + let(:client_arguments) { { url: webhook_url } } + let(:content_key) { :content } end end diff --git a/spec/models/project_services/hangouts_chat_service_spec.rb b/spec/models/project_services/hangouts_chat_service_spec.rb index 3557f62fde2..0505ac9b49c 100644 --- a/spec/models/project_services/hangouts_chat_service_spec.rb +++ b/spec/models/project_services/hangouts_chat_service_spec.rb @@ -1,235 +1,11 @@ -require 'spec_helper' +# frozen_string_literal: true + +require "spec_helper" describe HangoutsChatService do - describe 'Associations' do - it { is_expected.to belong_to :project } - it { is_expected.to have_one :service_hook } - end - - describe 'Validations' do - context 'when service is active' do - before do - subject.active = true - end - - it { is_expected.to validate_presence_of(:webhook) } - it_behaves_like 'issue tracker service URL attribute', :webhook - end - - context 'when service is inactive' do - before do - subject.active = false - end - - it { is_expected.not_to validate_presence_of(:webhook) } - end - end - - 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 - - context 'with push events' do - let(:sample_data) do - Gitlab::DataBuilder::Push.build_sample(project, user) - end - - it_behaves_like "Interacts with external service", "Hangouts Chat", content_key: :text - - it 'specifies the webhook when it is configured' do - expect(HangoutsChat::Sender).to receive(:new).with(webhook_url).and_return(double(:hangouts_chat_service).as_null_object) - - subject.execute(sample_data) - end - - context 'with not default branch' do - let(:sample_data) do - Gitlab::DataBuilder::Push.build(project, user, nil, nil, 'not-the-default-branch') - end - - context 'when notify_only_default_branch enabled' do - before do - subject.notify_only_default_branch = true - end - - it 'does not call the Hangouts Chat API' do - result = subject.execute(sample_data) - - expect(result).to be_falsy - end - end - - context 'when notify_only_default_branch disabled' do - before do - subject.notify_only_default_branch = false - end - - it_behaves_like "Interacts with external service", "Hangouts Chat", content_key: :text - end - end - end - - context 'with issue events' do - let(:opts) { { title: 'Awesome issue', description: 'please fix' } } - let(:sample_data) do - service = Issues::CreateService.new(project, user, opts) - issue = service.execute - service.hook_data(issue, 'open') - end - - it_behaves_like "Interacts with external service", "Hangouts Chat", content_key: :text - 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 - service = MergeRequests::CreateService.new(project, user, opts) - merge_request = service.execute - service.hook_data(merge_request, 'open') - end - - before do - project.add_developer(user) - end - - it_behaves_like "Interacts with external service", "Hangouts Chat", content_key: :text - 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 - let(:wiki_page) { create(:wiki_page, wiki: project.wiki, attrs: opts) } - let(:sample_data) { Gitlab::DataBuilder::WikiPage.build(wiki_page, user, 'create') } - - it_behaves_like "Interacts with external service", "Hangouts Chat", content_key: :text - 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 - - it_behaves_like "Interacts with external service", "Hangouts Chat", content_key: :text - end - - context 'with merge request comment' do - let(:note) do - create(:note_on_merge_request, project: project, - note: 'merge request note') - end - - it_behaves_like "Interacts with external service", "Hangouts Chat", content_key: :text - end - - context 'with issue comment' do - let(:note) do - create(:note_on_issue, project: project, note: 'issue note') - end - - it_behaves_like "Interacts with external service", "Hangouts Chat", content_key: :text - end - - context 'with snippet comment' do - let(:note) do - create(:note_on_project_snippet, project: project, - note: 'snippet note') - end - - it_behaves_like "Interacts with external service", "Hangouts Chat", content_key: :text - 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 - let(:sample_data) { Gitlab::DataBuilder::Pipeline.build(pipeline) } - - context 'with failed pipeline' do - let(:status) { 'failed' } - - it_behaves_like "Interacts with external service", "Hangouts Chat", content_key: :text - end - - context 'with succeeded pipeline' do - let(:status) { 'success' } - - context 'with default notify_only_broken_pipelines' do - it 'does not call Hangouts Chat API' do - 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 - - it_behaves_like "Interacts with external service", "Hangouts Chat", content_key: :text - end - end - - context 'with not default branch' do - let(:pipeline) do - create(:ci_pipeline, project: project, status: 'failed', ref: 'not-the-default-branch') - end - - context 'when notify_only_default_branch enabled' do - before do - subject.notify_only_default_branch = true - end - - it 'does not call the Hangouts Chat API' do - result = subject.execute(sample_data) - - expect(result).to be_falsy - end - end - - context 'when notify_only_default_branch disabled' do - before do - subject.notify_only_default_branch = false - end - - it_behaves_like "Interacts with external service", "Hangouts Chat", content_key: :text - end - end - end + it_behaves_like "chat service", "Hangouts Chat" do + let(:client) { HangoutsChat::Sender } + let(:client_arguments) { webhook_url } + let(:content_key) { :text } end end diff --git a/spec/support/shared_examples/models/chat_service_spec.rb b/spec/support/shared_examples/models/chat_service_spec.rb new file mode 100644 index 00000000000..cf1d52a9616 --- /dev/null +++ b/spec/support/shared_examples/models/chat_service_spec.rb @@ -0,0 +1,242 @@ +require "spec_helper" + +shared_examples_for "chat service" do |service_name| + describe "Associations" do + it { is_expected.to belong_to :project } + it { is_expected.to have_one :service_hook } + end + + describe "Validations" do + context "when service is active" do + before do + subject.active = true + end + + it { is_expected.to validate_presence_of(:webhook) } + it_behaves_like "issue tracker service URL attribute", :webhook + end + + context "when service is inactive" do + before do + subject.active = false + end + + it { is_expected.not_to validate_presence_of(:webhook) } + end + end + + 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 + + shared_examples "#{service_name} service" do + it "calls #{service_name} API" do + subject.execute(sample_data) + + expect(WebMock).to have_requested(:post, webhook_url).with { |req| req.body =~ /\A{"#{content_key}":.+}\Z/ }.once + end + end + + context "with push events" do + let(:sample_data) do + Gitlab::DataBuilder::Push.build_sample(project, user) + end + + it_behaves_like "#{service_name} service" + + it "specifies the webhook when it is configured" do + expect(client).to receive(:new).with(client_arguments).and_return(double(:chat_service).as_null_object) + + subject.execute(sample_data) + end + + context "with not default branch" do + let(:sample_data) do + Gitlab::DataBuilder::Push.build(project, user, nil, nil, "not-the-default-branch") + end + + context "when notify_only_default_branch enabled" do + before do + subject.notify_only_default_branch = true + end + + it "does not call the Discord Webhooks API" do + result = subject.execute(sample_data) + + expect(result).to be_falsy + end + end + + context "when notify_only_default_branch disabled" do + before do + subject.notify_only_default_branch = false + end + + it_behaves_like "#{service_name} service" + end + end + end + + context "with issue events" do + let(:opts) { { title: "Awesome issue", description: "please fix" } } + let(:sample_data) do + service = Issues::CreateService.new(project, user, opts) + issue = service.execute + service.hook_data(issue, "open") + end + + it_behaves_like "#{service_name} service" + 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 + service = MergeRequests::CreateService.new(project, user, opts) + merge_request = service.execute + service.hook_data(merge_request, "open") + end + + before do + project.add_developer(user) + end + + it_behaves_like "#{service_name} service" + 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 + let(:wiki_page) { create(:wiki_page, wiki: project.wiki, attrs: opts) } + let(:sample_data) { Gitlab::DataBuilder::WikiPage.build(wiki_page, user, "create") } + + it_behaves_like "#{service_name} service" + 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 + + it_behaves_like "#{service_name} service" + end + + context "with merge request comment" do + let(:note) do + create(:note_on_merge_request, project: project, note: "merge request note") + end + + it_behaves_like "#{service_name} service" + end + + context "with issue comment" do + let(:note) do + create(:note_on_issue, project: project, note: "issue note") + end + + it_behaves_like "#{service_name} service" + end + + context "with snippet comment" do + let(:note) do + create(:note_on_project_snippet, project: project, note: "snippet note") + end + + it_behaves_like "#{service_name} service" + 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 + let(:sample_data) { Gitlab::DataBuilder::Pipeline.build(pipeline) } + + context "with failed pipeline" do + let(:status) { "failed" } + + it_behaves_like "#{service_name} service" + end + + context "with succeeded pipeline" do + let(:status) { "success" } + + context "with default notify_only_broken_pipelines" do + it "does not call Discord Webhooks API" do + 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 + + it_behaves_like "#{service_name} service" + end + end + + context "with not default branch" do + let(:pipeline) do + create(:ci_pipeline, project: project, status: "failed", ref: "not-the-default-branch") + end + + context "when notify_only_default_branch enabled" do + before do + subject.notify_only_default_branch = true + end + + it "does not call the Discord Webhooks API" do + result = subject.execute(sample_data) + + expect(result).to be_falsy + end + end + + context "when notify_only_default_branch disabled" do + before do + subject.notify_only_default_branch = false + end + + it_behaves_like "#{service_name} service" + end + end + end + end +end diff --git a/spec/support/shared_examples/models/project_services_spec.rb b/spec/support/shared_examples/models/project_services_spec.rb deleted file mode 100644 index 4eec52a2d52..00000000000 --- a/spec/support/shared_examples/models/project_services_spec.rb +++ /dev/null @@ -1,9 +0,0 @@ -require "spec_helper" - -shared_examples_for "Interacts with external service" do |service_name, content_key:| - it "calls #{service_name} Webhooks API" do - subject.execute(sample_data) - - expect(WebMock).to have_requested(:post, webhook_url).with { |req| req.body =~ /\A{"#{content_key}":.+}\Z/ }.once - end -end