File: openapicustomschema_test.go

package info (click to toggle)
golang-k8s-sigs-kustomize-api 0.20.1%2Bds-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 3,768 kB
  • sloc: makefile: 206; sh: 67
file content (645 lines) | stat: -rw-r--r-- 14,376 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
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
// Copyright 2019 The Kubernetes Authors.
// SPDX-License-Identifier: Apache-2.0

package krusty_test

import (
	"os"
	"testing"

	"github.com/stretchr/testify/assert"
	"github.com/stretchr/testify/require"
	kusttest_test "sigs.k8s.io/kustomize/api/testutils/kusttest"
	"sigs.k8s.io/kustomize/kyaml/openapi"
	"sigs.k8s.io/kustomize/kyaml/openapi/kubernetesapi"
)

func writeTestSchema(th kusttest_test.Harness, filepath string) {
	bytes, _ := os.ReadFile("./testdata/customschema.json")
	th.WriteF(filepath+"mycrd_schema.json", string(bytes))
}

func writeTestSchemaYaml(th kusttest_test.Harness, filepath string) {
	bytes, _ := os.ReadFile("./testdata/customschema.yaml")
	th.WriteF(filepath+"mycrd_schema.yaml", string(bytes))
}

func writeCustomResource(th kusttest_test.Harness, filepath string) {
	th.WriteF(filepath, `
apiVersion: example.com/v1alpha1
kind: MyCRD
metadata:
  name: service
spec:
  template:
    spec:
      containers:
      - name: server
        image: server
        command: example
        ports:
        - name: grpc
          protocol: TCP
          containerPort: 8080
`)
}

func writeOtherCustomResource(th kusttest_test.Harness, filepath string) {
	th.WriteF(filepath, `
apiVersion: v1alpha1
kind: MyCRD
metadata:
  name: service
spec:
  template:
    spec:
      containers:
      - name: server
        image: server
        command: example
        ports:
        - name: grpc
          protocol: TCP
          containerPort: 8080
`)
}

func writeTestComponentWithCustomSchema(th kusttest_test.Harness) {
	writeTestSchema(th, "comp/")
	openapi.ResetOpenAPI()
	th.WriteC("comp", `
openapi:
  path: mycrd_schema.json
`)
	th.WriteF("comp/stub.yaml", `
apiVersion: v1
kind: Deployment
metadata:
  name: stub
spec:
  replicas: 1
`)
}

const customSchemaPatch = `
patchesStrategicMerge:
- |-
  apiVersion: example.com/v1alpha1
  kind: MyCRD
  metadata:
    name: service
  spec:
    template:
      spec:
        containers:
        - name: server
          image: nginx
`

const customSchemaPatchMultipleGvks = `
patchesStrategicMerge:
- |-
  apiVersion: example.com/v1alpha1
  kind: MyCRD
  metadata:
    name: service
  spec:
    template:
      spec:
        containers:
        - name: server
          image: nginx
- |-
  apiVersion: v1alpha1
  kind: MyCRD
  metadata:
    name: service
  spec:
    template:
      spec:
        containers:
        - name: server
          image: nginx
`

const patchedCustomResource = `
apiVersion: example.com/v1alpha1
kind: MyCRD
metadata:
  name: service
spec:
  template:
    spec:
      containers:
      - command: example
        image: nginx
        name: server
        ports:
        - containerPort: 8080
          name: grpc
          protocol: TCP
`

func runOpenApiTest(t *testing.T, test func(t *testing.T)) {
	t.Helper()
	openapi.ResetOpenAPI()
	test(t)
	openapi.ResetOpenAPI()
}

// Test for issue #2825
func TestCustomOpenApiFieldBasicUsage(t *testing.T) {
	runOpenApiTest(t, func(t *testing.T) {
		t.Helper()
		th := kusttest_test.MakeHarness(t)
		th.WriteK(".", `
resources:
- mycrd.yaml
openapi:
  path: mycrd_schema.json
`+customSchemaPatch)
		writeCustomResource(th, "mycrd.yaml")
		writeTestSchema(th, "./")
		m := th.Run(".", th.MakeDefaultOptions())
		th.AssertActualEqualsExpected(m, patchedCustomResource)
	})
}

func TestCustomOpenApiFieldBasicUsageWithRemoteSchema(t *testing.T) {
	runOpenApiTest(t, func(t *testing.T) {
		t.Helper()
		th := kusttest_test.MakeHarness(t)
		th.WriteK(".", `
resources:
- mycrd.yaml
openapi:
  path: https://github.com/kubernetes-sigs/kustomize/raw/master/api/krusty/testdata/customschema.json
`+customSchemaPatch)
		writeCustomResource(th, "mycrd.yaml")
		writeTestSchema(th, "./")
		m := th.Run(".", th.MakeDefaultOptions())
		th.AssertActualEqualsExpected(m, patchedCustomResource)
	})
}

func TestCustomOpenApiFieldWithTwoGvks(t *testing.T) {
	runOpenApiTest(t, func(t *testing.T) {
		t.Helper()
		th := kusttest_test.MakeHarness(t)
		th.WriteK(".", `
resources:
- mycrd.yaml
- myothercrd.yaml
openapi:
  path: mycrd_schema.json
`+customSchemaPatchMultipleGvks)
		writeCustomResource(th, "mycrd.yaml")
		writeOtherCustomResource(th, "myothercrd.yaml")
		writeTestSchema(th, "./")
		m := th.Run(".", th.MakeDefaultOptions())
		th.AssertActualEqualsExpected(m, `apiVersion: example.com/v1alpha1
kind: MyCRD
metadata:
  name: service
spec:
  template:
    spec:
      containers:
      - command: example
        image: nginx
        name: server
        ports:
        - containerPort: 8080
          name: grpc
          protocol: TCP
---
apiVersion: v1alpha1
kind: MyCRD
metadata:
  name: service
spec:
  template:
    spec:
      containers:
      - command: example
        image: nginx
        name: server
        ports:
        - containerPort: 8080
          name: grpc
          protocol: TCP
`)
	})
}

func TestCustomOpenApiFieldYaml(t *testing.T) {
	runOpenApiTest(t, func(t *testing.T) {
		t.Helper()
		th := kusttest_test.MakeHarness(t)
		th.WriteK(".", `
resources:
- mycrd.yaml
openapi:
  path: mycrd_schema.yaml
`+customSchemaPatch)
		writeCustomResource(th, "mycrd.yaml")
		writeTestSchemaYaml(th, "./")
		m := th.Run(".", th.MakeDefaultOptions())
		th.AssertActualEqualsExpected(m, patchedCustomResource)
	})
}

// Error if user tries to specify both builtin version
// and custom schema
func TestCustomOpenApiFieldBothPathAndVersion(t *testing.T) {
	runOpenApiTest(t, func(t *testing.T) {
		t.Helper()
		th := kusttest_test.MakeHarness(t)
		th.WriteK(".", `
resources:
- mycrd.yaml
openapi:
  version: v1.21.2
  path: mycrd_schema.json
`+customSchemaPatch)
		writeCustomResource(th, "mycrd.yaml")
		writeTestSchema(th, "./")
		err := th.RunWithErr(".", th.MakeDefaultOptions())
		require.Error(t, err)
		assert.Equal(t,
			"builtin version and custom schema provided, cannot use both",
			err.Error())
	})
}

// Test for if the filepath specified is not found
func TestCustomOpenApiFieldFileNotFound(t *testing.T) {
	runOpenApiTest(t, func(t *testing.T) {
		t.Helper()
		th := kusttest_test.MakeHarness(t)
		th.WriteK(".", `
resources:
- mycrd.yaml
openapi:
  path: mycrd_schema.json
`+customSchemaPatch)
		writeCustomResource(th, "mycrd.yaml")
		err := th.RunWithErr(".", th.MakeDefaultOptions())
		require.Error(t, err)
		assert.Equal(t,
			"'/mycrd_schema.json' doesn't exist",
			err.Error())
	})
}

func TestCustomOpenApiFieldFromBase(t *testing.T) {
	runOpenApiTest(t, func(t *testing.T) {
		t.Helper()
		th := kusttest_test.MakeHarness(t)
		th.WriteK("base", `
resources:
- mycrd.yaml
openapi:
  path: mycrd_schema.json
`)
		th.WriteK("overlay", `
resources:
- ../base
`+customSchemaPatch)
		writeCustomResource(th, "base/mycrd.yaml")
		writeTestSchema(th, "base/")
		m := th.Run("overlay", th.MakeDefaultOptions())
		th.AssertActualEqualsExpected(m, patchedCustomResource)
		assert.Equal(t, "using custom schema from file provided",
			openapi.GetSchemaVersion())
	})
}

func TestCustomOpenApiFieldFromBaseWithRemoteSchema(t *testing.T) {
	runOpenApiTest(t, func(t *testing.T) {
		t.Helper()
		th := kusttest_test.MakeHarness(t)
		th.WriteK("base", `
resources:
- mycrd.yaml
openapi:
  path: https://github.com/kubernetes-sigs/kustomize/raw/master/api/krusty/testdata/customschema.json
`)
		th.WriteK("overlay", `
resources:
- ../base
`+customSchemaPatch)
		writeCustomResource(th, "base/mycrd.yaml")
		writeTestSchema(th, "base/")
		m := th.Run("overlay", th.MakeDefaultOptions())
		th.AssertActualEqualsExpected(m, patchedCustomResource)
		assert.Equal(t, "using custom schema from file provided",
			openapi.GetSchemaVersion())
	})
}

func TestCustomOpenApiFieldFromOverlay(t *testing.T) {
	runOpenApiTest(t, func(t *testing.T) {
		t.Helper()
		th := kusttest_test.MakeHarness(t)
		th.WriteK("base", `
resources:
- mycrd.yaml
`)
		th.WriteK("overlay", `
resources:
- ../base
openapi:
  path: mycrd_schema.json
`+customSchemaPatch)
		writeCustomResource(th, "base/mycrd.yaml")
		writeTestSchema(th, "overlay/")
		m := th.Run("overlay", th.MakeDefaultOptions())
		th.AssertActualEqualsExpected(m, patchedCustomResource)
		assert.Equal(t, "using custom schema from file provided",
			openapi.GetSchemaVersion())
	})
}

func TestCustomOpenApiFieldFromOverlayWithRemoteSchema(t *testing.T) {
	runOpenApiTest(t, func(t *testing.T) {
		t.Helper()
		th := kusttest_test.MakeHarness(t)
		th.WriteK("base", `
resources:
- mycrd.yaml
`)
		th.WriteK("overlay", `
resources:
- ../base
openapi:
  path: https://github.com/kubernetes-sigs/kustomize/raw/master/api/krusty/testdata/customschema.json
`+customSchemaPatch)
		writeCustomResource(th, "base/mycrd.yaml")
		writeTestSchema(th, "overlay/")
		m := th.Run("overlay", th.MakeDefaultOptions())
		th.AssertActualEqualsExpected(m, patchedCustomResource)
		assert.Equal(t, "using custom schema from file provided",
			openapi.GetSchemaVersion())
	})
}

func TestCustomOpenApiFieldOverlayTakesPrecedence(t *testing.T) {
	runOpenApiTest(t, func(t *testing.T) {
		t.Helper()
		th := kusttest_test.MakeHarness(t)
		openapi.ResetOpenAPI()
		th.WriteK("base", `
resources:
- mycrd.yaml
openapi:
  path: mycrd_schema.json
`)
		th.WriteK("overlay", `
resources:
- ../base
openapi:
  version: v1.21.2
`+customSchemaPatch)
		writeCustomResource(th, "base/mycrd.yaml")
		writeTestSchema(th, "base/")
		m := th.Run("overlay", th.MakeDefaultOptions())
		th.AssertActualEqualsExpected(m, `
apiVersion: example.com/v1alpha1
kind: MyCRD
metadata:
  name: service
spec:
  template:
    spec:
      containers:
      - image: nginx
        name: server
`)
		assert.Equal(t, "v1.21.2", openapi.GetSchemaVersion())
	})
}

func TestCustomOpenApiFieldFromComponent(t *testing.T) {
	runOpenApiTest(t, func(t *testing.T) {
		t.Helper()
		input := []FileGen{
			writeTestBase,
			writeTestComponentWithCustomSchema,
			writeOverlayProd}

		th := kusttest_test.MakeHarness(t)
		for _, f := range input {
			f(th)
		}
		th.Run("prod", th.MakeDefaultOptions())
		assert.Equal(t, "using custom schema from file provided", openapi.GetSchemaVersion())
	})
}

// test for https://github.com/kubernetes-sigs/kustomize/issues/4179
// kustomize is not seeing the openapi field from the component defined in the overlay
func TestCustomOpenApiFieldFromComponentWithOverlays(t *testing.T) {
	runOpenApiTest(t, func(t *testing.T) {
		t.Helper()
		th := kusttest_test.MakeHarness(t)

		// overlay declaring the component
		th.WriteK("overlays/overlay-component-openapi", `resources:
- ../base/
components:
- ../../components/dc-openapi
`)

		// base kustomization
		th.WriteK("overlays/base", `resources:
- dc.yml
`)

		// resource declared in the base kustomization
		th.WriteF("overlays/base/dc.yml", `apiVersion: apps.openshift.io/v1
kind: DeploymentConfig
metadata:
  name: my-dc
spec:
  template:
    spec:
      initContainers:
        - name: init
      containers:
        - name: container
          env:
            - name: foo
              value: bar
          volumeMounts:
            - name: cm
              mountPath: /opt/cm
      volumes:
        - name: cm
          configMap:
            name: cm
`)

		// openapi schema referred to by the component
		bytes, _ := os.ReadFile("./testdata/openshiftschema.json")
		th.WriteF("components/dc-openapi/openapi.json", string(bytes))

		// patch referred to by the component
		th.WriteF("components/dc-openapi/patch.yml", `apiVersion: apps.openshift.io/v1
kind: DeploymentConfig
metadata:
  name: my-dc
spec:
  template:
    spec:
      containers:
        - name: container
          volumeMounts:
            - name: additional-cm
              mountPath: /mnt
      volumes:
        - name: additional-cm
          configMap:
             name: additional-cm
`)

		// component declared in overlay with custom schema and patch
		th.WriteC("components/dc-openapi", `patchesStrategicMerge:
  - patch.yml
openapi:
  path: openapi.json
`)

		m := th.Run("overlays/overlay-component-openapi", th.MakeDefaultOptions())
		th.AssertActualEqualsExpected(m, `apiVersion: apps.openshift.io/v1
kind: DeploymentConfig
metadata:
  name: my-dc
spec:
  template:
    spec:
      containers:
      - env:
        - name: foo
          value: bar
        name: container
        volumeMounts:
        - mountPath: /mnt
          name: additional-cm
        - mountPath: /opt/cm
          name: cm
      initContainers:
      - name: init
      volumes:
      - configMap:
          name: additional-cm
        name: additional-cm
      - configMap:
          name: cm
        name: cm
`)
	})
}

func TestCustomOpenApiFieldVersion(t *testing.T) {
	runOpenApiTest(t, func(t *testing.T) {
		t.Helper()
		th := kusttest_test.MakeHarness(t)
		th.WriteK(".", `
openapi:
  version: v1.21.2
resources:
- deployment.yaml
`)
		th.WriteF("deployment.yaml", `
apiVersion: apps/v1
kind: Deployment
metadata:
  name: myDeployment
spec:
  template:
    spec:
      containers:
      - image: whatever
`)

		m := th.Run(".", th.MakeDefaultOptions())
		th.AssertActualEqualsExpected(m, `
apiVersion: apps/v1
kind: Deployment
metadata:
  name: myDeployment
spec:
  template:
    spec:
      containers:
      - image: whatever
`)
		assert.Equal(t, "v1.21.2", openapi.GetSchemaVersion())
	})
}

func TestCustomOpenApiFieldNotBuiltin(t *testing.T) {
	runOpenApiTest(t, func(t *testing.T) {
		t.Helper()
		th := kusttest_test.MakeHarness(t)
		th.WriteK(".", `
openapi:
  version: v1.14.1
resources:
- deployment.yaml
`)
		th.WriteF("deployment.yaml", `
apiVersion: apps/v1
kind: Deployment
metadata:
  name: myDeployment
spec:
  template:
    spec:
      containers:
      - image: whatever
`)

		err := th.RunWithErr(".", th.MakeDefaultOptions())
		if err == nil {
			t.Fatalf("expected an error")
		}
	})
}

func TestCustomOpenApiFieldDefaultVersion(t *testing.T) {
	runOpenApiTest(t, func(t *testing.T) {
		t.Helper()
		th := kusttest_test.MakeHarness(t)
		th.WriteK(".", `
resources:
- deployment.yaml
`)
		th.WriteF("deployment.yaml", `
apiVersion: apps/v1
kind: Deployment
metadata:
  name: myDeployment
spec:
  template:
    spec:
      containers:
      - image: whatever
`)

		m := th.Run(".", th.MakeDefaultOptions())
		th.AssertActualEqualsExpected(m, `
apiVersion: apps/v1
kind: Deployment
metadata:
  name: myDeployment
spec:
  template:
    spec:
      containers:
      - image: whatever
`)
		assert.Equal(t, kubernetesapi.DefaultOpenAPI, openapi.GetSchemaVersion())
	})
}