| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583 |
- /*
- 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 {
- 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, OtherNamespace 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())
- OtherNamespace, 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]
- setSecretArgs := fakeProvider.GetPushSecretData()
- providerValue, ok := 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) {
- setSecretArgs := fakeProvider.GetPushSecretData()
- _, ok := setSecretArgs[ref.GetRemoteKey()]
- return ok, nil
- }
- tc.pushsecret.Spec.UpdatePolicy = v1alpha1.PushSecretUpdatePolicyIfNotExists
- tc.assert = func(ps *v1alpha1.PushSecret, secret *v1.Secret) bool {
- Consistently(func() bool {
- By("updating the secret value")
- tc.secret.Data[defaultKey] = []byte(newVal)
- Expect(k8sClient.Update(context.Background(), secret, &client.UpdateOptions{})).Should(Succeed())
- By("checking if Provider value does not get updated")
- setSecretArgs := fakeProvider.GetPushSecretData()
- providerValue, ok := setSecretArgs[ps.Spec.Data[0].Match.RemoteRef.RemoteKey]
- if !ok {
- return false
- }
- got := providerValue.Value
- return bytes.Equal(got, []byte(defaultVal))
- }, 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) {
- setSecretArgs := fakeProvider.GetPushSecretData()
- _, ok := 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.assert = func(ps *v1alpha1.PushSecret, secret *v1.Secret) bool {
- Eventually(func() bool {
- tc.secret.Data[defaultKey] = []byte(newVal) // change initial value in secret
- tc.secret.Data[otherKey] = []byte(otherVal)
- By("checking if only not existing Provider value got updated")
- Expect(k8sClient.Update(context.Background(), secret, &client.UpdateOptions{})).Should(Succeed())
- setSecretArgs := fakeProvider.GetPushSecretData()
- providerValue, ok := setSecretArgs[ps.Spec.Data[0].Match.RemoteRef.RemoteKey]
- if !ok {
- return false
- }
- got := providerValue.Value
- otherProviderValue, ok := 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, []byte(defaultVal))
- }, 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) {
- setSecretArgs := fakeProvider.GetPushSecretData()
- _, ok := 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
- 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")
- 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)
- }, 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")
- setSecretArgs := fakeProvider.GetPushSecretData()
- providerValue, ok := 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")
- setSecretArgs := fakeProvider.GetPushSecretData()
- providerValue, ok := 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"]
- setSecretArgs := fakeProvider.GetPushSecretData()
- providerValue, ok := 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]
- setSecretArgs := fakeProvider.GetPushSecretData()
- providerValue := 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]
- setSecretArgs := fakeProvider.GetPushSecretData()
- providerValue := 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 {
- setSecretArgs := fakeProvider.GetPushSecretData()
- providerValue := 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]
- setSecretArgs := fakeProvider.GetPushSecretData()
- providerValue := 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)
- }
- }
- // SecretStores in different namespace than PushSecret should not be selected.
- secretStoreDifferentNamespace := func(tc *testCase) {
- fakeProvider.SetSecretFn = func() error {
- return nil
- }
- // Create the SecretStore in a different namespace
- tc.store = &esv1.SecretStore{
- ObjectMeta: metav1.ObjectMeta{
- Name: "other-ns-store",
- Namespace: OtherNamespace,
- Labels: map[string]string{
- "foo": "bar",
- },
- },
- TypeMeta: metav1.TypeMeta{
- Kind: "SecretStore",
- },
- Spec: esv1.SecretStoreSpec{
- Provider: &esv1.SecretStoreProvider{
- Fake: &esv1.FakeProvider{
- Data: []esv1.FakeProviderData{},
- },
- },
- },
- }
- // Use label selector to select SecretStores
- tc.pushsecret.Spec.SecretStoreRefs = []v1alpha1.PushSecretStoreRef{
- {
- Kind: "SecretStore",
- LabelSelector: &metav1.LabelSelector{
- MatchLabels: map[string]string{
- "foo": "bar",
- },
- },
- },
- }
- // Should not select the SecretStore in a different namespace
- // (if so, it would fail to find it in the same namespace and be reflected in the status)
- tc.assert = func(ps *v1alpha1.PushSecret, secret *v1.Secret) bool {
- // Assert that the status is never updated (no SecretStores found)
- Consistently(func() bool {
- err := k8sClient.Get(context.Background(), client.ObjectKeyFromObject(ps), ps)
- if err != nil {
- return false
- }
- return len(ps.Status.Conditions) == 0
- }, timeout, interval).Should(BeTrue())
- return true
- }
- }
- // Secrets in different namespace than PushSecret should not be selected.
- secretDifferentNamespace := func(tc *testCase) {
- fakeProvider.SetSecretFn = func() error {
- return nil
- }
- // Create the Secret in a different namespace
- tc.secret = &v1.Secret{
- ObjectMeta: metav1.ObjectMeta{
- Name: SecretName,
- Namespace: OtherNamespace,
- Labels: map[string]string{
- "foo": "bar",
- },
- },
- Data: map[string][]byte{
- defaultKey: []byte(defaultVal),
- },
- }
- // Use label selector to select Secrets
- tc.pushsecret.Spec.Selector.Secret = &v1alpha1.PushSecretSecret{
- Selector: &metav1.LabelSelector{
- MatchLabels: map[string]string{
- "foo": "bar",
- },
- },
- }
- tc.assert = func(ps *v1alpha1.PushSecret, secret *v1.Secret) bool {
- Eventually(func() bool {
- // We should not be able to reference a secret across namespaces,
- // the map should be empty.
- Expect(fakeProvider.GetPushSecretData()).To(BeEmpty())
- return true
- }, time.Second*10, time.Second).Should(BeTrue())
- return true
- }
- }
- 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),
- Entry("should not sync to SecretStore in different namespace", secretStoreDifferentNamespace),
- Entry("should not reference secret in different namespace", secretDifferentNamespace),
- )
- })
- 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]
- setSecretArgs := fakeProvider.GetPushSecretData()
- providerValue, ok := 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]
- setSecretArgs := fakeProvider.GetPushSecretData()
- providerValue, ok := 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),
- )
- })
|