/
sort_results.go
259 lines (212 loc) · 5.25 KB
/
sort_results.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
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
package processors
import (
"errors"
"fmt"
"slices"
"sort"
"strings"
"github.com/golangci/golangci-lint/pkg/config"
"github.com/golangci/golangci-lint/pkg/result"
)
// Base propose of this functionality to sort results (issues)
// produced by various linters by analyzing code. We're achieving this
// by sorting results.Issues using processor step, and chain based
// rules that can compare different properties of the Issues struct.
const (
orderNameFile = "file"
orderNameLinter = "linter"
orderNameSeverity = "severity"
)
var _ Processor = (*SortResults)(nil)
type SortResults struct {
cmps map[string]*comparator
cfg *config.Output
}
func NewSortResults(cfg *config.Config) *SortResults {
return &SortResults{
cmps: map[string]*comparator{
// For sorting we are comparing (in next order):
// file names, line numbers, position, and finally - giving up.
orderNameFile: byFileName().SetNext(byLine().SetNext(byColumn())),
// For sorting we are comparing: linter name
orderNameLinter: byLinter(),
// For sorting we are comparing: severity
orderNameSeverity: bySeverity(),
},
cfg: &cfg.Output,
}
}
func (SortResults) Name() string { return "sort_results" }
// Process is performing sorting of the result issues.
func (p SortResults) Process(issues []result.Issue) ([]result.Issue, error) {
if !p.cfg.SortResults {
return issues, nil
}
if len(p.cfg.SortOrder) == 0 {
p.cfg.SortOrder = []string{orderNameFile}
}
var cmps []*comparator
for _, name := range p.cfg.SortOrder {
c, ok := p.cmps[name]
if !ok {
return nil, fmt.Errorf("unsupported sort-order name %q", name)
}
cmps = append(cmps, c)
}
cmp, err := mergeComparators(cmps)
if err != nil {
return nil, err
}
sort.Slice(issues, func(i, j int) bool {
return cmp.Compare(&issues[i], &issues[j]) == less
})
return issues, nil
}
func (SortResults) Finish() {}
type compareResult int
const (
less compareResult = iota - 1
equal
greater
none
)
func (c compareResult) isNeutral() bool {
// return true if compare result is incomparable or equal.
return c == none || c == equal
}
func (c compareResult) String() string {
switch c {
case less:
return "less"
case equal:
return "equal"
case greater:
return "greater"
default:
return "none"
}
}
// comparator describes how to implement compare for two "issues".
type comparator struct {
name string
compare func(a, b *result.Issue) compareResult
next *comparator
}
func (cmp *comparator) Next() *comparator { return cmp.next }
func (cmp *comparator) SetNext(c *comparator) *comparator {
cmp.next = c
return cmp
}
func (cmp *comparator) String() string {
s := cmp.name
if cmp.Next() != nil {
s += " > " + cmp.Next().String()
}
return s
}
func (cmp *comparator) Compare(a, b *result.Issue) compareResult {
res := cmp.compare(a, b)
if !res.isNeutral() {
return res
}
if next := cmp.Next(); next != nil {
return next.Compare(a, b)
}
return res
}
func byFileName() *comparator {
return &comparator{
name: "byFileName",
compare: func(a, b *result.Issue) compareResult {
return compareResult(strings.Compare(a.FilePath(), b.FilePath()))
},
}
}
func byLine() *comparator {
return &comparator{
name: "byLine",
compare: func(a, b *result.Issue) compareResult {
return numericCompare(a.Line(), b.Line())
},
}
}
func byColumn() *comparator {
return &comparator{
name: "byColumn",
compare: func(a, b *result.Issue) compareResult {
return numericCompare(a.Column(), b.Column())
},
}
}
func byLinter() *comparator {
return &comparator{
name: "byLinter",
compare: func(a, b *result.Issue) compareResult {
return compareResult(strings.Compare(a.FromLinter, b.FromLinter))
},
}
}
func bySeverity() *comparator {
return &comparator{
name: "bySeverity",
compare: func(a, b *result.Issue) compareResult {
return severityCompare(a.Severity, b.Severity)
},
}
}
func mergeComparators(cmps []*comparator) (*comparator, error) {
if len(cmps) == 0 {
return nil, errors.New("no comparator")
}
for i := 0; i < len(cmps)-1; i++ {
findComparatorTip(cmps[i]).SetNext(cmps[i+1])
}
return cmps[0], nil
}
func findComparatorTip(cmp *comparator) *comparator {
if cmp.Next() != nil {
return findComparatorTip(cmp.Next())
}
return cmp
}
func severityCompare(a, b string) compareResult {
// The position inside the slice define the importance (lower to higher).
classic := []string{"low", "medium", "high", "warning", "error"}
if slices.Contains(classic, a) && slices.Contains(classic, b) {
switch {
case slices.Index(classic, a) > slices.Index(classic, b):
return greater
case slices.Index(classic, a) < slices.Index(classic, b):
return less
default:
return equal
}
}
if slices.Contains(classic, a) {
return greater
}
if slices.Contains(classic, b) {
return less
}
return compareResult(strings.Compare(a, b))
}
func numericCompare(a, b int) compareResult {
var (
isValuesInvalid = a < 0 || b < 0
isZeroValuesBoth = a == 0 && b == 0
isEqual = a == b
isZeroValueInA = b > 0 && a == 0
isZeroValueInB = a > 0 && b == 0
)
switch {
case isZeroValuesBoth || isEqual:
return equal
case isValuesInvalid || isZeroValueInA || isZeroValueInB:
return none
case a > b:
return greater
case a < b:
return less
}
return equal
}