gopls/internal/regtest: eliminate DiagnosticAt

Replace the DiagnosticAt expectation with a filter.

Updates golang/go#39384

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

gopls/internal/lsp/regtest/expectation.go

@@ -817,6 +817,18 @@ func (e *Env) AtRegexp(name, pattern string) DiagnosticFilter {
 	}
 }
 
+// AtPosition filters to diagnostics at location name:line:character, for a
+// sandbox-relative path name.
+func AtPosition(name string, line, character uint32) DiagnosticFilter {
+	pos := protocol.Position{Line: line, Character: character}
+	return DiagnosticFilter{
+		desc: fmt.Sprintf("at %s:%d:%d", name, line, character),
+		check: func(diagName string, d protocol.Diagnostic) bool {
+			return diagName == name && d.Range.Start == pos
+		},
+	}
+}
+
 // WithMessageContaining filters to diagnostics whose message contains the
 // given substring.
 func WithMessageContaining(substring string) DiagnosticFilter {
@@ -846,9 +858,3 @@ func (e *Env) DiagnosticAtRegexpWithMessage(name, re, msg string) DiagnosticExpe
 	pos := e.RegexpSearch(name, re)
 	return DiagnosticExpectation{path: name, pos: &pos, re: re, present: true, message: msg}
 }
-
-// DiagnosticAt asserts that there is a diagnostic entry at the position
-// specified by line and col, for the workdir-relative path name.
-func DiagnosticAt(name string, line, col uint32) DiagnosticExpectation {
-	return DiagnosticExpectation{path: name, pos: &protocol.Position{Line: line, Character: col}, present: true}
-}

gopls/internal/regtest/codelens/gcdetails_test.go

@@ -46,7 +46,7 @@ func main() {
 		env.ExecuteCodeLensCommand("main.go", command.GCDetails, nil)
 		d := &protocol.PublishDiagnosticsParams{}
 		env.OnceMet(
-			DiagnosticAt("main.go", 5, 13),
+			Diagnostics(AtPosition("main.go", 5, 13)),
 			ReadDiagnostics("main.go", d),
 		)
 		// Confirm that the diagnostics come from the gc details code lens.
@@ -71,7 +71,7 @@ func main() {
 		// Saving a buffer should re-format back to the original state, and
 		// re-enable the gc_details diagnostics.
 		env.SaveBuffer("main.go")
-		env.AfterChange(DiagnosticAt("main.go", 5, 13))
+		env.AfterChange(Diagnostics(AtPosition("main.go", 5, 13)))
 
 		// Toggle the GC details code lens again so now it should be off.
 		env.ExecuteCodeLensCommand("main.go", command.GCDetails, nil)

gopls/internal/regtest/diagnostics/diagnostics_test.go

@@ -228,9 +228,9 @@ func TestDeleteTestVariant(t *testing.T) {
 func TestDeleteTestVariant_DiskOnly(t *testing.T) {
 	Run(t, test38878, func(t *testing.T, env *Env) {
 		env.OpenFile("a_test.go")
-		env.Await(DiagnosticAt("a_test.go", 5, 3))
+		env.Await(Diagnostics(AtPosition("a_test.go", 5, 3)))
 		env.Sandbox.Workdir.RemoveFile(context.Background(), "a_test.go")
-		env.AfterChange(DiagnosticAt("a_test.go", 5, 3))
+		env.AfterChange(Diagnostics(AtPosition("a_test.go", 5, 3)))
 	})
 }
 
@@ -343,8 +343,8 @@ func TestHello(t *testing.T) {
 	Run(t, testPackage, func(t *testing.T, env *Env) {
 		env.OpenFile("lib_test.go")
 		env.Await(
-			DiagnosticAt("lib_test.go", 10, 2),
-			DiagnosticAt("lib_test.go", 11, 2),
+			Diagnostics(AtPosition("lib_test.go", 10, 2)),
+			Diagnostics(AtPosition("lib_test.go", 11, 2)),
 		)
 		env.OpenFile("lib.go")
 		env.RegexpReplace("lib.go", "_ = x", "var y int")
@@ -515,7 +515,7 @@ func _() {
 		env.OpenFile("main.go")
 		var d protocol.PublishDiagnosticsParams
 		env.AfterChange(
-			DiagnosticAt("main.go", 5, 8),
+			Diagnostics(AtPosition("main.go", 5, 8)),
 			ReadDiagnostics("main.go", &d),
 		)
 		if fixes := env.GetQuickFixes("main.go", d.Diagnostics); len(fixes) != 0 {
@@ -1286,7 +1286,7 @@ func _() {
 		)
 		env.OpenFile("a/a_exclude.go")
 		env.Await(
-			DiagnosticAt("a/a_exclude.go", 2, 8),
+			Diagnostics(env.AtRegexp("a/a_exclude.go", "package (a)")),
 		)
 	})
 }

gopls/internal/regtest/misc/configuration_test.go

@@ -46,7 +46,7 @@ var FooErr = errors.New("foo")
 		// change.
 		env.ChangeConfiguration(cfg)
 		env.Await(
-			DiagnosticAt("a/a.go", 5, 4),
+			Diagnostics(env.AtRegexp("a/a.go", "var (FooErr)")),
 		)
 	})
 }

gopls/internal/regtest/modfile/modfile_test.go

@@ -1023,7 +1023,7 @@ func main() {}
 			env.OpenFile("go.mod")
 			pos := env.RegexpSearch("go.mod", "require hasdep.com v1.2.3")
 			env.AfterChange(
-				DiagnosticAt("go.mod", pos.Line, pos.Character),
+				Diagnostics(AtPosition("go.mod", pos.Line, pos.Character)),
 				ReadDiagnostics("go.mod", d),
 			)
 			const want = `module mod.com

gopls/internal/regtest/watch/watch_test.go

@@ -324,7 +324,7 @@ func _() {
 		Run(t, pkg, func(t *testing.T, env *Env) {
 			env.WriteWorkspaceFile("b/b.go", newMethod)
 			env.AfterChange(
-				DiagnosticAt("a/a.go", 12, 12),
+				Diagnostics(AtPosition("a/a.go", 12, 12)),
 			)
 			env.WriteWorkspaceFile("a/a.go", implementation)
 			env.AfterChange(

gopls/internal/regtest/workspace/workspace_test.go

@@ -503,7 +503,7 @@ func Hello() int {
 	).Run(t, multiModule, func(t *testing.T, env *Env) {
 		env.OpenFile("modb/go.mod")
 		env.AfterChange(
-			DiagnosticAt("modb/go.mod", 0, 0),
+			Diagnostics(AtPosition("modb/go.mod", 0, 0)),
 		)
 		env.RegexpReplace("modb/go.mod", "modul", "module")
 		env.SaveBufferWithoutActions("modb/go.mod")
@@ -1052,7 +1052,7 @@ func main() {}
 		// package declaration.
 		env.AfterChange(
 			NoDiagnostics(ForFile("main.go")),
-			DiagnosticAt("b/main.go", 0, 0),
+			Diagnostics(AtPosition("b/main.go", 0, 0)),
 		)
 		env.WriteWorkspaceFile("go.work", `go 1.16
 
@@ -1078,7 +1078,7 @@ use (
 
 		env.AfterChange(
 			NoDiagnostics(ForFile("main.go")),
-			DiagnosticAt("b/main.go", 0, 0),
+			Diagnostics(AtPosition("b/main.go", 0, 0)),
 		)
 	})
 }