|
| 1 | +//go:build integration_tests |
| 2 | +// +build integration_tests |
| 3 | + |
| 4 | +package integration |
| 5 | + |
| 6 | +import ( |
| 7 | + "fmt" |
| 8 | + "testing" |
| 9 | + "time" |
| 10 | + |
| 11 | + "github.com/stretchr/testify/assert" |
| 12 | + "github.com/stretchr/testify/require" |
| 13 | + corev1 "k8s.io/api/core/v1" |
| 14 | + v1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1" |
| 15 | + metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" |
| 16 | + "sigs.k8s.io/controller-runtime/pkg/client" |
| 17 | + |
| 18 | + "github.com/kong/kubernetes-ingress-controller/v2/internal/annotations" |
| 19 | + "github.com/kong/kubernetes-ingress-controller/v2/internal/dataplane" |
| 20 | + kongv1 "github.com/kong/kubernetes-ingress-controller/v2/pkg/apis/configuration/v1" |
| 21 | + "github.com/kong/kubernetes-ingress-controller/v2/pkg/clientset" |
| 22 | +) |
| 23 | + |
| 24 | +// TestTranslationFailures ensures that proper warning Kubernetes events are recorded in case of translation failures |
| 25 | +// encountered. |
| 26 | +func TestTranslationFailures(t *testing.T) { |
| 27 | + testCases := []struct { |
| 28 | + name string |
| 29 | + // translationFailureTrigger should create objects that trigger translation failure and return the objects |
| 30 | + // that we expect translation failure warning events to be created for. |
| 31 | + translationFailureTrigger func(t *testing.T, ns string) []client.Object |
| 32 | + }{ |
| 33 | + { |
| 34 | + name: "invalid CA secret", |
| 35 | + translationFailureTrigger: func(t *testing.T, ns string) []client.Object { |
| 36 | + createdSecret, err := env.Cluster().Client().CoreV1().Secrets(ns).Create(ctx, invalidCASecret(ns), metav1.CreateOptions{}) |
| 37 | + require.NoError(t, err) |
| 38 | + |
| 39 | + return []client.Object{createdSecret} |
| 40 | + }, |
| 41 | + }, |
| 42 | + { |
| 43 | + name: "invalid CA secret referred by a plugin", |
| 44 | + translationFailureTrigger: func(t *testing.T, ns string) []client.Object { |
| 45 | + createdSecret, err := env.Cluster().Client().CoreV1().Secrets(ns).Create(ctx, invalidCASecret(ns), metav1.CreateOptions{}) |
| 46 | + require.NoError(t, err) |
| 47 | + |
| 48 | + c, err := clientset.NewForConfig(env.Cluster().Config()) |
| 49 | + require.NoError(t, err) |
| 50 | + createdPlugin, err := c.ConfigurationV1().KongPlugins(ns).Create(ctx, pluginUsingInvalidCACert(ns), metav1.CreateOptions{}) |
| 51 | + require.NoError(t, err) |
| 52 | + |
| 53 | + // expect events for both: a faulty secret and a plugin referring it |
| 54 | + return []client.Object{createdSecret, createdPlugin} |
| 55 | + }, |
| 56 | + }, |
| 57 | + } |
| 58 | + |
| 59 | + for _, tt := range testCases { |
| 60 | + tt := tt |
| 61 | + t.Run(tt.name, func(t *testing.T) { |
| 62 | + t.Parallel() |
| 63 | + ns, cleaner := setup(t) |
| 64 | + defer func() { assert.NoError(t, cleaner.Cleanup(ctx)) }() |
| 65 | + |
| 66 | + expectedCausingObjects := tt.translationFailureTrigger(t, ns.GetName()) |
| 67 | + |
| 68 | + require.Eventually(t, func() bool { |
| 69 | + eventsForAllObjectsFound := true |
| 70 | + |
| 71 | + for _, expectedCausingObject := range expectedCausingObjects { |
| 72 | + events, err := env.Cluster().Client().CoreV1().Events(ns.GetName()).List(ctx, metav1.ListOptions{ |
| 73 | + FieldSelector: fmt.Sprintf( |
| 74 | + "reason=%s,type=%s,involvedObject.name=%s", |
| 75 | + dataplane.KongConfigurationTranslationFailedEventReason, |
| 76 | + corev1.EventTypeWarning, |
| 77 | + expectedCausingObject.GetName(), |
| 78 | + ), |
| 79 | + }) |
| 80 | + if err != nil { |
| 81 | + t.Logf("failed to list events: %s", err) |
| 82 | + eventsForAllObjectsFound = false |
| 83 | + } |
| 84 | + |
| 85 | + if len(events.Items) == 0 { |
| 86 | + t.Logf("waiting for events related to '%s' to be created", expectedCausingObject.GetName()) |
| 87 | + eventsForAllObjectsFound = false |
| 88 | + } |
| 89 | + } |
| 90 | + |
| 91 | + return eventsForAllObjectsFound |
| 92 | + }, time.Minute*5, time.Second) |
| 93 | + }) |
| 94 | + } |
| 95 | +} |
| 96 | + |
| 97 | +const invalidCASecretID = "8214a145-a328-4c56-ab72-2973a56d4eae" //nolint:gosec |
| 98 | + |
| 99 | +func invalidCASecret(ns string) *corev1.Secret { |
| 100 | + return &corev1.Secret{ |
| 101 | + ObjectMeta: metav1.ObjectMeta{ |
| 102 | + GenerateName: "ca-secret-", |
| 103 | + Namespace: ns, |
| 104 | + Labels: map[string]string{ |
| 105 | + "konghq.com/ca-cert": "true", |
| 106 | + }, |
| 107 | + Annotations: map[string]string{ |
| 108 | + annotations.IngressClassKey: ingressClass, |
| 109 | + }, |
| 110 | + }, |
| 111 | + Data: map[string][]byte{ |
| 112 | + "id": []byte(invalidCASecretID), |
| 113 | + // missing cert key |
| 114 | + }, |
| 115 | + } |
| 116 | +} |
| 117 | + |
| 118 | +func pluginUsingInvalidCACert(ns string) *kongv1.KongPlugin { |
| 119 | + return &kongv1.KongPlugin{ |
| 120 | + ObjectMeta: metav1.ObjectMeta{ |
| 121 | + GenerateName: "kong-plugin-", |
| 122 | + Namespace: ns, |
| 123 | + Annotations: map[string]string{ |
| 124 | + annotations.IngressClassKey: ingressClass, |
| 125 | + }, |
| 126 | + }, |
| 127 | + Config: v1.JSON{Raw: []byte(fmt.Sprintf(`{"ca_certificates": ["%s"]}`, invalidCASecretID))}, |
| 128 | + PluginName: "mtls-auth", |
| 129 | + } |
| 130 | +} |
0 commit comments