datadog-ci 0.5.0 → 0.6.0

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

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require_relative "../../ext/test"
+require_relative "ext"
+
+module Datadog
+  module CI
+    module Contrib
+      module RSpec
+        # Instrument RSpec::Core::Example
+        module ExampleGroup
+          def self.included(base)
+            base.singleton_class.prepend(ClassMethods)
+          end
+
+          # Instance methods for configuration
+          module ClassMethods
+            def run(reporter = ::RSpec::Core::NullReporter)
+              return super unless configuration[:enabled]
+              return super unless top_level?
+
+              test_suite = Datadog::CI.start_test_suite(file_path)
+
+              result = super
+
+              if result
+                test_suite.passed!
+              else
+                test_suite.failed!
+              end
+              test_suite.finish
+
+              result
+            end
+
+            private
+
+            def configuration
+              Datadog.configuration.ci[:rspec]
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -7,13 +7,14 @@ module Datadog
         # RSpec integration constants
         # TODO: mark as `@public_api` when GA, to protect from resource and tag name changes.
         module Ext
-          APP = "rspec"
+          FRAMEWORK = "rspec"
+          DEFAULT_SERVICE_NAME = "rspec"
+
           ENV_ENABLED = "DD_TRACE_RSPEC_ENABLED"
+
+          # TODO: remove in 1.0
           ENV_OPERATION_NAME = "DD_TRACE_RSPEC_OPERATION_NAME"
-          FRAMEWORK = "rspec"
           OPERATION_NAME = "rspec.example"
-          SERVICE_NAME = "rspec"
-          TEST_TYPE = "test"
         end
       end
     end

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

@@ -22,7 +22,7 @@ module Datadog
           end
 
           def self.loaded?
-            !defined?(::RSpec).nil? && !defined?(::RSpec::Core).nil? && \
+            !defined?(::RSpec).nil? && !defined?(::RSpec::Core).nil? &&
               !defined?(::RSpec::Core::Example).nil?
           end
 

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

@@ -1,7 +1,10 @@
 # frozen_string_literal: true
 
 require "datadog/tracing/contrib/patcher"
+
 require_relative "example"
+require_relative "example_group"
+require_relative "runner"
 
 module Datadog
   module CI
@@ -19,6 +22,8 @@ module Datadog
 
           def patch
             ::RSpec::Core::Example.include(Example)
+            ::RSpec::Core::Runner.include(Runner)
+            ::RSpec::Core::ExampleGroup.include(ExampleGroup)
           end
         end
       end

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

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require_relative "../../ext/test"
+require_relative "ext"
+
+module Datadog
+  module CI
+    module Contrib
+      module RSpec
+        # Instrument RSpec::Core::Runner
+        module Runner
+          def self.included(base)
+            base.prepend(InstanceMethods)
+          end
+
+          module InstanceMethods
+            def run_specs(example_groups)
+              return super unless configuration[:enabled]
+
+              test_session = CI.start_test_session(
+                tags: {
+                  CI::Ext::Test::TAG_FRAMEWORK => Ext::FRAMEWORK,
+                  CI::Ext::Test::TAG_FRAMEWORK_VERSION => CI::Contrib::RSpec::Integration.version.to_s,
+                  CI::Ext::Test::TAG_TYPE => CI::Ext::Test::TEST_TYPE
+                },
+                service: configuration[:service_name]
+              )
+
+              test_module = CI.start_test_module(test_session.name)
+
+              result = super
+
+              if result != 0
+                # TODO: repeating this twice feels clunky, we need to remove test_module API before GA
+                test_module.failed!
+                test_session.failed!
+              else
+                test_module.passed!
+                test_session.passed!
+              end
+              test_module.finish
+              test_session.finish
+
+              result
+            end
+
+            private
+
+            def configuration
+              Datadog.configuration.ci[:rspec]
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -27,7 +27,7 @@ module Datadog
         end
 
         def []=(name, value)
-          respond_to?("#{name}=") ? send("#{name}=", value) : set_option(name, value)
+          respond_to?(:"#{name}=") ? send(:"#{name}=", value) : set_option(name, value)
         end
       end
     end

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

@@ -20,6 +20,8 @@ module Datadog
         TAG_TYPE = "test.type"
         TAG_COMMAND = "test.command"
 
+        TEST_TYPE = "test"
+
         # those tags are special and they are 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"

data/lib/datadog/ci/span.rb

@@ -36,6 +36,30 @@ module Datadog
         tracer_span.type
       end
 
+      # Checks whether span status is not set yet.
+      # @return [bool] true if span does not have status
+      def undefined?
+        tracer_span.get_tag(Ext::Test::TAG_STATUS).nil?
+      end
+
+      # Checks whether span status is PASS.
+      # @return [bool] true if span status is PASS
+      def passed?
+        tracer_span.get_tag(Ext::Test::TAG_STATUS) == Ext::Test::Status::PASS
+      end
+
+      # Checks whether span status is FAIL.
+      # @return [bool] true if span status is FAIL
+      def failed?
+        tracer_span.get_tag(Ext::Test::TAG_STATUS) == Ext::Test::Status::FAIL
+      end
+
+      # Checks whether span status is SKIP.
+      # @return [bool] true if span status is SKIP
+      def skipped?
+        tracer_span.get_tag(Ext::Test::TAG_STATUS) == Ext::Test::Status::SKIP
+      end
+
       # Sets the status of the span to "pass".
       # @return [void]
       def passed!

data/lib/datadog/ci/test.rb

@@ -20,6 +20,36 @@ module Datadog
 
         CI.deactivate_test(self)
       end
+
+      # Running test suite that this test is part of (if any).
+      # @return [Datadog::CI::TestSuite] the test suite this test belongs to
+      # @return [nil] if the test suite is not found
+      def test_suite
+        suite_name = test_suite_name
+        CI.active_test_suite(suite_name) if suite_name
+      end
+
+      # Span id of the running test suite this test belongs to.
+      # @return [String] the span id of the test suite.
+      def test_suite_id
+        get_tag(Ext::Test::TAG_TEST_SUITE_ID)
+      end
+
+      def test_suite_name
+        get_tag(Ext::Test::TAG_SUITE)
+      end
+
+      # Span id of the running test module this test belongs to.
+      # @return [String] the span id of the test module.
+      def test_module_id
+        get_tag(Ext::Test::TAG_TEST_MODULE_ID)
+      end
+
+      # Span id of the running test module this test belongs to.
+      # @return [String] the span id of the test session.
+      def test_session_id
+        get_tag(Ext::Test::TAG_TEST_SESSION_ID)
+      end
     end
   end
 end

data/lib/datadog/ci/test_session.rb

@@ -20,6 +20,14 @@ module Datadog
         CI.deactivate_test_session
       end
 
+      # Return the test session's name which is equal to test command used
+      # @return [String] the command for this test session.
+      def name
+        get_tag(Ext::Test::TAG_COMMAND)
+      end
+
+      # Return the test session tags that could be inherited by sub-spans
+      # @return [Hash] the tags to be inherited by sub-spans.
       def inheritable_tags
         return @inheritable_tags if defined?(@inheritable_tags)
 

data/lib/datadog/ci/test_visibility/context/global.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module Datadog
+  module CI
+    module TestVisibility
+      module Context
+        # This context is shared between threads and represents the current test session and test module.
+        class Global
+          def initialize
+            # we are using Monitor instead of Mutex because it is reentrant
+            @mutex = Monitor.new
+
+            @test_session = nil
+            @test_module = nil
+            @test_suites = {}
+          end
+
+          def fetch_or_activate_test_suite(test_suite_name, &block)
+            @mutex.synchronize do
+              @test_suites[test_suite_name] ||= block.call
+            end
+          end
+
+          def fetch_or_activate_test_module(&block)
+            @mutex.synchronize do
+              @test_module ||= block.call
+            end
+          end
+
+          def fetch_or_activate_test_session(&block)
+            @mutex.synchronize do
+              @test_session ||= block.call
+            end
+          end
+
+          def active_test_module
+            @test_module
+          end
+
+          def active_test_session
+            @test_session
+          end
+
+          def active_test_suite(test_suite_name)
+            @mutex.synchronize { @test_suites[test_suite_name] }
+          end
+
+          def service
+            @mutex.synchronize do
+              # thank you RBS for this weirdness
+              test_session = @test_session
+              test_session.service if test_session
+            end
+          end
+
+          def inheritable_session_tags
+            @mutex.synchronize do
+              test_session = @test_session
+              if test_session
+                test_session.inheritable_tags
+              else
+                {}
+              end
+            end
+          end
+
+          def deactivate_test_session!
+            @mutex.synchronize { @test_session = nil }
+          end
+
+          def deactivate_test_module!
+            @mutex.synchronize { @test_module = nil }
+          end
+
+          def deactivate_test_suite!(test_suite_name)
+            @mutex.synchronize { @test_suites.delete(test_suite_name) }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/ci/test_visibility/context/local.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Datadog
+  module CI
+    module TestVisibility
+      module Context
+        class Local
+          def initialize
+            @key = :datadog_ci_active_test
+
+            self.active_test = nil
+          end
+
+          def activate_test!(test)
+            raise "Nested tests are not supported. Currently active test: #{active_test}" unless active_test.nil?
+
+            if block_given?
+              begin
+                self.active_test = test
+                yield
+              ensure
+                self.active_test = nil
+              end
+            else
+              self.active_test = test
+            end
+          end
+
+          def deactivate_test!(test)
+            return if active_test.nil?
+
+            if active_test == test
+              self.active_test = nil
+            else
+              raise "Trying to deactivate test #{test}, but currently active test is #{active_test}"
+            end
+          end
+
+          def active_test
+            Thread.current[@key]
+          end
+
+          private
+
+          def active_test=(test)
+            Thread.current[@key] = test
+          end
+        end
+      end
+    end
+  end
+end

data/lib/datadog/ci/test_visibility/null_recorder.rb

@@ -0,0 +1,73 @@
+# frozen_string_literal: true
+
+require_relative "recorder"
+
+module Datadog
+  module CI
+    module TestVisibility
+      # Special recorder that does not record anything
+      class NullRecorder
+        def start_test_session(service: nil, tags: {})
+          skip_tracing
+        end
+
+        def start_test_module(test_module_name, service: nil, tags: {})
+          skip_tracing
+        end
+
+        def start_test_suite(test_suite_name, service: nil, tags: {})
+          skip_tracing
+        end
+
+        def trace_test(test_name, test_suite_name, service: nil, tags: {}, &block)
+          skip_tracing(block)
+        end
+
+        def trace(span_type, span_name, tags: {}, &block)
+          skip_tracing(block)
+        end
+
+        def active_span
+        end
+
+        def active_test
+        end
+
+        def active_test_session
+        end
+
+        def active_test_module
+        end
+
+        def active_test_suite(test_suite_name)
+        end
+
+        def deactivate_test(test)
+        end
+
+        def deactivate_test_session
+        end
+
+        def deactivate_test_module
+        end
+
+        def deactivate_test_suite(test_suite_name)
+        end
+
+        private
+
+        def skip_tracing(block = nil)
+          if block
+            block.call(null_span)
+          else
+            null_span
+          end
+        end
+
+        def null_span
+          @null_span ||= NullSpan.new
+        end
+      end
+    end
+  end
+end