build_spec.rb 57 KB
Newer Older
1 2
require 'spec_helper'

3
describe Ci::Build do
4
  set(:user) { create(:user) }
5 6
  set(:group) { create(:group, :access_requestable) }
  set(:project) { create(:project, :repository, group: group) }
7

8
  set(:pipeline) do
9 10 11 12 13 14
    create(:ci_pipeline, project: project,
                         sha: project.commit.id,
                         ref: project.default_branch,
                         status: 'success')
  end

15 16
  let(:build) { create(:ci_build, pipeline: pipeline) }

17 18 19
  it { is_expected.to belong_to(:runner) }
  it { is_expected.to belong_to(:trigger_request) }
  it { is_expected.to belong_to(:erased_by) }
20
  it { is_expected.to have_many(:deployments) }
21
  it { is_expected.to have_many(:trace_sections)}
22 23 24
  it { is_expected.to validate_presence_of(:ref) }
  it { is_expected.to respond_to(:has_trace?) }
  it { is_expected.to respond_to(:trace) }
25

26 27
  it { is_expected.to be_a(ArtifactMigratable) }

28 29 30 31 32 33 34
  describe 'associations' do
    it 'has a bidirectional relationship with projects' do
      expect(described_class.reflect_on_association(:project).has_inverse?).to eq(:builds)
      expect(Project.reflect_on_association(:builds).has_inverse?).to eq(:project)
    end
  end

35 36 37 38 39 40 41 42 43 44
  describe 'callbacks' do
    context 'when running after_create callback' do
      it 'triggers asynchronous build hooks worker' do
        expect(BuildHooksWorker).to receive(:perform_async)

        create(:ci_build)
      end
    end
  end

45 46 47 48 49 50 51 52 53 54 55 56
  describe '.manual_actions' do
    let!(:manual_but_created) { create(:ci_build, :manual, status: :created, pipeline: pipeline) }
    let!(:manual_but_succeeded) { create(:ci_build, :manual, status: :success, pipeline: pipeline) }
    let!(:manual_action) { create(:ci_build, :manual, pipeline: pipeline) }

    subject { described_class.manual_actions }

    it { is_expected.to include(manual_action) }
    it { is_expected.to include(manual_but_succeeded) }
    it { is_expected.not_to include(manual_but_created) }
  end

57 58
  describe '.ref_protected' do
    subject { described_class.ref_protected }
Shinya Maeda's avatar
Shinya Maeda committed
59

60 61 62 63 64 65 66
    context 'when protected is true' do
      let!(:job) { create(:ci_build, :protected) }

      it { is_expected.to include(job) }
    end

    context 'when protected is false' do
Shinya Maeda's avatar
Shinya Maeda committed
67
      let!(:job) { create(:ci_build) }
68 69 70 71

      it { is_expected.not_to include(job) }
    end

Shinya Maeda's avatar
Shinya Maeda committed
72
    context 'when protected is nil' do
73 74 75 76 77
      let!(:job) { create(:ci_build) }

      before do
        job.update_attribute(:protected, nil)
      end
78 79 80

      it { is_expected.not_to include(job) }
    end
Shinya Maeda's avatar
Shinya Maeda committed
81 82
  end

83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106
  describe '#actionize' do
    context 'when build is a created' do
      before do
        build.update_column(:status, :created)
      end

      it 'makes build a manual action' do
        expect(build.actionize).to be true
        expect(build.reload).to be_manual
      end
    end

    context 'when build is not created' do
      before do
        build.update_column(:status, :pending)
      end

      it 'does not change build status' do
        expect(build.actionize).to be false
        expect(build.reload).to be_pending
      end
    end
  end

107 108 109 110 111 112 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
  describe '#any_runners_online?' do
    subject { build.any_runners_online? }

    context 'when no runners' do
      it { is_expected.to be_falsey }
    end

    context 'when there are runners' do
      let(:runner) { create(:ci_runner) }

      before do
        build.project.runners << runner
        runner.update_attributes(contacted_at: 1.second.ago)
      end

      it { is_expected.to be_truthy }

      it 'that is inactive' do
        runner.update_attributes(active: false)
        is_expected.to be_falsey
      end

      it 'that is not online' do
        runner.update_attributes(contacted_at: nil)
        is_expected.to be_falsey
      end

      it 'that cannot handle build' do
        expect_any_instance_of(Ci::Runner).to receive(:can_pick?).and_return(false)
        is_expected.to be_falsey
      end
    end
  end

  describe '#artifacts?' do
142
    subject { build.artifacts? }
143

144
    context 'when new artifacts are used' do
145 146
      context 'artifacts archive does not exist' do
        let(:build) { create(:ci_build) }
147

148 149 150 151
        it { is_expected.to be_falsy }
      end

      context 'artifacts archive exists' do
152 153
        let(:build) { create(:ci_build, :artifacts) }

154 155 156
        it { is_expected.to be_truthy }

        context 'is expired' do
157
          let(:build) { create(:ci_build, :artifacts, :expired) }
158 159 160 161

          it { is_expected.to be_falsy }
        end
      end
162 163
    end

164 165 166
    context 'when legacy artifacts are used' do
      context 'artifacts archive does not exist' do
        let(:build) { create(:ci_build) }
167

168 169 170
        it { is_expected.to be_falsy }
      end

171
      context 'artifacts archive exists' do
172 173
        let(:build) { create(:ci_build, :legacy_artifacts) }

174
        it { is_expected.to be_truthy }
175 176

        context 'is expired' do
177
          let(:build) { create(:ci_build, :legacy_artifacts, :expired) }
178 179 180

          it { is_expected.to be_falsy }
        end
181 182 183 184 185 186 187 188
      end
    end
  end

  describe '#artifacts_expired?' do
    subject { build.artifacts_expired? }

    context 'is expired' do
189 190 191
      before do
        build.update(artifacts_expire_at: Time.now - 7.days)
      end
192 193 194 195 196

      it { is_expected.to be_truthy }
    end

    context 'is not expired' do
197 198 199
      before do
        build.update(artifacts_expire_at: Time.now + 7.days)
      end
200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223

      it { is_expected.to be_falsey }
    end
  end

  describe '#artifacts_metadata?' do
    subject { build.artifacts_metadata? }
    context 'artifacts metadata does not exist' do
      it { is_expected.to be_falsy }
    end

    context 'artifacts archive is a zip file and metadata exists' do
      let(:build) { create(:ci_build, :artifacts) }
      it { is_expected.to be_truthy }
    end
  end

  describe '#artifacts_expire_in' do
    subject { build.artifacts_expire_in }
    it { is_expected.to be_nil }

    context 'when artifacts_expire_at is specified' do
      let(:expire_at) { Time.now + 7.days }

224 225 226
      before do
        build.artifacts_expire_at = expire_at
      end
227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245

      it { is_expected.to be_within(5).of(expire_at - Time.now) }
    end
  end

  describe '#artifacts_expire_in=' do
    subject { build.artifacts_expire_in }

    it 'when assigning valid duration' do
      build.artifacts_expire_in = '7 days'

      is_expected.to be_within(10).of(7.days.to_i)
    end

    it 'when assigning invalid duration' do
      expect { build.artifacts_expire_in = '7 elephants' }.to raise_error(ChronicDuration::DurationParseError)
      is_expected.to be_nil
    end

246
    it 'when resetting value' do
247 248
      build.artifacts_expire_in = nil

249 250 251 252 253 254
      is_expected.to be_nil
    end

    it 'when setting to 0' do
      build.artifacts_expire_in = '0'

255 256 257 258 259 260 261 262 263 264
      is_expected.to be_nil
    end
  end

  describe '#commit' do
    it 'returns commit pipeline has been created for' do
      expect(build.commit).to eq project.commit
    end
  end

265 266 267 268 269 270 271 272 273 274
  describe '#cache' do
    let(:options) { { cache: { key: "key", paths: ["public"], policy: "pull-push" } } }

    subject { build.cache }

    context 'when build has cache' do
      before do
        allow(build).to receive(:options).and_return(options)
      end

275
      context 'when project has jobs_cache_index' do
276
        before do
277
          allow_any_instance_of(Project).to receive(:jobs_cache_index).and_return(1)
278 279
        end

280
        it { is_expected.to be_an(Array).and all(include(key: "key_1")) }
281 282
      end

283
      context 'when project does not have jobs_cache_index' do
284
        before do
285
          allow_any_instance_of(Project).to receive(:jobs_cache_index).and_return(nil)
286 287 288 289 290 291 292 293 294 295 296 297 298 299 300
        end

        it { is_expected.to eq([options[:cache]]) }
      end
    end

    context 'when build does not have cache' do
      before do
        allow(build).to receive(:options).and_return({})
      end

      it { is_expected.to eq([nil]) }
    end
  end

301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319
  describe '#depends_on_builds' do
    let!(:build) { create(:ci_build, pipeline: pipeline, name: 'build', stage_idx: 0, stage: 'build') }
    let!(:rspec_test) { create(:ci_build, pipeline: pipeline, name: 'rspec', stage_idx: 1, stage: 'test') }
    let!(:rubocop_test) { create(:ci_build, pipeline: pipeline, name: 'rubocop', stage_idx: 1, stage: 'test') }
    let!(:staging) { create(:ci_build, pipeline: pipeline, name: 'staging', stage_idx: 2, stage: 'deploy') }

    it 'expects to have no dependents if this is first build' do
      expect(build.depends_on_builds).to be_empty
    end

    it 'expects to have one dependent if this is test' do
      expect(rspec_test.depends_on_builds.map(&:id)).to contain_exactly(build.id)
    end

    it 'expects to have all builds from build and test stage if this is last' do
      expect(staging.depends_on_builds.map(&:id)).to contain_exactly(build.id, rspec_test.id, rubocop_test.id)
    end

    it 'expects to have retried builds instead the original ones' do
320
      project.add_developer(user)
321

322
      retried_rspec = described_class.retry(rspec_test, user)
323 324 325

      expect(staging.depends_on_builds.map(&:id))
        .to contain_exactly(build.id, retried_rspec.id, rubocop_test.id)
326 327 328
    end
  end

329 330
  describe '#triggered_by?' do
    subject { build.triggered_by?(user) }
331 332 333 334 335 336 337 338 339 340 341 342 343 344 345

    context 'when user is owner' do
      let(:build) { create(:ci_build, pipeline: pipeline, user: user) }

      it { is_expected.to be_truthy }
    end

    context 'when user is not owner' do
      let(:another_user) { create(:user) }
      let(:build) { create(:ci_build, pipeline: pipeline, user: another_user) }

      it { is_expected.to be_falsy }
    end
  end

346 347 348 349 350 351 352
  describe '#detailed_status' do
    it 'returns a detailed status' do
      expect(build.detailed_status(user))
        .to be_a Gitlab::Ci::Status::Build::Cancelable
    end
  end

353
  describe '#coverage_regex' do
354 355
    subject { build.coverage_regex }

356
    context 'when project has build_coverage_regex set' do
357 358
      let(:project_regex) { '\(\d+\.\d+\) covered' }

359
      before do
Grzegorz Bizon's avatar
Grzegorz Bizon committed
360
        project.update_column(:build_coverage_regex, project_regex)
361
      end
362 363

      context 'and coverage_regex attribute is not set' do
364
        it { is_expected.to eq(project_regex) }
365 366 367
      end

      context 'but coverage_regex attribute is also set' do
368
        let(:build_regex) { 'Code coverage: \d+\.\d+' }
369

370 371 372 373
        before do
          build.coverage_regex = build_regex
        end

374
        it { is_expected.to eq(build_regex) }
375 376 377 378 379 380 381 382 383
      end
    end

    context 'when neither project nor build has coverage regex set' do
      it { is_expected.to be_nil }
    end
  end

  describe '#update_coverage' do
384
    context "regarding coverage_regex's value," do
385
      before do
386
        build.coverage_regex = '\(\d+.\d+\%\) covered'
387 388 389 390 391 392 393 394 395 396
        build.trace.set('Coverage 1033 / 1051 LOC (98.29%) covered')
      end

      it "saves the correct extracted coverage value" do
        expect(build.update_coverage).to be(true)
        expect(build.coverage).to eq(98.29)
      end
    end
  end

397
  describe '#parse_trace_sections!' do
398 399 400 401 402
    it 'calls ExtractSectionsFromBuildTraceService' do
      expect(Ci::ExtractSectionsFromBuildTraceService)
          .to receive(:new).with(project, build.user).once.and_call_original
      expect_any_instance_of(Ci::ExtractSectionsFromBuildTraceService)
        .to receive(:execute).with(build).once
403

404
      build.parse_trace_sections!
405 406 407
    end
  end

408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 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 456 457 458 459 460 461 462 463 464
  describe '#trace' do
    subject { build.trace }

    it { is_expected.to be_a(Gitlab::Ci::Trace) }
  end

  describe '#has_trace?' do
    subject { build.has_trace? }

    it "expect to call exist? method" do
      expect_any_instance_of(Gitlab::Ci::Trace).to receive(:exist?)
        .and_return(true)

      is_expected.to be(true)
    end
  end

  describe '#trace=' do
    it "expect to fail trace=" do
      expect { build.trace = "new" }.to raise_error(NotImplementedError)
    end
  end

  describe '#old_trace' do
    subject { build.old_trace }

    before do
      build.update_column(:trace, 'old trace')
    end

    it "expect to receive data from database" do
      is_expected.to eq('old trace')
    end
  end

  describe '#erase_old_trace!' do
    subject { build.send(:read_attribute, :trace) }

    before do
      build.send(:write_attribute, :trace, 'old trace')
    end

    it "expect to receive data from database" do
      build.erase_old_trace!

      is_expected.to be_nil
    end
  end

  describe '#hide_secrets' do
    let(:subject) { build.hide_secrets(data) }

    context 'hide runners token' do
      let(:data) { 'new token data'}

      before do
        build.project.update(runners_token: 'token')
465
      end
466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484

      it { is_expected.to eq('new xxxxx data') }
    end

    context 'hide build token' do
      let(:data) { 'new token data'}

      before do
        build.update(token: 'token')
      end

      it { is_expected.to eq('new xxxxx data') }
    end

    context 'hide build token' do
      let(:data) { 'new token data'}

      before do
        build.update(token: 'token')
485
      end
486 487

      it { is_expected.to eq('new xxxxx data') }
488 489 490
    end
  end

491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554
  describe 'deployment' do
    describe '#last_deployment' do
      subject { build.last_deployment }

      context 'when multiple deployments are created' do
        let!(:deployment1) { create(:deployment, deployable: build) }
        let!(:deployment2) { create(:deployment, deployable: build) }

        it 'returns the latest one' do
          is_expected.to eq(deployment2)
        end
      end
    end

    describe '#outdated_deployment?' do
      subject { build.outdated_deployment? }

      context 'when build succeeded' do
        let(:build) { create(:ci_build, :success) }
        let!(:deployment) { create(:deployment, deployable: build) }

        context 'current deployment is latest' do
          it { is_expected.to be_falsey }
        end

        context 'current deployment is not latest on environment' do
          let!(:deployment2) { create(:deployment, environment: deployment.environment) }

          it { is_expected.to be_truthy }
        end
      end

      context 'when build failed' do
        let(:build) { create(:ci_build, :failed) }

        it { is_expected.to be_falsey }
      end
    end
  end

  describe 'environment' do
    describe '#has_environment?' do
      subject { build.has_environment? }

      context 'when environment is defined' do
        before do
          build.update(environment: 'review')
        end

        it { is_expected.to be_truthy }
      end

      context 'when environment is not defined' do
        before do
          build.update(environment: nil)
        end

        it { is_expected.to be_falsey }
      end
    end

    describe '#expanded_environment_name' do
      subject { build.expanded_environment_name }

555
      context 'when environment uses $CI_COMMIT_REF_NAME' do
556 557 558
        let(:build) do
          create(:ci_build,
                 ref: 'master',
559
                 environment: 'review/$CI_COMMIT_REF_NAME')
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 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647
        end

        it { is_expected.to eq('review/master') }
      end

      context 'when environment uses yaml_variables containing symbol keys' do
        let(:build) do
          create(:ci_build,
                 yaml_variables: [{ key: :APP_HOST, value: 'host' }],
                 environment: 'review/$APP_HOST')
        end

        it { is_expected.to eq('review/host') }
      end
    end

    describe '#starts_environment?' do
      subject { build.starts_environment? }

      context 'when environment is defined' do
        before do
          build.update(environment: 'review')
        end

        context 'no action is defined' do
          it { is_expected.to be_truthy }
        end

        context 'and start action is defined' do
          before do
            build.update(options: { environment: { action: 'start' } } )
          end

          it { is_expected.to be_truthy }
        end
      end

      context 'when environment is not defined' do
        before do
          build.update(environment: nil)
        end

        it { is_expected.to be_falsey }
      end
    end

    describe '#stops_environment?' do
      subject { build.stops_environment? }

      context 'when environment is defined' do
        before do
          build.update(environment: 'review')
        end

        context 'no action is defined' do
          it { is_expected.to be_falsey }
        end

        context 'and stop action is defined' do
          before do
            build.update(options: { environment: { action: 'stop' } } )
          end

          it { is_expected.to be_truthy }
        end
      end

      context 'when environment is not defined' do
        before do
          build.update(environment: nil)
        end

        it { is_expected.to be_falsey }
      end
    end
  end

  describe 'erasable build' do
    shared_examples 'erasable' do
      it 'removes artifact file' do
        expect(build.artifacts_file.exists?).to be_falsy
      end

      it 'removes artifact metadata file' do
        expect(build.artifacts_metadata.exists?).to be_falsy
      end

      it 'erases build trace in trace file' do
648
        expect(build).not_to have_trace
649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670
      end

      it 'sets erased to true' do
        expect(build.erased?).to be true
      end

      it 'sets erase date' do
        expect(build.erased_at).not_to be_falsy
      end
    end

    context 'build is not erasable' do
      let!(:build) { create(:ci_build) }

      describe '#erase' do
        subject { build.erase }

        it { is_expected.to be false }
      end

      describe '#erasable?' do
        subject { build.erasable? }
671

672 673 674 675 676
        it { is_expected.to eq false }
      end
    end

    context 'build is erasable' do
677
      context 'new artifacts' do
678
        let!(:build) { create(:ci_build, :trace_artifact, :success, :artifacts) }
679

680 681 682 683
        describe '#erase' do
          before do
            build.erase(erased_by: user)
          end
684

685 686
          context 'erased by user' do
            let!(:user) { create(:user, username: 'eraser') }
687

688
            include_examples 'erasable'
689

690 691 692
            it 'records user who erased a build' do
              expect(build.erased_by).to eq user
            end
693 694
          end

695 696
          context 'erased by system' do
            let(:user) { nil }
697

698
            include_examples 'erasable'
699

700 701 702
            it 'does not set user who erased a build' do
              expect(build.erased_by).to be_nil
            end
703 704 705
          end
        end

706 707 708 709
        describe '#erasable?' do
          subject { build.erasable? }
          it { is_expected.to be_truthy }
        end
710

711
        describe '#erased?' do
712
          let!(:build) { create(:ci_build, :trace_artifact, :success, :artifacts) }
713
          subject { build.erased? }
714

715 716 717 718 719 720 721 722 723 724 725
          context 'job has not been erased' do
            it { is_expected.to be_falsey }
          end

          context 'job has been erased' do
            before do
              build.erase
            end

            it { is_expected.to be_truthy }
          end
726 727
        end

728 729 730
        context 'metadata and build trace are not available' do
          let!(:build) { create(:ci_build, :success, :artifacts) }

731
          before do
732
            build.remove_artifacts_metadata!
733 734
          end

735 736 737 738 739
          describe '#erase' do
            it 'does not raise error' do
              expect { build.erase }.not_to raise_error
            end
          end
740 741
        end
      end
742
    end
743

744 745 746
    context 'old artifacts' do
      context 'build is erasable' do
        context 'new artifacts' do
747
          let!(:build) { create(:ci_build, :trace_artifact, :success, :legacy_artifacts) }
748

749 750 751 752
          describe '#erase' do
            before do
              build.erase(erased_by: user)
            end
753

754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780
            context 'erased by user' do
              let!(:user) { create(:user, username: 'eraser') }

              include_examples 'erasable'

              it 'records user who erased a build' do
                expect(build.erased_by).to eq user
              end
            end

            context 'erased by system' do
              let(:user) { nil }

              include_examples 'erasable'

              it 'does not set user who erased a build' do
                expect(build.erased_by).to be_nil
              end
            end
          end

          describe '#erasable?' do
            subject { build.erasable? }
            it { is_expected.to be_truthy }
          end

          describe '#erased?' do
781
            let!(:build) { create(:ci_build, :trace_artifact, :success, :legacy_artifacts) }
782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808
            subject { build.erased? }

            context 'job has not been erased' do
              it { is_expected.to be_falsey }
            end

            context 'job has been erased' do
              before do
                build.erase
              end

              it { is_expected.to be_truthy }
            end
          end

          context 'metadata and build trace are not available' do
            let!(:build) { create(:ci_build, :success, :legacy_artifacts) }

            before do
              build.remove_artifacts_metadata!
            end

            describe '#erase' do
              it 'does not raise error' do
                expect { build.erase }.not_to raise_error
              end
            end
809 810 811 812 813 814 815 816 817
          end
        end
      end
    end
  end

  describe '#first_pending' do
    let!(:first) { create(:ci_build, pipeline: pipeline, status: 'pending', created_at: Date.yesterday) }
    let!(:second) { create(:ci_build, pipeline: pipeline, status: 'pending') }
818
    subject { described_class.first_pending }
819

820
    it { is_expected.to be_a(described_class) }
821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861
    it('returns with the first pending build') { is_expected.to eq(first) }
  end

  describe '#failed_but_allowed?' do
    subject { build.failed_but_allowed? }

    context 'when build is not allowed to fail' do
      before do
        build.allow_failure = false
      end

      context 'and build.status is success' do
        before do
          build.status = 'success'
        end

        it { is_expected.to be_falsey }
      end

      context 'and build.status is failed' do
        before do
          build.status = 'failed'
        end

        it { is_expected.to be_falsey }
      end
    end

    context 'when build is allowed to fail' do
      before do
        build.allow_failure = true
      end

      context 'and build.status is success' do
        before do
          build.status = 'success'
        end

        it { is_expected.to be_falsey }
      end

862
      context 'and build status is failed' do
863 864 865 866 867 868
        before do
          build.status = 'failed'
        end

        it { is_expected.to be_truthy }
      end
869 870 871 872 873 874 875 876

      context 'when build is a manual action' do
        before do
          build.status = 'manual'
        end

        it { is_expected.to be_falsey }
      end
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 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964
    end
  end

  describe 'flags' do
    describe '#cancelable?' do
      subject { build }

      context 'when build is cancelable' do
        context 'when build is pending' do
          it { is_expected.to be_cancelable }
        end

        context 'when build is running' do
          before do
            build.run!
          end

          it { is_expected.to be_cancelable }
        end
      end

      context 'when build is not cancelable' do
        context 'when build is successful' do
          before do
            build.success!
          end

          it { is_expected.not_to be_cancelable }
        end

        context 'when build is failed' do
          before do
            build.drop!
          end

          it { is_expected.not_to be_cancelable }
        end
      end
    end

    describe '#retryable?' do
      subject { build }

      context 'when build is retryable' do
        context 'when build is successful' do
          before do
            build.success!
          end

          it { is_expected.to be_retryable }
        end

        context 'when build is failed' do
          before do
            build.drop!
          end

          it { is_expected.to be_retryable }
        end

        context 'when build is canceled' do
          before do
            build.cancel!
          end

          it { is_expected.to be_retryable }
        end
      end

      context 'when build is not retryable' do
        context 'when build is running' do
          before do
            build.run!
          end

          it { is_expected.not_to be_retryable }
        end

        context 'when build is skipped' do
          before do
            build.skip!
          end

          it { is_expected.not_to be_retryable }
        end
      end
    end

965
    describe '#action?' do
966 967 968 969
      before do
        build.update(when: value)
      end

970
      subject { build.action? }
971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988

      context 'when is set to manual' do
        let(:value) { 'manual' }

        it { is_expected.to be_truthy }
      end

      context 'when set to something else' do
        let(:value) { 'something else' }

        it { is_expected.to be_falsey }
      end
    end
  end

  describe '#has_tags?' do
    context 'when build has tags' do
      subject { create(:ci_build, tag_list: ['tag']) }
989

990 991 992 993 994
      it { is_expected.to have_tags }
    end

    context 'when build does not have tags' do
      subject { create(:ci_build, tag_list: []) }
995

996 997 998 999
      it { is_expected.not_to have_tags }
    end
  end

1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023
  describe 'build auto retry feature' do
    describe '#retries_count' do
      subject { create(:ci_build, name: 'test', pipeline: pipeline) }

      context 'when build has been retried several times' do
        before do
          create(:ci_build, :retried, name: 'test', pipeline: pipeline)
          create(:ci_build, :retried, name: 'test', pipeline: pipeline)
        end

        it 'reports a correct retry count value' do
          expect(subject.retries_count).to eq 2
        end
      end

      context 'when build has not been retried' do
        it 'returns zero' do
          expect(subject.retries_count).to eq 0
        end
      end
    end

    describe '#retries_max' do
      context 'when max retries value is defined' do
1024
        subject { create(:ci_build, options: { retry: 1 }) }
1025 1026

        it 'returns a number of configured max retries' do
1027
          expect(subject.retries_max).to eq 1
1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040
        end
      end

      context 'when max retries value is not defined' do
        subject { create(:ci_build) }

        it 'returns zero' do
          expect(subject.retries_max).to eq 0
        end
      end
    end
  end

1041 1042 1043
  describe '#keep_artifacts!' do
    let(:build) { create(:ci_build, artifacts_expire_at: Time.now + 7.days) }

1044 1045
    subject { build.keep_artifacts! }

1046
    it 'to reset expire_at' do
1047
      subject
1048 1049 1050

      expect(build.artifacts_expire_at).to be_nil
    end
1051 1052 1053 1054 1055 1056 1057 1058 1059 1060

    context 'when having artifacts files' do
      let!(:artifact) { create(:ci_job_artifact, job: build, expire_in: '7 days') }

      it 'to reset dependent objects' do
        subject

        expect(artifact.reload.expire_at).to be_nil
      end
    end
1061 1062 1063 1064
  end

  describe '#merge_request' do
    def create_mr(build, pipeline, factory: :merge_request, created_at: Time.now)
1065
      create(factory, source_project: pipeline.project,
1066 1067 1068
                      target_project: pipeline.project,
                      source_branch: build.ref,
                      created_at: created_at)
1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089
    end

    context 'when a MR has a reference to the pipeline' do
      before do
        @merge_request = create_mr(build, pipeline, factory: :merge_request)

        commits = [double(id: pipeline.sha)]
        allow(@merge_request).to receive(:commits).and_return(commits)
        allow(MergeRequest).to receive_message_chain(:includes, :where, :reorder).and_return([@merge_request])
      end

      it 'returns the single associated MR' do
        expect(build.merge_request.id).to eq(@merge_request.id)
      end
    end

    context 'when there is not a MR referencing the pipeline' do
      it 'returns nil' do
        expect(build.merge_request).to be_nil
      end
    end
1090

1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106
    context 'when more than one MR have a reference to the pipeline' do
      before do
        @merge_request = create_mr(build, pipeline, factory: :merge_request)
        @merge_request.close!
        @merge_request2 = create_mr(build, pipeline, factory: :merge_request)

        commits = [double(id: pipeline.sha)]
        allow(@merge_request).to receive(:commits).and_return(commits)
        allow(@merge_request2).to receive(:commits).and_return(commits)
        allow(MergeRequest).to receive_message_chain(:includes, :where, :reorder).and_return([@merge_request, @merge_request2])
      end

      it 'returns the first MR' do
        expect(build.merge_request.id).to eq(@merge_request.id)
      end
    end
1107

1108 1109 1110 1111 1112 1113
    context 'when a Build is created after the MR' do
      before do
        @merge_request = create_mr(build, pipeline, factory: :merge_request_with_diffs)
        pipeline2 = create(:ci_pipeline, project: project)
        @build2 = create(:ci_build, pipeline: pipeline2)

1114
        allow(@merge_request).to receive(:commit_shas)
1115
          .and_return([pipeline.sha, pipeline2.sha])
1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145
        allow(MergeRequest).to receive_message_chain(:includes, :where, :reorder).and_return([@merge_request])
      end

      it 'returns the current MR' do
        expect(@build2.merge_request.id).to eq(@merge_request.id)
      end
    end
  end

  describe '#options' do
    let(:options) do
      {
        image: "ruby:2.1",
        services: [
          "postgres"
        ]
      }
    end

    it 'contains options' do
      expect(build.options).to eq(options)
    end
  end

  describe '#other_actions' do
    let(:build) { create(:ci_build, :manual, pipeline: pipeline) }
    let!(:other_build) { create(:ci_build, :manual, pipeline: pipeline, name: 'other action') }

    subject { build.other_actions }

1146
    before do
1147
      project.add_developer(user)
1148 1149
    end

1150 1151 1152 1153 1154
    it 'returns other actions' do
      is_expected.to contain_exactly(other_build)
    end

    context 'when build is retried' do
1155
      let!(:new_build) { described_class.retry(build, user) }
1156 1157 1158 1159 1160 1161 1162

      it 'does not return any of them' do
        is_expected.not_to include(build, new_build)
      end
    end

    context 'when other build is retried' do
1163
      let!(:retried_build) { described_class.retry(other_build, user) }
1164

1165 1166 1167 1168
      before do
        retried_build.success
      end

1169 1170 1171 1172 1173 1174 1175
      it 'returns a retried build' do
        is_expected.to contain_exactly(retried_build)
      end
    end
  end

  describe '#persisted_environment' do
1176 1177
    let!(:environment) do
      create(:environment, project: project, name: "foo-#{project.default_branch}")
1178 1179 1180 1181
    end

    subject { build.persisted_environment }

1182 1183 1184 1185
    context 'when referenced literally' do
      let(:build) do
        create(:ci_build, pipeline: pipeline, environment: "foo-#{project.default_branch}")
      end
1186

1187
      it { is_expected.to eq(environment) }
1188 1189
    end

1190
    context 'when referenced with a variable' do
1191 1192 1193
      let(:build) do
        create(:ci_build, pipeline: pipeline, environment: "foo-$CI_COMMIT_REF_NAME")
      end
1194

1195
      it { is_expected.to eq(environment) }
1196
    end
1197

Lin Jen-Shin's avatar
Lin Jen-Shin committed
1198
    context 'when there is no environment' do
1199 1200 1201 1202
      it { is_expected.to be_nil }
    end
  end

1203 1204 1205
  describe '#play' do
    let(:build) { create(:ci_build, :manual, pipeline: pipeline) }

1206
    before do
1207
      project.add_developer(user)
1208 1209
    end

1210 1211
    it 'enqueues the build' do
      expect(build.play(user)).to be_pending
1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248
    end
  end

  describe 'project settings' do
    describe '#timeout' do
      it 'returns project timeout configuration' do
        expect(build.timeout).to eq(project.build_timeout)
      end
    end

    describe '#allow_git_fetch' do
      it 'return project allow_git_fetch configuration' do
        expect(build.allow_git_fetch).to eq(project.build_allow_git_fetch)
      end
    end
  end

  describe '#project' do
    subject { build.project }

    it { is_expected.to eq(pipeline.project) }
  end

  describe '#project_id' do
    subject { build.project_id }

    it { is_expected.to eq(pipeline.project_id) }
  end

  describe '#project_name' do
    subject { build.project_name }

    it { is_expected.to eq(project.name) }
  end

  describe '#ref_slug' do
    {
Shinya Maeda's avatar
Shinya Maeda committed
1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259
      'master'                => 'master',
      '1-foo'                 => '1-foo',
      'fix/1-foo'             => 'fix-1-foo',
      'fix-1-foo'             => 'fix-1-foo',
      'a' * 63                => 'a' * 63,
      'a' * 64                => 'a' * 63,
      'FOO'                   => 'foo',
      '-' + 'a' * 61 + '-'    => 'a' * 61,
      '-' + 'a' * 62 + '-'    => 'a' * 62,
      '-' + 'a' * 63 + '-'    => 'a' * 62,
      'a' * 62 + ' '          => 'a' * 62
1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311
    }.each do |ref, slug|
      it "transforms #{ref} to #{slug}" do
        build.ref = ref

        expect(build.ref_slug).to eq(slug)
      end
    end
  end

  describe '#repo_url' do
    subject { build.repo_url }

    it { is_expected.to be_a(String) }
    it { is_expected.to end_with(".git") }
    it { is_expected.to start_with(project.web_url[0..6]) }
    it { is_expected.to include(build.token) }
    it { is_expected.to include('gitlab-ci-token') }
    it { is_expected.to include(project.web_url[7..-1]) }
  end

  describe '#stuck?' do
    subject { build.stuck? }

    context "when commit_status.status is pending" do
      before do
        build.status = 'pending'
      end

      it { is_expected.to be_truthy }

      context "and there are specific runner" do
        let(:runner) { create(:ci_runner, contacted_at: 1.second.ago) }

        before do
          build.project.runners << runner
          runner.save
        end

        it { is_expected.to be_falsey }
      end
    end

    %w[success failed canceled running].each do |state|
      context "when commit_status.status is #{state}" do
        before do
          build.status = state
        end

        it { is_expected.to be_falsey }
      end
    end
  end
1312

1313 1314
  describe '#has_expiring_artifacts?' do
    context 'when artifacts have expiration date set' do
1315 1316 1317
      before do
        build.update(artifacts_expire_at: 1.day.from_now)
      end
1318 1319 1320 1321 1322 1323 1324

      it 'has expiring artifacts' do
        expect(build).to have_expiring_artifacts
      end
    end

    context 'when artifacts do not have expiration date set' do
1325 1326 1327
      before do
        build.update(artifacts_expire_at: nil)
      end
1328 1329 1330 1331 1332

      it 'does not have expiring artifacts' do
        expect(build).not_to have_expiring_artifacts
      end
    end
1333
  end
Tomasz Maczukin's avatar
Tomasz Maczukin committed
1334

1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359
  describe '#update_project_statistics' do
    let!(:build) { create(:ci_build, artifacts_size: 23) }

    it 'updates project statistics when the artifact size changes' do
      expect(ProjectCacheWorker).to receive(:perform_async)
        .with(build.project_id, [], [:build_artifacts_size])

      build.artifacts_size = 42
      build.save!
    end

    it 'does not update project statistics when the artifact size stays the same' do
      expect(ProjectCacheWorker).not_to receive(:perform_async)

      build.name = 'changed'
      build.save!
    end

    it 'updates project statistics when the build is destroyed' do
      expect(ProjectCacheWorker).to receive(:perform_async)
        .with(build.project_id, [], [:build_artifacts_size])

      build.destroy
    end
  end
1360 1361 1362 1363 1364 1365 1366

  describe '#when' do
    subject { build.when }

    context 'when `when` is undefined' do
      before do
        build.when = nil
1367
      end
1368 1369

      context 'use from gitlab-ci.yml' do
1370 1371
        let(:pipeline) { create(:ci_pipeline) }

1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384
        before do
          stub_ci_pipeline_yaml_file(config)
        end

        context 'when config is not found' do
          let(:config) { nil }

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

        context 'when config does not have a questioned job' do
          let(:config) do
            YAML.dump({
1385 1386 1387 1388
              test_other: {
                script: 'Hello World'
              }
            })
1389 1390 1391 1392 1393 1394 1395 1396
          end

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

        context 'when config has `when`' do
          let(:config) do
            YAML.dump({
1397 1398 1399 1400 1401
              test: {
                script: 'Hello World',
                when: 'always'
              }
            })
1402 1403 1404 1405 1406 1407
          end

          it { is_expected.to eq('always') }
        end
      end
    end
1408
  end
1409 1410 1411 1412 1413 1414 1415

  describe '#variables' do
    let(:container_registry_enabled) { false }
    let(:predefined_variables) do
      [
        { key: 'CI', value: 'true', public: true },
        { key: 'GITLAB_CI', value: 'true', public: true },
1416
        { key: 'GITLAB_FEATURES', value: '', public: true },
1417 1418 1419
        { key: 'CI_SERVER_NAME', value: 'GitLab', public: true },
        { key: 'CI_SERVER_VERSION', value: Gitlab::VERSION, public: true },
        { key: 'CI_SERVER_REVISION', value: Gitlab::REVISION, public: true },
1420 1421 1422 1423
        { key: 'CI_JOB_ID', value: build.id.to_s, public: true },
        { key: 'CI_JOB_NAME', value: 'test', public: true },
        { key: 'CI_JOB_STAGE', value: 'test', public: true },
        { key: 'CI_JOB_TOKEN', value: build.token, public: false },
Z.J. van de Weg's avatar
Z.J. van de Weg committed
1424
        { key: 'CI_COMMIT_SHA', value: build.sha, public: true },
1425 1426
        { key: 'CI_COMMIT_REF_NAME', value: build.ref, public: true },
        { key: 'CI_COMMIT_REF_SLUG', value: build.ref_slug, public: true },
1427 1428
        { key: 'CI_PROJECT_ID', value: project.id.to_s, public: true },
        { key: 'CI_PROJECT_NAME', value: project.path, public: true },
1429
        { key: 'CI_PROJECT_PATH', value: project.full_path, public: true },
1430
        { key: 'CI_PROJECT_PATH_SLUG', value: project.full_path_slug, public: true },
1431
        { key: 'CI_PROJECT_NAMESPACE', value: project.namespace.full_path, public: true },
1432
        { key: 'CI_PROJECT_URL', value: project.web_url, public: true },
1433
        { key: 'CI_PROJECT_VISIBILITY', value: 'private', public: true },
1434
        { key: 'CI_PIPELINE_ID', value: pipeline.id.to_s, public: true },
1435
        { key: 'CI_CONFIG_PATH', value: pipeline.ci_yaml_file_path, public: true },
1436 1437
        { key: 'CI_REGISTRY_USER', value: 'gitlab-ci-token', public: true },
        { key: 'CI_REGISTRY_PASSWORD', value: build.token, public: false },
1438
        { key: 'CI_REPOSITORY_URL', value: build.repo_url, public: false }
1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452
      ]
    end

    before do
      stub_container_registry_config(enabled: container_registry_enabled, host_port: 'registry.example.com')
    end

    subject { build.variables }

    context 'returns variables' do
      before do
        build.yaml_variables = []
      end

1453
      it { is_expected.to include(*predefined_variables) }
1454 1455 1456 1457
    end

    context 'when build has user' do
      let(:user_variables) do
1458 1459 1460
        [
          { key: 'GITLAB_USER_ID', value: user.id.to_s, public: true },
          { key: 'GITLAB_USER_EMAIL', value: user.email, public: true },
1461
          { key: 'GITLAB_USER_LOGIN', value: user.username, public: true },
1462 1463
          { key: 'GITLAB_USER_NAME', value: user.name, public: true }
        ]
1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480
      end

      before do
        build.update_attributes(user: user)
      end

      it { user_variables.each { |v| is_expected.to include(v) } }
    end

    context 'when build has an environment' do
      let(:environment_variables) do
        [
          { key: 'CI_ENVIRONMENT_NAME', value: 'production', public: true },
          { key: 'CI_ENVIRONMENT_SLUG', value: 'prod-slug',  public: true }
        ]
      end

1481 1482
      let!(:environment) do
        create(:environment,
1483 1484 1485 1486
               project: build.project,
               name: 'production',
               slug: 'prod-slug',
               external_url: '')
1487 1488
      end

1489 1490 1491 1492
      before do
        build.update(environment: 'production')
      end

1493
      shared_examples 'containing environment variables' do
1494
        it { environment_variables.each { |v| is_expected.to include(v) } }
1495 1496 1497 1498
      end

      context 'when no URL was set' do
        it_behaves_like 'containing environment variables'
1499 1500 1501 1502 1503 1504 1505 1506 1507

        it 'does not have CI_ENVIRONMENT_URL' do
          keys = subject.map { |var| var[:key] }

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

      context 'when an URL was set' do
1508
        let(:url) { 'http://host/test' }
1509

1510
        before do
1511
          environment_variables <<
1512
            { key: 'CI_ENVIRONMENT_URL', value: url, public: true }
1513 1514
        end

1515 1516
        context 'when the URL was set from the job' do
          before do
1517
            build.update(options: { environment: { url: url } })
1518 1519 1520
          end

          it_behaves_like 'containing environment variables'
1521 1522 1523 1524 1525 1526 1527 1528 1529 1530

          context 'when variables are used in the URL, it does not expand' do
            let(:url) { 'http://$CI_PROJECT_NAME-$CI_ENVIRONMENT_SLUG' }

            it_behaves_like 'containing environment variables'

            it 'puts $CI_ENVIRONMENT_URL in the last so all other variables are available to be used when runners are trying to expand it' do
              expect(subject.last).to eq(environment_variables.last)
            end
          end
1531 1532 1533 1534 1535 1536 1537 1538 1539
        end

        context 'when the URL was not set from the job, but environment' do
          before do
            environment.update(external_url: url)
          end

          it_behaves_like 'containing environment variables'
        end
1540
      end
1541 1542 1543 1544 1545 1546 1547 1548
    end

    context 'when build started manually' do
      before do
        build.update_attributes(when: :manual)
      end

      let(:manual_variable) do
1549
        { key: 'CI_JOB_MANUAL', value: 'true', public: true }
1550 1551 1552 1553 1554 1555 1556
      end

      it { is_expected.to include(manual_variable) }
    end

    context 'when build is for tag' do
      let(:tag_variable) do
1557
        { key: 'CI_COMMIT_TAG', value: 'master', public: true }
1558 1559 1560 1561 1562 1563 1564 1565 1566
      end

      before do
        build.update_attributes(tag: true)
      end

      it { is_expected.to include(tag_variable) }
    end

1567 1568
    context 'when secret variable is defined' do
      let(:secret_variable) do
1569 1570 1571 1572
        { key: 'SECRET_KEY', value: 'secret_value', public: false }
      end

      before do
1573 1574
        create(:ci_variable,
               secret_variable.slice(:key, :value).merge(project: project))
1575 1576
      end

1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592
      it { is_expected.to include(secret_variable) }
    end

    context 'when protected variable is defined' do
      let(:protected_variable) do
        { key: 'PROTECTED_KEY', value: 'protected_value', public: false }
      end

      before do
        create(:ci_variable,
               :protected,
               protected_variable.slice(:key, :value).merge(project: project))
      end

      context 'when the branch is protected' do
        before do
1593
          allow(build.project).to receive(:protected_for?).with(build.ref).and_return(true)
1594 1595 1596 1597 1598 1599 1600
        end

        it { is_expected.to include(protected_variable) }
      end

      context 'when the tag is protected' do
        before do
1601
          allow(build.project).to receive(:protected_for?).with(build.ref).and_return(true)
1602 1603 1604 1605 1606 1607 1608 1609
        end

        it { is_expected.to include(protected_variable) }
      end

      context 'when the ref is not protected' do
        it { is_expected.not_to include(protected_variable) }
      end
1610 1611
    end

Shinya Maeda's avatar
Shinya Maeda committed
1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637
    context 'when group secret variable is defined' do
      let(:secret_variable) do
        { key: 'SECRET_KEY', value: 'secret_value', public: false }
      end

      before do
        create(:ci_group_variable,
               secret_variable.slice(:key, :value).merge(group: group))
      end

      it { is_expected.to include(secret_variable) }
    end

    context 'when group protected variable is defined' do
      let(:protected_variable) do
        { key: 'PROTECTED_KEY', value: 'protected_value', public: false }
      end

      before do
        create(:ci_group_variable,
               :protected,
               protected_variable.slice(:key, :value).merge(group: group))
      end

      context 'when the branch is protected' do
        before do
1638
          allow(build.project).to receive(:protected_for?).with(build.ref).and_return(true)
Shinya Maeda's avatar
Shinya Maeda committed
1639 1640 1641 1642 1643 1644
        end

        it { is_expected.to include(protected_variable) }
      end

      context 'when the tag is protected' do
1645
        before do
1646
          allow(build.project).to receive(:protected_for?).with(build.ref).and_return(true)
1647 1648 1649 1650 1651 1652
        end

        it { is_expected.to include(protected_variable) }
      end

      context 'when the ref is not protected' do
1653 1654 1655 1656
        before do
          build.update_column(:ref, 'some/feature')
        end

1657 1658
        it { is_expected.not_to include(protected_variable) }
      end
1659 1660 1661 1662
    end

    context 'when build is for triggers' do
      let(:trigger) { create(:ci_trigger, project: project) }
1663 1664
      let(:trigger_request) { create(:ci_trigger_request, pipeline: pipeline, trigger: trigger) }

1665
      let(:user_trigger_variable) do
1666
        { key: 'TRIGGER_KEY_1', value: 'TRIGGER_VALUE_1', public: false }
1667
      end
1668

1669
      let(:predefined_trigger_variable) do
1670
        { key: 'CI_PIPELINE_TRIGGERED', value: 'true', public: true }
1671 1672 1673 1674 1675 1676
      end

      before do
        build.trigger_request = trigger_request
      end

1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696
      shared_examples 'returns variables for triggers' do
        it { is_expected.to include(user_trigger_variable) }
        it { is_expected.to include(predefined_trigger_variable) }
      end

      context 'when variables are stored in trigger_request' do
        before do
          trigger_request.update_attribute(:variables, { 'TRIGGER_KEY_1' => 'TRIGGER_VALUE_1' } )
        end

        it_behaves_like 'returns variables for triggers'
      end

      context 'when variables are stored in pipeline_variables' do
        before do
          create(:ci_pipeline_variable, pipeline: pipeline, key: 'TRIGGER_KEY_1', value: 'TRIGGER_VALUE_1')
        end

        it_behaves_like 'returns variables for triggers'
      end
1697 1698
    end

Shinya Maeda's avatar
init  
Shinya Maeda committed
1699 1700 1701 1702 1703 1704
    context 'when pipeline has a variable' do
      let!(:pipeline_variable) { create(:ci_pipeline_variable, pipeline: pipeline) }

      it { is_expected.to include(pipeline_variable.to_runner_variable) }
    end

Shinya Maeda's avatar
Shinya Maeda committed
1705
    context 'when a job was triggered by a pipeline schedule' do
1706
      let(:pipeline_schedule) { create(:ci_pipeline_schedule, project: project) }
1707

Shinya Maeda's avatar
Shinya Maeda committed
1708
      let!(:pipeline_schedule_variable) do
1709
        create(:ci_pipeline_schedule_variable,
1710 1711
               key: 'SCHEDULE_VARIABLE_KEY',
               pipeline_schedule: pipeline_schedule)
Shinya Maeda's avatar
Shinya Maeda committed
1712
      end
1713

1714 1715
      before do
        pipeline_schedule.pipelines << pipeline
Shinya Maeda's avatar
Shinya Maeda committed
1716
        pipeline_schedule.reload
1717 1718
      end

Shinya Maeda's avatar
Shinya Maeda committed
1719
      it { is_expected.to include(pipeline_schedule_variable.to_runner_variable) }
1720 1721
    end

1722
    context 'when yaml_variables are undefined' do
1723 1724
      let(:pipeline) { create(:ci_pipeline, project: project) }

1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736
      before do
        build.yaml_variables = nil
      end

      context 'use from gitlab-ci.yml' do
        before do
          stub_ci_pipeline_yaml_file(config)
        end

        context 'when config is not found' do
          let(:config) { nil }

1737
          it { is_expected.to include(*predefined_variables) }
1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748
        end

        context 'when config does not have a questioned job' do
          let(:config) do
            YAML.dump({
              test_other: {
                script: 'Hello World'
              }
            })
          end

1749
          it { is_expected.to include(*predefined_variables) }
1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766
        end

        context 'when config has variables' do
          let(:config) do
            YAML.dump({
              test: {
                script: 'Hello World',
                variables: {
                  KEY: 'value'
                }
              }
            })
          end
          let(:variables) do
            [{ key: 'KEY', value: 'value', public: true }]
          end

1767 1768
          it { is_expected.to include(*predefined_variables) }
          it { is_expected.to include(*variables) }
1769 1770 1771 1772 1773 1774 1775 1776 1777 1778
        end
      end
    end

    context 'when container registry is enabled' do
      let(:container_registry_enabled) { true }
      let(:ci_registry) do
        { key: 'CI_REGISTRY',  value: 'registry.example.com',  public: true }
      end
      let(:ci_registry_image) do
1779
        { key: 'CI_REGISTRY_IMAGE',  value: project.container_registry_url, public: true }
1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801
      end

      context 'and is disabled for project' do
        before do
          project.update(container_registry_enabled: false)
        end

        it { is_expected.to include(ci_registry) }
        it { is_expected.not_to include(ci_registry_image) }
      end

      context 'and is enabled for project' do
        before do
          project.update(container_registry_enabled: true)
        end

        it { is_expected.to include(ci_registry) }
        it { is_expected.to include(ci_registry_image) }
      end
    end

    context 'when runner is assigned to build' do
Douwe Maan's avatar
Douwe Maan committed
1802
      let(:runner) { create(:ci_runner, description: 'description', tag_list: %w(docker linux)) }
1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817

      before do
        build.update(runner: runner)
      end

      it { is_expected.to include({ key: 'CI_RUNNER_ID', value: runner.id.to_s, public: true }) }
      it { is_expected.to include({ key: 'CI_RUNNER_DESCRIPTION', value: 'description', public: true }) }
      it { is_expected.to include({ key: 'CI_RUNNER_TAGS', value: 'docker, linux', public: true }) }
    end

    context 'when build is for a deployment' do
      let(:deployment_variable) { { key: 'KUBERNETES_TOKEN', value: 'TOKEN', public: false } }

      before do
        build.environment = 'production'
1818 1819 1820 1821

        allow_any_instance_of(Project)
          .to receive(:deployment_variables)
          .and_return([deployment_variable])
1822 1823 1824 1825 1826
      end

      it { is_expected.to include(deployment_variable) }
    end

Lin Jen-Shin's avatar
Lin Jen-Shin committed
1827 1828 1829 1830
    context 'when project has custom CI config path' do
      let(:ci_config_path) { { key: 'CI_CONFIG_PATH', value: 'custom', public: true } }

      before do
1831
        project.update(ci_config_path: 'custom')
Lin Jen-Shin's avatar
Lin Jen-Shin committed
1832 1833 1834 1835 1836
      end

      it { is_expected.to include(ci_config_path) }
    end

1837
    context 'returns variables in valid order' do
1838 1839 1840 1841 1842
      let(:build_pre_var) { { key: 'build', value: 'value' } }
      let(:project_pre_var) { { key: 'project', value: 'value' } }
      let(:pipeline_pre_var) { { key: 'pipeline', value: 'value' } }
      let(:build_yaml_var) { { key: 'yaml', value: 'value' } }

1843
      before do
1844 1845 1846
        allow(build).to receive(:predefined_variables) { [build_pre_var] }
        allow(build).to receive(:yaml_variables) { [build_yaml_var] }

1847 1848 1849 1850 1851
        allow_any_instance_of(Project)
          .to receive(:predefined_variables) { [project_pre_var] }

        allow_any_instance_of(Project)
          .to receive(:secret_variables_for)
Lin Jen-Shin's avatar
Lin Jen-Shin committed
1852
          .with(ref: 'master', environment: nil) do
1853 1854
          [create(:ci_variable, key: 'secret', value: 'value')]
        end
1855 1856 1857

        allow_any_instance_of(Ci::Pipeline)
          .to receive(:predefined_variables) { [pipeline_pre_var] }
1858 1859
      end

1860 1861 1862 1863 1864 1865 1866 1867
      it do
        is_expected.to eq(
          [build_pre_var,
           project_pre_var,
           pipeline_pre_var,
           build_yaml_var,
           { key: 'secret', value: 'value', public: false }])
      end
1868
    end
1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892

    context 'when using auto devops' do
      context 'and is enabled' do
        before do
          project.create_auto_devops!(enabled: true, domain: 'example.com')
        end

        it "includes AUTO_DEVOPS_DOMAIN" do
          is_expected.to include(
            { key: 'AUTO_DEVOPS_DOMAIN', value: 'example.com', public: true })
        end
      end

      context 'and is disabled' do
        before do
          project.create_auto_devops!(enabled: false, domain: 'example.com')
        end

        it "includes AUTO_DEVOPS_DOMAIN" do
          is_expected.not_to include(
            { key: 'AUTO_DEVOPS_DOMAIN', value: 'example.com', public: true })
        end
      end
    end
1893
  end
Kamil Trzcinski's avatar
Kamil Trzcinski committed
1894

1895
  describe 'state transition: any => [:pending]' do
Kamil Trzcinski's avatar
Kamil Trzcinski committed
1896 1897 1898 1899 1900 1901 1902 1903
    let(:build) { create(:ci_build, :created) }

    it 'queues BuildQueueWorker' do
      expect(BuildQueueWorker).to receive(:perform_async).with(build.id)

      build.enqueue
    end
  end
1904

1905
  describe 'state transition: any => [:running]' do
1906 1907
    shared_examples 'validation is active' do
      context 'when depended job has not been completed yet' do
1908
        let!(:pre_stage_job) { create(:ci_build, :manual, pipeline: pipeline, name: 'test', stage_idx: 0) }
Shinya Maeda's avatar
Shinya Maeda committed
1909

1910
        it { expect { job.run! }.not_to raise_error(Ci::Build::MissingDependenciesError) }
1911
      end
1912

1913 1914
      context 'when artifacts of depended job has been expired' do
        let!(:pre_stage_job) { create(:ci_build, :success, :expired, pipeline: pipeline, name: 'test', stage_idx: 0) }
1915

1916 1917
        it { expect { job.run! }.to raise_error(Ci::Build::MissingDependenciesError) }
      end
1918

1919 1920
      context 'when artifacts of depended job has been erased' do
        let!(:pre_stage_job) { create(:ci_build, :success, pipeline: pipeline, name: 'test', stage_idx: 0, erased_at: 1.minute.ago) }
1921

1922 1923 1924 1925 1926 1927
        before do
          pre_stage_job.erase
        end

        it { expect { job.run! }.to raise_error(Ci::Build::MissingDependenciesError) }
      end
1928 1929
    end

1930 1931
    shared_examples 'validation is not active' do
      context 'when depended job has not been completed yet' do
1932
        let!(:pre_stage_job) { create(:ci_build, :manual, pipeline: pipeline, name: 'test', stage_idx: 0) }
1933

1934 1935 1936 1937 1938 1939 1940
        it { expect { job.run! }.not_to raise_error }
      end
      context 'when artifacts of depended job has been expired' do
        let!(:pre_stage_job) { create(:ci_build, :success, :expired, pipeline: pipeline, name: 'test', stage_idx: 0) }

        it { expect { job.run! }.not_to raise_error }
      end
1941

1942 1943
      context 'when artifacts of depended job has been erased' do
        let!(:pre_stage_job) { create(:ci_build, :success, pipeline: pipeline, name: 'test', stage_idx: 0, erased_at: 1.minute.ago) }
1944

1945 1946
        before do
          pre_stage_job.erase
1947
        end
1948

1949 1950 1951
        it { expect { job.run! }.not_to raise_error }
      end
    end
Shinya Maeda's avatar
Shinya Maeda committed
1952

1953
    let!(:job) { create(:ci_build, :pending, pipeline: pipeline, stage_idx: 1, options: options) }
Shinya Maeda's avatar
Shinya Maeda committed
1954

1955 1956 1957 1958
    context 'when validates for dependencies is enabled' do
      before do
        stub_feature_flags(ci_disable_validates_dependencies: false)
      end
Shinya Maeda's avatar
Shinya Maeda committed
1959

1960
      let!(:pre_stage_job) { create(:ci_build, :success, pipeline: pipeline, name: 'test', stage_idx: 0) }
Shinya Maeda's avatar
Shinya Maeda committed
1961

1962 1963
      context 'when "dependencies" keyword is not defined' do
        let(:options) { {} }
Shinya Maeda's avatar
Shinya Maeda committed
1964

1965 1966
        it { expect { job.run! }.not_to raise_error }
      end
Shinya Maeda's avatar
Shinya Maeda committed
1967

1968 1969 1970 1971 1972 1973 1974 1975 1976 1977
      context 'when "dependencies" keyword is empty' do
        let(:options) { { dependencies: [] } }

        it { expect { job.run! }.not_to raise_error }
      end

      context 'when "dependencies" keyword is specified' do
        let(:options) { { dependencies: ['test'] } }

        it_behaves_like 'validation is active'
1978 1979
      end
    end
1980 1981 1982 1983 1984 1985 1986 1987 1988 1989

    context 'when validates for dependencies is disabled' do
      let(:options) { { dependencies: ['test'] } }

      before do
        stub_feature_flags(ci_disable_validates_dependencies: true)
      end

      it_behaves_like 'validation is not active'
    end
1990 1991
  end

1992
  describe 'state transition when build fails' do
1993 1994 1995 1996 1997 1998 1999
    let(:service) { MergeRequests::AddTodoWhenBuildFailsService.new(project, user) }

    before do
      allow(MergeRequests::AddTodoWhenBuildFailsService).to receive(:new).and_return(service)
      allow(service).to receive(:close)
    end

2000
    context 'when build is configured to be retried' do
2001
      subject { create(:ci_build, :running, options: { retry: 3 }, project: project, user: user) }
2002

2003
      it 'retries build and assigns the same user to it' do
2004
        expect(described_class).to receive(:retry)
2005 2006 2007 2008 2009 2010 2011 2012 2013
          .with(subject, user)

        subject.drop!
      end

      it 'does not try to create a todo' do
        project.add_developer(user)

        expect(service).not_to receive(:commit_status_merge_requests)
2014 2015 2016 2017 2018 2019

        subject.drop!
      end
    end

    context 'when build is not configured to be retried' do
2020
      subject { create(:ci_build, :running, project: project, user: user) }
2021 2022 2023 2024 2025 2026 2027 2028 2029 2030 2031 2032 2033 2034

      it 'does not retry build' do
        expect(described_class).not_to receive(:retry)

        subject.drop!
      end

      it 'does not count retries when not necessary' do
        expect(described_class).not_to receive(:retry)
        expect_any_instance_of(described_class)
          .not_to receive(:retries_count)

        subject.drop!
      end
2035 2036 2037 2038 2039 2040 2041 2042

      it 'creates a todo' do
        project.add_developer(user)

        expect(service).to receive(:commit_status_merge_requests)

        subject.drop!
      end
2043 2044
    end
  end
2045 2046 2047 2048 2049 2050 2051 2052 2053 2054 2055 2056 2057 2058 2059 2060 2061 2062 2063 2064 2065 2066 2067 2068 2069 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 2100 2101 2102 2103 2104 2105 2106 2107 2108 2109 2110 2111 2112 2113 2114 2115 2116 2117

  describe '.matches_tag_ids' do
    set(:build) { create(:ci_build, project: project, user: user) }
    let(:tag_ids) { ::ActsAsTaggableOn::Tag.named_any(tag_list).ids }

    subject { described_class.where(id: build).matches_tag_ids(tag_ids) }

    before do
      build.update(tag_list: build_tag_list)
    end

    context 'when have different tags' do
      let(:build_tag_list) { %w(A B) }
      let(:tag_list) { %w(C D) }

      it "does not match a build" do
        is_expected.not_to contain_exactly(build)
      end
    end

    context 'when have a subset of tags' do
      let(:build_tag_list) { %w(A B) }
      let(:tag_list) { %w(A B C D) }

      it "does match a build" do
        is_expected.to contain_exactly(build)
      end
    end

    context 'when build does not have tags' do
      let(:build_tag_list) { [] }
      let(:tag_list) { %w(C D) }

      it "does match a build" do
        is_expected.to contain_exactly(build)
      end
    end

    context 'when does not have a subset of tags' do
      let(:build_tag_list) { %w(A B C) }
      let(:tag_list) { %w(C D) }

      it "does not match a build" do
        is_expected.not_to contain_exactly(build)
      end
    end
  end

  describe '.matches_tags' do
    set(:build) { create(:ci_build, project: project, user: user) }

    subject { described_class.where(id: build).with_any_tags }

    before do
      build.update(tag_list: tag_list)
    end

    context 'when does have tags' do
      let(:tag_list) { %w(A B) }

      it "does match a build" do
        is_expected.to contain_exactly(build)
      end
    end

    context 'when does not have tags' do
      let(:tag_list) { [] }

      it "does not match a build" do
        is_expected.not_to contain_exactly(build)
      end
    end
  end
2118
end