[gopls-release-branch.0.15] gopls: fix test failures due to quoting of names in go/types errors

findleyr · findleyr · commit 4b7ce7c70d1f · 2024-04-08T18:27:49.000Z
Starting soon, go/types will quote some user defined names in error messages as `a'. Update tests to be tolerant of the new syntax. Notably, logic in the unusedvariable analyzer which extracts the variable name had to be updated. Change-Id: I091ab2af9b5ed82aa7eacad8f4a9405f34fcded7 Reviewed-on: https://go-review.googlesource.com/c/tools/+/571517 LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com> Auto-Submit: Robert Findley <rfindley@google.com> Reviewed-by: Robert Griesemer <gri@google.com> (cherry picked from commit 67e856b) Reviewed-on: https://go-review.googlesource.com/c/tools/+/577258 Reviewed-by: Alan Donovan <adonovan@google.com>
diff --git a/gopls/internal/analysis/unusedvariable/testdata/src/assign/a.go b/gopls/internal/analysis/unusedvariable/testdata/src/assign/a.go
@@ -14,55 +14,55 @@ type A struct {
 }
 
 func singleAssignment() {
-	v := "s" // want `v declared (and|but) not used`
+	v := "s" // want `v.*declared (and|but) not used`
 
-	s := []int{ // want `s declared (and|but) not used`
+	s := []int{ // want `s.*declared (and|but) not used`
 		1,
 		2,
 	}
 
-	a := func(s string) bool { // want `a declared (and|but) not used`
+	a := func(s string) bool { // want `a.*declared (and|but) not used`
 		return false
 	}
 
 	if 1 == 1 {
-		s := "v" // want `s declared (and|but) not used`
+		s := "v" // want `s.*declared (and|but) not used`
 	}
 
 	panic("I should survive")
 }
 
 func noOtherStmtsInBlock() {
-	v := "s" // want `v declared (and|but) not used`
+	v := "s" // want `v.*declared (and|but) not used`
 }
 
 func partOfMultiAssignment() {
-	f, err := os.Open("file") // want `f declared (and|but) not used`
+	f, err := os.Open("file") // want `f.*declared (and|but) not used`
 	panic(err)
 }
 
 func sideEffects(cBool chan bool, cInt chan int) {
-	b := <-c            // want `b declared (and|but) not used`
-	s := fmt.Sprint("") // want `s declared (and|but) not used`
-	a := A{             // want `a declared (and|but) not used`
+	b := <-c            // want `b.*declared (and|but) not used`
+	s := fmt.Sprint("") // want `s.*declared (and|but) not used`
+	a := A{             // want `a.*declared (and|but) not used`
 		b: func() int {
 			return 1
 		}(),
 	}
-	c := A{<-cInt}          // want `c declared (and|but) not used`
-	d := fInt() + <-cInt    // want `d declared (and|but) not used`
-	e := fBool() && <-cBool // want `e declared (and|but) not used`
-	f := map[int]int{       // want `f declared (and|but) not used`
+	c := A{<-cInt}          // want `c.*declared (and|but) not used`
+	d := fInt() + <-cInt    // want `d.*declared (and|but) not used`
+	e := fBool() && <-cBool // want `e.*declared (and|but) not used`
+	f := map[int]int{       // want `f.*declared (and|but) not used`
 		fInt(): <-cInt,
 	}
-	g := []int{<-cInt}       // want `g declared (and|but) not used`
-	h := func(s string) {}   // want `h declared (and|but) not used`
-	i := func(s string) {}() // want `i declared (and|but) not used`
+	g := []int{<-cInt}       // want `g.*declared (and|but) not used`
+	h := func(s string) {}   // want `h.*declared (and|but) not used`
+	i := func(s string) {}() // want `i.*declared (and|but) not used`
 }
 
 func commentAbove() {
 	// v is a variable
-	v := "s" // want `v declared (and|but) not used`
+	v := "s" // want `v.*declared (and|but) not used`
 }
 
 func fBool() bool {
diff --git a/gopls/internal/analysis/unusedvariable/testdata/src/assign/a.go.golden b/gopls/internal/analysis/unusedvariable/testdata/src/assign/a.go.golden
@@ -24,26 +24,26 @@ func noOtherStmtsInBlock() {
 }
 
 func partOfMultiAssignment() {
-	_, err := os.Open("file") // want `f declared (and|but) not used`
+	_, err := os.Open("file") // want `f.*declared (and|but) not used`
 	panic(err)
 }
 
 func sideEffects(cBool chan bool, cInt chan int) {
-	<-c            // want `b declared (and|but) not used`
-	fmt.Sprint("") // want `s declared (and|but) not used`
-	A{             // want `a declared (and|but) not used`
+	<-c            // want `b.*declared (and|but) not used`
+	fmt.Sprint("") // want `s.*declared (and|but) not used`
+	A{             // want `a.*declared (and|but) not used`
 		b: func() int {
 			return 1
 		}(),
 	}
-	A{<-cInt}          // want `c declared (and|but) not used`
-	fInt() + <-cInt    // want `d declared (and|but) not used`
-	fBool() && <-cBool // want `e declared (and|but) not used`
-	map[int]int{       // want `f declared (and|but) not used`
+	A{<-cInt}          // want `c.*declared (and|but) not used`
+	fInt() + <-cInt    // want `d.*declared (and|but) not used`
+	fBool() && <-cBool // want `e.*declared (and|but) not used`
+	map[int]int{       // want `f.*declared (and|but) not used`
 		fInt(): <-cInt,
 	}
-	[]int{<-cInt}       // want `g declared (and|but) not used`
-	func(s string) {}() // want `i declared (and|but) not used`
+	[]int{<-cInt}       // want `g.*declared (and|but) not used`
+	func(s string) {}() // want `i.*declared (and|but) not used`
 }
 
 func commentAbove() {
diff --git a/gopls/internal/analysis/unusedvariable/testdata/src/decl/a.go b/gopls/internal/analysis/unusedvariable/testdata/src/decl/a.go
@@ -5,25 +5,25 @@
 package decl
 
 func a() {
-	var b, c bool // want `b declared (and|but) not used`
+	var b, c bool // want `b.*declared (and|but) not used`
 	panic(c)
 
 	if 1 == 1 {
-		var s string // want `s declared (and|but) not used`
+		var s string // want `s.*declared (and|but) not used`
 	}
 }
 
 func b() {
 	// b is a variable
-	var b bool // want `b declared (and|but) not used`
+	var b bool // want `b.*declared (and|but) not used`
 }
 
 func c() {
 	var (
 		d string
 
 		// some comment for c
-		c bool // want `c declared (and|but) not used`
+		c bool // want `c.*declared (and|but) not used`
 	)
 
 	panic(d)
diff --git a/gopls/internal/analysis/unusedvariable/testdata/src/decl/a.go.golden b/gopls/internal/analysis/unusedvariable/testdata/src/decl/a.go.golden
@@ -5,7 +5,7 @@
 package decl
 
 func a() {
-	var c bool // want `b declared (and|but) not used`
+	var c bool // want `b.*declared (and|but) not used`
 	panic(c)
 
 	if 1 == 1 {
diff --git a/gopls/internal/analysis/unusedvariable/unusedvariable.go b/gopls/internal/analysis/unusedvariable/unusedvariable.go
@@ -37,6 +37,9 @@ func run(pass *analysis.Pass) (interface{}, error) {
 		for _, suffix := range unusedVariableSuffixes {
 			if strings.HasSuffix(typeErr.Msg, suffix) {
 				varName := strings.TrimSuffix(typeErr.Msg, suffix)
+				// Beginning in Go 1.23, go/types began quoting vars as `v'.
+				varName = strings.Trim(varName, "'`'")
+
 				err := runForError(pass, typeErr, varName)
 				if err != nil {
 					return nil, err
diff --git a/gopls/internal/test/marker/testdata/completion/bad.txt b/gopls/internal/test/marker/testdata/completion/bad.txt
@@ -20,7 +20,7 @@ func stuff() { //@item(stuff, "stuff", "func()", "func")
 	x := "heeeeyyyy"
 	random2(x) //@diag("x", re"cannot use x \\(variable of type string\\) as int value in argument to random2")
 	random2(1) //@complete("dom", random, random2, random3)
-	y := 3     //@diag("y", re"y declared (and|but) not used")
+	y := 3     //@diag("y", re"y.*declared (and|but) not used")
 }
 
 type bob struct { //@item(bob, "bob", "struct{...}", "struct")
@@ -48,9 +48,9 @@ func random() int { //@item(random, "random", "func() int", "func")
 }
 
 func random2(y int) int { //@item(random2, "random2", "func(y int) int", "func"),item(bad_y_param, "y", "int", "var")
-	x := 6       //@item(x, "x", "int", "var"),diag("x", re"x declared (and|but) not used")
-	var q blah   //@item(q, "q", "blah", "var"),diag("q", re"q declared (and|but) not used"),diag("blah", re"(undeclared name|undefined): blah")
-	var t **blob //@item(t, "t", "**blob", "var"),diag("t", re"t declared (and|but) not used"),diag("blob", re"(undeclared name|undefined): blob")
+	x := 6       //@item(x, "x", "int", "var"),diag("x", re"x.*declared (and|but) not used")
+	var q blah   //@item(q, "q", "blah", "var"),diag("q", re"q.*declared (and|but) not used"),diag("blah", re"(undeclared name|undefined): blah")
+	var t **blob //@item(t, "t", "**blob", "var"),diag("t", re"t.*declared (and|but) not used"),diag("blob", re"(undeclared name|undefined): blob")
 	//@complete("", q, t, x, bad_y_param, global_a, bob, random, random2, random3, stateFunc, stuff)
 
 	return y
@@ -59,10 +59,10 @@ func random2(y int) int { //@item(random2, "random2", "func(y int) int", "func")
 func random3(y ...int) { //@item(random3, "random3", "func(y ...int)", "func"),item(y_variadic_param, "y", "[]int", "var")
 	//@complete("", y_variadic_param, global_a, bob, random, random2, random3, stateFunc, stuff)
 
-	var ch chan (favType1)   //@item(ch, "ch", "chan (favType1)", "var"),diag("ch", re"ch declared (and|but) not used"),diag("favType1", re"(undeclared name|undefined): favType1")
-	var m map[keyType]int    //@item(m, "m", "map[keyType]int", "var"),diag("m", re"m declared (and|but) not used"),diag("keyType", re"(undeclared name|undefined): keyType")
-	var arr []favType2       //@item(arr, "arr", "[]favType2", "var"),diag("arr", re"arr declared (and|but) not used"),diag("favType2", re"(undeclared name|undefined): favType2")
-	var fn1 func() badResult //@item(fn1, "fn1", "func() badResult", "var"),diag("fn1", re"fn1 declared (and|but) not used"),diag("badResult", re"(undeclared name|undefined): badResult")
-	var fn2 func(badParam)   //@item(fn2, "fn2", "func(badParam)", "var"),diag("fn2", re"fn2 declared (and|but) not used"),diag("badParam", re"(undeclared name|undefined): badParam")
+	var ch chan (favType1)   //@item(ch, "ch", "chan (favType1)", "var"),diag("ch", re"ch.*declared (and|but) not used"),diag("favType1", re"(undeclared name|undefined): favType1")
+	var m map[keyType]int    //@item(m, "m", "map[keyType]int", "var"),diag("m", re"m.*declared (and|but) not used"),diag("keyType", re"(undeclared name|undefined): keyType")
+	var arr []favType2       //@item(arr, "arr", "[]favType2", "var"),diag("arr", re"arr.*declared (and|but) not used"),diag("favType2", re"(undeclared name|undefined): favType2")
+	var fn1 func() badResult //@item(fn1, "fn1", "func() badResult", "var"),diag("fn1", re"fn1.*declared (and|but) not used"),diag("badResult", re"(undeclared name|undefined): badResult")
+	var fn2 func(badParam)   //@item(fn2, "fn2", "func(badParam)", "var"),diag("fn2", re"fn2.*declared (and|but) not used"),diag("badParam", re"(undeclared name|undefined): badParam")
 	//@complete("", arr, ch, fn1, fn2, m, y_variadic_param, global_a, bob, random, random2, random3, stateFunc, stuff)
 }
diff --git a/gopls/internal/test/marker/testdata/completion/testy.txt b/gopls/internal/test/marker/testdata/completion/testy.txt
@@ -47,7 +47,7 @@ import (
 )
 
 func TestSomething(t *testing.T) { //@item(TestSomething, "TestSomething(t *testing.T)", "", "func")
-	var x int //@loc(testyX, "x"), diag("x", re"x declared (and|but) not used")
+	var x int //@loc(testyX, "x"), diag("x", re"x.*declared (and|but) not used")
 	a()       //@loc(testyA, "a")
 }
 
diff --git a/gopls/internal/test/marker/testdata/diagnostics/generated.txt b/gopls/internal/test/marker/testdata/diagnostics/generated.txt
@@ -10,12 +10,12 @@ package generated
 // Code generated by generator.go. DO NOT EDIT.
 
 func _() {
-	var y int //@diag("y", re"y declared (and|but) not used")
+	var y int //@diag("y", re"y.*declared (and|but) not used")
 }
 
 -- generator.go --
 package generated
 
 func _() {
-	var x int //@diag("x", re"x declared (and|but) not used")
+	var x int //@diag("x", re"x.*declared (and|but) not used")
 }
diff --git a/gopls/internal/test/marker/testdata/diagnostics/issue56943.txt b/gopls/internal/test/marker/testdata/diagnostics/issue56943.txt
@@ -12,7 +12,7 @@ import (
 )
 
 func main() {
-	var a int               //@diag(re"(a) int", re"a declared.*not used")
+	var a int               //@diag(re"(a) int", re"a.*declared.*not used")
 	var _ ast.Expr = node{} //@diag("node{}", re"missing.*exprNode")
 }
 
diff --git a/gopls/internal/test/marker/testdata/format/format.txt b/gopls/internal/test/marker/testdata/format/format.txt
@@ -39,7 +39,7 @@ func hello() {
 
 
 
-	var x int //@diag("x", re"x declared (and|but) not used")
+	var x int //@diag("x", re"x.*declared (and|but) not used")
 }
 
 func hi() {
@@ -59,7 +59,7 @@ import (
 
 func hello() {
 
-	var x int //@diag("x", re"x declared (and|but) not used")
+	var x int //@diag("x", re"x.*declared (and|but) not used")
 }
 
 func hi() {

Original file line number	Diff line number	Diff line change
`@@ -5,25 +5,25 @@`
`5`	`5`	`package decl`
`6`	`6`
`7`	`7`	`func a() {`
`8`		- var b, c bool // want `b declared (and\|but) not used`
	`8`	+ var b, c bool // want `b.*declared (and\|but) not used`
`9`	`9`	`panic(c)`
`10`	`10`
`11`	`11`	`if 1 == 1 {`
`12`		- var s string // want `s declared (and\|but) not used`
	`12`	+ var s string // want `s.*declared (and\|but) not used`
`13`	`13`	`}`
`14`	`14`	`}`
`15`	`15`
`16`	`16`	`func b() {`
`17`	`17`	`// b is a variable`
`18`		- var b bool // want `b declared (and\|but) not used`
	`18`	+ var b bool // want `b.*declared (and\|but) not used`
`19`	`19`	`}`
`20`	`20`
`21`	`21`	`func c() {`
`22`	`22`	`var (`
`23`	`23`	`d string`
`24`	`24`
`25`	`25`	`// some comment for c`
`26`		- c bool // want `c declared (and\|but) not used`
	`26`	+ c bool // want `c.*declared (and\|but) not used`
`27`	`27`	`)`
`28`	`28`
`29`	`29`	`panic(d)`
Original file line number	Diff line number	Diff line change
`@@ -47,7 +47,7 @@ import (`
`47`	`47`	`)`
`48`	`48`
`49`	`49`	`func TestSomething(t testing.T) { //@item(TestSomething, "TestSomething(t testing.T)", "", "func")`
`50`		`- var x int //@loc(testyX, "x"), diag("x", re"x declared (and\|but) not used")`
	`50`	`+ var x int //@loc(testyX, "x"), diag("x", re"x.*declared (and\|but) not used")`
`51`	`51`	`a() //@loc(testyA, "a")`
`52`	`52`	`}`
`53`	`53`
Original file line number	Diff line number	Diff line change
`@@ -10,12 +10,12 @@ package generated`
`10`	`10`	`// Code generated by generator.go. DO NOT EDIT.`
`11`	`11`
`12`	`12`	`func _() {`
`13`		`- var y int //@diag("y", re"y declared (and\|but) not used")`
	`13`	`+ var y int //@diag("y", re"y.*declared (and\|but) not used")`
`14`	`14`	`}`
`15`	`15`
`16`	`16`	`-- generator.go --`
`17`	`17`	`package generated`
`18`	`18`
`19`	`19`	`func _() {`
`20`		`- var x int //@diag("x", re"x declared (and\|but) not used")`
	`20`	`+ var x int //@diag("x", re"x.*declared (and\|but) not used")`
`21`	`21`	`}`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ import (`
`12`	`12`	`)`
`13`	`13`
`14`	`14`	`func main() {`
`15`		`- var a int //@diag(re"(a) int", re"a declared.*not used")`
	`15`	`+ var a int //@diag(re"(a) int", re"a.declared.not used")`
`16`	`16`	`var _ ast.Expr = node{} //@diag("node{}", re"missing.*exprNode")`
`17`	`17`	`}`
`18`	`18`
Original file line number	Diff line number	Diff line change
`@@ -39,7 +39,7 @@ func hello() {`
`39`	`39`
`40`	`40`
`41`	`41`
`42`		`- var x int //@diag("x", re"x declared (and\|but) not used")`
	`42`	`+ var x int //@diag("x", re"x.*declared (and\|but) not used")`
`43`	`43`	`}`
`44`	`44`
`45`	`45`	`func hi() {`
`@@ -59,7 +59,7 @@ import (`
`59`	`59`
`60`	`60`	`func hello() {`
`61`	`61`
`62`		`- var x int //@diag("x", re"x declared (and\|but) not used")`
	`62`	`+ var x int //@diag("x", re"x.*declared (and\|but) not used")`
`63`	`63`	`}`
`64`	`64`
`65`	`65`	`func hi() {`