-
Notifications
You must be signed in to change notification settings - Fork 25
/
summarydetails.go
181 lines (154 loc) · 6.49 KB
/
summarydetails.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
package reportsummary
import (
"github.com/kubescape/opa-utils/reporthandling/apis"
helpersv1 "github.com/kubescape/opa-utils/reporthandling/helpers/v1"
"github.com/kubescape/opa-utils/reporthandling/results/v1/resourcesresults"
)
// =================================== Status ============================================
// Status get the scan status. returns an apis.ScanningStatus object
func (summaryDetails *SummaryDetails) GetStatus() *helpersv1.Status {
if summaryDetails.Status == apis.StatusUnknown {
summaryDetails.CalculateStatus()
}
return helpersv1.NewStatus(summaryDetails.Status)
}
// GetScore return score
func (summaryDetails *SummaryDetails) GetScore() float32 {
return summaryDetails.Score
}
// SetStatus set the framework status based on the resource counters
func (summaryDetails *SummaryDetails) CalculateStatus() {
summaryDetails.Status = calculateStatus(&summaryDetails.ResourceCounters)
}
// =================================== Counters ============================================
// NumberOfExcluded get the number of excluded resources
func (summaryDetails *SummaryDetails) NumberOfResources() ICounters {
return &summaryDetails.ResourceCounters
}
// Increase increases the counter based on the status
func (summaryDetails *SummaryDetails) Increase(status apis.IStatus) {
summaryDetails.ResourceCounters.Increase(status)
}
// InitResourcesSummary must run this AFTER initializing the controls
func (summaryDetails *SummaryDetails) InitResourcesSummary(controlInfoMap map[string]apis.StatusInfo) {
for i := range summaryDetails.Frameworks {
summaryDetails.Frameworks[i].initResourcesSummary(controlInfoMap)
}
for k, control := range summaryDetails.Controls {
if statusInfo, ok := controlInfoMap[control.ControlID]; ok && statusInfo.InnerStatus != apis.StatusUnknown {
control.SetStatus(&statusInfo)
} else if control.GetStatus().Status() == apis.StatusUnknown {
control.CalculateStatus()
}
summaryDetails.Controls[k] = control
}
summaryDetails.ResourceCounters.Set(summaryDetails.ListResourcesIDs())
summaryDetails.CalculateStatus()
}
// =========================================== List Frameworks ====================================
// ListFrameworksNames list all framework names
func (summaryDetails *SummaryDetails) ListFrameworksNames() *helpersv1.AllLists {
frameworks := &helpersv1.AllLists{}
for i := range summaryDetails.Frameworks {
frameworks.Append(summaryDetails.Frameworks[i].GetStatus().Status(), summaryDetails.Frameworks[i].GetName())
}
frameworks.ToUniqueControls()
return frameworks
}
// ListFrameworks list all frameworks
func (summaryDetails *SummaryDetails) ListFrameworks() []IFrameworkSummary {
frameworks := []IFrameworkSummary{}
for i := range summaryDetails.Frameworks {
frameworks = append(frameworks, &summaryDetails.Frameworks[i])
}
return frameworks
}
// =========================================== List Controls ====================================
// ListControlsNames list all framework names
func (summaryDetails *SummaryDetails) ListControlsNames() *helpersv1.AllLists {
controls := &helpersv1.AllLists{}
for _, controlSummary := range summaryDetails.Controls {
controls.Append(controlSummary.GetStatus().Status(), controlSummary.Name)
}
controls.ToUniqueControls()
return controls
}
func (summaryDetails *SummaryDetails) ListControlsIDs() *helpersv1.AllLists {
controls := &helpersv1.AllLists{}
for controlID, controlSummary := range summaryDetails.Controls {
controls.Append(controlSummary.GetStatus().Status(), controlID)
}
controls.ToUniqueControls()
return controls
}
// ListControls list all controls
func (summaryDetails *SummaryDetails) ListControls() []IControlSummary {
controls := make([]IControlSummary, len(summaryDetails.Controls))
iter := summaryDetails.ListControlsIDs().All()
i := 0
for iter.HasNext() {
controls[i] = summaryDetails.Controls.GetControl(EControlCriteriaID, iter.Next())
i++
}
return controls
}
// NumberOfControls get number of controls
func (summaryDetails *SummaryDetails) NumberOfControls() ICounters {
controlsIds := summaryDetails.ListControlsIDs()
return &PostureCounters{
PassedCounter: len(controlsIds.Passed()),
FailedCounter: len(controlsIds.Failed()),
ExcludedCounter: len(controlsIds.Excluded()),
SkippedCounter: len(controlsIds.Skipped()),
UnknownCounter: len(controlsIds.Other()),
}
}
// ================================================================================
func (summaryDetails *SummaryDetails) ControlName(controlID string) string {
if c, ok := summaryDetails.Controls[controlID]; ok {
return c.Name
}
return ""
}
// ListResourcesIDs list all resources IDs
func (summaryDetails *SummaryDetails) ListResourcesIDs() *helpersv1.AllLists {
return summaryDetails.Controls.ListResourcesIDs()
}
// AppendResourceResult appends the given resource result to the summary
//
// Updates any necessary info accordingly
func (summaryDetails *SummaryDetails) AppendResourceResult(resourceResult *resourcesresults.Result) {
// update full-summary counter
updateControlsSummaryCounters(resourceResult, summaryDetails.Controls, nil)
// update the summary’s severity counters
if resourceResult.GetStatus(nil).IsFailed() {
for _, resourceControl := range resourceResult.ListControls() {
if resourceControl.GetStatus(nil).IsFailed() {
control := summaryDetails.Controls.GetControl(EControlCriteriaID, resourceControl.GetID())
severityScore := control.GetScoreFactor()
severity := apis.ControlSeverityToString(severityScore)
summaryDetails.SeverityCounters.Increase(severity, 1)
}
}
}
// update frameworks counters
for _, framework := range summaryDetails.Frameworks {
updateControlsSummaryCounters(resourceResult, framework.Controls, &helpersv1.Filters{FrameworkNames: []string{framework.Name}})
framework.CalculateStatus()
}
}
// updateSummaryWithResource get the result of a single resource. If resource not found will return nil
func (summaryDetails *SummaryDetails) GetResourcesSeverityCounters() ISeverityCounters {
return &summaryDetails.SeverityCounters
}
func updateControlsSummaryCounters(resourceResult *resourcesresults.Result, controls map[string]ControlSummary, f *helpersv1.Filters) {
// update controls counters
for i := range resourceResult.AssociatedControls {
controlID := resourceResult.AssociatedControls[i].ControlID
if controlSummary, ok := controls[controlID]; ok {
controlSummary.Append(resourceResult.AssociatedControls[i].GetStatus(f), resourceResult.ResourceID)
controlSummary.CalculateStatus()
controls[controlID] = controlSummary
}
}
}