Ensure that tests that crash before running emit finish event (#3487)

Author: vinistock

lib/ruby_lsp/test_reporters/lsp_reporter.rb

@@ -1,6 +1,7 @@
 # typed: strict
 # frozen_string_literal: true
 
+require "English"
 require "json"
 require "socket"
 require "singleton"
@@ -211,3 +212,11 @@ def send_message(method_name, **params)
   require "coverage"
   Coverage.start(:all)
 end
+
+if RubyLsp::LspReporter.executed_under_test_runner?
+  at_exit do
+    # Regular finish events are registered per test reporter. However, if the test crashes during loading the files
+    # (e.g.: a bad require), we need to ensure that the execution is finalized so that the extension is not left hanging
+    RubyLsp::LspReporter.instance.at_exit if $ERROR_INFO
+  end
+end

test/fixtures/minitest_crash_example.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "minitest/autorun"
+
+Minitest::Test.i_suck_and_my_tests_are_order_dependent!
+
+class SampleTest < Minitest::Test
+  raise "oh, no"
+
+  def test_that_passes
+    assert_equal(1, 1)
+  end
+end

test/fixtures/test_unit_crash_example.rb

@@ -0,0 +1,12 @@
+# typed: false
+# frozen_string_literal: true
+
+require "test-unit"
+
+class SampleTest < Test::Unit::TestCase
+  raise "oh, no"
+
+  def test_that_passes
+    assert_equal(1, 1)
+  end
+end

test/test_reporters/minitest_reporter_test.rb

@@ -6,56 +6,16 @@
 module RubyLsp
   class MinitestReporterTest < Minitest::Test
     def test_minitest_output
-      plugin_path = File.expand_path("lib/ruby_lsp/test_reporters/minitest_reporter.rb")
-      uri = URI::Generic.from_path(path: "#{Dir.pwd}/test/fixtures/minitest_example.rb").to_s
-
-      server = TCPServer.new("localhost", 0)
-      port = server.addr[1].to_s
-      events = []
-      socket = nil #: Socket?
-
-      receiver = Thread.new do
-        socket = server.accept
-        socket.setsockopt(Socket::SOL_SOCKET, Socket::SO_KEEPALIVE, true)
-
-        loop do
-          headers = socket.gets("\r\n\r\n")
-          break unless headers
-
-          content_length = headers[/Content-Length: (\d+)/i, 1].to_i
-          raw_message = socket.read(content_length)
-
-          event = JSON.parse(raw_message)
-          events << event
-
-          break if event["method"] == "finish"
-        end
-      end
-
-      _stdin, stdout, _stderr, wait_thr = Open3 #: as untyped
-        .popen3(
-          {
-            "RUBYOPT" => "-rbundler/setup -r#{plugin_path}",
-            "RUBY_LSP_TEST_RUNNER" => "run",
-            "RUBY_LSP_REPORTER_PORT" => port,
-          },
-          "bundle",
-          "exec",
-          "ruby",
-          "-Itest",
-          "test/fixtures/minitest_example.rb",
-        )
-
-      receiver.join
-      wait_thr.join
-      socket&.close
+      uri = URI::Generic.from_path(path: "#{Dir.pwd}/test/fixtures/minitest_example.rb")
+      string_uri = uri.to_s
+      events = gather_events(uri)
 
       expected = [
         {
           "method" => "start",
           "params" => {
             "id" => "SampleTest#test_that_fails",
-            "uri" => uri,
+            "uri" => string_uri,
             "line" => 14,
           },
         },
@@ -64,44 +24,44 @@ def test_minitest_output
           "params" => {
             "id" => "SampleTest#test_that_fails",
             "message" => "Expected: 1\n  Actual: 2",
-            "uri" => uri,
+            "uri" => string_uri,
           },
         },
         {
           "method" => "start",
           "params" => {
             "id" => "SampleTest#test_that_is_pending",
-            "uri" => uri,
+            "uri" => string_uri,
             "line" => 18,
           },
         },
         {
           "method" => "skip",
           "params" => {
             "id" => "SampleTest#test_that_is_pending",
-            "uri" => uri,
+            "uri" => string_uri,
           },
         },
         {
           "method" => "start",
           "params" => {
             "id" => "SampleTest#test_that_passes",
-            "uri" => uri,
+            "uri" => string_uri,
             "line" => 9,
           },
         },
         {
           "method" => "pass",
           "params" => {
             "id" => "SampleTest#test_that_passes",
-            "uri" => uri,
+            "uri" => string_uri,
           },
         },
         {
           "method" => "start",
           "params" => {
             "id" => "SampleTest#test_that_raises",
-            "uri" => uri,
+            "uri" => string_uri,
             "line" => 22,
           },
         },
@@ -110,22 +70,22 @@ def test_minitest_output
           "params" => {
             "id" => "SampleTest#test_that_raises",
             "message" => "RuntimeError: oops\n    test/fixtures/minitest_example.rb:24:in #{error_location}",
-            "uri" => uri,
+            "uri" => string_uri,
           },
         },
         {
           "method" => "start",
           "params" => {
             "id" => "SampleTest#test_with_output",
-            "uri" => uri,
+            "uri" => string_uri,
             "line" => 26,
           },
         },
         {
           "method" => "pass",
           "params" => {
             "id" => "SampleTest#test_with_output",
-            "uri" => uri,
+            "uri" => string_uri,
           },
         },
         {
@@ -135,11 +95,67 @@ def test_minitest_output
       ]
 
       assert_equal(expected, events)
-      refute_empty(stdout.read)
+    end
+
+    def test_crashing_example
+      uri = URI::Generic.from_path(path: "#{Dir.pwd}/test/fixtures/minitest_crash_example.rb")
+      events = gather_events(uri, output: :stderr)
+
+      expected = [{ "method" => "finish", "params" => {} }]
+      assert_equal(expected, events)
     end
 
     private
 
+    #: (URI::Generic, ?output: Symbol) -> Array[Hash[untyped, untyped]]
+    def gather_events(uri, output: :stdout)
+      plugin_path = File.expand_path("lib/ruby_lsp/test_reporters/minitest_reporter.rb")
+
+      server = TCPServer.new("localhost", 0)
+      port = server.addr[1].to_s
+      events = []
+      socket = nil #: Socket?
+
+      receiver = Thread.new do
+        socket = server.accept
+        socket.setsockopt(Socket::SOL_SOCKET, Socket::SO_KEEPALIVE, true)
+
+        loop do
+          headers = socket.gets("\r\n\r\n")
+          break unless headers
+
+          content_length = headers[/Content-Length: (\d+)/i, 1].to_i
+          raw_message = socket.read(content_length)
+
+          event = JSON.parse(raw_message)
+          events << event
+
+          break if event["method"] == "finish"
+        end
+      end
+
+      _stdin, stdout, stderr, wait_thr = Open3.popen3(
+        {
+          "RUBYOPT" => "-rbundler/setup -r#{plugin_path}",
+          "RUBY_LSP_TEST_RUNNER" => "run",
+          "RUBY_LSP_REPORTER_PORT" => port,
+          "RUBY_LSP_ENV" => "production",
+        },
+        "bundle",
+        "exec",
+        "ruby",
+        "-Itest",
+        uri.to_standardized_path, #: as !nil
+      )
+
+      receiver.join
+      wait_thr.join
+      socket&.close
+      io = output == :stdout ? stdout : stderr
+      refute_empty(io.read)
+      events
+    end
+
     def error_location
       ruby_version = Gem::Version.new(RUBY_VERSION)