datadog-ci 0.3.0 → 0.5.1

data/lib/datadog/ci/contrib/minitest/hooks.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "../../recorder"
 require_relative "../../ext/test"
 require_relative "ext"
 
@@ -19,41 +18,32 @@ module Datadog
             path, = method(name).source_location
             test_suite = Pathname.new(path.to_s).relative_path_from(Pathname.pwd).to_s
 
-            span = CI::Recorder.trace(
-              configuration[:operation_name],
-              {
-                span_options: {
-                  resource: test_name,
-                  service: configuration[:service_name]
-                },
-                framework: Ext::FRAMEWORK,
-                framework_version: CI::Contrib::Minitest::Integration.version.to_s,
-                test_name: test_name,
-                test_suite: test_suite,
-                test_type: Ext::TEST_TYPE
-              }
+            CI.start_test(
+              test_name,
+              test_suite,
+              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_TYPE => Ext::TEST_TYPE
+              },
+              service: configuration[:service_name]
             )
-
-            Thread.current[:_datadog_test_span] = span
           end
 
           def after_teardown
-            span = Thread.current[:_datadog_test_span]
-            return super unless span
-
-            Thread.current[:_datadog_test_span] = nil
+            test_span = CI.active_test
+            return super unless test_span
 
             case result_code
             when "."
-              CI::Recorder.passed!(span)
+              test_span.passed!
             when "E", "F"
-              CI::Recorder.failed!(span, failure)
+              test_span.failed!(exception: failure)
             when "S"
-              CI::Recorder.skipped!(span)
-              span.set_tag(CI::Ext::Test::TAG_SKIP_REASON, failure.message)
+              test_span.skipped!(reason: failure.message)
             end
 
-            span.finish
+            test_span.finish
 
             super
           end

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

@@ -9,7 +9,7 @@ module Datadog
       module RSpec
         module Configuration
           # Custom settings for the RSpec integration
-          # TODO: mark as `@public_api` when GA
+          # @public_api
           class Settings < Datadog::CI::Contrib::Settings
             option :enabled do |o|
               o.type :bool
@@ -22,10 +22,19 @@ module Datadog
               o.default { Datadog.configuration.service_without_fallback || Ext::SERVICE_NAME }
             end
 
+            # @deprecated Will be removed in 1.0
             option :operation_name do |o|
               o.type :string
               o.env Ext::ENV_OPERATION_NAME
               o.default Ext::OPERATION_NAME
+
+              o.after_set do |value|
+                if value && value != Ext::OPERATION_NAME
+                  Datadog::Core.log_deprecation do
+                    "The operation_name setting has no effect and will be removed in 1.0"
+                  end
+                end
+              end
             end
           end
         end

data/lib/datadog/ci/contrib/rspec/example.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "../../recorder"
 require_relative "../../ext/test"
 require_relative "ext"
 
@@ -25,29 +24,25 @@ module Datadog
                 test_name += " #{description}"
               end
 
-              CI::Recorder.trace(
-                configuration[:operation_name],
-                {
-                  span_options: {
-                    resource: test_name,
-                    service: configuration[:service_name]
-                  },
-                  framework: Ext::FRAMEWORK,
-                  framework_version: CI::Contrib::RSpec::Integration.version.to_s,
-                  test_name: test_name,
-                  test_suite: metadata[:example_group][:file_path],
-                  test_type: Ext::TEST_TYPE
-                }
-              ) do |span|
+              CI.trace_test(
+                test_name,
+                metadata[:example_group][:file_path],
+                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_TYPE => Ext::TEST_TYPE
+                },
+                service: configuration[:service_name]
+              ) do |test_span|
                 result = super
 
                 case execution_result.status
                 when :passed
-                  CI::Recorder.passed!(span)
+                  test_span.passed!
                 when :failed
-                  CI::Recorder.failed!(span, execution_result.exception)
+                  test_span.failed!(exception: execution_result.exception)
                 else
-                  CI::Recorder.skipped!(span, execution_result.exception) if execution_result.example_skipped?
+                  test_span.skipped!(exception: execution_result.exception) if execution_result.example_skipped?
                 end
 
                 result

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

@@ -10,6 +10,8 @@ module Datadog
 
         option :enabled, default: true
         option :service_name
+
+        # @deprecated Will be removed in 1.0
         option :operation_name
 
         def configure(options = {})

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

@@ -5,6 +5,11 @@ module Datadog
     module Ext
       module AppTypes
         TYPE_TEST = "test"
+        TYPE_TEST_SESSION = "test_session_end"
+        TYPE_TEST_MODULE = "test_module_end"
+        TYPE_TEST_SUITE = "test_suite_end"
+
+        CI_SPAN_TYPES = [TYPE_TEST, TYPE_TEST_SESSION, TYPE_TEST_MODULE, TYPE_TEST_SUITE].freeze
       end
     end
   end

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

@@ -2,6 +2,7 @@
 
 require_relative "../git"
 require_relative "../../utils/git"
+require_relative "../../utils/url"
 require_relative "providers"
 
 module Datadog
@@ -68,14 +69,14 @@ module Datadog
 
           def normalize_git!
             branch_ref = @tags[Git::TAG_BRANCH]
-            if Datadog::CI::Utils::Git.is_git_tag?(branch_ref)
+            if Utils::Git.is_git_tag?(branch_ref)
               @tags[Git::TAG_TAG] = branch_ref
               @tags.delete(Git::TAG_BRANCH)
             end
 
-            @tags[Git::TAG_TAG] = Datadog::CI::Utils::Git.normalize_ref(@tags[Git::TAG_TAG])
-            @tags[Git::TAG_BRANCH] = Datadog::CI::Utils::Git.normalize_ref(@tags[Git::TAG_BRANCH])
-            @tags[Git::TAG_REPOSITORY_URL] = filter_sensitive_info(
+            @tags[Git::TAG_TAG] = Utils::Git.normalize_ref(@tags[Git::TAG_TAG])
+            @tags[Git::TAG_BRANCH] = Utils::Git.normalize_ref(@tags[Git::TAG_BRANCH])
+            @tags[Git::TAG_REPOSITORY_URL] = Utils::Url.filter_sensitive_info(
               @tags[Git::TAG_REPOSITORY_URL]
             )
           end
@@ -87,12 +88,6 @@ module Datadog
               @tags[TAG_WORKSPACE_PATH] = File.expand_path(workspace_path)
             end
           end
-
-          def filter_sensitive_info(url)
-            return nil if url.nil?
-
-            url.gsub(%r{(https?://)[^/]*@}, '\1')
-          end
         end
       end
     end

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

@@ -3,6 +3,7 @@
 require "json"
 
 require_relative "base"
+require_relative "../../../utils/url"
 
 module Datadog
   module CI
@@ -25,7 +26,7 @@ module Datadog
             end
 
             def job_url
-              "#{env["GITHUB_SERVER_URL"]}/#{env["GITHUB_REPOSITORY"]}/commit/#{env["GITHUB_SHA"]}/checks"
+              "#{github_server_url}/#{env["GITHUB_REPOSITORY"]}/commit/#{env["GITHUB_SHA"]}/checks"
             end
 
             def pipeline_id
@@ -41,7 +42,7 @@ module Datadog
             end
 
             def pipeline_url
-              res = "#{env["GITHUB_SERVER_URL"]}/#{env["GITHUB_REPOSITORY"]}/actions/runs/#{env["GITHUB_RUN_ID"]}"
+              res = "#{github_server_url}/#{env["GITHUB_REPOSITORY"]}/actions/runs/#{env["GITHUB_RUN_ID"]}"
               res = "#{res}/attempts/#{env["GITHUB_RUN_ATTEMPT"]}" if env["GITHUB_RUN_ATTEMPT"]
               res
             end
@@ -51,7 +52,7 @@ module Datadog
             end
 
             def git_repository_url
-              "#{env["GITHUB_SERVER_URL"]}/#{env["GITHUB_REPOSITORY"]}.git"
+              "#{github_server_url}/#{env["GITHUB_REPOSITORY"]}.git"
             end
 
             def git_commit_sha
@@ -66,12 +67,20 @@ module Datadog
 
             def ci_env_vars
               {
-                "GITHUB_SERVER_URL" => env["GITHUB_SERVER_URL"],
+                "GITHUB_SERVER_URL" => github_server_url,
                 "GITHUB_REPOSITORY" => env["GITHUB_REPOSITORY"],
                 "GITHUB_RUN_ID" => env["GITHUB_RUN_ID"],
                 "GITHUB_RUN_ATTEMPT" => env["GITHUB_RUN_ATTEMPT"]
               }.reject { |_, v| v.nil? }.to_json
             end
+
+            private
+
+            def github_server_url
+              return @github_server_url if defined?(@github_server_url)
+
+              @github_server_url ||= Utils::Url.filter_sensitive_info(env["GITHUB_SERVER_URL"])
+            end
           end
         end
       end

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

@@ -8,6 +8,17 @@ module Datadog
         ENV_MODE_ENABLED = "DD_TRACE_CI_ENABLED"
         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"
+
+        # Source: https://docs.datadoghq.com/getting_started/site/
+        DD_SITE_ALLOWLIST = [
+          "datadoghq.com",
+          "us3.datadoghq.com",
+          "us5.datadoghq.com",
+          "datadoghq.eu",
+          "ddog-gov.com",
+          "ap1.datadoghq.com"
+        ].freeze
       end
     end
   end

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

@@ -4,6 +4,7 @@ module Datadog
   module CI
     module Ext
       # Defines constants for test tags
+      # @public_api
       module Test
         CONTEXT_ORIGIN = "ciapp-test"
 
@@ -14,8 +15,19 @@ module Datadog
         TAG_SKIP_REASON = "test.skip_reason" # DEV: Not populated yet
         TAG_STATUS = "test.status"
         TAG_SUITE = "test.suite"
+        TAG_MODULE = "test.module"
         TAG_TRAITS = "test.traits"
         TAG_TYPE = "test.type"
+        TAG_COMMAND = "test.command"
+
+        # those tags are special and they are used to correlate tests with the test sessions, suites, and modules
+        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
+
+        # tags that can be inherited from the test session
+        INHERITABLE_TAGS = [TAG_FRAMEWORK, TAG_FRAMEWORK_VERSION, TAG_TYPE].freeze
 
         # Environment runtime tags
         TAG_OS_ARCHITECTURE = "os.architecture"
@@ -23,7 +35,6 @@ module Datadog
         TAG_RUNTIME_NAME = "runtime.name"
         TAG_RUNTIME_VERSION = "runtime.version"
 
-        # TODO: is there a better place for SPAN_KIND?
         TAG_SPAN_KIND = "span.kind"
 
         module Status

data/lib/datadog/ci/null_span.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require "datadog/tracing/span_operation"
+
+module Datadog
+  module CI
+    # Represents an ignored span when CI visibility is disabled.
+    # Replaces all methods with no-op.
+    #
+    # @public_api
+    class NullSpan < Span
+      def initialize
+        super(Datadog::Tracing::SpanOperation.new("null.span"))
+      end
+
+      def id
+      end
+
+      def name
+      end
+
+      def service
+      end
+
+      def span_type
+      end
+
+      def passed!
+      end
+
+      def failed!(exception: nil)
+      end
+
+      def skipped!(exception: nil, reason: nil)
+      end
+
+      def get_tag(key)
+      end
+
+      def set_tag(key, value)
+      end
+
+      def set_metric(key, value)
+      end
+
+      def finish
+      end
+
+      def set_tags(tags)
+      end
+
+      def set_environment_runtime_tags
+      end
+
+      def set_default_tags
+      end
+
+      def to_s
+        self.class.to_s
+      end
+    end
+  end
+end

data/lib/datadog/ci/span.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+require_relative "ext/test"
+require_relative "utils/test_run"
+
+module Datadog
+  module CI
+    # Represents a single part of a test run.
+    # Could be a session, suite, test, or any custom span.
+    #
+    # @public_api
+    class Span
+      attr_reader :tracer_span
+
+      def initialize(tracer_span)
+        @tracer_span = tracer_span
+      end
+
+      # @return [Integer] the ID of the span.
+      def id
+        tracer_span.id
+      end
+
+      # @return [String] the name of the span.
+      def name
+        tracer_span.name
+      end
+
+      # @return [String] the service name of the span.
+      def service
+        tracer_span.service
+      end
+
+      # @return [String] the type of the span (for example "test" or type that was provided to [Datadog::CI.trace]).
+      def span_type
+        tracer_span.type
+      end
+
+      # Sets the status of the span to "pass".
+      # @return [void]
+      def passed!
+        tracer_span.set_tag(Ext::Test::TAG_STATUS, 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)
+        tracer_span.status = 1
+        tracer_span.set_tag(Ext::Test::TAG_STATUS, Ext::Test::Status::FAIL)
+        tracer_span.set_error(exception) unless exception.nil?
+      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)
+        tracer_span.set_tag(Ext::Test::TAG_STATUS, Ext::Test::Status::SKIP)
+        tracer_span.set_error(exception) unless exception.nil?
+        tracer_span.set_tag(Ext::Test::TAG_SKIP_REASON, reason) unless reason.nil?
+      end
+
+      # Gets tag value by key.
+      # @param [String] key the key of the tag.
+      # @return [String] the value of the tag.
+      def get_tag(key)
+        tracer_span.get_tag(key)
+      end
+
+      # Sets tag value by key.
+      # @param [String] key the key of the tag.
+      # @param [String] value the value of the tag.
+      # @return [void]
+      def set_tag(key, value)
+        tracer_span.set_tag(key, value)
+      end
+
+      # Sets metric value by key.
+      # @param [String] key the key of the metric.
+      # @param [Numeric] value the value of the metric.
+      # @return [void]
+      def set_metric(key, value)
+        tracer_span.set_metric(key, value)
+      end
+
+      # Finishes the span.
+      # @return [void]
+      def finish
+        tracer_span.finish
+      end
+
+      # Sets multiple tags at once.
+      # @param [Hash[String, String]] tags the tags to set.
+      # @return [void]
+      def set_tags(tags)
+        tracer_span.set_tags(tags)
+      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"])
+        tracer_span.set_tag(Ext::Test::TAG_RUNTIME_NAME, Core::Environment::Ext::LANG_ENGINE)
+        tracer_span.set_tag(Ext::Test::TAG_RUNTIME_VERSION, Core::Environment::Ext::ENGINE_VERSION)
+        tracer_span.set_tag(Ext::Test::TAG_COMMAND, Utils::TestRun.command)
+      end
+
+      def set_default_tags
+        tracer_span.set_tag(Ext::Test::TAG_SPAN_KIND, Ext::AppTypes::TYPE_TEST)
+      end
+
+      def to_s
+        "#{self.class}(name:#{name},tracer_span:#{@tracer_span})"
+      end
+    end
+  end
+end

data/lib/datadog/ci/test.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative "span"
+
+module Datadog
+  module CI
+    # Represents a single part of a test run.
+    #
+    # @public_api
+    class Test < Span
+      # @return [String] the name of the test.
+      def name
+        get_tag(Ext::Test::TAG_NAME)
+      end
+
+      # Finishes the current test.
+      # @return [void]
+      def finish
+        super
+
+        CI.deactivate_test(self)
+      end
+    end
+  end
+end

data/lib/datadog/ci/test_module.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+require_relative "concurrent_span"
+
+module Datadog
+  module CI
+    # Represents a single test module.
+    # Read here on what test module could mean:
+    # https://docs.datadoghq.com/continuous_integration/explorer/?tab=testruns#module
+    # This object can be shared between multiple threads.
+    #
+    # @public_api
+    class TestModule < ConcurrentSpan
+      # Finishes this test module.
+      # @return [void]
+      def finish
+        super
+
+        CI.deactivate_test_module
+      end
+    end
+  end
+end

data/lib/datadog/ci/test_session.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "concurrent_span"
+require_relative "ext/test"
+
+module Datadog
+  module CI
+    # Represents the whole test session process.
+    # Documentation on test sessions is here:
+    # https://docs.datadoghq.com/continuous_integration/explorer/?tab=testruns#sessions
+    # This object can be shared between multiple threads.
+    #
+    # @public_api
+    class TestSession < ConcurrentSpan
+      # Finishes the current test session.
+      # @return [void]
+      def finish
+        super
+
+        CI.deactivate_test_session
+      end
+
+      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
+        res = {}
+        Ext::Test::INHERITABLE_TAGS.each do |tag|
+          res[tag] = get_tag(tag)
+        end
+        @inheritable_tags = res.freeze
+      end
+    end
+  end
+end

data/lib/datadog/ci/test_suite.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+require_relative "concurrent_span"
+
+module Datadog
+  module CI
+    # Represents a single test suite.
+    #
+    # Read here on what test suite means:
+    # https://docs.datadoghq.com/continuous_integration/explorer/?tab=testruns#suite
+    #
+    # This object can be shared between multiple threads.
+    #
+    # @public_api
+    class TestSuite < ConcurrentSpan
+      # Finishes this test suite.
+      # @return [void]
+      def finish
+        super
+
+        CI.deactivate_test_suite(name)
+      end
+    end
+  end
+end