datadog-ci 0.1.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 20f65248441964ee0af226ab2a401cb0c3b951bdde8cd359cfb43f46f379e3e5
-  data.tar.gz: a8d4e496ae5037a5454072da2a0a3ca308b95889f0b077763f8ed1f4cd9f12b8
+  metadata.gz: ce3b4502404f6faa6b05421763ced6582071c9ad025937219b59ba8c63c39175
+  data.tar.gz: 7a341aa75161299cb04a29f745e172ef5ca4fec3a24f536ec96e08119de11a97
 SHA512:
-  metadata.gz: dbffc3a2f982924c33e896314d6425b2521830b301372f43fba4e6e3038bfd4b5053d4a5efa529086a9854e78c9dc2492cc74f1a9aa3ec295db91d8b7515d0a3
-  data.tar.gz: a477d14e4ab84c527cbfa988c41b9bbb521269e2c82fc1baaa0fc2ab488799d468b24274b79a40338cdec0500f100830f14a6eec83e286066533dbc90f63b19e
+  metadata.gz: 6058fbf497f43040a588018a2104055a303849d5616d063412dae4dab1e5247098e9ecd1b0b718776a51bc090f137d2bcf19cc78d252c7968c9cd6e4723ad902
+  data.tar.gz: 3c8d8eb9a34266a690a0dd5103d344b80df5175c703a414b1bc8255dc3c2732d723960e786765f2686fdcaaff5f009b675942c5e39dbd4a6fc9e58a38653051e

data/CHANGELOG.md

@@ -1,5 +1,26 @@
 ## [Unreleased]
 
+## [0.3.0] - 2023-10-25
+
+### Added
+
+* Add AWS CodePipeline support for automatic CI tags extraction ([#54][])
+* Support test visibility protocol via Datadog Agent with EVP proxy ([#51][])
+
+### Changed
+
+* Migrate to Net::HTTP adapter from Core module of ddtrace gem ([#49][])
+
+## [0.2.0] - 2023-10-05
+
+### Added
+
+* [CIAPP-2959] Agentless mode ([#33][])
+
+### Fixed
+
+* [CIAPP-4278] Fix an issue with emojis in commit message breaking LocalGit tags provider ([#40][])
+
 ## [0.1.1] - 2023-09-14
 
 ### Fixed
@@ -26,7 +47,9 @@
 
 * Ruby versions < 2.7 no longer supported ([#8][])
 
-[Unreleased]: https://github.com/DataDog/datadog-ci-rb/compare/v0.1.1...main
+[Unreleased]: https://github.com/DataDog/datadog-ci-rb/compare/v0.3.0...main
+[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
 
 <!--- The following link definition list is generated by PimpMyChangelog --->
@@ -38,3 +61,8 @@
 [#20]: https://github.com/DataDog/datadog-ci-rb/issues/20
 [#28]: https://github.com/DataDog/datadog-ci-rb/issues/28
 [#31]: https://github.com/DataDog/datadog-ci-rb/issues/31
+[#33]: https://github.com/DataDog/datadog-ci-rb/issues/33
+[#40]: https://github.com/DataDog/datadog-ci-rb/issues/40
+[#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

data/LICENSE-3rdparty.csv

@@ -1,2 +1,3 @@
 Component,Origin,License,Copyright
 dd-trace-rb,https://github.com/DataDog/dd-trace-rb,Apache 2.0,"Copyright 2016-Present Datadog, Inc."
+msgpack,https://rubygems.org/gems/msgpack,Apache-2.0,"Copyright (c) 2008-2015 Sadayuki Furuhashi"

data/README.md

@@ -117,6 +117,70 @@ end
 | `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'` |
 
+## 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)
+
+In order to achieve this you can configure ddtrace instrumentations in your configure block:
+
+```ruby
+Datadog.configure do |c|
+  #  ... ci configs and instrumentation here ...
+  c.instrument :redis
+  c.instrument :pg
+end
+```
+
+...or enable auto instrumentation in your test_helper/spec_helper:
+
+```ruby
+require "ddtrace/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 [ddtrace documentation](https://github.com/DataDog/dd-trace-rb/blob/master/docs/GettingStarted.md)
+
+### 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 `diagnostics.startup_logs.enabled = false` or `DD_TRACE_STARTUP_LOGS=0`.
+
+```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 `diagnostics.debug = true` or `DD_TRACE_DEBUG=1`.
+
+```ruby
+Datadog.configure { |c| c.diagnostics.debug = true }
+```
+
 ## Contributing
 
 See [development guide](/docs/DevelopmentGuide.md), [static typing guide](docs/StaticTypingGuide.md) and [contributing guidelines](/CONTRIBUTING.md).

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

@@ -1,6 +1,12 @@
 # frozen_string_literal: true
 
-require_relative "../flush"
+require "datadog/core/configuration/agent_settings_resolver"
+require "datadog/core/remote/negotiation"
+
+require_relative "../ext/transport"
+require_relative "../test_visibility/flush"
+require_relative "../test_visibility/transport"
+require_relative "../transport/api/builder"
 
 module Datadog
   module CI
@@ -16,15 +22,76 @@ module Datadog
         end
 
         def activate_ci!(settings)
+          test_visibility_transport = nil
+          agent_settings = Datadog::Core::Configuration::AgentSettingsResolver.call(settings)
+
+          if settings.ci.agentless_mode_enabled
+            test_visibility_transport = build_agentless_transport(settings)
+          elsif can_use_evp_proxy?(settings, agent_settings)
+            test_visibility_transport = build_evp_proxy_transport(settings, agent_settings)
+          end
+
+          # Deactivate telemetry
+          settings.telemetry.enabled = false
+
+          # Deactivate remote configuration
+          settings.remote.enabled = false
+
           # Activate underlying tracing test mode
           settings.tracing.test_mode.enabled = true
 
           # Choose user defined TraceFlush or default to CI TraceFlush
-          settings.tracing.test_mode.trace_flush = settings.ci.trace_flush \
-                                             || CI::Flush::Finished.new
+          settings.tracing.test_mode.trace_flush = settings.ci.trace_flush || CI::TestVisibility::Flush::Finished.new
+
+          writer_options = settings.ci.writer_options
+          if test_visibility_transport
+            writer_options[:transport] = test_visibility_transport
+            writer_options[:shutdown_timeout] = 60
+
+            settings.tracing.test_mode.async = true
+          end
+
+          settings.tracing.test_mode.writer_options = writer_options
+        end
+
+        def can_use_evp_proxy?(settings, agent_settings)
+          Datadog::Core::Remote::Negotiation.new(settings, agent_settings).endpoint?(
+            Ext::Transport::EVP_PROXY_PATH_PREFIX
+          )
+        end
+
+        def build_agentless_transport(settings)
+          if settings.api_key.nil?
+            # agentless mode is requested but no API key is provided -
+            # we cannot continue and log an error
+            # Tests are running without CI visibility enabled
+
+            Datadog.logger.error(
+              "DATADOG CONFIGURATION - CI VISIBILITY - ATTENTION - " \
+              "Agentless mode was enabled but DD_API_KEY is not set: CI visibility is disabled. " \
+              "Please make sure to set valid api key in DD_API_KEY environment variable"
+            )
+
+            settings.ci.enabled = false
+
+            nil
+          else
+            Datadog.logger.debug("CI visibility configured to use agentless transport")
+
+            Datadog::CI::TestVisibility::Transport.new(
+              api: Transport::Api::Builder.build_ci_test_cycle_api(settings),
+              dd_env: settings.env
+            )
+          end
+        end
+
+        def build_evp_proxy_transport(settings, agent_settings)
+          Datadog.logger.debug("CI visibility configured to use agent transport via EVP proxy")
 
-          # Pass through any other options
-          settings.tracing.test_mode.writer_options = settings.ci.writer_options
+          Datadog::CI::TestVisibility::Transport.new(
+            api: Transport::Api::Builder.build_evp_proxy_api(agent_settings),
+            dd_env: settings.env
+          )
         end
       end
     end

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

@@ -5,8 +5,10 @@ require_relative "../ext/settings"
 module Datadog
   module CI
     module Configuration
-      # Adds CI behavior to Datadog trace settings
+      # Adds CI behavior to ddtrace settings
       module Settings
+        InvalidIntegrationError = Class.new(StandardError)
+
         def self.extended(base)
           base = base.singleton_class unless base.is_a?(Class)
           add_settings!(base)
@@ -21,16 +23,37 @@ module Datadog
                 o.default false
               end
 
-              # DEV: Alias to Datadog::Tracing::Contrib::Extensions::Configuration::Settings#instrument.
-              # DEV: Should be removed when CI implement its own `c.ci.instrument`.
+              option :agentless_mode_enabled do |o|
+                o.type :bool
+                o.env CI::Ext::Settings::ENV_AGENTLESS_MODE_ENABLED
+                o.default false
+              end
+
+              option :agentless_url do |o|
+                o.type :string, nilable: true
+                o.env CI::Ext::Settings::ENV_AGENTLESS_URL
+              end
+
               define_method(:instrument) do |integration_name, options = {}, &block|
-                Datadog.configuration.tracing.instrument(integration_name, options, &block)
+                return unless enabled
+
+                integration = fetch_integration(integration_name)
+                integration.configure(options, &block)
+
+                return unless integration.enabled
+
+                patch_results = integration.patch
+                next if patch_results == true
+
+                error_message = <<-ERROR
+                  Available?: #{patch_results[:available]}, Loaded?: #{patch_results[:loaded]},
+                  Compatible?: #{patch_results[:compatible]}, Patchable?: #{patch_results[:patchable]}"
+                ERROR
+                Datadog.logger.warn("Unable to patch #{integration_name} (#{error_message})")
               end
 
-              # DEV: Alias to Datadog::Tracing::Contrib::Extensions::Configuration::Settings#instrument.
-              # DEV: Should be removed when CI implement its own `c.ci[]`.
-              define_method(:[]) do |integration_name, key = :default|
-                Datadog.configuration.tracing[integration_name, key]
+              define_method(:[]) do |integration_name|
+                fetch_integration(integration_name).configuration
               end
 
               # TODO: Deprecate in the next major version, as `instrument` better describes this method's purpose
@@ -42,6 +65,11 @@ module Datadog
                 o.type :hash
                 o.default({})
               end
+
+              define_method(:fetch_integration) do |name|
+                Datadog::CI::Contrib::Integration.registry[name] ||
+                  raise(InvalidIntegrationError, "'#{name}' is not a valid integration.")
+              end
             end
           end
         end

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

@@ -1,8 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "../ext"
-
-require "datadog/tracing/contrib/configuration/settings"
+require_relative "../../settings"
 
 module Datadog
   module CI
@@ -11,7 +10,7 @@ module Datadog
         module Configuration
           # Custom settings for the Cucumber integration
           # TODO: mark as `@public_api` when GA
-          class Settings < Datadog::Tracing::Contrib::Configuration::Settings
+          class Settings < Datadog::CI::Contrib::Settings
             option :enabled do |o|
               o.type :bool
               o.env Ext::ENV_ENABLED

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

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "../../test"
-require_relative "../../ext/app_types"
-require_relative "../../ext/environment"
+require_relative "../../recorder"
 require_relative "../../ext/test"
 require_relative "ext"
 
@@ -30,7 +28,7 @@ module Datadog
           end
 
           def on_test_case_started(event)
-            @current_feature_span = CI::Test.trace(
+            @current_feature_span = CI::Recorder.trace(
               configuration[:operation_name],
               {
                 span_options: {
@@ -50,11 +48,11 @@ module Datadog
             return if @current_feature_span.nil?
 
             if event.result.skipped?
-              CI::Test.skipped!(@current_feature_span)
+              CI::Recorder.skipped!(@current_feature_span)
             elsif event.result.ok?
-              CI::Test.passed!(@current_feature_span)
+              CI::Recorder.passed!(@current_feature_span)
             elsif event.result.failed?
-              CI::Test.failed!(@current_feature_span)
+              CI::Recorder.failed!(@current_feature_span)
             end
 
             @current_feature_span.finish
@@ -72,11 +70,11 @@ module Datadog
             return if @current_step_span.nil?
 
             if event.result.skipped?
-              CI::Test.skipped!(@current_step_span, event.result.exception)
+              CI::Recorder.skipped!(@current_step_span, event.result.exception)
             elsif event.result.ok?
-              CI::Test.passed!(@current_step_span)
+              CI::Recorder.passed!(@current_step_span)
             elsif event.result.failed?
-              CI::Test.failed!(@current_step_span, event.result.exception)
+              CI::Recorder.failed!(@current_step_span, event.result.exception)
             end
 
             @current_step_span.finish

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

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
-require "datadog/tracing/contrib"
-require "datadog/tracing/contrib/integration"
-
+require_relative "../integration"
 require_relative "configuration/settings"
 require_relative "patcher"
 
@@ -12,11 +10,11 @@ module Datadog
       module Cucumber
         # Description of Cucumber integration
         class Integration
-          include Datadog::Tracing::Contrib::Integration
+          include Datadog::CI::Contrib::Integration
 
           MINIMUM_VERSION = Gem::Version.new("3.0.0")
 
-          register_as :cucumber, auto_patch: true
+          register_as :cucumber
 
           def self.version
             Gem.loaded_specs["cucumber"] \

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

@@ -0,0 +1,149 @@
+# frozen_string_literal: true
+
+require_relative "settings"
+
+module Datadog
+  module CI
+    module Contrib
+      module Integration
+        @registry = {}
+
+        def self.included(base)
+          base.extend(ClassMethods)
+          base.include(InstanceMethods)
+        end
+
+        def self.register(klass, name)
+          registry[name] = klass.new
+        end
+
+        def self.registry
+          @registry
+        end
+
+        # Class-level methods for Integration
+        module ClassMethods
+          def register_as(name)
+            Integration.register(self, name)
+          end
+
+          # Version of the integration target code in the environment.
+          #
+          # This is the gem version, when the instrumentation target is a Ruby gem.
+          #
+          # If the target for instrumentation has concept of versioning, override {.version},
+          # otherwise override {.available?} and implement a custom target presence check.
+          # @return [Object] the target version
+          def version
+            nil
+          end
+
+          # Is the target available to be instrumented? (e.g. gem installed?)
+          #
+          # The target doesn't have to be loaded (e.g. `require`) yet, but needs to be able
+          # to be loaded before instrumentation can commence.
+          #
+          # By default, {.available?} checks if {.version} returned a non-nil object.
+          #
+          # If the target for instrumentation has concept of versioning, override {.version},
+          # otherwise override {.available?} and implement a custom target presence check.
+          # @return [Boolean] is the target available for instrumentation in this Ruby environment?
+          def available?
+            !version.nil?
+          end
+
+          # Is the target loaded into the application? (e.g. gem required? Constant defined?)
+          #
+          # The target's objects should be ready to be referenced by the instrumented when {.loaded}
+          # returns `true`.
+          #
+          # @return [Boolean] is the target ready to be referenced during instrumentation?
+          def loaded?
+            true
+          end
+
+          # Is this instrumentation compatible with the available target? (e.g. minimum version met?)
+          # @return [Boolean] is the available target compatible with this instrumentation?
+          def compatible?
+            available?
+          end
+
+          # Can the patch for this integration be applied?
+          #
+          # By default, this is equivalent to {#available?}, {#loaded?}, and {#compatible?}
+          # all being truthy.
+          def patchable?
+            available? && loaded? && compatible?
+          end
+        end
+
+        module InstanceMethods
+          # returns the configuration instance.
+          def configuration
+            @configuration ||= new_configuration
+          end
+
+          def configure(options = {}, &block)
+            configuration.configure(options, &block)
+            configuration
+          end
+
+          # Resets all configuration options
+          def reset_configuration!
+            @configuration = nil
+          end
+
+          def enabled
+            configuration.enabled
+          end
+
+          # The patcher module to inject instrumented objects into the instrumentation target.
+          #
+          # {Contrib::Patcher} includes the basic functionality of a patcher. `include`ing
+          # {Contrib::Patcher} into a new module is the recommend way to create a custom patcher.
+          #
+          # @return [Contrib::Patcher] a module that `include`s {Contrib::Patcher}
+          def patcher
+            nil
+          end
+
+          # @!visibility private
+          def patch
+            # @type var patcher_klass: untyped
+            patcher_klass = patcher
+            if !self.class.patchable? || patcher_klass.nil?
+              return {
+                available: self.class.available?,
+                loaded: self.class.loaded?,
+                compatible: self.class.compatible?,
+                patchable: self.class.patchable?
+              }
+            end
+
+            patcher_klass.patch
+            true
+          end
+
+          # Can the patch for this integration be applied automatically?
+          # @return [Boolean] can the tracer activate this instrumentation without explicit user input?
+          def auto_instrument?
+            true
+          end
+
+          protected
+
+          # Returns a new configuration object for this integration.
+          #
+          # This method normally needs to be overridden for each integration
+          # as their settings, defaults and environment variables are
+          # specific for each integration.
+          #
+          # @return [Datadog::CI::Contrib::Settings] a new, integration-specific settings object
+          def new_configuration
+            Datadog::CI::Contrib::Settings.new
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,8 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "../ext"
-
-require "datadog/tracing/contrib/configuration/settings"
+require_relative "../../settings"
 
 module Datadog
   module CI
@@ -11,7 +10,7 @@ module Datadog
         module Configuration
           # Custom settings for the Minitest integration
           # TODO: mark as `@public_api` when GA
-          class Settings < Datadog::Tracing::Contrib::Configuration::Settings
+          class Settings < Datadog::CI::Contrib::Settings
             option :enabled do |o|
               o.type :bool
               o.env Ext::ENV_ENABLED

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

@@ -1,5 +1,9 @@
 # frozen_string_literal: true
 
+require_relative "../../recorder"
+require_relative "../../ext/test"
+require_relative "ext"
+
 module Datadog
   module CI
     module Contrib
@@ -15,7 +19,7 @@ module Datadog
             path, = method(name).source_location
             test_suite = Pathname.new(path.to_s).relative_path_from(Pathname.pwd).to_s
 
-            span = CI::Test.trace(
+            span = CI::Recorder.trace(
               configuration[:operation_name],
               {
                 span_options: {
@@ -41,11 +45,11 @@ module Datadog
 
             case result_code
             when "."
-              CI::Test.passed!(span)
+              CI::Recorder.passed!(span)
             when "E", "F"
-              CI::Test.failed!(span, failure)
+              CI::Recorder.failed!(span, failure)
             when "S"
-              CI::Test.skipped!(span)
+              CI::Recorder.skipped!(span)
               span.set_tag(CI::Ext::Test::TAG_SKIP_REASON, failure.message)
             end
 

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

@@ -1,8 +1,6 @@
 # frozen_string_literal: true
 
-require "datadog/tracing/contrib"
-require "datadog/tracing/contrib/integration"
-
+require_relative "../integration"
 require_relative "configuration/settings"
 require_relative "patcher"
 
@@ -12,11 +10,11 @@ module Datadog
       module Minitest
         # Description of Minitest integration
         class Integration
-          include Datadog::Tracing::Contrib::Integration
+          include Datadog::CI::Contrib::Integration
 
           MINIMUM_VERSION = Gem::Version.new("5.0.0")
 
-          register_as :minitest, auto_patch: true
+          register_as :minitest
 
           def self.version
             Gem.loaded_specs["minitest"] && Gem.loaded_specs["minitest"].version

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

@@ -1,8 +1,7 @@
 # frozen_string_literal: true
 
 require_relative "../ext"
-
-require "datadog/tracing/contrib/configuration/settings"
+require_relative "../../settings"
 
 module Datadog
   module CI
@@ -11,7 +10,7 @@ module Datadog
         module Configuration
           # Custom settings for the RSpec integration
           # TODO: mark as `@public_api` when GA
-          class Settings < Datadog::Tracing::Contrib::Configuration::Settings
+          class Settings < Datadog::CI::Contrib::Settings
             option :enabled do |o|
               o.type :bool
               o.env Ext::ENV_ENABLED

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

@@ -1,9 +1,6 @@
 # frozen_string_literal: true
 
-require_relative "../../test"
-
-require_relative "../../ext/app_types"
-require_relative "../../ext/environment"
+require_relative "../../recorder"
 require_relative "../../ext/test"
 require_relative "ext"
 
@@ -28,7 +25,7 @@ module Datadog
                 test_name += " #{description}"
               end
 
-              CI::Test.trace(
+              CI::Recorder.trace(
                 configuration[:operation_name],
                 {
                   span_options: {
@@ -46,11 +43,11 @@ module Datadog
 
                 case execution_result.status
                 when :passed
-                  CI::Test.passed!(span)
+                  CI::Recorder.passed!(span)
                 when :failed
-                  CI::Test.failed!(span, execution_result.exception)
+                  CI::Recorder.failed!(span, execution_result.exception)
                 else
-                  CI::Test.skipped!(span, execution_result.exception) if execution_result.example_skipped?
+                  CI::Recorder.skipped!(span, execution_result.exception) if execution_result.example_skipped?
                 end
 
                 result