BigW Consortium Gitlab

issuable_spec.rb 13.8 KB
Newer Older
1 2
require 'spec_helper'

3
describe Issue, "Issuable" do
4
  let(:issue) { create(:issue) }
5
  let(:user) { create(:user) }
6 7

  describe "Associations" do
8 9 10 11
    it { is_expected.to belong_to(:project) }
    it { is_expected.to belong_to(:author) }
    it { is_expected.to belong_to(:assignee) }
    it { is_expected.to have_many(:notes).dependent(:destroy) }
12
    it { is_expected.to have_many(:todos).dependent(:destroy) }
13 14 15 16 17 18 19 20 21 22

    context 'Notes' do
      let!(:note) { create(:note, noteable: issue, project: issue.project) }
      let(:scoped_issue) { Issue.includes(notes: :author).find(issue.id) }

      it 'indicates if the notes have their authors loaded' do
        expect(issue.notes).not_to be_authors_loaded
        expect(scoped_issue.notes).to be_authors_loaded
      end
    end
23 24
  end

25 26 27 28
  describe 'Included modules' do
    it { is_expected.to include_module(Awardable) }
  end

29
  describe "Validation" do
30 31 32 33
    before do
      allow(subject).to receive(:set_iid).and_return(false)
    end

34 35 36 37
    it { is_expected.to validate_presence_of(:project) }
    it { is_expected.to validate_presence_of(:iid) }
    it { is_expected.to validate_presence_of(:author) }
    it { is_expected.to validate_presence_of(:title) }
38
    it { is_expected.to validate_length_of(:title).is_at_most(255) }
39 40 41
  end

  describe "Scope" do
42 43 44
    it { expect(described_class).to respond_to(:opened) }
    it { expect(described_class).to respond_to(:closed) }
    it { expect(described_class).to respond_to(:assigned) }
45 46
  end

47
  describe "before_save" do
48 49
    describe "#update_cache_counts" do
      context "when previous assignee exists" do
50 51 52 53 54 55 56 57 58
        before do
          assignee = create(:user)
          issue.project.team << [assignee, :developer]
          issue.update(assignee: assignee)
        end

        it "updates cache counts for new assignee" do
          user = create(:user)

59 60 61 62
          expect(user).to receive(:update_cache_counts)

          issue.update(assignee: user)
        end
63 64 65 66 67 68 69 70 71

        it "updates cache counts for previous assignee" do
          old_assignee = issue.assignee
          allow(User).to receive(:find_by_id).with(old_assignee.id).and_return(old_assignee)

          expect(old_assignee).to receive(:update_cache_counts)

          issue.update(assignee: nil)
        end
72 73 74
      end

      context "when previous assignee does not exist" do
75
        before{ issue.update(assignee: nil) }
76

77 78 79 80
        it "updates cache count for the new assignee" do
          expect_any_instance_of(User).to receive(:update_cache_counts)

          issue.update(assignee: user)
81 82 83 84 85
        end
      end
    end
  end

86 87 88
  describe ".search" do
    let!(:searchable_issue) { create(:issue, title: "Searchable issue") }

89
    it 'returns notes with a matching title' do
90 91 92 93 94
      expect(described_class.search(searchable_issue.title)).
        to eq([searchable_issue])
    end

    it 'returns notes with a partially matching title' do
95
      expect(described_class.search('able')).to eq([searchable_issue])
96
    end
97 98 99 100 101 102 103 104 105 106 107 108

    it 'returns notes with a matching title regardless of the casing' do
      expect(described_class.search(searchable_issue.title.upcase)).
        to eq([searchable_issue])
    end
  end

  describe ".full_search" do
    let!(:searchable_issue) do
      create(:issue, title: "Searchable issue", description: 'kittens')
    end

109
    it 'returns notes with a matching title' do
110 111 112 113 114 115 116 117 118 119 120 121 122
      expect(described_class.full_search(searchable_issue.title)).
        to eq([searchable_issue])
    end

    it 'returns notes with a partially matching title' do
      expect(described_class.full_search('able')).to eq([searchable_issue])
    end

    it 'returns notes with a matching title regardless of the casing' do
      expect(described_class.full_search(searchable_issue.title.upcase)).
        to eq([searchable_issue])
    end

123
    it 'returns notes with a matching description' do
124 125 126 127 128 129 130 131 132 133 134 135 136
      expect(described_class.full_search(searchable_issue.description)).
        to eq([searchable_issue])
    end

    it 'returns notes with a partially matching description' do
      expect(described_class.full_search(searchable_issue.description)).
        to eq([searchable_issue])
    end

    it 'returns notes with a matching description regardless of the casing' do
      expect(described_class.full_search(searchable_issue.description.upcase)).
        to eq([searchable_issue])
    end
137 138
  end

139 140 141 142 143
  describe '.to_ability_name' do
    it { expect(Issue.to_ability_name).to eq("issue") }
    it { expect(MergeRequest.to_ability_name).to eq("merge_request") }
  end

144 145 146
  describe "#today?" do
    it "returns true when created today" do
      # Avoid timezone differences and just return exactly what we want
147 148
      allow(Date).to receive(:today).and_return(issue.created_at.to_date)
      expect(issue.today?).to be_truthy
149 150 151
    end

    it "returns false when not created today" do
152 153
      allow(Date).to receive(:today).and_return(Date.yesterday)
      expect(issue.today?).to be_falsey
154 155 156 157 158
    end
  end

  describe "#new?" do
    it "returns true when created today and record hasn't been updated" do
159 160
      allow(issue).to receive(:today?).and_return(true)
      expect(issue.new?).to be_truthy
161 162 163
    end

    it "returns false when not created today" do
164 165
      allow(issue).to receive(:today?).and_return(false)
      expect(issue.new?).to be_falsey
166 167 168
    end

    it "returns false when record has been updated" do
169
      allow(issue).to receive(:today?).and_return(true)
170
      issue.touch
171
      expect(issue.new?).to be_falsey
172 173
    end
  end
174

175
  describe "#sort" do
176 177 178
    let(:project) { build_stubbed(:empty_project) }

    context "by milestone due date" do
179 180 181 182
      # Correct order is:
      # Issues/MRs with milestones ordered by date
      # Issues/MRs with milestones without dates
      # Issues/MRs without milestones
183

184 185 186 187 188 189 190 191 192 193 194
      let!(:issue) { create(:issue, project: project) }
      let!(:early_milestone) { create(:milestone, project: project, due_date: 10.days.from_now) }
      let!(:late_milestone) { create(:milestone, project: project, due_date: 30.days.from_now) }
      let!(:issue1) { create(:issue, project: project, milestone: early_milestone) }
      let!(:issue2) { create(:issue, project: project, milestone: late_milestone) }
      let!(:issue3) { create(:issue, project: project) }

      it "sorts desc" do
        issues = project.issues.sort('milestone_due_desc')
        expect(issues).to match_array([issue2, issue1, issue, issue3])
      end
195

196 197 198
      it "sorts asc" do
        issues = project.issues.sort('milestone_due_asc')
        expect(issues).to match_array([issue1, issue2, issue, issue3])
199 200
      end
    end
201 202 203 204 205 206 207 208 209 210 211 212 213 214

    context 'when all of the results are level on the sort key' do
      let!(:issues) do
        10.times { create(:issue, project: project) }
      end

      it 'has no duplicates across pages' do
        sorted_issue_ids = 1.upto(10).map do |i|
          project.issues.sort('milestone_due_desc').page(i).per(1).first.id
        end

        expect(sorted_issue_ids).to eq(sorted_issue_ids.uniq)
      end
    end
215 216
  end

217
  describe '#subscribed?' do
218 219
    let(:project) { issue.project }

220 221 222 223
    context 'user is not a participant in the issue' do
      before { allow(issue).to receive(:participants).with(user).and_return([]) }

      it 'returns false when no subcription exists' do
224
        expect(issue.subscribed?(user, project)).to be_falsey
225 226 227
      end

      it 'returns true when a subcription exists and subscribed is true' do
228
        issue.subscriptions.create(user: user, project: project, subscribed: true)
229

230
        expect(issue.subscribed?(user, project)).to be_truthy
231 232 233
      end

      it 'returns false when a subcription exists and subscribed is false' do
234
        issue.subscriptions.create(user: user, project: project, subscribed: false)
235

236
        expect(issue.subscribed?(user, project)).to be_falsey
237 238 239 240 241 242 243
      end
    end

    context 'user is a participant in the issue' do
      before { allow(issue).to receive(:participants).with(user).and_return([user]) }

      it 'returns false when no subcription exists' do
244
        expect(issue.subscribed?(user, project)).to be_truthy
245 246 247
      end

      it 'returns true when a subcription exists and subscribed is true' do
248
        issue.subscriptions.create(user: user, project: project, subscribed: true)
249

250
        expect(issue.subscribed?(user, project)).to be_truthy
251 252 253
      end

      it 'returns false when a subcription exists and subscribed is false' do
254
        issue.subscriptions.create(user: user, project: project, subscribed: false)
255

256
        expect(issue.subscribed?(user, project)).to be_falsey
257 258 259 260
      end
    end
  end

261
  describe "#to_hook_data" do
262 263 264
    let(:data) { issue.to_hook_data(user) }
    let(:project) { issue.project }

265
    it "returns correct hook data" do
266 267 268
      expect(data[:object_kind]).to eq("issue")
      expect(data[:user]).to eq(user.hook_attrs)
      expect(data[:object_attributes]).to eq(issue.hook_attrs)
269
      expect(data).not_to have_key(:assignee)
270 271 272 273 274 275
    end

    context "issue is assigned" do
      before { issue.update_attribute(:assignee, user) }

      it "returns correct hook data" do
276 277
        expect(data[:object_attributes]['assignee_id']).to eq(user.id)
        expect(data[:assignee]).to eq(user.hook_attrs)
278
      end
279
    end
280 281 282

    include_examples 'project hook data'
    include_examples 'deprecated repository hook data'
283
  end
284 285 286 287 288 289 290

  describe '#card_attributes' do
    it 'includes the author name' do
      allow(issue).to receive(:author).and_return(double(name: 'Robert'))
      allow(issue).to receive(:assignee).and_return(nil)

      expect(issue.card_attributes).
Douwe Maan committed
291
        to eq({ 'Author' => 'Robert', 'Assignee' => nil })
292 293 294 295 296 297 298
    end

    it 'includes the assignee name' do
      allow(issue).to receive(:author).and_return(double(name: 'Robert'))
      allow(issue).to receive(:assignee).and_return(double(name: 'Douwe'))

      expect(issue.card_attributes).
Douwe Maan committed
299
        to eq({ 'Author' => 'Robert', 'Assignee' => 'Douwe' })
300 301
    end
  end
302

303
  describe '#labels_array' do
304
    let(:project) { create(:empty_project) }
305 306 307 308 309 310 311 312 313 314 315 316
    let(:bug) { create(:label, project: project, title: 'bug') }
    let(:issue) { create(:issue, project: project) }

    before(:each) do
      issue.labels << bug
    end

    it 'loads the association and returns it as an array' do
      expect(issue.reload.labels_array).to eq([bug])
    end
  end

317
  describe '#user_notes_count' do
318
    let(:project) { create(:empty_project) }
319 320 321 322 323 324 325 326 327 328 329 330 331 332
    let(:issue1) { create(:issue, project: project) }
    let(:issue2) { create(:issue, project: project) }

    before do
      create_list(:note, 3, noteable: issue1, project: project)
      create_list(:note, 6, noteable: issue2, project: project)
    end

    it 'counts the user notes' do
      expect(issue1.user_notes_count).to be(3)
      expect(issue2.user_notes_count).to be(6)
    end
  end

333
  describe "votes" do
334 335
    let(:project) { issue.project }

336
    before do
337 338
      create(:award_emoji, :upvote, awardable: issue)
      create(:award_emoji, :downvote, awardable: issue)
339 340 341 342 343 344 345
    end

    it "returns correct values" do
      expect(issue.upvotes).to eq(1)
      expect(issue.downvotes).to eq(1)
    end
  end
346

347 348 349 350 351 352 353 354 355 356 357 358 359 360
  describe '.order_labels_priority' do
    let(:label_1) { create(:label, title: 'label_1', project: issue.project, priority: 1) }
    let(:label_2) { create(:label, title: 'label_2', project: issue.project, priority: 2) }

    subject { Issue.order_labels_priority(excluded_labels: ['label_1']).first.highest_priority }

    before do
      issue.labels << label_1
      issue.labels << label_2
    end

    it { is_expected.to eq(2) }
  end

361
  describe ".with_label" do
362
    let(:project) { create(:empty_project, :public) }
363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389
    let(:bug) { create(:label, project: project, title: 'bug') }
    let(:feature) { create(:label, project: project, title: 'feature') }
    let(:enhancement) { create(:label, project: project, title: 'enhancement') }
    let(:issue1) { create(:issue, title: "Bugfix1", project: project) }
    let(:issue2) { create(:issue, title: "Bugfix2", project: project) }
    let(:issue3) { create(:issue, title: "Feature1", project: project) }

    before(:each) do
      issue1.labels << bug
      issue1.labels << feature
      issue2.labels << bug
      issue2.labels << enhancement
      issue3.labels << feature
    end

    it 'finds the correct issue containing just enhancement label' do
      expect(Issue.with_label(enhancement.title)).to match_array([issue2])
    end

    it 'finds the correct issues containing the same label' do
      expect(Issue.with_label(bug.title)).to match_array([issue1, issue2])
    end

    it 'finds the correct issues containing only both labels' do
      expect(Issue.with_label([bug.title, enhancement.title])).to match_array([issue2])
    end
  end
Yorick Peterse committed
390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410

  describe '#assignee_or_author?' do
    let(:user) { build(:user, id: 1) }
    let(:issue) { build(:issue) }

    it 'returns true for a user that is assigned to an issue' do
      issue.assignee = user

      expect(issue.assignee_or_author?(user)).to eq(true)
    end

    it 'returns true for a user that is the author of an issue' do
      issue.author = user

      expect(issue.assignee_or_author?(user)).to eq(true)
    end

    it 'returns false for a user that is not the assignee or author' do
      expect(issue.assignee_or_author?(user)).to eq(false)
    end
  end
411 412 413 414 415 416

  describe '#spend_time' do
    let(:user) { create(:user) }
    let(:issue) { create(:issue) }

    def spend_time(seconds)
417
      issue.spend_time(duration: seconds, user: user)
418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440
      issue.save!
    end

    context 'adding time' do
      it 'should update the total time spent' do
        spend_time(1800)

        expect(issue.total_time_spent).to eq(1800)
      end
    end

    context 'substracting time' do
      before do
        spend_time(1800)
      end

      it 'should update the total time spent' do
        spend_time(-900)

        expect(issue.total_time_spent).to eq(900)
      end

      context 'when time to substract exceeds the total time spent' do
441 442 443 444
        it 'raise a validation error' do
          expect do
            spend_time(-3600)
          end.to raise_error(ActiveRecord::RecordInvalid)
445 446 447 448
        end
      end
    end
  end
449
end