datadog-ci 1.34.0 → 1.36.0

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

@@ -7,6 +7,7 @@ require_relative "../../source_code/path_filter"
 require_relative "../../utils/bundle"
 require_relative "../../utils/test_run"
 require_relative "../instrumentation"
+require_relative "anonymous_example_name"
 require_relative "ext"
 
 module Datadog
@@ -110,11 +111,7 @@ module Datadog
             def datadog_test_name
               return @datadog_test_name if defined?(@datadog_test_name)
 
-              test_name = full_description.strip
-              if metadata[:description].empty?
-                # for unnamed it blocks this appends something like "example at ./spec/some_spec.rb:10"
-                test_name << " #{description}"
-              end
+              test_name = datadog_unnamed_example? ? datadog_unnamed_example_name : full_description.strip
 
               # remove example group description from test name to avoid duplication
               test_name = test_name.sub(datadog_test_suite_description, "").strip
@@ -266,6 +263,27 @@ module Datadog
               end
             end
 
+            # ============================================
+            # Test name helpers
+            # ============================================
+
+            def datadog_unnamed_example?
+              # @type var description_args: Array[untyped]
+              description_args = Array(metadata[:description_args])
+              description_args.empty? || description_args.all? { |description_arg| description_arg.to_s.strip.empty? }
+            end
+
+            def datadog_unnamed_example_name
+              example_name = AnonymousExampleName.call(datadog_anonymous_example_block)
+              example_name ||= "anonymous example"
+
+              "#{metadata[:example_group][:full_description]} #{example_name}"
+            end
+
+            def datadog_anonymous_example_block
+              metadata[:block] || @example_block
+            end
+
             # ============================================
             # Source location resolution
             # ============================================

data/lib/datadog/ci/contrib/simplecov/result_extractor.rb

@@ -22,7 +22,15 @@ module Datadog
                 ::SimpleCov::ResultAdapter.call(::Coverage.peek_result)
               )
 
-              ::SimpleCov::Result.new(add_not_loaded_files(result))
+              # SimpleCov 1.0 changed add_not_loaded_files to return a
+              # [coverage, not_loaded_files] tuple instead of a coverage hash.
+              processed = add_not_loaded_files(result)
+              if processed.is_a?(::Array)
+                coverage, not_loaded_files = processed
+                ::SimpleCov::Result.new(coverage, not_loaded_files: not_loaded_files)
+              else
+                ::SimpleCov::Result.new(processed)
+              end
             end
 
             def datadog_configuration

data/lib/datadog/ci/ext/environment/extractor.rb

@@ -28,6 +28,7 @@ module Datadog
               Environment::TAG_JOB_URL => @provider.job_url,
               Environment::TAG_PIPELINE_ID => @provider.pipeline_id,
               Environment::TAG_PIPELINE_NAME => @provider.pipeline_name,
+              Environment::TAG_PIPELINE_DISPLAY_NAME => @provider.pipeline_display_name,
               Environment::TAG_PIPELINE_NUMBER => @provider.pipeline_number,
               Environment::TAG_PIPELINE_URL => @provider.pipeline_url,
               Environment::TAG_PROVIDER_NAME => @provider.provider_name,

data/lib/datadog/ci/ext/environment/providers/base.rb

@@ -33,6 +33,9 @@ module Datadog
             def pipeline_name
             end
 
+            def pipeline_display_name
+            end
+
             def pipeline_number
             end
 

data/lib/datadog/ci/ext/environment/providers/buildkite.rb

@@ -36,6 +36,10 @@ module Datadog
               env["BUILDKITE_PIPELINE_SLUG"]
             end
 
+            def pipeline_display_name
+              env["BUILDKITE_PIPELINE_NAME"]
+            end
+
             def pipeline_number
               env["BUILDKITE_BUILD_NUMBER"]
             end

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

@@ -18,6 +18,7 @@ module Datadog
         TAG_JOB_URL = "ci.job.url"
         TAG_PIPELINE_ID = "ci.pipeline.id"
         TAG_PIPELINE_NAME = "ci.pipeline.name"
+        TAG_PIPELINE_DISPLAY_NAME = "ci.pipeline.display_name"
         TAG_PIPELINE_NUMBER = "ci.pipeline.number"
         TAG_PIPELINE_URL = "ci.pipeline.url"
         TAG_PROVIDER_NAME = "ci.provider.name"

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

@@ -33,6 +33,7 @@ module Datadog
         ENV_AUTO_INSTRUMENTATION_PROVIDER = "DD_CIVISIBILITY_AUTO_INSTRUMENTATION_PROVIDER"
         ENV_TIA_STATIC_DEPENDENCIES_TRACKING_ENABLED = "DD_TEST_OPTIMIZATION_TIA_STATIC_DEPS_COVERAGE_ENABLED"
         ENV_CODE_COVERAGE_REPORT_UPLOAD_ENABLED = "DD_CIVISIBILITY_CODE_COVERAGE_REPORT_UPLOAD_ENABLED"
+        ENV_CODE_COVERAGE_FLAGS = "DD_CODE_COVERAGE_FLAGS"
         ENV_RUNTIME_TAGS = "DD_TEST_OPTIMIZATION_RUNTIME_TAGS"
 
         # Source: https://docs.datadoghq.com/getting_started/site/

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

@@ -65,6 +65,9 @@ module Datadog
         METRIC_KNOWN_TESTS_REQUEST_ERRORS = "known_tests.request_errors"
         METRIC_KNOWN_TESTS_RESPONSE_BYTES = "known_tests.response_bytes"
         METRIC_KNOWN_TESTS_RESPONSE_TESTS = "known_tests.response_tests"
+        METRIC_KNOWN_TESTS_PAGES_FETCHED = "known_tests.pages_fetched"
+        METRIC_KNOWN_TESTS_TOTAL_FETCH_MS = "known_tests.total_fetch_ms"
+        METRIC_KNOWN_TESTS_TOTAL_REQUEST_MS = "known_tests.total_request_ms"
 
         METRIC_TEST_MANAGEMENT_TESTS_REQUEST = "test_management_tests.request"
         METRIC_TEST_MANAGEMENT_TESTS_REQUEST_MS = "test_management_tests.request_ms"

data/lib/datadog/ci/test.rb

@@ -12,6 +12,13 @@ module Datadog
     #
     # @public_api
     class Test < Span
+      def initialize(tracer_span)
+        super
+
+        @custom_impacted_files = []
+        @inherited_custom_impacted_files = []
+      end
+
       # Context IDs for this test (used for TIA context coverage merging).
       # Contains list of context identifiers from outermost to innermost.
       # @return [Array<String>] list of context IDs
@@ -157,6 +164,66 @@ module Datadog
         end
       end
 
+      # Adds custom files that Test Impact Analysis should consider capable of
+      # impacting this test.
+      #
+      # This is useful for files that Datadog's native Ruby coverage cannot
+      # observe, such as JavaScript executed in a browser during a Capybara
+      # test. Paths must resolve inside the Git repository. Relative paths must
+      # be relative to the repository root. Absolute paths are also accepted.
+      #
+      # If paths are relative to the current working directory, convert them to
+      # absolute paths with +File.expand_path+ before calling this method.
+      # Submitted paths must be lexically normalized without redundant +.+ or
+      # +..+ components.
+      #
+      # Path resolution does not access the filesystem, so files do not need
+      # to exist when they are added. Paths outside the repository are ignored
+      # when the coverage event is serialized. Calls are incremental: every
+      # call adds files for the remainder of the test.
+      #
+      # @example Register JavaScript files loaded during an RSpec test
+      #   RSpec.configure do |config|
+      #     config.after do
+      #       Datadog::CI.active_test&.add_impacted_files(
+      #         javascript_files_loaded_by_browser.map do |path|
+      #           File.expand_path(path, Dir.pwd)
+      #         end
+      #       )
+      #     end
+      #   end
+      #
+      # @param [Array<String>] file_paths custom paths that can impact this test
+      # @raise [ArgumentError] if file_paths is not an Array
+      # @return [void]
+      def add_impacted_files(file_paths)
+        raise ArgumentError, "file_paths must be an Array" unless file_paths.is_a?(Array)
+
+        @custom_impacted_files.concat(file_paths)
+        nil
+      end
+
+      # Inherits suite-level custom impacted files without copying them.
+      #
+      # @internal
+      # @return [void]
+      def inherit_impacted_files(custom_impacted_files)
+        @inherited_custom_impacted_files = custom_impacted_files
+        nil
+      end
+
+      # Locks custom impacted files against further changes and returns them to
+      # Test Impact Analysis.
+      #
+      # @internal
+      # @return [Array<String>]
+      def lock_custom_impacted_files
+        return @custom_impacted_files if @custom_impacted_files.frozen?
+
+        @custom_impacted_files =
+          (@inherited_custom_impacted_files | @custom_impacted_files).freeze
+      end
+
       # Sets the status of the span to "pass".
       # @return [void]
       def passed!

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

@@ -4,6 +4,7 @@ require "fileutils"
 require "json"
 require_relative "../ext/test"
 require_relative "../ext/test_discovery"
+require_relative "../utils/test_name"
 
 module Datadog
   module CI
@@ -76,6 +77,9 @@ module Datadog
         end
 
         def record_test(name:, suite:, module_name:, parameters:, source_file:)
+          name = name.nil? ? nil : Utils::TestName.normalize(name)
+          suite = suite.nil? ? nil : Utils::TestName.normalize(suite)
+
           test_info = {
             "name" => name,
             "suite" => suite,

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

@@ -16,6 +16,7 @@ require_relative "../utils/stateful"
 require_relative "../utils/telemetry"
 
 require_relative "coverage/event"
+require_relative "coverage/files"
 require_relative "skippable"
 require_relative "telemetry"
 
@@ -187,6 +188,8 @@ module Datadog
         # @param test [Datadog::CI::Test] The test that is starting
         # @return [void]
         def on_test_started(test)
+          inherit_suite_impacted_files(test) if test_skipping_mode?
+
           return if !enabled? || !code_coverage?
           return if suite_skipping_mode?
 
@@ -215,7 +218,11 @@ module Datadog
         # @return [Datadog::CI::TestImpactAnalysis::Coverage::Event, nil] The coverage event or nil
         def on_test_finished(test, context)
           return unless enabled?
-          return if suite_skipping_mode?
+
+          if suite_skipping_mode?
+            test.test_suite&.add_impacted_files(test.lock_custom_impacted_files)
+            return
+          end
 
           # Handle ITR statistics
           if test.skipped_by_test_impact_analysis?
@@ -243,7 +250,8 @@ module Datadog
             test_suite_id: test.test_suite_id.to_s,
             test_session_id: test.test_session_id.to_s,
             source_file: test.source_file,
-            coverage: coverage
+            coverage: coverage,
+            custom_impacted_files: test.lock_custom_impacted_files
           )
         end
 
@@ -350,7 +358,8 @@ module Datadog
             test_suite_id: test_suite.id.to_s,
             test_session_id: test_suite.get_tag(Ext::Test::TAG_TEST_SESSION_ID).to_s,
             source_file: test_suite.source_file,
-            coverage: coverage
+            coverage: coverage,
+            custom_impacted_files: test_suite.lock_custom_impacted_files
           )
         end
 
@@ -451,7 +460,7 @@ module Datadog
           return unless @static_dependencies_tracking_enabled
 
           static_dependencies_map = {}
-          coverage.keys.each do |file|
+          coverage.each_key do |file|
             static_dependencies_map.merge!(
               Datadog::CI::SourceCode::StaticDependencies.fetch_static_dependencies(file)
             )
@@ -466,9 +475,16 @@ module Datadog
           coverage[absolute_test_source_file_path] = true
         end
 
-        def write_coverage_event(test_id:, test_suite_id:, test_session_id:, source_file:, coverage:)
+        def write_coverage_event(
+          test_id:,
+          test_suite_id:,
+          test_session_id:,
+          source_file:,
+          coverage:,
+          custom_impacted_files: Coverage::Files::EMPTY_FILES
+        )
           coverage ||= {}
-          if coverage.empty?
+          if coverage.empty? && custom_impacted_files.empty?
             Telemetry.code_coverage_is_empty
             return
           end
@@ -477,13 +493,18 @@ module Datadog
 
           enrich_coverage_with_static_dependencies(coverage)
 
-          Telemetry.code_coverage_files(coverage.size)
+          # Avoid normalizing and deduplicating paths on the test thread. The
+          # writer does that when it serializes the event. Telemetry only needs
+          # an estimate and may count overlaps between the two collections.
+          Telemetry.code_coverage_files(coverage.size + custom_impacted_files.size)
+
+          files = Coverage::Files.new(coverage, custom_impacted_files)
 
           coverage_event = Coverage::Event.new(
             test_id: test_id,
             test_suite_id: test_suite_id,
             test_session_id: test_session_id,
-            coverage: coverage
+            files: files
           )
 
           Datadog.logger.debug { "Writing coverage event \n #{coverage_event.pretty_inspect}" }
@@ -493,6 +514,13 @@ module Datadog
           coverage_event
         end
 
+        def inherit_suite_impacted_files(test)
+          test_suite = test.test_suite
+          return if test_suite.nil?
+
+          test.inherit_impacted_files(test_suite.lock_custom_impacted_files)
+        end
+
         def fetch_skippables(test_session)
           return unless skipping_tests? || skipping_suites?
 

data/lib/datadog/ci/test_impact_analysis/coverage/event.rb

@@ -2,27 +2,37 @@
 
 require "msgpack"
 
-require_relative "../../git/local_repository"
+require_relative "files"
 
 module Datadog
   module CI
     module TestImpactAnalysis
       module Coverage
         class Event
-          attr_reader :test_id, :test_suite_id, :test_session_id, :coverage
-
-          def initialize(test_id:, test_suite_id:, test_session_id:, coverage:)
+          attr_reader :test_id, :test_suite_id, :test_session_id
+
+          def initialize(
+            test_id:,
+            test_suite_id:,
+            test_session_id:,
+            files:
+          )
             @test_id = test_id
             @test_suite_id = test_suite_id
             @test_session_id = test_session_id
-            @coverage = coverage
+            @files = files
+          end
+
+          def inspect_coverage
+            @files.inspect_coverage
           end
 
           def valid?
             valid = true
 
-            %i[test_suite_id test_session_id coverage].each do |key|
-              next unless send(key).nil?
+            %i[test_suite_id test_session_id files].each do |key|
+              value = (key == :files) ? @files : send(key)
+              next unless value.nil?
 
               Datadog.logger.warn("citestcov event is invalid: [#{key}] is nil. Event: #{self}")
               valid = false
@@ -47,19 +57,18 @@ module Datadog
               packer.write(test_id.to_i)
             end
 
-            files = coverage.keys
             packer.write("files")
-            packer.write_array_header(files.size)
-
-            files.each do |filename|
+            packer.write_array_header(@files.size)
+            @files.each do |filename|
               packer.write_map_header(1)
               packer.write("filename")
-              packer.write(Git::LocalRepository.relative_to_root(filename))
+              packer.write(filename)
             end
           end
 
           def to_s
-            "Coverage::Event[test_id=#{test_id}, test_suite_id=#{test_suite_id}, test_session_id=#{test_session_id}, coverage=#{coverage}]"
+            coverage_value = @files.nil? ? nil : inspect_coverage
+            "Coverage::Event[test_id=#{test_id}, test_suite_id=#{test_suite_id}, test_session_id=#{test_session_id}, coverage=#{coverage_value}]"
           end
 
           # Return a human readable version of the event
@@ -70,8 +79,8 @@ module Datadog
               q.text "Test Suite ID: #{@test_suite_id}\n"
               q.text "Test Session ID: #{@test_session_id}\n"
               q.group(2, "Files: [", "]\n") do
-                q.seplist @coverage.keys.each do |key|
-                  q.text key
+                q.seplist @files do |filename|
+                  q.text filename
                 end
               end
             end

data/lib/datadog/ci/test_impact_analysis/coverage/files.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require_relative "../../git/local_repository"
+
+module Datadog
+  module CI
+    module TestImpactAnalysis
+      module Coverage
+        # Keeps native coverage and custom impacted files together and
+        # normalizes them as one set.
+        #
+        # @internal
+        class Files
+          EMPTY_FILES = [].freeze
+
+          def initialize(coverage, custom_impacted_files = EMPTY_FILES)
+            @coverage = coverage
+            @custom_impacted_files = custom_impacted_files
+            @normalized_files = nil
+          end
+
+          def each
+            normalized_files.each { |file| yield file }
+          end
+
+          def size
+            normalized_files.size
+          end
+
+          # Returns a readable view while preserving the paths supplied by
+          # native coverage and the custom impacted-files API. Serialized files
+          # are normalized through {#each}.
+          def inspect_coverage
+            coverage = @coverage.dup
+            @custom_impacted_files.each do |file|
+              coverage[file] = true
+            end
+            coverage
+          end
+
+          private
+
+          def normalized_files
+            @normalized_files ||= begin
+              files = []
+              @coverage.each_key do |file|
+                relative_file = Git::LocalRepository.relative_to_root(file)
+                files << relative_file unless relative_file.empty?
+              end
+              @custom_impacted_files.each do |file|
+                # The public API defines relative custom paths as repository-relative.
+                relative_file = if File.absolute_path?(file)
+                  Git::LocalRepository.relative_to_root(file)
+                else
+                  file
+                end
+                files << relative_file unless relative_file.empty?
+              end
+              files.uniq
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/ci/test_suite.rb

@@ -16,6 +16,8 @@ module Datadog
       def initialize(tracer_span)
         super
 
+        @custom_impacted_files = []
+
         # counts how many times every test in this suite was executed with each status:
         #   { "MySuite.mytest.a:1" => { "pass" => 3, "fail" => 2 } }
         @execution_stats_per_test = {}
@@ -25,6 +27,63 @@ module Datadog
         @final_statuses_per_test = {}
       end
 
+      # Adds files that Test Impact Analysis should consider capable of
+      # impacting every test in this suite.
+      #
+      # In test-level skipping mode, custom impacted files must be added before
+      # the first test in this suite starts. In suite-level skipping mode, they
+      # may be added until the suite finishes.
+      #
+      # This is useful for files shared by every test that Datadog's native
+      # Ruby coverage cannot observe, such as JavaScript test setup. Calls are
+      # incremental: every call adds files for the remainder of the suite.
+      #
+      # Paths must resolve inside the Git repository. Relative paths must be
+      # relative to the repository root. Absolute paths are also accepted.
+      #
+      # If paths are relative to the current working directory, convert them to
+      # absolute paths with +File.expand_path+ before calling this method.
+      # Submitted paths must be lexically normalized without redundant +.+ or
+      # +..+ components. Resolution does not access the filesystem. Paths
+      # outside the repository are ignored when the coverage event is
+      # serialized.
+      #
+      # @example Register JavaScript setup shared by an RSpec suite
+      #   before(:context) do
+      #     Datadog::CI.active_test_suite&.add_impacted_files(
+      #       ["app/frontend/test_setup.js"]
+      #     )
+      #   end
+      #
+      # @raise [RuntimeError] if test-level skipping is active and a test in
+      #   this suite has already started
+      # @param [Array<String>] file_paths custom paths that can impact this suite
+      # @raise [ArgumentError] if file_paths is not an Array
+      # @return [void]
+      def add_impacted_files(file_paths)
+        raise ArgumentError, "file_paths must be an Array" unless file_paths.is_a?(Array)
+
+        synchronize do
+          ensure_custom_impacted_files_mutable!
+          @custom_impacted_files.concat(file_paths)
+        end
+        nil
+      end
+
+      # Locks suite-level custom impacted files against further changes and
+      # returns them to Test Impact Analysis.
+      #
+      # @internal
+      # @return [Array<String>]
+      def lock_custom_impacted_files
+        synchronize do
+          unless @custom_impacted_files.frozen?
+            @custom_impacted_files = @custom_impacted_files.uniq.freeze
+          end
+          @custom_impacted_files
+        end
+      end
+
       # Finishes this test suite.
       # @return [void]
       def finish
@@ -133,6 +192,14 @@ module Datadog
 
       private
 
+      def ensure_custom_impacted_files_mutable!
+        return unless @custom_impacted_files.frozen?
+
+        raise(
+          "Custom impacted files must be added to a test suite before the first test in the suite starts"
+        )
+      end
+
       def set_status_from_stats!
         synchronize do
           # count how many tests have each final status

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

@@ -16,6 +16,7 @@ require_relative "../ext/test"
 require_relative "../git/local_repository"
 require_relative "../utils/file_storage"
 require_relative "../utils/stateful"
+require_relative "../utils/test_name"
 
 require_relative "../worker"
 
@@ -109,6 +110,7 @@ module Datadog
         def start_test_suite(test_suite_name, service: nil, tags: {})
           return skip_tracing unless test_suite_level_visibility_enabled
 
+          test_suite_name = Utils::TestName.normalize(test_suite_name)
           context = @local_test_suites_mode ? @context : maybe_remote_context
 
           test_suite = context.start_test_suite(test_suite_name, service: service, tags: tags)
@@ -117,6 +119,9 @@ module Datadog
         end
 
         def trace_test(test_name, test_suite_name, service: nil, tags: {}, &block)
+          test_name = Utils::TestName.normalize(test_name)
+          test_suite_name = Utils::TestName.normalize(test_suite_name)
+
           test_suite = active_test_suite(test_suite_name)
           tags[Ext::Test::TAG_SUITE] ||= test_suite_name
 
@@ -165,6 +170,8 @@ module Datadog
           # we return the single active test suite because most of the time there is only one test suite running
           return single_active_test_suite if test_suite_name.nil?
 
+          test_suite_name = Utils::TestName.normalize(test_suite_name)
+
           # when fetching test_suite to use as test's context, try local context instance first
           local_test_suite = @context.active_test_suite(test_suite_name)
           return local_test_suite if local_test_suite
@@ -194,6 +201,7 @@ module Datadog
         end
 
         def deactivate_test_suite(test_suite_name)
+          test_suite_name = Utils::TestName.normalize(test_suite_name)
           test_suite = active_test_suite(test_suite_name)
           on_test_suite_finished(test_suite) if test_suite
 

data/lib/datadog/ci/test_tracing/deprecated_total_coverage_metric.rb

@@ -12,7 +12,7 @@ module Datadog
             return
           end
 
-          unless ::SimpleCov.running
+          unless simplecov_running?
             Datadog.logger.debug("SimpleCov is not running, skipping code coverage extraction")
             return
           end
@@ -30,6 +30,16 @@ module Datadog
 
           test_session.set_tag(Ext::Test::TAG_CODE_COVERAGE_LINES_PCT, result.covered_percent)
         end
+
+        # SimpleCov 1.0 removed the `running` accessor and relies on Ruby's
+        # Coverage.running? instead.
+        def self.simplecov_running?
+          return ::SimpleCov.running if ::SimpleCov.respond_to?(:running)
+          return false unless defined?(::Coverage)
+
+          ::Coverage.running?
+        end
+        private_class_method :simplecov_running?
       end
     end
   end