-
Notifications
You must be signed in to change notification settings - Fork 1
/
config.go
176 lines (141 loc) · 4.15 KB
/
config.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
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
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
package spancheck
import (
"flag"
"fmt"
"log"
"regexp"
"strings"
)
// Check is a type of check that can be enabled or disabled.
type Check int
const (
// EndCheck if enabled, checks that span.End() is called after span creation and before the function returns.
EndCheck Check = iota
// SetStatusCheck if enabled, checks that `span.SetStatus(codes.Error, msg)` is called when returning an error.
SetStatusCheck
// RecordErrorCheck if enabled, checks that span.RecordError(err) is called when returning an error.
RecordErrorCheck
)
func (c Check) String() string {
switch c {
case EndCheck:
return "end"
case SetStatusCheck:
return "set-status"
case RecordErrorCheck:
return "record-error"
default:
return ""
}
}
var (
// Checks is a list of all checks by name.
Checks = map[string]Check{
EndCheck.String(): EndCheck,
SetStatusCheck.String(): SetStatusCheck,
RecordErrorCheck.String(): RecordErrorCheck,
}
)
// Config is a configuration for the spancheck analyzer.
type Config struct {
fs flag.FlagSet
// EnabledChecks is a list of checks to enable by name.
EnabledChecks []string
// IgnoreChecksSignaturesSlice is a slice of strings that are turned into
// the IgnoreSetStatusCheckSignatures regex.
IgnoreChecksSignaturesSlice []string
endCheckEnabled bool
setStatusEnabled bool
recordErrorEnabled bool
// ignoreChecksSignatures is a regex that, if matched, disables the
// SetStatus and RecordError checks on error.
ignoreChecksSignatures *regexp.Regexp
}
// NewConfigFromFlags returns a new Config with default values and flags for CLI usage.
func NewConfigFromFlags() *Config {
cfg := NewDefaultConfig()
cfg.fs = flag.FlagSet{}
// Set the list of checks to enable.
checkOptions := []string{}
for check := range Checks {
checkOptions = append(checkOptions, check)
}
checkStrings := cfg.fs.String("checks", "end", fmt.Sprintf("comma-separated list of checks to enable (options: %v)", strings.Join(checkOptions, ", ")))
cfg.EnabledChecks = strings.Split(*checkStrings, ",")
// Set the list of function signatures to ignore checks for.
ignoreCheckSignatures := flag.String("ignore-check-signatures", "", "comma-separated list of regex for function signatures that disable checks on errors")
cfg.ignoreChecksSignatures = parseSignatures(*ignoreCheckSignatures)
return cfg
}
// NewDefaultConfig returns a new Config with default values.
func NewDefaultConfig() *Config {
return &Config{
EnabledChecks: []string{EndCheck.String()},
}
}
// finalize parses checks and signatures from the public string slices of Config.
func (c *Config) finalize() {
c.parseSignatures()
checks := parseChecks(c.EnabledChecks)
c.endCheckEnabled = contains(checks, EndCheck)
c.setStatusEnabled = contains(checks, SetStatusCheck)
c.recordErrorEnabled = contains(checks, RecordErrorCheck)
}
// parseSignatures sets the Ignore*CheckSignatures regex from the string slices.
func (c *Config) parseSignatures() {
if c.ignoreChecksSignatures == nil && len(c.IgnoreChecksSignaturesSlice) > 0 {
c.ignoreChecksSignatures = createRegex(c.IgnoreChecksSignaturesSlice)
}
}
func parseChecks(checksSlice []string) []Check {
if len(checksSlice) == 0 {
return nil
}
checks := []Check{}
for _, check := range checksSlice {
checkName := strings.TrimSpace(check)
if checkName == "" {
continue
}
check, ok := Checks[checkName]
if !ok {
continue
}
checks = append(checks, check)
}
return checks
}
func parseSignatures(sigFlag string) *regexp.Regexp {
if sigFlag == "" {
return nil
}
sigs := []string{}
for _, sig := range strings.Split(sigFlag, ",") {
sig = strings.TrimSpace(sig)
if sig == "" {
continue
}
sigs = append(sigs, sig)
}
return createRegex(sigs)
}
func createRegex(sigs []string) *regexp.Regexp {
if len(sigs) == 0 {
return nil
}
regex := fmt.Sprintf("(%s)", strings.Join(sigs, "|"))
regexCompiled, err := regexp.Compile(regex)
if err != nil {
log.Default().Print("[WARN] failed to compile regex from signature flag", "regex", regex, "err", err)
return nil
}
return regexCompiled
}
func contains(s []Check, e Check) bool {
for _, a := range s {
if a == e {
return true
}
}
return false
}