| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234 |
- /*
- 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 (
- "context"
- "fmt"
- "os"
- "strconv"
- "time"
- . "github.com/onsi/ginkgo"
- . "github.com/onsi/ginkgo/extensions/table"
- . "github.com/onsi/gomega"
- dto "github.com/prometheus/client_model/go"
- v1 "k8s.io/api/core/v1"
- metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
- "k8s.io/apimachinery/pkg/types"
- "k8s.io/apimachinery/pkg/util/wait"
- "sigs.k8s.io/controller-runtime/pkg/client"
- esv1alpha1 "github.com/external-secrets/external-secrets/apis/externalsecrets/v1alpha1"
- "github.com/external-secrets/external-secrets/pkg/provider"
- "github.com/external-secrets/external-secrets/pkg/provider/fake"
- "github.com/external-secrets/external-secrets/pkg/provider/schema"
- )
- var (
- fakeProvider *fake.Client
- metric dto.Metric
- timeout = time.Second * 10
- interval = time.Millisecond * 250
- )
- type testCase struct {
- secretStore *esv1alpha1.SecretStore
- externalSecret *esv1alpha1.ExternalSecret
- // checkCondition should return true if the externalSecret
- // has the expected condition
- checkCondition func(*esv1alpha1.ExternalSecret) bool
- // checkExternalSecret is called after the condition has been verified
- // use this to verify the externalSecret
- checkExternalSecret func(*esv1alpha1.ExternalSecret)
- // optional. use this to test the secret value
- checkSecret func(*esv1alpha1.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{
- esv1alpha1.AnnotationDataHash: "xxxxxx",
- },
- },
- },
- ExpectedOutput: false,
- },
- {
- Name: "A valid config map should return true",
- Input: v1.Secret{
- ObjectMeta: metav1.ObjectMeta{
- UID: "xxx",
- Annotations: map[string]string{
- esv1alpha1.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", func() {
- const (
- ExternalSecretName = "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"
- )
- 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 = CreateNamespace("test-ns", k8sClient)
- Expect(err).ToNot(HaveOccurred())
- metric.Reset()
- syncCallsTotal.Reset()
- syncCallsError.Reset()
- externalSecretCondition.Reset()
- })
- AfterEach(func() {
- Expect(k8sClient.Delete(context.Background(), &v1.Namespace{
- ObjectMeta: metav1.ObjectMeta{
- Name: ExternalSecretNamespace,
- },
- }, client.PropagationPolicy(metav1.DeletePropagationBackground)), client.GracePeriodSeconds(0)).To(Succeed())
- Expect(k8sClient.Delete(context.Background(), &esv1alpha1.SecretStore{
- ObjectMeta: metav1.ObjectMeta{
- Name: ExternalSecretStore,
- Namespace: ExternalSecretNamespace,
- },
- }, client.PropagationPolicy(metav1.DeletePropagationBackground)), client.GracePeriodSeconds(0)).To(Succeed())
- })
- const targetProp = "targetProperty"
- const remoteKey = "barz"
- const remoteProperty = "bang"
- makeDefaultTestcase := func() *testCase {
- return &testCase{
- // default condition: es should be ready
- checkCondition: func(es *esv1alpha1.ExternalSecret) bool {
- cond := GetExternalSecretCondition(es.Status, esv1alpha1.ExternalSecretReady)
- if cond == nil || cond.Status != v1.ConditionTrue {
- return false
- }
- return true
- },
- checkExternalSecret: func(es *esv1alpha1.ExternalSecret) {},
- secretStore: &esv1alpha1.SecretStore{
- ObjectMeta: metav1.ObjectMeta{
- Name: ExternalSecretStore,
- Namespace: ExternalSecretNamespace,
- },
- Spec: esv1alpha1.SecretStoreSpec{
- Provider: &esv1alpha1.SecretStoreProvider{
- AWS: &esv1alpha1.AWSProvider{
- Service: esv1alpha1.AWSServiceSecretsManager,
- },
- },
- },
- },
- externalSecret: &esv1alpha1.ExternalSecret{
- ObjectMeta: metav1.ObjectMeta{
- Name: ExternalSecretName,
- Namespace: ExternalSecretNamespace,
- },
- Spec: esv1alpha1.ExternalSecretSpec{
- SecretStoreRef: esv1alpha1.SecretStoreRef{
- Name: ExternalSecretStore,
- },
- Target: esv1alpha1.ExternalSecretTarget{
- Name: ExternalSecretTargetSecretName,
- },
- Data: []esv1alpha1.ExternalSecretData{
- {
- SecretKey: targetProp,
- RemoteRef: esv1alpha1.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 *esv1alpha1.ExternalSecret, secret *v1.Secret) {
- // check secret name
- Expect(secret.ObjectMeta.Name).To(Equal(ExternalSecretName))
- }
- }
- // 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 *esv1alpha1.ExternalSecret, secret *v1.Secret) {
- // check value
- Expect(string(secret.Data[targetProp])).To(Equal(secretVal))
- // check labels & annotations
- Expect(secret.ObjectMeta.Labels).To(BeEquivalentTo(es.ObjectMeta.Labels))
- for k, v := range es.ObjectMeta.Annotations {
- Expect(secret.ObjectMeta.Annotations).To(HaveKeyWithValue(k, v))
- }
- // ownerRef must not not be set!
- Expect(hasOwnerRef(secret.ObjectMeta, "ExternalSecret", ExternalSecretName)).To(BeTrue())
- }
- }
- checkPrometheusCounters := func(tc *testCase) {
- const secretVal = "someValue"
- fakeProvider.WithGetSecret([]byte(secretVal), nil)
- tc.checkSecret = func(es *esv1alpha1.ExternalSecret, secret *v1.Secret) {
- Expect(externalSecretConditionShouldBe(ExternalSecretName, ExternalSecretNamespace, esv1alpha1.ExternalSecretReady, v1.ConditionFalse, 0.0)).To(BeTrue())
- Expect(externalSecretConditionShouldBe(ExternalSecretName, ExternalSecretNamespace, esv1alpha1.ExternalSecretReady, v1.ConditionTrue, 1.0)).To(BeTrue())
- Eventually(func() bool {
- Expect(syncCallsTotal.WithLabelValues(ExternalSecretName, ExternalSecretNamespace).Write(&metric)).To(Succeed())
- return metric.GetCounter().GetValue() == 1.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 = esv1alpha1.Merge
- // 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 *esv1alpha1.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
- Expect(secret.ObjectMeta.Labels).To(BeEquivalentTo(es.ObjectMeta.Labels))
- for k, v := range es.ObjectMeta.Annotations {
- Expect(secret.ObjectMeta.Annotations).To(HaveKeyWithValue(k, v))
- }
- Expect(hasOwnerRef(secret.ObjectMeta, "ExternalSecret", ExternalSecretName)).To(BeFalse())
- Expect(secret.ObjectMeta.ManagedFields).To(HaveLen(2))
- Expect(hasFieldOwnership(
- secret.ObjectMeta,
- "external-secrets",
- fmt.Sprintf("{\"f:data\":{\"f:targetProperty\":{}},\"f:immutable\":{},\"f:metadata\":{\"f:annotations\":{\"f:%s\":{}}}}", esv1alpha1.AnnotationDataHash)),
- ).To(BeTrue())
- Expect(hasFieldOwnership(secret.ObjectMeta, FakeManager, "{\"f:data\":{\".\":{},\"f:pre-existing-key\":{}},\"f:type\":{}}")).To(BeTrue())
- }
- }
- // should not merge with secret if it doesn't exist
- mergeWithSecretErr := func(tc *testCase) {
- const secretVal = "someValue"
- tc.externalSecret.Spec.Target.CreationPolicy = esv1alpha1.Merge
- fakeProvider.WithGetSecret([]byte(secretVal), nil)
- tc.checkCondition = func(es *esv1alpha1.ExternalSecret) bool {
- cond := GetExternalSecretCondition(es.Status, esv1alpha1.ExternalSecretReady)
- if cond == nil || cond.Status != v1.ConditionFalse || cond.Reason != esv1alpha1.ConditionReasonSecretSyncedError {
- return false
- }
- return true
- }
- tc.checkExternalSecret = func(es *esv1alpha1.ExternalSecret) {
- Eventually(func() bool {
- Expect(syncCallsError.WithLabelValues(ExternalSecretName, ExternalSecretNamespace).Write(&metric)).To(Succeed())
- return metric.GetCounter().GetValue() >= 2.0
- }, timeout, interval).Should(BeTrue())
- Expect(externalSecretConditionShouldBe(ExternalSecretName, ExternalSecretNamespace, esv1alpha1.ExternalSecretReady, v1.ConditionFalse, 1.0)).To(BeTrue())
- Expect(externalSecretConditionShouldBe(ExternalSecretName, ExternalSecretNamespace, esv1alpha1.ExternalSecretReady, v1.ConditionTrue, 0.0)).To(BeTrue())
- }
- }
- // controller should not force override but
- // return an error on conflict
- mergeWithConflict := func(tc *testCase) {
- const secretVal = "someValue"
- // this should confict
- const existingKey = targetProp
- existingVal := "pre-existing-value"
- tc.externalSecret.Spec.Target.CreationPolicy = esv1alpha1.Merge
- // 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.checkCondition = func(es *esv1alpha1.ExternalSecret) bool {
- cond := GetExternalSecretCondition(es.Status, esv1alpha1.ExternalSecretReady)
- if cond == nil || cond.Status != v1.ConditionFalse || cond.Reason != esv1alpha1.ConditionReasonSecretSyncedError {
- return false
- }
- return true
- }
- tc.checkSecret = func(es *esv1alpha1.ExternalSecret, secret *v1.Secret) {
- // check that value stays the same
- Expect(string(secret.Data[existingKey])).To(Equal(existingVal))
- Expect(string(secret.Data[targetProp])).ToNot(Equal(secretVal))
- // check owner/managedFields
- Expect(hasOwnerRef(secret.ObjectMeta, "ExternalSecret", ExternalSecretName)).To(BeFalse())
- Expect(secret.ObjectMeta.ManagedFields).To(HaveLen(1))
- Expect(hasFieldOwnership(secret.ObjectMeta, FakeManager, "{\"f:data\":{\".\":{},\"f:targetProperty\":{}},\"f:type\":{}}")).To(BeTrue())
- }
- }
- // 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 = &esv1alpha1.ExternalSecretTemplate{
- Metadata: esv1alpha1.ExternalSecretTemplateMetadata{
- Labels: map[string]string{
- "foos": "ball",
- },
- Annotations: map[string]string{
- "hihi": "ga",
- },
- },
- Type: v1.SecretTypeOpaque,
- Data: map[string]string{
- targetProp: targetPropObj,
- tplStaticKey: tplStaticVal,
- },
- }
- fakeProvider.WithGetSecret([]byte(secretVal), nil)
- tc.checkSecret = func(es *esv1alpha1.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
- Expect(secret.ObjectMeta.Labels).To(BeEquivalentTo(es.Spec.Target.Template.Metadata.Labels))
- for k, v := range es.Spec.Target.Template.Metadata.Annotations {
- Expect(secret.ObjectMeta.Annotations).To(HaveKeyWithValue(k, v))
- }
- }
- }
- // secret should be synced with correct value precedence:
- // * template
- // * 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 = &esv1alpha1.ExternalSecretTemplate{
- Metadata: esv1alpha1.ExternalSecretTemplateMetadata{},
- Type: v1.SecretTypeOpaque,
- TemplateFrom: []esv1alpha1.TemplateFrom{
- {
- ConfigMap: &esv1alpha1.TemplateRef{
- Name: tplFromCMName,
- Items: []esv1alpha1.TemplateRefItem{
- {
- Key: tplFromKey,
- },
- },
- },
- },
- {
- Secret: &esv1alpha1.TemplateRef{
- Name: tplFromSecretName,
- Items: []esv1alpha1.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 = []esv1alpha1.ExternalSecretDataRemoteRef{
- {
- Key: "datamap",
- },
- }
- fakeProvider.WithGetSecret([]byte(secretVal), nil)
- fakeProvider.WithGetSecretMap(map[string][]byte{
- "targetProperty": []byte(FooValue),
- "bar": []byte(BarValue),
- }, nil)
- tc.checkSecret = func(es *esv1alpha1.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"))
- }
- }
- 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 = &esv1alpha1.ExternalSecretTemplate{
- Metadata: esv1alpha1.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 *esv1alpha1.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
- Expect(secret.ObjectMeta.Labels).To(BeEquivalentTo(es.Spec.Target.Template.Metadata.Labels))
- // 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
- Expect(secret.ObjectMeta.Labels).To(BeEquivalentTo(es.Spec.Target.Template.Metadata.Labels))
- 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 = &esv1alpha1.ExternalSecretTemplate{
- Metadata: esv1alpha1.ExternalSecretTemplateMetadata{
- Labels: map[string]string{"foo": "bar"},
- Annotations: map[string]string{"foo": "bar"},
- },
- }
- fakeProvider.WithGetSecret([]byte(secretVal), nil)
- tc.checkSecret = func(es *esv1alpha1.ExternalSecret, secret *v1.Secret) {
- // check values
- Expect(string(secret.Data[targetProp])).To(Equal(secretVal))
- // labels/annotations should be taken from the template
- Expect(secret.ObjectMeta.Labels).To(BeEquivalentTo(es.Spec.Target.Template.Metadata.Labels))
- 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 *esv1alpha1.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())
- }
- }
- 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 *esv1alpha1.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())
- }
- }
- // 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 = []esv1alpha1.ExternalSecretDataRemoteRef{
- {
- Key: remoteKey,
- },
- }
- fakeProvider.WithGetSecretMap(map[string][]byte{
- "foo": []byte(FooValue),
- "bar": []byte(BarValue),
- }, nil)
- tc.checkSecret = func(es *esv1alpha1.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 = esv1alpha1.ExternalSecretTarget{
- Name: ExternalSecretTargetSecretName,
- Template: &esv1alpha1.ExternalSecretTemplate{
- Type: v1.SecretTypeTLS,
- },
- }
- tc.externalSecret.Spec.DataFrom = []esv1alpha1.ExternalSecretDataRemoteRef{
- {
- Key: remoteKey,
- },
- }
- fakeProvider.WithGetSecretMap(map[string][]byte{
- "tls.crt": []byte(FooValue),
- "tls.key": []byte(BarValue),
- }, nil)
- tc.checkSecret = func(es *esv1alpha1.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 *esv1alpha1.ExternalSecret) bool {
- cond := GetExternalSecretCondition(es.Status, esv1alpha1.ExternalSecretReady)
- if cond == nil || cond.Status != v1.ConditionFalse || cond.Reason != esv1alpha1.ConditionReasonSecretSyncedError {
- return false
- }
- return true
- }
- tc.checkExternalSecret = func(es *esv1alpha1.ExternalSecret) {
- Eventually(func() bool {
- Expect(syncCallsError.WithLabelValues(ExternalSecretName, ExternalSecretNamespace).Write(&metric)).To(Succeed())
- return metric.GetCounter().GetValue() >= 2.0
- }, timeout, interval).Should(BeTrue())
- Expect(externalSecretConditionShouldBe(ExternalSecretName, ExternalSecretNamespace, esv1alpha1.ExternalSecretReady, v1.ConditionFalse, 1.0)).To(BeTrue())
- Expect(externalSecretConditionShouldBe(ExternalSecretName, ExternalSecretNamespace, esv1alpha1.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, esv1alpha1.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 *esv1alpha1.ExternalSecret) bool {
- cond := GetExternalSecretCondition(es.Status, esv1alpha1.ExternalSecretReady)
- if cond == nil || cond.Status != v1.ConditionFalse || cond.Reason != esv1alpha1.ConditionReasonSecretSyncedError {
- return false
- }
- return true
- }
- tc.checkExternalSecret = func(es *esv1alpha1.ExternalSecret) {
- Eventually(func() bool {
- Expect(syncCallsError.WithLabelValues(ExternalSecretName, ExternalSecretNamespace).Write(&metric)).To(Succeed())
- return metric.GetCounter().GetValue() >= 2.0
- }, timeout, interval).Should(BeTrue())
- Expect(externalSecretConditionShouldBe(ExternalSecretName, ExternalSecretNamespace, esv1alpha1.ExternalSecretReady, v1.ConditionFalse, 1.0)).To(BeTrue())
- Expect(externalSecretConditionShouldBe(ExternalSecretName, ExternalSecretNamespace, esv1alpha1.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, esv1alpha1.GenericStore, client.Client,
- string) (provider.SecretsClient, error) {
- return nil, fmt.Errorf("artificial constructor error")
- })
- tc.checkCondition = func(es *esv1alpha1.ExternalSecret) bool {
- // condition must be false
- cond := GetExternalSecretCondition(es.Status, esv1alpha1.ExternalSecretReady)
- if cond == nil || cond.Status != v1.ConditionFalse || cond.Reason != esv1alpha1.ConditionReasonSecretSyncedError {
- return false
- }
- return true
- }
- tc.checkExternalSecret = func(es *esv1alpha1.ExternalSecret) {
- Eventually(func() bool {
- Expect(syncCallsError.WithLabelValues(ExternalSecretName, ExternalSecretNamespace).Write(&metric)).To(Succeed())
- return metric.GetCounter().GetValue() >= 2.0
- }, timeout, interval).Should(BeTrue())
- Expect(externalSecretConditionShouldBe(ExternalSecretName, ExternalSecretNamespace, esv1alpha1.ExternalSecretReady, v1.ConditionFalse, 1.0)).To(BeTrue())
- Expect(externalSecretConditionShouldBe(ExternalSecretName, ExternalSecretNamespace, esv1alpha1.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.Spec.Controller = "nop"
- tc.checkCondition = func(es *esv1alpha1.ExternalSecret) bool {
- cond := GetExternalSecretCondition(es.Status, esv1alpha1.ExternalSecretReady)
- return cond == nil
- }
- tc.checkExternalSecret = func(es *esv1alpha1.ExternalSecret) {
- // Condition True and False should be 0, since the Condition was not created
- Eventually(func() float64 {
- Expect(externalSecretCondition.WithLabelValues(ExternalSecretName, ExternalSecretNamespace, string(esv1alpha1.ExternalSecretReady), string(v1.ConditionTrue)).Write(&metric)).To(Succeed())
- return metric.GetGauge().GetValue()
- }, timeout, interval).Should(Equal(0.0))
- Eventually(func() float64 {
- Expect(externalSecretCondition.WithLabelValues(ExternalSecretName, ExternalSecretNamespace, string(esv1alpha1.ExternalSecretReady), string(v1.ConditionFalse)).Write(&metric)).To(Succeed())
- return metric.GetGauge().GetValue()
- }, timeout, interval).Should(Equal(0.0))
- Expect(externalSecretConditionShouldBe(ExternalSecretName, ExternalSecretNamespace, esv1alpha1.ExternalSecretReady, v1.ConditionFalse, 0.0)).To(BeTrue())
- Expect(externalSecretConditionShouldBe(ExternalSecretName, ExternalSecretNamespace, esv1alpha1.ExternalSecretReady, v1.ConditionTrue, 0.0)).To(BeTrue())
- }
- }
- // 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 *esv1alpha1.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 *esv1alpha1.ExternalSecret, secret *v1.Secret) {
- Expect(secret.Annotations[esv1alpha1.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 *esv1alpha1.ExternalSecret, secret *v1.Secret) {
- oldHash := secret.Annotations[esv1alpha1.AnnotationDataHash]
- oldResourceVersion := secret.ResourceVersion
- Expect(oldHash).NotTo(BeEmpty())
- cleanSecret := secret.DeepCopy()
- secret.Data["new"] = []byte("value")
- secret.ObjectMeta.Annotations[esv1alpha1.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[esv1alpha1.AnnotationDataHash] == oldHash
- }, timeout, interval).Should(BeTrue())
- }
- }
- 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 := &esv1alpha1.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: ExternalSecretTargetSecretName,
- 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("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 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 sync with template", syncWithTemplate),
- Entry("should sync template with correct value precedence", syncWithTemplatePrecedence),
- 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 not refresh secret value when provider secret changes but refreshInterval is zero", refreshintervalZero),
- Entry("should fetch secret using dataFrom", syncWithDataFrom),
- 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),
- )
- })
- var _ = Describe("ExternalSecret refresh logic", func() {
- Context("secret refresh", func() {
- It("should refresh when resource version does not match", func() {
- Expect(shouldRefresh(esv1alpha1.ExternalSecret{
- Status: esv1alpha1.ExternalSecretStatus{
- SyncedResourceVersion: "some resource version",
- },
- })).To(BeTrue())
- })
- It("should refresh when labels change", func() {
- es := esv1alpha1.ExternalSecret{
- ObjectMeta: metav1.ObjectMeta{
- Generation: 1,
- Labels: map[string]string{
- "foo": "bar",
- },
- },
- Spec: esv1alpha1.ExternalSecretSpec{
- RefreshInterval: &metav1.Duration{Duration: time.Minute},
- },
- Status: esv1alpha1.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 := esv1alpha1.ExternalSecret{
- ObjectMeta: metav1.ObjectMeta{
- Generation: 1,
- Annotations: map[string]string{
- "foo": "bar",
- },
- },
- Spec: esv1alpha1.ExternalSecretSpec{
- RefreshInterval: &metav1.Duration{Duration: time.Minute},
- },
- Status: esv1alpha1.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 := esv1alpha1.ExternalSecret{
- ObjectMeta: metav1.ObjectMeta{
- Generation: 1,
- },
- Spec: esv1alpha1.ExternalSecretSpec{
- RefreshInterval: &metav1.Duration{Duration: 0},
- },
- Status: esv1alpha1.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 := esv1alpha1.ExternalSecret{
- ObjectMeta: metav1.ObjectMeta{
- Generation: 1,
- },
- Spec: esv1alpha1.ExternalSecretSpec{
- RefreshInterval: &metav1.Duration{Duration: 0},
- },
- Status: esv1alpha1.ExternalSecretStatus{},
- }
- // resource version matches
- es.Status.SyncedResourceVersion = getResourceVersion(es)
- Expect(shouldRefresh(es)).To(BeFalse())
- })
- It("should refresh when refresh interval has passed", func() {
- es := esv1alpha1.ExternalSecret{
- ObjectMeta: metav1.ObjectMeta{
- Generation: 1,
- },
- Spec: esv1alpha1.ExternalSecretSpec{
- RefreshInterval: &metav1.Duration{Duration: time.Second},
- },
- Status: esv1alpha1.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 := esv1alpha1.ExternalSecret{
- ObjectMeta: metav1.ObjectMeta{
- Generation: 1,
- },
- Spec: esv1alpha1.ExternalSecretSpec{
- RefreshInterval: &metav1.Duration{Duration: time.Second},
- },
- Status: esv1alpha1.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(esv1alpha1.ExternalSecret{
- Status: esv1alpha1.ExternalSecretStatus{
- SyncedResourceVersion: "some resource version",
- Conditions: []esv1alpha1.ExternalSecretStatusCondition{{Reason: "NotASecretSynced"}},
- },
- })).To(BeTrue())
- })
- It("should reconcile when secret isn't immutable", func() {
- Expect(shouldReconcile(esv1alpha1.ExternalSecret{
- Spec: esv1alpha1.ExternalSecretSpec{
- Target: esv1alpha1.ExternalSecretTarget{
- Immutable: false,
- },
- },
- })).To(BeTrue())
- })
- It("should not reconcile if secret is immutable and has synced condition", func() {
- Expect(shouldReconcile(esv1alpha1.ExternalSecret{
- Spec: esv1alpha1.ExternalSecretSpec{
- Target: esv1alpha1.ExternalSecretTarget{
- Immutable: true,
- },
- },
- Status: esv1alpha1.ExternalSecretStatus{
- SyncedResourceVersion: "some resource version",
- Conditions: []esv1alpha1.ExternalSecretStatusCondition{{Reason: "SecretSynced"}},
- },
- })).To(BeFalse())
- })
- })
- })
- // CreateNamespace creates a new namespace in the cluster.
- func CreateNamespace(baseName string, c client.Client) (string, error) {
- genName := fmt.Sprintf("ctrl-test-%v", baseName)
- ns := &v1.Namespace{
- ObjectMeta: metav1.ObjectMeta{
- GenerateName: genName,
- },
- }
- var err error
- err = wait.Poll(time.Second, 10*time.Second, func() (bool, error) {
- err = c.Create(context.Background(), ns)
- if err != nil {
- return false, nil
- }
- return true, nil
- })
- if err != nil {
- return "", err
- }
- return ns.Name, nil
- }
- func hasOwnerRef(meta metav1.ObjectMeta, kind, name string) bool {
- for _, ref := range meta.OwnerReferences {
- if ref.Kind == kind && ref.Name == name {
- return true
- }
- }
- return false
- }
- func hasFieldOwnership(meta metav1.ObjectMeta, mgr, rawFields string) bool {
- for _, ref := range meta.ManagedFields {
- if ref.Manager == mgr && string(ref.FieldsV1.Raw) == rawFields {
- return true
- }
- }
- return false
- }
- func externalSecretConditionShouldBe(name, ns string, ct esv1alpha1.ExternalSecretConditionType, cs v1.ConditionStatus, v float64) bool {
- return Eventually(func() float64 {
- Expect(externalSecretCondition.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()
- schema.ForceRegister(fakeProvider, &esv1alpha1.SecretStoreProvider{
- AWS: &esv1alpha1.AWSProvider{
- Service: esv1alpha1.AWSServiceSecretsManager,
- },
- })
- }
|