datadog-ci 1.23.2 → 1.24.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 660ce0996ea0998e1074ca1f3671b00b74659b31520486c0fec7f850cf619c40
-  data.tar.gz: b3fa584967668ee53d4f66b9c4963236b1fbe58367f4833bf1436064a5112773
+  metadata.gz: 30bc86afa5d05d656f9abfa7ffb5ff21d6f9a8fc5edeb5924651de4cdc6df10d
+  data.tar.gz: c846a97a47a74120d9926350360cefa4ca3fcdadea6819337ad2990f7856e267
 SHA512:
-  metadata.gz: 8c99eab8f2b7f6367627746f94cb1338e77000791f89a96767f23572c43d13d96384b7f9b85c494d64bbef34dbbc0659123b31df14976a1de973075ce7bcb657
-  data.tar.gz: 5eab6749fe723823f6bcade1f946e9669924b3299219b7a9e67c1db1b8ac12483ffb910aedbd4be145839dd7a17ac0527d95ec36358cd2f2cee82387b6d136b9
+  metadata.gz: 2e2a5b3efa12f1c64176e1751e86ebf803f8c894aba7c53453abb22732e0ed16a6087292538b2e03f0657dc9433ceba9e452f5899a95ace325a004ee12c37fbc
+  data.tar.gz: 461912b9cb9f406c4fd1cb9975ece506df7e979ed7b373b46c9e0060977f397b2da63095be353351d74b4273ea3cc1a354c12a4ef9dc7bf75a0a5ed065a16fa3

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 ## [Unreleased]
 
+## [1.24.0] - 2025-12-15
+
+### Added
+* Create final status tag on test events ([#433][])
+
+### Changed
+* Add `branch` parameter to `/test-management/tests` request ([#436][])
+
+### Fixed
+* Fix an inheritance blind spot for Test Impact Analysis ([#440][])
+
+## [1.23.3] - 2025-11-19
+
+### Fixed
+
+* Fix nil error for test discovery component by introducing NullObject pattern for all components of Datadog Test Optimization ([#430][])
+
 ## [1.23.2] - 2025-11-18
 
 ### Added
@@ -548,7 +565,9 @@ 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/v1.23.2...main
+[Unreleased]: https://github.com/DataDog/datadog-ci-rb/compare/v1.24.0...main
+[1.24.0]: https://github.com/DataDog/datadog-ci-rb/compare/v1.23.3...v1.24.0
+[1.23.3]: https://github.com/DataDog/datadog-ci-rb/compare/v1.23.2...v1.23.3
 [1.23.2]: https://github.com/DataDog/datadog-ci-rb/compare/v1.23.1...v1.23.2
 [1.23.1]: https://github.com/DataDog/datadog-ci-rb/compare/v1.23.0...v1.23.1
 [1.23.0]: https://github.com/DataDog/datadog-ci-rb/compare/v1.22.1...v1.23.0
@@ -778,4 +797,8 @@ Currently test suite level visibility is not used by our instrumentation: it wil
 [#414]: https://github.com/DataDog/datadog-ci-rb/issues/414
 [#416]: https://github.com/DataDog/datadog-ci-rb/issues/416
 [#418]: https://github.com/DataDog/datadog-ci-rb/issues/418
-[#425]: https://github.com/DataDog/datadog-ci-rb/issues/425
+[#425]: https://github.com/DataDog/datadog-ci-rb/issues/425
+[#430]: https://github.com/DataDog/datadog-ci-rb/issues/430
+[#433]: https://github.com/DataDog/datadog-ci-rb/issues/433
+[#436]: https://github.com/DataDog/datadog-ci-rb/issues/436
+[#440]: https://github.com/DataDog/datadog-ci-rb/issues/440

data/ext/datadog_ci_native/datadog_cov.c

@@ -156,12 +156,12 @@ static VALUE dd_cov_allocate(VALUE klass) {
 
 // Checks if the filename is located under the root folder of the project (but
 // not in the ignored folder) and adds it to the impacted_files hash.
-static void record_impacted_file(struct dd_cov_data *dd_cov_data,
+static bool record_impacted_file(struct dd_cov_data *dd_cov_data,
                                  VALUE filename) {
   char *filename_ptr = RSTRING_PTR(filename);
   // if the current filename is not located under the root, we skip it
   if (strncmp(dd_cov_data->root, filename_ptr, dd_cov_data->root_len) != 0) {
-    return;
+    return false;
   }
 
   // if ignored_path is provided and the current filename is located under the
@@ -170,10 +170,11 @@ static void record_impacted_file(struct dd_cov_data *dd_cov_data,
   if (dd_cov_data->ignored_path_len != 0 &&
       strncmp(dd_cov_data->ignored_path, filename_ptr,
               dd_cov_data->ignored_path_len) == 0) {
-    return;
+    return false;
   }
 
   rb_hash_aset(dd_cov_data->impacted_files, filename, Qtrue);
+  return true;
 }
 
 // Executed on RUBY_EVENT_LINE event and captures the filename from
@@ -221,29 +222,61 @@ static VALUE safely_get_source_location(VALUE klass_name) {
   return rescue_nil(get_source_location, klass_name);
 }
 
-// This function is called for each class that was instantiated during the test
-// run.
-static int process_instantiated_klass(st_data_t key, st_data_t _value,
-                                      st_data_t data) {
-  VALUE klass = (VALUE)key;
-  struct dd_cov_data *dd_cov_data = (struct dd_cov_data *)data;
+// Safely get class name, returns Qnil on any error
+static VALUE safely_get_class_name(VALUE klass) {
+  return rescue_nil(rb_class_name, klass);
+}
 
-  VALUE klass_name = rb_class_name(klass);
+// Safely get module ancestors, returns Qnil on any error
+static VALUE safely_get_mod_ancestors(VALUE klass) {
+  return rescue_nil(rb_mod_ancestors, klass);
+}
+
+static bool record_impacted_klass(struct dd_cov_data *dd_cov_data,
+                                  VALUE klass) {
+  VALUE klass_name = safely_get_class_name(klass);
   if (klass_name == Qnil) {
-    return ST_CONTINUE;
+    return false;
   }
 
   VALUE source_location = safely_get_source_location(klass_name);
-  if (source_location == Qnil || RARRAY_LEN(source_location) == 0) {
-    return ST_CONTINUE;
+  if (source_location == Qnil || !RB_TYPE_P(source_location, T_ARRAY) ||
+      RARRAY_LEN(source_location) == 0) {
+    return false;
   }
 
   VALUE filename = RARRAY_AREF(source_location, 0);
   if (filename == Qnil || !RB_TYPE_P(filename, T_STRING)) {
+    return false;
+  }
+
+  return record_impacted_file(dd_cov_data, filename);
+}
+
+// This function is called for each class that was instantiated during the test
+// run.
+static int each_instantiated_klass(st_data_t key, st_data_t _value,
+                                   st_data_t data) {
+  VALUE klass = (VALUE)key;
+  struct dd_cov_data *dd_cov_data = (struct dd_cov_data *)data;
+
+  // rb_mod_ancestors returns an array containing the "klass" itself
+  // and all the parent classes and/or included/prepended modules
+  VALUE ancestors = safely_get_mod_ancestors(klass);
+  if (ancestors == Qnil || !RB_TYPE_P(ancestors, T_ARRAY)) {
     return ST_CONTINUE;
   }
 
-  record_impacted_file(dd_cov_data, filename);
+  long len = RARRAY_LEN(ancestors);
+  for (long i = 0; i < len; i++) {
+    VALUE mod = rb_ary_entry(ancestors, i);
+    if (mod == Qnil) {
+      continue;
+    }
+
+    record_impacted_klass(dd_cov_data, mod);
+  }
+
   return ST_CONTINUE;
 }
 
@@ -385,7 +418,7 @@ static VALUE dd_cov_stop(VALUE self) {
   }
 
   // process classes covered by allocation tracing
-  st_foreach(dd_cov_data->klasses_table, process_instantiated_klass,
+  st_foreach(dd_cov_data->klasses_table, each_instantiated_klass,
              (st_data_t)dd_cov_data);
   st_clear(dd_cov_data->klasses_table);
 

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

@@ -5,18 +5,22 @@ require "datadog/core/telemetry/ext"
 require_relative "../ext/settings"
 require_relative "../git/tree_uploader"
 require_relative "../impacted_tests_detection/component"
+require_relative "../impacted_tests_detection/null_component"
 require_relative "../logs/component"
 require_relative "../logs/transport"
+require_relative "../remote/null_component"
 require_relative "../remote/component"
 require_relative "../remote/library_settings_client"
 require_relative "../test_management/component"
 require_relative "../test_management/null_component"
 require_relative "../test_management/tests_properties"
+require_relative "../test_optimisation/null_component"
 require_relative "../test_optimisation/component"
 require_relative "../test_optimisation/coverage/transport"
 require_relative "../test_retries/component"
 require_relative "../test_retries/null_component"
 require_relative "../test_discovery/component"
+require_relative "../test_discovery/null_component"
 require_relative "../test_visibility/component"
 require_relative "../test_visibility/flush"
 require_relative "../test_visibility/known_tests"
@@ -41,14 +45,14 @@ module Datadog
           :test_management, :agentless_logs_submission, :impacted_tests_detection, :test_discovery
 
         def initialize(settings)
-          @test_optimisation = nil
+          @test_optimisation = TestOptimisation::NullComponent.new
           @test_visibility = TestVisibility::NullComponent.new
           @git_tree_upload_worker = DummyWorker.new
-          @ci_remote = nil
+          @ci_remote = Remote::NullComponent.new
           @test_retries = TestRetries::NullComponent.new
           @test_management = TestManagement::NullComponent.new
-          @impacted_tests_detection = nil
-          @test_discovery = nil
+          @impacted_tests_detection = ImpactedTestsDetection::NullComponent.new
+          @test_discovery = TestDiscovery::NullComponent.new
 
           # Activate CI mode if enabled
           if settings.ci.enabled

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

@@ -18,8 +18,10 @@ module Datadog
             def run_specs(*args)
               return super unless datadog_configuration[:enabled]
 
-              if test_discovery_component.enabled?
-                discover_tests
+              discovery_component = test_discovery_component
+
+              if discovery_component&.enabled?
+                discover_tests(discovery_component)
 
                 # don't run the tests, we just needed to discover them and now we can return
                 return
@@ -74,15 +76,15 @@ module Datadog
               Datadog.send(:components).test_discovery
             end
 
-            def discover_tests
-              test_discovery_component.start
+            def discover_tests(component)
+              component.start
 
               examples = ::RSpec.world.all_examples
 
               examples.each do |example|
                 next if example.metadata[:skip]
 
-                test_discovery_component.record_test(
+                component.record_test(
                   name: example.datadog_test_name,
                   suite: example.datadog_test_suite_name,
                   parameters: example.datadog_test_parameters,
@@ -91,7 +93,7 @@ module Datadog
                 )
               end
 
-              test_discovery_component.finish
+              component.finish
             end
           end
         end

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

@@ -13,7 +13,21 @@ module Datadog
         TAG_FRAMEWORK_VERSION = "test.framework_version"
         TAG_NAME = "test.name"
         TAG_SKIP_REASON = "test.skip_reason"
+
+        # Status is the result of a single test run
+        # See the [Datadog::CI::Ext::Test::Status] module for the list of possible values of this tag
         TAG_STATUS = "test.status"
+        # Final status is the result that Datadog reports after all retries for a given test. It might be different
+        # from the status of the given test run:
+        #
+        # Example: new test was retried 10 times by Early Flake Detection. It succeeded 9 times and failed once.
+        # The final status will be "pass" because we keep CI green for flaky tests.
+        #
+        # This tag is useful to create monitors on hard failures: if test.final_status is "fail", then CI is red.
+        #
+        # See the [Datadog::CI::Ext::Test::Status] module for the list of possible values of this tag
+        TAG_FINAL_STATUS = "test.final_status"
+
         TAG_SUITE = "test.suite"
         TAG_MODULE = "test.module"
         TAG_TYPE = "test.type"

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

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+module Datadog
+  module CI
+    module ImpactedTestsDetection
+      # Null object used when impacted tests detection is unavailable
+      class NullComponent
+        def configure(_library_settings = nil, _test_session = nil)
+        end
+
+        def enabled?
+          false
+        end
+
+        def modified?(_test_span)
+          false
+        end
+
+        def tag_modified_test(_test_span)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Datadog
+  module CI
+    module Remote
+      # No-op implementation used when remote configuration is disabled.
+      class NullComponent
+        def configure(_test_session)
+        end
+      end
+    end
+  end
+end

data/lib/datadog/ci/test.rb

@@ -244,6 +244,32 @@ module Datadog
         get_tag(Ext::Test::TAG_ITR_SKIPPED_BY_ITR) == "true"
       end
 
+      # @internal
+      def record_final_status
+        status = get_tag(Ext::Test::TAG_STATUS)
+        return if status.nil?
+
+        if [Ext::Test::Status::PASS, Ext::Test::Status::SKIP].include?(status)
+          set_tag(Ext::Test::TAG_FINAL_STATUS, status)
+          return
+        end
+
+        if should_ignore_failures?
+          set_tag(Ext::Test::TAG_FINAL_STATUS, Ext::Test::Status::PASS)
+        else
+          set_tag(Ext::Test::TAG_FINAL_STATUS, Ext::Test::Status::FAIL)
+        end
+      end
+
+      # @internal
+      def peek_duration
+        end_time = Core::Utils::Time.now.utc
+        start_time = tracer_span.start_time
+
+        return 0.0 if start_time.nil? || end_time.nil?
+        end_time - start_time
+      end
+
       private
 
       def record_test_result(datadog_status)

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Datadog
+  module CI
+    module TestDiscovery
+      # Null object used when test discovery component is unavailable
+      class NullComponent
+        def configure(_library_settings = nil, _test_session = nil)
+        end
+
+        def disable_features_for_test_discovery!(_settings = nil)
+        end
+
+        def start
+        end
+
+        def finish
+        end
+
+        def record_test(name:, suite:, module_name:, parameters:, source_file:)
+        end
+
+        def shutdown!
+        end
+
+        def enabled?
+          false
+        end
+      end
+    end
+  end
+end

data/lib/datadog/ci/test_management/tests_properties.rb

@@ -127,7 +127,8 @@ module Datadog
               "attributes" => {
                 "repository_url" => test_session.git_repository_url,
                 "commit_message" => test_session.original_git_commit_message,
-                "sha" => test_session.original_git_commit_sha
+                "sha" => test_session.original_git_commit_sha,
+                "branch" => test_session.git_branch
               }
             }
           }.to_json

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

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require "set"
+
+module Datadog
+  module CI
+    module TestOptimisation
+      # No-op implementation used when test optimisation is disabled.
+      class NullComponent
+        attr_reader :enabled, :skippable_tests_fetch_error, :test_skipping_enabled,
+          :code_coverage_enabled, :skippable_tests, :correlation_id
+
+        def initialize
+          @enabled = false
+          @test_skipping_enabled = false
+          @code_coverage_enabled = false
+          @skippable_tests_fetch_error = nil
+          @skippable_tests = Set.new
+          @correlation_id = nil
+        end
+
+        def configure(_remote_configuration = nil, _test_session = nil)
+        end
+
+        def enabled?
+          false
+        end
+
+        def skipping_tests?
+          false
+        end
+
+        def code_coverage?
+          false
+        end
+
+        def start_coverage(_test)
+        end
+
+        def stop_coverage(_test)
+          nil
+        end
+
+        def mark_if_skippable(_test)
+        end
+
+        def skippable?(_datadog_test_id)
+          false
+        end
+
+        def on_test_finished(_test, _context)
+        end
+
+        def write_test_session_tags(_test_session, _skipped_tests_count)
+        end
+
+        def skippable_tests_count
+          0
+        end
+
+        def shutdown!
+        end
+      end
+    end
+  end
+end

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

@@ -94,18 +94,27 @@ module Datadog
 
         def record_test_finished(test_span)
           if current_retry_driver.nil?
-            # we always run test at least once and after the first pass create a correct retry driver
+            # We always run test at least once and after the first pass create a correct retry driver
             self.current_retry_driver = build_driver(test_span)
           else
-            # after each retry we record the result, the driver will decide if we should retry again
+            # After each retry we let the driver to record the result.
+            # Then the driver will decide if we should retry again.
             current_retry_driver&.record_retry(test_span)
 
+            # We know that the test was already retried at least once so if we should not retry anymore, then this
+            # is the last retry.
             tag_last_retry(test_span) unless should_retry?
           end
-        end
 
-        def record_test_span_duration(tracer_span)
-          current_retry_driver&.record_duration(tracer_span.duration)
+          # Some retry strategies such as Early Flake Detection change the number of retries based on
+          # how long the test was.
+          current_retry_driver&.record_duration(test_span.peek_duration)
+
+          # We need to set the final status of the test (what will be reported to the test framework) on the last execution
+          # no matter if test was retried or not
+          #
+          # If we should not retry at this point, it means that this execution is the last one (it might the only one as well).
+          test_span.record_final_status unless should_retry?
         end
 
         # this API is targeted on Cucumber instrumentation or any other that cannot leverage #with_retries method

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

@@ -121,8 +121,6 @@ module Datadog
 
           if block
             @context.trace_test(test_name, test_suite, service: service, tags: tags) do |test|
-              subscribe_to_after_stop_event(test.tracer_span)
-
               on_test_started(test)
               res = block.call(test)
               on_test_finished(test)
@@ -130,7 +128,6 @@ module Datadog
             end
           else
             test = @context.trace_test(test_name, test_suite, service: service, tags: tags)
-            subscribe_to_after_stop_event(test.tracer_span)
             on_test_started(test)
             test
           end
@@ -340,10 +337,6 @@ module Datadog
           Telemetry.event_finished(test)
         end
 
-        def on_after_test_span_finished(tracer_span)
-          test_retries.record_test_span_duration(tracer_span)
-        end
-
         # HELPERS
         def single_active_test_suite
           # when fetching test_suite to use as test's context, try local context instance first
@@ -357,14 +350,6 @@ module Datadog
           block&.call(nil)
         end
 
-        def subscribe_to_after_stop_event(tracer_span)
-          events = tracer_span.send(:events)
-
-          events.after_stop.subscribe do |span|
-            on_after_test_span_finished(span)
-          end
-        end
-
         def set_codeowners(span)
           source = span.source_file
           owners = @codeowners.list_owners(source) if source

data/lib/datadog/ci/version.rb

@@ -4,8 +4,8 @@ module Datadog
   module CI
     module VERSION
       MAJOR = 1
-      MINOR = 23
-      PATCH = 2
+      MINOR = 24
+      PATCH = 0
       PRE = nil
       BUILD = nil
       # PRE and BUILD above are modified for dev gems during gem build GHA workflow
@@ -22,7 +22,7 @@ module Datadog
       # To allow testing with the next unreleased version of Ruby, the version check is performed
       # as `< #{MAXIMUM_RUBY_VERSION}`, meaning prereleases of MAXIMUM_RUBY_VERSION are allowed
       # but not stable MAXIMUM_RUBY_VERSION releases.
-      MAXIMUM_RUBY_VERSION = "3.5"
+      MAXIMUM_RUBY_VERSION = "4.0"
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: datadog-ci
 version: !ruby/object:Gem::Version
-  version: 1.23.2
+  version: 1.24.0
 platform: ruby
 authors:
 - Datadog, Inc.
@@ -211,6 +211,7 @@ files:
 - lib/datadog/ci/git/upload_packfile.rb
 - lib/datadog/ci/git/user.rb
 - lib/datadog/ci/impacted_tests_detection/component.rb
+- lib/datadog/ci/impacted_tests_detection/null_component.rb
 - lib/datadog/ci/logs/component.rb
 - lib/datadog/ci/logs/transport.rb
 - lib/datadog/ci/readonly_test_module.rb
@@ -218,10 +219,12 @@ files:
 - lib/datadog/ci/remote/component.rb
 - lib/datadog/ci/remote/library_settings.rb
 - lib/datadog/ci/remote/library_settings_client.rb
+- lib/datadog/ci/remote/null_component.rb
 - lib/datadog/ci/remote/slow_test_retries.rb
 - lib/datadog/ci/span.rb
 - lib/datadog/ci/test.rb
 - lib/datadog/ci/test_discovery/component.rb
+- lib/datadog/ci/test_discovery/null_component.rb
 - lib/datadog/ci/test_management/component.rb
 - lib/datadog/ci/test_management/null_component.rb
 - lib/datadog/ci/test_management/tests_properties.rb
@@ -230,6 +233,7 @@ files:
 - lib/datadog/ci/test_optimisation/coverage/ddcov.rb
 - lib/datadog/ci/test_optimisation/coverage/event.rb
 - lib/datadog/ci/test_optimisation/coverage/transport.rb
+- lib/datadog/ci/test_optimisation/null_component.rb
 - lib/datadog/ci/test_optimisation/skippable.rb
 - lib/datadog/ci/test_optimisation/skippable_percentage/base.rb
 - lib/datadog/ci/test_optimisation/skippable_percentage/calculator.rb
@@ -311,7 +315,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.7.0
   - - "<"
     - !ruby/object:Gem::Version
-      version: '3.5'
+      version: '4.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="