datadog-ci 0.1.0

data/lib/datadog/ci/contrib/cucumber/integration.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require_relative "configuration/settings"
+require_relative "patcher"
+
+module Datadog
+  module CI
+    module Contrib
+      module Cucumber
+        # Description of Cucumber integration
+        class Integration
+          include Datadog::Tracing::Contrib::Integration
+
+          MINIMUM_VERSION = Gem::Version.new("3.0.0")
+
+          register_as :cucumber, auto_patch: true
+
+          def self.version
+            Gem.loaded_specs["cucumber"] \
+              && Gem.loaded_specs["cucumber"].version
+          end
+
+          def self.loaded?
+            !defined?(::Cucumber).nil? && !defined?(::Cucumber::Runtime).nil?
+          end
+
+          def self.compatible?
+            super && version >= MINIMUM_VERSION
+          end
+
+          # test environments should not auto instrument test libraries
+          def auto_instrument?
+            false
+          end
+
+          def new_configuration
+            Configuration::Settings.new
+          end
+
+          def patcher
+            Patcher
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/ci/contrib/cucumber/patcher.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "datadog/tracing/contrib/patcher"
+require_relative "instrumentation"
+
+module Datadog
+  module CI
+    module Contrib
+      module Cucumber
+        # Patcher enables patching of 'cucumber' module.
+        module Patcher
+          include Datadog::Tracing::Contrib::Patcher
+
+          module_function
+
+          def target_version
+            Integration.version
+          end
+
+          def patch
+            ::Cucumber::Runtime.include(Instrumentation)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/ci/contrib/minitest/configuration/settings.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "../ext"
+
+require "datadog/tracing/contrib/configuration/settings"
+
+module Datadog
+  module CI
+    module Contrib
+      module Minitest
+        module Configuration
+          # Custom settings for the Minitest integration
+          # TODO: mark as `@public_api` when GA
+          class Settings < Datadog::Tracing::Contrib::Configuration::Settings
+            option :enabled do |o|
+              o.type :bool
+              o.env Ext::ENV_ENABLED
+              o.default true
+            end
+
+            option :service_name do |o|
+              o.type :string
+              o.default { Datadog.configuration.service_without_fallback || Ext::SERVICE_NAME }
+            end
+
+            option :operation_name do |o|
+              o.type :string
+              o.env Ext::ENV_OPERATION_NAME
+              o.default Ext::OPERATION_NAME
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/ci/contrib/minitest/ext.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Datadog
+  module CI
+    module Contrib
+      module Minitest
+        # Minitest integration constants
+        # TODO: mark as `@public_api` when GA, to protect from resource and tag name changes.
+        module Ext
+          APP = "minitest"
+          ENV_ENABLED = "DD_TRACE_MINITEST_ENABLED"
+          ENV_OPERATION_NAME = "DD_TRACE_MINITEST_OPERATION_NAME"
+          FRAMEWORK = "minitest"
+          OPERATION_NAME = "minitest.test"
+          SERVICE_NAME = "minitest"
+          TEST_TYPE = "test"
+        end
+      end
+    end
+  end
+end

data/lib/datadog/ci/contrib/minitest/hooks.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Datadog
+  module CI
+    module Contrib
+      module Minitest
+        # Lifecycle hooks to instrument Minitest::Test
+        module Hooks
+          def before_setup
+            super
+            return unless configuration[:enabled]
+
+            test_name = "#{class_name}##{name}"
+
+            path, = method(name).source_location
+            test_suite = Pathname.new(path.to_s).relative_path_from(Pathname.pwd).to_s
+
+            span = CI::Test.trace(
+              configuration[:operation_name],
+              {
+                span_options: {
+                  resource: test_name,
+                  service: configuration[:service_name]
+                },
+                framework: Ext::FRAMEWORK,
+                framework_version: CI::Contrib::Minitest::Integration.version.to_s,
+                test_name: test_name,
+                test_suite: test_suite,
+                test_type: Ext::TEST_TYPE
+              }
+            )
+
+            Thread.current[:_datadog_test_span] = span
+          end
+
+          def after_teardown
+            span = Thread.current[:_datadog_test_span]
+            return super unless span
+
+            Thread.current[:_datadog_test_span] = nil
+
+            case result_code
+            when "."
+              CI::Test.passed!(span)
+            when "E", "F"
+              CI::Test.failed!(span, failure)
+            when "S"
+              CI::Test.skipped!(span)
+              span.set_tag(CI::Ext::Test::TAG_SKIP_REASON, failure.message)
+            end
+
+            span.finish
+
+            super
+          end
+
+          private
+
+          def configuration
+            ::Datadog.configuration.ci[:minitest]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/ci/contrib/minitest/integration.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require_relative "configuration/settings"
+require_relative "patcher"
+
+module Datadog
+  module CI
+    module Contrib
+      module Minitest
+        # Description of Minitest integration
+        class Integration
+          include Datadog::Tracing::Contrib::Integration
+
+          MINIMUM_VERSION = Gem::Version.new("5.0.0")
+
+          register_as :minitest, auto_patch: true
+
+          def self.version
+            Gem.loaded_specs["minitest"] && Gem.loaded_specs["minitest"].version
+          end
+
+          def self.loaded?
+            !defined?(::Minitest).nil?
+          end
+
+          def self.compatible?
+            super && version >= MINIMUM_VERSION
+          end
+
+          # test environments should not auto instrument test libraries
+          def auto_instrument?
+            false
+          end
+
+          def new_configuration
+            Configuration::Settings.new
+          end
+
+          def patcher
+            Patcher
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/ci/contrib/minitest/patcher.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require_relative "hooks"
+
+module Datadog
+  module CI
+    module Contrib
+      module Minitest
+        # Patcher enables patching of 'minitest' module.
+        module Patcher
+          include Datadog::Tracing::Contrib::Patcher
+
+          module_function
+
+          def target_version
+            Integration.version
+          end
+
+          def patch
+            ::Minitest::Test.include(Hooks)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/ci/contrib/rspec/configuration/settings.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "../ext"
+
+require "datadog/tracing/contrib/configuration/settings"
+
+module Datadog
+  module CI
+    module Contrib
+      module RSpec
+        module Configuration
+          # Custom settings for the RSpec integration
+          # TODO: mark as `@public_api` when GA
+          class Settings < Datadog::Tracing::Contrib::Configuration::Settings
+            option :enabled do |o|
+              o.type :bool
+              o.env Ext::ENV_ENABLED
+              o.default true
+            end
+
+            option :service_name do |o|
+              o.type :string
+              o.default { Datadog.configuration.service_without_fallback || Ext::SERVICE_NAME }
+            end
+
+            option :operation_name do |o|
+              o.type :string
+              o.env Ext::ENV_OPERATION_NAME
+              o.default Ext::OPERATION_NAME
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/ci/contrib/rspec/example.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+require_relative "../../test"
+
+require_relative "../../ext/app_types"
+require_relative "../../ext/environment"
+require_relative "../../ext/test"
+require_relative "ext"
+
+module Datadog
+  module CI
+    module Contrib
+      module RSpec
+        # Instrument RSpec::Core::Example
+        module Example
+          def self.included(base)
+            base.prepend(InstanceMethods)
+          end
+
+          # Instance methods for configuration
+          module InstanceMethods
+            def run(example_group_instance, reporter)
+              return super unless configuration[:enabled]
+
+              test_name = full_description.strip
+              if metadata[:description].empty?
+                # for unnamed it blocks this appends something like "example at ./spec/some_spec.rb:10"
+                test_name += " #{description}"
+              end
+
+              CI::Test.trace(
+                configuration[:operation_name],
+                {
+                  span_options: {
+                    resource: test_name,
+                    service: configuration[:service_name]
+                  },
+                  framework: Ext::FRAMEWORK,
+                  framework_version: CI::Contrib::RSpec::Integration.version.to_s,
+                  test_name: test_name,
+                  test_suite: metadata[:example_group][:file_path],
+                  test_type: Ext::TEST_TYPE
+                }
+              ) do |span|
+                result = super
+
+                case execution_result.status
+                when :passed
+                  CI::Test.passed!(span)
+                when :failed
+                  CI::Test.failed!(span, execution_result.exception)
+                else
+                  CI::Test.skipped!(span, execution_result.exception) if execution_result.example_skipped?
+                end
+
+                result
+              end
+            end
+
+            private
+
+            def configuration
+              Datadog.configuration.ci[:rspec]
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/ci/contrib/rspec/ext.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Datadog
+  module CI
+    module Contrib
+      module RSpec
+        # RSpec integration constants
+        # TODO: mark as `@public_api` when GA, to protect from resource and tag name changes.
+        module Ext
+          APP = "rspec"
+          ENV_ENABLED = "DD_TRACE_RSPEC_ENABLED"
+          ENV_OPERATION_NAME = "DD_TRACE_RSPEC_OPERATION_NAME"
+          FRAMEWORK = "rspec"
+          OPERATION_NAME = "rspec.example"
+          SERVICE_NAME = "rspec"
+          TEST_TYPE = "test"
+        end
+      end
+    end
+  end
+end

data/lib/datadog/ci/contrib/rspec/integration.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require "datadog/tracing/contrib/integration"
+
+require_relative "configuration/settings"
+require_relative "patcher"
+
+module Datadog
+  module CI
+    module Contrib
+      module RSpec
+        # Description of RSpec integration
+        class Integration
+          include Datadog::Tracing::Contrib::Integration
+
+          MINIMUM_VERSION = Gem::Version.new("3.0.0")
+
+          register_as :rspec, auto_patch: true
+
+          def self.version
+            Gem.loaded_specs["rspec-core"] \
+              && Gem.loaded_specs["rspec-core"].version
+          end
+
+          def self.loaded?
+            !defined?(::RSpec).nil? && !defined?(::RSpec::Core).nil? && \
+              !defined?(::RSpec::Core::Example).nil?
+          end
+
+          def self.compatible?
+            super && version >= MINIMUM_VERSION
+          end
+
+          # test environments should not auto instrument test libraries
+          def auto_instrument?
+            false
+          end
+
+          def new_configuration
+            Configuration::Settings.new
+          end
+
+          def patcher
+            Patcher
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/ci/contrib/rspec/patcher.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "datadog/tracing/contrib/patcher"
+require_relative "example"
+
+module Datadog
+  module CI
+    module Contrib
+      module RSpec
+        # Patcher enables patching of 'rspec' module.
+        module Patcher
+          include Datadog::Tracing::Contrib::Patcher
+
+          module_function
+
+          def target_version
+            Integration.version
+          end
+
+          def patch
+            ::RSpec::Core::Example.include(Example)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Datadog
+  module CI
+    module Ext
+      module AppTypes
+        TYPE_TEST = "test"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,101 @@
+# frozen_string_literal: true
+
+require_relative "../environment"
+require_relative "../git"
+require_relative "../../utils/git"
+require_relative "providers"
+
+module Datadog
+  module CI
+    module Ext
+      module Environment
+        # Provider is a specific CI provider like Azure Pipelines, Github Actions, Gitlab CI, etc
+        # Extractor is responsible for detecting where pipeline is being executed based on environment vars
+        # and return the specific extractor that is able to return environment- and git-specific tags
+        class Extractor
+          def initialize(env, provider_klass: nil)
+            @env = env
+            @provider = provider_klass ? provider_klass.new(env) : Providers.for_environment(env)
+          end
+
+          def tags
+            return @tags if defined?(@tags)
+
+            @tags = {
+              Environment::TAG_JOB_NAME => @provider.job_name,
+              Environment::TAG_JOB_URL => @provider.job_url,
+              Environment::TAG_PIPELINE_ID => @provider.pipeline_id,
+              Environment::TAG_PIPELINE_NAME => @provider.pipeline_name,
+              Environment::TAG_PIPELINE_NUMBER => @provider.pipeline_number,
+              Environment::TAG_PIPELINE_URL => @provider.pipeline_url,
+              Environment::TAG_PROVIDER_NAME => @provider.provider_name,
+              Environment::TAG_STAGE_NAME => @provider.stage_name,
+              Environment::TAG_WORKSPACE_PATH => @provider.workspace_path,
+              Environment::TAG_NODE_LABELS => @provider.node_labels,
+              Environment::TAG_NODE_NAME => @provider.node_name,
+              Environment::TAG_CI_ENV_VARS => @provider.ci_env_vars,
+
+              Git::TAG_BRANCH => @provider.git_branch,
+              Git::TAG_REPOSITORY_URL => @provider.git_repository_url,
+              Git::TAG_TAG => @provider.git_tag,
+              Git::TAG_COMMIT_AUTHOR_DATE => @provider.git_commit_author_date,
+              Git::TAG_COMMIT_AUTHOR_EMAIL => @provider.git_commit_author_email,
+              Git::TAG_COMMIT_AUTHOR_NAME => @provider.git_commit_author_name,
+              Git::TAG_COMMIT_COMMITTER_DATE => @provider.git_commit_committer_date,
+              Git::TAG_COMMIT_COMMITTER_EMAIL => @provider.git_commit_committer_email,
+              Git::TAG_COMMIT_COMMITTER_NAME => @provider.git_commit_committer_name,
+              Git::TAG_COMMIT_MESSAGE => @provider.git_commit_message,
+              Git::TAG_COMMIT_SHA => @provider.git_commit_sha
+            }
+
+            # Normalize Git references and filter sensitive data
+            normalize_git!
+            # Expand ~
+            expand_workspace!
+
+            # remove empty tags
+            @tags.reject! do |_, v|
+              # setting type of v here to untyped because steep does not
+              # understand `v.nil? || something`
+
+              # @type var v: untyped
+              v.nil? || v.strip.empty?
+            end
+
+            @tags
+          end
+
+          private
+
+          def normalize_git!
+            branch_ref = @tags[Git::TAG_BRANCH]
+            if Datadog::CI::Utils::Git.is_git_tag?(branch_ref)
+              @tags[Git::TAG_TAG] = branch_ref
+              @tags.delete(Git::TAG_BRANCH)
+            end
+
+            @tags[Git::TAG_TAG] = Datadog::CI::Utils::Git.normalize_ref(@tags[Git::TAG_TAG])
+            @tags[Git::TAG_BRANCH] = Datadog::CI::Utils::Git.normalize_ref(@tags[Git::TAG_BRANCH])
+            @tags[Git::TAG_REPOSITORY_URL] = filter_sensitive_info(
+              @tags[Git::TAG_REPOSITORY_URL]
+            )
+          end
+
+          def expand_workspace!
+            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
+          end
+
+          def filter_sensitive_info(url)
+            return nil if url.nil?
+
+            url.gsub(%r{(https?://)[^/]*@}, '\1')
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,98 @@
+# frozen_string_literal: true
+
+require_relative "base"
+
+module Datadog
+  module CI
+    module Ext
+      module Environment
+        module Providers
+          # Appveyor: https://www.appveyor.com/
+          # Environment variables docs: https://www.appveyor.com/docs/environment-variables/
+          class Appveyor < Base
+            def provider_name
+              "appveyor"
+            end
+
+            def pipeline_url
+              url
+            end
+
+            def job_url
+              url
+            end
+
+            def workspace_path
+              env["APPVEYOR_BUILD_FOLDER"]
+            end
+
+            def pipeline_id
+              env["APPVEYOR_BUILD_ID"]
+            end
+
+            def pipeline_name
+              env["APPVEYOR_REPO_NAME"]
+            end
+
+            def pipeline_number
+              env["APPVEYOR_BUILD_NUMBER"]
+            end
+
+            def git_repository_url
+              return nil unless github_repo_provider?
+
+              "https://github.com/#{env["APPVEYOR_REPO_NAME"]}.git"
+            end
+
+            def git_commit_sha
+              return nil unless github_repo_provider?
+
+              env["APPVEYOR_REPO_COMMIT"]
+            end
+
+            def git_branch
+              return nil unless github_repo_provider?
+
+              env["APPVEYOR_PULL_REQUEST_HEAD_REPO_BRANCH"] || env["APPVEYOR_REPO_BRANCH"]
+            end
+
+            def git_tag
+              return nil unless github_repo_provider?
+
+              env["APPVEYOR_REPO_TAG_NAME"]
+            end
+
+            def git_commit_author_name
+              env["APPVEYOR_REPO_COMMIT_AUTHOR"]
+            end
+
+            def git_commit_author_email
+              env["APPVEYOR_REPO_COMMIT_AUTHOR_EMAIL"]
+            end
+
+            def git_commit_message
+              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
+              commit_message
+            end
+
+            private
+
+            def github_repo_provider?
+              return @github_repo_provider if defined?(@github_repo_provider)
+
+              @github_repo_provider = env["APPVEYOR_REPO_PROVIDER"] == "github"
+            end
+
+            def url
+              @url ||= "https://ci.appveyor.com/project/#{env["APPVEYOR_REPO_NAME"]}/builds/#{env["APPVEYOR_BUILD_ID"]}"
+            end
+          end
+        end
+      end
+    end
+  end
+end