Add test command resolution

Author: alexcrocha

lib/ruby_lsp/ruby_lsp_rails/addon.rb

@@ -93,6 +93,12 @@ def create_discover_tests_listener(response_builder, dispatcher, uri)
         RailsTestStyle.new(@rails_runner_client, response_builder, @global_state, dispatcher, uri)
       end
 
+      # @override
+      #: (Array[Hash[Symbol, untyped]]) -> Array[String]
+      def resolve_test_commands(items)
+        RailsTestStyle.resolve_test_commands(items)
+      end
+
       # Creates a new CodeLens listener. This method is invoked on every CodeLens request
       # @override
       #: (ResponseBuilders::CollectionResponseBuilder[Interface::CodeLens] response_builder, URI::Generic uri, Prism::Dispatcher dispatcher) -> void

lib/ruby_lsp/ruby_lsp_rails/rails_test_style.rb

@@ -4,6 +4,52 @@
 module RubyLsp
   module Rails
     class RailsTestStyle < Listeners::TestDiscovery
+      BASE_COMMAND = "#{RbConfig.ruby} bin/rails test" #: String
+
+      class << self
+        #: (Array[Hash[Symbol, untyped]]) -> Array[String]
+        def resolve_test_commands(items)
+          commands = []
+          queue = items.dup
+
+          full_files = []
+
+          until queue.empty?
+            item = T.must(queue.shift)
+            tags = Set.new(item[:tags])
+            next unless tags.include?("framework:rails")
+
+            children = item[:children]
+            uri = URI(item[:uri])
+            path = uri.full_path
+            next unless path
+
+            if tags.include?("test_dir")
+              if children.empty?
+                full_files.concat(Dir.glob(
+                  "#{path}/**/{*_test,test_*}.rb",
+                  File::Constants::FNM_EXTGLOB | File::Constants::FNM_PATHNAME,
+                ))
+              end
+            elsif tags.include?("test_file")
+              full_files << path if children.empty?
+            elsif tags.include?("test_group")
+              commands << "#{BASE_COMMAND} #{path} --name \"/#{Shellwords.escape(item[:id])}(#|::)/\""
+            else
+              full_files << "#{path}:#{item.dig(:range, :start, :line) + 1}"
+            end
+
+            queue.concat(children)
+          end
+
+          unless full_files.empty?
+            commands << "#{BASE_COMMAND} #{full_files.join(" ")}"
+          end
+
+          commands
+        end
+      end
+
       #: (RunnerClient client, ResponseBuilders::TestCollection response_builder, GlobalState global_state, Prism::Dispatcher dispatcher, URI::Generic uri) -> void
       def initialize(client, response_builder, global_state, dispatcher, uri)
         super(response_builder, global_state, dispatcher, uri)

test/ruby_lsp_rails/rails_test_style_test.rb

@@ -133,6 +133,96 @@ class SpecialCharsTest < ActiveSupport::TestCase
         end
       end
 
+      test "resolve test command entire files" do
+        Dir.stubs(:glob).returns(["/other/test/fake_test.rb", "/other/test/fake_test2.rb"])
+
+        with_server do |server|
+          sleep(0.1) while RubyLsp::Addon.addons.first.instance_variable_get(:@rails_runner_client).is_a?(NullClient)
+
+          server.process_message({
+            id: 1,
+            method: "rubyLsp/resolveTestCommands",
+            params: {
+              items: [
+                {
+                  id: "file:///test/server_test.rb",
+                  uri: "file:///test/server_test.rb",
+                  label: "/test/server_test.rb",
+                  tags: ["test_file", "framework:rails"],
+                  children: [],
+                },
+                {
+                  id: "file:///other/test",
+                  uri: "file:///other/test",
+                  label: "/other/test",
+                  tags: ["test_dir", "framework:rails"],
+                  children: [],
+                },
+              ],
+            },
+          })
+
+          result = pop_result(server)
+          response = result.response
+
+          assert_equal(
+            [
+              "#{RailsTestStyle::BASE_COMMAND} /test/server_test.rb /other/test/fake_test.rb /other/test/fake_test2.rb",
+            ],
+            response[:commands],
+          )
+        end
+      end
+
+      test "resolve test command group test" do
+        with_server do |server|
+          sleep(0.1) while RubyLsp::Addon.addons.first.instance_variable_get(:@rails_runner_client).is_a?(NullClient)
+
+          server.process_message({
+            id: 1,
+            method: "rubyLsp/resolveTestCommands",
+            params: {
+              items: [
+                {
+                  id: "GroupTest",
+                  uri: "file:///test/group_test.rb",
+                  label: "GroupTest",
+                  range: {
+                    start: { line: 0, character: 0 },
+                    end: { line: 30, character: 3 },
+                  },
+                  tags: ["framework:rails", "test_group"],
+                  children: [
+                    {
+                      id: "GroupTest#test_example",
+                      uri: "file:///test/group_test.rb",
+                      label: "test_example",
+                      range: {
+                        start: { line: 1, character: 2 },
+                        end: { line: 10, character: 3 },
+                      },
+                      tags: ["framework:rails"],
+                      children: [],
+                    },
+                  ],
+                },
+              ],
+            },
+          })
+
+          result = pop_result(server)
+          response = result.response
+
+          assert_equal(
+            [
+              "#{RailsTestStyle::BASE_COMMAND} /test/group_test.rb --name \"/GroupTest(#|::)/\"",
+              "#{RailsTestStyle::BASE_COMMAND} /test/group_test.rb:2",
+            ],
+            response[:commands],
+          )
+        end
+      end
+
       private
 
       def with_active_support_declarative_tests(source, file: "/fake.rb", &block)