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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
|
package main
import (
"go/ast"
"go/token"
"go/types"
"reflect"
"golang.org/x/tools/go/analysis"
)
type indirectCalls struct {
methods map[token.Pos]string
functions map[string]token.Pos
}
var PanicAnalyzer = &analysis.Analyzer{
Name: "panic",
Doc: "finds goroutines that do not initialize the panic handler",
Run: runPanic,
ResultType: reflect.TypeOf(&indirectCalls{}),
}
var PanicIndirectAnalyzer = &analysis.Analyzer{
Name: "panicindirect",
Doc: "finds functions called as goroutines that do not initialize the panic handler",
Run: runPanicIndirect,
Requires: []*analysis.Analyzer{PanicAnalyzer},
}
func runPanic(pass *analysis.Pass) (interface{}, error) {
var calls indirectCalls
calls.methods = make(map[token.Pos]string)
calls.functions = make(map[string]token.Pos)
for _, file := range pass.Files {
ast.Inspect(file, func(n ast.Node) bool {
g, ok := n.(*ast.GoStmt)
if !ok {
return true
}
var block *ast.BlockStmt
expr := g.Call.Fun
if e, ok := expr.(*ast.ParenExpr); ok {
expr = e.X
}
switch e := expr.(type) {
case *ast.FuncLit:
block = e.Body
case *ast.SelectorExpr:
sel, ok := pass.TypesInfo.Selections[e]
if ok {
f, ok := sel.Obj().(*types.Func)
if ok {
calls.methods[f.Pos()] = f.Name()
}
}
case *ast.Ident:
block = inlineFuncBody(e)
if block == nil {
calls.functions[e.Name] = e.NamePos
}
}
if block == nil {
return true
}
if !isPanicHandlerInstall(block.List[0]) {
pass.Report(panicDiag(block.Pos()))
}
return true
})
}
return &calls, nil
}
func runPanicIndirect(pass *analysis.Pass) (interface{}, error) {
calls := pass.ResultOf[PanicAnalyzer].(*indirectCalls)
for _, file := range pass.Files {
for _, decl := range file.Decls {
if f, ok := decl.(*ast.FuncDecl); ok {
if _, ok := calls.methods[f.Name.Pos()]; ok {
delete(calls.methods, f.Name.Pos())
} else if _, ok := calls.functions[f.Name.Name]; ok {
delete(calls.functions, f.Name.Name)
} else {
continue
}
if !isPanicHandlerInstall(f.Body.List[0]) {
pass.Report(panicDiag(f.Body.Pos()))
}
}
}
}
return nil, nil
}
func panicDiag(pos token.Pos) analysis.Diagnostic {
return analysis.Diagnostic{
Pos: pos,
Category: "panic",
Message: "missing defer log.PanicHandler() as first statement",
}
}
func inlineFuncBody(s *ast.Ident) *ast.BlockStmt {
if s.Obj == nil || s.Obj.Decl == nil {
return nil
}
d, ok := s.Obj.Decl.(*ast.AssignStmt)
if !ok {
return nil
}
for _, r := range d.Rhs {
if f, ok := r.(*ast.FuncLit); ok {
return f.Body
}
}
return nil
}
func isPanicHandlerInstall(stmt ast.Stmt) bool {
d, ok := stmt.(*ast.DeferStmt)
if !ok {
return false
}
s, ok := d.Call.Fun.(*ast.SelectorExpr)
if !ok {
return false
}
i, ok := s.X.(*ast.Ident)
if !ok {
return false
}
return i.Name == "log" && s.Sel.Name == "PanicHandler"
}
// golang-lint required plugin api
type analyzerPlugin struct{}
// This must be implemented
func (*analyzerPlugin) GetAnalyzers() []*analysis.Analyzer {
return []*analysis.Analyzer{
PanicAnalyzer,
PanicIndirectAnalyzer,
}
}
// This must be defined and named 'AnalyzerPlugin'
var AnalyzerPlugin analyzerPlugin
|
