datadog-ci 0.1.0

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

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require "json"
+
+require_relative "base"
+
+module Datadog
+  module CI
+    module Ext
+      module Environment
+        module Providers
+          # Github Actions: https://github.com/features/actions
+          # Environment variables docs: https://docs.github.com/en/actions/learn-github-actions/variables#default-environment-variables
+          class GithubActions < Base
+            def provider_name
+              "github"
+            end
+
+            def job_name
+              env["GITHUB_JOB"]
+            end
+
+            def job_url
+              "#{env["GITHUB_SERVER_URL"]}/#{env["GITHUB_REPOSITORY"]}/commit/#{env["GITHUB_SHA"]}/checks"
+            end
+
+            def pipeline_id
+              env["GITHUB_RUN_ID"]
+            end
+
+            def pipeline_name
+              env["GITHUB_WORKFLOW"]
+            end
+
+            def pipeline_number
+              env["GITHUB_RUN_NUMBER"]
+            end
+
+            def pipeline_url
+              res = "#{env["GITHUB_SERVER_URL"]}/#{env["GITHUB_REPOSITORY"]}/actions/runs/#{env["GITHUB_RUN_ID"]}"
+              res = "#{res}/attempts/#{env["GITHUB_RUN_ATTEMPT"]}" if env["GITHUB_RUN_ATTEMPT"]
+              res
+            end
+
+            def workspace_path
+              env["GITHUB_WORKSPACE"]
+            end
+
+            def git_repository_url
+              "#{env["GITHUB_SERVER_URL"]}/#{env["GITHUB_REPOSITORY"]}.git"
+            end
+
+            def git_commit_sha
+              env["GITHUB_SHA"]
+            end
+
+            def git_branch_or_tag
+              ref = env["GITHUB_HEAD_REF"]
+              ref = env["GITHUB_REF"] if ref.nil? || ref.empty?
+              ref
+            end
+
+            def 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 { |_, v| v.nil? }.to_json
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,119 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Datadog
+  module CI
+    module Ext
+      module Environment
+        module Providers
+          # Gitlab CI: https://docs.gitlab.com/ee/ci/
+          # Environment variables docs: https://docs.gitlab.com/ee/ci/variables/predefined_variables.html
+          class Gitlab < Base
+            def provider_name
+              "gitlab"
+            end
+
+            def job_name
+              env["CI_JOB_NAME"]
+            end
+
+            def job_url
+              env["CI_JOB_URL"]
+            end
+
+            def pipeline_id
+              env["CI_PIPELINE_ID"]
+            end
+
+            def pipeline_name
+              env["CI_PROJECT_PATH"]
+            end
+
+            def pipeline_number
+              env["CI_PIPELINE_IID"]
+            end
+
+            def pipeline_url
+              env["CI_PIPELINE_URL"]
+            end
+
+            def stage_name
+              env["CI_JOB_STAGE"]
+            end
+
+            def workspace_path
+              env["CI_PROJECT_DIR"]
+            end
+
+            def node_name
+              env["CI_RUNNER_ID"]
+            end
+
+            def node_labels
+              env["CI_RUNNER_TAGS"]
+            end
+
+            def git_repository_url
+              env["CI_REPOSITORY_URL"]
+            end
+
+            def git_commit_sha
+              env["CI_COMMIT_SHA"]
+            end
+
+            def git_branch
+              env["CI_COMMIT_REF_NAME"]
+            end
+
+            def git_tag
+              env["CI_COMMIT_TAG"]
+            end
+
+            def git_commit_author_name
+              name, _ = extract_name_email
+              name
+            end
+
+            def git_commit_author_email
+              _, email = extract_name_email
+              email
+            end
+
+            def git_commit_author_date
+              env["CI_COMMIT_TIMESTAMP"]
+            end
+
+            def git_commit_message
+              env["CI_COMMIT_MESSAGE"]
+            end
+
+            def 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
+
+            private
+
+            def extract_name_email
+              return @name_email_tuple if defined?(@name_email_tuple)
+
+              name_and_email_string = env["CI_COMMIT_AUTHOR"]
+              if name_and_email_string.include?("<") && (match = /^([^<]*)<([^>]*)>$/.match(name_and_email_string))
+                name = match[1]
+                name = name.strip if name
+                email = match[2]
+                return @name_email_tuple = [name, email] if name && email
+              end
+
+              @name_email_tuple = [nil, name_and_email_string]
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require "json"
+
+require_relative "base"
+require_relative "../../../utils/git"
+
+module Datadog
+  module CI
+    module Ext
+      module Environment
+        module Providers
+          # Jenkins: https://www.jenkins.io/
+          # Environment variables docs: https://www.jenkins.io/doc/book/pipeline/jenkinsfile/#using-environment-variables
+          class Jenkins < Base
+            def provider_name
+              "jenkins"
+            end
+
+            def pipeline_id
+              env["BUILD_TAG"]
+            end
+
+            def pipeline_name
+              if (name = env["JOB_NAME"])
+                name = name.gsub("/#{Datadog::CI::Utils::Git.normalize_ref(git_branch)}", "") if git_branch
+                name = name.split("/").reject { |v| v.nil? || v.include?("=") }.join("/")
+              end
+              name
+            end
+
+            def pipeline_number
+              env["BUILD_NUMBER"]
+            end
+
+            def pipeline_url
+              env["BUILD_URL"]
+            end
+
+            def workspace_path
+              env["WORKSPACE"]
+            end
+
+            def node_name
+              env["NODE_NAME"]
+            end
+
+            def node_labels
+              env["NODE_LABELS"] && env["NODE_LABELS"].split.to_json
+            end
+
+            def git_repository_url
+              env["GIT_URL"] || env["GIT_URL_1"]
+            end
+
+            def git_commit_sha
+              env["GIT_COMMIT"]
+            end
+
+            def git_branch_or_tag
+              env["GIT_BRANCH"]
+            end
+
+            def ci_env_vars
+              {
+                "DD_CUSTOM_TRACE_ID" => env["DD_CUSTOM_TRACE_ID"]
+              }.to_json
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,170 @@
+# frozen_string_literal: true
+
+require "open3"
+
+require_relative "base"
+require_relative "../../git"
+
+module Datadog
+  module CI
+    module Ext
+      module Environment
+        module Providers
+          # As a fallback we try to fetch git information from the local git repository
+          class LocalGit < Base
+            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
+
+            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
+
+            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
+
+            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
+
+            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
+
+            def git_commit_author_name
+              author.name
+            end
+
+            def git_commit_author_email
+              author.email
+            end
+
+            def git_commit_author_date
+              author.date
+            end
+
+            def git_commit_committer_name
+              committer.name
+            end
+
+            def git_commit_committer_email
+              committer.email
+            end
+
+            def git_commit_committer_date
+              committer.date
+            end
+
+            def workspace_path
+              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
+
+            private
+
+            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 author
+              return @author if defined?(@author)
+
+              set_git_commit_users
+              @author
+            end
+
+            def committer
+              return @committer if defined?(@committer)
+
+              set_git_commit_users
+              @committer
+            end
+
+            def set_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'")
+              unless output
+                Datadog.logger.debug(
+                  "Unable to read git commit users: git command output is nil"
+                )
+                @author = @committer = NilUser.new
+                return
+              end
+
+              author_name, author_email, author_timestamp,
+                committer_name, committer_email, committer_timestamp = output.split("\t").each(&:strip!)
+
+              @author = GitUser.new(author_name, author_email, author_timestamp)
+              @committer = GitUser.new(committer_name, committer_email, committer_timestamp)
+            rescue => e
+              Datadog.logger.debug(
+                "Unable to read git commit users: #{e.class.name} #{e.message} at #{Array(e.backtrace).first}"
+              )
+              @author = @committer = NilUser.new
+            end
+
+            class GitUser
+              attr_reader :name, :email, :timestamp
+
+              def initialize(name, email, timestamp)
+                @name = name
+                @email = email
+                @timestamp = timestamp
+              end
+
+              def date
+                return nil if timestamp.nil?
+
+                Time.at(timestamp.to_i).utc.to_datetime.iso8601
+              end
+            end
+
+            class NilUser < GitUser
+              def initialize
+                super(nil, nil, nil)
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Datadog
+  module CI
+    module Ext
+      module Environment
+        module Providers
+          # Teamcity: https://www.jetbrains.com/teamcity/
+          # Environment variables docs: https://www.jetbrains.com/help/teamcity/predefined-build-parameters.html
+          class Teamcity < Base
+            def provider_name
+              "teamcity"
+            end
+
+            def job_name
+              env["TEAMCITY_BUILDCONF_NAME"]
+            end
+
+            def job_url
+              env["BUILD_URL"]
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Datadog
+  module CI
+    module Ext
+      module Environment
+        module Providers
+          # Travis CI: https://www.travis-ci.com/
+          # Environment variables docs: https://docs.travis-ci.com/user/environment-variables#default-environment-variables
+          class Travis < Base
+            def provider_name
+              "travisci"
+            end
+
+            def job_url
+              env["TRAVIS_JOB_WEB_URL"]
+            end
+
+            def pipeline_id
+              env["TRAVIS_BUILD_ID"]
+            end
+
+            def pipeline_name
+              env["TRAVIS_REPO_SLUG"]
+            end
+
+            def pipeline_number
+              env["TRAVIS_BUILD_NUMBER"]
+            end
+
+            def pipeline_url
+              env["TRAVIS_BUILD_WEB_URL"]
+            end
+
+            def workspace_path
+              env["TRAVIS_BUILD_DIR"]
+            end
+
+            def git_repository_url
+              "https://github.com/#{env["TRAVIS_REPO_SLUG"]}.git"
+            end
+
+            def git_commit_sha
+              env["TRAVIS_COMMIT"]
+            end
+
+            def git_branch
+              env["TRAVIS_PULL_REQUEST_BRANCH"] || env["TRAVIS_BRANCH"]
+            end
+
+            def git_tag
+              env["TRAVIS_TAG"]
+            end
+
+            def git_commit_message
+              env["TRAVIS_COMMIT_MESSAGE"]
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require_relative "base"
+require_relative "../../git"
+
+module Datadog
+  module CI
+    module Ext
+      module Environment
+        module Providers
+          # Parses user defined git data from the environment variables
+          # User documentation: https://docs.datadoghq.com/continuous_integration/troubleshooting/#data-appears-in-test-runs-but-not-tests
+          class UserDefinedTags < Base
+            def git_repository_url
+              env[Git::ENV_REPOSITORY_URL]
+            end
+
+            def git_commit_sha
+              env[Git::ENV_COMMIT_SHA]
+            end
+
+            def git_branch
+              env[Git::ENV_BRANCH]
+            end
+
+            def git_tag
+              env[Git::ENV_TAG]
+            end
+
+            def git_commit_message
+              env[Git::ENV_COMMIT_MESSAGE]
+            end
+
+            def git_commit_author_name
+              env[Git::ENV_COMMIT_AUTHOR_NAME]
+            end
+
+            def git_commit_author_email
+              env[Git::ENV_COMMIT_AUTHOR_EMAIL]
+            end
+
+            def git_commit_author_date
+              env[Git::ENV_COMMIT_AUTHOR_DATE]
+            end
+
+            def git_commit_committer_name
+              env[Git::ENV_COMMIT_COMMITTER_NAME]
+            end
+
+            def git_commit_committer_email
+              env[Git::ENV_COMMIT_COMMITTER_EMAIL]
+            end
+
+            def git_commit_committer_date
+              env[Git::ENV_COMMIT_COMMITTER_DATE]
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+require_relative "providers/base"
+require_relative "providers/appveyor"
+require_relative "providers/azure"
+require_relative "providers/bitbucket"
+require_relative "providers/bitrise"
+require_relative "providers/buddy"
+require_relative "providers/buildkite"
+require_relative "providers/circleci"
+require_relative "providers/codefresh"
+require_relative "providers/github_actions"
+require_relative "providers/gitlab"
+require_relative "providers/jenkins"
+require_relative "providers/teamcity"
+require_relative "providers/travis"
+
+require_relative "providers/local_git"
+require_relative "providers/user_defined_tags"
+
+module Datadog
+  module CI
+    module Ext
+      module Environment
+        module Providers
+          PROVIDERS = [
+            ["APPVEYOR", Providers::Appveyor],
+            ["TF_BUILD", Providers::Azure],
+            ["BITBUCKET_COMMIT", Providers::Bitbucket],
+            ["BITRISE_BUILD_SLUG", Providers::Bitrise],
+            ["BUDDY", Providers::Buddy],
+            ["BUILDKITE", Providers::Buildkite],
+            ["CIRCLECI", Providers::Circleci],
+            ["CF_BUILD_ID", Providers::Codefresh],
+            ["GITHUB_SHA", Providers::GithubActions],
+            ["GITLAB_CI", Providers::Gitlab],
+            ["JENKINS_URL", Providers::Jenkins],
+            ["TEAMCITY_VERSION", Providers::Teamcity],
+            ["TRAVIS", Providers::Travis]
+          ]
+
+          def self.for_environment(env)
+            _, provider_klass = PROVIDERS.find { |provider_env_var, _| env.key?(provider_env_var) }
+            provider_klass = Providers::Base if provider_klass.nil?
+
+            provider_klass.new(env)
+          end
+        end
+      end
+    end
+  end
+end