Class: Ci::Build

Constant Summary collapse

BuildArchivedError =
Class.new(StandardError)
RUNNER_FEATURES =
{
  upload_multiple_artifacts: -> (build) { build.publishes_artifacts_reports? },
  refspecs: -> (build) { build.merge_request_ref? },
  artifacts_exclude: -> (build) { build.supports_artifacts_exclude? },
  multi_build_steps: -> (build) { build.multi_build_steps? },
  return_exit_code: -> (build) { build.exit_codes_defined? }
}.freeze
DEFAULT_RETRIES =
{
  scheduler_failure: 2
}.freeze
DEGRADATION_THRESHOLD_VARIABLE_NAME =
'DEGRADATION_THRESHOLD'
RUNNERS_STATUS_CACHE_EXPIRATION =
1.minute
DEPLOYMENT_NAMES =
%w[deploy release rollout].freeze

Constants included from TaggableQueries

TaggableQueries::MAX_TAGS_IDS, TaggableQueries::TooManyTagsError

Constants included from HasStatus

HasStatus::ACTIVE_STATUSES, HasStatus::ALIVE_STATUSES, HasStatus::AVAILABLE_STATUSES, HasStatus::BLOCKED_STATUS, HasStatus::CANCELABLE_STATUSES, HasStatus::COMPLETED_STATUSES, HasStatus::DEFAULT_STATUS, HasStatus::EXCLUDE_IGNORED_STATUSES, HasStatus::ORDERED_STATUSES, HasStatus::PASSED_WITH_WARNINGS_STATUSES, HasStatus::STARTED_STATUSES, HasStatus::STATUSES_ENUM, HasStatus::STOPPED_STATUSES, HasStatus::UnknownStatusError

Constants inherited from ApplicationRecord

ApplicationRecord::MAX_PLUCK

Instance Attribute Summary

Attributes included from Importable

#imported, #importing

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Gitlab::Utils::Override

extended, extensions, included, method_added, override, prepended, queue_verification, verify!

Methods included from HasDeploymentName

#count_user_deployment?, #deployment_name?

Methods included from HasRef

#branch?, #git_ref, #ref_slug

Methods included from Presentable

#present

Methods included from ObjectStorage::BackgroundMove

#background_upload, #changed_mounts

Methods included from AfterCommitQueue

#run_after_commit, #run_after_commit_or_now

Methods included from Contextable

#scoped_variables, #simple_variables, #simple_variables_without_dependencies, #track_duration

Methods included from Metadatable

#cancel_gracefully?, #degenerate!, #degenerated?, #ensure_metadata, #has_exposed_artifacts?, #interruptible, #interruptible=, #options, #options=, #yaml_variables, #yaml_variables=

Methods inherited from Processable

#aggregated_needs_names, #all_dependencies, #clone, #dependency_variables, #ensure_scheduling_type!, #find_legacy_scheduling_type, #needs_attributes, populate_scheduling_type!, #retryable?, #scheduling_type_dag?, select_with_aggregated_needs, #when, #with_resource_group?

Methods included from Gitlab::Utils::StrongMemoize

#clear_memoization, #strong_memoize, #strong_memoized?

Methods inherited from CommitStatus

#auto_canceled?, bulk_insert_tags!, #duration, #expire_etag_cache!, #failed_but_allowed?, #group_name, #importing?, #latest?, locking_enabled?, #locking_enabled?, names, #queued_duration, #recoverable?, #retryable?, #sortable_name, update_as_processed!, #update_older_statuses_retried!

Methods included from TaggableQueries

#tags_ids

Methods included from BulkInsertableAssociations

#bulk_insert_associations!, bulk_inserts_enabled?, with_bulk_insert

Methods included from HasStatus

#active?, #blocked?, #complete?, #started?

Methods inherited from ApplicationRecord

table_name_prefix

Methods inherited from ApplicationRecord

cached_column_list, #create_or_load_association, declarative_enum, default_select_columns, id_in, id_not_in, iid_in, pluck_primary_key, primary_key_in, #readable_by?, safe_ensure_unique, safe_find_or_create_by, safe_find_or_create_by!, #to_ability_name, underscore, where_exists, where_not_exists, with_fast_read_statement_timeout, without_order

Class Method Details

.build_matchers(project) ⇒ Object


385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
# File 'app/models/ci/build.rb', line 385

def self.build_matchers(project)
  unique_params = [
    :protected,
    Arel.sql("(#{arel_tag_names_array.to_sql})")
  ]

  group(*unique_params).pluck('array_agg(id)', *unique_params).map do |values|
    Gitlab::Ci::Matching::BuildMatcher.new({
      build_ids: values[0],
      protected: values[1],
      tag_list: values[2],
      project: project
    })
  end
end

.clone_accessorsObject


230
231
232
233
234
235
236
# File 'app/models/ci/build.rb', line 230

def clone_accessors
  %i[pipeline project ref tag options name
     allow_failure stage stage_id stage_idx trigger_request
     yaml_variables when environment coverage_regex
     description tag_list protected needs_attributes
     job_variables_attributes resource_group scheduling_type].freeze
end

.extra_accessorsObject


226
227
228
# File 'app/models/ci/build.rb', line 226

def extra_accessors
  []
end

.first_pendingObject


218
219
220
# File 'app/models/ci/build.rb', line 218

def first_pending
  pending.unstarted.order('created_at ASC').first
end

.keep_artifacts!Object


876
877
878
879
# File 'app/models/ci/build.rb', line 876

def self.keep_artifacts!
  update_all(artifacts_expire_at: nil)
  Ci::JobArtifact.where(job: self.select(:id)).update_all(expire_at: nil)
end

.model_nameObject

This is needed for url_for to work, as the controller is JobsController


214
215
216
# File 'app/models/ci/build.rb', line 214

def model_name
  ActiveModel::Name.new(self, nil, 'job')
end

.with_preloadsObject


222
223
224
# File 'app/models/ci/build.rb', line 222

def with_preloads
  preload(:job_artifacts_archive, :job_artifacts, :tags, project: [:namespace])
end

Instance Method Details

#action?Boolean

Returns:

  • (Boolean)

470
471
472
# File 'app/models/ci/build.rb', line 470

def action?
  %w[manual delayed].include?(self.when)
end

#all_met_to_become_pending?Boolean

Returns:

  • (Boolean)

491
492
493
# File 'app/models/ci/build.rb', line 491

def all_met_to_become_pending?
  super && !any_unmet_prerequisites?
end

#all_queuing_entriesObject

We can have only one queuing entry or running build tracking entry, because there is a unique index on `build_id` in each table, but we need a relation to remove these entries more efficiently in a single statement without actually loading data.


1117
1118
1119
# File 'app/models/ci/build.rb', line 1117

def all_queuing_entries
  ::Ci::PendingBuild.where(build_id: self.id)
end

#all_runtime_metadataObject


1121
1122
1123
# File 'app/models/ci/build.rb', line 1121

def 
  ::Ci::RunningBuild.where(build_id: self.id)
end

#allow_git_fetchObject


661
662
663
# File 'app/models/ci/build.rb', line 661

def allow_git_fetch
  project.build_allow_git_fetch
end

#allowed_to_fail_with_code?(exit_code) ⇒ Boolean

Returns:

  • (Boolean)

1139
1140
1141
1142
1143
1144
# File 'app/models/ci/build.rb', line 1139

def allowed_to_fail_with_code?(exit_code)
  options
    .dig(:allow_failure_criteria, :exit_codes)
    .to_a
    .include?(exit_code)
end

#any_runners_available?Boolean

Returns:

  • (Boolean)

789
790
791
792
793
# File 'app/models/ci/build.rb', line 789

def any_runners_available?
  cache_for_available_runners do
    project.active_runners.exists?
  end
end

#any_runners_online?Boolean

Returns:

  • (Boolean)

783
784
785
786
787
# File 'app/models/ci/build.rb', line 783

def any_runners_online?
  cache_for_online_runners do
    project.any_online_runners? { |runner| runner.match_build_if_online?(self) }
  end
end

#any_unmet_prerequisites?Boolean

Returns:

  • (Boolean)

495
496
497
# File 'app/models/ci/build.rb', line 495

def any_unmet_prerequisites?
  prerequisites.present?
end

#archived?Boolean

Returns:

  • (Boolean)

447
448
449
450
451
452
# File 'app/models/ci/build.rb', line 447

def archived?
  return true if degenerated?

  archive_builds_older_than = Gitlab::CurrentSettings.current_application_settings.archive_builds_older_than
  archive_builds_older_than.present? && created_at < archive_builds_older_than
end

#artifacts?Boolean

Returns:

  • (Boolean)

698
699
700
# File 'app/models/ci/build.rb', line 698

def artifacts?
  !artifacts_expired? && artifacts_file&.exists?
end

#artifacts_expire_inObject


856
857
858
# File 'app/models/ci/build.rb', line 856

def artifacts_expire_in
  artifacts_expire_at - Time.current if artifacts_expire_at
end

#artifacts_expire_in=(value) ⇒ Object


860
861
862
863
864
865
# File 'app/models/ci/build.rb', line 860

def artifacts_expire_in=(value)
  self.artifacts_expire_at =
    if value
      ChronicDuration.parse(value)&.seconds&.from_now
    end
end

#artifacts_expired?Boolean

Returns:

  • (Boolean)

852
853
854
# File 'app/models/ci/build.rb', line 852

def artifacts_expired?
  artifacts_expire_at && artifacts_expire_at < Time.current
end

#artifacts_expose_asObject


747
748
749
# File 'app/models/ci/build.rb', line 747

def artifacts_expose_as
  options.dig(:artifacts, :expose_as)
end

#artifacts_fileObject


686
687
688
# File 'app/models/ci/build.rb', line 686

def artifacts_file
  job_artifacts_archive&.file
end

#artifacts_file_for_type(type) ⇒ Object


886
887
888
889
890
# File 'app/models/ci/build.rb', line 886

def artifacts_file_for_type(type)
  file_types = Ci::JobArtifact.associated_file_types_for(type)
  file_types_ids = file_types&.map { |file_type| Ci::JobArtifact.file_types[file_type] }
  job_artifacts.find_by(file_type: file_types_ids)&.file
end

#artifacts_metadataObject


694
695
696
# File 'app/models/ci/build.rb', line 694

def 
  &.file
end

#artifacts_metadata?Boolean

Returns:

  • (Boolean)

713
714
715
# File 'app/models/ci/build.rb', line 713

def artifacts_metadata?
  artifacts? && &.exists?
end

#artifacts_metadata_entry(path, **options) ⇒ Object


820
821
822
823
824
825
826
827
828
829
# File 'app/models/ci/build.rb', line 820

def (path, **options)
  .open do ||
     = Gitlab::Ci::Build::Artifacts::Metadata.new(
      ,
      path,
      **options)

    .to_entry
  end
end

#artifacts_pathsObject


751
752
753
# File 'app/models/ci/build.rb', line 751

def artifacts_paths
  options.dig(:artifacts, :paths)
end

#artifacts_public?Boolean

Returns:

  • (Boolean)

810
811
812
813
814
815
816
817
818
# File 'app/models/ci/build.rb', line 810

def artifacts_public?
  return true unless Feature.enabled?(:non_public_artifacts, type: :development)

  artifacts_public = options.dig(:artifacts, :public)

  return true if artifacts_public.nil? # Default artifacts:public to true

  options.dig(:artifacts, :public)
end

#artifacts_sizeObject


690
691
692
# File 'app/models/ci/build.rb', line 690

def artifacts_size
  job_artifacts_archive&.size
end

#auto_retry_allowed?Boolean

Returns:

  • (Boolean)

412
413
414
# File 'app/models/ci/build.rb', line 412

def auto_retry_allowed?
  auto_retry.allowed?
end

#auto_retry_expected?Boolean

Returns:

  • (Boolean)

416
417
418
# File 'app/models/ci/build.rb', line 416

def auto_retry_expected?
  failed? && auto_retry_allowed?
end

#available_artifacts?Boolean

This method is similar to #artifacts? but it includes the artifacts locking mechanics. A new method was created to prevent breaking existing behavior and avoid introducing N+1s.

Returns:

  • (Boolean)

709
710
711
# File 'app/models/ci/build.rb', line 709

def available_artifacts?
  (!artifacts_expired? || pipeline.artifacts_locked?) && job_artifacts_archive&.exists?
end

#browsable_artifacts?Boolean

Returns:

  • (Boolean)

806
807
808
# File 'app/models/ci/build.rb', line 806

def browsable_artifacts?
  artifacts_metadata?
end

#build_matcherObject


401
402
403
404
405
406
407
408
409
410
# File 'app/models/ci/build.rb', line 401

def build_matcher
  strong_memoize(:build_matcher) do
    Gitlab::Ci::Matching::BuildMatcher.new({
      protected: protected?,
      tag_list: tag_list,
      build_ids: [id],
      project: project
    })
  end
end

#cacheObject


906
907
908
909
910
911
912
913
914
915
916
917
918
919
# File 'app/models/ci/build.rb', line 906

def cache
  cache = Array.wrap(options[:cache])

  if project.jobs_cache_index
    cache = cache.map do |single_cache|
      single_cache.merge(key: "#{single_cache[:key]}-#{project.jobs_cache_index}")
    end
  end

  type_suffix = pipeline.protected_ref? ? 'protected' : 'non_protected'
  cache.map do |entry|
    entry.merge(key: "#{entry[:key]}-#{type_suffix}")
  end
end

#cancelable?Boolean

rubocop: enable CodeReuse/ServiceClass

Returns:

  • (Boolean)

482
483
484
# File 'app/models/ci/build.rb', line 482

def cancelable?
  active? || created?
end

#collect_accessibility_reports!(accessibility_report) ⇒ Object


999
1000
1001
1002
1003
1004
1005
# File 'app/models/ci/build.rb', line 999

def collect_accessibility_reports!(accessibility_report)
  each_report(Ci::JobArtifact::ACCESSIBILITY_REPORT_FILE_TYPES) do |file_type, blob|
    Gitlab::Ci::Parsers.fabricate!(file_type).parse!(blob, accessibility_report)
  end

  accessibility_report
end

#collect_codequality_reports!(codequality_report) ⇒ Object


1020
1021
1022
1023
1024
1025
1026
# File 'app/models/ci/build.rb', line 1020

def collect_codequality_reports!(codequality_report)
  each_report(Ci::JobArtifact::CODEQUALITY_REPORT_FILE_TYPES) do |file_type, blob|
    Gitlab::Ci::Parsers.fabricate!(file_type).parse!(blob, codequality_report)
  end

  codequality_report
end

#collect_coverage_reports!(coverage_report) ⇒ Object


1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
# File 'app/models/ci/build.rb', line 1007

def collect_coverage_reports!(coverage_report)
  each_report(Ci::JobArtifact::COVERAGE_REPORT_FILE_TYPES) do |file_type, blob|
    Gitlab::Ci::Parsers.fabricate!(file_type).parse!(
      blob,
      coverage_report,
      project_path: project.full_path,
      worktree_paths: pipeline.all_worktree_paths
    )
  end

  coverage_report
end

#collect_terraform_reports!(terraform_reports) ⇒ Object


1028
1029
1030
1031
1032
1033
1034
# File 'app/models/ci/build.rb', line 1028

def collect_terraform_reports!(terraform_reports)
  each_report(::Ci::JobArtifact::TERRAFORM_REPORT_FILE_TYPES) do |file_type, blob, report_artifact|
    ::Gitlab::Ci::Parsers.fabricate!(file_type).parse!(blob, terraform_reports, artifact: report_artifact)
  end

  terraform_reports
end

#collect_test_reports!(test_reports) ⇒ Object


987
988
989
990
991
992
993
994
995
996
997
# File 'app/models/ci/build.rb', line 987

def collect_test_reports!(test_reports)
  test_reports.get_suite(group_name).tap do |test_suite|
    each_report(Ci::JobArtifact::TEST_REPORT_FILE_TYPES) do |file_type, blob|
      Gitlab::Ci::Parsers.fabricate!(file_type).parse!(
        blob,
        test_suite,
        job: self
      )
    end
  end
end

#create_queuing_entry!Object


1103
1104
1105
# File 'app/models/ci/build.rb', line 1103

def create_queuing_entry!
  ::Ci::PendingBuild.upsert_from_build!(self)
end

#create_runtime_metadata!Object


1107
1108
1109
# File 'app/models/ci/build.rb', line 1107

def create_runtime_metadata!
  ::Ci::RunningBuild.upsert_shared_runner_build!(self)
end

#credentialsObject


921
922
923
# File 'app/models/ci/build.rb', line 921

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

#custom_contextsObject


767
768
769
# File 'app/models/ci/build.rb', line 767

def custom_contexts
  []
end

#debug_mode?Boolean

Returns:

  • (Boolean)

1088
1089
1090
1091
1092
1093
# File 'app/models/ci/build.rb', line 1088

def debug_mode?
  # TODO: Have `debug_mode?` check against data on sent back from runner
  # to capture all the ways that variables can be set.
  # See (https://gitlab.com/gitlab-org/gitlab/-/issues/290955)
  variables['CI_DEBUG_TRACE']&.value&.casecmp('true') == 0
end

#degradation_thresholdObject


1069
1070
1071
1072
# File 'app/models/ci/build.rb', line 1069

def degradation_threshold
  var = yaml_variables.find { |v| v[:key] == DEGRADATION_THRESHOLD_VARIABLE_NAME }
  var[:value]&.to_i if var
end

#dependency_proxy_variablesObject


624
625
626
627
628
629
630
631
# File 'app/models/ci/build.rb', line 624

def dependency_proxy_variables
  Gitlab::Ci::Variables::Collection.new.tap do |variables|
    break variables unless Gitlab.config.dependency_proxy.enabled

    variables.append(key: 'CI_DEPENDENCY_PROXY_USER', value: ::Gitlab::Auth::CI_JOB_USER)
    variables.append(key: 'CI_DEPENDENCY_PROXY_PASSWORD', value: token.to_s, public: false, masked: true)
  end
end

#deploy_token_variablesObject


615
616
617
618
619
620
621
622
# File 'app/models/ci/build.rb', line 615

def deploy_token_variables
  Gitlab::Ci::Variables::Collection.new.tap do |variables|
    break variables unless gitlab_deploy_token

    variables.append(key: 'CI_DEPLOY_USER', value: gitlab_deploy_token.username)
    variables.append(key: 'CI_DEPLOY_PASSWORD', value: gitlab_deploy_token.token, public: false, masked: true)
  end
end

#deployment_statusObject

Virtual deployment status depending on the environment status.


1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
# File 'app/models/ci/build.rb', line 1041

def deployment_status
  return unless starts_environment?

  if success?
    return successful_deployment_status
  elsif failed?
    return :failed
  end

  :creating
end

#detailed_status(current_user) ⇒ Object


420
421
422
423
424
# File 'app/models/ci/build.rb', line 420

def detailed_status(current_user)
  Gitlab::Ci::Status::Build::Factory
    .new(self.present, current_user)
    .fabricate!
end

#doom!Object

Consider this object to have a structural integrity problems


1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
# File 'app/models/ci/build.rb', line 1054

def doom!
  transaction do
    update_columns(status: :failed, failure_reason: :data_integrity_failure)
    all_queuing_entries.delete_all
    .delete_all
  end

  Gitlab::AppLogger.info(
    message: 'Build doomed',
    class: self.class.name,
    build_id: id,
    pipeline_id: pipeline_id,
    project_id: project_id)
end

#drop_with_exit_code!(failure_reason, exit_code) ⇒ Object


1095
1096
1097
# File 'app/models/ci/build.rb', line 1095

def drop_with_exit_code!(failure_reason, exit_code)
  drop!(::Gitlab::Ci::Build::Status::Reason.new(self, failure_reason, exit_code))
end

#ensure_trace_metadata!Object


743
744
745
# File 'app/models/ci/build.rb', line 743

def ensure_trace_metadata!
  Ci::BuildTraceMetadata.find_or_upsert_for!(id)
end

#environment_actionObject


545
546
547
# File 'app/models/ci/build.rb', line 545

def environment_action
  self.options.fetch(:environment, {}).fetch(:action, 'start') if self.options
end

#environment_deployment_tierObject


549
550
551
# File 'app/models/ci/build.rb', line 549

def environment_deployment_tier
  self.options.dig(:environment, :deployment_tier) if self.options
end

#erasable?Boolean

Returns:

  • (Boolean)

844
845
846
# File 'app/models/ci/build.rb', line 844

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

#erase(opts = {}) ⇒ Object


836
837
838
839
840
841
842
# File 'app/models/ci/build.rb', line 836

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

  job_artifacts.destroy_all # rubocop: disable Cop/DestroyAll
  erase_trace!
  update_erased!(opts[:erased_by])
end

#erase_erasable_artifacts!Object

and use that for `ExpireBuildInstanceArtifactsWorker`?


832
833
834
# File 'app/models/ci/build.rb', line 832

def erase_erasable_artifacts!
  job_artifacts.erasable.destroy_all # rubocop: disable Cop/DestroyAll
end

#erase_old_trace!Object


737
738
739
740
741
# File 'app/models/ci/build.rb', line 737

def erase_old_trace!
  return unless has_old_trace?

  update_column(:trace, nil)
end

#erased?Boolean

Returns:

  • (Boolean)

848
849
850
# File 'app/models/ci/build.rb', line 848

def erased?
  !self.erased_at.nil?
end

#execute_hooksObject


799
800
801
802
803
804
# File 'app/models/ci/build.rb', line 799

def execute_hooks
  return unless project

  project.execute_hooks(build_data.dup, :job_hooks) if project.has_active_hooks?(:job_hooks)
  project.execute_integrations(build_data.dup, :job_hooks) if project.has_active_integrations?(:job_hooks)
end

#exit_codes_defined?Boolean

Returns:

  • (Boolean)

1099
1100
1101
# File 'app/models/ci/build.rb', line 1099

def exit_codes_defined?
  options.dig(:allow_failure_criteria, :exit_codes).present?
end

#expanded_environment_nameObject


503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
# File 'app/models/ci/build.rb', line 503

def expanded_environment_name
  return unless has_environment?

  strong_memoize(:expanded_environment_name) do
    # We're using a persisted expanded environment name in order to avoid
    # variable expansion per request.
    if &.expanded_environment_name.present?
      .expanded_environment_name
    else
      if ::Feature.enabled?(:ci_expand_environment_name_and_url, project)
        ExpandVariables.expand(environment, -> { simple_variables.sort_and_expand_all })
      else
        ExpandVariables.expand(environment, -> { simple_variables })
      end
    end
  end
end

#expanded_kubernetes_namespaceObject


521
522
523
524
525
526
527
528
529
530
531
# File 'app/models/ci/build.rb', line 521

def expanded_kubernetes_namespace
  return unless has_environment?

  namespace = options.dig(:environment, :kubernetes, :namespace)

  if namespace.present?
    strong_memoize(:expanded_kubernetes_namespace) do
      ExpandVariables.expand(namespace, -> { simple_variables })
    end
  end
end

#featuresObject


639
640
641
642
643
644
# File 'app/models/ci/build.rb', line 639

def features
  {
    trace_sections: true,
    failure_reasons: self.class.failure_reasons.keys
  }
end

#harbor_variablesObject


633
634
635
636
637
# File 'app/models/ci/build.rb', line 633

def harbor_variables
  return [] unless harbor_integration.try(:activated?)

  Gitlab::Ci::Variables::Collection.new(harbor_integration.ci_variables)
end

#has_archived_trace?Boolean

Returns:

  • (Boolean)

682
683
684
# File 'app/models/ci/build.rb', line 682

def has_archived_trace?
  trace.archived_trace_exist?
end

#has_environment?Boolean

Returns:

  • (Boolean)

533
534
535
# File 'app/models/ci/build.rb', line 533

def has_environment?
  environment.present?
end

#has_expired_locked_archive_artifacts?Boolean

Returns:

  • (Boolean)

867
868
869
870
# File 'app/models/ci/build.rb', line 867

def has_expired_locked_archive_artifacts?
  locked_artifacts? &&
    artifacts_expire_at.present? && artifacts_expire_at < Time.current
end

#has_expiring_archive_artifacts?Boolean

Returns:

  • (Boolean)

872
873
874
# File 'app/models/ci/build.rb', line 872

def has_expiring_archive_artifacts?
  has_expiring_artifacts? && job_artifacts_archive.present?
end

#has_job_artifacts?Boolean

Returns:

  • (Boolean)

717
718
719
# File 'app/models/ci/build.rb', line 717

def has_job_artifacts?
  job_artifacts.any?
end

#has_live_trace?Boolean

Returns:

  • (Boolean)

678
679
680
# File 'app/models/ci/build.rb', line 678

def has_live_trace?
  trace.live_trace_exist?
end

#has_old_trace?Boolean

Returns:

  • (Boolean)

725
726
727
# File 'app/models/ci/build.rb', line 725

def has_old_trace?
  old_trace.present?
end

#has_tags?Boolean

Returns:

  • (Boolean)

779
780
781
# File 'app/models/ci/build.rb', line 779

def has_tags?
  tag_list.any?
end

#has_terminal?Boolean

Returns:

  • (Boolean)

983
984
985
# File 'app/models/ci/build.rb', line 983

def has_terminal?
  running? && runner_session_url.present?
end

#has_test_reports?Boolean

Returns:

  • (Boolean)

721
722
723
# File 'app/models/ci/build.rb', line 721

def has_test_reports?
  job_artifacts.test_reports.exists?
end

#has_trace?Boolean

Returns:

  • (Boolean)

674
675
676
# File 'app/models/ci/build.rb', line 674

def has_trace?
  trace.exist?
end

#has_valid_build_dependencies?Boolean

Returns:

  • (Boolean)

925
926
927
# File 'app/models/ci/build.rb', line 925

def has_valid_build_dependencies?
  dependencies.valid?
end

#hide_secrets(data, metrics = ::Gitlab::Ci::Trace::Metrics.new) ⇒ Object


966
967
968
969
970
971
972
973
974
975
976
977
# File 'app/models/ci/build.rb', line 966

def hide_secrets(data, metrics = ::Gitlab::Ci::Trace::Metrics.new)
  return unless trace

  data.dup.tap do |trace|
    Gitlab::Ci::MaskSecret.mask!(trace, project.runners_token) if project
    Gitlab::Ci::MaskSecret.mask!(trace, token) if token

    if trace != data
      metrics.increment_trace_operation(operation: :mutated)
    end
  end
end

#imageObject


898
899
900
# File 'app/models/ci/build.rb', line 898

def image
  Gitlab::Ci::Build::Image.from_image(self)
end

#invalid_dependenciesObject


929
930
931
# File 'app/models/ci/build.rb', line 929

def invalid_dependencies
  dependencies.invalid_local
end

#job_variables_attributesObject


1129
1130
1131
1132
1133
1134
1135
1136
1137
# File 'app/models/ci/build.rb', line 1129

def job_variables_attributes
  strong_memoize(:job_variables_attributes) do
    job_variables.internal_source.map do |variable|
      variable.attributes.except('id', 'job_id', 'encrypted_value', 'encrypted_value_iv').tap do |attrs|
        attrs[:value] = variable.value
      end
    end
  end
end

#keep_artifacts!Object


881
882
883
884
# File 'app/models/ci/build.rb', line 881

def keep_artifacts!
  self.update(artifacts_expire_at: nil)
  self.job_artifacts.update_all(expire_at: nil)
end

#locked_artifacts?Boolean

Returns:

  • (Boolean)

702
703
704
# File 'app/models/ci/build.rb', line 702

def locked_artifacts?
  pipeline.artifacts_locked? && artifacts_file&.exists?
end

#max_test_cases_per_reportObject


1082
1083
1084
1085
1086
# File 'app/models/ci/build.rb', line 1082

def max_test_cases_per_report
  # NOTE: This is temporary and will be replaced later by a value
  # that would come from an actual application limit.
  ::Gitlab.com? ? 500_000 : 0
end

#merge_requestObject


646
647
648
649
650
# File 'app/models/ci/build.rb', line 646

def merge_request
  strong_memoize(:merge_request) do
    pipeline.all_merge_requests.order(iid: :asc).first
  end
end

#multi_build_steps?Boolean

Returns:

  • (Boolean)

962
963
964
# File 'app/models/ci/build.rb', line 962

def multi_build_steps?
  options.dig(:release)&.any?
end

#needs_touch?Boolean

Returns:

  • (Boolean)

755
756
757
# File 'app/models/ci/build.rb', line 755

def needs_touch?
  Time.current - updated_at > 15.minutes.to_i
end

#old_traceObject


733
734
735
# File 'app/models/ci/build.rb', line 733

def old_trace
  read_attribute(:trace)
end

#on_stopObject


561
562
563
# File 'app/models/ci/build.rb', line 561

def on_stop
  options&.dig(:environment, :on_stop)
end

#options_scheduled_atObject


466
467
468
# File 'app/models/ci/build.rb', line 466

def options_scheduled_at
  ChronicDuration.parse(options[:start_in])&.seconds&.from_now
end

#other_manual_actionsObject


426
427
428
# File 'app/models/ci/build.rb', line 426

def other_manual_actions
  pipeline.manual_actions.reject { |action| action.name == self.name }
end

#other_scheduled_actionsObject


430
431
432
# File 'app/models/ci/build.rb', line 430

def other_scheduled_actions
  pipeline.scheduled_actions.reject { |action| action.name == self.name }
end

#outdated_deployment?Boolean

Returns:

  • (Boolean)

553
554
555
# File 'app/models/ci/build.rb', line 553

def outdated_deployment?
  success? && !deployment.try(:last?)
end

#pages_generator?Boolean

Returns:

  • (Boolean)

434
435
436
437
# File 'app/models/ci/build.rb', line 434

def pages_generator?
  Gitlab.config.pages.enabled &&
    self.name == 'pages'
end

#persisted_environmentObject

Since Gitlab 11.5, deployments records started being created right after `ci_builds` creation. We can look up a relevant `environment` through `deployment` relation today. (See more gitlab.com/gitlab-org/gitlab-foss/merge_requests/22380)

Since Gitlab 12.9, we started persisting the expanded environment name to avoid repeated variables expansion in `action: stop` builds as well.


87
88
89
90
91
92
93
94
95
96
97
98
99
100
# File 'app/models/ci/build.rb', line 87

def persisted_environment
  return unless has_environment?

  strong_memoize(:persisted_environment) do
    # This code path has caused N+1s in the past, since environments are only indirectly
    # associated to builds and pipelines; see https://gitlab.com/gitlab-org/gitlab/-/issues/326445
    # We therefore batch-load them to prevent dormant N+1s until we found a proper solution.
    BatchLoader.for(expanded_environment_name).batch(key: project_id) do |names, loader, args|
      Environment.where(name: names, project: args[:key]).find_each do |environment|
        loader.call(environment.name, environment)
      end
    end
  end
end

#persisted_environment=(environment) ⇒ Object


102
103
104
# File 'app/models/ci/build.rb', line 102

def persisted_environment=(environment)
  strong_memoize(:persisted_environment) { environment }
end

#persisted_environment_variablesObject


600
601
602
603
604
605
606
607
608
609
610
611
612
613
# File 'app/models/ci/build.rb', line 600

def persisted_environment_variables
  Gitlab::Ci::Variables::Collection.new.tap do |variables|
    break variables unless persisted? && persisted_environment.present?

    variables.concat(persisted_environment.predefined_variables)

    variables.append(key: 'CI_ENVIRONMENT_ACTION', value: environment_action)

    # 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.
    variables.append(key: 'CI_ENVIRONMENT_URL', value: environment_url) if environment_url
  end
end

#persisted_variablesObject


580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
# File 'app/models/ci/build.rb', line 580

def persisted_variables
  Gitlab::Ci::Variables::Collection.new.tap do |variables|
    break variables unless persisted?

    variables
      .concat(pipeline.persisted_variables)
      .append(key: 'CI_JOB_ID', value: id.to_s)
      .append(key: 'CI_JOB_URL', value: Gitlab::Routing.url_helpers.project_job_url(project, self))
      .append(key: 'CI_JOB_TOKEN', value: token.to_s, public: false, masked: true)
      .append(key: 'CI_JOB_STARTED_AT', value: started_at&.iso8601)
      .append(key: 'CI_BUILD_ID', value: id.to_s)
      .append(key: 'CI_BUILD_TOKEN', value: token.to_s, public: false, masked: true)
      .append(key: 'CI_REGISTRY_USER', value: ::Gitlab::Auth::CI_JOB_USER)
      .append(key: 'CI_REGISTRY_PASSWORD', value: token.to_s, public: false, masked: true)
      .append(key: 'CI_REPOSITORY_URL', value: repo_url.to_s, public: false)
      .concat(deploy_token_variables)
      .concat(harbor_variables)
  end
end

#play(current_user, job_variables_attributes = nil) ⇒ Object

rubocop: disable CodeReuse/ServiceClass


475
476
477
478
479
# File 'app/models/ci/build.rb', line 475

def play(current_user, job_variables_attributes = nil)
  Ci::PlayBuildService
    .new(project, current_user)
    .execute(self, job_variables_attributes)
end

#playable?Boolean

Returns:

  • (Boolean)

454
455
456
# File 'app/models/ci/build.rb', line 454

def playable?
  action? && !archived? && (manual? || scheduled? || retryable?) && !waiting_for_deployment_approval?
end

#prerequisitesObject


499
500
501
# File 'app/models/ci/build.rb', line 499

def prerequisites
  Gitlab::Ci::Build::Prerequisite::Factory.new(self).unmet
end

#publishes_artifacts_reports?Boolean

Returns:

  • (Boolean)

954
955
956
# File 'app/models/ci/build.rb', line 954

def publishes_artifacts_reports?
  options&.dig(:artifacts, :reports)&.any?
end

#remove_pending_state!Object


1074
1075
1076
# File 'app/models/ci/build.rb', line 1074

def remove_pending_state!
  pending_state.try(:delete)
end

#repo_urlObject


652
653
654
655
656
657
658
659
# File 'app/models/ci/build.rb', line 652

def repo_url
  return unless token

  auth = "#{::Gitlab::Auth::CI_JOB_USER}:#{token}@"
  project.http_url_to_repo.sub(%r{^https?://}) do |prefix|
    prefix + auth
  end
end

#report_artifactsObject


1036
1037
1038
# File 'app/models/ci/build.rb', line 1036

def report_artifacts
  job_artifacts.with_reports
end

#retries_countObject


486
487
488
# File 'app/models/ci/build.rb', line 486

def retries_count
  pipeline.builds.retried.where(name: self.name).count
end

#run_on_status_commit(&block) ⇒ Object


1078
1079
1080
# File 'app/models/ci/build.rb', line 1078

def run_on_status_commit(&block)
  status_commit_hooks.push(block)
end

#runnable?Boolean

Returns:

  • (Boolean)

439
440
441
# File 'app/models/ci/build.rb', line 439

def runnable?
  true
end

#runner_required_feature_namesObject


940
941
942
943
944
945
946
# File 'app/models/ci/build.rb', line 940

def runner_required_feature_names
  strong_memoize(:runner_required_feature_names) do
    RUNNER_FEATURES.select do |feature, method|
      method.call(self)
    end.keys
  end
end

#save_tagsObject


443
444
445
# File 'app/models/ci/build.rb', line 443

def save_tags
  super unless Thread.current['ci_bulk_insert_tags']
end

#schedulable?Boolean

Returns:

  • (Boolean)

462
463
464
# File 'app/models/ci/build.rb', line 462

def schedulable?
  self.when == 'delayed' && options[:start_in].present?
end

#serializable_hash(options = {}) ⇒ Object


979
980
981
# File 'app/models/ci/build.rb', line 979

def serializable_hash(options = {})
  super(options).merge(when: read_attribute(:when))
end

#servicesObject


902
903
904
# File 'app/models/ci/build.rb', line 902

def services
  Gitlab::Ci::Build::Image.from_services(self)
end

#shared_runner_build?Boolean

Returns:

  • (Boolean)

1125
1126
1127
# File 'app/models/ci/build.rb', line 1125

def shared_runner_build?
  runner&.instance_type?
end

#starts_environment?Boolean

Returns:

  • (Boolean)

537
538
539
# File 'app/models/ci/build.rb', line 537

def starts_environment?
  has_environment? && self.environment_action == 'start'
end

#stepsObject


892
893
894
895
896
# File 'app/models/ci/build.rb', line 892

def steps
  [Gitlab::Ci::Build::Step.from_commands(self),
   Gitlab::Ci::Build::Step.from_release(self),
   Gitlab::Ci::Build::Step.from_after_script(self)].compact
end

#stops_environment?Boolean

Returns:

  • (Boolean)

541
542
543
# File 'app/models/ci/build.rb', line 541

def stops_environment?
  has_environment? && self.environment_action == 'stop'
end

#stuck?Boolean

Returns:

  • (Boolean)

795
796
797
# File 'app/models/ci/build.rb', line 795

def stuck?
  pending? && !any_runners_online?
end

#supported_runner?(features) ⇒ Boolean

Returns:

  • (Boolean)

948
949
950
951
952
# File 'app/models/ci/build.rb', line 948

def supported_runner?(features)
  runner_required_feature_names.all? do |feature_name|
    features&.dig(feature_name)
  end
end

#supports_artifacts_exclude?Boolean

Returns:

  • (Boolean)

958
959
960
# File 'app/models/ci/build.rb', line 958

def supports_artifacts_exclude?
  options&.dig(:artifacts, :exclude)&.any?
end

#tag_listObject


771
772
773
774
775
776
777
# File 'app/models/ci/build.rb', line 771

def tag_list
  if tags.loaded?
    tags.map(&:name)
  else
    super
  end
end

#traceObject


670
671
672
# File 'app/models/ci/build.rb', line 670

def trace
  Gitlab::Ci::Trace.new(self)
end

#trace=(data) ⇒ Object

Raises:

  • (NotImplementedError)

729
730
731
# File 'app/models/ci/build.rb', line 729

def trace=(data)
  raise NotImplementedError
end

#track_deployment_usageObject


1146
1147
1148
# File 'app/models/ci/build.rb', line 1146

def track_deployment_usage
  Gitlab::Utils::UsageData.track_usage_event('ci_users_executing_deployment_job', user_id) if user_id.present? && count_user_deployment?
end

#triggered_by?(current_user) ⇒ Boolean

Returns:

  • (Boolean)

557
558
559
# File 'app/models/ci/build.rb', line 557

def triggered_by?(current_user)
  user == current_user
end

#update_coverageObject


665
666
667
668
# File 'app/models/ci/build.rb', line 665

def update_coverage
  coverage = trace.extract_coverage(coverage_regex)
  update(coverage: coverage) if coverage.present?
end

#valid_dependency?Boolean

Returns:

  • (Boolean)

933
934
935
936
937
938
# File 'app/models/ci/build.rb', line 933

def valid_dependency?
  return false if artifacts_expired? && !pipeline.artifacts_locked?
  return false if erased?

  true
end

#valid_token?(token) ⇒ Boolean

Returns:

  • (Boolean)

759
760
761
# File 'app/models/ci/build.rb', line 759

def valid_token?(token)
  self.token && ActiveSupport::SecurityUtils.secure_compare(token, self.token)
end

#variablesObject

All variables, including persisted environment variables.


568
569
570
571
572
573
574
575
576
577
578
# File 'app/models/ci/build.rb', line 568

def variables
  strong_memoize(:variables) do
    Gitlab::Ci::Variables::Collection.new
      .concat(persisted_variables)
      .concat(dependency_proxy_variables)
      .concat(job_jwt_variables)
      .concat(scoped_variables)
      .concat(job_variables)
      .concat(persisted_environment_variables)
  end
end

#waiting_for_deployment_approval?Boolean

Returns:

  • (Boolean)

458
459
460
# File 'app/models/ci/build.rb', line 458

def waiting_for_deployment_approval?
  manual? && starts_environment? && deployment&.blocked?
end