datadog-ci 0.5.0 → 0.6.0

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

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

@@ -0,0 +1,45 @@
+module Datadog
+  module CI
+    module TestVisibility
+      class NullRecorder
+        @null_span: Datadog::CI::NullSpan
+
+        def initialize: (?untyped args) -> 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
+
+        private
+
+        def null_span: () -> Datadog::CI::Span
+
+        def skip_tracing: (?untyped block) -> untyped
+      end
+    end
+  end
+end

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
+
+        @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
+
+        def initialize: (?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
+
+        private
+
+        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
+
+        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
+
+        def validate_test_suite_level_visibility_correctness: (Datadog::CI::Test test) -> void
+      end
+    end
+  end
+end

data/sig/datadog/ci.rbs

@@ -18,6 +18,8 @@ module Datadog
 
     def self.active_test: () -> Datadog::CI::Test?
 
+    def self.active_test_suite: (String test_suite_name) -> Datadog::CI::TestSuite?
+
     def self.active_span: (String span_type) -> Datadog::CI::Span?
 
     def self.deactivate_test: (Datadog::CI::Test test) -> void
@@ -30,6 +32,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.6.0
 platform: ruby
 authors:
 - Datadog, Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-12-06 00:00:00.000000000 Z
+date: 2024-01-03 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
@@ -56,14 +55,19 @@ files:
 - lib/datadog/ci/contrib/integration.rb
 - lib/datadog/ci/contrib/minitest/configuration/settings.rb
 - lib/datadog/ci/contrib/minitest/ext.rb
+- lib/datadog/ci/contrib/minitest/helpers.rb
 - lib/datadog/ci/contrib/minitest/hooks.rb
 - lib/datadog/ci/contrib/minitest/integration.rb
 - lib/datadog/ci/contrib/minitest/patcher.rb
+- lib/datadog/ci/contrib/minitest/plugin.rb
+- lib/datadog/ci/contrib/minitest/runnable.rb
 - lib/datadog/ci/contrib/rspec/configuration/settings.rb
 - lib/datadog/ci/contrib/rspec/example.rb
+- lib/datadog/ci/contrib/rspec/example_group.rb
 - lib/datadog/ci/contrib/rspec/ext.rb
 - lib/datadog/ci/contrib/rspec/integration.rb
 - lib/datadog/ci/contrib/rspec/patcher.rb
+- lib/datadog/ci/contrib/rspec/runner.rb
 - lib/datadog/ci/contrib/settings.rb
 - lib/datadog/ci/ext/app_types.rb
 - lib/datadog/ci/ext/environment.rb
@@ -90,15 +94,17 @@ 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/null_recorder.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 +128,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
@@ -134,14 +139,19 @@ files:
 - sig/datadog/ci/contrib/integration.rbs
 - sig/datadog/ci/contrib/minitest/configuration/settings.rbs
 - sig/datadog/ci/contrib/minitest/ext.rbs
+- sig/datadog/ci/contrib/minitest/helpers.rbs
 - sig/datadog/ci/contrib/minitest/hooks.rbs
 - sig/datadog/ci/contrib/minitest/integration.rbs
 - sig/datadog/ci/contrib/minitest/patcher.rbs
+- sig/datadog/ci/contrib/minitest/plugin.rbs
+- sig/datadog/ci/contrib/minitest/runnable.rbs
 - sig/datadog/ci/contrib/rspec/configuration/settings.rbs
 - sig/datadog/ci/contrib/rspec/example.rbs
+- sig/datadog/ci/contrib/rspec/example_group.rbs
 - sig/datadog/ci/contrib/rspec/ext.rbs
 - sig/datadog/ci/contrib/rspec/integration.rbs
 - sig/datadog/ci/contrib/rspec/patcher.rbs
+- sig/datadog/ci/contrib/rspec/runner.rbs
 - sig/datadog/ci/contrib/settings.rbs
 - sig/datadog/ci/ext/app_types.rbs
 - sig/datadog/ci/ext/environment.rbs
@@ -168,15 +178,17 @@ 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/null_recorder.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
@@ -223,7 +235,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 2.0.0
 requirements: []
-rubygems_version: 3.4.21
+rubygems_version: 3.4.22
 signing_key:
 specification_version: 4
 summary: Datadog CI visibility for your ruby application

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