-
Notifications
You must be signed in to change notification settings - Fork 153
/
log.go
84 lines (76 loc) · 2.22 KB
/
log.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
// Copyright 2019 Anapaya Systems
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package log
import (
"go/ast"
"golang.org/x/tools/go/analysis"
"golang.org/x/tools/go/analysis/passes/inspect"
"golang.org/x/tools/go/ast/inspector"
)
// Analyzer contains an analyzer that makes sure that go target is always a
// func literal that calls defer log.HandlePanic as first statement.
var Analyzer = &analysis.Analyzer{
Name: "gocall",
Doc: "go target is a func that calls" +
" defer log.HandlePanic as first statement",
Requires: []*analysis.Analyzer{inspect.Analyzer},
Run: run,
}
var goCallFilter = []ast.Node{
(*ast.GoStmt)(nil),
}
func run(pass *analysis.Pass) (interface{}, error) {
inspect := pass.ResultOf[inspect.Analyzer].(*inspector.Inspector)
inspect.Preorder(goCallFilter, func(n ast.Node) {
goStmt := n.(*ast.GoStmt)
call := goStmt.Call
switch f := call.Fun.(type) {
case *ast.FuncLit:
if !checkFuncLit(pass, f) {
pass.Reportf(f.Pos(), "First statement should be 'defer HandlePanic()")
}
default:
pass.Reportf(f.Pos(), "go statement should always call a func lit.")
}
})
return nil, nil
}
func checkFuncLit(pass *analysis.Pass, fl *ast.FuncLit) bool {
if len(fl.Body.List) == 0 {
return true
}
firstStmt := fl.Body.List[0]
deferStmt, ok := firstStmt.(*ast.DeferStmt)
if !ok {
return false
}
if pkgNameSave(pass) == "log" {
ident, ok := deferStmt.Call.Fun.(*ast.Ident)
if !ok || ident.Name != "HandlePanic" {
return false
}
} else {
callSel, ok := deferStmt.Call.Fun.(*ast.SelectorExpr)
if !ok || callSel.Sel.Name != "HandlePanic" {
return false
}
}
return true
}
func pkgNameSave(pass *analysis.Pass) string {
if pass.Pkg != nil {
return pass.Pkg.Name()
}
return ""
}