yaml_processor_spec.rb 74.3 KB
Newer Older
1 2
# frozen_string_literal: true

3 4 5 6
require 'spec_helper'

module Gitlab
  module Ci
7
    describe YamlProcessor do
8 9
      include StubRequests

10
      subject { described_class.new(config, user: nil) }
11 12

      describe '#build_attributes' do
13
        subject { described_class.new(config, user: nil).build_attributes(:rspec) }
14

15 16 17 18
        describe 'attributes list' do
          let(:config) do
            YAML.dump(
              before_script: ['pwd'],
19 20 21 22
              rspec: {
                script: 'rspec',
                interruptible: true
              }
23 24 25 26 27 28
            )
          end

          it 'returns valid build attributes' do
            expect(subject).to eq({
              stage: "test",
29
              stage_idx: 2,
30 31 32 33 34
              name: "rspec",
              options: {
                before_script: ["pwd"],
                script: ["rspec"]
              },
35
              interruptible: true,
36 37 38 39 40 41 42
              allow_failure: false,
              when: "on_success",
              yaml_variables: []
            })
          end
        end

43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58
        context 'with job rules' do
          let(:config) do
            YAML.dump(
              rspec: {
                script: 'rspec',
                rules: [
                  { if: '$CI_COMMIT_REF_NAME == "master"' },
                  { changes: %w[README.md] }
                ]
              }
            )
          end

          it 'returns valid build attributes' do
            expect(subject).to eq({
              stage: 'test',
59
              stage_idx: 2,
60 61 62 63 64 65 66 67 68 69 70 71 72
              name: 'rspec',
              options: { script: ['rspec'] },
              rules: [
                { if: '$CI_COMMIT_REF_NAME == "master"' },
                { changes: %w[README.md] }
              ],
              allow_failure: false,
              when: 'on_success',
              yaml_variables: []
            })
          end
        end

73 74 75 76 77 78 79 80 81 82 83 84 85 86
        describe 'coverage entry' do
          describe 'code coverage regexp' do
            let(:config) do
              YAML.dump(rspec: { script: 'rspec',
                                 coverage: '/Code coverage: \d+\.\d+/' })
            end

            it 'includes coverage regexp in build attributes' do
              expect(subject)
                .to include(coverage_regex: 'Code coverage: \d+\.\d+')
            end
          end
        end

87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110
        describe 'interruptible entry' do
          describe 'interruptible job' do
            let(:config) do
              YAML.dump(rspec: { script: 'rspec', interruptible: true })
            end

            it { expect(subject[:interruptible]).to be_truthy }
          end

          describe 'interruptible job with default value' do
            let(:config) do
              YAML.dump(rspec: { script: 'rspec' })
            end

            it { expect(subject).not_to have_key(:interruptible) }
          end

          describe 'uninterruptible job' do
            let(:config) do
              YAML.dump(rspec: { script: 'rspec', interruptible: false })
            end

            it { expect(subject[:interruptible]).to be_falsy }
          end
111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129

          it "returns interruptible when overridden for job" do
            config = YAML.dump({ default: { interruptible: true },
                                 rspec: { script: "rspec" } })

            config_processor = Gitlab::Ci::YamlProcessor.new(config)

            expect(config_processor.stage_builds_attributes("test").size).to eq(1)
            expect(config_processor.stage_builds_attributes("test").first).to eq({
              stage: "test",
              stage_idx: 2,
              name: "rspec",
              options: { script: ["rspec"] },
              interruptible: true,
              allow_failure: false,
              when: "on_success",
              yaml_variables: []
            })
          end
130 131
        end

132 133 134
        describe 'retry entry' do
          context 'when retry count is specified' do
            let(:config) do
135
              YAML.dump(rspec: { script: 'rspec', retry: { max: 1 } })
136 137 138
            end

            it 'includes retry count in build options attribute' do
139
              expect(subject[:options]).to include(retry: { max: 1 })
140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202
            end
          end

          context 'when retry count is not specified' do
            let(:config) do
              YAML.dump(rspec: { script: 'rspec' })
            end

            it 'does not persist retry count in the database' do
              expect(subject[:options]).not_to have_key(:retry)
            end
          end
        end

        describe 'allow failure entry' do
          context 'when job is a manual action' do
            context 'when allow_failure is defined' do
              let(:config) do
                YAML.dump(rspec: { script: 'rspec',
                                   when: 'manual',
                                   allow_failure: false })
              end

              it 'is not allowed to fail' do
                expect(subject[:allow_failure]).to be false
              end
            end

            context 'when allow_failure is not defined' do
              let(:config) do
                YAML.dump(rspec: { script: 'rspec',
                                   when: 'manual' })
              end

              it 'is allowed to fail' do
                expect(subject[:allow_failure]).to be true
              end
            end
          end

          context 'when job is not a manual action' do
            context 'when allow_failure is defined' do
              let(:config) do
                YAML.dump(rspec: { script: 'rspec',
                                   allow_failure: false })
              end

              it 'is not allowed to fail' do
                expect(subject[:allow_failure]).to be false
              end
            end

            context 'when allow_failure is not defined' do
              let(:config) do
                YAML.dump(rspec: { script: 'rspec' })
              end

              it 'is not allowed to fail' do
                expect(subject[:allow_failure]).to be false
              end
            end
          end
        end
Shinya Maeda's avatar
Shinya Maeda committed
203 204 205 206

        describe 'delayed job entry' do
          context 'when delayed is defined' do
            let(:config) do
207 208 209 210 211
              YAML.dump(rspec: {
                script:   'rollout 10%',
                when:     'delayed',
                start_in: '1 day'
              })
Shinya Maeda's avatar
Shinya Maeda committed
212 213 214 215 216 217 218 219
            end

            it 'has the attributes' do
              expect(subject[:when]).to eq 'delayed'
              expect(subject[:options][:start_in]).to eq '1 day'
            end
          end
        end
220 221
      end

222 223 224 225 226 227
      describe '#stages_attributes' do
        let(:config) do
          YAML.dump(
            rspec: { script: 'rspec', stage: 'test', only: ['branches'] },
            prod: { script: 'cap prod', stage: 'deploy', only: ['tags'] }
          )
228 229
        end

230
        let(:attributes) do
231
          [{ name: ".pre",
232 233
             index: 0,
             builds: [] },
234
           { name: "build",
235
             index: 1,
236 237 238
             builds: [] },
           { name: "test",
             index: 2,
239
             builds:
240
               [{ stage_idx: 2,
241 242 243 244 245 246 247 248 249
                  stage: "test",
                  name: "rspec",
                  allow_failure: false,
                  when: "on_success",
                  yaml_variables: [],
                  options: { script: ["rspec"] },
                  only: { refs: ["branches"] },
                  except: {} }] },
           { name: "deploy",
250
             index: 3,
251
             builds:
252
               [{ stage_idx: 3,
253 254 255 256 257 258 259
                  stage: "deploy",
                  name: "prod",
                  allow_failure: false,
                  when: "on_success",
                  yaml_variables: [],
                  options: { script: ["cap prod"] },
                  only: { refs: ["tags"] },
260 261 262 263
                  except: {} }] },
           { name: ".post",
             index: 4,
             builds: [] }]
264 265 266 267
        end

        it 'returns stages seed attributes' do
          expect(subject.stages_attributes).to eq attributes
268 269 270
        end
      end

271 272 273 274
      describe 'only / except policies validations' do
        context 'when `only` has an invalid value' do
          let(:config) { { rspec: { script: "rspec", type: "test", only: only } } }
          let(:processor) { Gitlab::Ci::YamlProcessor.new(YAML.dump(config)) }
275

276 277
          context 'when it is integer' do
            let(:only) { 1 }
278

279 280 281
            it do
              expect { processor }.to raise_error(Gitlab::Ci::YamlProcessor::ValidationError,
                                                  'jobs:rspec:only has to be either an array of conditions or a hash')
282 283 284
            end
          end

285 286
          context 'when it is an array of integers' do
            let(:only) { [1, 1] }
287

288 289 290
            it do
              expect { processor }.to raise_error(Gitlab::Ci::YamlProcessor::ValidationError,
                                                  'jobs:rspec:only config should be an array of strings or regexps')
291 292 293
            end
          end

294 295
          context 'when it is invalid regex' do
            let(:only) { ["/*invalid/"] }
296

297 298 299
            it do
              expect { processor }.to raise_error(Gitlab::Ci::YamlProcessor::ValidationError,
                                                  'jobs:rspec:only config should be an array of strings or regexps')
300 301 302 303
            end
          end
        end

304 305 306
        context 'when `except` has an invalid value' do
          let(:config) { { rspec: { script: "rspec", except: except } } }
          let(:processor) { Gitlab::Ci::YamlProcessor.new(YAML.dump(config)) }
307

308 309
          context 'when it is integer' do
            let(:except) { 1 }
310

311 312 313
            it do
              expect { processor }.to raise_error(Gitlab::Ci::YamlProcessor::ValidationError,
                                                  'jobs:rspec:except has to be either an array of conditions or a hash')
314 315 316
            end
          end

317 318
          context 'when it is an array of integers' do
            let(:except) { [1, 1] }
319

320 321 322
            it do
              expect { processor }.to raise_error(Gitlab::Ci::YamlProcessor::ValidationError,
                                                  'jobs:rspec:except config should be an array of strings or regexps')
323 324 325
            end
          end

326 327
          context 'when it is invalid regex' do
            let(:except) { ["/*invalid/"] }
328

329 330 331
            it do
              expect { processor }.to raise_error(Gitlab::Ci::YamlProcessor::ValidationError,
                                                  'jobs:rspec:except config should be an array of strings or regexps')
332 333 334 335 336 337 338
            end
          end
        end
      end

      describe "Scripts handling" do
        let(:config_data) { YAML.dump(config) }
339
        let(:config_processor) { Gitlab::Ci::YamlProcessor.new(config_data) }
340

341
        subject { config_processor.stage_builds_attributes('test').first }
342 343 344 345 346 347 348 349 350 351

        describe "before_script" do
          context "in global context" do
            let(:config) do
              {
                before_script: ["global script"],
                test: { script: ["script"] }
              }
            end

352
            it "return commands with scripts concatenated" do
353
              expect(subject[:options][:before_script]).to eq(["global script"])
354 355 356
            end
          end

357 358 359 360 361 362 363 364
          context "in default context" do
            let(:config) do
              {
                default: { before_script: ["global script"] },
                test: { script: ["script"] }
              }
            end

365
            it "return commands with scripts concatenated" do
366 367 368 369
              expect(subject[:options][:before_script]).to eq(["global script"])
            end
          end

370 371 372 373 374 375 376 377
          context "overwritten in local context" do
            let(:config) do
              {
                before_script: ["global script"],
                test: { before_script: ["local script"], script: ["script"] }
              }
            end

378
            it "return commands with scripts concatenated" do
379
              expect(subject[:options][:before_script]).to eq(["local script"])
380 381
            end
          end
382 383 384 385 386 387 388 389 390 391 392 393 394

          context 'when script is array of arrays of strings' do
            let(:config) do
              {
                before_script: [["global script", "echo 1"], ["ls"], "pwd"],
                test: { script: ["script"] }
              }
            end

            it "return commands with scripts concatenated" do
              expect(subject[:options][:before_script]).to eq(["global script", "echo 1", "ls", "pwd"])
            end
          end
395 396 397
        end

        describe "script" do
398 399 400 401 402 403 404 405 406 407
          context 'when script is array of strings' do
            let(:config) do
              {
                test: { script: ["script"] }
              }
            end

            it "return commands with scripts concatenated" do
              expect(subject[:options][:script]).to eq(["script"])
            end
408 409
          end

410 411 412 413 414 415 416 417 418 419
          context 'when script is array of arrays of strings' do
            let(:config) do
              {
                test: { script: [["script"], ["echo 1"], "ls"] }
              }
            end

            it "return commands with scripts concatenated" do
              expect(subject[:options][:script]).to eq(["script", "echo 1", "ls"])
            end
420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436
          end
        end

        describe "after_script" do
          context "in global context" do
            let(:config) do
              {
                after_script: ["after_script"],
                test: { script: ["script"] }
              }
            end

            it "return after_script in options" do
              expect(subject[:options][:after_script]).to eq(["after_script"])
            end
          end

437 438 439 440 441 442 443 444 445 446 447 448 449
          context "in default context" do
            let(:config) do
              {
                after_script: ["after_script"],
                test: { script: ["script"] }
              }
            end

            it "return after_script in options" do
              expect(subject[:options][:after_script]).to eq(["after_script"])
            end
          end

450 451 452 453 454 455 456 457 458 459 460 461
          context "overwritten in local context" do
            let(:config) do
              {
                after_script: ["local after_script"],
                test: { after_script: ["local after_script"], script: ["script"] }
              }
            end

            it "return after_script in options" do
              expect(subject[:options][:after_script]).to eq(["local after_script"])
            end
          end
462 463 464 465 466 467 468 469 470 471 472 473 474

          context 'when script is array of arrays of strings' do
            let(:config) do
              {
                after_script: [["global script", "echo 1"], ["ls"], "pwd"],
                test: { script: ["script"] }
              }
            end

            it "return after_script in options" do
              expect(subject[:options][:after_script]).to eq(["global script", "echo 1", "ls", "pwd"])
            end
          end
475 476 477 478 479 480 481 482 483 484 485 486 487
        end
      end

      describe "Image and service handling" do
        context "when extended docker configuration is used" do
          it "returns image and service when defined" do
            config = YAML.dump({ image: { name: "ruby:2.1", entrypoint: ["/usr/local/bin/init", "run"] },
                                 services: ["mysql", { name: "docker:dind", alias: "docker",
                                                       entrypoint: ["/usr/local/bin/init", "run"],
                                                       command: ["/usr/local/bin/init", "run"] }],
                                 before_script: ["pwd"],
                                 rspec: { script: "rspec" } })

488
            config_processor = Gitlab::Ci::YamlProcessor.new(config)
489

490 491
            expect(config_processor.stage_builds_attributes("test").size).to eq(1)
            expect(config_processor.stage_builds_attributes("test").first).to eq({
492
              stage: "test",
493
              stage_idx: 2,
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
              name: "rspec",
              options: {
                before_script: ["pwd"],
                script: ["rspec"],
                image: { name: "ruby:2.1", entrypoint: ["/usr/local/bin/init", "run"] },
                services: [{ name: "mysql" },
                           { name: "docker:dind", alias: "docker", entrypoint: ["/usr/local/bin/init", "run"],
                             command: ["/usr/local/bin/init", "run"] }]
              },
              allow_failure: false,
              when: "on_success",
              yaml_variables: []
            })
          end

          it "returns image and service when overridden for job" do
            config = YAML.dump({ image: "ruby:2.1",
                                 services: ["mysql"],
                                 before_script: ["pwd"],
                                 rspec: { image: { name: "ruby:2.5", entrypoint: ["/usr/local/bin/init", "run"] },
                                          services: [{ name: "postgresql", alias: "db-pg",
                                                       entrypoint: ["/usr/local/bin/init", "run"],
                                                       command: ["/usr/local/bin/init", "run"] }, "docker:dind"],
                                          script: "rspec" } })

519
            config_processor = Gitlab::Ci::YamlProcessor.new(config)
520

521 522
            expect(config_processor.stage_builds_attributes("test").size).to eq(1)
            expect(config_processor.stage_builds_attributes("test").first).to eq({
523
              stage: "test",
524
              stage_idx: 2,
525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547
              name: "rspec",
              options: {
                before_script: ["pwd"],
                script: ["rspec"],
                image: { name: "ruby:2.5", entrypoint: ["/usr/local/bin/init", "run"] },
                services: [{ name: "postgresql", alias: "db-pg", entrypoint: ["/usr/local/bin/init", "run"],
                             command: ["/usr/local/bin/init", "run"] },
                           { name: "docker:dind" }]
              },
              allow_failure: false,
              when: "on_success",
              yaml_variables: []
            })
          end
        end

        context "when etended docker configuration is not used" do
          it "returns image and service when defined" do
            config = YAML.dump({ image: "ruby:2.1",
                                 services: ["mysql", "docker:dind"],
                                 before_script: ["pwd"],
                                 rspec: { script: "rspec" } })

548
            config_processor = Gitlab::Ci::YamlProcessor.new(config)
549

550 551
            expect(config_processor.stage_builds_attributes("test").size).to eq(1)
            expect(config_processor.stage_builds_attributes("test").first).to eq({
552
              stage: "test",
553
              stage_idx: 2,
554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572
              name: "rspec",
              options: {
                before_script: ["pwd"],
                script: ["rspec"],
                image: { name: "ruby:2.1" },
                services: [{ name: "mysql" }, { name: "docker:dind" }]
              },
              allow_failure: false,
              when: "on_success",
              yaml_variables: []
            })
          end

          it "returns image and service when overridden for job" do
            config = YAML.dump({ image: "ruby:2.1",
                                 services: ["mysql"],
                                 before_script: ["pwd"],
                                 rspec: { image: "ruby:2.5", services: ["postgresql", "docker:dind"], script: "rspec" } })

573
            config_processor = Gitlab::Ci::YamlProcessor.new(config)
574

575 576
            expect(config_processor.stage_builds_attributes("test").size).to eq(1)
            expect(config_processor.stage_builds_attributes("test").first).to eq({
577
              stage: "test",
578
              stage_idx: 2,
579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594
              name: "rspec",
              options: {
                before_script: ["pwd"],
                script: ["rspec"],
                image: { name: "ruby:2.5" },
                services: [{ name: "postgresql" }, { name: "docker:dind" }]
              },
              allow_failure: false,
              when: "on_success",
              yaml_variables: []
            })
          end
        end
      end

      describe 'Variables' do
595
        let(:config_processor) { Gitlab::Ci::YamlProcessor.new(YAML.dump(config)) }
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 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708

        subject { config_processor.builds.first[:yaml_variables] }

        context 'when global variables are defined' do
          let(:variables) do
            { 'VAR1' => 'value1', 'VAR2' => 'value2' }
          end
          let(:config) do
            {
              variables: variables,
              before_script: ['pwd'],
              rspec: { script: 'rspec' }
            }
          end

          it 'returns global variables' do
            expect(subject).to contain_exactly(
              { key: 'VAR1', value: 'value1', public: true },
              { key: 'VAR2', value: 'value2', public: true }
            )
          end
        end

        context 'when job and global variables are defined' do
          let(:global_variables) do
            { 'VAR1' => 'global1', 'VAR3' => 'global3' }
          end
          let(:job_variables) do
            { 'VAR1' => 'value1', 'VAR2' => 'value2' }
          end
          let(:config) do
            {
              before_script: ['pwd'],
              variables: global_variables,
              rspec: { script: 'rspec', variables: job_variables }
            }
          end

          it 'returns all unique variables' do
            expect(subject).to contain_exactly(
              { key: 'VAR3', value: 'global3', public: true },
              { key: 'VAR1', value: 'value1', public: true },
              { key: 'VAR2', value: 'value2', public: true }
            )
          end
        end

        context 'when job variables are defined' do
          let(:config) do
            {
              before_script: ['pwd'],
              rspec: { script: 'rspec', variables: variables }
            }
          end

          context 'when syntax is correct' do
            let(:variables) do
              { 'VAR1' => 'value1', 'VAR2' => 'value2' }
            end

            it 'returns job variables' do
              expect(subject).to contain_exactly(
                { key: 'VAR1', value: 'value1', public: true },
                { key: 'VAR2', value: 'value2', public: true }
              )
            end
          end

          context 'when syntax is incorrect' do
            context 'when variables defined but invalid' do
              let(:variables) do
                %w(VAR1 value1 VAR2 value2)
              end

              it 'raises error' do
                expect { subject }
                  .to raise_error(Gitlab::Ci::YamlProcessor::ValidationError,
                                   /jobs:rspec:variables config should be a hash of key value pairs/)
              end
            end

            context 'when variables key defined but value not specified' do
              let(:variables) do
                nil
              end

              it 'returns empty array' do
                ##
                # When variables config is empty, we assume this is a valid
                # configuration, see issue #18775
                #
                expect(subject).to be_an_instance_of(Array)
                expect(subject).to be_empty
              end
            end
          end
        end

        context 'when job variables are not defined' do
          let(:config) do
            {
              before_script: ['pwd'],
              rspec: { script: 'rspec' }
            }
          end

          it 'returns empty array' do
            expect(subject).to be_an_instance_of(Array)
            expect(subject).to be_empty
          end
        end
      end

709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727
      context 'when using `extends`' do
        let(:config_processor) { Gitlab::Ci::YamlProcessor.new(config) }

        subject { config_processor.builds.first }

        context 'when using simple `extends`' do
          let(:config) do
            <<~YAML
              .template:
                script: test

              rspec:
                extends: .template
                image: ruby:alpine
            YAML
          end

          it 'correctly extends rspec job' do
            expect(config_processor.builds).to be_one
728
            expect(subject.dig(:options, :script)).to eq %w(test)
729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753
            expect(subject.dig(:options, :image, :name)).to eq 'ruby:alpine'
          end
        end

        context 'when using recursive `extends`' do
          let(:config) do
            <<~YAML
              rspec:
                extends: .test
                script: rspec
                when: always

              .template:
                before_script:
                  - bundle install

              .test:
                extends: .template
                script: test
                image: image:test
            YAML
          end

          it 'correctly extends rspec job' do
            expect(config_processor.builds).to be_one
754 755
            expect(subject.dig(:options, :before_script)).to eq ["bundle install"]
            expect(subject.dig(:options, :script)).to eq %w(rspec)
756 757 758 759 760 761
            expect(subject.dig(:options, :image, :name)).to eq 'image:test'
            expect(subject.dig(:when)).to eq 'always'
          end
        end
      end

Paul B's avatar
Paul B committed
762
      describe "Include" do
763 764 765 766 767 768 769 770 771 772 773 774
        let(:opts) { {} }

        let(:config) do
          {
            include: include_content,
            rspec: { script: "test" }
          }
        end

        subject { Gitlab::Ci::YamlProcessor.new(YAML.dump(config), opts) }

        context "when validating a ci config file with no project context" do
Kamil Trzciński's avatar
Kamil Trzciński committed
775
          context "when a single string is provided" do
776 777
            let(:include_content) { "/local.gitlab-ci.yml" }

Kamil Trzciński's avatar
Kamil Trzciński committed
778 779
            it "returns a validation error" do
              expect { subject }.to raise_error /does not have project/
780 781 782
            end
          end

783 784 785
          context "when an array is provided" do
            let(:include_content) { ["/local.gitlab-ci.yml"] }

786 787
            it "returns a validation error" do
              expect { subject }.to raise_error(Gitlab::Ci::YamlProcessor::ValidationError, /does not have project/)
788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806
            end
          end

          context "when an array of wrong keyed object is provided" do
            let(:include_content) { [{ yolo: "/local.gitlab-ci.yml" }] }

            it "returns a validation error" do
              expect { subject }.to raise_error(Gitlab::Ci::YamlProcessor::ValidationError)
            end
          end

          context "when an array of mixed typed objects is provided" do
            let(:include_content) do
              [
                'https://gitlab.com/awesome-project/raw/master/.before-script-template.yml',
                { template: 'Auto-DevOps.gitlab-ci.yml' }
              ]
            end

807
            before do
808
              stub_full_request('https://gitlab.com/awesome-project/raw/master/.before-script-template.yml')
809 810 811 812 813 814
                .to_return(
                  status: 200,
                  headers: { 'Content-Type' => 'application/json' },
                  body: 'prepare: { script: ls -al }')
            end

815 816 817 818 819 820 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
            it "does not return any error" do
              expect { subject }.not_to raise_error
            end
          end

          context "when the include type is incorrect" do
            let(:include_content) { { name: "/local.gitlab-ci.yml" } }

            it "returns an invalid configuration error" do
              expect { subject }.to raise_error(Gitlab::Ci::YamlProcessor::ValidationError)
            end
          end
        end

        context "when validating a ci config file within a project" do
          let(:include_content) { "/local.gitlab-ci.yml" }
          let(:project) { create(:project, :repository) }
          let(:opts) { { project: project, sha: project.commit.sha } }

          context "when the included internal file is present" do
            before do
              expect(project.repository).to receive(:blob_data_at)
                .and_return(YAML.dump({ job1: { script: 'hello' } }))
            end

            it "does not return an error" do
              expect { subject }.not_to raise_error
            end
          end

          context "when the included internal file is not present" do
            it "returns an error with missing file details" do
              expect { subject }.to raise_error(
                Gitlab::Ci::YamlProcessor::ValidationError,
                "Local file `#{include_content}` does not exist!"
              )
            end
          end
Paul B's avatar
Paul B committed
853 854 855
        end
      end

856 857 858
      describe 'when:' do
        (Gitlab::Ci::Config::Entry::Job::ALLOWED_WHEN - %w[delayed]).each do |when_state|
          it "#{when_state} creates one build and sets when:" do
859
            config = YAML.dump({
860 861
              rspec: { script: 'rspec', when: when_state }
            })
862

863
            config_processor = Gitlab::Ci::YamlProcessor.new(config)
864
            builds = config_processor.stage_builds_attributes("test")
865 866 867 868 869

            expect(builds.size).to eq(1)
            expect(builds.first[:when]).to eq(when_state)
          end
        end
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

        context 'delayed' do
          context 'with start_in' do
            it 'creates one build and sets when:' do
              config = YAML.dump({
                rspec: { script: 'rspec', when: 'delayed', start_in: '1 hour' }
              })

              config_processor = Gitlab::Ci::YamlProcessor.new(config)
              builds = config_processor.stage_builds_attributes("test")

              expect(builds.size).to eq(1)
              expect(builds.first[:when]).to eq('delayed')
              expect(builds.first[:options][:start_in]).to eq('1 hour')
            end
          end

          context 'without start_in' do
            it 'raises an error' do
              config = YAML.dump({
                rspec: { script: 'rspec', when: 'delayed' }
              })

              expect do
                Gitlab::Ci::YamlProcessor.new(config)
              end.to raise_error(YamlProcessor::ValidationError, /start in should be a duration/)
            end
          end
        end
899 900
      end

Matija Čupić's avatar
Matija Čupić committed
901 902 903 904 905 906 907 908 909
      describe 'Parallel' do
        context 'when job is parallelized' do
          let(:parallel) { 5 }

          let(:config) do
            YAML.dump(rspec: { script: 'rspec',
                               parallel: parallel })
          end

910
          it 'returns parallelized jobs' do
Matija Čupić's avatar
Matija Čupić committed
911
            config_processor = Gitlab::Ci::YamlProcessor.new(config)
912
            builds = config_processor.stage_builds_attributes('test')
913
            build_options = builds.map { |build| build[:options] }
Matija Čupić's avatar
Matija Čupić committed
914

915
            expect(builds.size).to eq(5)
916 917 918 919 920 921 922 923
            expect(build_options).to all(include(:instance, parallel: parallel))
          end

          it 'does not have the original job' do
            config_processor = Gitlab::Ci::YamlProcessor.new(config)
            builds = config_processor.stage_builds_attributes('test')

            expect(builds).not_to include(:rspec)
Matija Čupić's avatar
Matija Čupić committed
924 925 926 927
          end
        end
      end

928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951
      describe 'cache' do
        context 'when cache definition has unknown keys' do
          it 'raises relevant validation error' do
            config = YAML.dump(
              { cache: { untracked: true, invalid: 'key' },
                rspec: { script: 'rspec' } })

            expect { Gitlab::Ci::YamlProcessor.new(config) }.to raise_error(
              Gitlab::Ci::YamlProcessor::ValidationError,
              'cache config contains unknown keys: invalid'
            )
          end
        end

        it "returns cache when defined globally" do
          config = YAML.dump({
                               cache: { paths: ["logs/", "binaries/"], untracked: true, key: 'key' },
                               rspec: {
                                 script: "rspec"
                               }
                             })

          config_processor = Gitlab::Ci::YamlProcessor.new(config)

952
          expect(config_processor.stage_builds_attributes("test").size).to eq(1)
953
          expect(config_processor.stage_builds_attributes("test").first[:cache]).to eq(
954 955 956 957 958 959 960
            paths: ["logs/", "binaries/"],
            untracked: true,
            key: 'key',
            policy: 'pull-push'
          )
        end

961 962 963 964
        it "returns cache when defined in default context" do
          config = YAML.dump(
            {
              default: {
965
                cache: { paths: ["logs/", "binaries/"], untracked: true, key: { files: ['file'] } }
966 967 968 969 970 971 972 973 974
              },
              rspec: {
                script: "rspec"
              }
            })

          config_processor = Gitlab::Ci::YamlProcessor.new(config)

          expect(config_processor.stage_builds_attributes("test").size).to eq(1)
975
          expect(config_processor.stage_builds_attributes("test").first[:cache]).to eq(
976 977
            paths: ["logs/", "binaries/"],
            untracked: true,
978
            key: { files: ['file'] },
979 980 981 982
            policy: 'pull-push'
          )
        end

983
        it 'returns cache key when defined in a job' do
984 985
          config = YAML.dump({
                               rspec: {
986 987
                                 cache: { paths: ['logs/', 'binaries/'], untracked: true, key: 'key' },
                                 script: 'rspec'
988 989 990 991 992
                               }
                             })

          config_processor = Gitlab::Ci::YamlProcessor.new(config)

993 994 995
          expect(config_processor.stage_builds_attributes('test').size).to eq(1)
          expect(config_processor.stage_builds_attributes('test').first[:cache]).to eq(
            paths: ['logs/', 'binaries/'],
996 997 998 999 1000 1001
            untracked: true,
            key: 'key',
            policy: 'pull-push'
          )
        end

1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047
        it 'returns cache files' do
          config = YAML.dump(
            rspec: {
              cache: {
                paths: ['logs/', 'binaries/'],
                untracked: true,
                key: { files: ['file'] }
              },
              script: 'rspec'
            }
          )

          config_processor = Gitlab::Ci::YamlProcessor.new(config)

          expect(config_processor.stage_builds_attributes('test').size).to eq(1)
          expect(config_processor.stage_builds_attributes('test').first[:cache]).to eq(
            paths: ['logs/', 'binaries/'],
            untracked: true,
            key: { files: ['file'] },
            policy: 'pull-push'
          )
        end

        it 'returns cache files with prefix' do
          config = YAML.dump(
            rspec: {
              cache: {
                paths: ['logs/', 'binaries/'],
                untracked: true,
                key: { files: ['file'], prefix: 'prefix' }
              },
              script: 'rspec'
            }
          )

          config_processor = Gitlab::Ci::YamlProcessor.new(config)

          expect(config_processor.stage_builds_attributes('test').size).to eq(1)
          expect(config_processor.stage_builds_attributes('test').first[:cache]).to eq(
            paths: ['logs/', 'binaries/'],
            untracked: true,
            key: { files: ['file'], prefix: 'prefix' },
            policy: 'pull-push'
          )
        end

1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058
        it "overwrite cache when defined for a job and globally" do
          config = YAML.dump({
                               cache: { paths: ["logs/", "binaries/"], untracked: true, key: 'global' },
                               rspec: {
                                 script: "rspec",
                                 cache: { paths: ["test/"], untracked: false, key: 'local' }
                               }
                             })

          config_processor = Gitlab::Ci::YamlProcessor.new(config)

1059
          expect(config_processor.stage_builds_attributes("test").size).to eq(1)
1060
          expect(config_processor.stage_builds_attributes("test").first[:cache]).to eq(
1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077
            paths: ["test/"],
            untracked: false,
            key: 'local',
            policy: 'pull-push'
          )
        end
      end

      describe "Artifacts" do
        it "returns artifacts when defined" do
          config = YAML.dump({
                               image:         "ruby:2.1",
                               services:      ["mysql"],
                               before_script: ["pwd"],
                               rspec:         {
                                 artifacts: {
                                   paths: ["logs/", "binaries/"],
1078
                                   expose_as: "Exposed artifacts",
1079 1080 1081 1082 1083 1084 1085 1086 1087 1088
                                   untracked: true,
                                   name: "custom_name",
                                   expire_in: "7d"
                                 },
                                 script: "rspec"
                               }
                             })

          config_processor = Gitlab::Ci::YamlProcessor.new(config)

1089 1090
          expect(config_processor.stage_builds_attributes("test").size).to eq(1)
          expect(config_processor.stage_builds_attributes("test").first).to eq({
1091
            stage: "test",
1092
            stage_idx: 2,
1093 1094 1095 1096 1097 1098 1099 1100 1101
            name: "rspec",
            options: {
              before_script: ["pwd"],
              script: ["rspec"],
              image: { name: "ruby:2.1" },
              services: [{ name: "mysql" }],
              artifacts: {
                name: "custom_name",
                paths: ["logs/", "binaries/"],
1102
                expose_as: "Exposed artifacts",
1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121
                untracked: true,
                expire_in: "7d"
              }
            },
            when: "on_success",
            allow_failure: false,
            yaml_variables: []
          })
        end

        %w[on_success on_failure always].each do |when_state|
          it "returns artifacts for when #{when_state}  defined" do
            config = YAML.dump({
                                 rspec: {
                                   script: "rspec",
                                   artifacts: { paths: ["logs/", "binaries/"], when: when_state }
                                 }
                               })

1122
            config_processor = Gitlab::Ci::YamlProcessor.new(config)
1123
            builds = config_processor.stage_builds_attributes("test")
1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138

            expect(builds.size).to eq(1)
            expect(builds.first[:options][:artifacts][:when]).to eq(when_state)
          end
        end
      end

      describe '#environment' do
        let(:config) do
          {
            deploy_to_production: { stage: 'deploy', script: 'test', environment: environment }
          }
        end

        let(:processor) { Gitlab::Ci::YamlProcessor.new(YAML.dump(config)) }
1139
        let(:builds) { processor.stage_builds_attributes('deploy') }
1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 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 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216

        context 'when a production environment is specified' do
          let(:environment) { 'production' }

          it 'does return production' do
            expect(builds.size).to eq(1)
            expect(builds.first[:environment]).to eq(environment)
            expect(builds.first[:options]).to include(environment: { name: environment, action: "start" })
          end
        end

        context 'when hash is specified' do
          let(:environment) do
            { name: 'production',
              url: 'http://production.gitlab.com' }
          end

          it 'does return production and URL' do
            expect(builds.size).to eq(1)
            expect(builds.first[:environment]).to eq(environment[:name])
            expect(builds.first[:options]).to include(environment: environment)
          end

          context 'the url has a port as variable' do
            let(:environment) do
              { name: 'production',
                url: 'http://production.gitlab.com:$PORT' }
            end

            it 'allows a variable for the port' do
              expect(builds.size).to eq(1)
              expect(builds.first[:environment]).to eq(environment[:name])
              expect(builds.first[:options]).to include(environment: environment)
            end
          end
        end

        context 'when no environment is specified' do
          let(:environment) { nil }

          it 'does return nil environment' do
            expect(builds.size).to eq(1)
            expect(builds.first[:environment]).to be_nil
          end
        end

        context 'is not a string' do
          let(:environment) { 1 }

          it 'raises error' do
            expect { builds }.to raise_error(
              'jobs:deploy_to_production:environment config should be a hash or a string')
          end
        end

        context 'is not a valid string' do
          let(:environment) { 'production:staging' }

          it 'raises error' do
            expect { builds }.to raise_error("jobs:deploy_to_production:environment name #{Gitlab::Regex.environment_name_regex_message}")
          end
        end

        context 'when on_stop is specified' do
          let(:review) { { stage: 'deploy', script: 'test', environment: { name: 'review', on_stop: 'close_review' } } }
          let(:config) { { review: review, close_review: close_review }.compact }

          context 'with matching job' do
            let(:close_review) { { stage: 'deploy', script: 'test', environment: { name: 'review', action: 'stop' } } }

            it 'does return a list of builds' do
              expect(builds.size).to eq(2)
              expect(builds.first[:environment]).to eq('review')
            end
          end

          context 'without matching job' do
1217
            let(:close_review) { nil }
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 1249

            it 'raises error' do
              expect { builds }.to raise_error('review job: on_stop job close_review is not defined')
            end
          end

          context 'with close job without environment' do
            let(:close_review) { { stage: 'deploy', script: 'test' } }

            it 'raises error' do
              expect { builds }.to raise_error('review job: on_stop job close_review does not have environment defined')
            end
          end

          context 'with close job for different environment' do
            let(:close_review) { { stage: 'deploy', script: 'test', environment: 'production' } }

            it 'raises error' do
              expect { builds }.to raise_error('review job: on_stop job close_review have different environment name')
            end
          end

          context 'with close job without stop action' do
            let(:close_review) { { stage: 'deploy', script: 'test', environment: { name: 'review' } } }

            it 'raises error' do
              expect { builds }.to raise_error('review job: on_stop job close_review needs to have action stop defined')
            end
          end
        end
      end

1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 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
      describe "Timeout" do
        let(:config) do
          {
            deploy_to_production: {
              stage:  'deploy',
              script: 'test'
            }
          }
        end

        let(:processor) { Gitlab::Ci::YamlProcessor.new(YAML.dump(config)) }
        let(:builds) { processor.stage_builds_attributes('deploy') }

        context 'when no timeout was provided' do
          it 'does not include job_timeout' do
            expect(builds.size).to eq(1)
            expect(builds.first[:options]).not_to include(:job_timeout)
          end
        end

        context 'when an invalid timeout was provided' do
          before do
            config[:deploy_to_production][:timeout] = 'not-a-number'
          end

          it 'raises an error for invalid number' do
            expect { builds }.to raise_error('jobs:deploy_to_production timeout should be a duration')
          end
        end

        context 'when some valid timeout was provided' do
          before do
            config[:deploy_to_production][:timeout] = '1m 3s'
          end

          it 'returns provided timeout value' do
            expect(builds.size).to eq(1)
            expect(builds.first[:options]).to include(job_timeout: 63)
          end
        end
      end

1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333
      describe "Dependencies" do
        let(:config) do
          {
            build1: { stage: 'build', script: 'test' },
            build2: { stage: 'build', script: 'test' },
            test1: { stage: 'test', script: 'test', dependencies: dependencies },
            test2: { stage: 'test', script: 'test' },
            deploy: { stage: 'test', script: 'test' }
          }
        end

        subject { Gitlab::Ci::YamlProcessor.new(YAML.dump(config)) }

        context 'no dependencies' do
          let(:dependencies) { }

          it { expect { subject }.not_to raise_error }
        end

        context 'dependencies to builds' do
          let(:dependencies) { %w(build1 build2) }

          it { expect { subject }.not_to raise_error }
        end

        context 'dependencies to builds defined as symbols' do
          let(:dependencies) { [:build1, :build2] }

          it { expect { subject }.not_to raise_error }
        end

        context 'undefined dependency' do
          let(:dependencies) { ['undefined'] }

          it { expect { subject }.to raise_error(Gitlab::Ci::YamlProcessor::ValidationError, 'test1 job: undefined dependency: undefined') }
        end

        context 'dependencies to deploy' do
          let(:dependencies) { ['deploy'] }

          it { expect { subject }.to raise_error(Gitlab::Ci::YamlProcessor::ValidationError, 'test1 job: dependency deploy is not defined in prior stages') }
        end
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

        context 'when a job depends on another job that references a not-yet defined stage' do
          let(:config) do
            {
              "stages" => [
                "version"
              ],
              "version" => {
                "stage" => "version",
                "dependencies" => ["release:components:versioning"],
                "script" => ["./versioning/versioning"]
              },
              ".release_go" => {
                "stage" => "build",
                "script" => ["cd versioning"]
              },
              "release:components:versioning" => {
                "stage" => "build",
                "script" => ["cd versioning"]
              }
            }
          end

          it { expect { subject }.to raise_error(Gitlab::Ci::YamlProcessor::ValidationError, /is not defined in prior stages/) }
        end
1359 1360
      end

1361
      describe "Job Needs" do
Kamil Trzciński's avatar
Kamil Trzciński committed
1362 1363 1364 1365 1366 1367 1368
        let(:needs) { }
        let(:dependencies) { }

        let(:config) do
          {
            build1: { stage: 'build', script: 'test' },
            build2: { stage: 'build', script: 'test' },
1369
            parallel: { stage: 'build', script: 'test', parallel: 2 },
Kamil Trzciński's avatar
Kamil Trzciński committed
1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381
            test1: { stage: 'test', script: 'test', needs: needs, dependencies: dependencies },
            test2: { stage: 'test', script: 'test' },
            deploy: { stage: 'test', script: 'test' }
          }
        end

        subject { Gitlab::Ci::YamlProcessor.new(YAML.dump(config)) }

        context 'no needs' do
          it { expect { subject }.not_to raise_error }
        end

1382
        context 'needs two builds' do
Kamil Trzciński's avatar
Kamil Trzciński committed
1383 1384 1385
          let(:needs) { %w(build1 build2) }

          it "does create jobs with valid specification" do
1386
            expect(subject.builds.size).to eq(7)
Kamil Trzciński's avatar
Kamil Trzciński committed
1387 1388
            expect(subject.builds[0]).to eq(
              stage: "build",
1389
              stage_idx: 1,
Kamil Trzciński's avatar
Kamil Trzciński committed
1390 1391 1392 1393 1394 1395 1396 1397
              name: "build1",
              options: {
                script: ["test"]
              },
              when: "on_success",
              allow_failure: false,
              yaml_variables: []
            )
1398
            expect(subject.builds[4]).to eq(
Kamil Trzciński's avatar
Kamil Trzciński committed
1399
              stage: "test",
1400
              stage_idx: 2,
Kamil Trzciński's avatar
Kamil Trzciński committed
1401
              name: "test1",
1402
              options: { script: ["test"] },
Kamil Trzciński's avatar
Kamil Trzciński committed
1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413
              needs_attributes: [
                { name: "build1" },
                { name: "build2" }
              ],
              when: "on_success",
              allow_failure: false,
              yaml_variables: []
            )
          end
        end

1414 1415
        context 'needs parallel job' do
          let(:needs) { %w(parallel) }
1416

1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432
          it "does create jobs with valid specification" do
            expect(subject.builds.size).to eq(7)
            expect(subject.builds[4]).to eq(
              stage: "test",
              stage_idx: 2,
              name: "test1",
              options: { script: ["test"] },
              needs_attributes: [
                { name: "parallel 1/2" },
                { name: "parallel 2/2" }
              ],
              when: "on_success",
              allow_failure: false,
              yaml_variables: []
            )
          end
1433 1434
        end

Kamil Trzciński's avatar
Kamil Trzciński committed
1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454
        context 'undefined need' do
          let(:needs) { ['undefined'] }

          it { expect { subject }.to raise_error(Gitlab::Ci::YamlProcessor::ValidationError, 'test1 job: undefined need: undefined') }
        end

        context 'needs to deploy' do
          let(:needs) { ['deploy'] }

          it { expect { subject }.to raise_error(Gitlab::Ci::YamlProcessor::ValidationError, 'test1 job: need deploy is not defined in prior stages') }
        end

        context 'needs and dependencies that are mismatching' do
          let(:needs) { %w(build1) }
          let(:dependencies) { %w(build2) }

          it { expect { subject }.to raise_error(Gitlab::Ci::YamlProcessor::ValidationError, 'jobs:test1 dependencies the build2 should be part of needs') }
        end
      end

1455
      context 'with when/rules conflict' do
1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515
        subject { Gitlab::Ci::YamlProcessor.new(YAML.dump(config)) }

        let(:config) do
          {
            var_default:     { stage: 'build',  script: 'test', rules: [{ if: '$VAR == null' }] },
            var_when:        { stage: 'build',  script: 'test', rules: [{ if: '$VAR == null', when: 'always' }] },
            var_and_changes: { stage: 'build',  script: 'test', rules: [{ if: '$VAR == null', changes: %w[README], when: 'always' }] },
            changes_not_var: { stage: 'test',   script: 'test', rules: [{ if: '$VAR != null', changes: %w[README] }] },
            var_not_changes: { stage: 'test',   script: 'test', rules: [{ if: '$VAR == null', changes: %w[other/file.rb], when: 'always' }] },
            nothing:         { stage: 'test',   script: 'test', rules: [{ when: 'manual' }] },
            var_never:       { stage: 'deploy', script: 'test', rules: [{ if: '$VAR == null', when: 'never' }] },
            var_delayed:     { stage: 'deploy', script: 'test', rules: [{ if: '$VAR == null', when: 'delayed', start_in: '3 hours' }] },
            two_rules:       { stage: 'deploy', script: 'test', rules: [{ if: '$VAR == null', when: 'on_success' }, { changes: %w[README], when: 'manual' }] }
          }
        end

        it 'raises no exceptions' do
          expect { subject }.not_to raise_error
        end

        it 'returns all jobs regardless of their inclusion' do
          expect(subject.builds.count).to eq(config.keys.count)
        end

        context 'used with job-level when' do
          let(:config) do
            {
              var_default: {
                stage: 'build',
                script: 'test',
                when: 'always',
                rules: [{ if: '$VAR == null' }]
              }
            }
          end

          it 'raises a ValidationError' do
            expect { subject }.to raise_error(YamlProcessor::ValidationError, /may not be used with `rules`: when/)
          end
        end

        context 'used with job-level when:delayed' do
          let(:config) do
            {
              var_default: {
                stage: 'build',
                script: 'test',
                when: 'delayed',
                start_in: '10 minutes',
                rules: [{ if: '$VAR == null' }]
              }
            }
          end

          it 'raises a ValidationError' do
            expect { subject }.to raise_error(YamlProcessor::ValidationError, /may not be used with `rules`: when, start_in/)
          end
        end
      end

1516 1517
      describe "Hidden jobs" do
        let(:config_processor) { Gitlab::Ci::YamlProcessor.new(config) }
1518
        subject { config_processor.stage_builds_attributes("test") }
1519 1520 1521 1522 1523 1524

        shared_examples 'hidden_job_handling' do
          it "doesn't create jobs that start with dot" do
            expect(subject.size).to eq(1)
            expect(subject.first).to eq({
              stage: "test",
1525
              stage_idx: 2,
1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561
              name: "normal_job",
              options: {
                script: ["test"]
              },
              when: "on_success",
              allow_failure: false,
              yaml_variables: []
            })
          end
        end

        context 'when hidden job have a script definition' do
          let(:config) do
            YAML.dump({
                        '.hidden_job' => { image: 'ruby:2.1', script: 'test' },
                        'normal_job' => { script: 'test' }
                      })
          end

          it_behaves_like 'hidden_job_handling'
        end

        context "when hidden job doesn't have a script definition" do
          let(:config) do
            YAML.dump({
                        '.hidden_job' => { image: 'ruby:2.1' },
                        'normal_job' => { script: 'test' }
                      })
          end

          it_behaves_like 'hidden_job_handling'
        end
      end

      describe "YAML Alias/Anchor" do
        let(:config_processor) { Gitlab::Ci::YamlProcessor.new(config) }
1562
        subject { config_processor.stage_builds_attributes("build") }
1563 1564 1565 1566 1567 1568

        shared_examples 'job_templates_handling' do
          it "is correctly supported for jobs" do
            expect(subject.size).to eq(2)
            expect(subject.first).to eq({
              stage: "build",
1569
              stage_idx: 1,
1570 1571 1572 1573 1574 1575 1576 1577 1578 1579
              name: "job1",
              options: {
                script: ["execute-script-for-job"]
              },
              when: "on_success",
              allow_failure: false,
              yaml_variables: []
            })
            expect(subject.second).to eq({
              stage: "build",
1580
              stage_idx: 1,
1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593
              name: "job2",
              options: {
                script: ["execute-script-for-job"]
              },
              when: "on_success",
              allow_failure: false,
              yaml_variables: []
            })
          end
        end

        context 'when template is a job' do
          let(:config) do
1594
            <<~EOT
1595 1596 1597
            job1: &JOBTMPL
              stage: build
              script: execute-script-for-job
1598

1599
            job2: *JOBTMPL
1600
            EOT
1601 1602 1603 1604 1605 1606 1607
          end

          it_behaves_like 'job_templates_handling'
        end

        context 'when template is a hidden job' do
          let(:config) do
1608
            <<~EOT
1609 1610 1611
            .template: &JOBTMPL
              stage: build
              script: execute-script-for-job
1612

1613
            job1: *JOBTMPL
1614

1615
            job2: *JOBTMPL
1616
            EOT
1617 1618 1619 1620 1621 1622 1623
          end

          it_behaves_like 'job_templates_handling'
        end

        context 'when job adds its own keys to a template definition' do
          let(:config) do
1624
            <<~EOT
1625 1626
            .template: &JOBTMPL
              stage: build
1627

1628 1629 1630
            job1:
              <<: *JOBTMPL
              script: execute-script-for-job
1631

1632 1633 1634
            job2:
              <<: *JOBTMPL
              script: execute-script-for-job
1635
            EOT
1636 1637 1638 1639 1640 1641 1642 1643
          end

          it_behaves_like 'job_templates_handling'
        end
      end

      describe "Error handling" do
        it "fails to parse YAML" do
1644 1645 1646
          expect do
            Gitlab::Ci::YamlProcessor.new("invalid: yaml: test")
          end.to raise_error(Gitlab::Ci::YamlProcessor::ValidationError)
1647 1648 1649
        end

        it "indicates that object is invalid" do
1650 1651 1652
          expect do
            Gitlab::Ci::YamlProcessor.new("invalid_yaml")
          end.to raise_error(Gitlab::Ci::YamlProcessor::ValidationError)
1653 1654 1655 1656 1657
        end

        it "returns errors if tags parameter is invalid" do
          config = YAML.dump({ rspec: { script: "test", tags: "mysql" } })
          expect do
1658
            Gitlab::Ci::YamlProcessor.new(config)
1659 1660 1661 1662 1663 1664
          end.to raise_error(Gitlab::Ci::YamlProcessor::ValidationError, "jobs:rspec tags should be an array of strings")
        end

        it "returns errors if before_script parameter is invalid" do
          config = YAML.dump({ before_script: "bundle update", rspec: { script: "test" } })
          expect do
1665
            Gitlab::Ci::YamlProcessor.new(config)
1666
          end.to raise_error(Gitlab::Ci::YamlProcessor::ValidationError, "before_script config should be an array containing strings and arrays of strings")
1667 1668 1669 1670 1671
        end

        it "returns errors if job before_script parameter is not an array of strings" do
          config = YAML.dump({ rspec: { script: "test", before_script: [10, "test"] } })
          expect do
1672
            Gitlab::Ci::YamlProcessor.new(config)
1673 1674 1675 1676 1677 1678 1679 1680
          end.to raise_error(Gitlab::Ci::YamlProcessor::ValidationError, "jobs:rspec:before_script config should be an array containing strings and arrays of strings")
        end

        it "returns errors if job before_script parameter is multi-level nested array of strings" do
          config = YAML.dump({ rspec: { script: "test", before_script: [["ls", ["pwd"]], "test"] } })
          expect do
            Gitlab::Ci::YamlProcessor.new(config)
          end.to raise_error(Gitlab::Ci::YamlProcessor::ValidationError, "jobs:rspec:before_script config should be an array containing strings and arrays of strings")
1681 1682 1683 1684 1685
        end

        it "returns errors if after_script parameter is invalid" do
          config = YAML.dump({ after_script: "bundle update", rspec: { script: "test" } })
          expect do
1686
            Gitlab::Ci::YamlProcessor.new(config)
1687
          end.to raise_error(Gitlab::Ci::YamlProcessor::ValidationError, "after_script config should be an array containing strings and arrays of strings")
1688 1689 1690 1691 1692
        end

        it "returns errors if job after_script parameter is not an array of strings" do
          config = YAML.dump({ rspec: { script: "test", after_script: [10, "test"] } })
          expect do
1693
            Gitlab::Ci::YamlProcessor.new(config)
1694 1695 1696 1697 1698 1699 1700 1701
          end.to raise_error(Gitlab::Ci::YamlProcessor::ValidationError, "jobs:rspec:after_script config should be an array containing strings and arrays of strings")
        end

        it "returns errors if job after_script parameter is multi-level nested array of strings" do
          config = YAML.dump({ rspec: { script: "test", after_script: [["ls", ["pwd"]], "test"] } })
          expect do
            Gitlab::Ci::YamlProcessor.new(config)
          end.to raise_error(Gitlab::Ci::YamlProcessor::ValidationError, "jobs:rspec:after_script config should be an array containing strings and arrays of strings")
1702 1703 1704 1705 1706
        end

        it "returns errors if image parameter is invalid" do
          config = YAML.dump({ image: ["test"], rspec: { script: "test" } })
          expect do
1707
            Gitlab::Ci::YamlProcessor.new(config)
1708 1709 1710 1711 1712 1713
          end.to raise_error(Gitlab::Ci::YamlProcessor::ValidationError, "image config should be a hash or a string")
        end

        it "returns errors if job name is blank" do
          config = YAML.dump({ '' => { script: "test" } })
          expect do
1714
            Gitlab::Ci::YamlProcessor.new(config)
1715 1716 1717 1718 1719 1720
          end.to raise_error(Gitlab::Ci::YamlProcessor::ValidationError, "jobs:job name can't be blank")
        end

        it "returns errors if job name is non-string" do
          config = YAML.dump({ 10 => { script: "test" } })
          expect do
1721
            Gitlab::Ci::YamlProcessor.new(config)
1722 1723 1724 1725 1726 1727
          end.to raise_error(Gitlab::Ci::YamlProcessor::ValidationError, "jobs:10 name should be a symbol")
        end

        it "returns errors if job image parameter is invalid" do
          config = YAML.dump({ rspec: { script: "test", image: ["test"] } })
          expect do
1728
            Gitlab::Ci::YamlProcessor.new(config)
1729 1730 1731 1732 1733 1734
          end.to raise_error(Gitlab::Ci::YamlProcessor::ValidationError, "jobs:rspec:image config should be a hash or a string")
        end

        it "returns errors if services parameter is not an array" do
          config = YAML.dump({ services: "test", rspec: { script: "test" } })
          expect do
1735
            Gitlab::Ci::YamlProcessor.new(config)
1736 1737 1738 1739 1740 1741
          end.to raise_error(Gitlab::Ci::YamlProcessor::ValidationError, "services config should be a array")
        end

        it "returns errors if services parameter is not an array of strings" do
          config = YAML.dump({ services: [10, "test"], rspec: { script: "test" } })
          expect do
1742
            Gitlab::Ci::YamlProcessor.new(config)
1743
          end.to raise_error(Gitlab::Ci::YamlProcessor::ValidationError, "services:service config should be a hash or a string")
1744 1745 1746 1747 1748
        end

        it "returns errors if job services parameter is not an array" do
          config = YAML.dump({ rspec: { script: "test", services: "test" } })
          expect do
1749
            Gitlab::Ci::YamlProcessor.new(config)
1750 1751 1752 1753 1754 1755
          end.to raise_error(Gitlab::Ci::YamlProcessor::ValidationError, "jobs:rspec:services config should be a array")
        end

        it "returns errors if job services parameter is not an array of strings" do
          config = YAML.dump({ rspec: { script: "test", services: [10, "test"] } })
          expect do
1756
            Gitlab::Ci::YamlProcessor.new(config)
1757
          end.to raise_error(Gitlab::Ci::YamlProcessor::ValidationError, "jobs:rspec:services:service config should be a hash or a string")
1758 1759 1760 1761 1762
        end

        it "returns error if job configuration is invalid" do
          config = YAML.dump({ extra: "bundle update" })
          expect do
1763
            Gitlab::Ci::YamlProcessor.new(config)
1764
          end.to raise_error(Gitlab::Ci::YamlProcessor::ValidationError, "root config contains unknown keys: extra")
1765 1766 1767 1768 1769
        end

        it "returns errors if services configuration is not correct" do
          config = YAML.dump({ extra: { script: 'rspec', services: "test" } })
          expect do
1770
            Gitlab::Ci::YamlProcessor.new(config)
1771 1772 1773 1774 1775 1776
          end.to raise_error(Gitlab::Ci::YamlProcessor::ValidationError, "jobs:extra:services config should be a array")
        end

        it "returns errors if there are no jobs defined" do
          config = YAML.dump({ before_script: ["bundle update"] })
          expect do
1777
            Gitlab::Ci::YamlProcessor.new(config)
1778 1779 1780 1781 1782 1783
          end.to raise_error(Gitlab::Ci::YamlProcessor::ValidationError, "jobs config should contain at least one visible job")
        end

        it "returns errors if there are no visible jobs defined" do
          config = YAML.dump({ before_script: ["bundle update"], '.hidden'.to_sym => { script: 'ls' } })
          expect do
1784
            Gitlab::Ci::YamlProcessor.new(config)
1785 1786 1787 1788 1789 1790
          end.to raise_error(Gitlab::Ci::YamlProcessor::ValidationError, "jobs config should contain at least one visible job")
        end

        it "returns errors if job allow_failure parameter is not an boolean" do
          config = YAML.dump({ rspec: { script: "test", allow_failure: "string" } })
          expect do
1791
            Gitlab::Ci::YamlProcessor.new(config)
1792 1793 1794 1795 1796 1797
          end.to raise_error(Gitlab::Ci::YamlProcessor::ValidationError, "jobs:rspec allow failure should be a boolean value")
        end

        it "returns errors if job stage is not a string" do
          config = YAML.dump({ rspec: { script: "test", type: 1 } })
          expect do
1798
            Gitlab::Ci::YamlProcessor.new(config)
1799 1800 1801 1802 1803 1804
          end.to raise_error(Gitlab::Ci::YamlProcessor::ValidationError, "jobs:rspec:type config should be a string")
        end

        it "returns errors if job stage is not a pre-defined stage" do
          config = YAML.dump({ rspec: { script: "test", type: "acceptance" } })
          expect do
1805
            Gitlab::Ci::YamlProcessor.new(config)
1806
          end.to raise_error(Gitlab::Ci::YamlProcessor::ValidationError, "rspec job: stage parameter should be .pre, build, test, deploy, .post")
1807 1808 1809 1810 1811
        end

        it "returns errors if job stage is not a defined stage" do
          config = YAML.dump({ types: %w(build test), rspec: { script: "test", type: "acceptance" } })
          expect do
1812
            Gitlab::Ci::YamlProcessor.new(config)
1813
          end.to raise_error(Gitlab::Ci::YamlProcessor::ValidationError, "rspec job: stage parameter should be .pre, build, test, .post")
1814 1815 1816 1817 1818
        end

        it "returns errors if stages is not an array" do
          config = YAML.dump({ stages: "test", rspec: { script: "test" } })
          expect do
1819
            Gitlab::Ci::YamlProcessor.new(config)
1820 1821 1822 1823 1824 1825
          end.to raise_error(Gitlab::Ci::YamlProcessor::ValidationError, "stages config should be an array of strings")
        end

        it "returns errors if stages is not an array of strings" do
          config = YAML.dump({ stages: [true, "test"], rspec: { script: "test" } })
          expect do
1826
            Gitlab::Ci::YamlProcessor.new(config)
1827 1828 1829 1830 1831 1832
          end.to raise_error(Gitlab::Ci::YamlProcessor::ValidationError, "stages config should be an array of strings")
        end

        it "returns errors if variables is not a map" do
          config = YAML.dump({ variables: "test", rspec: { script: "test" } })
          expect do
1833
            Gitlab::Ci::YamlProcessor.new(config)
1834 1835 1836 1837 1838 1839
          end.to raise_error(Gitlab::Ci::YamlProcessor::ValidationError, "variables config should be a hash of key value pairs")
        end

        it "returns errors if variables is not a map of key-value strings" do
          config = YAML.dump({ variables: { test: false }, rspec: { script: "test" } })
          expect do
1840
            Gitlab::Ci::YamlProcessor.new(config)
1841 1842 1843 1844 1845 1846
          end.to raise_error(Gitlab::Ci::YamlProcessor::ValidationError, "variables config should be a hash of key value pairs")
        end

        it "returns errors if job when is not on_success, on_failure or always" do
          config = YAML.dump({ rspec: { script: "test", when: 1 } })
          expect do
1847
            Gitlab::Ci::YamlProcessor.new(config)
1848
          end.to raise_error(Gitlab::Ci::YamlProcessor::ValidationError, "jobs:rspec when should be one of: #{Gitlab::Ci::Config::Entry::Job::ALLOWED_WHEN.join(', ')}")
1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910
        end

        it "returns errors if job artifacts:name is not an a string" do
          config = YAML.dump({ types: %w(build test), rspec: { script: "test", artifacts: { name: 1 } } })
          expect do
            Gitlab::Ci::YamlProcessor.new(config)
          end.to raise_error(Gitlab::Ci::YamlProcessor::ValidationError, "jobs:rspec:artifacts name should be a string")
        end

        it "returns errors if job artifacts:when is not an a predefined value" do
          config = YAML.dump({ types: %w(build test), rspec: { script: "test", artifacts: { when: 1 } } })
          expect do
            Gitlab::Ci::YamlProcessor.new(config)
          end.to raise_error(Gitlab::Ci::YamlProcessor::ValidationError, "jobs:rspec:artifacts when should be on_success, on_failure or always")
        end

        it "returns errors if job artifacts:expire_in is not an a string" do
          config = YAML.dump({ types: %w(build test), rspec: { script: "test", artifacts: { expire_in: 1 } } })
          expect do
            Gitlab::Ci::YamlProcessor.new(config)
          end.to raise_error(Gitlab::Ci::YamlProcessor::ValidationError, "jobs:rspec:artifacts expire in should be a duration")
        end

        it "returns errors if job artifacts:expire_in is not an a valid duration" do
          config = YAML.dump({ types: %w(build test), rspec: { script: "test", artifacts: { expire_in: "7 elephants" } } })
          expect do
            Gitlab::Ci::YamlProcessor.new(config)
          end.to raise_error(Gitlab::Ci::YamlProcessor::ValidationError, "jobs:rspec:artifacts expire in should be a duration")
        end

        it "returns errors if job artifacts:untracked is not an array of strings" do
          config = YAML.dump({ types: %w(build test), rspec: { script: "test", artifacts: { untracked: "string" } } })
          expect do
            Gitlab::Ci::YamlProcessor.new(config)
          end.to raise_error(Gitlab::Ci::YamlProcessor::ValidationError, "jobs:rspec:artifacts untracked should be a boolean value")
        end

        it "returns errors if job artifacts:paths is not an array of strings" do
          config = YAML.dump({ types: %w(build test), rspec: { script: "test", artifacts: { paths: "string" } } })
          expect do
            Gitlab::Ci::YamlProcessor.new(config)
          end.to raise_error(Gitlab::Ci::YamlProcessor::ValidationError, "jobs:rspec:artifacts paths should be an array of strings")
        end

        it "returns errors if cache:untracked is not an array of strings" do
          config = YAML.dump({ cache: { untracked: "string" }, rspec: { script: "test" } })
          expect do
            Gitlab::Ci::YamlProcessor.new(config)
          end.to raise_error(Gitlab::Ci::YamlProcessor::ValidationError, "cache:untracked config should be a boolean value")
        end

        it "returns errors if cache:paths is not an array of strings" do
          config = YAML.dump({ cache: { paths: "string" }, rspec: { script: "test" } })
          expect do
            Gitlab::Ci::YamlProcessor.new(config)
          end.to raise_error(Gitlab::Ci::YamlProcessor::ValidationError, "cache:paths config should be an array of strings")
        end

        it "returns errors if cache:key is not a string" do
          config = YAML.dump({ cache: { key: 1 }, rspec: { script: "test" } })
          expect do
            Gitlab::Ci::YamlProcessor.new(config)
1911
          end.to raise_error(Gitlab::Ci::YamlProcessor::ValidationError, "cache:key should be a hash, a string or a symbol")
1912 1913 1914 1915 1916 1917
        end

        it "returns errors if job cache:key is not an a string" do
          config = YAML.dump({ types: %w(build test), rspec: { script: "test", cache: { key: 1 } } })
          expect do
            Gitlab::Ci::YamlProcessor.new(config)
1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946
          end.to raise_error(Gitlab::Ci::YamlProcessor::ValidationError, "jobs:rspec:cache:key should be a hash, a string or a symbol")
        end

        it 'returns errors if job cache:key:files is not an array of strings' do
          config = YAML.dump({ types: %w(build test), rspec: { script: "test", cache: { key: { files: [1] } } } })
          expect do
            Gitlab::Ci::YamlProcessor.new(config)
          end.to raise_error(Gitlab::Ci::YamlProcessor::ValidationError, 'jobs:rspec:cache:key:files config should be an array of strings')
        end

        it 'returns errors if job cache:key:files is an empty array' do
          config = YAML.dump({ types: %w(build test), rspec: { script: "test", cache: { key: { files: [] } } } })
          expect do
            Gitlab::Ci::YamlProcessor.new(config)
          end.to raise_error(Gitlab::Ci::YamlProcessor::ValidationError, 'jobs:rspec:cache:key:files config requires at least 1 item')
        end

        it 'returns errors if job defines only cache:key:prefix' do
          config = YAML.dump({ types: %w(build test), rspec: { script: "test", cache: { key: { prefix: 'prefix-key' } } } })
          expect do
            Gitlab::Ci::YamlProcessor.new(config)
          end.to raise_error(Gitlab::Ci::YamlProcessor::ValidationError, 'jobs:rspec:cache:key config missing required keys: files')
        end

        it 'returns errors if job cache:key:prefix is not an a string' do
          config = YAML.dump({ types: %w(build test), rspec: { script: "test", cache: { key: { prefix: 1, files: ['file'] } } } })
          expect do
            Gitlab::Ci::YamlProcessor.new(config)
          end.to raise_error(Gitlab::Ci::YamlProcessor::ValidationError, 'jobs:rspec:cache:key:prefix config should be a string or symbol')
1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968
        end

        it "returns errors if job cache:untracked is not an array of strings" do
          config = YAML.dump({ types: %w(build test), rspec: { script: "test", cache: { untracked: "string" } } })
          expect do
            Gitlab::Ci::YamlProcessor.new(config)
          end.to raise_error(Gitlab::Ci::YamlProcessor::ValidationError, "jobs:rspec:cache:untracked config should be a boolean value")
        end

        it "returns errors if job cache:paths is not an array of strings" do
          config = YAML.dump({ types: %w(build test), rspec: { script: "test", cache: { paths: "string" } } })
          expect do
            Gitlab::Ci::YamlProcessor.new(config)
          end.to raise_error(Gitlab::Ci::YamlProcessor::ValidationError, "jobs:rspec:cache:paths config should be an array of strings")
        end

        it "returns errors if job dependencies is not an array of strings" do
          config = YAML.dump({ types: %w(build test), rspec: { script: "test", dependencies: "string" } })
          expect do
            Gitlab::Ci::YamlProcessor.new(config)
          end.to raise_error(Gitlab::Ci::YamlProcessor::ValidationError, "jobs:rspec dependencies should be an array of strings")
        end
1969

1970
        it 'returns errors if pipeline variables expression policy is invalid' do
1971 1972 1973 1974
          config = YAML.dump({ rspec: { script: 'test', only: { variables: ['== null'] } } })

          expect { Gitlab::Ci::YamlProcessor.new(config) }
            .to raise_error(Gitlab::Ci::YamlProcessor::ValidationError,
1975
                            'jobs:rspec:only variables invalid expression syntax')
1976
        end
1977

1978 1979 1980 1981 1982 1983 1984 1985
        it 'returns errors if pipeline changes policy is invalid' do
          config = YAML.dump({ rspec: { script: 'test', only: { changes: [1] } } })

          expect { Gitlab::Ci::YamlProcessor.new(config) }
            .to raise_error(Gitlab::Ci::YamlProcessor::ValidationError,
                            'jobs:rspec:only changes should be an array of strings')
        end

1986 1987 1988 1989 1990
        it 'returns errors if extended hash configuration is invalid' do
          config = YAML.dump({ rspec: { extends: 'something', script: 'test' } })

          expect { Gitlab::Ci::YamlProcessor.new(config) }
            .to raise_error(Gitlab::Ci::YamlProcessor::ValidationError,
Wolphin's avatar
Wolphin committed
1991
                            'rspec: unknown keys in `extends` (something)')
1992
        end
1993 1994 1995
      end

      describe "#validation_message" do
1996 1997
        subject { Gitlab::Ci::YamlProcessor.validation_message(content) }

1998
        context "when the YAML could not be parsed" do
1999
          let(:content) { YAML.dump("invalid: yaml: test") }
2000

2001
          it { is_expected.to eq "Invalid configuration format" }
2002 2003 2004
        end

        context "when the tags parameter is invalid" do
2005
          let(:content) { YAML.dump({ rspec: { script: "test", tags: "mysql" } }) }
2006

2007
          it { is_expected.to eq "jobs:rspec tags should be an array of strings" }
2008 2009 2010
        end

        context "when YAML content is empty" do
2011
          let(:content) { '' }
2012

2013 2014 2015 2016 2017 2018 2019
          it { is_expected.to eq "Please provide content of .gitlab-ci.yml" }
        end

        context 'when the YAML contains an unknown alias' do
          let(:content) { 'steps: *bad_alias' }

          it { is_expected.to eq "Unknown alias: bad_alias" }
2020 2021 2022
        end

        context "when the YAML is valid" do
2023
          let(:content) { File.read(Rails.root.join('spec/support/gitlab_stubs/gitlab_ci.yml')) }
2024

2025
          it { is_expected.to be_nil }
2026 2027 2028 2029 2030
        end
      end
    end
  end
end