gitlab_ci_yaml_processor.rb 10.2 KB
Newer Older
1 2
module Ci
  class GitlabCiYamlProcessor
3
    class ValidationError < StandardError; end
4

5
    include Gitlab::Ci::Config::Node::LegacyValidationHelpers
6

7
    DEFAULT_STAGE = 'test'
8
    ALLOWED_YAML_KEYS = [:before_script, :after_script, :image, :services, :types, :stages, :variables, :cache]
9 10
    ALLOWED_JOB_KEYS = [:tags, :script, :only, :except, :type, :image, :services,
                        :allow_failure, :type, :stage, :when, :artifacts, :cache,
11 12
                        :dependencies, :before_script, :after_script, :variables,
                        :environment]
Kamil Trzcinski's avatar
Kamil Trzcinski committed
13
    ALLOWED_CACHE_KEYS = [:key, :untracked, :paths]
14
    ALLOWED_ARTIFACTS_KEYS = [:name, :untracked, :paths, :when, :expire_in]
15

16
    attr_reader :path, :cache, :stages
17

18
    def initialize(config, path = nil)
19 20 21
      @ci_config = Gitlab::Ci::Config.new(config)
      @config = @ci_config.to_hash

22
      @path = path
23

24 25 26
      unless @ci_config.valid?
        raise ValidationError, @ci_config.errors.first
      end
27

28
      initial_parsing
29
      validate!
30
    rescue Gitlab::Ci::Config::Loader::FormatError => e
31
      raise ValidationError, e.message
32 33
    end

34
    def builds_for_stage_and_ref(stage, ref, tag = false, trigger_request = nil)
35 36 37 38
      builds.select do |build|
        build[:stage] == stage &&
          process?(build[:only], build[:except], ref, tag, trigger_request)
      end
39 40 41 42 43 44 45 46
    end

    def builds
      @jobs.map do |name, job|
        build_job(name, job)
      end
    end

47
    def global_variables
48 49 50 51
      @variables
    end

    def job_variables(name)
52 53 54
      job = @jobs[name.to_sym]
      return [] unless job

55
      job[:variables] || []
56 57
    end

58 59 60
    private

    def initial_parsing
61 62
      @before_script = @ci_config.before_script
      @image = @ci_config.image
63
      @after_script = @ci_config.after_script
64
      @services = @ci_config.services
65
      @variables = @ci_config.variables
66
      @stages = @ci_config.stages
67
      @cache = @ci_config.cache
68

69
      @jobs = {}
70

71 72 73
      @ci_config.jobs.each do |name, param|
        add_job(name, param)
      end
74

75
      raise ValidationError, "Please define at least one job" if @jobs.none?
76 77
    end

78 79 80 81 82
    def add_job(name, job)
      raise ValidationError, "Unknown parameter: #{name}" unless job.is_a?(Hash) && job.has_key?(:script)

      stage = job[:stage] || job[:type] || DEFAULT_STAGE
      @jobs[name] = { stage: stage }.merge(job)
83 84
    end

85 86
    def build_job(name, job)
      {
87
        stage_idx: @stages.index(job[:stage]),
88
        stage: job[:stage],
89 90 91 92 93
        ##
        # Refactoring note:
        #  - before script behaves differently than after script
        #  - after script returns an array of commands
        #  - before script should be a concatenated command
94
        commands: [job[:before_script] || @before_script, job[:script]].flatten.compact.join("\n"),
Kamil Trzcinski's avatar
Kamil Trzcinski committed
95
        tag_list: job[:tags] || [],
96 97 98 99
        name: name,
        only: job[:only],
        except: job[:except],
        allow_failure: job[:allow_failure] || false,
100
        when: job[:when] || 'on_success',
101
        environment: job[:environment],
102 103
        options: {
          image: job[:image] || @image,
104
          services: job[:services] || @services,
105 106
          artifacts: job[:artifacts],
          cache: job[:cache] || @cache,
107
          dependencies: job[:dependencies],
108
          after_script: job[:after_script] || @after_script,
109 110 111 112 113
        }.compact
      }
    end

    def validate!
Kamil Trzcinski's avatar
Kamil Trzcinski committed
114 115 116 117 118 119 120
      @jobs.each do |name, job|
        validate_job!(name, job)
      end

      true
    end

121
    def validate_job!(name, job)
122 123 124
      validate_job_name!(name)
      validate_job_keys!(name, job)
      validate_job_types!(name, job)
Kamil Trzcinski's avatar
Kamil Trzcinski committed
125
      validate_job_script!(name, job)
126 127

      validate_job_stage!(name, job) if job[:stage]
128
      validate_job_variables!(name, job) if job[:variables]
129 130
      validate_job_cache!(name, job) if job[:cache]
      validate_job_artifacts!(name, job) if job[:artifacts]
131
      validate_job_dependencies!(name, job) if job[:dependencies]
132 133 134
    end

    def validate_job_name!(name)
Kamil Trzcinski's avatar
Kamil Trzcinski committed
135 136 137
      if name.blank? || !validate_string(name)
        raise ValidationError, "job name should be non-empty string"
      end
138
    end
Kamil Trzcinski's avatar
Kamil Trzcinski committed
139

140
    def validate_job_keys!(name, job)
141 142
      job.keys.each do |key|
        unless ALLOWED_JOB_KEYS.include? key
Kamil Trzcinski's avatar
Kamil Trzcinski committed
143
          raise ValidationError, "#{name} job: unknown parameter #{key}"
144 145
        end
      end
146
    end
147

148
    def validate_job_types!(name, job)
Kamil Trzcinski's avatar
Kamil Trzcinski committed
149 150
      if job[:image] && !validate_string(job[:image])
        raise ValidationError, "#{name} job: image should be a string"
151 152 153
      end

      if job[:services] && !validate_array_of_strings(job[:services])
Kamil Trzcinski's avatar
Kamil Trzcinski committed
154
        raise ValidationError, "#{name} job: services should be an array of strings"
155 156 157
      end

      if job[:tags] && !validate_array_of_strings(job[:tags])
Kamil Trzcinski's avatar
Kamil Trzcinski committed
158
        raise ValidationError, "#{name} job: tags parameter should be an array of strings"
159 160
      end

161 162
      if job[:only] && !validate_array_of_strings_or_regexps(job[:only])
        raise ValidationError, "#{name} job: only parameter should be an array of strings or regexps"
163 164
      end

165 166
      if job[:except] && !validate_array_of_strings_or_regexps(job[:except])
        raise ValidationError, "#{name} job: except parameter should be an array of strings or regexps"
167 168
      end

169 170
      if job[:allow_failure] && !validate_boolean(job[:allow_failure])
        raise ValidationError, "#{name} job: allow_failure parameter should be an boolean"
171 172
      end

Kamil Trzcinski's avatar
Kamil Trzcinski committed
173
      if job[:when] && !job[:when].in?(%w[on_success on_failure always])
174 175
        raise ValidationError, "#{name} job: when parameter should be on_success, on_failure or always"
      end
176

177 178
      if job[:environment] && !validate_environment(job[:environment])
        raise ValidationError, "#{name} job: environment parameter #{Gitlab::Regex.environment_name_regex_message}"
179
      end
180
    end
181

Kamil Trzcinski's avatar
Kamil Trzcinski committed
182 183 184 185 186 187 188 189 190 191 192 193 194 195
    def validate_job_script!(name, job)
      if !validate_string(job[:script]) && !validate_array_of_strings(job[:script])
        raise ValidationError, "#{name} job: script should be a string or an array of a strings"
      end

      if job[:before_script] && !validate_array_of_strings(job[:before_script])
        raise ValidationError, "#{name} job: before_script should be an array of strings"
      end

      if job[:after_script] && !validate_array_of_strings(job[:after_script])
        raise ValidationError, "#{name} job: after_script should be an array of strings"
      end
    end

196
    def validate_job_stage!(name, job)
197 198
      unless job[:stage].is_a?(String) && job[:stage].in?(@stages)
        raise ValidationError, "#{name} job: stage parameter should be #{@stages.join(", ")}"
199
      end
200
    end
201

202
    def validate_job_variables!(name, job)
203
      unless validate_variables(job[:variables])
204
        raise ValidationError,
205
          "#{name} job: variables should be a map of key-value strings"
206 207 208
      end
    end

209
    def validate_job_cache!(name, job)
Kamil Trzcinski's avatar
Kamil Trzcinski committed
210 211 212 213 214 215
      job[:cache].keys.each do |key|
        unless ALLOWED_CACHE_KEYS.include? key
          raise ValidationError, "#{name} job: cache unknown parameter #{key}"
        end
      end

216 217 218 219
      if job[:cache][:key] && !validate_string(job[:cache][:key])
        raise ValidationError, "#{name} job: cache:key parameter should be a string"
      end

220 221
      if job[:cache][:untracked] && !validate_boolean(job[:cache][:untracked])
        raise ValidationError, "#{name} job: cache:untracked parameter should be an boolean"
222
      end
223

224 225
      if job[:cache][:paths] && !validate_array_of_strings(job[:cache][:paths])
        raise ValidationError, "#{name} job: cache:paths parameter should be an array of strings"
226
      end
227 228
    end

229
    def validate_job_artifacts!(name, job)
Kamil Trzcinski's avatar
Kamil Trzcinski committed
230 231 232 233 234 235
      job[:artifacts].keys.each do |key|
        unless ALLOWED_ARTIFACTS_KEYS.include? key
          raise ValidationError, "#{name} job: artifacts unknown parameter #{key}"
        end
      end

236 237 238 239
      if job[:artifacts][:name] && !validate_string(job[:artifacts][:name])
        raise ValidationError, "#{name} job: artifacts:name parameter should be a string"
      end

240 241 242 243 244 245 246
      if job[:artifacts][:untracked] && !validate_boolean(job[:artifacts][:untracked])
        raise ValidationError, "#{name} job: artifacts:untracked parameter should be an boolean"
      end

      if job[:artifacts][:paths] && !validate_array_of_strings(job[:artifacts][:paths])
        raise ValidationError, "#{name} job: artifacts:paths parameter should be an array of strings"
      end
Kamil Trzcinski's avatar
Kamil Trzcinski committed
247

Kamil Trzcinski's avatar
Kamil Trzcinski committed
248
      if job[:artifacts][:when] && !job[:artifacts][:when].in?(%w[on_success on_failure always])
Kamil Trzcinski's avatar
Kamil Trzcinski committed
249 250
        raise ValidationError, "#{name} job: artifacts:when parameter should be on_success, on_failure or always"
      end
251 252 253 254

      if job[:artifacts][:expire_in] && !validate_duration(job[:artifacts][:expire_in])
        raise ValidationError, "#{name} job: artifacts:expire_in parameter should be a duration"
      end
255
    end
256

257
    def validate_job_dependencies!(name, job)
258
      unless validate_array_of_strings(job[:dependencies])
259 260 261
        raise ValidationError, "#{name} job: dependencies parameter should be an array of strings"
      end

262
      stage_index = @stages.index(job[:stage])
263 264

      job[:dependencies].each do |dependency|
265
        raise ValidationError, "#{name} job: undefined dependency: #{dependency}" unless @jobs[dependency.to_sym]
266

267
        unless @stages.index(@jobs[dependency.to_sym][:stage]) < stage_index
268 269 270 271 272
          raise ValidationError, "#{name} job: dependency #{dependency} is not defined in prior stages"
        end
      end
    end

273
    def process?(only_params, except_params, ref, tag, trigger_request)
274
      if only_params.present?
275
        return false unless matching?(only_params, ref, tag, trigger_request)
276 277 278
      end

      if except_params.present?
279
        return false if matching?(except_params, ref, tag, trigger_request)
280 281 282 283 284
      end

      true
    end

285
    def matching?(patterns, ref, tag, trigger_request)
286
      patterns.any? do |pattern|
287
        match_ref?(pattern, ref, tag, trigger_request)
288 289 290
      end
    end

291
    def match_ref?(pattern, ref, tag, trigger_request)
292 293 294 295
      pattern, path = pattern.split('@', 2)
      return false if path && path != self.path
      return true if tag && pattern == 'tags'
      return true if !tag && pattern == 'branches'
296
      return true if trigger_request.present? && pattern == 'triggers'
297 298 299 300 301 302 303

      if pattern.first == "/" && pattern.last == "/"
        Regexp.new(pattern[1...-1]) =~ ref
      else
        pattern == ref
      end
    end
304
  end
305
end