change how minitest instrumentation works: instrument CompositeReport…

…er as it does not get overwritten when using minitest-reporters gem

Steepfile

@@ -20,5 +20,5 @@ target :lib do
   library "rspec"
   library "cucumber"
   library "msgpack"
-  library "weakref"
+  library "ci_queue"
 end

lib/datadog/ci/contrib/minitest/patcher.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require_relative "reporter"
 require_relative "hooks"
 require_relative "runnable"
 
@@ -18,13 +19,9 @@ def target_version
           end
 
           def patch
-            require_relative "plugin"
-
+            ::Minitest::CompositeReporter.include(Reporter)
             ::Minitest::Test.include(Hooks)
-            ::Minitest.include(Plugin)
             ::Minitest::Runnable.include(Runnable)
-
-            ::Minitest.extensions << "datadog_ci"
           end
         end
       end

lib/datadog/ci/contrib/minitest/plugin.rb → lib/datadog/ci/contrib/minitest/reporter.rb

@@ -9,26 +9,23 @@ module Datadog
   module CI
     module Contrib
       module Minitest
-        module Plugin
+        module Reporter
           def self.included(base)
-            base.extend(ClassMethods)
+            base.prepend(InstanceMethods)
           end
 
-          class DatadogReporter < ::Minitest::AbstractReporter
-            def initialize(minitest_reporter)
-              # This creates circular reference as minitest_reporter also holds reference to DatadogReporter.
-              # To make sure that minitest_reporter can be garbage collected, we use WeakRef.
-              @reporter = WeakRef.new(minitest_reporter)
-            end
+          module InstanceMethods
+            def report(*)
+              return super unless datadog_configuration[:enabled]
+
+              res = super
 
-            def report
               active_test_session = CI.active_test_session
               active_test_module = CI.active_test_module
 
-              return unless @reporter.weakref_alive?
-              return if active_test_session.nil? || active_test_module.nil?
+              return res if active_test_session.nil? || active_test_module.nil?
 
-              if @reporter.passed?
+              if passed?
                 active_test_module.passed!
                 active_test_session.passed!
               else
@@ -39,13 +36,11 @@ def report
               active_test_module.finish
               active_test_session.finish
 
-              nil
+              res
             end
-          end
 
-          module ClassMethods
-            def plugin_datadog_ci_init(*)
-              return unless datadog_configuration[:enabled]
+            def start(*)
+              return super unless datadog_configuration[:enabled]
 
               test_session = CI.start_test_session(
                 tags: {
@@ -56,7 +51,7 @@ def plugin_datadog_ci_init(*)
               )
               CI.start_test_module(test_session.name) if test_session
 
-              reporter.reporters << DatadogReporter.new(reporter)
+              super
             end
 
             private

sig/datadog/ci/contrib/minitest/reporter.rbs

@@ -0,0 +1,21 @@
+module Datadog
+  module CI
+    module Contrib
+      module Minitest
+        module Reporter
+          def self.included: (untyped base) -> untyped
+
+          class InstanceMethods < ::Minitest::AbstractReporter
+            def report: (*untyped) -> untyped
+
+            def start: (*untyped) -> untyped
+
+            private
+
+            def datadog_configuration: () -> untyped
+          end
+        end
+      end
+    end
+  end
+end

spec/datadog/ci/contrib/minitest/patcher_spec.rb

@@ -18,14 +18,10 @@
       end
     end
 
-    context "Minitest includes plugin" do
-      let(:minitest) { Minitest }
+    context "Minitest::CompositeReporter is patched" do
+      let(:reporter) { Minitest::CompositeReporter }
       it "has a custom bases" do
-        expect(minitest.ancestors).to include(Datadog::CI::Contrib::Minitest::Plugin)
-      end
-
-      it "has datadog_ci extension" do
-        expect(minitest.extensions).to include("datadog_ci")
+        expect(reporter.ancestors).to include(Datadog::CI::Contrib::Minitest::Reporter)
       end
     end
   end

vendor/rbs/ci_queue/0/minitest.rbs

@@ -0,0 +1,5 @@
+module Minitest
+end
+
+module Minitest::Queue
+end