Skip to content

Commit 4e4135c

Browse files
committedMar 17, 2021
Add check for InfoS & ErrorS parameters
1 parent 0f69eb5 commit 4e4135c

File tree

4 files changed

+79
-4
lines changed

4 files changed

+79
-4
lines changed
 

‎hack/tools/go.mod

+4-1
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,7 @@ module k8s.io/klog/hack/tools
22

33
go 1.15
44

5-
require golang.org/x/tools v0.1.0
5+
require (
6+
golang.org/x/exp v0.0.0-20210220032938-85be41e4509f
7+
golang.org/x/tools v0.1.0
8+
)

‎hack/tools/go.sum

+21-1
Original file line numberDiff line numberDiff line change
@@ -1,23 +1,43 @@
1+
dmitri.shuralyov.com/gpu/mtl v0.0.0-20201218220906-28db891af037/go.mod h1:H6x//7gZCb22OMCxBHrMx7a5I7Hp++hsVxbQ4BYO7hU=
2+
github.com/BurntSushi/xgb v0.0.0-20160522181843-27f122750802/go.mod h1:IVnqGOEym/WlBOVXweHU+Q+/VP0lqqI8lqeDx9IjBqo=
3+
github.com/go-gl/glfw/v3.3/glfw v0.0.0-20200222043503-6f7a984d4dc4/go.mod h1:tQ2UAYgL5IevRw8kRxooKSPJfGvJ9fJQFa0TUsXzTg8=
14
github.com/yuin/goldmark v1.2.1/go.mod h1:3hX8gzYuyVAZsxl0MRgGTJEmQBFcNTphYh9decYSb74=
25
golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w=
6+
golang.org/x/crypto v0.0.0-20190510104115-cbcb75029529/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=
37
golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI=
48
golang.org/x/crypto v0.0.0-20200622213623-75b288015ac9/go.mod h1:LzIPMQfyMNhhGPhUkYOs5KpL4U8rLKemX1yGLhDgUto=
5-
golang.org/x/mod v0.3.0 h1:RM4zey1++hCTbCVQfnWeKs9/IEsaBLA8vTkd0WVtmH4=
9+
golang.org/x/exp v0.0.0-20190731235908-ec7cb31e5a56/go.mod h1:JhuoJpWY28nO4Vef9tZUw9qufEGTyX1+7lmHxV5q5G4=
10+
golang.org/x/exp v0.0.0-20210220032938-85be41e4509f h1:GrkO5AtFUU9U/1f5ctbIBXtBGeSJbWwIYfIsTcFMaX4=
11+
golang.org/x/exp v0.0.0-20210220032938-85be41e4509f/go.mod h1:I6l2HNBLBZEcrOoCpyKLdY2lHoRZ8lI4x60KMCQDft4=
12+
golang.org/x/image v0.0.0-20190227222117-0694c2d4d067/go.mod h1:kZ7UVZpmo3dzQBMxlp+ypCbDeSB+sBbTgSJuh5dn5js=
13+
golang.org/x/image v0.0.0-20190802002840-cff245a6509b/go.mod h1:FeLwcggjj3mMvU+oOTbSwawSJRM1uh48EjtB4UJZlP0=
14+
golang.org/x/mobile v0.0.0-20190312151609-d3739f865fa6/go.mod h1:z+o9i4GpDbdi3rU15maQ/Ox0txvL9dWGYEHz965HBQE=
15+
golang.org/x/mobile v0.0.0-20201217150744-e6ae53a27f4f/go.mod h1:skQtrUTUwhdJvXM/2KKJzY8pDgNr9I/FOMqDVRPBUS4=
16+
golang.org/x/mod v0.1.0/go.mod h1:0QHyrYULN0/3qlju5TqG8bIK38QM8yzMo5ekMj3DlcY=
17+
golang.org/x/mod v0.1.1-0.20191105210325-c90efee705ee/go.mod h1:QqPTAvyqsEbceGzBzNggFXnrqF1CaUcvgkdR5Ot7KZg=
18+
golang.org/x/mod v0.1.1-0.20191209134235-331c550502dd/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
619
golang.org/x/mod v0.3.0/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
20+
golang.org/x/mod v0.3.1-0.20200828183125-ce943fd02449 h1:xUIPaMhvROX9dhPvRCenIJtU78+lbEenGbgqB5hfHCQ=
21+
golang.org/x/mod v0.3.1-0.20200828183125-ce943fd02449/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA=
22+
golang.org/x/net v0.0.0-20190311183353-d8887717615a/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
723
golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg=
824
golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s=
925
golang.org/x/net v0.0.0-20201021035429-f5854403a974/go.mod h1:sp8m0HH+o8qH0wwXwYZr8TS3Oi6o0r6Gce1SSxlDquU=
1026
golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
1127
golang.org/x/sync v0.0.0-20201020160332-67f06af15bc9/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
1228
golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY=
1329
golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
30+
golang.org/x/sys v0.0.0-20191001151750-bb3f8db39f24/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
1431
golang.org/x/sys v0.0.0-20200930185726-fdedc70b468f/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
1532
golang.org/x/sys v0.0.0-20210119212857-b64e53b001e4 h1:myAQVi0cGEoqQVR5POX+8RR2mrocKqNN1hmeMqhX27k=
1633
golang.org/x/sys v0.0.0-20210119212857-b64e53b001e4/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs=
1734
golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ=
1835
golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ=
1936
golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
37+
golang.org/x/tools v0.0.0-20190312151545-0bb0c0a6e846/go.mod h1:LCzVGOaR6xXOjkQ3onu1FJEFr0SW1gC7cKk1uF8kGRs=
2038
golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo=
39+
golang.org/x/tools v0.0.0-20200117012304-6edc0a871e69/go.mod h1:TB2adYChydJhpapKDTa4BR/hXlZSLoq2Wpct/0txZ28=
40+
golang.org/x/tools v0.0.0-20200207183749-b753a1ba74fa/go.mod h1:TB2adYChydJhpapKDTa4BR/hXlZSLoq2Wpct/0txZ28=
2141
golang.org/x/tools v0.1.0 h1:po9/4sTYwZU9lPhi1tOrb4hCv3qrhiQ77LZfGa2OjwY=
2242
golang.org/x/tools v0.1.0/go.mod h1:xkSsbof2nBLbhDlRMhhhyNLN/zl3eTqcnHD5viDpcZ0=
2343
golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=

‎hack/tools/logcheck/main.go

+48-2
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,9 @@ package main
1919
import (
2020
"fmt"
2121
"go/ast"
22+
"go/token"
2223

24+
"golang.org/x/exp/utf8string"
2325
"golang.org/x/tools/go/analysis"
2426
"golang.org/x/tools/go/analysis/singlechecker"
2527
)
@@ -48,7 +50,7 @@ func run(pass *analysis.Pass) (interface{}, error) {
4850
// passing all function calls to checkForFunctionExpr
4951
if fexpr, ok := n.(*ast.CallExpr); ok {
5052

51-
checkForFunctionExpr(fexpr.Fun, pass)
53+
checkForFunctionExpr(fexpr.Fun, fexpr.Args, pass)
5254
}
5355

5456
return true
@@ -58,7 +60,7 @@ func run(pass *analysis.Pass) (interface{}, error) {
5860
}
5961

6062
// checkForFunctionExpr checks for unstructured logging function, prints error if found any.
61-
func checkForFunctionExpr(fun ast.Expr, pass *analysis.Pass) {
63+
func checkForFunctionExpr(fun ast.Expr, args []ast.Expr, pass *analysis.Pass) {
6264

6365
/* we are extracting external package function calls e.g. klog.Infof fmt.Printf
6466
and eliminating calls like setLocalHost()
@@ -80,6 +82,13 @@ func checkForFunctionExpr(fun ast.Expr, pass *analysis.Pass) {
8082
// extracting package name
8183
pName, ok := selExpr.X.(*ast.Ident)
8284

85+
if ok && pName.Name == "klog" && !isUnstructured((fName)) {
86+
if fName == "InfoS" {
87+
isKeysValid(args[1:], fun, pass, fName)
88+
} else if fName == "ErrorS" {
89+
isKeysValid(args[2:], fun, pass, fName)
90+
}
91+
}
8392
// Matching if package name is klog and any unstructured logging function is used.
8493
if ok && pName.Name == "klog" && isUnstructured((fName)) {
8594

@@ -110,3 +119,40 @@ func isUnstructured(fName string) bool {
110119

111120
return false
112121
}
122+
123+
// isKeysValid check if all keys in keyAndValues is string type
124+
func isKeysValid(keyValues []ast.Expr, fun ast.Expr, pass *analysis.Pass, funName string) {
125+
if len(keyValues)%2 != 0 {
126+
pass.Report(analysis.Diagnostic{
127+
Pos: fun.Pos(),
128+
Message: fmt.Sprintf("Invalid Number of arguments for %s", funName),
129+
})
130+
}
131+
132+
for index, arg := range keyValues {
133+
if index%2 != 0 {
134+
continue
135+
}
136+
if lit, ok := arg.(*ast.BasicLit); ok {
137+
if lit.Kind != token.STRING {
138+
pass.Report(analysis.Diagnostic{
139+
Pos: fun.Pos(),
140+
Message: fmt.Sprintf("Invalid value type for key %v", lit.Value),
141+
})
142+
continue
143+
}
144+
isASCII := utf8string.NewString(lit.Value).IsASCII()
145+
if !isASCII {
146+
pass.Report(analysis.Diagnostic{
147+
Pos: fun.Pos(),
148+
Message: fmt.Sprintf("Invalid value for key %v, it's must be ascii", lit.Value),
149+
})
150+
}
151+
} else {
152+
pass.Report(analysis.Diagnostic{
153+
Pos: fun.Pos(),
154+
Message: "Invalid value type for key",
155+
})
156+
}
157+
}
158+
}

‎hack/tools/logcheck/testdata/data.go

+6
Original file line numberDiff line numberDiff line change
@@ -44,4 +44,10 @@ func printUnstructuredLog() {
4444
func printStructuredLog() {
4545
klog.InfoS("test log")
4646
klog.ErrorS(nil, "test log")
47+
klog.InfoS("Starting container in a pod", "containerID", "containerID", "pod") // want `Invalid Number of arguments for InfoS`
48+
klog.ErrorS(nil, "Starting container in a pod", "containerID", "containerID", "pod") // want `Invalid Number of arguments for ErrorS`
49+
klog.InfoS("Starting container in a pod", "测试", "containerID") // want `Invalid value for key`
50+
klog.ErrorS(nil, "Starting container in a pod", "测试", "containerID") // want `Invalid value for key`
51+
klog.InfoS("Starting container in a pod", 7, "containerID") // want `Invalid value type for key 7`
52+
klog.ErrorS(nil, "Starting container in a pod", 7, "containerID") // want `Invalid value type for key 7`
4753
}

0 commit comments

Comments
 (0)
Please sign in to comment.