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
|
// Copyright (C) 2019-2023 Algorand, Inc.
// This file is part of go-algorand
//
// go-algorand is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as
// published by the Free Software Foundation, either version 3 of the
// License, or (at your option) any later version.
//
// go-algorand is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with go-algorand. If not, see <https://www.gnu.org/licenses/>.
package linter
import (
"go/ast"
"strings"
"golang.org/x/tools/go/analysis"
)
const packageName string = "partitiontest"
const functionName string = "PartitionTest"
const fileNameSuffix string = "_test.go"
const functionNamePrefix string = "Test"
const parameterType string = "T"
const parameterName string = "t"
// Analyzer initilization
var Analyzer = &analysis.Analyzer{
Name: "lint",
Doc: "This custom linter checks inside files that end in '_test.go', and inside functions that start with 'Test' and have testing argument, for a line 'partitiontest.ParitionTest(<testing arg>)'",
Run: run,
}
func run(pass *analysis.Pass) (interface{}, error) {
for _, f := range pass.Files {
currentFileName := pass.Fset.File(f.Pos()).Name()
if !strings.HasSuffix(currentFileName, fileNameSuffix) {
continue
}
for _, decl := range f.Decls {
fn, ok := decl.(*ast.FuncDecl)
if !ok || fn.Recv != nil {
// Ignore non-functions or functions with receivers.
continue
}
// Check that function name starts with "Test"
if !strings.HasPrefix(fn.Name.Name, functionNamePrefix) {
continue
}
if !isTestParameterInFunction(fn.Type.Params.List[0].Type, parameterType) {
continue
}
if !isSearchLineInFunction(fn) {
pass.Reportf(fn.Pos(), "%s: Add missing partition call to top of test. To disable partitioning, add it as a comment: %s.%s(%s)", fn.Name.Name, packageName, functionName, parameterName)
}
}
}
return nil, nil
}
func isTestParameterInFunction(typ ast.Expr, wantType string) bool {
ptr, ok := typ.(*ast.StarExpr)
if !ok {
// Not a pointer.
return false
}
if name, ok := ptr.X.(*ast.Ident); ok {
return name.Name == wantType
}
if sel, ok := ptr.X.(*ast.SelectorExpr); ok {
return sel.Sel.Name == wantType
}
return false
}
func isSearchLineInFunction(fn *ast.FuncDecl) bool {
for _, oneline := range fn.Body.List {
if exprStmt, ok := oneline.(*ast.ExprStmt); ok {
if call, ok := exprStmt.X.(*ast.CallExpr); ok {
if fun, ok := call.Fun.(*ast.SelectorExpr); ok {
if !doesPackageNameMatch(fun) {
continue
}
if !doesFunctionNameMatch(fun) {
continue
}
}
if !doesParameterNameMatch(call, fn) {
continue
}
return true
}
}
}
return false
}
func doesPackageNameMatch(fun *ast.SelectorExpr) bool {
if packageobject, ok := fun.X.(*ast.Ident); ok {
if packageobject.Name == packageName {
return true
}
}
return false
}
func doesFunctionNameMatch(fun *ast.SelectorExpr) bool {
return fun.Sel.Name == functionName
}
func doesParameterNameMatch(call *ast.CallExpr, fn *ast.FuncDecl) bool {
for _, oneArg := range call.Args {
if realArg, ok := oneArg.(*ast.Ident); ok {
if realArg != nil && realArg.Obj != nil && realArg.Obj.Name == fn.Type.Params.List[0].Names[0].Obj.Name {
return true
}
}
}
return false
}
|
