BigW Consortium Gitlab

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

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

  describe "Associations" do
9 10
    subject { build(:issue) }

11 12 13
    it { is_expected.to belong_to(:project) }
    it { is_expected.to belong_to(:author) }
    it { is_expected.to have_many(:notes).dependent(:destroy) }
14
    it { is_expected.to have_many(:todos).dependent(:destroy) }
15 16 17 18 19 20 21 22 23 24

    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
25 26
  end

27
  describe 'Included modules' do
28 29
    let(:described_class) { issuable_class }

30 31 32
    it { is_expected.to include_module(Awardable) }
  end

33
  describe "Validation" do
34 35
    subject { build(:issue) }

36 37 38 39
    before do
      allow(subject).to receive(:set_iid).and_return(false)
    end

40 41 42 43
    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) }
44
    it { is_expected.to validate_length_of(:title).is_at_most(255) }
45 46 47
  end

  describe "Scope" do
48 49 50 51 52
    subject { build(:issue) }

    it { expect(issuable_class).to respond_to(:opened) }
    it { expect(issuable_class).to respond_to(:closed) }
    it { expect(issuable_class).to respond_to(:assigned) }
53 54
  end

55 56 57 58 59 60 61 62 63 64 65 66 67
  describe 'author_name' do
    it 'is delegated to author' do
      expect(issue.author_name).to eq issue.author.name
    end

    it 'returns nil when author is nil' do
      issue.author_id = nil
      issue.save(validate: false)

      expect(issue.author_name).to eq nil
    end
  end

68 69 70
  describe ".search" do
    let!(:searchable_issue) { create(:issue, title: "Searchable issue") }

71
    it 'returns notes with a matching title' do
72 73
      expect(issuable_class.search(searchable_issue.title))
        .to eq([searchable_issue])
74 75 76
    end

    it 'returns notes with a partially matching title' do
77
      expect(issuable_class.search('able')).to eq([searchable_issue])
78
    end
79 80

    it 'returns notes with a matching title regardless of the casing' do
81 82
      expect(issuable_class.search(searchable_issue.title.upcase))
        .to eq([searchable_issue])
83 84 85 86 87 88 89 90
    end
  end

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

91
    it 'returns notes with a matching title' do
92 93
      expect(issuable_class.full_search(searchable_issue.title))
        .to eq([searchable_issue])
94 95 96
    end

    it 'returns notes with a partially matching title' do
97
      expect(issuable_class.full_search('able')).to eq([searchable_issue])
98 99 100
    end

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

105
    it 'returns notes with a matching description' do
106 107
      expect(issuable_class.full_search(searchable_issue.description))
        .to eq([searchable_issue])
108 109 110
    end

    it 'returns notes with a partially matching description' do
111 112
      expect(issuable_class.full_search(searchable_issue.description))
        .to eq([searchable_issue])
113 114 115
    end

    it 'returns notes with a matching description regardless of the casing' do
116 117
      expect(issuable_class.full_search(searchable_issue.description.upcase))
        .to eq([searchable_issue])
118
    end
119 120
  end

121 122 123 124 125
  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

126 127 128
  describe "#today?" do
    it "returns true when created today" do
      # Avoid timezone differences and just return exactly what we want
129 130
      allow(Date).to receive(:today).and_return(issue.created_at.to_date)
      expect(issue.today?).to be_truthy
131 132 133
    end

    it "returns false when not created today" do
134 135
      allow(Date).to receive(:today).and_return(Date.yesterday)
      expect(issue.today?).to be_falsey
136 137 138 139 140
    end
  end

  describe "#new?" do
    it "returns true when created today and record hasn't been updated" do
141 142
      allow(issue).to receive(:today?).and_return(true)
      expect(issue.new?).to be_truthy
143 144 145
    end

    it "returns false when not created today" do
146 147
      allow(issue).to receive(:today?).and_return(false)
      expect(issue.new?).to be_falsey
148 149 150
    end

    it "returns false when record has been updated" do
151
      allow(issue).to receive(:today?).and_return(true)
152
      issue.touch
153
      expect(issue.new?).to be_falsey
154 155
    end
  end
156

157
  describe "#sort" do
158 159 160
    let(:project) { build_stubbed(:empty_project) }

    context "by milestone due date" do
161 162 163 164
      # Correct order is:
      # Issues/MRs with milestones ordered by date
      # Issues/MRs with milestones without dates
      # Issues/MRs without milestones
165

166 167 168 169 170 171 172 173 174 175 176
      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
177

178 179 180
      it "sorts asc" do
        issues = project.issues.sort('milestone_due_asc')
        expect(issues).to match_array([issue1, issue2, issue, issue3])
181 182
      end
    end
183 184 185 186 187 188 189 190 191 192 193 194 195 196

    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
197 198
  end

199
  describe '#subscribed?' do
200 201
    let(:project) { issue.project }

202
    context 'user is not a participant in the issue' do
203 204 205
      before do
        allow(issue).to receive(:participants).with(user).and_return([])
      end
206 207

      it 'returns false when no subcription exists' do
208
        expect(issue.subscribed?(user, project)).to be_falsey
209 210 211
      end

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

214
        expect(issue.subscribed?(user, project)).to be_truthy
215 216 217
      end

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

220
        expect(issue.subscribed?(user, project)).to be_falsey
221 222 223 224
      end
    end

    context 'user is a participant in the issue' do
225 226 227
      before do
        allow(issue).to receive(:participants).with(user).and_return([user])
      end
228 229

      it 'returns false when no subcription exists' do
230
        expect(issue.subscribed?(user, project)).to be_truthy
231 232 233
      end

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

236
        expect(issue.subscribed?(user, project)).to be_truthy
237 238 239
      end

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

242
        expect(issue.subscribed?(user, project)).to be_falsey
243 244 245 246
      end
    end
  end

247
  describe "#to_hook_data" do
248 249 250
    let(:data) { issue.to_hook_data(user) }
    let(:project) { issue.project }

251
    it "returns correct hook data" do
252 253 254
      expect(data[:object_kind]).to eq("issue")
      expect(data[:user]).to eq(user.hook_attrs)
      expect(data[:object_attributes]).to eq(issue.hook_attrs)
255
      expect(data).not_to have_key(:assignee)
256 257 258
    end

    context "issue is assigned" do
259 260 261
      before do
        issue.assignees << user
      end
262 263 264 265 266 267 268 269 270 271 272 273 274

      it "returns correct hook data" do
        expect(data[:assignees].first).to eq(user.hook_attrs)
      end
    end

    context "merge_request is assigned" do
      let(:merge_request) { create(:merge_request) }
      let(:data) { merge_request.to_hook_data(user) }

      before do
        merge_request.update_attribute(:assignee, user)
      end
275 276

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

282 283 284
    context 'issue has labels' do
      let(:labels) { [create(:label), create(:label)] }

285 286 287
      before do
        issue.update_attribute(:labels, labels)
      end
288 289 290 291 292 293

      it 'includes labels in the hook data' do
        expect(data[:labels]).to eq(labels.map(&:hook_attrs))
      end
    end

294 295
    include_examples 'project hook data'
    include_examples 'deprecated repository hook data'
296
  end
297

298
  describe '#labels_array' do
299
    let(:project) { create(:empty_project) }
300 301 302 303 304 305 306 307 308 309 310 311
    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

312
  describe '#user_notes_count' do
313
    let(:project) { create(:empty_project) }
314 315 316 317 318 319 320 321 322 323 324 325 326 327
    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

328
  describe "votes" do
329 330
    let(:project) { issue.project }

331
    before do
332 333
      create(:award_emoji, :upvote, awardable: issue)
      create(:award_emoji, :downvote, awardable: issue)
334 335 336 337 338
    end

    it "returns correct values" do
      expect(issue.upvotes).to eq(1)
      expect(issue.downvotes).to eq(1)
339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378
    end
  end

  describe '.order_due_date_and_labels_priority' do
    let(:project) { create(:empty_project) }

    def create_issue(milestone, labels)
      create(:labeled_issue, milestone: milestone, labels: labels, project: project)
    end

    it 'sorts issues in order of milestone due date, then label priority' do
      first_priority = create(:label, project: project, priority: 1)
      second_priority = create(:label, project: project, priority: 2)
      no_priority = create(:label, project: project)

      first_milestone = create(:milestone, project: project, due_date: Time.now)
      second_milestone = create(:milestone, project: project, due_date: Time.now + 1.month)
      third_milestone = create(:milestone, project: project)

      # The issues here are ordered by label priority, to ensure that we don't
      # accidentally just sort by creation date.
      second_milestone_first_priority = create_issue(second_milestone, [first_priority, second_priority, no_priority])
      third_milestone_first_priority = create_issue(third_milestone, [first_priority, second_priority, no_priority])
      first_milestone_second_priority = create_issue(first_milestone, [second_priority, no_priority])
      second_milestone_second_priority = create_issue(second_milestone, [second_priority, no_priority])
      no_milestone_second_priority = create_issue(nil, [second_priority, no_priority])
      first_milestone_no_priority = create_issue(first_milestone, [no_priority])
      second_milestone_no_labels = create_issue(second_milestone, [])
      third_milestone_no_priority = create_issue(third_milestone, [no_priority])

      result = Issue.order_due_date_and_labels_priority

      expect(result).to eq([first_milestone_second_priority,
                            first_milestone_no_priority,
                            second_milestone_first_priority,
                            second_milestone_second_priority,
                            second_milestone_no_labels,
                            third_milestone_first_priority,
                            no_milestone_second_priority,
                            third_milestone_no_priority])
379 380
    end
  end
381

382 383 384 385 386 387 388 389 390 391 392 393 394 395
  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

396
  describe ".with_label" do
397
    let(:project) { create(:empty_project, :public) }
398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424
    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
425

426 427 428 429 430
  describe '#spend_time' do
    let(:user) { create(:user) }
    let(:issue) { create(:issue) }

    def spend_time(seconds)
431
      issue.spend_time(duration: seconds, user: user)
432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454
      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
455 456 457 458
        it 'raise a validation error' do
          expect do
            spend_time(-3600)
          end.to raise_error(ActiveRecord::RecordInvalid)
459 460 461 462
        end
      end
    end
  end
463
end