ddtrace 1.4.2 → 1.19.0

data/lib/datadog/appsec/contrib/configuration/settings.rb

@@ -1,20 +0,0 @@
-# typed: false
-
-require_relative '../../../core/configuration/base'
-
-module Datadog
-  module AppSec
-    module Contrib
-      module Configuration
-        # Common settings for all integrations
-        # TODO: move to datadog/appsec/configuration or remove?
-        class Settings
-          include Datadog::Core::Configuration::Base
-
-          option :enabled, default: true
-          option :service_name
-        end
-      end
-    end
-  end
-end

data/lib/datadog/appsec/contrib/rack/configuration/settings.rb

@@ -1,22 +0,0 @@
-# typed: false
-
-require_relative '../../configuration/settings'
-require_relative '../ext'
-
-module Datadog
-  module AppSec
-    module Contrib
-      module Rack
-        module Configuration
-          # Custom settings for the Rack integration
-          class Settings < Datadog::AppSec::Contrib::Configuration::Settings
-            option :enabled do |o|
-              o.default { env_to_bool(Ext::ENV_ENABLED, true) }
-              o.lazy
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/datadog/appsec/contrib/rack/request.rb

@@ -1,58 +0,0 @@
-# typed: true
-
-module Datadog
-  module AppSec
-    module Contrib
-      module Rack
-        # Normalized extration of data from Rack::Request
-        module Request
-          def self.query(request)
-            # Downstream libddwaf expects keys and values to be extractable
-            # separately so we can't use [[k, v], ...]. We also want to allow
-            # duplicate keys, so we use [{k, v}, ...] instead.
-            request.query_string.split('&').map do |e|
-              k, v = e.split('=').map { |s| CGI.unescape(s) }
-
-              { k => v }
-            end
-          end
-
-          # Rack < 2.0 does not have :each_header
-          # TODO: We need access to Rack here. We must make sure we are able to load AppSec without Rack,
-          # TODO: while still ensure correctness in ths code path.
-          if defined?(::Rack) && ::Rack::Request.instance_methods.include?(:each_header)
-            def self.headers(request)
-              request.each_header.each_with_object({}) do |(k, v), h|
-                h[k.gsub(/^HTTP_/, '').downcase.tr('_', '-')] = v if k =~ /^HTTP_/
-              end
-            end
-          else
-            def self.headers(request)
-              request.env.each_with_object({}) do |(k, v), h|
-                h[k.gsub(/^HTTP_/, '').downcase.tr('_', '-')] = v if k =~ /^HTTP_/
-              end
-            end
-          end
-
-          def self.body(request)
-            request.body.read.tap { request.body.rewind }
-          end
-
-          def self.url(request)
-            request.url
-          end
-
-          def self.cookies(request)
-            request.cookies
-          end
-
-          def self.form_hash(request)
-            # usually Hash<String,String> but can be a more complex
-            # Hash<String,String||Array||Hash> when e.g coming from JSON
-            request.env['rack.request.form_hash']
-          end
-        end
-      end
-    end
-  end
-end

data/lib/datadog/appsec/contrib/rack/response.rb

@@ -1,24 +0,0 @@
-# typed: true
-
-module Datadog
-  module AppSec
-    module Contrib
-      module Rack
-        # Normalized extration of data from Rack::Response
-        module Response
-          def self.headers(response)
-            response.headers.each_with_object({}) { |(k, v), h| h[k.downcase] = v }
-          end
-
-          def self.cookies(response)
-            response.cookies
-          end
-
-          def self.status(response)
-            response.status
-          end
-        end
-      end
-    end
-  end
-end

data/lib/datadog/appsec/contrib/rails/configuration/settings.rb

@@ -1,22 +0,0 @@
-# typed: false
-
-require_relative '../../configuration/settings'
-require_relative '../ext'
-
-module Datadog
-  module AppSec
-    module Contrib
-      module Rails
-        module Configuration
-          # Custom settings for the Rack integration
-          class Settings < Datadog::AppSec::Contrib::Configuration::Settings
-            option :enabled do |o|
-              o.default { env_to_bool(Ext::ENV_ENABLED, true) }
-              o.lazy
-            end
-          end
-        end
-      end
-    end
-  end
-end

data/lib/datadog/appsec/contrib/sinatra/configuration/settings.rb

@@ -1,22 +0,0 @@
-# typed: false
-
-require_relative '../../configuration/settings'
-require_relative '../ext'
-
-module Datadog
-  module AppSec
-    module Contrib
-      module Sinatra
-        module Configuration
-          # Custom settings for the Rack integration
-          class Settings < Datadog::AppSec::Contrib::Configuration::Settings
-            option :enabled do |o|
-              o.default { env_to_bool(Ext::ENV_ENABLED, true) }
-              o.lazy
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,32 +0,0 @@
-# typed: true
-
-require_relative '../flush'
-
-module Datadog
-  module CI
-    module Configuration
-      # Adds CI behavior to Datadog trace components
-      module Components
-        def initialize(settings)
-          # Activate CI mode if enabled
-          activate_ci!(settings) if settings.ci.enabled
-
-          # Initialize normally
-          super
-        end
-
-        def activate_ci!(settings)
-          # 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
-
-          # Pass through any other options
-          settings.tracing.test_mode.writer_options = settings.ci.writer_options
-        end
-      end
-    end
-  end
-end

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

@@ -1,53 +0,0 @@
-# typed: false
-
-require_relative '../ext/settings'
-
-module Datadog
-  module CI
-    module Configuration
-      # Adds CI behavior to Datadog trace settings
-      module Settings
-        def self.extended(base)
-          base = base.singleton_class unless base.is_a?(Class)
-          add_settings!(base)
-        end
-
-        def self.add_settings!(base)
-          base.class_eval do
-            settings :ci do
-              option :enabled do |o|
-                o.default { env_to_bool(CI::Ext::Settings::ENV_MODE_ENABLED, false) }
-                o.lazy
-              end
-
-              # DEV: Alias to Datadog::Tracing::Contrib::Extensions::Configuration::Settings#instrument.
-              # DEV: Should be removed when CI implement its own `c.ci.instrument`.
-              define_method(:instrument) do |integration_name, options = {}, &block|
-                Datadog.configuration.tracing.instrument(integration_name, options, &block)
-              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]
-              end
-
-              # TODO: Deprecate in the next major version, as `instrument` better describes this method's purpose
-              alias_method :use, :instrument
-
-              option :trace_flush do |o|
-                o.default { nil }
-                o.lazy
-              end
-
-              option :writer_options do |o|
-                o.default { {} }
-                o.lazy
-              end
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,33 +0,0 @@
-# typed: false
-
-require_relative '../../../../tracing/contrib/configuration/settings'
-require_relative '../ext'
-
-module Datadog
-  module CI
-    module Contrib
-      module Cucumber
-        module Configuration
-          # Custom settings for the Cucumber integration
-          # TODO: mark as `@public_api` when GA
-          class Settings < Datadog::Tracing::Contrib::Configuration::Settings
-            option :enabled do |o|
-              o.default { env_to_bool(Ext::ENV_ENABLED, true) }
-              o.lazy
-            end
-
-            option :service_name do |o|
-              o.default { Datadog.configuration.service_without_fallback || Ext::SERVICE_NAME }
-              o.lazy
-            end
-
-            option :operation_name do |o|
-              o.default { ENV.key?(Ext::ENV_OPERATION_NAME) ? ENV[Ext::ENV_OPERATION_NAME] : Ext::OPERATION_NAME }
-              o.lazy
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,22 +0,0 @@
-# typed: true
-
-module Datadog
-  module CI
-    module Contrib
-      module Cucumber
-        # Cucumber integration constants
-        # TODO: mark as `@public_api` when GA, to protect from resource and tag name changes.
-        module Ext
-          APP = 'cucumber'.freeze
-          ENV_ENABLED = 'DD_TRACE_CUCUMBER_ENABLED'.freeze
-          ENV_OPERATION_NAME = 'DD_TRACE_CUCUMBER_OPERATION_NAME'.freeze
-          FRAMEWORK = 'cucumber'.freeze
-          OPERATION_NAME = 'cucumber.test'.freeze
-          SERVICE_NAME = 'cucumber'.freeze
-          STEP_SPAN_TYPE = 'step'.freeze
-          TEST_TYPE = 'test'.freeze
-        end
-      end
-    end
-  end
-end

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

@@ -1,94 +0,0 @@
-# typed: true
-
-require_relative '../../test'
-require_relative '../../ext/app_types'
-require_relative '../../ext/environment'
-require_relative '../../ext/test'
-require_relative 'ext'
-
-module Datadog
-  module CI
-    module Contrib
-      module Cucumber
-        # Defines collection of instrumented Cucumber events
-        class Formatter
-          attr_reader :config, :current_feature_span, :current_step_span
-          private :config
-          private :current_feature_span, :current_step_span
-
-          def initialize(config)
-            @config = config
-
-            bind_events(config)
-          end
-
-          def bind_events(config)
-            config.on_event :test_case_started, &method(:on_test_case_started)
-            config.on_event :test_case_finished, &method(:on_test_case_finished)
-            config.on_event :test_step_started, &method(:on_test_step_started)
-            config.on_event :test_step_finished, &method(:on_test_step_finished)
-          end
-
-          def on_test_case_started(event)
-            @current_feature_span = CI::Test.trace(
-              configuration[:operation_name],
-              {
-                span_options: {
-                  resource: event.test_case.name,
-                  service: configuration[:service_name]
-                },
-                framework: Ext::FRAMEWORK,
-                framework_version: CI::Contrib::Cucumber::Integration.version.to_s,
-                test_name: event.test_case.name,
-                test_suite: event.test_case.location.file,
-                test_type: Ext::TEST_TYPE
-              }
-            )
-          end
-
-          def on_test_case_finished(event)
-            return if @current_feature_span.nil?
-
-            if event.result.skipped?
-              CI::Test.skipped!(@current_feature_span)
-            elsif event.result.ok?
-              CI::Test.passed!(@current_feature_span)
-            elsif event.result.failed?
-              CI::Test.failed!(@current_feature_span)
-            end
-
-            @current_feature_span.finish
-          end
-
-          def on_test_step_started(event)
-            trace_options = {
-              resource: event.test_step.to_s,
-              span_type: Ext::STEP_SPAN_TYPE
-            }
-            @current_step_span = Tracing.trace(Ext::STEP_SPAN_TYPE, **trace_options)
-          end
-
-          def on_test_step_finished(event)
-            return if @current_step_span.nil?
-
-            if event.result.skipped?
-              CI::Test.skipped!(@current_step_span, event.result.exception)
-            elsif event.result.ok?
-              CI::Test.passed!(@current_step_span)
-            elsif event.result.failed?
-              CI::Test.failed!(@current_step_span, event.result.exception)
-            end
-
-            @current_step_span.finish
-          end
-
-          private
-
-          def configuration
-            Datadog.configuration.ci[:cucumber]
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,28 +0,0 @@
-# typed: true
-
-require_relative 'formatter'
-
-module Datadog
-  module CI
-    module Contrib
-      module Cucumber
-        # Instrumentation for Cucumber
-        module Instrumentation
-          def self.included(base)
-            base.prepend(InstanceMethods)
-          end
-
-          # Instance methods for configuration
-          module InstanceMethods
-            attr_reader :datadog_formatter
-
-            def formatters
-              @datadog_formatter ||= CI::Contrib::Cucumber::Formatter.new(@configuration)
-              [@datadog_formatter] + super
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,49 +0,0 @@
-# typed: false
-
-require_relative '../../../tracing/contrib/integration'
-
-require_relative 'configuration/settings'
-require_relative 'patcher'
-
-module Datadog
-  module CI
-    module Contrib
-      module Cucumber
-        # Description of Cucumber integration
-        class Integration
-          include Datadog::Tracing::Contrib::Integration
-
-          MINIMUM_VERSION = Gem::Version.new('3.0.0')
-
-          register_as :cucumber, auto_patch: true
-
-          def self.version
-            Gem.loaded_specs['cucumber'] \
-              && Gem.loaded_specs['cucumber'].version
-          end
-
-          def self.loaded?
-            !defined?(::Cucumber).nil? && !defined?(::Cucumber::Runtime).nil?
-          end
-
-          def self.compatible?
-            super && version >= MINIMUM_VERSION
-          end
-
-          # test environments should not auto instrument test libraries
-          def auto_instrument?
-            false
-          end
-
-          def new_configuration
-            Configuration::Settings.new
-          end
-
-          def patcher
-            Patcher
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,33 +0,0 @@
-# typed: false
-
-require_relative '../../../../tracing/contrib/configuration/settings'
-require_relative '../ext'
-
-module Datadog
-  module CI
-    module Contrib
-      module RSpec
-        module Configuration
-          # Custom settings for the RSpec integration
-          # TODO: mark as `@public_api` when GA
-          class Settings < Datadog::Tracing::Contrib::Configuration::Settings
-            option :enabled do |o|
-              o.default { env_to_bool(Ext::ENV_ENABLED, true) }
-              o.lazy
-            end
-
-            option :service_name do |o|
-              o.default { Datadog.configuration.service_without_fallback || Ext::SERVICE_NAME }
-              o.lazy
-            end
-
-            option :operation_name do |o|
-              o.default { ENV.key?(Ext::ENV_OPERATION_NAME) ? ENV[Ext::ENV_OPERATION_NAME] : Ext::OPERATION_NAME }
-              o.lazy
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,70 +0,0 @@
-# typed: false
-
-require_relative '../../test'
-
-require_relative '../../ext/app_types'
-require_relative '../../ext/environment'
-require_relative '../../ext/test'
-require_relative 'ext'
-
-module Datadog
-  module CI
-    module Contrib
-      module RSpec
-        # Instrument RSpec::Core::Example
-        module Example
-          def self.included(base)
-            base.prepend(InstanceMethods)
-          end
-
-          # Instance methods for configuration
-          module InstanceMethods
-            def run(example_group_instance, reporter)
-              return super unless 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}"
-              end
-
-              CI::Test.trace(
-                configuration[:operation_name],
-                {
-                  span_options: {
-                    resource: test_name,
-                    service: configuration[:service_name]
-                  },
-                  framework: Ext::FRAMEWORK,
-                  framework_version: CI::Contrib::RSpec::Integration.version.to_s,
-                  test_name: test_name,
-                  test_suite: metadata[:example_group][:file_path],
-                  test_type: Ext::TEST_TYPE
-                }
-              ) do |span|
-                result = super
-
-                case execution_result.status
-                when :passed
-                  CI::Test.passed!(span)
-                when :failed
-                  CI::Test.failed!(span, execution_result.exception)
-                else
-                  CI::Test.skipped!(span, execution_result.exception) if execution_result.example_skipped?
-                end
-
-                result
-              end
-            end
-
-            private
-
-            def configuration
-              Datadog.configuration.ci[:rspec]
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,21 +0,0 @@
-# typed: true
-
-module Datadog
-  module CI
-    module Contrib
-      module RSpec
-        # RSpec integration constants
-        # TODO: mark as `@public_api` when GA, to protect from resource and tag name changes.
-        module Ext
-          APP = 'rspec'.freeze
-          ENV_ENABLED = 'DD_TRACE_RSPEC_ENABLED'.freeze
-          ENV_OPERATION_NAME = 'DD_TRACE_RSPEC_OPERATION_NAME'.freeze
-          FRAMEWORK = 'rspec'.freeze
-          OPERATION_NAME = 'rspec.example'.freeze
-          SERVICE_NAME = 'rspec'.freeze
-          TEST_TYPE = 'test'.freeze
-        end
-      end
-    end
-  end
-end

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

@@ -1,50 +0,0 @@
-# typed: false
-
-require_relative '../../../tracing/contrib/integration'
-
-require_relative 'configuration/settings'
-require_relative 'patcher'
-
-module Datadog
-  module CI
-    module Contrib
-      module RSpec
-        # Description of RSpec integration
-        class Integration
-          include Datadog::Tracing::Contrib::Integration
-
-          MINIMUM_VERSION = Gem::Version.new('3.0.0')
-
-          register_as :rspec, auto_patch: true
-
-          def self.version
-            Gem.loaded_specs['rspec-core'] \
-              && Gem.loaded_specs['rspec-core'].version
-          end
-
-          def self.loaded?
-            !defined?(::RSpec).nil? && !defined?(::RSpec::Core).nil? && \
-              !defined?(::RSpec::Core::Example).nil?
-          end
-
-          def self.compatible?
-            super && version >= MINIMUM_VERSION
-          end
-
-          # test environments should not auto instrument test libraries
-          def auto_instrument?
-            false
-          end
-
-          def new_configuration
-            Configuration::Settings.new
-          end
-
-          def patcher
-            Patcher
-          end
-        end
-      end
-    end
-  end
-end