datadog-ci 1.20.2 → 1.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4d52c09221c7fbde835ed3db436baf1ffe998903eaff32f3ea9c6c463d4d67e6
-  data.tar.gz: f1445fdbb0e305050d3340e099113b12077a3b9323029fc7b5c524b936eb478b
+  metadata.gz: e7fac7df8bd20e5c52ea01bfe200854a7d2ad85454b60b9bad429d43527074b1
+  data.tar.gz: 6763a5ac2a1f6c5dafbec6a1f3ed95f3eccfbd8e66b009b115dcae82ff6b62c8
 SHA512:
-  metadata.gz: 06f3c204a01fbb5c73560cd9eca6af94d8b01a9142fa464ca3d65f77c6a1ec375ddc0ec3045d510dae0b7afa0b59f842c5548d62265036e574f540d74c676bcf
-  data.tar.gz: '08eaeb1b1f58ac8f27d93f83ec011c87d5d706498cd546b27335448ef9dcba2c2ed51fbc72c73799ae114ff5545cae487c3db760961f1f1051a838b60da75383'
+  metadata.gz: e1fefe3b31fff717f7df05fe2399459b2db086380c78cc7f27d7211cc082b804723d83cc0617c00c8851b8389205aa511d07ba09d67871de2bb1d38b67498b38
+  data.tar.gz: 8eac96f33d23410db16c0199aa0b4bd28237b6f1e9eac087dde993db4a14c309017fe92592071e5c67718f7c2a7b2ce7e773b39cd7a643860a4898135381cb3f

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## [Unreleased]
 
+## [1.21.0] - 2025-07-14
+
+### Added
+
+* Support automated flaky test fixing flow for Github Action jobs with pull_request trigger ([#370][])
+
 ## [1.20.2] - 2025-07-04
 
 ### Fixed
@@ -486,7 +492,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.20.2...main
+[Unreleased]: https://github.com/DataDog/datadog-ci-rb/compare/v1.21.0...main
+[1.21.0]: https://github.com/DataDog/datadog-ci-rb/compare/v1.20.2...v1.21.0
 [1.20.2]: https://github.com/DataDog/datadog-ci-rb/compare/v1.20.1...v1.20.2
 [1.20.1]: https://github.com/DataDog/datadog-ci-rb/compare/v1.20.0...v1.20.1
 [1.20.0]: https://github.com/DataDog/datadog-ci-rb/compare/v1.19.0...v1.20.0
@@ -690,4 +697,5 @@ Currently test suite level visibility is not used by our instrumentation: it wil
 [#349]: https://github.com/DataDog/datadog-ci-rb/issues/349
 [#355]: https://github.com/DataDog/datadog-ci-rb/issues/355
 [#359]: https://github.com/DataDog/datadog-ci-rb/issues/359
-[#366]: https://github.com/DataDog/datadog-ci-rb/issues/366
+[#366]: https://github.com/DataDog/datadog-ci-rb/issues/366
+[#370]: https://github.com/DataDog/datadog-ci-rb/issues/370

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

@@ -36,22 +36,31 @@ module Datadog
               Environment::TAG_NODE_NAME => @provider.node_name,
               Environment::TAG_CI_ENV_VARS => @provider.ci_env_vars,
 
-              Git::TAG_BRANCH => @provider.git_branch,
               Git::TAG_REPOSITORY_URL => @provider.git_repository_url,
+              Git::TAG_BRANCH => @provider.git_branch,
               Git::TAG_TAG => @provider.git_tag,
+
+              Git::TAG_COMMIT_SHA => @provider.git_commit_sha,
+              Git::TAG_COMMIT_MESSAGE => @provider.git_commit_message,
               Git::TAG_COMMIT_AUTHOR_DATE => @provider.git_commit_author_date,
               Git::TAG_COMMIT_AUTHOR_EMAIL => @provider.git_commit_author_email,
               Git::TAG_COMMIT_AUTHOR_NAME => @provider.git_commit_author_name,
               Git::TAG_COMMIT_COMMITTER_DATE => @provider.git_commit_committer_date,
               Git::TAG_COMMIT_COMMITTER_EMAIL => @provider.git_commit_committer_email,
               Git::TAG_COMMIT_COMMITTER_NAME => @provider.git_commit_committer_name,
-              Git::TAG_COMMIT_MESSAGE => @provider.git_commit_message,
-              Git::TAG_COMMIT_SHA => @provider.git_commit_sha,
+
               Git::TAG_PULL_REQUEST_BASE_BRANCH => @provider.git_pull_request_base_branch,
               Git::TAG_PULL_REQUEST_BASE_BRANCH_SHA => @provider.git_pull_request_base_branch_sha,
-              Git::TAG_COMMIT_HEAD_SHA => @provider.git_commit_head_sha,
+              Environment::TAG_PR_NUMBER => @provider.pr_number,
 
-              Environment::TAG_PR_NUMBER => @provider.pr_number
+              Git::TAG_COMMIT_HEAD_SHA => @provider.git_commit_head_sha,
+              Git::TAG_COMMIT_HEAD_MESSAGE => @provider.git_commit_head_message,
+              Git::TAG_COMMIT_HEAD_AUTHOR_DATE => @provider.git_commit_head_author_date,
+              Git::TAG_COMMIT_HEAD_AUTHOR_EMAIL => @provider.git_commit_head_author_email,
+              Git::TAG_COMMIT_HEAD_AUTHOR_NAME => @provider.git_commit_head_author_name,
+              Git::TAG_COMMIT_HEAD_COMMITTER_DATE => @provider.git_commit_head_committer_date,
+              Git::TAG_COMMIT_HEAD_COMMITTER_EMAIL => @provider.git_commit_head_committer_email,
+              Git::TAG_COMMIT_HEAD_COMMITTER_NAME => @provider.git_commit_head_committer_name
             }
 
             # Normalize Git references and filter sensitive data

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

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require_relative "../../../git/local_repository"
+
 module Datadog
   module CI
     module Ext
@@ -105,6 +107,27 @@ module Datadog
             def git_commit_head_sha
             end
 
+            def git_commit_head_message
+            end
+
+            def git_commit_head_author_date
+            end
+
+            def git_commit_head_author_email
+            end
+
+            def git_commit_head_author_name
+            end
+
+            def git_commit_head_committer_date
+            end
+
+            def git_commit_head_committer_email
+            end
+
+            def git_commit_head_committer_name
+            end
+
             def pr_number
             end
 

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

@@ -31,27 +31,57 @@ module Datadog
             end
 
             def git_commit_author_name
-              author.name
+              author&.name
             end
 
             def git_commit_author_email
-              author.email
+              author&.email
             end
 
             def git_commit_author_date
-              author.date
+              author&.date
             end
 
             def git_commit_committer_name
-              committer.name
+              committer&.name
             end
 
             def git_commit_committer_email
-              committer.email
+              committer&.email
             end
 
             def git_commit_committer_date
-              committer.date
+              committer&.date
+            end
+
+            def git_commit_head_message
+              return nil if head_commit_sha_from_env.nil?
+
+              CI::Git::LocalRepository.git_commit_message(head_commit_sha_from_env)
+            end
+
+            def git_commit_head_author_date
+              head_author&.date
+            end
+
+            def git_commit_head_author_email
+              head_author&.email
+            end
+
+            def git_commit_head_author_name
+              head_author&.name
+            end
+
+            def git_commit_head_committer_date
+              head_committer&.date
+            end
+
+            def git_commit_head_committer_email
+              head_committer&.email
+            end
+
+            def git_commit_head_committer_name
+              head_committer&.name
             end
 
             def workspace_path
@@ -74,8 +104,30 @@ module Datadog
               @committer
             end
 
+            def head_author
+              return @head_author if defined?(@head_author)
+
+              set_git_commit_users
+              @head_author
+            end
+
+            def head_committer
+              return @head_committer if defined?(@head_committer)
+
+              set_git_commit_users
+              @head_committer
+            end
+
             def set_git_commit_users
               @author, @committer = CI::Git::LocalRepository.git_commit_users
+
+              return if head_commit_sha_from_env.nil?
+
+              @head_author, @head_committer = CI::Git::LocalRepository.git_commit_users(head_commit_sha_from_env)
+            end
+
+            def head_commit_sha_from_env
+              @head_commit_sha_from_env ||= env[Ext::Environment::ENV_SPECIAL_KEY_FOR_GIT_COMMIT_HEAD_SHA]
             end
           end
         end

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

@@ -47,6 +47,8 @@ module Datadog
 
         POSSIBLE_BUNDLE_LOCATIONS = %w[vendor/bundle .bundle].freeze
 
+        ENV_SPECIAL_KEY_FOR_GIT_COMMIT_HEAD_SHA = "_dd.ci.environment.git_commit_head_sha"
+
         module_function
 
         def tags(env)
@@ -57,6 +59,22 @@ module Datadog
           user_provided_tags = Environment::Extractor.new(env, provider_klass: Providers::UserDefinedTags).tags
           tags.merge!(user_provided_tags)
 
+          # NOTE: we need to provide head commit sha as part of the environment if it was discovered from provider.
+          #
+          # This info will be later used by LocalGit provider to extract commit message and user info for head commit.
+          # It is useful for CI providers that run jobs on artificial merge commits instead of a head commit of a
+          # feature branch.
+          #
+          # NOTE 2: when we discover that head commit sha exists it means that we are running on an artificial merge
+          # commit created by CI provider. Most likely we also operate on a shallow clone of a repo - in this case
+          # we need to unshallow at least the parent of the current merge commit to be able to extract information
+          # from the real original commit.
+          if tags[Git::TAG_COMMIT_HEAD_SHA]
+            CI::Git::LocalRepository.git_unshallow(parent_only: true) if CI::Git::LocalRepository.git_shallow_clone?
+
+            env[ENV_SPECIAL_KEY_FOR_GIT_COMMIT_HEAD_SHA] = tags[Git::TAG_COMMIT_HEAD_SHA]
+          end
+
           # Fill out tags from local git as fallback
           local_git_tags = Environment::Extractor.new(env, provider_klass: Providers::LocalGit).tags
           local_git_tags.each do |key, value|

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

@@ -21,10 +21,18 @@ module Datadog
         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"
 
+        TAG_COMMIT_HEAD_SHA = "git.commit.head.sha"
+        TAG_COMMIT_HEAD_MESSAGE = "git.commit.head.message"
+        TAG_COMMIT_HEAD_AUTHOR_DATE = "git.commit.head.author.date"
+        TAG_COMMIT_HEAD_AUTHOR_EMAIL = "git.commit.head.author.email"
+        TAG_COMMIT_HEAD_AUTHOR_NAME = "git.commit.head.author.name"
+        TAG_COMMIT_HEAD_COMMITTER_DATE = "git.commit.head.committer.date"
+        TAG_COMMIT_HEAD_COMMITTER_EMAIL = "git.commit.head.committer.email"
+        TAG_COMMIT_HEAD_COMMITTER_NAME = "git.commit.head.committer.name"
+
         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

@@ -95,7 +95,7 @@ module Datadog
             AUTO_TEST_RETRIES_VERSION = "1"
             TEST_MANAGEMENT_QUARANTINE_VERSION = "1"
             TEST_MANAGEMENT_DISABLE_VERSION = "1"
-            TEST_MANAGEMENT_ATTEMPT_TO_FIX_VERSION = "4"
+            TEST_MANAGEMENT_ATTEMPT_TO_FIX_VERSION = "5"
           end
 
           # Map of capabilities to their versions

data/lib/datadog/ci/git/base_branch_sha_detection/guesser.rb

@@ -3,8 +3,6 @@
 require_relative "base"
 require_relative "branch_metric"
 
-require_relative "../local_repository"
-
 module Datadog
   module CI
     module Git

data/lib/datadog/ci/git/base_branch_sha_detection/merge_base_extractor.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require_relative "base"
-require_relative "../local_repository"
 
 module Datadog
   module CI

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

@@ -143,16 +143,16 @@ module Datadog
           nil
         end
 
-        def self.git_commit_message
-          CLI.exec_git_command(["log", "-n", "1", "--format=%B"])
+        def self.git_commit_message(commit_sha = nil)
+          CLI.exec_git_command(["log", "-n", "1", "--format=%B", commit_sha].compact)
         rescue => e
           log_failure(e, "git commit message")
           nil
         end
 
-        def self.git_commit_users
+        def self.git_commit_users(commit_sha = nil)
           # Get committer and author information in one command.
-          output = CLI.exec_git_command(["show", "-s", "--format=%an\t%ae\t%at\t%cn\t%ce\t%ct"])
+          output = CLI.exec_git_command(["show", "-s", "--format=%an\t%ae\t%at\t%cn\t%ce\t%ct", commit_sha].compact)
           unless output
             Datadog.logger.debug(
               "Unable to read git commit users: git command output is nil"
@@ -268,7 +268,7 @@ module Datadog
           false
         end
 
-        def self.git_unshallow
+        def self.git_unshallow(parent_only: false)
           Telemetry.git_command(Ext::Telemetry::Command::UNSHALLOW)
           # @type var res: String?
           res = nil
@@ -289,10 +289,11 @@ module Datadog
 
               res =
                 begin
+                  unshallowing_depth = parent_only ? "--deepen=1" : "--shallow-since=\"1 month ago\""
                   # @type var cmd: Array[String]
                   cmd = [
                     "fetch",
-                    "--shallow-since=\"1 month ago\"",
+                    unshallowing_depth,
                     "--update-shallow",
                     "--filter=blob:none",
                     "--recurse-submodules=no",

data/lib/datadog/ci/span.rb

@@ -165,6 +165,30 @@ module Datadog
         tracer_span.get_tag(Ext::Git::TAG_COMMIT_SHA)
       end
 
+      # Returns the git commit message extracted from the environment.
+      # @return [String] the commit message.
+      def git_commit_message
+        get_tag(Ext::Git::TAG_COMMIT_MESSAGE)
+      end
+
+      # Returns the original last git commit SHA extracted from the environment.
+      # Original here means that it is the last commit that was pushed by the user,
+      # not the artifical merge commit created by CI provider
+      #
+      # @return [String] the commit SHA of the last commit.
+      def original_git_commit_sha
+        get_tag(Ext::Git::TAG_COMMIT_HEAD_SHA) || git_commit_sha
+      end
+
+      # Returns the original last git commit message extracted from the environment.
+      # Original here means that it is the last commit that was pushed by the user,
+      # not the artifical merge commit created by CI provider
+      #
+      # @return [String] the commit message of the last commit.
+      def original_git_commit_message
+        get_tag(Ext::Git::TAG_COMMIT_HEAD_MESSAGE) || git_commit_message
+      end
+
       # Returns the git branch name extracted from the environment.
       # @return [String] the branch.
       def git_branch

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

@@ -118,8 +118,8 @@ module Datadog
               "type" => Ext::Transport::DD_API_TEST_MANAGEMENT_TESTS_TYPE,
               "attributes" => {
                 "repository_url" => test_session.git_repository_url,
-                "commit_message" => test_session.git_commit_message,
-                "sha" => test_session.git_commit_sha
+                "commit_message" => test_session.original_git_commit_message,
+                "sha" => test_session.original_git_commit_sha
               }
             }
           }.to_json

data/lib/datadog/ci/test_session.rb

@@ -46,12 +46,6 @@ module Datadog
         get_tag(Ext::Environment::TAG_JOB_NAME)
       end
 
-      # Returns the git commit message extracted from the environment.
-      # @return [String] the commit message.
-      def git_commit_message
-        get_tag(Ext::Git::TAG_COMMIT_MESSAGE)
-      end
-
       def skipping_tests?
         get_tag(Ext::Test::TAG_ITR_TEST_SKIPPING_ENABLED) == "true"
       end

data/lib/datadog/ci/version.rb

@@ -4,8 +4,8 @@ module Datadog
   module CI
     module VERSION
       MAJOR = 1
-      MINOR = 20
-      PATCH = 2
+      MINOR = 21
+      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.20.2
+  version: 1.21.0
 platform: ruby
 authors:
 - Datadog, Inc.