datadog-ci 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 262f238c451500ef744ff6f24ba5176a5e2064ef49d46055965bb5ed13bc70ea
-  data.tar.gz: 3023b3bca603feb1a591ebf8e68c9339cc887aaea2466fda2596c3cb6a209295
+  metadata.gz: 85bb3584dc8081e8f6e8531d2a600e3948f4f9ea23d551dd99df0eab9daf2a3c
+  data.tar.gz: b6f686d49d3dbb1695c0f6e20b434b77648a118c32e1691f4a0f30b13d38dc62
 SHA512:
-  metadata.gz: a15556f403d45a9b4384643028ca42971f40847f7cb0a090ae4776a2e4f1615931fe8612f5306f21578ed30d72e15d725d1fbe74f488752cbec01f30f74a67ed
-  data.tar.gz: 02c7f199399babed0311149c2abca1a3cad27b705d92b139e0485351589707e24ee136ccebae5cef1361afdaabdfe5e2209fa97bd65edfeb947777156bd91c68
+  metadata.gz: 8e8ae716ea7c7408c59c11efa5a3bc30e0767a02c659e231f1cec2a02d5494d451c1e2b43c7c16240cbe7c9418f004ead32faa09b08c83bcd878156fa1062ae9
+  data.tar.gz: 15bdfb45e32660356fcc4c5726c4a640c78cfc2d5007807623f532a0b7c321f0b11a32d0a75f571a64ae263159d4b86b0a750dda5d7e8a5c33f9c110bf7682a0

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 ## [Unreleased]
 
+## [0.5.1] - 2023-12-11
+
+### Fixed
+
+* do not collect environment tags when CI is not enabled ([#87][])
+
+### Changed
+
+* Move private classes and modules deeper in module hierarchy ([#85][])
+* update appraisal dependencies ([#84][])
+
 ## [0.5.0] - 2023-12-06
 
 ### Test suite level visibility
@@ -101,7 +112,8 @@ Currently test suite level visibility is not used by our instrumentation: it wil
 
 * Ruby versions < 2.7 no longer supported ([#8][])
 
-[Unreleased]: https://github.com/DataDog/datadog-ci-rb/compare/v0.5.0...main
+[Unreleased]: https://github.com/DataDog/datadog-ci-rb/compare/v0.5.1...main
+[0.5.1]: https://github.com/DataDog/datadog-ci-rb/compare/v0.5.0...v0.5.1
 [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
@@ -138,4 +150,7 @@ Currently test suite level visibility is not used by our instrumentation: it wil
 [#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
+[#82]: https://github.com/DataDog/datadog-ci-rb/issues/82
+[#84]: https://github.com/DataDog/datadog-ci-rb/issues/84
+[#85]: https://github.com/DataDog/datadog-ci-rb/issues/85
+[#87]: https://github.com/DataDog/datadog-ci-rb/issues/87

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

@@ -6,11 +6,11 @@ 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/recorder"
 require_relative "../test_visibility/serializers/factories/test_level"
 require_relative "../test_visibility/serializers/factories/test_suite_level"
+require_relative "../test_visibility/transport"
 require_relative "../transport/api/builder"
-require_relative "../recorder"
 
 module Datadog
   module CI
@@ -23,7 +23,7 @@ module Datadog
           # Activate CI mode if enabled
           activate_ci!(settings) if settings.ci.enabled
 
-          @ci_recorder = Recorder.new(
+          @ci_recorder = TestVisibility::Recorder.new(
             enabled: settings.ci.enabled,
             test_suite_level_visibility_enabled: settings.ci.experimental_test_suite_level_visibility_enabled
           )

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "datadog/core/configuration/settings"
+require "datadog/core/configuration/components"
+
+require_relative "settings"
+require_relative "components"
+
+module Datadog
+  module CI
+    module Configuration
+      # 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
+end

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

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module Datadog
+  module CI
+    module TestVisibility
+      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
+end

data/lib/datadog/ci/test_visibility/context/local.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Datadog
+  module CI
+    module TestVisibility
+      module Context
+        class Local
+          def initialize
+            @key = :datadog_ci_active_test
+
+            self.active_test = nil
+          end
+
+          def activate_test!(test)
+            raise "Nested tests are not supported. Currently active test: #{active_test}" unless active_test.nil?
+
+            if block_given?
+              begin
+                self.active_test = test
+                yield
+              ensure
+                self.active_test = nil
+              end
+            else
+              self.active_test = test
+            end
+          end
+
+          def deactivate_test!(test)
+            return if active_test.nil?
+
+            if active_test == test
+              self.active_test = nil
+            else
+              raise "Trying to deactivate test #{test}, but currently active test is #{active_test}"
+            end
+          end
+
+          def active_test
+            Thread.current[@key]
+          end
+
+          private
+
+          def active_test=(test)
+            Thread.current[@key] = test
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/ci/test_visibility/recorder.rb

@@ -0,0 +1,293 @@
+# frozen_string_literal: true
+
+require "datadog/tracing"
+require "datadog/tracing/trace_digest"
+
+require "rbconfig"
+
+require_relative "context/global"
+require_relative "context/local"
+
+require_relative "../ext/app_types"
+require_relative "../ext/test"
+require_relative "../ext/environment"
+
+require_relative "../span"
+require_relative "../null_span"
+require_relative "../test"
+require_relative "../test_session"
+require_relative "../test_module"
+require_relative "../test_suite"
+
+module Datadog
+  module CI
+    module TestVisibility
+      # Common behavior for CI tests
+      # Note: this class has too many responsibilities and should be split into multiple classes
+      class Recorder
+        attr_reader :environment_tags, :test_suite_level_visibility_enabled, :enabled
+
+        def initialize(enabled: true, test_suite_level_visibility_enabled: false)
+          @enabled = enabled
+          @test_suite_level_visibility_enabled = enabled && test_suite_level_visibility_enabled
+
+          @environment_tags = @enabled ? Ext::Environment.tags(ENV).freeze : {}
+          @local_context = Context::Local.new
+          @global_context = Context::Global.new
+        end
+
+        def start_test_session(service: nil, tags: {})
+          return skip_tracing unless test_suite_level_visibility_enabled
+
+          @global_context.fetch_or_activate_test_session do
+            tracer_span = start_datadog_tracer_span(
+              "test.session", build_span_options(service, Ext::AppTypes::TYPE_TEST_SESSION)
+            )
+            set_session_context(tags, tracer_span)
+
+            build_test_session(tracer_span, tags)
+          end
+        end
+
+        def start_test_module(test_module_name, service: nil, tags: {})
+          return skip_tracing unless test_suite_level_visibility_enabled
+
+          @global_context.fetch_or_activate_test_module do
+            set_inherited_globals(tags)
+            set_session_context(tags)
+
+            tracer_span = start_datadog_tracer_span(
+              test_module_name, build_span_options(service, Ext::AppTypes::TYPE_TEST_MODULE)
+            )
+            set_module_context(tags, tracer_span)
+
+            build_test_module(tracer_span, tags)
+          end
+        end
+
+        def start_test_suite(test_suite_name, service: nil, tags: {})
+          return skip_tracing unless test_suite_level_visibility_enabled
+
+          @global_context.fetch_or_activate_test_suite(test_suite_name) do
+            set_inherited_globals(tags)
+            set_session_context(tags)
+            set_module_context(tags)
+
+            tracer_span = start_datadog_tracer_span(
+              test_suite_name, build_span_options(service, Ext::AppTypes::TYPE_TEST_SUITE)
+            )
+            set_suite_context(tags, span: tracer_span)
+
+            build_test_suite(tracer_span, tags)
+          end
+        end
+
+        def trace_test(test_name, test_suite_name, service: nil, tags: {}, &block)
+          return skip_tracing(block) unless enabled
+
+          set_inherited_globals(tags)
+          set_session_context(tags)
+          set_module_context(tags)
+          set_suite_context(tags, name: test_suite_name)
+
+          tags[Ext::Test::TAG_NAME] = test_name
+
+          span_options = build_span_options(
+            service,
+            Ext::AppTypes::TYPE_TEST,
+            # :resource is needed for the agent APM protocol to work correctly (for older agent versions)
+            # :continue_from is required to start a new trace for each test
+            {resource: test_name, continue_from: Datadog::Tracing::TraceDigest.new}
+          )
+
+          if block
+            start_datadog_tracer_span(test_name, span_options) do |tracer_span|
+              test = build_test(tracer_span, tags)
+
+              @local_context.activate_test!(test) do
+                block.call(test)
+              end
+            end
+          else
+            tracer_span = start_datadog_tracer_span(test_name, span_options)
+
+            test = build_test(tracer_span, tags)
+            @local_context.activate_test!(test)
+            test
+          end
+        end
+
+        def trace(span_type, span_name, tags: {}, &block)
+          return skip_tracing(block) unless enabled
+
+          span_options = build_span_options(
+            nil, # service name is completely optional for custom spans
+            span_type,
+            {resource: span_name}
+          )
+
+          if block
+            start_datadog_tracer_span(span_name, span_options) do |tracer_span|
+              block.call(build_span(tracer_span, tags))
+            end
+          else
+            tracer_span = start_datadog_tracer_span(span_name, span_options)
+
+            build_span(tracer_span, tags)
+          end
+        end
+
+        def active_span
+          tracer_span = Datadog::Tracing.active_span
+          Span.new(tracer_span) if tracer_span
+        end
+
+        def active_test
+          @local_context.active_test
+        end
+
+        def active_test_session
+          @global_context.active_test_session
+        end
+
+        def active_test_module
+          @global_context.active_test_module
+        end
+
+        def active_test_suite(test_suite_name)
+          @global_context.active_test_suite(test_suite_name)
+        end
+
+        def deactivate_test(test)
+          @local_context.deactivate_test!(test)
+        end
+
+        def deactivate_test_session
+          @global_context.deactivate_test_session!
+        end
+
+        def deactivate_test_module
+          @global_context.deactivate_test_module!
+        end
+
+        def deactivate_test_suite(test_suite_name)
+          @global_context.deactivate_test_suite!(test_suite_name)
+        end
+
+        private
+
+        def skip_tracing(block = nil)
+          if block
+            block.call(null_span)
+          else
+            null_span
+          end
+        end
+
+        # Sets trace's origin to ciapp-test
+        def set_trace_origin(trace)
+          trace.origin = Ext::Test::CONTEXT_ORIGIN if trace
+        end
+
+        def build_test_session(tracer_span, tags)
+          test_session = TestSession.new(tracer_span)
+          set_initial_tags(test_session, tags)
+          test_session
+        end
+
+        def build_test_module(tracer_span, tags)
+          test_module = TestModule.new(tracer_span)
+          set_initial_tags(test_module, tags)
+          test_module
+        end
+
+        def build_test_suite(tracer_span, tags)
+          test_suite = TestSuite.new(tracer_span)
+          set_initial_tags(test_suite, tags)
+          test_suite
+        end
+
+        def build_test(tracer_span, tags)
+          test = Test.new(tracer_span)
+          set_initial_tags(test, tags)
+          test
+        end
+
+        def build_span(tracer_span, tags)
+          span = Span.new(tracer_span)
+          set_initial_tags(span, tags)
+          span
+        end
+
+        def build_span_options(service, span_type, other_options = {})
+          other_options[:service] = service || @global_context.service
+          other_options[:span_type] = span_type
+
+          other_options
+        end
+
+        def set_inherited_globals(tags)
+          # this code achieves the same as @global_context.inheritable_session_tags.merge(tags)
+          # but without allocating a new hash
+          @global_context.inheritable_session_tags.each do |key, value|
+            tags[key] = value unless tags.key?(key)
+          end
+        end
+
+        def set_initial_tags(ci_span, tags)
+          ci_span.set_default_tags
+          ci_span.set_environment_runtime_tags
+
+          ci_span.set_tags(tags)
+          ci_span.set_tags(environment_tags)
+        end
+
+        def set_session_context(tags, test_session = nil)
+          test_session ||= active_test_session
+          tags[Ext::Test::TAG_TEST_SESSION_ID] = test_session.id.to_s if test_session
+        end
+
+        def set_module_context(tags, test_module = nil)
+          test_module ||= active_test_module
+          if test_module
+            tags[Ext::Test::TAG_TEST_MODULE_ID] = test_module.id.to_s
+            tags[Ext::Test::TAG_MODULE] = test_module.name
+          end
+        end
+
+        def set_suite_context(tags, span: nil, name: nil)
+          return if span.nil? && name.nil?
+
+          test_suite = span || active_test_suite(name)
+
+          if test_suite
+            tags[Ext::Test::TAG_TEST_SUITE_ID] = test_suite.id.to_s
+            tags[Ext::Test::TAG_SUITE] = test_suite.name
+          else
+            tags[Ext::Test::TAG_SUITE] = name
+          end
+        end
+
+        def start_datadog_tracer_span(span_name, span_options, &block)
+          if block
+            Datadog::Tracing.trace(span_name, **span_options) do |tracer_span, trace|
+              set_trace_origin(trace)
+
+              yield tracer_span
+            end
+          else
+            tracer_span = Datadog::Tracing.trace(span_name, **span_options)
+            trace = Datadog::Tracing.active_trace
+            set_trace_origin(trace)
+
+            tracer_span
+          end
+        end
+
+        def null_span
+          @null_span ||= NullSpan.new
+        end
+      end
+    end
+  end
+end

data/lib/datadog/ci/version.rb

@@ -5,7 +5,7 @@ module Datadog
     module VERSION
       MAJOR = "0"
       MINOR = "5"
-      PATCH = "0"
+      PATCH = "1"
       PRE = nil
       BUILD = nil
       # PRE and BUILD above are modified for dev gems during gem build GHA workflow

data/lib/datadog/ci.rb

@@ -389,6 +389,6 @@ 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!
+# Configuration extensions
+require_relative "ci/configuration/extensions"
+Datadog::CI::Configuration::Extensions.activate!

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

@@ -2,9 +2,9 @@ module Datadog
   module CI
     module Configuration
       module Components : Datadog::Core::Configuration::Components
-        @ci_recorder: Datadog::CI::Recorder
+        @ci_recorder: Datadog::CI::TestVisibility::Recorder
 
-        attr_reader ci_recorder: Datadog::CI::Recorder
+        attr_reader ci_recorder: Datadog::CI::TestVisibility::Recorder
 
         def initialize: (untyped settings) -> void
 

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

@@ -0,0 +1,9 @@
+module Datadog
+  module CI
+    module Configuration
+      module Extensions
+        def self.activate!: () -> untyped
+      end
+    end
+  end
+end

data/sig/datadog/ci/test_visibility/context/global.rbs

@@ -0,0 +1,39 @@
+module Datadog
+  module CI
+    module TestVisibility
+      module Context
+        class Global
+          @mutex: Thread::Mutex
+
+          @test_session: Datadog::CI::TestSession?
+          @test_module: Datadog::CI::TestModule?
+          @test_suites: Hash[String, Datadog::CI::TestSuite]
+
+          def initialize: () -> void
+
+          def fetch_or_activate_test_suite: (String test_suite_name) {() -> Datadog::CI::TestSuite} -> Datadog::CI::TestSuite
+
+          def fetch_or_activate_test_module: () {() -> Datadog::CI::TestModule} -> Datadog::CI::TestModule
+
+          def fetch_or_activate_test_session: () {() -> Datadog::CI::TestSession} -> Datadog::CI::TestSession
+
+          def active_test_session: () -> Datadog::CI::TestSession?
+
+          def active_test_suite: (String test_suite_name) -> Datadog::CI::TestSuite?
+
+          def service: () -> String?
+
+          def inheritable_session_tags: () -> Hash[untyped, untyped]
+
+          def active_test_module: () -> Datadog::CI::TestModule?
+
+          def deactivate_test_session!: () -> void
+
+          def deactivate_test_module!: () -> void
+
+          def deactivate_test_suite!: (String test_suite_name) -> void
+        end
+      end
+    end
+  end
+end

data/sig/datadog/ci/test_visibility/context/local.rbs

@@ -0,0 +1,23 @@
+module Datadog
+  module CI
+    module TestVisibility
+      module Context
+        class Local
+          @key: Symbol
+
+          def initialize: () -> void
+
+          def activate_test!: (Datadog::CI::Test test) ?{ () -> untyped } -> void
+
+          def deactivate_test!: (Datadog::CI::Test test) -> void
+
+          def active_test: () -> Datadog::CI::Test?
+
+          private
+
+          def active_test=: (Datadog::CI::Test? test) -> untyped
+        end
+      end
+    end
+  end
+end