| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168 |
- /*
- Copyright © The ESO Authors
- Licensed under the Apache License, Version 2.0 (the "License");
- you may not use this file except in compliance with the License.
- You may obtain a copy of the License at
- https://www.apache.org/licenses/LICENSE-2.0
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
- */
- package store
- import (
- "context"
- "encoding/json"
- "errors"
- "strings"
- "testing"
- corev1 "k8s.io/api/core/v1"
- "k8s.io/apimachinery/pkg/runtime/schema"
- "sigs.k8s.io/controller-runtime/pkg/client"
- "sigs.k8s.io/controller-runtime/pkg/webhook/admission"
- esv1 "github.com/external-secrets/external-secrets/apis/externalsecrets/v1"
- pb "github.com/external-secrets/external-secrets/proto/provider"
- )
- const (
- serverTestRemoteKey = "remote/path"
- serverTestProperty = "property"
- serverTestSourceNamespace = "tenant-a"
- serverTestValue = "value"
- )
- type fakeProviderInterface struct {
- newClient func(context.Context, esv1.GenericStore, client.Client, string) (esv1.SecretsClient, error)
- caps esv1.SecretStoreCapabilities
- }
- func (f *fakeProviderInterface) NewClient(ctx context.Context, store esv1.GenericStore, kube client.Client, namespace string) (esv1.SecretsClient, error) {
- return f.newClient(ctx, store, kube, namespace)
- }
- func (f *fakeProviderInterface) Capabilities() esv1.SecretStoreCapabilities {
- return f.caps
- }
- func (f *fakeProviderInterface) ValidateStore(esv1.GenericStore) (admission.Warnings, error) {
- return nil, nil
- }
- type fakeSecretsClient struct {
- getSecretResponse []byte
- getSecretErr error
- getSecretRef esv1.ExternalSecretDataRemoteRef
- getSecretMapResponse map[string][]byte
- getSecretMapErr error
- getSecretMapRef esv1.ExternalSecretDataRemoteRef
- getAllSecretsResponse map[string][]byte
- getAllSecretsErr error
- getAllSecretsFind esv1.ExternalSecretFind
- pushSecretErr error
- pushSecretSecret *corev1.Secret
- pushSecretData esv1.PushSecretData
- deleteSecretErr error
- deleteSecretRef esv1.PushSecretRemoteRef
- secretExistsResp bool
- secretExistsErr error
- secretExistsRef esv1.PushSecretRemoteRef
- validateResult esv1.ValidationResult
- validateErr error
- closeCalled bool
- }
- func (f *fakeSecretsClient) GetSecret(_ context.Context, ref esv1.ExternalSecretDataRemoteRef) ([]byte, error) {
- f.getSecretRef = ref
- return f.getSecretResponse, f.getSecretErr
- }
- func (f *fakeSecretsClient) GetSecretMap(_ context.Context, ref esv1.ExternalSecretDataRemoteRef) (map[string][]byte, error) {
- f.getSecretMapRef = ref
- return f.getSecretMapResponse, f.getSecretMapErr
- }
- func (f *fakeSecretsClient) GetAllSecrets(_ context.Context, find esv1.ExternalSecretFind) (map[string][]byte, error) {
- f.getAllSecretsFind = find
- return f.getAllSecretsResponse, f.getAllSecretsErr
- }
- func (f *fakeSecretsClient) PushSecret(_ context.Context, secret *corev1.Secret, data esv1.PushSecretData) error {
- f.pushSecretSecret = secret
- f.pushSecretData = data
- return f.pushSecretErr
- }
- func (f *fakeSecretsClient) DeleteSecret(_ context.Context, remoteRef esv1.PushSecretRemoteRef) error {
- f.deleteSecretRef = remoteRef
- return f.deleteSecretErr
- }
- func (f *fakeSecretsClient) SecretExists(_ context.Context, remoteRef esv1.PushSecretRemoteRef) (bool, error) {
- f.secretExistsRef = remoteRef
- return f.secretExistsResp, f.secretExistsErr
- }
- func (f *fakeSecretsClient) Validate() (esv1.ValidationResult, error) {
- return f.validateResult, f.validateErr
- }
- func (f *fakeSecretsClient) Close(context.Context) error {
- f.closeCalled = true
- return nil
- }
- type specMapperRecorder struct {
- ref *pb.ProviderReference
- sourceNamespace string
- spec *esv1.SecretStoreSpec
- err error
- }
- func (r *specMapperRecorder) mapRef(ref *pb.ProviderReference, sourceNamespace string) (*esv1.SecretStoreSpec, error) {
- r.ref = ref
- r.sourceNamespace = sourceNamespace
- return r.spec, r.err
- }
- func mustCompatibilityStore(t *testing.T, spec *esv1.SecretStoreSpec) *pb.CompatibilityStore {
- t.Helper()
- specBytes, err := json.Marshal(spec)
- if err != nil {
- t.Fatalf("json.Marshal() error = %v", err)
- }
- return &pb.CompatibilityStore{
- StoreName: "compat-store",
- StoreNamespace: serverTestSourceNamespace,
- StoreKind: esv1.SecretStoreKind,
- StoreUid: "uid-1",
- StoreGeneration: 7,
- StoreSpecJson: specBytes,
- }
- }
- func TestCompatibilityStoreToSyntheticStoreRejectsInvalidPayloads(t *testing.T) {
- validSpec := &esv1.SecretStoreSpec{
- Provider: &esv1.SecretStoreProvider{
- Fake: &esv1.FakeProvider{},
- },
- }
- validSpecBytes, err := json.Marshal(validSpec)
- if err != nil {
- t.Fatalf("json.Marshal() error = %v", err)
- }
- testCases := []struct {
- name string
- store *pb.CompatibilityStore
- want string
- }{
- {
- name: "nil store",
- store: nil,
- want: "compatibility store is nil",
- },
- {
- name: "empty spec",
- store: &pb.CompatibilityStore{
- StoreKind: esv1.SecretStoreKind,
- },
- want: "compatibility store spec is empty",
- },
- {
- name: "bad json",
- store: &pb.CompatibilityStore{
- StoreKind: esv1.SecretStoreKind,
- StoreSpecJson: []byte(`{`),
- },
- want: "decode compatibility store spec:",
- },
- {
- name: "bad kind",
- store: &pb.CompatibilityStore{
- StoreKind: "UnknownStore",
- StoreSpecJson: validSpecBytes,
- },
- want: `unsupported compatibility store kind "UnknownStore"`,
- },
- {
- name: "missing provider",
- store: &pb.CompatibilityStore{
- StoreKind: esv1.SecretStoreKind,
- StoreSpecJson: []byte(`{"retrySettings":{"maxRetries":1}}`),
- },
- want: "compatibility store provider config is required",
- },
- }
- for _, tc := range testCases {
- t.Run(tc.name, func(t *testing.T) {
- _, err := CompatibilityStoreToSyntheticStore(tc.store)
- if err == nil || !strings.Contains(err.Error(), tc.want) {
- t.Fatalf("expected error containing %q, got %v", tc.want, err)
- }
- })
- }
- }
- func TestServerGetSecretMapsRemoteRefAndSyntheticStoreNamespace(t *testing.T) {
- mapper := &specMapperRecorder{
- spec: &esv1.SecretStoreSpec{
- Provider: &esv1.SecretStoreProvider{
- Fake: &esv1.FakeProvider{},
- },
- },
- }
- fakeClient := &fakeSecretsClient{getSecretResponse: []byte("secret-value")}
- var receivedStore esv1.GenericStore
- var receivedNamespace string
- server := NewServer(nil, ProviderMapping{
- schema.GroupVersionKind{Group: "provider.external-secrets.io", Version: "v2alpha1", Kind: "Fake"}: &fakeProviderInterface{
- caps: esv1.SecretStoreReadWrite,
- newClient: func(_ context.Context, store esv1.GenericStore, _ client.Client, namespace string) (esv1.SecretsClient, error) {
- receivedStore = store
- receivedNamespace = namespace
- return fakeClient, nil
- },
- },
- }, mapper.mapRef)
- req := &pb.GetSecretRequest{
- ProviderRef: &pb.ProviderReference{
- ApiVersion: "provider.external-secrets.io/v2alpha1",
- Kind: "Fake",
- Name: "backend",
- Namespace: "provider-config-ns",
- StoreRefKind: esv1.ProviderStoreKindStr,
- },
- SourceNamespace: serverTestSourceNamespace,
- RemoteRef: &pb.ExternalSecretDataRemoteRef{
- Key: "sample",
- Version: "v1",
- Property: "password",
- DecodingStrategy: string(esv1.ExternalSecretDecodeBase64),
- MetadataPolicy: string(esv1.ExternalSecretMetadataPolicyFetch),
- },
- }
- resp, err := server.GetSecret(context.Background(), req)
- if err != nil {
- t.Fatalf("GetSecret() error = %v", err)
- }
- if string(resp.Value) != "secret-value" {
- t.Fatalf("expected secret-value, got %q", string(resp.Value))
- }
- if mapper.ref != req.ProviderRef || mapper.sourceNamespace != serverTestSourceNamespace {
- t.Fatalf("unexpected spec mapper input: ref=%#v namespace=%q", mapper.ref, mapper.sourceNamespace)
- }
- if receivedNamespace != "provider-config-ns" {
- t.Fatalf("unexpected new client namespace: %q", receivedNamespace)
- }
- syntheticStore, ok := receivedStore.(*SyntheticStore)
- if !ok {
- t.Fatalf("expected SyntheticStore, got %T", receivedStore)
- }
- if syntheticStore.Namespace != "provider-config-ns" {
- t.Fatalf("unexpected synthetic store namespace: %q", syntheticStore.Namespace)
- }
- if syntheticStore.Kind != esv1.SecretStoreKind {
- t.Fatalf("unexpected synthetic store kind: %q", syntheticStore.Kind)
- }
- if syntheticStore.GetSpec() != mapper.spec {
- t.Fatalf("unexpected synthetic spec: %#v", syntheticStore.GetSpec())
- }
- if fakeClient.getSecretRef.Key != "sample" || fakeClient.getSecretRef.Version != "v1" || fakeClient.getSecretRef.Property != "password" {
- t.Fatalf("unexpected remote ref: %#v", fakeClient.getSecretRef)
- }
- if fakeClient.getSecretRef.DecodingStrategy != esv1.ExternalSecretDecodeBase64 {
- t.Fatalf("unexpected decoding strategy: %q", fakeClient.getSecretRef.DecodingStrategy)
- }
- if fakeClient.getSecretRef.MetadataPolicy != esv1.ExternalSecretMetadataPolicyFetch {
- t.Fatalf("unexpected metadata policy: %q", fakeClient.getSecretRef.MetadataPolicy)
- }
- if !fakeClient.closeCalled {
- t.Fatal("expected secrets client to be closed")
- }
- }
- func TestServerPushSecretMapsClusterProviderStoreKindToClusterSecretStore(t *testing.T) {
- mapper := &specMapperRecorder{
- spec: &esv1.SecretStoreSpec{
- Provider: &esv1.SecretStoreProvider{
- Fake: &esv1.FakeProvider{},
- },
- },
- }
- fakeClient := &fakeSecretsClient{}
- var receivedStore esv1.GenericStore
- server := NewServer(nil, ProviderMapping{
- schema.GroupVersionKind{Group: "provider.external-secrets.io", Version: "v2alpha1", Kind: "Fake"}: &fakeProviderInterface{
- caps: esv1.SecretStoreReadWrite,
- newClient: func(_ context.Context, store esv1.GenericStore, _ client.Client, _ string) (esv1.SecretsClient, error) {
- receivedStore = store
- return fakeClient, nil
- },
- },
- }, mapper.mapRef)
- _, err := server.PushSecret(context.Background(), &pb.PushSecretRequest{
- ProviderRef: &pb.ProviderReference{
- ApiVersion: "provider.external-secrets.io/v2alpha1",
- Kind: "Fake",
- Name: "backend",
- StoreRefKind: esv1.ClusterProviderStoreKindStr,
- },
- SourceNamespace: serverTestSourceNamespace,
- SecretData: map[string][]byte{
- serverTestValue: []byte("secret-value"),
- },
- PushSecretData: &pb.PushSecretData{
- RemoteKey: "remote-secret",
- SecretKey: serverTestValue,
- },
- })
- if err != nil {
- t.Fatalf("PushSecret() error = %v", err)
- }
- syntheticStore, ok := receivedStore.(*SyntheticStore)
- if !ok {
- t.Fatalf("expected SyntheticStore, got %T", receivedStore)
- }
- if syntheticStore.Kind != esv1.ClusterSecretStoreKind {
- t.Fatalf("unexpected synthetic store kind: %q", syntheticStore.Kind)
- }
- }
- func TestServerGetSecretMapDelegates(t *testing.T) {
- mapper := &specMapperRecorder{
- spec: &esv1.SecretStoreSpec{Provider: &esv1.SecretStoreProvider{Fake: &esv1.FakeProvider{}}},
- }
- fakeClient := &fakeSecretsClient{
- getSecretMapResponse: map[string][]byte{"foo": []byte("bar")},
- }
- server := NewServer(nil, ProviderMapping{
- schema.GroupVersionKind{Group: "provider.external-secrets.io", Version: "v2alpha1", Kind: "Fake"}: &fakeProviderInterface{
- caps: esv1.SecretStoreReadWrite,
- newClient: func(context.Context, esv1.GenericStore, client.Client, string) (esv1.SecretsClient, error) {
- return fakeClient, nil
- },
- },
- }, mapper.mapRef)
- resp, err := server.GetSecretMap(context.Background(), &pb.GetSecretMapRequest{
- ProviderRef: &pb.ProviderReference{
- ApiVersion: "provider.external-secrets.io/v2alpha1",
- Kind: "Fake",
- Name: "backend",
- },
- SourceNamespace: serverTestSourceNamespace,
- RemoteRef: &pb.ExternalSecretDataRemoteRef{Key: "sample"},
- })
- if err != nil {
- t.Fatalf("GetSecretMap() error = %v", err)
- }
- if string(resp.Secrets["foo"]) != "bar" {
- t.Fatalf("unexpected response: %#v", resp.Secrets)
- }
- if fakeClient.getSecretMapRef.Key != "sample" {
- t.Fatalf("unexpected ref: %#v", fakeClient.getSecretMapRef)
- }
- }
- func TestServerGetSecretUsesCompatibilityStore(t *testing.T) {
- mapper := &specMapperRecorder{err: errors.New("spec mapper should not be called")}
- fakeClient := &fakeSecretsClient{getSecretResponse: []byte("secret-value")}
- var receivedStore esv1.GenericStore
- provider := &fakeProviderInterface{
- caps: esv1.SecretStoreReadWrite,
- newClient: func(_ context.Context, store esv1.GenericStore, _ client.Client, _ string) (esv1.SecretsClient, error) {
- receivedStore = store
- return fakeClient, nil
- },
- }
- server := NewServerWithCompatibilityProvider(nil, ProviderMapping{
- schema.GroupVersionKind{Group: "provider.external-secrets.io", Version: "v2alpha1", Kind: "Fake"}: &fakeProviderInterface{
- caps: provider.caps,
- newClient: provider.newClient,
- },
- }, mapper.mapRef, provider)
- spec := &esv1.SecretStoreSpec{
- Provider: &esv1.SecretStoreProvider{
- Fake: &esv1.FakeProvider{
- Data: []esv1.FakeProviderData{
- {Key: "sample", Value: "secret-value"},
- },
- },
- },
- }
- resp, err := server.GetSecret(context.Background(), &pb.GetSecretRequest{
- ProviderRef: &pb.ProviderReference{
- ApiVersion: "provider.external-secrets.io/v2alpha1",
- Kind: "Fake",
- Name: "backend",
- },
- CompatibilityStore: mustCompatibilityStore(t, spec),
- SourceNamespace: serverTestSourceNamespace,
- RemoteRef: &pb.ExternalSecretDataRemoteRef{Key: "sample"},
- })
- if err != nil {
- t.Fatalf("GetSecret() error = %v", err)
- }
- if string(resp.Value) != "secret-value" {
- t.Fatalf("unexpected response: %q", string(resp.Value))
- }
- if mapper.ref != nil {
- t.Fatalf("expected spec mapper to be bypassed, got %#v", mapper.ref)
- }
- syntheticStore, ok := receivedStore.(*SyntheticStore)
- if !ok {
- t.Fatalf("expected SyntheticStore, got %T", receivedStore)
- }
- if syntheticStore.Name != "compat-store" || syntheticStore.Namespace != serverTestSourceNamespace {
- t.Fatalf("unexpected synthetic store metadata: %#v", syntheticStore.ObjectMeta)
- }
- if syntheticStore.GetSpec().Provider == nil || syntheticStore.GetSpec().Provider.Fake == nil {
- t.Fatalf("expected fake provider config, got %#v", syntheticStore.GetSpec().Provider)
- }
- }
- func TestServerCompatibilityReadsRequireExplicitCompatibilityProvider(t *testing.T) {
- server := NewServer(nil, ProviderMapping{}, (&specMapperRecorder{}).mapRef)
- _, err := server.GetSecret(context.Background(), &pb.GetSecretRequest{
- CompatibilityStore: &pb.CompatibilityStore{
- StoreName: "compat-store",
- StoreNamespace: serverTestSourceNamespace,
- StoreKind: esv1.SecretStoreKind,
- StoreSpecJson: []byte(`{"provider":{"fake":{}}}`),
- StoreGeneration: 1,
- },
- SourceNamespace: serverTestSourceNamespace,
- RemoteRef: &pb.ExternalSecretDataRemoteRef{Key: "sample"},
- })
- if err == nil || err.Error() != "failed to get client: compatibility provider is not configured" {
- t.Fatalf("unexpected error: %v", err)
- }
- }
- func TestServerReadRequestsRequireReadIdentity(t *testing.T) {
- server := NewServerWithCompatibilityProvider(nil, ProviderMapping{}, (&specMapperRecorder{}).mapRef, &fakeProviderInterface{})
- testCases := []struct {
- name string
- call func() error
- }{
- {
- name: "get secret",
- call: func() error {
- _, err := server.GetSecret(context.Background(), &pb.GetSecretRequest{
- SourceNamespace: serverTestSourceNamespace,
- RemoteRef: &pb.ExternalSecretDataRemoteRef{Key: "sample"},
- })
- return err
- },
- },
- {
- name: "get secret map",
- call: func() error {
- _, err := server.GetSecretMap(context.Background(), &pb.GetSecretMapRequest{
- SourceNamespace: serverTestSourceNamespace,
- RemoteRef: &pb.ExternalSecretDataRemoteRef{Key: "sample"},
- })
- return err
- },
- },
- {
- name: "get all secrets",
- call: func() error {
- _, err := server.GetAllSecrets(context.Background(), &pb.GetAllSecretsRequest{
- SourceNamespace: serverTestSourceNamespace,
- Find: &pb.ExternalSecretFind{},
- })
- return err
- },
- },
- }
- for _, tc := range testCases {
- t.Run(tc.name, func(t *testing.T) {
- err := tc.call()
- if err == nil || err.Error() != "provider reference or compatibility store is required for read operations" {
- t.Fatalf("unexpected error: %v", err)
- }
- })
- }
- }
- func TestServerGetSecretPrefersCompatibilityStoreOverProviderRef(t *testing.T) {
- mapper := &specMapperRecorder{
- spec: &esv1.SecretStoreSpec{
- Provider: &esv1.SecretStoreProvider{
- Fake: &esv1.FakeProvider{
- Data: []esv1.FakeProviderData{
- {Key: "sample", Value: "mapped-value"},
- },
- },
- },
- },
- }
- fakeClient := &fakeSecretsClient{getSecretResponse: []byte("compat-value")}
- provider := &fakeProviderInterface{
- caps: esv1.SecretStoreReadWrite,
- newClient: func(_ context.Context, _ esv1.GenericStore, _ client.Client, _ string) (esv1.SecretsClient, error) {
- return fakeClient, nil
- },
- }
- server := NewServerWithCompatibilityProvider(nil, ProviderMapping{
- schema.GroupVersionKind{Group: "provider.external-secrets.io", Version: "v2alpha1", Kind: "Fake"}: &fakeProviderInterface{
- caps: provider.caps,
- newClient: provider.newClient,
- },
- }, mapper.mapRef, provider)
- spec := &esv1.SecretStoreSpec{
- Provider: &esv1.SecretStoreProvider{
- Fake: &esv1.FakeProvider{
- Data: []esv1.FakeProviderData{
- {Key: "sample", Value: "compat-value"},
- },
- },
- },
- }
- resp, err := server.GetSecret(context.Background(), &pb.GetSecretRequest{
- ProviderRef: &pb.ProviderReference{
- ApiVersion: "provider.external-secrets.io/v2alpha1",
- Kind: "Fake",
- Name: "backend",
- },
- CompatibilityStore: mustCompatibilityStore(t, spec),
- SourceNamespace: serverTestSourceNamespace,
- RemoteRef: &pb.ExternalSecretDataRemoteRef{Key: "sample"},
- })
- if err != nil {
- t.Fatalf("GetSecret() error = %v", err)
- }
- if string(resp.Value) != "compat-value" {
- t.Fatalf("unexpected response: %q", string(resp.Value))
- }
- if mapper.ref != nil {
- t.Fatalf("expected compatibility store to bypass provider ref mapping, got %#v", mapper.ref)
- }
- }
- func TestServerGetSecretMapUsesCompatibilityStore(t *testing.T) {
- mapper := &specMapperRecorder{err: errors.New("spec mapper should not be called")}
- fakeClient := &fakeSecretsClient{
- getSecretMapResponse: map[string][]byte{"foo": []byte("bar")},
- }
- provider := &fakeProviderInterface{
- caps: esv1.SecretStoreReadWrite,
- newClient: func(_ context.Context, _ esv1.GenericStore, _ client.Client, _ string) (esv1.SecretsClient, error) {
- return fakeClient, nil
- },
- }
- server := NewServerWithCompatibilityProvider(nil, ProviderMapping{
- schema.GroupVersionKind{Group: "provider.external-secrets.io", Version: "v2alpha1", Kind: "Fake"}: &fakeProviderInterface{
- caps: provider.caps,
- newClient: provider.newClient,
- },
- }, mapper.mapRef, provider)
- spec := &esv1.SecretStoreSpec{
- Provider: &esv1.SecretStoreProvider{
- Fake: &esv1.FakeProvider{},
- },
- }
- resp, err := server.GetSecretMap(context.Background(), &pb.GetSecretMapRequest{
- CompatibilityStore: mustCompatibilityStore(t, spec),
- SourceNamespace: serverTestSourceNamespace,
- RemoteRef: &pb.ExternalSecretDataRemoteRef{Key: "sample"},
- })
- if err != nil {
- t.Fatalf("GetSecretMap() error = %v", err)
- }
- if string(resp.Secrets["foo"]) != "bar" {
- t.Fatalf("unexpected response: %#v", resp.Secrets)
- }
- if mapper.ref != nil {
- t.Fatalf("expected spec mapper to be bypassed, got %#v", mapper.ref)
- }
- }
- func TestServerGetAllSecretsUsesCompatibilityStore(t *testing.T) {
- mapper := &specMapperRecorder{err: errors.New("spec mapper should not be called")}
- fakeClient := &fakeSecretsClient{
- getAllSecretsResponse: map[string][]byte{"db-password": []byte(serverTestValue)},
- }
- provider := &fakeProviderInterface{
- caps: esv1.SecretStoreReadWrite,
- newClient: func(_ context.Context, _ esv1.GenericStore, _ client.Client, _ string) (esv1.SecretsClient, error) {
- return fakeClient, nil
- },
- }
- server := NewServerWithCompatibilityProvider(nil, ProviderMapping{
- schema.GroupVersionKind{Group: "provider.external-secrets.io", Version: "v2alpha1", Kind: "Fake"}: &fakeProviderInterface{
- caps: provider.caps,
- newClient: provider.newClient,
- },
- }, mapper.mapRef, provider)
- spec := &esv1.SecretStoreSpec{
- Provider: &esv1.SecretStoreProvider{
- Fake: &esv1.FakeProvider{},
- },
- }
- resp, err := server.GetAllSecrets(context.Background(), &pb.GetAllSecretsRequest{
- CompatibilityStore: mustCompatibilityStore(t, spec),
- SourceNamespace: serverTestSourceNamespace,
- Find: &pb.ExternalSecretFind{Tags: map[string]string{"team": "a"}},
- })
- if err != nil {
- t.Fatalf("GetAllSecrets() error = %v", err)
- }
- if string(resp.Secrets["db-password"]) != serverTestValue {
- t.Fatalf("unexpected response: %#v", resp.Secrets)
- }
- if mapper.ref != nil {
- t.Fatalf("expected spec mapper to be bypassed, got %#v", mapper.ref)
- }
- }
- func TestServerPushSecretUsesCompatibilityStore(t *testing.T) {
- mapper := &specMapperRecorder{err: errors.New("spec mapper should not be called")}
- fakeClient := &fakeSecretsClient{}
- provider := &fakeProviderInterface{
- caps: esv1.SecretStoreReadWrite,
- newClient: func(_ context.Context, _ esv1.GenericStore, _ client.Client, _ string) (esv1.SecretsClient, error) {
- return fakeClient, nil
- },
- }
- server := NewServerWithCompatibilityProvider(nil, ProviderMapping{}, mapper.mapRef, provider)
- spec := &esv1.SecretStoreSpec{
- Provider: &esv1.SecretStoreProvider{
- Fake: &esv1.FakeProvider{},
- },
- }
- _, err := server.PushSecret(context.Background(), &pb.PushSecretRequest{
- CompatibilityStore: mustCompatibilityStore(t, spec),
- SourceNamespace: serverTestSourceNamespace,
- SecretData: map[string][]byte{"token": []byte(serverTestValue)},
- PushSecretData: &pb.PushSecretData{RemoteKey: serverTestRemoteKey, SecretKey: "token"},
- })
- if err != nil {
- t.Fatalf("PushSecret() error = %v", err)
- }
- if mapper.ref != nil {
- t.Fatalf("expected spec mapper to be bypassed, got %#v", mapper.ref)
- }
- if fakeClient.pushSecretData.GetRemoteKey() != serverTestRemoteKey {
- t.Fatalf("unexpected push data: %#v", fakeClient.pushSecretData)
- }
- }
- func TestServerDeleteSecretUsesCompatibilityStore(t *testing.T) {
- mapper := &specMapperRecorder{err: errors.New("spec mapper should not be called")}
- fakeClient := &fakeSecretsClient{}
- provider := &fakeProviderInterface{
- caps: esv1.SecretStoreReadWrite,
- newClient: func(_ context.Context, _ esv1.GenericStore, _ client.Client, _ string) (esv1.SecretsClient, error) {
- return fakeClient, nil
- },
- }
- server := NewServerWithCompatibilityProvider(nil, ProviderMapping{}, mapper.mapRef, provider)
- spec := &esv1.SecretStoreSpec{
- Provider: &esv1.SecretStoreProvider{
- Fake: &esv1.FakeProvider{},
- },
- }
- _, err := server.DeleteSecret(context.Background(), &pb.DeleteSecretRequest{
- CompatibilityStore: mustCompatibilityStore(t, spec),
- SourceNamespace: serverTestSourceNamespace,
- RemoteRef: &pb.PushSecretRemoteRef{RemoteKey: serverTestRemoteKey, Property: serverTestProperty},
- })
- if err != nil {
- t.Fatalf("DeleteSecret() error = %v", err)
- }
- if mapper.ref != nil {
- t.Fatalf("expected spec mapper to be bypassed, got %#v", mapper.ref)
- }
- if fakeClient.deleteSecretRef.GetRemoteKey() != serverTestRemoteKey {
- t.Fatalf("unexpected delete ref: %#v", fakeClient.deleteSecretRef)
- }
- }
- func TestServerSecretExistsUsesCompatibilityStore(t *testing.T) {
- mapper := &specMapperRecorder{err: errors.New("spec mapper should not be called")}
- fakeClient := &fakeSecretsClient{secretExistsResp: true}
- provider := &fakeProviderInterface{
- caps: esv1.SecretStoreReadWrite,
- newClient: func(_ context.Context, _ esv1.GenericStore, _ client.Client, _ string) (esv1.SecretsClient, error) {
- return fakeClient, nil
- },
- }
- server := NewServerWithCompatibilityProvider(nil, ProviderMapping{}, mapper.mapRef, provider)
- spec := &esv1.SecretStoreSpec{
- Provider: &esv1.SecretStoreProvider{
- Fake: &esv1.FakeProvider{},
- },
- }
- resp, err := server.SecretExists(context.Background(), &pb.SecretExistsRequest{
- CompatibilityStore: mustCompatibilityStore(t, spec),
- SourceNamespace: serverTestSourceNamespace,
- RemoteRef: &pb.PushSecretRemoteRef{RemoteKey: serverTestRemoteKey, Property: serverTestProperty},
- })
- if err != nil {
- t.Fatalf("SecretExists() error = %v", err)
- }
- if !resp.Exists {
- t.Fatal("expected secret to exist")
- }
- if mapper.ref != nil {
- t.Fatalf("expected spec mapper to be bypassed, got %#v", mapper.ref)
- }
- if fakeClient.secretExistsRef.GetRemoteKey() != serverTestRemoteKey {
- t.Fatalf("unexpected secret exists ref: %#v", fakeClient.secretExistsRef)
- }
- }
- func TestServerValidateUsesCompatibilityStore(t *testing.T) {
- mapper := &specMapperRecorder{err: errors.New("spec mapper should not be called")}
- fakeClient := &fakeSecretsClient{validateResult: esv1.ValidationResultReady}
- provider := &fakeProviderInterface{
- caps: esv1.SecretStoreReadWrite,
- newClient: func(_ context.Context, _ esv1.GenericStore, _ client.Client, _ string) (esv1.SecretsClient, error) {
- return fakeClient, nil
- },
- }
- server := NewServerWithCompatibilityProvider(nil, ProviderMapping{}, mapper.mapRef, provider)
- spec := &esv1.SecretStoreSpec{
- Provider: &esv1.SecretStoreProvider{
- Fake: &esv1.FakeProvider{},
- },
- }
- resp, err := server.Validate(context.Background(), &pb.ValidateRequest{
- CompatibilityStore: mustCompatibilityStore(t, spec),
- SourceNamespace: serverTestSourceNamespace,
- })
- if err != nil {
- t.Fatalf("Validate() error = %v", err)
- }
- if !resp.Valid {
- t.Fatalf("expected validate response to be valid: %#v", resp)
- }
- if mapper.ref != nil {
- t.Fatalf("expected spec mapper to be bypassed, got %#v", mapper.ref)
- }
- }
- func TestServerGetAllSecretsMapsFindCriteria(t *testing.T) {
- mapper := &specMapperRecorder{
- spec: &esv1.SecretStoreSpec{Provider: &esv1.SecretStoreProvider{Fake: &esv1.FakeProvider{}}},
- }
- fakeClient := &fakeSecretsClient{
- getAllSecretsResponse: map[string][]byte{"db-password": []byte(serverTestValue)},
- }
- server := NewServer(nil, ProviderMapping{
- schema.GroupVersionKind{Group: "provider.external-secrets.io", Version: "v2alpha1", Kind: "Fake"}: &fakeProviderInterface{
- caps: esv1.SecretStoreReadWrite,
- newClient: func(context.Context, esv1.GenericStore, client.Client, string) (esv1.SecretsClient, error) {
- return fakeClient, nil
- },
- },
- }, mapper.mapRef)
- resp, err := server.GetAllSecrets(context.Background(), &pb.GetAllSecretsRequest{
- ProviderRef: &pb.ProviderReference{
- ApiVersion: "provider.external-secrets.io/v2alpha1",
- Kind: "Fake",
- Name: "backend",
- },
- SourceNamespace: serverTestSourceNamespace,
- Find: &pb.ExternalSecretFind{
- Tags: map[string]string{"team": "a"},
- Path: "/team-a",
- ConversionStrategy: string(esv1.ExternalSecretConversionDefault),
- DecodingStrategy: string(esv1.ExternalSecretDecodeBase64),
- Name: &pb.FindName{Regexp: "db-.*"},
- },
- })
- if err != nil {
- t.Fatalf("GetAllSecrets() error = %v", err)
- }
- if string(resp.Secrets["db-password"]) != serverTestValue {
- t.Fatalf("unexpected response: %#v", resp.Secrets)
- }
- if fakeClient.getAllSecretsFind.Tags["team"] != "a" {
- t.Fatalf("unexpected find tags: %#v", fakeClient.getAllSecretsFind)
- }
- if fakeClient.getAllSecretsFind.Path == nil || *fakeClient.getAllSecretsFind.Path != "/team-a" {
- t.Fatalf("unexpected find path: %#v", fakeClient.getAllSecretsFind.Path)
- }
- if fakeClient.getAllSecretsFind.Name == nil || fakeClient.getAllSecretsFind.Name.RegExp != "db-.*" {
- t.Fatalf("unexpected find name: %#v", fakeClient.getAllSecretsFind.Name)
- }
- }
- func TestServerPushDeleteAndExistsMapWriteRequests(t *testing.T) {
- mapper := &specMapperRecorder{
- spec: &esv1.SecretStoreSpec{Provider: &esv1.SecretStoreProvider{Fake: &esv1.FakeProvider{}}},
- }
- fakeClient := &fakeSecretsClient{secretExistsResp: true}
- server := NewServer(nil, ProviderMapping{
- schema.GroupVersionKind{Group: "provider.external-secrets.io", Version: "v2alpha1", Kind: "Fake"}: &fakeProviderInterface{
- caps: esv1.SecretStoreReadWrite,
- newClient: func(context.Context, esv1.GenericStore, client.Client, string) (esv1.SecretsClient, error) {
- return fakeClient, nil
- },
- },
- }, mapper.mapRef)
- _, err := server.PushSecret(context.Background(), &pb.PushSecretRequest{
- ProviderRef: &pb.ProviderReference{
- ApiVersion: "provider.external-secrets.io/v2alpha1",
- Kind: "Fake",
- Name: "backend",
- },
- SourceNamespace: serverTestSourceNamespace,
- SecretData: map[string][]byte{
- "token": []byte(serverTestValue),
- },
- PushSecretData: &pb.PushSecretData{
- RemoteKey: serverTestRemoteKey,
- SecretKey: "token",
- Property: serverTestProperty,
- Metadata: []byte(`{"owner":"eso"}`),
- },
- })
- if err != nil {
- t.Fatalf("PushSecret() error = %v", err)
- }
- if fakeClient.pushSecretSecret == nil || string(fakeClient.pushSecretSecret.Data["token"]) != serverTestValue {
- t.Fatalf("unexpected pushed secret: %#v", fakeClient.pushSecretSecret)
- }
- if fakeClient.pushSecretSecret.Type != "" {
- t.Fatalf("unexpected secret type: %q", fakeClient.pushSecretSecret.Type)
- }
- if fakeClient.pushSecretData.GetRemoteKey() != serverTestRemoteKey || fakeClient.pushSecretData.GetSecretKey() != "token" || fakeClient.pushSecretData.GetProperty() != serverTestProperty {
- t.Fatalf("unexpected push data: %#v", fakeClient.pushSecretData)
- }
- if got := fakeClient.pushSecretData.GetMetadata(); got == nil || string(got.Raw) != `{"owner":"eso"}` {
- t.Fatalf("unexpected metadata: %#v", got)
- }
- _, err = server.DeleteSecret(context.Background(), &pb.DeleteSecretRequest{
- ProviderRef: &pb.ProviderReference{
- ApiVersion: "provider.external-secrets.io/v2alpha1",
- Kind: "Fake",
- Name: "backend",
- },
- SourceNamespace: serverTestSourceNamespace,
- RemoteRef: &pb.PushSecretRemoteRef{
- RemoteKey: serverTestRemoteKey,
- Property: serverTestProperty,
- },
- })
- if err != nil {
- t.Fatalf("DeleteSecret() error = %v", err)
- }
- if fakeClient.deleteSecretRef.GetRemoteKey() != serverTestRemoteKey || fakeClient.deleteSecretRef.GetProperty() != serverTestProperty {
- t.Fatalf("unexpected delete ref: %#v", fakeClient.deleteSecretRef)
- }
- resp, err := server.SecretExists(context.Background(), &pb.SecretExistsRequest{
- ProviderRef: &pb.ProviderReference{
- ApiVersion: "provider.external-secrets.io/v2alpha1",
- Kind: "Fake",
- Name: "backend",
- },
- SourceNamespace: serverTestSourceNamespace,
- RemoteRef: &pb.PushSecretRemoteRef{
- RemoteKey: serverTestRemoteKey,
- Property: serverTestProperty,
- },
- })
- if err != nil {
- t.Fatalf("SecretExists() error = %v", err)
- }
- if !resp.Exists {
- t.Fatal("expected exists response to be true")
- }
- if fakeClient.secretExistsRef.GetRemoteKey() != serverTestRemoteKey || fakeClient.secretExistsRef.GetProperty() != serverTestProperty {
- t.Fatalf("unexpected exists ref: %#v", fakeClient.secretExistsRef)
- }
- }
- func TestServerPushSecretForwardsKubernetesSecretMetadata(t *testing.T) {
- mapper := &specMapperRecorder{
- spec: &esv1.SecretStoreSpec{Provider: &esv1.SecretStoreProvider{Fake: &esv1.FakeProvider{}}},
- }
- fakeClient := &fakeSecretsClient{}
- server := NewServer(nil, ProviderMapping{
- schema.GroupVersionKind{Group: "provider.external-secrets.io", Version: "v2alpha1", Kind: "Fake"}: &fakeProviderInterface{
- caps: esv1.SecretStoreReadWrite,
- newClient: func(context.Context, esv1.GenericStore, client.Client, string) (esv1.SecretsClient, error) {
- return fakeClient, nil
- },
- },
- }, mapper.mapRef)
- req := &pb.PushSecretRequest{
- ProviderRef: &pb.ProviderReference{
- ApiVersion: "provider.external-secrets.io/v2alpha1",
- Kind: "Fake",
- Name: "backend",
- },
- SourceNamespace: serverTestSourceNamespace,
- SecretData: map[string][]byte{
- ".dockerconfigjson": []byte("payload"),
- },
- SecretType: string(corev1.SecretTypeDockerConfigJson),
- SecretLabels: map[string]string{"team": "platform"},
- SecretAnnotations: map[string]string{"owner": "app-team"},
- PushSecretData: &pb.PushSecretData{
- RemoteKey: serverTestRemoteKey,
- SecretKey: ".dockerconfigjson",
- Property: serverTestProperty,
- Metadata: []byte(`{"mergePolicy":"replace"}`),
- },
- }
- _, err := server.PushSecret(context.Background(), req)
- if err != nil {
- t.Fatalf("PushSecret() error = %v", err)
- }
- if fakeClient.pushSecretSecret == nil {
- t.Fatal("expected pushed secret to be recorded")
- }
- if got, want := string(fakeClient.pushSecretSecret.Data[".dockerconfigjson"]), "payload"; got != want {
- t.Errorf("expected payload %q, got %q", want, got)
- }
- if got, want := fakeClient.pushSecretSecret.Type, corev1.SecretTypeDockerConfigJson; got != want {
- t.Errorf("expected secret type %q, got %q", want, got)
- }
- if got, want := fakeClient.pushSecretSecret.Labels["team"], "platform"; got != want {
- t.Errorf("expected secret label team=%q, got %q", want, got)
- }
- if got, want := fakeClient.pushSecretSecret.Annotations["owner"], "app-team"; got != want {
- t.Errorf("expected secret annotation owner=%q, got %q", want, got)
- }
- }
- func TestServerValidateMapsReadyUnknownAndErrorResults(t *testing.T) {
- t.Run("ready", func(t *testing.T) {
- resp := runValidateTest(t, esv1.ValidationResultReady, nil)
- if !resp.Valid {
- t.Fatalf("expected valid response, got %#v", resp)
- }
- })
- t.Run("unknown", func(t *testing.T) {
- resp := runValidateTest(t, esv1.ValidationResultUnknown, nil)
- if !resp.Valid {
- t.Fatalf("expected unknown to be treated as valid, got %#v", resp)
- }
- })
- t.Run("error_result", func(t *testing.T) {
- resp := runValidateTest(t, esv1.ValidationResultError, nil)
- if resp.Valid {
- t.Fatalf("expected invalid response, got %#v", resp)
- }
- })
- t.Run("error", func(t *testing.T) {
- validateErr := errors.New("invalid credentials")
- resp := runValidateTest(t, esv1.ValidationResultError, validateErr)
- if resp.Valid || resp.Error != "invalid credentials" {
- t.Fatalf("unexpected response: %#v", resp)
- }
- })
- }
- func TestServerCapabilitiesMapsProviderCapabilities(t *testing.T) {
- testCases := []struct {
- name string
- caps esv1.SecretStoreCapabilities
- expectedPB pb.SecretStoreCapabilities
- }{
- {name: "read_only", caps: esv1.SecretStoreReadOnly, expectedPB: pb.SecretStoreCapabilities_READ_ONLY},
- {name: "write_only", caps: esv1.SecretStoreWriteOnly, expectedPB: pb.SecretStoreCapabilities_WRITE_ONLY},
- {name: "read_write", caps: esv1.SecretStoreReadWrite, expectedPB: pb.SecretStoreCapabilities_READ_WRITE},
- }
- for _, tc := range testCases {
- t.Run(tc.name, func(t *testing.T) {
- server := NewServer(nil, ProviderMapping{
- schema.GroupVersionKind{Group: "provider.external-secrets.io", Version: "v2alpha1", Kind: "Fake"}: &fakeProviderInterface{
- caps: tc.caps,
- newClient: func(context.Context, esv1.GenericStore, client.Client, string) (esv1.SecretsClient, error) {
- return &fakeSecretsClient{}, nil
- },
- },
- }, (&specMapperRecorder{}).mapRef)
- resp, err := server.Capabilities(context.Background(), &pb.CapabilitiesRequest{
- ProviderRef: &pb.ProviderReference{
- ApiVersion: "provider.external-secrets.io/v2alpha1",
- Kind: "Fake",
- Name: "backend",
- },
- })
- if err != nil {
- t.Fatalf("Capabilities() error = %v", err)
- }
- if resp.Capabilities != tc.expectedPB {
- t.Fatalf("expected %v, got %v", tc.expectedPB, resp.Capabilities)
- }
- })
- }
- }
- func TestServerRejectsInvalidRequests(t *testing.T) {
- server := NewServer(nil, ProviderMapping{}, (&specMapperRecorder{}).mapRef)
- testCases := []struct {
- name string
- call func() error
- want string
- }{
- {
- name: "get_secret_nil_request",
- call: func() error {
- _, err := server.GetSecret(context.Background(), nil)
- return err
- },
- want: "request or remote ref is nil",
- },
- {
- name: "get_secret_empty_source_namespace",
- call: func() error {
- _, err := server.GetSecret(context.Background(), &pb.GetSecretRequest{
- RemoteRef: &pb.ExternalSecretDataRemoteRef{Key: "sample"},
- })
- return err
- },
- want: "source namespace is required",
- },
- {
- name: "push_secret_nil_payload",
- call: func() error {
- _, err := server.PushSecret(context.Background(), &pb.PushSecretRequest{
- SourceNamespace: serverTestSourceNamespace,
- })
- return err
- },
- want: "request or push secret data is nil",
- },
- {
- name: "validate_nil_request",
- call: func() error {
- _, err := server.Validate(context.Background(), nil)
- return err
- },
- want: "request is nil",
- },
- {
- name: "capabilities_nil_request",
- call: func() error {
- _, err := server.Capabilities(context.Background(), nil)
- return err
- },
- want: "request is nil",
- },
- }
- for _, tc := range testCases {
- t.Run(tc.name, func(t *testing.T) {
- err := tc.call()
- if err == nil || err.Error() != tc.want {
- t.Fatalf("expected %q, got %v", tc.want, err)
- }
- })
- }
- }
- func runValidateTest(t *testing.T, result esv1.ValidationResult, validateErr error) *pb.ValidateResponse {
- t.Helper()
- server := NewServer(nil, ProviderMapping{
- schema.GroupVersionKind{Group: "provider.external-secrets.io", Version: "v2alpha1", Kind: "Fake"}: &fakeProviderInterface{
- caps: esv1.SecretStoreReadWrite,
- newClient: func(context.Context, esv1.GenericStore, client.Client, string) (esv1.SecretsClient, error) {
- return &fakeSecretsClient{
- validateResult: result,
- validateErr: validateErr,
- }, nil
- },
- },
- }, (&specMapperRecorder{
- spec: &esv1.SecretStoreSpec{Provider: &esv1.SecretStoreProvider{Fake: &esv1.FakeProvider{}}},
- }).mapRef)
- resp, err := server.Validate(context.Background(), &pb.ValidateRequest{
- ProviderRef: &pb.ProviderReference{
- ApiVersion: "provider.external-secrets.io/v2alpha1",
- Kind: "Fake",
- Name: "backend",
- },
- SourceNamespace: "tenant-a",
- })
- if err != nil {
- t.Fatalf("Validate() error = %v", err)
- }
- return resp
- }
|