summaryrefslogtreecommitdiff
path: root/spec/lib/gitlab_ci_yaml_processor_spec.rb
blob: 127b8bea9cffaff27069931c59917a76d17dc990 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
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
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
require 'spec_helper'

describe GitlabCiYamlProcessor do
  
  describe "#builds_for_ref" do
    let (:type) { 'test' }

    it "returns builds if no branch specified" do
      config = YAML.dump({
        before_script: ["pwd"],
        rspec: {script: "rspec"}
      })

      config_processor = described_class.new(config)

      expect(config_processor.builds_for_stage_and_ref(type, "master").size).to eq 1
      expect(config_processor.builds_for_stage_and_ref(type, "master").first).to eq({
        stage: "test",
        except: nil,
        name: :rspec,
        only: nil,
        script: "pwd\nrspec",
        tags: [],
        options: {},
        allow_failure: false
      })
    end

    it "does not return builds if only has another branch" do
      config = YAML.dump({
        before_script: ["pwd"],
        rspec: {script: "rspec", only: ["deploy"]}
      })

      config_processor = described_class.new(config)

      expect(config_processor.builds_for_stage_and_ref(type, "master").size).to eq 0
    end

    it "does not return builds if only has regexp with another branch" do
      config = YAML.dump({
        before_script: ["pwd"],
        rspec: {script: "rspec", only: ["/^deploy$/"]}
      })

      config_processor = described_class.new(config)

      expect(config_processor.builds_for_stage_and_ref(type, "master").size).to eq 0
    end

    it "returns builds if only has specified this branch" do
      config = YAML.dump({
        before_script: ["pwd"],
        rspec: {script: "rspec", only: ["master"]}
      })

      config_processor = described_class.new(config)

      expect(config_processor.builds_for_stage_and_ref(type, "master").size).to eq 1
    end

    it "does not build tags" do
      config = YAML.dump({
        before_script: ["pwd"],
        rspec: {script: "rspec", except: ["tags"]}
      })

      config_processor = described_class.new(config)

      expect(config_processor.builds_for_stage_and_ref(type, "0-1", true).size).to eq 0
    end

    it "returns builds if only has a list of branches including specified" do
      config = YAML.dump({
                           before_script: ["pwd"],
                           rspec: {script: "rspec", type: type, only: ["master", "deploy"]}
                         })

      config_processor = described_class.new(config)

      expect(config_processor.builds_for_stage_and_ref(type, "deploy").size).to eq 1
    end

    it "returns build only for specified type" do

      config = YAML.dump({
                           before_script: ["pwd"],
                           build: {script: "build", type: "build", only: ["master", "deploy"]},
                           rspec: {script: "rspec", type: type, only: ["master", "deploy"]},
                           staging: {script: "deploy", type: "deploy", only: ["master", "deploy"]},
                           production: {script: "deploy", type: "deploy", only: ["master", "deploy"]},
                         })

      config_processor = described_class.new(config)

      expect(config_processor.builds_for_stage_and_ref("production", "deploy").size).to eq 0
      expect(config_processor.builds_for_stage_and_ref(type, "deploy").size).to eq 1
      expect(config_processor.builds_for_stage_and_ref("deploy", "deploy").size).to eq 2
    end
  end

  describe "Image and service handling" do
    it "returns image and service when defined" do
      config = YAML.dump({
                           image: "ruby:2.1",
                           services: ["mysql"],
                           before_script: ["pwd"],
                           rspec: {script: "rspec"}
                         })

      config_processor = described_class.new(config)

      expect(config_processor.builds_for_stage_and_ref("test", "master").size).to eq 1
      expect(config_processor.builds_for_stage_and_ref("test", "master").first).to eq({
        except: nil,
        stage: "test",
        name: :rspec,
        only: nil,
        script: "pwd\nrspec",
        tags: [],
        options: {
          image: "ruby:2.1",
          services: ["mysql"]
        },
        allow_failure: false
      })
    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"], script: "rspec"}
                         })

      config_processor = described_class.new(config)

      expect(config_processor.builds_for_stage_and_ref("test", "master").size).to eq 1
      expect(config_processor.builds_for_stage_and_ref("test", "master").first).to eq({
        except: nil,
        stage: "test",
        name: :rspec,
        only: nil,
        script: "pwd\nrspec",
        tags: [],
        options: {
          image: "ruby:2.5",
          services: ["postgresql"]
        },
        allow_failure: false
      })
    end
  end

  describe "Variables" do
    it "returns variables when defined" do
      variables = {
        var1: "value1",
        var2: "value2",
      }
      config = YAML.dump({
                           variables: variables,
                           before_script: ["pwd"],
                           rspec: {script: "rspec"}
                         })

      config_processor = described_class.new(config)
      expect(config_processor.variables).to eq variables
    end
  end

  describe "Error handling" do
    it "indicates that object is invalid" do
      expect{described_class.new("invalid_yaml\n!ccdvlf%612334@@@@")}.to raise_error(described_class::ValidationError)
    end

    it "returns errors if tags parameter is invalid" do
      config = YAML.dump({rspec: {script: "test", tags: "mysql"}})
      expect do
        described_class.new(config)
      end.to raise_error(described_class::ValidationError, "rspec job: tags parameter 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
        described_class.new(config)
      end.to raise_error(described_class::ValidationError, "before_script should be an array of strings")
    end

    it "returns errors if image parameter is invalid" do
      config = YAML.dump({image: ["test"], rspec: {script: "test"}})
      expect do
        described_class.new(config)
      end.to raise_error(described_class::ValidationError, "image should be a string")
    end

    it "returns errors if job image parameter is invalid" do
      config = YAML.dump({rspec: {script: "test", image: ["test"]}})
      expect do
        described_class.new(config)
      end.to raise_error(described_class::ValidationError, "rspec job: image should be a string")
    end

    it "returns errors if services parameter is not an array" do
      config = YAML.dump({services: "test", rspec: {script: "test"}})
      expect do
        described_class.new(config)
      end.to raise_error(described_class::ValidationError, "services should be an array of strings")
    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
        described_class.new(config)
      end.to raise_error(described_class::ValidationError, "services should be an array of strings")
    end

    it "returns errors if job services parameter is not an array" do
      config = YAML.dump({rspec: {script: "test", services: "test"}})
      expect do
        described_class.new(config)
      end.to raise_error(described_class::ValidationError, "rspec job: services should be an array of strings")
    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
        described_class.new(config)
      end.to raise_error(described_class::ValidationError, "rspec job: services should be an array of strings")
    end

    it "returns errors if there are unknown parameters" do
      config = YAML.dump({extra: "bundle update"})
      expect do
        described_class.new(config)
      end.to raise_error(described_class::ValidationError, "Unknown parameter: extra")
    end

    it "returns errors if there are unknown parameters that are hashes, but doesn't have a script" do
      config = YAML.dump({extra: {services: "test"}})
      expect do
        described_class.new(config)
      end.to raise_error(described_class::ValidationError, "Unknown parameter: extra")
    end

    it "returns errors if there is no any jobs defined" do
      config = YAML.dump({before_script: ["bundle update"]})
      expect do
        described_class.new(config)
      end.to raise_error(described_class::ValidationError, "Please define at least one 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
        described_class.new(config)
      end.to raise_error(described_class::ValidationError, "rspec job: allow_failure parameter should be an boolean")
    end

    it "returns errors if job stage is not a string" do
      config = YAML.dump({rspec: {script: "test", type: 1, allow_failure: "string"}})
      expect do
        described_class.new(config)
      end.to raise_error(described_class::ValidationError, "rspec job: stage parameter should be build, test, deploy")
    end

    it "returns errors if job stage is not a pre-defined stage" do
      config = YAML.dump({rspec: {script: "test", type: "acceptance", allow_failure: "string"}})
      expect do
        described_class.new(config)
      end.to raise_error(described_class::ValidationError, "rspec job: stage parameter should be build, test, deploy")
    end

    it "returns errors if job stage is not a defined stage" do
      config = YAML.dump({types: ["build", "test"], rspec: {script: "test", type: "acceptance", allow_failure: "string"}})
      expect do
        described_class.new(config)
      end.to raise_error(described_class::ValidationError, "rspec job: stage parameter should be build, test")
    end

    it "returns errors if stages is not an array" do
      config = YAML.dump({types: "test", rspec: {script: "test"}})
      expect do
        described_class.new(config)
      end.to raise_error(described_class::ValidationError, "stages should be an array of strings")
    end

    it "returns errors if stages is not an array of strings" do
      config = YAML.dump({types: [true, "test"], rspec: {script: "test"}})
      expect do
        described_class.new(config)
      end.to raise_error(described_class::ValidationError, "stages 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
        described_class.new(config)
      end.to raise_error(described_class::ValidationError, "variables should be a map of key-valued strings")
    end

    it "returns errors if variables is not a map of key-valued strings" do
      config = YAML.dump({variables: {test: false}, rspec: {script: "test"}})
      expect do
        described_class.new(config)
      end.to raise_error(described_class::ValidationError, "variables should be a map of key-valued strings")
    end
  end
end