Module: Datadog::CI::Ext::Environment

Defined in:
lib/datadog/ci/ext/environment.rb

Overview

Defines constants for CI tags

Constant Summary collapse

TAG_JOB_NAME = 
'ci.job.name'
TAG_JOB_URL = 
'ci.job.url'
TAG_PIPELINE_ID = 
'ci.pipeline.id'
TAG_PIPELINE_NAME = 
'ci.pipeline.name'
TAG_PIPELINE_NUMBER = 
'ci.pipeline.number'
TAG_PIPELINE_URL = 
'ci.pipeline.url'
TAG_PROVIDER_NAME = 
'ci.provider.name'
TAG_STAGE_NAME = 
'ci.stage.name'
TAG_WORKSPACE_PATH = 
'ci.workspace_path'
TAG_CI_ENV_VARS = 
'_dd.ci.env_vars'
PROVIDERS = 
[
  ['APPVEYOR', :extract_appveyor],
  ['TF_BUILD', :extract_azure_pipelines],
  ['BITBUCKET_COMMIT', :extract_bitbucket],
  ['BUDDY', :extract_buddy],
  ['BUILDKITE', :extract_buildkite],
  ['CIRCLECI', :extract_circle_ci],
  ['GITHUB_SHA', :extract_github_actions],
  ['GITLAB_CI', :extract_gitlab],
  ['JENKINS_URL', :extract_jenkins],
  ['TEAMCITY_VERSION', :extract_teamcity],
  ['TRAVIS', :extract_travis],
  ['BITRISE_BUILD_SLUG', :extract_bitrise]
].freeze

Class Method Summary collapse

Class Method Details

.branch_or_tag(branch_or_tag) ⇒ Object 



515
516
517
518
519
520
521
522
523
524
 
# File 'lib/datadog/ci/ext/environment.rb', line 515

def branch_or_tag(branch_or_tag)
  branch = tag = nil
  if branch_or_tag && branch_or_tag.include?('tags/')
    tag = branch_or_tag
  else
    branch = branch_or_tag
  end

  [branch, tag]
end

.exec_git_command(cmd) ⇒ Object 



479
480
481
482
483
484
485
486
487
488
489
 
# File 'lib/datadog/ci/ext/environment.rb', line 479

def exec_git_command(cmd)
  out, status = Open3.capture2e(cmd)

  raise "Failed to run git command #{cmd}: #{out}" unless status.success?

  out.strip! # There's always a "\n" at the end of the command output

  return nil if out.empty?

  out
end

.extract_appveyor(env) ⇒ Object

CI providers



87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
 
# File 'lib/datadog/ci/ext/environment.rb', line 87

def extract_appveyor(env)
  url = "https://ci.appveyor.com/project/#{env['APPVEYOR_REPO_NAME']}/builds/#{env['APPVEYOR_BUILD_ID']}"

  if env['APPVEYOR_REPO_PROVIDER'] == 'github'
    repository = "https://github.com/#{env['APPVEYOR_REPO_NAME']}.git"
    commit = env['APPVEYOR_REPO_COMMIT']
    branch = (env['APPVEYOR_PULL_REQUEST_HEAD_REPO_BRANCH'] || env['APPVEYOR_REPO_BRANCH'])
    tag = env['APPVEYOR_REPO_TAG_NAME']
  end

  commit_message = env['APPVEYOR_REPO_COMMIT_MESSAGE']
  if commit_message
    extended = env['APPVEYOR_REPO_COMMIT_MESSAGE_EXTENDED']
    commit_message = "#{commit_message}\n#{extended}" if extended
  end

  {
    TAG_PROVIDER_NAME => 'appveyor',
    Core::Git::Ext::TAG_REPOSITORY_URL => repository,
    Core::Git::Ext::TAG_COMMIT_SHA => commit,
    TAG_WORKSPACE_PATH => env['APPVEYOR_BUILD_FOLDER'],
    TAG_PIPELINE_ID => env['APPVEYOR_BUILD_ID'],
    TAG_PIPELINE_NAME => env['APPVEYOR_REPO_NAME'],
    TAG_PIPELINE_NUMBER => env['APPVEYOR_BUILD_NUMBER'],
    TAG_PIPELINE_URL => url,
    TAG_JOB_URL => url,
    Core::Git::Ext::TAG_BRANCH => branch,
    Core::Git::Ext::TAG_TAG => tag,
    Core::Git::Ext::TAG_COMMIT_AUTHOR_NAME => env['APPVEYOR_REPO_COMMIT_AUTHOR'],
    Core::Git::Ext::TAG_COMMIT_AUTHOR_EMAIL => env['APPVEYOR_REPO_COMMIT_AUTHOR_EMAIL'],
    Core::Git::Ext::TAG_COMMIT_MESSAGE => commit_message
  }
end

.extract_azure_pipelines(env) ⇒ Object 



121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
 
# File 'lib/datadog/ci/ext/environment.rb', line 121

def extract_azure_pipelines(env)
  build_id = env['BUILD_BUILDID']

  if build_id &&
      (team_foundation_server_uri = env['SYSTEM_TEAMFOUNDATIONSERVERURI']) &&
      (team_project_id = env['SYSTEM_TEAMPROJECTID'])
    pipeline_url = "#{team_foundation_server_uri}#{team_project_id}/_build/results?buildId=#{build_id}"
    job_url = "#{pipeline_url}&view=logs&j=#{env['SYSTEM_JOBID']}&t=#{env['SYSTEM_TASKINSTANCEID']}"
  end

  branch, tag = branch_or_tag(
    env['SYSTEM_PULLREQUEST_SOURCEBRANCH'] || env['BUILD_SOURCEBRANCH'] || env['BUILD_SOURCEBRANCHNAME']
  )

  {
    TAG_PROVIDER_NAME => 'azurepipelines',
    TAG_WORKSPACE_PATH => env['BUILD_SOURCESDIRECTORY'],
    TAG_PIPELINE_ID => build_id,
    TAG_PIPELINE_NAME => env['BUILD_DEFINITIONNAME'],
    TAG_PIPELINE_NUMBER => build_id,
    TAG_PIPELINE_URL => pipeline_url,
    TAG_JOB_URL => job_url,
    TAG_STAGE_NAME => env['SYSTEM_STAGEDISPLAYNAME'],
    TAG_JOB_NAME => env['SYSTEM_JOBDISPLAYNAME'],
    Core::Git::Ext::TAG_REPOSITORY_URL =>
      env['SYSTEM_PULLREQUEST_SOURCEREPOSITORYURI'] || env['BUILD_REPOSITORY_URI'],
    Core::Git::Ext::TAG_COMMIT_SHA => env['SYSTEM_PULLREQUEST_SOURCECOMMITID'] \
                                               || env['BUILD_SOURCEVERSION'],
    Core::Git::Ext::TAG_BRANCH => branch,
    Core::Git::Ext::TAG_TAG => tag,
    Core::Git::Ext::TAG_COMMIT_AUTHOR_NAME => env['BUILD_REQUESTEDFORID'],
    Core::Git::Ext::TAG_COMMIT_AUTHOR_EMAIL => env['BUILD_REQUESTEDFOREMAIL'],
    Core::Git::Ext::TAG_COMMIT_MESSAGE => env['BUILD_SOURCEVERSIONMESSAGE'],
    TAG_CI_ENV_VARS => {
      'SYSTEM_TEAMPROJECTID' => env['SYSTEM_TEAMPROJECTID'],
      'BUILD_BUILDID' => env['BUILD_BUILDID'],
      'SYSTEM_JOBID' => env['SYSTEM_JOBID']
    }.to_json
  }
end

.extract_bitbucket(env) ⇒ Object 



162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
 
# File 'lib/datadog/ci/ext/environment.rb', line 162

def extract_bitbucket(env)
  url = "https://bitbucket.org/#{env['BITBUCKET_REPO_FULL_NAME']}/addon/pipelines/home#" \
    "!/results/#{env['BITBUCKET_BUILD_NUMBER']}"
  {
    Core::Git::Ext::TAG_BRANCH => env['BITBUCKET_BRANCH'],
    Core::Git::Ext::TAG_COMMIT_SHA => env['BITBUCKET_COMMIT'],
    Core::Git::Ext::TAG_REPOSITORY_URL => env['BITBUCKET_GIT_SSH_ORIGIN'],
    Core::Git::Ext::TAG_TAG => env['BITBUCKET_TAG'],
    TAG_JOB_URL => url,
    TAG_PIPELINE_ID => env['BITBUCKET_PIPELINE_UUID'] ? env['BITBUCKET_PIPELINE_UUID'].tr('{}', '') : nil,
    TAG_PIPELINE_NAME => env['BITBUCKET_REPO_FULL_NAME'],
    TAG_PIPELINE_NUMBER => env['BITBUCKET_BUILD_NUMBER'],
    TAG_PIPELINE_URL => url,
    TAG_PROVIDER_NAME => 'bitbucket',
    TAG_WORKSPACE_PATH => env['BITBUCKET_CLONE_DIR'],
  }
end

.extract_bitrise(env) ⇒ Object 



353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
 
# File 'lib/datadog/ci/ext/environment.rb', line 353

def extract_bitrise(env)
  commit = (
    env['BITRISE_GIT_COMMIT'] || env['GIT_CLONE_COMMIT_HASH']
  )
  branch = (
    env['BITRISEIO_GIT_BRANCH_DEST'] || env['BITRISE_GIT_BRANCH']
  )
  commiter_email = (
    env['GIT_CLONE_COMMIT_COMMITER_EMAIL'] || env['GIT_CLONE_COMMIT_COMMITER_NAME']
  )

  {
    TAG_PROVIDER_NAME => 'bitrise',
    TAG_PIPELINE_ID => env['BITRISE_BUILD_SLUG'],
    TAG_PIPELINE_NAME => env['BITRISE_TRIGGERED_WORKFLOW_ID'],
    TAG_PIPELINE_NUMBER => env['BITRISE_BUILD_NUMBER'],
    TAG_PIPELINE_URL => env['BITRISE_BUILD_URL'],
    TAG_WORKSPACE_PATH => env['BITRISE_SOURCE_DIR'],
    Core::Git::Ext::TAG_REPOSITORY_URL => env['GIT_REPOSITORY_URL'],
    Core::Git::Ext::TAG_COMMIT_SHA => commit,
    Core::Git::Ext::TAG_BRANCH => branch,
    Core::Git::Ext::TAG_TAG => env['BITRISE_GIT_TAG'],
    Core::Git::Ext::TAG_COMMIT_MESSAGE => env['BITRISE_GIT_MESSAGE'],
    Core::Git::Ext::TAG_COMMIT_AUTHOR_NAME => env['GIT_CLONE_COMMIT_AUTHOR_NAME'],
    Core::Git::Ext::TAG_COMMIT_AUTHOR_EMAIL => env['GIT_CLONE_COMMIT_AUTHOR_EMAIL'],
    Core::Git::Ext::TAG_COMMIT_COMMITTER_NAME => env['GIT_CLONE_COMMIT_COMMITER_NAME'],
    Core::Git::Ext::TAG_COMMIT_COMMITTER_EMAIL => commiter_email
  }
end

.extract_buddy(env) ⇒ Object 



180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
 
# File 'lib/datadog/ci/ext/environment.rb', line 180

def extract_buddy(env)
  {
    TAG_PROVIDER_NAME => 'buddy',
    TAG_PIPELINE_ID => "#{env['BUDDY_PIPELINE_ID']}/#{env['BUDDY_EXECUTION_ID']}",
    TAG_PIPELINE_NAME => env['BUDDY_PIPELINE_NAME'],
    TAG_PIPELINE_NUMBER => env['BUDDY_EXECUTION_ID'],
    TAG_PIPELINE_URL => env['BUDDY_EXECUTION_URL'],
    TAG_WORKSPACE_PATH => env['CI_WORKSPACE_PATH'],
    Core::Git::Ext::TAG_REPOSITORY_URL => env['BUDDY_SCM_URL'],
    Core::Git::Ext::TAG_COMMIT_SHA => env['BUDDY_EXECUTION_REVISION'],
    Core::Git::Ext::TAG_BRANCH => env['BUDDY_EXECUTION_BRANCH'],
    Core::Git::Ext::TAG_TAG => env['BUDDY_EXECUTION_TAG'],
    Core::Git::Ext::TAG_COMMIT_MESSAGE => env['BUDDY_EXECUTION_REVISION_MESSAGE'],
    Core::Git::Ext::TAG_COMMIT_COMMITTER_NAME => env['BUDDY_EXECUTION_REVISION_COMMITTER_NAME'],
    Core::Git::Ext::TAG_COMMIT_COMMITTER_EMAIL => env['BUDDY_EXECUTION_REVISION_COMMITTER_EMAIL'],
  }
end

.extract_buildkite(env) ⇒ Object 



198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/datadog/ci/ext/environment.rb', line 198

def extract_buildkite(env)
  {
    Core::Git::Ext::TAG_BRANCH => env['BUILDKITE_BRANCH'],
    Core::Git::Ext::TAG_COMMIT_SHA => env['BUILDKITE_COMMIT'],
    Core::Git::Ext::TAG_REPOSITORY_URL => env['BUILDKITE_REPO'],
    Core::Git::Ext::TAG_TAG => env['BUILDKITE_TAG'],
    TAG_PIPELINE_ID => env['BUILDKITE_BUILD_ID'],
    TAG_PIPELINE_NAME => env['BUILDKITE_PIPELINE_SLUG'],
    TAG_PIPELINE_NUMBER => env['BUILDKITE_BUILD_NUMBER'],
    TAG_PIPELINE_URL => env['BUILDKITE_BUILD_URL'],
    TAG_JOB_URL => "#{env['BUILDKITE_BUILD_URL']}##{env['BUILDKITE_JOB_ID']}",
    TAG_PROVIDER_NAME => 'buildkite',
    TAG_WORKSPACE_PATH => env['BUILDKITE_BUILD_CHECKOUT_PATH'],
    Core::Git::Ext::TAG_COMMIT_AUTHOR_NAME => env['BUILDKITE_BUILD_AUTHOR'],
    Core::Git::Ext::TAG_COMMIT_AUTHOR_EMAIL => env['BUILDKITE_BUILD_AUTHOR_EMAIL'],
    Core::Git::Ext::TAG_COMMIT_MESSAGE => env['BUILDKITE_MESSAGE'],
    TAG_CI_ENV_VARS => {
      'BUILDKITE_BUILD_ID' => env['BUILDKITE_BUILD_ID'],
      'BUILDKITE_JOB_ID' => env['BUILDKITE_JOB_ID']
    }.to_json
  }
end

.extract_circle_ci(env) ⇒ Object 



221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
 
# File 'lib/datadog/ci/ext/environment.rb', line 221

def extract_circle_ci(env)
  {
    Core::Git::Ext::TAG_BRANCH => env['CIRCLE_BRANCH'],
    Core::Git::Ext::TAG_COMMIT_SHA => env['CIRCLE_SHA1'],
    Core::Git::Ext::TAG_REPOSITORY_URL => env['CIRCLE_REPOSITORY_URL'],
    Core::Git::Ext::TAG_TAG => env['CIRCLE_TAG'],
    TAG_PIPELINE_ID => env['CIRCLE_WORKFLOW_ID'],
    TAG_PIPELINE_NAME => env['CIRCLE_PROJECT_REPONAME'],
    TAG_PIPELINE_URL => "https://app.circleci.com/pipelines/workflows/#{env['CIRCLE_WORKFLOW_ID']}",
    TAG_JOB_NAME => env['CIRCLE_JOB'],
    TAG_JOB_URL => env['CIRCLE_BUILD_URL'],
    TAG_PROVIDER_NAME => 'circleci',
    TAG_WORKSPACE_PATH => env['CIRCLE_WORKING_DIRECTORY'],
    Core::Git::Ext::TAG_COMMIT_AUTHOR_NAME => env['BUILD_REQUESTEDFORID'],
    Core::Git::Ext::TAG_COMMIT_AUTHOR_EMAIL => env['BUILD_REQUESTEDFOREMAIL'],
    Core::Git::Ext::TAG_COMMIT_MESSAGE => env['BUILD_SOURCEVERSIONMESSAGE'],
    TAG_CI_ENV_VARS => {
      'CIRCLE_WORKFLOW_ID' => env['CIRCLE_WORKFLOW_ID'],
      'CIRCLE_BUILD_NUM' => env['CIRCLE_BUILD_NUM']
    }.to_json
  }
end

.extract_github_actions(env) ⇒ Object 



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
 
# File 'lib/datadog/ci/ext/environment.rb', line 244

def extract_github_actions(env)
  ref = env['GITHUB_HEAD_REF']
  ref = env['GITHUB_REF'] if ref.nil? || ref.empty?
  branch, tag = branch_or_tag(ref)

  pipeline_url = "#{env['GITHUB_SERVER_URL']}/#{env['GITHUB_REPOSITORY']}/actions/runs/#{env['GITHUB_RUN_ID']}"
  pipeline_url = "#{pipeline_url}/attempts/#{env['GITHUB_RUN_ATTEMPT']}" if env['GITHUB_RUN_ATTEMPT']

  {
    Core::Git::Ext::TAG_BRANCH => branch,
    Core::Git::Ext::TAG_COMMIT_SHA => env['GITHUB_SHA'],
    Core::Git::Ext::TAG_REPOSITORY_URL => "#{env['GITHUB_SERVER_URL']}/#{env['GITHUB_REPOSITORY']}.git",
    Core::Git::Ext::TAG_TAG => tag,
    TAG_JOB_URL => "#{env['GITHUB_SERVER_URL']}/#{env['GITHUB_REPOSITORY']}/commit/#{env['GITHUB_SHA']}/checks",
    TAG_JOB_NAME => env['GITHUB_JOB'],
    TAG_PIPELINE_ID => env['GITHUB_RUN_ID'],
    TAG_PIPELINE_NAME => env['GITHUB_WORKFLOW'],
    TAG_PIPELINE_NUMBER => env['GITHUB_RUN_NUMBER'],
    TAG_PIPELINE_URL => pipeline_url,
    TAG_PROVIDER_NAME => 'github',
    TAG_WORKSPACE_PATH => env['GITHUB_WORKSPACE'],
    TAG_CI_ENV_VARS => {
      'GITHUB_SERVER_URL' => env['GITHUB_SERVER_URL'],
      'GITHUB_REPOSITORY' => env['GITHUB_REPOSITORY'],
      'GITHUB_RUN_ID' => env['GITHUB_RUN_ID'],
      'GITHUB_RUN_ATTEMPT' => env['GITHUB_RUN_ATTEMPT'],
    }.reject { |_k, v| v.nil? }.to_json
  }
end

.extract_gitlab(env) ⇒ Object 



274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/datadog/ci/ext/environment.rb', line 274

def extract_gitlab(env)
  commit_author_name, commit_author_email = extract_name_email(env['CI_COMMIT_AUTHOR'])

  url = env['CI_PIPELINE_URL']
  {
    Core::Git::Ext::TAG_BRANCH => env['CI_COMMIT_REF_NAME'],
    Core::Git::Ext::TAG_COMMIT_SHA => env['CI_COMMIT_SHA'],
    Core::Git::Ext::TAG_REPOSITORY_URL => env['CI_REPOSITORY_URL'],
    Core::Git::Ext::TAG_TAG => env['CI_COMMIT_TAG'],
    Core::Git::Ext::TAG_COMMIT_AUTHOR_NAME => commit_author_name,
    Core::Git::Ext::TAG_COMMIT_AUTHOR_EMAIL => commit_author_email,
    Core::Git::Ext::TAG_COMMIT_AUTHOR_DATE => env['CI_COMMIT_TIMESTAMP'],
    TAG_STAGE_NAME => env['CI_JOB_STAGE'],
    TAG_JOB_NAME => env['CI_JOB_NAME'],
    TAG_JOB_URL => env['CI_JOB_URL'],
    TAG_PIPELINE_ID => env['CI_PIPELINE_ID'],
    TAG_PIPELINE_NAME => env['CI_PROJECT_PATH'],
    TAG_PIPELINE_NUMBER => env['CI_PIPELINE_IID'],
    TAG_PIPELINE_URL => (url.gsub(%r{/-/pipelines/}, '/pipelines/') if url),
    TAG_PROVIDER_NAME => 'gitlab',
    TAG_WORKSPACE_PATH => env['CI_PROJECT_DIR'],
    Core::Git::Ext::TAG_COMMIT_MESSAGE => env['CI_COMMIT_MESSAGE'],
    TAG_CI_ENV_VARS => {
      'CI_PROJECT_URL' => env['CI_PROJECT_URL'],
      'CI_PIPELINE_ID' => env['CI_PIPELINE_ID'],
      'CI_JOB_ID' => env['CI_JOB_ID']
    }.to_json
  }
end

.extract_jenkins(env) ⇒ Object 



304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
 
# File 'lib/datadog/ci/ext/environment.rb', line 304

def extract_jenkins(env)
  branch, tag = branch_or_tag(env['GIT_BRANCH'])

  if (name = env['JOB_NAME'])
    name = name.gsub("/#{normalize_ref(branch)}", '') if branch
    name = name.split('/').reject { |v| v.nil? || v.include?('=') }.join('/')
  end
  {
    Core::Git::Ext::TAG_BRANCH => branch,
    Core::Git::Ext::TAG_COMMIT_SHA => env['GIT_COMMIT'],
    Core::Git::Ext::TAG_REPOSITORY_URL => env['GIT_URL'] || env['GIT_URL_1'],
    Core::Git::Ext::TAG_TAG => tag,
    TAG_PIPELINE_ID => env['BUILD_TAG'],
    TAG_PIPELINE_NAME => name,
    TAG_PIPELINE_NUMBER => env['BUILD_NUMBER'],
    TAG_PIPELINE_URL => env['BUILD_URL'],
    TAG_PROVIDER_NAME => 'jenkins',
    TAG_WORKSPACE_PATH => env['WORKSPACE'],
    TAG_CI_ENV_VARS => {
      'DD_CUSTOM_TRACE_ID' => env['DD_CUSTOM_TRACE_ID']
    }.to_json
  }
end

.extract_local_git ⇒ Object 



491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
 
# File 'lib/datadog/ci/ext/environment.rb', line 491

def extract_local_git
  env = {
    TAG_WORKSPACE_PATH => git_base_directory,
    Core::Git::Ext::TAG_REPOSITORY_URL => git_repository_url,
    Core::Git::Ext::TAG_COMMIT_SHA => git_commit_sha,
    Core::Git::Ext::TAG_BRANCH => git_branch,
    Core::Git::Ext::TAG_TAG => git_tag,
    Core::Git::Ext::TAG_COMMIT_MESSAGE => git_commit_message
  }

  if (commit_users = git_commit_users)
    env.merge!(
      Core::Git::Ext::TAG_COMMIT_AUTHOR_NAME => commit_users[:author_name],
      Core::Git::Ext::TAG_COMMIT_AUTHOR_EMAIL => commit_users[:author_email],
      Core::Git::Ext::TAG_COMMIT_AUTHOR_DATE => commit_users[:author_date],
      Core::Git::Ext::TAG_COMMIT_COMMITTER_NAME => commit_users[:committer_name],
      Core::Git::Ext::TAG_COMMIT_COMMITTER_EMAIL => commit_users[:committer_email],
      Core::Git::Ext::TAG_COMMIT_COMMITTER_DATE => commit_users[:committer_date]
    )
  end

  env
end

.extract_name_email(name_and_email) ⇒ Object 



526
527
528
529
530
531
532
533
534
535
 
# File 'lib/datadog/ci/ext/environment.rb', line 526

def extract_name_email(name_and_email)
  if name_and_email.include?('<') && (match = /^([^<]*)<([^>]*)>$/.match(name_and_email))
    name = match[1]
    name = name.strip if name
    email = match[2]
    return [name, email] if name && email
  end

  [nil, name_and_email]
end

.extract_teamcity(env) ⇒ Object 



328
329
330
331
332
333
334
 
# File 'lib/datadog/ci/ext/environment.rb', line 328

def extract_teamcity(env)
  {
    TAG_PROVIDER_NAME => 'teamcity',
    TAG_JOB_NAME => env['TEAMCITY_BUILDCONF_NAME'],
    TAG_JOB_URL => env['BUILD_URL'],
  }
end

.extract_travis(env) ⇒ Object 



336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
 
# File 'lib/datadog/ci/ext/environment.rb', line 336

def extract_travis(env)
  {
    Core::Git::Ext::TAG_BRANCH => (env['TRAVIS_PULL_REQUEST_BRANCH'] || env['TRAVIS_BRANCH']),
    Core::Git::Ext::TAG_COMMIT_SHA => env['TRAVIS_COMMIT'],
    Core::Git::Ext::TAG_REPOSITORY_URL => "https://github.com/#{env['TRAVIS_REPO_SLUG']}.git",
    Core::Git::Ext::TAG_TAG => env['TRAVIS_TAG'],
    TAG_JOB_URL => env['TRAVIS_JOB_WEB_URL'],
    TAG_PIPELINE_ID => env['TRAVIS_BUILD_ID'],
    TAG_PIPELINE_NAME => env['TRAVIS_REPO_SLUG'],
    TAG_PIPELINE_NUMBER => env['TRAVIS_BUILD_NUMBER'],
    TAG_PIPELINE_URL => env['TRAVIS_BUILD_WEB_URL'],
    TAG_PROVIDER_NAME => 'travisci',
    TAG_WORKSPACE_PATH => env['TRAVIS_BUILD_DIR'],
    Core::Git::Ext::TAG_COMMIT_MESSAGE => env['TRAVIS_COMMIT_MESSAGE']
  }
end

.extract_user_defined_git(env) ⇒ Object 



383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
 
# File 'lib/datadog/ci/ext/environment.rb', line 383

def extract_user_defined_git(env)
  {
    Core::Git::Ext::TAG_REPOSITORY_URL => env[Core::Git::Ext::ENV_REPOSITORY_URL],
    Core::Git::Ext::TAG_COMMIT_SHA => env[Core::Git::Ext::ENV_COMMIT_SHA],
    Core::Git::Ext::TAG_BRANCH => env[Core::Git::Ext::ENV_BRANCH],
    Core::Git::Ext::TAG_TAG => env[Core::Git::Ext::ENV_TAG],
    Core::Git::Ext::TAG_COMMIT_MESSAGE => env[Core::Git::Ext::ENV_COMMIT_MESSAGE],
    Core::Git::Ext::TAG_COMMIT_AUTHOR_NAME => env[Core::Git::Ext::ENV_COMMIT_AUTHOR_NAME],
    Core::Git::Ext::TAG_COMMIT_AUTHOR_EMAIL => env[Core::Git::Ext::ENV_COMMIT_AUTHOR_EMAIL],
    Core::Git::Ext::TAG_COMMIT_AUTHOR_DATE => env[Core::Git::Ext::ENV_COMMIT_AUTHOR_DATE],
    Core::Git::Ext::TAG_COMMIT_COMMITTER_NAME => env[Core::Git::Ext::ENV_COMMIT_COMMITTER_NAME],
    Core::Git::Ext::TAG_COMMIT_COMMITTER_EMAIL => env[Core::Git::Ext::ENV_COMMIT_COMMITTER_EMAIL],
    Core::Git::Ext::TAG_COMMIT_COMMITTER_DATE => env[Core::Git::Ext::ENV_COMMIT_COMMITTER_DATE]
  }.reject { |_, v| v.nil? || v.strip.empty? }
end

.filter_sensitive_info(url) ⇒ Object 



81
82
83
 
# File 'lib/datadog/ci/ext/environment.rb', line 81

def filter_sensitive_info(url)
  url.gsub(%r{(https?://)[^/]*@}, '\1') unless url.nil?
end

.git_base_directory ⇒ Object 



470
471
472
473
474
475
476
477
 
# File 'lib/datadog/ci/ext/environment.rb', line 470

def git_base_directory
  exec_git_command('git rev-parse --show-toplevel')
rescue => e
  Datadog.logger.debug(
    "Unable to read git base directory: #{e.class.name} #{e.message} at #{Array(e.backtrace).first}"
  )
  nil
end

.git_branch ⇒ Object 



443
444
445
446
447
448
449
450
 
# File 'lib/datadog/ci/ext/environment.rb', line 443

def git_branch
  exec_git_command('git rev-parse --abbrev-ref HEAD')
rescue => e
  Datadog.logger.debug(
    "Unable to read git branch: #{e.class.name} #{e.message} at #{Array(e.backtrace).first}"
  )
  nil
end

.git_commit_message ⇒ Object 



434
435
436
437
438
439
440
441
 
# File 'lib/datadog/ci/ext/environment.rb', line 434

def git_commit_message
  exec_git_command('git show -s --format=%s')
rescue => e
  Datadog.logger.debug(
    "Unable to read git commit message: #{e.class.name} #{e.message} at #{Array(e.backtrace).first}"
  )
  nil
end

.git_commit_sha ⇒ Object 



452
453
454
455
456
457
458
459
 
# File 'lib/datadog/ci/ext/environment.rb', line 452

def git_commit_sha
  exec_git_command('git rev-parse HEAD')
rescue => e
  Datadog.logger.debug(
    "Unable to read git commit SHA: #{e.class.name} #{e.message} at #{Array(e.backtrace).first}"
  )
  nil
end

.git_commit_users ⇒ Object 



399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
 
# File 'lib/datadog/ci/ext/environment.rb', line 399

def git_commit_users
  # Get committer and author information in one command.
  output = exec_git_command("git show -s --format='%an\t%ae\t%at\t%cn\t%ce\t%ct'")
  return unless output

  fields = output.split("\t").each(&:strip!)

  {
    author_name: fields[0],
    author_email: fields[1],
    # Because we can't get a reliable UTC time from all recent versions of git
    # We have to rely on converting the date to UTC ourselves.
    author_date: Time.at(fields[2].to_i).utc.to_datetime.iso8601,
    committer_name: fields[3],
    committer_email: fields[4],
    # Because we can't get a reliable UTC time from all recent versions of git
    # We have to rely on converting the date to UTC ourselves.
    committer_date: Time.at(fields[5].to_i).utc.to_datetime.iso8601
  }
rescue => e
  Datadog.logger.debug(
    "Unable to read git commit users: #{e.class.name} #{e.message} at #{Array(e.backtrace).first}"
  )
  nil
end

.git_repository_url ⇒ Object 



425
426
427
428
429
430
431
432
 
# File 'lib/datadog/ci/ext/environment.rb', line 425

def git_repository_url
  exec_git_command('git ls-remote --get-url')
rescue => e
  Datadog.logger.debug(
    "Unable to read git repository url: #{e.class.name} #{e.message} at #{Array(e.backtrace).first}"
  )
  nil
end

.git_tag ⇒ Object 



461
462
463
464
465
466
467
468
 
# File 'lib/datadog/ci/ext/environment.rb', line 461

def git_tag
  exec_git_command('git tag --points-at HEAD')
rescue => e
  Datadog.logger.debug(
    "Unable to read git tag: #{e.class.name} #{e.message} at #{Array(e.backtrace).first}"
  )
  nil
end

.normalize_ref(name) ⇒ Object 



74
75
76
77
78
79
 
# File 'lib/datadog/ci/ext/environment.rb', line 74

def normalize_ref(name)
  refs = %r{^refs/(heads/)?}
  origin = %r{^origin/}
  tags = %r{^tags/}
  name.gsub(refs, '').gsub(origin, '').gsub(tags, '') unless name.nil?
end

.tags(env) ⇒ Object 



41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
 
# File 'lib/datadog/ci/ext/environment.rb', line 41

def tags(env)
  # Extract metadata from CI provider environment variables
  _, extractor = PROVIDERS.find { |provider_env_var, _| env.key?(provider_env_var) }
  tags = extractor ? public_send(extractor, env).reject { |_, v| v.nil? || v.strip.empty? } : {}

  # If user defined metadata is defined, overwrite
  tags.merge!(extract_user_defined_git(env))
  if !tags[Core::Git::Ext::TAG_BRANCH].nil? && tags[Core::Git::Ext::TAG_BRANCH].include?('tags/')
    tags[Core::Git::Ext::TAG_TAG] = tags[Core::Git::Ext::TAG_BRANCH]
    tags.delete(Core::Git::Ext::TAG_BRANCH)
  end

  # Normalize Git references
  tags[Core::Git::Ext::TAG_TAG] = normalize_ref(tags[Core::Git::Ext::TAG_TAG])
  tags[Core::Git::Ext::TAG_BRANCH] = normalize_ref(tags[Core::Git::Ext::TAG_BRANCH])
  tags[Core::Git::Ext::TAG_REPOSITORY_URL] = filter_sensitive_info(
    tags[Core::Git::Ext::TAG_REPOSITORY_URL]
  )

  # Expand ~
  workspace_path = tags[TAG_WORKSPACE_PATH]
  if !workspace_path.nil? && (workspace_path == '~' || workspace_path.start_with?('~/'))
    tags[TAG_WORKSPACE_PATH] = File.expand_path(workspace_path)
  end

  # Fill out tags from local git as fallback
  extract_local_git.each do |key, value|
    tags[key] ||= value
  end

  tags.reject { |_, v| v.nil? }
end