add tests for code action

Author: ShoshinNikita

gopls/doc/codelenses.md

@@ -40,6 +40,17 @@ Default: on
 
 File type: Go
 
+## `go_to_test`: Go to the functions's Test, Example, Benchmark, or Fuzz declarations
+
+
+This codelens source annotates function and method declarations
+with their corresponding Test, Example, Benchmark, and Fuzz functions.
+
+
+Default: off
+
+File type: Go
+
 ## `regenerate_cgo`: Re-generate cgo declarations
 
 

gopls/internal/cache/testfuncs/tests.go

@@ -8,6 +8,7 @@ import (
 	"go/ast"
 	"go/constant"
 	"go/types"
+	"iter"
 	"strings"
 	"unicode"
 	"unicode/utf8"
@@ -35,14 +36,16 @@ func (index *Index) Encode() []byte {
 	return packageCodec.Encode(index.pkg)
 }
 
-func (index *Index) All() []Result {
-	var results []Result
-	for _, file := range index.pkg.Files {
-		for _, test := range file.Tests {
-			results = append(results, test.result())
+func (index *Index) All() iter.Seq[Result] {
+	return func(yield func(Result) bool) {
+		for _, file := range index.pkg.Files {
+			for _, test := range file.Tests {
+				if !yield(test.result()) {
+					return
+				}
+			}
 		}
 	}
-	return results
 }
 
 // A Result reports a test function

gopls/internal/doc/api.json

@@ -2013,6 +2013,12 @@
 							"Default": "true",
 							"Status": ""
 						},
+						{
+							"Name": "\"go_to_test\"",
+							"Doc": "`\"go_to_test\"`: Go to the functions's Test, Example, Benchmark, or Fuzz declarations\n\nThis codelens source annotates function and method declarations\nwith their corresponding Test, Example, Benchmark, and Fuzz functions.\n",
+							"Default": "false",
+							"Status": ""
+						},
 						{
 							"Name": "\"regenerate_cgo\"",
 							"Doc": "`\"regenerate_cgo\"`: Re-generate cgo declarations\n\nThis codelens source annotates an `import \"C\"` declaration\nwith a command to re-run the [cgo\ncommand](https://pkg.go.dev/cmd/cgo) to regenerate the\ncorresponding Go declarations.\n\nUse this after editing the C code in comments attached to\nthe import, or in C header files included by it.\n",
@@ -2200,6 +2206,14 @@
 			"Default": true,
 			"Status": ""
 		},
+		{
+			"FileType": "Go",
+			"Lens": "go_to_test",
+			"Title": "Go to the functions's Test, Example, Benchmark, or Fuzz declarations",
+			"Doc": "\nThis codelens source annotates function and method declarations\nwith their corresponding Test, Example, Benchmark, and Fuzz functions.\n",
+			"Default": false,
+			"Status": ""
+		},
 		{
 			"FileType": "Go",
 			"Lens": "regenerate_cgo",

gopls/internal/golang/code_lens.go

@@ -24,7 +24,7 @@ import (
 	"golang.org/x/tools/gopls/internal/protocol"
 	"golang.org/x/tools/gopls/internal/protocol/command"
 	"golang.org/x/tools/gopls/internal/settings"
-	"golang.org/x/tools/gopls/internal/util/astutil"
+	"golang.org/x/tools/internal/astutil"
 )
 
 // CodeLensSources returns the supported sources of code lenses for Go files.
@@ -214,6 +214,12 @@ func regenerateCgoLens(ctx context.Context, snapshot *cache.Snapshot, fh file.Ha
 }
 
 func goToTestCodeLens(ctx context.Context, snapshot *cache.Snapshot, fh file.Handle) ([]protocol.CodeLens, error) {
+	if !snapshot.Options().ClientOptions.ShowDocumentSupported {
+		// GoToTest command uses 'window/showDocument' request. Don't generate
+		// code lenses for clients that won't be able to use them.
+		return nil, nil
+	}
+
 	matches, err := matchFunctionsWithTests(ctx, snapshot, fh)
 	if err != nil {
 		return nil, err
@@ -298,7 +304,7 @@ func matchFunctionsWithTests(ctx context.Context, snapshot *cache.Snapshot, fh f
 		return nil, fmt.Errorf("couldn't request all tests for packages %v: %w", pkgIDs, err)
 	}
 	for _, tests := range allTests {
-		for _, test := range tests.All() {
+		for test := range tests.All() {
 			if test.Subtest {
 				continue
 			}
@@ -310,9 +316,9 @@ func matchFunctionsWithTests(ctx context.Context, snapshot *cache.Snapshot, fh f
 			var matchedFunc Func
 			for _, fn := range fileFuncs {
 				var matched bool
-				for _, n := range potentialFuncNames {
-					// Check the prefix to be able to match 'TestDeletePanics' with 'Delete'.
-					if strings.HasPrefix(n, fn.Name) {
+				for _, potentialName := range potentialFuncNames {
+					// Check the prefix to match 'TestDeletePanics' with 'Delete'.
+					if strings.HasPrefix(potentialName, fn.Name) {
 						matched = true
 						break
 					}
@@ -373,13 +379,13 @@ func getPotentialFuncNames(test testfuncs.Result) []string {
 	if name == "" {
 		return nil
 	}
-	name = strings.TrimPrefix(name, "_")
-
-	lowerCasedName := []rune(name)
-	lowerCasedName[0] = unicode.ToLower(lowerCasedName[0])
+	name = strings.TrimPrefix(name, "_") // 'Foo' for 'TestFoo', 'foo' for 'Test_foo'
 
-	return []string{
-		name,                   // 'Foo' for 'TestFoo', 'foo' for 'Test_foo'
-		string(lowerCasedName), // 'foo' for 'TestFoo'
+	names := []string{name}
+	if token.IsExported(name) {
+		unexportedName := []rune(name)
+		unexportedName[0] = unicode.ToLower(unexportedName[0])
+		names = append(names, string(unexportedName)) // 'foo' for 'TestFoo'
 	}
+	return names
 }

gopls/internal/golang/codeaction.go

@@ -238,6 +238,7 @@ type codeActionProducer struct {
 var codeActionProducers = [...]codeActionProducer{
 	{kind: protocol.QuickFix, fn: quickFix, needPkg: true},
 	{kind: protocol.SourceOrganizeImports, fn: sourceOrganizeImports},
+	{kind: settings.GoToTest, fn: goToTestCodeAction, needPkg: true},
 	{kind: settings.AddTest, fn: addTest, needPkg: true},
 	{kind: settings.GoAssembly, fn: goAssembly, needPkg: true},
 	{kind: settings.GoDoc, fn: goDoc, needPkg: true},
@@ -266,7 +267,6 @@ var codeActionProducers = [...]codeActionProducer{
 	{kind: settings.RefactorRewriteEliminateDotImport, fn: refactorRewriteEliminateDotImport, needPkg: true},
 	{kind: settings.RefactorRewriteAddTags, fn: refactorRewriteAddStructTags, needPkg: true},
 	{kind: settings.RefactorRewriteRemoveTags, fn: refactorRewriteRemoveStructTags, needPkg: true},
-	{kind: settings.GoToTest, fn: goToTest, needPkg: true},
 	{kind: settings.GoplsDocFeatures, fn: goplsDocFeatures}, // offer this one last (#72742)
 
 	// Note: don't forget to update the allow-list in Server.CodeAction
@@ -1131,10 +1131,14 @@ func toggleCompilerOptDetails(ctx context.Context, req *codeActionsRequest) erro
 	return nil
 }
 
-// goToTest produces "Go to TestXxx" code action.
+// goToTestCodeAction produces "Go to TestXxx" code action.
 // See [server.commandHandler.GoToTest] for command implementation.
-func goToTest(ctx context.Context, req *codeActionsRequest) error {
-	// TODO: add tests.
+func goToTestCodeAction(ctx context.Context, req *codeActionsRequest) error {
+	if !req.snapshot.Options().ClientOptions.ShowDocumentSupported {
+		// GoToTest command uses 'window/showDocument' request. Don't generate
+		// code actions for clients that won't be able to use them.
+		return nil
+	}
 
 	path, _ := astutil.PathEnclosingInterval(req.pgf.File, req.start, req.end)
 	if len(path) < 2 {

gopls/internal/server/command.go

@@ -234,7 +234,7 @@ func (h *commandHandler) Packages(ctx context.Context, args command.PackagesArgs
 			for i, tests := range allTests {
 				pkg := &result.Packages[start+i]
 				fileByPath := map[protocol.DocumentURI]*command.TestFile{}
-				for _, test := range tests.All() {
+				for test := range tests.All() {
 					test := command.TestCase{
 						Name: test.Name,
 						Loc:  test.Location,

gopls/internal/settings/settings.go

@@ -359,7 +359,7 @@ const (
 
 	// Go to the functions's Test, Example, Benchmark, or Fuzz declarations
 	//
-	// This codelens source annotates the function and method declarations
+	// This codelens source annotates function and method declarations
 	// with their corresponding Test, Example, Benchmark, and Fuzz functions.
 	CodeLensGoToTest CodeLensSource = "go_to_test"
 )

gopls/internal/test/integration/misc/codeactions_test.go

@@ -16,13 +16,23 @@ func bar() {} //@codelens(re"()func bar", "Go to Test_bar"),codelens(re"()func b
 
 func xyz() {} //@codelens(re"()func xyz", "Go to TestXyz")
 
+func Translate() { //@codelens(re"()func Translate", "Go to TestTranslate")
+	translate()
+}
+
+func translate() {}
+
 -- a1_test.go --
 package codelenses
 
 import "testing"
 
 func TestFoo(*testing.T) {}
 
+func TestTranslate(*testing.T) {
+	translate()
+}
+
 -- a2_test.go --
 package codelenses
 
@@ -84,3 +94,17 @@ func TestDeletePanics(*testing.T) {}
 func TestDeleteFunc(*testing.T) {}
 
 func TestDeleteFuncClearTail(*testing.T) {}
+
+-- example.go --
+//@codelenses()
+
+package codelenses
+
+func Sort() {} //@codelens(re"()func", "Go to ExampleSort_long"),codelens(re"()func", "Go to ExampleSort_short")
+
+-- example_test.go --
+package codelenses
+
+func ExampleSort_short() {}
+
+func ExampleSort_long() {}