datadog-ci 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 60a81205d586462fc1e58ff85bcddd69bbab3dc597abe2a730ad393fe9261040
-  data.tar.gz: d44884f838dd3b50db30796d581017127ff6de63dc3121fc531ad54f786ae389
+  metadata.gz: 262f238c451500ef744ff6f24ba5176a5e2064ef49d46055965bb5ed13bc70ea
+  data.tar.gz: 3023b3bca603feb1a591ebf8e68c9339cc887aaea2466fda2596c3cb6a209295
 SHA512:
-  metadata.gz: e69a35a679697d2b142140f71f0704f2c9a4fcf28d2fc9ddff79dd4f514172711c50123c4294252b2e89188ce17ced36656f08290e4c86ee187c3b22965d56da
-  data.tar.gz: c12c56c96a6b31be3b931afdc441890ac88a59e7d12cf663b3fbbce7408ea8338b8d31fb4f49360fcaddfd425e36088bf638f960032cae6c1507d9c83fe36c7a
+  metadata.gz: a15556f403d45a9b4384643028ca42971f40847f7cb0a090ae4776a2e4f1615931fe8612f5306f21578ed30d72e15d725d1fbe74f488752cbec01f30f74a67ed
+  data.tar.gz: 02c7f199399babed0311149c2abca1a3cad27b705d92b139e0485351589707e24ee136ccebae5cef1361afdaabdfe5e2209fa97bd65edfeb947777156bd91c68

data/CHANGELOG.md

@@ -1,5 +1,41 @@
 ## [Unreleased]
 
+## [0.5.0] - 2023-12-06
+
+### Test suite level visibility
+
+This release includes experimental manual API for [test suite level visibility](https://docs.datadoghq.com/continuous_integration/explorer/?tab=testruns#sessions) in Ruby.
+
+Currently test suite level visibility is not used by our instrumentation: it will be released in v0.6.
+
+### Added
+
+* Test suite level visibility: add test session public API ([#72][])
+* Test suite level visibility: test module support ([#76][])
+* Test suite level visibility: test suites support ([#77][])
+* add YARD documentation ([#82][])
+* support validation errors for CI spans ([#78][])
+
+### Changed
+
+* Validate DD_SITE variable ([#79][])
+* Document how to use WebMock with datadog-ci ([#80][])
+
+### Fixed
+
+* Datadog::CI.trace_test always starts a new trace ([#74][])
+* Skip tracing when CI mode disabled and manual API is used ([#75][])
+
+### Removed
+
+* Deprecate operation name setting, change service_name to service in public API ([#81][])
+
+## [0.4.1] - 2023-11-22
+
+### Fixed
+
+* disable 128-bit trace id generation in CI mode ([#70][])
+
 ## [0.4.0] - 2023-11-21
 
 ### Added
@@ -65,7 +101,9 @@
 
 * Ruby versions < 2.7 no longer supported ([#8][])
 
-[Unreleased]: https://github.com/DataDog/datadog-ci-rb/compare/v0.4.0...main
+[Unreleased]: https://github.com/DataDog/datadog-ci-rb/compare/v0.5.0...main
+[0.5.0]: https://github.com/DataDog/datadog-ci-rb/compare/v0.4.1...v0.5.0
+[0.4.1]: https://github.com/DataDog/datadog-ci-rb/compare/v0.4.0...v0.4.1
 [0.4.0]: https://github.com/DataDog/datadog-ci-rb/compare/v0.3.0...v0.4.0
 [0.3.0]: https://github.com/DataDog/datadog-ci-rb/compare/v0.2.0...v0.3.0
 [0.2.0]: https://github.com/DataDog/datadog-ci-rb/compare/v0.1.1...v0.2.0
@@ -90,3 +128,14 @@
 [#64]: https://github.com/DataDog/datadog-ci-rb/issues/64
 [#65]: https://github.com/DataDog/datadog-ci-rb/issues/65
 [#66]: https://github.com/DataDog/datadog-ci-rb/issues/66
+[#70]: https://github.com/DataDog/datadog-ci-rb/issues/70
+[#72]: https://github.com/DataDog/datadog-ci-rb/issues/72
+[#74]: https://github.com/DataDog/datadog-ci-rb/issues/74
+[#75]: https://github.com/DataDog/datadog-ci-rb/issues/75
+[#76]: https://github.com/DataDog/datadog-ci-rb/issues/76
+[#77]: https://github.com/DataDog/datadog-ci-rb/issues/77
+[#78]: https://github.com/DataDog/datadog-ci-rb/issues/78
+[#79]: https://github.com/DataDog/datadog-ci-rb/issues/79
+[#80]: https://github.com/DataDog/datadog-ci-rb/issues/80
+[#81]: https://github.com/DataDog/datadog-ci-rb/issues/81
+[#82]: https://github.com/DataDog/datadog-ci-rb/issues/82

data/README.md

@@ -1,6 +1,7 @@
 # Datadog CI Visibility for Ruby
 
 [![Gem Version](https://badge.fury.io/rb/datadog-ci.svg)](https://badge.fury.io/rb/datadog-ci)
+[![YARD documentation](https://img.shields.io/badge/YARD-documentation-blue)](https://datadoghq.dev/datadog-ci-rb/)
 [![codecov](https://codecov.io/gh/DataDog/datadog-ci-rb/branch/main/graph/badge.svg)](https://app.codecov.io/gh/DataDog/datadog-ci-rb/branch/main)
 [![CircleCI](https://dl.circleci.com/status-badge/img/gh/DataDog/datadog-ci-rb/tree/main.svg?style=svg)](https://dl.circleci.com/status-badge/redirect/gh/DataDog/datadog-ci-rb/tree/main)
 
@@ -51,7 +52,7 @@ end
 | --- | ----------- | ------- |
 | `enabled` | Defines whether RSpec tests should be traced. Useful for temporarily disabling tracing. `true` or `false` | `true` |
 | `service_name` | Service name used for `rspec` instrumentation. | `'rspec'` |
-| `operation_name` | Operation name used for `rspec` instrumentation. | `'rspec.example'` |
+| `operation_name` | *DEPRECATED, to be removed in 1.0* Operation name used for `rspec` instrumentation (has no effect in agentless mode or when using newer agent versions). | `'rspec.example'` |
 
 ### Minitest
 
@@ -84,7 +85,7 @@ end
 | --- | ----------- | ------- |
 | `enabled` | Defines whether Minitest tests should be traced. Useful for temporarily disabling tracing. `true` or `false` | `true` |
 | `service_name` | Service name used for `minitest` instrumentation. | `'minitest'` |
-| `operation_name` | Operation name used for `minitest` instrumentation. | `'minitest.test'` |
+| `operation_name` | *DEPRECATED, to be removed in 1.0* Operation name used for `minitest` instrumentation (has no effect in agentless mode or when using newer agent versions). | `'minitest.test'` |
 
 ### Cucumber
 
@@ -115,7 +116,7 @@ end
 | --- | ----------- | ------- |
 | `enabled` | Defines whether Cucumber tests should be traced. Useful for temporarily disabling tracing. `true` or `false` | `true` |
 | `service_name` | Service name used for `cucumber` instrumentation. | `'cucumber'` |
-| `operation_name` | Operation name used for `cucumber` instrumentation. | `'cucumber.test'` |
+| `operation_name` | *DEPRECATED, to be removed in 1.0* Operation name used for `cucumber` instrumentation (has no effect in agentless mode or when using newer agent versions). | `'cucumber.test'` |
 
 ## Agentless mode
 
@@ -161,6 +162,28 @@ they will **not** show up in Datadog APM.
 
 For the full list of available instrumentations see [ddtrace documentation](https://github.com/DataDog/dd-trace-rb/blob/master/docs/GettingStarted.md)
 
+### WebMock
+
+[WebMock](https://github.com/bblimke/webmock)
+is a popular Ruby library that stubs HTTP requests when running tests.
+By default it fails when used together with datadog-ci as traces are being sent
+to Datadog via HTTP calls.
+
+In order to allow HTTP connections for Datadog backend you would need to configure
+Webmock accordingly.
+
+```ruby
+# when using agentless mode
+# note to use the correct datadog site (e.g. datadoghq.eu, etc)
+WebMock.disable_net_connect!(:allow => "citestcycle-intake.datadoghq.com")
+
+# when using agent
+WebMock.disable_net_connect!(:allow_localhost => true)
+
+# or for more granular setting set your agent URL
+WebMock.disable_net_connect!(:allow => "localhost:8126")
+```
+
 ### Disabling startup logs
 
 Startup logs produce a report of tracing state when the application is initially configured.

data/lib/datadog/ci/concurrent_span.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+require_relative "span"
+
+module Datadog
+  module CI
+    # Represents a single part of a test run that can be safely shared between threads.
+    # Examples of shared objects are: TestSession, TestModule, TestSpan.
+    #
+    # @public_api
+    class ConcurrentSpan < Span
+      def initialize(tracer_span)
+        super
+
+        @mutex = Mutex.new
+      end
+
+      # Gets tag value by key. This method is thread-safe.
+      # @param [String] key the key of the tag.
+      # @return [String] the value of the tag.
+      def get_tag(key)
+        synchronize { super }
+      end
+
+      # Sets tag value by key. This method is thread-safe.
+      # @param [String] key the key of the tag.
+      # @param [String] value the value of the tag.
+      # @return [void]
+      def set_tag(key, value)
+        synchronize { super }
+      end
+
+      # Sets metric value by key. This method is thread-safe.
+      # @param [String] key the key of the metric.
+      # @param [Numeric] value the value of the metric.
+      # @return [void]
+      def set_metric(key, value)
+        synchronize { super }
+      end
+
+      # Finishes the span. This method is thread-safe.
+      # @return [void]
+      def finish
+        synchronize { super }
+      end
+
+      # Sets multiple tags at once. This method is thread-safe.
+      # @param [Hash[String, String]] tags the tags to set.
+      # @return [void]
+      def set_tags(tags)
+        synchronize { super }
+      end
+
+      def synchronize
+        @mutex.synchronize { yield }
+      end
+    end
+  end
+end

data/lib/datadog/ci/configuration/components.rb

@@ -4,8 +4,11 @@ require "datadog/core/configuration/agent_settings_resolver"
 require "datadog/core/remote/negotiation"
 
 require_relative "../ext/transport"
+require_relative "../ext/settings"
 require_relative "../test_visibility/flush"
 require_relative "../test_visibility/transport"
+require_relative "../test_visibility/serializers/factories/test_level"
+require_relative "../test_visibility/serializers/factories/test_suite_level"
 require_relative "../transport/api/builder"
 require_relative "../recorder"
 
@@ -20,6 +23,11 @@ module Datadog
           # Activate CI mode if enabled
           activate_ci!(settings) if settings.ci.enabled
 
+          @ci_recorder = Recorder.new(
+            enabled: settings.ci.enabled,
+            test_suite_level_visibility_enabled: settings.ci.experimental_test_suite_level_visibility_enabled
+          )
+
           # Initialize normally
           super
         end
@@ -29,9 +37,12 @@ module Datadog
           agent_settings = Datadog::Core::Configuration::AgentSettingsResolver.call(settings)
 
           if settings.ci.agentless_mode_enabled
+            check_dd_site(settings)
             test_visibility_transport = build_agentless_transport(settings)
           elsif can_use_evp_proxy?(settings, agent_settings)
             test_visibility_transport = build_evp_proxy_transport(settings, agent_settings)
+          else
+            settings.ci.experimental_test_suite_level_visibility_enabled = false
           end
 
           # Deactivate telemetry
@@ -40,11 +51,15 @@ module Datadog
           # Deactivate remote configuration
           settings.remote.enabled = false
 
+          # do not use 128-bit trace ids for CI visibility
+          # they are used for OTEL compatibility in Datadog tracer
+          settings.tracing.trace_id_128_bit_generation_enabled = false
+
           # Activate underlying tracing test mode
           settings.tracing.test_mode.enabled = true
 
           # Choose user defined TraceFlush or default to CI TraceFlush
-          settings.tracing.test_mode.trace_flush = settings.ci.trace_flush || CI::TestVisibility::Flush::Finished.new
+          settings.tracing.test_mode.trace_flush = settings.ci.trace_flush || CI::TestVisibility::Flush::Partial.new
 
           writer_options = settings.ci.writer_options
           if test_visibility_transport
@@ -55,8 +70,6 @@ module Datadog
           end
 
           settings.tracing.test_mode.writer_options = writer_options
-
-          @ci_recorder = Recorder.new
         end
 
         def can_use_evp_proxy?(settings, agent_settings)
@@ -85,6 +98,7 @@ module Datadog
 
             Datadog::CI::TestVisibility::Transport.new(
               api: Transport::Api::Builder.build_ci_test_cycle_api(settings),
+              serializers_factory: serializers_factory(settings),
               dd_env: settings.env
             )
           end
@@ -95,9 +109,29 @@ module Datadog
 
           Datadog::CI::TestVisibility::Transport.new(
             api: Transport::Api::Builder.build_evp_proxy_api(agent_settings),
+            serializers_factory: serializers_factory(settings),
             dd_env: settings.env
           )
         end
+
+        def serializers_factory(settings)
+          if settings.ci.experimental_test_suite_level_visibility_enabled
+            Datadog::CI::TestVisibility::Serializers::Factories::TestSuiteLevel
+          else
+            Datadog::CI::TestVisibility::Serializers::Factories::TestLevel
+          end
+        end
+
+        def check_dd_site(settings)
+          return if settings.site.nil?
+          return if Ext::Settings::DD_SITE_ALLOWLIST.include?(settings.site)
+
+          Datadog.logger.warn(
+            "CI VISIBILITY CONFIGURATION " \
+            "Agentless mode was enabled but DD_SITE is not set to one of the following: #{Ext::Settings::DD_SITE_ALLOWLIST.join(", ")}. " \
+            "Please make sure to set valid site in DD_SITE environment variable"
+          )
+        end
       end
     end
   end

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

@@ -34,6 +34,12 @@ module Datadog
                 o.env CI::Ext::Settings::ENV_AGENTLESS_URL
               end
 
+              option :experimental_test_suite_level_visibility_enabled do |o|
+                o.type :bool
+                o.env CI::Ext::Settings::ENV_EXPERIMENTAL_TEST_SUITE_LEVEL_VISIBILITY_ENABLED
+                o.default false
+              end
+
               define_method(:instrument) do |integration_name, options = {}, &block|
                 return unless enabled
 
@@ -56,7 +62,7 @@ module Datadog
                 fetch_integration(integration_name).configuration
               end
 
-              # TODO: Deprecate in the next major version, as `instrument` better describes this method's purpose
+              # @deprecated Will be removed on datadog-ci-rb 1.0.
               alias_method :use, :instrument
 
               option :trace_flush

data/lib/datadog/ci/context/global.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module Datadog
+  module CI
+    module Context
+      # This context is shared between threads and represents the current test session and test module.
+      class Global
+        def initialize
+          # we are using Monitor instead of Mutex because it is reentrant
+          @mutex = Monitor.new
+
+          @test_session = nil
+          @test_module = nil
+          @test_suites = {}
+        end
+
+        def fetch_or_activate_test_suite(test_suite_name, &block)
+          @mutex.synchronize do
+            @test_suites[test_suite_name] ||= block.call
+          end
+        end
+
+        def fetch_or_activate_test_module(&block)
+          @mutex.synchronize do
+            @test_module ||= block.call
+          end
+        end
+
+        def fetch_or_activate_test_session(&block)
+          @mutex.synchronize do
+            @test_session ||= block.call
+          end
+        end
+
+        def active_test_module
+          @test_module
+        end
+
+        def active_test_session
+          @test_session
+        end
+
+        def active_test_suite(test_suite_name)
+          @mutex.synchronize { @test_suites[test_suite_name] }
+        end
+
+        def service
+          @mutex.synchronize do
+            # thank you RBS for this weirdness
+            test_session = @test_session
+            test_session.service if test_session
+          end
+        end
+
+        def inheritable_session_tags
+          @mutex.synchronize do
+            test_session = @test_session
+            if test_session
+              test_session.inheritable_tags
+            else
+              {}
+            end
+          end
+        end
+
+        def deactivate_test_session!
+          @mutex.synchronize { @test_session = nil }
+        end
+
+        def deactivate_test_module!
+          @mutex.synchronize { @test_module = nil }
+        end
+
+        def deactivate_test_suite!(test_suite_name)
+          @mutex.synchronize { @test_suites.delete(test_suite_name) }
+        end
+      end
+    end
+  end
+end

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

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "datadog/core"
+
 require_relative "../ext"
 require_relative "../../settings"
 
@@ -9,7 +11,7 @@ module Datadog
       module Cucumber
         module Configuration
           # Custom settings for the Cucumber integration
-          # TODO: mark as `@public_api` when GA
+          # @public_api
           class Settings < Datadog::CI::Contrib::Settings
             option :enabled do |o|
               o.type :bool
@@ -22,10 +24,19 @@ module Datadog
               o.default { Datadog.configuration.service_without_fallback || Ext::SERVICE_NAME }
             end
 
+            # @deprecated Will be removed in 1.0
             option :operation_name do |o|
               o.type :string
               o.env Ext::ENV_OPERATION_NAME
               o.default Ext::OPERATION_NAME
+
+              o.after_set do |value|
+                if value && value != Ext::OPERATION_NAME
+                  Datadog::Core.log_deprecation do
+                    "The operation_name setting has no effect and will be removed in 1.0"
+                  end
+                end
+              end
             end
           end
         end

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

@@ -29,14 +29,13 @@ module Datadog
           def on_test_case_started(event)
             CI.start_test(
               event.test_case.name,
+              event.test_case.location.file,
               tags: {
                 CI::Ext::Test::TAG_FRAMEWORK => Ext::FRAMEWORK,
                 CI::Ext::Test::TAG_FRAMEWORK_VERSION => CI::Contrib::Cucumber::Integration.version.to_s,
-                CI::Ext::Test::TAG_TYPE => Ext::TEST_TYPE,
-                CI::Ext::Test::TAG_SUITE => event.test_case.location.file
+                CI::Ext::Test::TAG_TYPE => Ext::TEST_TYPE
               },
-              service_name: configuration[:service_name],
-              operation_name: configuration[:operation_name]
+              service: configuration[:service_name]
             )
           end
 

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

@@ -9,7 +9,7 @@ module Datadog
       module Minitest
         module Configuration
           # Custom settings for the Minitest integration
-          # TODO: mark as `@public_api` when GA
+          # @public_api
           class Settings < Datadog::CI::Contrib::Settings
             option :enabled do |o|
               o.type :bool
@@ -22,10 +22,19 @@ module Datadog
               o.default { Datadog.configuration.service_without_fallback || Ext::SERVICE_NAME }
             end
 
+            # @deprecated Will be removed in 1.0
             option :operation_name do |o|
               o.type :string
               o.env Ext::ENV_OPERATION_NAME
               o.default Ext::OPERATION_NAME
+
+              o.after_set do |value|
+                if value && value != Ext::OPERATION_NAME
+                  Datadog::Core.log_deprecation do
+                    "The operation_name setting has no effect and will be removed in 1.0"
+                  end
+                end
+              end
             end
           end
         end

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

@@ -20,14 +20,13 @@ module Datadog
 
             CI.start_test(
               test_name,
+              test_suite,
               tags: {
                 CI::Ext::Test::TAG_FRAMEWORK => Ext::FRAMEWORK,
                 CI::Ext::Test::TAG_FRAMEWORK_VERSION => CI::Contrib::Minitest::Integration.version.to_s,
-                CI::Ext::Test::TAG_TYPE => Ext::TEST_TYPE,
-                CI::Ext::Test::TAG_SUITE => test_suite
+                CI::Ext::Test::TAG_TYPE => Ext::TEST_TYPE
               },
-              service_name: configuration[:service_name],
-              operation_name: configuration[:operation_name]
+              service: configuration[:service_name]
             )
           end
 

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

@@ -9,7 +9,7 @@ module Datadog
       module RSpec
         module Configuration
           # Custom settings for the RSpec integration
-          # TODO: mark as `@public_api` when GA
+          # @public_api
           class Settings < Datadog::CI::Contrib::Settings
             option :enabled do |o|
               o.type :bool
@@ -22,10 +22,19 @@ module Datadog
               o.default { Datadog.configuration.service_without_fallback || Ext::SERVICE_NAME }
             end
 
+            # @deprecated Will be removed in 1.0
             option :operation_name do |o|
               o.type :string
               o.env Ext::ENV_OPERATION_NAME
               o.default Ext::OPERATION_NAME
+
+              o.after_set do |value|
+                if value && value != Ext::OPERATION_NAME
+                  Datadog::Core.log_deprecation do
+                    "The operation_name setting has no effect and will be removed in 1.0"
+                  end
+                end
+              end
             end
           end
         end

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

@@ -26,14 +26,13 @@ module Datadog
 
               CI.trace_test(
                 test_name,
+                metadata[:example_group][:file_path],
                 tags: {
                   CI::Ext::Test::TAG_FRAMEWORK => Ext::FRAMEWORK,
                   CI::Ext::Test::TAG_FRAMEWORK_VERSION => CI::Contrib::RSpec::Integration.version.to_s,
-                  CI::Ext::Test::TAG_TYPE => Ext::TEST_TYPE,
-                  CI::Ext::Test::TAG_SUITE => metadata[:example_group][:file_path]
+                  CI::Ext::Test::TAG_TYPE => Ext::TEST_TYPE
                 },
-                service_name: configuration[:service_name],
-                operation_name: configuration[:operation_name]
+                service: configuration[:service_name]
               ) do |test_span|
                 result = super
 

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

@@ -10,6 +10,8 @@ module Datadog
 
         option :enabled, default: true
         option :service_name
+
+        # @deprecated Will be removed in 1.0
         option :operation_name
 
         def configure(options = {})

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

@@ -5,6 +5,11 @@ module Datadog
     module Ext
       module AppTypes
         TYPE_TEST = "test"
+        TYPE_TEST_SESSION = "test_session_end"
+        TYPE_TEST_MODULE = "test_module_end"
+        TYPE_TEST_SUITE = "test_suite_end"
+
+        CI_SPAN_TYPES = [TYPE_TEST, TYPE_TEST_SESSION, TYPE_TEST_MODULE, TYPE_TEST_SUITE].freeze
       end
     end
   end

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

@@ -8,6 +8,17 @@ module Datadog
         ENV_MODE_ENABLED = "DD_TRACE_CI_ENABLED"
         ENV_AGENTLESS_MODE_ENABLED = "DD_CIVISIBILITY_AGENTLESS_ENABLED"
         ENV_AGENTLESS_URL = "DD_CIVISIBILITY_AGENTLESS_URL"
+        ENV_EXPERIMENTAL_TEST_SUITE_LEVEL_VISIBILITY_ENABLED = "DD_CIVISIBILITY_EXPERIMENTAL_TEST_SUITE_LEVEL_VISIBILITY_ENABLED"
+
+        # Source: https://docs.datadoghq.com/getting_started/site/
+        DD_SITE_ALLOWLIST = [
+          "datadoghq.com",
+          "us3.datadoghq.com",
+          "us5.datadoghq.com",
+          "datadoghq.eu",
+          "ddog-gov.com",
+          "ap1.datadoghq.com"
+        ].freeze
       end
     end
   end

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

@@ -4,6 +4,7 @@ module Datadog
   module CI
     module Ext
       # Defines constants for test tags
+      # @public_api
       module Test
         CONTEXT_ORIGIN = "ciapp-test"
 
@@ -14,8 +15,19 @@ module Datadog
         TAG_SKIP_REASON = "test.skip_reason" # DEV: Not populated yet
         TAG_STATUS = "test.status"
         TAG_SUITE = "test.suite"
+        TAG_MODULE = "test.module"
         TAG_TRAITS = "test.traits"
         TAG_TYPE = "test.type"
+        TAG_COMMAND = "test.command"
+
+        # those tags are special and they are used to correlate tests with the test sessions, suites, and modules
+        TAG_TEST_SESSION_ID = "_test.session_id"
+        TAG_TEST_MODULE_ID = "_test.module_id"
+        TAG_TEST_SUITE_ID = "_test.suite_id"
+        SPECIAL_TAGS = [TAG_TEST_SESSION_ID, TAG_TEST_MODULE_ID, TAG_TEST_SUITE_ID].freeze
+
+        # tags that can be inherited from the test session
+        INHERITABLE_TAGS = [TAG_FRAMEWORK, TAG_FRAMEWORK_VERSION, TAG_TYPE].freeze
 
         # Environment runtime tags
         TAG_OS_ARCHITECTURE = "os.architecture"
@@ -23,7 +35,6 @@ module Datadog
         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