gopls/internal/test/marker: rename s/suggestedfix/quickfix/

At the protocol level, this operation requests all CodeActions
of kind "quickfix", so that's the appropriate name.
(SuggestedFix refers to types in go/analysis and in
gopls/internal/cache that are only loosely related.)

All the tests of @quickfix are now beneath testdata/quickfix
(except diagnostics/typeerr.txt since that's not its primary aim).

Change-Id: I907aab2fcc4c7f99170c1eefa5ee2cb8aca6331f
Reviewed-on: https://go-review.googlesource.com/c/tools/+/621598
Auto-Submit: Alan Donovan <[email protected]>
Reviewed-by: Robert Findley <[email protected]>
LUCI-TryBot-Result: Go LUCI <[email protected]>

Author: adonovan

gopls/internal/test/integration/workspace/quickfix_test.go

@@ -341,7 +341,7 @@ func main() {}
 }
 
 func TestStubMethods64087(t *testing.T) {
-	// We can't use the @fix or @suggestedfixerr or @codeactionerr
+	// We can't use the @fix or @quickfixerr or @codeactionerr
 	// because the error now reported by the corrected logic
 	// is internal and silently causes no fix to be offered.
 	//
@@ -404,7 +404,7 @@ type myerror struct{any}
 }
 
 func TestStubMethods64545(t *testing.T) {
-	// We can't use the @fix or @suggestedfixerr or @codeactionerr
+	// We can't use the @fix or @quickfixerr or @codeactionerr
 	// because the error now reported by the corrected logic
 	// is internal and silently causes no fix to be offered.
 	//

gopls/internal/test/marker/doc.go

@@ -219,14 +219,14 @@ The following markers are supported within marker tests:
     signatureHelp at the given location should match the provided string, with
     the active parameter (an index) highlighted.
 
-  - suggestedfix(location, regexp, golden): like diag, the location and
+  - quickfix(location, regexp, golden): like diag, the location and
     regexp identify an expected diagnostic, which must have exactly one
     associated "quickfix" code action.
     This action is executed for its editing effects on the source files.
     Like rename, the golden directory contains the expected transformed files.
 
-  - suggestedfixerr(location, regexp, wantError): specifies that the
-    suggestedfix operation should fail with an error that matches the expectation.
+  - quickfixerr(location, regexp, wantError): specifies that the
+    quickfix operation should fail with an error that matches the expectation.
     (Failures in the computation to offer a fix do not generally result
     in LSP errors, so this marker is not appropriate for testing them.)
 
@@ -372,6 +372,6 @@ Note that -update does not cause missing @diag or @loc markers to be added.
   - If possible, improve handling for optional arguments. Rather than have
     multiple variations of a marker, it would be nice to support a more
     flexible signature: can codeaction, codeactionedit, codeactionerr, and
-    suggestedfix be consolidated?
+    quickfix be consolidated?
 */
 package marker

gopls/internal/test/marker/marker_test.go

@@ -561,8 +561,8 @@ var actionMarkerFuncs = map[string]func(marker){
 	"selectionrange":   actionMarkerFunc(selectionRangeMarker),
 	"signature":        actionMarkerFunc(signatureMarker),
 	"snippet":          actionMarkerFunc(snippetMarker),
-	"suggestedfix":     actionMarkerFunc(suggestedfixMarker),
-	"suggestedfixerr":  actionMarkerFunc(suggestedfixErrMarker),
+	"quickfix":         actionMarkerFunc(quickfixMarker),
+	"quickfixerr":      actionMarkerFunc(quickfixErrMarker),
 	"symbol":           actionMarkerFunc(symbolMarker),
 	"token":            actionMarkerFunc(tokenMarker),
 	"typedef":          actionMarkerFunc(typedefMarker),
@@ -932,7 +932,7 @@ type markerTestRun struct {
 	settings map[string]any
 
 	// Collected information.
-	// Each @diag/@suggestedfix marker eliminates an entry from diags.
+	// Each @diag/@quickfix marker eliminates an entry from diags.
 	values map[expect.Identifier]any
 	diags  map[protocol.Location][]protocol.Diagnostic // diagnostics by position; location end == start
 
@@ -2047,13 +2047,11 @@ func (mark marker) consumeExtraNotes(name string, f func(marker)) {
 	}
 }
 
-// suggestedfixMarker implements the @suggestedfix(location, regexp,
+// quickfixMarker implements the @quickfix(location, regexp,
 // kind, golden) marker. It acts like @diag(location, regexp), to set
 // the expectation of a diagnostic, but then it applies the "quickfix"
 // code action (which must be unique) suggested by the matched diagnostic.
-//
-// TODO(adonovan): rename to @quickfix, since that's the LSP term.
-func suggestedfixMarker(mark marker, loc protocol.Location, re *regexp.Regexp, golden *Golden) {
+func quickfixMarker(mark marker, loc protocol.Location, re *regexp.Regexp, golden *Golden) {
 	loc.Range.End = loc.Range.Start // diagnostics ignore end position.
 	// Find and remove the matching diagnostic.
 	diag, ok := removeDiagnostic(mark, loc, re)
@@ -2065,15 +2063,15 @@ func suggestedfixMarker(mark marker, loc protocol.Location, re *regexp.Regexp, g
 	// Apply the fix it suggests.
 	changed, err := codeAction(mark.run.env, loc.URI, diag.Range, "quickfix", &diag)
 	if err != nil {
-		mark.errorf("suggestedfix failed: %v. (Use @suggestedfixerr for expected errors.)", err)
+		mark.errorf("quickfix failed: %v. (Use @quickfixerr for expected errors.)", err)
 		return
 	}
 
 	// Check the file state.
 	checkDiffs(mark, changed, golden)
 }
 
-func suggestedfixErrMarker(mark marker, loc protocol.Location, re *regexp.Regexp, wantErr stringMatcher) {
+func quickfixErrMarker(mark marker, loc protocol.Location, re *regexp.Regexp, wantErr stringMatcher) {
 	loc.Range.End = loc.Range.Start // diagnostics ignore end position.
 	// Find and remove the matching diagnostic.
 	diag, ok := removeDiagnostic(mark, loc, re)
@@ -2188,7 +2186,7 @@ func codeActionChanges(env *integration.Env, uri protocol.DocumentURI, rng proto
 		//
 		// The client makes an ExecuteCommand RPC to the server,
 		// which dispatches it to the ApplyFix handler.
-		// ApplyFix dispatches to the "stub_methods" suggestedfix hook (the meat).
+		// ApplyFix dispatches to the "stub_methods" fixer (the meat).
 		// The server then makes an ApplyEdit RPC to the client,
 		// whose WorkspaceEditFunc hook temporarily gathers the edits
 		// instead of applying them.

gopls/internal/test/marker/testdata/diagnostics/typeerr.txt

@@ -19,10 +19,10 @@ package a
 func f(x int) {
 	append("") //@diag(re`""`, re"a slice")
 
-	x := 123 //@diag(re"x := 123", re"no new variables"), suggestedfix(re"():", re"no new variables", fix)
+	x := 123 //@diag(re"x := 123", re"no new variables"), quickfix(re"():", re"no new variables", fix)
 }
 
 -- @fix/typeerr.go --
 @@ -6 +6 @@
--	x := 123 //@diag(re"x := 123", re"no new variables"), suggestedfix(re"():", re"no new variables", fix)
-+	x = 123 //@diag(re"x := 123", re"no new variables"), suggestedfix(re"():", re"no new variables", fix)
+-	x := 123 //@diag(re"x := 123", re"no new variables"), quickfix(re"():", re"no new variables", fix)
++	x = 123 //@diag(re"x := 123", re"no new variables"), quickfix(re"():", re"no new variables", fix)

gopls/internal/test/marker/testdata/suggestedfix/embeddirective.txt renamed to gopls/internal/test/marker/testdata/quickfix/embeddirective.txt

@@ -10,7 +10,7 @@ import (
 	"os"
 )
 
-//go:embed embed.txt //@suggestedfix("//go:embed", re`must import "embed"`, fix_import)
+//go:embed embed.txt //@quickfix("//go:embed", re`must import "embed"`, fix_import)
 var t string
 
 func unused() {

gopls/internal/test/marker/testdata/codeaction/infertypeargs.txt renamed to gopls/internal/test/marker/testdata/quickfix/infertypeargs.txt

@@ -15,11 +15,11 @@ func app[S interface{ ~[]E }, E interface{}](s S, e E) S {
 func _() {
 	_ = app[[]int]
 	_ = app[[]int, int]
-	_ = app[[]int]([]int{}, 0) //@suggestedfix("[[]int]", re"unnecessary type arguments", infer)
+	_ = app[[]int]([]int{}, 0) //@quickfix("[[]int]", re"unnecessary type arguments", infer)
 	_ = app([]int{}, 0)
 }
 
 -- @infer/p.go --
 @@ -10 +10 @@
--	_ = app[[]int]([]int{}, 0) //@suggestedfix("[[]int]", re"unnecessary type arguments", infer)
-+	_ = app([]int{}, 0) //@suggestedfix("[[]int]", re"unnecessary type arguments", infer)
+-	_ = app[[]int]([]int{}, 0) //@quickfix("[[]int]", re"unnecessary type arguments", infer)
++	_ = app([]int{}, 0) //@quickfix("[[]int]", re"unnecessary type arguments", infer)

gopls/internal/test/marker/testdata/suggestedfix/issue65024.txt renamed to gopls/internal/test/marker/testdata/quickfix/issue65024.txt

@@ -22,7 +22,7 @@ import "example.com/a/v2"
 
 type B struct{}
 
-var _ a.I = &B{} //@ suggestedfix("&B{}", re"does not implement", out)
+var _ a.I = &B{} //@ quickfix("&B{}", re"does not implement", out)
 
 // This line makes the diff tidier.
 
@@ -55,7 +55,7 @@ package b
 
 type B struct{}
 
-var _ I = &B{} //@ suggestedfix("&B{}", re"does not implement", out2)
+var _ I = &B{} //@ quickfix("&B{}", re"does not implement", out2)
 
 // This line makes the diff tidier.
 

gopls/internal/test/marker/testdata/suggestedfix/missingfunction.txt renamed to gopls/internal/test/marker/testdata/quickfix/missingfunction.txt

@@ -4,7 +4,7 @@ This test checks the quick fix for undefined functions.
 package missingfunction
 
 func channels(s string) {
-	undefinedChannels(c()) //@suggestedfix("undefinedChannels", re"(undeclared|undefined)", channels)
+	undefinedChannels(c()) //@quickfix("undefinedChannels", re"(undeclared|undefined)", channels)
 }
 
 func c() (<-chan string, chan string) {
@@ -21,7 +21,7 @@ package missingfunction
 
 func consecutiveParams() {
 	var s string
-	undefinedConsecutiveParams(s, s) //@suggestedfix("undefinedConsecutiveParams", re"(undeclared|undefined)", consecutive)
+	undefinedConsecutiveParams(s, s) //@quickfix("undefinedConsecutiveParams", re"(undeclared|undefined)", consecutive)
 }
 -- @consecutive/consecutive.go --
 @@ -7 +7,4 @@
@@ -34,7 +34,7 @@ package missingfunction
 
 func errorParam() {
 	var err error
-	undefinedErrorParam(err) //@suggestedfix("undefinedErrorParam", re"(undeclared|undefined)", error)
+	undefinedErrorParam(err) //@quickfix("undefinedErrorParam", re"(undeclared|undefined)", error)
 }
 -- @error/error.go --
 @@ -7 +7,4 @@
@@ -48,7 +48,7 @@ package missingfunction
 type T struct{}
 
 func literals() {
-	undefinedLiterals("hey compiler", T{}, &T{}) //@suggestedfix("undefinedLiterals", re"(undeclared|undefined)", literals)
+	undefinedLiterals("hey compiler", T{}, &T{}) //@quickfix("undefinedLiterals", re"(undeclared|undefined)", literals)
 }
 -- @literals/literals.go --
 @@ -8 +8,4 @@
@@ -62,7 +62,7 @@ package missingfunction
 import "time"
 
 func operation() {
-	undefinedOperation(10 * time.Second) //@suggestedfix("undefinedOperation", re"(undeclared|undefined)", operation)
+	undefinedOperation(10 * time.Second) //@quickfix("undefinedOperation", re"(undeclared|undefined)", operation)
 }
 -- @operation/operation.go --
 @@ -8 +8,4 @@
@@ -75,7 +75,7 @@ package missingfunction
 
 func selector() {
 	m := map[int]bool{}
-	undefinedSelector(m[1]) //@suggestedfix("undefinedSelector", re"(undeclared|undefined)", selector)
+	undefinedSelector(m[1]) //@quickfix("undefinedSelector", re"(undeclared|undefined)", selector)
 }
 -- @selector/selector.go --
 @@ -7 +7,4 @@
@@ -87,7 +87,7 @@ func selector() {
 package missingfunction
 
 func slice() {
-	undefinedSlice([]int{1, 2}) //@suggestedfix("undefinedSlice", re"(undeclared|undefined)", slice)
+	undefinedSlice([]int{1, 2}) //@quickfix("undefinedSlice", re"(undeclared|undefined)", slice)
 }
 -- @slice/slice.go --
 @@ -6 +6,4 @@
@@ -99,7 +99,7 @@ func slice() {
 package missingfunction
 
 func tuple() {
-	undefinedTuple(b()) //@suggestedfix("undefinedTuple", re"(undeclared|undefined)", tuple)
+	undefinedTuple(b()) //@quickfix("undefinedTuple", re"(undeclared|undefined)", tuple)
 }
 
 func b() (string, error) {
@@ -117,7 +117,7 @@ package missingfunction
 func uniqueArguments() {
 	var s string
 	var i int
-	undefinedUniqueArguments(s, i, s) //@suggestedfix("undefinedUniqueArguments", re"(undeclared|undefined)", unique)
+	undefinedUniqueArguments(s, i, s) //@quickfix("undefinedUniqueArguments", re"(undeclared|undefined)", unique)
 }
 -- @unique/unique_params.go --
 @@ -8 +8,4 @@

gopls/internal/test/marker/testdata/quickfix/noresultvalues.txt

@@ -0,0 +1,18 @@
+This test checks the quick fix for removing extra return values.
+
+Note: gopls should really discard unnecessary return statements.
+
+-- noresultvalues.go --
+package typeerrors
+
+func x() { return nil } //@quickfix("nil", re"too many return", x)
+
+func y() { return nil, "hello" } //@quickfix("nil", re"too many return", y)
+-- @x/noresultvalues.go --
+@@ -3 +3 @@
+-func x() { return nil } //@quickfix("nil", re"too many return", x)
++func x() { return } //@quickfix("nil", re"too many return", x)
+-- @y/noresultvalues.go --
+@@ -5 +5 @@
+-func y() { return nil, "hello" } //@quickfix("nil", re"too many return", y)
++func y() { return } //@quickfix("nil", re"too many return", y)

gopls/internal/test/marker/testdata/quickfix/self_assignment.txt

@@ -0,0 +1,19 @@
+Test of the suggested fix to remove unnecessary assignments.
+
+-- a.go --
+package quickfix
+
+import (
+	"log"
+)
+
+func goodbye() {
+	s := "hiiiiiii"
+	s = s //@quickfix("s = s", re"self-assignment", fix)
+	log.Print(s)
+}
+
+-- @fix/a.go --
+@@ -9 +9 @@
+-	s = s //@quickfix("s = s", re"self-assignment", fix)
++	 //@quickfix("s = s", re"self-assignment", fix)