datadog-ci 0.6.0 → 0.8.0

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

@@ -1,9 +1,7 @@
 # frozen_string_literal: true
 
-require "open3"
-
 require_relative "base"
-require_relative "../../git"
+require_relative "../../../utils/git"
 
 module Datadog
   module CI
@@ -13,7 +11,7 @@ module Datadog
           # As a fallback we try to fetch git information from the local git repository
           class LocalGit < Base
             def git_repository_url
-              exec_git_command("git ls-remote --get-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}"
@@ -22,7 +20,7 @@ module Datadog
             end
 
             def git_commit_sha
-              exec_git_command("git rev-parse HEAD")
+              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}"
@@ -31,7 +29,7 @@ module Datadog
             end
 
             def git_branch
-              exec_git_command("git rev-parse --abbrev-ref HEAD")
+              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}"
@@ -40,7 +38,7 @@ module Datadog
             end
 
             def git_tag
-              exec_git_command("git tag --points-at HEAD")
+              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}"
@@ -49,7 +47,7 @@ module Datadog
             end
 
             def git_commit_message
-              exec_git_command("git show -s --format=%s")
+              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}"
@@ -82,7 +80,7 @@ module Datadog
             end
 
             def workspace_path
-              exec_git_command("git rev-parse --show-toplevel")
+              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}"
@@ -92,25 +90,6 @@ module Datadog
 
             private
 
-            def exec_git_command(cmd)
-              out, status = Open3.capture2e(cmd)
-
-              raise "Failed to run git command #{cmd}: #{out}" unless status.success?
-
-              # Sometimes Encoding.default_external is somehow set to US-ASCII which breaks
-              # commit messages with UTF-8 characters like emojis
-              # We force output's encoding to be UTF-8 in this case
-              # This is safe to do as UTF-8 is compatible with US-ASCII
-              if Encoding.default_external == Encoding::US_ASCII
-                out = out.force_encoding(Encoding::UTF_8)
-              end
-              out.strip! # There's always a "\n" at the end of the command output
-
-              return nil if out.empty?
-
-              out
-            end
-
             def author
               return @author if defined?(@author)
 
@@ -127,7 +106,7 @@ module Datadog
 
             def set_git_commit_users
               # Get committer and author information in one command.
-              output = exec_git_command("git show -s --format='%an\t%ae\t%at\t%cn\t%ce\t%ct'")
+              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"

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

@@ -9,6 +9,8 @@ module Datadog
         ENV_AGENTLESS_MODE_ENABLED = "DD_CIVISIBILITY_AGENTLESS_ENABLED"
         ENV_AGENTLESS_URL = "DD_CIVISIBILITY_AGENTLESS_URL"
         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"
 
         # Source: https://docs.datadoghq.com/getting_started/site/
         DD_SITE_ALLOWLIST = [

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

@@ -12,24 +12,33 @@ module Datadog
         TAG_FRAMEWORK = "test.framework"
         TAG_FRAMEWORK_VERSION = "test.framework_version"
         TAG_NAME = "test.name"
-        TAG_SKIP_REASON = "test.skip_reason" # DEV: Not populated yet
+        TAG_SKIP_REASON = "test.skip_reason"
         TAG_STATUS = "test.status"
         TAG_SUITE = "test.suite"
         TAG_MODULE = "test.module"
-        TAG_TRAITS = "test.traits"
         TAG_TYPE = "test.type"
         TAG_COMMAND = "test.command"
+        TAG_SOURCE_FILE = "test.source.file"
+        TAG_SOURCE_START = "test.source.start"
+        TAG_CODEOWNERS = "test.codeowners"
+        TAG_PARAMETERS = "test.parameters"
 
-        TEST_TYPE = "test"
+        # ITR tags
+        TAG_ITR_TEST_SKIPPING_ENABLED = "test.itr.tests_skipping.enabled"
+        TAG_ITR_TEST_SKIPPING_TYPE = "test.itr.tests_skipping.type"
 
-        # those tags are special and they are used to correlate tests with the test sessions, suites, and modules
+        # Code coverage tags
+        TAG_CODE_COVERAGE_ENABLED = "test.code_coverage.enabled"
+
+        # those tags are special and used to correlate tests with the test sessions, suites, and modules
+        # they are transient and not sent to the backend
         TAG_TEST_SESSION_ID = "_test.session_id"
         TAG_TEST_MODULE_ID = "_test.module_id"
         TAG_TEST_SUITE_ID = "_test.suite_id"
-        SPECIAL_TAGS = [TAG_TEST_SESSION_ID, TAG_TEST_MODULE_ID, TAG_TEST_SUITE_ID].freeze
+        TRANSIENT_TAGS = [TAG_TEST_SESSION_ID, TAG_TEST_MODULE_ID, TAG_TEST_SUITE_ID].freeze
 
-        # tags that can be inherited from the test session
-        INHERITABLE_TAGS = [TAG_FRAMEWORK, TAG_FRAMEWORK_VERSION, TAG_TYPE].freeze
+        # tags that are common for the whole session and can be inherited from the test session
+        INHERITABLE_TAGS = [TAG_FRAMEWORK, TAG_FRAMEWORK_VERSION].freeze
 
         # Environment runtime tags
         TAG_OS_ARCHITECTURE = "os.architecture"
@@ -37,13 +46,26 @@ module Datadog
         TAG_RUNTIME_NAME = "runtime.name"
         TAG_RUNTIME_VERSION = "runtime.version"
 
+        # internal APM tag to mark a span as a test span
         TAG_SPAN_KIND = "span.kind"
+        SPAN_KIND_TEST = "test"
+
+        # 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"
 
+        # test status as recognized by Datadog
         module Status
           PASS = "pass"
           FAIL = "fail"
           SKIP = "skip"
         end
+
+        # test types (e.g. test, benchmark, browser)
+        module Type
+          TEST = "test"
+          BENCHMARK = "benchmark" # DEV: not used yet, will be used when benchmarks are supported
+        end
       end
     end
   end

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

@@ -12,11 +12,29 @@ module Datadog
         HEADER_EVP_SUBDOMAIN = "X-Datadog-EVP-Subdomain"
         HEADER_CONTAINER_ID = "Datadog-Container-ID"
 
-        EVP_PROXY_PATH_PREFIX = "/evp_proxy/v2/"
+        EVP_PROXY_V2_PATH_PREFIX = "/evp_proxy/v2/"
+        EVP_PROXY_V4_PATH_PREFIX = "/evp_proxy/v4/"
+        EVP_PROXY_PATH_PREFIXES = [EVP_PROXY_V4_PATH_PREFIX, EVP_PROXY_V2_PATH_PREFIX].freeze
+        EVP_PROXY_COMPRESSION_SUPPORTED = {
+          EVP_PROXY_V4_PATH_PREFIX => true,
+          EVP_PROXY_V2_PATH_PREFIX => false
+        }
+
         TEST_VISIBILITY_INTAKE_HOST_PREFIX = "citestcycle-intake"
         TEST_VISIBILITY_INTAKE_PATH = "/api/v2/citestcycle"
 
+        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
+        DD_API_SETTINGS_RESPONSE_ITR_ENABLED_KEY = "itr_enabled"
+        DD_API_SETTINGS_RESPONSE_CODE_COVERAGE_KEY = "code_coverage"
+        DD_API_SETTINGS_RESPONSE_TESTS_SKIPPING_KEY = "tests_skipping"
+        DD_API_SETTINGS_RESPONSE_REQUIRE_GIT_KEY = "require_git"
+        DD_API_SETTINGS_RESPONSE_DEFAULT = {DD_API_SETTINGS_RESPONSE_ITR_ENABLED_KEY => false}.freeze
+
         CONTENT_TYPE_MESSAGEPACK = "application/msgpack"
+        CONTENT_TYPE_JSON = "application/json"
         CONTENT_ENCODING_GZIP = "gzip"
       end
     end

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

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require_relative "../ext/test"
+require_relative "../ext/transport"
+
+module Datadog
+  module CI
+    module ITR
+      # Intelligent test runner implementation
+      # Integrates with backend to provide test impact analysis data and
+      # skip tests that are not impacted by the changes
+      class Runner
+        def initialize(
+          enabled: false
+        )
+          @enabled = enabled
+          @test_skipping_enabled = false
+          @code_coverage_enabled = false
+
+          Datadog.logger.debug("ITR Runner initialized with enabled: #{@enabled}")
+        end
+
+        def configure(remote_configuration, test_session)
+          Datadog.logger.debug("Configuring ITR Runner with remote configuration: #{remote_configuration}")
+
+          @enabled = convert_to_bool(
+            remote_configuration.fetch(Ext::Transport::DD_API_SETTINGS_RESPONSE_ITR_ENABLED_KEY, false)
+          )
+          @test_skipping_enabled = @enabled && convert_to_bool(
+            remote_configuration.fetch(Ext::Transport::DD_API_SETTINGS_RESPONSE_TESTS_SKIPPING_KEY, false)
+          )
+          @code_coverage_enabled = @enabled && convert_to_bool(
+            remote_configuration.fetch(Ext::Transport::DD_API_SETTINGS_RESPONSE_CODE_COVERAGE_KEY, false)
+          )
+
+          test_session.set_tag(Ext::Test::TAG_ITR_TEST_SKIPPING_ENABLED, @test_skipping_enabled)
+          # currently we set this tag when ITR requires collecting code coverage
+          # this will change as soon as we implement total code coverage support in this library
+          test_session.set_tag(Ext::Test::TAG_CODE_COVERAGE_ENABLED, @code_coverage_enabled)
+
+          # we skip tests, not suites
+          test_session.set_tag(Ext::Test::TAG_ITR_TEST_SKIPPING_TYPE, Ext::Test::ITR_TEST_SKIPPING_MODE)
+
+          Datadog.logger.debug("Configured ITR Runner with enabled: #{@enabled}, skipping_tests: #{@test_skipping_enabled}, code_coverage: #{@code_coverage_enabled}")
+        end
+
+        def enabled?
+          @enabled
+        end
+
+        def skipping_tests?
+          @test_skipping_enabled
+        end
+
+        def code_coverage?
+          @code_coverage_enabled
+        end
+
+        private
+
+        def convert_to_bool(value)
+          value.to_s == "true"
+        end
+      end
+    end
+  end
+end

data/lib/datadog/ci/span.rb

@@ -32,7 +32,7 @@ module Datadog
       end
 
       # @return [String] the type of the span (for example "test" or type that was provided to [Datadog::CI.trace]).
-      def span_type
+      def type
         tracer_span.type
       end
 
@@ -121,6 +121,48 @@ module Datadog
         tracer_span.set_tags(tags)
       end
 
+      # Returns the git repository URL extracted from the environment.
+      # @return [String] the repository URL.
+      def git_repository_url
+        tracer_span.get_tag(Ext::Git::TAG_REPOSITORY_URL)
+      end
+
+      # Returns the latest commit SHA extracted from the environment.
+      # @return [String] the commit SHA of the last commit.
+      def git_commit_sha
+        tracer_span.get_tag(Ext::Git::TAG_COMMIT_SHA)
+      end
+
+      # Returns the git branch name extracted from the environment.
+      # @return [String] the branch.
+      def git_branch
+        tracer_span.get_tag(Ext::Git::TAG_BRANCH)
+      end
+
+      # Returns the OS architecture extracted from the environment.
+      # @return [String] OS arch.
+      def os_architecture
+        tracer_span.get_tag(Ext::Test::TAG_OS_ARCHITECTURE)
+      end
+
+      # Returns the OS platform extracted from the environment.
+      # @return [String] OS platform.
+      def os_platform
+        tracer_span.get_tag(Ext::Test::TAG_OS_PLATFORM)
+      end
+
+      # Returns the runtime name extracted from the environment.
+      # @return [String] runtime name.
+      def runtime_name
+        tracer_span.get_tag(Ext::Test::TAG_RUNTIME_NAME)
+      end
+
+      # Returns the runtime version extracted from the environment.
+      # @return [String] runtime version.
+      def runtime_version
+        tracer_span.get_tag(Ext::Test::TAG_RUNTIME_VERSION)
+      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"])
@@ -130,12 +172,19 @@ module Datadog
       end
 
       def set_default_tags
-        tracer_span.set_tag(Ext::Test::TAG_SPAN_KIND, Ext::AppTypes::TYPE_TEST)
+        tracer_span.set_tag(Ext::Test::TAG_SPAN_KIND, Ext::Test::SPAN_KIND_TEST)
       end
 
       def to_s
         "#{self.class}(name:#{name},tracer_span:#{@tracer_span})"
       end
+
+      private
+
+      # provides access to global CI recorder for CI models to deactivate themselves
+      def recorder
+        Datadog.send(:components).ci_recorder
+      end
     end
   end
 end

data/lib/datadog/ci/test.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "json"
+
 require_relative "span"
 
 module Datadog
@@ -18,7 +20,7 @@ module Datadog
       def finish
         super
 
-        CI.deactivate_test(self)
+        recorder.deactivate_test
       end
 
       # Running test suite that this test is part of (if any).
@@ -35,6 +37,8 @@ module Datadog
         get_tag(Ext::Test::TAG_TEST_SUITE_ID)
       end
 
+      # Name of the running test suite this test belongs to.
+      # @return [String] the name of the test suite.
       def test_suite_name
         get_tag(Ext::Test::TAG_SUITE)
       end
@@ -45,11 +49,72 @@ module Datadog
         get_tag(Ext::Test::TAG_TEST_MODULE_ID)
       end
 
-      # Span id of the running test module this test belongs to.
+      # Span id of the running test session this test belongs to.
       # @return [String] the span id of the test session.
       def test_session_id
         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
+
+      # Sets the status of the span to "pass".
+      # @return [void]
+      def passed!
+        super
+
+        record_test_result(Ext::Test::Status::PASS)
+      end
+
+      # Sets the status of the span to "fail".
+      # @param [Exception] exception the exception that caused the test to fail.
+      # @return [void]
+      def failed!(exception: nil)
+        super
+
+        record_test_result(Ext::Test::Status::FAIL)
+      end
+
+      # Sets the status of the span to "skip".
+      # @param [Exception] exception the exception that caused the test to fail.
+      # @param [String] reason the reason why the test was skipped.
+      # @return [void]
+      def skipped!(exception: nil, reason: nil)
+        super
+
+        record_test_result(Ext::Test::Status::SKIP)
+      end
+
+      # Sets the parameters for this test (e.g. Cucumber example or RSpec shared specs).
+      # Parameters are needed to compute test fingerprint to distinguish between different tests having same names.
+      #
+      # @param [Hash] arguments the arguments that test accepts as key-value hash
+      # @param [Hash] metadata optional metadata
+      # @return [void]
+      def set_parameters(arguments, metadata = {})
+        return if arguments.nil?
+
+        set_tag(
+          Ext::Test::TAG_PARAMETERS,
+          JSON.generate(
+            {
+              arguments: arguments,
+              metadata: metadata
+            }
+          )
+        )
+      end
+
+      private
+
+      def record_test_result(datadog_status)
+        suite = test_suite
+        suite.record_test_result(datadog_status) if suite
+      end
     end
   end
 end

data/lib/datadog/ci/test_module.rb

@@ -16,7 +16,7 @@ module Datadog
       def finish
         super
 
-        CI.deactivate_test_module
+        recorder.deactivate_test_module
       end
     end
   end

data/lib/datadog/ci/test_session.rb

@@ -17,7 +17,7 @@ module Datadog
       def finish
         super
 
-        CI.deactivate_test_session
+        recorder.deactivate_test_session
       end
 
       # Return the test session's name which is equal to test command used
@@ -26,13 +26,21 @@ module Datadog
         get_tag(Ext::Test::TAG_COMMAND)
       end
 
+      def skipping_tests?
+        get_tag(Ext::Test::TAG_ITR_TEST_SKIPPING_ENABLED) == "true"
+      end
+
+      def code_coverage?
+        get_tag(Ext::Test::TAG_CODE_COVERAGE_ENABLED) == "true"
+      end
+
       # Return the test session tags that could be inherited by sub-spans
       # @return [Hash] the tags to be inherited by sub-spans.
       def inheritable_tags
         return @inheritable_tags if defined?(@inheritable_tags)
 
         # this method is not synchronized because it does not iterate over the tags collection, but rather
-        # uses synchronized method to get each tag value
+        # uses synchronized method #get_tag to get each tag value
         res = {}
         Ext::Test::INHERITABLE_TAGS.each do |tag|
           res[tag] = get_tag(tag)

data/lib/datadog/ci/test_suite.rb

@@ -13,12 +13,63 @@ module Datadog
     #
     # @public_api
     class TestSuite < ConcurrentSpan
+      def initialize(tracer_span)
+        super
+
+        @test_suite_stats = Hash.new(0)
+      end
+
       # Finishes this test suite.
       # @return [void]
       def finish
-        super
+        synchronize do
+          # we try to derive test suite status from execution stats if no status was set explicitly
+          set_status_from_stats! if undefined?
+
+          super
+
+          recorder.deactivate_test_suite(name)
+        end
+      end
+
+      # @internal
+      def record_test_result(datadog_test_status)
+        synchronize do
+          @test_suite_stats[datadog_test_status] += 1
+        end
+      end
+
+      # @internal
+      def passed_tests_count
+        synchronize do
+          @test_suite_stats[Ext::Test::Status::PASS]
+        end
+      end
+
+      # @internal
+      def skipped_tests_count
+        synchronize do
+          @test_suite_stats[Ext::Test::Status::SKIP]
+        end
+      end
+
+      # @internal
+      def failed_tests_count
+        synchronize do
+          @test_suite_stats[Ext::Test::Status::FAIL]
+        end
+      end
+
+      private
 
-        CI.deactivate_test_suite(name)
+      def set_status_from_stats!
+        if failed_tests_count > 0
+          failed!
+        elsif passed_tests_count == 0
+          skipped!
+        else
+          passed!
+        end
       end
     end
   end

data/lib/datadog/ci/test_visibility/context/local.rb

@@ -11,7 +11,7 @@ module Datadog
             self.active_test = nil
           end
 
-          def activate_test!(test)
+          def activate_test(test)
             raise "Nested tests are not supported. Currently active test: #{active_test}" unless active_test.nil?
 
             if block_given?
@@ -26,14 +26,8 @@ module Datadog
             end
           end
 
-          def deactivate_test!(test)
-            return if active_test.nil?
-
-            if active_test == test
-              self.active_test = nil
-            else
-              raise "Trying to deactivate test #{test}, but currently active test is #{active_test}"
-            end
+          def deactivate_test
+            self.active_test = nil
           end
 
           def active_test

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

@@ -23,7 +23,7 @@ module Datadog
           skip_tracing(block)
         end
 
-        def trace(span_type, span_name, tags: {}, &block)
+        def trace(type, span_name, tags: {}, &block)
           skip_tracing(block)
         end
 
@@ -42,30 +42,10 @@ module Datadog
         def active_test_suite(test_suite_name)
         end
 
-        def deactivate_test(test)
-        end
-
-        def deactivate_test_session
-        end
-
-        def deactivate_test_module
-        end
-
-        def deactivate_test_suite(test_suite_name)
-        end
-
         private
 
         def skip_tracing(block = nil)
-          if block
-            block.call(null_span)
-          else
-            null_span
-          end
-        end
-
-        def null_span
-          @null_span ||= NullSpan.new
+          block.call(nil) if block
         end
       end
     end