helm-external-secrets/pkg/controllers/pushsecret/pushsecret_controller_test.go

/*
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

package pushsecret

import (
	"context"
	"errors"
	"fmt"
	"time"

	"github.com/go-logr/logr"
	. "github.com/onsi/ginkgo/v2"
	. "github.com/onsi/gomega"
	v1 "k8s.io/api/core/v1"
	"k8s.io/apimachinery/pkg/types"
	ctrl "sigs.k8s.io/controller-runtime"
	kubeclient "sigs.k8s.io/controller-runtime/pkg/client"

	esapi "github.com/external-secrets/external-secrets/apis/externalsecrets/v1alpha1"
	v1beta1 "github.com/external-secrets/external-secrets/apis/externalsecrets/v1beta1"
	"github.com/external-secrets/external-secrets/pkg/controllers/pushsecret/internal/fakes"
	"github.com/external-secrets/external-secrets/pkg/provider/testing/fake"
)

var fakeProvider *fake.Client

var _ = Describe("pushsecret", func() {
	var (
		reconciler *Reconciler
		client     *fakes.Client
		recorder   *fakes.FakeEventRecorder
	)
	BeforeEach(func() {
		client = new(fakes.Client)
		recorder = &fakes.FakeEventRecorder{}
		reconciler = &Reconciler{client, logr.Discard(), nil, recorder, 0, ""}
	})

	Describe("RefreshInterval", func() {
		var (
			statusWriter *fakes.StatusWriter
		)

		BeforeEach(func() {
			statusWriter = new(fakes.StatusWriter)
			client.StatusReturns(statusWriter)

		})

		It("Passes", func() {
			namspacedName := types.NamespacedName{Namespace: "foo", Name: "Bar"}
			refreshInt := time.Duration(5000)
			reconciler.RequeueInterval = refreshInt
			result, err := reconciler.Reconcile(context.Background(), ctrl.Request{NamespacedName: namspacedName})
			Expect(result).To(Equal(ctrl.Result{RequeueAfter: refreshInt}))
			Expect(err).NotTo(HaveOccurred())
		})
	})

	Describe("#Reconcile", func() {
		var (
			statusWriter *fakes.StatusWriter
		)

		BeforeEach(func() {
			statusWriter = new(fakes.StatusWriter)
			client.StatusReturns(statusWriter)
		})

		It("succeeds", func() {
			namspacedName := types.NamespacedName{Namespace: "foo", Name: "Bar"}
			result, err := reconciler.Reconcile(context.Background(), ctrl.Request{NamespacedName: namspacedName})
			Expect(result).To(Equal(ctrl.Result{RequeueAfter: 0, Requeue: false}))
			Expect(err).NotTo(HaveOccurred())
			Expect(client.GetCallCount()).To(Equal(2))
			Expect(client.StatusCallCount()).To(Equal(1))

			_, gotNamespacedName, _ := client.GetArgsForCall(0)
			Expect(gotNamespacedName).To(Equal(namspacedName))

			Expect(statusWriter.PatchCallCount()).To(Equal(1))
			_, _, patch, _ := statusWriter.PatchArgsForCall(0)
			Expect(patch.Type()).To(Equal(types.MergePatchType))
			Expect(recorder.EventCallCount()).To(Equal(1))
			_, _, reason, message := recorder.EventArgsForCall(0)
			Expect(reason).To(Equal(esapi.ReasonSynced))
			Expect(message).To(Equal("PushSecret synced successfully"))
		})

		When("an error returns in get", func() {
			BeforeEach(func() {
				client.GetReturns(errors.New("UnknownError"))
			})

			It("returns the error", func() {
				namspacedName := types.NamespacedName{Namespace: "foo", Name: "Bar"}
				_, err := reconciler.Reconcile(context.Background(), ctrl.Request{NamespacedName: namspacedName})

				Expect(err).To(MatchError("get resource: UnknownError"))
				Expect(client.GetCallCount()).To(Equal(1))
				Expect(client.StatusCallCount()).To(Equal(0))
				_, _, reason, message := recorder.EventArgsForCall(0)
				Expect(reason).To(Equal(esapi.ReasonErrored))
				Expect(message).To(Equal("unable to get PushSecret"))
			})
		})
		When("an error returns in get secret", func() {
			BeforeEach(func() {
				client.GetStub = func(context context.Context, name types.NamespacedName, obj kubeclient.Object) error {
					switch obj.(type) {
					case *v1.Secret:
						return fmt.Errorf("GetSecretError")
					default:
						return nil
					}
				}
			})

			It("returns the error", func() {
				namspacedName := types.NamespacedName{Namespace: "foo", Name: "Bar"}
				_, err := reconciler.Reconcile(context.Background(), ctrl.Request{NamespacedName: namspacedName})

				Expect(err).To(MatchError("GetSecretError"))
				_, _, reason, message := recorder.EventArgsForCall(0)
				Expect(reason).To(Equal(esapi.ReasonErrored))
				Expect(message).To(Equal(errFailedGetSecret))
			})
		})

		When("an error returns in get secret store", func() {
			BeforeEach(func() {
				client.GetStub = func(context context.Context, name types.NamespacedName, obj kubeclient.Object) error {
					switch v := obj.(type) {
					case *esapi.PushSecret:
						v.Spec.SecretStoreRefs = []esapi.PushSecretStoreRef{
							{Name: "a", Kind: "secretstore"},
						}
					}
					switch obj.(type) {
					case *v1beta1.SecretStore:
						return fmt.Errorf("BORK")
					default:
						return nil
					}

				}
			})

			It("returns the error", func() {
				namspacedName := types.NamespacedName{Namespace: "foo", Name: "Bar"}
				_, err := reconciler.Reconcile(context.Background(), ctrl.Request{NamespacedName: namspacedName})

				Expect(err).To(MatchError("could not get SecretStore \"a\", BORK"))
				_, _, reason, message := recorder.EventArgsForCall(0)
				Expect(reason).To(Equal(esapi.ReasonErrored))
				Expect(message).To(Equal("could not get SecretStore \"a\", BORK"))
			})
		})

		When("an error returns in set secret to providers", func() {
			BeforeEach(func() {
				client.GetStub = func(context context.Context, name types.NamespacedName, obj kubeclient.Object) error {
					switch v := obj.(type) {
					case *esapi.PushSecret:
						v.Spec.SecretStoreRefs = []esapi.PushSecretStoreRef{
							{Name: "a", Kind: "secretstore"},
						}
					case *v1beta1.SecretStore:
						v.Kind = "PotatoStore"
					}
					switch obj.(type) {
					default:
						return nil
					}

				}
			})

			It("returns the error", func() {
				namspacedName := types.NamespacedName{Namespace: "foo", Name: "Bar"}
				_, err := reconciler.Reconcile(context.Background(), ctrl.Request{NamespacedName: namspacedName})

				Expect(err).To(MatchError("could not start provider"))
				_, _, reason, message := recorder.EventArgsForCall(0)
				Expect(reason).To(Equal(esapi.ReasonErrored))
				Expect(message).To(Equal("set secret failed: could not start provider"))
			})
		})

		When("an object is not found", func() {
			BeforeEach(func() {
				client.GetReturns(statusErrorNotFound{})
			})

			It("returns an empty result without error", func() {
				namspacedName := types.NamespacedName{Namespace: "foo", Name: "Bar"}
				_, err := reconciler.Reconcile(context.Background(), ctrl.Request{NamespacedName: namspacedName})

				Expect(err).NotTo(HaveOccurred())
			})
		})
	})

	Describe("#GetPushSecretCondition", func() {
		It("returns nil for empty secret sink status", func() {
			pushSecretStatus := new(esapi.PushSecretStatus)
			pushSecretConditionType := new(esapi.PushSecretConditionType)

			Expect(GetPushSecretCondition(*pushSecretStatus, *pushSecretConditionType)).To(BeNil())
		})

		It("returns correct condition for secret sink status", func() {
			pushSecretStatusCondition := esapi.PushSecretStatusCondition{Type: esapi.PushSecretReady}
			pushSecretStatus := esapi.PushSecretStatus{Conditions: []esapi.PushSecretStatusCondition{pushSecretStatusCondition}}
			pushSecretConditionType := esapi.PushSecretReady

			Expect(GetPushSecretCondition(pushSecretStatus, pushSecretConditionType)).To(Equal(&pushSecretStatusCondition))
		})
	})

	Describe("#SetPushSecretCondition", func() {
		It("appends a condition", func() {
			pushSecret := esapi.PushSecret{}

			pushSecretStatusCondition := esapi.PushSecretStatusCondition{}
			pushSecretStatus := esapi.PushSecretStatus{Conditions: []esapi.PushSecretStatusCondition{pushSecretStatusCondition}}
			expected := esapi.PushSecret{Status: pushSecretStatus}
			Expect(SetPushSecretCondition(pushSecret, pushSecretStatusCondition)).To(Equal(expected))
		})

		It("changes an existing condition", func() {
			conditionStatusTrue := v1.ConditionTrue
			pushSecretWithCondition := esapi.PushSecret{Status: esapi.PushSecretStatus{Conditions: []esapi.PushSecretStatusCondition{
				{
					Status: conditionStatusTrue,
					Type:   esapi.PushSecretReady,
				},
			}},
			}
			pushSecretStatusConditionTrue := esapi.PushSecretStatusCondition{Status: conditionStatusTrue,
				Type:    esapi.PushSecretReady,
				Message: "Update status",
			}

			got := SetPushSecretCondition(pushSecretWithCondition, pushSecretStatusConditionTrue)
			Expect(len(got.Status.Conditions)).To(Equal(1))
			Expect(got.Status.Conditions[0]).To(Equal(pushSecretStatusConditionTrue))
		})
	})
	Describe("#GetSecret", func() {
		It("returns a secret if it exists", func() {
			sink := esapi.PushSecret{
				Spec: esapi.PushSecretSpec{
					Selector: esapi.PushSecretSelector{
						Secret: esapi.PushSecretSecret{
							Name: "foo",
						},
					},
				},
			}
			sink.Namespace = "foobar"
			_, err := reconciler.GetSecret(context.TODO(), sink)
			Expect(err).To(BeNil())
			_, name, _ := client.GetArgsForCall(0)
			Expect(name.Namespace).To(Equal("foobar"))
			Expect(name.Name).To(Equal("foo"))

		})

		It("returns an error if it doesn't exist", func() {
			client.GetReturns(errors.New("secret not found"))
			_, err := reconciler.GetSecret(context.TODO(), esapi.PushSecret{})
			Expect(err).To(HaveOccurred())
		})
	})

	Describe("#GetSecretStore", func() {
		sink := esapi.PushSecret{
			Spec: esapi.PushSecretSpec{
				SecretStoreRefs: []esapi.PushSecretStoreRef{
					{
						Name: "foo",
					},
				},
			},
		}
		sink.Namespace = "bar"

		clusterSink := esapi.PushSecret{
			Spec: esapi.PushSecretSpec{
				SecretStoreRefs: []esapi.PushSecretStoreRef{
					{
						Name: "foo",
						Kind: "ClusterSecretStore",
					},
				},
			},
		}

		It("returns a secretstore if it exists", func() {
			_, err := reconciler.GetSecretStores(context.TODO(), sink)
			Expect(err).To(BeNil())
			Expect(client.GetCallCount()).To(Equal(1))
			_, name, store := client.GetArgsForCall(0)
			Expect(name.Namespace).To(Equal("bar"))
			Expect(name.Name).To(Equal("foo"))
			Expect(store).To(BeAssignableToTypeOf(&v1beta1.SecretStore{}))
		})

		It("returns an error if it doesn't exist", func() {
			client.GetReturns(errors.New("secretstore not found"))
			_, err := reconciler.GetSecretStores(context.TODO(), sink)
			Expect(err).To(HaveOccurred())
		})

		It("returns a clustersecretstore if it exists", func() {
			_, err := reconciler.GetSecretStores(context.TODO(), clusterSink)
			Expect(err).To(BeNil())
			Expect(client.GetCallCount()).To(Equal(1))
			_, name, store := client.GetArgsForCall(0)
			Expect(store).To(BeAssignableToTypeOf(&v1beta1.ClusterSecretStore{}))
			Expect(name.Name).To(Equal("foo"))
		})
	})
	Describe("#SetSecretToProviders", func() {
		val := "supersecret"
		secret := &v1.Secret{
			Data: map[string][]byte{
				"foo": []byte(val),
			},
		}
		sink := esapi.PushSecret{
			Spec: esapi.PushSecretSpec{
				SecretStoreRefs: []esapi.PushSecretStoreRef{
					{
						Name: "foo",
					},
				},
				Data: []esapi.PushSecretData{
					{
						Match: []esapi.PushSecretMatch{
							{
								SecretKey: "foo",
								RemoteRefs: []esapi.PushSecretRemoteRefs{
									{
										RemoteKey: "bar",
									},
								},
							},
						},
					},
				},
			},
		}
		sink.Namespace = "bar"

		secretStore := v1beta1.SecretStore{}
		stores := make([]v1beta1.GenericStore, 0)
		stores = append(stores, &secretStore)

		It("gets the provider and client and then sets the secret", func() {

			Expect(reconciler.SetSecretToProviders(context.TODO(), []v1beta1.GenericStore{}, sink, secret)).To(BeNil())
		})

		It("returns an error if it can't get a provider", func() {
			err := reconciler.SetSecretToProviders(context.TODO(), stores, sink, secret)

			Expect(err).To(HaveOccurred())
			Expect(err.Error()).To(Equal(errGetProviderFailed))
		})

		It("returns an if it can't get a client", func() {
			specWithProvider := v1beta1.SecretStoreSpec{
				Provider: &v1beta1.SecretStoreProvider{
					Fake: &v1beta1.FakeProvider{},
				},
			}
			fakeProvider.WithNew(func(context.Context, v1beta1.GenericStore, kubeclient.Client,
				string) (v1beta1.SecretsClient, error) {
				return nil, fmt.Errorf("Something went wrong")
			})
			secretStore = v1beta1.SecretStore{
				Spec: specWithProvider,
			}

			stores[0] = &secretStore
			err := reconciler.SetSecretToProviders(context.TODO(), stores, sink, secret)

			Expect(err).To(HaveOccurred())
			Expect(err.Error()).To(Equal(errGetSecretsClientFailed))
		})
		It("returns an error if set secret fails", func() {
			specWithProvider := v1beta1.SecretStoreSpec{
				Provider: &v1beta1.SecretStoreProvider{
					Fake: &v1beta1.FakeProvider{},
				},
			}
			fakeProvider.Reset()
			fakeProvider.WithSetSecret(fmt.Errorf("something went wrong"))
			secretStore = v1beta1.SecretStore{
				Spec: specWithProvider,
			}

			stores[0] = &secretStore
			err := reconciler.SetSecretToProviders(context.TODO(), stores, sink, secret)

			Expect(err).To(HaveOccurred())
			Expect(err.Error()).To(Equal(fmt.Sprintf(errSetSecretFailed, "foo", "", "something went wrong")))
		})
	})

	// Secrets should not be updated when refreshInterval is not equals to zero
	// RequeueInterval shouldn't be updated if spec.refreshInterval is zero
	// Checking if requeue interval is zero does an error occur
	// requeue interval not zero
	//
	//Describe("#")
})

func init() {
	fakeProvider = fake.New()
	v1beta1.ForceRegister(fakeProvider, &v1beta1.SecretStoreProvider{
		Fake: &v1beta1.FakeProvider{},
	})
}