-
Notifications
You must be signed in to change notification settings - Fork 14
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(konnect): support Secrets in KonnectAPIAuthConfiguration
- Loading branch information
Showing
7 changed files
with
366 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| kind: KonnectAPIAuthConfiguration | ||
| apiVersion: konnect.konghq.com/v1alpha1 | ||
| metadata: | ||
| name: konnect-api-auth-1 | ||
| namespace: default | ||
| spec: | ||
| type: token | ||
| token: kpat_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx | ||
| serverURL: eu.api.konghq.com | ||
| --- | ||
| kind: KonnectAPIAuthConfiguration | ||
| apiVersion: konnect.konghq.com/v1alpha1 | ||
| metadata: | ||
| name: konnect-api-auth-2 | ||
| namespace: default | ||
| spec: | ||
| type: secretRef | ||
| secretRef: | ||
| name: konnect-api-auth-secret | ||
| serverURL: eu.api.konghq.com | ||
| --- | ||
| kind: Secret | ||
| apiVersion: v1 | ||
| metadata: | ||
| name: konnect-api-auth-secret | ||
| namespace: default | ||
| labels: | ||
| konghq.com/credential: konnect | ||
| stringData: | ||
| token: kpat_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,161 @@ | ||
| package konnect | ||
|
|
||
| import ( | ||
| "context" | ||
| "testing" | ||
|
|
||
| "github.com/stretchr/testify/assert" | ||
| corev1 "k8s.io/api/core/v1" | ||
| metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" | ||
| "sigs.k8s.io/controller-runtime/pkg/client/fake" | ||
|
|
||
| konnectv1alpha1 "github.com/kong/kubernetes-configuration/api/konnect/v1alpha1" | ||
| ) | ||
|
|
||
| func TestGetTokenFromKonnectAPIAuthConfiguration(t *testing.T) { | ||
| tests := []struct { | ||
| name string | ||
| apiAuth *konnectv1alpha1.KonnectAPIAuthConfiguration | ||
| secret *corev1.Secret | ||
| expectedToken string | ||
| expectedError bool | ||
| }{ | ||
| { | ||
| name: "valid Token", | ||
| apiAuth: &konnectv1alpha1.KonnectAPIAuthConfiguration{ | ||
| ObjectMeta: metav1.ObjectMeta{ | ||
| Name: "test-api-auth", | ||
| Namespace: "default", | ||
| }, | ||
| Spec: konnectv1alpha1.KonnectAPIAuthConfigurationSpec{ | ||
| Type: konnectv1alpha1.KonnectAPIAuthTypeToken, | ||
| Token: "kpat_xxxxxxxxxxxx", | ||
| }, | ||
| }, | ||
| expectedToken: "kpat_xxxxxxxxxxxx", | ||
| }, | ||
| { | ||
| name: "valid Secret Reference", | ||
| apiAuth: &konnectv1alpha1.KonnectAPIAuthConfiguration{ | ||
| ObjectMeta: metav1.ObjectMeta{ | ||
| Name: "test-api-auth", | ||
| Namespace: "default", | ||
| }, | ||
| Spec: konnectv1alpha1.KonnectAPIAuthConfigurationSpec{ | ||
| Type: konnectv1alpha1.KonnectAPIAuthTypeSecretRef, | ||
| SecretRef: &corev1.SecretReference{ | ||
| Name: "test-secret", | ||
| Namespace: "default", | ||
| }, | ||
| }, | ||
| }, | ||
| secret: &corev1.Secret{ | ||
| ObjectMeta: metav1.ObjectMeta{ | ||
| Name: "test-secret", | ||
| Namespace: "default", | ||
| Labels: map[string]string{ | ||
| "konghq.com/credential": "konnect", | ||
| }, | ||
| }, | ||
| Data: map[string][]byte{ | ||
| "token": []byte("test-token"), | ||
| }, | ||
| }, | ||
| expectedToken: "test-token", | ||
| }, | ||
| { | ||
| name: "Secret is missing konghq.com/credential=konnect label", | ||
| apiAuth: &konnectv1alpha1.KonnectAPIAuthConfiguration{ | ||
| ObjectMeta: metav1.ObjectMeta{ | ||
| Name: "test-api-auth", | ||
| Namespace: "default", | ||
| }, | ||
| Spec: konnectv1alpha1.KonnectAPIAuthConfigurationSpec{ | ||
| Type: konnectv1alpha1.KonnectAPIAuthTypeSecretRef, | ||
| SecretRef: &corev1.SecretReference{ | ||
| Name: "test-secret", | ||
| Namespace: "default", | ||
| }, | ||
| }, | ||
| }, | ||
| secret: &corev1.Secret{ | ||
| ObjectMeta: metav1.ObjectMeta{ | ||
| Name: "test-secret", | ||
| Namespace: "default", | ||
| }, | ||
| Data: map[string][]byte{ | ||
| "token": []byte("test-token"), | ||
| }, | ||
| }, | ||
| expectedError: true, | ||
| }, | ||
| { | ||
| name: "missing token from referred Secret", | ||
| apiAuth: &konnectv1alpha1.KonnectAPIAuthConfiguration{ | ||
| ObjectMeta: metav1.ObjectMeta{ | ||
| Name: "test-api-auth", | ||
| Namespace: "default", | ||
| }, | ||
| Spec: konnectv1alpha1.KonnectAPIAuthConfigurationSpec{ | ||
| Type: konnectv1alpha1.KonnectAPIAuthTypeSecretRef, | ||
| SecretRef: &corev1.SecretReference{ | ||
| Name: "test-secret", | ||
| Namespace: "default", | ||
| }, | ||
| }, | ||
| }, | ||
| secret: &corev1.Secret{ | ||
| ObjectMeta: metav1.ObjectMeta{ | ||
| Name: "test-secret", | ||
| Namespace: "default", | ||
| Labels: map[string]string{ | ||
| "konghq.com/credential": "konnect", | ||
| }, | ||
| }, | ||
| Data: map[string][]byte{ | ||
| "random_key": []byte("dummy"), | ||
| }, | ||
| }, | ||
| expectedToken: "test-token", | ||
| expectedError: true, | ||
| }, | ||
| { | ||
| name: "Invalid Secret Reference", | ||
| apiAuth: &konnectv1alpha1.KonnectAPIAuthConfiguration{ | ||
| ObjectMeta: metav1.ObjectMeta{ | ||
| Name: "test-api-auth", | ||
| Namespace: "default", | ||
| }, | ||
| Spec: konnectv1alpha1.KonnectAPIAuthConfigurationSpec{ | ||
| Type: konnectv1alpha1.KonnectAPIAuthTypeSecretRef, | ||
| SecretRef: &corev1.SecretReference{ | ||
| Name: "non-existent-secret", | ||
| Namespace: "default", | ||
| }, | ||
| }, | ||
| }, | ||
| expectedError: true, | ||
| }, | ||
| } | ||
|
|
||
| for _, tt := range tests { | ||
| t.Run(tt.name, func(t *testing.T) { | ||
| clientBuilder := fake.NewClientBuilder() | ||
|
|
||
| // Create the secret in the fake client | ||
| if tt.secret != nil { | ||
| clientBuilder.WithObjects(tt.secret) | ||
| } | ||
| cl := clientBuilder.Build() | ||
|
|
||
| // Call the function under test | ||
| token, err := getTokenFromKonnectAPIAuthConfiguration(context.Background(), cl, tt.apiAuth) | ||
| if tt.expectedError { | ||
| assert.NotNil(t, err) | ||
| return | ||
| } | ||
|
|
||
| assert.Equal(t, tt.expectedToken, token) | ||
| }) | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,73 @@ | ||
| package konnect | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "reflect" | ||
|
|
||
| corev1 "k8s.io/api/core/v1" | ||
| "k8s.io/apimachinery/pkg/types" | ||
| "sigs.k8s.io/controller-runtime/pkg/client" | ||
| "sigs.k8s.io/controller-runtime/pkg/log" | ||
| "sigs.k8s.io/controller-runtime/pkg/reconcile" | ||
|
|
||
| operatorerrors "github.com/kong/gateway-operator/internal/errors" | ||
|
|
||
| konnectv1alpha1 "github.com/kong/kubernetes-configuration/api/konnect/v1alpha1" | ||
| ) | ||
|
|
||
| // listKonnectAPIAuthConfigurationsReferencingSecret returns a function that lists | ||
| // KonnectAPIAuthConfiguration resources that reference the given Secret. | ||
| // This function is intended to be used as a handler for the watch on Secrets. | ||
| // NOTE: The Secret has to have the konnect.konghq.com/credential=konnect set | ||
| // so that we can efficiently watch only the relevant Secrets' changes. | ||
| func listKonnectAPIAuthConfigurationsReferencingSecret(cl client.Client) func(ctx context.Context, obj client.Object) []reconcile.Request { | ||
| return func(ctx context.Context, obj client.Object) []reconcile.Request { | ||
| logger := log.FromContext(ctx) | ||
|
|
||
| secret, ok := obj.(*corev1.Secret) | ||
| if !ok { | ||
| logger.Error( | ||
| operatorerrors.ErrUnexpectedObject, | ||
| "failed to run map funcs", | ||
| "expected", "Secret", "found", reflect.TypeOf(obj), | ||
| ) | ||
| return nil | ||
| } | ||
|
|
||
| var konnectAPIAuthConfigList konnectv1alpha1.KonnectAPIAuthConfigurationList | ||
| if err := cl.List(ctx, &konnectAPIAuthConfigList); err != nil { | ||
| log.FromContext(ctx).Error( | ||
| fmt.Errorf("unexpected error occurred while listing KonnectAPIAuthConfiguration resources"), | ||
| "failed to run map funcs", | ||
| "error", err.Error(), | ||
| ) | ||
| return nil | ||
| } | ||
|
|
||
| var recs []reconcile.Request | ||
| for _, apiAuth := range konnectAPIAuthConfigList.Items { | ||
| if apiAuth.Spec.Type != konnectv1alpha1.KonnectAPIAuthTypeSecretRef { | ||
| continue | ||
| } | ||
|
|
||
| if apiAuth.Spec.SecretRef == nil || | ||
| apiAuth.Spec.SecretRef.Name != secret.Name { | ||
| continue | ||
| } | ||
|
|
||
| if (apiAuth.Spec.SecretRef.Namespace != "" && apiAuth.Spec.SecretRef.Namespace != secret.Namespace) || | ||
| (apiAuth.Spec.SecretRef.Namespace == "" && secret.Namespace != apiAuth.Namespace) { | ||
| continue | ||
| } | ||
|
|
||
| recs = append(recs, reconcile.Request{ | ||
| NamespacedName: types.NamespacedName{ | ||
| Namespace: apiAuth.Namespace, | ||
| Name: apiAuth.Name, | ||
| }, | ||
| }) | ||
| } | ||
| return recs | ||
| } | ||
| } |
Oops, something went wrong.