datadog-ci 0.5.0 → 0.5.1

data/sig/datadog/ci/test_visibility/recorder.rbs

@@ -0,0 +1,85 @@
+module Datadog
+  module CI
+    module TestVisibility
+      class Recorder
+        @test_suite_level_visibility_enabled: bool
+        @enabled: bool
+
+        @environment_tags: Hash[String, String]
+        @local_context: Datadog::CI::TestVisibility::Context::Local
+        @global_context: Datadog::CI::TestVisibility::Context::Global
+
+        @null_span: Datadog::CI::NullSpan
+
+        attr_reader environment_tags: Hash[String, String]
+        attr_reader test_suite_level_visibility_enabled: bool
+        attr_reader enabled: bool
+
+        def initialize: (?enabled: bool, ?test_suite_level_visibility_enabled: bool) -> void
+
+        def trace_test: (String span_name, String test_suite_name, ?service: String?, ?tags: Hash[untyped, untyped]) ?{ (Datadog::CI::Span span) -> untyped } -> untyped
+
+        def trace: (String span_type, String span_name, ?tags: Hash[untyped, untyped]) ?{ (Datadog::CI::Span span) -> untyped } -> untyped
+
+        def start_test_session: (?service: String?, ?tags: Hash[untyped, untyped]) -> Datadog::CI::Span
+
+        def start_test_module: (String test_module_name, ?service: String?, ?tags: Hash[untyped, untyped]) -> Datadog::CI::Span
+
+        def start_test_suite: (String test_suite_name, ?service: String?, ?tags: Hash[untyped, untyped]) -> Datadog::CI::Span
+
+        def active_test_session: () -> Datadog::CI::TestSession?
+
+        def active_test_module: () -> Datadog::CI::TestModule?
+
+        def active_test_suite: (String test_suite_name) -> Datadog::CI::TestSuite?
+
+        def active_test: () -> Datadog::CI::Test?
+
+        def active_span: () -> Datadog::CI::Span?
+
+        def deactivate_test: (Datadog::CI::Test test) -> void
+
+        def deactivate_test_session: () -> void
+
+        def deactivate_test_module: () -> void
+
+        def deactivate_test_suite: (String test_suite_name) -> void
+
+        def create_datadog_span: (String span_name, ?span_options: Hash[untyped, untyped], ?tags: Hash[untyped, untyped]) ?{ (Datadog::CI::Span span) -> untyped } -> untyped
+
+        def set_trace_origin: (Datadog::Tracing::TraceOperation trace) -> untyped
+
+        private
+
+        def build_test: (Datadog::Tracing::SpanOperation tracer_span, Hash[untyped, untyped] tags) -> Datadog::CI::Test
+
+        def build_test_session: (Datadog::Tracing::SpanOperation tracer_span, Hash[untyped, untyped] tags) -> Datadog::CI::TestSession
+
+        def build_test_module: (Datadog::Tracing::SpanOperation tracer_span, Hash[untyped, untyped] tags) -> Datadog::CI::TestModule
+
+        def build_test_suite: (Datadog::Tracing::SpanOperation tracer_span, Hash[untyped, untyped] tags) -> Datadog::CI::TestSuite
+
+        def build_span: (Datadog::Tracing::SpanOperation tracer_span, Hash[untyped, untyped] tags) -> Datadog::CI::Span
+
+        def build_span_options: (String? service_name, String span_type, ?Hash[Symbol, untyped] other_options) -> Hash[Symbol, untyped]
+
+        def set_initial_tags: (Datadog::CI::Span ci_span, Hash[untyped, untyped] tags) -> void
+
+        # the type (Datadog::CI::TestSession | Datadog::Tracing::SpanOperation) screams of wrong/mising abstraction
+        def set_session_context: (Hash[untyped, untyped] tags, ?Datadog::CI::TestSession | Datadog::Tracing::SpanOperation? test_session) -> void
+
+        def set_suite_context: (Hash[untyped, untyped] tags, ?span: Datadog::Tracing::SpanOperation, ?name: String) -> void
+
+        def set_module_context: (Hash[untyped, untyped] tags, ?Datadog::CI::TestModule | Datadog::Tracing::SpanOperation? test_module) -> void
+
+        def null_span: () -> Datadog::CI::Span
+
+        def skip_tracing: (?untyped block) -> untyped
+
+        def start_datadog_tracer_span: (String span_name, Hash[untyped, untyped] span_options) ?{ (untyped) -> untyped } -> untyped
+
+        def set_inherited_globals: (Hash[untyped, untyped] tags) -> void
+      end
+    end
+  end
+end

data/sig/datadog/ci.rbs

@@ -30,6 +30,6 @@ module Datadog
 
     def self.components: () -> Datadog::CI::Configuration::Components
 
-    def self.recorder: () -> Datadog::CI::Recorder
+    def self.recorder: () -> Datadog::CI::TestVisibility::Recorder
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: datadog-ci
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Datadog, Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-06 00:00:00.000000000 Z
+date: 2023-12-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: msgpack
@@ -44,9 +44,8 @@ files:
 - lib/datadog/ci.rb
 - lib/datadog/ci/concurrent_span.rb
 - lib/datadog/ci/configuration/components.rb
+- lib/datadog/ci/configuration/extensions.rb
 - lib/datadog/ci/configuration/settings.rb
-- lib/datadog/ci/context/global.rb
-- lib/datadog/ci/context/local.rb
 - lib/datadog/ci/contrib/cucumber/configuration/settings.rb
 - lib/datadog/ci/contrib/cucumber/ext.rb
 - lib/datadog/ci/contrib/cucumber/formatter.rb
@@ -90,15 +89,16 @@ files:
 - lib/datadog/ci/ext/settings.rb
 - lib/datadog/ci/ext/test.rb
 - lib/datadog/ci/ext/transport.rb
-- lib/datadog/ci/extensions.rb
 - lib/datadog/ci/null_span.rb
-- lib/datadog/ci/recorder.rb
 - lib/datadog/ci/span.rb
 - lib/datadog/ci/test.rb
 - lib/datadog/ci/test_module.rb
 - lib/datadog/ci/test_session.rb
 - lib/datadog/ci/test_suite.rb
+- lib/datadog/ci/test_visibility/context/global.rb
+- lib/datadog/ci/test_visibility/context/local.rb
 - lib/datadog/ci/test_visibility/flush.rb
+- lib/datadog/ci/test_visibility/recorder.rb
 - lib/datadog/ci/test_visibility/serializers/base.rb
 - lib/datadog/ci/test_visibility/serializers/factories/test_level.rb
 - lib/datadog/ci/test_visibility/serializers/factories/test_suite_level.rb
@@ -122,9 +122,8 @@ files:
 - sig/datadog/ci.rbs
 - sig/datadog/ci/concurrent_span.rbs
 - sig/datadog/ci/configuration/components.rbs
+- sig/datadog/ci/configuration/extensions.rbs
 - sig/datadog/ci/configuration/settings.rbs
-- sig/datadog/ci/context/global.rbs
-- sig/datadog/ci/context/local.rbs
 - sig/datadog/ci/contrib/cucumber/configuration/settings.rbs
 - sig/datadog/ci/contrib/cucumber/ext.rbs
 - sig/datadog/ci/contrib/cucumber/formatter.rbs
@@ -168,15 +167,16 @@ files:
 - sig/datadog/ci/ext/settings.rbs
 - sig/datadog/ci/ext/test.rbs
 - sig/datadog/ci/ext/transport.rbs
-- sig/datadog/ci/extensions.rbs
 - sig/datadog/ci/null_span.rbs
-- sig/datadog/ci/recorder.rbs
 - sig/datadog/ci/span.rbs
 - sig/datadog/ci/test.rbs
 - sig/datadog/ci/test_module.rbs
 - sig/datadog/ci/test_session.rbs
 - sig/datadog/ci/test_suite.rbs
+- sig/datadog/ci/test_visibility/context/global.rbs
+- sig/datadog/ci/test_visibility/context/local.rbs
 - sig/datadog/ci/test_visibility/flush.rbs
+- sig/datadog/ci/test_visibility/recorder.rbs
 - sig/datadog/ci/test_visibility/serializers/base.rbs
 - sig/datadog/ci/test_visibility/serializers/factories/test_level.rbs
 - sig/datadog/ci/test_visibility/serializers/factories/test_suite_level.rbs

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

@@ -1,80 +0,0 @@
-# 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/context/local.rb

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

data/lib/datadog/ci/extensions.rb

@@ -1,19 +0,0 @@
-# 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/recorder.rb

@@ -1,291 +0,0 @@
-# frozen_string_literal: true
-
-require "datadog/tracing"
-require "datadog/tracing/trace_digest"
-
-require "rbconfig"
-
-require_relative "ext/app_types"
-require_relative "ext/test"
-require_relative "ext/environment"
-
-require_relative "context/global"
-require_relative "context/local"
-
-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
-    # 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 = 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

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

@@ -1,37 +0,0 @@
-module Datadog
-  module CI
-    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

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

@@ -1,21 +0,0 @@
-module Datadog
-  module CI
-    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

data/sig/datadog/ci/extensions.rbs

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