| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067 |
- /*
- Copyright © The ESO Authors
- 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
- https://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"
- "encoding/json"
- "errors"
- "fmt"
- "os"
- "strconv"
- "sync/atomic"
- "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/runtime/testing/fake"
- . "github.com/onsi/ginkgo/v2"
- . "github.com/onsi/gomega"
- )
- const (
- testAdminUser = "admin"
- testLocalhost = "localhost"
- testDBHost = "db-host"
- testDBPort = "db-port"
- testAppName = "app-name"
- testDBRegexp = "^db-.*"
- testAPIKey = "api-key"
- testDuplicateRemoteKeyErr = "duplicate remote key"
- )
- 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(_ 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(_ 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(_ 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(_ context.Context, _ esv1.PushSecretRemoteRef) (bool, error) {
- return false, errors.New("don't know")
- }
- tc.pushsecret.Spec.UpdatePolicy = v1alpha1.PushSecretUpdatePolicyIfNotExists
- tc.assert = func(ps *v1alpha1.PushSecret, _ *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",
- },
- Finalizers: []string{"example.com/finalizer"},
- },
- 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, _ *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",
- },
- Finalizers: []string{"example.com/finalizer"},
- },
- Type: v1.SecretTypeOpaque,
- EngineVersion: esv1.TemplateEngineV2,
- Data: map[string]string{
- defaultKey: "{{ .key | toString | upper }} was templated",
- },
- },
- },
- }
- tc.assert = func(ps *v1alpha1.PushSecret, _ *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, _ *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 deletes a secret with properties, the status map should be cleaned up correctly
- syncAndDeleteWithProperties := 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{
- 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,
- Property: "field1",
- },
- },
- },
- {
- Match: v1alpha1.PushSecretMatch{
- SecretKey: otherKey,
- RemoteRef: v1alpha1.PushSecretRemoteRef{
- RemoteKey: defaultPath,
- Property: "field2",
- },
- },
- },
- },
- },
- }
- tc.secret.Data[otherKey] = []byte(otherVal)
- tc.assert = func(ps *v1alpha1.PushSecret, _ *v1.Secret) bool {
- updatedPS := &v1alpha1.PushSecret{}
- // Wait for initial sync
- Eventually(func() bool {
- psKey := types.NamespacedName{Name: PushSecretName, Namespace: PushSecretNamespace}
- err := k8sClient.Get(context.Background(), psKey, updatedPS)
- if err != nil {
- return false
- }
- // Check both properties are in status
- _, ok1 := updatedPS.Status.SyncedPushSecrets[fmt.Sprintf(storePrefixTemplate, PushSecretStore)][defaultPath+"/field1"]
- _, ok2 := updatedPS.Status.SyncedPushSecrets[fmt.Sprintf(storePrefixTemplate, PushSecretStore)][defaultPath+"/field2"]
- return ok1 && ok2
- }, time.Second*10, time.Second).Should(BeTrue())
- // Remove one property
- updatedPS.Spec.Data = []v1alpha1.PushSecretData{
- {
- Match: v1alpha1.PushSecretMatch{
- SecretKey: defaultKey,
- RemoteRef: v1alpha1.PushSecretRemoteRef{
- RemoteKey: defaultPath,
- Property: "field1",
- },
- },
- },
- }
- Expect(k8sClient.Update(context.Background(), updatedPS, &client.UpdateOptions{})).Should(Succeed())
- // Verify the removed property is deleted from status
- Eventually(func() bool {
- psKey := types.NamespacedName{Name: PushSecretName, Namespace: PushSecretNamespace}
- err := k8sClient.Get(context.Background(), psKey, updatedPS)
- if err != nil {
- return false
- }
- // field1 should still exist
- _, ok1 := updatedPS.Status.SyncedPushSecrets[fmt.Sprintf(storePrefixTemplate, PushSecretStore)][defaultPath+"/field1"]
- // field2 should be removed
- _, ok2 := updatedPS.Status.SyncedPushSecrets[fmt.Sprintf(storePrefixTemplate, PushSecretStore)][defaultPath+"/field2"]
- return ok1 && !ok2
- }, 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, _ *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
- }
- }
- // When source Secret is deleted and DeletionPolicy=Delete, provider secrets should be cleaned up
- deleteProviderSecretsOnSourceSecretDeleted := func(tc *testCase) {
- var deleteCallCount int32
- fakeProvider.SetSecretFn = func() error {
- return nil
- }
- fakeProvider.DeleteSecretFn = func() error {
- atomic.AddInt32(&deleteCallCount, 1)
- return nil
- }
- tc.pushsecret = &v1alpha1.PushSecret{
- ObjectMeta: metav1.ObjectMeta{
- Name: PushSecretName,
- Namespace: PushSecretNamespace,
- },
- Spec: v1alpha1.PushSecretSpec{
- DeletionPolicy: v1alpha1.PushSecretDeletionPolicyDelete,
- // Short refresh interval so reconciler detects deleted secret quickly
- RefreshInterval: &metav1.Duration{Duration: time.Second},
- 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 {
- updatedPS := &v1alpha1.PushSecret{}
- psKey := types.NamespacedName{Name: PushSecretName, Namespace: PushSecretNamespace}
- // Wait for initial sync
- Eventually(func() bool {
- By("waiting for initial sync to complete")
- err := k8sClient.Get(context.Background(), psKey, updatedPS)
- if err != nil {
- return false
- }
- storeKey := fmt.Sprintf(storePrefixTemplate, PushSecretStore)
- _, ok := updatedPS.Status.SyncedPushSecrets[storeKey][defaultPath]
- return ok
- }, time.Second*10, time.Second).Should(BeTrue())
- // Delete the source Secret
- By("deleting source Secret")
- Expect(k8sClient.Delete(context.Background(), secret, &client.DeleteOptions{})).Should(Succeed())
- // Verify provider secrets are cleaned up
- Eventually(func() bool {
- By("checking if provider secrets were deleted")
- return atomic.LoadInt32(&deleteCallCount) > 0
- }, time.Second*10, time.Second).Should(BeTrue())
- // Verify status shows empty synced secrets
- Eventually(func() bool {
- By("checking if SyncedPushSecrets is empty")
- err := k8sClient.Get(context.Background(), psKey, updatedPS)
- if err != nil {
- return false
- }
- storeKey := fmt.Sprintf(storePrefixTemplate, PushSecretStore)
- secrets, exists := updatedPS.Status.SyncedPushSecrets[storeKey]
- return !exists || len(secrets) == 0
- }, 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, _ *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, _ *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, _ *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, _ *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, _ *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, _ *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, _ *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, _ *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, _ *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, _ *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, _ *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(_ *v1alpha1.PushSecret, _ *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
- }
- }
- // dataTo tests
- syncWithDataToMatchAll := func(tc *testCase) {
- fakeProvider.SetSecretFn = func() error {
- return nil
- }
- // Set up secret with multiple keys
- tc.secret.Data = map[string][]byte{
- testDBHost: []byte(testLocalhost),
- testDBPort: []byte("5432"),
- "db-username": []byte(testAdminUser),
- }
- // Replace data with dataTo that matches all keys
- tc.pushsecret.Spec.Data = nil
- tc.pushsecret.Spec.DataTo = []v1alpha1.PushSecretDataTo{
- {
- StoreRef: &v1alpha1.PushSecretStoreRef{
- Name: PushSecretStore,
- },
- // No match pattern means match all
- },
- }
- tc.assert = func(ps *v1alpha1.PushSecret, secret *v1.Secret) bool {
- Eventually(func() bool {
- By("checking if all keys were pushed to provider")
- setSecretArgs := fakeProvider.GetPushSecretData()
- // All three keys should be pushed
- if len(setSecretArgs) != 3 {
- return false
- }
- // Check each key was pushed with same name
- for key, expectedValue := range secret.Data {
- providerValue, ok := setSecretArgs[key]
- if !ok {
- return false
- }
- if !bytes.Equal(providerValue.Value, expectedValue) {
- return false
- }
- }
- return true
- }, time.Second*10, time.Second).Should(BeTrue())
- return true
- }
- }
- syncWithDataToRegex := func(tc *testCase) {
- fakeProvider.SetSecretFn = func() error {
- return nil
- }
- // Set up secret with multiple keys
- tc.secret.Data = map[string][]byte{
- testDBHost: []byte(testLocalhost),
- testDBPort: []byte("5432"),
- testAppName: []byte("myapp"),
- "app-version": []byte("1.0"),
- }
- // Use dataTo with regex to match only db-* keys
- tc.pushsecret.Spec.Data = nil
- tc.pushsecret.Spec.DataTo = []v1alpha1.PushSecretDataTo{
- {
- StoreRef: &v1alpha1.PushSecretStoreRef{
- Name: PushSecretStore,
- },
- Match: &v1alpha1.PushSecretDataToMatch{
- RegExp: testDBRegexp,
- },
- },
- }
- tc.assert = func(ps *v1alpha1.PushSecret, secret *v1.Secret) bool {
- Eventually(func() bool {
- By("checking if only db-* keys were pushed")
- setSecretArgs := fakeProvider.GetPushSecretData()
- // Only two db-* keys should be pushed
- if len(setSecretArgs) != 2 {
- return false
- }
- // Check db-* keys were pushed
- for key := range setSecretArgs {
- if key != testDBHost && key != testDBPort {
- return false
- }
- }
- return true
- }, time.Second*10, time.Second).Should(BeTrue())
- return true
- }
- }
- syncWithDataToRegexpRewrite := func(tc *testCase) {
- fakeProvider.SetSecretFn = func() error {
- return nil
- }
- // Set up secret with multiple keys
- tc.secret.Data = map[string][]byte{
- testDBHost: []byte(testLocalhost),
- testDBPort: []byte("5432"),
- }
- // Use dataTo with regex rewrite to add prefix
- tc.pushsecret.Spec.Data = nil
- tc.pushsecret.Spec.DataTo = []v1alpha1.PushSecretDataTo{
- {
- StoreRef: &v1alpha1.PushSecretStoreRef{
- Name: PushSecretStore,
- },
- Match: &v1alpha1.PushSecretDataToMatch{
- RegExp: testDBRegexp,
- },
- Rewrite: []v1alpha1.PushSecretRewrite{
- {
- Regexp: &esv1.ExternalSecretRewriteRegexp{
- Source: "^db-",
- Target: "app/database/",
- },
- },
- },
- },
- }
- tc.assert = func(ps *v1alpha1.PushSecret, secret *v1.Secret) bool {
- Eventually(func() bool {
- By("checking if keys were rewritten with prefix")
- setSecretArgs := fakeProvider.GetPushSecretData()
- if len(setSecretArgs) != 2 {
- return false
- }
- // Check keys were rewritten
- _, hasHost := setSecretArgs["app/database/host"]
- _, hasPort := setSecretArgs["app/database/port"]
- return hasHost && hasPort
- }, time.Second*10, time.Second).Should(BeTrue())
- return true
- }
- }
- syncWithDataToTransformRewrite := func(tc *testCase) {
- fakeProvider.SetSecretFn = func() error {
- return nil
- }
- tc.secret.Data = map[string][]byte{
- "username": []byte(testAdminUser),
- }
- // Use dataTo with template transformation
- tc.pushsecret.Spec.Data = nil
- tc.pushsecret.Spec.DataTo = []v1alpha1.PushSecretDataTo{
- {
- StoreRef: &v1alpha1.PushSecretStoreRef{
- Name: PushSecretStore,
- },
- Rewrite: []v1alpha1.PushSecretRewrite{
- {
- Transform: &esv1.ExternalSecretRewriteTransform{
- Template: "app/{{ .value | upper }}",
- },
- },
- },
- },
- }
- tc.assert = func(ps *v1alpha1.PushSecret, secret *v1.Secret) bool {
- Eventually(func() bool {
- By("checking if key was transformed using template")
- setSecretArgs := fakeProvider.GetPushSecretData()
- if len(setSecretArgs) != 1 {
- return false
- }
- // Check key was transformed to uppercase with prefix
- providerValue, ok := setSecretArgs["app/USERNAME"]
- if !ok {
- return false
- }
- return bytes.Equal(providerValue.Value, []byte(testAdminUser))
- }, time.Second*10, time.Second).Should(BeTrue())
- return true
- }
- }
- syncDataToWithDataOverride := func(tc *testCase) {
- fakeProvider.SetSecretFn = func() error {
- return nil
- }
- tc.secret.Data = map[string][]byte{
- "key1": []byte("value1"),
- "key2": []byte("value2"),
- }
- // Use both dataTo and explicit data
- // Explicit data should override dataTo for key1
- tc.pushsecret.Spec.DataTo = []v1alpha1.PushSecretDataTo{
- {
- StoreRef: &v1alpha1.PushSecretStoreRef{
- Name: PushSecretStore,
- },
- // Match all keys, no rewrite
- },
- }
- tc.pushsecret.Spec.Data = []v1alpha1.PushSecretData{
- {
- Match: v1alpha1.PushSecretMatch{
- SecretKey: "key1",
- RemoteRef: v1alpha1.PushSecretRemoteRef{
- RemoteKey: "override-key1", // Different remote key
- },
- },
- },
- }
- tc.assert = func(ps *v1alpha1.PushSecret, secret *v1.Secret) bool {
- Eventually(func() bool {
- By("checking if explicit data overrode dataTo")
- setSecretArgs := fakeProvider.GetPushSecretData()
- // Should have 2 keys: override-key1 and key2
- if len(setSecretArgs) != 2 {
- return false
- }
- // key1 should be pushed as override-key1 (from explicit data)
- _, hasOverride := setSecretArgs["override-key1"]
- // key2 should be pushed as key2 (from dataTo)
- _, hasKey2 := setSecretArgs["key2"]
- return hasOverride && hasKey2
- }, time.Second*10, time.Second).Should(BeTrue())
- return true
- }
- }
- failDataToInvalidRegex := func(tc *testCase) {
- tc.secret.Data = map[string][]byte{
- "key1": []byte("value1"),
- }
- // Use invalid regex pattern
- tc.pushsecret.Spec.Data = nil
- tc.pushsecret.Spec.DataTo = []v1alpha1.PushSecretDataTo{
- {
- StoreRef: &v1alpha1.PushSecretStoreRef{
- Name: PushSecretStore,
- },
- Match: &v1alpha1.PushSecretDataToMatch{
- RegExp: "[invalid(regex",
- },
- },
- }
- tc.assert = func(ps *v1alpha1.PushSecret, secret *v1.Secret) bool {
- Eventually(func() bool {
- By("checking if PushSecret has error condition")
- cond := GetPushSecretCondition(ps.Status.Conditions, v1alpha1.PushSecretReady)
- if cond == nil {
- return false
- }
- // Should have error status
- return cond.Status == v1.ConditionFalse && cond.Reason == v1alpha1.ReasonErrored
- }, time.Second*10, time.Second).Should(BeTrue())
- return true
- }
- }
- syncWithDataToConversionStrategy := func(tc *testCase) {
- fakeProvider.SetSecretFn = func() error {
- return nil
- }
- // Set up secret with unicode data
- tc.secret.Data = map[string][]byte{
- "unicode-key": []byte("unicode-value-αβγ"),
- "normal-key": []byte("normal-value"),
- }
- // Use dataTo with ConversionStrategy
- tc.pushsecret.Spec.Data = nil
- tc.pushsecret.Spec.DataTo = []v1alpha1.PushSecretDataTo{
- {
- StoreRef: &v1alpha1.PushSecretStoreRef{
- Name: PushSecretStore,
- },
- ConversionStrategy: v1alpha1.PushSecretConversionReverseUnicode,
- },
- }
- tc.assert = func(ps *v1alpha1.PushSecret, secret *v1.Secret) bool {
- Eventually(func() bool {
- By("checking if all keys were pushed with unicode conversion")
- setSecretArgs := fakeProvider.GetPushSecretData()
- // Both keys should be pushed
- if len(setSecretArgs) != 2 {
- return false
- }
- // Verify keys exist (actual unicode encoding is tested in provider tests)
- _, hasUnicode := setSecretArgs["unicode-key"]
- _, hasNormal := setSecretArgs["normal-key"]
- return hasUnicode && hasNormal
- }, timeout, time.Second).Should(BeTrue())
- cond := GetPushSecretCondition(ps.Status.Conditions, v1alpha1.PushSecretReady)
- return cond != nil && cond.Status == v1.ConditionTrue && cond.Reason == v1alpha1.ReasonSynced
- }
- }
- // Test dataTo with storeRef targeting specific store
- syncWithDataToStoreRef := func(tc *testCase) {
- fakeProvider.SetSecretFn = func() error {
- return nil
- }
- // Create a second store
- secondStoreName := "second-store"
- secondStore := &esv1.SecretStore{
- ObjectMeta: metav1.ObjectMeta{
- Name: secondStoreName,
- Namespace: PushSecretNamespace,
- },
- TypeMeta: metav1.TypeMeta{
- Kind: "SecretStore",
- },
- Spec: esv1.SecretStoreSpec{
- Provider: &esv1.SecretStoreProvider{
- Fake: &esv1.FakeProvider{
- Data: []esv1.FakeProviderData{},
- },
- },
- },
- }
- tc.secret.Data = map[string][]byte{
- testDBHost: []byte(testLocalhost),
- testAPIKey: []byte("secret123"),
- testAppName: []byte("myapp"),
- }
- // Configure multiple stores
- tc.pushsecret.Spec.SecretStoreRefs = []v1alpha1.PushSecretStoreRef{
- {Name: PushSecretStore, Kind: "SecretStore"},
- {Name: secondStoreName, Kind: "SecretStore"},
- }
- tc.pushsecret.Spec.Data = nil
- tc.pushsecret.Spec.DataTo = []v1alpha1.PushSecretDataTo{
- {
- // Entry targeting first store only
- StoreRef: &v1alpha1.PushSecretStoreRef{
- Name: PushSecretStore,
- Kind: "SecretStore",
- },
- Match: &v1alpha1.PushSecretDataToMatch{
- RegExp: testDBRegexp,
- },
- },
- {
- // Entry targeting second store only
- StoreRef: &v1alpha1.PushSecretStoreRef{
- Name: secondStoreName,
- Kind: "SecretStore",
- },
- Match: &v1alpha1.PushSecretDataToMatch{
- RegExp: "^api-.*",
- },
- },
- {
- // Entry targeting first store (app-name)
- StoreRef: &v1alpha1.PushSecretStoreRef{
- Name: PushSecretStore,
- Kind: "SecretStore",
- },
- Match: &v1alpha1.PushSecretDataToMatch{
- RegExp: "^app-.*",
- },
- },
- {
- // Entry targeting second store (app-name)
- StoreRef: &v1alpha1.PushSecretStoreRef{
- Name: secondStoreName,
- Kind: "SecretStore",
- },
- Match: &v1alpha1.PushSecretDataToMatch{
- RegExp: "^app-.*",
- },
- },
- }
- // Second store is created by test harness via tc.managedStore2 so it exists before PushSecret
- tc.managedStore2 = secondStore
- tc.assert = func(ps *v1alpha1.PushSecret, secret *v1.Secret) bool {
- updatedPS := &v1alpha1.PushSecret{}
- psKey := types.NamespacedName{Name: PushSecretName, Namespace: PushSecretNamespace}
- Eventually(func() bool {
- By("checking if secrets are synced to correct stores")
- err := k8sClient.Get(context.Background(), psKey, updatedPS)
- if err != nil {
- return false
- }
- firstStoreKey := fmt.Sprintf(storePrefixTemplate, PushSecretStore)
- secondStoreKey := "SecretStore/" + secondStoreName
- firstStoreSynced := updatedPS.Status.SyncedPushSecrets[firstStoreKey]
- secondStoreSynced := updatedPS.Status.SyncedPushSecrets[secondStoreKey]
- // First store should have: db-host and app-name (both from storeRef entries)
- _, hasDbHost := firstStoreSynced[testDBHost]
- _, hasAppNameFirst := firstStoreSynced[testAppName]
- // First store should NOT have api-key (targeted to second store)
- _, hasApiKeyFirst := firstStoreSynced[testAPIKey]
- // Second store should have: api-key and app-name (both from storeRef entries)
- _, hasApiKey := secondStoreSynced[testAPIKey]
- _, hasAppNameSecond := secondStoreSynced[testAppName]
- // Second store should NOT have db-host (targeted to first store)
- _, hasDbHostSecond := secondStoreSynced[testDBHost]
- return hasDbHost && hasAppNameFirst && !hasApiKeyFirst &&
- hasApiKey && hasAppNameSecond && !hasDbHostSecond
- }, time.Second*10, time.Second).Should(BeTrue())
- return true
- }
- }
- // Test: Template creates new keys, dataTo matches them
- templateCreatesKeysThenDataToMatches := func(tc *testCase) {
- fakeProvider.SetSecretFn = func() error {
- return nil
- }
- // Source secret has individual components
- tc.secret.Data = map[string][]byte{
- "db_host": []byte(testLocalhost),
- "db_port": []byte("3306"),
- }
- // Template creates connection string from components
- tc.pushsecret.Spec.Template = &esv1.ExternalSecretTemplate{
- Data: map[string]string{
- "mysql-connection": "mysql://{{ .db_host }}:{{ .db_port }}/mydb",
- },
- }
- // dataTo only matches keys ending in -connection (created by template)
- tc.pushsecret.Spec.Data = nil
- tc.pushsecret.Spec.DataTo = []v1alpha1.PushSecretDataTo{
- {
- StoreRef: &v1alpha1.PushSecretStoreRef{
- Name: PushSecretStore,
- },
- Match: &v1alpha1.PushSecretDataToMatch{
- RegExp: ".*-connection$",
- },
- },
- }
- tc.assert = func(ps *v1alpha1.PushSecret, secret *v1.Secret) bool {
- Eventually(func() bool {
- By("checking template key was pushed, not originals")
- setSecretArgs := fakeProvider.GetPushSecretData()
- // Only mysql-connection should be pushed
- _, hasConnection := setSecretArgs["mysql-connection"]
- _, hasDbHost := setSecretArgs["db_host"]
- _, hasDbPort := setSecretArgs["db_port"]
- return hasConnection && !hasDbHost && !hasDbPort
- }, timeout, time.Second).Should(BeTrue())
- cond := GetPushSecretCondition(ps.Status.Conditions, v1alpha1.PushSecretReady)
- return cond != nil && cond.Status == v1.ConditionTrue && cond.Reason == v1alpha1.ReasonSynced
- }
- }
- // Test: Template + dataTo + explicit data combined
- templateWithDataToAndExplicitData := func(tc *testCase) {
- fakeProvider.SetSecretFn = func() error {
- return nil
- }
- tc.secret.Data = map[string][]byte{
- "token": []byte("abc123"),
- "config-timeout": []byte("30s"),
- "config-retries": []byte("3"),
- }
- // Template creates api-key from token
- tc.pushsecret.Spec.Template = &esv1.ExternalSecretTemplate{
- Data: map[string]string{
- testAPIKey: "Bearer {{ .token }}",
- },
- }
- // dataTo matches config-* keys
- tc.pushsecret.Spec.DataTo = []v1alpha1.PushSecretDataTo{
- {
- StoreRef: &v1alpha1.PushSecretStoreRef{
- Name: PushSecretStore,
- },
- Match: &v1alpha1.PushSecretDataToMatch{
- RegExp: "^config-.*",
- },
- },
- }
- // Explicit data for api-key with custom remote path
- tc.pushsecret.Spec.Data = []v1alpha1.PushSecretData{
- {
- Match: v1alpha1.PushSecretMatch{
- SecretKey: testAPIKey,
- RemoteRef: v1alpha1.PushSecretRemoteRef{
- RemoteKey: "credentials/api-key",
- },
- },
- },
- }
- tc.assert = func(ps *v1alpha1.PushSecret, secret *v1.Secret) bool {
- Eventually(func() bool {
- By("checking all expected keys were pushed")
- setSecretArgs := fakeProvider.GetPushSecretData()
- // api-key should be at credentials/api-key (explicit), config-* from dataTo
- _, hasApiKey := setSecretArgs["credentials/api-key"]
- _, hasTimeout := setSecretArgs["config-timeout"]
- _, hasRetries := setSecretArgs["config-retries"]
- // Original token should NOT be pushed
- _, hasToken := setSecretArgs["token"]
- return hasApiKey && hasTimeout && hasRetries && !hasToken
- }, timeout, time.Second).Should(BeTrue())
- cond := GetPushSecretCondition(ps.Status.Conditions, v1alpha1.PushSecretReady)
- return cond != nil && cond.Status == v1.ConditionTrue && cond.Reason == v1alpha1.ReasonSynced
- }
- }
- failDataToDuplicateAcrossEntries := func(tc *testCase) {
- tc.secret.Data = map[string][]byte{
- testDBHost: []byte(testLocalhost),
- testDBPort: []byte("5432"),
- }
- // Create two dataTo entries that both produce the same remote key "app/config"
- tc.pushsecret.Spec.Data = nil
- tc.pushsecret.Spec.DataTo = []v1alpha1.PushSecretDataTo{
- {
- StoreRef: &v1alpha1.PushSecretStoreRef{
- Name: PushSecretStore,
- },
- Match: &v1alpha1.PushSecretDataToMatch{
- RegExp: "^db-host$",
- },
- Rewrite: []v1alpha1.PushSecretRewrite{
- {
- Regexp: &esv1.ExternalSecretRewriteRegexp{
- Source: ".*",
- Target: "app/config",
- },
- },
- },
- },
- {
- StoreRef: &v1alpha1.PushSecretStoreRef{
- Name: PushSecretStore,
- },
- Match: &v1alpha1.PushSecretDataToMatch{
- RegExp: "^db-port$",
- },
- Rewrite: []v1alpha1.PushSecretRewrite{
- {
- Regexp: &esv1.ExternalSecretRewriteRegexp{
- Source: ".*",
- Target: "app/config",
- },
- },
- },
- },
- }
- tc.assert = func(ps *v1alpha1.PushSecret, secret *v1.Secret) bool {
- Eventually(func() bool {
- By("checking if PushSecret has error condition for duplicate remote keys")
- cond := GetPushSecretCondition(ps.Status.Conditions, v1alpha1.PushSecretReady)
- if cond == nil {
- return false
- }
- // Should have error status
- return cond.Status == v1.ConditionFalse && cond.Reason == v1alpha1.ReasonErrored
- }, time.Second*10, time.Second).Should(BeTrue())
- return true
- }
- }
- failDataToAndDataDuplicateRemoteKey := func(tc *testCase) {
- tc.secret.Data = map[string][]byte{
- testDBHost: []byte(testLocalhost),
- testAPIKey: []byte("secret123"),
- }
- // Create dataTo entry and explicit data that map to the same remote key
- tc.pushsecret.Spec.DataTo = []v1alpha1.PushSecretDataTo{
- {
- StoreRef: &v1alpha1.PushSecretStoreRef{
- Name: PushSecretStore,
- },
- Match: &v1alpha1.PushSecretDataToMatch{
- RegExp: "^db-host$",
- },
- Rewrite: []v1alpha1.PushSecretRewrite{
- {
- Regexp: &esv1.ExternalSecretRewriteRegexp{
- Source: ".*",
- Target: "myapp/config",
- },
- },
- },
- },
- }
- tc.pushsecret.Spec.Data = []v1alpha1.PushSecretData{
- {
- Match: v1alpha1.PushSecretMatch{
- SecretKey: testAPIKey,
- RemoteRef: v1alpha1.PushSecretRemoteRef{
- RemoteKey: "myapp/config", // Same remote key as dataTo produces
- },
- },
- },
- }
- tc.assert = func(ps *v1alpha1.PushSecret, secret *v1.Secret) bool {
- Eventually(func() bool {
- By("checking if PushSecret has error condition for duplicate remote keys")
- cond := GetPushSecretCondition(ps.Status.Conditions, v1alpha1.PushSecretReady)
- if cond == nil {
- return false
- }
- // Should have error status
- return cond.Status == v1.ConditionFalse && cond.Reason == v1alpha1.ReasonErrored
- }, time.Second*10, time.Second).Should(BeTrue())
- return true
- }
- }
- // Note: failDataToMissingStoreRef test removed - missing storeRef is now
- // blocked by CEL validation at admission time
- failDataToStoreRefNotInList := func(tc *testCase) {
- tc.secret.Data = map[string][]byte{
- "key1": []byte("value1"),
- }
- // dataTo with storeRef that doesn't exist in secretStoreRefs
- tc.pushsecret.Spec.Data = nil
- tc.pushsecret.Spec.DataTo = []v1alpha1.PushSecretDataTo{
- {
- StoreRef: &v1alpha1.PushSecretStoreRef{
- Name: "non-existent-store", // Not in secretStoreRefs
- },
- },
- }
- tc.assert = func(ps *v1alpha1.PushSecret, secret *v1.Secret) bool {
- Eventually(func() bool {
- By("checking PushSecret has error for invalid storeRef")
- cond := GetPushSecretCondition(ps.Status.Conditions, v1alpha1.PushSecretReady)
- if cond == nil {
- return false
- }
- return cond.Status == v1.ConditionFalse && cond.Reason == v1alpha1.ReasonErrored
- }, time.Second*10, time.Second).Should(BeTrue())
- return true
- }
- }
- failDataToNamedStoreRefWithLabelSelectorRefs := func(tc *testCase) {
- tc.secret.Data = map[string][]byte{
- "key1": []byte("value1"),
- }
- tc.pushsecret.Spec.SecretStoreRefs = []v1alpha1.PushSecretStoreRef{
- {
- LabelSelector: &metav1.LabelSelector{
- MatchLabels: map[string]string{
- "env": "prod",
- },
- },
- },
- }
- tc.pushsecret.Spec.Data = nil
- tc.pushsecret.Spec.DataTo = []v1alpha1.PushSecretDataTo{
- {
- StoreRef: &v1alpha1.PushSecretStoreRef{
- Name: "totally-nonexistent-store",
- },
- },
- }
- tc.assert = func(ps *v1alpha1.PushSecret, secret *v1.Secret) bool {
- Eventually(func() bool {
- By("checking PushSecret rejects named storeRef not in secretStoreRefs")
- cond := GetPushSecretCondition(ps.Status.Conditions, v1alpha1.PushSecretReady)
- if cond == nil {
- return false
- }
- return cond.Status == v1.ConditionFalse && cond.Reason == v1alpha1.ReasonErrored
- }, time.Second*10, time.Second).Should(BeTrue())
- return true
- }
- }
- failDataToLabelSelectorMatchesNoStore := func(tc *testCase) {
- tc.store = &esv1.SecretStore{
- ObjectMeta: metav1.ObjectMeta{
- Name: PushSecretStore,
- Namespace: PushSecretNamespace,
- Labels: map[string]string{
- "env": "staging",
- },
- },
- TypeMeta: metav1.TypeMeta{
- Kind: "SecretStore",
- },
- Spec: esv1.SecretStoreSpec{
- Provider: &esv1.SecretStoreProvider{
- Fake: &esv1.FakeProvider{
- Data: []esv1.FakeProviderData{},
- },
- },
- },
- }
- tc.secret.Data = map[string][]byte{
- "key1": []byte("value1"),
- }
- tc.pushsecret.Spec.SecretStoreRefs = []v1alpha1.PushSecretStoreRef{
- {
- LabelSelector: &metav1.LabelSelector{
- MatchLabels: map[string]string{
- "env": "staging",
- },
- },
- },
- }
- tc.pushsecret.Spec.Data = nil
- tc.pushsecret.Spec.DataTo = []v1alpha1.PushSecretDataTo{
- {
- StoreRef: &v1alpha1.PushSecretStoreRef{
- LabelSelector: &metav1.LabelSelector{
- MatchLabels: map[string]string{
- "env": "production",
- },
- },
- },
- },
- }
- tc.assert = func(ps *v1alpha1.PushSecret, secret *v1.Secret) bool {
- Eventually(func() bool {
- cond := GetPushSecretCondition(ps.Status.Conditions, v1alpha1.PushSecretReady)
- if cond == nil {
- return false
- }
- return cond.Status == v1.ConditionFalse && cond.Reason == v1alpha1.ReasonErrored
- }, time.Second*10, time.Second).Should(BeTrue())
- return true
- }
- }
- syncWithDataToLabelSelector := func(tc *testCase) {
- fakeProvider.SetSecretFn = func() error {
- return nil
- }
- // Add labels to the store
- tc.store = &esv1.SecretStore{
- ObjectMeta: metav1.ObjectMeta{
- Name: PushSecretStore,
- Namespace: PushSecretNamespace,
- Labels: map[string]string{
- "env": "test",
- },
- },
- TypeMeta: metav1.TypeMeta{
- Kind: "SecretStore",
- },
- Spec: esv1.SecretStoreSpec{
- Provider: &esv1.SecretStoreProvider{
- Fake: &esv1.FakeProvider{
- Data: []esv1.FakeProviderData{},
- },
- },
- },
- }
- tc.secret.Data = map[string][]byte{
- "key1": []byte("value1"),
- }
- // Use labelSelector in secretStoreRefs to select stores by labels
- tc.pushsecret.Spec.SecretStoreRefs = []v1alpha1.PushSecretStoreRef{
- {
- LabelSelector: &metav1.LabelSelector{
- MatchLabels: map[string]string{
- "env": "test",
- },
- },
- },
- }
- // Use labelSelector in dataTo to target stores with matching labels
- tc.pushsecret.Spec.Data = nil
- tc.pushsecret.Spec.DataTo = []v1alpha1.PushSecretDataTo{
- {
- StoreRef: &v1alpha1.PushSecretStoreRef{
- LabelSelector: &metav1.LabelSelector{
- MatchLabels: map[string]string{
- "env": "test",
- },
- },
- },
- },
- }
- tc.assert = func(ps *v1alpha1.PushSecret, secret *v1.Secret) bool {
- Eventually(func() bool {
- By("checking key was pushed via labelSelector")
- setSecretArgs := fakeProvider.GetPushSecretData()
- return len(setSecretArgs) == 1
- }, time.Second*10, time.Second).Should(BeTrue())
- return true
- }
- }
- syncWithDataToDuplicateValues := func(tc *testCase) {
- fakeProvider.SetSecretFn = func() error {
- return nil
- }
- // Keys with same value - tests deterministic key mapping
- tc.secret.Data = map[string][]byte{
- testDBHost: []byte("same-value"),
- "cache-host": []byte("same-value"),
- }
- tc.pushsecret.Spec.Data = nil
- tc.pushsecret.Spec.DataTo = []v1alpha1.PushSecretDataTo{
- {
- StoreRef: &v1alpha1.PushSecretStoreRef{
- Name: PushSecretStore,
- },
- Rewrite: []v1alpha1.PushSecretRewrite{
- {
- Regexp: &esv1.ExternalSecretRewriteRegexp{
- Source: "-host$",
- Target: "/endpoint",
- },
- },
- },
- },
- }
- tc.assert = func(ps *v1alpha1.PushSecret, secret *v1.Secret) bool {
- Eventually(func() bool {
- By("checking both keys are rewritten despite same value")
- setSecretArgs := fakeProvider.GetPushSecretData()
- if len(setSecretArgs) != 2 {
- return false
- }
- _, hasDb := setSecretArgs["db/endpoint"]
- _, hasCache := setSecretArgs["cache/endpoint"]
- return hasDb && hasCache
- }, time.Second*10, time.Second).Should(BeTrue())
- return true
- }
- }
- syncWithDataToMultipleRewrites := func(tc *testCase) {
- fakeProvider.SetSecretFn = func() error {
- return nil
- }
- tc.secret.Data = map[string][]byte{
- "db-username": []byte(testAdminUser),
- }
- // Chain multiple rewrites
- tc.pushsecret.Spec.Data = nil
- tc.pushsecret.Spec.DataTo = []v1alpha1.PushSecretDataTo{
- {
- StoreRef: &v1alpha1.PushSecretStoreRef{
- Name: PushSecretStore,
- },
- Rewrite: []v1alpha1.PushSecretRewrite{
- {
- // First rewrite: remove db- prefix
- Regexp: &esv1.ExternalSecretRewriteRegexp{
- Source: "^db-",
- Target: "",
- },
- },
- {
- // Second rewrite: add app/ prefix
- Regexp: &esv1.ExternalSecretRewriteRegexp{
- Source: "^",
- Target: "app/",
- },
- },
- },
- },
- }
- tc.assert = func(ps *v1alpha1.PushSecret, secret *v1.Secret) bool {
- Eventually(func() bool {
- By("checking if multiple rewrites were applied")
- setSecretArgs := fakeProvider.GetPushSecretData()
- if len(setSecretArgs) != 1 {
- return false
- }
- // db-username -> username -> app/username
- _, ok := setSecretArgs["app/username"]
- return ok
- }, time.Second*10, time.Second).Should(BeTrue())
- return true
- }
- }
- // dataTo bundle mode tests (remoteKey set → all matched keys bundled as JSON)
- syncWithDataToBundleAllKeys := func(tc *testCase) {
- fakeProvider.SetSecretFn = func() error {
- return nil
- }
- tc.secret.Data = map[string][]byte{
- "DB_HOST": []byte(testLocalhost),
- "DB_USER": []byte(testAdminUser),
- }
- tc.pushsecret.Spec.Data = nil
- tc.pushsecret.Spec.DataTo = []v1alpha1.PushSecretDataTo{
- {
- StoreRef: &v1alpha1.PushSecretStoreRef{
- Name: PushSecretStore,
- },
- RemoteKey: "secrets-sync-target",
- },
- }
- tc.assert = func(ps *v1alpha1.PushSecret, secret *v1.Secret) bool {
- Eventually(func() bool {
- By("checking that all keys were bundled into a single provider secret")
- setSecretArgs := fakeProvider.GetPushSecretData()
- // Only one provider secret should be created
- if len(setSecretArgs) != 1 {
- return false
- }
- if bundled, ok := setSecretArgs["secrets-sync-target"]; ok {
- // Value should be a JSON object containing both keys
- var decoded map[string]string
- if json.Unmarshal(bundled.Value, &decoded) != nil {
- return false
- }
- return decoded["DB_HOST"] == testLocalhost && decoded["DB_USER"] == testAdminUser
- }
- return false
- }, time.Second*10, time.Second).Should(BeTrue())
- return true
- }
- }
- syncWithDataToBundleWithRegexFilter := func(tc *testCase) {
- fakeProvider.SetSecretFn = func() error {
- return nil
- }
- tc.secret.Data = map[string][]byte{
- "DB_HOST": []byte(testLocalhost),
- "DB_USER": []byte(testAdminUser),
- "APP_NAME": []byte("myapp"),
- }
- tc.pushsecret.Spec.Data = nil
- tc.pushsecret.Spec.DataTo = []v1alpha1.PushSecretDataTo{
- {
- StoreRef: &v1alpha1.PushSecretStoreRef{
- Name: PushSecretStore,
- },
- RemoteKey: "db-bundle",
- Match: &v1alpha1.PushSecretDataToMatch{
- RegExp: "^DB_",
- },
- },
- }
- tc.assert = func(ps *v1alpha1.PushSecret, secret *v1.Secret) bool {
- Eventually(func() bool {
- By("checking that only matched keys were bundled")
- setSecretArgs := fakeProvider.GetPushSecretData()
- if len(setSecretArgs) != 1 {
- return false
- }
- if bundled, ok := setSecretArgs["db-bundle"]; ok {
- var decoded map[string]string
- if json.Unmarshal(bundled.Value, &decoded) != nil {
- return false
- }
- // Only DB_* keys should be in the bundle, not APP_NAME
- _, hasApp := decoded["APP_NAME"]
- return decoded["DB_HOST"] == testLocalhost &&
- decoded["DB_USER"] == testAdminUser &&
- !hasApp
- }
- return false
- }, time.Second*10, time.Second).Should(BeTrue())
- return true
- }
- }
- syncWithDataToBundleAndPerKeyMixed := func(tc *testCase) {
- fakeProvider.SetSecretFn = func() error {
- return nil
- }
- tc.secret.Data = map[string][]byte{
- "DB_HOST": []byte(testLocalhost),
- "DB_USER": []byte(testAdminUser),
- "API_KEY": []byte("secret-key"),
- }
- tc.pushsecret.Spec.Data = nil
- tc.pushsecret.Spec.DataTo = []v1alpha1.PushSecretDataTo{
- {
- // Bundle mode: DB_* keys → single JSON secret
- StoreRef: &v1alpha1.PushSecretStoreRef{
- Name: PushSecretStore,
- },
- RemoteKey: "db-config",
- Match: &v1alpha1.PushSecretDataToMatch{
- RegExp: "^DB_",
- },
- },
- {
- // Per-key mode: API_KEY → individual secret
- StoreRef: &v1alpha1.PushSecretStoreRef{
- Name: PushSecretStore,
- },
- Match: &v1alpha1.PushSecretDataToMatch{
- RegExp: "^API_",
- },
- },
- }
- tc.assert = func(ps *v1alpha1.PushSecret, secret *v1.Secret) bool {
- Eventually(func() bool {
- By("checking bundle and per-key entries coexist")
- setSecretArgs := fakeProvider.GetPushSecretData()
- // db-config (bundle) + API_KEY (per-key) = 2 provider secrets
- if len(setSecretArgs) != 2 {
- return false
- }
- if bundled, ok := setSecretArgs["db-config"]; ok {
- var decoded map[string]string
- if json.Unmarshal(bundled.Value, &decoded) != nil {
- return false
- }
- if decoded["DB_HOST"] != testLocalhost || decoded["DB_USER"] != testAdminUser {
- return false
- }
- _, hasAPIKey := setSecretArgs["API_KEY"]
- return hasAPIKey
- }
- return false
- }, 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.managedStore2 != nil {
- Expect(k8sClient.Create(ctx, tc.managedStore2)).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 secrets with properties and update status correctly", syncAndDeleteWithProperties),
- Entry("should delete after DeletionPolicy changed from Delete to None", syncChangePolicyAndDeleteSuccessfully),
- Entry("should cleanup provider secrets when source Secret is deleted", deleteProviderSecretsOnSourceSecretDeleted),
- 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),
- Entry("should sync with dataTo matching all keys", syncWithDataToMatchAll),
- Entry("should sync with dataTo using regex pattern", syncWithDataToRegex),
- Entry("should sync with dataTo and regexp rewrite", syncWithDataToRegexpRewrite),
- Entry("should sync with dataTo and transform rewrite", syncWithDataToTransformRewrite),
- Entry("should override dataTo with explicit data", syncDataToWithDataOverride),
- Entry("should sync with dataTo and multiple chained rewrites", syncWithDataToMultipleRewrites),
- Entry("should fail with invalid regex in dataTo", failDataToInvalidRegex),
- Entry("should sync with dataTo and conversion strategy", syncWithDataToConversionStrategy),
- Entry("should sync with dataTo storeRef targeting specific stores", syncWithDataToStoreRef),
- Entry("should match dataTo against template-created keys", templateCreatesKeysThenDataToMatches),
- Entry("should combine template, dataTo and explicit data", templateWithDataToAndExplicitData),
- Entry("should fail with duplicate remote keys across dataTo entries", failDataToDuplicateAcrossEntries),
- Entry("should fail with duplicate remote keys between dataTo and explicit data", failDataToAndDataDuplicateRemoteKey),
- Entry("should fail with dataTo storeRef not in secretStoreRefs", failDataToStoreRefNotInList),
- Entry("should fail with named dataTo storeRef when secretStoreRefs only has labelSelector", failDataToNamedStoreRefWithLabelSelectorRefs),
- Entry("should fail with dataTo labelSelector matching no resolved store", failDataToLabelSelectorMatchesNoStore),
- Entry("should sync with dataTo using labelSelector", syncWithDataToLabelSelector),
- Entry("should sync with dataTo when keys have duplicate values", syncWithDataToDuplicateValues),
- Entry("should bundle all keys into single provider secret with dataTo remoteKey", syncWithDataToBundleAllKeys),
- Entry("should bundle only regex-matched keys with dataTo remoteKey and match filter", syncWithDataToBundleWithRegexFilter),
- Entry("should mix bundle mode and per-key mode in the same dataTo list", syncWithDataToBundleAndPerKeyMixed),
- )
- It("should reject dataTo with both remoteKey and rewrite at admission", func() {
- ns, err := ctest.CreateNamespace("test-ns", k8sClient)
- Expect(err).ToNot(HaveOccurred())
- ps := &v1alpha1.PushSecret{
- ObjectMeta: metav1.ObjectMeta{
- Name: PushSecretName,
- Namespace: ns,
- },
- Spec: v1alpha1.PushSecretSpec{
- SecretStoreRefs: []v1alpha1.PushSecretStoreRef{
- {Name: PushSecretStore},
- },
- Selector: v1alpha1.PushSecretSelector{
- Secret: &v1alpha1.PushSecretSecret{Name: SecretName},
- },
- DataTo: []v1alpha1.PushSecretDataTo{
- {
- StoreRef: &v1alpha1.PushSecretStoreRef{
- Name: PushSecretStore,
- },
- RemoteKey: "my-bundle",
- Rewrite: []v1alpha1.PushSecretRewrite{
- {
- Regexp: &esv1.ExternalSecretRewriteRegexp{
- Source: "^",
- Target: "prefix/",
- },
- },
- },
- },
- },
- },
- }
- err = k8sClient.Create(context.Background(), ps)
- Expect(err).To(HaveOccurred())
- Expect(err.Error()).To(ContainSubstring("remoteKey and rewrite are mutually exclusive"))
- })
- })
- 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
- 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, _ *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),
- )
- })
- var _ = Describe("mergeDataEntries unit tests", func() {
- Describe("resolveSourceKeyConflicts", func() {
- It("should let explicit data override dataTo for same source key", func() {
- secret := &v1.Secret{Data: map[string][]byte{"foo": []byte("v1"), "bar": []byte("v2")}}
- dataTo := []v1alpha1.PushSecretData{
- {Match: v1alpha1.PushSecretMatch{SecretKey: "foo", RemoteRef: v1alpha1.PushSecretRemoteRef{RemoteKey: "dataTo/foo"}}},
- {Match: v1alpha1.PushSecretMatch{SecretKey: "bar", RemoteRef: v1alpha1.PushSecretRemoteRef{RemoteKey: "dataTo/bar"}}},
- }
- explicit := []v1alpha1.PushSecretData{
- {Match: v1alpha1.PushSecretMatch{SecretKey: "foo", RemoteRef: v1alpha1.PushSecretRemoteRef{RemoteKey: "explicit/foo"}}},
- }
- result := resolveSourceKeyConflicts(dataTo, explicit, secret)
- Expect(result).To(HaveLen(2))
- keys := make(map[string]string)
- for _, d := range result {
- keys[d.GetSecretKey()] = d.GetRemoteKey()
- }
- Expect(keys["bar"]).To(Equal("dataTo/bar"))
- Expect(keys["foo"]).To(Equal("explicit/foo"))
- })
- It("should keep all entries when no conflicts", func() {
- secret := &v1.Secret{Data: map[string][]byte{"a": []byte("v1"), "b": []byte("v2")}}
- dataTo := []v1alpha1.PushSecretData{
- {Match: v1alpha1.PushSecretMatch{SecretKey: "a", RemoteRef: v1alpha1.PushSecretRemoteRef{RemoteKey: "a"}}},
- }
- explicit := []v1alpha1.PushSecretData{
- {Match: v1alpha1.PushSecretMatch{SecretKey: "b", RemoteRef: v1alpha1.PushSecretRemoteRef{RemoteKey: "b"}}},
- }
- result := resolveSourceKeyConflicts(dataTo, explicit, secret)
- Expect(result).To(HaveLen(2))
- })
- It("should handle empty dataTo", func() {
- secret := &v1.Secret{Data: map[string][]byte{"x": []byte("v1")}}
- explicit := []v1alpha1.PushSecretData{
- {Match: v1alpha1.PushSecretMatch{SecretKey: "x", RemoteRef: v1alpha1.PushSecretRemoteRef{RemoteKey: "x"}}},
- }
- result := resolveSourceKeyConflicts(nil, explicit, secret)
- Expect(result).To(HaveLen(1))
- Expect(result[0].GetSecretKey()).To(Equal("x"))
- })
- It("should handle empty explicit", func() {
- secret := &v1.Secret{Data: map[string][]byte{"y": []byte("v1")}}
- dataTo := []v1alpha1.PushSecretData{
- {Match: v1alpha1.PushSecretMatch{SecretKey: "y", RemoteRef: v1alpha1.PushSecretRemoteRef{RemoteKey: "y"}}},
- }
- result := resolveSourceKeyConflicts(dataTo, nil, secret)
- Expect(result).To(HaveLen(1))
- Expect(result[0].GetSecretKey()).To(Equal("y"))
- })
- It("should resolve conflicts when explicit data uses ConversionStrategy", func() {
- secret := &v1.Secret{Data: map[string][]byte{
- "some_U002D_key": []byte("value"),
- "other": []byte("other-value"),
- }}
- dataTo := []v1alpha1.PushSecretData{
- {Match: v1alpha1.PushSecretMatch{SecretKey: "some_U002D_key", RemoteRef: v1alpha1.PushSecretRemoteRef{RemoteKey: "dataTo/some-key"}}},
- {Match: v1alpha1.PushSecretMatch{SecretKey: "other", RemoteRef: v1alpha1.PushSecretRemoteRef{RemoteKey: "dataTo/other"}}},
- }
- explicit := []v1alpha1.PushSecretData{
- {
- ConversionStrategy: v1alpha1.PushSecretConversionReverseUnicode,
- Match: v1alpha1.PushSecretMatch{SecretKey: "some-key", RemoteRef: v1alpha1.PushSecretRemoteRef{RemoteKey: "explicit/some-key"}},
- },
- }
- result := resolveSourceKeyConflicts(dataTo, explicit, secret)
- Expect(result).To(HaveLen(2))
- keys := make(map[string]string)
- for _, d := range result {
- keys[d.GetSecretKey()] = d.GetRemoteKey()
- }
- Expect(keys["other"]).To(Equal("dataTo/other"))
- Expect(keys["some-key"]).To(Equal("explicit/some-key"))
- })
- })
- Describe("validateRemoteKeyUniqueness", func() {
- It("should pass for unique remote keys", func() {
- entries := []v1alpha1.PushSecretData{
- {Match: v1alpha1.PushSecretMatch{SecretKey: "a", RemoteRef: v1alpha1.PushSecretRemoteRef{RemoteKey: "remote-a"}}},
- {Match: v1alpha1.PushSecretMatch{SecretKey: "b", RemoteRef: v1alpha1.PushSecretRemoteRef{RemoteKey: "remote-b"}}},
- }
- err := validateRemoteKeyUniqueness(entries)
- Expect(err).ToNot(HaveOccurred())
- })
- It("should fail for duplicate remote keys", func() {
- entries := []v1alpha1.PushSecretData{
- {Match: v1alpha1.PushSecretMatch{SecretKey: "a", RemoteRef: v1alpha1.PushSecretRemoteRef{RemoteKey: "shared"}}},
- {Match: v1alpha1.PushSecretMatch{SecretKey: "b", RemoteRef: v1alpha1.PushSecretRemoteRef{RemoteKey: "shared"}}},
- }
- err := validateRemoteKeyUniqueness(entries)
- Expect(err).To(HaveOccurred())
- Expect(err.Error()).To(ContainSubstring(testDuplicateRemoteKeyErr))
- })
- It("should pass for same remote key with different properties", func() {
- entries := []v1alpha1.PushSecretData{
- {Match: v1alpha1.PushSecretMatch{SecretKey: "a", RemoteRef: v1alpha1.PushSecretRemoteRef{RemoteKey: "shared", Property: "field1"}}},
- {Match: v1alpha1.PushSecretMatch{SecretKey: "b", RemoteRef: v1alpha1.PushSecretRemoteRef{RemoteKey: "shared", Property: "field2"}}},
- }
- err := validateRemoteKeyUniqueness(entries)
- Expect(err).ToNot(HaveOccurred())
- })
- It("should fail for same remote key and same property", func() {
- entries := []v1alpha1.PushSecretData{
- {Match: v1alpha1.PushSecretMatch{SecretKey: "a", RemoteRef: v1alpha1.PushSecretRemoteRef{RemoteKey: "shared", Property: "field"}}},
- {Match: v1alpha1.PushSecretMatch{SecretKey: "b", RemoteRef: v1alpha1.PushSecretRemoteRef{RemoteKey: "shared", Property: "field"}}},
- }
- err := validateRemoteKeyUniqueness(entries)
- Expect(err).To(HaveOccurred())
- Expect(err.Error()).To(ContainSubstring(testDuplicateRemoteKeyErr))
- })
- })
- Describe("mergeDataEntries", func() {
- It("should merge valid entries", func() {
- secret := &v1.Secret{Data: map[string][]byte{"a": []byte("v1"), "b": []byte("v2")}}
- dataTo := []v1alpha1.PushSecretData{
- {Match: v1alpha1.PushSecretMatch{SecretKey: "a", RemoteRef: v1alpha1.PushSecretRemoteRef{RemoteKey: "a"}}},
- }
- explicit := []v1alpha1.PushSecretData{
- {Match: v1alpha1.PushSecretMatch{SecretKey: "b", RemoteRef: v1alpha1.PushSecretRemoteRef{RemoteKey: "b"}}},
- }
- result, err := mergeDataEntries(dataTo, explicit, secret)
- Expect(err).ToNot(HaveOccurred())
- Expect(result).To(HaveLen(2))
- })
- It("should override dataTo with explicit for same source key", func() {
- secret := &v1.Secret{Data: map[string][]byte{"key": []byte("v1")}}
- dataTo := []v1alpha1.PushSecretData{
- {Match: v1alpha1.PushSecretMatch{SecretKey: "key", RemoteRef: v1alpha1.PushSecretRemoteRef{RemoteKey: "dataTo-path"}}},
- }
- explicit := []v1alpha1.PushSecretData{
- {Match: v1alpha1.PushSecretMatch{SecretKey: "key", RemoteRef: v1alpha1.PushSecretRemoteRef{RemoteKey: "explicit-path"}}},
- }
- result, err := mergeDataEntries(dataTo, explicit, secret)
- Expect(err).ToNot(HaveOccurred())
- Expect(result).To(HaveLen(1))
- Expect(result[0].GetRemoteKey()).To(Equal("explicit-path"))
- })
- It("should fail for remote key conflict after merge", func() {
- secret := &v1.Secret{Data: map[string][]byte{"a": []byte("v1"), "b": []byte("v2")}}
- dataTo := []v1alpha1.PushSecretData{
- {Match: v1alpha1.PushSecretMatch{SecretKey: "a", RemoteRef: v1alpha1.PushSecretRemoteRef{RemoteKey: "shared"}}},
- }
- explicit := []v1alpha1.PushSecretData{
- {Match: v1alpha1.PushSecretMatch{SecretKey: "b", RemoteRef: v1alpha1.PushSecretRemoteRef{RemoteKey: "shared"}}},
- }
- _, err := mergeDataEntries(dataTo, explicit, secret)
- Expect(err).To(HaveOccurred())
- Expect(err.Error()).To(ContainSubstring(testDuplicateRemoteKeyErr))
- })
- })
- })
|