ddtrace 0.40.0 → 0.54.1

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

@@ -0,0 +1,99 @@
+# typed: true
+require 'datadog/ci/test'
+require 'datadog/ci/ext/app_types'
+require 'datadog/ci/ext/environment'
+require 'datadog/ci/ext/test'
+require 'datadog/ci/contrib/cucumber/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(
+              tracer,
+              configuration[:operation_name],
+              {
+                span_options: {
+                  app: Ext::APP,
+                  resource: event.test_case.name,
+                  service: configuration[:service_name]
+                },
+                framework: Ext::FRAMEWORK,
+                framework_version: Datadog::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 = tracer.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[:cucumber]
+          end
+
+          def tracer
+            configuration[:tracer]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+# typed: true
+require 'datadog/ci/contrib/cucumber/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 ||= Datadog::CI::Contrib::Cucumber::Formatter.new(@configuration)
+              [@datadog_formatter] + super
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+# typed: false
+require 'ddtrace/contrib/integration'
+
+require 'datadog/ci/contrib/cucumber/configuration/settings'
+require 'datadog/ci/contrib/cucumber/patcher'
+
+module Datadog
+  module CI
+    module Contrib
+      module Cucumber
+        # Description of Cucumber integration
+        class Integration
+          include Datadog::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 default_configuration
+            Configuration::Settings.new
+          end
+
+          def patcher
+            Patcher
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# typed: true
+require 'ddtrace/contrib/patcher'
+require 'datadog/ci/contrib/cucumber/instrumentation'
+
+module Datadog
+  module CI
+    module Contrib
+      module Cucumber
+        # Patcher enables patching of 'cucumber' module.
+        module Patcher
+          include Datadog::Contrib::Patcher
+
+          module_function
+
+          def target_version
+            Integration.version
+          end
+
+          def patch
+            ::Cucumber::Runtime.include(Instrumentation)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,31 @@
+# typed: false
+require 'ddtrace/contrib/configuration/settings'
+require 'datadog/ci/contrib/rspec/ext'
+
+module Datadog
+  module CI
+    module Contrib
+      module RSpec
+        module Configuration
+          # Custom settings for the RSpec integration
+          class Settings < Datadog::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

@@ -0,0 +1,75 @@
+# typed: false
+require 'datadog/ci/test'
+
+require 'datadog/ci/ext/app_types'
+require 'datadog/ci/ext/environment'
+require 'datadog/ci/ext/test'
+require 'datadog/ci/contrib/rspec/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(
+                tracer,
+                configuration[:operation_name],
+                {
+                  span_options: {
+                    app: Ext::APP,
+                    resource: test_name,
+                    service: configuration[:service_name]
+                  },
+                  framework: Ext::FRAMEWORK,
+                  framework_version: Datadog::CI::Contrib::RSpec::Integration.version.to_s,
+                  test_name: test_name,
+                  test_suite: 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[:rspec]
+            end
+
+            def tracer
+              configuration[:tracer]
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,19 @@
+# typed: true
+module Datadog
+  module CI
+    module Contrib
+      module RSpec
+        # RSpec integration constants
+        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

@@ -0,0 +1,49 @@
+# typed: false
+require 'ddtrace/contrib/integration'
+
+require 'datadog/ci/contrib/rspec/configuration/settings'
+require 'datadog/ci/contrib/rspec/patcher'
+
+module Datadog
+  module CI
+    module Contrib
+      module RSpec
+        # Description of RSpec integration
+        class Integration
+          include Datadog::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 default_configuration
+            Configuration::Settings.new
+          end
+
+          def patcher
+            Patcher
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+# typed: true
+require 'ddtrace/contrib/patcher'
+require 'datadog/ci/contrib/rspec/example'
+
+module Datadog
+  module CI
+    module Contrib
+      module RSpec
+        # Patcher enables patching of 'rspec' module.
+        module Patcher
+          include Datadog::Contrib::Patcher
+
+          module_function
+
+          def target_version
+            Integration.version
+          end
+
+          def patch
+            ::RSpec::Core::Example.include(Example)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,10 @@
+# typed: true
+module Datadog
+  module CI
+    module Ext
+      module AppTypes
+        TEST = 'test'.freeze
+      end
+    end
+  end
+end