Debian Codegraph @

pkg/admission/plugin/policy/mutating/patch/json_patch_test.go

raw
1 /*
2 Copyright 2024 The Kubernetes Authors.
3
4 Licensed under the Apache License, Version 2.0 (the "License");
5 you may not use this file except in compliance with the License.
6 You may obtain a copy of the License at
7
8 http://www.apache.org/licenses/LICENSE-2.0
9
10 Unless required by applicable law or agreed to in writing, software
11 distributed under the License is distributed on an "AS IS" BASIS,
12 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 See the License for the specific language governing permissions and
14 limitations under the License.
15 */
16
17 package patch
18
19 import (
20 "context"
21 "github.com/google/go-cmp/cmp"
22 "strings"
23 "testing"
24
25 appsv1 "k8s.io/api/apps/v1"
26 corev1 "k8s.io/api/core/v1"
27 "k8s.io/apimachinery/pkg/api/equality"
28 "k8s.io/apimachinery/pkg/api/meta"
29 metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
30 "k8s.io/apimachinery/pkg/runtime"
31 "k8s.io/apimachinery/pkg/runtime/schema"
32 "k8s.io/apiserver/pkg/admission"
33 "k8s.io/apiserver/pkg/admission/plugin/cel"
34 celconfig "k8s.io/apiserver/pkg/apis/cel"
35 "k8s.io/apiserver/pkg/cel/environment"
36 "k8s.io/utils/ptr"
37 )
38
39 func TestJSONPatch(t *testing.T) {
40 deploymentGVR := schema.GroupVersionResource{Group: "apps", Version: "v1", Resource: "deployments"}
41 tests := []struct {
42 name string
43 expression string
44 gvr schema.GroupVersionResource
45 object, oldObject runtime.Object
46 expectedResult runtime.Object
47 expectedErr string
48 }{
49 {
50 name: "jsonPatch with false test operation",
51 expression: `[
52 JSONPatch{op: "test", path: "/spec/replicas", value: 100},
53 JSONPatch{op: "replace", path: "/spec/replicas", value: 3},
54 ]`,
55 gvr: deploymentGVR,
56 object: &appsv1.Deployment{Spec: appsv1.DeploymentSpec{Replicas: ptr.To[int32](1)}},
57 expectedResult: &appsv1.Deployment{Spec: appsv1.DeploymentSpec{Replicas: ptr.To[int32](1)}},
58 },
59 {
60 name: "jsonPatch with true test operation",
61 expression: `[
62 JSONPatch{op: "test", path: "/spec/replicas", value: 1},
63 JSONPatch{op: "replace", path: "/spec/replicas", value: 3},
64 ]`,
65 gvr: deploymentGVR,
66 object: &appsv1.Deployment{Spec: appsv1.DeploymentSpec{Replicas: ptr.To[int32](1)}},
67 expectedResult: &appsv1.Deployment{Spec: appsv1.DeploymentSpec{Replicas: ptr.To[int32](3)}},
68 },
69 {
70 name: "jsonPatch remove to unset field",
71 expression: `[
72 JSONPatch{op: "remove", path: "/spec/replicas"},
73 ]`,
74 gvr: deploymentGVR,
75 object: &appsv1.Deployment{Spec: appsv1.DeploymentSpec{Replicas: ptr.To[int32](1)}},
76 expectedResult: &appsv1.Deployment{Spec: appsv1.DeploymentSpec{}},
77 },
78 {
79 name: "jsonPatch remove map entry by key",
80 expression: `[
81 JSONPatch{op: "remove", path: "/metadata/labels/y"},
82 ]`,
83 gvr: deploymentGVR,
84 object: &appsv1.Deployment{ObjectMeta: metav1.ObjectMeta{Labels: map[string]string{"x": "1", "y": "1"}}, Spec: appsv1.DeploymentSpec{}},
85 expectedResult: &appsv1.Deployment{ObjectMeta: metav1.ObjectMeta{Labels: map[string]string{"x": "1"}}, Spec: appsv1.DeploymentSpec{}},
86 },
87 {
88 name: "jsonPatch remove element in list",
89 expression: `[
90 JSONPatch{op: "remove", path: "/spec/template/spec/containers/1"},
91 ]`,
92 gvr: deploymentGVR,
93 object: &appsv1.Deployment{Spec: appsv1.DeploymentSpec{Template: corev1.PodTemplateSpec{Spec: corev1.PodSpec{
94 Containers: []corev1.Container{{Name: "a"}, {Name: "b"}, {Name: "c"}},
95 }}}},
96 expectedResult: &appsv1.Deployment{Spec: appsv1.DeploymentSpec{Template: corev1.PodTemplateSpec{Spec: corev1.PodSpec{
97 Containers: []corev1.Container{{Name: "a"}, {Name: "c"}},
98 }}}},
99 },
100 {
101 name: "jsonPatch copy map entry by key",
102 expression: `[
103 JSONPatch{op: "copy", from: "/metadata/labels/x", path: "/metadata/labels/y"},
104 ]`,
105 gvr: deploymentGVR,
106 object: &appsv1.Deployment{ObjectMeta: metav1.ObjectMeta{Labels: map[string]string{"x": "1"}}, Spec: appsv1.DeploymentSpec{}},
107 expectedResult: &appsv1.Deployment{ObjectMeta: metav1.ObjectMeta{Labels: map[string]string{"x": "1", "y": "1"}}, Spec: appsv1.DeploymentSpec{}},
108 },
109 {
110 name: "jsonPatch copy first element to end of list",
111 expression: `[
112 JSONPatch{op: "copy", from: "/spec/template/spec/containers/0", path: "/spec/template/spec/containers/-"},
113 ]`,
114 gvr: deploymentGVR,
115 object: &appsv1.Deployment{Spec: appsv1.DeploymentSpec{Template: corev1.PodTemplateSpec{Spec: corev1.PodSpec{
116 Containers: []corev1.Container{{Name: "a"}, {Name: "b"}, {Name: "c"}},
117 }}}},
118 expectedResult: &appsv1.Deployment{Spec: appsv1.DeploymentSpec{Template: corev1.PodTemplateSpec{Spec: corev1.PodSpec{
119 Containers: []corev1.Container{{Name: "a"}, {Name: "b"}, {Name: "c"}, {Name: "a"}},
120 }}}},
121 },
122 {
123 name: "jsonPatch move map entry by key",
124 expression: `[
125 JSONPatch{op: "move", from: "/metadata/labels/x", path: "/metadata/labels/y"},
126 ]`,
127 gvr: deploymentGVR,
128 object: &appsv1.Deployment{ObjectMeta: metav1.ObjectMeta{Labels: map[string]string{"x": "1"}}, Spec: appsv1.DeploymentSpec{}},
129 expectedResult: &appsv1.Deployment{ObjectMeta: metav1.ObjectMeta{Labels: map[string]string{"y": "1"}}, Spec: appsv1.DeploymentSpec{}},
130 },
131 {
132 name: "jsonPatch move first element to end of list",
133 expression: `[
134 JSONPatch{op: "move", from: "/spec/template/spec/containers/0", path: "/spec/template/spec/containers/-"},
135 ]`,
136 gvr: deploymentGVR,
137 object: &appsv1.Deployment{Spec: appsv1.DeploymentSpec{Template: corev1.PodTemplateSpec{Spec: corev1.PodSpec{
138 Containers: []corev1.Container{{Name: "a"}, {Name: "b"}, {Name: "c"}},
139 }}}},
140 expectedResult: &appsv1.Deployment{Spec: appsv1.DeploymentSpec{Template: corev1.PodTemplateSpec{Spec: corev1.PodSpec{
141 Containers: []corev1.Container{{Name: "b"}, {Name: "c"}, {Name: "a"}},
142 }}}},
143 },
144 {
145 name: "jsonPatch add map entry by key and value",
146 expression: `[
147 JSONPatch{op: "add", path: "/metadata/labels/x", value: "2"},
148 ]`,
149 gvr: deploymentGVR,
150 object: &appsv1.Deployment{ObjectMeta: metav1.ObjectMeta{Labels: map[string]string{"y": "1"}}, Spec: appsv1.DeploymentSpec{}},
151 expectedResult: &appsv1.Deployment{ObjectMeta: metav1.ObjectMeta{Labels: map[string]string{"y": "1", "x": "2"}}, Spec: appsv1.DeploymentSpec{}},
152 },
153 {
154 name: "jsonPatch add map value to field",
155 expression: `[
156 JSONPatch{op: "add", path: "/metadata/labels", value: {"y": "2"}},
157 ]`,
158 gvr: deploymentGVR,
159 object: &appsv1.Deployment{Spec: appsv1.DeploymentSpec{}},
160 expectedResult: &appsv1.Deployment{ObjectMeta: metav1.ObjectMeta{Labels: map[string]string{"y": "2"}}, Spec: appsv1.DeploymentSpec{}},
161 },
162 {
163 name: "jsonPatch add map to existing map", // performs a replacement
164 expression: `[
165 JSONPatch{op: "add", path: "/metadata/labels", value: {"y": "2"}},
166 ]`,
167 gvr: deploymentGVR,
168 object: &appsv1.Deployment{ObjectMeta: metav1.ObjectMeta{Labels: map[string]string{"x": "1"}}, Spec: appsv1.DeploymentSpec{}},
169 expectedResult: &appsv1.Deployment{ObjectMeta: metav1.ObjectMeta{Labels: map[string]string{"y": "2"}}, Spec: appsv1.DeploymentSpec{}},
170 },
171 {
172 name: "jsonPatch add to start of list",
173 expression: `[
174 JSONPatch{op: "add", path: "/spec/template/spec/containers/0", value: {"name": "x"}},
175 ]`,
176 gvr: deploymentGVR,
177 object: &appsv1.Deployment{Spec: appsv1.DeploymentSpec{Template: corev1.PodTemplateSpec{Spec: corev1.PodSpec{
178 Containers: []corev1.Container{{Name: "a"}},
179 }}}},
180 expectedResult: &appsv1.Deployment{Spec: appsv1.DeploymentSpec{Template: corev1.PodTemplateSpec{Spec: corev1.PodSpec{
181 Containers: []corev1.Container{{Name: "x"}, {Name: "a"}},
182 }}}},
183 },
184 {
185 name: "jsonPatch add to end of list",
186 expression: `[
187 JSONPatch{op: "add", path: "/spec/template/spec/containers/-", value: {"name": "x"}},
188 ]`,
189 gvr: deploymentGVR,
190 object: &appsv1.Deployment{Spec: appsv1.DeploymentSpec{Template: corev1.PodTemplateSpec{Spec: corev1.PodSpec{
191 Containers: []corev1.Container{{Name: "a"}},
192 }}}},
193 expectedResult: &appsv1.Deployment{Spec: appsv1.DeploymentSpec{Template: corev1.PodTemplateSpec{Spec: corev1.PodSpec{
194 Containers: []corev1.Container{{Name: "a"}, {Name: "x"}},
195 }}}},
196 },
197 {
198 name: "jsonPatch replace key in map",
199 expression: `[
200 JSONPatch{op: "replace", path: "/metadata/labels/x", value: "2"},
201 ]`,
202 gvr: deploymentGVR,
203 object: &appsv1.Deployment{ObjectMeta: metav1.ObjectMeta{Labels: map[string]string{"y": "1"}}, Spec: appsv1.DeploymentSpec{}},
204 expectedResult: &appsv1.Deployment{ObjectMeta: metav1.ObjectMeta{Labels: map[string]string{"y": "1", "x": "2"}}, Spec: appsv1.DeploymentSpec{}},
205 },
206 {
207 name: "jsonPatch replace map value of unset field", // adds the field value
208 expression: `[
209 JSONPatch{op: "replace", path: "/metadata/labels", value: {"y": "2"}},
210 ]`,
211 gvr: deploymentGVR,
212 object: &appsv1.Deployment{Spec: appsv1.DeploymentSpec{}},
213 expectedResult: &appsv1.Deployment{ObjectMeta: metav1.ObjectMeta{Labels: map[string]string{"y": "2"}}, Spec: appsv1.DeploymentSpec{}},
214 },
215 {
216 name: "jsonPatch replace map value of set field",
217 expression: `[
218 JSONPatch{op: "replace", path: "/metadata/labels", value: {"y": "2"}},
219 ]`,
220 gvr: deploymentGVR,
221 object: &appsv1.Deployment{ObjectMeta: metav1.ObjectMeta{Labels: map[string]string{"x": "1"}}, Spec: appsv1.DeploymentSpec{}},
222 expectedResult: &appsv1.Deployment{ObjectMeta: metav1.ObjectMeta{Labels: map[string]string{"y": "2"}}, Spec: appsv1.DeploymentSpec{}},
223 },
224 {
225 name: "jsonPatch replace first element in list",
226 expression: `[
227 JSONPatch{op: "replace", path: "/spec/template/spec/containers/0", value: {"name": "x"}},
228 ]`,
229 gvr: deploymentGVR,
230 object: &appsv1.Deployment{Spec: appsv1.DeploymentSpec{Template: corev1.PodTemplateSpec{Spec: corev1.PodSpec{
231 Containers: []corev1.Container{{Name: "a"}},
232 }}}},
233 expectedResult: &appsv1.Deployment{Spec: appsv1.DeploymentSpec{Template: corev1.PodTemplateSpec{Spec: corev1.PodSpec{
234 Containers: []corev1.Container{{Name: "x"}},
235 }}}},
236 },
237 {
238 name: "jsonPatch add map entry by key and value",
239 expression: `[
240 JSONPatch{op: "add", path: "/spec", value: Object.spec{selector: Object.spec.selector{}, replicas: 10}}
241 ]`,
242 gvr: deploymentGVR,
243 object: &appsv1.Deployment{Spec: appsv1.DeploymentSpec{}},
244 expectedResult: &appsv1.Deployment{Spec: appsv1.DeploymentSpec{Selector: &metav1.LabelSelector{}, Replicas: ptr.To[int32](10)}},
245 },
246 {
247 name: "JSONPatch patch type has field access",
248 expression: `[
249 JSONPatch{
250 op: "add", path: "/metadata/labels",
251 value: {
252 "op": JSONPatch{op: "opValue"}.op,
253 "path": JSONPatch{path: "pathValue"}.path,
254 "from": JSONPatch{from: "fromValue"}.from,
255 "value": string(JSONPatch{value: "valueValue"}.value),
256 }
257 }
258 ]`,
259 gvr: deploymentGVR,
260 object: &appsv1.Deployment{ObjectMeta: metav1.ObjectMeta{Labels: map[string]string{}}},
261 expectedResult: &appsv1.Deployment{ObjectMeta: metav1.ObjectMeta{Labels: map[string]string{
262 "op": "opValue",
263 "path": "pathValue",
264 "from": "fromValue",
265 "value": "valueValue",
266 }}},
267 },
268 {
269 name: "JSONPatch patch type has field testing",
270 expression: `[
271 JSONPatch{
272 op: "add", path: "/metadata/labels",
273 value: {
274 "op": string(has(JSONPatch{op: "opValue"}.op)),
275 "path": string(has(JSONPatch{path: "pathValue"}.path)),
276 "from": string(has(JSONPatch{from: "fromValue"}.from)),
277 "value": string(has(JSONPatch{value: "valueValue"}.value)),
278 "op-unset": string(has(JSONPatch{}.op)),
279 "path-unset": string(has(JSONPatch{}.path)),
280 "from-unset": string(has(JSONPatch{}.from)),
281 "value-unset": string(has(JSONPatch{}.value)),
282 }
283 }
284 ]`,
285 gvr: deploymentGVR,
286 object: &appsv1.Deployment{ObjectMeta: metav1.ObjectMeta{Labels: map[string]string{}}},
287 expectedResult: &appsv1.Deployment{ObjectMeta: metav1.ObjectMeta{Labels: map[string]string{
288 "op": "true",
289 "path": "true",
290 "from": "true",
291 "value": "true",
292 "op-unset": "false",
293 "path-unset": "false",
294 "from-unset": "false",
295 "value-unset": "false",
296 }}},
297 },
298 {
299 name: "JSONPatch patch type equality",
300 expression: `[
301 JSONPatch{
302 op: "add", path: "/metadata/labels",
303 value: {
304 "empty": string(JSONPatch{} == JSONPatch{}),
305 "partial": string(JSONPatch{op: "add"} == JSONPatch{op: "add"}),
306 "same-all": string(JSONPatch{op: "add", path: "path", from: "from", value: 1} == JSONPatch{op: "add", path: "path", from: "from", value: 1}),
307 "different-op": string(JSONPatch{op: "add"} == JSONPatch{op: "remove"}),
308 "different-path": string(JSONPatch{op: "add", path: "x", from: "from", value: 1} == JSONPatch{op: "add", path: "path", from: "from", value: 1}),
309 "different-from": string(JSONPatch{op: "add", path: "path", from: "x", value: 1} == JSONPatch{op: "add", path: "path", from: "from", value: 1}),
310 "different-value": string(JSONPatch{op: "add", path: "path", from: "from", value: "1"} == JSONPatch{op: "add", path: "path", from: "from", value: 1}),
311 }
312 }
313 ]`,
314 gvr: deploymentGVR,
315 object: &appsv1.Deployment{ObjectMeta: metav1.ObjectMeta{Labels: map[string]string{}}},
316 expectedResult: &appsv1.Deployment{ObjectMeta: metav1.ObjectMeta{Labels: map[string]string{
317 "empty": "true",
318 "partial": "true",
319 "same-all": "true",
320 "different-op": "false",
321 "different-path": "false",
322 "different-from": "false",
323 "different-value": "false",
324 }}},
325 },
326 {
327 name: "JSONPatch key escaping",
328 expression: `[
329 JSONPatch{
330 op: "add", path: "/metadata/labels", value: {}
331 },
332 JSONPatch{
333 op: "add", path: "/metadata/labels/" + jsonpatch.escapeKey("k8s.io/x~y"), value: "true"
334 }
335 ]`,
336 gvr: deploymentGVR,
337 object: &appsv1.Deployment{ObjectMeta: metav1.ObjectMeta{Labels: map[string]string{}}},
338 expectedResult: &appsv1.Deployment{ObjectMeta: metav1.ObjectMeta{Labels: map[string]string{
339 "k8s.io/x~y": "true",
340 }}},
341 },
342 {
343 name: "jsonPatch with CEL initializer",
344 expression: `[
345 JSONPatch{op: "add", path: "/spec/template/spec/containers/-", value: Object.spec.template.spec.containers{
346 name: "x",
347 ports: [Object.spec.template.spec.containers.ports{containerPort: 8080}],
348 }
349 },
350 ]`,
351 gvr: deploymentGVR,
352 object: &appsv1.Deployment{Spec: appsv1.DeploymentSpec{Template: corev1.PodTemplateSpec{Spec: corev1.PodSpec{
353 Containers: []corev1.Container{{Name: "a"}},
354 }}}},
355 expectedResult: &appsv1.Deployment{Spec: appsv1.DeploymentSpec{Template: corev1.PodTemplateSpec{Spec: corev1.PodSpec{
356 Containers: []corev1.Container{{Name: "a"}, {Name: "x", Ports: []corev1.ContainerPort{{ContainerPort: 8080}}}},
357 }}}},
358 },
359 {
360 name: "jsonPatch invalid CEL initializer field",
361 expression: `[
362 JSONPatch{
363 op: "add", path: "/spec/template/spec/containers/-",
364 value: Object.spec.template.spec.containers{
365 name: "x",
366 ports: [Object.spec.template.spec.containers.ports{containerPortZ: 8080}]
367 }
368 }
369 ]`,
370 gvr: deploymentGVR,
371 object: &appsv1.Deployment{Spec: appsv1.DeploymentSpec{Template: corev1.PodTemplateSpec{Spec: corev1.PodSpec{
372 Containers: []corev1.Container{{Name: "a"}},
373 }}}},
374 expectedErr: "strict decoding error: unknown field \"spec.template.spec.containers[1].ports[0].containerPortZ\"",
375 },
376 {
377 name: "jsonPatch invalid CEL initializer type",
378 expression: `[
379 JSONPatch{
380 op: "add", path: "/spec/template/spec/containers/-",
381 value: Object.spec.template.spec.containers{
382 name: "x",
383 ports: [Object.spec.template.spec.containers.portsZ{containerPort: 8080}]
384 }
385 }
386 ]`,
387 gvr: deploymentGVR,
388 object: &appsv1.Deployment{Spec: appsv1.DeploymentSpec{Template: corev1.PodTemplateSpec{Spec: corev1.PodSpec{
389 Containers: []corev1.Container{{Name: "a"}},
390 }}}},
391 expectedErr: " mismatch: unexpected type name \"Object.spec.template.spec.containers.portsZ\", expected \"Object.spec.template.spec.containers.ports\", which matches field name path from root Object type",
392 },
393 {
394 name: "jsonPatch replace end of list with - not allowed",
395 expression: `[
396 JSONPatch{op: "replace", path: "/spec/template/spec/containers/-", value: {"name": "x"}},
397 ]`,
398 gvr: deploymentGVR,
399 object: &appsv1.Deployment{Spec: appsv1.DeploymentSpec{Template: corev1.PodTemplateSpec{Spec: corev1.PodSpec{
400 Containers: []corev1.Container{{Name: "a"}},
401 }}}},
402 expectedErr: "JSON Patch: replace operation does not apply: doc is missing key: /spec/template/spec/containers/-: missing value",
403 },
404 }
405
406 compiler, err := cel.NewCompositedCompiler(environment.MustBaseEnvSet(environment.DefaultCompatibilityVersion(), true))
407
408 if err != nil {
409 t.Fatal(err)
410 }
411 for _, tc := range tests {
412 t.Run(tc.name, func(t *testing.T) {
413 accessor := &JSONPatchCondition{Expression: tc.expression}
414 compileResult := compiler.CompileMutatingEvaluator(accessor, cel.OptionalVariableDeclarations{StrictCost: true, HasPatchTypes: true}, environment.StoredExpressions)
415
416 patcher := jsonPatcher{PatchEvaluator: compileResult}
417
418 scheme := runtime.NewScheme()
419 err := appsv1.AddToScheme(scheme)
420 if err != nil {
421 t.Fatal(err)
422 }
423
424 var gvk schema.GroupVersionKind
425 gvks, _, err := scheme.ObjectKinds(tc.object)
426 if err != nil {
427 t.Fatal(err)
428 }
429 if len(gvks) == 1 {
430 gvk = gvks[0]
431 } else {
432 t.Fatalf("Failed to find gvk for type: %T", tc.object)
433 }
434
435 metaAccessor, err := meta.Accessor(tc.object)
436 if err != nil {
437 t.Fatal(err)
438 }
439
440 attrs := admission.NewAttributesRecord(tc.object, tc.oldObject, gvk,
441 metaAccessor.GetNamespace(), metaAccessor.GetName(), tc.gvr,
442 "", admission.Create, &metav1.CreateOptions{}, false, nil)
443 vAttrs := &admission.VersionedAttributes{
444 Attributes: attrs,
445 VersionedKind: gvk,
446 VersionedObject: tc.object,
447 VersionedOldObject: tc.oldObject,
448 }
449
450 r := Request{
451 MatchedResource: tc.gvr,
452 VersionedAttributes: vAttrs,
453 ObjectInterfaces: admission.NewObjectInterfacesFromScheme(scheme),
454 OptionalVariables: cel.OptionalVariableBindings{},
455 }
456
457 got, err := patcher.Patch(context.Background(), r, celconfig.RuntimeCELCostBudget)
458 if len(tc.expectedErr) > 0 {
459 if err == nil {
460 t.Fatalf("expected error: %s", tc.expectedErr)
461 } else {
462 if !strings.Contains(err.Error(), tc.expectedErr) {
463 t.Fatalf("expected error: %s, got: %s", tc.expectedErr, err.Error())
464 }
465 return
466 }
467 }
468 if err != nil && len(tc.expectedErr) == 0 {
469 t.Fatalf("unexpected error: %v", err)
470 }
471 if !equality.Semantic.DeepEqual(tc.expectedResult, got) {
472 t.Errorf("unexpected result, got diff:\n%s\n", cmp.Diff(tc.expectedResult, got))
473 }
474 })
475 }
476 }