build.rb 14.3 KB
Newer Older
1
module Ci
2
  class Build < CommitStatus
3
    include TokenAuthenticatable
4
    include AfterCommitQueue
Rémy Coutable's avatar
Rémy Coutable committed
5
    include Presentable
6

7 8
    belongs_to :runner
    belongs_to :trigger_request
9
    belongs_to :erased_by, class_name: 'User'
10

11
    has_many :deployments, as: :deployable
12
    has_one :last_deployment, -> { order('deployments.id DESC') }, as: :deployable, class_name: 'Deployment'
13

14 15 16 17
    # The "environment" field for builds is a String, and is the unexpanded name
    def persisted_environment
      @persisted_environment ||= Environment.find_by(
        name: expanded_environment_name,
18
        project: project
19 20 21
      )
    end

22 23
    serialize :options # rubocop:disable Cop/ActiveRecordSerialize
    serialize :yaml_variables, Gitlab::Serializer::Ci::Variables # rubocop:disable Cop/ActiveRecordSerialize
24

Douwe Maan's avatar
Douwe Maan committed
25 26
    delegate :name, to: :project, prefix: true

27
    validates :coverage, numericality: true, allow_blank: true
Douwe Maan's avatar
Douwe Maan committed
28
    validates :ref, presence: true
29 30

    scope :unstarted, ->() { where(runner_id: nil) }
31
    scope :ignore_failures, ->() { where(allow_failure: false) }
32
    scope :with_artifacts, ->() { where.not(artifacts_file: [nil, '']) }
33
    scope :with_artifacts_not_expired, ->() { with_artifacts.where('artifacts_expire_at IS NULL OR artifacts_expire_at > ?', Time.now) }
34
    scope :with_expired_artifacts, ->() { with_artifacts.where('artifacts_expire_at < ?', Time.now) }
35
    scope :last_month, ->() { where('created_at > ?', Date.today - 1.month) }
36
    scope :manual_actions, ->() { where(when: :manual, status: COMPLETED_STATUSES + [:manual]) }
37

38
    mount_uploader :artifacts_file, ArtifactUploader
39
    mount_uploader :artifacts_metadata, ArtifactUploader
40

41 42
    acts_as_taggable

43 44
    add_authentication_token_field :token

45
    before_save :update_artifacts_size, if: :artifacts_file_changed?
46
    before_save :ensure_token
47
    before_destroy { unscoped_project }
48

49
    after_create :execute_hooks
50 51
    after_commit :update_project_statistics_after_save, on: [:create, :update]
    after_commit :update_project_statistics, on: :destroy
52 53

    class << self
54 55 56 57 58 59
      # This is needed for url_for to work,
      # as the controller is JobsController
      def model_name
        ActiveModel::Name.new(self, nil, 'job')
      end

60 61 62 63
      def first_pending
        pending.unstarted.order('created_at ASC').first
      end

64
      def retry(build, current_user)
65 66 67
        Ci::RetryBuildService
          .new(build.project, current_user)
          .execute(build)
68 69 70
      end
    end

71
    state_machine :status do
72 73
      event :actionize do
        transition created: :manual
74 75
      end

76 77
      after_transition any => [:pending] do |build|
        build.run_after_commit do
Kim "BKC" Carlbäcker's avatar
Kim "BKC" Carlbäcker committed
78
          BuildQueueWorker.perform_async(id)
79 80 81
        end
      end

82
      after_transition pending: :running do |build|
83 84 85
        build.run_after_commit do
          BuildHooksWorker.perform_async(id)
        end
86 87
      end

88
      after_transition any => [:success, :failed, :canceled] do |build|
89
        build.run_after_commit do
90
          BuildFinishedWorker.perform_async(id)
91
        end
92
      end
93

94
      after_transition any => [:success] do |build|
95 96
        build.run_after_commit do
          BuildSuccessWorker.perform_async(id)
97 98
        end
      end
99 100
    end

101
    def detailed_status(current_user)
102 103 104
      Gitlab::Ci::Status::Build::Factory
        .new(self, current_user)
        .fabricate!
105 106
    end

107
    def other_actions
108
      pipeline.manual_actions.where.not(name: name)
109 110
    end

111
    def playable?
112
      action? && (manual? || complete?)
113 114
    end

115
    def action?
116 117 118
      self.when == 'manual'
    end

119
    def play(current_user)
120 121 122
      Ci::PlayBuildService
        .new(project, current_user)
        .execute(self)
123 124
    end

Kamil Trzcinski's avatar
Kamil Trzcinski committed
125 126 127 128
    def cancelable?
      active?
    end

Kamil Trzcinski's avatar
Kamil Trzcinski committed
129
    def retryable?
130
      success? || failed? || canceled?
Kamil Trzcinski's avatar
Kamil Trzcinski committed
131 132
    end

133 134
    def latest?
      !retried?
135 136
    end

137
    def expanded_environment_name
138
      ExpandVariables.expand(environment, simple_variables) if environment
139 140
    end

141
    def has_environment?
142
      environment.present?
143 144
    end

145
    def starts_environment?
146
      has_environment? && self.environment_action == 'start'
147 148 149
    end

    def stops_environment?
150
      has_environment? && self.environment_action == 'stop'
151 152 153
    end

    def environment_action
154
      self.options.fetch(:environment, {}).fetch(:action, 'start') if self.options
155 156 157 158
    end

    def outdated_deployment?
      success? && !last_deployment.try(:last?)
159
    end
160

161 162
    def depends_on_builds
      # Get builds of the same type
163
      latest_builds = self.pipeline.builds.latest
164 165 166 167 168

      # Return builds from previous stages
      latest_builds.where('stage_idx < ?', stage_idx)
    end

169
    def timeout
170
      project.build_timeout
171 172
    end

173 174 175 176 177 178
    # A slugified version of the build ref, suitable for inclusion in URLs and
    # domain names. Rules:
    #
    #   * Lowercased
    #   * Anything not matching [a-z0-9-] is replaced with a -
    #   * Maximum length is 63 bytes
179
    #   * First/Last Character is not a hyphen
180
    def ref_slug
181 182 183 184
      ref.to_s
          .downcase
          .gsub(/[^a-z0-9]/, '-')[0..62]
          .gsub(/(\A-+|-+\z)/, '')
185 186
    end

187
    # Variables whose value does not depend on environment
188
    def simple_variables
189
      variables = predefined_variables
190 191 192 193 194 195 196
      variables += project.predefined_variables
      variables += pipeline.predefined_variables
      variables += runner.predefined_variables if runner
      variables += project.container_registry_variables
      variables += project.deployment_variables if has_environment?
      variables += yaml_variables
      variables += user_variables
197
      variables += project.secret_variables_for(ref).map(&:to_runner_variable)
198
      variables += trigger_request.user_variables if trigger_request
199
      variables
200 201
    end

202 203
    # All variables, including those dependent on environment, which could
    # contain unexpanded variables.
204
    def variables
205
      simple_variables.concat(persisted_environment_variables)
206 207
    end

208
    def merge_request
209
      return @merge_request if defined?(@merge_request)
Z.J. van de Weg's avatar
Z.J. van de Weg committed
210

211 212 213 214 215
      @merge_request ||=
        begin
          merge_requests = MergeRequest.includes(:merge_request_diff)
            .where(source_branch: ref,
                   source_project: pipeline.project)
Z.J. van de Weg's avatar
Z.J. van de Weg committed
216
            .reorder(iid: :desc)
217 218 219 220 221

          merge_requests.find do |merge_request|
            merge_request.commits_sha.include?(pipeline.sha)
          end
        end
222 223
    end

224
    def repo_url
Kamil Trzcinski's avatar
Kamil Trzcinski committed
225
      auth = "gitlab-ci-token:#{ensure_token!}@"
226 227 228
      project.http_url_to_repo.sub(/^https?:\/\//) do |prefix|
        prefix + auth
      end
229 230 231
    end

    def allow_git_fetch
232
      project.build_allow_git_fetch
233 234 235
    end

    def update_coverage
236
      coverage = trace.extract_coverage(coverage_regex)
237
      update_attributes(coverage: coverage) if coverage.present?
238 239
    end

240 241
    def trace
      Gitlab::Ci::Trace.new(self)
242 243
    end

244
    def has_trace?
245
      trace.exist?
246 247
    end

248 249
    def trace=(data)
      raise NotImplementedError
Tomasz Maczukin's avatar
Tomasz Maczukin committed
250 251
    end

252 253
    def old_trace
      read_attribute(:trace)
254 255
    end

256 257 258
    def erase_old_trace!
      write_attribute(:trace, nil)
      save
259 260
    end

261 262 263 264
    def needs_touch?
      Time.now - updated_at > 15.minutes.to_i
    end

Lin Jen-Shin's avatar
Lin Jen-Shin committed
265
    def valid_token?(token)
266
      self.token && ActiveSupport::SecurityUtils.variable_size_secure_compare(token, self.token)
267 268
    end

269 270 271 272
    def has_tags?
      tag_list.any?
    end

273
    def any_runners_online?
274
      project.any_runners? { |runner| runner.active? && runner.online? && runner.can_pick?(self) }
275 276
    end

277
    def stuck?
278 279 280
      pending? && !any_runners_online?
    end

281
    def execute_hooks
282
      return unless project
283
      build_data = Gitlab::DataBuilder::Build.build(self)
284 285
      project.execute_hooks(build_data.dup, :job_hooks)
      project.execute_services(build_data.dup, :job_hooks)
286
      PagesService.new(build_data).execute
Josh Frye's avatar
Josh Frye committed
287
      project.running_or_pending_build_count(force: true)
288 289
    end

290
    def artifacts?
291
      !artifacts_expired? && artifacts_file.exists?
292 293
    end

294
    def artifacts_metadata?
295
      artifacts? && artifacts_metadata.exists?
296 297
    end

298
    def artifacts_metadata_entry(path, **options)
299 300 301 302 303 304
      metadata = Gitlab::Ci::Build::Artifacts::Metadata.new(
        artifacts_metadata.path,
        path,
        **options)

      metadata.to_entry
305 306
    end

307 308 309
    def erase_artifacts!
      remove_artifacts_file!
      remove_artifacts_metadata!
310
      save
311 312
    end

313 314 315
    def erase(opts = {})
      return false unless erasable?

316
      erase_artifacts!
317 318 319 320 321 322 323 324 325 326 327 328
      erase_trace!
      update_erased!(opts[:erased_by])
    end

    def erasable?
      complete? && (artifacts? || has_trace?)
    end

    def erased?
      !self.erased_at.nil?
    end

329
    def artifacts_expired?
330
      artifacts_expire_at && artifacts_expire_at < Time.now
331 332
    end

333 334 335 336 337
    def artifacts_expire_in
      artifacts_expire_at - Time.now if artifacts_expire_at
    end

    def artifacts_expire_in=(value)
338 339
      self.artifacts_expire_at =
        if value
340
          ChronicDuration.parse(value)&.seconds&.from_now
341
        end
342 343
    end

344
    def has_expiring_artifacts?
Z.J. van de Weg's avatar
Z.J. van de Weg committed
345
      artifacts_expire_at.present? && artifacts_expire_at > Time.now
346 347
    end

348
    def keep_artifacts!
349 350 351
      self.update(artifacts_expire_at: nil)
    end

352
    def coverage_regex
353
      super || project.try(:build_coverage_regex)
354 355
    end

356 357
    def when
      read_attribute(:when) || build_attributes_from_config[:when] || 'on_success'
358 359
    end

360 361
    def yaml_variables
      read_attribute(:yaml_variables) || build_attributes_from_config[:yaml_variables] || []
362 363
    end

364 365 366 367 368 369 370 371 372
    def user_variables
      return [] if user.blank?

      [
        { key: 'GITLAB_USER_ID', value: user.id.to_s, public: true },
        { key: 'GITLAB_USER_EMAIL', value: user.email, public: true }
      ]
    end

373
    def steps
Tomasz Maczukin's avatar
Tomasz Maczukin committed
374 375
      [Gitlab::Ci::Build::Step.from_commands(self),
       Gitlab::Ci::Build::Step.from_after_script(self)].compact
376 377 378
    end

    def image
379
      Gitlab::Ci::Build::Image.from_image(self)
380 381 382
    end

    def services
383
      Gitlab::Ci::Build::Image.from_services(self)
384 385 386
    end

    def artifacts
387
      [options[:artifacts]]
388 389 390
    end

    def cache
391
      [options[:cache]]
392 393
    end

394
    def credentials
395
      Gitlab::Ci::Build::Credentials::Factory.new(self).create!
396 397
    end

398
    def dependencies
399 400
      return [] if empty_dependencies?

401 402
      depended_jobs = depends_on_builds

403
      return depended_jobs unless options[:dependencies].present?
404

405 406
      depended_jobs.select do |job|
        options[:dependencies].include?(job.name)
407 408 409
      end
    end

410 411 412 413
    def empty_dependencies?
      options[:dependencies]&.empty?
    end

414 415 416 417 418 419 420 421 422
    def hide_secrets(trace)
      return unless trace

      trace = trace.dup
      Ci::MaskSecret.mask!(trace, project.runners_token) if project
      Ci::MaskSecret.mask!(trace, token)
      trace
    end

423 424
    private

425
    def update_artifacts_size
426 427
      self.artifacts_size = if artifacts_file.exists?
                              artifacts_file.size
428 429
                            else
                              nil
430
                            end
431 432
    end

433
    def erase_trace!
434
      trace.erase!
435 436 437
    end

    def update_erased!(user = nil)
438
      self.update(erased_by: user, erased_at: Time.now, artifacts_expire_at: nil)
439 440
    end

441
    def unscoped_project
442
      @unscoped_project ||= Project.unscoped.find_by(id: project_id)
443 444
    end

445 446
    CI_REGISTRY_USER = 'gitlab-ci-token'.freeze

447
    def predefined_variables
448 449 450
      variables = [
        { key: 'CI', value: 'true', public: true },
        { key: 'GITLAB_CI', value: 'true', public: true },
451 452 453 454 455 456 457
        { key: 'CI_SERVER_NAME', value: 'GitLab', public: true },
        { key: 'CI_SERVER_VERSION', value: Gitlab::VERSION, public: true },
        { key: 'CI_SERVER_REVISION', value: Gitlab::REVISION, public: true },
        { key: 'CI_JOB_ID', value: id.to_s, public: true },
        { key: 'CI_JOB_NAME', value: name, public: true },
        { key: 'CI_JOB_STAGE', value: stage, public: true },
        { key: 'CI_JOB_TOKEN', value: token, public: false },
Z.J. van de Weg's avatar
Z.J. van de Weg committed
458
        { key: 'CI_COMMIT_SHA', value: sha, public: true },
459 460 461 462 463 464 465 466 467 468 469 470 471
        { key: 'CI_COMMIT_REF_NAME', value: ref, public: true },
        { key: 'CI_COMMIT_REF_SLUG', value: ref_slug, public: true },
        { key: 'CI_REGISTRY_USER', value: CI_REGISTRY_USER, public: true },
        { key: 'CI_REGISTRY_PASSWORD', value: token, public: false },
        { key: 'CI_REPOSITORY_URL', value: repo_url, public: false }
      ]

      variables << { key: "CI_COMMIT_TAG", value: ref, public: true } if tag?
      variables << { key: "CI_PIPELINE_TRIGGERED", value: 'true', public: true } if trigger_request
      variables << { key: "CI_JOB_MANUAL", value: 'true', public: true } if action?
      variables.concat(legacy_variables)
    end

472
    def persisted_environment_variables
473 474
      return [] unless persisted_environment

475 476
      variables = persisted_environment.predefined_variables

477 478 479
      # Here we're passing unexpanded environment_url for runner to expand,
      # and we need to make sure that CI_ENVIRONMENT_NAME and
      # CI_ENVIRONMENT_SLUG so on are available for the URL be expanded.
480
      variables << { key: 'CI_ENVIRONMENT_URL', value: environment_url, public: true } if environment_url
481 482

      variables
483 484
    end

485 486
    def legacy_variables
      variables = [
487 488 489 490 491
        { key: 'CI_BUILD_ID', value: id.to_s, public: true },
        { key: 'CI_BUILD_TOKEN', value: token, public: false },
        { key: 'CI_BUILD_REF', value: sha, public: true },
        { key: 'CI_BUILD_BEFORE_SHA', value: before_sha, public: true },
        { key: 'CI_BUILD_REF_NAME', value: ref, public: true },
492
        { key: 'CI_BUILD_REF_SLUG', value: ref_slug, public: true },
493
        { key: 'CI_BUILD_NAME', value: name, public: true },
494
        { key: 'CI_BUILD_STAGE', value: stage, public: true }
495
      ]
496 497 498 499

      variables << { key: "CI_BUILD_TAG", value: ref, public: true } if tag?
      variables << { key: "CI_BUILD_TRIGGERED", value: 'true', public: true } if trigger_request
      variables << { key: "CI_BUILD_MANUAL", value: 'true', public: true } if action?
500 501
      variables
    end
502

503
    def environment_url
504
      options&.dig(:environment, :url) || persisted_environment&.external_url
505 506
    end

507 508
    def build_attributes_from_config
      return {} unless pipeline.config_processor
509

510 511
      pipeline.config_processor.build_attributes(name)
    end
512

513
    def update_project_statistics
514 515
      return unless project

516 517
      ProjectCacheWorker.perform_async(project_id, [], [:build_artifacts_size])
    end
518 519 520 521 522 523

    def update_project_statistics_after_save
      if previous_changes.include?('artifacts_size')
        update_project_statistics
      end
    end
524 525
  end
end