/
short_skip.go
98 lines (91 loc) · 2.73 KB
/
short_skip.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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
// Copyright 2018 Istio Authors. All Rights Reserved.
//
// 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 rules
import (
"go/ast"
"go/token"
"strings"
"istio.io/istio/tests/util/checker"
)
// ShortSkip requires that a test function should have one of these pattern.
// Pattern 1
// func TestA(t *testing.T) {
// if !testing.Short() {
// ...
// }
// }
//
// Pattern 2
// func TestB(t *testing.T) {
// if testing.Short() {
// t.Skip("xxx")
// }
// ...
// }
type ShortSkip struct{}
// NewSkipByShort creates and returns a ShortSkip object.
func NewSkipByShort() *ShortSkip {
return &ShortSkip{}
}
// GetID returns skip_by_short_rule.
func (lr *ShortSkip) GetID() string {
return GetCallerFileName()
}
// Check verifies if aNode is a valid t.Skip(). If verification fails lrp creates a new report.
// There are two examples for valid t.Skip().
// case 1:
// func Testxxx(t *testing.T) {
// if !testing.Short() {
// ...
// }
// }
// case 2:
// func Testxxx(t *testing.T) {
// if testing.Short() {
// t.Skip("xxx")
// }
// ...
// }
func (lr *ShortSkip) Check(aNode ast.Node, fs *token.FileSet, lrp *checker.Report) {
if fn, isFn := aNode.(*ast.FuncDecl); isFn && strings.HasPrefix(fn.Name.Name, "Test") {
if len(fn.Body.List) == 0 {
lrp.AddItem(fs.Position(aNode.Pos()), lr.GetID(), "Missing either 'if testing.Short() { t.Skip() }' or 'if !testing.Short() {}'")
} else if len(fn.Body.List) == 1 {
if ifStmt, ok := fn.Body.List[0].(*ast.IfStmt); ok {
if uExpr, ok := ifStmt.Cond.(*ast.UnaryExpr); ok {
if call, ok := uExpr.X.(*ast.CallExpr); ok && uExpr.Op == token.NOT {
if MatchCallExpr(call, "testing", "Short") {
return
}
}
}
}
} else {
if ifStmt, ok := fn.Body.List[0].(*ast.IfStmt); ok {
if call, ok := ifStmt.Cond.(*ast.CallExpr); ok {
if MatchCallExpr(call, "testing", "Short") && len(ifStmt.Body.List) > 0 {
if exprStmt, ok := ifStmt.Body.List[0].(*ast.ExprStmt); ok {
if call, ok := exprStmt.X.(*ast.CallExpr); ok {
if MatchCallExpr(call, "t", "Skip") {
return
}
}
}
}
}
}
}
lrp.AddItem(fs.Position(aNode.Pos()), lr.GetID(), "Missing either 'if testing.Short() { t.Skip() }' or 'if !testing.Short() {}'")
}
}