Use a custom executable to hook to test explorer (#3499)

Author: vinistock

exe/ruby-lsp-test-exec

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Append to RUBYOPT the necessary requires to hook our custom test reporters so that results are automatically
+# reflected in the test explorer
+rubyopt = [
+  *ENV["RUBYOPT"],
+  "-rbundler/setup",
+  "-r#{File.expand_path("../lib/ruby_lsp/test_reporters/minitest_reporter", __dir__)}",
+  "-r#{File.expand_path("../lib/ruby_lsp/test_reporters/test_unit_reporter", __dir__)}",
+].join(" ")
+
+# Replace this process with whatever command was passed. We only want to set RUBYOPT.
+# The way you use this executable is by prefixing your test command with `ruby-lsp-test-exec`, like so:
+#  ruby-lsp-test-exec bundle exec ruby -Itest test/example_test.rb
+#  ruby-lsp-test-exec bundle exec ruby -Ispec spec/example_spec.rb
+#  ruby-lsp-test-exec bundle exec rspec spec/example_spec.rb
+exec({ "RUBYOPT" => rubyopt }, *ARGV)

jekyll/test_explorer.markdown

@@ -107,6 +107,20 @@ Automatically detecting what type of external argument is required for each test
 Code's test explorer doesn't have support for arguments when running tests out of the box and neither do its test
 items accept metadata. This scenario will not be supported by the Ruby LSP.
 
+## Connecting terminal tests to the explorer
+
+When running tests in the terminal through a code lens or test explorer, the Ruby LSP uses the `ruby-lsp-test-exec`
+executable, which hooks the test run to the extension so that we can show test results in the explorer.
+
+By running tests with this executable, even manually written test commands will also have their results reported
+to the test explorer. For example, all of the following will report test statuses to the extension:
+
+```shell
+ruby-lsp-test-exec bundle exec ruby -Itest test/example_test.rb
+ruby-lsp-test-exec bundle exec ruby -Ispec spec/example_spec.rb
+ruby-lsp-test-exec bundle exec rspec spec/example_spec.rb
+```
+
 ## Customization
 
 When tests are running through any execution mode, we set the `RUBY_LSP_TEST_RUNNER` environment variable to allow

ruby-lsp.gemspec

@@ -15,7 +15,7 @@ Gem::Specification.new do |s|
 
   s.files = Dir.glob("lib/**/*.rb") + ["README.md", "VERSION", "LICENSE.txt"] + Dir.glob("static_docs/**/*.md")
   s.bindir = "exe"
-  s.executables = ["ruby-lsp", "ruby-lsp-check", "ruby-lsp-launcher"]
+  s.executables = ["ruby-lsp", "ruby-lsp-check", "ruby-lsp-launcher", "ruby-lsp-test-exec"]
   s.require_paths = ["lib"]
 
   # Dependencies must be kept in sync with the checks in the extension side on workspace.ts

vscode/src/streamingRunner.ts

@@ -114,7 +114,7 @@ export class StreamingRunner implements vscode.Disposable {
           abortController,
         );
       } else if (mode === Mode.RunInTerminal) {
-        this.runInTerminal(command, env, workspace.workspaceFolder);
+        this.runInTerminal(command, workspace.workspaceFolder);
       } else {
         // eslint-disable-next-line @typescript-eslint/no-floating-promises
         this.launchDebugger(command, env, workspace);
@@ -164,7 +164,6 @@ export class StreamingRunner implements vscode.Disposable {
   // Run the given test in the terminal
   private runInTerminal(
     command: string,
-    env: NodeJS.ProcessEnv,
     workspaceFolder: vscode.WorkspaceFolder,
   ) {
     const cwd = workspaceFolder.uri.fsPath;
@@ -177,17 +176,14 @@ export class StreamingRunner implements vscode.Disposable {
       });
     }
 
-    // We need to send RUBYOPT since that hooks up the custom LSP test reporters and the user's shell may override it
-    if (process.platform === "win32") {
-      terminal.sendText(`$env:RUBYOPT="${env.RUBYOPT}"; Clear-Host`);
-    } else {
-      terminal.sendText(`export RUBYOPT="${env.RUBYOPT}"; clear`);
-    }
-
     this.terminals.set(name, terminal);
 
     terminal.show();
-    terminal.sendText(command);
+    const exec =
+      path.basename(cwd) === "ruby-lsp" && os.platform() !== "win32"
+        ? "exe/ruby-lsp-test-exec"
+        : "ruby-lsp-test-exec";
+    terminal.sendText(`${exec} ${command}`);
   }
 
   // Spawns the test process and redirects any stdout or stderr output to the test run output