datadog-ci 1.22.1 → 1.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1460c3b89178f919bb71b356889f177c36f74ac11a8770f71e57eeebcd7215ff
-  data.tar.gz: 37d0ede02d7851e074287b465968aa36d8db4ad078329553b29b3f1eff7d76d9
+  metadata.gz: 2a07d37d208941128fa6c8e31303578021e07a2974e9b5fb27cd0bb7dd64baea
+  data.tar.gz: c9e258132d7e8fc0278db80c6659b96a2c2d68ac6f7c7a0f2b6720f98052dc38
 SHA512:
-  metadata.gz: 617904ffa77b85fa4dfdadb3d81efffbbfc3be9c09e621ba6df7849b85cc803e10e2b5bdef802da457360b02da6c4b3ebfdad7c448c18588870566c657890830
-  data.tar.gz: 74f3b46a41f00d968df66673ddee9835712ae5e15d49a35ad889596f392e9b6fb4681c7575cd44159612097e0a74994e9a2e5a9da7c4f3876a5b54768c934ded
+  metadata.gz: 445771d8c3192ed674a30541c9b89444d4ecf3c95728f156cceac42d08c1fb800ca163876546b8cd5fe25dcabe17a2a47471efa51a71d539385795d9264de813
+  data.tar.gz: 62a95307714de058754837a753aed50564e8490fdfebc75472a11b464c417ed7020d59cbad18e69b622863e45a3699b5628229cd3b7fcd7781fe2a4d37feb3fb

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 ## [Unreleased]
 
+## [1.23.0] - 2025-10-08
+
+
+### Changed
+* In test discovery mode output suiteSourceFile for each test ([#400][])
+* DDTest integration changes ([#407][])
+* Support context propagation from Datadog test runner ([#399][])
+
+### Fixed
+* Fix issue when parallel_tests doesn't track test sessions when using manual instrumentation ([#410][])
+
 ## [1.22.1] - 2025-08-25
 
 ### Fixed
@@ -520,7 +531,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/v1.22.1...main
+[Unreleased]: https://github.com/DataDog/datadog-ci-rb/compare/v1.23.0...main
+[1.23.0]: https://github.com/DataDog/datadog-ci-rb/compare/v1.22.1...v1.23.0
 [1.22.1]: https://github.com/DataDog/datadog-ci-rb/compare/v1.22.0...v1.22.1
 [1.22.0]: https://github.com/DataDog/datadog-ci-rb/compare/v1.21.1...v1.22.0
 [1.21.1]: https://github.com/DataDog/datadog-ci-rb/compare/v1.21.0...v1.21.1
@@ -739,4 +751,8 @@ Currently test suite level visibility is not used by our instrumentation: it wil
 [#393]: https://github.com/DataDog/datadog-ci-rb/issues/393
 [#394]: https://github.com/DataDog/datadog-ci-rb/issues/394
 [#396]: https://github.com/DataDog/datadog-ci-rb/issues/396
-[#402]: https://github.com/DataDog/datadog-ci-rb/issues/402
+[#399]: https://github.com/DataDog/datadog-ci-rb/issues/399
+[#400]: https://github.com/DataDog/datadog-ci-rb/issues/400
+[#402]: https://github.com/DataDog/datadog-ci-rb/issues/402
+[#407]: https://github.com/DataDog/datadog-ci-rb/issues/407
+[#410]: https://github.com/DataDog/datadog-ci-rb/issues/410

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

@@ -2,7 +2,6 @@
 
 require_relative "../../ext/test"
 require_relative "ext"
-require_relative "helpers"
 
 module Datadog
   module CI

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

@@ -3,7 +3,6 @@
 require_relative "../../ext/test"
 require_relative "../instrumentation"
 require_relative "ext"
-require_relative "helpers"
 
 module Datadog
   module CI
@@ -33,7 +32,8 @@ module Datadog
 
               result = super
               return result unless test_module && test_session
-              return result if Helpers.parallel_tests?
+              # distributed test session must end in the parent process (for RSpec it would be parallel_tests CLI)
+              return result if test_session.distributed
 
               if result != 0
                 test_module.failed!

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Datadog
+  module CI
+    module Ext
+      # Constants for integration with DDTest tool: https://github.com/DataDog/ddtest
+      module DDTest
+        PLAN_FOLDER = ".testoptimization"
+        TESTOPTIMIZATION_CACHE_PATH = "#{PLAN_FOLDER}/cache"
+
+        SETTINGS_FILE_NAME = "settings.json"
+        KNOWN_TESTS_FILE_NAME = "known_tests.json"
+        TEST_MANAGEMENT_TESTS_FILE_NAME = "test_management_tests.json"
+        SKIPPABLE_TESTS_FILE_NAME = "skippable_tests.json"
+      end
+    end
+  end
+end

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

@@ -6,7 +6,7 @@ module Datadog
       # Defines constants for test discovery mode
       module TestDiscovery
         # Default output path for test discovery mode
-        DEFAULT_OUTPUT_PATH = "./.dd/test_discovery/tests.json"
+        DEFAULT_OUTPUT_PATH = "./#{DDTest::PLAN_FOLDER}/test_discovery/tests.json"
 
         # Maximum buffer size before writing to file
         MAX_BUFFER_SIZE = 10_000

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

@@ -54,11 +54,25 @@ module Datadog
           FILE_STORAGE_KEY
         end
 
+        def restore_state_from_datadog_test_runner
+          Datadog.logger.debug { "Restoring library configuration from DDTest cache" }
+
+          settings = load_json(Ext::DDTest::SETTINGS_FILE_NAME)
+          if settings.nil?
+            Datadog.logger.debug { "Restoring library configuration failed, will request again" }
+            return false
+          end
+
+          Datadog.logger.debug { "Restored library configuration from DDTest: #{settings}" }
+          @library_configuration = LibrarySettings.from_json(settings)
+          true
+        end
+
         private
 
         def fetch_library_configuration(test_session)
           # In test discovery mode, skip backend fetching and use default settings (everything is disabled)
-          return @library_configuration = LibrarySettings.new(nil) if @test_discovery_enabled
+          return @library_configuration = LibrarySettings.from_http_response(nil) if @test_discovery_enabled
 
           # skip backend request if library configuration was loaded by a different process and stored on disk
           library_configuration_loaded = load_component_state

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

@@ -14,9 +14,12 @@ module Datadog
     module Remote
       # Wrapper around the settings HTTP response
       class LibrarySettings
-        def initialize(http_response)
-          @http_response = http_response
-          @json = nil
+        def self.from_http_response(http_response)
+          new(http_response, nil)
+        end
+
+        def self.from_json(json)
+          new(nil, json)
         end
 
         def ok?
@@ -148,6 +151,11 @@ module Datadog
 
         private
 
+        def initialize(http_response, json)
+          @http_response = http_response
+          @json = json
+        end
+
         def test_management_payload
           payload.fetch(
             Ext::Transport::DD_API_SETTINGS_RESPONSE_TEST_MANAGEMENT_KEY,

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

@@ -25,7 +25,7 @@ module Datadog
 
         def fetch(test_session)
           api = @api
-          return LibrarySettings.new(nil) unless api
+          return LibrarySettings.from_http_response(nil) unless api
 
           request_payload = payload(test_session)
           Datadog.logger.debug("Fetching library settings with request: #{request_payload}")
@@ -51,7 +51,7 @@ module Datadog
             )
           end
 
-          library_settings = LibrarySettings.new(http_response)
+          library_settings = LibrarySettings.from_http_response(http_response)
 
           Utils::Telemetry.inc(
             Ext::Telemetry::METRIC_GIT_REQUESTS_SETTINGS_RESPONSE,

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

@@ -86,6 +86,7 @@ module Datadog
             "name" => test.name,
             "suite" => test.test_suite_name,
             "sourceFile" => test.source_file,
+            "suiteSourceFile" => test.test_suite&.source_file,
             "fqn" => test.datadog_test_id
           }
 

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

@@ -2,6 +2,7 @@
 
 require_relative "../ext/telemetry"
 require_relative "../ext/test"
+require_relative "../ext/dd_test"
 require_relative "../utils/stateful"
 require_relative "../utils/telemetry"
 require_relative "../utils/test_run"
@@ -35,11 +36,11 @@ module Datadog
 
           test_session.set_tag(Ext::Test::TAG_TEST_MANAGEMENT_ENABLED, "true")
 
-          # Load component state first, and if successful, skip fetching tests properties
-          if !load_component_state
-            @tests_properties = @tests_properties_client.fetch(test_session)
-            store_component_state if test_session.distributed
-          end
+          return if restore_state_from_datadog_test_runner
+          return if load_component_state
+
+          @tests_properties = @tests_properties_client.fetch(test_session)
+          store_component_state if test_session.distributed
 
           Utils::Telemetry.distribution(
             Ext::Telemetry::METRIC_TEST_MANAGEMENT_TESTS_RESPONSE_TESTS,
@@ -74,6 +75,33 @@ module Datadog
           test_properties.fetch("attempt_to_fix", false)
         end
 
+        def restore_state_from_datadog_test_runner
+          Datadog.logger.debug { "Restoring test management tests from DDTest cache" }
+
+          test_management_data = load_json(Ext::DDTest::TEST_MANAGEMENT_TESTS_FILE_NAME)
+          if test_management_data.nil?
+            Datadog.logger.debug { "Restoring test management tests failed, will request again" }
+            return false
+          end
+
+          Datadog.logger.debug { "Restored test management tests from DDTest: #{test_management_data}" }
+
+          # Use the TestsProperties::Response class method to parse the JSON data
+          # Wrap the data in the expected backend API format
+          wrapped_data = {
+            "data" => {
+              "attributes" => test_management_data
+            }
+          }
+
+          tests_properties_response = TestsProperties::Response.from_json(wrapped_data)
+          @tests_properties = tests_properties_response.tests
+
+          Datadog.logger.debug { "Found [#{@tests_properties.size}] test management tests from context" }
+
+          true
+        end
+
         # Implementation of Stateful interface
         def serialize_state
           {

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

@@ -15,9 +15,12 @@ module Datadog
       # fetches and stores a map of tests to their test management properties from the backend
       class TestsProperties
         class Response
-          def initialize(http_response)
-            @http_response = http_response
-            @json = nil
+          def self.from_http_response(http_response)
+            new(http_response, nil)
+          end
+
+          def self.from_json(json)
+            new(nil, json)
           end
 
           def ok?
@@ -51,6 +54,11 @@ module Datadog
 
           private
 
+          def initialize(http_response, json)
+            @http_response = http_response
+            @json = json
+          end
+
           def payload
             cached = @json
             return cached unless cached.nil?
@@ -106,7 +114,7 @@ module Datadog
             )
           end
 
-          Response.new(http_response).tests
+          Response.from_http_response(http_response).tests
         end
 
         private

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

@@ -6,6 +6,7 @@ require "datadog/core/telemetry/logging"
 
 require_relative "../ext/test"
 require_relative "../ext/telemetry"
+require_relative "../ext/dd_test"
 
 require_relative "../git/local_repository"
 
@@ -84,7 +85,11 @@ module Datadog
           load_datadog_cov! if @code_coverage_enabled
 
           # Load component state first, and if successful, skip fetching skippable tests
-          if skipping_tests? && !load_component_state
+          # Also try to restore from DDTest cache if available
+          if skipping_tests?
+            return if load_component_state
+            return if restore_state_from_datadog_test_runner
+
             fetch_skippable_tests(test_session)
             store_component_state if test_session.distributed
           end
@@ -210,8 +215,89 @@ module Datadog
           FILE_STORAGE_KEY
         end
 
+        def restore_state_from_datadog_test_runner
+          Datadog.logger.debug { "Restoring skippable tests from DDTest cache" }
+
+          skippable_tests_data = load_json(Ext::DDTest::SKIPPABLE_TESTS_FILE_NAME)
+          if skippable_tests_data.nil?
+            Datadog.logger.debug { "Restoring skippable tests failed, will request again" }
+            return false
+          end
+
+          Datadog.logger.debug { "Restored skippable tests from DDTest: #{skippable_tests_data}" }
+
+          transformed_data = transform_test_runner_data(skippable_tests_data)
+
+          Datadog.logger.debug { "Skippable tests after transformation: #{transformed_data}" }
+
+          # Use the Skippable::Response class to parse the transformed data
+          skippable_response = Skippable::Response.from_json(transformed_data)
+
+          @mutex.synchronize do
+            @correlation_id = skippable_response.correlation_id
+            @skippable_tests = skippable_response.tests
+          end
+
+          Datadog.logger.debug { "Found [#{@skippable_tests.size}] skippable tests from context" }
+          Datadog.logger.debug { "ITR correlation ID from context: #{@correlation_id}" }
+
+          true
+        end
+
         private
 
+        # Transforms Test Runner skippable tests data format to the format expected by Skippable::Response
+        #
+        # Test Runner format:
+        # {
+        #   "correlationId": "abc123",
+        #   "skippableTests": {
+        #     "suite_name": {
+        #       "test_name": [{"suite": "suite_name", "name": "test_name", "parameters": "{...}", "configurations": {}}]
+        #     }
+        #   }
+        # }
+        #
+        # Expected format:
+        # {
+        #   "meta": {"correlation_id": "abc123"},
+        #   "data": [{"type": "test", "attributes": {"suite": "suite_name", "name": "test_name", "parameters": "{...}"}}]
+        # }
+        def transform_test_runner_data(skippable_tests_data)
+          skippable_tests = skippable_tests_data.fetch("skippableTests", {})
+
+          # Pre-calculate array size for better memory allocation
+          total_test_configs = skippable_tests.sum do |_, tests_hash|
+            tests_hash.sum { |_, test_configs| test_configs.size }
+          end
+
+          data_array = Array.new(total_test_configs)
+          index = 0
+
+          skippable_tests.each_value do |tests_hash|
+            tests_hash.each_value do |test_configs|
+              test_configs.each do |test_config|
+                data_array[index] = {
+                  "type" => Ext::Test::ITR_TEST_SKIPPING_MODE,
+                  "attributes" => {
+                    "suite" => test_config["suite"],
+                    "name" => test_config["name"],
+                    "parameters" => test_config["parameters"]
+                  }
+                }
+                index += 1
+              end
+            end
+          end
+
+          {
+            "meta" => {
+              "correlation_id" => skippable_tests_data["correlationId"]
+            },
+            "data" => data_array
+          }
+        end
+
         def write(event)
           # skip sending events if writer is not configured
           @coverage_writer&.write(event)

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

@@ -14,9 +14,12 @@ module Datadog
     module TestOptimisation
       class Skippable
         class Response
-          def initialize(http_response)
-            @http_response = http_response
-            @json = nil
+          def self.from_http_response(http_response)
+            new(http_response, nil)
+          end
+
+          def self.from_json(json)
+            new(nil, json)
           end
 
           def ok?
@@ -50,6 +53,11 @@ module Datadog
 
           private
 
+          def initialize(http_response, json)
+            @http_response = http_response
+            @json = json
+          end
+
           def payload
             cached = @json
             return cached unless cached.nil?
@@ -74,7 +82,7 @@ module Datadog
 
         def fetch_skippable_tests(test_session)
           api = @api
-          return Response.new(nil) unless api
+          return Response.from_http_response(nil) unless api
 
           request_payload = payload(test_session)
           Datadog.logger.debug("Fetching skippable tests with request: #{request_payload}")
@@ -105,7 +113,7 @@ module Datadog
             )
           end
 
-          Response.new(http_response)
+          Response.from_http_response(http_response)
         end
 
         private

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

@@ -6,6 +6,7 @@ require "rbconfig"
 require "datadog/core/utils/forking"
 
 require_relative "context"
+require_relative "known_tests"
 require_relative "telemetry"
 require_relative "total_coverage"
 
@@ -226,6 +227,36 @@ module Datadog
           (forked? && !@context_service_uri.nil? && !@context_service_uri.empty?) || @is_client_process
         end
 
+        def restore_state_from_datadog_test_runner
+          Datadog.logger.debug { "Restoring known tests from DDTest cache" }
+
+          known_tests_data = load_json(Ext::DDTest::KNOWN_TESTS_FILE_NAME)
+          if known_tests_data.nil?
+            Datadog.logger.debug { "Restoring known tests failed, will request again" }
+            return false
+          end
+
+          Datadog.logger.debug { "Restored known tests from DDTest: #{known_tests_data}" }
+
+          # Use the KnownTests class method to parse the JSON data
+          known_tests_data = {
+            "data" => {
+              "attributes" => known_tests_data
+            }
+          }
+
+          @known_tests = KnownTests::Response.from_json(known_tests_data).tests
+          @known_tests_enabled = !@known_tests.empty?
+
+          unless @known_tests_enabled
+            Datadog.logger.debug("Empty set of known tests from the DDTest cache file")
+          end
+
+          Datadog.logger.debug { "Found [#{@known_tests.size}] known tests from context" }
+
+          true
+        end
+
         private
 
         # DOMAIN EVENTS
@@ -398,6 +429,9 @@ module Datadog
         end
 
         def new_test?(test_span)
+          # check if @known_tests set is empty again
+          # to ensure that we don't tag tests as new unnecessarily
+          @known_tests_enabled = false if @known_tests_enabled && @known_tests.empty?
           return false unless @known_tests_enabled
 
           test_id = Utils::TestRun.datadog_test_id(test_span.name, test_span.test_suite_name)

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

@@ -14,9 +14,12 @@ module Datadog
       # fetches and stores a list of known tests from the backend
       class KnownTests
         class Response
-          def initialize(http_response)
-            @http_response = http_response
-            @json = nil
+          def self.from_http_response(http_response)
+            new(http_response, nil)
+          end
+
+          def self.from_json(json)
+            new(nil, json)
           end
 
           def ok?
@@ -44,6 +47,11 @@ module Datadog
 
           private
 
+          def initialize(http_response, json)
+            @http_response = http_response
+            @json = json
+          end
+
           def payload
             cached = @json
             return cached unless cached.nil?
@@ -99,7 +107,7 @@ module Datadog
             )
           end
 
-          Response.new(http_response).tests
+          Response.from_http_response(http_response).tests
         end
 
         private

data/lib/datadog/ci/test_visibility/store/process.rb

@@ -9,8 +9,6 @@ module Datadog
       module Store
         # This context is shared between threads and represents the current test session and test module.
         class Process
-          attr_reader :readonly_test_session, :readonly_test_module
-
           def initialize
             # we are using Monitor instead of Mutex because it is reentrant
             @mutex = Monitor.new
@@ -52,11 +50,11 @@ module Datadog
           end
 
           def active_test_module
-            @test_module
+            @mutex.synchronize { @test_module }
           end
 
           def active_test_session
-            @test_session
+            @mutex.synchronize { @test_session }
           end
 
           def active_test_suite(test_suite_name)
@@ -82,16 +80,28 @@ module Datadog
             @mutex.synchronize { @test_suites.delete(test_suite_name) }
           end
 
+          def readonly_test_session
+            @mutex.synchronize { @readonly_test_session }
+          end
+
+          def readonly_test_module
+            @mutex.synchronize { @readonly_test_module }
+          end
+
           def set_readonly_test_session(remote_test_session)
             return if remote_test_session.nil?
 
-            @readonly_test_session = Datadog::CI::ReadonlyTestSession.new(remote_test_session)
+            @mutex.synchronize do
+              @readonly_test_session = Datadog::CI::ReadonlyTestSession.new(remote_test_session)
+            end
           end
 
           def set_readonly_test_module(remote_test_module)
             return if remote_test_module.nil?
 
-            @readonly_test_module = Datadog::CI::ReadonlyTestModule.new(remote_test_module)
+            @mutex.synchronize do
+              @readonly_test_module = Datadog::CI::ReadonlyTestModule.new(remote_test_module)
+            end
           end
         end
       end

data/lib/datadog/ci/utils/stateful.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
+require "json"
 require_relative "file_storage"
+require_relative "../ext/dd_test"
 
 module Datadog
   module CI
@@ -19,6 +21,12 @@ module Datadog
 
         # Load component state
         def load_component_state
+          # Check for DDTest cache first
+          if Dir.exist?(Ext::DDTest::TESTOPTIMIZATION_CACHE_PATH)
+            Datadog.logger.debug { "DDTest cache found" }
+            return true if restore_state_from_datadog_test_runner
+          end
+
           test_visibility_component = Datadog.send(:components).test_visibility
           return false unless test_visibility_component.client_process?
 
@@ -46,6 +54,28 @@ module Datadog
         def storage_key
           raise NotImplementedError, "Components must implement #storage_key"
         end
+
+        def restore_state_from_datadog_test_runner
+          false
+        end
+
+        def load_json(file_name)
+          file_path = File.join(Ext::DDTest::TESTOPTIMIZATION_CACHE_PATH, file_name)
+
+          unless File.exist?(file_path)
+            Datadog.logger.debug { "JSON file not found: #{file_path}" }
+            return nil
+          end
+
+          content = File.read(file_path)
+          JSON.parse(content)
+        rescue JSON::ParserError => e
+          Datadog.logger.debug { "Failed to parse JSON file #{file_path}: #{e.message}" }
+          nil
+        rescue => e
+          Datadog.logger.debug { "Failed to load JSON file #{file_path}: #{e.message}" }
+          nil
+        end
       end
     end
   end

data/lib/datadog/ci/version.rb

@@ -4,8 +4,8 @@ module Datadog
   module CI
     module VERSION
       MAJOR = 1
-      MINOR = 22
-      PATCH = 1
+      MINOR = 23
+      PATCH = 0
       PRE = nil
       BUILD = nil
       # PRE and BUILD above are modified for dev gems during gem build GHA workflow

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: datadog-ci
 version: !ruby/object:Gem::Version
-  version: 1.22.1
+  version: 1.23.0
 platform: ruby
 authors:
 - Datadog, Inc.
@@ -143,7 +143,6 @@ files:
 - 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/helpers.rb
 - lib/datadog/ci/contrib/rspec/integration.rb
 - lib/datadog/ci/contrib/rspec/patcher.rb
 - lib/datadog/ci/contrib/rspec/runner.rb
@@ -166,6 +165,7 @@ files:
 - lib/datadog/ci/contrib/simplecov/patcher.rb
 - lib/datadog/ci/contrib/simplecov/result_extractor.rb
 - lib/datadog/ci/ext/app_types.rb
+- lib/datadog/ci/ext/dd_test.rb
 - lib/datadog/ci/ext/environment.rb
 - lib/datadog/ci/ext/environment/configuration_discrepancy_checker.rb
 - lib/datadog/ci/ext/environment/extractor.rb

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

@@ -1,16 +0,0 @@
-# frozen_string_literal: true
-
-module Datadog
-  module CI
-    module Contrib
-      module RSpec
-        # Helper methods for RSpec instrumentation
-        module Helpers
-          def self.parallel_tests?
-            !!ENV.fetch("TEST_ENV_NUMBER", nil) && !!ENV.fetch("PARALLEL_TEST_GROUPS", nil)
-          end
-        end
-      end
-    end
-  end
-end