File: selector_test.go

package info (click to toggle)
golang-k8s-sigs-kustomize-kyaml 0.20.1%2Bds-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 7,180 kB
  • sloc: makefile: 220; sh: 68
file content (467 lines) | stat: -rw-r--r-- 9,945 bytes parent folder | download | duplicates (2)
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
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
// Copyright 2021 The Kubernetes Authors.
// SPDX-License-Identifier: Apache-2.0

package framework_test

import (
	"bytes"
	"strings"
	"testing"

	"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/require"
	"sigs.k8s.io/kustomize/kyaml/yaml"

	"sigs.k8s.io/kustomize/kyaml/fn/framework"
	"sigs.k8s.io/kustomize/kyaml/kio"
)

func TestSelector(t *testing.T) {
	type Test struct {
		// Name is the name of the test
		Name string

		// Filter configures the selector
		Fn func(*framework.Selector)

		// ValueFoo is the value to substitute to select the foo resource
		ValueFoo string

		// ValueBar is the value to substitute to select the bar resource
		ValueBar string

		// Value is set by the test to either ValueFoo or ValueBar
		// and substituted into the selector
		Value string
	}
	tests := []Test{
		// Test the name template
		{
			Name: "names",
			Fn: func(s *framework.Selector) {
				s.Names = []string{"{{ .Value }}"}
			},
			ValueFoo: "foo",
			ValueBar: "bar",
		},

		// Test the kind template
		{
			Name: "kinds",
			Fn: func(s *framework.Selector) {
				s.Kinds = []string{"{{ .Value }}"}
			},
			ValueFoo: "StatefulSet",
			ValueBar: "Deployment",
		},

		// Test the apiVersion template
		{
			Name: "apiVersion",
			Fn: func(s *framework.Selector) {
				s.APIVersions = []string{"{{ .Value }}"}
			},
			ValueFoo: "apps/v1beta1",
			ValueBar: "apps/v1",
		},

		// Test the namespace template
		{
			Name: "namespaces",
			Fn: func(s *framework.Selector) {
				s.Namespaces = []string{"{{ .Value }}"}
			},
			ValueFoo: "foo-default",
			ValueBar: "bar-default",
		},

		// Test the annotations template
		{
			Name: "annotations",
			Fn: func(s *framework.Selector) {
				s.Annotations = map[string]string{"key": "{{ .Value }}"}
			},
			ValueFoo: "foo-a",
			ValueBar: "bar-a",
		},

		// Test the labels template
		{
			Name: "labels",
			Fn: func(s *framework.Selector) {
				s.Labels = map[string]string{"key": "{{ .Value }}"}
			},
			ValueFoo: "foo-l",
			ValueBar: "bar-l",
		},
	}

	// input is the input resources that are selected
	input := `
apiVersion: apps/v1beta1
kind: StatefulSet
metadata:
 name: foo
 namespace: foo-default
 annotations:
   key: foo-a
 labels:
   key: foo-l
---
apiVersion: apps/v1
kind: Deployment
metadata:
 name: bar
 namespace: bar-default
 annotations:
   key: bar-a
 labels:
   key: bar-l
`
	// expectedFoo is the expected output when the FooValue is substituted
	expectedFoo := `
apiVersion: apps/v1beta1
kind: StatefulSet
metadata:
  name: foo
  namespace: foo-default
  annotations:
    key: foo-a
    config.kubernetes.io/index: '0'
    internal.config.kubernetes.io/index: '0'
  labels:
    key: foo-l
`
	// expectedFoo is the expected output when the BarValue is substituted
	expectedBar := `
apiVersion: apps/v1
kind: Deployment
metadata:
  name: bar
  namespace: bar-default
  annotations:
    key: bar-a
    config.kubernetes.io/index: '1'
    internal.config.kubernetes.io/index: '1'
  labels:
    key: bar-l
`

	// Run the tests by substituting the FooValues
	var err error
	for i := range tests {
		test := tests[i]
		t.Run(tests[i].Name+"-foo", func(t *testing.T) {
			test.Value = test.ValueFoo
			var out bytes.Buffer
			rw := &kio.ByteReadWriter{
				Reader:                bytes.NewBufferString(input),
				Writer:                &out,
				KeepReaderAnnotations: true,
			}
			p := func(rl *framework.ResourceList) error {
				s := &framework.Selector{TemplateData: test}
				test.Fn(s)
				rl.Items, err = s.Filter(rl.Items)
				return err
			}

			require.NoError(t, framework.Execute(framework.ResourceListProcessorFunc(p), rw))
			require.Equal(t, strings.TrimSpace(expectedFoo), strings.TrimSpace(out.String()))
		})
	}

	// Run the tests by substituting the BarValues
	for i := range tests {
		test := tests[i]
		t.Run(tests[i].Name+"-bar", func(t *testing.T) {
			test.Value = test.ValueBar
			var out bytes.Buffer
			rw := &kio.ByteReadWriter{
				Reader:                bytes.NewBufferString(input),
				Writer:                &out,
				KeepReaderAnnotations: true,
			}

			p := func(rl *framework.ResourceList) error {
				s := &framework.Selector{TemplateData: test}
				test.Fn(s)
				rl.Items, err = s.Filter(rl.Items)
				return err
			}
			require.NoError(t, framework.Execute(framework.ResourceListProcessorFunc(p), rw))
			require.Equal(t, strings.TrimSpace(expectedBar), strings.TrimSpace(out.String()))
		})
	}
}

func TestAndOrSelector_Composition(t *testing.T) {
	// This selector should pick the "prime-target" deployment by name
	// as well as any resources with the given labels or annotations regardless of kind
	s := framework.MatchAny(
		framework.MatchAll(
			framework.GVKMatcher("apps/v1/Deployment"),
			framework.NameMatcher("prime-target"),
		),
		framework.MatchAny(
			framework.LabelMatcher(map[string]string{
				"select": "yes",
			}),
			framework.AnnotationMatcher(map[string]string{
				"example.io/select": "yes",
			}),
		),
	)

	input, err := kio.FromBytes([]byte(`
apiVersion: apps/v1
kind: Deployment
metadata:
  name: prime-target
---
apiVersion: apps/v1
kind: Deployment
metadata:
  name: exclude-one
---
apiVersion: apps/v1
kind: Deployment
metadata:
  name: exclude-two
  labels:
    select: no
---
apiVersion: v1
kind: ConfigMap
metadata:
  name: extra-target
  labels:
    select: yes
---
apiVersion: apps/v1
kind: ConfigMap
metadata:
  name: prime-target
data:
  shouldSelect: false
---
apiVersion: apps/v1
kind: Deployment
metadata:
  name: extra-target-one
  labels:
    select: yes
---
apiVersion: apps/v1
kind: Deployment
metadata:
  name: extra-target-two
  annotations:
    example.io/select: yes
`))
	require.NoError(t, err)
	result, err := s.Filter(input)
	require.NoError(t, err)

	expected := `
apiVersion: apps/v1
kind: Deployment
metadata:
  name: prime-target
---
apiVersion: v1
kind: ConfigMap
metadata:
  name: extra-target
  labels:
    select: yes
---
apiVersion: apps/v1
kind: Deployment
metadata:
  name: extra-target-one
  labels:
    select: yes
---
apiVersion: apps/v1
kind: Deployment
metadata:
  name: extra-target-two
  annotations:
    example.io/select: yes
`
	resultStr, err := kio.StringAll(result)
	require.NoError(t, err)
	assert.Equal(t, strings.TrimSpace(expected), strings.TrimSpace(resultStr))
}

func TestAndOrSelector_CompositionTemplated(t *testing.T) {
	// This selector should pick the "prime-target" deployment by name
	// as well as any resources with the given labels or annotations regardless of kind
	// Note: very similar to above test, but uses verbose expression to access templating
	type templateStruct struct {
		GVK             string
		Name            string
		LabelValue      string
		AnnotationValue string
	}

	s := framework.OrSelector{
		// This should get propagated to matchers without explicit data
		TemplateData: &templateStruct{
			GVK:             "apps/v1/Oops",
			Name:            "extra-target",
			LabelValue:      "yes",
			AnnotationValue: "yes",
		},
		Matchers: []framework.ResourceMatcher{
			&framework.AndSelector{
				TemplateData: &templateStruct{
					GVK:  "apps/v1/Deployment",
					Name: "prime-target",
				},
				Matchers: []framework.ResourceMatcher{
					framework.GVKMatcher("{{.GVK}}"),
					framework.NameMatcher("{{.Name}}"),
				},
			},
			&framework.OrSelector{
				Matchers: []framework.ResourceMatcher{
					framework.LabelMatcher(map[string]string{
						"select": "{{.LabelValue}}",
					}),
					framework.AnnotationMatcher(map[string]string{
						"example.io/select": "{{.AnnotationValue}}",
					}),
				},
			},
		},
	}

	input, err := kio.FromBytes([]byte(`
apiVersion: apps/v1
kind: Deployment
metadata:
  name: prime-target
---
apiVersion: apps/v1
kind: Deployment
metadata:
  name: exclude-one
---
apiVersion: apps/v1
kind: Deployment
metadata:
  name: exclude-two
  labels:
    select: no
---
apiVersion: v1
kind: ConfigMap
metadata:
  name: extra-target
  labels:
    select: yes
---
apiVersion: apps/v1
kind: ConfigMap
metadata:
  name: prime-target
data:
  shouldSelect: false
---
apiVersion: apps/v1
kind: Deployment
metadata:
  name: extra-target-one
  labels:
    select: yes
---
apiVersion: apps/v1
kind: Deployment
metadata:
  name: extra-target-two
  annotations:
    example.io/select: yes
`))
	require.NoError(t, err)
	result, err := s.Filter(input)
	require.NoError(t, err)

	expected := `
apiVersion: apps/v1
kind: Deployment
metadata:
  name: prime-target
---
apiVersion: v1
kind: ConfigMap
metadata:
  name: extra-target
  labels:
    select: yes
---
apiVersion: apps/v1
kind: Deployment
metadata:
  name: extra-target-one
  labels:
    select: yes
---
apiVersion: apps/v1
kind: Deployment
metadata:
  name: extra-target-two
  annotations:
    example.io/select: yes
`
	resultStr, err := kio.StringAll(result)
	require.NoError(t, err)
	assert.Equal(t, strings.TrimSpace(expected), strings.TrimSpace(resultStr))
}

func TestMatchersAsFilters(t *testing.T) {
	input, err := kio.FromBytes([]byte(`
apiVersion: apps/v1
kind: Deployment
metadata:
  name: target
  labels:
    select: me
---
apiVersion: extensions/v1beta2
kind: Deployment
metadata:
  name: exclude
  labels:
    select: no
`))
	require.NoError(t, err)

	expected := `
apiVersion: apps/v1
kind: Deployment
metadata:
  name: target
  labels:
    select: me
`
	matchers := map[string]framework.ResourceMatcher{
		"slice": framework.NameMatcher("target"),
		"map":   framework.LabelMatcher(map[string]string{"select": "me"}),
		"func": framework.ResourceMatcherFunc(func(node *yaml.RNode) bool {
			v := node.Field("apiVersion").Value
			return strings.TrimSpace(v.MustString()) == "apps/v1"
		}),
	}
	for desc, m := range matchers {
		matcher := m
		t.Run(desc, func(t *testing.T) {
			result, err := matcher.Filter(input)
			require.NoError(t, err)
			resultStr, err := kio.StringAll(result)
			require.NoError(t, err)
			assert.Equal(t, strings.TrimSpace(expected), strings.TrimSpace(resultStr))
		})
	}
}