gopls/internal/lsp/regtest: move @implementation to new framework

This change is a simple migration of the old @implementation tests
into the new marker framework. The tests themselves are logically
unchanged.

Change-Id: I431e13814612180a5500dba18b26ce8c66dbbe8b
Reviewed-on: https://go-review.googlesource.com/c/tools/+/479295
gopls-CI: kokoro <[email protected]>
Reviewed-by: Robert Findley <[email protected]>
TryBot-Result: Gopher Robot <[email protected]>
Run-TryBot: Alan Donovan <[email protected]>

Author: adonovan

gopls/internal/lsp/lsp_test.go

@@ -25,7 +25,6 @@ import (
 	"golang.org/x/tools/gopls/internal/lsp/tests/compare"
 	"golang.org/x/tools/gopls/internal/span"
 	"golang.org/x/tools/internal/bug"
-	"golang.org/x/tools/internal/diff"
 	"golang.org/x/tools/internal/event"
 	"golang.org/x/tools/internal/testenv"
 )
@@ -769,35 +768,6 @@ func (r *runner) Definition(t *testing.T, _ span.Span, d tests.Definition) {
 	}
 }
 
-func (r *runner) Implementation(t *testing.T, spn span.Span, wantSpans []span.Span) {
-	sm, err := r.data.Mapper(spn.URI())
-	if err != nil {
-		t.Fatal(err)
-	}
-	loc, err := sm.SpanLocation(spn)
-	if err != nil {
-		t.Fatal(err)
-	}
-	gotImpls, err := r.server.Implementation(r.ctx, &protocol.ImplementationParams{
-		TextDocumentPositionParams: protocol.LocationTextDocumentPositionParams(loc),
-	})
-	if err != nil {
-		t.Fatalf("Server.Implementation(%s): %v", spn, err)
-	}
-	gotLocs, err := tests.LocationsToSpans(r.data, gotImpls)
-	if err != nil {
-		t.Fatal(err)
-	}
-	sanitize := func(s string) string {
-		return strings.ReplaceAll(s, r.data.Config.Dir, "gopls/internal/lsp/testdata")
-	}
-	want := sanitize(tests.SortAndFormatSpans(wantSpans))
-	got := sanitize(tests.SortAndFormatSpans(gotLocs))
-	if got != want {
-		t.Errorf("implementations(%s):\n%s", sanitize(fmt.Sprint(spn)), diff.Unified("want", "got", want, got))
-	}
-}
-
 func (r *runner) Highlight(t *testing.T, src span.Span, spans []span.Span) {
 	m, err := r.data.Mapper(src.URI())
 	if err != nil {

gopls/internal/lsp/regtest/marker.go

@@ -34,7 +34,6 @@ import (
 	"golang.org/x/tools/gopls/internal/lsp/source"
 	"golang.org/x/tools/gopls/internal/lsp/tests"
 	"golang.org/x/tools/gopls/internal/lsp/tests/compare"
-	"golang.org/x/tools/internal/diff"
 	"golang.org/x/tools/internal/jsonrpc2"
 	"golang.org/x/tools/internal/jsonrpc2/servertest"
 	"golang.org/x/tools/internal/testenv"
@@ -130,6 +129,10 @@ var update = flag.Bool("update", false, "if set, update test data during marker
 //     src location, and checks that the result is the dst location, with hover
 //     content matching "hover.md" in the golden data g.
 //
+//   - implementations(src location, want ...location): makes a
+//     textDocument/implementation query at the src location and
+//     checks that the resulting set of locations matches want.
+//
 //   - loc(name, location): specifies the name for a location in the source. These
 //     locations may be referenced by other markers.
 //
@@ -258,7 +261,6 @@ var update = flag.Bool("update", false, "if set, update test data during marker
 //   - FunctionExtractions
 //   - MethodExtractions
 //   - Definitions
-//   - Implementations
 //   - Highlights
 //   - Renames
 //   - PrepareRenames
@@ -428,9 +430,7 @@ func (mark marker) execute() {
 		if i < len(fn.converters) {
 			convert = fn.converters[i]
 		} else if !fn.variadic {
-			mark.errorf("got %d arguments to %s, expect %d",
-				len(mark.note.Args), mark.note.Name, len(fn.converters))
-			return
+			goto arity // too many args
 		}
 
 		// Special handling for the blank identifier: treat it as the zero value.
@@ -447,8 +447,16 @@ func (mark marker) execute() {
 		}
 		args = append(args, reflect.ValueOf(out))
 	}
+	if len(args) < len(fn.converters) {
+		goto arity // too few args
+	}
 
 	fn.fn.Call(args)
+	return
+
+arity:
+	mark.errorf("got %d arguments to %s, want %d",
+		len(mark.note.Args), mark.note.Name, len(fn.converters))
 }
 
 // Supported marker functions.
@@ -459,15 +467,16 @@ func (mark marker) execute() {
 // Marker funcs should not mutate the test environment (e.g. via opening files
 // or applying edits in the editor).
 var markerFuncs = map[string]markerFunc{
-	"complete":     makeMarkerFunc(completeMarker),
-	"def":          makeMarkerFunc(defMarker),
-	"diag":         makeMarkerFunc(diagMarker),
-	"hover":        makeMarkerFunc(hoverMarker),
-	"loc":          makeMarkerFunc(locMarker),
-	"rename":       makeMarkerFunc(renameMarker),
-	"renameerr":    makeMarkerFunc(renameErrMarker),
-	"suggestedfix": makeMarkerFunc(suggestedfixMarker),
-	"refs":         makeMarkerFunc(refsMarker),
+	"complete":       makeMarkerFunc(completeMarker),
+	"def":            makeMarkerFunc(defMarker),
+	"diag":           makeMarkerFunc(diagMarker),
+	"hover":          makeMarkerFunc(hoverMarker),
+	"implementation": makeMarkerFunc(implementationMarker),
+	"loc":            makeMarkerFunc(locMarker),
+	"rename":         makeMarkerFunc(renameMarker),
+	"renameerr":      makeMarkerFunc(renameErrMarker),
+	"suggestedfix":   makeMarkerFunc(suggestedfixMarker),
+	"refs":           makeMarkerFunc(refsMarker),
 }
 
 // markerTest holds all the test data extracted from a test txtar archive.
@@ -1354,37 +1363,17 @@ func suggestedfix(env *Env, loc protocol.Location, diag protocol.Diagnostic, act
 // refsMarker implements the @refs marker.
 func refsMarker(mark marker, src protocol.Location, want ...protocol.Location) {
 	refs := func(includeDeclaration bool, want []protocol.Location) error {
-		params := &protocol.ReferenceParams{
+		got, err := mark.run.env.Editor.Server.References(mark.run.env.Ctx, &protocol.ReferenceParams{
 			TextDocumentPositionParams: protocol.LocationTextDocumentPositionParams(src),
 			Context: protocol.ReferenceContext{
 				IncludeDeclaration: includeDeclaration,
 			},
-		}
-
-		got, err := mark.run.env.Editor.Server.References(mark.run.env.Ctx, params)
+		})
 		if err != nil {
 			return err
 		}
 
-		// Compare the sets of locations.
-		toString := func(locs []protocol.Location) string {
-			// TODO(adonovan): use generic JoinValues(locs, fmtLoc).
-			strs := make([]string, len(locs))
-			for i, loc := range locs {
-				strs[i] = mark.run.fmtLoc(loc)
-			}
-			sort.Strings(strs)
-			return strings.Join(strs, "\n")
-		}
-		gotStr := toString(got)
-		wantStr := toString(want)
-		if gotStr != wantStr {
-			return fmt.Errorf("incorrect references (got %d, want %d) at %s:\n%s",
-				len(got), len(want),
-				mark.run.fmtLoc(src),
-				diff.Unified("want", "got", wantStr, gotStr))
-		}
-		return nil
+		return compareLocations(mark, got, want)
 	}
 
 	for _, includeDeclaration := range []bool{false, true} {
@@ -1401,3 +1390,35 @@ func refsMarker(mark marker, src protocol.Location, want ...protocol.Location) {
 		}
 	}
 }
+
+// implementationMarker implements the @implementation marker.
+func implementationMarker(mark marker, src protocol.Location, want ...protocol.Location) {
+	got, err := mark.run.env.Editor.Server.Implementation(mark.run.env.Ctx, &protocol.ImplementationParams{
+		TextDocumentPositionParams: protocol.LocationTextDocumentPositionParams(src),
+	})
+	if err != nil {
+		mark.errorf("implementation at %s failed: %v", src, err)
+		return
+	}
+	if err := compareLocations(mark, got, want); err != nil {
+		mark.errorf("implementation: %v", err)
+	}
+}
+
+// compareLocations returns an error message if got and want are not
+// the same set of locations. The marker is used only for fmtLoc.
+func compareLocations(mark marker, got, want []protocol.Location) error {
+	toStrings := func(locs []protocol.Location) []string {
+		strs := make([]string, len(locs))
+		for i, loc := range locs {
+			strs[i] = mark.run.fmtLoc(loc)
+		}
+		sort.Strings(strs)
+		return strs
+	}
+	if diff := cmp.Diff(toStrings(want), toStrings(got)); diff != "" {
+		return fmt.Errorf("incorrect result locations: (got %d, want %d):\n%s",
+			len(got), len(want), diff)
+	}
+	return nil
+}

gopls/internal/lsp/testdata/implementation/implementation.go

@@ -26,6 +26,5 @@ SymbolsCount = 1
 WorkspaceSymbolsCount = 20
 SignaturesCount = 33
 LinksCount = 7
-ImplementationsCount = 16
 SelectionRangesCount = 3
 

gopls/internal/lsp/testdata/implementation/implementation_generics.go

@@ -26,6 +26,5 @@ SymbolsCount = 2
 WorkspaceSymbolsCount = 20
 SignaturesCount = 33
 LinksCount = 7
-ImplementationsCount = 26
 SelectionRangesCount = 3