ddtrace 0.42.0 → 0.54.2

data/lib/datadog/ci/ext/environment.rb

@@ -0,0 +1,485 @@
+# typed: true
+# frozen_string_literal: true
+
+require 'ddtrace/ext/git'
+
+require 'open3'
+
+module Datadog
+  module CI
+    module Ext
+      # Defines constants for CI tags
+      # rubocop:disable Metrics/ModuleLength:
+      module Environment
+        include Kernel # Ensure that kernel methods are always available (https://sorbet.org/docs/error-reference#7003)
+
+        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'
+
+        PROVIDERS = [
+          ['APPVEYOR', :extract_appveyor],
+          ['TF_BUILD', :extract_azure_pipelines],
+          ['BITBUCKET_COMMIT', :extract_bitbucket],
+          ['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
+
+        module_function
+
+        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? } : {}
+          tags.delete(Datadog::Ext::Git::TAG_BRANCH) unless tags[Datadog::Ext::Git::TAG_TAG].nil?
+
+          # If user defined metadata is defined, overwrite
+          tags.merge!(extract_user_defined_git(env))
+          if !tags[Datadog::Ext::Git::TAG_BRANCH].nil? && tags[Datadog::Ext::Git::TAG_BRANCH].include?('tags/')
+            tags[Datadog::Ext::Git::TAG_TAG] = tags[Datadog::Ext::Git::TAG_BRANCH]
+            tags.delete(Datadog::Ext::Git::TAG_BRANCH)
+          end
+
+          # Normalize Git references
+          tags[Datadog::Ext::Git::TAG_TAG] = normalize_ref(tags[Datadog::Ext::Git::TAG_TAG])
+          tags[Datadog::Ext::Git::TAG_BRANCH] = normalize_ref(tags[Datadog::Ext::Git::TAG_BRANCH])
+          tags[Datadog::Ext::Git::TAG_REPOSITORY_URL] = filter_sensitive_info(tags[Datadog::Ext::Git::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
+
+        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
+
+        def filter_sensitive_info(url)
+          url.gsub(%r{(https?://)[^/]*@}, '\1') unless url.nil?
+        end
+
+        # CI providers
+
+        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
+
+          {
+            TAG_PROVIDER_NAME => 'appveyor',
+            Datadog::Ext::Git::TAG_REPOSITORY_URL => repository,
+            Datadog::Ext::Git::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,
+            Datadog::Ext::Git::TAG_BRANCH => branch,
+            Datadog::Ext::Git::TAG_TAG => tag,
+            Datadog::Ext::Git::TAG_COMMIT_AUTHOR_NAME => env['APPVEYOR_REPO_COMMIT_AUTHOR'],
+            Datadog::Ext::Git::TAG_COMMIT_AUTHOR_EMAIL => env['APPVEYOR_REPO_COMMIT_AUTHOR_EMAIL'],
+            Datadog::Ext::Git::TAG_COMMIT_MESSAGE => env['APPVEYOR_REPO_COMMIT_MESSAGE_EXTENDED']
+          }
+        end
+
+        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'],
+            Datadog::Ext::Git::TAG_REPOSITORY_URL =>
+              env['SYSTEM_PULLREQUEST_SOURCEREPOSITORYURI'] || env['BUILD_REPOSITORY_URI'],
+            Datadog::Ext::Git::TAG_COMMIT_SHA => env['SYSTEM_PULLREQUEST_SOURCECOMMITID'] || env['BUILD_SOURCEVERSION'],
+            Datadog::Ext::Git::TAG_BRANCH => branch,
+            Datadog::Ext::Git::TAG_TAG => tag,
+            Datadog::Ext::Git::TAG_COMMIT_AUTHOR_NAME => env['BUILD_REQUESTEDFORID'],
+            Datadog::Ext::Git::TAG_COMMIT_AUTHOR_EMAIL => env['BUILD_REQUESTEDFOREMAIL'],
+            Datadog::Ext::Git::TAG_COMMIT_MESSAGE => env['BUILD_SOURCEVERSIONMESSAGE']
+          }
+        end
+
+        def extract_bitbucket(env)
+          url = "https://bitbucket.org/#{env['BITBUCKET_REPO_FULL_NAME']}/addon/pipelines/home#" \
+            "!/results/#{env['BITBUCKET_BUILD_NUMBER']}"
+          {
+            Datadog::Ext::Git::TAG_BRANCH => env['BITBUCKET_BRANCH'],
+            Datadog::Ext::Git::TAG_COMMIT_SHA => env['BITBUCKET_COMMIT'],
+            Datadog::Ext::Git::TAG_REPOSITORY_URL => env['BITBUCKET_GIT_SSH_ORIGIN'],
+            Datadog::Ext::Git::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'],
+            Datadog::Ext::Git::TAG_COMMIT_AUTHOR_NAME => env['BUILD_REQUESTEDFORID'],
+            Datadog::Ext::Git::TAG_COMMIT_AUTHOR_EMAIL => env['BUILD_REQUESTEDFOREMAIL'],
+            Datadog::Ext::Git::TAG_COMMIT_MESSAGE => env['BUILD_SOURCEVERSIONMESSAGE']
+          }
+        end
+
+        def extract_buildkite(env)
+          {
+            Datadog::Ext::Git::TAG_BRANCH => env['BUILDKITE_BRANCH'],
+            Datadog::Ext::Git::TAG_COMMIT_SHA => env['BUILDKITE_COMMIT'],
+            Datadog::Ext::Git::TAG_REPOSITORY_URL => env['BUILDKITE_REPO'],
+            Datadog::Ext::Git::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'],
+            Datadog::Ext::Git::TAG_COMMIT_AUTHOR_NAME => env['BUILDKITE_BUILD_AUTHOR'],
+            Datadog::Ext::Git::TAG_COMMIT_AUTHOR_EMAIL => env['BUILDKITE_BUILD_AUTHOR_EMAIL'],
+            Datadog::Ext::Git::TAG_COMMIT_MESSAGE => env['BUILDKITE_MESSAGE']
+          }
+        end
+
+        def extract_circle_ci(env)
+          {
+            Datadog::Ext::Git::TAG_BRANCH => env['CIRCLE_BRANCH'],
+            Datadog::Ext::Git::TAG_COMMIT_SHA => env['CIRCLE_SHA1'],
+            Datadog::Ext::Git::TAG_REPOSITORY_URL => env['CIRCLE_REPOSITORY_URL'],
+            Datadog::Ext::Git::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'],
+            Datadog::Ext::Git::TAG_COMMIT_AUTHOR_NAME => env['BUILD_REQUESTEDFORID'],
+            Datadog::Ext::Git::TAG_COMMIT_AUTHOR_EMAIL => env['BUILD_REQUESTEDFOREMAIL'],
+            Datadog::Ext::Git::TAG_COMMIT_MESSAGE => env['BUILD_SOURCEVERSIONMESSAGE']
+          }
+        end
+
+        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']
+
+          {
+            Datadog::Ext::Git::TAG_BRANCH => branch,
+            Datadog::Ext::Git::TAG_COMMIT_SHA => env['GITHUB_SHA'],
+            Datadog::Ext::Git::TAG_REPOSITORY_URL => "#{env['GITHUB_SERVER_URL']}/#{env['GITHUB_REPOSITORY']}.git",
+            Datadog::Ext::Git::TAG_TAG => tag,
+            TAG_JOB_URL => "#{env['GITHUB_SERVER_URL']}/#{env['GITHUB_REPOSITORY']}/commit/#{env['GITHUB_SHA']}/checks",
+            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'],
+            Datadog::Ext::Git::TAG_COMMIT_AUTHOR_NAME => env['BUILD_REQUESTEDFORID'],
+            Datadog::Ext::Git::TAG_COMMIT_AUTHOR_EMAIL => env['BUILD_REQUESTEDFOREMAIL'],
+            Datadog::Ext::Git::TAG_COMMIT_MESSAGE => env['BUILD_SOURCEVERSIONMESSAGE']
+          }
+        end
+
+        def extract_gitlab(env)
+          commit_author_name, commit_author_email = extract_name_email(env['CI_COMMIT_AUTHOR'])
+
+          url = env['CI_PIPELINE_URL']
+          {
+            Datadog::Ext::Git::TAG_BRANCH => env['CI_COMMIT_REF_NAME'],
+            Datadog::Ext::Git::TAG_COMMIT_SHA => env['CI_COMMIT_SHA'],
+            Datadog::Ext::Git::TAG_REPOSITORY_URL => env['CI_REPOSITORY_URL'],
+            Datadog::Ext::Git::TAG_TAG => env['CI_COMMIT_TAG'],
+            Datadog::Ext::Git::TAG_COMMIT_AUTHOR_NAME => commit_author_name,
+            Datadog::Ext::Git::TAG_COMMIT_AUTHOR_EMAIL => commit_author_email,
+            Datadog::Ext::Git::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'],
+            Datadog::Ext::Git::TAG_COMMIT_MESSAGE => env['CI_COMMIT_MESSAGE']
+          }
+        end
+
+        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
+          {
+            Datadog::Ext::Git::TAG_BRANCH => branch,
+            Datadog::Ext::Git::TAG_COMMIT_SHA => env['GIT_COMMIT'],
+            Datadog::Ext::Git::TAG_REPOSITORY_URL => env['GIT_URL'] || env['GIT_URL_1'],
+            Datadog::Ext::Git::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'],
+            Datadog::Ext::Git::TAG_COMMIT_AUTHOR_NAME => env['BUILD_REQUESTEDFORID'],
+            Datadog::Ext::Git::TAG_COMMIT_AUTHOR_EMAIL => env['BUILD_REQUESTEDFOREMAIL'],
+            Datadog::Ext::Git::TAG_COMMIT_MESSAGE => env['BUILD_SOURCEVERSIONMESSAGE']
+          }
+        end
+
+        def extract_teamcity(env)
+          {
+            TAG_PROVIDER_NAME => 'teamcity',
+            Datadog::Ext::Git::TAG_REPOSITORY_URL => env['BUILD_VCS_URL'],
+            Datadog::Ext::Git::TAG_COMMIT_SHA => env['BUILD_VCS_NUMBER'],
+            TAG_WORKSPACE_PATH => env['BUILD_CHECKOUTDIR'],
+            TAG_PIPELINE_ID => env['BUILD_ID'],
+            TAG_PIPELINE_NUMBER => env['BUILD_NUMBER'],
+            TAG_PIPELINE_URL => (
+              env['SERVER_URL'] && env['BUILD_ID'] ? "#{env['SERVER_URL']}/viewLog.html?buildId=#{env['SERVER_URL']}" : nil
+            ),
+            Datadog::Ext::Git::TAG_COMMIT_AUTHOR_NAME => env['BUILD_REQUESTEDFORID'],
+            Datadog::Ext::Git::TAG_COMMIT_AUTHOR_EMAIL => env['BUILD_REQUESTEDFOREMAIL'],
+            Datadog::Ext::Git::TAG_COMMIT_MESSAGE => env['BUILD_SOURCEVERSIONMESSAGE']
+          }
+        end
+
+        def extract_travis(env)
+          {
+            Datadog::Ext::Git::TAG_BRANCH => (env['TRAVIS_PULL_REQUEST_BRANCH'] || env['TRAVIS_BRANCH']),
+            Datadog::Ext::Git::TAG_COMMIT_SHA => env['TRAVIS_COMMIT'],
+            Datadog::Ext::Git::TAG_REPOSITORY_URL => "https://github.com/#{env['TRAVIS_REPO_SLUG']}.git",
+            Datadog::Ext::Git::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'],
+            Datadog::Ext::Git::TAG_COMMIT_MESSAGE => env['TRAVIS_COMMIT_MESSAGE']
+          }
+        end
+
+        def extract_bitrise(env)
+          commit = (
+            env['BITRISE_GIT_COMMIT'] || env['GIT_CLONE_COMMIT_HASH']
+          )
+          branch = (
+            env['BITRISEIO_GIT_BRANCH_DEST'] || env['BITRISE_GIT_BRANCH']
+          )
+          {
+            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'],
+            Datadog::Ext::Git::TAG_REPOSITORY_URL => env['GIT_REPOSITORY_URL'],
+            Datadog::Ext::Git::TAG_COMMIT_SHA => commit,
+            Datadog::Ext::Git::TAG_BRANCH => branch,
+            Datadog::Ext::Git::TAG_TAG => env['BITRISE_GIT_TAG'],
+            Datadog::Ext::Git::TAG_COMMIT_MESSAGE => env['BITRISE_GIT_MESSAGE']
+          }
+        end
+
+        def extract_user_defined_git(env)
+          {
+            Datadog::Ext::Git::TAG_REPOSITORY_URL => env[Datadog::Ext::Git::ENV_REPOSITORY_URL],
+            Datadog::Ext::Git::TAG_COMMIT_SHA => env[Datadog::Ext::Git::ENV_COMMIT_SHA],
+            Datadog::Ext::Git::TAG_BRANCH => env[Datadog::Ext::Git::ENV_BRANCH],
+            Datadog::Ext::Git::TAG_TAG => env[Datadog::Ext::Git::ENV_TAG],
+            Datadog::Ext::Git::TAG_COMMIT_MESSAGE => env[Datadog::Ext::Git::ENV_COMMIT_MESSAGE],
+            Datadog::Ext::Git::TAG_COMMIT_AUTHOR_NAME => env[Datadog::Ext::Git::ENV_COMMIT_AUTHOR_NAME],
+            Datadog::Ext::Git::TAG_COMMIT_AUTHOR_EMAIL => env[Datadog::Ext::Git::ENV_COMMIT_AUTHOR_EMAIL],
+            Datadog::Ext::Git::TAG_COMMIT_AUTHOR_DATE => env[Datadog::Ext::Git::ENV_COMMIT_AUTHOR_DATE],
+            Datadog::Ext::Git::TAG_COMMIT_COMMITTER_NAME => env[Datadog::Ext::Git::ENV_COMMIT_COMMITTER_NAME],
+            Datadog::Ext::Git::TAG_COMMIT_COMMITTER_EMAIL => env[Datadog::Ext::Git::ENV_COMMIT_COMMITTER_EMAIL],
+            Datadog::Ext::Git::TAG_COMMIT_COMMITTER_DATE => env[Datadog::Ext::Git::ENV_COMMIT_COMMITTER_DATE]
+          }.reject { |_, v| v.nil? || v.strip.empty? }
+        end
+
+        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.message} at #{Array(e.backtrace).first}")
+          nil
+        end
+
+        def git_repository_url
+          exec_git_command('git ls-remote --get-url')
+        rescue => e
+          Datadog.logger.debug("Unable to read git repository url: #{e.message} at #{Array(e.backtrace).first}")
+          nil
+        end
+
+        def git_commit_message
+          exec_git_command('git show -s --format=%s')
+        rescue => e
+          Datadog.logger.debug("Unable to read git commit message: #{e.message} at #{Array(e.backtrace).first}")
+          nil
+        end
+
+        def git_branch
+          exec_git_command('git rev-parse --abbrev-ref HEAD')
+        rescue => e
+          Datadog.logger.debug("Unable to read git branch: #{e.message} at #{Array(e.backtrace).first}")
+          nil
+        end
+
+        def git_commit_sha
+          exec_git_command('git rev-parse HEAD')
+        rescue => e
+          Datadog.logger.debug("Unable to read git commit SHA: #{e.message} at #{Array(e.backtrace).first}")
+          nil
+        end
+
+        def git_tag
+          exec_git_command('git tag --points-at HEAD')
+        rescue => e
+          Datadog.logger.debug("Unable to read git tag: #{e.message} at #{Array(e.backtrace).first}")
+          nil
+        end
+
+        def git_base_directory
+          exec_git_command('git rev-parse --show-toplevel')
+        rescue => e
+          Datadog.logger.debug("Unable to read git base directory: #{e.message} at #{Array(e.backtrace).first}")
+          nil
+        end
+
+        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
+
+        def extract_local_git
+          env = {
+            TAG_WORKSPACE_PATH => git_base_directory,
+            Datadog::Ext::Git::TAG_REPOSITORY_URL => git_repository_url,
+            Datadog::Ext::Git::TAG_COMMIT_SHA => git_commit_sha,
+            Datadog::Ext::Git::TAG_BRANCH => git_branch,
+            Datadog::Ext::Git::TAG_TAG => git_tag,
+            Datadog::Ext::Git::TAG_COMMIT_MESSAGE => git_commit_message
+          }
+
+          if (commit_users = git_commit_users)
+            env.merge!(
+              Datadog::Ext::Git::TAG_COMMIT_AUTHOR_NAME => commit_users[:author_name],
+              Datadog::Ext::Git::TAG_COMMIT_AUTHOR_EMAIL => commit_users[:author_email],
+              Datadog::Ext::Git::TAG_COMMIT_AUTHOR_DATE => commit_users[:author_date],
+              Datadog::Ext::Git::TAG_COMMIT_COMMITTER_NAME => commit_users[:committer_name],
+              Datadog::Ext::Git::TAG_COMMIT_COMMITTER_EMAIL => commit_users[:committer_email],
+              Datadog::Ext::Git::TAG_COMMIT_COMMITTER_DATE => commit_users[:committer_date]
+            )
+          end
+
+          env
+        end
+
+        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
+
+        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
+      end
+      # rubocop:enable Metrics/ModuleLength:
+    end
+  end
+end

data/lib/datadog/ci/ext/settings.rb

@@ -0,0 +1,11 @@
+# typed: true
+module Datadog
+  module CI
+    module Ext
+      # Defines constants for test tags
+      module Settings
+        ENV_MODE_ENABLED = 'DD_TRACE_CI_MODE_ENABLED'.freeze
+      end
+    end
+  end
+end

data/lib/datadog/ci/ext/test.rb

@@ -0,0 +1,36 @@
+# typed: true
+module Datadog
+  module CI
+    module Ext
+      # Defines constants for test tags
+      module Test
+        CONTEXT_ORIGIN = 'ciapp-test'.freeze
+
+        TAG_ARGUMENTS = 'test.arguments'.freeze
+        TAG_FRAMEWORK = 'test.framework'.freeze
+        TAG_FRAMEWORK_VERSION = 'test.framework_version'.freeze
+        TAG_NAME = 'test.name'.freeze
+        TAG_SKIP_REASON = 'test.skip_reason'.freeze # DEV: Not populated yet
+        TAG_STATUS = 'test.status'.freeze
+        TAG_SUITE = 'test.suite'.freeze
+        TAG_TRAITS = 'test.traits'.freeze
+        TAG_TYPE = 'test.type'.freeze
+
+        # Environment runtime tags
+        TAG_OS_ARCHITECTURE = 'os.architecture'.freeze
+        TAG_OS_PLATFORM = 'os.platform'.freeze
+        TAG_RUNTIME_NAME = 'runtime.name'.freeze
+        TAG_RUNTIME_VERSION = 'runtime.version'.freeze
+
+        # TODO: is there a better place for SPAN_KIND?
+        TAG_SPAN_KIND = 'span.kind'.freeze
+
+        module Status
+          PASS = 'pass'.freeze
+          FAIL = 'fail'.freeze
+          SKIP = 'skip'.freeze
+        end
+      end
+    end
+  end
+end

data/lib/datadog/ci/extensions.rb

@@ -0,0 +1,18 @@
+# typed: true
+require 'ddtrace/configuration/settings'
+require 'ddtrace/configuration/components'
+
+require 'datadog/ci/configuration/settings'
+require 'datadog/ci/configuration/components'
+
+module Datadog
+  module CI
+    # Extends Datadog tracing with CI features
+    module Extensions
+      def self.activate!
+        Datadog::Configuration::Settings.extend(CI::Configuration::Settings)
+        Datadog::Configuration::Components.prepend(CI::Configuration::Components)
+      end
+    end
+  end
+end

data/lib/datadog/ci/test.rb

@@ -0,0 +1,81 @@
+# typed: true
+# frozen_string_literal: true
+
+require 'ddtrace/contrib/analytics'
+
+require 'datadog/ci/ext/app_types'
+require 'datadog/ci/ext/test'
+
+require 'rbconfig'
+
+module Datadog
+  module CI
+    # Common behavior for CI tests
+    module Test
+      # Creates a new span for a CI test
+      def self.trace(tracer, span_name, options = {})
+        span_options = {
+          span_type: Ext::AppTypes::TEST
+        }.merge(options[:span_options] || {})
+
+        if block_given?
+          tracer.trace(span_name, span_options) do |span|
+            set_tags!(span, options)
+            yield(span)
+          end
+        else
+          span = tracer.trace(span_name, span_options)
+          set_tags!(span, options)
+          span
+        end
+      end
+
+      # Adds tags to a CI test span.
+      def self.set_tags!(span, tags = {})
+        tags ||= {}
+
+        # Set default tags
+        span.context.origin = Ext::Test::CONTEXT_ORIGIN if span.context
+        Datadog::Contrib::Analytics.set_measured(span)
+        span.set_tag(Ext::Test::TAG_SPAN_KIND, Ext::AppTypes::TEST)
+
+        # Set environment tags
+        @environment_tags ||= Ext::Environment.tags(ENV)
+        @environment_tags.each { |k, v| span.set_tag(k, v) }
+
+        # Set contextual tags
+        span.set_tag(Ext::Test::TAG_FRAMEWORK, tags[:framework]) if tags[:framework]
+        span.set_tag(Ext::Test::TAG_FRAMEWORK_VERSION, tags[:framework_version]) if tags[:framework_version]
+        span.set_tag(Ext::Test::TAG_NAME, tags[:test_name]) if tags[:test_name]
+        span.set_tag(Ext::Test::TAG_SUITE, tags[:test_suite]) if tags[:test_suite]
+        span.set_tag(Ext::Test::TAG_TYPE, tags[:test_type]) if tags[:test_type]
+
+        set_environment_runtime_tags!(span)
+
+        span
+      end
+
+      def self.passed!(span)
+        span.set_tag(Ext::Test::TAG_STATUS, Ext::Test::Status::PASS)
+      end
+
+      def self.failed!(span, exception = nil)
+        span.status = 1
+        span.set_tag(Ext::Test::TAG_STATUS, Ext::Test::Status::FAIL)
+        span.set_error(exception) unless exception.nil?
+      end
+
+      def self.skipped!(span, exception = nil)
+        span.set_tag(Ext::Test::TAG_STATUS, Ext::Test::Status::SKIP)
+        span.set_error(exception) unless exception.nil?
+      end
+
+      private_class_method def self.set_environment_runtime_tags!(span)
+        span.set_tag(Ext::Test::TAG_OS_ARCHITECTURE, ::RbConfig::CONFIG['host_cpu'])
+        span.set_tag(Ext::Test::TAG_OS_PLATFORM, ::RbConfig::CONFIG['host_os'])
+        span.set_tag(Ext::Test::TAG_RUNTIME_NAME, Core::Environment::Ext::LANG_ENGINE)
+        span.set_tag(Ext::Test::TAG_RUNTIME_VERSION, Core::Environment::Ext::ENGINE_VERSION)
+      end
+    end
+  end
+end

data/lib/datadog/ci.rb

@@ -0,0 +1,17 @@
+# typed: strict
+require 'ddtrace'
+
+module Datadog
+  # Namespace for Datadog CI instrumentation:
+  # e.g. rspec, cucumber, etc...
+  module CI
+  end
+end
+
+# Integrations
+require 'datadog/ci/contrib/cucumber/integration'
+require 'datadog/ci/contrib/rspec/integration'
+
+# Extensions
+require 'datadog/ci/extensions'
+Datadog::CI::Extensions.activate!