datadog-ci 1.5.0 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 876a0e7ada3aeaf87b19dade6ee73fec0fe8d37387cde5fc31b43aaad76e99c5
-  data.tar.gz: 8c46ad7c35a621ae03b7b42faa5b3c6934066e422ff4d3a8ac2249cd6466ecd3
+  metadata.gz: f38fbb3ab8e2c8c1b058d7cbefb3ac30c59cd138fb2a69929d2c7309763b0c6e
+  data.tar.gz: 862f8c10065b47fb8763701399de65cf0da652f36f0d301ba3b0cd4e1c12080c
 SHA512:
-  metadata.gz: 8f312e6920cad6072665c00dc5d253e66a7c3272abda20e79f86cf11beb38fffe0be789f644affb6f8920e458f00f221c7969fb84c2ee6f2198af6a140eafc64
-  data.tar.gz: f9b7c2b184e7a140269eaa2069cbf5062270d6bb07410fd9b46cab4c521a8d0bd694a676086164c58300c264357e53e0118611053f6bdf0c2dee757b487b4769
+  metadata.gz: 4be4dec3f2b5a11d0a822a3cd17d422eedab4262445dd42ba4d4efa96d4ee3f92049e5b37e1b6497928cf1fe980a847e4749538275092ca9fecd24700db3c62f
+  data.tar.gz: 2ebcae9e728ffd517d2c4f583808ade0170cb705967b59710213633bc73d1cd5d529c2b22323f8f70d45f657a8d848e856560aacc53c3ec7aea6e3aff45110af

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 ## [Unreleased]
 
+## [1.6.0] - 2024-09-20
+
+
+### Added
+* support logical names for test sessions ([#235][])
+* Send internal vCPU count metric ([#236][])
+
 ## [1.5.0] - 2024-09-18
 
 ### Added
@@ -325,7 +332,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.5.0...main
+[Unreleased]: https://github.com/DataDog/datadog-ci-rb/compare/v1.6.0...main
+[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
 [1.4.0]: https://github.com/DataDog/datadog-ci-rb/compare/v1.3.0...v1.4.0
@@ -467,4 +475,6 @@ Currently test suite level visibility is not used by our instrumentation: it wil
 [#226]: https://github.com/DataDog/datadog-ci-rb/issues/226
 [#227]: https://github.com/DataDog/datadog-ci-rb/issues/227
 [#229]: https://github.com/DataDog/datadog-ci-rb/issues/229
-[#231]: https://github.com/DataDog/datadog-ci-rb/issues/231
+[#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

data/README.md

@@ -13,6 +13,7 @@ Learn more on our [official website](https://docs.datadoghq.com/tests/) and chec
 - [Test Visibility](https://docs.datadoghq.com/tests/) - collect metrics and results for your tests
 - [Intelligent test runner](https://docs.datadoghq.com/intelligent_test_runner/) - save time by selectively running only tests affected by code changes
 - [Auto test retries](https://docs.datadoghq.com/tests/auto_test_retries/?tab=ruby) - retrying failing tests up to N times to avoid failing your build due to flaky tests
+- [Early flake detection](https://docs.datadoghq.com/tests/early_flake_detection?tab=ruby) - Datadog’s test flakiness solution that identifies flakes early by running newly added tests multiple times
 - [Search and manage CI tests](https://docs.datadoghq.com/tests/search/)
 - [Enhance developer workflows](https://docs.datadoghq.com/tests/developer_workflows)
 - [Flaky test management](https://docs.datadoghq.com/tests/guides/flaky_test_management/)

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

@@ -123,7 +123,8 @@ module Datadog
           # @type ivar @test_optimisation: Datadog::CI::TestOptimisation::Component
           @test_optimisation = build_test_optimisation(settings, test_visibility_api)
           @test_visibility = TestVisibility::Component.new(
-            test_suite_level_visibility_enabled: !settings.ci.force_test_level_visibility
+            test_suite_level_visibility_enabled: !settings.ci.force_test_level_visibility,
+            logical_test_session_name: settings.ci.test_session_name
           )
         end
 

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

@@ -24,6 +24,11 @@ module Datadog
                 o.default false
               end
 
+              option :test_session_name do |o|
+                o.type :string, nilable: true
+                o.env CI::Ext::Settings::ENV_TEST_SESSION_NAME
+              end
+
               option :agentless_mode_enabled do |o|
                 o.type :bool
                 o.env CI::Ext::Settings::ENV_AGENTLESS_MODE_ENABLED

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

@@ -19,6 +19,7 @@ module Datadog
         ENV_RETRY_FAILED_TESTS_MAX_ATTEMPTS = "DD_CIVISIBILITY_FLAKY_RETRY_COUNT"
         ENV_RETRY_FAILED_TESTS_TOTAL_LIMIT = "DD_CIVISIBILITY_TOTAL_FLAKY_RETRY_COUNT"
         ENV_RETRY_NEW_TESTS_ENABLED = "DD_CIVISIBILITY_EARLY_FLAKE_DETECTION_ENABLED"
+        ENV_TEST_SESSION_NAME = "DD_TEST_SESSION_NAME"
 
         # Source: https://docs.datadoghq.com/getting_started/site/
         DD_SITE_ALLOWLIST = %w[

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

@@ -68,6 +68,12 @@ module Datadog
         TAG_SPAN_KIND = "span.kind"
         SPAN_KIND_TEST = "test"
 
+        # common tags that are serialized directly in msgpack header in metadata field
+        METADATA_TAG_TEST_SESSION_NAME = "test_session.name"
+
+        # internal metric with the number of virtual CPUs
+        METRIC_CPU_COUNT = "_dd.host.vcpu_count"
+
         # tags that are common for the whole session and can be inherited from the test session
         INHERITABLE_TAGS = [TAG_FRAMEWORK, TAG_FRAMEWORK_VERSION].freeze
 

data/lib/datadog/ci/span.rb

@@ -114,6 +114,13 @@ module Datadog
         tracer_span.clear_tag(key)
       end
 
+      # Gets metric value by key.
+      # @param [String] key the key of the metric.
+      # @return [Numeric] value the value of the metric.
+      def get_metric(key)
+        tracer_span.get_metric(key)
+      end
+
       # Sets metric value by key.
       # @param [String] key the key of the metric.
       # @param [Numeric] value the value of the metric.

data/lib/datadog/ci/test_session.rb

@@ -28,6 +28,24 @@ module Datadog
         get_tag(Ext::Test::TAG_COMMAND)
       end
 
+      # Return the test session's command used to run the tests
+      # @return [String] the command for this test session.
+      def test_command
+        get_tag(Ext::Test::TAG_COMMAND)
+      end
+
+      # Return the test session's CI provider name (e.g. "travis", "circleci", etc.)
+      # @return [String] the provider name for this test session.
+      def ci_provider
+        get_tag(Ext::Environment::TAG_PROVIDER_NAME)
+      end
+
+      # Return the test session's CI job name (e.g. "build", "test", etc.)
+      # @return [String] the job name for this test session.
+      def ci_job_name
+        get_tag(Ext::Environment::TAG_JOB_NAME)
+      end
+
       def skipping_tests?
         get_tag(Ext::Test::TAG_ITR_TEST_SKIPPING_ENABLED) == "true"
       end

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

@@ -17,15 +17,17 @@ module Datadog
     module TestVisibility
       # Common behavior for CI tests
       class Component
-        attr_reader :test_suite_level_visibility_enabled
+        attr_reader :test_suite_level_visibility_enabled, :logical_test_session_name
 
         def initialize(
           test_suite_level_visibility_enabled: false,
-          codeowners: Codeowners::Parser.new(Git::LocalRepository.root).parse
+          codeowners: Codeowners::Parser.new(Git::LocalRepository.root).parse,
+          logical_test_session_name: nil
         )
           @test_suite_level_visibility_enabled = test_suite_level_visibility_enabled
           @context = Context.new
           @codeowners = codeowners
+          @logical_test_session_name = logical_test_session_name
         end
 
         def start_test_session(service: nil, tags: {}, total_tests_count: 0)
@@ -152,6 +154,9 @@ module Datadog
           Telemetry.test_session_started(test_session)
           Telemetry.event_created(test_session)
 
+          # sets logical test session name if none provided by the user
+          override_logical_test_session_name!(test_session) if logical_test_session_name.nil?
+
           # signal Remote::Component to configure the library
           remote.configure(test_session)
         end
@@ -269,6 +274,14 @@ module Datadog
           end
         end
 
+        def override_logical_test_session_name!(test_session)
+          @logical_test_session_name = test_session.test_command
+          ci_job_name = test_session.ci_job_name
+          if ci_job_name
+            @logical_test_session_name = "#{ci_job_name}-#{@logical_test_session_name}"
+          end
+        end
+
         def test_optimisation
           Datadog.send(:components).test_optimisation
         end

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

@@ -11,6 +11,8 @@ require_relative "../ext/app_types"
 require_relative "../ext/environment"
 require_relative "../ext/test"
 
+require_relative "../utils/test_run"
+
 require_relative "../span"
 require_relative "../test"
 require_relative "../test_session"
@@ -203,6 +205,8 @@ module Datadog
 
           ci_span.set_tags(tags)
           ci_span.set_tags(@environment_tags)
+
+          ci_span.set_metric(Ext::Test::METRIC_CPU_COUNT, Utils::TestRun.virtual_cpu_count)
         end
 
         # PROPAGATING CONTEXT FROM TOP-LEVEL TO THE LOWER LEVELS

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

@@ -53,6 +53,13 @@ module Datadog
         def remove_test_finished_callback
         end
 
+        def test_suite_level_visibility_enabled
+          false
+        end
+
+        def logical_test_session_name
+        end
+
         private
 
         def skip_tracing(block = nil)

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

@@ -34,9 +34,7 @@ module Datadog
             1,
             {
               Ext::Telemetry::TAG_AUTO_INJECTED => "false", # ruby doesn't support auto injection yet
-              Ext::Telemetry::TAG_PROVIDER =>
-                test_session.get_tag(Ext::Environment::TAG_PROVIDER_NAME) ||
-                Ext::Telemetry::Provider::UNSUPPORTED
+              Ext::Telemetry::TAG_PROVIDER => test_session.ci_provider || Ext::Telemetry::Provider::UNSUPPORTED
             }
           )
         end

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

@@ -3,6 +3,7 @@
 require "datadog/core/environment/identity"
 
 require_relative "serializers/factories/test_level"
+require_relative "../ext/app_types"
 require_relative "../ext/telemetry"
 require_relative "../ext/transport"
 require_relative "../transport/event_platform_transport"
@@ -51,7 +52,12 @@ module Datadog
         end
 
         def encode_span(trace, span)
-          serializer = serializers_factory.serializer(trace, span, options: {itr_correlation_id: itr&.correlation_id})
+          serializer = serializers_factory.serializer(
+            trace,
+            span,
+            options: {itr_correlation_id: test_optimisation&.correlation_id}
+          )
+
           if serializer.valid?
             encoded = encoder.encode(serializer)
             return nil if event_too_large?(span, encoded)
@@ -75,7 +81,7 @@ module Datadog
           packer.write(1)
 
           packer.write("metadata")
-          packer.write_map_header(1)
+          packer.write_map_header(1 + Ext::AppTypes::CI_SPAN_TYPES.size)
 
           packer.write("*")
           metadata_fields_count = dd_env ? 4 : 3
@@ -95,12 +101,24 @@ module Datadog
           packer.write("library_version")
           packer.write(Datadog::CI::VERSION::STRING)
 
+          Ext::AppTypes::CI_SPAN_TYPES.each do |ci_span_type|
+            packer.write(ci_span_type)
+            packer.write_map_header(1)
+
+            packer.write(Ext::Test::METADATA_TAG_TEST_SESSION_NAME)
+            packer.write(test_visibility&.logical_test_session_name)
+          end
+
           packer.write("events")
         end
 
-        def itr
+        def test_optimisation
           @test_optimisation ||= Datadog::CI.send(:test_optimisation)
         end
+
+        def test_visibility
+          @test_visibility ||= Datadog::CI.send(:test_visibility)
+        end
       end
     end
   end

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

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "etc"
+
 module Datadog
   module CI
     module Utils
@@ -34,6 +36,12 @@ module Datadog
           end
           res
         end
+
+        def self.virtual_cpu_count
+          return @virtual_cpu_count if defined?(@virtual_cpu_count)
+
+          @virtual_cpu_count = ::Etc.nprocessors
+        end
       end
     end
   end

data/lib/datadog/ci/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: datadog-ci
 version: !ruby/object:Gem::Version
-  version: 1.5.0
+  version: 1.6.0
 platform: ruby
 authors:
 - Datadog, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-09-18 00:00:00.000000000 Z
+date: 2024-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: datadog