| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379 |
- /*
- Licensed under the Apache License, Version 2.0 (the "License");
- you may not use this file except in compliance with the License.
- You may obtain a copy of the License at
- http://www.apache.org/licenses/LICENSE-2.0
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
- */
- package externalsecret
- import (
- "bytes"
- "context"
- "encoding/json"
- "fmt"
- "os"
- "strconv"
- "time"
- . "github.com/onsi/ginkgo/v2"
- . "github.com/onsi/gomega"
- "github.com/prometheus/client_golang/prometheus"
- dto "github.com/prometheus/client_model/go"
- v1 "k8s.io/api/core/v1"
- apiextensions "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
- apierrors "k8s.io/apimachinery/pkg/api/errors"
- metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
- "k8s.io/apimachinery/pkg/types"
- "sigs.k8s.io/controller-runtime/pkg/client"
- esv1beta1 "github.com/external-secrets/external-secrets/apis/externalsecrets/v1beta1"
- 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/externalsecret/esmetrics"
- ctrlmetrics "github.com/external-secrets/external-secrets/pkg/controllers/metrics"
- "github.com/external-secrets/external-secrets/pkg/provider/testing/fake"
- )
- var (
- fakeProvider *fake.Client
- metric dto.Metric
- metricDuration dto.Metric
- timeout = time.Second * 10
- interval = time.Millisecond * 250
- )
- var (
- testSyncCallsTotal *prometheus.CounterVec
- testSyncCallsError *prometheus.CounterVec
- testExternalSecretCondition *prometheus.GaugeVec
- testExternalSecretReconcileDuration *prometheus.GaugeVec
- )
- type testCase struct {
- secretStore esv1beta1.GenericStore
- externalSecret *esv1beta1.ExternalSecret
- targetSecretName string
- // checkCondition should return true if the externalSecret
- // has the expected condition
- checkCondition func(*esv1beta1.ExternalSecret) bool
- // checkExternalSecret is called after the condition has been verified
- // use this to verify the externalSecret
- checkExternalSecret func(*esv1beta1.ExternalSecret)
- // optional. use this to test the secret value
- checkSecret func(*esv1beta1.ExternalSecret, *v1.Secret)
- }
- type testTweaks func(*testCase)
- var _ = Describe("Kind=secret existence logic", func() {
- type testCase struct {
- Name string
- Input v1.Secret
- ExpectedOutput bool
- }
- tests := []testCase{
- {
- Name: "Should not be valid in case of missing uid",
- Input: v1.Secret{},
- ExpectedOutput: false,
- },
- {
- Name: "A nil annotation should not be valid",
- Input: v1.Secret{
- ObjectMeta: metav1.ObjectMeta{
- UID: "xxx",
- Annotations: map[string]string{},
- },
- },
- ExpectedOutput: false,
- },
- {
- Name: "A nil annotation should not be valid",
- Input: v1.Secret{
- ObjectMeta: metav1.ObjectMeta{
- UID: "xxx",
- Annotations: map[string]string{},
- },
- },
- ExpectedOutput: false,
- },
- {
- Name: "An invalid annotation hash should not be valid",
- Input: v1.Secret{
- ObjectMeta: metav1.ObjectMeta{
- UID: "xxx",
- Annotations: map[string]string{
- esv1beta1.AnnotationDataHash: "xxxxxx",
- },
- },
- },
- ExpectedOutput: false,
- },
- {
- Name: "A valid config map should return true",
- Input: v1.Secret{
- ObjectMeta: metav1.ObjectMeta{
- UID: "xxx",
- Annotations: map[string]string{
- esv1beta1.AnnotationDataHash: "caa0155759a6a9b3b6ada5a6883ee2bb",
- },
- },
- Data: map[string][]byte{
- "foo": []byte("value1"),
- "bar": []byte("value2"),
- },
- },
- ExpectedOutput: true,
- },
- }
- for _, tt := range tests {
- It(tt.Name, func() {
- Expect(isSecretValid(tt.Input)).To(BeEquivalentTo(tt.ExpectedOutput))
- })
- }
- })
- var _ = Describe("ExternalSecret controller", Serial, func() {
- const (
- ExternalSecretName = "test-es"
- ExternalSecretFQDN = "externalsecrets.external-secrets.io/test-es"
- ExternalSecretStore = "test-store"
- ExternalSecretTargetSecretName = "test-secret"
- FakeManager = "fake.manager"
- expectedSecretVal = "SOMEVALUE was templated"
- targetPropObj = "{{ .targetProperty | toString | upper }} was templated"
- FooValue = "map-foo-value"
- BarValue = "map-bar-value"
- NamespaceLabelKey = "css-test-label-key"
- NamespaceLabelValue = "css-test-label-value"
- )
- var ExternalSecretNamespace 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
- ExternalSecretNamespace, err = ctest.CreateNamespaceWithLabels("test-ns", k8sClient, map[string]string{NamespaceLabelKey: NamespaceLabelValue})
- Expect(err).ToNot(HaveOccurred())
- metric.Reset()
- testSyncCallsTotal.Reset()
- testSyncCallsError.Reset()
- testExternalSecretCondition.Reset()
- testExternalSecretReconcileDuration.Reset()
- fakeProvider.Reset()
- })
- AfterEach(
- func() {
- secretStore := &esv1beta1.SecretStore{}
- secretStoreLookupKey := types.NamespacedName{
- Name: ExternalSecretStore,
- Namespace: ExternalSecretNamespace,
- }
- if err := k8sClient.Get(context.Background(), secretStoreLookupKey, secretStore); err == nil {
- Expect(k8sClient.Delete(context.Background(), secretStore)).To(Succeed())
- }
- clusterSecretStore := &esv1beta1.ClusterSecretStore{}
- clusterSecretStoreLookupKey := types.NamespacedName{
- Name: ExternalSecretStore,
- }
- if err := k8sClient.Get(context.Background(), clusterSecretStoreLookupKey, clusterSecretStore); err == nil {
- Expect(k8sClient.Delete(context.Background(), clusterSecretStore)).To(Succeed())
- }
- Expect(k8sClient.Delete(context.Background(), &v1.Namespace{
- ObjectMeta: metav1.ObjectMeta{
- Name: ExternalSecretNamespace,
- },
- })).To(Succeed())
- },
- )
- const secretVal = "some-value"
- const targetProp = "targetProperty"
- const remoteKey = "barz"
- const remoteProperty = "bang"
- makeDefaultTestcase := func() *testCase {
- return &testCase{
- // default condition: es should be ready
- targetSecretName: ExternalSecretTargetSecretName,
- checkCondition: func(es *esv1beta1.ExternalSecret) bool {
- cond := GetExternalSecretCondition(es.Status, esv1beta1.ExternalSecretReady)
- if cond == nil || cond.Status != v1.ConditionTrue {
- return false
- }
- return true
- },
- checkExternalSecret: func(es *esv1beta1.ExternalSecret) {
- // noop by default
- },
- secretStore: &esv1beta1.SecretStore{
- ObjectMeta: metav1.ObjectMeta{
- Name: ExternalSecretStore,
- Namespace: ExternalSecretNamespace,
- },
- Spec: esv1beta1.SecretStoreSpec{
- Provider: &esv1beta1.SecretStoreProvider{
- AWS: &esv1beta1.AWSProvider{
- Service: esv1beta1.AWSServiceSecretsManager,
- },
- },
- },
- },
- externalSecret: &esv1beta1.ExternalSecret{
- ObjectMeta: metav1.ObjectMeta{
- Name: ExternalSecretName,
- Namespace: ExternalSecretNamespace,
- },
- Spec: esv1beta1.ExternalSecretSpec{
- SecretStoreRef: esv1beta1.SecretStoreRef{
- Name: ExternalSecretStore,
- },
- Target: esv1beta1.ExternalSecretTarget{
- Name: ExternalSecretTargetSecretName,
- },
- Data: []esv1beta1.ExternalSecretData{
- {
- SecretKey: targetProp,
- RemoteRef: esv1beta1.ExternalSecretDataRemoteRef{
- Key: remoteKey,
- Property: remoteProperty,
- },
- },
- },
- },
- },
- }
- }
- // if target Secret name is not specified it should use the ExternalSecret name.
- syncWithoutTargetName := func(tc *testCase) {
- tc.externalSecret.Spec.Target.Name = ""
- tc.checkSecret = func(es *esv1beta1.ExternalSecret, secret *v1.Secret) {
- // check secret name
- Expect(secret.ObjectMeta.Name).To(Equal(ExternalSecretName))
- // check binding secret on external secret
- Expect(es.Status.Binding.Name).To(Equal(secret.ObjectMeta.Name))
- }
- }
- // if target Secret name is not specified it should use the ExternalSecret name.
- syncBigNames := func(tc *testCase) {
- tc.targetSecretName = "this-is-a-very-big-secret-name-that-wouldnt-be-generated-due-to-label-limits"
- tc.externalSecret.Spec.Target.Name = "this-is-a-very-big-secret-name-that-wouldnt-be-generated-due-to-label-limits"
- tc.checkSecret = func(es *esv1beta1.ExternalSecret, secret *v1.Secret) {
- // check binding secret on external secret
- Expect(es.Status.Binding.Name).To(Equal(tc.externalSecret.Spec.Target.Name))
- }
- }
- // the secret name is reflected on the external secret's status as the binding secret
- syncBindingSecret := func(tc *testCase) {
- tc.checkSecret = func(es *esv1beta1.ExternalSecret, secret *v1.Secret) {
- // check binding secret on external secret
- Expect(es.Status.Binding.Name).To(Equal(secret.ObjectMeta.Name))
- }
- }
- // their is no binding secret when a secret is not synced
- skipBindingSecret := func(tc *testCase) {
- tc.externalSecret.Spec.Target.CreationPolicy = esv1beta1.CreatePolicyNone
- tc.checkExternalSecret = func(es *esv1beta1.ExternalSecret) {
- // check binding secret is not set
- Expect(es.Status.Binding.Name).To(BeEmpty())
- }
- }
- // labels and annotations from the Kind=ExternalSecret
- // should be copied over to the Kind=Secret
- syncLabelsAnnotations := func(tc *testCase) {
- const secretVal = "someValue"
- tc.externalSecret.ObjectMeta.Labels = map[string]string{
- "fooobar": "bazz",
- }
- tc.externalSecret.ObjectMeta.Annotations = map[string]string{
- "hihihih": "hehehe",
- }
- fakeProvider.WithGetSecret([]byte(secretVal), nil)
- tc.checkSecret = func(es *esv1beta1.ExternalSecret, secret *v1.Secret) {
- // check value
- Expect(string(secret.Data[targetProp])).To(Equal(secretVal))
- // check labels & annotations
- for k, v := range es.ObjectMeta.Labels {
- Expect(secret.ObjectMeta.Labels).To(HaveKeyWithValue(k, v))
- }
- for k, v := range es.ObjectMeta.Annotations {
- Expect(secret.ObjectMeta.Annotations).To(HaveKeyWithValue(k, v))
- }
- // ownerRef must not not be set!
- Expect(ctest.HasOwnerRef(secret.ObjectMeta, "ExternalSecret", ExternalSecretName)).To(BeTrue())
- }
- }
- checkPrometheusCounters := func(tc *testCase) {
- const secretVal = "someValue"
- fakeProvider.WithGetSecret([]byte(secretVal), nil)
- tc.checkSecret = func(es *esv1beta1.ExternalSecret, secret *v1.Secret) {
- Expect(externalSecretConditionShouldBe(ExternalSecretName, ExternalSecretNamespace, esv1beta1.ExternalSecretReady, v1.ConditionFalse, 0.0)).To(BeTrue())
- Expect(externalSecretConditionShouldBe(ExternalSecretName, ExternalSecretNamespace, esv1beta1.ExternalSecretReady, v1.ConditionTrue, 1.0)).To(BeTrue())
- Eventually(func() bool {
- Expect(testSyncCallsTotal.WithLabelValues(ExternalSecretName, ExternalSecretNamespace).Write(&metric)).To(Succeed())
- Expect(testExternalSecretReconcileDuration.WithLabelValues(ExternalSecretName, ExternalSecretNamespace).Write(&metricDuration)).To(Succeed())
- // three reconciliations: initial sync, status update, secret update
- return metric.GetCounter().GetValue() >= 2.0 && metricDuration.GetGauge().GetValue() > 0.0
- }, timeout, interval).Should(BeTrue())
- }
- }
- // merge with existing secret using creationPolicy=Merge
- // it should NOT have a ownerReference
- // metadata.managedFields with the correct owner should be added to the secret
- mergeWithSecret := func(tc *testCase) {
- const secretVal = "someValue"
- const existingKey = "pre-existing-key"
- existingVal := "pre-existing-value"
- tc.externalSecret.Spec.Target.CreationPolicy = esv1beta1.CreatePolicyMerge
- // create secret beforehand
- Expect(k8sClient.Create(context.Background(), &v1.Secret{
- ObjectMeta: metav1.ObjectMeta{
- Name: ExternalSecretTargetSecretName,
- Namespace: ExternalSecretNamespace,
- },
- Data: map[string][]byte{
- existingKey: []byte(existingVal),
- },
- }, client.FieldOwner(FakeManager))).To(Succeed())
- fakeProvider.WithGetSecret([]byte(secretVal), nil)
- tc.checkSecret = func(es *esv1beta1.ExternalSecret, secret *v1.Secret) {
- // check value
- Expect(string(secret.Data[existingKey])).To(Equal(existingVal))
- Expect(string(secret.Data[targetProp])).To(Equal(secretVal))
- // check labels & annotations
- for k, v := range es.ObjectMeta.Labels {
- Expect(secret.ObjectMeta.Labels).To(HaveKeyWithValue(k, v))
- }
- for k, v := range es.ObjectMeta.Annotations {
- Expect(secret.ObjectMeta.Annotations).To(HaveKeyWithValue(k, v))
- }
- Expect(ctest.HasOwnerRef(secret.ObjectMeta, "ExternalSecret", ExternalSecretFQDN)).To(BeFalse())
- Expect(secret.ObjectMeta.ManagedFields).To(HaveLen(2))
- Expect(ctest.HasFieldOwnership(
- secret.ObjectMeta,
- ExternalSecretFQDN,
- fmt.Sprintf("{\"f:data\":{\"f:targetProperty\":{}},\"f:immutable\":{},\"f:metadata\":{\"f:annotations\":{\"f:%s\":{}}}}", esv1beta1.AnnotationDataHash)),
- ).To(BeTrue())
- Expect(ctest.HasFieldOwnership(secret.ObjectMeta, FakeManager, "{\"f:data\":{\".\":{},\"f:pre-existing-key\":{}},\"f:type\":{}}")).To(BeTrue())
- }
- }
- // should not update if no changes
- mergeWithSecretNoChange := func(tc *testCase) {
- const existingKey = "pre-existing-key"
- existingVal := "someValue"
- tc.externalSecret.Spec.Target.CreationPolicy = esv1beta1.CreatePolicyMerge
- // create secret beforehand
- Expect(k8sClient.Create(context.Background(), &v1.Secret{
- ObjectMeta: metav1.ObjectMeta{
- Name: ExternalSecretTargetSecretName,
- Namespace: ExternalSecretNamespace,
- },
- Data: map[string][]byte{
- existingKey: []byte(existingVal),
- },
- }, client.FieldOwner(FakeManager))).To(Succeed())
- tc.checkSecret = func(es *esv1beta1.ExternalSecret, secret *v1.Secret) {
- oldResourceVersion := secret.ResourceVersion
- cleanSecret := secret.DeepCopy()
- Expect(k8sClient.Patch(context.Background(), secret, client.MergeFrom(cleanSecret))).To(Succeed())
- newSecret := &v1.Secret{}
- Eventually(func() bool {
- secretLookupKey := types.NamespacedName{
- Name: ExternalSecretTargetSecretName,
- Namespace: ExternalSecretNamespace,
- }
- err := k8sClient.Get(context.Background(), secretLookupKey, newSecret)
- if err != nil {
- return false
- }
- return oldResourceVersion == newSecret.ResourceVersion
- }, timeout, interval).Should(Equal(true))
- }
- }
- // should not merge with secret if it doesn't exist
- mergeWithSecretErr := func(tc *testCase) {
- const secretVal = "someValue"
- tc.externalSecret.Spec.Target.CreationPolicy = esv1beta1.CreatePolicyMerge
- fakeProvider.WithGetSecret([]byte(secretVal), nil)
- tc.checkCondition = func(es *esv1beta1.ExternalSecret) bool {
- cond := GetExternalSecretCondition(es.Status, esv1beta1.ExternalSecretReady)
- if cond == nil || cond.Status != v1.ConditionFalse || cond.Reason != esv1beta1.ConditionReasonSecretSyncedError {
- return false
- }
- return true
- }
- tc.checkExternalSecret = func(es *esv1beta1.ExternalSecret) {
- Eventually(func() bool {
- Expect(testSyncCallsError.WithLabelValues(ExternalSecretName, ExternalSecretNamespace).Write(&metric)).To(Succeed())
- Expect(testExternalSecretReconcileDuration.WithLabelValues(ExternalSecretName, ExternalSecretNamespace).Write(&metricDuration)).To(Succeed())
- return metric.GetCounter().GetValue() >= 2.0 && metricDuration.GetGauge().GetValue() > 0.0
- }, timeout, interval).Should(BeTrue())
- Expect(externalSecretConditionShouldBe(ExternalSecretName, ExternalSecretNamespace, esv1beta1.ExternalSecretReady, v1.ConditionFalse, 1.0)).To(BeTrue())
- Expect(externalSecretConditionShouldBe(ExternalSecretName, ExternalSecretNamespace, esv1beta1.ExternalSecretReady, v1.ConditionTrue, 0.0)).To(BeTrue())
- }
- }
- // controller should force ownership
- mergeWithConflict := func(tc *testCase) {
- const secretVal = "someValue"
- // this should confict
- const existingKey = targetProp
- existingVal := "pre-existing-value"
- tc.externalSecret.Spec.Target.CreationPolicy = esv1beta1.CreatePolicyMerge
- // create secret beforehand
- Expect(k8sClient.Create(context.Background(), &v1.Secret{
- ObjectMeta: metav1.ObjectMeta{
- Name: ExternalSecretTargetSecretName,
- Namespace: ExternalSecretNamespace,
- },
- Data: map[string][]byte{
- existingKey: []byte(existingVal),
- },
- }, client.FieldOwner(FakeManager))).To(Succeed())
- fakeProvider.WithGetSecret([]byte(secretVal), nil)
- tc.checkSecret = func(es *esv1beta1.ExternalSecret, secret *v1.Secret) {
- // check that value stays the same
- Expect(string(secret.Data[existingKey])).To(Equal(secretVal))
- // check owner/managedFields
- Expect(ctest.HasOwnerRef(secret.ObjectMeta, "ExternalSecret", ExternalSecretFQDN)).To(BeFalse())
- Expect(secret.ObjectMeta.ManagedFields).To(HaveLen(2))
- Expect(ctest.HasFieldOwnership(
- secret.ObjectMeta,
- ExternalSecretFQDN,
- fmt.Sprintf("{\"f:data\":{\"f:targetProperty\":{}},\"f:immutable\":{},\"f:metadata\":{\"f:annotations\":{\"f:%s\":{}}}}", esv1beta1.AnnotationDataHash)),
- ).To(BeTrue())
- }
- }
- syncWithGeneratorRef := func(tc *testCase) {
- const secretKey = "somekey"
- const secretVal = "someValue"
- Expect(k8sClient.Create(context.Background(), &genv1alpha1.Fake{
- ObjectMeta: metav1.ObjectMeta{
- Name: "mytestfake",
- Namespace: ExternalSecretNamespace,
- },
- Spec: genv1alpha1.FakeSpec{
- Data: map[string]string{
- secretKey: secretVal,
- },
- },
- })).To(Succeed())
- // reset secretStoreRef
- tc.externalSecret.Spec.SecretStoreRef = esv1beta1.SecretStoreRef{}
- tc.externalSecret.Spec.Data = nil
- tc.externalSecret.Spec.DataFrom = []esv1beta1.ExternalSecretDataFromRemoteRef{
- {
- SourceRef: &esv1beta1.SourceRef{
- GeneratorRef: &esv1beta1.GeneratorRef{
- APIVersion: genv1alpha1.Group + "/" + genv1alpha1.Version,
- Kind: "Fake",
- Name: "mytestfake",
- },
- },
- },
- }
- tc.checkSecret = func(es *esv1beta1.ExternalSecret, secret *v1.Secret) {
- // check values
- Expect(string(secret.Data[secretKey])).To(Equal(secretVal))
- }
- }
- deleteOrphanedSecrets := func(tc *testCase) {
- tc.checkSecret = func(es *esv1beta1.ExternalSecret, secret *v1.Secret) {
- cleanEs := es.DeepCopy()
- oldSecret := v1.Secret{}
- oldSecretName := types.NamespacedName{
- Name: "test-secret",
- Namespace: secret.Namespace,
- }
- newSecret := v1.Secret{}
- secretName := types.NamespacedName{
- Name: "new-foo",
- Namespace: secret.Namespace,
- }
- Eventually(func() bool {
- err := k8sClient.Get(context.Background(), oldSecretName, &oldSecret)
- return err == nil
- }, time.Second*10, time.Millisecond*200).Should(BeTrue())
- es.Spec.Target.Name = "new-foo"
- Expect(k8sClient.Patch(context.Background(), es, client.MergeFrom(cleanEs))).To(Succeed())
- Eventually(func() bool {
- err := k8sClient.Get(context.Background(), secretName, &newSecret)
- return err == nil
- }, time.Second*10, time.Millisecond*200).Should(BeTrue())
- Eventually(func() bool {
- err := k8sClient.Get(context.Background(), oldSecretName, &oldSecret)
- return apierrors.IsNotFound(err)
- }, time.Second*10, time.Millisecond*200).Should(BeTrue())
- }
- }
- ignoreMismatchControllerForGeneratorRef := func(tc *testCase) {
- const secretKey = "somekey"
- const secretVal = "someValue"
- fakeGenerator := &genv1alpha1.Fake{
- ObjectMeta: metav1.ObjectMeta{
- Name: "mytestfake2",
- Namespace: ExternalSecretNamespace,
- },
- Spec: genv1alpha1.FakeSpec{
- Data: map[string]string{
- secretKey: secretVal,
- },
- Controller: "fakeControllerClass",
- },
- }
- fakeGeneratorJSON, _ := json.Marshal(fakeGenerator)
- Expect(shouldSkipGenerator(
- &Reconciler{
- ControllerClass: "default",
- },
- &apiextensions.JSON{Raw: fakeGeneratorJSON},
- )).To(BeTrue())
- }
- syncWithMultipleSecretStores := func(tc *testCase) {
- Expect(k8sClient.Create(context.Background(), &esv1beta1.SecretStore{
- ObjectMeta: metav1.ObjectMeta{
- Name: "foo",
- Namespace: ExternalSecretNamespace,
- },
- Spec: esv1beta1.SecretStoreSpec{
- Provider: &esv1beta1.SecretStoreProvider{
- Fake: &esv1beta1.FakeProvider{
- Data: []esv1beta1.FakeProviderData{
- {
- Key: "foo",
- Version: "",
- ValueMap: map[string]string{
- "foo": "bar",
- "foo2": "bar2",
- },
- },
- },
- },
- },
- },
- })).To(Succeed())
- Expect(k8sClient.Create(context.Background(), &esv1beta1.SecretStore{
- ObjectMeta: metav1.ObjectMeta{
- Name: "baz",
- Namespace: ExternalSecretNamespace,
- },
- Spec: esv1beta1.SecretStoreSpec{
- Provider: &esv1beta1.SecretStoreProvider{
- Fake: &esv1beta1.FakeProvider{
- Data: []esv1beta1.FakeProviderData{
- {
- Key: "baz",
- Version: "",
- ValueMap: map[string]string{
- "baz": "bang",
- "baz2": "bang2",
- },
- },
- },
- },
- },
- },
- })).To(Succeed())
- tc.externalSecret.Spec.DataFrom = []esv1beta1.ExternalSecretDataFromRemoteRef{
- {
- Extract: &esv1beta1.ExternalSecretDataRemoteRef{
- Key: "foo",
- },
- SourceRef: &esv1beta1.SourceRef{
- SecretStoreRef: &esv1beta1.SecretStoreRef{
- Name: "foo",
- Kind: esv1beta1.SecretStoreKind,
- },
- },
- },
- {
- Extract: &esv1beta1.ExternalSecretDataRemoteRef{
- Key: "baz",
- },
- SourceRef: &esv1beta1.SourceRef{
- SecretStoreRef: &esv1beta1.SecretStoreRef{
- Name: "baz",
- Kind: esv1beta1.SecretStoreKind,
- },
- },
- },
- }
- tc.checkSecret = func(es *esv1beta1.ExternalSecret, secret *v1.Secret) {
- // check values
- Expect(string(secret.Data["foo"])).To(Equal("bar"))
- Expect(string(secret.Data["foo2"])).To(Equal("bar2"))
- Expect(string(secret.Data["baz"])).To(Equal("bang"))
- Expect(string(secret.Data["baz2"])).To(Equal("bang2"))
- }
- }
- // when using a template it should be used as a blueprint
- // to construct a new secret: labels, annotations and type
- syncWithTemplate := func(tc *testCase) {
- const secretVal = "someValue"
- const tplStaticKey = "tplstatickey"
- const tplStaticVal = "tplstaticvalue"
- tc.externalSecret.ObjectMeta.Labels = map[string]string{
- "fooobar": "bazz",
- }
- tc.externalSecret.ObjectMeta.Annotations = map[string]string{
- "hihihih": "hehehe",
- }
- tc.externalSecret.Spec.Target.Template = &esv1beta1.ExternalSecretTemplate{
- Metadata: esv1beta1.ExternalSecretTemplateMetadata{
- Labels: map[string]string{
- "foos": "ball",
- },
- Annotations: map[string]string{
- "hihi": "ga",
- },
- },
- Type: v1.SecretTypeOpaque,
- EngineVersion: esv1beta1.TemplateEngineV1,
- Data: map[string]string{
- targetProp: targetPropObj,
- tplStaticKey: tplStaticVal,
- },
- }
- fakeProvider.WithGetSecret([]byte(secretVal), nil)
- tc.checkSecret = func(es *esv1beta1.ExternalSecret, secret *v1.Secret) {
- // check values
- Expect(string(secret.Data[targetProp])).To(Equal(expectedSecretVal))
- Expect(string(secret.Data[tplStaticKey])).To(Equal(tplStaticVal))
- // labels/annotations should be taken from the template
- for k, v := range es.Spec.Target.Template.Metadata.Labels {
- Expect(secret.ObjectMeta.Labels).To(HaveKeyWithValue(k, v))
- }
- for k, v := range es.Spec.Target.Template.Metadata.Annotations {
- Expect(secret.ObjectMeta.Annotations).To(HaveKeyWithValue(k, v))
- }
- }
- }
- // when using a v2 template it should use the v2 engine version
- syncWithTemplateV2 := func(tc *testCase) {
- const secretVal = "someValue"
- tc.externalSecret.Spec.Target.Template = &esv1beta1.ExternalSecretTemplate{
- Type: v1.SecretTypeOpaque,
- // it should default to v2 for beta11
- // EngineVersion: esv1beta1.TemplateEngineV2,
- Data: map[string]string{
- targetProp: "{{ .targetProperty | upper }} was templated",
- },
- }
- fakeProvider.WithGetSecret([]byte(secretVal), nil)
- tc.checkSecret = func(es *esv1beta1.ExternalSecret, secret *v1.Secret) {
- // check values
- Expect(string(secret.Data[targetProp])).To(Equal(expectedSecretVal))
- }
- }
- // // secret should be synced with correct value precedence:
- // // * fromString
- // // * template data
- // // * templateFrom
- // // * data
- // // * dataFrom
- syncWithTemplatePrecedence := func(tc *testCase) {
- const secretVal = "someValue"
- const tplStaticKey = "tplstatickey"
- const tplStaticVal = "tplstaticvalue"
- const tplFromCMName = "template-cm"
- const tplFromSecretName = "template-secret"
- const tplFromKey = "tpl-from-key"
- const tplFromSecKey = "tpl-from-sec-key"
- const tplFromVal = "tpl-from-value: {{ .targetProperty | toString }} // {{ .bar | toString }}"
- const tplFromSecVal = "tpl-from-sec-value: {{ .targetProperty | toString }} // {{ .bar | toString }}"
- Expect(k8sClient.Create(context.Background(), &v1.ConfigMap{
- ObjectMeta: metav1.ObjectMeta{
- Name: tplFromCMName,
- Namespace: ExternalSecretNamespace,
- },
- Data: map[string]string{
- tplFromKey: tplFromVal,
- },
- })).To(Succeed())
- Expect(k8sClient.Create(context.Background(), &v1.Secret{
- ObjectMeta: metav1.ObjectMeta{
- Name: tplFromSecretName,
- Namespace: ExternalSecretNamespace,
- },
- Data: map[string][]byte{
- tplFromSecKey: []byte(tplFromSecVal),
- },
- })).To(Succeed())
- tc.externalSecret.Spec.Target.Template = &esv1beta1.ExternalSecretTemplate{
- Metadata: esv1beta1.ExternalSecretTemplateMetadata{},
- Type: v1.SecretTypeOpaque,
- TemplateFrom: []esv1beta1.TemplateFrom{
- {
- ConfigMap: &esv1beta1.TemplateRef{
- Name: tplFromCMName,
- Items: []esv1beta1.TemplateRefItem{
- {
- Key: tplFromKey,
- },
- },
- },
- },
- {
- Secret: &esv1beta1.TemplateRef{
- Name: tplFromSecretName,
- Items: []esv1beta1.TemplateRefItem{
- {
- Key: tplFromSecKey,
- },
- },
- },
- },
- },
- Data: map[string]string{
- // this should be the data value, not dataFrom
- targetProp: targetPropObj,
- // this should use the value from the map
- "bar": "value from map: {{ .bar | toString }}",
- // just a static value
- tplStaticKey: tplStaticVal,
- },
- }
- tc.externalSecret.Spec.DataFrom = []esv1beta1.ExternalSecretDataFromRemoteRef{
- {
- Extract: &esv1beta1.ExternalSecretDataRemoteRef{
- Key: "datamap",
- },
- },
- }
- fakeProvider.WithGetSecret([]byte(secretVal), nil)
- fakeProvider.WithGetSecretMap(map[string][]byte{
- "targetProperty": []byte(FooValue),
- "bar": []byte(BarValue),
- }, nil)
- tc.checkSecret = func(es *esv1beta1.ExternalSecret, secret *v1.Secret) {
- // check values
- Expect(string(secret.Data[targetProp])).To(Equal(expectedSecretVal))
- Expect(string(secret.Data[tplStaticKey])).To(Equal(tplStaticVal))
- Expect(string(secret.Data["bar"])).To(Equal("value from map: map-bar-value"))
- Expect(string(secret.Data[tplFromKey])).To(Equal("tpl-from-value: someValue // map-bar-value"))
- Expect(string(secret.Data[tplFromSecKey])).To(Equal("tpl-from-sec-value: someValue // map-bar-value"))
- }
- }
- syncTemplateFromKeysAndValues := func(tc *testCase) {
- const tplFromCMName = "template-cm"
- const tplFromSecretName = "template-secret"
- const tplFromKey = "tpl-from-key"
- const tplFromSecKey = "tpl-from-sec-key"
- const tplFromVal = "{{ .targetKey }}-cm: {{ .targetValue }}"
- const tplFromSecVal = "{{ .targetKey }}-sec: {{ .targetValue }}"
- Expect(k8sClient.Create(context.Background(), &v1.ConfigMap{
- ObjectMeta: metav1.ObjectMeta{
- Name: tplFromCMName,
- Namespace: ExternalSecretNamespace,
- },
- Data: map[string]string{
- tplFromKey: tplFromVal,
- },
- })).To(Succeed())
- Expect(k8sClient.Create(context.Background(), &v1.Secret{
- ObjectMeta: metav1.ObjectMeta{
- Name: tplFromSecretName,
- Namespace: ExternalSecretNamespace,
- },
- Data: map[string][]byte{
- tplFromSecKey: []byte(tplFromSecVal),
- },
- })).To(Succeed())
- tc.externalSecret.Spec.Target.Template = &esv1beta1.ExternalSecretTemplate{
- Metadata: esv1beta1.ExternalSecretTemplateMetadata{},
- Type: v1.SecretTypeOpaque,
- TemplateFrom: []esv1beta1.TemplateFrom{
- {
- ConfigMap: &esv1beta1.TemplateRef{
- Name: tplFromCMName,
- Items: []esv1beta1.TemplateRefItem{
- {
- Key: tplFromKey,
- TemplateAs: esv1beta1.TemplateScopeKeysAndValues,
- },
- },
- },
- },
- {
- Secret: &esv1beta1.TemplateRef{
- Name: tplFromSecretName,
- Items: []esv1beta1.TemplateRefItem{
- {
- Key: tplFromSecKey,
- TemplateAs: esv1beta1.TemplateScopeKeysAndValues,
- },
- },
- },
- },
- },
- }
- tc.externalSecret.Spec.DataFrom = []esv1beta1.ExternalSecretDataFromRemoteRef{
- {
- Extract: &esv1beta1.ExternalSecretDataRemoteRef{
- Key: "datamap",
- },
- },
- }
- fakeProvider.WithGetSecretMap(map[string][]byte{
- "targetKey": []byte(FooValue),
- "targetValue": []byte(BarValue),
- }, nil)
- tc.checkSecret = func(es *esv1beta1.ExternalSecret, secret *v1.Secret) {
- // check values
- Expect(string(secret.Data["map-foo-value-cm"])).To(Equal(BarValue))
- Expect(string(secret.Data["map-foo-value-sec"])).To(Equal(BarValue))
- }
- }
- syncTemplateFromLiteral := func(tc *testCase) {
- tplDataVal := "{{ .targetKey }}-literal: {{ .targetValue }}"
- tplAnnotationsVal := "{{ .targetKey }}-annotations: {{ .targetValue }}"
- tplLabelsVal := "{{ .targetKey }}-labels: {{ .targetValue }}"
- tplComplexVal := `
- {{- range $k, $v := ( .complex | fromJson )}}
- {{ $k }}: {{ $v }}
- {{- end }}
- `
- tc.externalSecret.Spec.Target.Template = &esv1beta1.ExternalSecretTemplate{
- Metadata: esv1beta1.ExternalSecretTemplateMetadata{},
- Type: v1.SecretTypeOpaque,
- TemplateFrom: []esv1beta1.TemplateFrom{
- {
- Literal: &tplDataVal,
- },
- {
- Literal: &tplComplexVal,
- },
- {
- Target: esv1beta1.TemplateTargetAnnotations,
- Literal: &tplAnnotationsVal,
- },
- {
- Target: esv1beta1.TemplateTargetLabels,
- Literal: &tplLabelsVal,
- },
- },
- }
- tc.externalSecret.Spec.DataFrom = []esv1beta1.ExternalSecretDataFromRemoteRef{
- {
- Extract: &esv1beta1.ExternalSecretDataRemoteRef{
- Key: "datamap",
- },
- },
- }
- fakeProvider.WithGetSecretMap(map[string][]byte{
- "targetKey": []byte(FooValue),
- "targetValue": []byte(BarValue),
- "complex": []byte("{\"nested\":\"json\",\"can\":\"be\",\"templated\":\"successfully\"}"),
- }, nil)
- tc.checkSecret = func(es *esv1beta1.ExternalSecret, secret *v1.Secret) {
- // check values
- Expect(string(secret.Data["map-foo-value-literal"])).To(Equal(BarValue))
- Expect(string(secret.Data["nested"])).To(Equal("json"))
- Expect(string(secret.Data["can"])).To(Equal("be"))
- Expect(string(secret.Data["templated"])).To(Equal("successfully"))
- Expect(secret.ObjectMeta.Annotations["map-foo-value-annotations"]).To(Equal(BarValue))
- Expect(secret.ObjectMeta.Labels["map-foo-value-labels"]).To(Equal(BarValue))
- }
- }
- refreshWithTemplate := func(tc *testCase) {
- const secretVal = "someValue"
- const tplStaticKey = "tplstatickey"
- const tplStaticVal = "tplstaticvalue"
- tc.externalSecret.Spec.RefreshInterval = &metav1.Duration{Duration: time.Second}
- tc.externalSecret.Spec.Target.Template = &esv1beta1.ExternalSecretTemplate{
- Metadata: esv1beta1.ExternalSecretTemplateMetadata{
- Labels: map[string]string{"foo": "bar"},
- Annotations: map[string]string{"foo": "bar"},
- },
- Type: v1.SecretTypeOpaque,
- Data: map[string]string{
- targetProp: targetPropObj,
- tplStaticKey: tplStaticVal,
- },
- }
- fakeProvider.WithGetSecret([]byte(secretVal), nil)
- tc.checkSecret = func(es *esv1beta1.ExternalSecret, secret *v1.Secret) {
- // check values
- Expect(string(secret.Data[targetProp])).To(Equal(expectedSecretVal))
- Expect(string(secret.Data[tplStaticKey])).To(Equal(tplStaticVal))
- // labels/annotations should be taken from the template
- for k, v := range es.Spec.Target.Template.Metadata.Labels {
- Expect(secret.ObjectMeta.Labels).To(HaveKeyWithValue(k, v))
- }
- // a secret will always have some extra annotations (i.e. hashmap check), so we only check for specific
- // source annotations
- for k, v := range es.Spec.Target.Template.Metadata.Annotations {
- Expect(secret.ObjectMeta.Annotations).To(HaveKeyWithValue(k, v))
- }
- cleanEs := tc.externalSecret.DeepCopy()
- // now update ExternalSecret
- tc.externalSecret.Spec.Target.Template.Metadata.Annotations["fuzz"] = "buzz"
- tc.externalSecret.Spec.Target.Template.Metadata.Labels["fuzz"] = "buzz"
- tc.externalSecret.Spec.Target.Template.Data["new"] = "value"
- Expect(k8sClient.Patch(context.Background(), tc.externalSecret, client.MergeFrom(cleanEs))).To(Succeed())
- // wait for secret
- sec := &v1.Secret{}
- secretLookupKey := types.NamespacedName{
- Name: ExternalSecretTargetSecretName,
- Namespace: ExternalSecretNamespace,
- }
- Eventually(func() bool {
- err := k8sClient.Get(context.Background(), secretLookupKey, sec)
- if err != nil {
- return false
- }
- // ensure new data value exist
- return string(sec.Data["new"]) == "value"
- }, time.Second*10, time.Millisecond*200).Should(BeTrue())
- // also check labels/annotations have been updated
- for k, v := range es.Spec.Target.Template.Metadata.Labels {
- Expect(secret.ObjectMeta.Labels).To(HaveKeyWithValue(k, v))
- }
- for k, v := range es.Spec.Target.Template.Metadata.Annotations {
- Expect(secret.ObjectMeta.Annotations).To(HaveKeyWithValue(k, v))
- }
- }
- }
- onlyMetadataFromTemplate := func(tc *testCase) {
- const secretVal = "someValue"
- tc.externalSecret.Spec.RefreshInterval = &metav1.Duration{Duration: time.Second}
- tc.externalSecret.Spec.Target.Template = &esv1beta1.ExternalSecretTemplate{
- Metadata: esv1beta1.ExternalSecretTemplateMetadata{
- Labels: map[string]string{"foo": "bar"},
- Annotations: map[string]string{"foo": "bar"},
- },
- }
- fakeProvider.WithGetSecret([]byte(secretVal), nil)
- tc.checkSecret = func(es *esv1beta1.ExternalSecret, secret *v1.Secret) {
- // check values
- Expect(string(secret.Data[targetProp])).To(Equal(secretVal))
- // labels/annotations should be taken from the template
- for k, v := range es.Spec.Target.Template.Metadata.Labels {
- Expect(secret.ObjectMeta.Labels).To(HaveKeyWithValue(k, v))
- }
- for k, v := range es.Spec.Target.Template.Metadata.Annotations {
- Expect(secret.ObjectMeta.Annotations).To(HaveKeyWithValue(k, v))
- }
- }
- }
- // when the provider secret changes the Kind=Secret value
- // must change, too.
- refreshSecretValue := func(tc *testCase) {
- const targetProp = "targetProperty"
- const secretVal = "someValue"
- fakeProvider.WithGetSecret([]byte(secretVal), nil)
- tc.externalSecret.Spec.RefreshInterval = &metav1.Duration{Duration: time.Second}
- tc.checkSecret = func(es *esv1beta1.ExternalSecret, secret *v1.Secret) {
- // check values
- Expect(string(secret.Data[targetProp])).To(Equal(secretVal))
- // update provider secret
- newValue := "NEW VALUE"
- sec := &v1.Secret{}
- fakeProvider.WithGetSecret([]byte(newValue), nil)
- secretLookupKey := types.NamespacedName{
- Name: ExternalSecretTargetSecretName,
- Namespace: ExternalSecretNamespace,
- }
- Eventually(func() bool {
- err := k8sClient.Get(context.Background(), secretLookupKey, sec)
- if err != nil {
- return false
- }
- v := sec.Data[targetProp]
- return string(v) == newValue
- }, timeout, interval).Should(BeTrue())
- }
- }
- // when a provider secret was deleted it must be deleted from
- // the secret aswell
- refreshSecretValueMap := func(tc *testCase) {
- fakeProvider.WithGetSecretMap(map[string][]byte{
- "foo": []byte("1111"),
- "bar": []byte("2222"),
- }, nil)
- tc.externalSecret.Spec.Data = []esv1beta1.ExternalSecretData{}
- tc.externalSecret.Spec.DataFrom = []esv1beta1.ExternalSecretDataFromRemoteRef{
- {
- Extract: &esv1beta1.ExternalSecretDataRemoteRef{
- Key: remoteKey,
- },
- },
- }
- tc.externalSecret.Spec.RefreshInterval = &metav1.Duration{Duration: time.Second}
- tc.checkSecret = func(es *esv1beta1.ExternalSecret, secret *v1.Secret) {
- // check values
- Expect(string(secret.Data["foo"])).To(Equal("1111"))
- Expect(string(secret.Data["bar"])).To(Equal("2222"))
- // update provider secret
- sec := &v1.Secret{}
- fakeProvider.WithGetSecretMap(map[string][]byte{
- "foo": []byte("1111"),
- }, nil)
- secretLookupKey := types.NamespacedName{
- Name: ExternalSecretTargetSecretName,
- Namespace: ExternalSecretNamespace,
- }
- Eventually(func() bool {
- err := k8sClient.Get(context.Background(), secretLookupKey, sec)
- if err != nil {
- return false
- }
- return string(sec.Data["foo"]) == "1111" &&
- sec.Data["bar"] == nil // must not be defined, it was deleted
- }, timeout, interval).Should(BeTrue())
- }
- }
- // when a provider secret was deleted it must be deleted from
- // the secret aswell when using a template
- refreshSecretValueMapTemplate := func(tc *testCase) {
- fakeProvider.WithGetSecretMap(map[string][]byte{
- "foo": []byte("1111"),
- "bar": []byte("2222"),
- }, nil)
- tc.externalSecret.Spec.Target.Template = &esv1beta1.ExternalSecretTemplate{}
- tc.externalSecret.Spec.Data = []esv1beta1.ExternalSecretData{}
- tc.externalSecret.Spec.DataFrom = []esv1beta1.ExternalSecretDataFromRemoteRef{
- {
- Extract: &esv1beta1.ExternalSecretDataRemoteRef{
- Key: remoteKey,
- },
- },
- }
- tc.externalSecret.Spec.RefreshInterval = &metav1.Duration{Duration: time.Second}
- tc.checkSecret = func(es *esv1beta1.ExternalSecret, secret *v1.Secret) {
- // check values
- Expect(string(secret.Data["foo"])).To(Equal("1111"))
- Expect(string(secret.Data["bar"])).To(Equal("2222"))
- // update provider secret
- sec := &v1.Secret{}
- fakeProvider.WithGetSecretMap(map[string][]byte{
- "foo": []byte("1111"),
- }, nil)
- secretLookupKey := types.NamespacedName{
- Name: ExternalSecretTargetSecretName,
- Namespace: ExternalSecretNamespace,
- }
- Eventually(func() bool {
- err := k8sClient.Get(context.Background(), secretLookupKey, sec)
- if err != nil {
- return false
- }
- return string(sec.Data["foo"]) == "1111" &&
- sec.Data["bar"] == nil // must not be defined, it was deleted
- }, timeout, interval).Should(BeTrue())
- }
- }
- refreshintervalZero := func(tc *testCase) {
- const targetProp = "targetProperty"
- const secretVal = "someValue"
- fakeProvider.WithGetSecret([]byte(secretVal), nil)
- tc.externalSecret.Spec.RefreshInterval = &metav1.Duration{Duration: 0}
- tc.checkSecret = func(es *esv1beta1.ExternalSecret, secret *v1.Secret) {
- // check values
- Expect(string(secret.Data[targetProp])).To(Equal(secretVal))
- // update provider secret
- newValue := "NEW VALUE"
- sec := &v1.Secret{}
- fakeProvider.WithGetSecret([]byte(newValue), nil)
- secretLookupKey := types.NamespacedName{
- Name: ExternalSecretTargetSecretName,
- Namespace: ExternalSecretNamespace,
- }
- Consistently(func() bool {
- err := k8sClient.Get(context.Background(), secretLookupKey, sec)
- if err != nil {
- return false
- }
- v := sec.Data[targetProp]
- return string(v) == secretVal
- }, time.Second*10, time.Second).Should(BeTrue())
- }
- }
- deleteSecretPolicy := func(tc *testCase) {
- expVal := []byte("1234")
- // set initial value
- fakeProvider.WithGetAllSecrets(map[string][]byte{
- "foo": expVal,
- "bar": expVal,
- }, nil)
- tc.externalSecret.Spec.Data = nil
- tc.externalSecret.Spec.DataFrom = []esv1beta1.ExternalSecretDataFromRemoteRef{
- {
- Find: &esv1beta1.ExternalSecretFind{
- Tags: map[string]string{},
- },
- },
- }
- tc.externalSecret.Spec.Target.DeletionPolicy = esv1beta1.DeletionPolicyDelete
- tc.externalSecret.Spec.RefreshInterval = &metav1.Duration{Duration: time.Second}
- tc.checkSecret = func(es *esv1beta1.ExternalSecret, secret *v1.Secret) {
- Expect(secret.Data["foo"]).To(Equal(expVal))
- // update provider secret
- fakeProvider.WithGetAllSecrets(map[string][]byte{
- "foo": expVal,
- }, nil)
- sec := &v1.Secret{}
- secretLookupKey := types.NamespacedName{
- Name: ExternalSecretTargetSecretName,
- Namespace: ExternalSecretNamespace,
- }
- Eventually(func() bool {
- By("checking secret value for foo=1234 and bar=nil")
- err := k8sClient.Get(context.Background(), secretLookupKey, sec)
- if err != nil {
- return false
- }
- return bytes.Equal(sec.Data["foo"], expVal) && sec.Data["bar"] == nil
- }, time.Second*10, time.Second).Should(BeTrue())
- // return specific delete err to indicate deletion
- fakeProvider.WithGetAllSecrets(map[string][]byte{}, esv1beta1.NoSecretErr)
- Eventually(func() bool {
- By("checking that secret has been deleted")
- err := k8sClient.Get(context.Background(), secretLookupKey, sec)
- return apierrors.IsNotFound(err)
- }, time.Second*10, time.Second).Should(BeTrue())
- }
- }
- deleteSecretPolicyRetain := func(tc *testCase) {
- expVal := []byte("1234")
- // set initial value
- fakeProvider.WithGetAllSecrets(map[string][]byte{
- "foo": expVal,
- "bar": expVal,
- }, nil)
- tc.externalSecret.Spec.DataFrom = []esv1beta1.ExternalSecretDataFromRemoteRef{
- {
- Find: &esv1beta1.ExternalSecretFind{
- Tags: map[string]string{},
- },
- },
- }
- tc.externalSecret.Spec.Target.DeletionPolicy = esv1beta1.DeletionPolicyRetain
- tc.externalSecret.Spec.RefreshInterval = &metav1.Duration{Duration: time.Second}
- tc.checkSecret = func(es *esv1beta1.ExternalSecret, secret *v1.Secret) {
- Expect(secret.Data["foo"]).To(Equal(expVal))
- sec := &v1.Secret{}
- secretLookupKey := types.NamespacedName{
- Name: ExternalSecretTargetSecretName,
- Namespace: ExternalSecretNamespace,
- }
- // return specific delete err to indicate deletion
- // however this should not trigger a delete
- fakeProvider.WithGetAllSecrets(map[string][]byte{}, esv1beta1.NoSecretErr)
- Consistently(func() bool {
- By("checking that secret has not been deleted")
- err := k8sClient.Get(context.Background(), secretLookupKey, sec)
- return apierrors.IsNotFound(err) && bytes.Equal(sec.Data["foo"], expVal)
- }, time.Second*10, time.Second).Should(BeFalse())
- }
- }
- // merge with existing secret using creationPolicy=Merge
- // if provider secret gets deleted only the managed field should get deleted
- deleteSecretPolicyMerge := func(tc *testCase) {
- const secretVal = "someValue"
- const existingKey = "some-existing-key"
- existingVal := "some-existing-value"
- tc.externalSecret.Spec.RefreshInterval = &metav1.Duration{Duration: time.Second}
- tc.externalSecret.Spec.Target.CreationPolicy = esv1beta1.CreatePolicyMerge
- tc.externalSecret.Spec.Target.DeletionPolicy = esv1beta1.DeletionPolicyMerge
- // create secret beforehand
- Expect(k8sClient.Create(context.Background(), &v1.Secret{
- ObjectMeta: metav1.ObjectMeta{
- Name: ExternalSecretTargetSecretName,
- Namespace: ExternalSecretNamespace,
- },
- Data: map[string][]byte{
- existingKey: []byte(existingVal),
- },
- }, client.FieldOwner(FakeManager))).To(Succeed())
- fakeProvider.WithGetSecret([]byte(secretVal), nil)
- tc.checkSecret = func(es *esv1beta1.ExternalSecret, secret *v1.Secret) {
- // check value
- Expect(string(secret.Data[existingKey])).To(Equal(existingVal))
- Expect(string(secret.Data[targetProp])).To(Equal(secretVal))
- sec := &v1.Secret{}
- secretLookupKey := types.NamespacedName{
- Name: ExternalSecretTargetSecretName,
- Namespace: ExternalSecretNamespace,
- }
- // return specific delete err to indicate deletion
- // however this should not trigger a delete
- // instead expect that only the pre-existing value exists
- fakeProvider.WithGetSecret(nil, esv1beta1.NoSecretErr)
- Eventually(func() bool {
- By("checking that secret has not been deleted and pre-existing key exists")
- err := k8sClient.Get(context.Background(), secretLookupKey, sec)
- return !apierrors.IsNotFound(err) &&
- len(sec.Data) == 1 &&
- bytes.Equal(sec.Data[existingKey], []byte(existingVal))
- }, time.Second*30, time.Second).Should(BeTrue())
- }
- }
- // orphan the secret after the external secret has been deleted
- createSecretPolicyOrphan := func(tc *testCase) {
- const secretVal = "someValue"
- tc.externalSecret.Spec.RefreshInterval = &metav1.Duration{Duration: time.Second}
- tc.externalSecret.Spec.Target.CreationPolicy = esv1beta1.CreatePolicyOrphan
- fakeProvider.WithGetSecret([]byte(secretVal), nil)
- tc.checkSecret = func(es *esv1beta1.ExternalSecret, secret *v1.Secret) {
- // check value
- Expect(string(secret.Data[targetProp])).To(Equal(secretVal))
- sec := &v1.Secret{}
- secretLookupKey := types.NamespacedName{
- Name: ExternalSecretTargetSecretName,
- Namespace: ExternalSecretNamespace,
- }
- err := k8sClient.Delete(context.Background(), tc.externalSecret)
- Expect(err).ToNot(HaveOccurred())
- Consistently(func() bool {
- By("checking that secret has not been deleted")
- err := k8sClient.Get(context.Background(), secretLookupKey, sec)
- return !apierrors.IsNotFound(err)
- }, time.Second*15, time.Second).Should(BeTrue())
- }
- }
- // with rewrite all keys from a dataFrom operation
- // should be put with new rewriting into the secret
- syncAndRewriteWithDataFrom := func(tc *testCase) {
- tc.externalSecret.Spec.Data = nil
- tc.externalSecret.Spec.DataFrom = []esv1beta1.ExternalSecretDataFromRemoteRef{
- {
- Extract: &esv1beta1.ExternalSecretDataRemoteRef{
- Key: remoteKey,
- },
- Rewrite: []esv1beta1.ExternalSecretRewrite{{
- Regexp: &esv1beta1.ExternalSecretRewriteRegexp{
- Source: "(.*)",
- Target: "new-$1",
- },
- }},
- },
- {
- Extract: &esv1beta1.ExternalSecretDataRemoteRef{
- Key: remoteKey,
- },
- Rewrite: []esv1beta1.ExternalSecretRewrite{{
- Regexp: &esv1beta1.ExternalSecretRewriteRegexp{
- Source: "(.*)",
- Target: "old-$1",
- },
- }},
- },
- }
- fakeProvider.WithGetSecretMap(map[string][]byte{
- "foo": []byte(FooValue),
- "bar": []byte(BarValue),
- }, nil)
- tc.checkSecret = func(es *esv1beta1.ExternalSecret, secret *v1.Secret) {
- // check values
- Expect(string(secret.Data["new-foo"])).To(Equal(FooValue))
- Expect(string(secret.Data["new-bar"])).To(Equal(BarValue))
- Expect(string(secret.Data["old-foo"])).To(Equal(FooValue))
- Expect(string(secret.Data["old-bar"])).To(Equal(BarValue))
- }
- }
- // with rewrite keys from dataFrom
- // should error if keys are not compliant
- invalidExtractKeysErrCondition := func(tc *testCase) {
- tc.externalSecret.Spec.Data = nil
- tc.externalSecret.Spec.DataFrom = []esv1beta1.ExternalSecretDataFromRemoteRef{
- {
- Extract: &esv1beta1.ExternalSecretDataRemoteRef{
- Key: remoteKey,
- },
- Rewrite: []esv1beta1.ExternalSecretRewrite{{
- Regexp: &esv1beta1.ExternalSecretRewriteRegexp{
- Source: "(.*)",
- Target: "$1",
- },
- }},
- },
- }
- fakeProvider.WithGetSecretMap(map[string][]byte{
- "foo/bar": []byte(FooValue),
- "bar/foo": []byte(BarValue),
- }, nil)
- tc.checkCondition = func(es *esv1beta1.ExternalSecret) bool {
- cond := GetExternalSecretCondition(es.Status, esv1beta1.ExternalSecretReady)
- if cond == nil || cond.Status != v1.ConditionFalse || cond.Reason != esv1beta1.ConditionReasonSecretSyncedError {
- return false
- }
- return true
- }
- tc.checkCondition = func(es *esv1beta1.ExternalSecret) bool {
- cond := GetExternalSecretCondition(es.Status, esv1beta1.ExternalSecretReady)
- if cond == nil || cond.Status != v1.ConditionFalse || cond.Reason != esv1beta1.ConditionReasonSecretSyncedError {
- return false
- }
- return true
- }
- tc.checkExternalSecret = func(es *esv1beta1.ExternalSecret) {
- Eventually(func() bool {
- Expect(testSyncCallsError.WithLabelValues(ExternalSecretName, ExternalSecretNamespace).Write(&metric)).To(Succeed())
- Expect(testExternalSecretReconcileDuration.WithLabelValues(ExternalSecretName, ExternalSecretNamespace).Write(&metricDuration)).To(Succeed())
- return metric.GetCounter().GetValue() >= 2.0 && metricDuration.GetGauge().GetValue() > 0.0
- }, timeout, interval).Should(BeTrue())
- Expect(externalSecretConditionShouldBe(ExternalSecretName, ExternalSecretNamespace, esv1beta1.ExternalSecretReady, v1.ConditionFalse, 1.0)).To(BeTrue())
- Expect(externalSecretConditionShouldBe(ExternalSecretName, ExternalSecretNamespace, esv1beta1.ExternalSecretReady, v1.ConditionTrue, 0.0)).To(BeTrue())
- }
- }
- // with rewrite keys from dataFrom
- // should error if keys are not compliant
- invalidFindKeysErrCondition := func(tc *testCase) {
- tc.externalSecret.Spec.Data = nil
- tc.externalSecret.Spec.DataFrom = []esv1beta1.ExternalSecretDataFromRemoteRef{
- {
- Find: &esv1beta1.ExternalSecretFind{
- Name: &esv1beta1.FindName{
- RegExp: ".*",
- },
- },
- Rewrite: []esv1beta1.ExternalSecretRewrite{{
- Regexp: &esv1beta1.ExternalSecretRewriteRegexp{
- Source: "(.*)",
- Target: "$1",
- },
- }},
- },
- }
- fakeProvider.WithGetAllSecrets(map[string][]byte{
- "foo/bar": []byte(FooValue),
- "bar/foo": []byte(BarValue),
- }, nil)
- tc.checkCondition = func(es *esv1beta1.ExternalSecret) bool {
- cond := GetExternalSecretCondition(es.Status, esv1beta1.ExternalSecretReady)
- if cond == nil || cond.Status != v1.ConditionFalse || cond.Reason != esv1beta1.ConditionReasonSecretSyncedError {
- return false
- }
- return true
- }
- tc.checkCondition = func(es *esv1beta1.ExternalSecret) bool {
- cond := GetExternalSecretCondition(es.Status, esv1beta1.ExternalSecretReady)
- if cond == nil || cond.Status != v1.ConditionFalse || cond.Reason != esv1beta1.ConditionReasonSecretSyncedError {
- return false
- }
- return true
- }
- tc.checkExternalSecret = func(es *esv1beta1.ExternalSecret) {
- Eventually(func() bool {
- Expect(testSyncCallsError.WithLabelValues(ExternalSecretName, ExternalSecretNamespace).Write(&metric)).To(Succeed())
- Expect(testExternalSecretReconcileDuration.WithLabelValues(ExternalSecretName, ExternalSecretNamespace).Write(&metricDuration)).To(Succeed())
- return metric.GetCounter().GetValue() >= 2.0 && metricDuration.GetGauge().GetValue() > 0.0
- }, timeout, interval).Should(BeTrue())
- Expect(externalSecretConditionShouldBe(ExternalSecretName, ExternalSecretNamespace, esv1beta1.ExternalSecretReady, v1.ConditionFalse, 1.0)).To(BeTrue())
- Expect(externalSecretConditionShouldBe(ExternalSecretName, ExternalSecretNamespace, esv1beta1.ExternalSecretReady, v1.ConditionTrue, 0.0)).To(BeTrue())
- }
- }
- // with dataFrom all properties from the specified secret
- // should be put into the secret
- syncWithDataFrom := func(tc *testCase) {
- tc.externalSecret.Spec.Data = nil
- tc.externalSecret.Spec.DataFrom = []esv1beta1.ExternalSecretDataFromRemoteRef{
- {
- Extract: &esv1beta1.ExternalSecretDataRemoteRef{
- Key: remoteKey,
- },
- },
- }
- fakeProvider.WithGetSecretMap(map[string][]byte{
- "foo": []byte(FooValue),
- "bar": []byte(BarValue),
- }, nil)
- tc.checkSecret = func(es *esv1beta1.ExternalSecret, secret *v1.Secret) {
- // check values
- Expect(string(secret.Data["foo"])).To(Equal(FooValue))
- Expect(string(secret.Data["bar"])).To(Equal(BarValue))
- }
- }
- // with dataFrom.Find the change is on the called method GetAllSecrets
- // all keys should be put into the secret
- syncAndRewriteDataFromFind := func(tc *testCase) {
- tc.externalSecret.Spec.Data = nil
- tc.externalSecret.Spec.DataFrom = []esv1beta1.ExternalSecretDataFromRemoteRef{
- {
- Find: &esv1beta1.ExternalSecretFind{
- Name: &esv1beta1.FindName{
- RegExp: "foobar",
- },
- },
- Rewrite: []esv1beta1.ExternalSecretRewrite{
- {
- Regexp: &esv1beta1.ExternalSecretRewriteRegexp{
- Source: "(.*)",
- Target: "new-$1",
- },
- },
- },
- },
- }
- fakeProvider.WithGetAllSecrets(map[string][]byte{
- "foo": []byte(FooValue),
- "bar": []byte(BarValue),
- }, nil)
- tc.checkSecret = func(es *esv1beta1.ExternalSecret, secret *v1.Secret) {
- // check values
- Expect(string(secret.Data["new-foo"])).To(Equal(FooValue))
- Expect(string(secret.Data["new-bar"])).To(Equal(BarValue))
- }
- }
- // with dataFrom.Find the change is on the called method GetAllSecrets
- // all keys should be put into the secret
- syncDataFromFind := func(tc *testCase) {
- tc.externalSecret.Spec.Data = nil
- tc.externalSecret.Spec.DataFrom = []esv1beta1.ExternalSecretDataFromRemoteRef{
- {
- Find: &esv1beta1.ExternalSecretFind{
- Name: &esv1beta1.FindName{
- RegExp: "foobar",
- },
- },
- },
- }
- fakeProvider.WithGetAllSecrets(map[string][]byte{
- "foo": []byte(FooValue),
- "bar": []byte(BarValue),
- }, nil)
- tc.checkSecret = func(es *esv1beta1.ExternalSecret, secret *v1.Secret) {
- // check values
- Expect(string(secret.Data["foo"])).To(Equal(FooValue))
- Expect(string(secret.Data["bar"])).To(Equal(BarValue))
- }
- }
- // with dataFrom and using a template
- // should be put into the secret
- syncWithDataFromTemplate := func(tc *testCase) {
- tc.externalSecret.Spec.Data = nil
- tc.externalSecret.Spec.Target = esv1beta1.ExternalSecretTarget{
- Name: ExternalSecretTargetSecretName,
- Template: &esv1beta1.ExternalSecretTemplate{
- Type: v1.SecretTypeTLS,
- },
- }
- tc.externalSecret.Spec.DataFrom = []esv1beta1.ExternalSecretDataFromRemoteRef{
- {
- Extract: &esv1beta1.ExternalSecretDataRemoteRef{
- Key: remoteKey,
- },
- },
- }
- fakeProvider.WithGetSecretMap(map[string][]byte{
- "tls.crt": []byte(FooValue),
- "tls.key": []byte(BarValue),
- }, nil)
- tc.checkSecret = func(es *esv1beta1.ExternalSecret, secret *v1.Secret) {
- Expect(secret.Type).To(Equal(v1.SecretTypeTLS))
- // check values
- Expect(string(secret.Data["tls.crt"])).To(Equal(FooValue))
- Expect(string(secret.Data["tls.key"])).To(Equal(BarValue))
- }
- }
- // when a provider errors in a GetSecret call
- // a error condition must be set.
- providerErrCondition := func(tc *testCase) {
- const secretVal = "foobar"
- fakeProvider.WithGetSecret(nil, fmt.Errorf("boom"))
- tc.externalSecret.Spec.RefreshInterval = &metav1.Duration{Duration: time.Millisecond * 100}
- tc.checkCondition = func(es *esv1beta1.ExternalSecret) bool {
- cond := GetExternalSecretCondition(es.Status, esv1beta1.ExternalSecretReady)
- if cond == nil || cond.Status != v1.ConditionFalse || cond.Reason != esv1beta1.ConditionReasonSecretSyncedError {
- return false
- }
- return true
- }
- tc.checkExternalSecret = func(es *esv1beta1.ExternalSecret) {
- Eventually(func() bool {
- Expect(testSyncCallsError.WithLabelValues(ExternalSecretName, ExternalSecretNamespace).Write(&metric)).To(Succeed())
- Expect(testExternalSecretReconcileDuration.WithLabelValues(ExternalSecretName, ExternalSecretNamespace).Write(&metricDuration)).To(Succeed())
- return metric.GetCounter().GetValue() >= 2.0 && metricDuration.GetGauge().GetValue() > 0.0
- }, timeout, interval).Should(BeTrue())
- Expect(externalSecretConditionShouldBe(ExternalSecretName, ExternalSecretNamespace, esv1beta1.ExternalSecretReady, v1.ConditionFalse, 1.0)).To(BeTrue())
- Expect(externalSecretConditionShouldBe(ExternalSecretName, ExternalSecretNamespace, esv1beta1.ExternalSecretReady, v1.ConditionTrue, 0.0)).To(BeTrue())
- // es condition should reflect recovered provider error
- fakeProvider.WithGetSecret([]byte(secretVal), nil)
- esKey := types.NamespacedName{Name: ExternalSecretName, Namespace: ExternalSecretNamespace}
- Eventually(func() bool {
- err := k8sClient.Get(context.Background(), esKey, es)
- if err != nil {
- return false
- }
- // condition must now be true!
- cond := GetExternalSecretCondition(es.Status, esv1beta1.ExternalSecretReady)
- if cond == nil && cond.Status != v1.ConditionTrue {
- return false
- }
- return true
- }, timeout, interval).Should(BeTrue())
- }
- }
- // When a ExternalSecret references an non-existing SecretStore
- // a error condition must be set.
- storeMissingErrCondition := func(tc *testCase) {
- tc.externalSecret.Spec.SecretStoreRef.Name = "nonexistent"
- tc.checkCondition = func(es *esv1beta1.ExternalSecret) bool {
- cond := GetExternalSecretCondition(es.Status, esv1beta1.ExternalSecretReady)
- if cond == nil || cond.Status != v1.ConditionFalse || cond.Reason != esv1beta1.ConditionReasonSecretSyncedError {
- return false
- }
- return true
- }
- tc.checkExternalSecret = func(es *esv1beta1.ExternalSecret) {
- Eventually(func() bool {
- Expect(testSyncCallsError.WithLabelValues(ExternalSecretName, ExternalSecretNamespace).Write(&metric)).To(Succeed())
- Expect(testExternalSecretReconcileDuration.WithLabelValues(ExternalSecretName, ExternalSecretNamespace).Write(&metricDuration)).To(Succeed())
- return metric.GetCounter().GetValue() >= 2.0 && metricDuration.GetGauge().GetValue() > 0.0
- }, timeout, interval).Should(BeTrue())
- Expect(externalSecretConditionShouldBe(ExternalSecretName, ExternalSecretNamespace, esv1beta1.ExternalSecretReady, v1.ConditionFalse, 1.0)).To(BeTrue())
- Expect(externalSecretConditionShouldBe(ExternalSecretName, ExternalSecretNamespace, esv1beta1.ExternalSecretReady, v1.ConditionTrue, 0.0)).To(BeTrue())
- }
- }
- // when the provider constructor errors (e.g. invalid configuration)
- // a SecretSyncedError status condition must be set
- storeConstructErrCondition := func(tc *testCase) {
- fakeProvider.WithNew(func(context.Context, esv1beta1.GenericStore, client.Client,
- string) (esv1beta1.SecretsClient, error) {
- return nil, fmt.Errorf("artificial constructor error")
- })
- tc.checkCondition = func(es *esv1beta1.ExternalSecret) bool {
- // condition must be false
- cond := GetExternalSecretCondition(es.Status, esv1beta1.ExternalSecretReady)
- if cond == nil || cond.Status != v1.ConditionFalse || cond.Reason != esv1beta1.ConditionReasonSecretSyncedError {
- return false
- }
- return true
- }
- tc.checkExternalSecret = func(es *esv1beta1.ExternalSecret) {
- Eventually(func() bool {
- Expect(testSyncCallsError.WithLabelValues(ExternalSecretName, ExternalSecretNamespace).Write(&metric)).To(Succeed())
- Expect(testExternalSecretReconcileDuration.WithLabelValues(ExternalSecretName, ExternalSecretNamespace).Write(&metricDuration)).To(Succeed())
- return metric.GetCounter().GetValue() >= 2.0 && metricDuration.GetGauge().GetValue() > 0.0
- }, timeout, interval).Should(BeTrue())
- Expect(externalSecretConditionShouldBe(ExternalSecretName, ExternalSecretNamespace, esv1beta1.ExternalSecretReady, v1.ConditionFalse, 1.0)).To(BeTrue())
- Expect(externalSecretConditionShouldBe(ExternalSecretName, ExternalSecretNamespace, esv1beta1.ExternalSecretReady, v1.ConditionTrue, 0.0)).To(BeTrue())
- }
- }
- // when a SecretStore has a controller field set which we don't care about
- // the externalSecret must not be touched
- ignoreMismatchController := func(tc *testCase) {
- tc.secretStore.GetSpec().Controller = "nop"
- tc.checkCondition = func(es *esv1beta1.ExternalSecret) bool {
- cond := GetExternalSecretCondition(es.Status, esv1beta1.ExternalSecretReady)
- return cond == nil
- }
- tc.checkExternalSecret = func(es *esv1beta1.ExternalSecret) {
- // Condition True and False should be 0, since the Condition was not created
- Eventually(func() float64 {
- Expect(testExternalSecretCondition.WithLabelValues(ExternalSecretName, ExternalSecretNamespace, string(esv1beta1.ExternalSecretReady), string(v1.ConditionTrue)).Write(&metric)).To(Succeed())
- return metric.GetGauge().GetValue()
- }, timeout, interval).Should(Equal(0.0))
- Eventually(func() float64 {
- Expect(testExternalSecretCondition.WithLabelValues(ExternalSecretName, ExternalSecretNamespace, string(esv1beta1.ExternalSecretReady), string(v1.ConditionFalse)).Write(&metric)).To(Succeed())
- return metric.GetGauge().GetValue()
- }, timeout, interval).Should(Equal(0.0))
- Expect(externalSecretConditionShouldBe(ExternalSecretName, ExternalSecretNamespace, esv1beta1.ExternalSecretReady, v1.ConditionFalse, 0.0)).To(BeTrue())
- Expect(externalSecretConditionShouldBe(ExternalSecretName, ExternalSecretNamespace, esv1beta1.ExternalSecretReady, v1.ConditionTrue, 0.0)).To(BeTrue())
- }
- }
- ignoreClusterSecretStoreWhenDisabled := func(tc *testCase) {
- tc.externalSecret.Spec.SecretStoreRef.Kind = esv1beta1.ClusterSecretStoreKind
- Expect(shouldSkipClusterSecretStore(
- &Reconciler{
- ClusterSecretStoreEnabled: false,
- },
- *tc.externalSecret,
- )).To(BeTrue())
- tc.checkCondition = func(es *esv1beta1.ExternalSecret) bool {
- cond := GetExternalSecretCondition(es.Status, esv1beta1.ExternalSecretReady)
- return cond == nil
- }
- }
- // When the ownership is set to owner, and we delete a dependent child kind=secret
- // it should be recreated without waiting for refresh interval
- checkDeletion := func(tc *testCase) {
- const secretVal = "someValue"
- fakeProvider.WithGetSecret([]byte(secretVal), nil)
- tc.externalSecret.Spec.RefreshInterval = &metav1.Duration{Duration: time.Minute * 10}
- tc.checkSecret = func(es *esv1beta1.ExternalSecret, secret *v1.Secret) {
- // check values
- oldUID := secret.UID
- Expect(oldUID).NotTo(BeEmpty())
- // delete the related config
- Expect(k8sClient.Delete(context.TODO(), secret))
- var newSecret v1.Secret
- secretLookupKey := types.NamespacedName{
- Name: ExternalSecretTargetSecretName,
- Namespace: ExternalSecretNamespace,
- }
- Eventually(func() bool {
- err := k8sClient.Get(context.Background(), secretLookupKey, &newSecret)
- if err != nil {
- return false
- }
- // new secret should be a new, recreated object with a different UID
- return newSecret.UID != oldUID
- }, timeout, interval).Should(BeTrue())
- }
- }
- // Checks that secret annotation has been written based on the data
- checkSecretDataHashAnnotation := func(tc *testCase) {
- const secretVal = "someValue"
- fakeProvider.WithGetSecret([]byte(secretVal), nil)
- tc.checkSecret = func(es *esv1beta1.ExternalSecret, secret *v1.Secret) {
- Expect(secret.Annotations[esv1beta1.AnnotationDataHash]).To(Equal("9d30b95ca81e156f9454b5ef3bfcc6ee"))
- }
- }
- // When we amend the created kind=secret, refresh operation should be run again regardless of refresh interval
- checkSecretDataHashAnnotationChange := func(tc *testCase) {
- fakeData := map[string][]byte{
- "targetProperty": []byte(FooValue),
- }
- fakeProvider.WithGetSecretMap(fakeData, nil)
- tc.externalSecret.Spec.RefreshInterval = &metav1.Duration{Duration: time.Minute * 10}
- tc.checkSecret = func(es *esv1beta1.ExternalSecret, secret *v1.Secret) {
- oldHash := secret.Annotations[esv1beta1.AnnotationDataHash]
- oldResourceVersion := secret.ResourceVersion
- Expect(oldHash).NotTo(BeEmpty())
- cleanSecret := secret.DeepCopy()
- secret.Data["new"] = []byte("value")
- secret.ObjectMeta.Annotations[esv1beta1.AnnotationDataHash] = "thisiswronghash"
- Expect(k8sClient.Patch(context.Background(), secret, client.MergeFrom(cleanSecret))).To(Succeed())
- var refreshedSecret v1.Secret
- secretLookupKey := types.NamespacedName{
- Name: ExternalSecretTargetSecretName,
- Namespace: ExternalSecretNamespace,
- }
- Eventually(func() bool {
- err := k8sClient.Get(context.Background(), secretLookupKey, &refreshedSecret)
- if err != nil {
- return false
- }
- // refreshed secret should have a different generation (sign that it was updated), but since
- // the secret source is the same (not changed), the hash should be reverted to an old value
- return refreshedSecret.ResourceVersion != oldResourceVersion && refreshedSecret.Annotations[esv1beta1.AnnotationDataHash] == oldHash
- }, timeout, interval).Should(BeTrue())
- }
- }
- // When we update the template, remaining keys should not be preserved
- templateShouldRewrite := func(tc *testCase) {
- const secretVal = "someValue"
- fakeProvider.WithGetSecret([]byte(secretVal), nil)
- tc.externalSecret.Spec.RefreshInterval = &metav1.Duration{Duration: time.Minute * 10}
- tc.externalSecret.Spec.Target.Template = &esv1beta1.ExternalSecretTemplate{
- Data: map[string]string{
- "key": `{{.targetProperty}}-foo`,
- },
- }
- tc.checkSecret = func(es *esv1beta1.ExternalSecret, secret *v1.Secret) {
- Expect(secret.Data["key"]).To(Equal([]byte("someValue-foo")))
- newEs := es.DeepCopy()
- newEs.Spec.Target.Template.Data = map[string]string{
- "new": "foo",
- }
- Expect(k8sClient.Patch(context.Background(), newEs, client.MergeFrom(es))).To(Succeed())
- var refreshedSecret v1.Secret
- secretLookupKey := types.NamespacedName{
- Name: ExternalSecretTargetSecretName,
- Namespace: ExternalSecretNamespace,
- }
- Eventually(func() bool {
- err := k8sClient.Get(context.Background(), secretLookupKey, &refreshedSecret)
- if err != nil {
- return false
- }
- _, ok := refreshedSecret.Data["key"]
- return !ok && bytes.Equal(refreshedSecret.Data["new"], []byte("foo"))
- }, timeout, interval).Should(BeTrue())
- }
- }
- // When we update the template, remaining keys should not be preserved
- templateShouldMerge := func(tc *testCase) {
- const secretVal = "someValue"
- fakeProvider.WithGetSecret([]byte(secretVal), nil)
- tc.externalSecret.Spec.RefreshInterval = &metav1.Duration{Duration: time.Minute * 10}
- tc.externalSecret.Spec.Target.Template = &esv1beta1.ExternalSecretTemplate{
- MergePolicy: esv1beta1.MergePolicyMerge,
- Data: map[string]string{
- "key": `{{.targetProperty}}-foo`,
- },
- }
- tc.checkSecret = func(es *esv1beta1.ExternalSecret, secret *v1.Secret) {
- Expect(secret.Data["key"]).To(Equal([]byte("someValue-foo")))
- Expect(string(secret.Data[targetProp])).To(Equal(secretVal))
- }
- }
- useClusterSecretStore := func(tc *testCase) {
- tc.secretStore = &esv1beta1.ClusterSecretStore{
- ObjectMeta: metav1.ObjectMeta{
- Name: ExternalSecretStore,
- },
- Spec: esv1beta1.SecretStoreSpec{
- Provider: &esv1beta1.SecretStoreProvider{
- AWS: &esv1beta1.AWSProvider{
- Service: esv1beta1.AWSServiceSecretsManager,
- },
- },
- },
- }
- tc.externalSecret.Spec.SecretStoreRef.Kind = esv1beta1.ClusterSecretStoreKind
- fakeProvider.WithGetSecret([]byte(secretVal), nil)
- }
- // Secret is created when ClusterSecretStore has no conditions
- noConditionsSecretCreated := func(tc *testCase) {
- tc.checkSecret = func(es *esv1beta1.ExternalSecret, secret *v1.Secret) {
- Expect(string(secret.Data[targetProp])).To(Equal(secretVal))
- }
- }
- // Secret is not created when ClusterSecretStore has a single non-matching string condition
- noSecretCreatedWhenNamespaceDoesntMatchStringCondition := func(tc *testCase) {
- tc.secretStore.GetSpec().Conditions = []esv1beta1.ClusterSecretStoreCondition{
- {
- Namespaces: []string{"some-other-ns"},
- },
- }
- tc.checkCondition = func(es *esv1beta1.ExternalSecret) bool {
- cond := GetExternalSecretCondition(es.Status, esv1beta1.ExternalSecretReady)
- if cond == nil || cond.Status != v1.ConditionFalse || cond.Reason != esv1beta1.ConditionReasonSecretSyncedError {
- return false
- }
- return true
- }
- }
- // Secret is not created when ClusterSecretStore has a single non-matching string condition with multiple names
- noSecretCreatedWhenNamespaceDoesntMatchStringConditionWithMultipleNames := func(tc *testCase) {
- tc.secretStore.GetSpec().Conditions = []esv1beta1.ClusterSecretStoreCondition{
- {
- Namespaces: []string{"some-other-ns", "another-ns"},
- },
- }
- tc.checkCondition = func(es *esv1beta1.ExternalSecret) bool {
- cond := GetExternalSecretCondition(es.Status, esv1beta1.ExternalSecretReady)
- if cond == nil || cond.Status != v1.ConditionFalse || cond.Reason != esv1beta1.ConditionReasonSecretSyncedError {
- return false
- }
- return true
- }
- }
- // Secret is not created when ClusterSecretStore has a multiple non-matching string condition
- noSecretCreatedWhenNamespaceDoesntMatchMultipleStringCondition := func(tc *testCase) {
- tc.secretStore.GetSpec().Conditions = []esv1beta1.ClusterSecretStoreCondition{
- {
- Namespaces: []string{"some-other-ns"},
- },
- {
- Namespaces: []string{"another-ns"},
- },
- }
- tc.checkCondition = func(es *esv1beta1.ExternalSecret) bool {
- cond := GetExternalSecretCondition(es.Status, esv1beta1.ExternalSecretReady)
- if cond == nil || cond.Status != v1.ConditionFalse || cond.Reason != esv1beta1.ConditionReasonSecretSyncedError {
- return false
- }
- return true
- }
- }
- // Secret is created when ClusterSecretStore has a single matching string condition
- secretCreatedWhenNamespaceMatchesSingleStringCondition := func(tc *testCase) {
- tc.secretStore.GetSpec().Conditions = []esv1beta1.ClusterSecretStoreCondition{
- {
- Namespaces: []string{ExternalSecretNamespace},
- },
- }
- tc.checkSecret = func(es *esv1beta1.ExternalSecret, secret *v1.Secret) {
- Expect(string(secret.Data[targetProp])).To(Equal(secretVal))
- }
- }
- // Secret is created when ClusterSecretStore has a multiple string conditions, one matching
- secretCreatedWhenNamespaceMatchesMultipleStringConditions := func(tc *testCase) {
- tc.secretStore.GetSpec().Conditions = []esv1beta1.ClusterSecretStoreCondition{
- {
- Namespaces: []string{ExternalSecretNamespace, "some-other-ns"},
- },
- }
- tc.checkSecret = func(es *esv1beta1.ExternalSecret, secret *v1.Secret) {
- Expect(string(secret.Data[targetProp])).To(Equal(secretVal))
- }
- }
- // Secret is not created when ClusterSecretStore has a single non-matching label condition
- noSecretCreatedWhenNamespaceDoesntMatchLabelCondition := func(tc *testCase) {
- tc.secretStore.GetSpec().Conditions = []esv1beta1.ClusterSecretStoreCondition{
- {
- NamespaceSelector: &metav1.LabelSelector{MatchLabels: map[string]string{"some-label-key": "some-label-value"}},
- },
- }
- tc.checkCondition = func(es *esv1beta1.ExternalSecret) bool {
- cond := GetExternalSecretCondition(es.Status, esv1beta1.ExternalSecretReady)
- if cond == nil || cond.Status != v1.ConditionFalse || cond.Reason != esv1beta1.ConditionReasonSecretSyncedError {
- return false
- }
- return true
- }
- }
- // Secret is created when ClusterSecretStore has a single matching label condition
- secretCreatedWhenNamespaceMatchOnlyLabelCondition := func(tc *testCase) {
- tc.secretStore.GetSpec().Conditions = []esv1beta1.ClusterSecretStoreCondition{
- {
- NamespaceSelector: &metav1.LabelSelector{MatchLabels: map[string]string{NamespaceLabelKey: NamespaceLabelValue}},
- },
- }
- tc.checkSecret = func(es *esv1beta1.ExternalSecret, secret *v1.Secret) {
- Expect(string(secret.Data[targetProp])).To(Equal(secretVal))
- }
- }
- // Secret is not created when ClusterSecretStore has a partially matching label condition
- noSecretCreatedWhenNamespacePartiallyMatchLabelCondition := func(tc *testCase) {
- tc.secretStore.GetSpec().Conditions = []esv1beta1.ClusterSecretStoreCondition{
- {
- NamespaceSelector: &metav1.LabelSelector{MatchLabels: map[string]string{NamespaceLabelKey: NamespaceLabelValue, "some-label-key": "some-label-value"}},
- },
- }
- tc.checkCondition = func(es *esv1beta1.ExternalSecret) bool {
- cond := GetExternalSecretCondition(es.Status, esv1beta1.ExternalSecretReady)
- if cond == nil || cond.Status != v1.ConditionFalse || cond.Reason != esv1beta1.ConditionReasonSecretSyncedError {
- return false
- }
- return true
- }
- }
- // Secret is created when ClusterSecretStore has at least one matching label condition
- secretCreatedWhenNamespaceMatchOneLabelCondition := func(tc *testCase) {
- tc.secretStore.GetSpec().Conditions = []esv1beta1.ClusterSecretStoreCondition{
- {
- NamespaceSelector: &metav1.LabelSelector{MatchLabels: map[string]string{NamespaceLabelKey: NamespaceLabelValue}},
- },
- {
- NamespaceSelector: &metav1.LabelSelector{MatchLabels: map[string]string{"some-label-key": "some-label-value"}},
- },
- }
- tc.checkSecret = func(es *esv1beta1.ExternalSecret, secret *v1.Secret) {
- Expect(string(secret.Data[targetProp])).To(Equal(secretVal))
- }
- }
- // Secret is created when ClusterSecretStore has multiple matching conditions
- secretCreatedWhenNamespaceMatchMultipleConditions := func(tc *testCase) {
- tc.secretStore.GetSpec().Conditions = []esv1beta1.ClusterSecretStoreCondition{
- {
- NamespaceSelector: &metav1.LabelSelector{MatchLabels: map[string]string{NamespaceLabelKey: NamespaceLabelValue}},
- },
- {
- Namespaces: []string{ExternalSecretNamespace},
- },
- }
- tc.checkSecret = func(es *esv1beta1.ExternalSecret, secret *v1.Secret) {
- Expect(string(secret.Data[targetProp])).To(Equal(secretVal))
- }
- }
- // Secret is not created when ClusterSecretStore has multiple non-matching conditions
- noSecretCreatedWhenNamespaceMatchMultipleNonMatchingConditions := func(tc *testCase) {
- tc.secretStore.GetSpec().Conditions = []esv1beta1.ClusterSecretStoreCondition{
- {
- NamespaceSelector: &metav1.LabelSelector{MatchLabels: map[string]string{"some-label-key": "some-label-value"}},
- },
- {
- Namespaces: []string{"some-other-ns"},
- },
- }
- tc.checkCondition = func(es *esv1beta1.ExternalSecret) bool {
- cond := GetExternalSecretCondition(es.Status, esv1beta1.ExternalSecretReady)
- if cond == nil || cond.Status != v1.ConditionFalse || cond.Reason != esv1beta1.ConditionReasonSecretSyncedError {
- return false
- }
- return true
- }
- }
- DescribeTable("When reconciling an ExternalSecret",
- func(tweaks ...testTweaks) {
- tc := makeDefaultTestcase()
- for _, tweak := range tweaks {
- tweak(tc)
- }
- ctx := context.Background()
- By("creating a secret store and external secret")
- Expect(k8sClient.Create(ctx, tc.secretStore)).To(Succeed())
- Expect(k8sClient.Create(ctx, tc.externalSecret)).Should(Succeed())
- esKey := types.NamespacedName{Name: ExternalSecretName, Namespace: ExternalSecretNamespace}
- createdES := &esv1beta1.ExternalSecret{}
- By("checking the es condition")
- Eventually(func() bool {
- err := k8sClient.Get(ctx, esKey, createdES)
- if err != nil {
- return false
- }
- return tc.checkCondition(createdES)
- }, timeout, interval).Should(BeTrue())
- tc.checkExternalSecret(createdES)
- // this must be optional so we can test faulty es configuration
- if tc.checkSecret != nil {
- syncedSecret := &v1.Secret{}
- secretLookupKey := types.NamespacedName{
- Name: tc.targetSecretName,
- Namespace: ExternalSecretNamespace,
- }
- if createdES.Spec.Target.Name == "" {
- secretLookupKey = types.NamespacedName{
- Name: ExternalSecretName,
- Namespace: ExternalSecretNamespace,
- }
- }
- Eventually(func() bool {
- err := k8sClient.Get(ctx, secretLookupKey, syncedSecret)
- return err == nil
- }, timeout, interval).Should(BeTrue())
- tc.checkSecret(createdES, syncedSecret)
- }
- },
- Entry("should recreate deleted secret", checkDeletion),
- Entry("should create proper hash annotation for the external secret", checkSecretDataHashAnnotation),
- Entry("es deletes orphaned secrets", deleteOrphanedSecrets),
- Entry("should refresh when the hash annotation doesn't correspond to secret data", checkSecretDataHashAnnotationChange),
- Entry("should use external secret name if target secret name isn't defined", syncWithoutTargetName),
- Entry("should sync to target secrets with naming bigger than 63 characters", syncBigNames),
- Entry("should expose the secret as a provisioned service binding secret", syncBindingSecret),
- Entry("should not expose a provisioned service when no secret is synced", skipBindingSecret),
- Entry("should set the condition eventually", syncLabelsAnnotations),
- Entry("should set prometheus counters", checkPrometheusCounters),
- Entry("should merge with existing secret using creationPolicy=Merge", mergeWithSecret),
- Entry("should error if secret doesn't exist when using creationPolicy=Merge", mergeWithSecretErr),
- Entry("should not resolve conflicts with creationPolicy=Merge", mergeWithConflict),
- Entry("should not update unchanged secret using creationPolicy=Merge", mergeWithSecretNoChange),
- Entry("should not delete pre-existing secret with creationPolicy=Orphan", createSecretPolicyOrphan),
- Entry("should sync with generatorRef", syncWithGeneratorRef),
- Entry("should not process generatorRef with mismatching controller field", ignoreMismatchControllerForGeneratorRef),
- Entry("should sync with multiple secret stores via sourceRef", syncWithMultipleSecretStores),
- Entry("should sync with template", syncWithTemplate),
- Entry("should sync with template engine v2", syncWithTemplateV2),
- Entry("should sync template with correct value precedence", syncWithTemplatePrecedence),
- Entry("should sync template from keys and values", syncTemplateFromKeysAndValues),
- Entry("should sync template from literal", syncTemplateFromLiteral),
- Entry("should update template if ExternalSecret is updated", templateShouldRewrite),
- Entry("should keep data with templates if MergePolicy=Merge", templateShouldMerge),
- Entry("should refresh secret from template", refreshWithTemplate),
- Entry("should be able to use only metadata from template", onlyMetadataFromTemplate),
- Entry("should refresh secret value when provider secret changes", refreshSecretValue),
- Entry("should refresh secret map when provider secret changes", refreshSecretValueMap),
- Entry("should refresh secret map when provider secret changes when using a template", refreshSecretValueMapTemplate),
- Entry("should not refresh secret value when provider secret changes but refreshInterval is zero", refreshintervalZero),
- Entry("should fetch secret using dataFrom", syncWithDataFrom),
- Entry("should rewrite secret using dataFrom", syncAndRewriteWithDataFrom),
- Entry("should not automatically convert from extract if rewrite is used", invalidExtractKeysErrCondition),
- Entry("should fetch secret using dataFrom.find", syncDataFromFind),
- Entry("should rewrite secret using dataFrom.find", syncAndRewriteDataFromFind),
- Entry("should not automatically convert from find if rewrite is used", invalidFindKeysErrCondition),
- Entry("should fetch secret using dataFrom and a template", syncWithDataFromTemplate),
- Entry("should set error condition when provider errors", providerErrCondition),
- Entry("should set an error condition when store does not exist", storeMissingErrCondition),
- Entry("should set an error condition when store provider constructor fails", storeConstructErrCondition),
- Entry("should not process store with mismatching controller field", ignoreMismatchController),
- Entry("should not process cluster secret store when it is disabled", ignoreClusterSecretStoreWhenDisabled),
- Entry("should eventually delete target secret with deletionPolicy=Delete", deleteSecretPolicy),
- Entry("should not delete target secret with deletionPolicy=Retain", deleteSecretPolicyRetain),
- Entry("should not delete pre-existing secret with deletionPolicy=Merge", deleteSecretPolicyMerge),
- Entry("secret is created when there are no conditions for the cluster secret store", useClusterSecretStore, noConditionsSecretCreated),
- Entry("secret is not created when the condition for the cluster secret store states a different namespace single string condition", useClusterSecretStore, noSecretCreatedWhenNamespaceDoesntMatchStringCondition),
- Entry("secret is not created when the condition for the cluster secret store states a different namespace single string condition with multiple names", useClusterSecretStore, noSecretCreatedWhenNamespaceDoesntMatchStringConditionWithMultipleNames),
- Entry("secret is not created when the condition for the cluster secret store states a different namespace multiple string conditions", useClusterSecretStore, noSecretCreatedWhenNamespaceDoesntMatchMultipleStringCondition),
- Entry("secret is created when the condition for the cluster secret store has only one matching namespace by string condition", useClusterSecretStore, secretCreatedWhenNamespaceMatchesSingleStringCondition),
- Entry("secret is created when the condition for the cluster secret store has one matching namespace of multiple namespaces by string condition", useClusterSecretStore, secretCreatedWhenNamespaceMatchesMultipleStringConditions),
- Entry("secret is not created when the condition for the cluster secret store states a non-matching label condition", useClusterSecretStore, noSecretCreatedWhenNamespaceDoesntMatchLabelCondition),
- Entry("secret is created when the condition for the cluster secret store states a single matching label condition", useClusterSecretStore, secretCreatedWhenNamespaceMatchOnlyLabelCondition),
- Entry("secret is not created when the condition for the cluster secret store states a partially-matching label condition", useClusterSecretStore, noSecretCreatedWhenNamespacePartiallyMatchLabelCondition),
- Entry("secret is created when one of the label conditions for the cluster secret store matches", useClusterSecretStore, secretCreatedWhenNamespaceMatchOneLabelCondition),
- Entry("secret is created when the namespaces matches multiple cluster secret store conditions", useClusterSecretStore, secretCreatedWhenNamespaceMatchMultipleConditions),
- Entry("secret is not created when the namespaces doesn't match any of multiple cluster secret store conditions", useClusterSecretStore, noSecretCreatedWhenNamespaceMatchMultipleNonMatchingConditions),
- )
- })
- var _ = Describe("ExternalSecret refresh logic", func() {
- Context("secret refresh", func() {
- It("should refresh when resource version does not match", func() {
- Expect(shouldRefresh(esv1beta1.ExternalSecret{
- Status: esv1beta1.ExternalSecretStatus{
- SyncedResourceVersion: "some resource version",
- },
- })).To(BeTrue())
- })
- It("should refresh when labels change", func() {
- es := esv1beta1.ExternalSecret{
- ObjectMeta: metav1.ObjectMeta{
- Generation: 1,
- Labels: map[string]string{
- "foo": "bar",
- },
- },
- Spec: esv1beta1.ExternalSecretSpec{
- RefreshInterval: &metav1.Duration{Duration: time.Minute},
- },
- Status: esv1beta1.ExternalSecretStatus{
- RefreshTime: metav1.Now(),
- },
- }
- es.Status.SyncedResourceVersion = getResourceVersion(es)
- // this should not refresh, rv matches object
- Expect(shouldRefresh(es)).To(BeFalse())
- // change labels without changing the syncedResourceVersion and expect refresh
- es.ObjectMeta.Labels["new"] = "w00t"
- Expect(shouldRefresh(es)).To(BeTrue())
- })
- It("should refresh when annotations change", func() {
- es := esv1beta1.ExternalSecret{
- ObjectMeta: metav1.ObjectMeta{
- Generation: 1,
- Annotations: map[string]string{
- "foo": "bar",
- },
- },
- Spec: esv1beta1.ExternalSecretSpec{
- RefreshInterval: &metav1.Duration{Duration: time.Minute},
- },
- Status: esv1beta1.ExternalSecretStatus{
- RefreshTime: metav1.Now(),
- },
- }
- es.Status.SyncedResourceVersion = getResourceVersion(es)
- // this should not refresh, rv matches object
- Expect(shouldRefresh(es)).To(BeFalse())
- // change annotations without changing the syncedResourceVersion and expect refresh
- es.ObjectMeta.Annotations["new"] = "w00t"
- Expect(shouldRefresh(es)).To(BeTrue())
- })
- It("should refresh when generation has changed", func() {
- es := esv1beta1.ExternalSecret{
- ObjectMeta: metav1.ObjectMeta{
- Generation: 1,
- },
- Spec: esv1beta1.ExternalSecretSpec{
- RefreshInterval: &metav1.Duration{Duration: 0},
- },
- Status: esv1beta1.ExternalSecretStatus{
- RefreshTime: metav1.Now(),
- },
- }
- es.Status.SyncedResourceVersion = getResourceVersion(es)
- Expect(shouldRefresh(es)).To(BeFalse())
- // update gen -> refresh
- es.ObjectMeta.Generation = 2
- Expect(shouldRefresh(es)).To(BeTrue())
- })
- It("should skip refresh when refreshInterval is 0", func() {
- es := esv1beta1.ExternalSecret{
- ObjectMeta: metav1.ObjectMeta{
- Generation: 1,
- },
- Spec: esv1beta1.ExternalSecretSpec{
- RefreshInterval: &metav1.Duration{Duration: 0},
- },
- Status: esv1beta1.ExternalSecretStatus{},
- }
- // resource version matches
- es.Status.SyncedResourceVersion = getResourceVersion(es)
- Expect(shouldRefresh(es)).To(BeFalse())
- })
- It("should refresh when refresh interval has passed", func() {
- es := esv1beta1.ExternalSecret{
- ObjectMeta: metav1.ObjectMeta{
- Generation: 1,
- },
- Spec: esv1beta1.ExternalSecretSpec{
- RefreshInterval: &metav1.Duration{Duration: time.Second},
- },
- Status: esv1beta1.ExternalSecretStatus{
- RefreshTime: metav1.NewTime(metav1.Now().Add(-time.Second * 5)),
- },
- }
- // resource version matches
- es.Status.SyncedResourceVersion = getResourceVersion(es)
- Expect(shouldRefresh(es)).To(BeTrue())
- })
- It("should refresh when no refresh time was set", func() {
- es := esv1beta1.ExternalSecret{
- ObjectMeta: metav1.ObjectMeta{
- Generation: 1,
- },
- Spec: esv1beta1.ExternalSecretSpec{
- RefreshInterval: &metav1.Duration{Duration: time.Second},
- },
- Status: esv1beta1.ExternalSecretStatus{},
- }
- // resource version matches
- es.Status.SyncedResourceVersion = getResourceVersion(es)
- Expect(shouldRefresh(es)).To(BeTrue())
- })
- })
- Context("objectmeta hash", func() {
- It("should produce different hashes for different k/v pairs", func() {
- h1 := hashMeta(metav1.ObjectMeta{
- Generation: 1,
- Annotations: map[string]string{
- "foo": "bar",
- },
- })
- h2 := hashMeta(metav1.ObjectMeta{
- Generation: 1,
- Annotations: map[string]string{
- "foo": "bing",
- },
- })
- Expect(h1).ToNot(Equal(h2))
- })
- It("should produce different hashes for different generations but same label/annotations", func() {
- h1 := hashMeta(metav1.ObjectMeta{
- Generation: 1,
- Annotations: map[string]string{
- "foo": "bar",
- },
- Labels: map[string]string{
- "foo": "bar",
- },
- })
- h2 := hashMeta(metav1.ObjectMeta{
- Generation: 2,
- Annotations: map[string]string{
- "foo": "bar",
- },
- Labels: map[string]string{
- "foo": "bar",
- },
- })
- Expect(h1).To(Equal(h2))
- })
- It("should produce the same hash for the same k/v pairs", func() {
- h1 := hashMeta(metav1.ObjectMeta{
- Generation: 1,
- })
- h2 := hashMeta(metav1.ObjectMeta{
- Generation: 1,
- })
- Expect(h1).To(Equal(h2))
- h1 = hashMeta(metav1.ObjectMeta{
- Generation: 1,
- Annotations: map[string]string{
- "foo": "bar",
- },
- })
- h2 = hashMeta(metav1.ObjectMeta{
- Generation: 1,
- Annotations: map[string]string{
- "foo": "bar",
- },
- })
- Expect(h1).To(Equal(h2))
- })
- })
- })
- var _ = Describe("Controller Reconcile logic", func() {
- Context("controller reconcile", func() {
- It("should reconcile when resource is not synced", func() {
- Expect(shouldReconcile(esv1beta1.ExternalSecret{
- Status: esv1beta1.ExternalSecretStatus{
- SyncedResourceVersion: "some resource version",
- Conditions: []esv1beta1.ExternalSecretStatusCondition{{Reason: "NotASecretSynced"}},
- },
- })).To(BeTrue())
- })
- It("should reconcile when secret isn't immutable", func() {
- Expect(shouldReconcile(esv1beta1.ExternalSecret{
- Spec: esv1beta1.ExternalSecretSpec{
- Target: esv1beta1.ExternalSecretTarget{
- Immutable: false,
- },
- },
- })).To(BeTrue())
- })
- It("should not reconcile if secret is immutable and has synced condition", func() {
- Expect(shouldReconcile(esv1beta1.ExternalSecret{
- Spec: esv1beta1.ExternalSecretSpec{
- Target: esv1beta1.ExternalSecretTarget{
- Immutable: true,
- },
- },
- Status: esv1beta1.ExternalSecretStatus{
- SyncedResourceVersion: "some resource version",
- Conditions: []esv1beta1.ExternalSecretStatusCondition{{Reason: "SecretSynced"}},
- },
- })).To(BeFalse())
- })
- })
- })
- func externalSecretConditionShouldBe(name, ns string, ct esv1beta1.ExternalSecretConditionType, cs v1.ConditionStatus, v float64) bool {
- return Eventually(func() float64 {
- Expect(testExternalSecretCondition.WithLabelValues(name, ns, string(ct), string(cs)).Write(&metric)).To(Succeed())
- return metric.GetGauge().GetValue()
- }, timeout, interval).Should(Equal(v))
- }
- func init() {
- fakeProvider = fake.New()
- esv1beta1.ForceRegister(fakeProvider, &esv1beta1.SecretStoreProvider{
- AWS: &esv1beta1.AWSProvider{
- Service: esv1beta1.AWSServiceSecretsManager,
- },
- })
- ctrlmetrics.SetUpLabelNames(false)
- esmetrics.SetUpMetrics()
- testSyncCallsTotal = esmetrics.GetCounterVec(esmetrics.SyncCallsKey)
- testSyncCallsError = esmetrics.GetCounterVec(esmetrics.SyncCallsErrorKey)
- testExternalSecretCondition = esmetrics.GetGaugeVec(esmetrics.ExternalSecretStatusConditionKey)
- testExternalSecretReconcileDuration = esmetrics.GetGaugeVec(esmetrics.ExternalSecretReconcileDurationKey)
- }
|