datadog-ci 1.0.0.beta5 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d82afa69ce303c4d7652a9455b4f19c6e89fe5afda868a10bf2b42c765bc06d
-  data.tar.gz: 5b2c939c277b4f0b712fcdd3d361cef50302e9947feac333b49bfcea5cd83e4d
+  metadata.gz: 7f96afc61b44202e506967dc7b2d6ec956c02561a99ec7e9eae4dc26902688b7
+  data.tar.gz: f6d66d038f8c5a5632f6c27ed2a3c70d9f85394fca2c237825041cb523063ec4
 SHA512:
-  metadata.gz: f315f6d11021a34dc32815ffa1fea4ffddd4e894253aa8c69225d40fb10930e50949a5bd11237aa9f15f60bca171e4781efbf24e1edce24f239b513819c41741
-  data.tar.gz: 80df3261fb5fbb357d4bdcec7b530de26ece4316ba5f289e9254b1e8fcc6129d58e9cf2cada61e81a98500c2aea03aa6410e0a25696148c782c74e99da44fc95
+  metadata.gz: a6a548db92e125ae6fdb23301554efec581f72ca63b9a32384be33162eb90daa79ebf67ccb5834f2347b094f8d131129cd4a6963a817c55beaed83e0cd10b96b
+  data.tar.gz: e6da7ae7f7607955b206859e8a6c583d65aea03c59d538de2c3c7de41433a0b9942fe48e6d79db9bc7cb6546100b001dfd90b421c7ed392aa6d10e14034ecd08

data/CHANGELOG.md

@@ -1,5 +1,18 @@
 ## [Unreleased]
 
+## [1.0.0] - 2024-06-06
+
+
+### Changed
+* automatically trace with correct time even when time is stubbed by timecop ([#185][])
+* depend on gem datadog ~> 2.0 ([#190][])
+
+## [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 +261,9 @@ 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...main
+[1.0.0]: https://github.com/DataDog/datadog-ci-rb/compare/v1.0.0.beta6...v1.0.0
+[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 +365,7 @@ 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
+[#185]: https://github.com/DataDog/datadog-ci-rb/issues/185
+[#190]: https://github.com/DataDog/datadog-ci-rb/issues/190

data/README.md

@@ -1,13 +1,23 @@
-# Datadog CI Visibility for Ruby
+# Datadog Test Visibility for Ruby
 
 [![Gem Version](https://badge.fury.io/rb/datadog-ci.svg)](https://badge.fury.io/rb/datadog-ci)
 [![YARD documentation](https://img.shields.io/badge/YARD-documentation-blue)](https://datadoghq.dev/datadog-ci-rb/)
 [![codecov](https://codecov.io/gh/DataDog/datadog-ci-rb/branch/main/graph/badge.svg)](https://app.codecov.io/gh/DataDog/datadog-ci-rb/branch/main)
 [![CircleCI](https://dl.circleci.com/status-badge/img/gh/DataDog/datadog-ci-rb/tree/main.svg?style=svg)](https://dl.circleci.com/status-badge/redirect/gh/DataDog/datadog-ci-rb/tree/main)
 
-Datadog's Ruby Library for instrumenting your test and continuous integration pipeline.
+Datadog's Ruby Library for instrumenting your tests.
 Learn more on our [official website](https://docs.datadoghq.com/tests/) and check out our [documentation for this library](https://docs.datadoghq.com/tests/setup/ruby/?tab=cloudciprovideragentless).
 
+## Features
+
+- [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
+- [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/)
+- [Add custom measures to your tests](https://docs.datadoghq.com/tests/guides/add_custom_measures/?tab=ruby)
+- [Browser tests integration with Datadog RUM](https://docs.datadoghq.com/tests/browser_tests)
+
 ## Installation
 
 Add to your Gemfile.
@@ -22,210 +32,10 @@ end
 
 If you used [test visibility for Ruby](https://docs.datadoghq.com/tests/setup/ruby/) with [ddtrace](https://github.com/datadog/dd-trace-rb) gem, check out our [upgrade guide](/docs/UpgradeGuide.md).
 
-## Usage
-
-### RSpec
-
-To activate `RSpec` integration, add this to the `spec_helper.rb` file:
-
-```ruby
-require 'rspec'
-require 'datadog/ci'
-
-# Only activates test instrumentation on CI
-if ENV["DD_ENV"] == "ci"
-  Datadog.configure do |c|
-    # The name of the service or library under test
-    c.service = 'my-ruby-app'
-    c.ci.enabled = true
-    c.ci.instrument :rspec
-  end
-end
-```
-
-### Minitest
-
-The Minitest integration will trace all executions of tests when using `minitest` test framework.
-
-To activate your integration, use the `Datadog.configure` method:
-
-```ruby
-require 'minitest'
-require 'datadog/ci'
-
-# Only activates test instrumentation on CI
-if ENV["DD_ENV"] == "ci"
-# Configure default Minitest integration
-  Datadog.configure do |c|
-    # The name of the service or library under test
-    c.service = 'my-ruby-app'
-    c.ci.enabled = true
-    c.ci.instrument :minitest
-  end
-end
-```
-
-> [!IMPORTANT]
-> When using `minitest/autorun` the order of requires matters: `datadog/ci` must be
-> always required before `minitest/autorun`.
-
-Example using `minitest/autorun`
-
-```ruby
-require 'datadog/ci'
-require 'minitest/autorun'
-
-if ENV["DD_ENV"] == "ci"
-  Datadog.configure do |c|
-    c.service = 'my-ruby-app'
-    c.ci.enabled = true
-    c.ci.instrument :minitest
-  end
-end
-```
-
-### Cucumber
-
-Activate `Cucumber` integration with configuration
-
-```ruby
-require 'cucumber'
-require 'datadog/ci'
-
-# Only activates test instrumentation on CI
-if ENV["DD_ENV"] == "ci"
-  Datadog.configure do |c|
-    # The name of the service or library under test
-    c.service = 'my-ruby-app'
-    c.ci.enabled = true
-    c.ci.instrument :cucumber
-  end
-end
-```
-
-### Instrumentation options
-
-Configuration `ci.instrument` accepts the following optional parameters:
+## Setup
 
-- `enabled` (default: `true`) - defines whether tests should be traced (useful for temporarily disabling tracing)
-- `service_name` - name of the service or library under test (when you want it to be different for a test framework)
-
-Example usage:
-
-```ruby
-  Datadog.configure do |c|
-    c.service = 'my-ruby-app'
-    c.ci.enabled = true
-    c.ci.instrument :cucumber, service_name: 'my-cucumber-features', enabled: true
-    c.ci.instrument :minitest, service_name: 'my-unit-tests', enabled: false
-  end
-```
-
-## Agentless mode
-
-If you are using a cloud CI provider without access to the underlying worker nodes, such as GitHub Actions or CircleCI, configure the library to use the Agentless mode. For this, set the following environment variables:
-`DD_CIVISIBILITY_AGENTLESS_ENABLED=true (Required)` and `DD_API_KEY=your_secret_api_key (Required)`.
-
-Additionally, configure which [Datadog site](https://docs.datadoghq.com/getting_started/site/) you want to send data to:
-`DD_SITE=your.datadoghq.com` (datadoghq.com by default).
-
-Agentless mode can also be enabled via `Datadog.configure` (but don't forget to set DD_API_KEY environment variable):
-
-```ruby
-Datadog.configure { |c| c.ci.agentless_mode_enabled = true }
-```
-
-## Additional configuration
-
-### Add tracing instrumentations
-
-It can be useful to have rich tracing information about your tests that includes time spent performing database operations
-or other external calls like here:
-
-![Test trace with redis instrumented](./docs/screenshots/test-trace-with-redis.png)
-
-To achieve this, add Datadog tracing instrumentations in your `Datadog.configure` block:
-
-```ruby
-Datadog.configure do |c|
-  #  ... ci configs and instrumentation here ...
-  c.tracing.instrument :redis
-  c.tracing.instrument :pg
-end
-```
-
-...or enable auto instrumentation in your test_helper/spec_helper:
-
-```ruby
-require "datadog/auto_instrument"
-```
-
-Note: in CI mode these traces are going to be submitted to CI Visibility,
-they will **not** show up in Datadog APM.
-
-For the full list of available instrumentations see [datadog documentation](https://github.com/DataDog/dd-trace-rb/blob/master/docs/GettingStarted.md)
-
-### WebMock
-
-[WebMock](https://github.com/bblimke/webmock)
-is a popular Ruby library that stubs HTTP requests when running tests.
-By default it fails when used together with datadog-ci as traces are being sent
-to Datadog via HTTP calls.
-
-In order to allow HTTP connections for Datadog backend you would need to configure
-Webmock accordingly.
-
-```ruby
-# when using agentless mode
-WebMock.disable_net_connect!(:allow => /datadoghq/)
-
-# when using agent
-WebMock.disable_net_connect!(:allow_localhost => true)
-
-# or for more granular setting set your agent URL
-WebMock.disable_net_connect!(:allow => "localhost:8126")
-```
-
-### VCR
-
-[VCR](https://github.com/vcr/vcr) is another popular testing library for HTTP interactions.
-
-It requires additional configuration to correctly work with datadog-ci:
-
-```ruby
-VCR.configure do |config|
-  # ... your usual configuration here ...
-
-  # when using agent
-  config.ignore_hosts "127.0.0.1", "localhost"
-
-  # when using agentless mode
-  config.ignore_request do |request|
-    # ignore all requests to datadoghq hosts
-    request.uri =~ /datadoghq/
-  end
-end
-```
-
-### Disabling startup logs
-
-Startup logs produce a report of tracing state when the application is initially configured.
-These logs are activated by default in test mode, if you don't want them you can disable this
-via `DD_TRACE_STARTUP_LOGS=0` or in the `Datadog.configure` block:
-
-```ruby
-Datadog.configure { |c| c.diagnostics.startup_logs.enabled = false }
-```
-
-### Enabling debug mode
-
-Switching the library into debug mode will produce verbose, detailed logs about tracing activity, including any suppressed errors. This output can be helpful in identifying errors, confirming trace output, or catching HTTP transport issues.
-
-You can enable this via `DD_TRACE_DEBUG=1` or in the `Datadog.configure` block:
-
-```ruby
-Datadog.configure { |c| c.diagnostics.debug = true }
-```
+- [Test visibility setup](https://docs.datadoghq.com/tests/setup/ruby/?tab=cloudciprovideragentless)
+- [Intelligent test runner setup](https://docs.datadoghq.com/intelligent_test_runner/setup/ruby) (test visibility setup is required before setting up intelligent test runner)
 
 ## Contributing
 

data/lib/datadog/ci/codeowners/matcher.rb

@@ -87,7 +87,7 @@ module Datadog
           return pattern if pattern == "*"
 
           # if pattern ends with a slash then it matches everything deeply nested in this directory
-          pattern += "**" if pattern.end_with?(::File::SEPARATOR)
+          pattern << "**" if pattern.end_with?(::File::SEPARATOR)
 
           # if pattern doesn't start with a slash then it matches anywhere in the repository
           if !pattern.start_with?(::File::SEPARATOR, "**#{::File::SEPARATOR}", "*#{::File::SEPARATOR}")

data/lib/datadog/ci/codeowners/parser.rb

@@ -8,11 +8,11 @@ module Datadog
       # Responsible for parsing a CODEOWNERS file
       class Parser
         DEFAULT_LOCATION = "CODEOWNERS"
-        POSSIBLE_CODEOWNERS_LOCATIONS = [
-          "CODEOWNERS",
-          ".github/CODEOWNERS",
-          ".gitlab/CODEOWNERS",
-          "docs/CODEOWNERS"
+        POSSIBLE_CODEOWNERS_LOCATIONS = %w[
+          CODEOWNERS
+          .github/CODEOWNERS
+          .gitlab/CODEOWNERS
+          docs/CODEOWNERS
         ].freeze
 
         def initialize(root_file_path)

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

@@ -70,6 +70,17 @@ module Datadog
           # Choose user defined TraceFlush or default to CI TraceFlush
           settings.tracing.test_mode.trace_flush = settings.ci.trace_flush || CI::TestVisibility::Flush::Partial.new
 
+          # When timecop is present, Time.now is mocked and .now_without_mock_time is added on Time to
+          # get the current time without the mock.
+          if timecop?
+            settings.time_now_provider = -> do
+              Time.now_without_mock_time
+            rescue NoMethodError
+              # fallback to normal Time.now if Time.now_without_mock_time is not defined for any reason
+              Time.now
+            end
+          end
+
           # startup logs are useless for CI visibility and create noise
           settings.diagnostics.startup_logs.enabled = false
 
@@ -191,6 +202,10 @@ module Datadog
             "Please make sure to set valid site in DD_SITE environment variable"
           end
         end
+
+        def timecop?
+          Gem.loaded_specs.key?("timecop") || defined?(Timecop)
+        end
       end
     end
   end

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/cucumber/formatter.rb

@@ -187,7 +187,7 @@ module Datadog
           def ok?(result, strict)
             # in minor update in Cucumber 9.2.0, the arity of the `ok?` method changed
             parameters = result.method(:ok?).parameters
-            if parameters == [[:opt, :be_strict]]
+            if parameters == [%i[opt be_strict]]
               result.ok?(strict)
             else
               result.ok?(strict: strict)

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,14 +16,14 @@ module Datadog
           end
 
           module InstanceMethods
-            def run(*)
+            def run(*args)
               return super if ::RSpec.configuration.dry_run?
               return super unless datadog_configuration[:enabled]
 
               test_name = full_description.strip
               if metadata[:description].empty?
                 # for unnamed it blocks this appends something like "example at ./spec/some_spec.rb:10"
-                test_name += " #{description}"
+                test_name << " #{description}"
               end
 
               test_suite_description = fetch_top_level_example_group[:description]
@@ -33,7 +33,7 @@ module Datadog
               test_name = test_name.sub(test_suite_description, "").strip
 
               if ci_queue?
-                suite_name += " (ci-queue running example [#{test_name}])"
+                suite_name = "#{suite_name} (ci-queue running example [#{test_name}])"
                 test_suite_span = CI.start_test_suite(suite_name)
               end
 
@@ -83,9 +83,12 @@ module Datadog
             private
 
             def fetch_top_level_example_group
-              return metadata[:example_group] unless metadata[:example_group][:parent_example_group]
+              example_group = metadata[:example_group]
+              parent_example_group = example_group[:parent_example_group]
 
-              res = metadata[:example_group][:parent_example_group]
+              return example_group unless parent_example_group
+
+              res = parent_example_group
               while (parent = res[:parent_example_group])
                 res = parent
               end

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/environment/providers/gitlab.rb

@@ -75,12 +75,12 @@ module Datadog
             end
 
             def git_commit_author_name
-              name, _ = extract_name_email
+              name, _email = extract_name_email
               name
             end
 
             def git_commit_author_email
-              _, email = extract_name_email
+              _name, email = extract_name_email
               email
             end
 

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

@@ -23,10 +23,7 @@ module Datadog
         TAG_NODE_NAME = "ci.node.name"
         TAG_CI_ENV_VARS = "_dd.ci.env_vars"
 
-        POSSIBLE_BUNDLE_LOCATIONS = [
-          "vendor/bundle",
-          ".bundle"
-        ].freeze
+        POSSIBLE_BUNDLE_LOCATIONS = %w[vendor/bundle .bundle].freeze
 
         module_function
 

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

@@ -15,13 +15,13 @@ module Datadog
         ENV_ITR_CODE_COVERAGE_EXCLUDED_BUNDLE_PATH = "DD_CIVISIBILITY_ITR_CODE_COVERAGE_EXCLUDED_BUNDLE_PATH"
 
         # 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"
+        DD_SITE_ALLOWLIST = %w[
+          datadoghq.com
+          us3.datadoghq.com
+          us5.datadoghq.com
+          datadoghq.eu
+          ddog-gov.com
+          ap1.datadoghq.com
         ].freeze
       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/itr/coverage/event.rb

@@ -21,7 +21,7 @@ module Datadog
           def valid?
             valid = true
 
-            [:test_id, :test_suite_id, :test_session_id, :coverage].each do |key|
+            %i[test_id test_suite_id test_session_id coverage].each do |key|
               next unless send(key).nil?
 
               Datadog.logger.warn("citestcov event is invalid: [#{key}] is nil. Event: #{self}")

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/test_visibility/serializers/base.rb

@@ -20,13 +20,7 @@ module Datadog
             "type" => "span_type"
           ].freeze
 
-          REQUIRED_FIELDS = [
-            "error",
-            "name",
-            "resource",
-            "start",
-            "duration"
-          ].freeze
+          REQUIRED_FIELDS = %w[error name resource start duration].freeze
 
           attr_reader :trace, :span, :meta, :options
 

data/lib/datadog/ci/test_visibility/serializers/span.rb

@@ -7,11 +7,11 @@ module Datadog
     module TestVisibility
       module Serializers
         class Span < Base
-          CONTENT_FIELDS = (["trace_id", "span_id", "parent_id"] + Base::CONTENT_FIELDS).freeze
+          CONTENT_FIELDS = (%w[trace_id span_id parent_id] + Base::CONTENT_FIELDS).freeze
 
           CONTENT_MAP_SIZE = calculate_content_map_size(CONTENT_FIELDS)
 
-          REQUIRED_FIELDS = (["trace_id", "span_id"] + Base::REQUIRED_FIELDS).freeze
+          REQUIRED_FIELDS = (%w[trace_id span_id] + Base::REQUIRED_FIELDS).freeze
 
           def content_fields
             CONTENT_FIELDS

data/lib/datadog/ci/test_visibility/serializers/test_module.rb

@@ -8,11 +8,11 @@ module Datadog
     module TestVisibility
       module Serializers
         class TestModule < Base
-          CONTENT_FIELDS = (["test_session_id", "test_module_id"] + Base::CONTENT_FIELDS).freeze
+          CONTENT_FIELDS = (%w[test_session_id test_module_id] + Base::CONTENT_FIELDS).freeze
 
           CONTENT_MAP_SIZE = calculate_content_map_size(CONTENT_FIELDS)
 
-          REQUIRED_FIELDS = (["test_session_id", "test_module_id"] + Base::REQUIRED_FIELDS).freeze
+          REQUIRED_FIELDS = (%w[test_session_id test_module_id] + Base::REQUIRED_FIELDS).freeze
 
           def content_fields
             CONTENT_FIELDS

data/lib/datadog/ci/test_visibility/serializers/test_session.rb

@@ -8,11 +8,11 @@ module Datadog
     module TestVisibility
       module Serializers
         class TestSession < Base
-          CONTENT_FIELDS = (["test_session_id"] + Base::CONTENT_FIELDS).freeze
+          CONTENT_FIELDS = (%w[test_session_id] + Base::CONTENT_FIELDS).freeze
 
           CONTENT_MAP_SIZE = calculate_content_map_size(CONTENT_FIELDS)
 
-          REQUIRED_FIELDS = (["test_session_id"] + Base::REQUIRED_FIELDS).freeze
+          REQUIRED_FIELDS = (%w[test_session_id] + Base::REQUIRED_FIELDS).freeze
 
           def content_fields
             CONTENT_FIELDS

data/lib/datadog/ci/test_visibility/serializers/test_suite.rb

@@ -8,11 +8,11 @@ module Datadog
     module TestVisibility
       module Serializers
         class TestSuite < Base
-          CONTENT_FIELDS = (["test_session_id", "test_module_id", "test_suite_id"] + Base::CONTENT_FIELDS).freeze
+          CONTENT_FIELDS = (%w[test_session_id test_module_id test_suite_id] + Base::CONTENT_FIELDS).freeze
 
           CONTENT_MAP_SIZE = calculate_content_map_size(CONTENT_FIELDS)
 
-          REQUIRED_FIELDS = (["test_session_id", "test_module_id", "test_suite_id"] + Base::REQUIRED_FIELDS).freeze
+          REQUIRED_FIELDS = (%w[test_session_id test_module_id test_suite_id] + Base::REQUIRED_FIELDS).freeze
 
           def content_fields
             CONTENT_FIELDS

data/lib/datadog/ci/test_visibility/serializers/test_v1.rb

@@ -8,11 +8,11 @@ module Datadog
     module TestVisibility
       module Serializers
         class TestV1 < Base
-          CONTENT_FIELDS = (["trace_id", "span_id"] + Base::CONTENT_FIELDS).freeze
+          CONTENT_FIELDS = (%w[trace_id span_id] + Base::CONTENT_FIELDS).freeze
 
           CONTENT_MAP_SIZE = calculate_content_map_size(CONTENT_FIELDS)
 
-          REQUIRED_FIELDS = (["trace_id", "span_id"] + Base::REQUIRED_FIELDS).freeze
+          REQUIRED_FIELDS = (%w[trace_id span_id] + Base::REQUIRED_FIELDS).freeze
 
           def content_fields
             CONTENT_FIELDS

data/lib/datadog/ci/test_visibility/serializers/test_v2.rb

@@ -8,15 +8,15 @@ module Datadog
     module TestVisibility
       module Serializers
         class TestV2 < TestV1
-          CONTENT_FIELDS = (["test_session_id", "test_module_id", "test_suite_id"] + TestV1::CONTENT_FIELDS).freeze
+          CONTENT_FIELDS = (%w[test_session_id test_module_id test_suite_id] + TestV1::CONTENT_FIELDS).freeze
 
-          CONTENT_FIELDS_WITH_ITR_CORRELATION_ID = (CONTENT_FIELDS + ["itr_correlation_id"]).freeze
+          CONTENT_FIELDS_WITH_ITR_CORRELATION_ID = (CONTENT_FIELDS + %w[itr_correlation_id]).freeze
 
           CONTENT_MAP_SIZE = calculate_content_map_size(CONTENT_FIELDS)
 
           CONTENT_MAP_SIZE_WITH_ITR_CORRELATION_ID = calculate_content_map_size(CONTENT_FIELDS_WITH_ITR_CORRELATION_ID)
 
-          REQUIRED_FIELDS = (["test_session_id", "test_module_id", "test_suite_id"] + TestV1::REQUIRED_FIELDS).freeze
+          REQUIRED_FIELDS = (%w[test_session_id test_module_id test_suite_id] + TestV1::REQUIRED_FIELDS).freeze
 
           def content_fields
             return CONTENT_FIELDS if itr_correlation_id.nil?

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

@@ -124,6 +124,7 @@ module Datadog
           def gzipped?(payload)
             return false if payload.nil? || payload.empty?
 
+            # no-dd-sa
             first_bytes = payload[0, 2]
             return false if first_bytes.nil? || first_bytes.empty?
 

data/lib/datadog/ci/version.rb

@@ -6,7 +6,7 @@ module Datadog
       MAJOR = "1"
       MINOR = "0"
       PATCH = "0"
-      PRE = "beta5"
+      PRE = nil
       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
 platform: ruby
 authors:
 - Datadog, Inc.
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2024-05-23 00:00:00.000000000 Z
+date: 2024-06-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: datadog
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0.beta2
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0.beta2
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: msgpack
   requirement: !ruby/object:Gem::Requirement
@@ -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
@@ -192,7 +201,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 2.0.0
 requirements: []
-rubygems_version: 3.4.19
+rubygems_version: 3.5.9
 signing_key: 
 specification_version: 4
 summary: Datadog CI visibility for your ruby application