-
Notifications
You must be signed in to change notification settings - Fork 732
/
assignmeta_mutator.go
182 lines (159 loc) Β· 5.17 KB
/
assignmeta_mutator.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
package mutators
import (
"encoding/json"
"fmt"
"reflect"
"github.com/google/go-cmp/cmp"
mutationsv1alpha1 "github.com/open-policy-agent/gatekeeper/apis/mutations/v1alpha1"
"github.com/open-policy-agent/gatekeeper/pkg/mutation/match"
"github.com/open-policy-agent/gatekeeper/pkg/mutation/mutators/core"
"github.com/open-policy-agent/gatekeeper/pkg/mutation/path/parser"
"github.com/open-policy-agent/gatekeeper/pkg/mutation/path/tester"
"github.com/open-policy-agent/gatekeeper/pkg/mutation/types"
"github.com/pkg/errors"
corev1 "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
"sigs.k8s.io/controller-runtime/pkg/client"
)
var (
labelsValidSubPath = []parser.Node{
&parser.Object{
Reference: "metadata",
},
&parser.Object{
Reference: "labels",
},
}
annotationValidSubPath = []parser.Node{
&parser.Object{
Reference: "metadata",
},
&parser.Object{
Reference: "annotations",
},
}
)
// AssignMetadataMutator is a mutator built out of an
// AssignMeta instance.
type AssignMetadataMutator struct {
id types.ID
tester *tester.Tester
assignMetadata *mutationsv1alpha1.AssignMetadata
path parser.Path
}
// assignMetadataMutator implements mutator.
var _ types.Mutator = &AssignMetadataMutator{}
func (m *AssignMetadataMutator) Matches(obj client.Object, ns *corev1.Namespace) bool {
matches, err := match.Matches(&m.assignMetadata.Spec.Match, obj, ns)
if err != nil {
log.Error(err, "AssignMetadataMutator.Matches failed", "assignMeta", m.assignMetadata.Name)
return false
}
return matches
}
func (m *AssignMetadataMutator) Mutate(obj *unstructured.Unstructured) (bool, error) {
return core.Mutate(m, m.tester, nil, obj)
}
func (m *AssignMetadataMutator) ID() types.ID {
return m.id
}
func (m *AssignMetadataMutator) Path() parser.Path {
return m.path
}
func (m *AssignMetadataMutator) HasDiff(mutator types.Mutator) bool {
toCheck, ok := mutator.(*AssignMetadataMutator)
if !ok { // different types, different
return true
}
if !cmp.Equal(toCheck.id, m.id) {
return true
}
// any difference in spec may be enough
if !cmp.Equal(toCheck.assignMetadata.Spec, m.assignMetadata.Spec) {
return true
}
return false
}
func (m *AssignMetadataMutator) DeepCopy() types.Mutator {
res := &AssignMetadataMutator{
id: m.id,
tester: m.tester.DeepCopy(),
assignMetadata: m.assignMetadata.DeepCopy(),
path: m.path.DeepCopy(),
}
return res
}
func (m *AssignMetadataMutator) Value() (interface{}, error) {
value, err := types.UnmarshalValue(m.assignMetadata.Spec.Parameters.Assign.Raw)
if err != nil {
return nil, err
}
switch t := value.(type) {
case string:
return value, nil
default:
return nil, fmt.Errorf("incorrect value for AssignMetadataMutator. Value must be a string. Value: %s Type: %s", value, t)
}
}
func (m *AssignMetadataMutator) String() string {
return fmt.Sprintf("%s/%s/%s:%d", m.id.Kind, m.id.Namespace, m.id.Name, m.assignMetadata.GetGeneration())
}
// MutatorForAssignMetadata builds an AssignMetadataMutator from the given AssignMetadata object.
func MutatorForAssignMetadata(assignMeta *mutationsv1alpha1.AssignMetadata) (*AssignMetadataMutator, error) {
path, err := parser.Parse(assignMeta.Spec.Location)
if err != nil {
return nil, errors.Wrapf(err, "invalid location format for AssignMetadata %s: %s", assignMeta.GetName(), assignMeta.Spec.Location)
}
if !isValidMetadataPath(path) {
return nil, fmt.Errorf("invalid location for assignmetadata %s: %s", assignMeta.GetName(), assignMeta.Spec.Location)
}
assign := make(map[string]interface{})
err = json.Unmarshal([]byte(assignMeta.Spec.Parameters.Assign.Raw), &assign)
if err != nil {
return nil, errors.Wrap(err, "invalid format for parameters.assign")
}
value, ok := assign["value"]
if !ok {
return nil, errors.New("spec.parameters.assign must have a string value field for AssignMetadata " + assignMeta.GetName())
}
if _, ok := value.(string); !ok {
return nil, errors.New("spec.parameters.assign.value field must be a string for AssignMetadata " + assignMeta.GetName())
}
t, err := tester.New(path, []tester.Test{
{SubPath: path, Condition: tester.MustNotExist},
})
if err != nil {
return nil, err
}
return &AssignMetadataMutator{
id: types.MakeID(assignMeta),
tester: t,
assignMetadata: assignMeta.DeepCopy(),
path: path,
}, nil
}
// Verifies that the given path is valid for metadata.
func isValidMetadataPath(path parser.Path) bool {
// Path must be metadata.annotations.something or metadata.labels.something
if len(path.Nodes) != 3 ||
path.Nodes[0].Type() != parser.ObjectNode ||
path.Nodes[1].Type() != parser.ObjectNode ||
path.Nodes[2].Type() != parser.ObjectNode {
return false
}
if reflect.DeepEqual(path.Nodes[0:2], labelsValidSubPath) {
return true
}
if reflect.DeepEqual(path.Nodes[0:2], annotationValidSubPath) {
return true
}
return false
}
// IsValidAssignMetadata returns an error if the given assignmetadata object is not
// semantically valid.
func IsValidAssignMetadata(assignMeta *mutationsv1alpha1.AssignMetadata) error {
if _, err := MutatorForAssignMetadata(assignMeta); err != nil {
return err
}
return nil
}