datadog-ci 1.8.0 → 1.9.0

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

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "datadog/tracing/contrib/patcher"
+require_relative "../patcher"
 
 require_relative "example"
 require_relative "example_group"
@@ -12,46 +12,15 @@ module Datadog
       module RSpec
         # Patcher enables patching of 'rspec' module.
         module Patcher
-          include Datadog::Tracing::Contrib::Patcher
+          include Datadog::CI::Contrib::Patcher
 
           module_function
 
-          def target_version
-            Integration.version
-          end
-
           def patch
-            # ci-queue test runner instrumentation
-            # https://github.com/Shopify/ci-queue
-            if ci_queue?
-              ::RSpec::Queue::Runner.include(Runner)
-            end
-
-            if knapsack_pro?
-              # Knapsack Pro test runner instrumentation
-              # https://github.com/KnapsackPro/knapsack_pro-ruby
-              require_relative "knapsack_pro/patcher"
-              Datadog::CI::Contrib::RSpec::KnapsackPro::Patcher.patch
-            end
-
-            # default rspec test runner instrumentation
             ::RSpec::Core::Runner.include(Runner)
-
             ::RSpec::Core::Example.include(Example)
             ::RSpec::Core::ExampleGroup.include(ExampleGroup)
           end
-
-          def ci_queue?
-            !!defined?(::RSpec::Queue::Runner)
-          end
-
-          def knapsack_pro?
-            knapsack_version = Gem.loaded_specs["knapsack_pro"]&.version
-
-            # additional instrumentation is needed for KnapsackPro version 7 and later
-            !!defined?(::KnapsackPro) &&
-              !knapsack_version.nil? && knapsack_version >= Gem::Version.new("7")
-          end
         end
       end
     end

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

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "../../ext/test"
+require_relative "../instrumentation"
 require_relative "ext"
 
 module Datadog
@@ -21,7 +22,7 @@ module Datadog
               test_session = test_visibility_component.start_test_session(
                 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_FRAMEWORK_VERSION => datadog_integration.version.to_s
                 },
                 service: datadog_configuration[:service_name],
                 total_tests_count: ::RSpec.world.example_count
@@ -47,6 +48,10 @@ module Datadog
 
             private
 
+            def datadog_integration
+              CI::Contrib::Instrumentation.fetch_integration(:rspec)
+            end
+
             def datadog_configuration
               Datadog.configuration.ci[:rspec]
             end

data/lib/datadog/ci/contrib/selenium/capybara_driver.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "datadog/tracing/contrib/patcher"
+require_relative "../patcher"
 
 require_relative "ext"
 require_relative "rum"

data/lib/datadog/ci/contrib/selenium/driver.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "datadog/tracing/contrib/patcher"
+require_relative "../patcher"
 
 require_relative "ext"
 require_relative "rum"

data/lib/datadog/ci/contrib/selenium/integration.rb

@@ -9,28 +9,24 @@ module Datadog
     module Contrib
       module Selenium
         # Description of Selenium integration
-        class Integration
-          include Datadog::CI::Contrib::Integration
-
+        class Integration < Contrib::Integration
           MINIMUM_VERSION = Gem::Version.new("4.0.0")
 
-          register_as :selenium
-
-          def self.version
+          def version
             Gem.loaded_specs["selenium-webdriver"]&.version
           end
 
-          def self.loaded?
+          def loaded?
             !defined?(::Selenium).nil? && !defined?(::Selenium::WebDriver).nil? &&
               !defined?(::Selenium::WebDriver::Driver).nil?
           end
 
-          def self.compatible?
+          def compatible?
             super && version >= MINIMUM_VERSION
           end
 
-          # additional instrumentations for test helpers are auto instrumented on test session start
-          def auto_instrument?
+          # additional instrumentations for test libraries are late instrumented on test session start
+          def late_instrument?
             true
           end
 

data/lib/datadog/ci/contrib/selenium/navigation.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "datadog/tracing/contrib/patcher"
+require_relative "../patcher"
 
 require_relative "ext"
 require_relative "../../ext/test"
@@ -43,7 +43,7 @@ module Datadog
               active_test.set_tag(CI::Ext::Test::TAG_BROWSER_DRIVER, "selenium")
               active_test.set_tag(
                 CI::Ext::Test::TAG_BROWSER_DRIVER_VERSION,
-                Integration.version
+                datadog_integration.version
               )
               active_test.set_tag(
                 CI::Ext::Test::TAG_BROWSER_NAME,
@@ -63,6 +63,10 @@ module Datadog
 
             private
 
+            def datadog_integration
+              CI::Contrib::Instrumentation.fetch_integration(:selenium)
+            end
+
             def datadog_configuration
               Datadog.configuration.ci[:selenium]
             end

data/lib/datadog/ci/contrib/selenium/patcher.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "datadog/tracing/contrib/patcher"
+require_relative "../patcher"
 
 require_relative "capybara_driver"
 require_relative "driver"
@@ -12,14 +12,10 @@ module Datadog
       module Selenium
         # Patcher enables patching of 'Selenium::WebDriver' module.
         module Patcher
-          include Datadog::Tracing::Contrib::Patcher
+          include Datadog::CI::Contrib::Patcher
 
           module_function
 
-          def target_version
-            Integration.version
-          end
-
           def patch
             ::Selenium::WebDriver::Driver.include(Driver)
             ::Selenium::WebDriver::Navigation.include(Navigation)

data/lib/datadog/ci/contrib/selenium/rum.rb

@@ -1,7 +1,5 @@
 # frozen_string_literal: true
 
-require "datadog/tracing/contrib/patcher"
-
 require_relative "ext"
 require_relative "../../ext/test"
 require_relative "../../utils/parsing"

data/lib/datadog/ci/contrib/simplecov/integration.rb

@@ -9,27 +9,23 @@ module Datadog
     module Contrib
       module Simplecov
         # Description of Simplecov integration
-        class Integration
-          include Datadog::CI::Contrib::Integration
-
+        class Integration < Contrib::Integration
           MINIMUM_VERSION = Gem::Version.new("0.18.0")
 
-          register_as :simplecov
-
-          def self.version
+          def version
             Gem.loaded_specs["simplecov"]&.version
           end
 
-          def self.loaded?
+          def loaded?
             !defined?(::SimpleCov).nil?
           end
 
-          def self.compatible?
+          def compatible?
             super && version >= MINIMUM_VERSION
           end
 
-          # additional instrumentations for test helpers are auto instrumented on test session start
-          def auto_instrument?
+          # additional instrumentations for test libraries are late instrumented on test session start
+          def late_instrument?
             true
           end
 

data/lib/datadog/ci/contrib/simplecov/patcher.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require "datadog/tracing/contrib/patcher"
+require_relative "../patcher"
 
 require_relative "result_extractor"
 
@@ -10,14 +10,10 @@ module Datadog
       module Simplecov
         # Patcher enables patching of 'SimpleCov' module.
         module Patcher
-          include Datadog::Tracing::Contrib::Patcher
+          include Datadog::CI::Contrib::Patcher
 
           module_function
 
-          def target_version
-            Integration.version
-          end
-
           def patch
             ::SimpleCov.include(ResultExtractor)
           end

data/lib/datadog/ci/test_retries/strategy/retry_new.rb

@@ -101,7 +101,7 @@ module Datadog
             end
             @total_limit = (tests_count * percentage_limit / 100.0).ceil
             Datadog.logger.debug do
-              "Retry new tests total limit is [#{@total_limit}] (#{percentage_limit}%) of #{tests_count}"
+              "Retry new tests total limit is [#{@total_limit}] (#{percentage_limit}% of #{tests_count})"
             end
           end
 

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

@@ -7,7 +7,7 @@ require_relative "telemetry"
 require_relative "total_coverage"
 
 require_relative "../codeowners/parser"
-require_relative "../contrib/contrib"
+require_relative "../contrib/instrumentation"
 require_relative "../ext/test"
 require_relative "../git/local_repository"
 
@@ -149,7 +149,7 @@ module Datadog
           git_tree_upload_worker.perform(test_session.git_repository_url)
 
           # finds and instruments additional test libraries that we support (ex: selenium-webdriver)
-          Contrib.auto_instrument_on_session_start!
+          Contrib::Instrumentation.instrument_on_session_start
 
           # sends internal telemetry events
           Telemetry.test_session_started(test_session)

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

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative "../contrib/instrumentation"
 require_relative "../ext/app_types"
 require_relative "../ext/environment"
 require_relative "../ext/telemetry"
@@ -33,7 +34,7 @@ module Datadog
             Ext::Telemetry::METRIC_TEST_SESSION,
             1,
             {
-              Ext::Telemetry::TAG_AUTO_INJECTED => "false", # ruby doesn't support auto injection yet
+              Ext::Telemetry::TAG_AUTO_INJECTED => Contrib::Instrumentation.auto_instrumented?.to_s,
               Ext::Telemetry::TAG_PROVIDER => test_session.ci_provider || Ext::Telemetry::Provider::UNSUPPORTED
             }
           )

data/lib/datadog/ci/version.rb

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

data/lib/datadog/ci.rb

@@ -406,9 +406,17 @@ module Datadog
 end
 
 # Integrations
+
+# Test frameworks (manual instrumentation)
 require_relative "ci/contrib/cucumber/integration"
-require_relative "ci/contrib/rspec/integration"
 require_relative "ci/contrib/minitest/integration"
+require_relative "ci/contrib/rspec/integration"
+
+# Test runners (instrumented automatically when corresponding frameworks are instrumented)
+require_relative "ci/contrib/knapsack/integration"
+require_relative "ci/contrib/ciqueue/integration"
+
+# Additional test libraries (auto instrumented later on test session start)
 require_relative "ci/contrib/selenium/integration"
 require_relative "ci/contrib/simplecov/integration"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: datadog-ci
 version: !ruby/object:Gem::Version
-  version: 1.8.0
+  version: 1.9.0
 platform: ruby
 authors:
 - Datadog, Inc.
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-10-17 00:00:00.000000000 Z
+date: 2024-11-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: datadog
@@ -61,8 +61,10 @@ files:
 - ext/datadog_cov/datadog_cov.c
 - ext/datadog_cov/extconf.rb
 - lib/datadog/ci.rb
+- lib/datadog/ci/auto_instrument.rb
 - lib/datadog/ci/cli/cli.rb
 - lib/datadog/ci/cli/command/base.rb
+- lib/datadog/ci/cli/command/exec.rb
 - lib/datadog/ci/cli/command/skippable_tests_percentage.rb
 - lib/datadog/ci/cli/command/skippable_tests_percentage_estimate.rb
 - lib/datadog/ci/codeowners/matcher.rb
@@ -72,7 +74,8 @@ files:
 - lib/datadog/ci/configuration/components.rb
 - lib/datadog/ci/configuration/extensions.rb
 - lib/datadog/ci/configuration/settings.rb
-- lib/datadog/ci/contrib/contrib.rb
+- lib/datadog/ci/contrib/ciqueue/integration.rb
+- lib/datadog/ci/contrib/ciqueue/patcher.rb
 - lib/datadog/ci/contrib/cucumber/configuration/settings.rb
 - lib/datadog/ci/contrib/cucumber/ext.rb
 - lib/datadog/ci/contrib/cucumber/filter.rb
@@ -80,7 +83,12 @@ 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/instrumentation.rb
 - lib/datadog/ci/contrib/integration.rb
+- lib/datadog/ci/contrib/knapsack/extension.rb
+- lib/datadog/ci/contrib/knapsack/integration.rb
+- lib/datadog/ci/contrib/knapsack/patcher.rb
+- lib/datadog/ci/contrib/knapsack/runner.rb
 - lib/datadog/ci/contrib/minitest/configuration/settings.rb
 - lib/datadog/ci/contrib/minitest/ext.rb
 - lib/datadog/ci/contrib/minitest/helpers.rb
@@ -90,14 +98,12 @@ files:
 - 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/patcher.rb
 - lib/datadog/ci/contrib/rspec/configuration/settings.rb
 - lib/datadog/ci/contrib/rspec/example.rb
 - lib/datadog/ci/contrib/rspec/example_group.rb
 - lib/datadog/ci/contrib/rspec/ext.rb
 - lib/datadog/ci/contrib/rspec/integration.rb
-- lib/datadog/ci/contrib/rspec/knapsack_pro/extension.rb
-- lib/datadog/ci/contrib/rspec/knapsack_pro/patcher.rb
-- lib/datadog/ci/contrib/rspec/knapsack_pro/runner.rb
 - lib/datadog/ci/contrib/rspec/patcher.rb
 - lib/datadog/ci/contrib/rspec/runner.rb
 - lib/datadog/ci/contrib/selenium/capybara_driver.rb
@@ -241,7 +247,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 2.0.0
 requirements: []
-rubygems_version: 3.5.16
+rubygems_version: 3.5.22
 signing_key: 
 specification_version: 4
 summary: Datadog CI visibility for your ruby application

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

@@ -1,31 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "integration"
-
-module Datadog
-  module CI
-    module Contrib
-      # This method auto instruments all test libraries (ex: selenium-webdriver).
-      # It is intended to be called when test session starts to add additional capabilities to test visibility.
-      #
-      # This method does not automatically instrument test frameworks (ex: RSpec, Cucumber, etc), it requires
-      # test framework to be already instrumented.
-      def self.auto_instrument_on_session_start!
-        Datadog.logger.debug("Auto instrumenting all integrations...")
-
-        Integration.registry.each do |name, integration|
-          next unless integration.auto_instrument?
-
-          Datadog.logger.debug "#{name} is allowed to be auto instrumented"
-
-          patch_results = integration.patch
-          if patch_results == true
-            Datadog.logger.debug("#{name} is patched")
-          else
-            Datadog.logger.debug("#{name} is not patched (#{patch_results})")
-          end
-        end
-      end
-    end
-  end
-end

data/lib/datadog/ci/contrib/rspec/knapsack_pro/extension.rb

@@ -1,29 +0,0 @@
-# frozen_string_literal: true
-
-require "knapsack_pro/extensions/rspec_extension"
-
-require_relative "runner"
-
-module Datadog
-  module CI
-    module Contrib
-      module RSpec
-        module KnapsackPro
-          module Extension
-            def self.included(base)
-              base.singleton_class.prepend(ClassMethods)
-            end
-
-            module ClassMethods
-              def setup!
-                super
-
-                ::RSpec::Core::Runner.include(Datadog::CI::Contrib::RSpec::KnapsackPro::Runner)
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/datadog/ci/contrib/rspec/knapsack_pro/patcher.rb

@@ -1,26 +0,0 @@
-# frozen_string_literal: true
-
-module Datadog
-  module CI
-    module Contrib
-      module RSpec
-        module KnapsackPro
-          module Patcher
-            def self.patch
-              if defined?(::KnapsackPro::Extensions::RSpecExtension::Runner) &&
-                  ::RSpec::Core::Runner.ancestors.include?(::KnapsackPro::Extensions::RSpecExtension::Runner)
-                # knapsack already patched rspec runner
-                require_relative "runner"
-                ::RSpec::Core::Runner.include(KnapsackPro::Runner)
-              else
-                # knapsack didn't patch rspec runner yet
-                require_relative "extension"
-                ::KnapsackPro::Extensions::RSpecExtension.include(KnapsackPro::Extension)
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/datadog/ci/contrib/rspec/knapsack_pro/runner.rb

@@ -1,62 +0,0 @@
-# frozen_string_literal: true
-
-require_relative "../../../ext/test"
-require_relative "../ext"
-
-module Datadog
-  module CI
-    module Contrib
-      module RSpec
-        module KnapsackPro
-          module Runner
-            def self.included(base)
-              base.prepend(InstanceMethods)
-            end
-
-            module InstanceMethods
-              def knapsack__run_specs(*args)
-                return super if ::RSpec.configuration.dry_run? && !datadog_configuration[:dry_run_enabled]
-                return super unless datadog_configuration[:enabled]
-
-                test_session = test_visibility_component.start_test_session(
-                  tags: {
-                    CI::Ext::Test::TAG_FRAMEWORK => Ext::FRAMEWORK,
-                    CI::Ext::Test::TAG_FRAMEWORK_VERSION => CI::Contrib::RSpec::Integration.version.to_s
-                  },
-                  service: datadog_configuration[:service_name]
-                )
-
-                test_module = test_visibility_component.start_test_module(Ext::FRAMEWORK)
-
-                result = super
-                return result unless test_module && test_session
-
-                if result != 0
-                  test_module.failed!
-                  test_session.failed!
-                else
-                  test_module.passed!
-                  test_session.passed!
-                end
-                test_module.finish
-                test_session.finish
-
-                result
-              end
-
-              private
-
-              def datadog_configuration
-                Datadog.configuration.ci[:rspec]
-              end
-
-              def test_visibility_component
-                Datadog.send(:components).test_visibility
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end