gitlab-org--gitlab-foss/spec/models/note_spec.rb

700 lines
22 KiB
Ruby
Raw Normal View History

2011-10-08 17:36:38 -04:00
require 'spec_helper'
2015-12-09 04:50:51 -05:00
describe Note, models: true do
include RepoHelpers
2015-05-10 22:57:44 -04:00
describe 'associations' do
it { is_expected.to belong_to(:project) }
it { is_expected.to belong_to(:noteable).touch(true) }
it { is_expected.to belong_to(:author).class_name('User') }
2016-02-20 08:59:59 -05:00
it { is_expected.to have_many(:todos).dependent(:destroy) }
2011-10-08 17:36:38 -04:00
end
2016-05-25 15:07:36 -04:00
describe 'modules' do
subject { described_class }
it { is_expected.to include_module(Participable) }
it { is_expected.to include_module(Mentionable) }
it { is_expected.to include_module(Awardable) }
it { is_expected.to include_module(Gitlab::CurrentSettings) }
end
2015-05-10 22:57:44 -04:00
describe 'validation' do
it { is_expected.to validate_presence_of(:note) }
it { is_expected.to validate_presence_of(:project) }
2016-05-04 05:17:16 -04:00
context 'when note is on commit' do
before do
allow(subject).to receive(:for_commit?).and_return(true)
end
it { is_expected.to validate_presence_of(:commit_id) }
2016-05-29 23:12:19 -04:00
it { is_expected.not_to validate_presence_of(:noteable_id) }
end
2016-05-04 05:17:16 -04:00
context 'when note is not on commit' do
before do
allow(subject).to receive(:for_commit?).and_return(false)
end
2016-05-29 23:12:19 -04:00
it { is_expected.not_to validate_presence_of(:commit_id) }
it { is_expected.to validate_presence_of(:noteable_id) }
end
2016-05-04 05:17:16 -04:00
context 'when noteable and note project differ' do
subject do
2016-05-04 05:17:16 -04:00
build(:note, noteable: build_stubbed(:issue),
project: build_stubbed(:empty_project))
end
it { is_expected.to be_invalid }
end
2016-05-04 05:17:16 -04:00
context 'when noteable and note project are the same' do
subject { create(:note) }
it { is_expected.to be_valid }
end
2017-01-05 08:36:06 -05:00
context 'when project is missing for a project related note' do
subject { build(:note, project: nil, noteable: build_stubbed(:issue)) }
it { is_expected.to be_invalid }
end
context 'when noteable is a personal snippet' do
2017-01-20 05:28:40 -05:00
subject { build(:note_on_personal_snippet) }
2017-01-05 08:36:06 -05:00
it 'is valid without project' do
is_expected.to be_valid
end
end
2011-10-08 17:36:38 -04:00
end
describe "Commit notes" do
2012-10-29 22:27:36 -04:00
let!(:note) { create(:note_on_commit, note: "+1 from me") }
let!(:commit) { note.noteable }
2012-01-21 07:54:32 -05:00
it "is accessible through #noteable" do
expect(note.commit_id).to eq(commit.id)
expect(note.noteable).to be_a(Commit)
expect(note.noteable).to eq(commit)
2012-10-13 10:23:12 -04:00
end
it "saves a valid note" do
expect(note.commit_id).to eq(commit.id)
2012-10-29 22:27:36 -04:00
note.noteable == commit
2012-10-13 10:23:12 -04:00
end
it "is recognized by #for_commit?" do
expect(note).to be_for_commit
2012-01-21 07:54:32 -05:00
end
it "keeps the commit around" do
expect(note.project.repository.kept_around?(commit.id)).to be_truthy
end
2012-10-29 22:27:36 -04:00
end
2015-05-10 22:57:44 -04:00
describe 'authorization' do
before do
@p1 = create(:empty_project)
@p2 = create(:empty_project)
@u1 = create(:user)
@u2 = create(:user)
@u3 = create(:user)
2011-10-08 17:36:38 -04:00
end
2015-05-10 22:57:44 -04:00
describe 'read' do
before do
@p1.project_members.create(user: @u2, access_level: ProjectMember::GUEST)
@p2.project_members.create(user: @u3, access_level: ProjectMember::GUEST)
2011-10-08 17:36:38 -04:00
end
2016-08-08 14:55:13 -04:00
it { expect(Ability.allowed?(@u1, :read_note, @p1)).to be_falsey }
it { expect(Ability.allowed?(@u2, :read_note, @p1)).to be_truthy }
it { expect(Ability.allowed?(@u3, :read_note, @p1)).to be_falsey }
2011-10-08 17:36:38 -04:00
end
2015-05-10 22:57:44 -04:00
describe 'write' do
before do
@p1.project_members.create(user: @u2, access_level: ProjectMember::DEVELOPER)
@p2.project_members.create(user: @u3, access_level: ProjectMember::DEVELOPER)
2011-10-08 17:36:38 -04:00
end
2016-08-08 14:55:13 -04:00
it { expect(Ability.allowed?(@u1, :create_note, @p1)).to be_falsey }
it { expect(Ability.allowed?(@u2, :create_note, @p1)).to be_truthy }
it { expect(Ability.allowed?(@u3, :create_note, @p1)).to be_falsey }
2011-10-08 17:36:38 -04:00
end
2015-05-10 22:57:44 -04:00
describe 'admin' do
before do
@p1.project_members.create(user: @u1, access_level: ProjectMember::REPORTER)
@p1.project_members.create(user: @u2, access_level: ProjectMember::MASTER)
@p2.project_members.create(user: @u3, access_level: ProjectMember::MASTER)
2011-10-08 17:36:38 -04:00
end
2016-08-08 14:55:13 -04:00
it { expect(Ability.allowed?(@u1, :admin_note, @p1)).to be_falsey }
it { expect(Ability.allowed?(@u2, :admin_note, @p1)).to be_truthy }
it { expect(Ability.allowed?(@u3, :admin_note, @p1)).to be_falsey }
2011-10-08 17:36:38 -04:00
end
end
it_behaves_like 'an editable mentionable' do
2015-10-12 10:23:15 -04:00
subject { create :note, noteable: issue, project: issue.project }
2015-04-16 16:25:25 -04:00
let(:issue) { create(:issue, project: create(:project, :repository)) }
let(:backref_text) { issue.gfm_reference }
let(:set_mentionable_text) { ->(txt) { subject.note = txt } }
end
2016-01-06 07:33:47 -05:00
describe "#all_references" do
let!(:note1) { create(:note_on_issue) }
let!(:note2) { create(:note_on_issue) }
2016-01-06 07:33:47 -05:00
it "reads the rendered note body from the cache" do
2017-06-21 09:48:12 -04:00
expect(Banzai::Renderer).to receive(:cache_collection_render)
.with([{
text: note1.note,
context: {
skip_project_check: false,
pipeline: :note,
cache_key: [note1, "note"],
project: note1.project,
author: note1.author
}
}]).and_call_original
2017-06-21 09:48:12 -04:00
expect(Banzai::Renderer).to receive(:cache_collection_render)
.with([{
text: note2.note,
context: {
skip_project_check: false,
pipeline: :note,
cache_key: [note2, "note"],
project: note2.project,
author: note2.author
}
}]).and_call_original
note1.all_references.users
note2.all_references.users
2016-01-06 07:33:47 -05:00
end
end
describe "editable?" do
it "returns true" do
note = build(:note)
expect(note.editable?).to be_truthy
end
it "returns false" do
note = build(:note, system: true)
expect(note.editable?).to be_falsy
end
end
2016-01-06 07:33:47 -05:00
describe "cross_reference_not_visible_for?" do
let(:private_user) { create(:user) }
let(:private_project) { create(:empty_project, namespace: private_user.namespace) { |p| p.team << [private_user, :master] } }
let(:private_issue) { create(:issue, project: private_project) }
let(:ext_proj) { create(:empty_project, :public) }
let(:ext_issue) { create(:issue, project: ext_proj) }
2016-01-14 04:04:48 -05:00
let(:note) do
create :note,
noteable: ext_issue, project: ext_proj,
note: "mentioned in issue #{private_issue.to_reference(ext_proj)}",
system: true
2016-01-14 04:04:48 -05:00
end
it "returns true" do
expect(note.cross_reference_not_visible_for?(ext_issue.author)).to be_truthy
end
it "returns false" do
expect(note.cross_reference_not_visible_for?(private_user)).to be_falsy
end
it "returns false if user visible reference count set" do
note.user_visible_reference_count = 1
expect(note).not_to receive(:reference_mentionables)
expect(note.cross_reference_not_visible_for?(ext_issue.author)).to be_falsy
end
it "returns true if ref count is 0" do
note.user_visible_reference_count = 0
expect(note).not_to receive(:reference_mentionables)
expect(note.cross_reference_not_visible_for?(ext_issue.author)).to be_truthy
end
end
describe 'clear_blank_line_code!' do
it 'clears a blank line code before validation' do
note = build(:note, line_code: ' ')
expect { note.valid? }.to change(note, :line_code).to(nil)
end
end
describe '#participants' do
it 'includes the note author' do
project = create(:empty_project, :public)
issue = create(:issue, project: project)
note = create(:note_on_issue, noteable: issue, project: project)
expect(note.participants).to include(note.author)
end
end
describe '.find_discussion' do
2017-03-17 15:25:52 -04:00
let!(:note) { create(:discussion_note_on_merge_request) }
let!(:note2) { create(:discussion_note_on_merge_request, in_reply_to: note) }
let(:merge_request) { note.noteable }
2017-04-04 18:27:23 -04:00
it 'returns a discussion with multiple notes' do
2017-03-17 15:25:52 -04:00
discussion = merge_request.notes.find_discussion(note.discussion_id)
expect(discussion).not_to be_nil
expect(discussion.notes).to match_array([note, note2])
expect(discussion.first_note.discussion_id).to eq(note.discussion_id)
end
end
describe ".grouped_diff_discussions" do
let!(:merge_request) { create(:merge_request) }
let(:project) { merge_request.project }
let!(:active_diff_note1) { create(:diff_note_on_merge_request, project: project, noteable: merge_request) }
2017-03-31 17:52:38 -04:00
let!(:active_diff_note2) { create(:diff_note_on_merge_request, project: project, noteable: merge_request, in_reply_to: active_diff_note1) }
let!(:active_diff_note3) { create(:diff_note_on_merge_request, project: project, noteable: merge_request, position: active_position2) }
let!(:outdated_diff_note1) { create(:diff_note_on_merge_request, project: project, noteable: merge_request, position: outdated_position) }
2017-03-31 17:52:38 -04:00
let!(:outdated_diff_note2) { create(:diff_note_on_merge_request, project: project, noteable: merge_request, in_reply_to: outdated_diff_note1) }
let(:active_position2) do
Gitlab::Diff::Position.new(
old_path: "files/ruby/popen.rb",
new_path: "files/ruby/popen.rb",
old_line: nil,
new_line: 13,
diff_refs: project.commit(sample_commit.id).diff_refs
)
end
let(:outdated_position) do
Gitlab::Diff::Position.new(
old_path: "files/ruby/popen.rb",
new_path: "files/ruby/popen.rb",
old_line: nil,
new_line: 9,
diff_refs: project.commit("874797c3a73b60d2187ed6e2fcabd289ff75171e").diff_refs
)
end
context 'active diff discussions' do
subject { merge_request.notes.grouped_diff_discussions }
it "includes active discussions" do
discussions = subject.values.flatten
expect(discussions.count).to eq(2)
expect(discussions.map(&:id)).to eq([active_diff_note1.discussion_id, active_diff_note3.discussion_id])
expect(discussions.all?(&:active?)).to be true
expect(discussions.first.notes).to eq([active_diff_note1, active_diff_note2])
expect(discussions.last.notes).to eq([active_diff_note3])
end
it "doesn't include outdated discussions" do
expect(subject.values.flatten.map(&:id)).not_to include(outdated_diff_note1.discussion_id)
end
it "groups the discussions by line code" do
expect(subject[active_diff_note1.line_code].first.id).to eq(active_diff_note1.discussion_id)
expect(subject[active_diff_note3.line_code].first.id).to eq(active_diff_note3.discussion_id)
end
end
context 'diff discussions for older diff refs' do
subject { merge_request.notes.grouped_diff_discussions(diff_refs) }
context 'for diff refs a discussion was created at' do
let(:diff_refs) { active_position2.diff_refs }
it "includes discussions that were created then" do
discussions = subject.values.flatten
expect(discussions.count).to eq(1)
discussion = discussions.first
expect(discussion.id).to eq(active_diff_note3.discussion_id)
expect(discussion.active?).to be true
expect(discussion.active?(diff_refs)).to be false
expect(discussion.created_at_diff?(diff_refs)).to be true
expect(discussion.notes).to eq([active_diff_note3])
end
it "groups the discussions by original line code" do
expect(subject[active_diff_note3.original_line_code].first.id).to eq(active_diff_note3.discussion_id)
end
end
context 'for diff refs a discussion was last active at' do
let(:diff_refs) { outdated_position.diff_refs }
it "includes discussions that were last active" do
discussions = subject.values.flatten
expect(discussions.count).to eq(1)
discussion = discussions.first
expect(discussion.id).to eq(outdated_diff_note1.discussion_id)
expect(discussion.active?).to be false
expect(discussion.active?(diff_refs)).to be true
expect(discussion.created_at_diff?(diff_refs)).to be true
expect(discussion.notes).to eq([outdated_diff_note1, outdated_diff_note2])
end
it "groups the discussions by line code" do
expect(subject[outdated_diff_note1.line_code].first.id).to eq(outdated_diff_note1.discussion_id)
end
end
end
end
2017-01-20 05:28:40 -05:00
describe '#for_personal_snippet?' do
it 'returns false for a project snippet note' do
expect(build(:note_on_project_snippet).for_personal_snippet?).to be_falsy
end
it 'returns true for a personal snippet note' do
expect(build(:note_on_personal_snippet).for_personal_snippet?).to be_truthy
end
end
describe '#to_ability_name' do
it 'returns snippet for a project snippet note' do
expect(build(:note_on_project_snippet).to_ability_name).to eq('snippet')
end
it 'returns personal_snippet for a personal snippet note' do
expect(build(:note_on_personal_snippet).to_ability_name).to eq('personal_snippet')
end
it 'returns merge_request for an MR note' do
expect(build(:note_on_merge_request).to_ability_name).to eq('merge_request')
end
it 'returns issue for an issue note' do
expect(build(:note_on_issue).to_ability_name).to eq('issue')
end
it 'returns issue for a commit note' do
expect(build(:note_on_commit).to_ability_name).to eq('commit')
end
end
describe '#cache_markdown_field' do
let(:html) { '<p>some html</p>'}
context 'note for a project snippet' do
let(:note) { build(:note_on_project_snippet) }
before do
2017-06-21 09:48:12 -04:00
expect(Banzai::Renderer).to receive(:cacheless_render_field)
.with(note, :note, { skip_project_check: false }).and_return(html)
2017-01-20 05:28:40 -05:00
note.save
end
it 'creates a note' do
expect(note.note_html).to eq(html)
end
end
context 'note for a personal snippet' do
let(:note) { build(:note_on_personal_snippet) }
before do
2017-06-21 09:48:12 -04:00
expect(Banzai::Renderer).to receive(:cacheless_render_field)
.with(note, :note, { skip_project_check: true }).and_return(html)
2017-01-20 05:28:40 -05:00
note.save
end
it 'creates a note' do
expect(note.note_html).to eq(html)
end
end
end
describe '#can_be_discussion_note?' do
2017-03-17 15:25:52 -04:00
context 'for a note on a merge request' do
it 'returns true' do
2017-04-04 18:27:23 -04:00
note = build(:note_on_merge_request)
2017-03-17 15:25:52 -04:00
expect(note.can_be_discussion_note?).to be_truthy
end
end
context 'for a note on an issue' do
it 'returns true' do
2017-04-04 18:27:23 -04:00
note = build(:note_on_issue)
2017-03-17 15:25:52 -04:00
expect(note.can_be_discussion_note?).to be_truthy
end
end
context 'for a note on a commit' do
it 'returns true' do
2017-04-04 18:27:23 -04:00
note = build(:note_on_commit)
2017-03-17 15:25:52 -04:00
expect(note.can_be_discussion_note?).to be_truthy
end
end
context 'for a note on a snippet' do
it 'returns true' do
2017-04-04 18:27:23 -04:00
note = build(:note_on_project_snippet)
2017-03-17 15:25:52 -04:00
expect(note.can_be_discussion_note?).to be_truthy
end
end
context 'for a diff note on merge request' do
it 'returns false' do
2017-04-04 18:27:23 -04:00
note = build(:diff_note_on_merge_request)
2017-03-17 15:25:52 -04:00
expect(note.can_be_discussion_note?).to be_falsey
end
end
context 'for a diff note on commit' do
it 'returns false' do
2017-04-04 18:27:23 -04:00
note = build(:diff_note_on_commit)
2017-03-17 15:25:52 -04:00
expect(note.can_be_discussion_note?).to be_falsey
end
end
context 'for a discussion note' do
it 'returns false' do
2017-04-04 18:27:23 -04:00
note = build(:discussion_note_on_merge_request)
2017-03-17 15:25:52 -04:00
expect(note.can_be_discussion_note?).to be_falsey
end
end
end
describe '#discussion_class' do
2017-03-17 15:25:52 -04:00
let(:note) { build(:note_on_commit) }
let(:merge_request) { create(:merge_request) }
context 'when the note is displayed out of context' do
it 'returns OutOfContextDiscussion' do
expect(note.discussion_class(merge_request)).to be(OutOfContextDiscussion)
end
end
context 'when the note is displayed in the original context' do
it 'returns IndividualNoteDiscussion' do
expect(note.discussion_class(note.noteable)).to be(IndividualNoteDiscussion)
end
end
end
describe "#discussion_id" do
2017-03-17 15:25:52 -04:00
let(:note) { create(:note_on_commit) }
context "when it is newly created" do
it "has a discussion id" do
expect(note.discussion_id).not_to be_nil
expect(note.discussion_id).to match(/\A\h{40}\z/)
end
end
context "when it didn't store a discussion id before" do
before do
note.update_column(:discussion_id, nil)
end
it "has a discussion id" do
# The discussion_id is set in `after_initialize`, so `reload` won't work
reloaded_note = Note.find(note.id)
expect(reloaded_note.discussion_id).not_to be_nil
expect(reloaded_note.discussion_id).to match(/\A\h{40}\z/)
end
end
2017-03-17 15:25:52 -04:00
context 'when the note is displayed out of context' do
let(:merge_request) { create(:merge_request) }
it 'overrides the discussion id' do
expect(note.discussion_id(merge_request)).not_to eq(note.discussion_id)
end
end
end
describe '#to_discussion' do
subject { create(:discussion_note_on_merge_request) }
2017-03-13 18:13:12 -04:00
let!(:note2) { create(:discussion_note_on_merge_request, project: subject.project, noteable: subject.noteable, in_reply_to: subject) }
it "returns a discussion with just this note" do
discussion = subject.to_discussion
expect(discussion.id).to eq(subject.discussion_id)
expect(discussion.notes).to eq([subject])
end
end
describe "#discussion" do
let!(:note1) { create(:discussion_note_on_merge_request) }
let!(:note2) { create(:diff_note_on_merge_request, project: note1.project, noteable: note1.noteable) }
context 'when the note is part of a discussion' do
2017-03-13 18:13:12 -04:00
subject { create(:discussion_note_on_merge_request, project: note1.project, noteable: note1.noteable, in_reply_to: note1) }
it "returns the discussion this note is in" do
discussion = subject.discussion
expect(discussion.id).to eq(subject.discussion_id)
expect(discussion.notes).to eq([note1, subject])
end
end
context 'when the note is not part of a discussion' do
subject { create(:note) }
it "returns a discussion with just this note" do
discussion = subject.discussion
expect(discussion.id).to eq(subject.discussion_id)
expect(discussion.notes).to eq([subject])
end
end
end
describe "#part_of_discussion?" do
2017-03-17 15:25:52 -04:00
context 'for a regular note' do
let(:note) { build(:note) }
it 'returns false' do
expect(note.part_of_discussion?).to be_falsey
end
end
context 'for a diff note' do
let(:note) { build(:diff_note_on_commit) }
it 'returns true' do
expect(note.part_of_discussion?).to be_truthy
end
end
context 'for a discussion note' do
let(:note) { build(:discussion_note_on_merge_request) }
it 'returns true' do
expect(note.part_of_discussion?).to be_truthy
end
end
end
describe '#in_reply_to?' do
context 'for a note' do
context 'when part of a discussion' do
subject { create(:discussion_note_on_issue) }
let(:note) { create(:discussion_note_on_issue, in_reply_to: subject) }
it 'checks if the note is in reply to the other discussion' do
expect(subject).to receive(:in_reply_to?).with(note).and_call_original
expect(subject).to receive(:in_reply_to?).with(note.noteable).and_call_original
expect(subject).to receive(:in_reply_to?).with(note.to_discussion).and_call_original
subject.in_reply_to?(note)
end
end
context 'when not part of a discussion' do
subject { create(:note) }
let(:note) { create(:note, in_reply_to: subject) }
it 'checks if the note is in reply to the other noteable' do
expect(subject).to receive(:in_reply_to?).with(note).and_call_original
expect(subject).to receive(:in_reply_to?).with(note.noteable).and_call_original
subject.in_reply_to?(note)
end
end
end
context 'for a discussion' do
context 'when part of the same discussion' do
subject { create(:diff_note_on_merge_request) }
let(:note) { create(:diff_note_on_merge_request, in_reply_to: subject) }
it 'returns true' do
expect(subject.in_reply_to?(note.to_discussion)).to be_truthy
end
end
context 'when not part of the same discussion' do
subject { create(:diff_note_on_merge_request) }
let(:note) { create(:diff_note_on_merge_request) }
it 'returns false' do
expect(subject.in_reply_to?(note.to_discussion)).to be_falsey
end
end
end
context 'for a noteable' do
context 'when a comment on the same noteable' do
subject { create(:note) }
let(:note) { create(:note, in_reply_to: subject) }
it 'returns true' do
expect(subject.in_reply_to?(note.noteable)).to be_truthy
end
end
context 'when not a comment on the same noteable' do
subject { create(:note) }
let(:note) { create(:note) }
it 'returns false' do
expect(subject.in_reply_to?(note.noteable)).to be_falsey
end
end
end
end
describe 'expiring ETag cache' do
let(:note) { build(:note_on_issue) }
def expect_expiration(note)
expect_any_instance_of(Gitlab::EtagCaching::Store)
.to receive(:touch)
.with("/#{note.project.namespace.to_param}/#{note.project.to_param}/noteable/issue/#{note.noteable.id}/notes")
end
it "expires cache for note's issue when note is saved" do
expect_expiration(note)
note.save!
end
it "expires cache for note's issue when note is destroyed" do
expect_expiration(note)
note.destroy!
end
end
2011-10-08 17:36:38 -04:00
end