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

          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

391
            it "return commands with scripts concatenated" do
392
393
394
              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
          context 'when script is array of strings' do
            let(:config) do
              {
                test: { script: ["script"] }
              }
            end

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

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

417
            it "return commands with scripts concatenated" do
418
419
              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

          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

471
            it "return after_script in options" do
472
473
474
              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
            untracked: true,
            key: 'key',
            policy: 'pull-push'
          )
        end