datadog-ci 1.12.0 → 1.13.0

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

@@ -18,9 +18,10 @@ module Datadog
     module TestVisibility
       # Common behavior for CI tests
       class Component
-        attr_reader :test_suite_level_visibility_enabled, :logical_test_session_name
+        attr_reader :test_suite_level_visibility_enabled, :logical_test_session_name, :known_tests, :known_tests_enabled
 
         def initialize(
+          known_tests_client:,
           test_suite_level_visibility_enabled: false,
           codeowners: Codeowners::Parser.new(Git::LocalRepository.root).parse,
           logical_test_session_name: nil
@@ -29,6 +30,21 @@ module Datadog
           @context = Context.new
           @codeowners = codeowners
           @logical_test_session_name = logical_test_session_name
+
+          # "Known tests" feature fetches a list of all tests known to Datadog for this repository
+          # and uses this list to determine if a test is new or not. New tests are marked with "test.is_new" tag.
+          @known_tests_enabled = false
+          @known_tests_client = known_tests_client
+          @known_tests = Set.new
+        end
+
+        def configure(library_configuration, test_session)
+          return unless test_suite_level_visibility_enabled
+
+          if library_configuration.known_tests_enabled?
+            @known_tests_enabled = true
+            fetch_known_tests(test_session)
+          end
         end
 
         def start_test_session(service: nil, tags: {}, total_tests_count: 0)
@@ -158,7 +174,8 @@ module Datadog
           # sets logical test session name if none provided by the user
           override_logical_test_session_name!(test_session) if logical_test_session_name.nil?
 
-          # signal Remote::Component to configure the library
+          # Signal Remote::Component to configure the library.
+          # Note that it will call this component back (unfortunate circular dependency).
           remote.configure(test_session)
         end
 
@@ -182,6 +199,10 @@ module Datadog
 
           Telemetry.event_created(test)
 
+          mark_test_as_new(test) if new_test?(test)
+
+          test_management.tag_test_from_properties(test)
+
           test_optimisation.mark_if_skippable(test)
           test_optimisation.start_coverage(test)
         end
@@ -287,6 +308,49 @@ module Datadog
           end
         end
 
+        def new_test?(test_span)
+          return false unless @known_tests_enabled
+
+          test_id = Utils::TestRun.datadog_test_id(test_span.name, test_span.test_suite_name)
+          result = !@known_tests.include?(test_id)
+
+          if result
+            Datadog.logger.debug do
+              "#{test_id} is not found in the known tests set, it is a new test"
+            end
+          end
+
+          result
+        end
+
+        def fetch_known_tests(test_session)
+          @known_tests = @known_tests_client.fetch(test_session)
+
+          if @known_tests.empty?
+            @known_tests_enabled = false
+
+            # this adds unfortunate knowledge on EFD from Testvisibility, rethink this
+            test_session&.set_tag(Ext::Test::TAG_EARLY_FLAKE_ABORT_REASON, Ext::Test::EARLY_FLAKE_FAULTY)
+
+            Datadog.logger.warn("Empty set of tests known to Datadog")
+          end
+
+          # report how many known tests were found
+          Datadog.logger.debug do
+            "Found [#{@known_tests.size}] known tests"
+          end
+          Utils::Telemetry.distribution(
+            Ext::Telemetry::METRIC_KNOWN_TESTS_RESPONSE_TESTS,
+            @known_tests.size.to_f
+          )
+
+          @known_tests
+        end
+
+        def mark_test_as_new(test_span)
+          test_span.set_tag(Ext::Test::TAG_IS_NEW, "true")
+        end
+
         def test_optimisation
           Datadog.send(:components).test_optimisation
         end
@@ -302,6 +366,10 @@ module Datadog
         def remote
           Datadog.send(:components).ci_remote
         end
+
+        def test_management
+          Datadog.send(:components).test_management
+        end
       end
     end
   end

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

@@ -208,10 +208,6 @@ module Datadog
           ci_span.set_tags(@environment_tags)
 
           ci_span.set_metric(Ext::Test::METRIC_CPU_COUNT, Utils::TestRun.virtual_cpu_count)
-          ci_span.set_tag(
-            Ext::Test::TAG_USER_PROVIDED_TEST_SERVICE,
-            Utils::Configuration.service_name_provided_by_user?.to_s
-          )
         end
 
         # PROPAGATING CONTEXT FROM TOP-LEVEL TO THE LOWER LEVELS

data/lib/datadog/ci/{test_retries/unique_tests_client.rb → test_visibility/known_tests.rb}

@@ -10,9 +10,9 @@ require_relative "../utils/test_run"
 
 module Datadog
   module CI
-    module TestRetries
-      # fetch a list of unique known tests from the backend
-      class UniqueTestsClient
+    module TestVisibility
+      # fetches and stores a list of known tests from the backend
+      class KnownTests
         class Response
           def initialize(http_response)
             @http_response = http_response
@@ -66,7 +66,7 @@ module Datadog
           @config_tags = config_tags
         end
 
-        def fetch_unique_tests(test_session)
+        def fetch(test_session)
           api = @api
           return Set.new unless api
 
@@ -78,21 +78,21 @@ module Datadog
             payload: request_payload
           )
 
-          Transport::Telemetry.api_requests(
-            Ext::Telemetry::METRIC_EFD_UNIQUE_TESTS_REQUEST,
+          CI::Transport::Telemetry.api_requests(
+            Ext::Telemetry::METRIC_KNOWN_TESTS_REQUEST,
             1,
             compressed: http_response.request_compressed
           )
-          Utils::Telemetry.distribution(Ext::Telemetry::METRIC_EFD_UNIQUE_TESTS_REQUEST_MS, http_response.duration_ms)
+          Utils::Telemetry.distribution(Ext::Telemetry::METRIC_KNOWN_TESTS_REQUEST_MS, http_response.duration_ms)
           Utils::Telemetry.distribution(
-            Ext::Telemetry::METRIC_EFD_UNIQUE_TESTS_RESPONSE_BYTES,
+            Ext::Telemetry::METRIC_KNOWN_TESTS_RESPONSE_BYTES,
             http_response.response_size.to_f,
             {Ext::Telemetry::TAG_RESPONSE_COMPRESSED => http_response.gzipped_content?.to_s}
           )
 
           unless http_response.ok?
-            Transport::Telemetry.api_requests_errors(
-              Ext::Telemetry::METRIC_EFD_UNIQUE_TESTS_REQUEST_ERRORS,
+            CI::Transport::Telemetry.api_requests_errors(
+              Ext::Telemetry::METRIC_KNOWN_TESTS_REQUEST_ERRORS,
               1,
               error_type: http_response.telemetry_error_type,
               status_code: http_response.code

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

@@ -5,6 +5,9 @@ module Datadog
     module TestVisibility
       # Special test visibility component that does not record anything
       class NullComponent
+        def configure(_, _)
+        end
+
         def start_test_session(service: nil, tags: {}, total_tests_count: 0)
           skip_tracing
         end

data/lib/datadog/ci/test_visibility/serializers/factories/test_level.rb

@@ -9,7 +9,7 @@ module Datadog
       module Serializers
         module Factories
           # This factory takes care of creating msgpack serializers when test-level visibility is enabled
-          # NOTE: citestcycle is a protocol Datadog uses to submit test execution tracing information to CI visibility
+          # NOTE: citestcycle is a protocol Datadog uses to submit test execution tracing information to Test Optimization
           # backend
           module TestLevel
             module_function

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

@@ -54,8 +54,11 @@ module Datadog
           # codeowner tag
           tags[Ext::Telemetry::TAG_HAS_CODEOWNER] = "true" if span.get_tag(Ext::Test::TAG_CODEOWNERS)
 
-          # set is_retry tag if span represents a retried test
-          tags[Ext::Telemetry::TAG_IS_RETRY] = "true" if span.get_tag(Ext::Test::TAG_IS_RETRY)
+          # set is_retry and retry_reason tags if span represents a retried test
+          if span.get_tag(Ext::Test::TAG_IS_RETRY)
+            tags[Ext::Telemetry::TAG_IS_RETRY] = "true"
+            tags[Ext::Telemetry::TAG_RETRY_REASON] = span.get_tag(Ext::Test::TAG_RETRY_REASON)
+          end
 
           # is_new
           tags[Ext::Telemetry::TAG_IS_NEW] = "true" if span.get_tag(Ext::Test::TAG_IS_NEW)
@@ -66,6 +69,12 @@ module Datadog
             tags[Ext::Telemetry::TAG_EARLY_FLAKE_DETECTION_ABORT_REASON] = early_flake_detection_abort_reason
           end
 
+          # test management tags
+          tags[Ext::Telemetry::TAG_IS_ATTEMPT_TO_FIX] = "true" if span.get_tag(Ext::Test::TAG_IS_ATTEMPT_TO_FIX)
+          tags[Ext::Telemetry::TAG_IS_QUARANTINED] = "true" if span.get_tag(Ext::Test::TAG_IS_QUARANTINED)
+          tags[Ext::Telemetry::TAG_IS_TEST_DISABLED] = "true" if span.get_tag(Ext::Test::TAG_IS_TEST_DISABLED)
+          tags[Ext::Telemetry::TAG_HAS_FAILED_ALL_RETRIES] = "true" if span.get_tag(Ext::Test::TAG_HAS_FAILED_ALL_RETRIES)
+
           tags
         end
 

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

@@ -4,12 +4,15 @@ require "datadog/core/environment/identity"
 require "datadog/core/telemetry/logging"
 require "datadog/core/utils/only_once"
 
+require_relative "capabilities"
 require_relative "serializers/factories/test_level"
+
 require_relative "../ext/app_types"
 require_relative "../ext/telemetry"
 require_relative "../ext/transport"
 require_relative "../transport/event_platform_transport"
 require_relative "../transport/telemetry"
+require_relative "../utils/configuration"
 
 module Datadog
   module CI
@@ -114,12 +117,22 @@ module Datadog
           packer.write("library_version")
           packer.write(Datadog::CI::VERSION::STRING)
 
+          library_capabilities_tags = Capabilities.tags
+
           Ext::AppTypes::CI_SPAN_TYPES.each do |ci_span_type|
             packer.write(ci_span_type)
-            packer.write_map_header(1)
+            packer.write_map_header(2 + library_capabilities_tags.count)
 
-            packer.write(Ext::Test::METADATA_TAG_TEST_SESSION_NAME)
+            packer.write(Ext::Test::TAG_TEST_SESSION_NAME)
             packer.write(test_visibility&.logical_test_session_name)
+
+            packer.write(Ext::Test::TAG_USER_PROVIDED_TEST_SERVICE)
+            packer.write(Utils::Configuration.service_name_provided_by_user?.to_s)
+
+            library_capabilities_tags.each do |tag, value|
+              packer.write(tag)
+              packer.write(value)
+            end
           end
 
           packer.write("events")

data/lib/datadog/ci/version.rb

@@ -4,7 +4,7 @@ module Datadog
   module CI
     module VERSION
       MAJOR = 1
-      MINOR = 12
+      MINOR = 13
       PATCH = 0
       PRE = nil
       BUILD = nil

data/lib/datadog/ci.rb

@@ -10,7 +10,7 @@ require "datadog"
 require "datadog/core"
 
 module Datadog
-  # Datadog CI visibility public API.
+  # Datadog Test Optimization public API.
   #
   # @public_api
   module CI
@@ -319,16 +319,16 @@ module Datadog
       # @return [Object] If a block is provided, returns the result of the block execution.
       # @return [Datadog::CI::Span] If no block is provided, returns the active,
       #         unfinished {Datadog::CI::Span}.
-      # @return [nil] if CI visibility is disabled
-      # @raise [ReservedTypeError] if provided type is reserved for Datadog CI visibility
+      # @return [nil] if Test Optimization is disabled
+      # @raise [ReservedTypeError] if provided type is reserved for Datadog Test Optimization
       # @yield Optional block where newly created {Datadog::CI::Span} captures the execution.
       # @yieldparam [Datadog::CI::Span] ci_span the newly created and active [Datadog::CI::Span]
-      # @yieldparam [nil] ci_span if CI visibility is disabled
+      # @yieldparam [nil] ci_span if Test Optimization is disabled
       def trace(span_name, type: "span", tags: {}, &block)
         if Ext::AppTypes::CI_SPAN_TYPES.include?(type)
           raise(
             ReservedTypeError,
-            "Span type #{type} is reserved for Datadog CI visibility. " \
+            "Span type #{type} is reserved for Datadog Test Optimization. " \
               "Reserved types are: #{Ext::AppTypes::CI_SPAN_TYPES}"
           )
         end
@@ -401,6 +401,14 @@ module Datadog
       def test_optimisation
         components.test_optimisation
       end
+
+      def test_management
+        components.test_management
+      end
+
+      def test_retries
+        components.test_retries
+      end
     end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: datadog-ci
 version: !ruby/object:Gem::Version
-  version: 1.12.0
+  version: 1.13.0
 platform: ruby
 authors:
 - Datadog, Inc.
 bindir: exe
 cert_chain: []
-date: 2025-01-23 00:00:00.000000000 Z
+date: 2025-02-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: datadog
@@ -38,7 +38,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 description: |2
-    datadog-ci is a Datadog's CI visibility library for Ruby. It traces
+    datadog-ci is a Datadog's Test Optimization library for Ruby. It traces
     tests as they are being executed and brings developers visibility into
     their CI pipelines.
 email:
@@ -164,6 +164,9 @@ files:
 - lib/datadog/ci/remote/slow_test_retries.rb
 - lib/datadog/ci/span.rb
 - lib/datadog/ci/test.rb
+- lib/datadog/ci/test_management/component.rb
+- lib/datadog/ci/test_management/null_component.rb
+- lib/datadog/ci/test_management/tests_properties.rb
 - lib/datadog/ci/test_module.rb
 - lib/datadog/ci/test_optimisation/component.rb
 - lib/datadog/ci/test_optimisation/coverage/ddcov.rb
@@ -179,18 +182,21 @@ files:
 - lib/datadog/ci/test_retries/driver/base.rb
 - lib/datadog/ci/test_retries/driver/no_retry.rb
 - lib/datadog/ci/test_retries/driver/retry_failed.rb
+- lib/datadog/ci/test_retries/driver/retry_flaky_fixed.rb
 - lib/datadog/ci/test_retries/driver/retry_new.rb
 - lib/datadog/ci/test_retries/null_component.rb
 - lib/datadog/ci/test_retries/strategy/base.rb
 - lib/datadog/ci/test_retries/strategy/no_retry.rb
 - lib/datadog/ci/test_retries/strategy/retry_failed.rb
+- lib/datadog/ci/test_retries/strategy/retry_flaky_fixed.rb
 - lib/datadog/ci/test_retries/strategy/retry_new.rb
-- lib/datadog/ci/test_retries/unique_tests_client.rb
 - lib/datadog/ci/test_session.rb
 - lib/datadog/ci/test_suite.rb
+- lib/datadog/ci/test_visibility/capabilities.rb
 - lib/datadog/ci/test_visibility/component.rb
 - lib/datadog/ci/test_visibility/context.rb
 - lib/datadog/ci/test_visibility/flush.rb
+- lib/datadog/ci/test_visibility/known_tests.rb
 - lib/datadog/ci/test_visibility/null_component.rb
 - lib/datadog/ci/test_visibility/null_transport.rb
 - lib/datadog/ci/test_visibility/serializers/base.rb
@@ -254,5 +260,5 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.6.2
 specification_version: 4
-summary: Datadog CI visibility for your ruby application
+summary: Datadog Test Optimization for your ruby application
 test_files: []