Skip to content

Commit faa496b

Browse files
armsnyderarmsnyder
committed
test: vet that all Cmders have a SetVal() method
1 parent 084c0c8 commit faa496b

File tree

8 files changed

+153
-0
lines changed

8 files changed

+153
-0
lines changed

‎Makefile

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ test: testdeps
66
go test ./... -run=NONE -bench=. -benchmem
77
env GOOS=linux GOARCH=386 go test ./...
88
go vet
9+
cd internal/customvet && go build .
10+
go vet -vettool ./internal/customvet/customvet
911

1012
testdeps: testdata/redis/src/redis-server
1113

‎internal/customvet/.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
/customvet

‎internal/customvet/checks/setval/setval.go

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
package setval
2+
3+
import (
4+
"go/ast"
5+
"go/token"
6+
"go/types"
7+
"golang.org/x/tools/go/analysis"
8+
)
9+
10+
var Analyzer = &analysis.Analyzer{
11+
Name: "setval",
12+
Doc: "find Cmder types that are missing a SetVal method",
13+
14+
Run: func(pass *analysis.Pass) (interface{}, error) {
15+
cmderTypes := make(map[string]token.Pos)
16+
typesWithSetValMethod := make(map[string]bool)
17+
18+
for _, file := range pass.Files {
19+
for _, decl := range file.Decls {
20+
funcName, receiverType := parseFuncDecl(decl, pass.TypesInfo)
21+
22+
switch funcName {
23+
case "Result":
24+
cmderTypes[receiverType] = decl.Pos()
25+
case "SetVal":
26+
typesWithSetValMethod[receiverType] = true
27+
}
28+
}
29+
}
30+
31+
for cmder, pos := range cmderTypes {
32+
if !typesWithSetValMethod[cmder] {
33+
pass.Reportf(pos, "%s is missing a SetVal method", cmder)
34+
}
35+
}
36+
37+
return nil, nil
38+
},
39+
}
40+
41+
func parseFuncDecl(decl ast.Decl, typesInfo *types.Info) (funcName, receiverType string) {
42+
funcDecl, ok := decl.(*ast.FuncDecl)
43+
if !ok {
44+
return "", "" // Not a function declaration.
45+
}
46+
47+
if funcDecl.Recv == nil {
48+
return "", "" // Not a method.
49+
}
50+
51+
if len(funcDecl.Recv.List) != 1 {
52+
return "", "" // Unexpected number of receiver arguments. (Can this happen?)
53+
}
54+
55+
receiverTypeObj := typesInfo.TypeOf(funcDecl.Recv.List[0].Type)
56+
if receiverTypeObj == nil {
57+
return "", "" // Unable to determine the receiver type.
58+
}
59+
60+
return funcDecl.Name.Name, receiverTypeObj.String()
61+
}

‎internal/customvet/checks/setval/setval_test.go

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
package setval_test
2+
3+
import (
4+
"github.com/go-redis/redis/internal/customvet/checks/setval"
5+
"golang.org/x/tools/go/analysis/analysistest"
6+
"testing"
7+
)
8+
9+
func Test(t *testing.T) {
10+
testdata := analysistest.TestData()
11+
analysistest.Run(t, testdata, setval.Analyzer, "a")
12+
}

‎internal/customvet/checks/setval/testdata/src/a/a.go

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
package a
2+
3+
type GoodCmd struct {
4+
val int
5+
}
6+
7+
func (c *GoodCmd) SetVal(val int) {
8+
c.val = val
9+
}
10+
11+
func (c *GoodCmd) Result() (int, error) {
12+
return c.val, nil
13+
}
14+
15+
type BadCmd struct {
16+
val int
17+
}
18+
19+
func (c *BadCmd) Result() (int, error) { // want "\\*a.BadCmd is missing a SetVal method"
20+
return c.val, nil
21+
}
22+
23+
type NotACmd struct {
24+
val int
25+
}
26+
27+
func (c *NotACmd) Val() int {
28+
return c.val
29+
}

‎internal/customvet/go.mod

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
module github.com/go-redis/redis/internal/customvet
2+
3+
go 1.17
4+
5+
require golang.org/x/tools v0.1.12
6+
7+
require (
8+
golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4 // indirect
9+
golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f // indirect
10+
)

‎internal/customvet/go.sum

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
github.com/yuin/goldmark v1.4.13/go.mod h1:6yULJ656Px+3vBD8DxQVa3kxgyrAnzto9xy5taEt/CY=
2+
golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
3+
golang.org/x/crypto v0.0.0-20210921155107-089bfa567519/go.mod h1:GvvjBRRGRdwPK5ydBHafDWAxML/pGHZbMvKqRZ5+Abc=
4+
golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4 h1:6zppjxzCulZykYSLyVDYbneBfbaBIQPYMevg0bEwv2s=
5+
golang.org/x/mod v0.6.0-dev.0.20220419223038-86c51ed26bb4/go.mod h1:jJ57K6gSWd91VN4djpZkiMVwK6gcyfeH4XE8wZrZaV4=
6+
golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
7+
golang.org/x/net v0.0.0-20210226172049-e18ecbb05110/go.mod h1:m0MpNAwzfU5UDzcl9v0D8zg8gWTRqZa9RBIspLL5mdg=
8+
golang.org/x/net v0.0.0-20220722155237-a158d28d115b/go.mod h1:XRhObCWvk6IyKnWLug+ECip1KBveYUHfp+8e9klMJ9c=
9+
golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
10+
golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
11+
golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
12+
golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
13+
golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
14+
golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
15+
golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f h1:v4INt8xihDGvnrfjMDVXGxw9wrfxYyCjk0KbXjhR55s=
16+
golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
17+
golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo=
18+
golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8=
19+
golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
20+
golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
21+
golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ=
22+
golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
23+
golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
24+
golang.org/x/tools v0.1.12 h1:VveCTK38A2rkS8ZqFY25HIDFscX5X9OoEhJd3quQmXU=
25+
golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc=
26+
golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=

‎internal/customvet/main.go

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
package main
2+
3+
import (
4+
"github.com/go-redis/redis/internal/customvet/checks/setval"
5+
"golang.org/x/tools/go/analysis/multichecker"
6+
)
7+
8+
func main() {
9+
multichecker.Main(
10+
setval.Analyzer,
11+
)
12+
}

0 commit comments

Comments
 (0)