pipeline_spec.rb 59 KB
Newer Older
1 2
require 'spec_helper'

3
describe Ci::Pipeline, :mailer do
4
  let(:user) { create(:user) }
5
  set(:project) { create(:project) }
6 7 8 9

  let(:pipeline) do
    create(:ci_empty_pipeline, status: :created, project: project)
  end
10

11
  it { is_expected.to belong_to(:project) }
12
  it { is_expected.to belong_to(:user) }
13
  it { is_expected.to belong_to(:auto_canceled_by) }
14
  it { is_expected.to belong_to(:pipeline_schedule) }
15

16
  it { is_expected.to have_many(:statuses) }
17
  it { is_expected.to have_many(:trigger_requests) }
Shinya Maeda's avatar
init  
Shinya Maeda committed
18
  it { is_expected.to have_many(:variables) }
Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
19
  it { is_expected.to have_many(:builds) }
20
  it { is_expected.to have_many(:auto_canceled_pipelines) }
21
  it { is_expected.to have_many(:auto_canceled_jobs) }
22

23 24
  it { is_expected.to validate_presence_of(:sha) }
  it { is_expected.to validate_presence_of(:status) }
25

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
26 27 28
  it { is_expected.to respond_to :git_author_name }
  it { is_expected.to respond_to :git_author_email }
  it { is_expected.to respond_to :short_sha }
29
  it { is_expected.to delegate_method(:full_path).to(:project).with_prefix }
30

31 32 33 34 35 36 37
  describe 'associations' do
    it 'has a bidirectional relationship with projects' do
      expect(described_class.reflect_on_association(:project).has_inverse?).to eq(:pipelines)
      expect(Project.reflect_on_association(:pipelines).has_inverse?).to eq(:project)
    end
  end

38
  describe 'modules' do
39
    it_behaves_like 'AtomicInternalId', validate_presence: false do
40 41
      let(:internal_id_attribute) { :iid }
      let(:instance) { build(:ci_pipeline) }
42
      let(:scope) { :project }
43 44 45 46 47
      let(:scope_attrs) { { project: instance.project } }
      let(:usage) { :ci_pipelines }
    end
  end

48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69
  describe '#source' do
    context 'when creating new pipeline' do
      let(:pipeline) do
        build(:ci_empty_pipeline, status: :created, project: project, source: nil)
      end

      it "prevents from creating an object" do
        expect(pipeline).not_to be_valid
      end
    end

    context 'when updating existing pipeline' do
      before do
        pipeline.update_attribute(:source, nil)
      end

      it "object is valid" do
        expect(pipeline).to be_valid
      end
    end
  end

70 71 72 73 74 75 76 77
  describe '#block' do
    it 'changes pipeline status to manual' do
      expect(pipeline.block).to be true
      expect(pipeline.reload).to be_manual
      expect(pipeline.reload).to be_blocked
    end
  end

78 79
  describe '#delay' do
    subject { pipeline.delay }
80 81 82 83 84 85 86 87 88 89

    let(:pipeline) { build(:ci_pipeline, status: :created) }

    it 'changes pipeline status to schedule' do
      subject

      expect(pipeline).to be_scheduled
    end
  end

90
  describe '#valid_commit_sha' do
91 92
    context 'commit.sha can not start with 00000000' do
      before do
93 94
        pipeline.sha = '0' * 40
        pipeline.valid_commit_sha
95 96
      end

97
      it('commit errors should not be empty') { expect(pipeline.errors).not_to be_empty }
98 99 100
    end
  end

101
  describe '#short_sha' do
102
    subject { pipeline.short_sha }
103

Dmitriy Zaporozhets's avatar
Dmitriy Zaporozhets committed
104 105 106
    it 'has 8 items' do
      expect(subject.size).to eq(8)
    end
107
    it { expect(pipeline.sha).to start_with(subject) }
108 109
  end

110
  describe '#retried' do
111
    subject { pipeline.retried }
112 113

    before do
114 115
      @build1 = create(:ci_build, pipeline: pipeline, name: 'deploy', retried: true)
      @build2 = create(:ci_build, pipeline: pipeline, name: 'deploy')
116 117 118
    end

    it 'returns old builds' do
119
      is_expected.to contain_exactly(@build1)
120 121 122
    end
  end

123
  describe "coverage" do
124
    let(:project) { create(:project, build_coverage_regex: "/.*/") }
125
    let(:pipeline) { create(:ci_empty_pipeline, project: project) }
126 127

    it "calculates average when there are two builds with coverage" do
128 129
      create(:ci_build, name: "rspec", coverage: 30, pipeline: pipeline)
      create(:ci_build, name: "rubocop", coverage: 40, pipeline: pipeline)
130
      expect(pipeline.coverage).to eq("35.00")
131 132 133
    end

    it "calculates average when there are two builds with coverage and one with nil" do
134 135 136
      create(:ci_build, name: "rspec", coverage: 30, pipeline: pipeline)
      create(:ci_build, name: "rubocop", coverage: 40, pipeline: pipeline)
      create(:ci_build, pipeline: pipeline)
137
      expect(pipeline.coverage).to eq("35.00")
138 139 140
    end

    it "calculates average when there are two builds with coverage and one is retried" do
141 142 143
      create(:ci_build, name: "rspec", coverage: 30, pipeline: pipeline)
      create(:ci_build, name: "rubocop", coverage: 30, pipeline: pipeline, retried: true)
      create(:ci_build, name: "rubocop", coverage: 40, pipeline: pipeline)
144
      expect(pipeline.coverage).to eq("35.00")
145 146 147
    end

    it "calculates average when there is one build without coverage" do
148
      FactoryBot.create(:ci_build, pipeline: pipeline)
149
      expect(pipeline.coverage).to be_nil
150 151
    end
  end
152 153

  describe '#retryable?' do
154
    subject { pipeline.retryable? }
155 156 157

    context 'no failed builds' do
      before do
158
        create_build('rspec', 'success')
159 160
      end

161
      it 'is not retryable' do
162 163
        is_expected.to be_falsey
      end
164 165 166 167 168 169 170 171 172 173

      context 'one canceled job' do
        before do
          create_build('rubocop', 'canceled')
        end

        it 'is retryable' do
          is_expected.to be_truthy
        end
      end
174 175 176 177
    end

    context 'with failed builds' do
      before do
178 179
        create_build('rspec', 'running')
        create_build('rubocop', 'failed')
180 181
      end

182
      it 'is retryable' do
183 184 185
        is_expected.to be_truthy
      end
    end
186 187 188 189

    def create_build(name, status)
      create(:ci_build, name: name, status: status, pipeline: pipeline)
    end
190 191
  end

192 193 194 195 196 197 198 199 200 201 202 203 204 205
  describe '#persisted_variables' do
    context 'when pipeline is not persisted yet' do
      subject { build(:ci_pipeline).persisted_variables }

      it 'does not contain some variables' do
        keys = subject.map { |variable| variable[:key] }

        expect(keys).not_to include 'CI_PIPELINE_ID'
      end
    end

    context 'when pipeline is persisted' do
      subject { build_stubbed(:ci_pipeline).persisted_variables }

206
      it 'does contains persisted variables' do
207 208
        keys = subject.map { |variable| variable[:key] }

209
        expect(keys).to eq %w[CI_PIPELINE_ID CI_PIPELINE_URL]
210 211 212 213
      end
    end
  end

214 215 216
  describe '#predefined_variables' do
    subject { pipeline.predefined_variables }

217
    it 'includes all predefined variables in a valid order' do
218
      keys = subject.map { |variable| variable[:key] }
219

220 221
      expect(keys).to eq %w[CI_PIPELINE_IID
                            CI_CONFIG_PATH
222 223 224 225
                            CI_PIPELINE_SOURCE
                            CI_COMMIT_MESSAGE
                            CI_COMMIT_TITLE
                            CI_COMMIT_DESCRIPTION]
226 227 228
    end
  end

229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246
  describe '#protected_ref?' do
    it 'delegates method to project' do
      expect(pipeline).not_to be_protected_ref
    end
  end

  describe '#legacy_trigger' do
    let(:trigger_request) { create(:ci_trigger_request) }

    before do
      pipeline.trigger_requests << trigger_request
    end

    it 'returns first trigger request' do
      expect(pipeline.legacy_trigger).to eq trigger_request
    end
  end

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 280 281 282 283
  describe '#auto_canceled?' do
    subject { pipeline.auto_canceled? }

    context 'when it is canceled' do
      before do
        pipeline.cancel
      end

      context 'when there is auto_canceled_by' do
        before do
          pipeline.update(auto_canceled_by: create(:ci_empty_pipeline))
        end

        it 'is auto canceled' do
          is_expected.to be_truthy
        end
      end

      context 'when there is no auto_canceled_by' do
        it 'is not auto canceled' do
          is_expected.to be_falsey
        end
      end

      context 'when it is retried and canceled manually' do
        before do
          pipeline.enqueue
          pipeline.cancel
        end

        it 'is not auto canceled' do
          is_expected.to be_falsey
        end
      end
    end
  end

284
  describe 'pipeline stages' do
285
    describe '#stage_seeds' do
286 287
      let(:pipeline) { build(:ci_pipeline, config: config) }
      let(:config) { { rspec: { script: 'rake' } } }
288 289

      it 'returns preseeded stage seeds object' do
290 291
        expect(pipeline.stage_seeds)
          .to all(be_a Gitlab::Ci::Pipeline::Seed::Base)
292
        expect(pipeline.stage_seeds.count).to eq 1
293 294
      end

295 296 297 298 299 300 301 302 303
      context 'when no refs policy is specified' do
        let(:config) do
          { production: { stage: 'deploy', script: 'cap prod' },
            rspec: { stage: 'test', script: 'rspec' },
            spinach: { stage: 'test', script: 'spinach' } }
        end

        it 'correctly fabricates a stage seeds object' do
          seeds = pipeline.stage_seeds
304

305 306 307 308 309 310
          expect(seeds.size).to eq 2
          expect(seeds.first.attributes[:name]).to eq 'test'
          expect(seeds.second.attributes[:name]).to eq 'deploy'
          expect(seeds.dig(0, 0, :name)).to eq 'rspec'
          expect(seeds.dig(0, 1, :name)).to eq 'spinach'
          expect(seeds.dig(1, 0, :name)).to eq 'production'
311
        end
312 313
      end

314 315 316
      context 'when refs policy is specified' do
        let(:pipeline) do
          build(:ci_pipeline, ref: 'feature', tag: true, config: config)
317
        end
318

319 320 321
        let(:config) do
          { production: { stage: 'deploy', script: 'cap prod', only: ['master'] },
            spinach: { stage: 'test', script: 'spinach', only: ['tags'] } }
322
        end
Kamil Trzcinski's avatar
Kamil Trzcinski committed
323

324 325
        it 'returns stage seeds only assigned to master to master' do
          seeds = pipeline.stage_seeds
326

327 328 329
          expect(seeds.size).to eq 1
          expect(seeds.first.attributes[:name]).to eq 'test'
          expect(seeds.dig(0, 0, :name)).to eq 'spinach'
330 331
        end
      end
332

333 334 335 336 337 338
      context 'when source policy is specified' do
        let(:pipeline) { build(:ci_pipeline, source: :schedule, config: config) }

        let(:config) do
          { production: { stage: 'deploy', script: 'cap prod', only: ['triggers'] },
            spinach: { stage: 'test', script: 'spinach', only: ['schedules'] } }
339 340
        end

341 342
        it 'returns stage seeds only assigned to schedules' do
          seeds = pipeline.stage_seeds
343

344 345 346
          expect(seeds.size).to eq 1
          expect(seeds.first.attributes[:name]).to eq 'test'
          expect(seeds.dig(0, 0, :name)).to eq 'spinach'
347 348
        end
      end
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 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396
      context 'when kubernetes policy is specified' do
        let(:config) do
          {
            spinach: { stage: 'test', script: 'spinach' },
            production: {
              stage: 'deploy',
              script: 'cap',
              only: { kubernetes: 'active' }
            }
          }
        end

        context 'when kubernetes is active' do
          shared_examples 'same behavior between KubernetesService and Platform::Kubernetes' do
            it 'returns seeds for kubernetes dependent job' do
              seeds = pipeline.stage_seeds

              expect(seeds.size).to eq 2
              expect(seeds.dig(0, 0, :name)).to eq 'spinach'
              expect(seeds.dig(1, 0, :name)).to eq 'production'
            end
          end

          context 'when user configured kubernetes from Integration > Kubernetes' do
            let(:project) { create(:kubernetes_project) }
            let(:pipeline) { build(:ci_pipeline, project: project, config: config) }

            it_behaves_like 'same behavior between KubernetesService and Platform::Kubernetes'
          end

          context 'when user configured kubernetes from CI/CD > Clusters' do
            let!(:cluster) { create(:cluster, :project, :provided_by_gcp) }
            let(:project) { cluster.project }
            let(:pipeline) { build(:ci_pipeline, project: project, config: config) }

            it_behaves_like 'same behavior between KubernetesService and Platform::Kubernetes'
          end
        end

        context 'when kubernetes is not active' do
          it 'does not return seeds for kubernetes dependent job' do
            seeds = pipeline.stage_seeds

            expect(seeds.size).to eq 1
            expect(seeds.dig(0, 0, :name)).to eq 'spinach'
          end
        end
397
      end
398 399 400 401 402 403 404 405 406 407 408 409 410 411

      context 'when variables policy is specified' do
        let(:config) do
          { unit: { script: 'minitest', only: { variables: ['$CI_PIPELINE_SOURCE'] } },
            feature: { script: 'spinach', only: { variables: ['$UNDEFINED'] } } }
        end

        it 'returns stage seeds only when variables expression is truthy' do
          seeds = pipeline.stage_seeds

          expect(seeds.size).to eq 1
          expect(seeds.dig(0, 0, :name)).to eq 'unit'
        end
      end
412
    end
413

414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430
    describe '#seeds_size' do
      context 'when refs policy is specified' do
        let(:config) do
          { production: { stage: 'deploy', script: 'cap prod', only: ['master'] },
            spinach: { stage: 'test', script: 'spinach', only: ['tags'] } }
        end

        let(:pipeline) do
          build(:ci_pipeline, ref: 'feature', tag: true, config: config)
        end

        it 'returns real seeds size' do
          expect(pipeline.seeds_size).to eq 1
        end
      end
    end

431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455
    describe 'legacy stages' do
      before do
        create(:commit_status, pipeline: pipeline,
                               stage: 'build',
                               name: 'linux',
                               stage_idx: 0,
                               status: 'success')

        create(:commit_status, pipeline: pipeline,
                               stage: 'build',
                               name: 'mac',
                               stage_idx: 0,
                               status: 'failed')

        create(:commit_status, pipeline: pipeline,
                               stage: 'deploy',
                               name: 'staging',
                               stage_idx: 2,
                               status: 'running')

        create(:commit_status, pipeline: pipeline,
                               stage: 'test',
                               name: 'rspec',
                               stage_idx: 1,
                               status: 'success')
456
      end
457

458 459
      describe '#legacy_stages' do
        subject { pipeline.legacy_stages }
460

461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513
        context 'stages list' do
          it 'returns ordered list of stages' do
            expect(subject.map(&:name)).to eq(%w[build test deploy])
          end
        end

        context 'stages with statuses' do
          let(:statuses) do
            subject.map { |stage| [stage.name, stage.status] }
          end

          it 'returns list of stages with correct statuses' do
            expect(statuses).to eq([%w(build failed),
                                    %w(test success),
                                    %w(deploy running)])
          end

          context 'when commit status is retried' do
            before do
              create(:commit_status, pipeline: pipeline,
                                     stage: 'build',
                                     name: 'mac',
                                     stage_idx: 0,
                                     status: 'success')

              pipeline.process!
            end

            it 'ignores the previous state' do
              expect(statuses).to eq([%w(build success),
                                      %w(test success),
                                      %w(deploy running)])
            end
          end
        end

        context 'when there is a stage with warnings' do
          before do
            create(:commit_status, pipeline: pipeline,
                                   stage: 'deploy',
                                   name: 'prod:2',
                                   stage_idx: 2,
                                   status: 'failed',
                                   allow_failure: true)
          end

          it 'populates stage with correct number of warnings' do
            deploy_stage = pipeline.legacy_stages.third

            expect(deploy_stage).not_to receive(:statuses)
            expect(deploy_stage).to have_warnings
          end
        end
514
      end
Kamil Trzcinski's avatar
Kamil Trzcinski committed
515

516 517 518 519 520 521 522 523 524 525 526
      describe '#stages_count' do
        it 'returns a valid number of stages' do
          expect(pipeline.stages_count).to eq(3)
        end
      end

      describe '#stages_names' do
        it 'returns a valid names of stages' do
          expect(pipeline.stages_names).to eq(%w(build test deploy))
        end
      end
527 528
    end

529 530 531 532 533 534 535 536 537 538 539
    describe '#legacy_stage' do
      subject { pipeline.legacy_stage('test') }

      context 'with status in stage' do
        before do
          create(:commit_status, pipeline: pipeline, stage: 'test')
        end

        it { expect(subject).to be_a Ci::LegacyStage }
        it { expect(subject.name).to eq 'test' }
        it { expect(subject.statuses).not_to be_empty }
Kamil Trzcinski's avatar
Kamil Trzcinski committed
540
      end
541

542 543 544 545 546 547 548 549
      context 'without status in stage' do
        before do
          create(:commit_status, pipeline: pipeline, stage: 'build')
        end

        it 'return stage object' do
          is_expected.to be_nil
        end
550 551
      end
    end
552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632

    describe '#stages' do
      before do
        create(:ci_stage_entity, project: project,
                                 pipeline: pipeline,
                                 name: 'build')
      end

      it 'returns persisted stages' do
        expect(pipeline.stages).not_to be_empty
        expect(pipeline.stages).to all(be_persisted)
      end
    end

    describe '#ordered_stages' do
      before do
        create(:ci_stage_entity, project: project,
                                 pipeline: pipeline,
                                 position: 4,
                                 name: 'deploy')

        create(:ci_build, project: project,
                          pipeline: pipeline,
                          stage: 'test',
                          stage_idx: 3,
                          name: 'test')

        create(:ci_build, project: project,
                          pipeline: pipeline,
                          stage: 'build',
                          stage_idx: 2,
                          name: 'build')

        create(:ci_stage_entity, project: project,
                                 pipeline: pipeline,
                                 position: 1,
                                 name: 'sanity')

        create(:ci_stage_entity, project: project,
                                 pipeline: pipeline,
                                 position: 5,
                                 name: 'cleanup')
      end

      subject { pipeline.ordered_stages }

      context 'when using legacy stages' do
        before do
          stub_feature_flags(ci_pipeline_persisted_stages: false)
        end

        it 'returns legacy stages in valid order' do
          expect(subject.map(&:name)).to eq %w[build test]
        end
      end

      context 'when using persisted stages' do
        before do
          stub_feature_flags(ci_pipeline_persisted_stages: true)
        end

        context 'when pipelines is not complete' do
          it 'still returns legacy stages' do
            expect(subject).to all(be_a Ci::LegacyStage)
            expect(subject.map(&:name)).to eq %w[build test]
          end
        end

        context 'when pipeline is complete' do
          before do
            pipeline.succeed!
          end

          it 'returns stages in valid order' do
            expect(subject).to all(be_a Ci::Stage)
            expect(subject.map(&:name))
              .to eq %w[sanity build test deploy cleanup]
          end
        end
      end
    end
633 634
  end

635
  describe 'state machine' do
636
    let(:current) { Time.now.change(usec: 0) }
637 638 639
    let(:build) { create_build('build1', queued_at: 0) }
    let(:build_b) { create_build('build2', queued_at: 0) }
    let(:build_c) { create_build('build3', queued_at: 0) }
640

641
    describe '#duration' do
642 643 644 645 646 647 648 649
      context 'when multiple builds are finished' do
        before do
          travel_to(current + 30) do
            build.run!
            build.success!
            build_b.run!
            build_c.run!
          end
650

651 652 653 654 655 656 657
          travel_to(current + 40) do
            build_b.drop!
          end

          travel_to(current + 70) do
            build_c.success!
          end
658
        end
659

660 661 662 663
        it 'matches sum of builds duration' do
          pipeline.reload

          expect(pipeline.duration).to eq(40)
664
        end
665 666
      end

667 668
      context 'when pipeline becomes blocked' do
        let!(:build) { create_build('build:1') }
669
        let!(:action) { create_build('manual:action', :manual) }
670

671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686
        before do
          travel_to(current + 1.minute) do
            build.run!
          end

          travel_to(current + 5.minutes) do
            build.success!
          end
        end

        it 'recalculates pipeline duration' do
          pipeline.reload

          expect(pipeline).to be_manual
          expect(pipeline.duration).to eq 4.minutes
        end
687
      end
688 689
    end

690 691 692
    describe '#started_at' do
      it 'updates on transitioning to running' do
        build.run
693

694 695 696
        expect(pipeline.reload.started_at).not_to be_nil
      end

697
      it 'does not update on transitioning to success' do
698 699 700
        build.success

        expect(pipeline.reload.started_at).to be_nil
701 702 703
      end
    end

704 705 706
    describe '#finished_at' do
      it 'updates on transitioning to success' do
        build.success
707

708
        expect(pipeline.reload.finished_at).not_to be_nil
709 710
      end

711
      it 'does not update on transitioning to running' do
712 713 714
        build.run

        expect(pipeline.reload.finished_at).to be_nil
715 716
      end
    end
717

718
    describe 'merge request metrics' do
719
      let(:project) { create(:project, :repository) }
720
      let(:pipeline) { FactoryBot.create(:ci_empty_pipeline, status: 'created', project: project, ref: 'master', sha: project.repository.commit('master').id) }
721 722
      let!(:merge_request) { create(:merge_request, source_project: project, source_branch: pipeline.ref) }

723 724 725
      before do
        expect(PipelineMetricsWorker).to receive(:perform_async).with(pipeline.id)
      end
726

727 728 729
      context 'when transitioning to running' do
        it 'schedules metrics workers' do
          pipeline.run
730 731 732 733
        end
      end

      context 'when transitioning to success' do
734 735
        it 'schedules metrics workers' do
          pipeline.succeed
736 737 738
        end
      end
    end
739

740
    describe 'pipeline caching' do
741 742
      it 'performs ExpirePipelinesCacheWorker' do
        expect(ExpirePipelineCacheWorker).to receive(:perform_async).with(pipeline.id)
743 744 745 746 747

        pipeline.cancel
      end
    end

748 749
    def create_build(name, *traits, queued_at: current, started_from: 0, **opts)
      create(:ci_build, *traits,
750 751
             name: name,
             pipeline: pipeline,
752
             queued_at: queued_at,
753 754
             started_at: queued_at + started_from,
             **opts)
755
    end
756
  end
Kamil Trzcinski's avatar
Kamil Trzcinski committed
757 758

  describe '#branch?' do
759
    subject { pipeline.branch? }
Kamil Trzcinski's avatar
Kamil Trzcinski committed
760 761 762

    context 'is not a tag' do
      before do
763
        pipeline.tag = false
Kamil Trzcinski's avatar
Kamil Trzcinski committed
764 765 766 767 768 769 770 771 772
      end

      it 'return true when tag is set to false' do
        is_expected.to be_truthy
      end
    end

    context 'is not a tag' do
      before do
773
        pipeline.tag = true
Kamil Trzcinski's avatar
Kamil Trzcinski committed
774 775 776 777 778 779 780
      end

      it 'return false when tag is set to true' do
        is_expected.to be_falsey
      end
    end
  end
781

782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804
  describe 'ref_exists?' do
    using RSpec::Parameterized::TableSyntax

    let(:project) { create(:project, :repository) }

    where(:tag, :ref, :result) do
      false | 'master'              | true
      false | 'non-existent-branch' | false
      true  | 'v1.1.0'              | true
      true  | 'non-existent-tag'    | false
    end

    with_them do
      let(:pipeline) do
        create(:ci_empty_pipeline, project: project, tag: tag, ref: ref)
      end

      it "correctly detects ref" do
        expect(pipeline.ref_exists?).to be result
      end
    end
  end

805
  context 'with non-empty project' do
806
    let(:project) { create(:project, :repository) }
807 808 809 810 811 812 813

    let(:pipeline) do
      create(:ci_pipeline,
             project: project,
             ref: project.default_branch,
             sha: project.commit.sha)
    end
814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834

    describe '#latest?' do
      context 'with latest sha' do
        it 'returns true' do
          expect(pipeline).to be_latest
        end
      end

      context 'with not latest sha' do
        before do
          pipeline.update(
            sha: project.commit("#{project.default_branch}~1").sha)
        end

        it 'returns false' do
          expect(pipeline).not_to be_latest
        end
      end
    end
  end

835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851
  describe '#manual_actions' do
    subject { pipeline.manual_actions }

    it 'when none defined' do
      is_expected.to be_empty
    end

    context 'when action defined' do
      let!(:manual) { create(:ci_build, :manual, pipeline: pipeline, name: 'deploy') }

      it 'returns one action' do
        is_expected.to contain_exactly(manual)
      end

      context 'there are multiple of the same name' do
        let!(:manual2) { create(:ci_build, :manual, pipeline: pipeline, name: 'deploy') }

852 853 854 855
        before do
          manual.update(retried: true)
        end

856 857 858 859 860 861
        it 'returns latest one' do
          is_expected.to contain_exactly(manual2)
        end
      end
    end
  end
862

863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913
  describe '#branch_updated?' do
    context 'when pipeline has before SHA' do
      before do
        pipeline.update_column(:before_sha, 'a1b2c3d4')
      end

      it 'runs on a branch update push' do
        expect(pipeline.before_sha).not_to be Gitlab::Git::BLANK_SHA
        expect(pipeline.branch_updated?).to be true
      end
    end

    context 'when pipeline does not have before SHA' do
      before do
        pipeline.update_column(:before_sha, Gitlab::Git::BLANK_SHA)
      end

      it 'does not run on a branch updating push' do
        expect(pipeline.branch_updated?).to be false
      end
    end
  end

  describe '#modified_paths' do
    context 'when old and new revisions are set' do
      let(:project) { create(:project, :repository) }

      before do
        pipeline.update(before_sha: '1234abcd', sha: '2345bcde')
      end

      it 'fetches stats for changes between commits' do
        expect(project.repository)
          .to receive(:diff_stats).with('1234abcd', '2345bcde')
          .and_call_original

        pipeline.modified_paths
      end
    end

    context 'when either old or new revision is missing' do
      before do
        pipeline.update_column(:before_sha, Gitlab::Git::BLANK_SHA)
      end

      it 'raises an error' do
        expect { pipeline.modified_paths }.to raise_error(ArgumentError)
      end
    end
  end

914
  describe '#has_kubernetes_active?' do
915
    context 'when kubernetes is active' do
916
      shared_examples 'same behavior between KubernetesService and Platform::Kubernetes' do
917 918 919 920 921 922 923 924
        it 'returns true' do
          expect(pipeline).to have_kubernetes_active
        end
      end

      context 'when user configured kubernetes from Integration > Kubernetes' do
        let(:project) { create(:kubernetes_project) }

925
        it_behaves_like 'same behavior between KubernetesService and Platform::Kubernetes'
926 927 928 929 930
      end

      context 'when user configured kubernetes from CI/CD > Clusters' do
        let!(:cluster) { create(:cluster, :project, :provided_by_gcp) }
        let(:project) { cluster.project }
931

932
        it_behaves_like 'same behavior between KubernetesService and Platform::Kubernetes'
933 934 935
      end
    end

936
    context 'when kubernetes is not active' do
937
      it 'returns false' do
938
        expect(pipeline).not_to have_kubernetes_active
939 940 941 942
      end
    end
  end

Connor Shea's avatar
Connor Shea committed
943 944
  describe '#has_warnings?' do
    subject { pipeline.has_warnings? }
945 946 947

    context 'build which is allowed to fail fails' do
      before do
Connor Shea's avatar
Connor Shea committed
948 949
        create :ci_build, :success, pipeline: pipeline, name: 'rspec'
        create :ci_build, :allowed_to_fail, :failed, pipeline: pipeline, name: 'rubocop'
950
      end
951

952 953 954 955 956 957 958
      it 'returns true' do
        is_expected.to be_truthy
      end
    end

    context 'build which is allowed to fail succeeds' do
      before do
Connor Shea's avatar
Connor Shea committed
959 960
        create :ci_build, :success, pipeline: pipeline, name: 'rspec'
        create :ci_build, :allowed_to_fail, :success, pipeline: pipeline, name: 'rubocop'
961
      end
962

963 964 965 966
      it 'returns false' do
        is_expected.to be_falsey
      end
    end
Connor Shea's avatar
Connor Shea committed
967 968 969 970 971 972 973 974 975 976 977 978

    context 'build is retried and succeeds' do
      before do
        create :ci_build, :success, pipeline: pipeline, name: 'rubocop'
        create :ci_build, :failed, pipeline: pipeline, name: 'rspec'
        create :ci_build, :success, pipeline: pipeline, name: 'rspec'
      end

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

981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007
  describe '#number_of_warnings' do
    it 'returns the number of warnings' do
      create(:ci_build, :allowed_to_fail, :failed, pipeline: pipeline, name: 'rubocop')

      expect(pipeline.number_of_warnings).to eq(1)
    end

    it 'supports eager loading of the number of warnings' do
      pipeline2 = create(:ci_empty_pipeline, status: :created, project: project)

      create(:ci_build, :allowed_to_fail, :failed, pipeline: pipeline, name: 'rubocop')
      create(:ci_build, :allowed_to_fail, :failed, pipeline: pipeline2, name: 'rubocop')

      pipelines = project.pipelines.to_a

      pipelines.each(&:number_of_warnings)

      # To run the queries we need to actually use the lazy objects, which we do
      # by just sending "to_i" to them.
      amount = ActiveRecord::QueryRecorder
        .new { pipelines.each { |p| p.number_of_warnings.to_i } }
        .count

      expect(amount).to eq(1)
    end
  end

1008
  shared_context 'with some outdated pipelines' do
1009
    before do
1010 1011 1012 1013
      create_pipeline(:canceled, 'ref', 'A', project)
      create_pipeline(:success, 'ref', 'A', project)
      create_pipeline(:failed, 'ref', 'B', project)
      create_pipeline(:skipped, 'feature', 'C', project)
1014 1015
    end

1016 1017 1018 1019 1020 1021 1022 1023
    def create_pipeline(status, ref, sha, project)
      create(
        :ci_empty_pipeline,
        status: status,
        ref: ref,
        sha: sha,
        project: project
      )
1024 1025 1026
    end
  end

1027
  describe '.newest_first' do
1028
    include_context 'with some outdated pipelines'
1029

1030 1031 1032
    it 'returns the pipelines from new to old' do
      expect(described_class.newest_first.pluck(:status))
        .to eq(%w[skipped failed success canceled])
1033 1034 1035 1036
    end
  end

  describe '.latest_status' do
1037
    include_context 'with some outdated pipelines'
1038 1039

    context 'when no ref is specified' do
1040 1041
      it 'returns the status of the latest pipeline' do
        expect(described_class.latest_status).to eq('skipped')
1042 1043 1044 1045
      end
    end

    context 'when ref is specified' do
1046 1047
      it 'returns the status of the latest pipeline for the given ref' do
        expect(described_class.latest_status('ref')).to eq('failed')
1048 1049 1050 1051
      end
    end
  end

1052 1053 1054 1055
  describe '.latest_successful_for' do
    include_context 'with some outdated pipelines'

    let!(:latest_successful_pipeline) do
1056
      create_pipeline(:success, 'ref', 'D', project)
1057 1058 1059
    end

    it 'returns the latest successful pipeline' do
1060 1061
      expect(described_class.latest_successful_for('ref'))
        .to eq(latest_successful_pipeline)
1062 1063 1064
    end
  end

1065 1066 1067
  describe '.latest_successful_for_refs' do
    include_context 'with some outdated pipelines'

1068 1069 1070 1071 1072 1073 1074
    let!(:latest_successful_pipeline1) do
      create_pipeline(:success, 'ref1', 'D', project)
    end

    let!(:latest_successful_pipeline2) do
      create_pipeline(:success, 'ref2', 'D', project)
    end
1075 1076 1077 1078 1079 1080 1081 1082

    it 'returns the latest successful pipeline for both refs' do
      refs = %w(ref1 ref2 ref3)

      expect(described_class.latest_successful_for_refs(refs)).to eq({ 'ref1' => latest_successful_pipeline1, 'ref2' => latest_successful_pipeline2 })
    end
  end

1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138
  describe '.latest_status_per_commit' do
    let(:project) { create(:project) }

    before do
      pairs = [
        %w[success ref1 123],
        %w[manual master 123],
        %w[failed ref 456]
      ]

      pairs.each do |(status, ref, sha)|
        create(
          :ci_empty_pipeline,
          status: status,
          ref: ref,
          sha: sha,
          project: project
        )
      end
    end

    context 'without a ref' do
      it 'returns a Hash containing the latest status per commit for all refs' do
        expect(described_class.latest_status_per_commit(%w[123 456]))
          .to eq({ '123' => 'manual', '456' => 'failed' })
      end

      it 'only includes the status of the given commit SHAs' do
        expect(described_class.latest_status_per_commit(%w[123]))
          .to eq({ '123' => 'manual' })
      end

      context 'when there are two pipelines for a ref and SHA' do
        it 'returns the status of the latest pipeline' do
          create(
            :ci_empty_pipeline,
            status: 'failed',
            ref: 'master',
            sha: '123',
            project: project
          )

          expect(described_class.latest_status_per_commit(%w[123]))
            .to eq({ '123' => 'failed' })
        end
      end
    end

    context 'with a ref' do
      it 'only includes the pipelines for the given ref' do
        expect(described_class.latest_status_per_commit(%w[123 456], 'master'))
          .to eq({ '123' => 'manual' })
      end
    end
  end

1139 1140 1141 1142 1143 1144
  describe '.internal_sources' do
    subject { described_class.internal_sources }

    it { is_expected.to be_an(Array) }
  end

1145
  describe '#status' do
1146 1147 1148
    let(:build) do
      create(:ci_build, :created, pipeline: pipeline, name: 'test')
    end
1149 1150 1151 1152

    subject { pipeline.reload.status }

    context 'on queuing' do
1153 1154 1155
      before do
        build.enqueue
      end
1156 1157 1158 1159 1160 1161

      it { is_expected.to eq('pending') }
    end

    context 'on run' do
      before do
1162
        build.enqueue
1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189
        build.run
      end

      it { is_expected.to eq('running') }
    end

    context 'on drop' do
      before do
        build.drop
      end

      it { is_expected.to eq('failed') }
    end

    context 'on success' do
      before do
        build.success
      end

      it { is_expected.to eq('success') }
    end

    context 'on cancel' do
      before do
        build.cancel
      end

1190 1191 1192 1193 1194 1195 1196
      context 'when build is pending' do
        let(:build) do
          create(:ci_build, :pending, pipeline: pipeline)
        end

        it { is_expected.to eq('canceled') }
      end
1197
    end
1198 1199 1200

    context 'on failure and build retry' do
      before do
Shinya Maeda's avatar
Shinya Maeda committed
1201 1202
        stub_not_protect_default_branch

1203
        build.drop
1204
        project.add_developer(user)
1205 1206

        Ci::Build.retry(build, user)
1207 1208 1209 1210 1211 1212 1213 1214
      end

      # We are changing a state: created > failed > running
      # Instead of: created > failed > pending
      # Since the pipeline already run, so it should not be pending anymore

      it { is_expected.to eq('running') }
    end
1215
  end
1216

1217 1218 1219 1220
  describe '#ci_yaml_file_path' do
    subject { pipeline.ci_yaml_file_path }

    it 'returns the path from project' do
1221
      allow(pipeline.project).to receive(:ci_config_path) { 'custom/path' }
1222 1223 1224 1225 1226

      is_expected.to eq('custom/path')
    end

    it 'returns default when custom path is nil' do
1227
      allow(pipeline.project).to receive(:ci_config_path) { nil }
1228 1229 1230 1231 1232

      is_expected.to eq('.gitlab-ci.yml')
    end

    it 'returns default when custom path is empty' do
1233
      allow(pipeline.project).to receive(:ci_config_path) { '' }
1234 1235 1236 1237 1238

      is_expected.to eq('.gitlab-ci.yml')
    end
  end

1239
  describe '#set_config_source' do
1240 1241 1242 1243 1244
    context 'when pipelines does not contain needed data and auto devops is disabled' do
      before do
        stub_application_setting(auto_devops_enabled: false)
      end

1245 1246
      it 'defines source to be unknown' do
        pipeline.set_config_source
1247

1248
        expect(pipeline).to be_unknown_source
1249
      end
1250
    end
1251

1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263
    context 'when pipeline contains all needed data' do
      let(:pipeline) do
        create(:ci_pipeline, project: project,
                             sha: '1234',
                             ref: 'master',
                             source: :push)
      end

      context 'when the repository has a config file' do
        before do
          allow(project.repository).to receive(:gitlab_ci_yml_for)
            .and_return('config')
1264
        end
1265

1266 1267
        it 'defines source to be from repository' do
          pipeline.set_config_source
1268

1269 1270
          expect(pipeline).to be_repository_source
        end
1271

1272 1273
        context 'when loading an object' do
          let(:new_pipeline) { Ci::Pipeline.find(pipeline.id) }
1274

1275 1276 1277
          it 'does not redefine the source' do
            # force to overwrite the source
            pipeline.unknown_source!
1278

1279
            expect(new_pipeline).to be_unknown_source
1280
          end
1281
        end
1282
      end
1283

1284 1285
      context 'when the repository does not have a config file' do
        let(:implied_yml) { Gitlab::Template::GitlabCiYmlTemplate.find('Auto-DevOps').content }
1286

1287 1288 1289 1290
        context 'auto devops enabled' do
          before do
            allow(project).to receive(:ci_config_path) { 'custom' }
          end
1291

1292 1293
          it 'defines source to be auto devops' do
            pipeline.set_config_source
1294

1295
            expect(pipeline).to be_auto_devops_source
1296
          end
1297
        end
1298 1299 1300
      end
    end
  end
1301

1302 1303
  describe '#ci_yaml_file' do
    let(:implied_yml) { Gitlab::Template::GitlabCiYmlTemplate.find('Auto-DevOps').content }
1304

1305
    context 'the source is unknown' do
1306 1307 1308
      before do
        pipeline.unknown_source!
      end
1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322

      it 'returns the configuration if found' do
        allow(pipeline.project.repository).to receive(:gitlab_ci_yml_for)
          .and_return('config')

        expect(pipeline.ci_yaml_file).to be_a(String)
        expect(pipeline.ci_yaml_file).not_to eq(implied_yml)
        expect(pipeline.yaml_errors).to be_nil
      end

      it 'sets yaml errors if not found' do
        expect(pipeline.ci_yaml_file).to be_nil
        expect(pipeline.yaml_errors)
            .to start_with('Failed to load CI/CD config file')
1323 1324 1325
      end
    end

1326
    context 'the source is the repository' do
1327 1328 1329
      before do
        pipeline.repository_source!
      end
1330

1331 1332 1333 1334 1335 1336 1337
      it 'returns the configuration if found' do
        allow(pipeline.project.repository).to receive(:gitlab_ci_yml_for)
          .and_return('config')

        expect(pipeline.ci_yaml_file).to be_a(String)
        expect(pipeline.ci_yaml_file).not_to eq(implied_yml)
        expect(pipeline.yaml_errors).to be_nil
1338
      end
1339
    end
1340

1341
    context 'when the source is auto_devops_source' do
1342
      before do
1343
        stub_application_setting(auto_devops_enabled: true)
1344 1345
        pipeline.auto_devops_source!
      end
1346

1347 1348 1349
      it 'finds the implied config' do
        expect(pipeline.ci_yaml_file).to eq(implied_yml)
        expect(pipeline.yaml_errors).to be_nil
1350
      end
1351 1352 1353
    end
  end

1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376
  describe '#update_status' do
    context 'when pipeline is empty' do
      it 'updates does not change pipeline status' do
        expect(pipeline.statuses.latest.status).to be_nil

        expect { pipeline.update_status }
          .to change { pipeline.reload.status }.to 'skipped'
      end
    end

    context 'when updating status to pending' do
      before do
        allow(pipeline)
          .to receive_message_chain(:statuses, :latest, :status)
          .and_return(:running)
      end

      it 'updates pipeline status to running' do
        expect { pipeline.update_status }
          .to change { pipeline.reload.status }.to 'running'
      end
    end

1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389
    context 'when updating status to scheduled' do
      before do
        allow(pipeline)
          .to receive_message_chain(:statuses, :latest, :status)
          .and_return(:scheduled)
      end

      it 'updates pipeline status to scheduled' do
        expect { pipeline.update_status }
          .to change { pipeline.reload.status }.to 'scheduled'
      end
    end

1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403
    context 'when statuses status was not recognized' do
      before do
        allow(pipeline)
          .to receive(:latest_builds_status)
          .and_return(:unknown)
      end

      it 'raises an exception' do
        expect { pipeline.update_status }
          .to raise_error(HasStatus::UnknownStatusError)
      end
    end
  end

1404
  describe '#detailed_status' do
1405 1406
    subject { pipeline.detailed_status(user) }

1407 1408 1409 1410
    context 'when pipeline is created' do
      let(:pipeline) { create(:ci_pipeline, status: :created) }

      it 'returns detailed status for created pipeline' do
1411
        expect(subject.text).to eq 'created'
1412 1413 1414 1415 1416 1417 1418
      end
    end

    context 'when pipeline is pending' do
      let(:pipeline) { create(:ci_pipeline, status: :pending) }

      it 'returns detailed status for pending pipeline' do
1419
        expect(subject.text).to eq 'pending'
1420 1421 1422 1423 1424 1425 1426
      end
    end

    context 'when pipeline is running' do
      let(:pipeline) { create(:ci_pipeline, status: :running) }

      it 'returns detailed status for running pipeline' do
1427
        expect(subject.text).to eq 'running'
1428 1429 1430 1431 1432 1433 1434
      end
    end

    context 'when pipeline is successful' do
      let(:pipeline) { create(:ci_pipeline, status: :success) }

      it 'returns detailed status for successful pipeline' do
1435
        expect(subject.text).to eq 'passed'
1436 1437 1438 1439 1440 1441 1442
      end
    end

    context 'when pipeline is failed' do
      let(:pipeline) { create(:ci_pipeline, status: :failed) }

      it 'returns detailed status for failed pipeline' do
1443
        expect(subject.text).to eq 'failed'
1444 1445 1446 1447 1448 1449 1450
      end
    end

    context 'when pipeline is canceled' do
      let(:pipeline) { create(:ci_pipeline, status: :canceled) }

      it 'returns detailed status for canceled pipeline' do
1451
        expect(subject.text).to eq 'canceled'
1452 1453 1454 1455 1456 1457 1458
      end
    end

    context 'when pipeline is skipped' do
      let(:pipeline) { create(:ci_pipeline, status: :skipped) }

      it 'returns detailed status for skipped pipeline' do
1459
        expect(subject.text).to eq 'skipped'
1460 1461 1462
      end
    end

1463 1464 1465 1466
    context 'when pipeline is blocked' do
      let(:pipeline) { create(:ci_pipeline, status: :manual) }

      it 'returns detailed status for blocked pipeline' do
1467
        expect(subject.text).to eq 'blocked'
1468 1469 1470
      end
    end

1471 1472 1473 1474 1475 1476 1477 1478
    context 'when pipeline is successful but with warnings' do
      let(:pipeline) { create(:ci_pipeline, status: :success) }

      before do
        create(:ci_build, :allowed_to_fail, :failed, pipeline: pipeline)
      end

      it 'retruns detailed status for successful pipeline with warnings' do
1479
        expect(subject.label).to eq 'passed with warnings'
1480 1481 1482 1483
      end
    end
  end

1484
  describe '#cancelable?' do
1485 1486
    %i[created running pending].each do |status0|
      context "when there is a build #{status0}" do
1487
        before do
1488
          create(:ci_build, status0, pipeline: pipeline)
1489 1490
        end

1491 1492 1493
        it 'is cancelable' do
          expect(pipeline.cancelable?).to be_truthy
        end
1494 1495
      end

1496
      context "when there is an external job #{status0}" do
1497
        before do
1498
          create(:generic_commit_status, status0, pipeline: pipeline)
1499 1500
        end

1501 1502 1503
        it 'is cancelable' do
          expect(pipeline.cancelable?).to be_truthy
        end
1504
      end
1505

1506
      %i[success failed canceled].each do |status1|
1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536
        context "when there are generic_commit_status jobs for #{status0} and #{status1}" do
          before do
            create(:generic_commit_status, status0, pipeline: pipeline)
            create(:generic_commit_status, status1, pipeline: pipeline)
          end

          it 'is cancelable' do
            expect(pipeline.cancelable?).to be_truthy
          end
        end

        context "when there are generic_commit_status and ci_build jobs for #{status0} and #{status1}" do
          before do
            create(:generic_commit_status, status0, pipeline: pipeline)
            create(:ci_build, status1, pipeline: pipeline)
          end

          it 'is cancelable' do
            expect(pipeline.cancelable?).to be_truthy
          end
        end

        context "when there are ci_build jobs for #{status0} and #{status1}" do
          before do
            create(:ci_build, status0, pipeline: pipeline)
            create(:ci_build, status1, pipeline: pipeline)
          end

          it 'is cancelable' do
            expect(pipeline.cancelable?).to be_truthy
1537
          end
1538 1539
        end
      end
1540 1541 1542 1543 1544 1545 1546 1547
    end

    %i[success failed canceled].each do |status|
      context "when there is a build #{status}" do
        before do
          create(:ci_build, status, pipeline: pipeline)
        end

1548 1549 1550
        it 'is not cancelable' do
          expect(pipeline.cancelable?).to be_falsey
        end
1551 1552 1553 1554 1555 1556 1557
      end

      context "when there is an external job #{status}" do
        before do
          create(:generic_commit_status, status, pipeline: pipeline)
        end

1558 1559 1560
        it 'is not cancelable' do
          expect(pipeline.cancelable?).to be_falsey
        end
1561 1562
      end
    end
1563 1564 1565 1566 1567 1568 1569 1570 1571 1572

    context 'when there is a manual action present in the pipeline' do
      before do
        create(:ci_build, :manual, pipeline: pipeline)
      end

      it 'is not cancelable' do
        expect(pipeline).not_to be_cancelable
      end
    end
1573 1574
  end

1575
  describe '#cancel_running' do
1576 1577
    let(:latest_status) { pipeline.statuses.pluck(:status) }

1578
    context 'when there is a running external job and a regular job' do
1579
      before do
1580
        create(:ci_build, :running, pipeline: pipeline)
1581 1582 1583 1584 1585 1586
        create(:generic_commit_status, :running, pipeline: pipeline)

        pipeline.cancel_running
      end

      it 'cancels both jobs' do
1587 1588 1589 1590
        expect(latest_status).to contain_exactly('canceled', 'canceled')
      end
    end

1591
    context 'when jobs are in different stages' do
1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602
      before do
        create(:ci_build, :running, stage_idx: 0, pipeline: pipeline)
        create(:ci_build, :running, stage_idx: 1, pipeline: pipeline)

        pipeline.cancel_running
      end

      it 'cancels both jobs' do
        expect(latest_status).to contain_exactly('canceled', 'canceled')
      end
    end
1603 1604 1605 1606 1607 1608 1609 1610 1611

    context 'when there are created builds present in the pipeline' do
      before do
        create(:ci_build, :running, stage_idx: 0, pipeline: pipeline)
        create(:ci_build, :created, stage_idx: 1, pipeline: pipeline)

        pipeline.cancel_running
      end

1612
      it 'cancels created builds' do
Douwe Maan's avatar
Douwe Maan committed
1613
        expect(latest_status).to eq %w(canceled canceled)
1614 1615
      end
    end
1616 1617 1618 1619 1620
  end

  describe '#retry_failed' do
    let(:latest_status) { pipeline.statuses.latest.pluck(:status) }

1621
    before do
Shinya Maeda's avatar
Shinya Maeda committed
1622 1623
      stub_not_protect_default_branch

1624
      project.add_developer(user)
1625 1626
    end

1627 1628 1629 1630 1631
    context 'when there is a failed build and failed external status' do
      before do
        create(:ci_build, :failed, name: 'build', pipeline: pipeline)
        create(:generic_commit_status, :failed, name: 'jenkins', pipeline: pipeline)

1632
        pipeline.retry_failed(user)
1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644
      end

      it 'retries only build' do
        expect(latest_status).to contain_exactly('pending', 'failed')
      end
    end

    context 'when builds are in different stages' do
      before do
        create(:ci_build, :failed, name: 'build', stage_idx: 0, pipeline: pipeline)
        create(:ci_build, :failed, name: 'jenkins', stage_idx: 1, pipeline: pipeline)

1645
        pipeline.retry_failed(user)
1646 1647 1648
      end

      it 'retries both builds' do
1649
        expect(latest_status).to contain_exactly('pending', 'created')
1650 1651 1652 1653 1654 1655 1656 1657
      end
    end

    context 'when there are canceled and failed' do
      before do
        create(:ci_build, :failed, name: 'build', stage_idx: 0, pipeline: pipeline)
        create(:ci_build, :canceled, name: 'jenkins', stage_idx: 1, pipeline: pipeline)

1658
        pipeline.retry_failed(user)
1659 1660 1661
      end

      it 'retries both builds' do
1662
        expect(latest_status).to contain_exactly('pending', 'created')
1663 1664 1665 1666
      end
    end
  end

1667
  describe '#execute_hooks' do
Lin Jen-Shin's avatar
Lin Jen-Shin committed
1668
    let!(:build_a) { create_build('a', 0) }
Shinya Maeda's avatar
Shinya Maeda committed
1669
    let!(:build_b) { create_build('b', 0) }
1670

1671 1672 1673 1674 1675
    let!(:hook) do
      create(:project_hook, project: project, pipeline_events: enabled)
    end

    before do
1676
      WebHookWorker.drain
1677 1678 1679 1680 1681
    end

    context 'with pipeline hooks enabled' do
      let(:enabled) { true }

1682 1683 1684 1685
      before do
        WebMock.stub_request(:post, hook.url)
      end

1686
      context 'with multiple builds' do
1687 1688
        context 'when build is queued' do
          before do
1689 1690
            build_a.enqueue
            build_b.enqueue
1691
          end
1692

Lin Jen-Shin's avatar
Lin Jen-Shin committed
1693
          it 'receives a pending event once' do
1694
            expect(WebMock).to have_requested_pipeline_hook('pending').once
1695 1696
          end
        end
1697

1698 1699
        context 'when build is run' do
          before do
1700
            build_a.enqueue
1701
            build_a.run
1702
            build_b.enqueue
1703 1704
            build_b.run
          end
1705

Lin Jen-Shin's avatar
Lin Jen-Shin committed
1706
          it 'receives a running event once' do
1707
            expect(WebMock).to have_requested_pipeline_hook('running').once
1708
          end
1709 1710
        end

1711 1712 1713
        context 'when all builds succeed' do
          before do
            build_a.success
Kamil Trzcinski's avatar
Kamil Trzcinski committed
1714 1715 1716

            # We have to reload build_b as this is in next stage and it gets triggered by PipelineProcessWorker
            build_b.reload.success
1717 1718
          end

Lin Jen-Shin's avatar
Lin Jen-Shin committed
1719
          it 'receives a success event once' do
1720
            expect(WebMock).to have_requested_pipeline_hook('success').once
1721
          end
1722 1723
        end

Lin Jen-Shin's avatar
Lin Jen-Shin committed
1724
        context 'when stage one failed' do
Shinya Maeda's avatar
Shinya Maeda committed
1725 1726
          let!(:build_b) { create_build('b', 1) }

Lin Jen-Shin's avatar
Lin Jen-Shin committed
1727 1728 1729 1730
          before do
            build_a.drop
          end

Lin Jen-Shin's avatar
Lin Jen-Shin committed
1731
          it 'receives a failed event once' do
Lin Jen-Shin's avatar
Lin Jen-Shin committed
1732 1733 1734 1735
            expect(WebMock).to have_requested_pipeline_hook('failed').once
          end
        end

1736
        def have_requested_pipeline_hook(status)
1737
          have_requested(:post, hook.url).with do |req|
1738 1739 1740 1741
            json_body = JSON.parse(req.body)
            json_body['object_attributes']['status'] == status &&
              json_body['builds'].length == 2
          end
1742
        end
1743
      end
1744 1745 1746 1747 1748
    end

    context 'with pipeline hooks disabled' do
      let(:enabled) { false }

1749
      before do
1750 1751
        build_a.enqueue
        build_b.enqueue
1752 1753
      end

1754 1755 1756 1757
      it 'did not execute pipeline_hook after touched' do
        expect(WebMock).not_to have_requested(:post, hook.url)
      end
    end
1758

Lin Jen-Shin's avatar
Lin Jen-Shin committed
1759 1760 1761 1762 1763 1764
    def create_build(name, stage_idx)
      create(:ci_build,
             :created,
             pipeline: pipeline,
             name: name,
             stage_idx: stage_idx)
1765
    end
1766
  end
1767 1768

  describe "#merge_requests" do
1769
    let(:project) { create(:project) }
1770
    let(:pipeline) { create(:ci_empty_pipeline, status: 'created', project: project, ref: 'master', sha: 'a288a022a53a5a944fae87bcec6efc87b7061808') }
1771 1772

    it "returns merge requests whose `diff_head_sha` matches the pipeline's SHA" do
1773
      allow_any_instance_of(MergeRequest).to receive(:diff_head_sha) { 'a288a022a53a5a944fae87bcec6efc87b7061808' }
Felipe Artur's avatar
Felipe Artur committed
1774
      merge_request = create(:merge_request, source_project: project, head_pipeline: pipeline, source_branch: pipeline.ref)
1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791

      expect(pipeline.merge_requests).to eq([merge_request])
    end

    it "doesn't return merge requests whose source branch doesn't match the pipeline's ref" do
      create(:merge_request, source_project: project, source_branch: 'feature', target_branch: 'master')

      expect(pipeline.merge_requests).to be_empty
    end

    it "doesn't return merge requests whose `diff_head_sha` doesn't match the pipeline's SHA" do
      create(:merge_request, source_project: project, source_branch: pipeline.ref)
      allow_any_instance_of(MergeRequest).to receive(:diff_head_sha) { '97de212e80737a608d939f648d959671fb0a0142b' }

      expect(pipeline.merge_requests).to be_empty
    end
  end
1792

1793
  describe "#all_merge_requests" do
1794
    let(:project) { create(:project) }
1795
    let(:pipeline) { create(:ci_empty_pipeline, status: 'created', project: project, ref: 'master') }
1796

1797
    it "returns all merge requests having the same source branch" do
1798 1799 1800 1801 1802
      merge_request = create(:merge_request, source_project: project, source_branch: pipeline.ref)

      expect(pipeline.all_merge_requests).to eq([merge_request])
    end

1803
    it "doesn't return merge requests having a different source branch" do
1804 1805 1806 1807 1808 1809
      create(:merge_request, source_project: project, source_branch: 'feature', target_branch: 'master')

      expect(pipeline.all_merge_requests).to be_empty
    end
  end

1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821
  describe '#stuck?' do
    before do
      create(:ci_build, :pending, pipeline: pipeline)
    end

    context 'when pipeline is stuck' do
      it 'is stuck' do
        expect(pipeline).to be_stuck
      end
    end

    context 'when pipeline is not stuck' do
1822
      before do
1823
        create(:ci_runner, :instance, :online)
1824
      end
1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847

      it 'is not stuck' do
        expect(pipeline).not_to be_stuck
      end
    end
  end

  describe '#has_yaml_errors?' do
    context 'when pipeline has errors' do
      let(:pipeline) do
        create(:ci_pipeline, config: { rspec: nil })
      end

      it 'contains yaml errors' do
        expect(pipeline).to have_yaml_errors
      end
    end

    context 'when pipeline does not have errors' do
      let(:pipeline) do
        create(:ci_pipeline, config: { rspec: { script: 'rake test' } })
      end

1848
      it 'does not contain yaml errors' do
1849 1850 1851 1852 1853
        expect(pipeline).not_to have_yaml_errors
      end
    end
  end

1854
  describe 'notifications when pipeline success or failed' do
1855
    let(:project) { create(:project, :repository) }
1856 1857 1858 1859 1860 1861 1862 1863

    let(:pipeline) do
      create(:ci_pipeline,
             project: project,
             sha: project.commit('master').sha,
             user: create(:user))
    end

1864
    before do
1865
      project.add_developer(pipeline.user)
1866

1867 1868
      pipeline.user.global_notification_setting
        .update(level: 'custom', failed_pipeline: true, success_pipeline: true)
Sean McGivern's avatar
Sean McGivern committed
1869

1870 1871 1872 1873
      perform_enqueued_jobs do
        pipeline.enqueue
        pipeline.run
      end
1874 1875 1876 1877
    end

    shared_examples 'sending a notification' do
      it 'sends an email' do
1878
        should_only_email(pipeline.user, kind: :bcc)
1879 1880 1881 1882 1883
      end
    end

    shared_examples 'not sending any notification' do
      it 'does not send any email' do
1884
        should_not_email_anyone
1885 1886 1887 1888 1889 1890
      end
    end

    context 'with success pipeline' do
      before do
        perform_enqueued_jobs do
Lin Jen-Shin's avatar
Lin Jen-Shin committed
1891
          pipeline.succeed
1892 1893
        end
      end
Lin Jen-Shin's avatar
Lin Jen-Shin committed
1894 1895

      it_behaves_like 'sending a notification'
1896 1897 1898 1899 1900
    end

    context 'with failed pipeline' do
      before do
        perform_enqueued_jobs do
1901 1902
          create(:ci_build, :failed, pipeline: pipeline)
          create(:generic_commit_status, :failed, pipeline: pipeline)
1903

1904
          pipeline.drop
1905 1906
        end
      end
Lin Jen-Shin's avatar
Lin Jen-Shin committed
1907 1908

      it_behaves_like 'sending a notification'
1909 1910 1911 1912 1913 1914 1915 1916
    end

    context 'with skipped pipeline' do
      before do
        perform_enqueued_jobs do
          pipeline.skip
        end
      end
Lin Jen-Shin's avatar
Lin Jen-Shin committed
1917 1918

      it_behaves_like 'not sending any notification'
1919 1920 1921 1922 1923 1924 1925 1926
    end

    context 'with cancelled pipeline' do
      before do
        perform_enqueued_jobs do
          pipeline.cancel
        end
      end
Lin Jen-Shin's avatar
Lin Jen-Shin committed
1927 1928

      it_behaves_like 'not sending any notification'
1929 1930
    end
  end
1931 1932 1933 1934 1935 1936 1937 1938

  describe '#latest_builds_with_artifacts' do
    let!(:pipeline) { create(:ci_pipeline, :success) }

    let!(:build) do
      create(:ci_build, :success, :artifacts, pipeline: pipeline)
    end

1939 1940 1941 1942
    it 'returns an Array' do
      expect(pipeline.latest_builds_with_artifacts).to be_an_instance_of(Array)
    end

1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954
    it 'returns the latest builds' do
      expect(pipeline.latest_builds_with_artifacts).to eq([build])
    end

    it 'memoizes the returned relation' do
      query_count = ActiveRecord::QueryRecorder
        .new { 2.times { pipeline.latest_builds_with_artifacts.to_a } }
        .count

      expect(query_count).to eq(1)
    end
  end
1955

1956 1957 1958 1959 1960
  describe '#has_test_reports?' do
    subject { pipeline.has_test_reports? }

    context 'when pipeline has builds with test reports' do
      before do
1961
        create(:ci_build, :test_reports, pipeline: pipeline, project: project)
1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975 1976 1977
      end

      context 'when pipeline status is running' do
        let(:pipeline) { create(:ci_pipeline, :running, project: project) }

        it { is_expected.to be_falsey }
      end

      context 'when pipeline status is success' do
        let(:pipeline) { create(:ci_pipeline, :success, project: project) }

        it { is_expected.to be_truthy }
      end
    end

    context 'when pipeline does not have builds with test reports' do
1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991 1992 1993
      before do
        create(:ci_build, :artifacts, pipeline: pipeline, project: project)
      end

      let(:pipeline) { create(:ci_pipeline, :success, project: project) }

      it { is_expected.to be_falsey }
    end

    context 'when retried build has test reports' do
      before do
        create(:ci_build, :retried, :test_reports, pipeline: pipeline, project: project)
      end

      let(:pipeline) { create(:ci_pipeline, :success, project: project) }

1994 1995 1996 1997 1998 1999 2000 2001
      it { is_expected.to be_falsey }
    end
  end

  describe '#test_reports' do
    subject { pipeline.test_reports }

    context 'when pipeline has multiple builds with test reports' do
2002 2003
      let!(:build_rspec) { create(:ci_build, :success, name: 'rspec', pipeline: pipeline, project: project) }
      let!(:build_java) { create(:ci_build, :success, name: 'java', pipeline: pipeline, project: project) }
2004

2005 2006 2007
      before do
        create(:ci_job_artifact, :junit, job: build_rspec, project: project)
        create(:ci_job_artifact, :junit_with_ant, job: build_java, project: project)
2008 2009 2010 2011 2012 2013 2014
      end

      it 'returns test reports with collected data' do
        expect(subject.total_count).to be(7)
        expect(subject.success_count).to be(5)
        expect(subject.failed_count).to be(2)
      end
2015 2016 2017 2018 2019 2020 2021 2022 2023 2024 2025

      context 'when builds are retried' do
        let!(:build_rspec) { create(:ci_build, :retried, :success, name: 'rspec', pipeline: pipeline, project: project) }
        let!(:build_java) { create(:ci_build, :retried, :success, name: 'java', pipeline: pipeline, project: project) }

        it 'does not take retried builds into account' do
          expect(subject.total_count).to be(0)
          expect(subject.success_count).to be(0)
          expect(subject.failed_count).to be(0)
        end
      end
2026 2027 2028 2029 2030 2031 2032 2033 2034
    end

    context 'when pipeline does not have any builds with test reports' do
      it 'returns empty test reports' do
        expect(subject.total_count).to be(0)
      end
    end
  end

2035 2036 2037 2038 2039 2040 2041 2042 2043 2044 2045
  describe '#total_size' do
    let!(:build_job1) { create(:ci_build, pipeline: pipeline, stage_idx: 0) }
    let!(:build_job2) { create(:ci_build, pipeline: pipeline, stage_idx: 0) }
    let!(:test_job_failed_and_retried) { create(:ci_build, :failed, :retried, pipeline: pipeline, stage_idx: 1) }
    let!(:second_test_job) { create(:ci_build, pipeline: pipeline, stage_idx: 1) }
    let!(:deploy_job) { create(:ci_build, pipeline: pipeline, stage_idx: 2) }

    it 'returns all jobs (including failed and retried)' do
      expect(pipeline.total_size).to eq(5)
    end
  end
2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069

  describe '#status' do
    context 'when transitioning to failed' do
      context 'when pipeline has autodevops as source' do
        let(:pipeline) { create(:ci_pipeline, :running, :auto_devops_source) }

        it 'calls autodevops disable service' do
          expect(AutoDevops::DisableWorker).to receive(:perform_async).with(pipeline.id)

          pipeline.drop
        end
      end

      context 'when pipeline has other source' do
        let(:pipeline) { create(:ci_pipeline, :running, :repository_source) }

        it 'does not call auto devops disable service' do
          expect(AutoDevops::DisableWorker).not_to receive(:perform_async)

          pipeline.drop
        end
      end
    end
  end
2070 2071 2072 2073 2074 2075 2076 2077 2078 2079 2080 2081 2082 2083 2084 2085 2086 2087 2088 2089 2090 2091 2092 2093 2094 2095 2096 2097 2098 2099

  describe '#default_branch?' do
    let(:default_branch) { 'master'}

    subject { pipeline.default_branch? }

    before do
      allow(project).to receive(:default_branch).and_return(default_branch)
    end

    context 'when pipeline ref is the default branch of the project' do
      let(:pipeline) do
        build(:ci_empty_pipeline, status: :created, project: project, ref: default_branch)
      end

      it "returns true" do
        expect(subject).to be_truthy
      end
    end

    context 'when pipeline ref is not the default branch of the project' do
      let(:pipeline) do
        build(:ci_empty_pipeline, status: :created, project: project, ref: 'another_branch')
      end

      it "returns false" do
        expect(subject).to be_falsey
      end
    end
  end
2100
end