datadog-ci 0.1.0

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

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+require "json"
+
+require_relative "base"
+
+module Datadog
+  module CI
+    module Ext
+      module Environment
+        module Providers
+          # Azure Pipelines: https://azure.microsoft.com/en-us/products/devops/pipelines
+          # Environment variables docs: https://learn.microsoft.com/en-us/azure/devops/pipelines/build/variables?view=azure-devops&tabs=yaml
+          class Azure < Base
+            def provider_name
+              "azurepipelines"
+            end
+
+            def pipeline_url
+              return unless url_defined?
+
+              @pipeline_url ||= "#{team_foundation_server_uri}#{team_project_id}/_build/results?buildId=#{build_id}"
+            end
+
+            def job_url
+              return unless url_defined?
+
+              @job_url ||= "#{pipeline_url}&view=logs&j=#{env["SYSTEM_JOBID"]}&t=#{env["SYSTEM_TASKINSTANCEID"]}"
+            end
+
+            def workspace_path
+              env["BUILD_SOURCESDIRECTORY"]
+            end
+
+            def pipeline_id
+              build_id
+            end
+
+            def pipeline_number
+              build_id
+            end
+
+            def pipeline_name
+              env["BUILD_DEFINITIONNAME"]
+            end
+
+            def stage_name
+              env["SYSTEM_STAGEDISPLAYNAME"]
+            end
+
+            def job_name
+              env["SYSTEM_JOBDISPLAYNAME"]
+            end
+
+            def git_repository_url
+              env["SYSTEM_PULLREQUEST_SOURCEREPOSITORYURI"] || env["BUILD_REPOSITORY_URI"]
+            end
+
+            def git_commit_sha
+              env["SYSTEM_PULLREQUEST_SOURCECOMMITID"] || env["BUILD_SOURCEVERSION"]
+            end
+
+            def git_branch_or_tag
+              env["SYSTEM_PULLREQUEST_SOURCEBRANCH"] || env["BUILD_SOURCEBRANCH"] || env["BUILD_SOURCEBRANCHNAME"]
+            end
+
+            def git_commit_author_name
+              env["BUILD_REQUESTEDFORID"]
+            end
+
+            def git_commit_author_email
+              env["BUILD_REQUESTEDFOREMAIL"]
+            end
+
+            def git_commit_message
+              env["BUILD_SOURCEVERSIONMESSAGE"]
+            end
+
+            def ci_env_vars
+              {
+                "SYSTEM_TEAMPROJECTID" => env["SYSTEM_TEAMPROJECTID"],
+                "BUILD_BUILDID" => env["BUILD_BUILDID"],
+                "SYSTEM_JOBID" => env["SYSTEM_JOBID"]
+              }.to_json
+            end
+
+            private
+
+            def build_id
+              env["BUILD_BUILDID"]
+            end
+
+            def team_foundation_server_uri
+              env["SYSTEM_TEAMFOUNDATIONSERVERURI"]
+            end
+
+            def team_project_id
+              env["SYSTEM_TEAMPROJECTID"]
+            end
+
+            def url_defined?
+              !(build_id && team_foundation_server_uri && team_project_id).nil?
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,115 @@
+# frozen_string_literal: true
+
+module Datadog
+  module CI
+    module Ext
+      module Environment
+        module Providers
+          class Base
+            attr_reader :env
+
+            def initialize(env)
+              @env = env
+            end
+
+            def job_name
+            end
+
+            def job_url
+            end
+
+            def pipeline_id
+            end
+
+            def pipeline_name
+            end
+
+            def pipeline_number
+            end
+
+            def pipeline_url
+            end
+
+            def provider_name
+            end
+
+            def stage_name
+            end
+
+            def workspace_path
+            end
+
+            def node_labels
+            end
+
+            def node_name
+            end
+
+            def ci_env_vars
+            end
+
+            def git_branch
+              return @branch if defined?(@branch)
+
+              set_branch_and_tag
+              @branch
+            end
+
+            def git_repository_url
+            end
+
+            def git_tag
+              return @tag if defined?(@tag)
+
+              set_branch_and_tag
+              @tag
+            end
+
+            def git_branch_or_tag
+            end
+
+            def git_commit_author_date
+            end
+
+            def git_commit_author_email
+            end
+
+            def git_commit_author_name
+            end
+
+            def git_commit_committer_date
+            end
+
+            def git_commit_committer_email
+            end
+
+            def git_commit_committer_name
+            end
+
+            def git_commit_message
+            end
+
+            def git_commit_sha
+            end
+
+            private
+
+            def set_branch_and_tag
+              branch_or_tag_string = git_branch_or_tag
+              @branch = @tag = nil
+
+              # @type var branch_or_tag_string: untyped
+              if branch_or_tag_string && branch_or_tag_string.include?("tags/")
+                @tag = branch_or_tag_string
+              else
+                @branch = branch_or_tag_string
+              end
+
+              [@branch, @tag]
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Datadog
+  module CI
+    module Ext
+      module Environment
+        module Providers
+          # Bitbucket Pipelines: https://bitbucket.org/product/features/pipelines
+          # Environment variables docs: https://support.atlassian.com/bitbucket-cloud/docs/variables-and-secrets/
+          class Bitbucket < Base
+            # overridden methods
+            def provider_name
+              "bitbucket"
+            end
+
+            def pipeline_id
+              env["BITBUCKET_PIPELINE_UUID"] ? env["BITBUCKET_PIPELINE_UUID"].tr("{}", "") : nil
+            end
+
+            def pipeline_name
+              env["BITBUCKET_REPO_FULL_NAME"]
+            end
+
+            def pipeline_number
+              env["BITBUCKET_BUILD_NUMBER"]
+            end
+
+            def pipeline_url
+              url
+            end
+
+            def job_url
+              url
+            end
+
+            def workspace_path
+              env["BITBUCKET_CLONE_DIR"]
+            end
+
+            def git_repository_url
+              env["BITBUCKET_GIT_SSH_ORIGIN"] || env["BITBUCKET_GIT_HTTP_ORIGIN"]
+            end
+
+            def git_commit_sha
+              env["BITBUCKET_COMMIT"]
+            end
+
+            def git_branch
+              env["BITBUCKET_BRANCH"]
+            end
+
+            def git_tag
+              env["BITBUCKET_TAG"]
+            end
+
+            private
+
+            def url
+              "https://bitbucket.org/#{env["BITBUCKET_REPO_FULL_NAME"]}/addon/pipelines/home#" \
+                "!/results/#{env["BITBUCKET_BUILD_NUMBER"]}"
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Datadog
+  module CI
+    module Ext
+      module Environment
+        module Providers
+          # Bitrise: https://bitrise.io/
+          # Environment variables docs: https://devcenter.bitrise.io/en/references/available-environment-variables.html
+          class Bitrise < Base
+            def provider_name
+              "bitrise"
+            end
+
+            def pipeline_id
+              env["BITRISE_BUILD_SLUG"]
+            end
+
+            def pipeline_name
+              env["BITRISE_TRIGGERED_WORKFLOW_ID"]
+            end
+
+            def pipeline_number
+              env["BITRISE_BUILD_NUMBER"]
+            end
+
+            def pipeline_url
+              env["BITRISE_BUILD_URL"]
+            end
+
+            def workspace_path
+              env["BITRISE_SOURCE_DIR"]
+            end
+
+            def git_repository_url
+              env["GIT_REPOSITORY_URL"]
+            end
+
+            def git_commit_sha
+              env["BITRISE_GIT_COMMIT"] || env["GIT_CLONE_COMMIT_HASH"]
+            end
+
+            def git_branch
+              env["BITRISEIO_GIT_BRANCH_DEST"] || env["BITRISE_GIT_BRANCH"]
+            end
+
+            def git_tag
+              env["BITRISE_GIT_TAG"]
+            end
+
+            def git_commit_message
+              env["BITRISE_GIT_MESSAGE"]
+            end
+
+            def git_commit_author_name
+              env["GIT_CLONE_COMMIT_AUTHOR_NAME"]
+            end
+
+            def git_commit_author_email
+              env["GIT_CLONE_COMMIT_AUTHOR_EMAIL"]
+            end
+
+            def git_commit_committer_name
+              env["GIT_CLONE_COMMIT_COMMITER_NAME"]
+            end
+
+            def git_commit_committer_email
+              env["GIT_CLONE_COMMIT_COMMITER_EMAIL"] || env["GIT_CLONE_COMMIT_COMMITER_NAME"]
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Datadog
+  module CI
+    module Ext
+      module Environment
+        module Providers
+          # Buddy: https://buddy.works/
+          # Environment variables docs: https://buddy.works/docs/pipelines/environment-variables
+          class Buddy < Base
+            def provider_name
+              "buddy"
+            end
+
+            def pipeline_id
+              "#{env["BUDDY_PIPELINE_ID"]}/#{env["BUDDY_EXECUTION_ID"]}"
+            end
+
+            def pipeline_name
+              env["BUDDY_PIPELINE_NAME"]
+            end
+
+            def pipeline_number
+              env["BUDDY_EXECUTION_ID"]
+            end
+
+            def pipeline_url
+              env["BUDDY_EXECUTION_URL"]
+            end
+
+            def workspace_path
+              env["CI_WORKSPACE_PATH"]
+            end
+
+            def git_repository_url
+              env["BUDDY_SCM_URL"]
+            end
+
+            def git_commit_sha
+              env["BUDDY_EXECUTION_REVISION"]
+            end
+
+            def git_branch
+              env["BUDDY_EXECUTION_BRANCH"]
+            end
+
+            def git_tag
+              env["BUDDY_EXECUTION_TAG"]
+            end
+
+            def git_commit_message
+              env["BUDDY_EXECUTION_REVISION_MESSAGE"]
+            end
+
+            def git_commit_committer_name
+              env["BUDDY_EXECUTION_REVISION_COMMITTER_NAME"]
+            end
+
+            def git_commit_committer_email
+              env["BUDDY_EXECUTION_REVISION_COMMITTER_EMAIL"]
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+require "json"
+
+require_relative "base"
+
+module Datadog
+  module CI
+    module Ext
+      module Environment
+        module Providers
+          # Buildkite: https://buildkite.com/
+          # Environment variables docs: https://buildkite.com/docs/pipelines/environment-variables
+          class Buildkite < Base
+            def provider_name
+              "buildkite"
+            end
+
+            def job_url
+              "#{env["BUILDKITE_BUILD_URL"]}##{env["BUILDKITE_JOB_ID"]}"
+            end
+
+            def pipeline_id
+              env["BUILDKITE_BUILD_ID"]
+            end
+
+            def pipeline_name
+              env["BUILDKITE_PIPELINE_SLUG"]
+            end
+
+            def pipeline_number
+              env["BUILDKITE_BUILD_NUMBER"]
+            end
+
+            def pipeline_url
+              env["BUILDKITE_BUILD_URL"]
+            end
+
+            def node_name
+              env["BUILDKITE_AGENT_ID"]
+            end
+
+            def node_labels
+              labels = env
+                .select { |key| key.start_with?("BUILDKITE_AGENT_META_DATA_") }
+                .map { |key, value| "#{key.to_s.sub("BUILDKITE_AGENT_META_DATA_", "").downcase}:#{value}" }
+                .sort_by(&:length)
+
+              labels.to_json unless labels.empty?
+            end
+
+            def workspace_path
+              env["BUILDKITE_BUILD_CHECKOUT_PATH"]
+            end
+
+            def git_repository_url
+              env["BUILDKITE_REPO"]
+            end
+
+            def git_commit_sha
+              env["BUILDKITE_COMMIT"]
+            end
+
+            def git_branch
+              env["BUILDKITE_BRANCH"]
+            end
+
+            def git_tag
+              env["BUILDKITE_TAG"]
+            end
+
+            def git_commit_author_name
+              env["BUILDKITE_BUILD_AUTHOR"]
+            end
+
+            def git_commit_author_email
+              env["BUILDKITE_BUILD_AUTHOR_EMAIL"]
+            end
+
+            def git_commit_message
+              env["BUILDKITE_MESSAGE"]
+            end
+
+            def ci_env_vars
+              {
+                "BUILDKITE_BUILD_ID" => env["BUILDKITE_BUILD_ID"],
+                "BUILDKITE_JOB_ID" => env["BUILDKITE_JOB_ID"]
+              }.to_json
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require "json"
+
+require_relative "base"
+
+module Datadog
+  module CI
+    module Ext
+      module Environment
+        module Providers
+          # Circle CI: https://circleci.com/
+          # Environment variables docs: https://circleci.com/docs/variables/#built-in-environment-variables
+          class Circleci < Base
+            def provider_name
+              "circleci"
+            end
+
+            def job_url
+              env["CIRCLE_BUILD_URL"]
+            end
+
+            def job_name
+              env["CIRCLE_JOB"]
+            end
+
+            def pipeline_id
+              env["CIRCLE_WORKFLOW_ID"]
+            end
+
+            def pipeline_name
+              env["CIRCLE_PROJECT_REPONAME"]
+            end
+
+            def pipeline_url
+              "https://app.circleci.com/pipelines/workflows/#{env["CIRCLE_WORKFLOW_ID"]}"
+            end
+
+            def workspace_path
+              env["CIRCLE_WORKING_DIRECTORY"]
+            end
+
+            def git_repository_url
+              env["CIRCLE_REPOSITORY_URL"]
+            end
+
+            def git_commit_sha
+              env["CIRCLE_SHA1"]
+            end
+
+            def git_branch
+              env["CIRCLE_BRANCH"]
+            end
+
+            def git_tag
+              env["CIRCLE_TAG"]
+            end
+
+            def git_commit_author_name
+              env["BUILD_REQUESTEDFORID"]
+            end
+
+            def git_commit_author_email
+              env["BUILD_REQUESTEDFOREMAIL"]
+            end
+
+            def git_commit_message
+              env["BUILD_SOURCEVERSIONMESSAGE"]
+            end
+
+            def ci_env_vars
+              {
+                "CIRCLE_WORKFLOW_ID" => env["CIRCLE_WORKFLOW_ID"],
+                "CIRCLE_BUILD_NUM" => env["CIRCLE_BUILD_NUM"]
+              }.to_json
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+require "json"
+
+require_relative "base"
+
+module Datadog
+  module CI
+    module Ext
+      module Environment
+        module Providers
+          # Codefresh: https://codefresh.io/
+          # Environment variables docs: https://codefresh.io/docs/docs/pipelines/variables/#export-variables-to-all-steps-with-cf_export
+          class Codefresh < Base
+            def provider_name
+              "codefresh"
+            end
+
+            def job_name
+              env["CF_STEP_NAME"]
+            end
+
+            def pipeline_id
+              env["CF_BUILD_ID"]
+            end
+
+            def pipeline_name
+              env["CF_PIPELINE_NAME"]
+            end
+
+            def pipeline_url
+              env["CF_BUILD_URL"]
+            end
+
+            def git_branch_or_tag
+              env["CF_BRANCH"]
+            end
+
+            def ci_env_vars
+              {
+                "CF_BUILD_ID" => env["CF_BUILD_ID"]
+              }.to_json
+            end
+          end
+        end
+      end
+    end
+  end
+end