Module: Gitlab::QA::Runtime::Env

Extended by:
Env
Included in:
Env
Defined in:
lib/gitlab/qa/runtime/env.rb

Constant Summary collapse

ENV_VARIABLES =

Variables that are used in tests and are passed through to the docker container that executes the tests. These variables should be listed in /docs/what_tests_can_be_run.md#supported-gitlab-environment-variables unless they’re defined elsewhere (e.g.: docs.gitlab.com/ee/ci/variables/predefined_variables.html)

{
  'QA_IMAGE' => :qa_image,
  'QA_REMOTE_GRID' => :remote_grid,
  'QA_REMOTE_GRID_USERNAME' => :remote_grid_username,
  'QA_REMOTE_GRID_ACCESS_KEY' => :remote_grid_access_key,
  'QA_REMOTE_GRID_PROTOCOL' => :remote_grid_protocol,
  'QA_BROWSER' => :browser,
  'QA_ADDITIONAL_REPOSITORY_STORAGE' => :qa_additional_repository_storage,
  'QA_PRAEFECT_REPOSITORY_STORAGE' => :qa_praefect_repository_storage,
  'QA_GITALY_NON_CLUSTER_STORAGE' => :qa_gitaly_non_cluster_storage,
  'QA_COOKIES' => :qa_cookie,
  'QA_DEBUG' => :qa_debug,
  'QA_DEFAULT_BRANCH' => :qa_default_branch,
  'QA_LOG_PATH' => :qa_log_path,
  'QA_CAN_TEST_ADMIN_FEATURES' => :qa_can_test_admin_features,
  'QA_CAN_TEST_GIT_PROTOCOL_V2' => :qa_can_test_git_protocol_v2,
  'QA_CAN_TEST_PRAEFECT' => :qa_can_test_praefect,
  'QA_DISABLE_RSPEC_RETRY' => :qa_disable_rspec_retry,
  'QA_SIMULATE_SLOW_CONNECTION' => :qa_simulate_slow_connection,
  'QA_SLOW_CONNECTION_LATENCY_MS' => :qa_slow_connection_latency_ms,
  'QA_SLOW_CONNECTION_THROUGHPUT_KBPS' => :qa_slow_connection_throughput_kbps,
  'QA_GENERATE_ALLURE_REPORT' => :generate_allure_report,
  'QA_EXPORT_TEST_METRICS' => :qa_export_test_metrics,
  'QA_INFLUXDB_URL' => :qa_influxdb_url,
  'QA_INFLUXDB_TOKEN' => :qa_influxdb_token,
  'QA_RUN_TYPE' => :qa_run_type,
  'QA_SKIP_PULL' => :qa_skip_pull,
  'GITLAB_API_BASE' => :api_base,
  'GITLAB_ADMIN_USERNAME' => :admin_username,
  'GITLAB_ADMIN_PASSWORD' => :admin_password,
  'GITLAB_USERNAME' => :user_username,
  'GITLAB_PASSWORD' => :user_password,
  'GITLAB_LDAP_USERNAME' => :ldap_username,
  'GITLAB_LDAP_PASSWORD' => :ldap_password,
  'GITLAB_FORKER_USERNAME' => :forker_username,
  'GITLAB_FORKER_PASSWORD' => :forker_password,
  'GITLAB_USER_TYPE' => :user_type,
  'GITLAB_SANDBOX_NAME' => :gitlab_sandbox_name,
  'GITLAB_QA_ACCESS_TOKEN' => :qa_access_token,
  'GITLAB_QA_ADMIN_ACCESS_TOKEN' => :qa_admin_access_token,
  'GITHUB_ACCESS_TOKEN' => :github_access_token,
  'GITLAB_URL' => :gitlab_url,
  'SIMPLE_SAML_HOSTNAME' => :simple_saml_hostname,
  'SIMPLE_SAML_FINGERPRINT' => :simple_saml_fingerprint,
  'ACCEPT_INSECURE_CERTS' => :accept_insecure_certs,
  'EE_LICENSE' => :ee_license,
  'GCLOUD_ACCOUNT_EMAIL' => :gcloud_account_email,
  'GCLOUD_ACCOUNT_KEY' => :gcloud_account_key,
  'CLOUDSDK_CORE_PROJECT' => :cloudsdk_core_project,
  'GCLOUD_REGION' => :gcloud_region,
  'SIGNUP_DISABLED' => :signup_disabled,
  'GITLAB_QA_USERNAME_1' => :gitlab_qa_username_1,
  'GITLAB_QA_PASSWORD_1' => :gitlab_qa_password_1,
  'GITLAB_QA_USERNAME_2' => :gitlab_qa_username_2,
  'GITLAB_QA_PASSWORD_2' => :gitlab_qa_password_2,
  'GITHUB_USERNAME' => :github_username,
  'GITHUB_PASSWORD' => :github_password,
  'KNAPSACK_GENERATE_REPORT' => :knapsack_generate_report,
  'KNAPSACK_REPORT_PATH' => :knapsack_report_path,
  'KNAPSACK_TEST_FILE_PATTERN' => :knapsack_test_file_pattern,
  'KNAPSACK_TEST_DIR' => :knapsack_test_dir,
  'CI' => :ci,
  'CI_JOB_NAME' => :ci_job_name,
  'CI_JOB_URL' => :ci_job_url,
  'CI_RUNNER_ID' => :ci_runner_id,
  'CI_SERVER_HOST' => :ci_server_host,
  'CI_SERVER_PERSONAL_ACCESS_TOKEN' => :ci_server_personal_access_token,
  'CI_NODE_INDEX' => :ci_node_index,
  'CI_NODE_TOTAL' => :ci_node_total,
  'CI_PROJECT_NAME' => :ci_project_name,
  'CI_SLACK_WEBHOOK_URL' => :ci_slack_webhook_url,
  'CI_PIPELINE_CREATED_AT' => :ci_pipeline_created_at,
  'CI_MERGE_REQUEST_IID' => :ci_merge_request_iid,
  'GITLAB_CI' => :gitlab_ci,
  'ELASTIC_URL' => :elastic_url,
  'GITLAB_QA_LOOP_RUNNER_MINUTES' => :gitlab_qa_loop_runner_minutes,
  'MAILHOG_HOSTNAME' => :mailhog_hostname,
  'SLACK_QA_CHANNEL' => :slack_qa_channel,
  'SLACK_ICON_EMOJI' => :slack_icon_emoji,
  'GITLAB_QA_FORMLESS_LOGIN_TOKEN' => :gitlab_qa_formless_login_token,
  'GEO_MAX_FILE_REPLICATION_TIME' => :geo_max_file_replication_time,
  'GEO_MAX_DB_REPLICATION_TIME' => :geo_max_db_replication_time,
  'JIRA_HOSTNAME' => :jira_hostname,
  'JIRA_ADMIN_USERNAME' => :jira_admin_username,
  'JIRA_ADMIN_PASSWORD' => :jira_admin_password,
  'CACHE_NAMESPACE_NAME' => :cache_namespace_name,
  'DEPLOY_VERSION' => :deploy_version,
  'GITLAB_QA_USER_AGENT' => :gitlab_qa_user_agent,
  'GEO_FAILOVER' => :geo_failover,
  'GITLAB_INITIAL_ROOT_PASSWORD' => :initial_root_password,
  'GITLAB_TLS_CERTIFICATE' => :gitlab_tls_certificate,
  'AWS_S3_REGION' => :aws_s3_region,
  'AWS_S3_KEY_ID' => :aws_s3_key_id,
  'AWS_S3_ACCESS_KEY' => :aws_s3_access_key,
  'AWS_S3_BUCKET_NAME' => :aws_s3_bucket_name,
  'TOP_UPSTREAM_MERGE_REQUEST_IID' => :top_upstream_merge_request_iid
}.freeze

Instance Method Summary collapse

Instance Method Details

#aws_s3_access_key ⇒ Object 



233
234
235
 
# File 'lib/gitlab/qa/runtime/env.rb', line 233

def aws_s3_access_key
  ENV['AWS_S3_ACCESS_KEY']
end

#aws_s3_bucket_name ⇒ Object 



237
238
239
 
# File 'lib/gitlab/qa/runtime/env.rb', line 237

def aws_s3_bucket_name
  ENV['AWS_S3_BUCKET_NAME']
end

#aws_s3_key_id ⇒ Object 



229
230
231
 
# File 'lib/gitlab/qa/runtime/env.rb', line 229

def aws_s3_key_id
  ENV['AWS_S3_KEY_ID']
end

#aws_s3_region ⇒ Object 



225
226
227
 
# File 'lib/gitlab/qa/runtime/env.rb', line 225

def aws_s3_region
  ENV['AWS_S3_REGION']
end

#ci_api_v4_url ⇒ Object 



145
146
147
 
# File 'lib/gitlab/qa/runtime/env.rb', line 145

def ci_api_v4_url
  ENV['CI_API_V4_URL']
end

#ci_commit_ref_name ⇒ Object 



173
174
175
 
# File 'lib/gitlab/qa/runtime/env.rb', line 173

def ci_commit_ref_name
  ENV['CI_COMMIT_REF_NAME']
end

#ci_job_name ⇒ Object 



149
150
151
 
# File 'lib/gitlab/qa/runtime/env.rb', line 149

def ci_job_name
  ENV['CI_JOB_NAME']
end

#ci_job_token ⇒ Object 



153
154
155
 
# File 'lib/gitlab/qa/runtime/env.rb', line 153

def ci_job_token
  ENV['CI_JOB_TOKEN']
end

#ci_pipeline_id ⇒ Object 



165
166
167
 
# File 'lib/gitlab/qa/runtime/env.rb', line 165

def ci_pipeline_id
  ENV['CI_PIPELINE_ID']
end

#ci_pipeline_source ⇒ Object 



157
158
159
 
# File 'lib/gitlab/qa/runtime/env.rb', line 157

def ci_pipeline_source
  ENV['CI_PIPELINE_SOURCE']
end

#ci_pipeline_url ⇒ Object 



161
162
163
 
# File 'lib/gitlab/qa/runtime/env.rb', line 161

def ci_pipeline_url
  ENV['CI_PIPELINE_URL']
end

#ci_project_id ⇒ Object 



169
170
171
 
# File 'lib/gitlab/qa/runtime/env.rb', line 169

def ci_project_id
  ENV['CI_PROJECT_ID']
end

#default_branch ⇒ Object 



121
122
123
 
# File 'lib/gitlab/qa/runtime/env.rb', line 121

def default_branch
  ENV['QA_DEFAULT_BRANCH'] || 'main'
end

#deploy_environment ⇒ Object 



213
214
215
 
# File 'lib/gitlab/qa/runtime/env.rb', line 213

def deploy_environment
  ENV['DEPLOY_ENVIRONMENT'] || pipeline_from_project_name
end

#dev_access_token_variable ⇒ Object 



193
194
195
 
# File 'lib/gitlab/qa/runtime/env.rb', line 193

def dev_access_token_variable
  env_value_if_defined('GITLAB_QA_DEV_ACCESS_TOKEN')
end

#elastic_version ⇒ Object 



221
222
223
 
# File 'lib/gitlab/qa/runtime/env.rb', line 221

def elastic_version
  ENV['ELASTIC_VERSION'] || '6.4.2'.freeze
end

#geo_failover? ⇒ Boolean

Returns:

  • (Boolean) 


325
326
327
 
# File 'lib/gitlab/qa/runtime/env.rb', line 325

def geo_failover?
  enabled?(ENV['GEO_FAILOVER'], default: false)
end

#gitlab_api_base ⇒ Object 



137
138
139
 
# File 'lib/gitlab/qa/runtime/env.rb', line 137

def gitlab_api_base
  ENV['GITLAB_API_BASE'] || 'https://gitlab.com/api/v4'
end

#gitlab_availability_timeout ⇒ Object 



125
126
127
 
# File 'lib/gitlab/qa/runtime/env.rb', line 125

def gitlab_availability_timeout
  ENV.fetch('GITLAB_QA_AVAILABILITY_TIMEOUT', 360).to_i
end

#gitlab_ci_api_token ⇒ Object 



141
142
143
 
# File 'lib/gitlab/qa/runtime/env.rb', line 141

def gitlab_ci_api_token
  ENV['GITLAB_CI_API_TOKEN']
end

#gitlab_dev_username ⇒ Object 



133
134
135
 
# File 'lib/gitlab/qa/runtime/env.rb', line 133

def gitlab_dev_username
  ENV['GITLAB_DEV_USERNAME'] || 'gitlab-qa-bot'
end

#gitlab_username ⇒ Object 



129
130
131
 
# File 'lib/gitlab/qa/runtime/env.rb', line 129

def gitlab_username
  ENV['GITLAB_USERNAME'] || 'gitlab-qa'
end

#host_artifacts_dir ⇒ Object 



217
218
219
 
# File 'lib/gitlab/qa/runtime/env.rb', line 217

def host_artifacts_dir
  @host_artifacts_dir ||= File.join(ENV['QA_ARTIFACTS_DIR'] || '/tmp/gitlab-qa', Runtime::Env.run_id)
end

#initial_root_password ⇒ Object 



201
202
203
 
# File 'lib/gitlab/qa/runtime/env.rb', line 201

def initial_root_password
  ENV['GITLAB_INITIAL_ROOT_PASSWORD'] || '5iveL!fe'
end

#override_default_password! ⇒ Object 



314
315
316
317
318
319
 
# File 'lib/gitlab/qa/runtime/env.rb', line 314

def override_default_password!
  require_initial_password!

  ENV['GITLAB_PASSWORD'] = initial_root_password
  ENV['GITLAB_ADMIN_PASSWORD'] = initial_root_password
end

#pipeline_from_project_name ⇒ Object 



177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/gitlab/qa/runtime/env.rb', line 177

def pipeline_from_project_name
  if ci_project_name.to_s.start_with?('gitlab-qa')
    if ENV['TOP_UPSTREAM_SOURCE_JOB'].to_s.start_with?('https://ops.gitlab.net')
      'staging-orchestrated'
    else
      QA::Runtime::Env.default_branch
    end
  else
    ci_project_name
  end
end

#qa_container_registry_access_token ⇒ Object 



205
206
207
 
# File 'lib/gitlab/qa/runtime/env.rb', line 205

def qa_container_registry_access_token
  ENV['GITLAB_QA_CONTAINER_REGISTRY_ACCESS_TOKEN']
end

#qa_dev_access_token ⇒ Object 



197
198
199
 
# File 'lib/gitlab/qa/runtime/env.rb', line 197

def qa_dev_access_token
  ENV['GITLAB_QA_DEV_ACCESS_TOKEN']
end

#qa_issue_url ⇒ Object 



209
210
211
 
# File 'lib/gitlab/qa/runtime/env.rb', line 209

def qa_issue_url
  ENV['GITLAB_QA_ISSUE_URL']
end

#require_aws_s3_environment! ⇒ Object 



296
297
298
299
300
 
# File 'lib/gitlab/qa/runtime/env.rb', line 296

def require_aws_s3_environment!
  %w[AWS_S3_REGION AWS_S3_KEY_ID AWS_S3_ACCESS_KEY AWS_S3_BUCKET_NAME].each do |env_key|
    raise ArgumentError, "Environment variable #{env_key} must be set to run AWS S3 object storage specs" unless ENV.key?(env_key)
  end
end

#require_ci_slack_webhook_url! ⇒ Object

Raises:

  • (ArgumentError) 


284
285
286
287
288
 
# File 'lib/gitlab/qa/runtime/env.rb', line 284

def require_ci_slack_webhook_url!
  return unless ENV['CI_SLACK_WEBHOOK_URL'].to_s.strip.empty?

  raise ArgumentError, "Please provide CI_SLACK_WEBHOOK_URL"
end

#require_initial_password! ⇒ Object

Raises:

  • (ArgumentError) 


302
303
304
305
306
 
# File 'lib/gitlab/qa/runtime/env.rb', line 302

def require_initial_password!
  return unless ENV['GITLAB_INITIAL_ROOT_PASSWORD'].to_s.strip.empty?

  raise ArgumentError, "Environment variable GITLAB_INITIAL_ROOT_PASSWORD must be provided to set an initial root password."
end

#require_kubernetes_environment! ⇒ Object 



290
291
292
293
294
 
# File 'lib/gitlab/qa/runtime/env.rb', line 290

def require_kubernetes_environment!
  %w[GCLOUD_ACCOUNT_EMAIL GCLOUD_ACCOUNT_KEY CLOUDSDK_CORE_PROJECT].each do |env_key|
    raise ArgumentError, "Environment variable #{env_key} must be set to run kubernetes specs" unless ENV.key?(env_key)
  end
end

#require_license! ⇒ Object

Raises:

  • (ArgumentError) 


254
255
256
257
258
 
# File 'lib/gitlab/qa/runtime/env.rb', line 254

def require_license!
  return if ENV.include?('EE_LICENSE')

  raise ArgumentError, 'GitLab License is not available. Please load a license into EE_LICENSE env variable.'
end

#require_no_license! ⇒ Object

Raises:

  • (ArgumentError) 


260
261
262
263
264
 
# File 'lib/gitlab/qa/runtime/env.rb', line 260

def require_no_license!
  return unless ENV.include?('EE_LICENSE')

  raise ArgumentError, "Unexpected EE_LICENSE provided. Please unset it to continue."
end

#require_qa_access_token! ⇒ Object

Raises:

  • (ArgumentError) 


266
267
268
269
270
 
# File 'lib/gitlab/qa/runtime/env.rb', line 266

def require_qa_access_token!
  return unless ENV['GITLAB_QA_ACCESS_TOKEN'].to_s.strip.empty?

  raise ArgumentError, "Please provide GITLAB_QA_ACCESS_TOKEN"
end

#require_qa_dev_access_token! ⇒ Object

Raises:

  • (ArgumentError) 


272
273
274
275
276
 
# File 'lib/gitlab/qa/runtime/env.rb', line 272

def require_qa_dev_access_token!
  return unless ENV['GITLAB_QA_DEV_ACCESS_TOKEN'].to_s.strip.empty?

  raise ArgumentError, "Please provide GITLAB_QA_DEV_ACCESS_TOKEN"
end

#require_slack_qa_channel! ⇒ Object

Raises:

  • (ArgumentError) 


278
279
280
281
282
 
# File 'lib/gitlab/qa/runtime/env.rb', line 278

def require_slack_qa_channel!
  return unless ENV['SLACK_QA_CHANNEL'].to_s.strip.empty?

  raise ArgumentError, "Please provide SLACK_QA_CHANNEL"
end

#require_ssh_tunnel! ⇒ Object 



308
309
310
311
312
 
# File 'lib/gitlab/qa/runtime/env.rb', line 308

def require_ssh_tunnel!
  %w[TUNNEL_SSH_PRIVATE_KEY TUNNEL_SERVER_HOSTNAME TUNNEL_SSH_USER].each do |env_key|
    raise ArgumentError, "Environment variable #{env_key} must be set to run tunnel specs" unless ENV.key?(env_key)
  end
end

#run_id ⇒ Object 



189
190
191
 
# File 'lib/gitlab/qa/runtime/env.rb', line 189

def run_id
  @run_id ||= "gitlab-qa-run-#{Time.now.strftime('%Y-%m-%d-%H-%M-%S')}-#{SecureRandom.hex(4)}"
end

#skip_pull? ⇒ Boolean

Returns:

  • (Boolean) 


321
322
323
 
# File 'lib/gitlab/qa/runtime/env.rb', line 321

def skip_pull?
  enabled?(ENV['QA_SKIP_PULL'], default: false)
end

#variables ⇒ Object 



241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/gitlab/qa/runtime/env.rb', line 241

def variables
  vars = {}

  ENV_VARIABLES.each do |name, attribute|
    # Variables that are overridden in the environment take precedence
    # over the defaults specified by the QA runtime.
    value = env_value_if_defined(name) || send(attribute) # rubocop:disable GitlabSecurity/PublicSend
    vars[name] = value if value
  end

  vars
end