-
Notifications
You must be signed in to change notification settings - Fork 10
/
ruleresultbuilder.go
147 lines (131 loc) · 4.04 KB
/
ruleresultbuilder.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
// Copyright 2022 Snyk Ltd
//
// 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 policy
import (
"sort"
"strings"
"github.com/snyk/policy-engine/pkg/interfacetricks"
"github.com/snyk/policy-engine/pkg/models"
)
// Helper for constructing results. Takes care of grouping resources by
// namespace and ID and then merging the different pieces of information we
// obtain.
type ruleResultBuilder struct {
passed bool
ignored bool
isMissingResource bool
messages []string
resourceId string
resourceNamespace string
resourceType string
remediation string
severity string
context map[string]interface{}
resources map[ResourceKey]*models.RuleResultResource
}
func newRuleResultBuilder() *ruleResultBuilder {
return &ruleResultBuilder{
resources: map[ResourceKey]*models.RuleResultResource{},
}
}
func (builder *ruleResultBuilder) setMissingResourceType(resourceType string) *ruleResultBuilder {
builder.resourceType = resourceType
builder.isMissingResource = true
return builder
}
func (builder *ruleResultBuilder) setPrimaryResource(key ResourceKey) *ruleResultBuilder {
builder.addResource(key)
builder.resourceId = key.ID
builder.resourceNamespace = key.Namespace
builder.resourceType = key.Type
return builder
}
func (builder *ruleResultBuilder) addResource(key ResourceKey) *ruleResultBuilder {
if _, ok := builder.resources[key]; ok {
return builder
} else {
builder.resources[key] = &models.RuleResultResource{
Id: key.ID,
Namespace: key.Namespace,
Type: key.Type,
}
return builder
}
}
func (builder *ruleResultBuilder) addResourceAttribute(
key ResourceKey,
attribute []interface{},
) *ruleResultBuilder {
builder.addResource(key)
resource := builder.resources[key]
// Check if this path is already present
present := false
for _, e := range resource.Attributes {
if interfacetricks.Equal(e.Path, attribute) {
present = true
}
}
if present {
return builder
}
resource.Attributes = append(
resource.Attributes,
models.RuleResultResourceAttribute{
Path: attribute,
},
)
return builder
}
func (builder *ruleResultBuilder) toRuleResult() models.RuleResult {
// Gather resources.
resourceKeys := []ResourceKey{}
for k := range builder.resources {
resourceKeys = append(resourceKeys, k)
}
sort.Slice(resourceKeys, func(i, j int) bool {
return resourceKeys[i].Less(resourceKeys[j])
})
resources := []*models.RuleResultResource{}
for _, k := range resourceKeys {
resources = append(resources, builder.resources[k])
}
// Gather messages.
messages := make([]string, len(builder.messages))
copy(messages, builder.messages)
sort.Strings(messages)
// Infer primary resource.
resourceId := builder.resourceId
resourceNamespace := builder.resourceNamespace
resourceType := builder.resourceType
// Infer the primary resource automatically is there is only one resource, but
// skip this step for "missing resource"-type rules.
if !builder.isMissingResource && len(resources) == 1 {
resource := resources[0]
resourceId = resource.Id
resourceNamespace = resource.Namespace
resourceType = resource.Type
}
return models.RuleResult{
Passed: builder.passed,
Ignored: builder.ignored,
Message: strings.Join(messages, "\n\n"),
ResourceId: resourceId,
ResourceNamespace: resourceNamespace,
ResourceType: resourceType,
Remediation: builder.remediation,
Severity: builder.severity,
Context: builder.context,
Resources: resources,
}
}