note_spec.rb 10.8 KB
Newer Older
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
1 2 3 4
# == Schema Information
#
# Table name: notes
#
5
#  id            :integer          not null, primary key
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
6 7 8
#  note          :text
#  noteable_type :string(255)
#  author_id     :integer
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
9 10
#  created_at    :datetime         not null
#  updated_at    :datetime         not null
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
11 12 13
#  project_id    :integer
#  attachment    :string(255)
#  line_code     :string(255)
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
14 15
#  commit_id     :string(255)
#  noteable_id   :integer
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
16
#  st_diff       :text
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
17
#  system        :boolean          default(FALSE), not null
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
18 19
#

gitlabhq's avatar
gitlabhq committed
20 21 22 23 24
require 'spec_helper'

describe Note do
  describe "Associations" do
    it { should belong_to(:project) }
25 26
    it { should belong_to(:noteable) }
    it { should belong_to(:author).class_name('User') }
gitlabhq's avatar
gitlabhq committed
27 28
  end

29 30 31 32 33
  describe "Mass assignment" do
    it { should_not allow_mass_assignment_of(:author) }
    it { should_not allow_mass_assignment_of(:author_id) }
  end

gitlabhq's avatar
gitlabhq committed
34 35 36 37 38
  describe "Validation" do
    it { should validate_presence_of(:note) }
    it { should validate_presence_of(:project) }
  end

39
  describe "Voting score" do
40
    let(:project) { create(:project) }
41 42

    it "recognizes a neutral note" do
Riyad Preukschas's avatar
Riyad Preukschas committed
43
      note = create(:votable_note, note: "This is not a +1 note")
44
      note.should_not be_upvote
45 46 47 48
      note.should_not be_downvote
    end

    it "recognizes a neutral emoji note" do
Riyad Preukschas's avatar
Riyad Preukschas committed
49
      note = build(:votable_note, note: "I would :+1: this, but I don't want to")
50 51
      note.should_not be_upvote
      note.should_not be_downvote
52 53 54
    end

    it "recognizes a +1 note" do
Riyad Preukschas's avatar
Riyad Preukschas committed
55
      note = create(:votable_note, note: "+1 for this")
56 57 58
      note.should be_upvote
    end

59
    it "recognizes a +1 emoji as a vote" do
Riyad Preukschas's avatar
Riyad Preukschas committed
60
      note = build(:votable_note, note: ":+1: for this")
61 62 63
      note.should be_upvote
    end

64 65 66 67 68
    it "recognizes a thumbsup emoji as a vote" do
      note = build(:votable_note, note: ":thumbsup: for this")
      note.should be_upvote
    end

69
    it "recognizes a -1 note" do
Riyad Preukschas's avatar
Riyad Preukschas committed
70
      note = create(:votable_note, note: "-1 for this")
71 72 73 74
      note.should be_downvote
    end

    it "recognizes a -1 emoji as a vote" do
Riyad Preukschas's avatar
Riyad Preukschas committed
75
      note = build(:votable_note, note: ":-1: for this")
76
      note.should be_downvote
77
    end
78 79 80 81 82

    it "recognizes a thumbsdown emoji as a vote" do
      note = build(:votable_note, note: ":thumbsdown: for this")
      note.should be_downvote
    end
83 84
  end

85
  let(:project) { create(:project) }
86

87
  describe "Commit notes" do
Riyad Preukschas's avatar
Riyad Preukschas committed
88 89
    let!(:note) { create(:note_on_commit, note: "+1 from me") }
    let!(:commit) { note.noteable }
90

Riyad Preukschas's avatar
Riyad Preukschas committed
91
    it "should be accessible through #noteable" do
92
      note.commit_id.should == commit.id
Riyad Preukschas's avatar
Riyad Preukschas committed
93 94
      note.noteable.should be_a(Commit)
      note.noteable.should == commit
Riyad Preukschas's avatar
Riyad Preukschas committed
95 96
    end

97
    it "should save a valid note" do
98
      note.commit_id.should == commit.id
Riyad Preukschas's avatar
Riyad Preukschas committed
99
      note.noteable == commit
Riyad Preukschas's avatar
Riyad Preukschas committed
100 101 102
    end

    it "should be recognized by #for_commit?" do
Riyad Preukschas's avatar
Riyad Preukschas committed
103
      note.should be_for_commit
104 105
    end

Riyad Preukschas's avatar
Riyad Preukschas committed
106 107
    it "should not be votable" do
      note.should_not be_votable
108
    end
Riyad Preukschas's avatar
Riyad Preukschas committed
109 110 111
  end

  describe "Commit diff line notes" do
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
112
    let!(:note) { create(:note_on_commit_diff, note: "+1 from me") }
Riyad Preukschas's avatar
Riyad Preukschas committed
113
    let!(:commit) { note.noteable }
114 115

    it "should save a valid note" do
116
      note.commit_id.should == commit.id
Riyad Preukschas's avatar
Riyad Preukschas committed
117
      note.noteable.id.should == commit.id
Riyad Preukschas's avatar
Riyad Preukschas committed
118 119 120
    end

    it "should be recognized by #for_diff_line?" do
Riyad Preukschas's avatar
Riyad Preukschas committed
121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143
      note.should be_for_diff_line
    end

    it "should be recognized by #for_commit_diff_line?" do
      note.should be_for_commit_diff_line
    end

    it "should not be votable" do
      note.should_not be_votable
    end
  end

  describe "Issue notes" do
    let!(:note) { create(:note_on_issue, note: "+1 from me") }

    it "should not be votable" do
      note.should be_votable
    end
  end

  describe "Merge request notes" do
    let!(:note) { create(:note_on_merge_request, note: "+1 from me") }

144
    it "should be votable" do
Riyad Preukschas's avatar
Riyad Preukschas committed
145 146 147 148 149
      note.should be_votable
    end
  end

  describe "Merge request diff line notes" do
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
150
    let!(:note) { create(:note_on_merge_request_diff, note: "+1 from me") }
Riyad Preukschas's avatar
Riyad Preukschas committed
151 152 153

    it "should not be votable" do
      note.should_not be_votable
154 155 156
    end
  end

157
  describe '#create_status_change_note' do
158 159 160 161
    let(:project) { create(:project) }
    let(:thing) { create(:issue, project: project) }
    let(:author) { create(:user) }
    let(:status) { 'new_status' }
162

163
    subject { Note.create_status_change_note(thing, project, author, status, nil) }
164 165 166 167 168 169 170

    it 'creates and saves a Note' do
      should be_a Note
      subject.id.should_not be_nil
    end

    its(:noteable) { should == thing }
171 172 173
    its(:project) { should == thing.project }
    its(:author) { should == author }
    its(:note) { should =~ /Status changed to #{status}/ }
174 175 176 177 178 179 180 181 182

    it 'appends a back-reference if a closing mentionable is supplied' do
      commit = double('commit', gfm_reference: 'commit 123456')
      n = Note.create_status_change_note(thing, project, author, status, commit)

      n.note.should =~ /Status changed to #{status} by commit 123456/
    end
  end

183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207
  describe '#create_assignee_change_note' do
    let(:project) { create(:project) }
    let(:thing) { create(:issue, project: project) }
    let(:author) { create(:user) }
    let(:assignee) { create(:user) }

    subject { Note.create_assignee_change_note(thing, project, author, assignee) }

    context 'creates and saves a Note' do
      it { should be_a Note }
      its(:id) { should_not be_nil }
    end

    its(:noteable) { should == thing }
    its(:project) { should == thing.project }
    its(:author) { should == author }
    its(:note) { should =~ /Reassigned to @#{assignee.username}/ }

    context 'assignee is removed' do
      let(:assignee) { nil }

      its(:note) { should =~ /Assignee removed/ }
    end
  end

208
  describe '#create_cross_reference_note' do
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
209
    let(:project)    { create(:project) }
210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279
    let(:author)     { create(:user) }
    let(:issue)      { create(:issue, project: project) }
    let(:mergereq)   { create(:merge_request, target_project: project) }
    let(:commit)     { project.repository.commit }

    # Test all of {issue, merge request, commit} in both the referenced and referencing
    # roles, to ensure that the correct information can be inferred from any argument.

    context 'issue from a merge request' do
      subject { Note.create_cross_reference_note(issue, mergereq, author, project) }

      it { should be_valid }
      its(:noteable) { should == issue }
      its(:project)  { should == issue.project }
      its(:author)   { should == author }
      its(:note) { should == "_mentioned in merge request !#{mergereq.iid}_" }
    end

    context 'issue from a commit' do
      subject { Note.create_cross_reference_note(issue, commit, author, project) }

      it { should be_valid }
      its(:noteable) { should == issue }
      its(:note) { should == "_mentioned in commit #{commit.sha[0..5]}_" }
    end

    context 'merge request from an issue' do
      subject { Note.create_cross_reference_note(mergereq, issue, author, project) }

      it { should be_valid }
      its(:noteable) { should == mergereq }
      its(:project) { should == mergereq.project }
      its(:note) { should == "_mentioned in issue ##{issue.iid}_" }
    end

    context 'commit from a merge request' do
      subject { Note.create_cross_reference_note(commit, mergereq, author, project) }

      it { should be_valid }
      its(:noteable) { should == commit }
      its(:project) { should == project }
      its(:note) { should == "_mentioned in merge request !#{mergereq.iid}_" }
    end
  end

  describe '#cross_reference_exists?' do
    let(:project) { create :project }
    let(:author) { create :user }
    let(:issue) { create :issue }
    let(:commit0) { double 'commit0', gfm_reference: 'commit 123456' }
    let(:commit1) { double 'commit1', gfm_reference: 'commit 654321' }

    before do
      Note.create_cross_reference_note(issue, commit0, author, project)
    end

    it 'detects if a mentionable has already been mentioned' do
      Note.cross_reference_exists?(issue, commit0).should be_true
    end

    it 'detects if a mentionable has not already been mentioned' do
      Note.cross_reference_exists?(issue, commit1).should be_false
    end
  end

  describe '#system?' do
    let(:project) { create(:project) }
    let(:issue)   { create(:issue, project: project) }
    let(:other)   { create(:issue, project: project) }
    let(:author)  { create(:user) }
280
    let(:assignee) { create(:user) }
281 282 283 284 285 286 287 288 289 290 291 292 293 294 295

    it 'should recognize user-supplied notes as non-system' do
      @note = create(:note_on_issue)
      @note.should_not be_system
    end

    it 'should identify status-change notes as system notes' do
      @note = Note.create_status_change_note(issue, project, author, 'closed', nil)
      @note.should be_system
    end

    it 'should identify cross-reference notes as system notes' do
      @note = Note.create_cross_reference_note(issue, other, author, project)
      @note.should be_system
    end
296 297 298 299 300

    it 'should identify assignee-change notes as system notes' do
      @note = Note.create_assignee_change_note(issue, project, author, assignee)
      @note.should be_system
    end
301 302
  end

Nihad Abbasov's avatar
Nihad Abbasov committed
303 304
  describe :authorization do
    before do
305
      @p1 = create(:project)
306 307 308 309
      @p2 = create(:project)
      @u1 = create(:user)
      @u2 = create(:user)
      @u3 = create(:user)
gitlabhq's avatar
gitlabhq committed
310 311 312 313
      @abilities = Six.new
      @abilities << Ability
    end

Nihad Abbasov's avatar
Nihad Abbasov committed
314 315
    describe :read do
      before do
316 317
        @p1.users_projects.create(user: @u2, project_access: UsersProject::GUEST)
        @p2.users_projects.create(user: @u3, project_access: UsersProject::GUEST)
gitlabhq's avatar
gitlabhq committed
318 319 320 321 322 323 324
      end

      it { @abilities.allowed?(@u1, :read_note, @p1).should be_false }
      it { @abilities.allowed?(@u2, :read_note, @p1).should be_true }
      it { @abilities.allowed?(@u3, :read_note, @p1).should be_false }
    end

Nihad Abbasov's avatar
Nihad Abbasov committed
325 326
    describe :write do
      before do
327 328
        @p1.users_projects.create(user: @u2, project_access: UsersProject::DEVELOPER)
        @p2.users_projects.create(user: @u3, project_access: UsersProject::DEVELOPER)
gitlabhq's avatar
gitlabhq committed
329 330 331 332 333 334 335
      end

      it { @abilities.allowed?(@u1, :write_note, @p1).should be_false }
      it { @abilities.allowed?(@u2, :write_note, @p1).should be_true }
      it { @abilities.allowed?(@u3, :write_note, @p1).should be_false }
    end

Nihad Abbasov's avatar
Nihad Abbasov committed
336 337
    describe :admin do
      before do
338 339 340
        @p1.users_projects.create(user: @u1, project_access: UsersProject::REPORTER)
        @p1.users_projects.create(user: @u2, project_access: UsersProject::MASTER)
        @p2.users_projects.create(user: @u3, project_access: UsersProject::MASTER)
gitlabhq's avatar
gitlabhq committed
341 342 343 344 345 346 347
      end

      it { @abilities.allowed?(@u1, :admin_note, @p1).should be_false }
      it { @abilities.allowed?(@u2, :admin_note, @p1).should be_true }
      it { @abilities.allowed?(@u3, :admin_note, @p1).should be_false }
    end
  end
348 349 350 351 352 353 354

  it_behaves_like 'an editable mentionable' do
    let(:issue) { create :issue, project: project }
    let(:subject) { create :note, noteable: issue, project: project }
    let(:backref_text) { issue.gfm_reference }
    let(:set_mentionable_text) { ->(txt) { subject.note = txt } }
  end
gitlabhq's avatar
gitlabhq committed
355
end