-
Notifications
You must be signed in to change notification settings - Fork 86
/
options.go
154 lines (126 loc) · 4.9 KB
/
options.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
/*
Copyright 2023 The Flux authors
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 jsondiff
// ResourceOption is some configuration that modifies the diffing behavior for
// a single resource.
type ResourceOption interface {
ApplyToResource(options *ResourceOptions)
}
// ListOption is some configuration that modifies the diffing behavior for
// a set of resources.
type ListOption interface {
ApplyToList(options *ListOptions)
}
// ResourceOptions holds options for the server-side apply diff operation.
type ResourceOptions struct {
// FieldManager is the name of the user or component submitting
// the server-side apply request.
FieldManager string
// IgnorePaths is a list of JSON pointers to ignore when comparing objects.
IgnorePaths []string
// ExclusionSelector is a map of annotations or labels which mark a
// resource to be excluded from the server-side apply diff.
ExclusionSelector map[string]string
// MaskSecrets enables masking of Kubernetes Secrets in the diff.
MaskSecrets bool
// Rationalize enables rationalization of JSON operations in the diff.
Rationalize bool
}
// ApplyOptions applies the given options on these options, and then returns
// itself (for convenient chaining).
func (o *ResourceOptions) ApplyOptions(opts []ResourceOption) *ResourceOptions {
for _, opt := range opts {
opt.ApplyToResource(o)
}
return o
}
// ListOptions holds options for the server-side apply diff operation.
type ListOptions struct {
// IgnoreRules is a list of rules that specify which paths to ignore
// for which resources.
IgnoreRules []IgnoreRule
// Graceful enables graceful handling of errors during a server-side
// apply diff operation. If enabled, the diff operation will continue
// even if an error occurs for a single resource.
Graceful bool
}
// ApplyOptions applies the given options on these options, and then returns
// itself (for convenient chaining).
func (o *ListOptions) ApplyOptions(opts []ListOption) *ListOptions {
for _, opt := range opts {
opt.ApplyToList(o)
}
return o
}
// FieldOwner sets the field manager for the server-side apply request.
type FieldOwner string
// ApplyToResource applies this configuration to the given options.
func (f FieldOwner) ApplyToResource(opts *ResourceOptions) {
opts.FieldManager = string(f)
}
// ApplyToList applies this configuration to the given options.
func (f FieldOwner) ApplyToList(_ *ListOptions) {
// no-op
}
// ExclusionSelector sets the annotations or labels which mark a resource to
// be excluded from the server-side apply diff.
type ExclusionSelector map[string]string
// ApplyToList applies this configuration to the given options.
func (e ExclusionSelector) ApplyToList(_ *ListOptions) {
// no-op
}
// ApplyToResource applies this configuration to the given options.
func (e ExclusionSelector) ApplyToResource(opts *ResourceOptions) {
opts.ExclusionSelector = e
}
// IgnorePaths sets the JSON pointers to ignore when comparing objects.
type IgnorePaths []string
// ApplyToResource applies this configuration to the given options.
func (i IgnorePaths) ApplyToResource(opts *ResourceOptions) {
opts.IgnorePaths = i
}
// IgnoreRules sets the JSON pointers to ignore when comparing objects.
type IgnoreRules []IgnoreRule
// ApplyToList applies this configuration to the given options.
func (i IgnoreRules) ApplyToList(opts *ListOptions) {
opts.IgnoreRules = i
}
// MaskSecrets sets the flag to mask secrets in the diff.
type MaskSecrets bool
// ApplyToResource applies this configuration to the given options.
func (m MaskSecrets) ApplyToResource(opts *ResourceOptions) {
opts.MaskSecrets = bool(m)
}
// ApplyToList applies this configuration to the given options.
func (m MaskSecrets) ApplyToList(_ *ListOptions) {
// no-op
}
// Rationalize enables the rationalization of JSON operations in the
// server-side apply diff.
type Rationalize bool
// ApplyToResource applies this configuration to the given options.
func (r Rationalize) ApplyToResource(opts *ResourceOptions) {
opts.Rationalize = bool(r)
}
// ApplyToList applies this configuration to the given options.
func (r Rationalize) ApplyToList(_ *ListOptions) {
// no-op
}
// Graceful enables graceful handling of errors during a server-side
// apply diff operation. If enabled, the diff operation will continue
// even if an error occurs for a single resource.
type Graceful bool
// ApplyToList applies this configuration to the given options.
func (f Graceful) ApplyToList(opts *ListOptions) {
opts.Graceful = bool(f)
}