BigW Consortium Gitlab

issue_spec.rb 22.8 KB
Newer Older
gitlabhq committed
1 2
require 'spec_helper'

Douwe Maan committed
3
describe Issue, models: true do
gitlabhq committed
4
  describe "Associations" do
5
    it { is_expected.to belong_to(:milestone) }
6
    it { is_expected.to have_many(:assignees) }
gitlabhq committed
7 8
  end

9
  describe 'modules' do
10 11 12
    subject { described_class }

    it { is_expected.to include_module(InternalId) }
13
    it { is_expected.to include_module(Issuable) }
14 15 16
    it { is_expected.to include_module(Referable) }
    it { is_expected.to include_module(Sortable) }
    it { is_expected.to include_module(Taskable) }
17 18
  end

19
  subject { create(:issue) }
20

21 22 23 24 25
  describe "act_as_paranoid" do
    it { is_expected.to have_db_column(:deleted_at) }
    it { is_expected.to have_db_index(:deleted_at) }
  end

26 27 28 29 30 31 32 33 34 35 36 37 38 39 40
  describe '#order_by_position_and_priority' do
    let(:project) { create :empty_project }
    let(:p1) { create(:label, title: 'P1', project: project, priority: 1) }
    let(:p2) { create(:label, title: 'P2', project: project, priority: 2) }
    let!(:issue1) { create(:labeled_issue, project: project, labels: [p1]) }
    let!(:issue2) { create(:labeled_issue, project: project, labels: [p2]) }
    let!(:issue3) { create(:issue, project: project, relative_position: 100) }
    let!(:issue4) { create(:issue, project: project, relative_position: 200) }

    it 'returns ordered list' do
      expect(project.issues.order_by_position_and_priority).
        to match [issue3, issue4, issue1, issue2]
    end
  end

41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58
  describe '#card_attributes' do
    it 'includes the author name' do
      allow(subject).to receive(:author).and_return(double(name: 'Robert'))
      allow(subject).to receive(:assignees).and_return([])

      expect(subject.card_attributes).
        to eq({ 'Author' => 'Robert', 'Assignee' => '' })
    end

    it 'includes the assignee name' do
      allow(subject).to receive(:author).and_return(double(name: 'Robert'))
      allow(subject).to receive(:assignees).and_return([double(name: 'Douwe')])

      expect(subject.card_attributes).
        to eq({ 'Author' => 'Robert', 'Assignee' => 'Douwe' })
    end
  end

59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74
  describe '#closed_at' do
    after do
      Timecop.return
    end

    let!(:now) { Timecop.freeze(Time.now) }

    it 'sets closed_at to Time.now when issue is closed' do
      issue = create(:issue, state: 'opened')

      issue.close

      expect(issue.closed_at).to eq(now)
    end
  end

75
  describe '#to_reference' do
76 77 78 79
    let(:namespace) { build(:namespace, path: 'sample-namespace') }
    let(:project)   { build(:empty_project, name: 'sample-project', namespace: namespace) }
    let(:issue)     { build(:issue, iid: 1, project: project) }
    let(:group)     { create(:group, name: 'Group', path: 'sample-group') }
80

81 82 83 84
    context 'when nil argument' do
      it 'returns issue id' do
        expect(issue.to_reference).to eq "#1"
      end
85 86
    end

87
    context 'when full is true' do
88
      it 'returns complete path to the issue' do
89 90 91
        expect(issue.to_reference(full: true)).to          eq 'sample-namespace/sample-project#1'
        expect(issue.to_reference(project, full: true)).to eq 'sample-namespace/sample-project#1'
        expect(issue.to_reference(group, full: true)).to   eq 'sample-namespace/sample-project#1'
92
      end
93 94
    end

95 96 97 98 99 100 101 102 103 104 105 106
    context 'when same project argument' do
      it 'returns issue id' do
        expect(issue.to_reference(project)).to eq("#1")
      end
    end

    context 'when cross namespace project argument' do
      let(:another_namespace_project) { create(:empty_project, name: 'another-project') }

      it 'returns complete path to the issue' do
        expect(issue.to_reference(another_namespace_project)).to eq 'sample-namespace/sample-project#1'
      end
107 108
    end

109
    it 'supports a cross-project reference' do
110
      another_project = build(:empty_project, name: 'another-project', namespace: project.namespace)
111
      expect(issue.to_reference(another_project)).to eq "sample-project#1"
112
    end
113

114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142
    context 'when same namespace / cross-project argument' do
      let(:another_project) { create(:empty_project, namespace: namespace) }

      it 'returns path to the issue with the project name' do
        expect(issue.to_reference(another_project)).to eq 'sample-project#1'
      end
    end

    context 'when different namespace / cross-project argument' do
      let(:another_namespace) { create(:namespace, path: 'another-namespace') }
      let(:another_project)   { create(:empty_project, path: 'another-project', namespace: another_namespace) }

      it 'returns full path to the issue' do
        expect(issue.to_reference(another_project)).to eq 'sample-namespace/sample-project#1'
      end
    end

    context 'when argument is a namespace' do
      context 'with same project path' do
        it 'returns path to the issue with the project name' do
          expect(issue.to_reference(namespace)).to eq 'sample-project#1'
        end
      end

      context 'with different project path' do
        it 'returns full path to the issue' do
          expect(issue.to_reference(group)).to eq 'sample-namespace/sample-project#1'
        end
      end
143
    end
144 145
  end

146 147 148 149 150 151 152 153
  describe '#assignee_or_author?' do
    let(:user) { create(:user) }
    let(:issue) { create(:issue) }

    it 'returns true for a user that is assigned to an issue' do
      issue.assignees << user

      expect(issue.assignee_or_author?(user)).to be_truthy
154
    end
155 156 157 158 159 160 161 162 163

    it 'returns true for a user that is the author of an issue' do
      issue.update(author: user)

      expect(issue.assignee_or_author?(user)).to be_truthy
    end

    it 'returns false for a user that is not the assignee or author' do
      expect(issue.assignee_or_author?(user)).to be_falsey
164 165
    end
  end
166

167
  describe '#closed_by_merge_requests' do
168 169 170
    let(:project) { create(:project, :repository) }
    let(:issue) { create(:issue, project: project)}
    let(:closed_issue) { build(:issue, :closed, project: project)}
171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193

    let(:mr) do
      opts = {
        title: 'Awesome merge_request',
        description: "Fixes #{issue.to_reference}",
        source_branch: 'feature',
        target_branch: 'master'
      }
      MergeRequests::CreateService.new(project, project.owner, opts).execute
    end

    let(:closed_mr) do
      opts = {
        title: 'Awesome merge_request 2',
        description: "Fixes #{issue.to_reference}",
        source_branch: 'feature',
        target_branch: 'master',
        state: 'closed'
      }
      MergeRequests::CreateService.new(project, project.owner, opts).execute
    end

    it 'returns the merge request to close this issue' do
194
      mr
195

196
      expect(issue.closed_by_merge_requests(mr.author)).to eq([mr])
197 198
    end

199 200 201
    it "returns an empty array when the merge request is closed already" do
      closed_mr

202
      expect(issue.closed_by_merge_requests(closed_mr.author)).to eq([])
203 204
    end

205
    it "returns an empty array when the current issue is closed already" do
206
      expect(closed_issue.closed_by_merge_requests(closed_issue.author)).to eq([])
207 208 209
    end
  end

210 211
  describe '#referenced_merge_requests' do
    it 'returns the referenced merge requests' do
212
      project = create(:empty_project, :public)
213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234

      mr1 = create(:merge_request,
                   source_project: project,
                   source_branch:  'master',
                   target_branch:  'feature')

      mr2 = create(:merge_request,
                   source_project: project,
                   source_branch:  'feature',
                   target_branch:  'master')

      issue = create(:issue, description: mr1.to_reference, project: project)

      create(:note_on_issue,
             noteable:   issue,
             note:       mr2.to_reference,
             project_id: project.id)

      expect(issue.referenced_merge_requests).to eq([mr1, mr2])
    end
  end

235 236 237 238 239 240 241 242 243 244
  describe '#can_move?' do
    let(:user) { create(:user) }
    let(:issue) { create(:issue) }
    subject { issue.can_move?(user) }

    context 'user is not a member of project issue belongs to' do
      it { is_expected.to eq false}
    end

    context 'user is reporter in project issue belongs to' do
245
      let(:project) { create(:empty_project) }
246 247 248 249 250 251
      let(:issue) { create(:issue, project: project) }

      before { project.team << [user, :reporter] }

      it { is_expected.to eq true }

252 253 254 255 256
      context 'issue not persisted' do
        let(:issue) { build(:issue, project: project) }
        it { is_expected.to eq false }
      end

257 258
      context 'checking destination project also' do
        subject { issue.can_move?(user, to_project) }
259
        let(:to_project) { create(:empty_project) }
260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289

        context 'destination project allowed' do
          before { to_project.team << [user, :reporter] }
          it { is_expected.to eq true }
        end

        context 'destination project not allowed' do
          before { to_project.team << [user, :guest] }
          it { is_expected.to eq false }
        end
      end
    end
  end

  describe '#moved?' do
    let(:issue) { create(:issue) }
    subject { issue.moved? }

    context 'issue not moved' do
      it { is_expected.to eq false }
    end

    context 'issue already moved' do
      let(:moved_to_issue) { create(:issue) }
      let(:issue) { create(:issue, moved_to: moved_to_issue) }

      it { is_expected.to eq true }
    end
  end

290
  describe '#related_branches' do
291
    let(:user) { build(:admin) }
292

293
    before do
294
      allow(subject.project.repository).to receive(:branch_names).
295
                                            and_return(["mpempe", "#{subject.iid}mepmep", subject.to_branch_name, "#{subject.iid}-branch"])
296 297 298 299 300 301 302 303

      # Without this stub, the `create(:merge_request)` above fails because it can't find
      # the source branch. This seems like a reasonable compromise, in comparison with
      # setting up a full repo here.
      allow_any_instance_of(MergeRequest).to receive(:create_merge_request_diff)
    end

    it "selects the right branches when there are no referenced merge requests" do
304
      expect(subject.related_branches(user)).to eq([subject.to_branch_name, "#{subject.iid}-branch"])
305
    end
306

307
    it "selects the right branches when there is a referenced merge request" do
308 309
      merge_request = create(:merge_request, { description: "Closes ##{subject.iid}",
                                               source_project: subject.project,
310
                                               source_branch: "#{subject.iid}-branch" })
311
      merge_request.create_cross_references!(user)
312
      expect(subject.referenced_merge_requests(user)).not_to be_empty
313
      expect(subject.related_branches(user)).to eq([subject.to_branch_name])
314
    end
315 316 317 318 319

    it 'excludes stable branches from the related branches' do
      allow(subject.project.repository).to receive(:branch_names).
        and_return(["#{subject.iid}-0-stable"])

320
      expect(subject.related_branches(user)).to eq []
321
    end
322 323
  end

324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344
  describe '#has_related_branch?' do
    let(:issue) { create(:issue, title: "Blue Bell Knoll") }
    subject { issue.has_related_branch? }

    context 'branch found' do
      before do
        allow(issue.project.repository).to receive(:branch_names).and_return(["iceblink-luck", issue.to_branch_name])
      end

      it { is_expected.to eq true }
    end

    context 'branch not found' do
      before do
        allow(issue.project.repository).to receive(:branch_names).and_return(["lazy-calm"])
      end

      it { is_expected.to eq false }
    end
  end

345
  it_behaves_like 'an editable mentionable' do
346
    subject { create(:issue, project: create(:project, :repository)) }
347

348
    let(:backref_text) { "issue #{subject.to_reference}" }
349 350
    let(:set_mentionable_text) { ->(txt){ subject.description = txt } }
  end
Vinnie Okada committed
351 352 353 354

  it_behaves_like 'a Taskable' do
    let(:subject) { create :issue }
  end
355 356

  describe "#to_branch_name" do
357
    let(:issue) { create(:issue, title: 'testing-issue') }
358

359
    it 'starts with the issue iid' do
360
      expect(issue.to_branch_name).to match /\A#{issue.iid}-[A-Za-z\-]+\z/
361
    end
362 363

    it "contains the issue title if not confidential" do
364
      expect(issue.to_branch_name).to match /testing-issue\z/
365 366 367 368
    end

    it "does not contain the issue title if confidential" do
      issue = create(:issue, title: 'testing-issue', confidential: true)
369
      expect(issue.to_branch_name).to match /confidential-issue\z/
370
    end
371
  end
Yorick Peterse committed
372 373 374

  describe '#participants' do
    context 'using a public project' do
375
      let(:project) { create(:empty_project, :public) }
Yorick Peterse committed
376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396
      let(:issue) { create(:issue, project: project) }

      let!(:note1) do
        create(:note_on_issue, noteable: issue, project: project, note: 'a')
      end

      let!(:note2) do
        create(:note_on_issue, noteable: issue, project: project, note: 'b')
      end

      it 'includes the issue author' do
        expect(issue.participants).to include(issue.author)
      end

      it 'includes the authors of the notes' do
        expect(issue.participants).to include(note1.author, note2.author)
      end
    end

    context 'using a private project' do
      it 'does not include mentioned users that do not have access to the project' do
397
        project = create(:empty_project)
Yorick Peterse committed
398 399 400 401 402 403 404 405 406 407 408 409
        user = create(:user)
        issue = create(:issue, project: project)

        create(:note_on_issue,
               noteable: issue,
               project: project,
               note: user.to_reference)

        expect(issue.participants).not_to include(user)
      end
    end
  end
410 411 412 413 414

  describe 'cached counts' do
    it 'updates when assignees change' do
      user1 = create(:user)
      user2 = create(:user)
415
      project = create(:empty_project)
416
      issue = create(:issue, assignees: [user1], project: project)
417 418
      project.add_developer(user1)
      project.add_developer(user2)
419 420 421 422

      expect(user1.assigned_open_issues_count).to eq(1)
      expect(user2.assigned_open_issues_count).to eq(0)

423
      issue.assignees = [user2]
424 425 426 427 428 429
      issue.save

      expect(user1.assigned_open_issues_count).to eq(0)
      expect(user2.assigned_open_issues_count).to eq(1)
    end
  end
430 431

  describe '#visible_to_user?' do
432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447
    context 'without a user' do
      let(:issue) { build(:issue) }

      it 'returns true when the issue is publicly visible' do
        expect(issue).to receive(:publicly_visible?).and_return(true)

        expect(issue.visible_to_user?).to eq(true)
      end

      it 'returns false when the issue is not publicly visible' do
        expect(issue).to receive(:publicly_visible?).and_return(false)

        expect(issue.visible_to_user?).to eq(false)
      end
    end

448
    context 'with a user' do
449
      let(:user) { create(:user) }
450 451 452 453 454 455 456 457 458 459 460 461 462 463
      let(:issue) { build(:issue) }

      it 'returns true when the issue is readable' do
        expect(issue).to receive(:readable_by?).with(user).and_return(true)

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

      it 'returns false when the issue is not readable' do
        expect(issue).to receive(:readable_by?).with(user).and_return(false)

        expect(issue.visible_to_user?(user)).to eq(false)
      end

464 465
      it 'returns false when feature is disabled' do
        expect(issue).not_to receive(:readable_by?)
466

467
        issue.project.project_feature.update_attribute(:issues_access_level, ProjectFeature::DISABLED)
468

469
        expect(issue.visible_to_user?(user)).to eq(false)
470 471
      end

472 473
      it 'returns false when restricted for members' do
        expect(issue).not_to receive(:readable_by?)
474

475 476 477
        issue.project.project_feature.update_attribute(:issues_access_level, ProjectFeature::PRIVATE)

        expect(issue.visible_to_user?(user)).to eq(false)
478 479 480 481 482 483 484 485 486 487 488 489
      end
    end

    describe 'with a regular user that is not a team member' do
      let(:user) { create(:user) }

      context 'using a public project' do
        let(:project) { create(:empty_project, :public) }

        it 'returns true for a regular issue' do
          issue = build(:issue, project: project)

490
          expect(issue.visible_to_user?(user)).to eq(true)
491 492 493 494 495
        end

        it 'returns false for a confidential issue' do
          issue = build(:issue, project: project, confidential: true)

496
          expect(issue.visible_to_user?(user)).to eq(false)
497 498 499 500 501 502 503 504 505 506
        end
      end

      context 'using an internal project' do
        let(:project) { create(:empty_project, :internal) }

        context 'using an internal user' do
          it 'returns true for a regular issue' do
            issue = build(:issue, project: project)

507
            expect(issue.visible_to_user?(user)).to eq(true)
508 509 510 511 512
          end

          it 'returns false for a confidential issue' do
            issue = build(:issue, :confidential, project: project)

513
            expect(issue.visible_to_user?(user)).to eq(false)
514 515 516 517 518 519 520 521 522 523 524
          end
        end

        context 'using an external user' do
          before do
            allow(user).to receive(:external?).and_return(true)
          end

          it 'returns false for a regular issue' do
            issue = build(:issue, project: project)

525
            expect(issue.visible_to_user?(user)).to eq(false)
526 527 528 529 530
          end

          it 'returns false for a confidential issue' do
            issue = build(:issue, :confidential, project: project)

531
            expect(issue.visible_to_user?(user)).to eq(false)
532 533 534 535 536 537 538 539 540 541
          end
        end
      end

      context 'using a private project' do
        let(:project) { create(:empty_project, :private) }

        it 'returns false for a regular issue' do
          issue = build(:issue, project: project)

542
          expect(issue.visible_to_user?(user)).to eq(false)
543 544 545 546 547
        end

        it 'returns false for a confidential issue' do
          issue = build(:issue, :confidential, project: project)

548
          expect(issue.visible_to_user?(user)).to eq(false)
549 550 551
        end

        context 'when the user is the project owner' do
552 553
          before { project.team << [user, :master] }

554 555 556
          it 'returns true for a regular issue' do
            issue = build(:issue, project: project)

557
            expect(issue.visible_to_user?(user)).to eq(true)
558 559 560 561 562
          end

          it 'returns true for a confidential issue' do
            issue = build(:issue, :confidential, project: project)

563
            expect(issue.visible_to_user?(user)).to eq(true)
564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580
          end
        end
      end
    end

    context 'with a regular user that is a team member' do
      let(:user) { create(:user) }
      let(:project) { create(:empty_project, :public) }

      context 'using a public project' do
        before do
          project.team << [user, Gitlab::Access::DEVELOPER]
        end

        it 'returns true for a regular issue' do
          issue = build(:issue, project: project)

581
          expect(issue.visible_to_user?(user)).to eq(true)
582 583 584 585 586
        end

        it 'returns true for a confidential issue' do
          issue = build(:issue, :confidential, project: project)

587
          expect(issue.visible_to_user?(user)).to eq(true)
588 589 590 591 592 593 594 595 596 597 598 599 600
        end
      end

      context 'using an internal project' do
        let(:project) { create(:empty_project, :internal) }

        before do
          project.team << [user, Gitlab::Access::DEVELOPER]
        end

        it 'returns true for a regular issue' do
          issue = build(:issue, project: project)

601
          expect(issue.visible_to_user?(user)).to eq(true)
602 603 604 605 606
        end

        it 'returns true for a confidential issue' do
          issue = build(:issue, :confidential, project: project)

607
          expect(issue.visible_to_user?(user)).to eq(true)
608 609 610 611 612 613 614 615 616 617 618 619 620
        end
      end

      context 'using a private project' do
        let(:project) { create(:empty_project, :private) }

        before do
          project.team << [user, Gitlab::Access::DEVELOPER]
        end

        it 'returns true for a regular issue' do
          issue = build(:issue, project: project)

621
          expect(issue.visible_to_user?(user)).to eq(true)
622 623 624 625 626
        end

        it 'returns true for a confidential issue' do
          issue = build(:issue, :confidential, project: project)

627
          expect(issue.visible_to_user?(user)).to eq(true)
628 629 630 631 632 633
        end
      end
    end

    context 'with an admin user' do
      let(:project) { create(:empty_project) }
634
      let(:user) { create(:admin) }
635 636 637 638

      it 'returns true for a regular issue' do
        issue = build(:issue, project: project)

639
        expect(issue.visible_to_user?(user)).to eq(true)
640 641 642 643 644
      end

      it 'returns true for a confidential issue' do
        issue = build(:issue, :confidential, project: project)

645
        expect(issue.visible_to_user?(user)).to eq(true)
646 647 648 649 650 651 652 653 654 655 656
      end
    end
  end

  describe '#publicly_visible?' do
    context 'using a public project' do
      let(:project) { create(:empty_project, :public) }

      it 'returns true for a regular issue' do
        issue = build(:issue, project: project)

657
        expect(issue).to be_truthy
658 659 660 661 662
      end

      it 'returns false for a confidential issue' do
        issue = build(:issue, :confidential, project: project)

663
        expect(issue).not_to be_falsy
664 665 666 667 668 669 670 671 672
      end
    end

    context 'using an internal project' do
      let(:project) { create(:empty_project, :internal) }

      it 'returns false for a regular issue' do
        issue = build(:issue, project: project)

673
        expect(issue).not_to be_falsy
674 675 676 677 678
      end

      it 'returns false for a confidential issue' do
        issue = build(:issue, :confidential, project: project)

679
        expect(issue).not_to be_falsy
680 681 682 683 684 685 686 687 688
      end
    end

    context 'using a private project' do
      let(:project) { create(:empty_project, :private) }

      it 'returns false for a regular issue' do
        issue = build(:issue, project: project)

689
        expect(issue).not_to be_falsy
690 691 692 693 694
      end

      it 'returns false for a confidential issue' do
        issue = build(:issue, :confidential, project: project)

695
        expect(issue).not_to be_falsy
696 697 698
      end
    end
  end
699 700 701 702 703 704 705 706 707 708

  describe '#hook_attrs' do
    let(:attrs_hash) { subject.hook_attrs }

    it 'includes time tracking attrs' do
      expect(attrs_hash).to include(:total_time_spent)
      expect(attrs_hash).to include(:human_time_estimate)
      expect(attrs_hash).to include(:human_total_time_spent)
      expect(attrs_hash).to include('time_estimate')
    end
709 710 711 712 713

    it 'includes assignee_ids and deprecated assignee_id' do
      expect(attrs_hash).to include(:assignee_id)
      expect(attrs_hash).to include(:assignee_ids)
    end
714
  end
715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751

  describe '#check_for_spam' do
    let(:project) { create :project, visibility_level: visibility_level }
    let(:issue) { create :issue, project: project }

    subject do
      issue.assign_attributes(description: description)
      issue.check_for_spam?
    end

    context 'when project is public and spammable attributes changed' do
      let(:visibility_level) { Gitlab::VisibilityLevel::PUBLIC }
      let(:description) { 'woo' }

      it 'returns true' do
        is_expected.to be_truthy
      end
    end

    context 'when project is private' do
      let(:visibility_level) { Gitlab::VisibilityLevel::PRIVATE }
      let(:description) { issue.description }

      it 'returns false' do
        is_expected.to be_falsey
      end
    end

    context 'when spammable attributes have not changed' do
      let(:visibility_level) { Gitlab::VisibilityLevel::PUBLIC }
      let(:description) { issue.description }

      it 'returns false' do
        is_expected.to be_falsey
      end
    end
  end
gitlabhq committed
752
end