Show message when trying to run a test that hasn't been discovered (#3631)

* Show message when trying to run a test that hasn't been discovered

* Don't show code lens for tests not matching the expected path

Author: vinistock

jekyll/test_explorer.markdown

@@ -49,6 +49,11 @@ There is limited support to using multiple test frameworks in the same codebase.
 and we will not make further investments into supporting it, in line with our design principle of [favoring common
 setups](design-and-roadmap#favoring-common-development-setups)
 
+{: .important }
+To discover all test files in the workspace with decent performance, the Ruby LSP uses a glob pattern based on
+conventions. For a test file to be discovered, the file path must match this glob:
+`**/{test,spec,features}/**/{*_test.rb,test_*.rb,*_spec.rb,*.feature}`
+
 ### Dynamically defined tests
 
 There is limited support for tests defined via meta-programming. Initially, they will not be present in the test

lib/ruby_lsp/requests/code_lens.rb

@@ -27,8 +27,10 @@ def initialize(global_state, document, dispatcher)
         @document = document
         @test_builder = ResponseBuilders::TestCollection.new #: ResponseBuilders::TestCollection
         uri = document.uri
+        file_path = uri.full_path
         code_lens_config = global_state.feature_configuration(:codeLens)
-        test_lenses_enabled = !code_lens_config || code_lens_config.enabled?(:enableTestCodeLens)
+        test_lenses_enabled = (!code_lens_config || code_lens_config.enabled?(:enableTestCodeLens)) &&
+          file_path && File.fnmatch?(TEST_PATH_PATTERN, file_path, File::FNM_PATHNAME | File::FNM_EXTGLOB)
 
         if global_state.enabled_feature?(:fullTestDiscovery)
           if test_lenses_enabled

lib/ruby_lsp/utils.rb

@@ -20,6 +20,7 @@ module RubyLsp
     "Gemfile"
   end #: String
   GUESSED_TYPES_URL = "https://shopify.github.io/ruby-lsp/#guessed-types"
+  TEST_PATH_PATTERN = "**/{test,spec,features}/**/{*_test.rb,test_*.rb,*_spec.rb,*.feature}"
 
   # Request delegation for embedded languages is not yet standardized into the language server specification. Here we
   # use this custom error class as a way to return a signal to the client that the request should be delegated to the

test/requests/discover_tests_test.rb

@@ -143,7 +143,7 @@ def test_something_else; end
         end
       RUBY
 
-      with_server(source) do |server, uri|
+      with_server(source, URI::Generic.from_path(path: "/test/foo_test.rb")) do |server, uri|
         server.global_state.index.index_single(URI("/other_file.rb"), <<~RUBY)
           module Test
             module Unit
@@ -227,7 +227,7 @@ def test_something_else; end
         end
       RUBY
 
-      with_server(source) do |server, uri|
+      with_server(source, URI::Generic.from_path(path: "/test/foo_test.rb")) do |server, uri|
         server.global_state.index.index_single(URI("/other_file.rb"), <<~RUBY)
           module Test
             module Unit
@@ -259,6 +259,39 @@ class TestCase; end
       end
     end
 
+    def test_does_not_collect_code_lenses_for_files_not_matching_path_convention
+      source = <<~RUBY
+        module Foo
+          class MyTest < Test::Unit::TestCase
+            def test_something; end
+
+            def test_something_else; end
+          end
+        end
+      RUBY
+
+      with_server(source, URI::Generic.from_path(path: "/tests/something.rb")) do |server, uri|
+        server.global_state.index.index_single(URI("/other_file.rb"), <<~RUBY)
+          module Test
+            module Unit
+              class TestCase; end
+            end
+          end
+        RUBY
+
+        server.global_state.stubs(:enabled_feature?).returns(true)
+
+        server.process_message(id: 1, method: "textDocument/codeLens", params: {
+          textDocument: { uri: uri },
+        })
+
+        # Discard the indexing log message
+        server.pop_response
+        items = get_response(server)
+        assert_empty(items)
+      end
+    end
+
     def test_ignores_minitest_tests_that_extend_active_support_declarative
       source = <<~RUBY
         class MyTest < ActiveSupport::TestCase

vscode/src/test/suite/client.test.ts

@@ -359,10 +359,15 @@ suite("Client", () => {
       "  end",
       "end",
     ].join("\n");
+    const uri = vscode.Uri.joinPath(
+      workspaceUri,
+      "test",
+      "server_test.rb",
+    ).toString();
 
     await client.sendNotification("textDocument/didOpen", {
       textDocument: {
-        uri: documentUri.toString(),
+        uri,
         version: 1,
         text,
       },
@@ -371,7 +376,7 @@ suite("Client", () => {
       "textDocument/codeLens",
       {
         textDocument: {
-          uri: documentUri.toString(),
+          uri,
         },
       },
     );

vscode/src/testController.ts

@@ -384,7 +384,17 @@ export class TestController {
   async runViaCommand(path: string, name: string, mode: Mode) {
     const uri = vscode.Uri.file(path);
     const testItem = await this.findTestItem(name, uri);
-    if (!testItem) return;
+
+    if (!testItem) {
+      await vscode.window.showErrorMessage(
+        `Attempted to run "${name}" defined in "${path}", but that test has not been discovered.
+        Does the file path match the expected glob pattern?
+        [Read more](https://shopify.github.io/ruby-lsp/test_explorer.html)
+
+        Expected pattern: "**/{test,spec,features}/**/{*_test.rb,test_*.rb,*_spec.rb,*.feature}"`,
+      );
+      return;
+    }
 
     if (mode === Mode.Run) {
       await vscode.commands.executeCommand(