forked from wagoodman/dive
/
evaluator.go
186 lines (158 loc) · 4.19 KB
/
evaluator.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
package ci
import (
"fmt"
"sort"
"strconv"
"strings"
"github.com/dustin/go-humanize"
"github.com/logrusorgru/aurora"
"github.com/spf13/viper"
"github.com/spencerdodd/dive/dive/image"
"github.com/spencerdodd/dive/utils"
)
type CiEvaluator struct {
Rules []CiRule
Results map[string]RuleResult
Tally ResultTally
Pass bool
Misconfigured bool
InefficientFiles []ReferenceFile
}
type ResultTally struct {
Pass int
Fail int
Skip int
Warn int
Total int
}
func NewCiEvaluator(config *viper.Viper) *CiEvaluator {
return &CiEvaluator{
Rules: loadCiRules(config),
Results: make(map[string]RuleResult),
Pass: true,
}
}
func (ci *CiEvaluator) isRuleEnabled(rule CiRule) bool {
return rule.Configuration() != "disabled"
}
func (ci *CiEvaluator) Evaluate(analysis *image.AnalysisResult) bool {
canEvaluate := true
for _, rule := range ci.Rules {
if !ci.isRuleEnabled(rule) {
ci.Results[rule.Key()] = RuleResult{
status: RuleConfigured,
message: "rule disabled",
}
continue
}
err := rule.Validate()
if err != nil {
ci.Results[rule.Key()] = RuleResult{
status: RuleMisconfigured,
message: err.Error(),
}
canEvaluate = false
} else {
ci.Results[rule.Key()] = RuleResult{
status: RuleConfigured,
message: "test",
}
}
}
if !canEvaluate {
ci.Pass = false
ci.Misconfigured = true
return ci.Pass
}
// capture inefficient files
for idx := 0; idx < len(analysis.Inefficiencies); idx++ {
fileData := analysis.Inefficiencies[len(analysis.Inefficiencies)-1-idx]
ci.InefficientFiles = append(ci.InefficientFiles, ReferenceFile{
References: len(fileData.Nodes),
SizeBytes: uint64(fileData.CumulativeSize),
Path: fileData.Path,
})
}
// evaluate results against the configured CI rules
for _, rule := range ci.Rules {
if !ci.isRuleEnabled(rule) {
ci.Results[rule.Key()] = RuleResult{
status: RuleDisabled,
message: "rule disabled",
}
continue
}
status, message := rule.Evaluate(analysis)
if value, exists := ci.Results[rule.Key()]; exists && value.status != RuleConfigured && value.status != RuleMisconfigured {
panic(fmt.Errorf("CI rule result recorded twice: %s", rule.Key()))
}
if status == RuleFailed {
ci.Pass = false
}
ci.Results[rule.Key()] = RuleResult{
status: status,
message: message,
}
}
ci.Tally.Total = len(ci.Results)
for rule, result := range ci.Results {
switch result.status {
case RulePassed:
ci.Tally.Pass++
case RuleFailed:
ci.Tally.Fail++
case RuleWarning:
ci.Tally.Warn++
case RuleDisabled:
ci.Tally.Skip++
default:
panic(fmt.Errorf("unknown test status (rule='%v'): %v", rule, result.status))
}
}
return ci.Pass
}
func (ci *CiEvaluator) Report() string {
var sb strings.Builder
fmt.Fprintln(&sb, utils.TitleFormat("Inefficient Files:"))
template := "%5s %12s %-s\n"
fmt.Fprintf(&sb, template, "Count", "Wasted Space", "File Path")
if len(ci.InefficientFiles) == 0 {
fmt.Fprintln(&sb, "None")
} else {
for _, file := range ci.InefficientFiles {
fmt.Fprintf(&sb, template, strconv.Itoa(file.References), humanize.Bytes(file.SizeBytes), file.Path)
}
}
fmt.Fprintln(&sb, utils.TitleFormat("Results:"))
status := "PASS"
rules := make([]string, 0, len(ci.Results))
for name := range ci.Results {
rules = append(rules, name)
}
sort.Strings(rules)
if ci.Tally.Fail > 0 {
status = "FAIL"
}
for _, rule := range rules {
result := ci.Results[rule]
name := strings.TrimPrefix(rule, "rules.")
if result.message != "" {
fmt.Fprintf(&sb, " %s: %s: %s\n", result.status.String(), name, result.message)
} else {
fmt.Fprintf(&sb, " %s: %s\n", result.status.String(), name)
}
}
if ci.Misconfigured {
fmt.Fprintln(&sb, aurora.Red("CI Misconfigured"))
} else {
summary := fmt.Sprintf("Result:%s [Total:%d] [Passed:%d] [Failed:%d] [Warn:%d] [Skipped:%d]", status, ci.Tally.Total, ci.Tally.Pass, ci.Tally.Fail, ci.Tally.Warn, ci.Tally.Skip)
if ci.Pass {
fmt.Fprintln(&sb, aurora.Green(summary))
} else if ci.Pass && ci.Tally.Warn > 0 {
fmt.Fprintln(&sb, aurora.Blue(summary))
} else {
fmt.Fprintln(&sb, aurora.Red(summary))
}
}
return sb.String()
}