-
Notifications
You must be signed in to change notification settings - Fork 437
/
helm_test.go
7677 lines (6984 loc) · 333 KB
/
helm_test.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
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
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
package test
import (
"encoding/json"
"fmt"
"os"
"os/exec"
"reflect"
"strconv"
"strings"
"unicode"
"github.com/ghodss/yaml"
"github.com/golang/protobuf/proto"
. "github.com/onsi/ginkgo/v2"
. "github.com/onsi/gomega"
"github.com/onsi/gomega/format"
"github.com/onsi/gomega/types"
values "github.com/solo-io/gloo/install/helm/gloo/generate"
"github.com/solo-io/gloo/install/test/securitycontext"
"github.com/solo-io/gloo/pkg/utils/kubeutils"
"github.com/solo-io/gloo/projects/gateway/pkg/defaults"
"github.com/solo-io/gloo/test/gomega/matchers"
glootestutils "github.com/solo-io/gloo/test/testutils"
"github.com/solo-io/k8s-utils/installutils/kuberesource"
. "github.com/solo-io/k8s-utils/manifesttestutils"
"github.com/solo-io/solo-kit/pkg/api/v1/resources"
skprotoutils "github.com/solo-io/solo-kit/pkg/utils/protoutils"
"github.com/solo-io/solo-kit/pkg/utils/statusutils"
appsv1 "k8s.io/api/apps/v1"
batchv1 "k8s.io/api/batch/v1"
corev1 "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/api/resource"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
"k8s.io/apimachinery/pkg/util/intstr"
"k8s.io/apimachinery/pkg/util/sets"
"k8s.io/utils/pointer"
)
func GetPodNamespaceStats() corev1.EnvVar {
return corev1.EnvVar{
Name: "START_STATS_SERVER",
Value: "true",
}
}
func GetPodNameEnvVar() corev1.EnvVar {
return corev1.EnvVar{
Name: "POD_NAME",
ValueFrom: &corev1.EnvVarSource{
FieldRef: &corev1.ObjectFieldSelector{
FieldPath: "metadata.name",
},
},
}
}
func GetLogLevelEnvVar(level string) corev1.EnvVar {
return corev1.EnvVar{
Name: "LOG_LEVEL",
Value: level,
}
}
func GetTestExtraEnvVar() corev1.EnvVar {
return corev1.EnvVar{
Name: "TEST_EXTRA_ENV_VAR",
Value: "test",
}
}
func GetValidationEnvVar() corev1.EnvVar {
return corev1.EnvVar{
Name: "VALIDATION_MUST_START",
Value: "true",
}
}
func ConvertKubeResource(unst *unstructured.Unstructured, res resources.Resource) {
byt, err := unst.MarshalJSON()
Expect(err).NotTo(HaveOccurred())
err = skprotoutils.UnmarshalResource(byt, res)
Expect(err).NotTo(HaveOccurred())
}
var _ = Describe("Helm Test", func() {
allTests := func(rendererTestCase renderTestCase) {
var (
glooPorts = []corev1.ContainerPort{
{Name: "grpc-xds", ContainerPort: 9977, Protocol: "TCP"},
{Name: "rest-xds", ContainerPort: 9976, Protocol: "TCP"},
{Name: "grpc-validation", ContainerPort: 9988, Protocol: "TCP"},
{Name: "grpc-proxydebug", ContainerPort: 9966, Protocol: "TCP"},
{Name: "wasm-cache", ContainerPort: 9979, Protocol: "TCP"},
}
selector map[string]string
testManifest TestManifest
renderErr error
statsAnnotations map[string]string
)
// Create a TestManifest out of the custom resource yaml from the configmap,
// and then perform assertions on the resources (which are assumed to all be Gateways).
// `matchers` is a map of Gateway name to the assertion to be made on that Gateway.
// There must be a matcher for every Gateway that's expected to be in the manifest.
assertCustomResourceManifest := func(matchers map[string]types.GomegaMatcher) {
configMap := getConfigMap(testManifest, namespace, customResourceConfigMapName)
ExpectWithOffset(1, configMap.Data).NotTo(BeNil())
customResourceYaml := configMap.Data["custom-resources"]
customResourceManifest := NewTestManifestFromYaml(customResourceYaml)
// make sure that the number of resources found in the manifest equals the number of
// matchers passed in, so we can ensure that every resource has an associated matcher
ExpectWithOffset(1, customResourceManifest.NumResources()).To(Equal(len(matchers)))
for gwName, matcher := range matchers {
customResourceManifest.ExpectUnstructured("Gateway", namespace, gwName).To(matcher)
}
}
BeforeEach(func() {
// Ensure that tests do not share manifests or renderErrs by accident
testManifest = nil
renderErr = nil
})
Describe(rendererTestCase.rendererName, func() {
// each entry in ValuesArgs should look like `path.to.helm.field=value`
prepareMakefile := func(namespace string, values glootestutils.HelmValues) {
tm, err := rendererTestCase.renderer.RenderManifest(namespace, values)
ExpectWithOffset(1, err).NotTo(HaveOccurred(), "Failed to render manifest")
testManifest = tm
}
expectRenderError := func(namespace string, values glootestutils.HelmValues) {
_, err := rendererTestCase.renderer.RenderManifest(namespace, values)
ExpectWithOffset(1, err).To(HaveOccurred())
renderErr = err
}
// helper for passing a values file
prepareMakefileFromValuesFile := func(valuesFile string) {
prepareMakefile(namespace, glootestutils.HelmValues{
ValuesFile: valuesFile,
ValuesArgs: []string{
"gatewayProxies.gatewayProxy.service.extraAnnotations.test=test",
},
})
}
BeforeEach(func() {
statsAnnotations = map[string]string{
"prometheus.io/path": "/metrics",
"prometheus.io/port": "9091",
"prometheus.io/scrape": "true",
}
})
It("should allow image digest pinning", func() {
shaTest := "sha256:1234123412341234123412341234213412341234123412341234123412341234"
prepareMakefile(namespace, glootestutils.HelmValues{
ValuesArgs: []string{
"gloo.deployment.image.digest=" + shaTest,
},
})
testManifest.SelectResources(func(resource *unstructured.Unstructured) bool {
return resource.GetKind() == "Deployment" && resource.GetName() == "gloo"
}).ExpectAll(func(deployment *unstructured.Unstructured) {
deploymentObject, err := kuberesource.ConvertUnstructured(deployment)
ExpectWithOffset(1, err).NotTo(HaveOccurred(), "Failed to render manifest")
structuredDeployment, ok := deploymentObject.(*appsv1.Deployment)
Expect(ok).To(BeTrue(), fmt.Sprintf("Deployment %+v should be able to cast to a structured deployment", deployment))
containers := structuredDeployment.Spec.Template.Spec.Containers
Expect(containers).To(HaveLen(1), "should have exactly 1 container")
image := containers[0].Image
Expect(image).To(ContainSubstring(shaTest), "should have sha digest in image")
})
})
It("should have all resources marked with a namespace", func() {
prepareMakefile(namespace, glootestutils.HelmValues{
ValuesArgs: []string{
// TODO: re-enable once our k8s gw integration supports namespaced rbac
"kubeGateway.enabled=false",
},
})
nonNamespacedKinds := sets.NewString(
"ClusterRole",
"ClusterRoleBinding",
"ValidatingWebhookConfiguration",
)
// all namespaced resources should have a namespace set on them
// this tests that nothing winds up in the default kube namespace from your config when you install (unless that's what you intended)
testManifest.SelectResources(func(resource *unstructured.Unstructured) bool {
return !nonNamespacedKinds.Has(resource.GetKind())
}).ExpectAll(func(resource *unstructured.Unstructured) {
ExpectWithOffset(1, resource.GetNamespace()).NotTo(BeEmpty(), fmt.Sprintf("Resource %+v does not have a namespace", resource))
})
})
It("Should have no duplicate resources", func() {
prepareMakefile(namespace, glootestutils.HelmValues{})
var resources []*unstructured.Unstructured
// This piece of work is the simplest way to directly access the unstructured resources list backing a testManifest struct
// without updating go-utils and adding a direct access function to the TestManifest interface.
// We aren't doing that because updating gloo's go-utils dependency is its own task to be addressed some other time.
testManifest.SelectResources(func(unstructured *unstructured.Unstructured) bool {
resources = append(resources, unstructured)
return true
})
for idx1, resource1 := range resources {
for idx2, resource2 := range resources {
if idx1 == idx2 {
continue
}
Expect(constructResourceID(resource1)).NotTo(Equal(constructResourceID(resource2)))
}
}
})
It("does not create the gloo pdb by default", func() {
prepareMakefile(namespace, glootestutils.HelmValues{})
testManifest.ExpectUnstructured("PodDisruptionBudget", namespace, "gloo-pdb").To(BeNil())
})
It("can create gloo pdb with minAvailable", func() {
prepareMakefile(namespace, glootestutils.HelmValues{
ValuesArgs: []string{
"gloo.podDisruptionBudget.minAvailable='2'",
},
})
pdb := makeUnstructured(`
apiVersion: policy/v1
kind: PodDisruptionBudget
metadata:
name: gloo-pdb
namespace: gloo-system
labels:
app: gloo
spec:
minAvailable: '2'
selector:
matchLabels:
gloo: gloo
`)
testManifest.ExpectUnstructured("PodDisruptionBudget", namespace, "gloo-pdb").To(BeEquivalentTo(pdb))
})
It("can create gloo pdb with maxUnavailable", func() {
prepareMakefile(namespace, glootestutils.HelmValues{
ValuesArgs: []string{
"gloo.podDisruptionBudget.maxUnavailable='2'",
},
})
pdb := makeUnstructured(`
apiVersion: policy/v1
kind: PodDisruptionBudget
metadata:
name: gloo-pdb
namespace: gloo-system
labels:
app: gloo
spec:
maxUnavailable: '2'
selector:
matchLabels:
gloo: gloo
`)
testManifest.ExpectUnstructured("PodDisruptionBudget", namespace, "gloo-pdb").To(BeEquivalentTo(pdb))
})
It("errors rendering when gloo pdb has both maxUnavailable and minAvailable set", func() {
expectRenderError(namespace, glootestutils.HelmValues{
ValuesArgs: []string{
"gloo.podDisruptionBudget.maxUnavailable='2'",
"gloo.podDisruptionBudget.minAvailable='2'",
},
})
Expect(renderErr).To(HaveOccurred())
Expect(renderErr.Error()).To(ContainSubstring("gloo PDB values minAvailable and maxUnavailable are mutually exclusive"))
})
Context("stats server settings", func() {
var (
normalPromAnnotations = map[string]string{
"prometheus.io/path": "/metrics",
"prometheus.io/port": "9091",
"prometheus.io/scrape": "true",
}
gatewayProxyDeploymentPromAnnotations = map[string]string{
"prometheus.io/path": "/metrics",
"prometheus.io/port": "8081",
"prometheus.io/scrape": "true",
}
)
It("should be able to configure a stats server by default on all relevant deployments", func() {
prepareMakefile(namespace, glootestutils.HelmValues{})
testManifest.SelectResources(func(resource *unstructured.Unstructured) bool {
return resource.GetKind() == "Deployment"
}).ExpectAll(func(deployment *unstructured.Unstructured) {
deploymentObject, err := kuberesource.ConvertUnstructured(deployment)
ExpectWithOffset(1, err).NotTo(HaveOccurred(), fmt.Sprintf("Deployment %+v should be able to convert from unstructured", deployment))
structuredDeployment, ok := deploymentObject.(*appsv1.Deployment)
ExpectWithOffset(1, ok).To(BeTrue(), fmt.Sprintf("Deployment %+v should be able to cast to a structured deployment", deployment))
promAnnotations := normalPromAnnotations
if structuredDeployment.GetName() == "gateway-proxy" {
promAnnotations = gatewayProxyDeploymentPromAnnotations
}
deploymentAnnotations := structuredDeployment.Spec.Template.ObjectMeta.Annotations
for annotation, value := range promAnnotations {
ExpectWithOffset(1, deploymentAnnotations[annotation]).To(Equal(value), fmt.Sprintf("Annotation %s should be set to %s on deployment %+v", deployment, annotation, value))
}
if structuredDeployment.GetName() != "gateway-proxy" {
for _, container := range structuredDeployment.Spec.Template.Spec.Containers {
foundExpected := false
for _, envVar := range container.Env {
if envVar.Name == "START_STATS_SERVER" {
foundExpected = true
ExpectWithOffset(1, envVar.Value).To(Equal("true"), fmt.Sprintf("Should have the START_STATS_SERVER env var set to 'true' on deployment %+v", deployment))
}
}
ExpectWithOffset(1, foundExpected).To(BeTrue(), fmt.Sprintf("Should have found the START_STATS_SERVER env var on deployment %+v", deployment))
}
}
})
})
It("should be able to set custom labels for pods", func() {
// This test expects ALL pods to be capable of setting custom labels unless exceptions are added
// here, which means that this test will fail if new deployments are added to the helm chart without
// custom labeling, unless those deployments aren't enabled by default (like the accessLogger).
// Note: test panics if values-template.yaml doesn't contain at least an empty definition
// of each label object that's modified here.
// Note note: Update number in final expectation if you add new labels here.
prepareMakefile(namespace, glootestutils.HelmValues{
ValuesArgs: []string{
"gloo.deployment.extraGlooLabels.foo=bar",
"discovery.deployment.extraDiscoveryLabels.foo=bar",
"gatewayProxies.gatewayProxy.podTemplate.extraGatewayProxyLabels.foo=bar",
"accessLogger.enabled=true", // required to test accessLogger
"accessLogger.extraAccessLoggerLabels.foo=bar",
"ingress.deployment.extraIngressLabels.foo=bar",
"ingress.enabled=true", // required to test Ingress Proxy, but not Ingress.
"ingressProxy.deployment.extraIngressProxyLabels.foo=bar",
"settings.integrations.knative.enabled=true", // required to test cluster ingress proxy and knative labels.
"settings.integrations.knative.extraKnativeExternalLabels.foo=bar",
"settings.integrations.knative.extraKnativeInternalLabels.foo=bar",
"gloo.deployment.extraGlooAnnotations.foo=bar",
"ingress.deployment.extraIngressAnnotations.foo=bar",
"settings.integrations.knative.extraKnativeExternalAnnotations.foo=bar",
"settings.integrations.knative.extraKnativeInternalAnnotations.foo=bar",
"discovery.deployment.extraDiscoveryAnnotations.foo=bar",
"accessLogger.extraAccessLoggerAnnotations.foo=bar",
"settings.integrations.knative.proxy.extraClusterIngressProxyAnnotations.foo=bar",
},
})
resourcesTested := 0
testManifest.SelectResources(func(resource *unstructured.Unstructured) bool {
return resource.GetKind() == "Deployment"
}).ExpectAll(func(deployment *unstructured.Unstructured) {
deploymentObject, err := kuberesource.ConvertUnstructured(deployment)
ExpectWithOffset(1, err).NotTo(HaveOccurred(), fmt.Sprintf("Deployment %+v should be able to convert from unstructured", deployment))
structuredDeployment, ok := deploymentObject.(*appsv1.Deployment)
ExpectWithOffset(1, ok).To(BeTrue(), fmt.Sprintf("Deployment %+v should be able to cast to a structured deployment", deployment))
deploymentLabels := structuredDeployment.Spec.Template.Labels
foundTestValue := false
for label, value := range deploymentLabels {
if label == "foo" {
ExpectWithOffset(1, value).To(Equal("bar"), fmt.Sprintf("Deployment %s expected test label to have"+
" value bar. Found value %s", deployment.GetName(), value))
foundTestValue = true
}
}
ExpectWithOffset(1, foundTestValue).To(BeTrue(), fmt.Sprintf("Coundn't find test label 'foo' in deployment %s", deployment.GetName()))
resourcesTested += 1
})
// Is there an elegant way to parameterized the expected number of deployments based on the valueArgs?
Expect(resourcesTested).To(Equal(8), "Tested %d resources when we were expecting 9."+
" Was a new pod added, or is an existing pod no longer being generated?", resourcesTested)
})
// due to the version requirements for rendering knative-related templates, the cluster ingress proxy
// template is mutually exclusive to the other knative templates, and needs to be tested separately.
It("should be able to set custom labels for cluster ingress proxy pod", func() {
prepareMakefile(namespace, glootestutils.HelmValues{
ValuesArgs: []string{
"settings.integrations.knative.enabled=true",
"settings.integrations.knative.version=0.7.0",
"settings.integrations.knative.proxy.extraClusterIngressProxyLabels.foo=bar",
},
})
resourcesTested := 0
testManifest.SelectResources(func(resource *unstructured.Unstructured) bool {
return resource.GetKind() == "Deployment"
}).ExpectAll(func(deployment *unstructured.Unstructured) {
deploymentObject, err := kuberesource.ConvertUnstructured(deployment)
ExpectWithOffset(1, err).NotTo(HaveOccurred(), fmt.Sprintf("Deployment %+v should be able to convert from unstructured", deployment))
structuredDeployment, ok := deploymentObject.(*appsv1.Deployment)
ExpectWithOffset(1, ok).To(BeTrue(), fmt.Sprintf("Deployment %+v should be able to cast to a structured deployment", deployment))
deploymentLabels := structuredDeployment.Spec.Template.Labels
if structuredDeployment.Name != "clusteringress-proxy" {
return
}
foundTestValue := false
for label, value := range deploymentLabels {
if label == "foo" {
ExpectWithOffset(1, value).To(Equal("bar"), fmt.Sprintf("Deployment %s expected test label to have"+
" value bar. Found value %s", deployment.GetName(), value))
foundTestValue = true
}
}
ExpectWithOffset(1, foundTestValue).To(BeTrue(), fmt.Sprintf("Coundn't find test label 'foo' in deployment %s", deployment.GetName()))
resourcesTested += 1
})
// Is there an elegant way to parameterized the expected number of deployments based on the valueArgs?
Expect(resourcesTested).To(Equal(1), "Tested %d resources when we were expecting 1."+
"What happened to the clusteringress-proxy deployment?", resourcesTested)
})
Context("should be able to set custom labels and annotations on jobs", func() {
// creates a template from the specified ValuesArgs, then confirms the jobs with the specified names
// have the expected labels and annotations
testJobLabelsAndAnnotations := func(ValuesArgs []string, jobNames []string, expectedLabels map[string]string, expectedAnnotations map[string]string) {
// create the chart with the specified values args
prepareMakefile(namespace, glootestutils.HelmValues{
ValuesArgs: ValuesArgs,
})
// convert the job names we expect to be affected into a map, for easy lookup
expectedNames := map[string]bool{}
for _, name := range jobNames {
expectedNames[name] = true
}
testManifest.SelectResources(func(resource *unstructured.Unstructured) bool {
// get jobs with the expected names
return resource.GetKind() == "Job" && expectedNames[resource.GetName()]
}).ExpectAll(func(job *unstructured.Unstructured) {
// convert the job to a structured object
jobObject, err := kuberesource.ConvertUnstructured(job)
ExpectWithOffset(1, err).NotTo(HaveOccurred(), fmt.Sprintf("Job %+v should be able to convert from unstructured", job))
structuredJob, ok := jobObject.(*batchv1.Job)
ExpectWithOffset(1, ok).To(BeTrue(), fmt.Sprintf("Job %+v should be able to cast to a structured job", job))
// check the labels
jobLabels := structuredJob.Spec.Template.Labels
foundTestValue := false
for label, expectedValue := range expectedLabels {
ExpectWithOffset(1, jobLabels[label]).To(Equal(expectedValue), fmt.Sprintf("Job %s expected test label to have"+
" value %s. Found value %s", job.GetName(), expectedValue, jobLabels[label]))
foundTestValue = true
}
ExpectWithOffset(1, foundTestValue).To(BeTrue(), fmt.Sprintf("Coundn't find test label 'foo' in job %s", job.GetName()))
// check the annotations
jobAnnotations := structuredJob.Spec.Template.Annotations
foundTestValue = false
for label, expectedValue := range expectedAnnotations {
ExpectWithOffset(1, jobAnnotations[label]).To(Equal(expectedValue), fmt.Sprintf("Job %s expected test annotation to have"+
" value %s. Found value %s", job.GetName(), expectedValue, jobAnnotations[label]))
foundTestValue = true
}
ExpectWithOffset(1, foundTestValue).To(BeTrue(), fmt.Sprintf("Coundn't find test annotation 'foo2' in job %s", job.GetName()))
})
}
It("should be able to set custom labels and annotations on certGenJob", func() {
values := []string{
"gateway.certGenJob.extraPodLabels.foo=bar",
"gateway.certGenJob.extraPodAnnotations.foo2=baz",
}
jobNames := []string{
"gloo-mtls-certgen-cronjob",
"gloo-mtls-certgen",
"gateway-certgen",
"gateway-certgen-cronjob",
}
expectedLabels := map[string]string{
"foo": "bar",
}
expectedAnnotations := map[string]string{
"foo2": "baz",
}
testJobLabelsAndAnnotations(values, jobNames, expectedLabels, expectedAnnotations)
})
It("should be able to set custom labels and annotations on cleanupJob", func() {
values := []string{
"gateway.cleanupJob.extraPodLabels.foo=bar",
"gateway.cleanupJob.extraPodAnnotations.foo2=baz",
}
jobNames := []string{
"gloo-resource-cleanup",
}
expectedLabels := map[string]string{
"foo": "bar",
}
expectedAnnotations := map[string]string{
"foo2": "baz",
}
testJobLabelsAndAnnotations(values, jobNames, expectedLabels, expectedAnnotations)
})
It("should be able to set custom labels and annotations on rolloutJob", func() {
values := []string{
"gateway.rolloutJob.extraPodLabels.foo=bar",
"gateway.rolloutJob.extraPodAnnotations.foo2=baz",
}
jobNames := []string{
"gloo-resource-rollout",
"gloo-resource-migration",
}
expectedLabels := map[string]string{
"foo": "bar",
}
expectedAnnotations := map[string]string{
"foo2": "baz",
}
testJobLabelsAndAnnotations(values, jobNames, expectedLabels, expectedAnnotations)
})
})
It("should set route prefix_rewrite in clusteringress-envoy-config from global.glooStats", func() {
prepareMakefile(namespace, glootestutils.HelmValues{
ValuesArgs: []string{
"settings.integrations.knative.enabled=true",
"settings.integrations.knative.version=0.7.0",
"settings.integrations.knative.proxy.stats=true",
"global.glooStats.routePrefixRewrite=/stats?format=json",
},
})
testManifest.SelectResources(func(resource *unstructured.Unstructured) bool {
return resource.GetKind() == "ConfigMap"
}).ExpectAll(func(configMap *unstructured.Unstructured) {
configMapObject, err := kuberesource.ConvertUnstructured(configMap)
ExpectWithOffset(1, err).NotTo(HaveOccurred(), fmt.Sprintf("ConfigMap %+v should be able to convert from unstructured", configMap))
structuredConfigMap, ok := configMapObject.(*corev1.ConfigMap)
ExpectWithOffset(1, ok).To(BeTrue(), fmt.Sprintf("ConfigMap %+v should be able to cast to a structured config map", configMap))
if structuredConfigMap.GetName() == "clusteringress-envoy-config" {
expectedPrefixRewrite := "prefix_rewrite: /stats?format=json"
ExpectWithOffset(1, structuredConfigMap.Data["envoy.yaml"]).To(ContainSubstring(expectedPrefixRewrite))
}
})
})
It("should set route prefix_rewrite in knative proxy configs from global.glooStats", func() {
prepareMakefile(namespace, glootestutils.HelmValues{
ValuesArgs: []string{
"settings.integrations.knative.enabled=true",
"settings.integrations.knative.version=0.8.0",
"settings.integrations.knative.proxy.stats=true",
"global.glooStats.routePrefixRewrite=/stats?format=json",
},
})
testManifest.SelectResources(func(resource *unstructured.Unstructured) bool {
return resource.GetKind() == "ConfigMap"
}).ExpectAll(func(configMap *unstructured.Unstructured) {
configMapObject, err := kuberesource.ConvertUnstructured(configMap)
ExpectWithOffset(1, err).NotTo(HaveOccurred(), fmt.Sprintf("ConfigMap %+v should be able to convert from unstructured", configMap))
structuredConfigMap, ok := configMapObject.(*corev1.ConfigMap)
ExpectWithOffset(1, ok).To(BeTrue(), fmt.Sprintf("ConfigMap %+v should be able to cast to a structured config map", configMap))
if structuredConfigMap.GetName() == "knative-internal-proxy-config" ||
structuredConfigMap.GetName() == "knative-external-proxy-config" {
expectedPrefixRewrite := "prefix_rewrite: /stats?format=json"
ExpectWithOffset(1, structuredConfigMap.Data["envoy.yaml"]).To(ContainSubstring(expectedPrefixRewrite))
}
})
})
It("should be able to set consul config values", func() {
settings := makeUnstructureFromTemplateFile("fixtures/settings/consul_config_values.yaml", namespace)
prepareMakefileFromValuesFile("values/val_consul_test_inputs.yaml")
testManifest.ExpectUnstructured(settings.GetKind(), settings.GetNamespace(), settings.GetName()).To(BeEquivalentTo(settings))
})
It("should be able to set consul config upstream discovery values", func() {
settings := makeUnstructureFromTemplateFile("fixtures/settings/consul_config_upstream_discovery.yaml", namespace)
prepareMakefileFromValuesFile("values/val_consul_discovery_test_inputs.yaml")
testManifest.ExpectUnstructured(settings.GetKind(), settings.GetNamespace(), settings.GetName()).To(BeEquivalentTo(settings))
})
deploymentContainsMonitoringPort := func(deployment *appsv1.Deployment) bool {
for _, container := range deployment.Spec.Template.Spec.Containers {
for _, containerPort := range container.Ports {
if containerPort.Name == "http-monitoring" {
return true
}
}
}
return false
}
serviceContainsMonitoringPort := func(service *corev1.Service) bool {
for _, servicePort := range service.Spec.Ports {
if servicePort.Name == "http-monitoring" {
return true
}
}
return false
}
It("should be able to override global defaults", func() {
prepareMakefile(namespace, glootestutils.HelmValues{
ValuesArgs: []string{
"discovery.deployment.stats.enabled=true",
"discovery.deployment.stats.podMonitorEnabled=true",
"global.glooStats.enabled=false",
"global.glooStats.podMonitorEnabled=false",
},
})
// assert that discovery has stats enabled
testManifest.SelectResources(func(resource *unstructured.Unstructured) bool {
return resource.GetKind() == "Deployment" && resource.GetName() == "discovery"
}).ExpectAll(func(deployment *unstructured.Unstructured) {
deploymentObject, err := kuberesource.ConvertUnstructured(deployment)
ExpectWithOffset(1, err).NotTo(HaveOccurred(), fmt.Sprintf("Deployment %+v should be able to convert from unstructured", deployment))
structuredDeployment, ok := deploymentObject.(*appsv1.Deployment)
ExpectWithOffset(1, ok).To(BeTrue(), fmt.Sprintf("Deployment %+v should be able to cast to a structured deployment", deployment))
for annotation, value := range normalPromAnnotations {
ExpectWithOffset(1, structuredDeployment.Spec.Template.ObjectMeta.Annotations[annotation]).To(Equal(value), fmt.Sprintf("Annotation %s should be set to %s on deployment %+v", deployment, annotation, value))
}
foundMonitoringPort := deploymentContainsMonitoringPort(structuredDeployment)
ExpectWithOffset(1, foundMonitoringPort).To(BeTrue(), fmt.Sprintf("'http-monitoring' port should be set on deployment %+v", deployment))
})
// assert that gloo has stats disabled
testManifest.SelectResources(func(resource *unstructured.Unstructured) bool {
return resource.GetKind() == "Deployment" && resource.GetName() == "gloo"
}).ExpectAll(func(deployment *unstructured.Unstructured) {
deploymentObject, err := kuberesource.ConvertUnstructured(deployment)
ExpectWithOffset(1, err).NotTo(HaveOccurred(), fmt.Sprintf("Deployment %+v should be able to convert from unstructured", deployment))
structuredDeployment, ok := deploymentObject.(*appsv1.Deployment)
ExpectWithOffset(1, ok).To(BeTrue(), fmt.Sprintf("Deployment %+v should be able to cast to a structured deployment", deployment))
ExpectWithOffset(1, structuredDeployment.Spec.Template.ObjectMeta.Annotations).To(BeEmpty(), fmt.Sprintf("No annotations should be present on deployment %+v", structuredDeployment))
foundMonitoringPort := deploymentContainsMonitoringPort(structuredDeployment)
ExpectWithOffset(1, foundMonitoringPort).To(BeFalse(), fmt.Sprintf("'http-monitoring' port should not be set on deployment %+v", deployment))
})
})
It("should be able to expose http-monitoring port on all relevant services", func() {
prepareMakefile(namespace, glootestutils.HelmValues{
ValuesArgs: []string{
// to enable accessLogger service
"gateway.enabled=true",
"accessLogger.enabled=true",
"accessLogger.stats.serviceMonitorEnabled=true",
"global.glooStats.enabled=true",
"global.glooStats.serviceMonitorEnabled=true",
},
})
expectedServicesWithHttpMonitoring := []string{
"gloo",
"discovery",
"gateway-proxy-access-logger",
"gateway-proxy-monitoring-service",
}
var actualServicesWithHttpMonitoring []string
testManifest.SelectResources(func(resource *unstructured.Unstructured) bool {
return resource.GetKind() == "Service"
}).ExpectAll(func(service *unstructured.Unstructured) {
serviceObject, err := kuberesource.ConvertUnstructured(service)
ExpectWithOffset(1, err).NotTo(HaveOccurred(), fmt.Sprintf("Service %+v should be able to convert from unstructured", service))
structuredService, ok := serviceObject.(*corev1.Service)
ExpectWithOffset(1, ok).To(BeTrue(), fmt.Sprintf("Service %+v should be able to cast to a structured service", service))
ExpectWithOffset(1, structuredService.Labels["app"]).To(Equal("gloo"), "Service has app=gloo label")
if serviceContainsMonitoringPort(structuredService) {
actualServicesWithHttpMonitoring = append(actualServicesWithHttpMonitoring, structuredService.GetName())
}
})
Expect(actualServicesWithHttpMonitoring).To(Equal(expectedServicesWithHttpMonitoring))
})
It("should be able to expose http-monitoring port on all relevant deployments", func() {
prepareMakefile(namespace, glootestutils.HelmValues{
ValuesArgs: []string{
// to enable accessLogger deployment
"gateway.enabled=true",
"accessLogger.enabled=true",
"accessLogger.stats.podMonitorEnabled=true",
"global.glooStats.enabled=true",
"global.glooStats.podMonitorEnabled=true",
},
})
expectedDeploymentsWithHttpMonitoring := []string{
"gloo",
"discovery",
"gateway-proxy-access-logger",
"gateway-proxy",
}
var actualDeploymentsWithHttpMonitoring []string
testManifest.SelectResources(func(resource *unstructured.Unstructured) bool {
return resource.GetKind() == "Deployment"
}).ExpectAll(func(deployment *unstructured.Unstructured) {
deploymentObject, err := kuberesource.ConvertUnstructured(deployment)
ExpectWithOffset(1, err).NotTo(HaveOccurred(), fmt.Sprintf("Deployment %+v should be able to convert from unstructured", deployment))
structuredDeployment, ok := deploymentObject.(*appsv1.Deployment)
ExpectWithOffset(1, ok).To(BeTrue(), fmt.Sprintf("Deployment %+v should be able to cast to a structured deployment", deployment))
ExpectWithOffset(1, structuredDeployment.Labels["app"]).To(Equal("gloo"), "Deployment has app=gloo label")
if deploymentContainsMonitoringPort(structuredDeployment) {
actualDeploymentsWithHttpMonitoring = append(actualDeploymentsWithHttpMonitoring, structuredDeployment.GetName())
}
})
Expect(actualDeploymentsWithHttpMonitoring).To(Equal(expectedDeploymentsWithHttpMonitoring))
})
})
Context("gloo mtls settings", func() {
var (
glooMtlsSecretVolume = corev1.Volume{
Name: "gloo-mtls-certs",
VolumeSource: corev1.VolumeSource{
Secret: &corev1.SecretVolumeSource{
SecretName: "gloo-mtls-certs",
Items: nil,
DefaultMode: proto.Int32(420),
},
},
}
haveEnvoySidecar = func(containers []corev1.Container) bool {
for _, c := range containers {
if c.Name == "envoy-sidecar" {
return true
}
}
return false
}
haveSdsSidecar = func(containers []corev1.Container) bool {
for _, c := range containers {
if c.Name == "sds" {
return true
}
}
return false
}
)
It("should put the secret volume in the Gloo and Gateway-Proxy Deployment and add a sidecar in the Gloo Deployment", func() {
prepareMakefile(namespace, glootestutils.HelmValues{
ValuesArgs: []string{"global.glooMtls.enabled=true"},
})
foundGlooMtlsCertgenJob := false
testManifest.SelectResources(func(resource *unstructured.Unstructured) bool {
return resource.GetKind() == "Job"
}).ExpectAll(func(job *unstructured.Unstructured) {
jobObject, err := kuberesource.ConvertUnstructured(job)
Expect(err).NotTo(HaveOccurred(), fmt.Sprintf("Job %+v should be able to convert from unstructured", job))
structuredDeployment, ok := jobObject.(*batchv1.Job)
Expect(ok).To(BeTrue(), fmt.Sprintf("Job %+v should be able to cast to a structured job", job))
if structuredDeployment.GetName() == "gloo-mtls-certgen" {
foundGlooMtlsCertgenJob = true
}
})
Expect(foundGlooMtlsCertgenJob).To(BeTrue(), "Did not find the gloo-mtls-certgen job")
testManifest.SelectResources(func(resource *unstructured.Unstructured) bool {
return resource.GetKind() == "Deployment"
}).ExpectAll(func(deployment *unstructured.Unstructured) {
deploymentObject, err := kuberesource.ConvertUnstructured(deployment)
Expect(err).NotTo(HaveOccurred(), fmt.Sprintf("Deployment %+v should be able to convert from unstructured", deployment))
structuredDeployment, ok := deploymentObject.(*appsv1.Deployment)
Expect(ok).To(BeTrue(), fmt.Sprintf("Deployment %+v should be able to cast to a structured deployment", deployment))
if structuredDeployment.GetName() == "gloo" {
Ω(haveEnvoySidecar(structuredDeployment.Spec.Template.Spec.Containers)).To(BeTrue())
Ω(haveSdsSidecar(structuredDeployment.Spec.Template.Spec.Containers)).To(BeTrue())
Expect(structuredDeployment.Spec.Template.Spec.Volumes).To(ContainElement(glooMtlsSecretVolume))
}
if structuredDeployment.GetName() == "gateway-proxy" {
Ω(haveSdsSidecar(structuredDeployment.Spec.Template.Spec.Containers)).To(BeTrue())
Expect(structuredDeployment.Spec.Template.Spec.Volumes).To(ContainElement(glooMtlsSecretVolume))
}
})
})
It("should add an additional listener to the gateway-proxy-envoy-config if $spec.extraListenersHelper is defined", func() {
prepareMakefile(namespace, glootestutils.HelmValues{
ValuesArgs: []string{"global.glooMtls.enabled=true,gatewayProxies.gatewayProxy.extraListenersHelper=gloo.testlistener"},
})
testManifest.SelectResources(func(resource *unstructured.Unstructured) bool {
return resource.GetKind() == "ConfigMap"
}).ExpectAll(func(configMap *unstructured.Unstructured) {
configMapObject, err := kuberesource.ConvertUnstructured(configMap)
Expect(err).NotTo(HaveOccurred(), fmt.Sprintf("ConfigMap %+v should be able to convert from unstructured", configMap))
structuredConfigMap, ok := configMapObject.(*corev1.ConfigMap)
Expect(ok).To(BeTrue(), fmt.Sprintf("ConfigMap %+v should be able to cast to a structured config map", configMap))
if structuredConfigMap.GetName() == "gateway-proxy-envoy-config" {
expectedTestListener := " - name: test_listener"
Expect(structuredConfigMap.Data["envoy.yaml"]).To(ContainSubstring(expectedTestListener))
}
})
})
It("should set route prefix_rewrite in gateway-proxy-envoy-config from global.glooStats", func() {
prepareMakefile(namespace, glootestutils.HelmValues{
ValuesArgs: []string{
"global.glooStats.enabled=true",
"global.glooStats.routePrefixRewrite=/stats?format=json",
},
})
testManifest.SelectResources(func(resource *unstructured.Unstructured) bool {
return resource.GetKind() == "ConfigMap"
}).ExpectAll(func(configMap *unstructured.Unstructured) {
configMapObject, err := kuberesource.ConvertUnstructured(configMap)
Expect(err).NotTo(HaveOccurred(), fmt.Sprintf("ConfigMap %+v should be able to convert from unstructured", configMap))
structuredConfigMap, ok := configMapObject.(*corev1.ConfigMap)
Expect(ok).To(BeTrue(), fmt.Sprintf("ConfigMap %+v should be able to cast to a structured config map", configMap))
if structuredConfigMap.GetName() == "gateway-proxy-envoy-config" {
expectedPrefixRewrite := "prefix_rewrite: /stats?format=json"
Expect(structuredConfigMap.Data["envoy.yaml"]).To(ContainSubstring(expectedPrefixRewrite))
}
})
})
It("should set route prefix_rewrite in gateway-proxy-envoy-config from gatewayProxies.gatewayProxy", func() {
prepareMakefile(namespace, glootestutils.HelmValues{
ValuesArgs: []string{
"gatewayProxies.gatewayProxy.stats.enabled=true",
"gatewayProxies.gatewayProxy.stats.routePrefixRewrite=/stats?format=json",
},
})
testManifest.SelectResources(func(resource *unstructured.Unstructured) bool {
return resource.GetKind() == "ConfigMap"
}).ExpectAll(func(configMap *unstructured.Unstructured) {
configMapObject, err := kuberesource.ConvertUnstructured(configMap)
Expect(err).NotTo(HaveOccurred(), fmt.Sprintf("ConfigMap %+v should be able to convert from unstructured", configMap))
structuredConfigMap, ok := configMapObject.(*corev1.ConfigMap)
Expect(ok).To(BeTrue(), fmt.Sprintf("ConfigMap %+v should be able to cast to a structured config map", configMap))
if structuredConfigMap.GetName() == "gateway-proxy-envoy-config" {
expectedPrefixRewrite := "prefix_rewrite: /stats?format=json"
Expect(structuredConfigMap.Data["envoy.yaml"]).To(ContainSubstring(expectedPrefixRewrite))
}
})
})
It("should set stats_config in gateway-proxy-envoy-config from gatewayProxies.gatewayProxy.envoyStatsConfig", func() {
prepareMakefile(namespace, glootestutils.HelmValues{
ValuesArgs: []string{
"gatewayProxies.gatewayProxy.envoyStatsConfig.stats_tags[0].fixed_value=zero",
"gatewayProxies.gatewayProxy.envoyStatsConfig.stats_tags[0].tag_name=one",
},
})
resources := testManifest.SelectResources(func(resource *unstructured.Unstructured) bool {
return resource.GetKind() == "ConfigMap" && resource.GetName() == "gateway-proxy-envoy-config"
})
Expect(resources.NumResources()).To(Equal(1), "Should find only one gateway-proxy-envoy-config ConfigMap")
resources.ExpectAll(func(configMap *unstructured.Unstructured) {
configMapObject, err := kuberesource.ConvertUnstructured(configMap)
Expect(err).NotTo(HaveOccurred(), fmt.Sprintf("ConfigMap %+v should be able to convert from unstructured", configMap))
structuredConfigMap, ok := configMapObject.(*corev1.ConfigMap)
Expect(ok).To(BeTrue(), fmt.Sprintf("ConfigMap %+v should be able to cast to a structured config map", configMap))
expect := Expect(structuredConfigMap.Data["envoy.yaml"])
expect.To(ContainSubstring("stats_config:"))
expect.To(ContainSubstring("stats_tags:"))
expect.To(ContainSubstring("- fixed_value: zero"))
})
})
It("Should have 'pre-install' and 'pre-upgrade' hook if gateway.certGenJob.runOnUpdate is true", func() {
prepareMakefile(namespace, glootestutils.HelmValues{
ValuesArgs: []string{
"global.glooMtls.enabled=true",
"gateway.certGenJob.runOnUpdate=true",
},
})
testManifest.SelectResources(func(resource *unstructured.Unstructured) bool {
return resource.GetKind() == "Job"
}).ExpectAll(func(job *unstructured.Unstructured) {
jobObject, err := kuberesource.ConvertUnstructured(job)
Expect(err).NotTo(HaveOccurred(), fmt.Sprintf("Job %+v should be able to convert from unstructured", job))
structuredDeployment, ok := jobObject.(*batchv1.Job)
Expect(ok).To(BeTrue(), fmt.Sprintf("Job %+v should be able to cast to a structured job", job))
if structuredDeployment.GetName() == "gloo-mtls-certgen" {
for annotation_name, annotation_value := range structuredDeployment.GetAnnotations() {
if annotation_name == "helm.sh/hook" {
Expect(annotation_value).To(Equal("pre-install, pre-upgrade"))
}
}
}
})
})
It("Should have only 'pre-install' hook if gateway.certGenJob.runOnUpdate is false", func() {
prepareMakefile(namespace, glootestutils.HelmValues{
ValuesArgs: []string{
"global.glooMtls.enabled=true",
"gateway.certGenJob.runOnUpdate=false",
},
})
testManifest.SelectResources(func(resource *unstructured.Unstructured) bool {
return resource.GetKind() == "Job"
}).ExpectAll(func(job *unstructured.Unstructured) {
jobObject, err := kuberesource.ConvertUnstructured(job)
Expect(err).NotTo(HaveOccurred(), fmt.Sprintf("Job %+v should be able to convert from unstructured", job))
structuredDeployment, ok := jobObject.(*batchv1.Job)
Expect(ok).To(BeTrue(), fmt.Sprintf("Job %+v should be able to cast to a structured job", job))
if structuredDeployment.GetName() == "gloo-mtls-certgen" {
for annotation_name, annotation_value := range structuredDeployment.GetAnnotations() {
if annotation_name == "helm.sh/hook" {
Expect(annotation_value).To(Equal("pre-install"))
}
}
}
})
})
})
Context("gloo with linkerd settings", func() {
linkerdInjectionLabel := "linkerd.io/inject"
It("linkerd injection should always be disabled in job pod templates when linkerd is enabled", func() {
prepareMakefile(namespace, glootestutils.HelmValues{
ValuesArgs: []string{
"settings.linkerd=true",
},
})
testManifest.SelectResources(func(resource *unstructured.Unstructured) bool {
return resource.GetKind() == "Job"
}).ExpectAll(func(job *unstructured.Unstructured) {
jobObj, err := kuberesource.ConvertUnstructured(job)
Expect(err).NotTo(HaveOccurred(), fmt.Sprintf("Job %+v should be able to convert from unstructured", job))
structuredJob, ok := jobObj.(*batchv1.Job)
Expect(ok).To(BeTrue(), fmt.Sprintf("Job %+v should be able to cast to a structured job", job))
val, ok := structuredJob.Spec.Template.ObjectMeta.Annotations[linkerdInjectionLabel]
Expect(ok).To(BeTrue(), fmt.Sprintf("Job %s should contain an linkerd injection annotation", job.GetName()))
Expect(val).To(Equal("disabled"), fmt.Sprintf("Job %s should have an linkerd injection annotation with value of 'disabled'", job.GetName()))
})
})
})