debian-mirror-gitlab/spec/services/system_note_service_spec.rb

1187 lines
37 KiB
Ruby
Raw Normal View History

2015-09-11 14:41:01 +05:30
require 'spec_helper'
2017-09-10 17:25:29 +05:30
describe SystemNoteService do
include Gitlab::Routing
2018-03-17 18:26:18 +05:30
include RepoHelpers
2017-08-17 22:00:37 +05:30
2018-03-17 18:26:18 +05:30
set(:group) { create(:group) }
set(:project) { create(:project, :repository, group: group) }
set(:author) { create(:user) }
2015-09-11 14:41:01 +05:30
let(:noteable) { create(:issue, project: project) }
2017-08-17 22:00:37 +05:30
let(:issue) { noteable }
2015-09-11 14:41:01 +05:30
shared_examples_for 'a system note' do
2017-08-17 22:00:37 +05:30
let(:expected_noteable) { noteable }
let(:commit_count) { nil }
2018-03-17 18:26:18 +05:30
it 'has the correct attributes', :aggregate_failures do
2015-09-11 14:41:01 +05:30
expect(subject).to be_valid
2018-03-17 18:26:18 +05:30
expect(subject).to be_system
2015-09-11 14:41:01 +05:30
2017-08-17 22:00:37 +05:30
expect(subject.noteable).to eq expected_noteable
2015-09-11 14:41:01 +05:30
expect(subject.project).to eq project
expect(subject.author).to eq author
2018-03-17 18:26:18 +05:30
expect(subject.system_note_metadata.action).to eq(action)
expect(subject.system_note_metadata.commit_count).to eq(commit_count)
2017-08-17 22:00:37 +05:30
end
2015-09-11 14:41:01 +05:30
end
describe '.add_commits' do
subject { described_class.add_commits(noteable, project, author, new_commits, old_commits, oldrev) }
2018-03-17 18:26:18 +05:30
let(:noteable) { create(:merge_request, source_project: project, target_project: project) }
2015-09-11 14:41:01 +05:30
let(:new_commits) { noteable.commits }
let(:old_commits) { [] }
let(:oldrev) { nil }
2017-08-17 22:00:37 +05:30
it_behaves_like 'a system note' do
let(:commit_count) { new_commits.size }
let(:action) { 'commit' }
end
2015-09-11 14:41:01 +05:30
describe 'note body' do
let(:note_lines) { subject.note.split("\n").reject(&:blank?) }
2016-11-03 12:29:30 +05:30
describe 'comparison diff link line' do
it 'adds the comparison text' do
expect(note_lines[2]).to match "[Compare with previous version]"
end
end
2015-09-11 14:41:01 +05:30
context 'without existing commits' do
it 'adds a message header' do
2017-08-17 22:00:37 +05:30
expect(note_lines[0]).to eq "added #{new_commits.size} commits"
2015-09-11 14:41:01 +05:30
end
2018-03-17 18:26:18 +05:30
it 'adds a message for each commit' do
decoded_note_content = HTMLEntities.new.decode(subject.note)
new_commits.each do |commit|
expect(decoded_note_content).to include("<li>#{commit.short_id} - #{commit.title}</li>")
2015-09-11 14:41:01 +05:30
end
end
end
describe 'summary line for existing commits' do
let(:summary_line) { note_lines[1] }
context 'with one existing commit' do
let(:old_commits) { [noteable.commits.last] }
it 'includes the existing commit' do
2018-03-17 18:26:18 +05:30
expect(summary_line).to start_with("<ul><li>#{old_commits.first.short_id} - 1 commit from branch <code>feature</code>")
2015-09-11 14:41:01 +05:30
end
end
context 'with multiple existing commits' do
let(:old_commits) { noteable.commits[3..-1] }
context 'with oldrev' do
let(:oldrev) { noteable.commits[2].id }
2018-03-17 18:26:18 +05:30
it 'includes a commit range and count' do
expect(summary_line)
.to start_with("<ul><li>#{Commit.truncate_sha(oldrev)}...#{old_commits.last.short_id} - 26 commits from branch <code>feature</code>")
2015-09-11 14:41:01 +05:30
end
end
context 'without oldrev' do
2018-03-17 18:26:18 +05:30
it 'includes a commit range and count' do
expect(summary_line)
.to start_with("<ul><li>#{old_commits[0].short_id}..#{old_commits[-1].short_id} - 26 commits from branch <code>feature</code>")
2015-09-11 14:41:01 +05:30
end
end
context 'on a fork' do
before do
expect(noteable).to receive(:for_fork?).and_return(true)
end
it 'includes the project namespace' do
2018-03-17 18:26:18 +05:30
expect(summary_line).to include("<code>#{noteable.target_project_namespace}:feature</code>")
2015-09-11 14:41:01 +05:30
end
end
end
end
end
end
describe '.change_assignee' do
subject { described_class.change_assignee(noteable, project, author, assignee) }
let(:assignee) { create(:user) }
2017-08-17 22:00:37 +05:30
it_behaves_like 'a system note' do
let(:action) { 'assignee' }
end
2015-09-11 14:41:01 +05:30
context 'when assignee added' do
it 'sets the note text' do
2017-08-17 22:00:37 +05:30
expect(subject.note).to eq "assigned to @#{assignee.username}"
2015-09-11 14:41:01 +05:30
end
end
context 'when assignee removed' do
let(:assignee) { nil }
it 'sets the note text' do
2017-08-17 22:00:37 +05:30
expect(subject.note).to eq 'removed assignee'
2015-09-11 14:41:01 +05:30
end
end
end
2017-08-17 22:00:37 +05:30
describe '.change_issue_assignees' do
subject { described_class.change_issue_assignees(noteable, project, author, [assignee]) }
let(:assignee) { create(:user) }
let(:assignee1) { create(:user) }
let(:assignee2) { create(:user) }
let(:assignee3) { create(:user) }
it_behaves_like 'a system note' do
let(:action) { 'assignee' }
end
def build_note(old_assignees, new_assignees)
issue.assignees = new_assignees
described_class.change_issue_assignees(issue, project, author, old_assignees).note
end
it 'builds a correct phrase when an assignee is added to a non-assigned issue' do
expect(build_note([], [assignee1])).to eq "assigned to @#{assignee1.username}"
end
it 'builds a correct phrase when assignee removed' do
2018-03-17 18:26:18 +05:30
expect(build_note([assignee1], [])).to eq "unassigned @#{assignee1.username}"
2017-08-17 22:00:37 +05:30
end
it 'builds a correct phrase when assignees changed' do
expect(build_note([assignee1], [assignee2])).to eq \
"assigned to @#{assignee2.username} and unassigned @#{assignee1.username}"
end
it 'builds a correct phrase when three assignees removed and one added' do
expect(build_note([assignee, assignee1, assignee2], [assignee3])).to eq \
"assigned to @#{assignee3.username} and unassigned @#{assignee.username}, @#{assignee1.username}, and @#{assignee2.username}"
end
it 'builds a correct phrase when one assignee changed from a set' do
expect(build_note([assignee, assignee1], [assignee, assignee2])).to eq \
"assigned to @#{assignee2.username} and unassigned @#{assignee1.username}"
end
it 'builds a correct phrase when one assignee removed from a set' do
expect(build_note([assignee, assignee1, assignee2], [assignee, assignee1])).to eq \
"unassigned @#{assignee2.username}"
end
end
2015-09-11 14:41:01 +05:30
describe '.change_label' do
subject { described_class.change_label(noteable, project, author, added, removed) }
2018-03-17 18:26:18 +05:30
let(:labels) { create_list(:label, 2, project: project) }
2015-09-11 14:41:01 +05:30
let(:added) { [] }
let(:removed) { [] }
2017-08-17 22:00:37 +05:30
it_behaves_like 'a system note' do
let(:action) { 'label' }
end
2015-09-11 14:41:01 +05:30
context 'with added labels' do
let(:added) { labels }
let(:removed) { [] }
it 'sets the note text' do
2017-08-17 22:00:37 +05:30
expect(subject.note).to eq "added ~#{labels[0].id} ~#{labels[1].id} labels"
2015-09-11 14:41:01 +05:30
end
end
context 'with removed labels' do
let(:added) { [] }
let(:removed) { labels }
it 'sets the note text' do
2017-08-17 22:00:37 +05:30
expect(subject.note).to eq "removed ~#{labels[0].id} ~#{labels[1].id} labels"
2015-09-11 14:41:01 +05:30
end
end
context 'with added and removed labels' do
let(:added) { [labels[0]] }
let(:removed) { [labels[1]] }
it 'sets the note text' do
2017-08-17 22:00:37 +05:30
expect(subject.note).to eq "added ~#{labels[0].id} and removed ~#{labels[1].id} labels"
2015-09-11 14:41:01 +05:30
end
end
end
describe '.change_milestone' do
2017-09-10 17:25:29 +05:30
context 'for a project milestone' do
subject { described_class.change_milestone(noteable, project, author, milestone) }
2015-09-11 14:41:01 +05:30
2017-09-10 17:25:29 +05:30
let(:milestone) { create(:milestone, project: project) }
2015-09-11 14:41:01 +05:30
2017-09-10 17:25:29 +05:30
it_behaves_like 'a system note' do
let(:action) { 'milestone' }
end
2015-09-11 14:41:01 +05:30
2017-09-10 17:25:29 +05:30
context 'when milestone added' do
it 'sets the note text' do
2018-03-17 18:26:18 +05:30
reference = milestone.to_reference(format: :iid)
expect(subject.note).to eq "changed milestone to #{reference}"
2017-09-10 17:25:29 +05:30
end
end
context 'when milestone removed' do
let(:milestone) { nil }
it 'sets the note text' do
expect(subject.note).to eq 'removed milestone'
end
2015-09-11 14:41:01 +05:30
end
end
2017-09-10 17:25:29 +05:30
context 'for a group milestone' do
subject { described_class.change_milestone(noteable, project, author, milestone) }
2015-09-11 14:41:01 +05:30
2017-09-10 17:25:29 +05:30
let(:milestone) { create(:milestone, group: group) }
it_behaves_like 'a system note' do
let(:action) { 'milestone' }
end
context 'when milestone added' do
it 'sets the note text to use the milestone name' do
expect(subject.note).to eq "changed milestone to #{milestone.to_reference(format: :name)}"
end
end
context 'when milestone removed' do
let(:milestone) { nil }
it 'sets the note text' do
expect(subject.note).to eq 'removed milestone'
end
2015-09-11 14:41:01 +05:30
end
end
end
describe '.change_status' do
subject { described_class.change_status(noteable, project, author, status, source) }
2017-08-17 22:00:37 +05:30
context 'with status reopened' do
let(:status) { 'reopened' }
let(:source) { nil }
2015-09-11 14:41:01 +05:30
2017-08-17 22:00:37 +05:30
it_behaves_like 'a system note' do
let(:action) { 'opened' }
end
end
2015-09-11 14:41:01 +05:30
context 'with a source' do
2017-08-17 22:00:37 +05:30
let(:status) { 'opened' }
2015-09-11 14:41:01 +05:30
let(:source) { double('commit', gfm_reference: 'commit 123456') }
it 'sets the note text' do
2017-08-17 22:00:37 +05:30
expect(subject.note).to eq "#{status} via commit 123456"
2015-09-11 14:41:01 +05:30
end
end
end
2017-08-17 22:00:37 +05:30
describe '.merge_when_pipeline_succeeds' do
let(:pipeline) { build(:ci_pipeline_without_jobs )}
let(:noteable) do
create(:merge_request, source_project: project, target_project: project)
end
2015-12-23 02:04:40 +05:30
2017-08-17 22:00:37 +05:30
subject { described_class.merge_when_pipeline_succeeds(noteable, project, author, noteable.diff_head_commit) }
2015-12-23 02:04:40 +05:30
2017-08-17 22:00:37 +05:30
it_behaves_like 'a system note' do
let(:action) { 'merge' }
end
2015-12-23 02:04:40 +05:30
2017-08-17 22:00:37 +05:30
it "posts the 'merge when pipeline succeeds' system note" do
2018-03-17 18:26:18 +05:30
expect(subject.note).to match(%r{enabled an automatic merge when the pipeline for (\w+/\w+@)?\h{40} succeeds})
2015-12-23 02:04:40 +05:30
end
end
2017-08-17 22:00:37 +05:30
describe '.cancel_merge_when_pipeline_succeeds' do
let(:noteable) do
create(:merge_request, source_project: project, target_project: project)
end
2015-12-23 02:04:40 +05:30
2017-08-17 22:00:37 +05:30
subject { described_class.cancel_merge_when_pipeline_succeeds(noteable, project, author) }
2015-12-23 02:04:40 +05:30
2017-08-17 22:00:37 +05:30
it_behaves_like 'a system note' do
let(:action) { 'merge' }
end
2015-12-23 02:04:40 +05:30
2017-08-17 22:00:37 +05:30
it "posts the 'merge when pipeline succeeds' system note" do
expect(subject.note).to eq "canceled the automatic merge"
2015-12-23 02:04:40 +05:30
end
end
2015-09-11 14:41:01 +05:30
describe '.change_title' do
2017-08-17 22:00:37 +05:30
let(:noteable) { create(:issue, project: project, title: 'Lorem ipsum') }
2015-09-11 14:41:01 +05:30
subject { described_class.change_title(noteable, project, author, 'Old title') }
context 'when noteable responds to `title`' do
2017-08-17 22:00:37 +05:30
it_behaves_like 'a system note' do
let(:action) { 'title' }
end
2015-09-11 14:41:01 +05:30
it 'sets the note text' do
2017-09-10 17:25:29 +05:30
expect(subject.note)
.to eq "changed title from **{-Old title-}** to **{+Lorem ipsum+}**"
2017-08-17 22:00:37 +05:30
end
end
end
describe '.change_description' do
subject { described_class.change_description(noteable, project, author) }
context 'when noteable responds to `description`' do
it_behaves_like 'a system note' do
let(:action) { 'description' }
end
it 'sets the note text' do
expect(subject.note).to eq('changed the description')
2015-09-11 14:41:01 +05:30
end
end
2016-06-02 11:05:42 +05:30
end
2015-09-11 14:41:01 +05:30
2016-06-02 11:05:42 +05:30
describe '.change_issue_confidentiality' do
subject { described_class.change_issue_confidentiality(noteable, project, author) }
2015-09-11 14:41:01 +05:30
2017-08-17 22:00:37 +05:30
context 'issue has been made confidential' do
before do
noteable.update_attribute(:confidential, true)
end
it_behaves_like 'a system note' do
let(:action) { 'confidential' }
end
it 'sets the note text' do
expect(subject.note).to eq 'made the issue confidential'
end
end
context 'issue has been made visible' do
it_behaves_like 'a system note' do
let(:action) { 'visible' }
end
2016-06-02 11:05:42 +05:30
it 'sets the note text' do
2017-08-17 22:00:37 +05:30
expect(subject.note).to eq 'made the issue visible to everyone'
2015-09-11 14:41:01 +05:30
end
end
end
describe '.change_branch' do
subject { described_class.change_branch(noteable, project, author, 'target', old_branch, new_branch) }
2017-08-17 22:00:37 +05:30
2015-09-11 14:41:01 +05:30
let(:old_branch) { 'old_branch'}
let(:new_branch) { 'new_branch'}
2017-08-17 22:00:37 +05:30
it_behaves_like 'a system note' do
let(:action) { 'branch' }
end
2015-09-11 14:41:01 +05:30
context 'when target branch name changed' do
it 'sets the note text' do
2017-08-17 22:00:37 +05:30
expect(subject.note).to eq "changed target branch from `#{old_branch}` to `#{new_branch}`"
2015-09-11 14:41:01 +05:30
end
end
end
2015-10-24 18:46:33 +05:30
describe '.change_branch_presence' do
subject { described_class.change_branch_presence(noteable, project, author, :source, 'feature', :delete) }
2017-08-17 22:00:37 +05:30
it_behaves_like 'a system note' do
let(:action) { 'branch' }
end
2015-10-24 18:46:33 +05:30
context 'when source branch deleted' do
it 'sets the note text' do
2017-08-17 22:00:37 +05:30
expect(subject.note).to eq "deleted source branch `feature`"
2015-10-24 18:46:33 +05:30
end
end
end
2016-06-02 11:05:42 +05:30
describe '.new_issue_branch' do
subject { described_class.new_issue_branch(noteable, project, author, "1-mepmep") }
2017-08-17 22:00:37 +05:30
it_behaves_like 'a system note' do
let(:action) { 'branch' }
end
2016-06-02 11:05:42 +05:30
context 'when a branch is created from the new branch button' do
it 'sets the note text' do
2017-08-17 22:00:37 +05:30
expect(subject.note).to start_with("created branch [`1-mepmep`]")
2016-06-02 11:05:42 +05:30
end
end
end
2015-09-11 14:41:01 +05:30
describe '.cross_reference' do
subject { described_class.cross_reference(noteable, mentioner, author) }
let(:mentioner) { create(:issue, project: project) }
2017-08-17 22:00:37 +05:30
it_behaves_like 'a system note' do
let(:action) { 'cross_reference' }
end
2015-09-11 14:41:01 +05:30
context 'when cross-reference disallowed' do
before do
expect(described_class).to receive(:cross_reference_disallowed?).and_return(true)
end
it 'returns nil' do
expect(subject).to be_nil
end
2017-08-17 22:00:37 +05:30
it 'does not create a system note metadata record' do
2018-03-17 18:26:18 +05:30
expect { subject }.not_to change { SystemNoteMetadata.count }
2017-08-17 22:00:37 +05:30
end
2015-09-11 14:41:01 +05:30
end
context 'when cross-reference allowed' do
before do
expect(described_class).to receive(:cross_reference_disallowed?).and_return(false)
end
2017-08-17 22:00:37 +05:30
it_behaves_like 'a system note' do
let(:action) { 'cross_reference' }
end
2015-09-11 14:41:01 +05:30
describe 'note_body' do
context 'cross-project' do
2018-03-17 18:26:18 +05:30
let(:project2) { create(:project, :repository) }
2015-09-11 14:41:01 +05:30
let(:mentioner) { create(:issue, project: project2) }
context 'from Commit' do
let(:mentioner) { project2.repository.commit }
it 'references the mentioning commit' do
2017-08-17 22:00:37 +05:30
expect(subject.note).to eq "mentioned in commit #{mentioner.to_reference(project)}"
2015-09-11 14:41:01 +05:30
end
end
context 'from non-Commit' do
it 'references the mentioning object' do
2017-08-17 22:00:37 +05:30
expect(subject.note).to eq "mentioned in issue #{mentioner.to_reference(project)}"
2015-09-11 14:41:01 +05:30
end
end
end
context 'within the same project' do
context 'from Commit' do
let(:mentioner) { project.repository.commit }
it 'references the mentioning commit' do
2017-08-17 22:00:37 +05:30
expect(subject.note).to eq "mentioned in commit #{mentioner.to_reference}"
2015-09-11 14:41:01 +05:30
end
end
context 'from non-Commit' do
it 'references the mentioning object' do
2017-08-17 22:00:37 +05:30
expect(subject.note).to eq "mentioned in issue #{mentioner.to_reference}"
2015-09-11 14:41:01 +05:30
end
end
end
end
end
end
describe '.cross_reference_disallowed?' do
context 'when mentioner is not a MergeRequest' do
it 'is falsey' do
mentioner = noteable.dup
2017-09-10 17:25:29 +05:30
expect(described_class.cross_reference_disallowed?(noteable, mentioner))
.to be_falsey
2015-09-11 14:41:01 +05:30
end
end
context 'when mentioner is a MergeRequest' do
let(:mentioner) { create(:merge_request, :simple, source_project: project) }
let(:noteable) { project.commit }
it 'is truthy when noteable is in commits' do
expect(mentioner).to receive(:commits).and_return([noteable])
2017-09-10 17:25:29 +05:30
expect(described_class.cross_reference_disallowed?(noteable, mentioner))
.to be_truthy
2015-09-11 14:41:01 +05:30
end
it 'is falsey when noteable is not in commits' do
expect(mentioner).to receive(:commits).and_return([])
2017-09-10 17:25:29 +05:30
expect(described_class.cross_reference_disallowed?(noteable, mentioner))
.to be_falsey
2015-09-11 14:41:01 +05:30
end
end
context 'when notable is an ExternalIssue' do
let(:noteable) { ExternalIssue.new('EXT-1234', project) }
it 'is truthy' do
mentioner = noteable.dup
2017-09-10 17:25:29 +05:30
expect(described_class.cross_reference_disallowed?(noteable, mentioner))
.to be_truthy
2015-09-11 14:41:01 +05:30
end
end
end
describe '.cross_reference_exists?' do
let(:commit0) { project.commit }
let(:commit1) { project.commit('HEAD~2') }
context 'issue from commit' do
before do
# Mention issue (noteable) from commit0
described_class.cross_reference(noteable, commit0, author)
end
it 'is truthy when already mentioned' do
2017-09-10 17:25:29 +05:30
expect(described_class.cross_reference_exists?(noteable, commit0))
.to be_truthy
2015-09-11 14:41:01 +05:30
end
it 'is falsey when not already mentioned' do
2017-09-10 17:25:29 +05:30
expect(described_class.cross_reference_exists?(noteable, commit1))
.to be_falsey
2015-09-11 14:41:01 +05:30
end
2017-08-17 22:00:37 +05:30
context 'legacy capitalized cross reference' do
before do
# Mention issue (noteable) from commit0
system_note = described_class.cross_reference(noteable, commit0, author)
system_note.update(note: system_note.note.capitalize)
end
it 'is truthy when already mentioned' do
2017-09-10 17:25:29 +05:30
expect(described_class.cross_reference_exists?(noteable, commit0))
.to be_truthy
2017-08-17 22:00:37 +05:30
end
end
2015-09-11 14:41:01 +05:30
end
context 'commit from commit' do
before do
# Mention commit1 from commit0
described_class.cross_reference(commit0, commit1, author)
end
it 'is truthy when already mentioned' do
2017-09-10 17:25:29 +05:30
expect(described_class.cross_reference_exists?(commit0, commit1))
.to be_truthy
2015-09-11 14:41:01 +05:30
end
it 'is falsey when not already mentioned' do
2017-09-10 17:25:29 +05:30
expect(described_class.cross_reference_exists?(commit1, commit0))
.to be_falsey
2015-09-11 14:41:01 +05:30
end
2017-08-17 22:00:37 +05:30
context 'legacy capitalized cross reference' do
before do
# Mention commit1 from commit0
system_note = described_class.cross_reference(commit0, commit1, author)
system_note.update(note: system_note.note.capitalize)
end
it 'is truthy when already mentioned' do
2017-09-10 17:25:29 +05:30
expect(described_class.cross_reference_exists?(commit0, commit1))
.to be_truthy
2017-08-17 22:00:37 +05:30
end
end
2015-09-11 14:41:01 +05:30
end
2016-04-02 18:10:28 +05:30
context 'commit with cross-reference from fork' do
2016-10-01 15:18:49 +05:30
let(:author2) { create(:project_member, :reporter, user: create(:user), project: project).user }
2016-04-02 18:10:28 +05:30
let(:forked_project) { Projects::ForkService.new(project, author2).execute }
let(:commit2) { forked_project.commit }
before do
described_class.cross_reference(noteable, commit0, author2)
end
it 'is true when a fork mentions an external issue' do
2017-09-10 17:25:29 +05:30
expect(described_class.cross_reference_exists?(noteable, commit2))
.to be true
2016-04-02 18:10:28 +05:30
end
2017-08-17 22:00:37 +05:30
context 'legacy capitalized cross reference' do
before do
system_note = described_class.cross_reference(noteable, commit0, author2)
system_note.update(note: system_note.note.capitalize)
end
it 'is true when a fork mentions an external issue' do
2017-09-10 17:25:29 +05:30
expect(described_class.cross_reference_exists?(noteable, commit2))
.to be true
2017-08-17 22:00:37 +05:30
end
end
2016-04-02 18:10:28 +05:30
end
2015-09-11 14:41:01 +05:30
end
2015-12-23 02:04:40 +05:30
2016-06-02 11:05:42 +05:30
describe '.noteable_moved' do
2017-09-10 17:25:29 +05:30
let(:new_project) { create(:project) }
2016-06-02 11:05:42 +05:30
let(:new_noteable) { create(:issue, project: new_project) }
subject do
described_class.noteable_moved(noteable, project, new_noteable, author, direction: direction)
end
shared_examples 'cross project mentionable' do
2017-08-17 22:00:37 +05:30
include MarkupHelper
2016-06-02 11:05:42 +05:30
2016-09-13 17:45:13 +05:30
it 'contains cross reference to new noteable' do
2016-06-02 11:05:42 +05:30
expect(subject.note).to include cross_project_reference(new_project, new_noteable)
end
2016-09-13 17:45:13 +05:30
it 'mentions referenced noteable' do
2016-06-02 11:05:42 +05:30
expect(subject.note).to include new_noteable.to_reference
end
2016-09-13 17:45:13 +05:30
it 'mentions referenced project' do
2017-09-10 17:25:29 +05:30
expect(subject.note).to include new_project.full_path
2016-06-02 11:05:42 +05:30
end
end
context 'moved to' do
let(:direction) { :to }
it_behaves_like 'cross project mentionable'
2017-08-17 22:00:37 +05:30
it_behaves_like 'a system note' do
let(:action) { 'moved' }
end
2016-06-02 11:05:42 +05:30
2016-09-13 17:45:13 +05:30
it 'notifies about noteable being moved to' do
2017-08-17 22:00:37 +05:30
expect(subject.note).to match('moved to')
2016-06-02 11:05:42 +05:30
end
end
context 'moved from' do
let(:direction) { :from }
it_behaves_like 'cross project mentionable'
2017-08-17 22:00:37 +05:30
it_behaves_like 'a system note' do
let(:action) { 'moved' }
end
2016-06-02 11:05:42 +05:30
2016-09-13 17:45:13 +05:30
it 'notifies about noteable being moved from' do
2017-08-17 22:00:37 +05:30
expect(subject.note).to match('moved from')
2016-06-02 11:05:42 +05:30
end
end
context 'invalid direction' do
let(:direction) { :invalid }
2016-09-13 17:45:13 +05:30
it 'raises error' do
2016-06-02 11:05:42 +05:30
expect { subject }.to raise_error StandardError, /Invalid direction/
end
end
end
describe '.new_commit_summary' do
it 'escapes HTML titles' do
commit = double(title: '<pre>This is a test</pre>', short_id: '12345678')
2018-03-17 18:26:18 +05:30
escaped = '&lt;pre&gt;This is a test&lt;/pre&gt;'
2016-06-02 11:05:42 +05:30
2018-03-17 18:26:18 +05:30
expect(described_class.new_commit_summary([commit])).to all(match(/- #{escaped}/))
2016-06-02 11:05:42 +05:30
end
end
2015-12-23 02:04:40 +05:30
describe 'JIRA integration' do
2017-08-17 22:00:37 +05:30
include JiraServiceHelper
2017-09-10 17:25:29 +05:30
let(:project) { create(:jira_project, :repository) }
2017-08-17 22:00:37 +05:30
let(:author) { create(:user) }
let(:issue) { create(:issue, project: project) }
let(:merge_request) { create(:merge_request, :simple, target_project: project, source_project: project) }
let(:jira_issue) { ExternalIssue.new("JIRA-1", project)}
let(:jira_tracker) { project.jira_service }
let(:commit) { project.commit }
let(:comment_url) { jira_api_comment_url(jira_issue.id) }
let(:success_message) { "JiraService SUCCESS: Successfully posted to http://jira.example.net." }
before do
stub_jira_urls(jira_issue.id)
jira_service_settings
end
2017-09-10 17:25:29 +05:30
def cross_reference(type, link_exists = false)
noteable = type == 'commit' ? commit : merge_request
links = []
if link_exists
url = if type == 'commit'
"#{Settings.gitlab.base_url}/#{project.namespace.path}/#{project.path}/commit/#{commit.id}"
else
"#{Settings.gitlab.base_url}/#{project.namespace.path}/#{project.path}/merge_requests/#{merge_request.iid}"
end
2018-03-17 18:26:18 +05:30
2017-09-10 17:25:29 +05:30
link = double(object: { 'url' => url })
links << link
expect(link).to receive(:save!)
end
allow(JIRA::Resource::Remotelink).to receive(:all).and_return(links)
described_class.cross_reference(jira_issue, noteable, author)
end
2017-08-17 22:00:37 +05:30
noteable_types = %w(merge_requests commit)
noteable_types.each do |type|
context "when noteable is a #{type}" do
it "blocks cross reference when #{type.underscore}_events is false" do
jira_tracker.update("#{type}_events" => false)
2017-09-10 17:25:29 +05:30
expect(cross_reference(type)).to eq("Events for #{type.pluralize.humanize.downcase} are disabled.")
2017-08-17 22:00:37 +05:30
end
it "blocks cross reference when #{type.underscore}_events is true" do
jira_tracker.update("#{type}_events" => true)
2017-09-10 17:25:29 +05:30
expect(cross_reference(type)).to eq(success_message)
end
end
2017-08-17 22:00:37 +05:30
2017-09-10 17:25:29 +05:30
context 'when a new cross reference is created' do
it 'creates a new comment and remote link' do
cross_reference(type)
expect(WebMock).to have_requested(:post, jira_api_comment_url(jira_issue))
expect(WebMock).to have_requested(:post, jira_api_remote_link_url(jira_issue))
end
end
context 'when a link exists' do
it 'updates a link but does not create a new comment' do
expect(WebMock).not_to have_requested(:post, jira_api_comment_url(jira_issue))
cross_reference(type, true)
2017-08-17 22:00:37 +05:30
end
2015-12-23 02:04:40 +05:30
end
2017-08-17 22:00:37 +05:30
end
2015-12-23 02:04:40 +05:30
2017-08-17 22:00:37 +05:30
describe "new reference" do
2017-09-10 17:25:29 +05:30
before do
allow(JIRA::Resource::Remotelink).to receive(:all).and_return([])
end
2017-08-17 22:00:37 +05:30
context 'for commits' do
it "creates comment" do
result = described_class.cross_reference(jira_issue, commit, author)
expect(result).to eq(success_message)
2015-12-23 02:04:40 +05:30
end
2017-08-17 22:00:37 +05:30
it "creates remote link" do
described_class.cross_reference(jira_issue, commit, author)
expect(WebMock).to have_requested(:post, jira_api_remote_link_url(jira_issue)).with(
body: hash_including(
GlobalID: "GitLab",
object: {
2017-09-10 17:25:29 +05:30
url: project_commit_url(project, commit),
2017-08-17 22:00:37 +05:30
title: "GitLab: Mentioned on commit - #{commit.title}",
icon: { title: "GitLab", url16x16: "https://gitlab.com/favicon.ico" },
status: { resolved: false }
}
)
).once
end
end
context 'for issues' do
let(:issue) { create(:issue, project: project) }
it "creates comment" do
result = described_class.cross_reference(jira_issue, issue, author)
2015-12-23 02:04:40 +05:30
2017-08-17 22:00:37 +05:30
expect(result).to eq(success_message)
end
it "creates remote link" do
described_class.cross_reference(jira_issue, issue, author)
expect(WebMock).to have_requested(:post, jira_api_remote_link_url(jira_issue)).with(
body: hash_including(
GlobalID: "GitLab",
object: {
2017-09-10 17:25:29 +05:30
url: project_issue_url(project, issue),
2017-08-17 22:00:37 +05:30
title: "GitLab: Mentioned on issue - #{issue.title}",
icon: { title: "GitLab", url16x16: "https://gitlab.com/favicon.ico" },
status: { resolved: false }
}
)
).once
end
2015-12-23 02:04:40 +05:30
end
2017-08-17 22:00:37 +05:30
context 'for snippets' do
let(:snippet) { create(:snippet, project: project) }
it "creates comment" do
result = described_class.cross_reference(jira_issue, snippet, author)
expect(result).to eq(success_message)
2015-12-23 02:04:40 +05:30
end
2017-08-17 22:00:37 +05:30
it "creates remote link" do
described_class.cross_reference(jira_issue, snippet, author)
expect(WebMock).to have_requested(:post, jira_api_remote_link_url(jira_issue)).with(
body: hash_including(
GlobalID: "GitLab",
object: {
2017-09-10 17:25:29 +05:30
url: project_snippet_url(project, snippet),
2017-08-17 22:00:37 +05:30
title: "GitLab: Mentioned on snippet - #{snippet.title}",
icon: { title: "GitLab", url16x16: "https://gitlab.com/favicon.ico" },
status: { resolved: false }
}
)
).once
end
2015-12-23 02:04:40 +05:30
end
end
2017-08-17 22:00:37 +05:30
describe "existing reference" do
before do
2017-09-10 17:25:29 +05:30
allow(JIRA::Resource::Remotelink).to receive(:all).and_return([])
message = "[#{author.name}|http://localhost/#{author.username}] mentioned this issue in [a commit of #{project.full_path}|http://localhost/#{project.full_path}/commit/#{commit.id}]:\n'#{commit.title.chomp}'"
2017-08-17 22:00:37 +05:30
allow_any_instance_of(JIRA::Resource::Issue).to receive(:comments).and_return([OpenStruct.new(body: message)])
end
it "does not return success message" do
result = described_class.cross_reference(jira_issue, commit, author)
expect(result).not_to eq(success_message)
end
it 'does not try to create comment and remote link' do
subject
expect(WebMock).not_to have_requested(:post, jira_api_comment_url(jira_issue))
expect(WebMock).not_to have_requested(:post, jira_api_remote_link_url(jira_issue))
end
end
end
describe '.discussion_continued_in_issue' do
2018-03-17 18:26:18 +05:30
let(:discussion) { create(:diff_note_on_merge_request, project: project).to_discussion }
2017-08-17 22:00:37 +05:30
let(:merge_request) { discussion.noteable }
let(:issue) { create(:issue, project: project) }
def reloaded_merge_request
MergeRequest.find(merge_request.id)
end
subject { described_class.discussion_continued_in_issue(discussion, project, author, issue) }
it_behaves_like 'a system note' do
let(:expected_noteable) { discussion.first_note.noteable }
let(:action) { 'discussion' }
end
it 'creates a new note in the discussion' do
# we need to completely rebuild the merge request object, or the `@discussions` on the merge request are not reloaded.
expect { subject }.to change { reloaded_merge_request.discussions.first.notes.size }.by(1)
end
it 'mentions the created issue in the system note' do
expect(subject.note).to include(issue.to_reference)
end
end
describe '.change_time_estimate' do
subject { described_class.change_time_estimate(noteable, project, author) }
it_behaves_like 'a system note' do
let(:action) { 'time_tracking' }
end
context 'with a time estimate' do
it 'sets the note text' do
noteable.update_attribute(:time_estimate, 277200)
expect(subject.note).to eq "changed time estimate to 1w 4d 5h"
end
end
context 'without a time estimate' do
it 'sets the note text' do
expect(subject.note).to eq "removed time estimate"
end
end
end
describe '.change_time_spent' do
# We need a custom noteable in order to the shared examples to be green.
let(:noteable) do
mr = create(:merge_request, source_project: project)
2018-03-17 18:26:18 +05:30
mr.spend_time(duration: 360000, user_id: author.id)
2017-08-17 22:00:37 +05:30
mr.save!
mr
end
subject do
described_class.change_time_spent(noteable, project, author)
end
it_behaves_like 'a system note' do
let(:action) { 'time_tracking' }
end
context 'when time was added' do
it 'sets the note text' do
spend_time!(277200)
expect(subject.note).to eq "added 1w 4d 5h of time spent"
end
end
context 'when time was subtracted' do
it 'sets the note text' do
spend_time!(-277200)
2015-12-23 02:04:40 +05:30
2017-08-17 22:00:37 +05:30
expect(subject.note).to eq "subtracted 1w 4d 5h of time spent"
end
end
2015-12-23 02:04:40 +05:30
2017-08-17 22:00:37 +05:30
context 'when time was removed' do
it 'sets the note text' do
spend_time!(:reset)
expect(subject.note).to eq "removed time spent"
2015-12-23 02:04:40 +05:30
end
end
2017-08-17 22:00:37 +05:30
def spend_time!(seconds)
2018-03-17 18:26:18 +05:30
noteable.spend_time(duration: seconds, user_id: author.id)
2017-08-17 22:00:37 +05:30
noteable.save!
end
end
2018-03-17 18:26:18 +05:30
describe '.handle_merge_request_wip' do
context 'adding wip note' do
let(:noteable) { create(:merge_request, source_project: project, title: 'WIP Lorem ipsum') }
2017-08-17 22:00:37 +05:30
2018-03-17 18:26:18 +05:30
subject { described_class.handle_merge_request_wip(noteable, project, author) }
2017-08-17 22:00:37 +05:30
2018-03-17 18:26:18 +05:30
it_behaves_like 'a system note' do
let(:action) { 'title' }
end
2017-08-17 22:00:37 +05:30
2018-03-17 18:26:18 +05:30
it 'sets the note text' do
expect(subject.note).to eq 'marked as a **Work In Progress**'
end
2017-08-17 22:00:37 +05:30
end
2018-03-17 18:26:18 +05:30
context 'removing wip note' do
let(:noteable) { create(:merge_request, source_project: project, title: 'Lorem ipsum') }
2017-08-17 22:00:37 +05:30
2018-03-17 18:26:18 +05:30
subject { described_class.handle_merge_request_wip(noteable, project, author) }
2017-08-17 22:00:37 +05:30
2018-03-17 18:26:18 +05:30
it_behaves_like 'a system note' do
let(:action) { 'title' }
end
2017-08-17 22:00:37 +05:30
2018-03-17 18:26:18 +05:30
it 'sets the note text' do
expect(subject.note).to eq 'unmarked as a **Work In Progress**'
end
2017-08-17 22:00:37 +05:30
end
end
describe '.add_merge_request_wip_from_commit' do
let(:noteable) do
create(:merge_request, source_project: project, target_project: project)
end
subject do
described_class.add_merge_request_wip_from_commit(
noteable,
project,
author,
noteable.diff_head_commit
)
end
it_behaves_like 'a system note' do
let(:action) { 'title' }
end
it "posts the 'marked as a Work In Progress from commit' system note" do
expect(subject.note).to match(
/marked as a \*\*Work In Progress\*\* from #{Commit.reference_pattern}/
)
end
end
describe '.change_task_status' do
let(:noteable) { create(:issue, project: project) }
let(:task) { double(:task, complete?: true, source: 'task') }
subject { described_class.change_task_status(noteable, project, author, task) }
it_behaves_like 'a system note' do
let(:action) { 'task' }
end
2017-09-10 17:25:29 +05:30
it "posts the 'marked the task as complete' system note" do
2017-08-17 22:00:37 +05:30
expect(subject.note).to eq("marked the task **task** as completed")
end
end
describe '.resolve_all_discussions' do
let(:noteable) { create(:merge_request, source_project: project, target_project: project) }
subject { described_class.resolve_all_discussions(noteable, project, author) }
it_behaves_like 'a system note' do
let(:action) { 'discussion' }
end
it 'sets the note text' do
expect(subject.note).to eq 'resolved all discussions'
end
2015-12-23 02:04:40 +05:30
end
2017-09-10 17:25:29 +05:30
describe '.diff_discussion_outdated' do
2018-03-17 18:26:18 +05:30
let(:discussion) { create(:diff_note_on_merge_request, project: project).to_discussion }
2017-09-10 17:25:29 +05:30
let(:merge_request) { discussion.noteable }
let(:change_position) { discussion.position }
def reloaded_merge_request
MergeRequest.find(merge_request.id)
end
subject { described_class.diff_discussion_outdated(discussion, project, author, change_position) }
it_behaves_like 'a system note' do
let(:expected_noteable) { discussion.first_note.noteable }
let(:action) { 'outdated' }
end
2018-03-17 18:26:18 +05:30
context 'when the change_position is valid for the discussion' do
it 'creates a new note in the discussion' do
# we need to completely rebuild the merge request object, or the `@discussions` on the merge request are not reloaded.
expect { subject }.to change { reloaded_merge_request.discussions.first.notes.size }.by(1)
end
it 'links to the diff in the system note' do
expect(subject.note).to include('version 1')
diff_id = merge_request.merge_request_diff.id
line_code = change_position.line_code(project.repository)
expect(subject.note).to include(diffs_project_merge_request_url(project, merge_request, diff_id: diff_id, anchor: line_code))
end
2017-09-10 17:25:29 +05:30
end
2018-03-17 18:26:18 +05:30
context 'when the change_position is invalid for the discussion' do
let(:change_position) { project.commit(sample_commit.id) }
it 'creates a new note in the discussion' do
# we need to completely rebuild the merge request object, or the `@discussions` on the merge request are not reloaded.
expect { subject }.to change { reloaded_merge_request.discussions.first.notes.size }.by(1)
end
2017-09-10 17:25:29 +05:30
2018-03-17 18:26:18 +05:30
it 'does not create a link' do
expect(subject.note).to eq('changed this line in version 1 of the diff')
end
2017-09-10 17:25:29 +05:30
end
end
describe '.mark_duplicate_issue' do
subject { described_class.mark_duplicate_issue(noteable, project, author, canonical_issue) }
context 'within the same project' do
let(:canonical_issue) { create(:issue, project: project) }
it_behaves_like 'a system note' do
let(:action) { 'duplicate' }
end
it { expect(subject.note).to eq "marked this issue as a duplicate of #{canonical_issue.to_reference}" }
end
context 'across different projects' do
let(:other_project) { create(:project) }
let(:canonical_issue) { create(:issue, project: other_project) }
it_behaves_like 'a system note' do
let(:action) { 'duplicate' }
end
it { expect(subject.note).to eq "marked this issue as a duplicate of #{canonical_issue.to_reference(project)}" }
end
end
describe '.mark_canonical_issue_of_duplicate' do
subject { described_class.mark_canonical_issue_of_duplicate(noteable, project, author, duplicate_issue) }
context 'within the same project' do
let(:duplicate_issue) { create(:issue, project: project) }
it_behaves_like 'a system note' do
let(:action) { 'duplicate' }
end
it { expect(subject.note).to eq "marked #{duplicate_issue.to_reference} as a duplicate of this issue" }
end
context 'across different projects' do
let(:other_project) { create(:project) }
let(:duplicate_issue) { create(:issue, project: other_project) }
it_behaves_like 'a system note' do
let(:action) { 'duplicate' }
end
it { expect(subject.note).to eq "marked #{duplicate_issue.to_reference(project)} as a duplicate of this issue" }
end
end
2018-03-17 18:26:18 +05:30
describe '.discussion_lock' do
subject { described_class.discussion_lock(noteable, author) }
context 'discussion unlocked' do
it_behaves_like 'a system note' do
let(:action) { 'unlocked' }
end
it 'creates the note text correctly' do
[:issue, :merge_request].each do |type|
issuable = create(type)
expect(described_class.discussion_lock(issuable, author).note)
.to eq("unlocked this #{type.to_s.titleize.downcase}")
end
end
end
context 'discussion locked' do
before do
noteable.update_attribute(:discussion_locked, true)
end
it_behaves_like 'a system note' do
let(:action) { 'locked' }
end
it 'creates the note text correctly' do
[:issue, :merge_request].each do |type|
issuable = create(type, discussion_locked: true)
expect(described_class.discussion_lock(issuable, author).note)
.to eq("locked this #{type.to_s.titleize.downcase}")
end
end
end
end
2015-09-11 14:41:01 +05:30
end