| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485 |
- /*
- 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 (
- "bytes"
- "context"
- "errors"
- "fmt"
- "os"
- "strconv"
- "time"
- v1 "k8s.io/api/core/v1"
- metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
- "k8s.io/apimachinery/pkg/types"
- "sigs.k8s.io/controller-runtime/pkg/client"
- esv1 "github.com/external-secrets/external-secrets/apis/externalsecrets/v1"
- "github.com/external-secrets/external-secrets/apis/externalsecrets/v1alpha1"
- genv1alpha1 "github.com/external-secrets/external-secrets/apis/generators/v1alpha1"
- ctest "github.com/external-secrets/external-secrets/pkg/controllers/commontest"
- "github.com/external-secrets/external-secrets/pkg/controllers/pushsecret/psmetrics"
- "github.com/external-secrets/external-secrets/pkg/provider/testing/fake"
- . "github.com/onsi/ginkgo/v2"
- . "github.com/onsi/gomega"
- )
- var (
- fakeProvider *fake.Client
- timeout = time.Second * 10
- interval = time.Millisecond * 250
- )
- type testCase struct {
- store esv1.GenericStore
- managedStore1 esv1.GenericStore
- managedStore2 esv1.GenericStore
- unmanagedStore1 esv1.GenericStore
- unmanagedStore2 esv1.GenericStore
- pushsecret *v1alpha1.PushSecret
- secret *v1.Secret
- assert func(pushsecret *v1alpha1.PushSecret, secret *v1.Secret) bool
- }
- func init() {
- fakeProvider = fake.New()
- esv1.ForceRegister(fakeProvider, &esv1.SecretStoreProvider{
- Fake: &esv1.FakeProvider{},
- }, esv1.MaintenanceStatusMaintained)
- psmetrics.SetUpMetrics()
- }
- func checkCondition(status v1alpha1.PushSecretStatus, cond v1alpha1.PushSecretStatusCondition) bool {
- fmt.Printf("status: %+v\ncond: %+v\n", status.Conditions, cond)
- for _, condition := range status.Conditions {
- if condition.Message == cond.Message &&
- condition.Reason == cond.Reason &&
- condition.Status == cond.Status &&
- condition.Type == cond.Type {
- return true
- }
- }
- return false
- }
- type testTweaks func(*testCase)
- var _ = Describe("PushSecret controller", func() {
- const (
- PushSecretName = "test-ps"
- PushSecretStore = "test-store"
- SecretName = "test-secret"
- )
- var PushSecretNamespace string
- // if we are in debug and need to increase the timeout for testing, we can do so by using an env var
- if customTimeout := os.Getenv("TEST_CUSTOM_TIMEOUT_SEC"); customTimeout != "" {
- if t, err := strconv.Atoi(customTimeout); err == nil {
- timeout = time.Second * time.Duration(t)
- }
- }
- BeforeEach(func() {
- var err error
- PushSecretNamespace, err = ctest.CreateNamespace("test-ns", k8sClient)
- Expect(err).ToNot(HaveOccurred())
- fakeProvider.Reset()
- Expect(k8sClient.Create(context.Background(), &genv1alpha1.Fake{
- TypeMeta: metav1.TypeMeta{
- Kind: "Fake",
- APIVersion: "generators.external-secrets.io/v1alpha1",
- },
- ObjectMeta: metav1.ObjectMeta{
- Name: "test",
- Namespace: PushSecretNamespace,
- },
- Spec: genv1alpha1.FakeSpec{
- Data: map[string]string{
- "key": "foo-bar-from-generator",
- },
- }})).ToNot(HaveOccurred())
- })
- AfterEach(func() {
- k8sClient.Delete(context.Background(), &v1alpha1.PushSecret{
- ObjectMeta: metav1.ObjectMeta{
- Name: PushSecretName,
- Namespace: PushSecretNamespace,
- },
- })
- // give a time for reconciler to remove finalizers before removing SecretStores
- time.Sleep(2 * time.Second)
- k8sClient.Delete(context.Background(), &esv1.SecretStore{
- ObjectMeta: metav1.ObjectMeta{
- Name: PushSecretStore,
- Namespace: PushSecretNamespace,
- },
- })
- k8sClient.Delete(context.Background(), &esv1.ClusterSecretStore{
- ObjectMeta: metav1.ObjectMeta{
- Name: PushSecretStore,
- },
- })
- k8sClient.Delete(context.Background(), &v1.Secret{
- ObjectMeta: metav1.ObjectMeta{
- Name: SecretName,
- Namespace: PushSecretNamespace,
- },
- })
- Expect(k8sClient.Delete(context.Background(), &v1.Namespace{
- ObjectMeta: metav1.ObjectMeta{
- Name: PushSecretNamespace,
- },
- })).To(Succeed())
- })
- const (
- defaultKey = "key"
- defaultVal = "value"
- defaultPath = "path/to/key"
- otherKey = "other-key"
- otherVal = "other-value"
- otherPath = "path/to/other-key"
- newKey = "new-key"
- newVal = "new-value"
- storePrefixTemplate = "SecretStore/%v"
- )
- makeDefaultTestcase := func() *testCase {
- return &testCase{
- pushsecret: &v1alpha1.PushSecret{
- ObjectMeta: metav1.ObjectMeta{
- Name: PushSecretName,
- Namespace: PushSecretNamespace,
- },
- Spec: v1alpha1.PushSecretSpec{
- SecretStoreRefs: []v1alpha1.PushSecretStoreRef{
- {
- Name: PushSecretStore,
- Kind: "SecretStore",
- },
- },
- Selector: v1alpha1.PushSecretSelector{
- Secret: &v1alpha1.PushSecretSecret{
- Name: SecretName,
- },
- },
- Data: []v1alpha1.PushSecretData{
- {
- Match: v1alpha1.PushSecretMatch{
- SecretKey: defaultKey,
- RemoteRef: v1alpha1.PushSecretRemoteRef{
- RemoteKey: defaultPath,
- },
- },
- },
- },
- },
- },
- secret: &v1.Secret{
- ObjectMeta: metav1.ObjectMeta{
- Name: SecretName,
- Namespace: PushSecretNamespace,
- },
- Data: map[string][]byte{
- defaultKey: []byte(defaultVal),
- },
- },
- store: &esv1.SecretStore{
- ObjectMeta: metav1.ObjectMeta{
- Name: PushSecretStore,
- Namespace: PushSecretNamespace,
- },
- TypeMeta: metav1.TypeMeta{
- Kind: "SecretStore",
- },
- Spec: esv1.SecretStoreSpec{
- Provider: &esv1.SecretStoreProvider{
- Fake: &esv1.FakeProvider{
- Data: []esv1.FakeProviderData{},
- },
- },
- },
- },
- }
- }
- // if target Secret name is not specified it should use the ExternalSecret name.
- syncSuccessfully := func(tc *testCase) {
- fakeProvider.SetSecretFn = func() error {
- return nil
- }
- tc.assert = func(ps *v1alpha1.PushSecret, secret *v1.Secret) bool {
- Eventually(func() bool {
- By("checking if Provider value got updated")
- secretValue := secret.Data[defaultKey]
- providerValue, ok := fakeProvider.SetSecretArgs[ps.Spec.Data[0].Match.RemoteRef.RemoteKey]
- if !ok {
- return false
- }
- got := providerValue.Value
- return bytes.Equal(got, secretValue)
- }, time.Second*10, time.Second).Should(BeTrue())
- return true
- }
- }
- updateIfNotExists := func(tc *testCase) {
- fakeProvider.SetSecretFn = func() error {
- return nil
- }
- fakeProvider.SecretExistsFn = func(ctx context.Context, ref esv1.PushSecretRemoteRef) (bool, error) {
- _, ok := fakeProvider.SetSecretArgs[ref.GetRemoteKey()]
- return ok, nil
- }
- tc.pushsecret.Spec.UpdatePolicy = v1alpha1.PushSecretUpdatePolicyIfNotExists
- initialValue := fakeProvider.SetSecretArgs[tc.pushsecret.Spec.Data[0].Match.RemoteRef.RemoteKey].Value
- tc.secret.Data[defaultKey] = []byte(newVal)
- tc.assert = func(ps *v1alpha1.PushSecret, secret *v1.Secret) bool {
- Eventually(func() bool {
- By("checking if Provider value did not get updated")
- Expect(k8sClient.Update(context.Background(), secret, &client.UpdateOptions{})).Should(Succeed())
- providerValue, ok := fakeProvider.SetSecretArgs[ps.Spec.Data[0].Match.RemoteRef.RemoteKey]
- if !ok {
- return false
- }
- got := providerValue.Value
- return bytes.Equal(got, initialValue)
- }, time.Second*10, time.Second).Should(BeTrue())
- return true
- }
- }
- updateIfNotExistsPartialSecrets := func(tc *testCase) {
- fakeProvider.SetSecretFn = func() error {
- return nil
- }
- fakeProvider.SecretExistsFn = func(ctx context.Context, ref esv1.PushSecretRemoteRef) (bool, error) {
- _, ok := fakeProvider.SetSecretArgs[ref.GetRemoteKey()]
- return ok, nil
- }
- tc.pushsecret.Spec.UpdatePolicy = v1alpha1.PushSecretUpdatePolicyIfNotExists
- tc.pushsecret.Spec.Data = append(tc.pushsecret.Spec.Data, v1alpha1.PushSecretData{
- Match: v1alpha1.PushSecretMatch{
- SecretKey: otherKey,
- RemoteRef: v1alpha1.PushSecretRemoteRef{
- RemoteKey: otherPath,
- },
- },
- })
- initialValue := fakeProvider.SetSecretArgs[tc.pushsecret.Spec.Data[0].Match.RemoteRef.RemoteKey].Value
- tc.secret.Data[defaultKey] = []byte(newVal) // change initial value in secret
- tc.secret.Data[otherKey] = []byte(otherVal)
- tc.assert = func(ps *v1alpha1.PushSecret, secret *v1.Secret) bool {
- Eventually(func() bool {
- By("checking if only not existing Provider value got updated")
- Expect(k8sClient.Update(context.Background(), secret, &client.UpdateOptions{})).Should(Succeed())
- providerValue, ok := fakeProvider.SetSecretArgs[ps.Spec.Data[0].Match.RemoteRef.RemoteKey]
- if !ok {
- return false
- }
- got := providerValue.Value
- otherProviderValue, ok := fakeProvider.SetSecretArgs[ps.Spec.Data[1].Match.RemoteRef.RemoteKey]
- if !ok {
- return false
- }
- gotOther := otherProviderValue.Value
- return bytes.Equal(gotOther, tc.secret.Data[otherKey]) && bytes.Equal(got, initialValue)
- }, time.Second*10, time.Second).Should(BeTrue())
- return true
- }
- }
- updateIfNotExistsSyncStatus := func(tc *testCase) {
- fakeProvider.SetSecretFn = func() error {
- return nil
- }
- fakeProvider.SecretExistsFn = func(ctx context.Context, ref esv1.PushSecretRemoteRef) (bool, error) {
- _, ok := fakeProvider.SetSecretArgs[ref.GetRemoteKey()]
- return ok, nil
- }
- tc.pushsecret.Spec.UpdatePolicy = v1alpha1.PushSecretUpdatePolicyIfNotExists
- tc.pushsecret.Spec.Data = append(tc.pushsecret.Spec.Data, v1alpha1.PushSecretData{
- Match: v1alpha1.PushSecretMatch{
- SecretKey: otherKey,
- RemoteRef: v1alpha1.PushSecretRemoteRef{
- RemoteKey: otherPath,
- },
- },
- })
- tc.secret.Data[defaultKey] = []byte(newVal)
- tc.secret.Data[otherKey] = []byte(otherVal)
- updatedPS := &v1alpha1.PushSecret{}
- tc.assert = func(ps *v1alpha1.PushSecret, secret *v1.Secret) bool {
- Eventually(func() bool {
- By("checking if PushSecret status gets updated correctly with UpdatePolicy=IfNotExists")
- Expect(k8sClient.Update(context.Background(), secret, &client.UpdateOptions{})).Should(Succeed())
- psKey := types.NamespacedName{Name: PushSecretName, Namespace: PushSecretNamespace}
- err := k8sClient.Get(context.Background(), psKey, updatedPS)
- if err != nil {
- return false
- }
- _, ok := updatedPS.Status.SyncedPushSecrets[fmt.Sprintf(storePrefixTemplate, PushSecretStore)][defaultPath]
- if !ok {
- return false
- }
- _, ok = updatedPS.Status.SyncedPushSecrets[fmt.Sprintf(storePrefixTemplate, PushSecretStore)][otherPath]
- if !ok {
- return false
- }
- expected := v1alpha1.PushSecretStatusCondition{
- Type: v1alpha1.PushSecretReady,
- Status: v1.ConditionTrue,
- Reason: v1alpha1.ReasonSynced,
- Message: "PushSecret synced successfully. Existing secrets in providers unchanged.",
- }
- return checkCondition(ps.Status, expected)
- }, time.Second*10, time.Second).Should(BeTrue())
- return true
- }
- }
- updateIfNotExistsSyncFailed := func(tc *testCase) {
- fakeProvider.SetSecretFn = func() error {
- return nil
- }
- fakeProvider.SecretExistsFn = func(ctx context.Context, ref esv1.PushSecretRemoteRef) (bool, error) {
- return false, errors.New("don't know")
- }
- tc.pushsecret.Spec.UpdatePolicy = v1alpha1.PushSecretUpdatePolicyIfNotExists
- initialValue := fakeProvider.SetSecretArgs[tc.pushsecret.Spec.Data[0].Match.RemoteRef.RemoteKey].Value
- tc.secret.Data[defaultKey] = []byte(newVal)
- tc.assert = func(ps *v1alpha1.PushSecret, secret *v1.Secret) bool {
- Eventually(func() bool {
- By("checking if sync failed if secret existence cannot be verified in Provider")
- providerValue, ok := fakeProvider.SetSecretArgs[ps.Spec.Data[0].Match.RemoteRef.RemoteKey]
- if !ok {
- return false
- }
- got := providerValue.Value
- expected := v1alpha1.PushSecretStatusCondition{
- Type: v1alpha1.PushSecretReady,
- Status: v1.ConditionFalse,
- Reason: v1alpha1.ReasonErrored,
- Message: "set secret failed: could not verify if secret exists in store: don't know",
- }
- return checkCondition(ps.Status, expected) && bytes.Equal(got, initialValue)
- }, time.Second*10, time.Second).Should(BeTrue())
- return true
- }
- }
- syncSuccessfullyReusingKeys := func(tc *testCase) {
- fakeProvider.SetSecretFn = func() error {
- return nil
- }
- tc.pushsecret = &v1alpha1.PushSecret{
- ObjectMeta: metav1.ObjectMeta{
- Name: PushSecretName,
- Namespace: PushSecretNamespace,
- },
- Spec: v1alpha1.PushSecretSpec{
- SecretStoreRefs: []v1alpha1.PushSecretStoreRef{
- {
- Name: PushSecretStore,
- Kind: "SecretStore",
- },
- },
- Selector: v1alpha1.PushSecretSelector{
- Secret: &v1alpha1.PushSecretSecret{
- Name: SecretName,
- },
- },
- Data: []v1alpha1.PushSecretData{
- {
- Match: v1alpha1.PushSecretMatch{
- SecretKey: "otherKey",
- RemoteRef: v1alpha1.PushSecretRemoteRef{
- RemoteKey: defaultPath,
- },
- },
- },
- },
- Template: &esv1.ExternalSecretTemplate{
- Metadata: esv1.ExternalSecretTemplateMetadata{
- Labels: map[string]string{
- "foos": "ball",
- },
- Annotations: map[string]string{
- "hihi": "ga",
- },
- },
- Type: v1.SecretTypeOpaque,
- EngineVersion: esv1.TemplateEngineV2,
- Data: map[string]string{
- defaultKey: "{{ .key | toString | upper }} was templated",
- "otherKey": "{{ .key | toString | upper }} was also templated",
- },
- },
- },
- }
- tc.assert = func(ps *v1alpha1.PushSecret, secret *v1.Secret) bool {
- Eventually(func() bool {
- By("checking if Provider value got updated")
- providerValue, ok := fakeProvider.SetSecretArgs[ps.Spec.Data[0].Match.RemoteRef.RemoteKey]
- if !ok {
- return false
- }
- got := providerValue.Value
- return bytes.Equal(got, []byte("VALUE was also templated"))
- }, time.Second*10, time.Second).Should(BeTrue())
- return true
- }
- }
- // if target Secret name is not specified it should use the ExternalSecret name.
- syncSuccessfullyWithTemplate := func(tc *testCase) {
- fakeProvider.SetSecretFn = func() error {
- return nil
- }
- tc.pushsecret = &v1alpha1.PushSecret{
- ObjectMeta: metav1.ObjectMeta{
- Name: PushSecretName,
- Namespace: PushSecretNamespace,
- },
- Spec: v1alpha1.PushSecretSpec{
- SecretStoreRefs: []v1alpha1.PushSecretStoreRef{
- {
- Name: PushSecretStore,
- Kind: "SecretStore",
- },
- },
- Selector: v1alpha1.PushSecretSelector{
- Secret: &v1alpha1.PushSecretSecret{
- Name: SecretName,
- },
- },
- Data: []v1alpha1.PushSecretData{
- {
- Match: v1alpha1.PushSecretMatch{
- SecretKey: defaultKey,
- RemoteRef: v1alpha1.PushSecretRemoteRef{
- RemoteKey: defaultPath,
- },
- },
- },
- },
- Template: &esv1.ExternalSecretTemplate{
- Metadata: esv1.ExternalSecretTemplateMetadata{
- Labels: map[string]string{
- "foos": "ball",
- },
- Annotations: map[string]string{
- "hihi": "ga",
- },
- },
- Type: v1.SecretTypeOpaque,
- EngineVersion: esv1.TemplateEngineV2,
- Data: map[string]string{
- defaultKey: "{{ .key | toString | upper }} was templated",
- },
- },
- },
- }
- tc.assert = func(ps *v1alpha1.PushSecret, secret *v1.Secret) bool {
- Eventually(func() bool {
- By("checking if Provider value got updated")
- providerValue, ok := fakeProvider.SetSecretArgs[ps.Spec.Data[0].Match.RemoteRef.RemoteKey]
- if !ok {
- return false
- }
- got := providerValue.Value
- return bytes.Equal(got, []byte("VALUE was templated"))
- }, time.Second*10, time.Second).Should(BeTrue())
- return true
- }
- }
- // if target Secret name is not specified it should use the ExternalSecret name.
- syncAndDeleteSuccessfully := func(tc *testCase) {
- fakeProvider.SetSecretFn = func() error {
- return nil
- }
- tc.pushsecret = &v1alpha1.PushSecret{
- ObjectMeta: metav1.ObjectMeta{
- Name: PushSecretName,
- Namespace: PushSecretNamespace,
- },
- Spec: v1alpha1.PushSecretSpec{
- DeletionPolicy: v1alpha1.PushSecretDeletionPolicyDelete,
- SecretStoreRefs: []v1alpha1.PushSecretStoreRef{
- {
- Name: PushSecretStore,
- Kind: "SecretStore",
- },
- },
- Selector: v1alpha1.PushSecretSelector{
- Secret: &v1alpha1.PushSecretSecret{
- Name: SecretName,
- },
- },
- Data: []v1alpha1.PushSecretData{
- {
- Match: v1alpha1.PushSecretMatch{
- SecretKey: defaultKey,
- RemoteRef: v1alpha1.PushSecretRemoteRef{
- RemoteKey: defaultPath,
- },
- },
- },
- },
- },
- }
- tc.assert = func(ps *v1alpha1.PushSecret, secret *v1.Secret) bool {
- ps.Spec.Data[0].Match.RemoteRef.RemoteKey = newKey
- updatedPS := &v1alpha1.PushSecret{}
- Expect(k8sClient.Update(context.Background(), ps, &client.UpdateOptions{})).Should(Succeed())
- Eventually(func() bool {
- psKey := types.NamespacedName{Name: PushSecretName, Namespace: PushSecretNamespace}
- By("checking if Provider value got updated")
- err := k8sClient.Get(context.Background(), psKey, updatedPS)
- if err != nil {
- return false
- }
- key, ok := updatedPS.Status.SyncedPushSecrets[fmt.Sprintf(storePrefixTemplate, PushSecretStore)][newKey]
- if !ok {
- return false
- }
- return key.Match.SecretKey == defaultKey
- }, time.Second*10, time.Second).Should(BeTrue())
- return true
- }
- }
- // if PushSecret's DeletionPolicy is cleared, it should delete successfully
- syncChangePolicyAndDeleteSuccessfully := func(tc *testCase) {
- fakeProvider.SetSecretFn = func() error {
- return nil
- }
- tc.pushsecret = &v1alpha1.PushSecret{
- ObjectMeta: metav1.ObjectMeta{
- Name: PushSecretName,
- Namespace: PushSecretNamespace,
- },
- Spec: v1alpha1.PushSecretSpec{
- DeletionPolicy: v1alpha1.PushSecretDeletionPolicyDelete,
- SecretStoreRefs: []v1alpha1.PushSecretStoreRef{
- {
- Name: PushSecretStore,
- Kind: "SecretStore",
- },
- },
- Selector: v1alpha1.PushSecretSelector{
- Secret: &v1alpha1.PushSecretSecret{
- Name: SecretName,
- },
- },
- Data: []v1alpha1.PushSecretData{
- {
- Match: v1alpha1.PushSecretMatch{
- SecretKey: defaultKey,
- RemoteRef: v1alpha1.PushSecretRemoteRef{
- RemoteKey: defaultPath,
- },
- },
- },
- },
- },
- }
- tc.assert = func(ps *v1alpha1.PushSecret, secret *v1.Secret) bool {
- ps.Spec.DeletionPolicy = v1alpha1.PushSecretDeletionPolicyNone
- updatedPS := &v1alpha1.PushSecret{}
- Expect(k8sClient.Update(context.Background(), ps, &client.UpdateOptions{})).Should(Succeed())
- Expect(k8sClient.Delete(context.Background(), ps, &client.DeleteOptions{})).Should(Succeed())
- Eventually(func() bool {
- psKey := types.NamespacedName{Name: PushSecretName, Namespace: PushSecretNamespace}
- By("checking if Get PushSecret returns not found")
- err := k8sClient.Get(context.Background(), psKey, updatedPS)
- if err != nil && client.IgnoreNotFound(err) == nil {
- return true
- }
- return false
- }, time.Second*10, time.Second).Should(BeTrue())
- return true
- }
- }
- failDelete := func(tc *testCase) {
- fakeProvider.SetSecretFn = func() error {
- return nil
- }
- fakeProvider.DeleteSecretFn = func() error {
- return errors.New("Nope")
- }
- tc.pushsecret = &v1alpha1.PushSecret{
- ObjectMeta: metav1.ObjectMeta{
- Name: PushSecretName,
- Namespace: PushSecretNamespace,
- },
- Spec: v1alpha1.PushSecretSpec{
- DeletionPolicy: v1alpha1.PushSecretDeletionPolicyDelete,
- SecretStoreRefs: []v1alpha1.PushSecretStoreRef{
- {
- Name: PushSecretStore,
- Kind: "SecretStore",
- },
- },
- Selector: v1alpha1.PushSecretSelector{
- Secret: &v1alpha1.PushSecretSecret{
- Name: SecretName,
- },
- },
- Data: []v1alpha1.PushSecretData{
- {
- Match: v1alpha1.PushSecretMatch{
- SecretKey: defaultKey,
- RemoteRef: v1alpha1.PushSecretRemoteRef{
- RemoteKey: defaultPath,
- },
- },
- },
- },
- },
- }
- tc.assert = func(ps *v1alpha1.PushSecret, secret *v1.Secret) bool {
- ps.Spec.Data[0].Match.RemoteRef.RemoteKey = newKey
- updatedPS := &v1alpha1.PushSecret{}
- Expect(k8sClient.Update(context.Background(), ps, &client.UpdateOptions{})).Should(Succeed())
- Eventually(func() bool {
- psKey := types.NamespacedName{Name: PushSecretName, Namespace: PushSecretNamespace}
- By("checking if synced secrets correspond to both keys")
- err := k8sClient.Get(context.Background(), psKey, updatedPS)
- if err != nil {
- return false
- }
- _, ok := updatedPS.Status.SyncedPushSecrets[fmt.Sprintf(storePrefixTemplate, PushSecretStore)][newKey]
- if !ok {
- return false
- }
- _, ok = updatedPS.Status.SyncedPushSecrets[fmt.Sprintf(storePrefixTemplate, PushSecretStore)][defaultPath]
- return ok
- }, time.Second*10, time.Second).Should(BeTrue())
- return true
- }
- }
- failDeleteStore := func(tc *testCase) {
- fakeProvider.SetSecretFn = func() error {
- return nil
- }
- fakeProvider.DeleteSecretFn = func() error {
- return errors.New("boom")
- }
- tc.pushsecret.Spec.DeletionPolicy = v1alpha1.PushSecretDeletionPolicyDelete
- tc.assert = func(ps *v1alpha1.PushSecret, secret *v1.Secret) bool {
- secondStore := &esv1.SecretStore{
- ObjectMeta: metav1.ObjectMeta{
- Name: "new-store",
- Namespace: PushSecretNamespace,
- },
- TypeMeta: metav1.TypeMeta{
- Kind: "SecretStore",
- },
- Spec: esv1.SecretStoreSpec{
- Provider: &esv1.SecretStoreProvider{
- Fake: &esv1.FakeProvider{
- Data: []esv1.FakeProviderData{},
- },
- },
- },
- }
- Expect(k8sClient.Create(context.Background(), secondStore, &client.CreateOptions{})).Should(Succeed())
- ps.Spec.SecretStoreRefs[0].Name = "new-store"
- updatedPS := &v1alpha1.PushSecret{}
- Expect(k8sClient.Update(context.Background(), ps, &client.UpdateOptions{})).Should(Succeed())
- Eventually(func() bool {
- psKey := types.NamespacedName{Name: PushSecretName, Namespace: PushSecretNamespace}
- By("checking if Provider value got updated")
- err := k8sClient.Get(context.Background(), psKey, updatedPS)
- if err != nil {
- return false
- }
- syncedLen := len(updatedPS.Status.SyncedPushSecrets)
- return syncedLen == 2
- }, time.Second*10, time.Second).Should(BeTrue())
- return true
- }
- }
- deleteWholeStore := func(tc *testCase) {
- fakeProvider.SetSecretFn = func() error {
- return nil
- }
- fakeProvider.DeleteSecretFn = func() error {
- return nil
- }
- tc.pushsecret.Spec.DeletionPolicy = v1alpha1.PushSecretDeletionPolicyDelete
- tc.assert = func(ps *v1alpha1.PushSecret, secret *v1.Secret) bool {
- secondStore := &esv1.SecretStore{
- ObjectMeta: metav1.ObjectMeta{
- Name: "new-store",
- Namespace: PushSecretNamespace,
- },
- TypeMeta: metav1.TypeMeta{
- Kind: "SecretStore",
- },
- Spec: esv1.SecretStoreSpec{
- Provider: &esv1.SecretStoreProvider{
- Fake: &esv1.FakeProvider{
- Data: []esv1.FakeProviderData{},
- },
- },
- },
- }
- Expect(k8sClient.Create(context.Background(), secondStore, &client.CreateOptions{})).Should(Succeed())
- ps.Spec.SecretStoreRefs[0].Name = "new-store"
- updatedPS := &v1alpha1.PushSecret{}
- Expect(k8sClient.Update(context.Background(), ps, &client.UpdateOptions{})).Should(Succeed())
- Eventually(func() bool {
- psKey := types.NamespacedName{Name: PushSecretName, Namespace: PushSecretNamespace}
- By("checking if Provider value got updated")
- err := k8sClient.Get(context.Background(), psKey, updatedPS)
- if err != nil {
- return false
- }
- key, ok := updatedPS.Status.SyncedPushSecrets["SecretStore/new-store"][defaultPath]
- if !ok {
- return false
- }
- syncedLen := len(updatedPS.Status.SyncedPushSecrets)
- if syncedLen != 1 {
- return false
- }
- return key.Match.SecretKey == defaultKey
- }, time.Second*10, time.Second).Should(BeTrue())
- return true
- }
- }
- // if conversion strategy is defined, revert the keys based on the strategy.
- syncSuccessfullyWithConversionStrategy := func(tc *testCase) {
- fakeProvider.SetSecretFn = func() error {
- return nil
- }
- tc.pushsecret = &v1alpha1.PushSecret{
- ObjectMeta: metav1.ObjectMeta{
- Name: PushSecretName,
- Namespace: PushSecretNamespace,
- },
- Spec: v1alpha1.PushSecretSpec{
- SecretStoreRefs: []v1alpha1.PushSecretStoreRef{
- {
- Name: PushSecretStore,
- Kind: "SecretStore",
- },
- },
- Selector: v1alpha1.PushSecretSelector{
- Secret: &v1alpha1.PushSecretSecret{
- Name: SecretName,
- },
- },
- Data: []v1alpha1.PushSecretData{
- {
- ConversionStrategy: v1alpha1.PushSecretConversionReverseUnicode,
- Match: v1alpha1.PushSecretMatch{
- SecretKey: "some-array[0].entity",
- RemoteRef: v1alpha1.PushSecretRemoteRef{
- RemoteKey: defaultPath,
- },
- },
- },
- },
- },
- }
- tc.secret = &v1.Secret{
- ObjectMeta: metav1.ObjectMeta{
- Name: SecretName,
- Namespace: PushSecretNamespace,
- },
- Data: map[string][]byte{
- "some-array_U005b_0_U005d_.entity": []byte("value"),
- },
- }
- tc.assert = func(ps *v1alpha1.PushSecret, secret *v1.Secret) bool {
- Eventually(func() bool {
- By("checking if Provider value got updated")
- secretValue := secret.Data["some-array_U005b_0_U005d_.entity"]
- providerValue, ok := fakeProvider.SetSecretArgs[ps.Spec.Data[0].Match.RemoteRef.RemoteKey]
- if !ok {
- return false
- }
- got := providerValue.Value
- return bytes.Equal(got, secretValue)
- }, time.Second*10, time.Second).Should(BeTrue())
- return true
- }
- }
- // if target Secret name is not specified it should use the ExternalSecret name.
- syncMatchingLabels := func(tc *testCase) {
- fakeProvider.SetSecretFn = func() error {
- return nil
- }
- fakeProvider.DeleteSecretFn = func() error {
- return nil
- }
- tc.pushsecret = &v1alpha1.PushSecret{
- ObjectMeta: metav1.ObjectMeta{
- Name: PushSecretName,
- Namespace: PushSecretNamespace,
- },
- Spec: v1alpha1.PushSecretSpec{
- SecretStoreRefs: []v1alpha1.PushSecretStoreRef{
- {
- LabelSelector: &metav1.LabelSelector{
- MatchLabels: map[string]string{
- "foo": "bar",
- },
- },
- Kind: "SecretStore",
- Name: PushSecretStore,
- },
- },
- Selector: v1alpha1.PushSecretSelector{
- Secret: &v1alpha1.PushSecretSecret{
- Name: SecretName,
- },
- },
- Data: []v1alpha1.PushSecretData{
- {
- Match: v1alpha1.PushSecretMatch{
- SecretKey: defaultKey,
- RemoteRef: v1alpha1.PushSecretRemoteRef{
- RemoteKey: defaultPath,
- },
- },
- },
- },
- },
- }
- tc.store = &esv1.SecretStore{
- TypeMeta: metav1.TypeMeta{
- Kind: "SecretStore",
- },
- ObjectMeta: metav1.ObjectMeta{
- Name: PushSecretStore,
- Namespace: PushSecretNamespace,
- Labels: map[string]string{
- "foo": "bar",
- },
- },
- Spec: esv1.SecretStoreSpec{
- Provider: &esv1.SecretStoreProvider{
- Fake: &esv1.FakeProvider{
- Data: []esv1.FakeProviderData{},
- },
- },
- },
- }
- tc.assert = func(ps *v1alpha1.PushSecret, secret *v1.Secret) bool {
- secretValue := secret.Data[defaultKey]
- providerValue := fakeProvider.SetSecretArgs[ps.Spec.Data[0].Match.RemoteRef.RemoteKey].Value
- expected := v1alpha1.PushSecretStatusCondition{
- Type: v1alpha1.PushSecretReady,
- Status: v1.ConditionTrue,
- Reason: v1alpha1.ReasonSynced,
- Message: "PushSecret synced successfully",
- }
- return bytes.Equal(secretValue, providerValue) && checkCondition(ps.Status, expected)
- }
- }
- syncWithClusterStore := func(tc *testCase) {
- fakeProvider.SetSecretFn = func() error {
- return nil
- }
- tc.store = &esv1.ClusterSecretStore{
- TypeMeta: metav1.TypeMeta{
- Kind: "ClusterSecretStore",
- },
- ObjectMeta: metav1.ObjectMeta{
- Name: PushSecretStore,
- },
- Spec: esv1.SecretStoreSpec{
- Provider: &esv1.SecretStoreProvider{
- Fake: &esv1.FakeProvider{
- Data: []esv1.FakeProviderData{},
- },
- },
- },
- }
- tc.pushsecret.Spec.SecretStoreRefs[0].Kind = "ClusterSecretStore"
- tc.assert = func(ps *v1alpha1.PushSecret, secret *v1.Secret) bool {
- secretValue := secret.Data[defaultKey]
- providerValue := fakeProvider.SetSecretArgs[ps.Spec.Data[0].Match.RemoteRef.RemoteKey].Value
- expected := v1alpha1.PushSecretStatusCondition{
- Type: v1alpha1.PushSecretReady,
- Status: v1.ConditionTrue,
- Reason: v1alpha1.ReasonSynced,
- Message: "PushSecret synced successfully",
- }
- return bytes.Equal(secretValue, providerValue) && checkCondition(ps.Status, expected)
- }
- }
- syncWithGenerator := func(tc *testCase) {
- fakeProvider.SetSecretFn = func() error {
- return nil
- }
- tc.pushsecret.Spec.Selector.Secret = nil
- tc.pushsecret.Spec.Selector.GeneratorRef = &esv1.GeneratorRef{
- APIVersion: "generators.external-secrets.io/v1alpha1",
- Kind: "Fake",
- Name: "test",
- }
- tc.assert = func(ps *v1alpha1.PushSecret, secret *v1.Secret) bool {
- providerValue := fakeProvider.SetSecretArgs[ps.Spec.Data[0].Match.RemoteRef.RemoteKey].Value
- expected := v1alpha1.PushSecretStatusCondition{
- Type: v1alpha1.PushSecretReady,
- Status: v1.ConditionTrue,
- Reason: v1alpha1.ReasonSynced,
- Message: "PushSecret synced successfully",
- }
- return bytes.Equal([]byte("foo-bar-from-generator"), providerValue) && checkCondition(ps.Status, expected)
- }
- }
- // if target Secret name is not specified it should use the ExternalSecret name.
- syncWithClusterStoreMatchingLabels := func(tc *testCase) {
- fakeProvider.SetSecretFn = func() error {
- return nil
- }
- tc.pushsecret = &v1alpha1.PushSecret{
- ObjectMeta: metav1.ObjectMeta{
- Name: PushSecretName,
- Namespace: PushSecretNamespace,
- },
- Spec: v1alpha1.PushSecretSpec{
- SecretStoreRefs: []v1alpha1.PushSecretStoreRef{
- {
- LabelSelector: &metav1.LabelSelector{
- MatchLabels: map[string]string{
- "foo": "bar",
- },
- },
- Kind: "ClusterSecretStore",
- Name: PushSecretStore,
- },
- },
- Selector: v1alpha1.PushSecretSelector{
- Secret: &v1alpha1.PushSecretSecret{
- Name: SecretName,
- },
- },
- Data: []v1alpha1.PushSecretData{
- {
- Match: v1alpha1.PushSecretMatch{
- SecretKey: defaultKey,
- RemoteRef: v1alpha1.PushSecretRemoteRef{
- RemoteKey: defaultPath,
- },
- },
- },
- },
- },
- }
- tc.store = &esv1.ClusterSecretStore{
- ObjectMeta: metav1.ObjectMeta{
- Name: PushSecretStore,
- Labels: map[string]string{
- "foo": "bar",
- },
- },
- Spec: esv1.SecretStoreSpec{
- Provider: &esv1.SecretStoreProvider{
- Fake: &esv1.FakeProvider{
- Data: []esv1.FakeProviderData{},
- },
- },
- },
- }
- tc.assert = func(ps *v1alpha1.PushSecret, secret *v1.Secret) bool {
- secretValue := secret.Data[defaultKey]
- providerValue := fakeProvider.SetSecretArgs[ps.Spec.Data[0].Match.RemoteRef.RemoteKey].Value
- expected := v1alpha1.PushSecretStatusCondition{
- Type: v1alpha1.PushSecretReady,
- Status: v1.ConditionTrue,
- Reason: v1alpha1.ReasonSynced,
- Message: "PushSecret synced successfully",
- }
- return bytes.Equal(secretValue, providerValue) && checkCondition(ps.Status, expected)
- }
- }
- // if target Secret name is not specified it should use the ExternalSecret name.
- failNoSecret := func(tc *testCase) {
- fakeProvider.SetSecretFn = func() error {
- return nil
- }
- tc.secret = nil
- tc.assert = func(ps *v1alpha1.PushSecret, secret *v1.Secret) bool {
- expected := v1alpha1.PushSecretStatusCondition{
- Type: v1alpha1.PushSecretReady,
- Status: v1.ConditionFalse,
- Reason: v1alpha1.ReasonErrored,
- Message: "could not get source secret",
- }
- return checkCondition(ps.Status, expected)
- }
- }
- // if target Secret name is not specified it should use the ExternalSecret name.
- failNoSecretKey := func(tc *testCase) {
- fakeProvider.SetSecretFn = func() error {
- return nil
- }
- tc.pushsecret.Spec.Data[0].Match.SecretKey = "unexisting"
- tc.assert = func(ps *v1alpha1.PushSecret, secret *v1.Secret) bool {
- expected := v1alpha1.PushSecretStatusCondition{
- Type: v1alpha1.PushSecretReady,
- Status: v1.ConditionFalse,
- Reason: v1alpha1.ReasonErrored,
- Message: "set secret failed: secret key unexisting does not exist",
- }
- return checkCondition(ps.Status, expected)
- }
- }
- // if target Secret name is not specified it should use the ExternalSecret name.
- failNoSecretStore := func(tc *testCase) {
- fakeProvider.SetSecretFn = func() error {
- return nil
- }
- tc.store = nil
- tc.assert = func(ps *v1alpha1.PushSecret, secret *v1.Secret) bool {
- expected := v1alpha1.PushSecretStatusCondition{
- Type: v1alpha1.PushSecretReady,
- Status: v1.ConditionFalse,
- Reason: v1alpha1.ReasonErrored,
- Message: "could not get SecretStore \"test-store\", secretstores.external-secrets.io \"test-store\" not found",
- }
- return checkCondition(ps.Status, expected)
- }
- }
- // if target Secret name is not specified it should use the ExternalSecret name.
- failNoClusterStore := func(tc *testCase) {
- fakeProvider.SetSecretFn = func() error {
- return nil
- }
- tc.store = nil
- tc.pushsecret.Spec.SecretStoreRefs[0].Kind = "ClusterSecretStore"
- tc.pushsecret.Spec.SecretStoreRefs[0].Name = "unexisting"
- tc.assert = func(ps *v1alpha1.PushSecret, secret *v1.Secret) bool {
- expected := v1alpha1.PushSecretStatusCondition{
- Type: v1alpha1.PushSecretReady,
- Status: v1.ConditionFalse,
- Reason: v1alpha1.ReasonErrored,
- Message: "could not get ClusterSecretStore \"unexisting\", clustersecretstores.external-secrets.io \"unexisting\" not found",
- }
- return checkCondition(ps.Status, expected)
- }
- }
- // if target Secret name is not specified it should use the ExternalSecret name.
- setSecretFail := func(tc *testCase) {
- fakeProvider.SetSecretFn = func() error {
- return errors.New("boom")
- }
- tc.assert = func(ps *v1alpha1.PushSecret, secret *v1.Secret) bool {
- expected := v1alpha1.PushSecretStatusCondition{
- Type: v1alpha1.PushSecretReady,
- Status: v1.ConditionFalse,
- Reason: v1alpha1.ReasonErrored,
- Message: "set secret failed: could not write remote ref key to target secretstore test-store: boom",
- }
- return checkCondition(ps.Status, expected)
- }
- }
- // if target Secret name is not specified it should use the ExternalSecret name.
- newClientFail := func(tc *testCase) {
- fakeProvider.NewFn = func(context.Context, esv1.GenericStore, client.Client, string) (esv1.SecretsClient, error) {
- return nil, errors.New("boom")
- }
- tc.assert = func(ps *v1alpha1.PushSecret, secret *v1.Secret) bool {
- expected := v1alpha1.PushSecretStatusCondition{
- Type: v1alpha1.PushSecretReady,
- Status: v1.ConditionFalse,
- Reason: v1alpha1.ReasonErrored,
- Message: "set secret failed: could not get secrets client for store test-store: boom",
- }
- return checkCondition(ps.Status, expected)
- }
- }
- DescribeTable("When reconciling a PushSecret",
- func(tweaks ...testTweaks) {
- tc := makeDefaultTestcase()
- for _, tweak := range tweaks {
- tweak(tc)
- }
- ctx := context.Background()
- By("creating a secret store, secret and pushsecret")
- if tc.store != nil {
- Expect(k8sClient.Create(ctx, tc.store)).To(Succeed())
- }
- if tc.secret != nil {
- Expect(k8sClient.Create(ctx, tc.secret)).To(Succeed())
- }
- if tc.pushsecret != nil {
- Expect(k8sClient.Create(ctx, tc.pushsecret)).Should(Succeed())
- }
- time.Sleep(2 * time.Second) // prevents race conditions during tests causing failures
- psKey := types.NamespacedName{Name: PushSecretName, Namespace: PushSecretNamespace}
- createdPS := &v1alpha1.PushSecret{}
- By("checking the pushSecret condition")
- Eventually(func() bool {
- err := k8sClient.Get(ctx, psKey, createdPS)
- if err != nil {
- return false
- }
- return tc.assert(createdPS, tc.secret)
- }, timeout, interval).Should(BeTrue())
- // this must be optional so we can test faulty es configuration
- },
- Entry("should sync", syncSuccessfully),
- Entry("should not update existing secret if UpdatePolicy=IfNotExists", updateIfNotExists),
- Entry("should only update parts of secret that don't already exist if UpdatePolicy=IfNotExists", updateIfNotExistsPartialSecrets),
- Entry("should update the PushSecret status correctly if UpdatePolicy=IfNotExists", updateIfNotExistsSyncStatus),
- Entry("should fail if secret existence cannot be verified if UpdatePolicy=IfNotExists", updateIfNotExistsSyncFailed),
- Entry("should sync with template", syncSuccessfullyWithTemplate),
- Entry("should sync with template reusing keys", syncSuccessfullyReusingKeys),
- Entry("should sync with conversion strategy", syncSuccessfullyWithConversionStrategy),
- Entry("should delete if DeletionPolicy=Delete", syncAndDeleteSuccessfully),
- Entry("should delete after DeletionPolicy changed from Delete to None", syncChangePolicyAndDeleteSuccessfully),
- Entry("should track deletion tasks if Delete fails", failDelete),
- Entry("should track deleted stores if Delete fails", failDeleteStore),
- Entry("should delete all secrets if SecretStore changes", deleteWholeStore),
- Entry("should sync to stores matching labels", syncMatchingLabels),
- Entry("should sync with ClusterStore", syncWithClusterStore),
- Entry("should sync with ClusterStore matching labels", syncWithClusterStoreMatchingLabels),
- Entry("should sync with Generator", syncWithGenerator),
- Entry("should fail if Secret is not created", failNoSecret),
- Entry("should fail if Secret Key does not exist", failNoSecretKey),
- Entry("should fail if SetSecret fails", setSecretFail),
- Entry("should fail if no valid SecretStore", failNoSecretStore),
- Entry("should fail if no valid ClusterSecretStore", failNoClusterStore),
- Entry("should fail if NewClient fails", newClientFail),
- )
- })
- var _ = Describe("PushSecret Controller Un/Managed Stores", func() {
- const (
- PushSecretName = "test-ps"
- ManagedPushSecretStore1 = "test-managed-store-1"
- ManagedPushSecretStore2 = "test-managed-store-2"
- UnmanagedPushSecretStore1 = "test-unmanaged-store-1"
- UnmanagedPushSecretStore2 = "test-unmanaged-store-2"
- SecretName = "test-secret"
- )
- var PushSecretNamespace string
- PushSecretStores := []string{ManagedPushSecretStore1, ManagedPushSecretStore2, UnmanagedPushSecretStore1, UnmanagedPushSecretStore2}
- // if we are in debug and need to increase the timeout for testing, we can do so by using an env var
- if customTimeout := os.Getenv("TEST_CUSTOM_TIMEOUT_SEC"); customTimeout != "" {
- if t, err := strconv.Atoi(customTimeout); err == nil {
- timeout = time.Second * time.Duration(t)
- }
- }
- BeforeEach(func() {
- var err error
- PushSecretNamespace, err = ctest.CreateNamespace("test-ns", k8sClient)
- Expect(err).ToNot(HaveOccurred())
- fakeProvider.Reset()
- })
- AfterEach(func() {
- k8sClient.Delete(context.Background(), &v1alpha1.PushSecret{
- ObjectMeta: metav1.ObjectMeta{
- Name: PushSecretName,
- Namespace: PushSecretNamespace,
- },
- })
- // give a time for reconciler to remove finalizers before removing SecretStores
- // TODO: Secret Stores should have finalizers bound to PushSecrets if DeletionPolicy == Delete
- time.Sleep(2 * time.Second)
- for _, psstore := range PushSecretStores {
- k8sClient.Delete(context.Background(), &esv1.SecretStore{
- ObjectMeta: metav1.ObjectMeta{
- Name: psstore,
- Namespace: PushSecretNamespace,
- },
- })
- k8sClient.Delete(context.Background(), &esv1.ClusterSecretStore{
- ObjectMeta: metav1.ObjectMeta{
- Name: psstore,
- },
- })
- }
- k8sClient.Delete(context.Background(), &v1.Secret{
- ObjectMeta: metav1.ObjectMeta{
- Name: SecretName,
- Namespace: PushSecretNamespace,
- },
- })
- Expect(k8sClient.Delete(context.Background(), &v1.Namespace{
- ObjectMeta: metav1.ObjectMeta{
- Name: PushSecretNamespace,
- },
- })).To(Succeed())
- })
- const (
- defaultKey = "key"
- defaultVal = "value"
- defaultPath = "path/to/key"
- )
- makeDefaultTestcase := func() *testCase {
- return &testCase{
- pushsecret: &v1alpha1.PushSecret{
- ObjectMeta: metav1.ObjectMeta{
- Name: PushSecretName,
- Namespace: PushSecretNamespace,
- },
- Spec: v1alpha1.PushSecretSpec{
- SecretStoreRefs: []v1alpha1.PushSecretStoreRef{
- {
- Name: ManagedPushSecretStore1,
- Kind: "SecretStore",
- },
- },
- Selector: v1alpha1.PushSecretSelector{
- Secret: &v1alpha1.PushSecretSecret{
- Name: SecretName,
- },
- },
- Data: []v1alpha1.PushSecretData{
- {
- Match: v1alpha1.PushSecretMatch{
- SecretKey: defaultKey,
- RemoteRef: v1alpha1.PushSecretRemoteRef{
- RemoteKey: defaultPath,
- },
- },
- },
- },
- },
- },
- secret: &v1.Secret{
- ObjectMeta: metav1.ObjectMeta{
- Name: SecretName,
- Namespace: PushSecretNamespace,
- },
- Data: map[string][]byte{
- defaultKey: []byte(defaultVal),
- },
- },
- managedStore1: &esv1.SecretStore{
- ObjectMeta: metav1.ObjectMeta{
- Name: ManagedPushSecretStore1,
- Namespace: PushSecretNamespace,
- },
- TypeMeta: metav1.TypeMeta{
- Kind: "SecretStore",
- },
- Spec: esv1.SecretStoreSpec{
- Provider: &esv1.SecretStoreProvider{
- Fake: &esv1.FakeProvider{
- Data: []esv1.FakeProviderData{},
- },
- },
- },
- },
- managedStore2: &esv1.SecretStore{
- ObjectMeta: metav1.ObjectMeta{
- Name: ManagedPushSecretStore2,
- Namespace: PushSecretNamespace,
- },
- TypeMeta: metav1.TypeMeta{
- Kind: "SecretStore",
- },
- Spec: esv1.SecretStoreSpec{
- Provider: &esv1.SecretStoreProvider{
- Fake: &esv1.FakeProvider{
- Data: []esv1.FakeProviderData{},
- },
- },
- },
- },
- unmanagedStore1: &esv1.SecretStore{
- ObjectMeta: metav1.ObjectMeta{
- Name: UnmanagedPushSecretStore1,
- Namespace: PushSecretNamespace,
- },
- TypeMeta: metav1.TypeMeta{
- Kind: "SecretStore",
- },
- Spec: esv1.SecretStoreSpec{
- Provider: &esv1.SecretStoreProvider{
- Fake: &esv1.FakeProvider{
- Data: []esv1.FakeProviderData{},
- },
- },
- Controller: "not-managed",
- },
- },
- unmanagedStore2: &esv1.SecretStore{
- ObjectMeta: metav1.ObjectMeta{
- Name: UnmanagedPushSecretStore2,
- Namespace: PushSecretNamespace,
- },
- TypeMeta: metav1.TypeMeta{
- Kind: "SecretStore",
- },
- Spec: esv1.SecretStoreSpec{
- Provider: &esv1.SecretStoreProvider{
- Fake: &esv1.FakeProvider{
- Data: []esv1.FakeProviderData{},
- },
- },
- Controller: "not-managed",
- },
- },
- }
- }
- multipleManagedStoresSyncsSuccessfully := func(tc *testCase) {
- fakeProvider.SetSecretFn = func() error {
- return nil
- }
- tc.pushsecret.Spec.SecretStoreRefs = append(tc.pushsecret.Spec.SecretStoreRefs,
- v1alpha1.PushSecretStoreRef{
- Name: ManagedPushSecretStore2,
- Kind: "SecretStore",
- },
- )
- tc.assert = func(ps *v1alpha1.PushSecret, secret *v1.Secret) bool {
- Eventually(func() bool {
- By("checking if Provider value got updated")
- secretValue := secret.Data[defaultKey]
- providerValue, ok := fakeProvider.SetSecretArgs[ps.Spec.Data[0].Match.RemoteRef.RemoteKey]
- if !ok {
- return false
- }
- got := providerValue.Value
- return bytes.Equal(got, secretValue)
- }, time.Second*10, time.Second).Should(BeTrue())
- return true
- }
- }
- skipUnmanagedStores := func(tc *testCase) {
- tc.pushsecret.Spec.SecretStoreRefs = []v1alpha1.PushSecretStoreRef{
- {
- Name: UnmanagedPushSecretStore1,
- Kind: "SecretStore",
- },
- {
- Name: UnmanagedPushSecretStore2,
- Kind: "SecretStore",
- },
- }
- tc.assert = func(ps *v1alpha1.PushSecret, secret *v1.Secret) bool {
- return len(ps.Status.Conditions) == 0
- }
- }
- warnUnmanagedStoresAndSyncManagedStores := func(tc *testCase) {
- fakeProvider.SetSecretFn = func() error {
- return nil
- }
- tc.pushsecret.Spec.SecretStoreRefs = []v1alpha1.PushSecretStoreRef{
- {
- Name: ManagedPushSecretStore1,
- Kind: "SecretStore",
- },
- {
- Name: ManagedPushSecretStore2,
- Kind: "SecretStore",
- },
- {
- Name: UnmanagedPushSecretStore1,
- Kind: "SecretStore",
- },
- {
- Name: UnmanagedPushSecretStore2,
- Kind: "SecretStore",
- },
- }
- tc.assert = func(ps *v1alpha1.PushSecret, secret *v1.Secret) bool {
- Eventually(func() bool {
- By("checking if Provider value got updated")
- secretValue := secret.Data[defaultKey]
- providerValue, ok := fakeProvider.SetSecretArgs[ps.Spec.Data[0].Match.RemoteRef.RemoteKey]
- if !ok {
- return false
- }
- got := providerValue.Value
- return bytes.Equal(got, secretValue)
- }, time.Second*10, time.Second).Should(BeTrue())
- return true
- }
- }
- DescribeTable("When reconciling a PushSecret with multiple secret stores",
- func(tweaks ...testTweaks) {
- tc := makeDefaultTestcase()
- for _, tweak := range tweaks {
- tweak(tc)
- }
- ctx := context.Background()
- By("creating secret stores, a secret and a pushsecret")
- if tc.managedStore1 != nil {
- Expect(k8sClient.Create(ctx, tc.managedStore1)).To(Succeed())
- }
- if tc.managedStore2 != nil {
- Expect(k8sClient.Create(ctx, tc.managedStore2)).To(Succeed())
- }
- if tc.unmanagedStore1 != nil {
- Expect(k8sClient.Create(ctx, tc.unmanagedStore1)).To(Succeed())
- }
- if tc.unmanagedStore2 != nil {
- Expect(k8sClient.Create(ctx, tc.unmanagedStore2)).To(Succeed())
- }
- if tc.secret != nil {
- Expect(k8sClient.Create(ctx, tc.secret)).To(Succeed())
- }
- if tc.pushsecret != nil {
- Expect(k8sClient.Create(ctx, tc.pushsecret)).Should(Succeed())
- }
- time.Sleep(2 * time.Second) // prevents race conditions during tests causing failures
- psKey := types.NamespacedName{Name: PushSecretName, Namespace: PushSecretNamespace}
- createdPS := &v1alpha1.PushSecret{}
- By("checking the pushSecret condition")
- Eventually(func() bool {
- err := k8sClient.Get(ctx, psKey, createdPS)
- if err != nil {
- return false
- }
- return tc.assert(createdPS, tc.secret)
- }, timeout, interval).Should(BeTrue())
- // this must be optional so we can test faulty es configuration
- },
- Entry("should sync successfully if there are multiple managed stores", multipleManagedStoresSyncsSuccessfully),
- Entry("should skip unmanaged stores", skipUnmanagedStores),
- Entry("should skip unmanaged stores and sync managed stores", warnUnmanagedStoresAndSyncManagedStores),
- )
- })
|