helm-external-secrets/providers/v1/vault/client_get_all_secrets_test.go

/*
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 vault

import (
	"context"
	"errors"
	"strings"
	"testing"

	"github.com/google/go-cmp/cmp"
	vault "github.com/hashicorp/vault/api"
	kclient "sigs.k8s.io/controller-runtime/pkg/client"

	esv1 "github.com/external-secrets/external-secrets/apis/externalsecrets/v1"
	"github.com/external-secrets/external-secrets/providers/v1/vault/fake"
	vaultutil "github.com/external-secrets/external-secrets/providers/v1/vault/util"
)

func TestGetAllSecrets(t *testing.T) {
	secret1Bytes := []byte("{\"access_key\":\"access_key\",\"access_secret\":\"access_secret\"}")
	secret2Bytes := []byte("{\"access_key\":\"access_key2\",\"access_secret\":\"access_secret2\"}")
	path1Bytes := []byte("{\"access_key\":\"path1\",\"access_secret\":\"path1\"}")
	path2Bytes := []byte("{\"access_key\":\"path2\",\"access_secret\":\"path2\"}")
	tagBytes := []byte("{\"access_key\":\"unfetched\",\"access_secret\":\"unfetched\"}")
	path := "path"
	kv2secret := map[string]any{
		"secret1": map[string]any{
			"metadata": map[string]any{
				"custom_metadata": map[string]any{
					"foo": "bar",
				},
			},
			"data": map[string]any{
				"access_key":    "access_key",
				"access_secret": "access_secret",
			},
		},
		"secret2": map[string]any{
			"metadata": map[string]any{
				"custom_metadata": map[string]any{
					"foo": "baz",
				},
			},
			"data": map[string]any{
				"access_key":    "access_key2",
				"access_secret": "access_secret2",
			},
		},
		"secret3": map[string]any{
			"metadata": map[string]any{
				"custom_metadata": map[string]any{
					"foo": "baz",
				},
			},
			"data": nil,
		},
		"tag": map[string]any{
			"metadata": map[string]any{
				"custom_metadata": map[string]any{
					"foo": "baz",
				},
			},
			"data": map[string]any{
				"access_key":    "unfetched",
				"access_secret": "unfetched",
			},
		},
		"path/1": map[string]any{
			"metadata": map[string]any{
				"custom_metadata": map[string]any{
					"foo": "path",
				},
			},
			"data": map[string]any{
				"access_key":    "path1",
				"access_secret": "path1",
			},
		},
		"path/2": map[string]any{
			"metadata": map[string]any{
				"custom_metadata": map[string]any{
					"foo": "path",
				},
			},
			"data": map[string]any{
				"access_key":    "path2",
				"access_secret": "path2",
			},
		},
		"default": map[string]any{
			"data": map[string]any{
				"empty": "true",
			},
			"metadata": map[string]any{
				"keys": []any{"secret1", "secret2", "secret3", "tag", "path/"},
			},
		},
		"path/": map[string]any{
			"data": map[string]any{
				"empty": "true",
			},
			"metadata": map[string]any{
				"keys": []any{"1", "2"},
			},
		},
	}
	kv1secret := map[string]any{
		"secret1": map[string]any{
			"access_key":    "access_key",
			"access_secret": "access_secret",
		},
		"secret2": map[string]any{
			"access_key":    "access_key2",
			"access_secret": "access_secret2",
		},
		"tag": map[string]any{
			"access_key":    "unfetched",
			"access_secret": "unfetched",
		},
		"path/1": map[string]any{
			"access_key":    "path1",
			"access_secret": "path1",
		},
		"path/2": map[string]any{
			"access_key":    "path2",
			"access_secret": "path2",
		},
	}
	type args struct {
		store    *esv1.VaultProvider
		kube     kclient.Client
		vLogical vaultutil.Logical
		ns       string
		data     esv1.ExternalSecretFind
	}

	type want struct {
		err error
		val map[string][]byte
	}

	cases := map[string]struct {
		reason string
		args   args
		want   want
	}{
		"FindByNameKv2": {
			reason: "should map multiple secrets matching name for kv2",
			args: args{
				store: makeValidSecretStoreWithVersion(esv1.VaultKVStoreV2).Spec.Provider.Vault,
				vLogical: &fake.Logical{
					ListWithContextFn:         newListWithContextFn(kv2secret),
					ReadWithDataWithContextFn: newReadtWithContextFn(kv2secret),
				},
				data: esv1.ExternalSecretFind{
					Name: &esv1.FindName{
						RegExp: "secret.*",
					},
				},
			},
			want: want{
				err: nil,
				val: map[string][]byte{
					"secret1": secret1Bytes,
					"secret2": secret2Bytes,
				},
			},
		},
		"FindByNameKv1": {
			reason: "should map multiple secrets matching name for kv1",
			args: args{
				store: makeValidSecretStoreWithVersion(esv1.VaultKVStoreV1).Spec.Provider.Vault,
				vLogical: &fake.Logical{
					ListWithContextFn:         newListWithContextKvv1Fn(kv1secret),
					ReadWithDataWithContextFn: newReadtWithContextKvv1Fn(kv1secret),
				},
				data: esv1.ExternalSecretFind{
					Name: &esv1.FindName{
						RegExp: "secret.*",
					},
				},
			},
			want: want{
				err: nil,
				val: map[string][]byte{
					"secret1": secret1Bytes,
					"secret2": secret2Bytes,
				},
			},
		},
		"FindByTagKv2": {
			reason: "should map multiple secrets matching tags",
			args: args{
				store: makeValidSecretStoreWithVersion(esv1.VaultKVStoreV2).Spec.Provider.Vault,
				vLogical: &fake.Logical{
					ListWithContextFn:         newListWithContextFn(kv2secret),
					ReadWithDataWithContextFn: newReadtWithContextFn(kv2secret),
				},
				data: esv1.ExternalSecretFind{
					Tags: map[string]string{
						"foo": "baz",
					},
				},
			},
			want: want{
				err: nil,
				val: map[string][]byte{
					"tag":     tagBytes,
					"secret2": secret2Bytes,
				},
			},
		},
		"FindByTagKv1": {
			reason: "find by tag should not work if using kv1 store",
			args: args{
				store: makeValidSecretStoreWithVersion(esv1.VaultKVStoreV1).Spec.Provider.Vault,
				vLogical: &fake.Logical{
					ListWithContextFn:         newListWithContextKvv1Fn(kv1secret),
					ReadWithDataWithContextFn: newReadtWithContextKvv1Fn(kv1secret),
				},
				data: esv1.ExternalSecretFind{
					Tags: map[string]string{
						"foo": "baz",
					},
				},
			},
			want: want{
				err: errors.New(errUnsupportedKvVersion),
			},
		},
		"FilterByPathKv2WithTags": {
			reason: "should filter secrets based on path for kv2 with tags",
			args: args{
				store: makeValidSecretStoreWithVersion(esv1.VaultKVStoreV2).Spec.Provider.Vault,
				vLogical: &fake.Logical{
					ListWithContextFn:         newListWithContextFn(kv2secret),
					ReadWithDataWithContextFn: newReadtWithContextFn(kv2secret),
				},
				data: esv1.ExternalSecretFind{
					Path: &path,
					Tags: map[string]string{
						"foo": "path",
					},
				},
			},
			want: want{
				err: nil,
				val: map[string][]byte{
					"path/1": path1Bytes,
					"path/2": path2Bytes,
				},
			},
		},
		"FilterByPathKv2WithoutTags": {
			reason: "should filter secrets based on path for kv2 without tags",
			args: args{
				store: makeValidSecretStoreWithVersion(esv1.VaultKVStoreV2).Spec.Provider.Vault,
				vLogical: &fake.Logical{
					ListWithContextFn:         newListWithContextFn(kv2secret),
					ReadWithDataWithContextFn: newReadtWithContextFn(kv2secret),
				},
				data: esv1.ExternalSecretFind{
					Path: &path,
				},
			},
			want: want{
				err: nil,
				val: map[string][]byte{
					"path/1": path1Bytes,
					"path/2": path2Bytes,
				},
			},
		},
		"FilterByPathReturnsNotFound": {
			reason: "should return a not found error if there are no more secrets on the path",
			args: args{
				store: makeValidSecretStoreWithVersion(esv1.VaultKVStoreV2).Spec.Provider.Vault,
				vLogical: &fake.Logical{
					ListWithContextFn: func(_ context.Context, _ string) (*vault.Secret, error) {
						return nil, nil
					},
					ReadWithDataWithContextFn: newReadtWithContextFn(map[string]any{}),
				},
				data: esv1.ExternalSecretFind{
					Path: &path,
				},
			},
			want: want{
				err: esv1.NoSecretError{},
			},
		},
		"FilterByPathKv1": {
			reason: "should filter secrets based on path for kv1",
			args: args{
				store: makeValidSecretStoreWithVersion(esv1.VaultKVStoreV1).Spec.Provider.Vault,
				vLogical: &fake.Logical{
					ListWithContextFn:         newListWithContextKvv1Fn(kv1secret),
					ReadWithDataWithContextFn: newReadtWithContextKvv1Fn(kv1secret),
				},
				data: esv1.ExternalSecretFind{
					Path: &path,
				},
			},
			want: want{
				err: nil,
				val: map[string][]byte{
					"path/1": path1Bytes,
					"path/2": path2Bytes,
				},
			},
		},
		"MetadataNotFound": {
			reason: "metadata secret not found",
			args: args{
				store: makeValidSecretStoreWithVersion(esv1.VaultKVStoreV2).Spec.Provider.Vault,
				vLogical: &fake.Logical{
					ListWithContextFn: newListWithContextFn(kv2secret),
					ReadWithDataWithContextFn: func(_ context.Context, _ string, _ map[string][]string) (*vault.Secret, error) {
						return nil, nil
					},
				},
				data: esv1.ExternalSecretFind{
					Tags: map[string]string{
						"foo": "baz",
					},
				},
			},
			want: want{
				err: errors.New(errNotFound),
			},
		},
	}

	for name, tc := range cases {
		t.Run(name, func(t *testing.T) {
			vStore := &client{
				kube:      tc.args.kube,
				logical:   tc.args.vLogical,
				store:     tc.args.store,
				namespace: tc.args.ns,
			}
			val, err := vStore.GetAllSecrets(context.Background(), tc.args.data)
			if diff := cmp.Diff(tc.want.err, err, EquateErrors()); diff != "" {
				t.Errorf("\n%s\nvault.GetAllSecrets(...): -want error, +got error:\n%s", tc.reason, diff)
			}
			if diff := cmp.Diff(tc.want.val, val); diff != "" {
				t.Errorf("\n%s\nvault.GetAllSecrets(...): -want val, +got val:\n%s", tc.reason, diff)
			}
		})
	}
}

func newListWithContextFn(secrets map[string]any) func(ctx context.Context, path string) (*vault.Secret, error) {
	return func(_ context.Context, path string) (*vault.Secret, error) {
		path = strings.TrimPrefix(path, "secret/metadata/") // kvv2
		if path == "" {
			path = "default"
		}

		data, ok := secrets[path]
		if !ok {
			return nil, errors.New("Secret not found")
		}
		meta := data.(map[string]any)
		ans := meta["metadata"].(map[string]any)
		secret := &vault.Secret{
			Data: map[string]any{
				"keys": ans["keys"],
			},
		}
		return secret, nil
	}
}

func newListWithContextKvv1Fn(secrets map[string]any) func(ctx context.Context, path string) (*vault.Secret, error) {
	return func(_ context.Context, path string) (*vault.Secret, error) {
		path = strings.TrimPrefix(path, "secret/")

		keys := make([]any, 0, len(secrets))
		for k := range secrets {
			if after, ok := strings.CutPrefix(k, path); ok {
				uniqueSuffix := after
				keys = append(keys, uniqueSuffix)
			}
		}
		if len(keys) == 0 {
			return nil, errors.New("secret not found")
		}

		secret := &vault.Secret{
			Data: map[string]any{
				"keys": keys,
			},
		}
		return secret, nil
	}
}

func newReadtWithContextFn(secrets map[string]any) func(ctx context.Context, path string, data map[string][]string) (*vault.Secret, error) {
	return func(_ context.Context, path string, _ map[string][]string) (*vault.Secret, error) {
		path = strings.TrimPrefix(path, "secret/data/")
		path = strings.TrimPrefix(path, "secret/metadata/")

		data, ok := secrets[path]
		if !ok {
			return nil, errors.New("Secret not found")
		}
		meta := data.(map[string]any)
		metadata := meta["metadata"].(map[string]any)
		content := map[string]any{
			"data":            meta["data"],
			"custom_metadata": metadata["custom_metadata"],
		}
		secret := &vault.Secret{
			Data: content,
		}
		return secret, nil
	}
}

func newReadtWithContextKvv1Fn(secrets map[string]any) func(ctx context.Context, path string, data map[string][]string) (*vault.Secret, error) {
	return func(_ context.Context, path string, _ map[string][]string) (*vault.Secret, error) {
		path = strings.TrimPrefix(path, "secret/")

		data, ok := secrets[path]
		if !ok {
			return nil, errors.New("secret not found")
		}

		dataAsMap := data.(map[string]any)
		secret := &vault.Secret{
			Data: dataAsMap,
		}
		return secret, nil
	}
}