ddtrace 0.49.0 → 0.50.0

data/integration/apps/rspec/spec/fibonacci_spec.rb

@@ -0,0 +1,16 @@
+require_relative '../app/fibonacci'
+
+# Test some library functions
+RSpec.describe '#fib' do
+  subject(:call_fib) { fib(n) }
+  let(:n) { rand(25..35) }
+
+  it { is_expected.to be_a_kind_of(Integer) }
+
+  context 'given a smaller and larger number' do
+    let(:smaller_fib) { fib(n) }
+    let(:larger_fib) { fib(n+1) }
+
+    it { expect(larger_fib).to be > smaller_fib }
+  end
+end

data/integration/apps/rspec/spec/rspec_spec.rb

@@ -0,0 +1,58 @@
+# Test some RSpec behavior
+# NOTE: This file is expected to always produce some test errors!
+#       So that we can 
+RSpec.describe 'RSpec behavior' do
+  shared_examples_for 'correct behavior' do
+    it 'passes' do
+      expect(1).to be < 2
+    end
+  end
+  
+  shared_examples_for 'incorrect behavior' do
+    it 'fails' do
+      expect(2).to be < 1
+    end
+  end
+
+  it 'passes correct assertions' do
+    expect(1).to be < 2
+  end
+
+  it 'fails incorrect assertions' do
+    expect(2).to be < 1
+  end
+
+  it_behaves_like 'correct behavior'
+  it_behaves_like 'incorrect behavior'
+
+  context 'context' do
+    it_behaves_like 'correct behavior'
+    it_behaves_like 'incorrect behavior'
+  end
+
+  context 'in a' do
+    context 'deeply' do
+      context 'nested' do
+        context 'context' do
+          it 'passes correct assertions' do
+            expect(1).to be < 2
+          end
+
+          it 'fails incorrect assertions' do
+            expect(2).to be < 1
+          end
+        end
+      end
+    end
+  end
+
+  context 'when calling traced code' do
+    it 'wraps the RSpec instrumentation around the traced code' do
+      Datadog.tracer.trace('code_under_test') do |span|
+        time_to_run = rand
+        sleep(rand)
+        span.set_tag('run_time', time_to_run)
+      end
+    end
+  end
+end

data/integration/apps/rspec/spec/spec_helper.rb

@@ -0,0 +1,24 @@
+require 'datadog/ci'
+
+# Enable CI tracing
+Datadog.configure do |c|
+  c.ci_mode.enabled = true
+  c.use :rspec
+end
+
+RSpec.configure do |config|
+  config.expect_with :rspec do |expectations|
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.verify_partial_doubles = true
+  end
+
+  config.shared_context_metadata_behavior = :apply_to_host_groups
+  config.filter_run_when_matching :focus
+  config.disable_monkey_patching!
+  config.profile_examples = 10
+  config.order = :random
+  Kernel.srand config.seed
+end

data/integration/apps/ruby/README.md

@@ -43,7 +43,7 @@ Within the container, run `bin/run <process>` where `<process>` is one of the fo
 
 ##### Features
 
-Set `DD_DEMO_ENV_PROCESS` to a comma-delimited list of any of the following values to activate the feature:
+Set `DD_DEMO_ENV_FEATURES` to a comma-delimited list of any of the following values to activate the feature:
 
  - `tracing`: Tracing instrumentation
  - `profiling`: Profiling (NOTE: Must also set `DD_PROFILING_ENABLED` to match.)
@@ -52,7 +52,7 @@ Set `DD_DEMO_ENV_PROCESS` to a comma-delimited list of any of the following valu
  - `runtime_metrics`: Enable runtime metrics
  - `pprof_to_file`: Dump profiling pprof to file instead of agent.
 
-e.g. `DD_DEMO_ENV_PROCESS=tracing,profiling`
+e.g. `DD_DEMO_ENV_FEATURES=tracing,profiling`
 
 ### Running integration tests
 

data/integration/apps/ruby/script/ci

@@ -44,7 +44,8 @@ echo ""
 APP_IMAGE=$APP_IMAGE docker-compose $APP_COMPOSE_FILES build
 
 # Run the test suite
-APP_IMAGE=$APP_IMAGE docker-compose $APP_COMPOSE_FILES run integration-tester
+APP_IMAGE=$APP_IMAGE docker-compose $APP_COMPOSE_FILES run integration-tester || \
+  APP_IMAGE=$APP_IMAGE docker-compose $APP_COMPOSE_FILES logs # Print container logs on `run` failure
 
 # Cleanup
 APP_IMAGE=$APP_IMAGE docker-compose $APP_COMPOSE_FILES down -t 0 --remove-orphans

data/lib/datadog/ci.rb

@@ -0,0 +1,16 @@
+require 'ddtrace'
+
+module Datadog
+  # Namespace for Datadog CI instrumentation:
+  # e.g. rspec, cucumber, etc...
+  module CI
+  end
+end
+
+# Integrations
+require 'datadog/ci/contrib/cucumber/integration'
+require 'datadog/ci/contrib/rspec/integration'
+
+# Extensions
+require 'datadog/ci/extensions'
+Datadog::CI::Extensions.activate!

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

@@ -0,0 +1,30 @@
+require 'datadog/ci/context_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_mode!(settings) if settings.ci_mode.enabled
+
+          # Initialize normally
+          super
+        end
+
+        def activate_ci_mode!(settings)
+          # Activate underlying tracing test mode
+          settings.test_mode.enabled = true
+
+          # Choose user defined ContextFlush or default to CI ContextFlush
+          settings.test_mode.context_flush = settings.ci_mode.context_flush \
+                                             || Datadog::CI::ContextFlush::Finished.new
+
+          # Pass through any other options
+          settings.test_mode.writer_options = settings.ci_mode.writer_options
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+require 'datadog/ci/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_mode do
+              option :enabled do |o|
+                o.default { env_to_bool(Datadog::CI::Ext::Settings::ENV_MODE_ENABLED, false) }
+                o.lazy
+              end
+
+              option :context_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/context_flush.rb

@@ -0,0 +1,28 @@
+require 'ddtrace/context_flush'
+
+module Datadog
+  module CI
+    module ContextFlush
+      # Common behavior for CI flushing
+      module Tagging
+        # Decorate a trace with CI tags
+        def get_trace(context)
+          context.get do |trace|
+            # Origin tag is required on every span
+            trace.each { |span| context.attach_origin(span) } if trace
+          end
+        end
+      end
+
+      # Consumes only completed traces (where all spans have finished)
+      class Finished < Datadog::ContextFlush::Finished
+        prepend Tagging
+      end
+
+      # Performs partial trace flushing to avoid large traces residing in memory for too long
+      class Partial < Datadog::ContextFlush::Partial
+        prepend Tagging
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+require 'ddtrace/contrib/configuration/settings'
+require 'datadog/ci/contrib/cucumber/ext'
+
+module Datadog
+  module CI
+    module Contrib
+      module Cucumber
+        module Configuration
+          # Custom settings for the Cucumber 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 || 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

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

@@ -0,0 +1,97 @@
+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,
+                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,26 @@
+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,47 @@
+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