datadog-ci 1.0.0.beta2 → 1.0.0.beta3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6b3e03ab226d98aac3dd518b1c554452a4c3812cb67e9a1d64762e2fe8767633
-  data.tar.gz: eac352d2b2488d16f979004f617097efe109364069f1c7b78cecfceef5365efa
+  metadata.gz: 335897204d48926d8c0e3ab1ef8e7c6247a88b12627e27e021614f1b368ab788
+  data.tar.gz: db5b4ac716d7e0f28712cb7fef86c1f438f2a8b5fa28af0bb67ef91d3758d1c0
 SHA512:
-  metadata.gz: c56ab91025f2a224e86bd732a5c891e961af184b29618241f8853756780ccba894c11955b00020a70139d72e47f57d22dfdf1f2ed6437f1d4e4a9d998453d7a4
-  data.tar.gz: e7c1aa73096d8d8b49800bbed168f288b7676d8fa328011c3e9c4f7024c86c17cf2c210a94a64dcd80f94121a80b36a824f0ca4e3aa6ccb1c35f682a1fb9e18b
+  metadata.gz: c2ebd289964298131bed28406316a48992aaec8e54a6fb21f58ffb6c3d2c523f49fbc5aedf83c9f72a5b8ba45c54cce6df46b8d83eae6ce42804a8901954b61c
+  data.tar.gz: dd1fcd1c56179c0ab933d166801f69cb843efe67449ad69e7491ee674ff3325fcb9b1adb814881a80137d24de6fa264103ad02d71b73c814acf84a56b706a707

data/CHANGELOG.md

@@ -1,117 +1,129 @@
 ## [Unreleased]
 
+## [1.0.0.beta3] - 2024-04-30
+
+### Added
+
+- "why this test was skipped" feature ([#165])
+- custom configurations tags support for ITR ([#166])
+- unskippable tests for ITR ([#167])
+
+### Changed
+
+- additional debug logging, do not skip tests when running in forked processes ([#168])
+
 ## [1.0.0.beta2] - 2024-04-23
 
 ### Added
 
-* Code coverage events writer ([#150])
-* Git tree upload - git command line integration ([#151])
-* Add Git::SearchCommits api client ([#152])
-* Upload packfiles API client ([#153])
-* Git tree uploader ([#154])
-* Git repository unshallowing logic ([#155])
-* Git upload async worker ([#156])
-* Reduce ITR-induced code coverage overhead for default branch ([#157])
-* Skippable tests api client ([#158])
-* Request skippable tests when configuring ITR ([#159])
-* Test skipping implementation ([#160])
+- Code coverage events writer ([#150])
+- Git tree upload - git command line integration ([#151])
+- Add Git::SearchCommits api client ([#152])
+- Upload packfiles API client ([#153])
+- Git tree uploader ([#154])
+- Git repository unshallowing logic ([#155])
+- Git upload async worker ([#156])
+- Reduce ITR-induced code coverage overhead for default branch ([#157])
+- Skippable tests api client ([#158])
+- Request skippable tests when configuring ITR ([#159])
+- Test skipping implementation ([#160])
 
 ## [1.0.0.beta1] - 2024-03-25
 
 ### Added
 
-* datadog-cov native extension for per test code coverage ([#137])
-* citestcov transport to serialize and send code coverage events ([#148])
+- datadog-cov native extension for per test code coverage ([#137])
+- citestcov transport to serialize and send code coverage events ([#148])
 
 ### Removed
 
-* Ruby 2.1-2.6 support is dropped
+- Ruby 2.1-2.6 support is dropped
 
 ## [0.8.3] - 2024-03-20
 
 ### Fixed
 
-* fix: cucumber-ruby 9.2 includes breaking change for Cucumber::Core::Test::Result ([#145][])
+- fix: cucumber-ruby 9.2 includes breaking change for Cucumber::Core::Test::Result ([#145][])
 
 ### Changed
 
-* remove temporary hack and use Core::Remote::Negotiation's new constructor param ([#142][])
-* use filter_basic_auth method from Datadog::Core ([#141][])
+- remove temporary hack and use Core::Remote::Negotiation's new constructor param ([#142][])
+- use filter_basic_auth method from Datadog::Core ([#141][])
 
 ## [0.8.2] - 2024-03-19
 
 ### Fixed
 
-* assign the single running test suite for a test if none found by test suite name ([#139][])
+- assign the single running test suite for a test if none found by test suite name ([#139][])
 
 ## [0.8.1] - 2024-03-12
 
 ### Fixed
 
-* fix minitest instrumentation with mixins ([#134][])
+- fix minitest instrumentation with mixins ([#134][])
 
 ## [0.8.0] - 2024-03-08
 
 ### Added
 
-* gzip agent payloads support via evp_proxy/v4 ([#123][])
+- gzip agent payloads support via evp_proxy/v4 ([#123][])
 
 ### Changed
 
-* Add note to README on using VCR ([#122][])
+- Add note to README on using VCR ([#122][])
 
 ### Fixed
 
-* use framework name as test module name to make test fingerprints stable ([#131][])
+- use framework name as test module name to make test fingerprints stable ([#131][])
 
 ## [0.7.0] - 2024-01-26
 
 ### Added
 
-* Source code integration ([#95][])
-* CODEOWNERS support ([#98][])
-* Cucumber scenarios with examples are treated as parametrized tests ([#100][])
-* Deduplicate dynamically generated RSpec examples using test.parameters ([#101][])
-* Repository name is used as default test service name ([#104][])
-* Cucumber v9 support ([#99][])
-* ci-queue runner support for minitest ([#110][])
-* ci-queue support for rspec ([#112][])
+- Source code integration ([#95][])
+- CODEOWNERS support ([#98][])
+- Cucumber scenarios with examples are treated as parametrized tests ([#100][])
+- Deduplicate dynamically generated RSpec examples using test.parameters ([#101][])
+- Repository name is used as default test service name ([#104][])
+- Cucumber v9 support ([#99][])
+- ci-queue runner support for minitest ([#110][])
+- ci-queue support for rspec ([#112][])
 
 ### Fixed
 
-* do not publish sig folder when publishing this gem to prevent steep errors in client applications ([#114][])
-* minitest: fix rails parallel test runner ([#115][])
-* Test suites and tests skipped by frameworks are correctly reported as skipped to Datadog ([#113][])
+- do not publish sig folder when publishing this gem to prevent steep errors in client applications ([#114][])
+- minitest: fix rails parallel test runner ([#115][])
+- Test suites and tests skipped by frameworks are correctly reported as skipped to Datadog ([#113][])
 
 ### Changed
 
-* Enable test suite level visibility by default (with killswitch) ([#109][])
-* Test suite names are more human-readable now ([#105][])
-* Remove span_type method in tracer-related models ([#107][])
-* Manual tracing API: convert type parameter to keyword in Datadog::CI.trace, remove internal-only methods from public API ([#108][])
+- Enable test suite level visibility by default (with killswitch) ([#109][])
+- Test suite names are more human-readable now ([#105][])
+- Remove span_type method in tracer-related models ([#107][])
+- Manual tracing API: convert type parameter to keyword in Datadog::CI.trace, remove internal-only methods from public API ([#108][])
 
 ## [0.6.0] - 2024-01-03
 
 ### Added
 
-* Test suite level visibility instrumentation for RSpec ([#86][])
-* Test suite level visibility instrumentation for Cucumber ([#90][])
-* Test suite level visibility instrumentation for Minitest framework ([#92][])
+- Test suite level visibility instrumentation for RSpec ([#86][])
+- Test suite level visibility instrumentation for Cucumber ([#90][])
+- Test suite level visibility instrumentation for Minitest framework ([#92][])
 
 ### Fixed
 
-* Do not instantiate TestVisibility::Recorder unless CI visibility is enabled ([#89][])
+- Do not instantiate TestVisibility::Recorder unless CI visibility is enabled ([#89][])
 
 ## [0.5.1] - 2023-12-11
 
 ### Fixed
 
-* do not collect environment tags when CI is not enabled ([#87][])
+- do not collect environment tags when CI is not enabled ([#87][])
 
 ### Changed
 
-* Move private classes and modules deeper in module hierarchy ([#85][])
-* update appraisal dependencies ([#84][])
+- Move private classes and modules deeper in module hierarchy ([#85][])
+- update appraisal dependencies ([#84][])
 
 ## [0.5.0] - 2023-12-06
 
@@ -123,98 +135,99 @@ Currently test suite level visibility is not used by our instrumentation: it wil
 
 ### Added
 
-* Test suite level visibility: add test session public API ([#72][])
-* Test suite level visibility: test module support ([#76][])
-* Test suite level visibility: test suites support ([#77][])
-* add YARD documentation ([#82][])
-* support validation errors for CI spans ([#78][])
+- Test suite level visibility: add test session public API ([#72][])
+- Test suite level visibility: test module support ([#76][])
+- Test suite level visibility: test suites support ([#77][])
+- add YARD documentation ([#82][])
+- support validation errors for CI spans ([#78][])
 
 ### Changed
 
-* Validate DD_SITE variable ([#79][])
-* Document how to use WebMock with datadog-ci ([#80][])
+- Validate DD_SITE variable ([#79][])
+- Document how to use WebMock with datadog-ci ([#80][])
 
 ### Fixed
 
-* Datadog::CI.trace_test always starts a new trace ([#74][])
-* Skip tracing when CI mode disabled and manual API is used ([#75][])
+- Datadog::CI.trace_test always starts a new trace ([#74][])
+- Skip tracing when CI mode disabled and manual API is used ([#75][])
 
 ### Removed
 
-* Deprecate operation name setting, change service_name to service in public API ([#81][])
+- Deprecate operation name setting, change service_name to service in public API ([#81][])
 
 ## [0.4.1] - 2023-11-22
 
 ### Fixed
 
-* disable 128-bit trace id generation in CI mode ([#70][])
+- disable 128-bit trace id generation in CI mode ([#70][])
 
 ## [0.4.0] - 2023-11-21
 
 ### Added
 
-* Public API for manual test instrumentation ([#64][]) ([#61][])
+- Public API for manual test instrumentation ([#64][]) ([#61][])
 
 ### Changed
 
-* fix tracing instrumentation example in readme ([#60][])
+- fix tracing instrumentation example in readme ([#60][])
 
 ### Fixed
 
-* Remove user credentials from ssh URLs and from GITHUB_REPO_URL environment variable ([#66][])
+- Remove user credentials from ssh URLs and from GITHUB_REPO_URL environment variable ([#66][])
 
 ### Removed
 
-* Remove _dd.measured tag from spans ([#65][])
+- Remove _dd.measured tag from spans ([#65][])
 
 ## [0.3.0] - 2023-10-25
 
 ### Added
 
-* Add AWS CodePipeline support for automatic CI tags extraction ([#54][])
-* Support test visibility protocol via Datadog Agent with EVP proxy ([#51][])
+- Add AWS CodePipeline support for automatic CI tags extraction ([#54][])
+- Support test visibility protocol via Datadog Agent with EVP proxy ([#51][])
 
 ### Changed
 
-* Migrate to Net::HTTP adapter from Core module of ddtrace gem ([#49][])
+- Migrate to Net::HTTP adapter from Core module of ddtrace gem ([#49][])
 
 ## [0.2.0] - 2023-10-05
 
 ### Added
 
-* [CIAPP-2959] Agentless mode ([#33][])
+- [CIAPP-2959] Agentless mode ([#33][])
 
 ### Fixed
 
-* [CIAPP-4278] Fix an issue with emojis in commit message breaking LocalGit tags provider ([#40][])
+- [CIAPP-4278] Fix an issue with emojis in commit message breaking LocalGit tags provider ([#40][])
 
 ## [0.1.1] - 2023-09-14
 
 ### Fixed
 
-* Fix circular dependencies warnings ([#31][])
+- Fix circular dependencies warnings ([#31][])
 
 ## 0.1.0 - 2023-09-12
 
 ### Added
 
-* Add cucumber 8.0.0 support ([#7][])
-* Docs: contribution documentation ([#14][], [#28][])
-* Dev process: issue templates ([#20][])
+- Add cucumber 8.0.0 support ([#7][])
+- Docs: contribution documentation ([#14][], [#28][])
+- Dev process: issue templates ([#20][])
 
 ### Changed
 
-* Validate customer-supplied git tags ([#15][])
+- Validate customer-supplied git tags ([#15][])
 
 ### Fixed
 
-* Fix Datadog::CI::Environment to support the new CI specs ([#11][])
+- Fix Datadog::CI::Environment to support the new CI specs ([#11][])
 
 ### Removed
 
-* Ruby versions < 2.7 no longer supported ([#8][])
+- Ruby versions < 2.7 no longer supported ([#8][])
 
 [Unreleased]: https://github.com/DataDog/datadog-ci-rb/compare/v0.8.3...main
+[1.0.0.beta3]: https://github.com/DataDog/datadog-ci-rb/compare/v1.0.0.beta2...v1.0.0.beta3
 [1.0.0.beta2]: https://github.com/DataDog/datadog-ci-rb/compare/v1.0.0.beta1...v1.0.0.beta2
 [1.0.0.beta1]: https://github.com/DataDog/datadog-ci-rb/compare/v0.8.3...v1.0.0.beta1
 [0.8.3]: https://github.com/DataDog/datadog-ci-rb/compare/v0.8.2...v0.8.3
@@ -304,3 +317,7 @@ Currently test suite level visibility is not used by our instrumentation: it wil
 [#158]: https://github.com/DataDog/datadog-ci-rb/issues/158
 [#159]: https://github.com/DataDog/datadog-ci-rb/issues/159
 [#160]: https://github.com/DataDog/datadog-ci-rb/issues/160
+[#165]: https://github.com/DataDog/datadog-ci-rb/issues/165
+[#166]: https://github.com/DataDog/datadog-ci-rb/issues/166
+[#167]: https://github.com/DataDog/datadog-ci-rb/issues/167
+[#168]: https://github.com/DataDog/datadog-ci-rb/issues/168

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

@@ -13,6 +13,7 @@ require_relative "../test_visibility/serializers/factories/test_suite_level"
 require_relative "../test_visibility/transport"
 require_relative "../transport/api/builder"
 require_relative "../transport/remote_settings_api"
+require_relative "../utils/test_run"
 require_relative "../worker"
 
 module Datadog
@@ -59,6 +60,9 @@ module Datadog
           # Choose user defined TraceFlush or default to CI TraceFlush
           settings.tracing.test_mode.trace_flush = settings.ci.trace_flush || CI::TestVisibility::Flush::Partial.new
 
+          # startup logs are useless for CI visibility and create noise
+          settings.diagnostics.startup_logs.enabled = false
+
           # transport creation
           writer_options = settings.ci.writer_options
           coverage_writer = nil
@@ -90,14 +94,18 @@ module Datadog
 
           settings.tracing.test_mode.writer_options = writer_options
 
+          custom_configuration_tags = Utils::TestRun.custom_configuration(settings.tags)
+
           remote_settings_api = Transport::RemoteSettingsApi.new(
             api: test_visibility_api,
-            dd_env: settings.env
+            dd_env: settings.env,
+            config_tags: custom_configuration_tags
           )
 
           itr = ITR::Runner.new(
             api: test_visibility_api,
             dd_env: settings.env,
+            config_tags: custom_configuration_tags,
             coverage_writer: coverage_writer,
             enabled: settings.ci.enabled && settings.ci.itr_enabled
           )

data/lib/datadog/ci/contrib/cucumber/formatter.rb

@@ -70,12 +70,15 @@ module Datadog
 
             start_test_suite(test_suite_name) unless same_test_suite_as_current?(test_suite_name)
 
-            CI.start_test(
+            test_span = CI.start_test(
               event.test_case.name,
               test_suite_name,
               tags: tags,
               service: configuration[:service_name]
             )
+            if event.test_case.match_tags?("@#{CI::Ext::Test::ITR_UNSKIPPABLE_OPTION}")
+              test_span&.itr_unskippable!
+            end
           end
 
           def on_test_case_finished(event)

data/lib/datadog/ci/contrib/minitest/patcher.rb

@@ -2,7 +2,7 @@
 
 require_relative "runner"
 require_relative "reporter"
-require_relative "hooks"
+require_relative "test"
 require_relative "runnable"
 
 module Datadog
@@ -25,7 +25,7 @@ module Datadog
             # test suites (when not executed concurrently)
             ::Minitest::Runnable.include(Runnable)
             # tests; test suites (when executed concurrently)
-            ::Minitest::Test.include(Hooks)
+            ::Minitest::Test.include(Test)
             # test session finish
             ::Minitest::CompositeReporter.include(Reporter)
           end

data/lib/datadog/ci/contrib/minitest/test.rb

@@ -0,0 +1,105 @@
+# frozen_string_literal: true
+
+require_relative "../../ext/test"
+require_relative "../../git/local_repository"
+require_relative "ext"
+require_relative "helpers"
+
+module Datadog
+  module CI
+    module Contrib
+      module Minitest
+        # Lifecycle hooks to instrument Minitest::Test
+        module Test
+          def self.included(base)
+            base.prepend(InstanceMethods)
+            base.singleton_class.prepend(ClassMethods)
+          end
+
+          module InstanceMethods
+            def before_setup
+              super
+              return unless datadog_configuration[:enabled]
+
+              test_suite_name = Helpers.test_suite_name(self.class, name)
+              if Helpers.parallel?(self.class)
+                test_suite_name = "#{test_suite_name} (#{name} concurrently)"
+
+                # for parallel execution we need to start a new test suite for each test
+                CI.start_test_suite(test_suite_name)
+              end
+
+              source_file, line_number = method(name).source_location
+
+              test_span = CI.start_test(
+                name,
+                test_suite_name,
+                tags: {
+                  CI::Ext::Test::TAG_FRAMEWORK => Ext::FRAMEWORK,
+                  CI::Ext::Test::TAG_FRAMEWORK_VERSION => CI::Contrib::Minitest::Integration.version.to_s,
+                  CI::Ext::Test::TAG_SOURCE_FILE => Git::LocalRepository.relative_to_root(source_file),
+                  CI::Ext::Test::TAG_SOURCE_START => line_number.to_s
+                },
+                service: datadog_configuration[:service_name]
+              )
+              test_span&.itr_unskippable! if self.class.dd_suite_unskippable? || self.class.dd_test_unskippable?(name)
+              skip(CI::Ext::Test::ITR_TEST_SKIP_REASON) if test_span&.skipped_by_itr?
+            end
+
+            def after_teardown
+              test_span = CI.active_test
+              return super unless test_span
+
+              finish_with_result(test_span, result_code)
+              if Helpers.parallel?(self.class)
+                finish_with_result(test_span.test_suite, result_code)
+              end
+
+              super
+            end
+
+            private
+
+            def finish_with_result(span, result_code)
+              return unless span
+
+              case result_code
+              when "."
+                span.passed!
+              when "E", "F"
+                span.failed!(exception: failure)
+              when "S"
+                span.skipped!(reason: failure.message)
+              end
+              span.finish
+            end
+
+            def datadog_configuration
+              Datadog.configuration.ci[:minitest]
+            end
+          end
+
+          module ClassMethods
+            def datadog_itr_unskippable(*args)
+              if args.nil? || args.empty?
+                @datadog_itr_unskippable_suite = true
+              else
+                @datadog_itr_unskippable_tests = args
+              end
+            end
+
+            def dd_suite_unskippable?
+              @datadog_itr_unskippable_suite
+            end
+
+            def dd_test_unskippable?(test_name)
+              return false unless @datadog_itr_unskippable_tests
+
+              @datadog_itr_unskippable_tests.include?(test_name)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -50,6 +50,8 @@ module Datadog
                 },
                 service: datadog_configuration[:service_name]
               ) do |test_span|
+                test_span&.itr_unskippable! if metadata[CI::Ext::Test::ITR_UNSKIPPABLE_OPTION]
+
                 metadata[:skip] = CI::Ext::Test::ITR_TEST_SKIP_REASON if test_span&.skipped_by_itr?
 
                 result = super

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

@@ -8,7 +8,6 @@ module Datadog
       module Test
         CONTEXT_ORIGIN = "ciapp-test"
 
-        TAG_ARGUMENTS = "test.arguments"
         TAG_FRAMEWORK = "test.framework"
         TAG_FRAMEWORK_VERSION = "test.framework_version"
         TAG_NAME = "test.name"
@@ -29,6 +28,8 @@ module Datadog
         TAG_ITR_TEST_SKIPPING_COUNT = "test.itr.tests_skipping.count"
         TAG_ITR_SKIPPED_BY_ITR = "test.skipped_by_itr"
         TAG_ITR_TESTS_SKIPPED = "_dd.ci.itr.tests_skipped"
+        TAG_ITR_UNSKIPPABLE = "test.itr.unskippable"
+        TAG_ITR_FORCED_RUN = "test.itr.forced_run"
 
         # Code coverage tags
         TAG_CODE_COVERAGE_ENABLED = "test.code_coverage.enabled"
@@ -58,6 +59,7 @@ module Datadog
         # we use test skipping for Ruby
         ITR_TEST_SKIPPING_MODE = "test"
         ITR_TEST_SKIP_REASON = "Skipped by Datadog's intelligent test runner"
+        ITR_UNSKIPPABLE_OPTION = :datadog_itr_unskippable
 
         # test status as recognized by Datadog
         module Status

data/lib/datadog/ci/itr/coverage/writer.rb

@@ -58,9 +58,15 @@ module Datadog
           def perform(*events)
             responses = transport.send_events(events)
 
-            loop_back_off! if responses.find(&:server_error?)
+            if responses.find(&:server_error?)
+              loop_back_off!
+              Datadog.logger.warn { "Encountered server error while sending coverage events" }
+            end
 
             nil
+          rescue => e
+            Datadog.logger.warn { "Error while sending coverage events: #{e}" }
+            loop_back_off!
           end
 
           def stop(force_stop = false, timeout = @shutdown_timeout)

data/lib/datadog/ci/itr/runner.rb

@@ -27,6 +27,7 @@ module Datadog
 
         def initialize(
           dd_env:,
+          config_tags: {},
           api: nil,
           coverage_writer: nil,
           enabled: false
@@ -34,6 +35,7 @@ module Datadog
           @enabled = enabled
           @api = api
           @dd_env = dd_env
+          @config_tags = config_tags || {}
 
           @test_skipping_enabled = false
           @code_coverage_enabled = false
@@ -127,6 +129,11 @@ module Datadog
 
           skippable_test_id = Utils::TestRun.skippable_test_id(test.name, test.test_suite_name, test.parameters)
           if @skippable_tests.include?(skippable_test_id)
+            if forked?
+              Datadog.logger.warn { "ITR is not supported for forking test runners yet" }
+              return
+            end
+
             test.set_tag(Ext::Test::TAG_ITR_SKIPPED_BY_ITR, "true")
 
             Datadog.logger.debug { "Marked test as skippable: #{skippable_test_id}" }
@@ -136,13 +143,13 @@ module Datadog
         end
 
         def count_skipped_test(test)
+          return if !test.skipped? || !test.skipped_by_itr?
+
           if forked?
             Datadog.logger.warn { "ITR is not supported for forking test runners yet" }
             return
           end
 
-          return if !test.skipped? || !test.skipped_by_itr?
-
           @mutex.synchronize do
             @skipped_tests_count += 1
           end
@@ -151,6 +158,9 @@ module Datadog
         def write_test_session_tags(test_session)
           return if !enabled?
 
+          Datadog.logger.debug { "Finished ITR session with test skipping enabled: #{@test_skipping_enabled}" }
+          Datadog.logger.debug { "#{@skipped_tests_count} tests were skipped" }
+
           test_session.set_tag(Ext::Test::TAG_ITR_TESTS_SKIPPED, @skipped_tests_count.positive?.to_s)
           test_session.set_tag(Ext::Test::TAG_ITR_TEST_SKIPPING_COUNT, @skipped_tests_count)
         end
@@ -191,11 +201,15 @@ module Datadog
           # we can only request skippable tests if git metadata is already uploaded
           git_tree_upload_worker.wait_until_done
 
-          skippable_response = Skippable.new(api: @api, dd_env: @dd_env).fetch_skippable_tests(test_session)
+          skippable_response =
+            Skippable.new(api: @api, dd_env: @dd_env, config_tags: @config_tags)
+              .fetch_skippable_tests(test_session)
+
           @correlation_id = skippable_response.correlation_id
           @skippable_tests = skippable_response.tests
 
           Datadog.logger.debug { "Fetched skippable tests: \n #{@skippable_tests}" }
+          Datadog.logger.debug { "Found #{@skippable_tests.count} skippable tests." }
           Datadog.logger.debug { "ITR correlation ID: #{@correlation_id}" }
         end
       end

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

@@ -57,9 +57,10 @@ module Datadog
           end
         end
 
-        def initialize(dd_env:, api: nil)
+        def initialize(dd_env:, api: nil, config_tags: {})
           @api = api
           @dd_env = dd_env
+          @config_tags = config_tags
         end
 
         def fetch_skippable_tests(test_session)
@@ -94,7 +95,8 @@ module Datadog
                   Ext::Test::TAG_OS_ARCHITECTURE => test_session.os_architecture,
                   Ext::Test::TAG_OS_VERSION => test_session.os_version,
                   Ext::Test::TAG_RUNTIME_NAME => test_session.runtime_name,
-                  Ext::Test::TAG_RUNTIME_VERSION => test_session.runtime_version
+                  Ext::Test::TAG_RUNTIME_VERSION => test_session.runtime_version,
+                  "custom" => @config_tags
                 }
               }
             }

data/lib/datadog/ci/span.rb

@@ -102,6 +102,13 @@ module Datadog
         tracer_span.set_tag(key, value)
       end
 
+      # Removes tag by key.
+      # @param [String] key the key of the tag.
+      # @return [void]
+      def clear_tag(key)
+        tracer_span.clear_tag(key)
+      end
+
       # Sets metric value by key.
       # @param [String] key the key of the metric.
       # @param [Numeric] value the value of the metric.

data/lib/datadog/ci/test.rb

@@ -69,6 +69,24 @@ module Datadog
         get_tag(Ext::Test::TAG_ITR_SKIPPED_BY_ITR) == "true"
       end
 
+      # Marks this test as unskippable by the intelligent test runner.
+      # This must be done before the test execution starts.
+      #
+      # Examples of tests that should be unskippable:
+      # - tests that read files from disk
+      # - tests that make network requests
+      # - tests that call external processes
+      # - tests that use forking or threading
+      #
+      # @return [void]
+      def itr_unskippable!
+        set_tag(Ext::Test::TAG_ITR_UNSKIPPABLE, "true")
+        if skipped_by_itr?
+          clear_tag(Ext::Test::TAG_ITR_SKIPPED_BY_ITR)
+          set_tag(Ext::Test::TAG_ITR_FORCED_RUN, "true")
+        end
+      end
+
       # Sets the status of the span to "pass".
       # @return [void]
       def passed!

data/lib/datadog/ci/test_visibility/serializers/base.rb

@@ -28,11 +28,12 @@ module Datadog
             "duration"
           ].freeze
 
-          attr_reader :trace, :span, :meta
+          attr_reader :trace, :span, :meta, :options
 
-          def initialize(trace, span)
+          def initialize(trace, span, options: {})
             @trace = trace
             @span = span
+            @options = options
 
             @meta = @span.meta.reject { |key, _| Ext::Test::TRANSIENT_TAGS.include?(key) }
 

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

@@ -14,12 +14,12 @@ module Datadog
           module TestLevel
             module_function
 
-            def serializer(trace, span)
+            def serializer(trace, span, options: {})
               case span.type
               when Datadog::CI::Ext::AppTypes::TYPE_TEST
-                Serializers::TestV1.new(trace, span)
+                Serializers::TestV1.new(trace, span, options: options)
               else
-                Serializers::Span.new(trace, span)
+                Serializers::Span.new(trace, span, options: options)
               end
             end
           end

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

@@ -15,18 +15,18 @@ module Datadog
           module TestSuiteLevel
             module_function
 
-            def serializer(trace, span)
+            def serializer(trace, span, options: {})
               case span.type
               when Datadog::CI::Ext::AppTypes::TYPE_TEST
-                Serializers::TestV2.new(trace, span)
+                Serializers::TestV2.new(trace, span, options: options)
               when Datadog::CI::Ext::AppTypes::TYPE_TEST_SESSION
-                Serializers::TestSession.new(trace, span)
+                Serializers::TestSession.new(trace, span, options: options)
               when Datadog::CI::Ext::AppTypes::TYPE_TEST_MODULE
-                Serializers::TestModule.new(trace, span)
+                Serializers::TestModule.new(trace, span, options: options)
               when Datadog::CI::Ext::AppTypes::TYPE_TEST_SUITE
-                Serializers::TestSuite.new(trace, span)
+                Serializers::TestSuite.new(trace, span, options: options)
               else
-                Serializers::Span.new(trace, span)
+                Serializers::Span.new(trace, span, options: options)
               end
             end
           end

data/lib/datadog/ci/test_visibility/serializers/test_v2.rb

@@ -10,22 +10,34 @@ module Datadog
         class TestV2 < TestV1
           CONTENT_FIELDS = (["test_session_id", "test_module_id", "test_suite_id"] + TestV1::CONTENT_FIELDS).freeze
 
+          CONTENT_FIELDS_WITH_ITR_CORRELATION_ID = (CONTENT_FIELDS + ["itr_correlation_id"]).freeze
+
           CONTENT_MAP_SIZE = calculate_content_map_size(CONTENT_FIELDS)
 
+          CONTENT_MAP_SIZE_WITH_ITR_CORRELATION_ID = calculate_content_map_size(CONTENT_FIELDS_WITH_ITR_CORRELATION_ID)
+
           REQUIRED_FIELDS = (["test_session_id", "test_module_id", "test_suite_id"] + TestV1::REQUIRED_FIELDS).freeze
 
           def content_fields
-            CONTENT_FIELDS
+            return CONTENT_FIELDS if itr_correlation_id.nil?
+
+            CONTENT_FIELDS_WITH_ITR_CORRELATION_ID
           end
 
           def content_map_size
-            CONTENT_MAP_SIZE
+            return CONTENT_MAP_SIZE if itr_correlation_id.nil?
+
+            CONTENT_MAP_SIZE_WITH_ITR_CORRELATION_ID
           end
 
           def version
             2
           end
 
+          def itr_correlation_id
+            options[:itr_correlation_id]
+          end
+
           private
 
           def required_fields

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

@@ -45,7 +45,7 @@ module Datadog
         end
 
         def encode_span(trace, span)
-          serializer = serializers_factory.serializer(trace, span)
+          serializer = serializers_factory.serializer(trace, span, options: {itr_correlation_id: itr&.correlation_id})
 
           if serializer.valid?
             encoded = encoder.encode(serializer)
@@ -98,6 +98,10 @@ module Datadog
 
           packer.write("events")
         end
+
+        def itr
+          @itr ||= Datadog::CI.send(:itr_runner)
+        end
       end
     end
   end

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

@@ -51,9 +51,10 @@ module Datadog
           end
         end
 
-        def initialize(dd_env:, api: nil)
+        def initialize(dd_env:, api: nil, config_tags: {})
           @api = api
           @dd_env = dd_env
+          @config_tags = config_tags || {}
         end
 
         def fetch_library_settings(test_session)
@@ -90,7 +91,8 @@ module Datadog
                   Ext::Test::TAG_OS_ARCHITECTURE => test_session.os_architecture,
                   Ext::Test::TAG_OS_VERSION => test_session.os_version,
                   Ext::Test::TAG_RUNTIME_NAME => test_session.runtime_name,
-                  Ext::Test::TAG_RUNTIME_VERSION => test_session.runtime_version
+                  Ext::Test::TAG_RUNTIME_VERSION => test_session.runtime_version,
+                  "custom" => @config_tags
                 }
               }
             }

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

@@ -22,6 +22,18 @@ module Datadog
             }
           )
         end
+
+        def self.custom_configuration(env_tags)
+          return {} if env_tags.nil?
+
+          res = {}
+          env_tags.each do |tag, value|
+            next unless tag.start_with?("test.configuration.")
+
+            res[tag.sub("test.configuration.", "")] = value
+          end
+          res
+        end
       end
     end
   end

data/lib/datadog/ci/version.rb

@@ -6,7 +6,7 @@ module Datadog
       MAJOR = "1"
       MINOR = "0"
       PATCH = "0"
-      PRE = "beta2"
+      PRE = "beta3"
       BUILD = nil
       # PRE and BUILD above are modified for dev gems during gem build GHA workflow
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: datadog-ci
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta2
+  version: 1.0.0.beta3
 platform: ruby
 authors:
 - Datadog, Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-04-24 00:00:00.000000000 Z
+date: 2024-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: datadog
@@ -77,12 +77,12 @@ files:
 - 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/reporter.rb
 - lib/datadog/ci/contrib/minitest/runnable.rb
 - lib/datadog/ci/contrib/minitest/runner.rb
+- lib/datadog/ci/contrib/minitest/test.rb
 - lib/datadog/ci/contrib/rspec/configuration/settings.rb
 - lib/datadog/ci/contrib/rspec/example.rb
 - lib/datadog/ci/contrib/rspec/example_group.rb
@@ -188,7 +188,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 2.0.0
 requirements: []
-rubygems_version: 3.5.6
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: Datadog CI visibility for your ruby application

data/lib/datadog/ci/contrib/minitest/hooks.rb

@@ -1,77 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "../../ext/test"
-require_relative "../../git/local_repository"
-require_relative "ext"
-require_relative "helpers"
-
-module Datadog
-  module CI
-    module Contrib
-      module Minitest
-        # Lifecycle hooks to instrument Minitest::Test
-        module Hooks
-          def before_setup
-            super
-            return unless datadog_configuration[:enabled]
-
-            test_suite_name = Helpers.test_suite_name(self.class, name)
-            if Helpers.parallel?(self.class)
-              test_suite_name = "#{test_suite_name} (#{name} concurrently)"
-
-              # for parallel execution we need to start a new test suite for each test
-              CI.start_test_suite(test_suite_name)
-            end
-
-            source_file, line_number = method(name).source_location
-
-            test_span = CI.start_test(
-              name,
-              test_suite_name,
-              tags: {
-                CI::Ext::Test::TAG_FRAMEWORK => Ext::FRAMEWORK,
-                CI::Ext::Test::TAG_FRAMEWORK_VERSION => CI::Contrib::Minitest::Integration.version.to_s,
-                CI::Ext::Test::TAG_SOURCE_FILE => Git::LocalRepository.relative_to_root(source_file),
-                CI::Ext::Test::TAG_SOURCE_START => line_number.to_s
-              },
-              service: datadog_configuration[:service_name]
-            )
-            skip(CI::Ext::Test::ITR_TEST_SKIP_REASON) if test_span&.skipped_by_itr?
-          end
-
-          def after_teardown
-            test_span = CI.active_test
-            return super unless test_span
-
-            finish_with_result(test_span, result_code)
-            if Helpers.parallel?(self.class)
-              finish_with_result(test_span.test_suite, result_code)
-            end
-
-            super
-          end
-
-          private
-
-          def finish_with_result(span, result_code)
-            return unless span
-
-            case result_code
-            when "."
-              span.passed!
-            when "E", "F"
-              span.failed!(exception: failure)
-            when "S"
-              span.skipped!(reason: failure.message)
-            end
-            span.finish
-          end
-
-          def datadog_configuration
-            Datadog.configuration.ci[:minitest]
-          end
-        end
-      end
-    end
-  end
-end