datadog-ci 1.6.0 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f38fbb3ab8e2c8c1b058d7cbefb3ac30c59cd138fb2a69929d2c7309763b0c6e
-  data.tar.gz: 862f8c10065b47fb8763701399de65cf0da652f36f0d301ba3b0cd4e1c12080c
+  metadata.gz: f4cb94bf0ef94f54289e38a26649d24eeaaca99ba91229f5ebb096c046bdc582
+  data.tar.gz: 9a88847a58121a1516b95fc1abac1fa89d4a1bab5c4593f932fc804410ee8a57
 SHA512:
-  metadata.gz: 4be4dec3f2b5a11d0a822a3cd17d422eedab4262445dd42ba4d4efa96d4ee3f92049e5b37e1b6497928cf1fe980a847e4749538275092ca9fecd24700db3c62f
-  data.tar.gz: 2ebcae9e728ffd517d2c4f583808ade0170cb705967b59710213633bc73d1cd5d529c2b22323f8f70d45f657a8d848e856560aacc53c3ec7aea6e3aff45110af
+  metadata.gz: 7830a7b52821efbea8e0f86e878588ef96718e845fd7a33575a4a5e92d350e26e36bb4b78f7ce78b58ff59654c62973c4eca58f21c63b958d44f4d8feff122cc
+  data.tar.gz: da8d30e84f9dea71eb498cccb6e03cb092e27e773008dc7533188020ee5cb59de774e4d2be32821e3fd82e28f4ccb426572695fd532dc7f7fff6479a392bca85

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 ## [Unreleased]
 
+## [1.7.0] - 2024-09-25
+
+### Added
+* Report total lines coverage percentage to Datadog ([#240][])
+* add source location info to test suites ([#239][])
+* Add pull_request extra tags for GitHub Actions ([#238][])
+
 ## [1.6.0] - 2024-09-20
 
 
@@ -332,7 +339,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.6.0...main
+[Unreleased]: https://github.com/DataDog/datadog-ci-rb/compare/v1.7.0...main
+[1.7.0]: https://github.com/DataDog/datadog-ci-rb/compare/v1.6.0...v1.7.0
 [1.6.0]: https://github.com/DataDog/datadog-ci-rb/compare/v1.5.0...v1.6.0
 [1.5.0]: https://github.com/DataDog/datadog-ci-rb/compare/v1.4.1...v1.5.0
 [1.4.1]: https://github.com/DataDog/datadog-ci-rb/compare/v1.4.0...v1.4.1
@@ -477,4 +485,7 @@ Currently test suite level visibility is not used by our instrumentation: it wil
 [#229]: https://github.com/DataDog/datadog-ci-rb/issues/229
 [#231]: https://github.com/DataDog/datadog-ci-rb/issues/231
 [#235]: https://github.com/DataDog/datadog-ci-rb/issues/235
-[#236]: https://github.com/DataDog/datadog-ci-rb/issues/236
+[#236]: https://github.com/DataDog/datadog-ci-rb/issues/236
+[#238]: https://github.com/DataDog/datadog-ci-rb/issues/238
+[#239]: https://github.com/DataDog/datadog-ci-rb/issues/239
+[#240]: https://github.com/DataDog/datadog-ci-rb/issues/240

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

@@ -70,7 +70,12 @@ module Datadog
               tags[CI::Ext::Test::TAG_PARAMETERS] = Utils::TestRun.test_parameters(arguments: parameters)
             end
 
-            start_test_suite(test_suite_name) unless same_test_suite_as_current?(test_suite_name)
+            unless same_test_suite_as_current?(test_suite_name)
+              start_test_suite(
+                test_suite_name,
+                tags: test_suite_source_file_tags(event.test_case)
+              )
+            end
 
             test_span = test_visibility_component.trace_test(
               event.test_case.name,
@@ -146,10 +151,10 @@ module Datadog
             test_session.finish
           end
 
-          def start_test_suite(test_suite_name)
+          def start_test_suite(test_suite_name, tags: {})
             finish_current_test_suite
 
-            @current_test_suite = test_visibility_component.start_test_suite(test_suite_name)
+            @current_test_suite = test_visibility_component.start_test_suite(test_suite_name, tags: tags)
           end
 
           def finish_current_test_suite
@@ -201,6 +206,23 @@ module Datadog
           def test_visibility_component
             Datadog.send(:components).test_visibility
           end
+
+          def test_suite_source_file_tags(test_case)
+            if test_case.respond_to?(:parent_locations)
+              # supported in cucumber >= 9.0
+              source_file = test_case.parent_locations.file
+              line_number = test_case.parent_locations.line.to_s
+            else
+              # fallback for cucumber < 9.0
+              source_file = test_case.location.file
+              line_number = "1"
+            end
+
+            {
+              CI::Ext::Test::TAG_SOURCE_FILE => Git::LocalRepository.relative_to_root(source_file),
+              CI::Ext::Test::TAG_SOURCE_START => line_number.to_s
+            }
+          end
         end
       end
     end

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

@@ -6,7 +6,7 @@ module Datadog
       module Minitest
         module Helpers
           def self.test_suite_name(klass, method_name)
-            source_location = extract_source_location_from_class(klass)
+            source_location = extract_source_location_from_class(klass)&.first
             # if we are in anonymous class, fallback to the method source location
             if source_location.nil?
               source_location, = klass.instance_method(method_name).source_location
@@ -23,11 +23,11 @@ module Datadog
           end
 
           def self.extract_source_location_from_class(klass)
-            return nil if klass.nil? || klass.name.nil?
+            return [] if klass.nil? || klass.name.nil?
 
-            klass.const_source_location(klass.name)&.first
+            klass.const_source_location(klass.name)
           rescue
-            nil
+            []
           end
         end
       end

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

@@ -18,8 +18,21 @@ module Datadog
               return super if method.nil?
 
               test_suite_name = Helpers.test_suite_name(self, method)
-
-              test_suite = test_visibility_component.start_test_suite(test_suite_name)
+              source_file, line_number = Helpers.extract_source_location_from_class(self)
+
+              test_suite_tags = if source_file
+                {
+                  CI::Ext::Test::TAG_SOURCE_FILE => (Git::LocalRepository.relative_to_root(source_file) if source_file),
+                  CI::Ext::Test::TAG_SOURCE_START => line_number&.to_s
+                }
+              else
+                {}
+              end
+
+              test_suite = test_visibility_component.start_test_suite(
+                test_suite_name,
+                tags: test_suite_tags
+              )
 
               results = super
               return results unless test_suite

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

@@ -21,7 +21,13 @@ module Datadog
               return super unless top_level?
 
               suite_name = "#{description} at #{file_path}"
-              test_suite = test_visibility_component.start_test_suite(suite_name)
+              test_suite = test_visibility_component.start_test_suite(
+                suite_name,
+                tags: {
+                  CI::Ext::Test::TAG_SOURCE_FILE => Git::LocalRepository.relative_to_root(metadata[:file_path]),
+                  CI::Ext::Test::TAG_SOURCE_START => metadata[:line_number].to_s
+                }
+              )
 
               success = super
               return success unless test_suite

data/lib/datadog/ci/contrib/simplecov/configuration/settings.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require "datadog/core"
+
+require_relative "../ext"
+require_relative "../../settings"
+
+module Datadog
+  module CI
+    module Contrib
+      module Simplecov
+        module Configuration
+          # Custom settings for the Simplecov integration
+          # @public_api
+          class Settings < Datadog::CI::Contrib::Settings
+            option :enabled do |o|
+              o.type :bool
+              o.env Ext::ENV_ENABLED
+              o.default true
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Datadog
+  module CI
+    module Contrib
+      module Simplecov
+        # Simplecov integration constants
+        # @public_api
+        module Ext
+          ENV_ENABLED = "DD_CIVISIBILITY_SIMPLECOV_INSTRUMENTATION_ENABLED"
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+require_relative "../integration"
+require_relative "configuration/settings"
+require_relative "patcher"
+
+module Datadog
+  module CI
+    module Contrib
+      module Simplecov
+        # Description of Simplecov integration
+        class Integration
+          include Datadog::CI::Contrib::Integration
+
+          MINIMUM_VERSION = Gem::Version.new("0.18.0")
+
+          register_as :simplecov
+
+          def self.version
+            Gem.loaded_specs["simplecov"]&.version
+          end
+
+          def self.loaded?
+            !defined?(::SimpleCov).nil?
+          end
+
+          def self.compatible?
+            super && version >= MINIMUM_VERSION
+          end
+
+          # additional instrumentations for test helpers are auto instrumented on test session start
+          def auto_instrument?
+            true
+          end
+
+          def new_configuration
+            Configuration::Settings.new
+          end
+
+          def patcher
+            Patcher
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require "datadog/tracing/contrib/patcher"
+
+require_relative "result_extractor"
+
+module Datadog
+  module CI
+    module Contrib
+      module Simplecov
+        # Patcher enables patching of 'SimpleCov' module.
+        module Patcher
+          include Datadog::Tracing::Contrib::Patcher
+
+          module_function
+
+          def target_version
+            Integration.version
+          end
+
+          def patch
+            ::SimpleCov.include(ResultExtractor)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require "coverage"
+
+module Datadog
+  module CI
+    module Contrib
+      module Simplecov
+        module ResultExtractor
+          def self.included(base)
+            base.singleton_class.prepend(ClassMethods)
+          end
+
+          module ClassMethods
+            def __dd_peek_result
+              unless datadog_configuration[:enabled]
+                Datadog.logger.debug("SimpleCov instrumentation is disabled")
+                return nil
+              end
+
+              result = ::SimpleCov::UselessResultsRemover.call(
+                ::SimpleCov::ResultAdapter.call(::Coverage.peek_result)
+              )
+
+              ::SimpleCov::Result.new(add_not_loaded_files(result))
+            end
+
+            def datadog_configuration
+              Datadog.configuration.ci[:simplecov]
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -49,6 +49,11 @@ module Datadog
               Git::TAG_COMMIT_SHA => @provider.git_commit_sha
             }
 
+            # set additional tags if provider needs them
+            @provider.additional_tags.each do |key, value|
+              @tags[key] = value
+            end
+
             # Normalize Git references and filter sensitive data
             normalize_git!
             # Expand ~

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

@@ -96,6 +96,10 @@ module Datadog
             def git_commit_sha
             end
 
+            def additional_tags
+              {}
+            end
+
             private
 
             def set_branch_and_tag

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

@@ -75,6 +75,30 @@ module Datadog
               }.reject { |_, v| v.nil? }.to_json
             end
 
+            def additional_tags
+              base_ref = env["GITHUB_BASE_REF"]
+              return {} if base_ref.nil? || base_ref.empty?
+
+              # @type var result: Hash[String, String]
+              result = {
+                Git::TAG_PULL_REQUEST_BASE_BRANCH => base_ref
+              }
+
+              event_path = env["GITHUB_EVENT_PATH"]
+              event_json = JSON.parse(File.read(event_path))
+
+              head_sha = event_json.dig("pull_request", "head", "sha")
+              result[Git::TAG_COMMIT_HEAD_SHA] = head_sha if head_sha
+
+              base_sha = event_json.dig("pull_request", "base", "sha")
+              result[Git::TAG_PULL_REQUEST_BASE_BRANCH_SHA] = base_sha if base_sha
+
+              result
+            rescue => e
+              Datadog.logger.error("Failed to extract additional tags from GitHub Actions: #{e}")
+              {}
+            end
+
             private
 
             def github_server_url

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

@@ -20,6 +20,11 @@ module Datadog
         TAG_COMMIT_MESSAGE = "git.commit.message"
         TAG_COMMIT_SHA = "git.commit.sha"
 
+        # additional tags that we use for github actions jobs with "pull_request" target
+        TAG_COMMIT_HEAD_SHA = "git.commit.head_sha"
+        TAG_PULL_REQUEST_BASE_BRANCH = "git.pull_request.base_branch"
+        TAG_PULL_REQUEST_BASE_BRANCH_SHA = "git.pull_request.base_branch_sha"
+
         ENV_REPOSITORY_URL = "DD_GIT_REPOSITORY_URL"
         ENV_COMMIT_SHA = "DD_GIT_COMMIT_SHA"
         ENV_BRANCH = "DD_GIT_BRANCH"

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

@@ -64,6 +64,9 @@ module Datadog
         TAG_EARLY_FLAKE_ENABLED = "test.early_flake.enabled" # true if early flake detection is enabled
         TAG_EARLY_FLAKE_ABORT_REASON = "test.early_flake.abort_reason" # reason why early flake detection was aborted
 
+        # Tags for total code coverage
+        TAG_CODE_COVERAGE_LINES_PCT = "test.code_coverage.lines_pct"
+
         # internal APM tag to mark a span as a test span
         TAG_SPAN_KIND = "span.kind"
         SPAN_KIND_TEST = "test"

data/lib/datadog/ci/span.rb

@@ -190,6 +190,13 @@ module Datadog
         tracer_span.get_tag(Ext::Test::TAG_RUNTIME_VERSION)
       end
 
+      # Source file path where the test or test suite defined (relative to git repository root).
+      # @return [String] the source file path of the test
+      # @return [nil] if the source file path is not found
+      def source_file
+        get_tag(Ext::Test::TAG_SOURCE_FILE)
+      end
+
       def set_environment_runtime_tags
         tracer_span.set_tag(Ext::Test::TAG_OS_ARCHITECTURE, ::RbConfig::CONFIG["host_cpu"])
         tracer_span.set_tag(Ext::Test::TAG_OS_PLATFORM, ::RbConfig::CONFIG["host_os"])

data/lib/datadog/ci/test.rb

@@ -57,13 +57,6 @@ module Datadog
         get_tag(Ext::Test::TAG_TEST_SESSION_ID)
       end
 
-      # Source file path of the test relative to git repository root.
-      # @return [String] the source file path of the test
-      # @return [nil] if the source file path is not found
-      def source_file
-        get_tag(Ext::Test::TAG_SOURCE_FILE)
-      end
-
       # Returns "true" if the test is skipped by the intelligent test runner.
       # @return [Boolean] true if the test is skipped by the intelligent test runner, false otherwise.
       def skipped_by_itr?

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

@@ -4,6 +4,7 @@ require "rbconfig"
 
 require_relative "context"
 require_relative "telemetry"
+require_relative "total_coverage"
 
 require_relative "../codeowners/parser"
 require_relative "../contrib/contrib"
@@ -166,6 +167,8 @@ module Datadog
         end
 
         def on_test_suite_started(test_suite)
+          set_codeowners(test_suite)
+
           Telemetry.event_created(test_suite)
         end
 
@@ -186,6 +189,8 @@ module Datadog
         def on_test_session_finished(test_session)
           test_optimisation.write_test_session_tags(test_session)
 
+          TotalCoverage.extract_lines_pct(test_session)
+
           Telemetry.event_finished(test_session)
         end
 
@@ -223,10 +228,10 @@ module Datadog
           end
         end
 
-        def set_codeowners(test)
-          source = test.source_file
+        def set_codeowners(span)
+          source = span.source_file
           owners = @codeowners.list_owners(source) if source
-          test.set_tag(Ext::Test::TAG_CODEOWNERS, owners) unless owners.nil?
+          span.set_tag(Ext::Test::TAG_CODEOWNERS, owners) unless owners.nil?
         end
 
         def fix_test_suite!(test)

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "../ext/test"
+
+module Datadog
+  module CI
+    module TestVisibility
+      module TotalCoverage
+        def self.extract_lines_pct(test_session)
+          unless defined?(::SimpleCov)
+            Datadog.logger.debug("SimpleCov is not loaded, skipping code coverage extraction")
+            return
+          end
+
+          unless ::SimpleCov.running
+            Datadog.logger.debug("SimpleCov is not running, skipping code coverage extraction")
+            return
+          end
+
+          unless ::SimpleCov.respond_to?(:__dd_peek_result)
+            Datadog.logger.debug("SimpleCov is not patched, skipping code coverage extraction")
+            return
+          end
+
+          result = ::SimpleCov.__dd_peek_result
+          unless result
+            Datadog.logger.debug("SimpleCov result is nil, skipping code coverage extraction")
+            return
+          end
+
+          test_session.set_tag(Ext::Test::TAG_CODE_COVERAGE_LINES_PCT, result.covered_percent)
+        end
+      end
+    end
+  end
+end

data/lib/datadog/ci/version.rb

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

data/lib/datadog/ci.rb

@@ -410,6 +410,7 @@ require_relative "ci/contrib/cucumber/integration"
 require_relative "ci/contrib/rspec/integration"
 require_relative "ci/contrib/minitest/integration"
 require_relative "ci/contrib/selenium/integration"
+require_relative "ci/contrib/simplecov/integration"
 
 # Configuration extensions
 require_relative "ci/configuration/extensions"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: datadog-ci
 version: !ruby/object:Gem::Version
-  version: 1.6.0
+  version: 1.7.0
 platform: ruby
 authors:
 - Datadog, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-09-20 00:00:00.000000000 Z
+date: 2024-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: datadog
@@ -103,6 +103,11 @@ files:
 - lib/datadog/ci/contrib/selenium/patcher.rb
 - lib/datadog/ci/contrib/selenium/rum.rb
 - lib/datadog/ci/contrib/settings.rb
+- lib/datadog/ci/contrib/simplecov/configuration/settings.rb
+- lib/datadog/ci/contrib/simplecov/ext.rb
+- lib/datadog/ci/contrib/simplecov/integration.rb
+- 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/environment.rb
 - lib/datadog/ci/ext/environment/extractor.rb
@@ -179,6 +184,7 @@ files:
 - lib/datadog/ci/test_visibility/store/global.rb
 - lib/datadog/ci/test_visibility/store/local.rb
 - lib/datadog/ci/test_visibility/telemetry.rb
+- lib/datadog/ci/test_visibility/total_coverage.rb
 - lib/datadog/ci/test_visibility/transport.rb
 - lib/datadog/ci/transport/adapters/net.rb
 - lib/datadog/ci/transport/adapters/net_http_client.rb