datadog-ci 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce3b4502404f6faa6b05421763ced6582071c9ad025937219b59ba8c63c39175
-  data.tar.gz: 7a341aa75161299cb04a29f745e172ef5ca4fec3a24f536ec96e08119de11a97
+  metadata.gz: 60a81205d586462fc1e58ff85bcddd69bbab3dc597abe2a730ad393fe9261040
+  data.tar.gz: d44884f838dd3b50db30796d581017127ff6de63dc3121fc531ad54f786ae389
 SHA512:
-  metadata.gz: 6058fbf497f43040a588018a2104055a303849d5616d063412dae4dab1e5247098e9ecd1b0b718776a51bc090f137d2bcf19cc78d252c7968c9cd6e4723ad902
-  data.tar.gz: 3c8d8eb9a34266a690a0dd5103d344b80df5175c703a414b1bc8255dc3c2732d723960e786765f2686fdcaaff5f009b675942c5e39dbd4a6fc9e58a38653051e
+  metadata.gz: e69a35a679697d2b142140f71f0704f2c9a4fcf28d2fc9ddff79dd4f514172711c50123c4294252b2e89188ce17ced36656f08290e4c86ee187c3b22965d56da
+  data.tar.gz: c12c56c96a6b31be3b931afdc441890ac88a59e7d12cf663b3fbbce7408ea8338b8d31fb4f49360fcaddfd425e36088bf638f960032cae6c1507d9c83fe36c7a

data/CHANGELOG.md

@@ -1,5 +1,23 @@
 ## [Unreleased]
 
+## [0.4.0] - 2023-11-21
+
+### Added
+
+* Public API for manual test instrumentation ([#64][]) ([#61][])
+
+### Changed
+
+* fix tracing instrumentation example in readme ([#60][])
+
+### Fixed
+
+* Remove user credentials from ssh URLs and from GITHUB_REPO_URL environment variable ([#66][])
+
+### Removed
+
+* Remove _dd.measured tag from spans ([#65][])
+
 ## [0.3.0] - 2023-10-25
 
 ### Added
@@ -47,7 +65,8 @@
 
 * Ruby versions < 2.7 no longer supported ([#8][])
 
-[Unreleased]: https://github.com/DataDog/datadog-ci-rb/compare/v0.3.0...main
+[Unreleased]: https://github.com/DataDog/datadog-ci-rb/compare/v0.4.0...main
+[0.4.0]: https://github.com/DataDog/datadog-ci-rb/compare/v0.3.0...v0.4.0
 [0.3.0]: https://github.com/DataDog/datadog-ci-rb/compare/v0.2.0...v0.3.0
 [0.2.0]: https://github.com/DataDog/datadog-ci-rb/compare/v0.1.1...v0.2.0
 [0.1.1]: https://github.com/DataDog/datadog-ci-rb/compare/v0.1.0...v0.1.1
@@ -66,3 +85,8 @@
 [#49]: https://github.com/DataDog/datadog-ci-rb/issues/49
 [#51]: https://github.com/DataDog/datadog-ci-rb/issues/51
 [#54]: https://github.com/DataDog/datadog-ci-rb/issues/54
+[#60]: https://github.com/DataDog/datadog-ci-rb/issues/60
+[#61]: https://github.com/DataDog/datadog-ci-rb/issues/61
+[#64]: https://github.com/DataDog/datadog-ci-rb/issues/64
+[#65]: https://github.com/DataDog/datadog-ci-rb/issues/65
+[#66]: https://github.com/DataDog/datadog-ci-rb/issues/66

data/README.md

@@ -30,18 +30,18 @@ To activate `RSpec` integration, add this to the `spec_helper.rb` file:
 require 'rspec'
 require 'datadog/ci'
 
-Datadog.configure do |c|
-  # Only activates test instrumentation on CI
-  c.tracing.enabled = (ENV["DD_ENV"] == "ci")
-
-  # Configures the tracer to ensure results delivery
-  c.ci.enabled = true
-
-  # The name of the service or library under test
-  c.service = 'my-ruby-app'
-
-  # Enables the RSpec instrumentation
-  c.ci.instrument :rspec, **options
+# Only activates test instrumentation on CI
+if ENV["DD_ENV"] == "ci"
+  Datadog.configure do |c|
+    # Configures the tracer to ensure results delivery
+    c.ci.enabled = true
+
+    # The name of the service or library under test
+    c.service = 'my-ruby-app'
+
+    # Enables the RSpec instrumentation
+    c.ci.instrument :rspec, **options
+  end
 end
 ```
 
@@ -51,7 +51,7 @@ end
 | --- | ----------- | ------- |
 | `enabled` | Defines whether RSpec tests should be traced. Useful for temporarily disabling tracing. `true` or `false` | `true` |
 | `service_name` | Service name used for `rspec` instrumentation. | `'rspec'` |
-| `operation_name` | Operation name used for `rspec` instrumentation. Useful if you want rename automatic trace metrics e.g. `trace.#{operation_name}.errors`. | `'rspec.example'` |
+| `operation_name` | Operation name used for `rspec` instrumentation. | `'rspec.example'` |
 
 ### Minitest
 
@@ -63,18 +63,18 @@ To activate your integration, use the `Datadog.configure` method:
 require 'minitest'
 require 'datadog/ci'
 
+# Only activates test instrumentation on CI
+if ENV["DD_ENV"] == "ci"
 # Configure default Minitest integration
-Datadog.configure do |c|
-  # Only activates test instrumentation on CI
-  c.tracing.enabled = (ENV["DD_ENV"] == "ci")
-
-  # Configures the tracer to ensure results delivery
-  c.ci.enabled = true
+  Datadog.configure do |c|
+    # Configures the tracer to ensure results delivery
+    c.ci.enabled = true
 
-  # The name of the service or library under test
-  c.service = 'my-ruby-app'
+    # The name of the service or library under test
+    c.service = 'my-ruby-app'
 
-  c.ci.instrument :minitest, **options
+    c.ci.instrument :minitest, **options
+  end
 end
 ```
 
@@ -84,7 +84,7 @@ end
 | --- | ----------- | ------- |
 | `enabled` | Defines whether Minitest tests should be traced. Useful for temporarily disabling tracing. `true` or `false` | `true` |
 | `service_name` | Service name used for `minitest` instrumentation. | `'minitest'` |
-| `operation_name` | Operation name used for `minitest` instrumentation. Useful if you want rename automatic trace metrics e.g. `trace.#{operation_name}.errors`. | `'minitest.test'` |
+| `operation_name` | Operation name used for `minitest` instrumentation. | `'minitest.test'` |
 
 ### Cucumber
 
@@ -94,18 +94,18 @@ Activate `Cucumber` integration with configuration
 require 'cucumber'
 require 'datadog/ci'
 
-Datadog.configure do |c|
-  # Only activates test instrumentation on CI
-  c.tracing.enabled = (ENV["DD_ENV"] == "ci")
-
-  # Configures the tracer to ensure results delivery
-  c.ci.enabled = true
+# Only activates test instrumentation on CI
+if ENV["DD_ENV"] == "ci"
+  Datadog.configure do |c|
+    # Configures the tracer to ensure results delivery
+    c.ci.enabled = true
 
-  # The name of the service or library under test
-  c.service = 'my-ruby-app'
+    # The name of the service or library under test
+    c.service = 'my-ruby-app'
 
-  # Enables the Cucumber instrumentation
-  c.ci.instrument :cucumber, **options
+    # Enables the Cucumber instrumentation
+    c.ci.instrument :cucumber, **options
+  end
 end
 ```
 
@@ -115,7 +115,7 @@ end
 | --- | ----------- | ------- |
 | `enabled` | Defines whether Cucumber tests should be traced. Useful for temporarily disabling tracing. `true` or `false` | `true` |
 | `service_name` | Service name used for `cucumber` instrumentation. | `'cucumber'` |
-| `operation_name` | Operation name used for `cucumber` instrumentation. Useful if you want rename automatic trace metrics e.g. `trace.#{operation_name}.errors`. | `'cucumber.test'` |
+| `operation_name` | Operation name used for `cucumber` instrumentation. | `'cucumber.test'` |
 
 ## Agentless mode
 
@@ -145,8 +145,8 @@ In order to achieve this you can configure ddtrace instrumentations in your conf
 ```ruby
 Datadog.configure do |c|
   #  ... ci configs and instrumentation here ...
-  c.instrument :redis
-  c.instrument :pg
+  c.tracing.instrument :redis
+  c.tracing.instrument :pg
 end
 ```
 

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

@@ -7,12 +7,15 @@ require_relative "../ext/transport"
 require_relative "../test_visibility/flush"
 require_relative "../test_visibility/transport"
 require_relative "../transport/api/builder"
+require_relative "../recorder"
 
 module Datadog
   module CI
     module Configuration
       # Adds CI behavior to Datadog trace components
       module Components
+        attr_reader :ci_recorder
+
         def initialize(settings)
           # Activate CI mode if enabled
           activate_ci!(settings) if settings.ci.enabled
@@ -52,6 +55,8 @@ module Datadog
           end
 
           settings.tracing.test_mode.writer_options = writer_options
+
+          @ci_recorder = Recorder.new
         end
 
         def can_use_evp_proxy?(settings, agent_settings)

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

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Datadog
+  module CI
+    module Context
+      class Local
+        def initialize
+          @key = :datadog_ci_active_test
+
+          self.active_test = nil
+        end
+
+        def activate_test!(test)
+          raise "Nested tests are not supported. Currently active test: #{active_test}" unless active_test.nil?
+
+          if block_given?
+            begin
+              self.active_test = test
+              yield
+            ensure
+              self.active_test = nil
+            end
+          else
+            self.active_test = test
+          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
+        end
+
+        def active_test
+          Thread.current[@key]
+        end
+
+        private
+
+        def active_test=(test)
+          Thread.current[@key] = test
+        end
+      end
+    end
+  end
+end

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

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "../../recorder"
 require_relative "../../ext/test"
 require_relative "ext"
 
@@ -28,56 +27,51 @@ module Datadog
           end
 
           def on_test_case_started(event)
-            @current_feature_span = CI::Recorder.trace(
-              configuration[:operation_name],
-              {
-                span_options: {
-                  resource: event.test_case.name,
-                  service: configuration[:service_name]
-                },
-                framework: Ext::FRAMEWORK,
-                framework_version: CI::Contrib::Cucumber::Integration.version.to_s,
-                test_name: event.test_case.name,
-                test_suite: event.test_case.location.file,
-                test_type: Ext::TEST_TYPE
-              }
+            CI.start_test(
+              event.test_case.name,
+              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_TYPE => Ext::TEST_TYPE,
+                CI::Ext::Test::TAG_SUITE => event.test_case.location.file
+              },
+              service_name: configuration[:service_name],
+              operation_name: configuration[:operation_name]
             )
           end
 
           def on_test_case_finished(event)
-            return if @current_feature_span.nil?
+            test_span = CI.active_test
+            return if test_span.nil?
 
             if event.result.skipped?
-              CI::Recorder.skipped!(@current_feature_span)
+              test_span.skipped!
             elsif event.result.ok?
-              CI::Recorder.passed!(@current_feature_span)
+              test_span.passed!
             elsif event.result.failed?
-              CI::Recorder.failed!(@current_feature_span)
+              test_span.failed!
             end
 
-            @current_feature_span.finish
+            test_span.finish
           end
 
           def on_test_step_started(event)
-            trace_options = {
-              resource: event.test_step.to_s,
-              span_type: Ext::STEP_SPAN_TYPE
-            }
-            @current_step_span = Tracing.trace(Ext::STEP_SPAN_TYPE, **trace_options)
+            CI.trace(Ext::STEP_SPAN_TYPE, event.test_step.to_s)
           end
 
           def on_test_step_finished(event)
-            return if @current_step_span.nil?
+            current_step_span = CI.active_span(Ext::STEP_SPAN_TYPE)
+            return if current_step_span.nil?
 
             if event.result.skipped?
-              CI::Recorder.skipped!(@current_step_span, event.result.exception)
+              current_step_span.skipped!
             elsif event.result.ok?
-              CI::Recorder.passed!(@current_step_span)
+              current_step_span.passed!
             elsif event.result.failed?
-              CI::Recorder.failed!(@current_step_span, event.result.exception)
+              current_step_span.failed!(exception: event.result.exception)
             end
 
-            @current_step_span.finish
+            current_step_span.finish
           end
 
           private

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,33 @@ 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,
+              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,
+                CI::Ext::Test::TAG_SUITE => test_suite
+              },
+              service_name: configuration[:service_name],
+              operation_name: configuration[:operation_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/example.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-require_relative "../../recorder"
 require_relative "../../ext/test"
 require_relative "ext"
 
@@ -25,29 +24,26 @@ 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,
+                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,
+                  CI::Ext::Test::TAG_SUITE => metadata[:example_group][:file_path]
+                },
+                service_name: configuration[:service_name],
+                operation_name: configuration[:operation_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/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