gopls: port import tests to the new marker framework

Port all the import tests by reusing the "codeaction" marker, with the
exception of one which was flaky due to golang/go#59976.

Updates golang/go#54845

Change-Id: I60688ba0bbc6f5c17018d304748555f3951d0556
Reviewed-on: https://go-review.googlesource.com/c/tools/+/492675
TryBot-Result: Gopher Robot <gobot@golang.org>
Run-TryBot: Robert Findley <rfindley@google.com>
Reviewed-by: Alan Donovan <adonovan@google.com>
gopls-CI: kokoro <noreply+kokoro@google.com>

Author: findleyr

gopls/internal/lsp/lsp_test.go

@@ -418,39 +418,6 @@ func (r *runner) SemanticTokens(t *testing.T, spn span.Span) {
 	}
 }
 
-func (r *runner) Import(t *testing.T, spn span.Span) {
-	// Invokes textDocument/codeAction and applies all the "goimports" edits.
-
-	uri := spn.URI()
-	filename := uri.Filename()
-	actions, err := r.server.CodeAction(r.ctx, &protocol.CodeActionParams{
-		TextDocument: protocol.TextDocumentIdentifier{
-			URI: protocol.URIFromSpanURI(uri),
-		},
-	})
-	if err != nil {
-		t.Fatal(err)
-	}
-	m, err := r.data.Mapper(uri)
-	if err != nil {
-		t.Fatal(err)
-	}
-	got := m.Content
-	if len(actions) > 0 {
-		res, err := applyTextDocumentEdits(r, actions[0].Edit.DocumentChanges)
-		if err != nil {
-			t.Fatal(err)
-		}
-		got = res[uri]
-	}
-	want := r.data.Golden(t, "goimports", filename, func() ([]byte, error) {
-		return got, nil
-	})
-	if diff := compare.Bytes(want, got); diff != "" {
-		t.Errorf("import failed for %s:\n%s", filename, diff)
-	}
-}
-
 func (r *runner) SuggestedFix(t *testing.T, spn span.Span, actionKinds []tests.SuggestedFix, expectedActions int) {
 	uri := spn.URI()
 	view, err := r.server.session.ViewOf(uri)

gopls/internal/lsp/regtest/marker.go

@@ -124,6 +124,9 @@ var update = flag.Bool("update", false, "if set, update test data during marker
 //     to be between start.Start and end.End. The golden directory contains
 //     changed file content after the code action is applied.
 //
+//   - codeactionerr(kind, start, end, wantError): specifies a codeaction that
+//     fails with an error that matches the expectation.
+//
 //   - complete(location, ...labels): specifies expected completion results at
 //     the given location.
 //
@@ -506,6 +509,7 @@ arity:
 // or applying edits in the editor).
 var markerFuncs = map[string]markerFunc{
 	"codeaction":      makeMarkerFunc(codeActionMarker),
+	"codeactionerr":   makeMarkerFunc(codeActionErrMarker),
 	"complete":        makeMarkerFunc(completeMarker),
 	"def":             makeMarkerFunc(defMarker),
 	"diag":            makeMarkerFunc(diagMarker),
@@ -1398,6 +1402,13 @@ func codeActionMarker(mark marker, actionKind string, start, end protocol.Locati
 	checkChangedFiles(mark, changed, golden)
 }
 
+func codeActionErrMarker(mark marker, actionKind string, start, end protocol.Location, wantErr wantError) {
+	loc := start
+	loc.Range.End = end.Range.End
+	_, err := codeAction(mark.run.env, loc.URI, loc.Range, actionKind, nil)
+	wantErr.check(mark, err)
+}
+
 // suggestedfixMarker implements the @suggestedfix(location, regexp,
 // kind, golden) marker. It acts like @diag(location, regexp), to set
 // the expectation of a diagnostic, but then it applies the first code

gopls/internal/lsp/testdata/imports/add_import.go.golden

@@ -10,7 +10,6 @@ RankedCompletionsCount = 164
 CaseSensitiveCompletionsCount = 4
 DiagnosticsCount = 39
 FoldingRangesCount = 2
-ImportCount = 8
 SemanticTokenCount = 3
 SuggestedFixCount = 76
 MethodExtractionCount = 6

gopls/internal/lsp/testdata/imports/add_import.go.in

@@ -10,7 +10,6 @@ RankedCompletionsCount = 174
 CaseSensitiveCompletionsCount = 4
 DiagnosticsCount = 39
 FoldingRangesCount = 2
-ImportCount = 8
 SemanticTokenCount = 3
 SuggestedFixCount = 82
 MethodExtractionCount = 6

gopls/internal/lsp/testdata/imports/good_imports.go.golden

@@ -10,7 +10,6 @@ RankedCompletionsCount = 174
 CaseSensitiveCompletionsCount = 4
 DiagnosticsCount = 40
 FoldingRangesCount = 2
-ImportCount = 8
 SemanticTokenCount = 3
 SuggestedFixCount = 82
 MethodExtractionCount = 6

gopls/internal/lsp/testdata/imports/good_imports.go.in

@@ -77,7 +77,6 @@ type FuzzyCompletions = map[span.Span][]Completion
 type CaseSensitiveCompletions = map[span.Span][]Completion
 type RankCompletions = map[span.Span][]Completion
 type FoldingRanges = []span.Span
-type Imports = []span.Span
 type SemanticTokens = []span.Span
 type SuggestedFixes = map[span.Span][]SuggestedFix
 type MethodExtractions = map[span.Span]span.Span
@@ -106,7 +105,6 @@ type Data struct {
 	CaseSensitiveCompletions CaseSensitiveCompletions
 	RankCompletions          RankCompletions
 	FoldingRanges            FoldingRanges
-	Imports                  Imports
 	SemanticTokens           SemanticTokens
 	SuggestedFixes           SuggestedFixes
 	MethodExtractions        MethodExtractions
@@ -149,7 +147,6 @@ type Tests interface {
 	CaseSensitiveCompletion(*testing.T, span.Span, Completion, CompletionItems)
 	RankCompletion(*testing.T, span.Span, Completion, CompletionItems)
 	FoldingRanges(*testing.T, span.Span)
-	Import(*testing.T, span.Span)
 	SemanticTokens(*testing.T, span.Span)
 	SuggestedFix(*testing.T, span.Span, []SuggestedFix, int)
 	MethodExtraction(*testing.T, span.Span, span.Span)
@@ -432,7 +429,6 @@ func load(t testing.TB, mode string, dir string) *Data {
 		"rank":           datum.collectCompletions(CompletionRank),
 		"snippet":        datum.collectCompletionSnippets,
 		"fold":           datum.collectFoldingRanges,
-		"import":         datum.collectImports,
 		"semantic":       datum.collectSemanticTokens,
 		"godef":          datum.collectDefinitions,
 		"typdef":         datum.collectTypeDefinitions,
@@ -624,16 +620,6 @@ func Run(t *testing.T, tests Tests, data *Data) {
 		}
 	})
 
-	t.Run("Import", func(t *testing.T) {
-		t.Helper()
-		for _, spn := range data.Imports {
-			t.Run(uriName(spn.URI()), func(t *testing.T) {
-				t.Helper()
-				tests.Import(t, spn)
-			})
-		}
-	})
-
 	t.Run("SemanticTokens", func(t *testing.T) {
 		t.Helper()
 		for _, spn := range data.SemanticTokens {
@@ -840,7 +826,6 @@ func checkData(t *testing.T, data *Data) {
 	fmt.Fprintf(buf, "CaseSensitiveCompletionsCount = %v\n", countCompletions(data.CaseSensitiveCompletions))
 	fmt.Fprintf(buf, "DiagnosticsCount = %v\n", diagnosticsCount)
 	fmt.Fprintf(buf, "FoldingRangesCount = %v\n", len(data.FoldingRanges))
-	fmt.Fprintf(buf, "ImportCount = %v\n", len(data.Imports))
 	fmt.Fprintf(buf, "SemanticTokenCount = %v\n", len(data.SemanticTokens))
 	fmt.Fprintf(buf, "SuggestedFixCount = %v\n", len(data.SuggestedFixes))
 	fmt.Fprintf(buf, "MethodExtractionCount = %v\n", len(data.MethodExtractions))
@@ -1015,10 +1000,6 @@ func (data *Data) collectFoldingRanges(spn span.Span) {
 	data.FoldingRanges = append(data.FoldingRanges, spn)
 }
 
-func (data *Data) collectImports(spn span.Span) {
-	data.Imports = append(data.Imports, spn)
-}
-
 func (data *Data) collectAddImports(spn span.Span, imp string) {
 	data.AddImport[spn.URI()] = imp
 }