datadog-ci 1.0.0.beta5 → 1.0.0.beta6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d82afa69ce303c4d7652a9455b4f19c6e89fe5afda868a10bf2b42c765bc06d
-  data.tar.gz: 5b2c939c277b4f0b712fcdd3d361cef50302e9947feac333b49bfcea5cd83e4d
+  metadata.gz: a905eacfa2face6f297e027aa344b9b36f99d7f7f2120ab6946b2e9c650c390b
+  data.tar.gz: 537bd49690464320a74f88d9a0c392dcac10b83575407d703cf756a71ea8c29e
 SHA512:
-  metadata.gz: f315f6d11021a34dc32815ffa1fea4ffddd4e894253aa8c69225d40fb10930e50949a5bd11237aa9f15f60bca171e4781efbf24e1edce24f239b513819c41741
-  data.tar.gz: 80df3261fb5fbb357d4bdcec7b530de26ece4316ba5f289e9254b1e8fcc6129d58e9cf2cada61e81a98500c2aea03aa6410e0a25696148c782c74e99da44fc95
+  metadata.gz: 8c87d7be67c31a970d0f6e75fcc4a0305719604afe02eac4061fd9c43a2539632f7a6f9199aafdaf55438913e721280ec2e5ac30f75d5921dd4bb3bdc1638f5a
+  data.tar.gz: '0838f7ce0df3bdf19a9a9c2c0df6c1b8ef0a96421e7043bfa339b6aa8d7a04f204a8c2a0dcb1cccb80f13df4a47a5da16c127a756d5064512120ea35a9beb8d0'

data/CHANGELOG.md

@@ -1,5 +1,11 @@
 ## [Unreleased]
 
+## [1.0.0.beta6] - 2024-05-29
+
+### Added
+
+* Browser tests support via selenium integration ([#183][])
+
 ## [1.0.0.beta5] - 2024-05-23
 
 ### Changed
@@ -248,7 +254,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.0.0.beta5...main
+[Unreleased]: https://github.com/DataDog/datadog-ci-rb/compare/v1.0.0.beta6...main
+[1.0.0.beta6]: https://github.com/DataDog/datadog-ci-rb/compare/v1.0.0.beta5...v1.0.0.beta6
 [1.0.0.beta5]: https://github.com/DataDog/datadog-ci-rb/compare/v1.0.0.beta4...v1.0.0.beta5
 [1.0.0.beta4]: https://github.com/DataDog/datadog-ci-rb/compare/v1.0.0.beta3...v1.0.0.beta4
 [1.0.0.beta3]: https://github.com/DataDog/datadog-ci-rb/compare/v1.0.0.beta2...v1.0.0.beta3
@@ -350,4 +357,5 @@ Currently test suite level visibility is not used by our instrumentation: it wil
 [#173]: https://github.com/DataDog/datadog-ci-rb/issues/173
 [#174]: https://github.com/DataDog/datadog-ci-rb/issues/174
 [#175]: https://github.com/DataDog/datadog-ci-rb/issues/175
-[#180]: https://github.com/DataDog/datadog-ci-rb/issues/180
+[#180]: https://github.com/DataDog/datadog-ci-rb/issues/180
+[#183]: https://github.com/DataDog/datadog-ci-rb/issues/183

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

@@ -0,0 +1,31 @@
+# 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/minitest/reporter.rb

@@ -13,7 +13,7 @@ module Datadog
           end
 
           module InstanceMethods
-            def report(*)
+            def report(*args)
               return super unless datadog_configuration[:enabled]
 
               res = super

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

@@ -10,7 +10,7 @@ module Datadog
           end
 
           module ClassMethods
-            def run(*)
+            def run(*args)
               return super unless datadog_configuration[:enabled]
               return super if Helpers.parallel?(self)
 

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

@@ -13,7 +13,7 @@ module Datadog
           end
 
           module ClassMethods
-            def init_plugins(*)
+            def init_plugins(*args)
               super
 
               return unless datadog_configuration[:enabled]

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

@@ -16,7 +16,7 @@ module Datadog
           end
 
           module InstanceMethods
-            def run(*)
+            def run(*args)
               return super if ::RSpec.configuration.dry_run?
               return super unless datadog_configuration[:enabled]
 

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

@@ -14,7 +14,7 @@ module Datadog
             end
 
             module InstanceMethods
-              def knapsack__run_specs(*)
+              def knapsack__run_specs(*args)
                 return super if ::RSpec.configuration.dry_run?
                 return super unless datadog_configuration[:enabled]
 

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

@@ -14,7 +14,7 @@ module Datadog
           end
 
           module InstanceMethods
-            def run_specs(*)
+            def run_specs(*args)
               return super if ::RSpec.configuration.dry_run?
               return super unless datadog_configuration[:enabled]
 

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require "datadog/tracing/contrib/patcher"
+
+require_relative "ext"
+require_relative "rum"
+require_relative "../../ext/test"
+
+module Datadog
+  module CI
+    module Contrib
+      module Selenium
+        # instruments Capybara::Selenium::Driver
+        module CapybaraDriver
+          def self.included(base)
+            base.prepend(InstanceMethods)
+          end
+
+          module InstanceMethods
+            def reset!
+              return super unless datadog_configuration[:enabled]
+
+              Datadog.logger.debug("[Selenium] Capybara session reset event")
+
+              RUM.stop_rum_session(@browser)
+
+              Datadog.logger.debug("[Selenium] RUM session stopped, deleting cookie")
+              @browser.manage.delete_cookie(Ext::COOKIE_TEST_EXECUTION_ID)
+            rescue ::Selenium::WebDriver::Error::WebDriverError => e
+              Datadog.logger.debug("[Selenium] Error while resetting Capybara session: #{e.message}")
+            ensure
+              super
+            end
+
+            private
+
+            def datadog_configuration
+              Datadog.configuration.ci[:selenium]
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+require "datadog/core"
+
+require_relative "../ext"
+require_relative "../../settings"
+
+module Datadog
+  module CI
+    module Contrib
+      module Selenium
+        module Configuration
+          # Custom settings for the Selenium integration
+          # @public_api
+          class Settings < Datadog::CI::Contrib::Settings
+            option :enabled do |o|
+              o.type :bool
+              o.env Ext::ENV_ENABLED
+              o.default true
+            end
+
+            option :rum_flush_wait_millis do |o|
+              o.type :int
+              o.env Ext::ENV_RUM_FLUSH_WAIT_MILLIS
+              o.default 500
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require "datadog/tracing/contrib/patcher"
+
+require_relative "ext"
+require_relative "rum"
+require_relative "../../ext/test"
+
+module Datadog
+  module CI
+    module Contrib
+      module Selenium
+        # instruments Selenium::WebDriver::Driver
+        module Driver
+          def self.included(base)
+            base.prepend(InstanceMethods)
+          end
+
+          module InstanceMethods
+            def quit
+              return super unless datadog_configuration[:enabled]
+
+              Datadog.logger.debug("[Selenium] Driver quit event")
+
+              RUM.stop_rum_session(@bridge)
+
+              Datadog.logger.debug("[Selenium] RUM session stopped, deleting cookie")
+              @bridge.manage.delete_cookie(Ext::COOKIE_TEST_EXECUTION_ID)
+            rescue ::Selenium::WebDriver::Error::WebDriverError => e
+              Datadog.logger.debug("[Selenium] Error while quitting Selenium driver: #{e.message}")
+            ensure
+              super
+            end
+
+            private
+
+            def datadog_configuration
+              Datadog.configuration.ci[:selenium]
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Datadog
+  module CI
+    module Contrib
+      module Selenium
+        # Selenium integration constants
+        # @public_api
+        module Ext
+          ENV_ENABLED = "DD_CIVISIBILITY_SELENIUM_ENABLED"
+          ENV_RUM_FLUSH_WAIT_MILLIS = "DD_CIVISIBILITY_RUM_FLUSH_WAIT_MILLIS"
+
+          COOKIE_TEST_EXECUTION_ID = "datadog-ci-visibility-test-execution-id"
+
+          SCRIPT_IS_RUM_ACTIVE = <<~JS
+            return !!window.DD_RUM
+          JS
+          SCRIPT_STOP_RUM_SESSION = <<~JS
+            if (window.DD_RUM && window.DD_RUM.stopSession) {
+              window.DD_RUM.stopSession();
+              return true;
+            } else {
+              return false;
+            }
+          JS
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+require_relative "../integration"
+require_relative "configuration/settings"
+require_relative "patcher"
+
+module Datadog
+  module CI
+    module Contrib
+      module Selenium
+        # Description of Selenium integration
+        class Integration
+          include Datadog::CI::Contrib::Integration
+
+          MINIMUM_VERSION = Gem::Version.new("4.0.0")
+
+          register_as :selenium
+
+          def self.version
+            Gem.loaded_specs["selenium-webdriver"]&.version
+          end
+
+          def self.loaded?
+            !defined?(::Selenium).nil? && !defined?(::Selenium::WebDriver).nil? &&
+              !defined?(::Selenium::WebDriver::Driver).nil?
+          end
+
+          def self.compatible?
+            super && version >= MINIMUM_VERSION
+          end
+
+          # additional instrumentations for test helpers are auto instrumented on test session start
+          def auto_instrument?
+            true
+          end
+
+          def new_configuration
+            Configuration::Settings.new
+          end
+
+          def patcher
+            Patcher
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,74 @@
+# frozen_string_literal: true
+
+require "datadog/tracing/contrib/patcher"
+
+require_relative "ext"
+require_relative "../../ext/test"
+
+module Datadog
+  module CI
+    module Contrib
+      module Selenium
+        # instruments Selenium::WebDriver::Navigation
+        module Navigation
+          def self.included(base)
+            base.prepend(InstanceMethods)
+          end
+
+          module InstanceMethods
+            def to(url)
+              result = super
+
+              return result unless datadog_configuration[:enabled]
+
+              Datadog.logger.debug("[Selenium] Navigation to #{url}")
+
+              # on session reset Capybara navigates to about:blank
+              return result if url == "about:blank"
+
+              active_test = Datadog::CI.active_test
+              Datadog.logger.debug("[Selenium] Active test: #{active_test}")
+
+              return result unless active_test
+
+              # Set the test's trace id as a cookie in browser session
+              cookie_hash = {name: Ext::COOKIE_TEST_EXECUTION_ID, value: active_test.trace_id.to_s}
+              Datadog.logger.debug { "[Selenium] Setting cookie: #{cookie_hash}" }
+              @bridge.manage.add_cookie(cookie_hash)
+
+              # set the test type to browser
+              active_test.set_tag(CI::Ext::Test::TAG_TYPE, CI::Ext::Test::Type::BROWSER)
+
+              # set the tags specific to the browser test
+              active_test.set_tag(CI::Ext::Test::TAG_BROWSER_DRIVER, "selenium")
+              active_test.set_tag(
+                CI::Ext::Test::TAG_BROWSER_DRIVER_VERSION,
+                Integration.version
+              )
+              active_test.set_tag(
+                CI::Ext::Test::TAG_BROWSER_NAME,
+                @bridge.browser
+              )
+              active_test.set_tag(
+                CI::Ext::Test::TAG_BROWSER_VERSION,
+                @bridge.capabilities.browser_version
+              )
+
+              result
+            rescue ::Selenium::WebDriver::Error::WebDriverError => e
+              Datadog.logger.debug("[Selenium] Error while navigating: #{e.message}")
+
+              result
+            end
+
+            private
+
+            def datadog_configuration
+              Datadog.configuration.ci[:selenium]
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require "datadog/tracing/contrib/patcher"
+
+require_relative "capybara_driver"
+require_relative "driver"
+require_relative "navigation"
+
+module Datadog
+  module CI
+    module Contrib
+      module Selenium
+        # Patcher enables patching of 'Selenium::WebDriver' module.
+        module Patcher
+          include Datadog::Tracing::Contrib::Patcher
+
+          module_function
+
+          def target_version
+            Integration.version
+          end
+
+          def patch
+            ::Selenium::WebDriver::Driver.include(Driver)
+            ::Selenium::WebDriver::Navigation.include(Navigation)
+
+            # capybara calls `reset!` after each test, so we need to patch it as well
+            if defined?(::Capybara::Selenium::Driver)
+              ::Capybara::Selenium::Driver.include(CapybaraDriver)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+require "datadog/tracing/contrib/patcher"
+
+require_relative "ext"
+require_relative "../../ext/test"
+require_relative "../../utils/parsing"
+
+module Datadog
+  module CI
+    module Contrib
+      module Selenium
+        # Provides functionality to interact with Datadog Real User Monitoring product
+        # via executing JavaScript code in the browser.
+        #
+        # Relevant docs: https://docs.datadoghq.com/real_user_monitoring/browser/
+        module RUM
+          def self.is_rum_active?(script_executor)
+            is_rum_active_script_result = script_executor.execute_script(Ext::SCRIPT_IS_RUM_ACTIVE)
+            Datadog.logger.debug { "[Selenium] SCRIPT_IS_RUM_ACTIVE result is #{is_rum_active_script_result.inspect}" }
+            Utils::Parsing.convert_to_bool(is_rum_active_script_result)
+          end
+
+          def self.stop_rum_session(script_executor)
+            config = Datadog.configuration.ci[:selenium]
+            if is_rum_active?(script_executor)
+              Datadog::CI.active_test&.set_tag(
+                CI::Ext::Test::TAG_IS_RUM_ACTIVE,
+                "true"
+              )
+
+              result = script_executor.execute_script(Ext::SCRIPT_STOP_RUM_SESSION)
+              Datadog.logger.debug { "[Selenium] SCRIPT_STOP_RUM_SESSION result is #{result.inspect}" }
+
+              # introduce a delay to allow the RUM session to be stopped
+              delay = config[:rum_flush_wait_millis] / 1000.0
+              Datadog.logger.debug { "[Selenium] Waiting for #{delay} seconds" }
+              sleep(delay)
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -8,6 +8,7 @@ module Datadog
       module Test
         CONTEXT_ORIGIN = "ciapp-test"
 
+        # Base test visibility tags
         TAG_FRAMEWORK = "test.framework"
         TAG_FRAMEWORK_VERSION = "test.framework_version"
         TAG_NAME = "test.name"
@@ -34,16 +35,13 @@ module Datadog
         # Code coverage tags
         TAG_CODE_COVERAGE_ENABLED = "test.code_coverage.enabled"
 
-        # those tags are special and used to correlate tests with the test sessions, suites, and modules
-        # they are transient and not sent to the backend
+        # Special tags, not sent to the backend.
+        # these tags are special and 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"
         TRANSIENT_TAGS = [TAG_TEST_SESSION_ID, TAG_TEST_MODULE_ID, TAG_TEST_SUITE_ID].freeze
 
-        # tags that are common for the whole session and can be inherited from the test session
-        INHERITABLE_TAGS = [TAG_FRAMEWORK, TAG_FRAMEWORK_VERSION].freeze
-
         # Environment runtime tags
         TAG_OS_ARCHITECTURE = "os.architecture"
         TAG_OS_PLATFORM = "os.platform"
@@ -51,10 +49,24 @@ module Datadog
         TAG_RUNTIME_NAME = "runtime.name"
         TAG_RUNTIME_VERSION = "runtime.version"
 
+        # Tags for browser tests
+        # true if Datadog RUM was detected in the page(s) loaded by Selenium
+        TAG_IS_RUM_ACTIVE = "test.is_rum_active"
+        TAG_BROWSER_DRIVER = "test.browser.driver"
+        # version of selenium driver used
+        TAG_BROWSER_DRIVER_VERSION = "test.browser.driver_version"
+        # name of the browser (Chrome, Firefox, Edge, etc), if multiple browsers then this tag is empty
+        TAG_BROWSER_NAME = "test.browser.name"
+        # version of the browser, if multiple browsers or multiple versions then this tag is empty
+        TAG_BROWSER_VERSION = "test.browser.version"
+
         # internal APM tag to mark a span as a test span
         TAG_SPAN_KIND = "span.kind"
         SPAN_KIND_TEST = "test"
 
+        # tags that are common for the whole session and can be inherited from the test session
+        INHERITABLE_TAGS = [TAG_FRAMEWORK, TAG_FRAMEWORK_VERSION].freeze
+
         # could be either "test" or "suite" depending on whether we skip individual tests or whole suites
         # we use test skipping for Ruby
         ITR_TEST_SKIPPING_MODE = "test"
@@ -71,6 +83,7 @@ module Datadog
         # test types (e.g. test, benchmark, browser)
         module Type
           TEST = "test"
+          BROWSER = "browser"
           BENCHMARK = "benchmark" # DEV: not used yet, will be used when benchmarks are supported
         end
       end

data/lib/datadog/ci/span.rb

@@ -23,6 +23,11 @@ module Datadog
         tracer_span.id
       end
 
+      # @return [Integer] the trace ID of the trace this span belongs to
+      def trace_id
+        tracer_span.trace_id
+      end
+
       # @return [String] the name of the span.
       def name
         tracer_span.name

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

@@ -10,6 +10,7 @@ require_relative "context/global"
 require_relative "context/local"
 
 require_relative "../codeowners/parser"
+require_relative "../contrib/contrib"
 require_relative "../ext/app_types"
 require_relative "../ext/test"
 require_relative "../ext/environment"
@@ -57,6 +58,9 @@ module Datadog
         def start_test_session(service: nil, tags: {})
           return skip_tracing unless test_suite_level_visibility_enabled
 
+          # finds and instruments additional test libraries that we support (ex: selenium-webdriver)
+          Contrib.auto_instrument_on_session_start!
+
           @global_context.fetch_or_activate_test_session do
             tracer_span = start_datadog_tracer_span(
               "test.session", build_span_options(service, Ext::AppTypes::TYPE_TEST_SESSION)

data/lib/datadog/ci/version.rb

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

data/lib/datadog/ci.rb

@@ -376,6 +376,7 @@ end
 require_relative "ci/contrib/cucumber/integration"
 require_relative "ci/contrib/rspec/integration"
 require_relative "ci/contrib/minitest/integration"
+require_relative "ci/contrib/selenium/integration"
 
 # Configuration extensions
 require_relative "ci/configuration/extensions"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: datadog-ci
 version: !ruby/object:Gem::Version
-  version: 1.0.0.beta5
+  version: 1.0.0.beta6
 platform: ruby
 authors:
 - Datadog, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-05-23 00:00:00.000000000 Z
+date: 2024-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: datadog
@@ -66,6 +66,7 @@ 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/cucumber/configuration/settings.rb
 - lib/datadog/ci/contrib/cucumber/ext.rb
 - lib/datadog/ci/contrib/cucumber/formatter.rb
@@ -93,6 +94,14 @@ files:
 - 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
+- lib/datadog/ci/contrib/selenium/configuration/settings.rb
+- lib/datadog/ci/contrib/selenium/driver.rb
+- lib/datadog/ci/contrib/selenium/ext.rb
+- lib/datadog/ci/contrib/selenium/integration.rb
+- lib/datadog/ci/contrib/selenium/navigation.rb
+- lib/datadog/ci/contrib/selenium/patcher.rb
+- lib/datadog/ci/contrib/selenium/rum.rb
 - lib/datadog/ci/contrib/settings.rb
 - lib/datadog/ci/ext/app_types.rb
 - lib/datadog/ci/ext/environment.rb