datadog-ci 0.6.0 → 0.7.0

data/lib/datadog/ci/test_suite.rb

@@ -13,12 +13,63 @@ module Datadog
     #
     # @public_api
     class TestSuite < ConcurrentSpan
+      def initialize(tracer_span)
+        super
+
+        @test_suite_stats = Hash.new(0)
+      end
+
       # Finishes this test suite.
       # @return [void]
       def finish
-        super
+        synchronize do
+          # we try to derive test suite status from execution stats if no status was set explicitly
+          set_status_from_stats! if undefined?
+
+          super
+
+          recorder.deactivate_test_suite(name)
+        end
+      end
+
+      # @internal
+      def record_test_result(datadog_test_status)
+        synchronize do
+          @test_suite_stats[datadog_test_status] += 1
+        end
+      end
+
+      # @internal
+      def passed_tests_count
+        synchronize do
+          @test_suite_stats[Ext::Test::Status::PASS]
+        end
+      end
+
+      # @internal
+      def skipped_tests_count
+        synchronize do
+          @test_suite_stats[Ext::Test::Status::SKIP]
+        end
+      end
+
+      # @internal
+      def failed_tests_count
+        synchronize do
+          @test_suite_stats[Ext::Test::Status::FAIL]
+        end
+      end
+
+      private
 
-        CI.deactivate_test_suite(name)
+      def set_status_from_stats!
+        if failed_tests_count > 0
+          failed!
+        elsif passed_tests_count == 0
+          skipped!
+        else
+          passed!
+        end
       end
     end
   end

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

@@ -11,7 +11,7 @@ module Datadog
             self.active_test = nil
           end
 
-          def activate_test!(test)
+          def activate_test(test)
             raise "Nested tests are not supported. Currently active test: #{active_test}" unless active_test.nil?
 
             if block_given?
@@ -26,14 +26,8 @@ module Datadog
             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
+          def deactivate_test
+            self.active_test = nil
           end
 
           def active_test

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

@@ -23,7 +23,7 @@ module Datadog
           skip_tracing(block)
         end
 
-        def trace(span_type, span_name, tags: {}, &block)
+        def trace(type, span_name, tags: {}, &block)
           skip_tracing(block)
         end
 
@@ -42,30 +42,10 @@ module Datadog
         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
+          block.call(nil) if block
         end
       end
     end

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

@@ -8,12 +8,13 @@ require "rbconfig"
 require_relative "context/global"
 require_relative "context/local"
 
+require_relative "../codeowners/parser"
 require_relative "../ext/app_types"
 require_relative "../ext/test"
 require_relative "../ext/environment"
+require_relative "../utils/git"
 
 require_relative "../span"
-require_relative "../null_span"
 require_relative "../test"
 require_relative "../test_session"
 require_relative "../test_module"
@@ -27,12 +28,16 @@ module Datadog
       class Recorder
         attr_reader :environment_tags, :test_suite_level_visibility_enabled
 
-        def initialize(test_suite_level_visibility_enabled: false)
+        def initialize(
+          test_suite_level_visibility_enabled: false,
+          codeowners: Codeowners::Parser.new(Utils::Git.root).parse
+        )
           @test_suite_level_visibility_enabled = test_suite_level_visibility_enabled
 
           @environment_tags = Ext::Environment.tags(ENV).freeze
           @local_context = Context::Local.new
           @global_context = Context::Global.new
+          @codeowners = codeowners
         end
 
         def start_test_session(service: nil, tags: {})
@@ -88,6 +93,7 @@ module Datadog
           set_suite_context(tags, name: test_suite_name)
 
           tags[Ext::Test::TAG_NAME] = test_name
+          tags[Ext::Test::TAG_TYPE] ||= Ext::Test::Type::TEST
 
           span_options = build_span_options(
             service,
@@ -101,7 +107,7 @@ module Datadog
             start_datadog_tracer_span(test_name, span_options) do |tracer_span|
               test = build_test(tracer_span, tags)
 
-              @local_context.activate_test!(test) do
+              @local_context.activate_test(test) do
                 block.call(test)
               end
             end
@@ -109,15 +115,15 @@ module Datadog
             tracer_span = start_datadog_tracer_span(test_name, span_options)
 
             test = build_test(tracer_span, tags)
-            @local_context.activate_test!(test)
+            @local_context.activate_test(test)
             test
           end
         end
 
-        def trace(span_type, span_name, tags: {}, &block)
+        def trace(span_name, type: "span", tags: {}, &block)
           span_options = build_span_options(
             nil, # service name is completely optional for custom spans
-            span_type,
+            type,
             {resource: span_name}
           )
 
@@ -153,8 +159,8 @@ module Datadog
           @global_context.active_test_suite(test_suite_name)
         end
 
-        def deactivate_test(test)
-          @local_context.deactivate_test!(test)
+        def deactivate_test
+          @local_context.deactivate_test
         end
 
         def deactivate_test_session
@@ -172,11 +178,7 @@ module Datadog
         private
 
         def skip_tracing(block = nil)
-          if block
-            block.call(null_span)
-          else
-            null_span
-          end
+          block.call(nil) if block
         end
 
         # Sets trace's origin to ciapp-test
@@ -206,6 +208,8 @@ module Datadog
           test = Test.new(tracer_span)
           set_initial_tags(test, tags)
           validate_test_suite_level_visibility_correctness(test)
+          set_codeowners(test)
+
           test
         end
 
@@ -215,9 +219,9 @@ module Datadog
           span
         end
 
-        def build_span_options(service, span_type, other_options = {})
+        def build_span_options(service, type, other_options = {})
           other_options[:service] = service || @global_context.service
-          other_options[:span_type] = span_type
+          other_options[:type] = type
 
           other_options
         end
@@ -251,6 +255,12 @@ module Datadog
           end
         end
 
+        def set_codeowners(test)
+          source = test.source_file
+          owners = @codeowners.list_owners(source) if source
+          test.set_tag(Ext::Test::TAG_CODEOWNERS, owners) unless owners.nil?
+        end
+
         def set_suite_context(tags, span: nil, name: nil)
           return if span.nil? && name.nil?
 
@@ -280,10 +290,6 @@ module Datadog
           end
         end
 
-        def null_span
-          @null_span ||= NullSpan.new
-        end
-
         def validate_test_suite_level_visibility_correctness(test)
           return unless test_suite_level_visibility_enabled
 

data/lib/datadog/ci/test_visibility/serializers/base.rb

@@ -34,7 +34,7 @@ module Datadog
             @trace = trace
             @span = span
 
-            @meta = @span.meta.reject { |key, _| Ext::Test::SPECIAL_TAGS.include?(key) }
+            @meta = @span.meta.reject { |key, _| Ext::Test::TRANSIENT_TAGS.include?(key) }
 
             @errors = {}
             @validated = false
@@ -45,7 +45,7 @@ module Datadog
 
             packer.write_map_header(3)
 
-            write_field(packer, "type")
+            write_field(packer, "type", "event_type")
             write_field(packer, "version")
 
             packer.write("content")
@@ -119,9 +119,6 @@ module Datadog
             to_integer(@span.get_tag(Ext::Test::TAG_TEST_SUITE_ID))
           end
 
-          def type
-          end
-
           def version
             1
           end
@@ -130,6 +127,10 @@ module Datadog
             @span.type
           end
 
+          def event_type
+            "span"
+          end
+
           def name
             @span.name
           end

data/lib/datadog/ci/test_visibility/serializers/span.rb

@@ -21,7 +21,7 @@ module Datadog
             CONTENT_MAP_SIZE
           end
 
-          def type
+          def event_type
             "span"
           end
 

data/lib/datadog/ci/test_visibility/serializers/test_module.rb

@@ -22,7 +22,7 @@ module Datadog
             CONTENT_MAP_SIZE
           end
 
-          def type
+          def event_type
             Ext::AppTypes::TYPE_TEST_MODULE
           end
 

data/lib/datadog/ci/test_visibility/serializers/test_session.rb

@@ -22,7 +22,7 @@ module Datadog
             CONTENT_MAP_SIZE
           end
 
-          def type
+          def event_type
             Ext::AppTypes::TYPE_TEST_SESSION
           end
 

data/lib/datadog/ci/test_visibility/serializers/test_suite.rb

@@ -22,7 +22,7 @@ module Datadog
             CONTENT_MAP_SIZE
           end
 
-          def type
+          def event_type
             Ext::AppTypes::TYPE_TEST_SUITE
           end
 

data/lib/datadog/ci/test_visibility/serializers/test_v1.rb

@@ -22,7 +22,7 @@ module Datadog
             CONTENT_MAP_SIZE
           end
 
-          def type
+          def event_type
             Ext::AppTypes::TYPE_TEST
           end
 

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative "git"
+
+module Datadog
+  module CI
+    module Utils
+      module Configuration
+        def self.fetch_service_name(default)
+          Datadog.configuration.service_without_fallback || Git.repository_name || default
+        end
+      end
+    end
+  end
+end

data/lib/datadog/ci/utils/git.rb

@@ -1,5 +1,8 @@
 # frozen_string_literal: true
 
+require "open3"
+require "pathname"
+
 module Datadog
   module CI
     module Utils
@@ -16,6 +19,73 @@ module Datadog
         def self.is_git_tag?(ref)
           !ref.nil? && ref.include?("tags/")
         end
+
+        def self.root
+          return @root if defined?(@root)
+
+          @root = exec_git_command("git rev-parse --show-toplevel")
+        rescue => e
+          Datadog.logger.debug(
+            "Unable to read git root: #{e.class.name} #{e.message} at #{Array(e.backtrace).first}"
+          )
+          @root = nil
+        end
+
+        def self.relative_to_root(path)
+          return nil if path.nil?
+
+          git_root = root
+          return path if git_root.nil?
+
+          path = Pathname.new(File.expand_path(path))
+          git_root = Pathname.new(git_root)
+
+          path.relative_path_from(git_root).to_s
+        end
+
+        def self.repository_name
+          return @repository_name if defined?(@repository_name)
+
+          git_remote_url = exec_git_command("git ls-remote --get-url origin")
+
+          # return git repository name from remote url without .git extension
+          last_path_segment = git_remote_url.split("/").last if git_remote_url
+          @repository_name = last_path_segment.gsub(".git", "") if last_path_segment
+          @repository_name ||= current_folder_name
+        rescue => e
+          Datadog.logger.debug(
+            "Unable to get git remote: #{e.class.name} #{e.message} at #{Array(e.backtrace).first}"
+          )
+          @repository_name = current_folder_name
+        end
+
+        def self.current_folder_name
+          root_folder = root
+          if root_folder.nil?
+            File.basename(Dir.pwd)
+          else
+            File.basename(root_folder)
+          end
+        end
+
+        def self.exec_git_command(cmd)
+          out, status = Open3.capture2e(cmd)
+
+          raise "Failed to run git command #{cmd}: #{out}" unless status.success?
+
+          # Sometimes Encoding.default_external is somehow set to US-ASCII which breaks
+          # commit messages with UTF-8 characters like emojis
+          # We force output's encoding to be UTF-8 in this case
+          # This is safe to do as UTF-8 is compatible with US-ASCII
+          if Encoding.default_external == Encoding::US_ASCII
+            out = out.force_encoding(Encoding::UTF_8)
+          end
+          out.strip! # There's always a "\n" at the end of the command output
+
+          return nil if out.empty?
+
+          out
+        end
       end
     end
   end

data/lib/datadog/ci/version.rb

@@ -4,7 +4,7 @@ module Datadog
   module CI
     module VERSION
       MAJOR = "0"
-      MINOR = "6"
+      MINOR = "7"
       PATCH = "0"
       PRE = nil
       BUILD = nil

data/lib/datadog/ci.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require_relative "ci/version"
+require_relative "ci/utils/configuration"
+require_relative "ci/ext/app_types"
 
 require "datadog/core"
 
@@ -9,6 +11,8 @@ module Datadog
   #
   # @public_api
   module CI
+    class ReservedTypeError < StandardError; end
+
     class << self
       # Starts a {Datadog::CI::TestSession ci_test_session} that represents the whole test session run.
       #
@@ -30,13 +34,11 @@ module Datadog
       #
       # Remember that calling {Datadog::CI::TestSession#finish} is mandatory.
       #
-      # @param [String] service the service name for this session (optional, defaults to DD_SERVICE)
+      # @param [String] service the service name for this session (optional, defaults to DD_SERVICE or repository name)
       # @param [Hash<String,String>] tags extra tags which should be added to the test session.
-      # @return [Datadog::CI::TestSession] returns the active, running {Datadog::CI::TestSession}.
-      # @return [Datadog::CI::NullSpan] ci_span null object if CI visibility is disabled or if old Datadog agent is
-      #         detected and test suite level visibility cannot be supported.
-      def start_test_session(service: nil, tags: {})
-        service ||= Datadog.configuration.service
+      # @return [Datadog::CI::TestSession] the active, running {Datadog::CI::TestSession}.
+      # @return [nil] if test suite level visibility is disabled or CI mode is disabled.
+      def start_test_session(service: Utils::Configuration.fetch_service_name("test"), tags: {})
         recorder.start_test_session(service: service, tags: tags)
       end
 
@@ -88,9 +90,8 @@ module Datadog
       # @param [String] test_module_name the name for this module
       # @param [String] service the service name for this session (optional, inherited from test session if not provided)
       # @param [Hash<String,String>] tags extra tags which should be added to the test module (optional, some tags are inherited from test session).
-      # @return [Datadog::CI::TestModule] returns the active, running {Datadog::CI::TestModule}.
-      # @return [Datadog::CI::NullSpan] ci_span null object if CI visibility is disabled or if old Datadog agent is
-      #         detected and test suite level visibility cannot be supported.
+      # @return [Datadog::CI::TestModule] the active, running {Datadog::CI::TestModule}.
+      # @return [nil] if test suite level visibility is disabled or CI mode is disabled.
       def start_test_module(test_module_name, service: nil, tags: {})
         recorder.start_test_module(test_module_name, service: service, tags: tags)
       end
@@ -141,9 +142,8 @@ module Datadog
       # @param [String] test_suite_name the name of the test suite
       # @param [String] service the service name for this test suite (optional, inherited from test session if not provided)
       # @param [Hash<String,String>] tags extra tags which should be added to the test module (optional, some tags are inherited from test session)
-      # @return [Datadog::CI::TestSuite] returns the active, running {Datadog::CI::TestSuite}.
-      # @return [Datadog::CI::NullSpan] ci_span null object if CI visibility is disabled or if old Datadog agent is
-      #         detected and test suite level visibility cannot be supported.
+      # @return [Datadog::CI::TestSuite] the active, running {Datadog::CI::TestSuite}.
+      # @return [nil] if test suite level visibility is disabled or CI mode is disabled.
       def start_test_suite(test_suite_name, service: nil, tags: {})
         recorder.start_test_suite(test_suite_name, service: service, tags: tags)
       end
@@ -217,10 +217,10 @@ module Datadog
       # @return [Object] If a block is provided, returns the result of the block execution.
       # @return [Datadog::CI::Test] If no block is provided, returns the active,
       #         unfinished {Datadog::CI::Test}.
-      # @return [Datadog::CI::NullSpan] ci_span null object if CI visibility is disabled
+      # @return [nil] if no block is provided and CI mode is disabled.
       # @yield Optional block where newly created {Datadog::CI::Test} captures the execution.
       # @yieldparam [Datadog::CI::Test] ci_test the newly created and active [Datadog::CI::Test]
-      # @yieldparam [Datadog::CI::NullSpan] ci_span null object if CI visibility is disabled
+      # @yieldparam [nil] if CI mode is disabled
       def trace_test(test_name, test_suite_name, service: nil, tags: {}, &block)
         recorder.trace_test(test_name, test_suite_name, service: service, tags: tags, &block)
       end
@@ -245,8 +245,8 @@ module Datadog
       # @param [String] test_suite_name name of test suite this test belongs to (example: "CalculatorTest").
       # @param [String] service the service name for this span (optional, inherited from test session if not provided)
       # @param [Hash<String,String>] tags extra tags which should be added to the test.
-      # @return [Datadog::CI::Test] Returns the active, unfinished {Datadog::CI::Test}.
-      # @return [Datadog::CI::NullSpan] ci_span null object if CI visibility is disabled
+      # @return [Datadog::CI::Test] the active, unfinished {Datadog::CI::Test}.
+      # @return [nil] if CI mode is disabled.
       def start_test(test_name, test_suite_name, service: nil, tags: {})
         recorder.trace_test(test_name, test_suite_name, service: service, tags: tags)
       end
@@ -260,8 +260,8 @@ module Datadog
       #
       # ```
       # Datadog::CI.trace(
-      #   "step",
       #   "Given I have 42 cucumbers",
+      #   type: "step",
       #   tags: {}
       # ) do
       #   run_operation
@@ -271,8 +271,8 @@ module Datadog
       # The {.trace} method can also be used without a block in this way:
       # ```
       # ci_span = Datadog::CI.trace(
-      #   "step",
       #   "Given I have 42 cucumbers",
+      #   type: "step",
       #   tags: {}
       # )
       # # ... run test here ...
@@ -280,22 +280,31 @@ module Datadog
       # ```
       # Remember that in this case, calling {Datadog::CI::Span#finish} is mandatory.
       #
-      # @param [String] span_type custom, user-defined span type (for example "step" or "query").
       # @param [String] span_name the resource this span refers, or `test` if it's missing
+      # @param [String] type custom, user-defined span type (for example "step" or "query").
       # @param [Hash<String,String>] tags extra tags which should be added to the span.
       # @return [Object] If a block is provided, returns the result of the block execution.
       # @return [Datadog::CI::Span] If no block is provided, returns the active,
       #         unfinished {Datadog::CI::Span}.
-      # @return [Datadog::CI::NullSpan] ci_span null object if CI visibility is disabled
+      # @return [nil] if CI visibility is disabled
+      # @raise [ReservedTypeError] if provided type is reserved for Datadog CI visibility
       # @yield Optional block where newly created {Datadog::CI::Span} captures the execution.
       # @yieldparam [Datadog::CI::Span] ci_span the newly created and active [Datadog::CI::Span]
-      # @yieldparam [Datadog::CI::NullSpan] ci_span null object if CI visibility is disabled
-      def trace(span_type, span_name, tags: {}, &block)
-        recorder.trace(span_type, span_name, tags: tags, &block)
+      # @yieldparam [nil] ci_span if CI visibility is disabled
+      def trace(span_name, type: "span", tags: {}, &block)
+        if Ext::AppTypes::CI_SPAN_TYPES.include?(type)
+          raise(
+            ReservedTypeError,
+            "Span type #{type} is reserved for Datadog CI visibility. " \
+              "Reserved types are: #{Ext::AppTypes::CI_SPAN_TYPES}"
+          )
+        end
+
+        recorder.trace(span_name, type: type, tags: tags, &block)
       end
 
-      # The active, unfinished custom span if it matches given type.
-      # If no span is active, or if the active span is not a custom span with given type, returns nil.
+      # The active, unfinished custom (i.e. not test/suite/module/session) span.
+      # If no span is active, or if the active span is not a custom span, returns nil.
       #
       # The active span belongs to an {.active_test}.
       #
@@ -304,22 +313,21 @@ module Datadog
       # ```
       # # start span
       # Datadog::CI.trace(
-      #   "step",
       #   "Given I have 42 cucumbers",
+      #   type: "step",
       #   tags: {}
       # )
       #
-      # # somewhere else, access the active "step" span
-      # step_span = Datadog::CI.active_span("step")
+      # # somewhere else, access the active step span
+      # step_span = Datadog::CI.active_span
       # step_span.finish()
       # ```
       #
-      # @param [String] span_type type of the span to retrieve (for example "step" or "query") that was provided to {.trace}
       # @return [Datadog::CI::Span] the active span
-      # @return [nil] if no span is active, or if the active span is not a custom span with given type
-      def active_span(span_type)
+      # @return [nil] if no span is active, or if the active span is not a custom span
+      def active_span
         span = recorder.active_span
-        span if span && span.span_type == span_type
+        span if span && !Ext::AppTypes::CI_SPAN_TYPES.include?(span.type)
       end
 
       # The active, unfinished test span.
@@ -347,30 +355,6 @@ module Datadog
         recorder.active_test
       end
 
-      # Internal only, to finish a test use {Datadog::CI::Test#finish}
-      # @private
-      def deactivate_test(test)
-        recorder.deactivate_test(test)
-      end
-
-      # Internal only, to finish a test session use {Datadog::CI::TestSession#finish}
-      # @private
-      def deactivate_test_session
-        recorder.deactivate_test_session
-      end
-
-      # Internal only, to finish a test module use {Datadog::CI::TestModule#finish}
-      # @private
-      def deactivate_test_module
-        recorder.deactivate_test_module
-      end
-
-      # Internal only, to finish a test suite use {Datadog::CI::TestSuite#finish}
-      # @private
-      def deactivate_test_suite(test_suite_name)
-        recorder.deactivate_test_suite(test_suite_name)
-      end
-
       private
 
       def components