datadog-ci 0.1.0

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

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require_relative "git"
+require_relative "environment/extractor"
+
+module Datadog
+  module CI
+    module Ext
+      # Defines constants for CI tags
+      module Environment
+        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_NODE_LABELS = "ci.node.labels"
+        TAG_NODE_NAME = "ci.node.name"
+        TAG_CI_ENV_VARS = "_dd.ci.env_vars"
+
+        HEX_NUMBER_REGEXP = /[0-9a-f]{40}/i.freeze
+
+        module_function
+
+        def tags(env)
+          # Extract metadata from CI provider environment variables
+          tags = Environment::Extractor.new(env).tags
+
+          # If user defined metadata is defined, overwrite
+          tags.merge!(
+            Environment::Extractor.new(env, provider_klass: Providers::UserDefinedTags).tags
+          )
+
+          # Fill out tags from local git as fallback
+          local_git_tags = Environment::Extractor.new(env, provider_klass: Providers::LocalGit).tags
+          local_git_tags.each do |key, value|
+            tags[key] ||= value
+          end
+
+          ensure_post_conditions(tags)
+
+          tags
+        end
+
+        def ensure_post_conditions(tags)
+          validate_repository_url(tags[Git::TAG_REPOSITORY_URL])
+          validate_git_sha(tags[Git::TAG_COMMIT_SHA])
+        end
+
+        def validate_repository_url(repo_url)
+          return if !repo_url.nil? && !repo_url.empty?
+
+          Datadog.logger.error("DD_GIT_REPOSITORY_URL is not set or empty; no repo URL was automatically extracted")
+        end
+
+        def validate_git_sha(git_sha)
+          message = "DD_GIT_COMMIT_SHA must be a full-length git SHA."
+
+          if git_sha.nil? || git_sha.empty?
+            message += " No value was set and no SHA was automatically extracted."
+            Datadog.logger.error(message)
+            return
+          end
+
+          if git_sha.length < Git::SHA_LENGTH
+            message += " Expected SHA length #{Git::SHA_LENGTH}, was #{git_sha.length}."
+            Datadog.logger.error(message)
+            return
+          end
+
+          unless HEX_NUMBER_REGEXP =~ git_sha
+            message += " Expected SHA to be a valid HEX number, got #{git_sha}."
+            Datadog.logger.error(message)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Datadog
+  module CI
+    module Ext
+      # Defines constants for Git tags
+      module Git
+        SHA_LENGTH = 40
+
+        TAG_BRANCH = "git.branch"
+        TAG_REPOSITORY_URL = "git.repository_url"
+        TAG_TAG = "git.tag"
+
+        TAG_COMMIT_AUTHOR_DATE = "git.commit.author.date"
+        TAG_COMMIT_AUTHOR_EMAIL = "git.commit.author.email"
+        TAG_COMMIT_AUTHOR_NAME = "git.commit.author.name"
+        TAG_COMMIT_COMMITTER_DATE = "git.commit.committer.date"
+        TAG_COMMIT_COMMITTER_EMAIL = "git.commit.committer.email"
+        TAG_COMMIT_COMMITTER_NAME = "git.commit.committer.name"
+        TAG_COMMIT_MESSAGE = "git.commit.message"
+        TAG_COMMIT_SHA = "git.commit.sha"
+
+        ENV_REPOSITORY_URL = "DD_GIT_REPOSITORY_URL"
+        ENV_COMMIT_SHA = "DD_GIT_COMMIT_SHA"
+        ENV_BRANCH = "DD_GIT_BRANCH"
+        ENV_TAG = "DD_GIT_TAG"
+        ENV_COMMIT_MESSAGE = "DD_GIT_COMMIT_MESSAGE"
+        ENV_COMMIT_AUTHOR_NAME = "DD_GIT_COMMIT_AUTHOR_NAME"
+        ENV_COMMIT_AUTHOR_EMAIL = "DD_GIT_COMMIT_AUTHOR_EMAIL"
+        ENV_COMMIT_AUTHOR_DATE = "DD_GIT_COMMIT_AUTHOR_DATE"
+        ENV_COMMIT_COMMITTER_NAME = "DD_GIT_COMMIT_COMMITTER_NAME"
+        ENV_COMMIT_COMMITTER_EMAIL = "DD_GIT_COMMIT_COMMITTER_EMAIL"
+        ENV_COMMIT_COMMITTER_DATE = "DD_GIT_COMMIT_COMMITTER_DATE"
+      end
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+module Datadog
+  module CI
+    module Ext
+      # Defines constants for test tags
+      module Settings
+        ENV_MODE_ENABLED = "DD_TRACE_CI_ENABLED"
+      end
+    end
+  end
+end

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

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

data/lib/datadog/ci/extensions.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+require "datadog/core/configuration/settings"
+require "datadog/core/configuration/components"
+
+require_relative "configuration/settings"
+require_relative "configuration/components"
+
+module Datadog
+  module CI
+    # Extends Datadog tracing with CI features
+    module Extensions
+      def self.activate!
+        Core::Configuration::Settings.extend(CI::Configuration::Settings)
+        Core::Configuration::Components.prepend(CI::Configuration::Components)
+      end
+    end
+  end
+end

data/lib/datadog/ci/flush.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require "datadog/tracing/metadata/ext"
+require "datadog/tracing/flush"
+
+module Datadog
+  module CI
+    module Flush
+      # Common behavior for CI flushing
+      module Tagging
+        # Decorate a trace with CI tags
+        def get_trace(trace_op)
+          trace = trace_op.flush!
+
+          # Origin tag is required on every span
+          trace.spans.each do |span|
+            span.set_tag(
+              Tracing::Metadata::Ext::Distributed::TAG_ORIGIN,
+              trace.origin
+            )
+          end
+
+          trace
+        end
+      end
+
+      # Consumes only completed traces (where all spans have finished)
+      class Finished < Tracing::Flush::Finished
+        prepend Tagging
+      end
+
+      # Performs partial trace flushing to avoid large traces residing in memory for too long
+      class Partial < Tracing::Flush::Partial
+        prepend Tagging
+      end
+    end
+  end
+end

data/lib/datadog/ci/test.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+require "datadog/tracing/contrib/analytics"
+
+require_relative "ext/app_types"
+require_relative "ext/test"
+require_relative "ext/environment"
+
+require "rbconfig"
+
+module Datadog
+  module CI
+    # Common behavior for CI tests
+    module Test
+      # Creates a new span for a CI test
+      def self.trace(span_name, options = {})
+        span_options = {
+          span_type: Ext::AppTypes::TYPE_TEST
+        }.merge(options[:span_options] || {})
+
+        if block_given?
+          Tracing.trace(span_name, **span_options) do |span, trace|
+            set_tags!(trace, span, options)
+            yield(span, trace)
+          end
+        else
+          span = Tracing.trace(span_name, **span_options)
+          trace = Tracing.active_trace
+          set_tags!(trace, span, options)
+          span
+        end
+      end
+
+      # Adds tags to a CI test span.
+      def self.set_tags!(trace, span, tags = {})
+        tags ||= {}
+
+        # Set default tags
+        trace.origin = Ext::Test::CONTEXT_ORIGIN if trace
+        Datadog::Tracing::Contrib::Analytics.set_measured(span)
+        span.set_tag(Ext::Test::TAG_SPAN_KIND, Ext::AppTypes::TYPE_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/utils/git.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Datadog
+  module CI
+    module Utils
+      module Git
+        def self.normalize_ref(ref)
+          return nil if ref.nil?
+
+          refs = %r{^refs/(heads/)?}
+          origin = %r{^origin/}
+          tags = %r{^tags/}
+          ref.gsub(refs, "").gsub(origin, "").gsub(tags, "")
+        end
+
+        def self.is_git_tag?(ref)
+          !ref.nil? && ref.include?("tags/")
+        end
+      end
+    end
+  end
+end

data/lib/datadog/ci/version.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Datadog
+  module CI
+    module VERSION
+      MAJOR = "0"
+      MINOR = "1"
+      PATCH = "0"
+      PRE = nil
+      BUILD = nil
+      # PRE and BUILD above are modified for dev gems during gem build GHA workflow
+
+      STRING = [MAJOR, MINOR, PATCH, PRE, BUILD].compact.join(".")
+
+      MINIMUM_RUBY_VERSION = "2.1.0"
+
+      # Restrict the installation of this gem with untested future versions of Ruby.
+      #
+      # This prevents crashes in the native extension code and sends a clear signal to the
+      # user that this version of the gem is untested for the host Ruby version.
+      #
+      # To allow testing with the next unreleased version of Ruby, the version check is performed
+      # as `< #{MAXIMUM_RUBY_VERSION}`, meaning prereleases of MAXIMUM_RUBY_VERSION are allowed
+      # but not stable MAXIMUM_RUBY_VERSION releases.
+      MAXIMUM_RUBY_VERSION = "3.4"
+    end
+  end
+end

data/lib/datadog/ci.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+require "ddtrace"
+require_relative "ci/version"
+
+require "datadog/core"
+
+module Datadog
+  # Namespace for Datadog CI instrumentation:
+  # e.g. rspec, cucumber, etc...
+  module CI
+    class Error < StandardError; end
+    # Your code goes here...
+  end
+end
+
+# Integrations
+require_relative "ci/contrib/cucumber/integration"
+require_relative "ci/contrib/rspec/integration"
+require_relative "ci/contrib/minitest/integration"
+
+# Extensions
+require_relative "ci/extensions"
+Datadog::CI::Extensions.activate!

data/sig/datadog/ci/configuration/components.rbs

@@ -0,0 +1,11 @@
+module Datadog
+  module CI
+    module Configuration
+      module Components : Datadog::Core::Configuration::Components
+        def initialize: (untyped settings) -> void
+
+        def activate_ci!: (untyped settings) -> untyped
+      end
+    end
+  end
+end

data/sig/datadog/ci/configuration/settings.rbs

@@ -0,0 +1,14 @@
+module Datadog
+  module CI
+    module Configuration
+      module Settings
+        extend Datadog::Core::Configuration::Options::ClassMethods
+        extend Datadog::Core::Configuration::Base::ClassMethods
+
+        def self.extended: (untyped base) -> untyped
+
+        def self.add_settings!: (untyped base) -> untyped
+      end
+    end
+  end
+end

data/sig/datadog/ci/contrib/cucumber/configuration/settings.rbs

@@ -0,0 +1,12 @@
+module Datadog
+  module CI
+    module Contrib
+      module Cucumber
+        module Configuration
+          class Settings < Datadog::Tracing::Contrib::Configuration::Settings
+          end
+        end
+      end
+    end
+  end
+end

data/sig/datadog/ci/contrib/cucumber/ext.rbs

@@ -0,0 +1,25 @@
+module Datadog
+  module CI
+    module Contrib
+      module Cucumber
+        module Ext
+          APP: String
+
+          ENV_ENABLED: String
+
+          ENV_OPERATION_NAME: String
+
+          FRAMEWORK: String
+
+          OPERATION_NAME: String
+
+          SERVICE_NAME: String
+
+          STEP_SPAN_TYPE: String
+
+          TEST_TYPE: String
+        end
+      end
+    end
+  end
+end

data/sig/datadog/ci/contrib/cucumber/formatter.rbs

@@ -0,0 +1,35 @@
+module Datadog
+  module CI
+    module Contrib
+      module Cucumber
+        class Formatter
+          private
+
+          attr_reader config: untyped
+
+          attr_reader current_feature_span: untyped
+
+          attr_reader current_step_span: untyped
+
+          public
+
+          def initialize: (untyped config) -> void
+
+          def bind_events: (untyped config) -> untyped
+
+          def on_test_case_started: (untyped event) -> untyped
+
+          def on_test_case_finished: (untyped event) -> (nil | untyped)
+
+          def on_test_step_started: (untyped event) -> untyped
+
+          def on_test_step_finished: (untyped event) -> (nil | untyped)
+
+          private
+
+          def configuration: () -> untyped
+        end
+      end
+    end
+  end
+end

data/sig/datadog/ci/contrib/cucumber/instrumentation.rbs

@@ -0,0 +1,16 @@
+module Datadog
+  module CI
+    module Contrib
+      module Cucumber
+        module Instrumentation
+          def self.included: (untyped base) -> untyped
+          module InstanceMethods : Cucumber::Runtime
+            attr_reader datadog_formatter: CI::Contrib::Cucumber::Formatter
+
+            def formatters: () -> untyped
+          end
+        end
+      end
+    end
+  end
+end

data/sig/datadog/ci/contrib/cucumber/integration.rbs

@@ -0,0 +1,25 @@
+module Datadog
+  module CI
+    module Contrib
+      module Cucumber
+        class Integration
+          extend Datadog::Tracing::Contrib::Integration
+
+          MINIMUM_VERSION: Gem::Version
+
+          def self.version: () -> untyped
+
+          def self.loaded?: () -> bool
+
+          def self.compatible?: () -> bool
+
+          def auto_instrument?: () -> false
+
+          def new_configuration: () -> untyped
+
+          def patcher: () -> untyped
+        end
+      end
+    end
+  end
+end

data/sig/datadog/ci/contrib/cucumber/patcher.rbs

@@ -0,0 +1,15 @@
+module Datadog
+  module CI
+    module Contrib
+      module Cucumber
+        module Patcher
+          include Datadog::Tracing::Contrib::Patcher
+
+          def self?.target_version: () -> untyped
+
+          def self?.patch: () -> untyped
+        end
+      end
+    end
+  end
+end

data/sig/datadog/ci/contrib/minitest/configuration/settings.rbs

@@ -0,0 +1,12 @@
+module Datadog
+  module CI
+    module Contrib
+      module Minitest
+        module Configuration
+          class Settings < Datadog::Tracing::Contrib::Configuration::Settings
+          end
+        end
+      end
+    end
+  end
+end

data/sig/datadog/ci/contrib/minitest/ext.rbs

@@ -0,0 +1,23 @@
+module Datadog
+  module CI
+    module Contrib
+      module Minitest
+        module Ext
+          APP: String
+
+          ENV_ENABLED: String
+
+          ENV_OPERATION_NAME: String
+
+          FRAMEWORK: String
+
+          OPERATION_NAME: String
+
+          SERVICE_NAME: String
+
+          TEST_TYPE: String
+        end
+      end
+    end
+  end
+end

data/sig/datadog/ci/contrib/minitest/hooks.rbs

@@ -0,0 +1,19 @@
+module Datadog
+  module CI
+    module Contrib
+      module Minitest
+        module Hooks : ::Minitest::Test
+          include ::Minitest::Test::LifecycleHooks
+
+          def before_setup: () -> (nil | untyped)
+
+          def after_teardown: () -> untyped
+
+          private
+
+          def configuration: () -> untyped
+        end
+      end
+    end
+  end
+end

data/sig/datadog/ci/contrib/minitest/integration.rbs

@@ -0,0 +1,25 @@
+module Datadog
+  module CI
+    module Contrib
+      module Minitest
+        class Integration
+          extend Datadog::Tracing::Contrib::Integration
+
+          MINIMUM_VERSION: untyped
+
+          def self.version: () -> untyped
+
+          def self.loaded?: () -> untyped
+
+          def compatible?: () -> bool
+
+          def auto_instrument?: () -> false
+
+          def new_configuration: () -> untyped
+
+          def patcher: () -> untyped
+        end
+      end
+    end
+  end
+end

data/sig/datadog/ci/contrib/minitest/patcher.rbs

@@ -0,0 +1,15 @@
+module Datadog
+  module CI
+    module Contrib
+      module Minitest
+        module Patcher
+          include Datadog::Tracing::Contrib::Patcher
+
+          def self?.target_version: () -> untyped
+
+          def self?.patch: () -> untyped
+        end
+      end
+    end
+  end
+end

data/sig/datadog/ci/contrib/rspec/configuration/settings.rbs

@@ -0,0 +1,12 @@
+module Datadog
+  module CI
+    module Contrib
+      module RSpec
+        module Configuration
+          class Settings < Datadog::Tracing::Contrib::Configuration::Settings
+          end
+        end
+      end
+    end
+  end
+end