107 lines
3.8 KiB
Ruby
107 lines
3.8 KiB
Ruby
# frozen_string_literal: true
|
|
|
|
module Ci
|
|
##
|
|
# This module implements methods that provide context in form of
|
|
# essential CI/CD variables that can be used by a build / bridge job.
|
|
#
|
|
module Contextable
|
|
##
|
|
# Variables in the environment name scope.
|
|
#
|
|
def scoped_variables(environment: expanded_environment_name, dependencies: true)
|
|
Gitlab::Ci::Variables::Collection.new.tap do |variables|
|
|
variables.concat(predefined_variables)
|
|
variables.concat(project.predefined_variables)
|
|
variables.concat(pipeline.predefined_variables)
|
|
variables.concat(runner.predefined_variables) if runnable? && runner
|
|
variables.concat(deployment_variables(environment: environment))
|
|
variables.concat(yaml_variables)
|
|
variables.concat(user_variables)
|
|
variables.concat(dependency_variables) if dependencies
|
|
variables.concat(secret_instance_variables)
|
|
variables.concat(secret_group_variables(environment: environment))
|
|
variables.concat(secret_project_variables(environment: environment))
|
|
variables.concat(trigger_request.user_variables) if trigger_request
|
|
variables.concat(pipeline.variables)
|
|
variables.concat(pipeline.pipeline_schedule.job_variables) if pipeline.pipeline_schedule
|
|
end
|
|
end
|
|
|
|
##
|
|
# Variables that do not depend on the environment name.
|
|
#
|
|
def simple_variables
|
|
strong_memoize(:simple_variables) do
|
|
scoped_variables(environment: nil).to_runner_variables
|
|
end
|
|
end
|
|
|
|
def simple_variables_without_dependencies
|
|
strong_memoize(:variables_without_dependencies) do
|
|
scoped_variables(environment: nil, dependencies: false).to_runner_variables
|
|
end
|
|
end
|
|
|
|
def user_variables
|
|
Gitlab::Ci::Variables::Collection.new.tap do |variables|
|
|
break variables if user.blank?
|
|
|
|
variables.append(key: 'GITLAB_USER_ID', value: user.id.to_s)
|
|
variables.append(key: 'GITLAB_USER_EMAIL', value: user.email)
|
|
variables.append(key: 'GITLAB_USER_LOGIN', value: user.username)
|
|
variables.append(key: 'GITLAB_USER_NAME', value: user.name)
|
|
end
|
|
end
|
|
|
|
def predefined_variables
|
|
Gitlab::Ci::Variables::Collection.new.tap do |variables|
|
|
variables.append(key: 'CI_JOB_NAME', value: name)
|
|
variables.append(key: 'CI_JOB_STAGE', value: stage)
|
|
variables.append(key: 'CI_JOB_MANUAL', value: 'true') if action?
|
|
variables.append(key: 'CI_PIPELINE_TRIGGERED', value: 'true') if trigger_request
|
|
|
|
variables.append(key: 'CI_NODE_INDEX', value: self.options[:instance].to_s) if self.options&.include?(:instance)
|
|
variables.append(key: 'CI_NODE_TOTAL', value: ci_node_total_value.to_s)
|
|
|
|
# legacy variables
|
|
variables.append(key: 'CI_BUILD_NAME', value: name)
|
|
variables.append(key: 'CI_BUILD_STAGE', value: stage)
|
|
variables.append(key: 'CI_BUILD_TRIGGERED', value: 'true') if trigger_request
|
|
variables.append(key: 'CI_BUILD_MANUAL', value: 'true') if action?
|
|
end
|
|
end
|
|
|
|
def deployment_variables(environment:)
|
|
return [] unless environment
|
|
|
|
project.deployment_variables(
|
|
environment: environment,
|
|
kubernetes_namespace: expanded_kubernetes_namespace
|
|
)
|
|
end
|
|
|
|
def secret_instance_variables
|
|
project.ci_instance_variables_for(ref: git_ref)
|
|
end
|
|
|
|
def secret_group_variables(environment: expanded_environment_name)
|
|
return [] unless project.group
|
|
|
|
project.group.ci_variables_for(git_ref, project, environment: environment)
|
|
end
|
|
|
|
def secret_project_variables(environment: expanded_environment_name)
|
|
project.ci_variables_for(ref: git_ref, environment: environment)
|
|
end
|
|
|
|
private
|
|
|
|
def ci_node_total_value
|
|
parallel = self.options&.dig(:parallel)
|
|
parallel = parallel.dig(:total) if parallel.is_a?(Hash)
|
|
parallel || 1
|
|
end
|
|
end
|
|
end
|