// Copyright 2020 the Pinniped contributors. All Rights Reserved. // SPDX-License-Identifier: Apache-2.0 package issuerconfig import ( "context" "errors" "testing" "time" "github.com/sclevine/spec" "github.com/sclevine/spec/report" "github.com/stretchr/testify/require" corev1 "k8s.io/api/core/v1" metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" "k8s.io/apimachinery/pkg/runtime" "k8s.io/apimachinery/pkg/runtime/schema" kubeinformers "k8s.io/client-go/informers" kubernetesfake "k8s.io/client-go/kubernetes/fake" coretesting "k8s.io/client-go/testing" configv1alpha1 "go.pinniped.dev/generated/1.19/apis/config/v1alpha1" pinnipedfake "go.pinniped.dev/generated/1.19/client/clientset/versioned/fake" pinnipedinformers "go.pinniped.dev/generated/1.19/client/informers/externalversions" "go.pinniped.dev/internal/controllerlib" "go.pinniped.dev/internal/here" "go.pinniped.dev/internal/testutil" ) func TestInformerFilters(t *testing.T) { spec.Run(t, "informer filters", func(t *testing.T, when spec.G, it spec.S) { const installedInNamespace = "some-namespace" var r *require.Assertions var observableWithInformerOption *testutil.ObservableWithInformerOption var configMapInformerFilter controllerlib.Filter var credentialIssuerConfigInformerFilter controllerlib.Filter it.Before(func() { r = require.New(t) observableWithInformerOption = testutil.NewObservableWithInformerOption() configMapInformer := kubeinformers.NewSharedInformerFactory(nil, 0).Core().V1().ConfigMaps() credentialIssuerConfigInformer := pinnipedinformers.NewSharedInformerFactory(nil, 0).Config().V1alpha1().CredentialIssuerConfigs() _ = NewPublisherController( installedInNamespace, nil, nil, configMapInformer, credentialIssuerConfigInformer, observableWithInformerOption.WithInformer, // make it possible to observe the behavior of the Filters ) configMapInformerFilter = observableWithInformerOption.GetFilterForInformer(configMapInformer) credentialIssuerConfigInformerFilter = observableWithInformerOption.GetFilterForInformer(credentialIssuerConfigInformer) }) when("watching ConfigMap objects", func() { var subject controllerlib.Filter var target, wrongNamespace, wrongName, unrelated *corev1.ConfigMap it.Before(func() { subject = configMapInformerFilter target = &corev1.ConfigMap{ObjectMeta: metav1.ObjectMeta{Name: "cluster-info", Namespace: "kube-public"}} wrongNamespace = &corev1.ConfigMap{ObjectMeta: metav1.ObjectMeta{Name: "cluster-info", Namespace: "wrong-namespace"}} wrongName = &corev1.ConfigMap{ObjectMeta: metav1.ObjectMeta{Name: "wrong-name", Namespace: "kube-public"}} unrelated = &corev1.ConfigMap{ObjectMeta: metav1.ObjectMeta{Name: "wrong-name", Namespace: "wrong-namespace"}} }) when("the target ConfigMap changes", func() { it("returns true to trigger the sync method", func() { r.True(subject.Add(target)) r.True(subject.Update(target, unrelated)) r.True(subject.Update(unrelated, target)) r.True(subject.Delete(target)) }) }) when("a ConfigMap from another namespace changes", func() { it("returns false to avoid triggering the sync method", func() { r.False(subject.Add(wrongNamespace)) r.False(subject.Update(wrongNamespace, unrelated)) r.False(subject.Update(unrelated, wrongNamespace)) r.False(subject.Delete(wrongNamespace)) }) }) when("a ConfigMap with a different name changes", func() { it("returns false to avoid triggering the sync method", func() { r.False(subject.Add(wrongName)) r.False(subject.Update(wrongName, unrelated)) r.False(subject.Update(unrelated, wrongName)) r.False(subject.Delete(wrongName)) }) }) when("a ConfigMap with a different name and a different namespace changes", func() { it("returns false to avoid triggering the sync method", func() { r.False(subject.Add(unrelated)) r.False(subject.Update(unrelated, unrelated)) r.False(subject.Delete(unrelated)) }) }) }) when("watching CredentialIssuerConfig objects", func() { var subject controllerlib.Filter var target, wrongNamespace, wrongName, unrelated *configv1alpha1.CredentialIssuerConfig it.Before(func() { subject = credentialIssuerConfigInformerFilter target = &configv1alpha1.CredentialIssuerConfig{ ObjectMeta: metav1.ObjectMeta{Name: "pinniped-config", Namespace: installedInNamespace}, } wrongNamespace = &configv1alpha1.CredentialIssuerConfig{ ObjectMeta: metav1.ObjectMeta{Name: "pinniped-config", Namespace: "wrong-namespace"}, } wrongName = &configv1alpha1.CredentialIssuerConfig{ ObjectMeta: metav1.ObjectMeta{Name: "wrong-name", Namespace: installedInNamespace}, } unrelated = &configv1alpha1.CredentialIssuerConfig{ ObjectMeta: metav1.ObjectMeta{Name: "wrong-name", Namespace: "wrong-namespace"}, } }) when("the target CredentialIssuerConfig changes", func() { it("returns true to trigger the sync method", func() { r.True(subject.Add(target)) r.True(subject.Update(target, unrelated)) r.True(subject.Update(unrelated, target)) r.True(subject.Delete(target)) }) }) when("a CredentialIssuerConfig from another namespace changes", func() { it("returns false to avoid triggering the sync method", func() { r.False(subject.Add(wrongNamespace)) r.False(subject.Update(wrongNamespace, unrelated)) r.False(subject.Update(unrelated, wrongNamespace)) r.False(subject.Delete(wrongNamespace)) }) }) when("a CredentialIssuerConfig with a different name changes", func() { it("returns false to avoid triggering the sync method", func() { r.False(subject.Add(wrongName)) r.False(subject.Update(wrongName, unrelated)) r.False(subject.Update(unrelated, wrongName)) r.False(subject.Delete(wrongName)) }) }) when("a CredentialIssuerConfig with a different name and a different namespace changes", func() { it("returns false to avoid triggering the sync method", func() { r.False(subject.Add(unrelated)) r.False(subject.Update(unrelated, unrelated)) r.False(subject.Delete(unrelated)) }) }) }) }, spec.Parallel(), spec.Report(report.Terminal{})) } func TestSync(t *testing.T) { spec.Run(t, "Sync", func(t *testing.T, when spec.G, it spec.S) { const installedInNamespace = "some-namespace" var r *require.Assertions var subject controllerlib.Controller var serverOverride *string var kubeInformerClient *kubernetesfake.Clientset var pinnipedInformerClient *pinnipedfake.Clientset var kubeInformers kubeinformers.SharedInformerFactory var pinnipedInformers pinnipedinformers.SharedInformerFactory var pinnipedAPIClient *pinnipedfake.Clientset var timeoutContext context.Context var timeoutContextCancel context.CancelFunc var syncContext *controllerlib.Context var expectedCredentialIssuerConfig = func(expectedNamespace, expectedServerURL, expectedCAData string) (schema.GroupVersionResource, *configv1alpha1.CredentialIssuerConfig) { expectedCredentialIssuerConfigGVR := schema.GroupVersionResource{ Group: configv1alpha1.GroupName, Version: "v1alpha1", Resource: "credentialissuerconfigs", } expectedCredentialIssuerConfig := &configv1alpha1.CredentialIssuerConfig{ ObjectMeta: metav1.ObjectMeta{ Name: "pinniped-config", Namespace: expectedNamespace, }, Status: configv1alpha1.CredentialIssuerConfigStatus{ Strategies: []configv1alpha1.CredentialIssuerConfigStrategy{}, KubeConfigInfo: &configv1alpha1.CredentialIssuerConfigKubeConfigInfo{ Server: expectedServerURL, CertificateAuthorityData: expectedCAData, }, }, } return expectedCredentialIssuerConfigGVR, expectedCredentialIssuerConfig } // Defer starting the informers until the last possible moment so that the // nested Before's can keep adding things to the informer caches. var startInformersAndController = func() { // Set this at the last second to allow for injection of server override. subject = NewPublisherController( installedInNamespace, serverOverride, pinnipedAPIClient, kubeInformers.Core().V1().ConfigMaps(), pinnipedInformers.Config().V1alpha1().CredentialIssuerConfigs(), controllerlib.WithInformer, ) // Set this at the last second to support calling subject.Name(). syncContext = &controllerlib.Context{ Context: timeoutContext, Name: subject.Name(), Key: controllerlib.Key{ Namespace: "kube-public", Name: "cluster-info", }, } // Must start informers before calling TestRunSynchronously() kubeInformers.Start(timeoutContext.Done()) pinnipedInformers.Start(timeoutContext.Done()) controllerlib.TestRunSynchronously(t, subject) } it.Before(func() { r = require.New(t) timeoutContext, timeoutContextCancel = context.WithTimeout(context.Background(), time.Second*3) kubeInformerClient = kubernetesfake.NewSimpleClientset() kubeInformers = kubeinformers.NewSharedInformerFactory(kubeInformerClient, 0) pinnipedAPIClient = pinnipedfake.NewSimpleClientset() pinnipedInformerClient = pinnipedfake.NewSimpleClientset() pinnipedInformers = pinnipedinformers.NewSharedInformerFactory(pinnipedInformerClient, 0) }) it.After(func() { timeoutContextCancel() }) when("there is a cluster-info ConfigMap in the kube-public namespace", func() { const caData = "c29tZS1jZXJ0aWZpY2F0ZS1hdXRob3JpdHktZGF0YQo=" // "some-certificate-authority-data" base64 encoded const kubeServerURL = "https://some-server" when("the ConfigMap has the expected `kubeconfig` top-level data key", func() { it.Before(func() { clusterInfoConfigMap := &corev1.ConfigMap{ ObjectMeta: metav1.ObjectMeta{Name: "cluster-info", Namespace: "kube-public"}, // Note that go fmt puts tabs in our file, which we must remove from our configmap yaml below. Data: map[string]string{ "kubeconfig": here.Docf(` kind: Config apiVersion: v1 clusters: - name: "" cluster: certificate-authority-data: "%s" server: "%s"`, caData, kubeServerURL), "uninteresting-key": "uninteresting-value", }, } err := kubeInformerClient.Tracker().Add(clusterInfoConfigMap) r.NoError(err) }) when("the CredentialIssuerConfig does not already exist", func() { it("creates a CredentialIssuerConfig", func() { startInformersAndController() err := controllerlib.TestSync(t, subject, *syncContext) r.NoError(err) expectedCredentialIssuerConfigGVR, expectedCredentialIssuerConfig := expectedCredentialIssuerConfig( installedInNamespace, kubeServerURL, caData, ) r.Equal( []coretesting.Action{ coretesting.NewCreateAction( expectedCredentialIssuerConfigGVR, installedInNamespace, expectedCredentialIssuerConfig, ), }, pinnipedAPIClient.Actions(), ) }) when("creating the CredentialIssuerConfig fails", func() { it.Before(func() { pinnipedAPIClient.PrependReactor( "create", "credentialissuerconfigs", func(_ coretesting.Action) (bool, runtime.Object, error) { return true, nil, errors.New("create failed") }, ) }) it("returns the create error", func() { startInformersAndController() err := controllerlib.TestSync(t, subject, *syncContext) r.EqualError(err, "could not create or update credentialissuerconfig: create failed: create failed") }) }) when("a server override is passed to the controller", func() { it("uses the server override field", func() { serverOverride = new(string) *serverOverride = "https://some-server-override" startInformersAndController() err := controllerlib.TestSync(t, subject, *syncContext) r.NoError(err) expectedCredentialIssuerConfigGVR, expectedCredentialIssuerConfig := expectedCredentialIssuerConfig( installedInNamespace, kubeServerURL, caData, ) expectedCredentialIssuerConfig.Status.KubeConfigInfo.Server = "https://some-server-override" r.Equal( []coretesting.Action{ coretesting.NewCreateAction( expectedCredentialIssuerConfigGVR, installedInNamespace, expectedCredentialIssuerConfig, ), }, pinnipedAPIClient.Actions(), ) }) }) }) when("the CredentialIssuerConfig already exists", func() { when("the CredentialIssuerConfig is already up to date according to the data in the ConfigMap", func() { it.Before(func() { _, expectedCredentialIssuerConfig := expectedCredentialIssuerConfig( installedInNamespace, kubeServerURL, caData, ) err := pinnipedInformerClient.Tracker().Add(expectedCredentialIssuerConfig) r.NoError(err) }) it("does not update the CredentialIssuerConfig to avoid unnecessary etcd writes/api calls", func() { startInformersAndController() err := controllerlib.TestSync(t, subject, *syncContext) r.NoError(err) r.Empty(pinnipedAPIClient.Actions()) }) }) when("the CredentialIssuerConfig is stale compared to the data in the ConfigMap", func() { it.Before(func() { _, expectedCredentialIssuerConfig := expectedCredentialIssuerConfig( installedInNamespace, kubeServerURL, caData, ) expectedCredentialIssuerConfig.Status.KubeConfigInfo.Server = "https://some-other-server" r.NoError(pinnipedInformerClient.Tracker().Add(expectedCredentialIssuerConfig)) r.NoError(pinnipedAPIClient.Tracker().Add(expectedCredentialIssuerConfig)) }) it("updates the existing CredentialIssuerConfig", func() { startInformersAndController() err := controllerlib.TestSync(t, subject, *syncContext) r.NoError(err) expectedCredentialIssuerConfigGVR, expectedCredentialIssuerConfig := expectedCredentialIssuerConfig( installedInNamespace, kubeServerURL, caData, ) expectedActions := []coretesting.Action{ coretesting.NewUpdateAction( expectedCredentialIssuerConfigGVR, installedInNamespace, expectedCredentialIssuerConfig, ), } r.Equal(expectedActions, pinnipedAPIClient.Actions()) }) when("updating the CredentialIssuerConfig fails", func() { it.Before(func() { pinnipedAPIClient.PrependReactor( "update", "credentialissuerconfigs", func(_ coretesting.Action) (bool, runtime.Object, error) { return true, nil, errors.New("update failed") }, ) }) it("returns the update error", func() { startInformersAndController() err := controllerlib.TestSync(t, subject, *syncContext) r.EqualError(err, "could not create or update credentialissuerconfig: update failed") }) }) }) }) }) when("the ConfigMap is missing the expected `kubeconfig` top-level data key", func() { it.Before(func() { clusterInfoConfigMap := &corev1.ConfigMap{ ObjectMeta: metav1.ObjectMeta{Name: "cluster-info", Namespace: "kube-public"}, Data: map[string]string{ "these are not the droids you're looking for": "uninteresting-value", }, } err := kubeInformerClient.Tracker().Add(clusterInfoConfigMap) r.NoError(err) }) it("keeps waiting for it to exist", func() { startInformersAndController() err := controllerlib.TestSync(t, subject, *syncContext) r.NoError(err) r.Empty(pinnipedAPIClient.Actions()) }) }) when("the ConfigMap does not have a valid kubeconfig", func() { it.Before(func() { clusterInfoConfigMap := &corev1.ConfigMap{ ObjectMeta: metav1.ObjectMeta{Name: "cluster-info", Namespace: "kube-public"}, Data: map[string]string{ "kubeconfig": "this is an invalid kubeconfig", }, } err := kubeInformerClient.Tracker().Add(clusterInfoConfigMap) r.NoError(err) }) it("keeps waiting for it to be properly formatted", func() { startInformersAndController() err := controllerlib.TestSync(t, subject, *syncContext) r.NoError(err) r.Empty(pinnipedAPIClient.Actions()) }) }) }) when("there is not a cluster-info ConfigMap in the kube-public namespace", func() { it.Before(func() { unrelatedConfigMap := &corev1.ConfigMap{ ObjectMeta: metav1.ObjectMeta{ Name: "oops this is not the cluster-info ConfigMap", Namespace: "kube-public", }, } err := kubeInformerClient.Tracker().Add(unrelatedConfigMap) r.NoError(err) }) it("keeps waiting for one", func() { startInformersAndController() err := controllerlib.TestSync(t, subject, *syncContext) r.NoError(err) r.Empty(pinnipedAPIClient.Actions()) }) }) }, spec.Parallel(), spec.Report(report.Terminal{})) }