datadog-ci 1.0.0.beta1 → 1.0.0.beta3

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

@@ -13,13 +13,14 @@ require_relative "../codeowners/parser"
 require_relative "../ext/app_types"
 require_relative "../ext/test"
 require_relative "../ext/environment"
-require_relative "../utils/git"
+require_relative "../git/local_repository"
 
 require_relative "../span"
 require_relative "../test"
 require_relative "../test_session"
 require_relative "../test_module"
 require_relative "../test_suite"
+require_relative "../worker"
 
 module Datadog
   module CI
@@ -30,8 +31,11 @@ module Datadog
         attr_reader :environment_tags, :test_suite_level_visibility_enabled
 
         def initialize(
-          itr:, remote_settings_api:, test_suite_level_visibility_enabled: false,
-          codeowners: Codeowners::Parser.new(Utils::Git.root).parse
+          itr:,
+          remote_settings_api:,
+          git_tree_upload_worker: DummyWorker.new,
+          test_suite_level_visibility_enabled: false,
+          codeowners: Codeowners::Parser.new(Git::LocalRepository.root).parse
         )
           @test_suite_level_visibility_enabled = test_suite_level_visibility_enabled
 
@@ -43,6 +47,11 @@ module Datadog
 
           @itr = itr
           @remote_settings_api = remote_settings_api
+          @git_tree_upload_worker = git_tree_upload_worker
+        end
+
+        def shutdown!
+          @git_tree_upload_worker.stop
         end
 
         def start_test_session(service: nil, tags: {})
@@ -56,6 +65,7 @@ module Datadog
 
             test_session = build_test_session(tracer_span, tags)
 
+            @git_tree_upload_worker.perform(test_session.git_repository_url)
             configure_library(test_session)
 
             test_session
@@ -117,21 +127,18 @@ module Datadog
               test = build_test(tracer_span, tags)
 
               @local_context.activate_test(test) do
-                @itr.start_coverage
-
+                on_test_started(test)
                 res = block.call(test)
                 on_test_finished(test)
-
                 res
               end
             end
           else
             tracer_span = start_datadog_tracer_span(test_name, span_options)
-
             test = build_test(tracer_span, tags)
 
             @local_context.activate_test(test)
-            @itr.start_coverage
+            on_test_started(test)
 
             test
           end
@@ -184,6 +191,9 @@ module Datadog
         end
 
         def deactivate_test_session
+          test_session = active_test_session
+          on_test_session_finished(test_session) if test_session
+
           @global_context.deactivate_test_session!
         end
 
@@ -206,7 +216,25 @@ module Datadog
           return unless itr_enabled?
 
           remote_configuration = @remote_settings_api.fetch_library_settings(test_session)
-          @itr.configure(remote_configuration.payload, test_session)
+          # sometimes we can skip code coverage for default branch if there are no changes in the repository
+          # backend needs git metadata uploaded for this test session to check if we can skip code coverage
+          if remote_configuration.require_git?
+            Datadog.logger.debug { "Library configuration endpoint requires git upload to be finished, waiting..." }
+            @git_tree_upload_worker.wait_until_done
+
+            Datadog.logger.debug { "Requesting library configuration again..." }
+            remote_configuration = @remote_settings_api.fetch_library_settings(test_session)
+
+            if remote_configuration.require_git?
+              Datadog.logger.debug { "git metadata upload did not complete in time when configuring library" }
+            end
+          end
+
+          @itr.configure(
+            remote_configuration.payload,
+            test_session: test_session,
+            git_tree_upload_worker: @git_tree_upload_worker
+          )
         end
 
         def skip_tracing(block = nil)
@@ -373,6 +401,16 @@ module Datadog
         # TODO: use kind of event system to notify about test finished?
         def on_test_finished(test)
           @itr.stop_coverage(test)
+          @itr.count_skipped_test(test)
+        end
+
+        def on_test_started(test)
+          @itr.mark_if_skippable(test)
+          @itr.start_coverage(test)
+        end
+
+        def on_test_session_finished(test_session)
+          @itr.write_test_session_tags(test_session)
         end
       end
     end

data/lib/datadog/ci/test_visibility/serializers/base.rb

@@ -28,11 +28,12 @@ module Datadog
             "duration"
           ].freeze
 
-          attr_reader :trace, :span, :meta
+          attr_reader :trace, :span, :meta, :options
 
-          def initialize(trace, span)
+          def initialize(trace, span, options: {})
             @trace = trace
             @span = span
+            @options = options
 
             @meta = @span.meta.reject { |key, _| Ext::Test::TRANSIENT_TAGS.include?(key) }
 

data/lib/datadog/ci/test_visibility/serializers/factories/test_level.rb

@@ -14,12 +14,12 @@ module Datadog
           module TestLevel
             module_function
 
-            def serializer(trace, span)
+            def serializer(trace, span, options: {})
               case span.type
               when Datadog::CI::Ext::AppTypes::TYPE_TEST
-                Serializers::TestV1.new(trace, span)
+                Serializers::TestV1.new(trace, span, options: options)
               else
-                Serializers::Span.new(trace, span)
+                Serializers::Span.new(trace, span, options: options)
               end
             end
           end

data/lib/datadog/ci/test_visibility/serializers/factories/test_suite_level.rb

@@ -15,18 +15,18 @@ module Datadog
           module TestSuiteLevel
             module_function
 
-            def serializer(trace, span)
+            def serializer(trace, span, options: {})
               case span.type
               when Datadog::CI::Ext::AppTypes::TYPE_TEST
-                Serializers::TestV2.new(trace, span)
+                Serializers::TestV2.new(trace, span, options: options)
               when Datadog::CI::Ext::AppTypes::TYPE_TEST_SESSION
-                Serializers::TestSession.new(trace, span)
+                Serializers::TestSession.new(trace, span, options: options)
               when Datadog::CI::Ext::AppTypes::TYPE_TEST_MODULE
-                Serializers::TestModule.new(trace, span)
+                Serializers::TestModule.new(trace, span, options: options)
               when Datadog::CI::Ext::AppTypes::TYPE_TEST_SUITE
-                Serializers::TestSuite.new(trace, span)
+                Serializers::TestSuite.new(trace, span, options: options)
               else
-                Serializers::Span.new(trace, span)
+                Serializers::Span.new(trace, span, options: options)
               end
             end
           end

data/lib/datadog/ci/test_visibility/serializers/test_v2.rb

@@ -10,22 +10,34 @@ module Datadog
         class TestV2 < TestV1
           CONTENT_FIELDS = (["test_session_id", "test_module_id", "test_suite_id"] + TestV1::CONTENT_FIELDS).freeze
 
+          CONTENT_FIELDS_WITH_ITR_CORRELATION_ID = (CONTENT_FIELDS + ["itr_correlation_id"]).freeze
+
           CONTENT_MAP_SIZE = calculate_content_map_size(CONTENT_FIELDS)
 
+          CONTENT_MAP_SIZE_WITH_ITR_CORRELATION_ID = calculate_content_map_size(CONTENT_FIELDS_WITH_ITR_CORRELATION_ID)
+
           REQUIRED_FIELDS = (["test_session_id", "test_module_id", "test_suite_id"] + TestV1::REQUIRED_FIELDS).freeze
 
           def content_fields
-            CONTENT_FIELDS
+            return CONTENT_FIELDS if itr_correlation_id.nil?
+
+            CONTENT_FIELDS_WITH_ITR_CORRELATION_ID
           end
 
           def content_map_size
-            CONTENT_MAP_SIZE
+            return CONTENT_MAP_SIZE if itr_correlation_id.nil?
+
+            CONTENT_MAP_SIZE_WITH_ITR_CORRELATION_ID
           end
 
           def version
             2
           end
 
+          def itr_correlation_id
+            options[:itr_correlation_id]
+          end
+
           private
 
           def required_fields

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

@@ -14,7 +14,7 @@ module Datadog
 
         def initialize(
           api:,
-          dd_env: nil,
+          dd_env:,
           serializers_factory: Datadog::CI::TestVisibility::Serializers::Factories::TestLevel,
           max_payload_size: DEFAULT_MAX_PAYLOAD_SIZE
         )
@@ -45,7 +45,7 @@ module Datadog
         end
 
         def encode_span(trace, span)
-          serializer = serializers_factory.serializer(trace, span)
+          serializer = serializers_factory.serializer(trace, span, options: {itr_correlation_id: itr&.correlation_id})
 
           if serializer.valid?
             encoded = encoder.encode(serializer)
@@ -98,6 +98,10 @@ module Datadog
 
           packer.write("events")
         end
+
+        def itr
+          @itr ||= Datadog::CI.send(:itr_runner)
+        end
       end
     end
   end

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

@@ -4,6 +4,7 @@ require "delegate"
 require "datadog/core/transport/http/adapters/net"
 require "datadog/core/transport/http/env"
 require "datadog/core/transport/request"
+require "socket"
 
 require_relative "gzip"
 require_relative "../ext/transport"
@@ -20,6 +21,8 @@ module Datadog
           :compress
 
         DEFAULT_TIMEOUT = 30
+        MAX_RETRIES = 3
+        INITIAL_BACKOFF = 1
 
         def initialize(host:, timeout: DEFAULT_TIMEOUT, port: nil, ssl: true, compress: false)
           @host = host
@@ -29,7 +32,7 @@ module Datadog
           @compress = compress.nil? ? false : compress
         end
 
-        def request(path:, payload:, headers:, verb: "post")
+        def request(path:, payload:, headers:, verb: "post", retries: MAX_RETRIES, backoff: INITIAL_BACKOFF)
           if compress
             headers[Ext::Transport::HEADER_CONTENT_ENCODING] = Ext::Transport::CONTENT_ENCODING_GZIP
             payload = Gzip.compress(payload)
@@ -41,9 +44,7 @@ module Datadog
           end
 
           response = ResponseDecorator.new(
-            adapter.call(
-              build_env(path: path, payload: payload, headers: headers, verb: verb)
-            )
+            perform_http_call(path: path, payload: payload, headers: headers, verb: verb, retries: retries, backoff: backoff)
           )
 
           Datadog.logger.debug do
@@ -55,6 +56,25 @@ module Datadog
 
         private
 
+        def perform_http_call(path:, payload:, headers:, verb:, retries: MAX_RETRIES, backoff: INITIAL_BACKOFF)
+          adapter.call(
+            build_env(path: path, payload: payload, headers: headers, verb: verb)
+          )
+        rescue Timeout::Error, Errno::EINVAL, Errno::ECONNRESET, EOFError, SocketError, Net::HTTPBadResponse => e
+          Datadog.logger.debug("Failed to send request with #{e} (#{e.message})")
+
+          if retries.positive?
+            sleep(backoff)
+
+            perform_http_call(
+              path: path, payload: payload, headers: headers, verb: verb, retries: retries - 1, backoff: backoff * 2
+            )
+          else
+            Datadog.logger.error("Failed to send request after #{MAX_RETRIES} retries")
+            raise e
+          end
+        end
+
         def build_env(path:, payload:, headers:, verb:)
           env = Datadog::Core::Transport::HTTP::Env.new(
             Datadog::Core::Transport::Request.new

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

@@ -5,6 +5,7 @@ require "json"
 require "datadog/core/environment/identity"
 
 require_relative "../ext/transport"
+require_relative "../utils/parsing"
 
 module Datadog
   module CI
@@ -28,7 +29,7 @@ module Datadog
             return cached unless cached.nil?
 
             resp = @http_response
-            return @json = default_payload if resp.nil? || !resp.ok?
+            return @json = default_payload if resp.nil? || !ok?
 
             begin
               @json = JSON.parse(resp.payload).dig(*Ext::Transport::DD_API_SETTINGS_RESPONSE_DIG_KEYS) ||
@@ -39,6 +40,10 @@ module Datadog
             end
           end
 
+          def require_git?
+            Utils::Parsing.convert_to_bool(payload[Ext::Transport::DD_API_SETTINGS_RESPONSE_REQUIRE_GIT_KEY])
+          end
+
           private
 
           def default_payload
@@ -46,9 +51,10 @@ module Datadog
           end
         end
 
-        def initialize(api: nil, dd_env: nil)
+        def initialize(dd_env:, api: nil, config_tags: {})
           @api = api
           @dd_env = dd_env
+          @config_tags = config_tags || {}
         end
 
         def fetch_library_settings(test_session)
@@ -81,10 +87,12 @@ module Datadog
                 "sha" => test_session.git_commit_sha,
                 "test_level" => Ext::Test::ITR_TEST_SKIPPING_MODE,
                 "configurations" => {
-                  "os.platform" => test_session.os_platform,
-                  "os.arch" => test_session.os_architecture,
-                  "runtime.name" => test_session.runtime_name,
-                  "runtime.version" => test_session.runtime_version
+                  Ext::Test::TAG_OS_PLATFORM => test_session.os_platform,
+                  Ext::Test::TAG_OS_ARCHITECTURE => test_session.os_architecture,
+                  Ext::Test::TAG_OS_VERSION => test_session.os_version,
+                  Ext::Test::TAG_RUNTIME_NAME => test_session.runtime_name,
+                  Ext::Test::TAG_RUNTIME_VERSION => test_session.runtime_version,
+                  "custom" => @config_tags
                 }
               }
             }

data/lib/datadog/ci/utils/configuration.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
 
-require_relative "git"
+require_relative "../git/local_repository"
 
 module Datadog
   module CI
     module Utils
       module Configuration
         def self.fetch_service_name(default)
-          Datadog.configuration.service_without_fallback || Git.repository_name || default
+          Datadog.configuration.service_without_fallback || CI::Git::LocalRepository.repository_name || default
         end
       end
     end

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

@@ -7,6 +7,12 @@ module Datadog
   module CI
     module Utils
       module Git
+        def self.valid_commit_sha?(sha)
+          return false if sha.nil?
+
+          sha.match?(/\A[0-9a-f]{40}\Z/) || sha.match?(/\A[0-9a-f]{64}\Z/)
+        end
+
         def self.normalize_ref(ref)
           return nil if ref.nil?
 
@@ -19,73 +25,6 @@ module Datadog
         def self.is_git_tag?(ref)
           !ref.nil? && ref.include?("tags/")
         end
-
-        def self.root
-          return @root if defined?(@root)
-
-          @root = exec_git_command("git rev-parse --show-toplevel") || Dir.pwd
-        rescue => e
-          Datadog.logger.debug(
-            "Unable to read git root: #{e.class.name} #{e.message} at #{Array(e.backtrace).first}"
-          )
-          @root = Dir.pwd
-        end
-
-        def self.relative_to_root(path)
-          return nil if path.nil?
-
-          git_root = root
-          return path if git_root.nil?
-
-          path = Pathname.new(File.expand_path(path))
-          git_root = Pathname.new(git_root)
-
-          path.relative_path_from(git_root).to_s
-        end
-
-        def self.repository_name
-          return @repository_name if defined?(@repository_name)
-
-          git_remote_url = exec_git_command("git ls-remote --get-url origin")
-
-          # return git repository name from remote url without .git extension
-          last_path_segment = git_remote_url.split("/").last if git_remote_url
-          @repository_name = last_path_segment.gsub(".git", "") if last_path_segment
-          @repository_name ||= current_folder_name
-        rescue => e
-          Datadog.logger.debug(
-            "Unable to get git remote: #{e.class.name} #{e.message} at #{Array(e.backtrace).first}"
-          )
-          @repository_name = current_folder_name
-        end
-
-        def self.current_folder_name
-          root_folder = root
-          if root_folder.nil?
-            File.basename(Dir.pwd)
-          else
-            File.basename(root_folder)
-          end
-        end
-
-        def self.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
       end
     end
   end

data/lib/datadog/ci/utils/parsing.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require "open3"
+require "pathname"
+
+module Datadog
+  module CI
+    module Utils
+      module Parsing
+        def self.convert_to_bool(value)
+          value.to_s.downcase == "true"
+        end
+      end
+    end
+  end
+end

data/lib/datadog/ci/utils/test_run.rb

@@ -9,6 +9,31 @@ module Datadog
 
           @command = "#{$0} #{ARGV.join(" ")}"
         end
+
+        def self.skippable_test_id(test_name, suite, parameters = nil)
+          "#{suite}.#{test_name}.#{parameters}"
+        end
+
+        def self.test_parameters(arguments: {}, metadata: {})
+          JSON.generate(
+            {
+              arguments: arguments,
+              metadata: metadata
+            }
+          )
+        end
+
+        def self.custom_configuration(env_tags)
+          return {} if env_tags.nil?
+
+          res = {}
+          env_tags.each do |tag, value|
+            next unless tag.start_with?("test.configuration.")
+
+            res[tag.sub("test.configuration.", "")] = value
+          end
+          res
+        end
       end
     end
   end

data/lib/datadog/ci/version.rb

@@ -6,7 +6,7 @@ module Datadog
       MAJOR = "1"
       MINOR = "0"
       PATCH = "0"
-      PRE = "beta1"
+      PRE = "beta3"
       BUILD = nil
       # PRE and BUILD above are modified for dev gems during gem build GHA workflow
 

data/lib/datadog/ci/worker.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: true
+
+require "datadog/core/worker"
+require "datadog/core/workers/async"
+
+# general purpose async worker for CI
+# executes given task once in separate thread
+module Datadog
+  module CI
+    class Worker < Datadog::Core::Worker
+      include Datadog::Core::Workers::Async::Thread
+
+      DEFAULT_SHUTDOWN_TIMEOUT = 60
+      DEFAULT_WAIT_TIMEOUT = 60
+
+      def stop(timeout = DEFAULT_SHUTDOWN_TIMEOUT)
+        join(timeout)
+      end
+
+      def wait_until_done(timeout = DEFAULT_WAIT_TIMEOUT)
+        join(timeout)
+      end
+
+      def done?
+        started? && !running?
+      end
+    end
+
+    class DummyWorker < Worker
+      def initialize
+        super { nil }
+      end
+    end
+  end
+end

data/lib/datadog/ci.rb

@@ -364,6 +364,10 @@ module Datadog
       def recorder
         components.ci_recorder
       end
+
+      def itr_runner
+        components.itr
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: datadog-ci
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta1
+  version: 1.0.0.beta3
 platform: ruby
 authors:
 - Datadog, Inc.
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-03-25 00:00:00.000000000 Z
+date: 2024-04-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: datadog
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0.beta1
+        version: 2.0.0.beta2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0.beta1
+        version: 2.0.0.beta2
 - !ruby/object:Gem::Dependency
   name: msgpack
   requirement: !ruby/object:Gem::Requirement
@@ -72,16 +72,17 @@ files:
 - lib/datadog/ci/contrib/cucumber/instrumentation.rb
 - lib/datadog/ci/contrib/cucumber/integration.rb
 - lib/datadog/ci/contrib/cucumber/patcher.rb
+- lib/datadog/ci/contrib/cucumber/step.rb
 - lib/datadog/ci/contrib/integration.rb
 - lib/datadog/ci/contrib/minitest/configuration/settings.rb
 - lib/datadog/ci/contrib/minitest/ext.rb
 - lib/datadog/ci/contrib/minitest/helpers.rb
-- lib/datadog/ci/contrib/minitest/hooks.rb
 - lib/datadog/ci/contrib/minitest/integration.rb
 - lib/datadog/ci/contrib/minitest/patcher.rb
 - lib/datadog/ci/contrib/minitest/reporter.rb
 - lib/datadog/ci/contrib/minitest/runnable.rb
 - lib/datadog/ci/contrib/minitest/runner.rb
+- lib/datadog/ci/contrib/minitest/test.rb
 - lib/datadog/ci/contrib/rspec/configuration/settings.rb
 - lib/datadog/ci/contrib/rspec/example.rb
 - lib/datadog/ci/contrib/rspec/example_group.rb
@@ -115,10 +116,18 @@ files:
 - lib/datadog/ci/ext/settings.rb
 - lib/datadog/ci/ext/test.rb
 - lib/datadog/ci/ext/transport.rb
+- lib/datadog/ci/git/local_repository.rb
+- lib/datadog/ci/git/packfiles.rb
+- lib/datadog/ci/git/search_commits.rb
+- lib/datadog/ci/git/tree_uploader.rb
+- lib/datadog/ci/git/upload_packfile.rb
+- lib/datadog/ci/git/user.rb
 - lib/datadog/ci/itr/coverage/ddcov.rb
 - lib/datadog/ci/itr/coverage/event.rb
 - lib/datadog/ci/itr/coverage/transport.rb
+- lib/datadog/ci/itr/coverage/writer.rb
 - lib/datadog/ci/itr/runner.rb
+- lib/datadog/ci/itr/skippable.rb
 - lib/datadog/ci/span.rb
 - lib/datadog/ci/test.rb
 - lib/datadog/ci/test_module.rb
@@ -149,8 +158,10 @@ files:
 - lib/datadog/ci/transport/remote_settings_api.rb
 - lib/datadog/ci/utils/configuration.rb
 - lib/datadog/ci/utils/git.rb
+- lib/datadog/ci/utils/parsing.rb
 - lib/datadog/ci/utils/test_run.rb
 - lib/datadog/ci/version.rb
+- lib/datadog/ci/worker.rb
 homepage: https://github.com/DataDog/datadog-ci-rb
 licenses:
 - BSD-3-Clause
@@ -177,7 +188,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 2.0.0
 requirements: []
-rubygems_version: 3.5.6
+rubygems_version: 3.5.9
 signing_key:
 specification_version: 4
 summary: Datadog CI visibility for your ruby application