datadog-ci 1.0.0.beta1 → 1.0.0.beta3

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

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
 require_relative "../../ext/test"
-require_relative "../../utils/git"
+require_relative "../../git/local_repository"
+require_relative "../../utils/test_run"
 require_relative "ext"
 
 module Datadog
@@ -55,13 +56,18 @@ module Datadog
           def on_test_case_started(event)
             test_suite_name = test_suite_name(event.test_case)
 
+            # @type var tags: Hash[String, String]
             tags = {
               CI::Ext::Test::TAG_FRAMEWORK => Ext::FRAMEWORK,
               CI::Ext::Test::TAG_FRAMEWORK_VERSION => CI::Contrib::Cucumber::Integration.version.to_s,
-              CI::Ext::Test::TAG_SOURCE_FILE => Utils::Git.relative_to_root(event.test_case.location.file),
+              CI::Ext::Test::TAG_SOURCE_FILE => Git::LocalRepository.relative_to_root(event.test_case.location.file),
               CI::Ext::Test::TAG_SOURCE_START => event.test_case.location.line.to_s
             }
 
+            if (parameters = extract_parameters_hash(event.test_case))
+              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)
 
             test_span = CI.start_test(
@@ -70,9 +76,8 @@ module Datadog
               tags: tags,
               service: configuration[:service_name]
             )
-
-            if (parameters = extract_parameters_hash(event.test_case))
-              test_span&.set_parameters(parameters)
+            if event.test_case.match_tags?("@#{CI::Ext::Test::ITR_UNSKIPPABLE_OPTION}")
+              test_span&.itr_unskippable!
             end
           end
 

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

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
 require "datadog/tracing/contrib/patcher"
+
 require_relative "instrumentation"
+require_relative "step"
 
 module Datadog
   module CI
@@ -19,6 +21,7 @@ module Datadog
 
           def patch
             ::Cucumber::Runtime.include(Instrumentation)
+            ::Cucumber::Core::Test::Step.include(Datadog::CI::Contrib::Cucumber::Step)
           end
         end
       end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Datadog
+  module CI
+    module Contrib
+      module Cucumber
+        # instruments Cucumber::Core::Test::Step from cucumber-ruby-core to change
+        module Step
+          def self.included(base)
+            base.prepend(InstanceMethods)
+          end
+
+          module InstanceMethods
+            def execute(*args)
+              test_span = CI.active_test
+              if test_span&.skipped_by_itr?
+                @action.skip(*args)
+              else
+                super
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,7 +1,8 @@
 # frozen_string_literal: true
 
 require_relative "../../ext/test"
-require_relative "../../utils/git"
+require_relative "../../git/local_repository"
+require_relative "../../utils/test_run"
 require_relative "ext"
 
 module Datadog
@@ -41,14 +42,19 @@ module Datadog
                 tags: {
                   CI::Ext::Test::TAG_FRAMEWORK => Ext::FRAMEWORK,
                   CI::Ext::Test::TAG_FRAMEWORK_VERSION => CI::Contrib::RSpec::Integration.version.to_s,
-                  CI::Ext::Test::TAG_SOURCE_FILE => Utils::Git.relative_to_root(metadata[:file_path]),
-                  CI::Ext::Test::TAG_SOURCE_START => metadata[:line_number].to_s
+                  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,
+                  CI::Ext::Test::TAG_PARAMETERS => Utils::TestRun.test_parameters(
+                    metadata: {"scoped_id" => metadata[:scoped_id]}
+                  )
                 },
                 service: datadog_configuration[:service_name]
               ) do |test_span|
-                result = super
+                test_span&.itr_unskippable! if metadata[CI::Ext::Test::ITR_UNSKIPPABLE_OPTION]
 
-                test_span&.set_parameters({}, {"scoped_id" => metadata[:scoped_id]})
+                metadata[:skip] = CI::Ext::Test::ITR_TEST_SKIP_REASON if test_span&.skipped_by_itr?
+
+                result = super
 
                 case execution_result.status
                 when :passed

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

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "base"
-require_relative "../../../utils/git"
+require_relative "../../../git/local_repository"
 
 module Datadog
   module CI
@@ -11,48 +11,23 @@ module Datadog
           # As a fallback we try to fetch git information from the local git repository
           class LocalGit < Base
             def git_repository_url
-              Utils::Git.exec_git_command("git ls-remote --get-url")
-            rescue => e
-              Datadog.logger.debug(
-                "Unable to read git repository url: #{e.class.name} #{e.message} at #{Array(e.backtrace).first}"
-              )
-              nil
+              CI::Git::LocalRepository.git_repository_url
             end
 
             def git_commit_sha
-              Utils::Git.exec_git_command("git rev-parse HEAD")
-            rescue => e
-              Datadog.logger.debug(
-                "Unable to read git commit SHA: #{e.class.name} #{e.message} at #{Array(e.backtrace).first}"
-              )
-              nil
+              CI::Git::LocalRepository.git_commit_sha
             end
 
             def git_branch
-              Utils::Git.exec_git_command("git rev-parse --abbrev-ref HEAD")
-            rescue => e
-              Datadog.logger.debug(
-                "Unable to read git branch: #{e.class.name} #{e.message} at #{Array(e.backtrace).first}"
-              )
-              nil
+              CI::Git::LocalRepository.git_branch
             end
 
             def git_tag
-              Utils::Git.exec_git_command("git tag --points-at HEAD")
-            rescue => e
-              Datadog.logger.debug(
-                "Unable to read git tag: #{e.class.name} #{e.message} at #{Array(e.backtrace).first}"
-              )
-              nil
+              CI::Git::LocalRepository.git_tag
             end
 
             def git_commit_message
-              Utils::Git.exec_git_command("git show -s --format=%s")
-            rescue => e
-              Datadog.logger.debug(
-                "Unable to read git commit message: #{e.class.name} #{e.message} at #{Array(e.backtrace).first}"
-              )
-              nil
+              CI::Git::LocalRepository.git_commit_message
             end
 
             def git_commit_author_name
@@ -80,12 +55,7 @@ module Datadog
             end
 
             def workspace_path
-              Utils::Git.exec_git_command("git rev-parse --show-toplevel")
-            rescue => e
-              Datadog.logger.debug(
-                "Unable to read git base directory: #{e.class.name} #{e.message} at #{Array(e.backtrace).first}"
-              )
-              nil
+              CI::Git::LocalRepository.git_root
             end
 
             private
@@ -105,48 +75,7 @@ module Datadog
             end
 
             def set_git_commit_users
-              # Get committer and author information in one command.
-              output = Utils::Git.exec_git_command("git show -s --format='%an\t%ae\t%at\t%cn\t%ce\t%ct'")
-              unless output
-                Datadog.logger.debug(
-                  "Unable to read git commit users: git command output is nil"
-                )
-                @author = @committer = NilUser.new
-                return
-              end
-
-              author_name, author_email, author_timestamp,
-                committer_name, committer_email, committer_timestamp = output.split("\t").each(&:strip!)
-
-              @author = GitUser.new(author_name, author_email, author_timestamp)
-              @committer = GitUser.new(committer_name, committer_email, committer_timestamp)
-            rescue => e
-              Datadog.logger.debug(
-                "Unable to read git commit users: #{e.class.name} #{e.message} at #{Array(e.backtrace).first}"
-              )
-              @author = @committer = NilUser.new
-            end
-
-            class GitUser
-              attr_reader :name, :email, :timestamp
-
-              def initialize(name, email, timestamp)
-                @name = name
-                @email = email
-                @timestamp = timestamp
-              end
-
-              def date
-                return nil if timestamp.nil?
-
-                Time.at(timestamp.to_i).utc.to_datetime.iso8601
-              end
-            end
-
-            class NilUser < GitUser
-              def initialize
-                super(nil, nil, nil)
-              end
+              @author, @committer = CI::Git::LocalRepository.git_commit_users
             end
           end
         end

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

@@ -3,6 +3,8 @@
 require_relative "git"
 require_relative "environment/extractor"
 
+require_relative "../utils/git"
+
 module Datadog
   module CI
     module Ext
@@ -21,8 +23,6 @@ module Datadog
         TAG_NODE_NAME = "ci.node.name"
         TAG_CI_ENV_VARS = "_dd.ci.env_vars"
 
-        HEX_NUMBER_REGEXP = /[0-9a-f]{40}/i.freeze
-
         module_function
 
         def tags(env)
@@ -57,24 +57,19 @@ module Datadog
         end
 
         def validate_git_sha(git_sha)
-          message = "DD_GIT_COMMIT_SHA must be a full-length git SHA."
+          return if Utils::Git.valid_commit_sha?(git_sha)
 
-          if git_sha.nil? || git_sha.empty?
-            message += " No value was set and no SHA was automatically extracted."
-            Datadog.logger.error(message)
-            return
-          end
+          message = "DD_GIT_COMMIT_SHA must be a full-length git SHA."
 
-          if git_sha.length < Git::SHA_LENGTH
-            message += " Expected SHA length #{Git::SHA_LENGTH}, was #{git_sha.length}."
-            Datadog.logger.error(message)
-            return
+          message += if git_sha.nil? || git_sha.empty?
+            " No value was set and no SHA was automatically extracted."
+          elsif git_sha.length < Git::SHA_LENGTH
+            " Expected SHA length #{Git::SHA_LENGTH}, was #{git_sha.length}."
+          else
+            " Expected SHA to be a valid HEX number, got #{git_sha}."
           end
 
-          unless HEX_NUMBER_REGEXP.match?(git_sha)
-            message += " Expected SHA to be a valid HEX number, got #{git_sha}."
-            Datadog.logger.error(message)
-          end
+          Datadog.logger.error(message)
         end
       end
     end

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

@@ -11,6 +11,7 @@ module Datadog
         ENV_EXPERIMENTAL_TEST_SUITE_LEVEL_VISIBILITY_ENABLED = "DD_CIVISIBILITY_EXPERIMENTAL_TEST_SUITE_LEVEL_VISIBILITY_ENABLED"
         ENV_FORCE_TEST_LEVEL_VISIBILITY = "DD_CIVISIBILITY_FORCE_TEST_LEVEL_VISIBILITY"
         ENV_ITR_ENABLED = "DD_CIVISIBILITY_ITR_ENABLED"
+        ENV_GIT_METADATA_UPLOAD_ENABLED = "DD_CIVISIBILITY_GIT_METADATA_UPLOAD_ENABLED"
 
         # Source: https://docs.datadoghq.com/getting_started/site/
         DD_SITE_ALLOWLIST = [

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"
@@ -26,6 +25,11 @@ module Datadog
         # ITR tags
         TAG_ITR_TEST_SKIPPING_ENABLED = "test.itr.tests_skipping.enabled"
         TAG_ITR_TEST_SKIPPING_TYPE = "test.itr.tests_skipping.type"
+        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"
@@ -43,6 +47,7 @@ module Datadog
         # Environment runtime tags
         TAG_OS_ARCHITECTURE = "os.architecture"
         TAG_OS_PLATFORM = "os.platform"
+        TAG_OS_VERSION = "os.version"
         TAG_RUNTIME_NAME = "runtime.name"
         TAG_RUNTIME_VERSION = "runtime.version"
 
@@ -53,6 +58,8 @@ module Datadog
         # could be either "test" or "suite" depending on whether we skip individual tests or whole suites
         # 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/ext/transport.rb

@@ -27,6 +27,7 @@ module Datadog
         TEST_COVERAGE_INTAKE_PATH = "/api/v2/citestcov"
 
         DD_API_HOST_PREFIX = "api"
+
         DD_API_SETTINGS_PATH = "/api/v2/libraries/tests/services/setting"
         DD_API_SETTINGS_TYPE = "ci_app_test_service_libraries_settings"
         DD_API_SETTINGS_RESPONSE_DIG_KEYS = %w[data attributes].freeze
@@ -36,6 +37,13 @@ module Datadog
         DD_API_SETTINGS_RESPONSE_REQUIRE_GIT_KEY = "require_git"
         DD_API_SETTINGS_RESPONSE_DEFAULT = {DD_API_SETTINGS_RESPONSE_ITR_ENABLED_KEY => false}.freeze
 
+        DD_API_GIT_SEARCH_COMMITS_PATH = "/api/v2/git/repository/search_commits"
+
+        DD_API_GIT_UPLOAD_PACKFILE_PATH = "/api/v2/git/repository/packfile"
+
+        DD_API_SKIPPABLE_TESTS_PATH = "/api/v2/ci/tests/skippable"
+        DD_API_SKIPPABLE_TESTS_TYPE = "test_params"
+
         CONTENT_TYPE_MESSAGEPACK = "application/msgpack"
         CONTENT_TYPE_JSON = "application/json"
         CONTENT_TYPE_MULTIPART_FORM_DATA = "multipart/form-data"