| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999 |
- /*
- 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 vault
- import (
- "context"
- "encoding/json"
- "errors"
- "fmt"
- "reflect"
- "strings"
- "testing"
- "github.com/google/go-cmp/cmp"
- vault "github.com/hashicorp/vault/api"
- corev1 "k8s.io/api/core/v1"
- metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
- typedcorev1 "k8s.io/client-go/kubernetes/typed/core/v1"
- "k8s.io/utils/pointer"
- kclient "sigs.k8s.io/controller-runtime/pkg/client"
- clientfake "sigs.k8s.io/controller-runtime/pkg/client/fake"
- esv1beta1 "github.com/external-secrets/external-secrets/apis/externalsecrets/v1beta1"
- esmeta "github.com/external-secrets/external-secrets/apis/meta/v1"
- utilfake "github.com/external-secrets/external-secrets/pkg/provider/util/fake"
- "github.com/external-secrets/external-secrets/pkg/provider/vault/fake"
- "github.com/external-secrets/external-secrets/pkg/provider/vault/util"
- )
- const (
- tokenSecretName = "example-secret-token"
- secretDataString = "some-creds"
- )
- var (
- secretStorePath = "secret"
- )
- func makeValidSecretStoreWithVersion(v esv1beta1.VaultKVStoreVersion) *esv1beta1.SecretStore {
- return &esv1beta1.SecretStore{
- ObjectMeta: metav1.ObjectMeta{
- Name: "vault-store",
- Namespace: "default",
- },
- Spec: esv1beta1.SecretStoreSpec{
- Provider: &esv1beta1.SecretStoreProvider{
- Vault: &esv1beta1.VaultProvider{
- Server: "vault.example.com",
- Path: &secretStorePath,
- Version: v,
- Auth: esv1beta1.VaultAuth{
- Kubernetes: &esv1beta1.VaultKubernetesAuth{
- Path: "kubernetes",
- Role: "kubernetes-auth-role",
- ServiceAccountRef: &esmeta.ServiceAccountSelector{
- Name: "example-sa",
- },
- },
- },
- },
- },
- },
- }
- }
- func makeValidSecretStore() *esv1beta1.SecretStore {
- return makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2)
- }
- func makeValidSecretStoreWithCerts() *esv1beta1.SecretStore {
- return &esv1beta1.SecretStore{
- ObjectMeta: metav1.ObjectMeta{
- Name: "vault-store",
- Namespace: "default",
- },
- Spec: esv1beta1.SecretStoreSpec{
- Provider: &esv1beta1.SecretStoreProvider{
- Vault: &esv1beta1.VaultProvider{
- Server: "vault.example.com",
- Path: &secretStorePath,
- Version: esv1beta1.VaultKVStoreV2,
- Auth: esv1beta1.VaultAuth{
- Cert: &esv1beta1.VaultCertAuth{
- ClientCert: esmeta.SecretKeySelector{
- Name: "tls-auth-certs",
- Key: "tls.crt",
- },
- SecretRef: esmeta.SecretKeySelector{
- Name: "tls-auth-certs",
- Key: "tls.key",
- },
- },
- },
- },
- },
- },
- }
- }
- func makeValidSecretStoreWithK8sCerts(isSecret bool) *esv1beta1.SecretStore {
- store := makeSecretStore()
- caProvider := &esv1beta1.CAProvider{
- Name: "vault-cert",
- Key: "cert",
- }
- if isSecret {
- caProvider.Type = "Secret"
- } else {
- caProvider.Type = "ConfigMap"
- }
- store.Spec.Provider.Vault.CAProvider = caProvider
- return store
- }
- func makeInvalidClusterSecretStoreWithK8sCerts() *esv1beta1.ClusterSecretStore {
- return &esv1beta1.ClusterSecretStore{
- TypeMeta: metav1.TypeMeta{
- Kind: "ClusterSecretStore",
- },
- ObjectMeta: metav1.ObjectMeta{
- Name: "vault-store",
- Namespace: "default",
- },
- Spec: esv1beta1.SecretStoreSpec{
- Provider: &esv1beta1.SecretStoreProvider{
- Vault: &esv1beta1.VaultProvider{
- Server: "vault.example.com",
- Path: &secretStorePath,
- Version: "v2",
- Auth: esv1beta1.VaultAuth{
- Kubernetes: &esv1beta1.VaultKubernetesAuth{
- Path: "kubernetes",
- Role: "kubernetes-auth-role",
- ServiceAccountRef: &esmeta.ServiceAccountSelector{
- Name: "example-sa",
- },
- },
- },
- CAProvider: &esv1beta1.CAProvider{
- Name: "vault-cert",
- Key: "cert",
- Type: "Secret",
- },
- },
- },
- },
- }
- }
- func makeValidSecretStoreWithIamAuthSecret() *esv1beta1.SecretStore {
- return &esv1beta1.SecretStore{
- ObjectMeta: metav1.ObjectMeta{
- Name: "vault-store",
- Namespace: "default",
- },
- Spec: esv1beta1.SecretStoreSpec{
- Provider: &esv1beta1.SecretStoreProvider{
- Vault: &esv1beta1.VaultProvider{
- Server: "https://vault.example.com:8200",
- Path: &secretStorePath,
- Version: esv1beta1.VaultKVStoreV2,
- Auth: esv1beta1.VaultAuth{
- Iam: &esv1beta1.VaultIamAuth{
- Path: "aws",
- Region: "us-east-1",
- Role: "vault-role",
- SecretRef: &esv1beta1.VaultAwsAuthSecretRef{
- AccessKeyID: esmeta.SecretKeySelector{
- Name: "vault-iam-creds-secret",
- Key: "access-key",
- },
- SecretAccessKey: esmeta.SecretKeySelector{
- Name: "vault-iam-creds-secret",
- Key: "secret-access-key",
- },
- SessionToken: &esmeta.SecretKeySelector{
- Name: "vault-iam-creds-secret",
- Key: "secret-session-token",
- },
- },
- },
- },
- },
- },
- },
- }
- }
- type secretStoreTweakFn func(s *esv1beta1.SecretStore)
- func makeSecretStore(tweaks ...secretStoreTweakFn) *esv1beta1.SecretStore {
- store := makeValidSecretStore()
- for _, fn := range tweaks {
- fn(store)
- }
- return store
- }
- type args struct {
- newClientFunc func(c *vault.Config) (util.Client, error)
- store esv1beta1.GenericStore
- kube kclient.Client
- corev1 typedcorev1.CoreV1Interface
- ns string
- }
- type want struct {
- err error
- }
- type testCase struct {
- reason string
- args args
- want want
- }
- func TestNewVault(t *testing.T) {
- errBoom := errors.New("boom")
- secretClientKey := []byte(`-----BEGIN PRIVATE KEY-----
- MIIJQgIBADANBgkqhkiG9w0BAQEFAASCCSwwggkoAgEAAoICAQCi4cG2CxHejOXaWW0Xri4PbWyuainurCZuULPLC0jJsJF0zkq778O7JleWzh7QhqVBKKIhW6LNUVS9tmGHfHC7ufaHr9YtadzVkiDzQKtA0Cgcco98CfX7bzn5pZn/yfnbRN/aTyxT5335DFhHc0/FCJn2Q/5H9UtX6LR3H3zbT9Io32T0B6OAUKKB/3uzxAECFwwSK8UqGUee8JKGBrU10XRAMGxOc1BOWYpCHWZRH2FRGIgS+bwYHOXUjPv6FH7qx+wCMzlxqd9LGvic2CpFE0BiEsOLIiY/qEqozvd2aOLVhBPjT/9LTXvRZwX/qA7h4YIsnq5N8lN4ytryb13N9fdRVgymVykGkaAmh5zA4DIg48ULWzOfdPwRQ1kVq2TRmj3IlcJsNn6MgHJTbRqvCdJMyA59FUZC9+QHfC307sV2aWPoVTwuUyD3pOFu4K0LV+OKIVQ8OTOqApbnL9dOLVx4wFVYE32lTC4tRdxUU8MKiPEoT19A+bLMPrZHnqXCIRzLwwfewICgTNYNuDHV93OmqJK4IXcF8UG00v+pRw+umqXNxNkk0x3grfX5w0sBGZbyuojYHnQQx6wZfUl3mEzJ2zlmCB1/2GKtXn6tIDmRxzeJ2bgaKTjG/uCv9OGtp1VLmn3b/3qC+he4fv/lGh/zd/i5JMVgMXM9MPRlWQIDAQABAoICAAec04fllo03Oprs6QtdSavQ6m5wactM4nLvdKe9vEYo6XNzHM0R1K0PirJyqcAHOvwDoSg79yzvay1+s6o4Z7BubZZD4pe2xep5bO7Ri+94ixdhR1F9ybBZr3T6h2sMDpBv9KJoZuL5A8s7B3k3a3gDAecfoGfOkBnot16F6zj4zxK39ijtnnelzSKURTzOoVluqFLFFu7zxYQpLD/1WkzMoElLuhQkkZFH4A1dAGY0OEEpC1sPrvnVh+xaNoCmqpPgiihEKqAkV1pURWBXPgqCbtTmmZsMGouJGwwuuCQhnNBr3t4V5BGp6mqMDRy4xxFJj+Lz+6OK+tm/aWJBUDn38JK1rQLCA5W3BxMoit4745VWxJc9PX068w6YwBRpqhfg94qZBZHxDe+nQBBEguQ5kBhoBpx60Wscrkjvr4ggb4fzuU6JxLDIDuE2HMIO+EZXl9HEwOB4ImmJhFxcxC8QTU7MnMJ05SuafZDGM2YdmvP2D/BfZf3DlWvVGOnbGh0vUSVLeS5qBBSNAoeG2UR4T3MCXLSaa9+GqIqzti+euPXXAUSYAC+y1qkqkE9rsPezMmKOJmybBIBf40hVLge8fIZPZuvMSW7Sykuex/EjIDfjohAj7GAkrzXOTKlnz7vZAv6Y3EUsoEiVKh5vot+p9xn/XEYH8+JMsVqAABH9AoIBAQDY8VwccTRzYjMoKxhWXdXKvCAAFumo8uUowpJnbbkZfTbf8+75zwi/XXHn9nm9ON/7tUrWAzwuUvtKz4AiHmwHt/IiicEC8Vlyl7N0X40pW/wtcFZJarFQAmVoRiZAzyszqggv3cwCcf8o1ugaBh1Q83RoT8Fz72yI+J70ldiGsu86aZY4V7ApzPH2OHdNbLUDTKkiMUrS6io5DzIeDx4x4riu+GAqm33nhnYdk1nwx/EATixPqwTN62n6XKhE5QysrKlO2pUEr0YXypN6ynRYiCBPsh8OvnB+2ibkgBNQRicSkOBoSMl/1BI35rwmARl/qUoypqJEUO4pgBsCBLBTAoIBAQDANMp+6rluPLGYXLf4vqT7Zlr1EgHIl0aBWzcqQlpVr6UrgHaFnw+q9T/wg+oFM7zMD02oPjGnsKyL8zaIveUCKSYQFjlznvLnFWeLMTbnrjkMrsN3aLriQ+7w6TXZVuGpA1W+DdChKl0z4BDJiMuHcZjiX4F9jFEB4xhvbH54e947Vk16GZVflSCqcBOAhH8DtGC/fQK76g1ndIHZjmUP8f2yQA7NaLhNbnZp0N2AvXOLBu+pDOaAKheENUOMRkDA+pNkEP0Krr0eW+P5o1iIuqK09ILytyECmUGd+VV6ePPsNAc/rKt0lF7Adg4Ay16hgPHHLbM7j+vsZd7KLU4jAoIBAE33SBRMtv30v8/i1QdNB+WpgJKnqWf3i1X/v1/+dfRsJMmNwEf1GP61VZd45D2V8CFlATUyynEXj4pOUo1wg4Cuog25li05kdz2Gh9rq66+iT3HTqtp9bl8cvdrppnKGouhwvl467XBRGNoANhBdE3AgQhwCWViGY6MU4wxQjT+n61NfxhWo1ASgK7tkiq4M8GwzmQkdPCiCXSiOm/FHSPuiFMRnnYRlckccNymNT+si7eBYLltC/f5cAfzPuIrs0dnch2NvtqFJ1qrih8qHXAn0/zwVesVlBZyzmF2ifpii+5HNO8loY0YKUf/24SJBqHztF/JtS16LG2rxYkPKFMCggEAT7yW1RgjXSwosQCmAbd1UiYgTdLuknzPbxKcTBfCyhFYADgG82ANa+raX7kZ+JaCGFWw7b7/coXEzzpSwV+mBcN0WvAdXW3vbxZeIkyEbpDEchJ+XKdCAGQWWDMnd8anTypnA7VPe8zLZZ3q2PC7HrFtr1vXqHHxmUrQ9EiaHvmkNBGVirXaVhDTwGFGdeaBmtPV3xrJa5Opg+W9iLeeDYNir/QLMAPlkZnl3fgcLDBsIpz6B7OmXD0aDGrcXvE2I9jQFI9HqorbQiD07rdpHy/uGAvn1zFJrH5Pzm2FnI1ZBACBkVTcvDxhIo7XOFUmKPIJW4wF8wu94BBS4KTy6QKCAQEAiG8TYUEAcCTpPzRC6oMc3uD0ukxJIYm94MbGts7j9cb+kULoxHN9BjPTeNMcq2dHFZoobLt33YmqcRbH4bRenBGAu1iGCGJsVDnwsnGrThuWwhlQQSVetGaIT7ODjuR2KA9ms/U0jpuYmcXFnQtAs9jhZ2Hx2GkWyQkcTEyQalwqAl3kCv05VYlRGOaYZA31xNyUnsjL0AMLzOAs0+t+IPM12l4FCEXV83m10J5DTFxpb12jWHRwGNmDlsk/Mknlj4uQEvmr9iopnpZnFOgi+jvRmx1CBmARXoMz5D/Hh/EVuCwJS1vIytYsHsml0x2yRxDYxD0V44p//HS/dG4SsQ==
- -----END PRIVATE KEY-----`)
- clientCrt := []byte(`-----BEGIN CERTIFICATE-----
- MIIFkTCCA3mgAwIBAgIUBEUg3m/WqAsWHG4Q/II3IePFfuowDQYJKoZIhvcNAQELBQAwWDELMAkGA1UEBhMCQVUxEzARBgNVBAgMClNvbWUtU3RhdGUxITAfBgNVBAoMGEludGVybmV0IFdpZGdpdHMgUHR5IEx0ZDERMA8GA1UEAwwIdmF1bHQtY2EwHhcNMjIwNzI5MjEyMjE4WhcNMzkwMTAxMjEyMjE4WjBYMQswCQYDVQQGEwJBVTETMBEGA1UECAwKU29tZS1TdGF0ZTEhMB8GA1UECgwYSW50ZXJuZXQgV2lkZ2l0cyBQdHkgTHRkMREwDwYDVQQDDAh2YXVsdC1jYTCCAiIwDQYJKoZIhvcNAQEBBQADggIPADCCAgoCggIBAKLhwbYLEd6M5dpZbReuLg9tbK5qKe6sJm5Qs8sLSMmwkXTOSrvvw7smV5bOHtCGpUEooiFbos1RVL22YYd8cLu59oev1i1p3NWSIPNAq0DQKBxyj3wJ9ftvOfmlmf/J+dtE39pPLFPnffkMWEdzT8UImfZD/kf1S1fotHcffNtP0ijfZPQHo4BQooH/e7PEAQIXDBIrxSoZR57wkoYGtTXRdEAwbE5zUE5ZikIdZlEfYVEYiBL5vBgc5dSM+/oUfurH7AIzOXGp30sa+JzYKkUTQGISw4siJj+oSqjO93Zo4tWEE+NP/0tNe9FnBf+oDuHhgiyerk3yU3jK2vJvXc3191FWDKZXKQaRoCaHnMDgMiDjxQtbM590/BFDWRWrZNGaPciVwmw2foyAclNtGq8J0kzIDn0VRkL35Ad8LfTuxXZpY+hVPC5TIPek4W7grQtX44ohVDw5M6oClucv104tXHjAVVgTfaVMLi1F3FRTwwqI8ShPX0D5ssw+tkeepcIhHMvDB97AgKBM1g24MdX3c6aokrghdwXxQbTS/6lHD66apc3E2STTHeCt9fnDSwEZlvK6iNgedBDHrBl9SXeYTMnbOWYIHX/YYq1efq0gOZHHN4nZuBopOMb+4K/04a2nVUuafdv/eoL6F7h+/+UaH/N3+LkkxWAxcz0w9GVZAgMBAAGjUzBRMB0GA1UdDgQWBBQuIVwmjMZvkq+jf6ViTelH5KDBVDAfBgNVHSMEGDAWgBQuIVwmjMZvkq+jf6ViTelH5KDBVDAPBgNVHRMBAf8EBTADAQH/MA0GCSqGSIb3DQEBCwUAA4ICAQAk4kNyFzmiKnREmi5PPj7xGAtv2aJIdMEfcZJ9e+H0Nb2aCvMvZsDodduXu6G5+1opd45v0AeTjLBkXDO6/8vnyM32VZEEKCAwMCLcOLD1z0+r+gaurDYMOGU5qr8hQadHKFsxEDYnR/9KdHhBg6A8qE2cOQa1ryu34DnWQ3m0CBApClf1YBRp/4T8BmHumfH6odD96H30HVzINrd9WM2hR9GRE3xqQyfwlvqmGn9S6snSVa+mcJ6w2wNE2LPGx0kOtBeOIUdfSsEgvSRjbowSHz9lohFZ0LxJYyizCA5vnMmYyhhkfJqm7YtjHkGWgXmqpH9BFt0D3gfORlIh787nuWfxtZ+554rDyQmPjYQG/qF4+Awehr4RxiGWTox1C67G/RzA6TOXX09xuFY+3U1ich90/KffvhoHvRVfhzxx+HUUY2qSU3HqQDzgieQQBaMuOhd1i6pua+/kPSXkuXqnIs8daao/goR5iU/lPLs7M8Dy7xZ9adzbIPuNuzHir2UuvtPlW+x/sSvOnVL9r/7TrAuWhdScglQ70EInPDVX7BgDWKrZUh86N4d7fu2f/T+6VoUSGEjq8obCj3BQ61mNEoftKVECUO4MMUdat6pY/4Xh6Dwc+FnbvR2+sX7IzI7FtgOrfO6abT+LCAR0R+UXyvnqZcjK2zkHz4DfXFbCQg==
- -----END CERTIFICATE-----`)
- secretData := []byte(secretDataString)
- cases := map[string]testCase{
- "InvalidVaultStore": {
- reason: "Should return error if given an invalid vault store.",
- args: args{
- store: &esv1beta1.SecretStore{},
- },
- want: want{
- err: errors.New(errVaultStore),
- },
- },
- "AddVaultStoreCertsError": {
- reason: "Should return error if given an invalid CA certificate.",
- args: args{
- store: makeSecretStore(func(s *esv1beta1.SecretStore) {
- s.Spec.Provider.Vault.CABundle = []byte("badcertdata")
- }),
- },
- want: want{
- err: fmt.Errorf(errVaultCert, errors.New("failed to parse certificates from CertPool")),
- },
- },
- "VaultAuthFormatError": {
- reason: "Should return error if no valid authentication method is given.",
- args: args{
- store: makeSecretStore(func(s *esv1beta1.SecretStore) {
- s.Spec.Provider.Vault.Auth = esv1beta1.VaultAuth{}
- }),
- },
- want: want{
- err: errors.New(errAuthFormat),
- },
- },
- "GetKubeServiceAccountError": {
- reason: "Should return error if fetching kubernetes secret fails.",
- args: args{
- newClientFunc: fake.ClientWithLoginMock,
- ns: "default",
- kube: clientfake.NewClientBuilder().Build(),
- store: makeSecretStore(),
- corev1: utilfake.NewCreateTokenMock().WithError(errBoom),
- },
- want: want{
- err: fmt.Errorf(errGetKubeSATokenRequest, "example-sa", errBoom),
- },
- },
- "GetKubeSecretError": {
- reason: "Should return error if fetching kubernetes secret fails.",
- args: args{
- ns: "default",
- store: makeSecretStore(func(s *esv1beta1.SecretStore) {
- s.Spec.Provider.Vault.Auth.Kubernetes.ServiceAccountRef = nil
- s.Spec.Provider.Vault.Auth.Kubernetes.SecretRef = &esmeta.SecretKeySelector{
- Name: "vault-secret",
- Key: "key",
- }
- }),
- kube: clientfake.NewClientBuilder().Build(),
- },
- want: want{
- err: fmt.Errorf(errGetKubeSecret, "vault-secret", errors.New("secrets \"vault-secret\" not found")),
- },
- },
- "SuccessfulVaultStoreWithCertAuth": {
- reason: "Should return a Vault provider successfully",
- args: args{
- store: makeValidSecretStoreWithCerts(),
- ns: "default",
- kube: clientfake.NewClientBuilder().WithObjects(&corev1.Secret{
- ObjectMeta: metav1.ObjectMeta{
- Name: "tls-auth-certs",
- Namespace: "default",
- },
- Data: map[string][]byte{
- "tls.key": secretClientKey,
- "tls.crt": clientCrt,
- },
- }).Build(),
- newClientFunc: fake.ClientWithLoginMock,
- },
- want: want{
- err: nil,
- },
- },
- "SuccessfulVaultStoreWithK8sCertSecret": {
- reason: "Should return a Vault provider with the cert from k8s",
- args: args{
- store: makeValidSecretStoreWithK8sCerts(true),
- ns: "default",
- kube: clientfake.NewClientBuilder().WithObjects(&corev1.Secret{
- ObjectMeta: metav1.ObjectMeta{
- Name: "vault-cert",
- Namespace: "default",
- },
- Data: map[string][]byte{
- "cert": clientCrt,
- "token": secretData,
- },
- }).Build(),
- corev1: utilfake.NewCreateTokenMock().WithToken("ok"),
- newClientFunc: fake.ClientWithLoginMock,
- },
- want: want{
- err: nil,
- },
- },
- "GetCertNamespaceMissingError": {
- reason: "Should return an error if namespace is missing and is a ClusterSecretStore",
- args: args{
- store: makeInvalidClusterSecretStoreWithK8sCerts(),
- ns: "default",
- kube: clientfake.NewClientBuilder().Build(),
- },
- want: want{
- err: errors.New(errCANamespace),
- },
- },
- "GetCertSecretKeyMissingError": {
- reason: "Should return an error if the secret key is missing",
- args: args{
- store: makeValidSecretStoreWithK8sCerts(true),
- ns: "default",
- kube: clientfake.NewClientBuilder().WithObjects(&corev1.Secret{
- ObjectMeta: metav1.ObjectMeta{
- Name: "vault-cert",
- Namespace: "default",
- },
- Data: map[string][]byte{},
- }).Build(),
- newClientFunc: fake.ClientWithLoginMock,
- },
- want: want{
- err: fmt.Errorf(errVaultCert, errors.New(`cannot find secret data for key: "cert"`)),
- },
- },
- "SuccessfulVaultStoreWithIamAuthSecret": {
- reason: "Should return a Vault provider successfully",
- args: args{
- store: makeValidSecretStoreWithIamAuthSecret(),
- ns: "default",
- kube: clientfake.NewClientBuilder().WithObjects(&corev1.Secret{
- ObjectMeta: metav1.ObjectMeta{
- Name: "vault-iam-creds-secret",
- Namespace: "default",
- },
- Data: map[string][]byte{
- "access-key": []byte("TESTING"),
- "secret-access-key": []byte("ABCDEF"),
- "secret-session-token": []byte("c2VjcmV0LXNlc3Npb24tdG9rZW4K"),
- },
- }).Build(),
- corev1: utilfake.NewCreateTokenMock().WithToken("ok"),
- newClientFunc: fake.ClientWithLoginMock,
- },
- want: want{
- err: nil,
- },
- },
- "SuccessfulVaultStoreWithK8sCertConfigMap": {
- reason: "Should return a Vault prodvider with the cert from k8s",
- args: args{
- store: makeValidSecretStoreWithK8sCerts(false),
- ns: "default",
- kube: clientfake.NewClientBuilder().WithObjects(&corev1.ConfigMap{
- ObjectMeta: metav1.ObjectMeta{
- Name: "vault-cert",
- },
- Data: map[string]string{
- "cert": string(clientCrt),
- },
- }).Build(),
- corev1: utilfake.NewCreateTokenMock().WithToken("ok"),
- newClientFunc: fake.ClientWithLoginMock,
- },
- want: want{
- err: nil,
- },
- },
- "GetCertConfigMapMissingError": {
- reason: "Should return an error if the config map key is missing",
- args: args{
- store: makeValidSecretStoreWithK8sCerts(false),
- ns: "default",
- kube: clientfake.NewClientBuilder().WithObjects(&corev1.ServiceAccount{
- ObjectMeta: metav1.ObjectMeta{
- Name: "example-sa",
- Namespace: "default",
- },
- Secrets: []corev1.ObjectReference{
- {
- Name: tokenSecretName,
- },
- },
- }, &corev1.ConfigMap{
- ObjectMeta: metav1.ObjectMeta{
- Name: "vault-cert",
- },
- Data: map[string]string{},
- }).Build(),
- newClientFunc: fake.ClientWithLoginMock,
- },
- want: want{
- err: fmt.Errorf(errConfigMapFmt, "cert"),
- },
- },
- "GetCertificateFormatError": {
- reason: "Should return error if client certificate is in wrong format.",
- args: args{
- store: makeValidSecretStoreWithCerts(),
- ns: "default",
- kube: clientfake.NewClientBuilder().WithObjects(&corev1.Secret{
- ObjectMeta: metav1.ObjectMeta{
- Name: "tls-auth-certs",
- Namespace: "default",
- },
- Data: map[string][]byte{
- "tls.key": secretClientKey,
- "tls.crt": []byte("cert with mistak"),
- },
- }).Build(),
- newClientFunc: fake.ClientWithLoginMock,
- },
- want: want{
- err: fmt.Errorf(errClientTLSAuth, "tls: failed to find any PEM data in certificate input"),
- },
- },
- "GetKeyFormatError": {
- reason: "Should return error if client key is in wrong format.",
- args: args{
- store: makeValidSecretStoreWithCerts(),
- ns: "default",
- kube: clientfake.NewClientBuilder().WithObjects(&corev1.Secret{
- ObjectMeta: metav1.ObjectMeta{
- Name: "tls-auth-certs",
- Namespace: "default",
- },
- Data: map[string][]byte{
- "tls.key": []byte("key with mistake"),
- "tls.crt": clientCrt,
- },
- }).Build(),
- newClientFunc: fake.ClientWithLoginMock,
- },
- want: want{
- err: fmt.Errorf(errClientTLSAuth, "tls: failed to find any PEM data in key input"),
- },
- },
- }
- for name, tc := range cases {
- t.Run(name, func(t *testing.T) {
- vaultTest(t, name, tc)
- })
- }
- }
- func vaultTest(t *testing.T, _ string, tc testCase) {
- conn := &Connector{
- NewVaultClient: tc.args.newClientFunc,
- }
- if tc.args.newClientFunc == nil {
- conn.NewVaultClient = NewVaultClient
- }
- _, err := conn.newClient(context.Background(), tc.args.store, tc.args.kube, tc.args.corev1, tc.args.ns)
- if diff := cmp.Diff(tc.want.err, err, EquateErrors()); diff != "" {
- t.Errorf("\n%s\nvault.New(...): -want error, +got error:\n%s", tc.reason, diff)
- }
- }
- func TestGetSecret(t *testing.T) {
- errBoom := errors.New("boom")
- secret := map[string]interface{}{
- "access_key": "access_key",
- "access_secret": "access_secret",
- }
- secretWithNilVal := map[string]interface{}{
- "access_key": "access_key",
- "access_secret": "access_secret",
- "token": nil,
- }
- secretWithNestedVal := map[string]interface{}{
- "access_key": "access_key",
- "access_secret": "access_secret",
- "nested.bar": "something different",
- "nested": map[string]string{
- "foo": "oke",
- "bar": "also ok?",
- },
- "list_of_values": []string{
- "first_value",
- "second_value",
- "third_value",
- },
- "json_number": json.Number("42"),
- }
- type args struct {
- store *esv1beta1.VaultProvider
- kube kclient.Client
- vLogical util.Logical
- ns string
- data esv1beta1.ExternalSecretDataRemoteRef
- }
- type want struct {
- err error
- val []byte
- }
- cases := map[string]struct {
- reason string
- args args
- want want
- }{
- "ReadSecret": {
- reason: "Should return the secret with property",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
- data: esv1beta1.ExternalSecretDataRemoteRef{
- Property: "access_key",
- },
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(secret, nil),
- },
- },
- want: want{
- err: nil,
- val: []byte("access_key"),
- },
- },
- "ReadSecretWithNil": {
- reason: "Should return the secret with property if it has a nil val",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
- data: esv1beta1.ExternalSecretDataRemoteRef{
- Property: "access_key",
- },
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(secretWithNilVal, nil),
- },
- },
- want: want{
- err: nil,
- val: []byte("access_key"),
- },
- },
- "ReadSecretWithoutProperty": {
- reason: "Should return the json encoded secret without property",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
- data: esv1beta1.ExternalSecretDataRemoteRef{},
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(secret, nil),
- },
- },
- want: want{
- err: nil,
- val: []byte(`{"access_key":"access_key","access_secret":"access_secret"}`),
- },
- },
- "ReadSecretWithNestedValue": {
- reason: "Should return a nested property",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
- data: esv1beta1.ExternalSecretDataRemoteRef{
- Property: "nested.foo",
- },
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(secretWithNestedVal, nil),
- },
- },
- want: want{
- err: nil,
- val: []byte("oke"),
- },
- },
- "ReadSecretWithNestedValueFromData": {
- reason: "Should return a nested property",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
- data: esv1beta1.ExternalSecretDataRemoteRef{
- //
- Property: "nested.bar",
- },
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(secretWithNestedVal, nil),
- },
- },
- want: want{
- err: nil,
- val: []byte("something different"),
- },
- },
- "ReadSecretWithMissingValueFromData": {
- reason: "Should return a NoSecretErr",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
- data: esv1beta1.ExternalSecretDataRemoteRef{
- Property: "not-relevant",
- },
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(nil, nil),
- },
- },
- want: want{
- err: esv1beta1.NoSecretErr,
- val: nil,
- },
- },
- "ReadSecretWithSliceValue": {
- reason: "Should return property as a joined slice",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
- data: esv1beta1.ExternalSecretDataRemoteRef{
- Property: "list_of_values",
- },
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(secretWithNestedVal, nil),
- },
- },
- want: want{
- err: nil,
- val: []byte("first_value\nsecond_value\nthird_value"),
- },
- },
- "ReadSecretWithJsonNumber": {
- reason: "Should return parsed json.Number property",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
- data: esv1beta1.ExternalSecretDataRemoteRef{
- Property: "json_number",
- },
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(secretWithNestedVal, nil),
- },
- },
- want: want{
- err: nil,
- val: []byte("42"),
- },
- },
- "NonexistentProperty": {
- reason: "Should return error property does not exist.",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
- data: esv1beta1.ExternalSecretDataRemoteRef{
- Property: "nop.doesnt.exist",
- },
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(secretWithNestedVal, nil),
- },
- },
- want: want{
- err: fmt.Errorf(errSecretKeyFmt, "nop.doesnt.exist"),
- },
- },
- "ReadSecretError": {
- reason: "Should return error if vault client fails to read secret.",
- args: args{
- store: makeSecretStore().Spec.Provider.Vault,
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(nil, errBoom),
- },
- },
- want: want{
- err: fmt.Errorf(errReadSecret, errBoom),
- },
- },
- "ReadSecretNotFound": {
- reason: "Secret doesn't exist",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
- data: esv1beta1.ExternalSecretDataRemoteRef{
- Property: "access_key",
- },
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: func(ctx context.Context, path string, data map[string][]string) (*vault.Secret, error) {
- return nil, nil
- },
- },
- },
- want: want{
- err: esv1beta1.NoSecretError{},
- },
- },
- "ReadSecretMetadataWithoutProperty": {
- reason: "Should return the json encoded metadata",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
- data: esv1beta1.ExternalSecretDataRemoteRef{
- MetadataPolicy: "Fetch",
- },
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadMetadataWithContextFn(secret, nil),
- },
- },
- want: want{
- err: nil,
- val: []byte(`{"access_key":"access_key","access_secret":"access_secret"}`),
- },
- },
- "ReadSecretMetadataWithProperty": {
- reason: "Should return the access_key value from the metadata",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
- data: esv1beta1.ExternalSecretDataRemoteRef{
- MetadataPolicy: "Fetch",
- Property: "access_key",
- },
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadMetadataWithContextFn(secret, nil),
- },
- },
- want: want{
- err: nil,
- val: []byte("access_key"),
- },
- },
- "FailReadSecretMetadataInvalidProperty": {
- reason: "Should return error of non existent key inmetadata",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
- data: esv1beta1.ExternalSecretDataRemoteRef{
- MetadataPolicy: "Fetch",
- Property: "does_not_exist",
- },
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadMetadataWithContextFn(secret, nil),
- },
- },
- want: want{
- err: fmt.Errorf(errSecretKeyFmt, "does_not_exist"),
- },
- },
- "FailReadSecretMetadataNoMetadata": {
- reason: "Should return the access_key value from the metadata",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
- data: esv1beta1.ExternalSecretDataRemoteRef{
- MetadataPolicy: "Fetch",
- },
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadMetadataWithContextFn(nil, nil),
- },
- },
- want: want{
- err: fmt.Errorf(errNotFound),
- },
- },
- "FailReadSecretMetadataWrongVersion": {
- reason: "Should return the access_key value from the metadata",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
- data: esv1beta1.ExternalSecretDataRemoteRef{
- MetadataPolicy: "Fetch",
- },
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadMetadataWithContextFn(nil, nil),
- },
- },
- want: want{
- err: fmt.Errorf(errUnsupportedMetadataKvVersion),
- },
- },
- }
- 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.GetSecret(context.Background(), tc.args.data)
- if diff := cmp.Diff(tc.want.err, err, EquateErrors()); diff != "" {
- t.Errorf("\n%s\nvault.GetSecret(...): -want error, +got error:\n%s", tc.reason, diff)
- }
- if diff := cmp.Diff(string(tc.want.val), string(val)); diff != "" {
- t.Errorf("\n%s\nvault.GetSecret(...): -want val, +got val:\n%s", tc.reason, diff)
- }
- })
- }
- }
- func TestGetSecretMap(t *testing.T) {
- errBoom := errors.New("boom")
- secret := map[string]interface{}{
- "access_key": "access_key",
- "access_secret": "access_secret",
- }
- secretWithNilVal := map[string]interface{}{
- "access_key": "access_key",
- "access_secret": "access_secret",
- "token": nil,
- }
- secretWithNestedVal := map[string]interface{}{
- "access_key": "access_key",
- "access_secret": "access_secret",
- "nested": map[string]interface{}{
- "foo": map[string]string{
- "oke": "yup",
- "mhkeih": "yada yada",
- },
- },
- }
- secretWithTypes := map[string]interface{}{
- "access_secret": "access_secret",
- "f32": float32(2.12),
- "f64": float64(2.1234534153423423),
- "int": 42,
- "bool": true,
- "bt": []byte("foobar"),
- }
- type args struct {
- store *esv1beta1.VaultProvider
- kube kclient.Client
- vClient util.Logical
- ns string
- data esv1beta1.ExternalSecretDataRemoteRef
- }
- type want struct {
- err error
- val map[string][]byte
- }
- cases := map[string]struct {
- reason string
- args args
- want want
- }{
- "ReadSecretKV1": {
- reason: "Should map the secret even if it has a nil value",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
- vClient: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(secret, nil),
- },
- },
- want: want{
- err: nil,
- val: map[string][]byte{
- "access_key": []byte("access_key"),
- "access_secret": []byte("access_secret"),
- },
- },
- },
- "ReadSecretKV2": {
- reason: "Should map the secret even if it has a nil value",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
- vClient: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
- "data": secret,
- }, nil),
- },
- },
- want: want{
- err: nil,
- val: map[string][]byte{
- "access_key": []byte("access_key"),
- "access_secret": []byte("access_secret"),
- },
- },
- },
- "ReadSecretWithNilValueKV1": {
- reason: "Should map the secret even if it has a nil value",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
- vClient: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(secretWithNilVal, nil),
- },
- },
- want: want{
- err: nil,
- val: map[string][]byte{
- "access_key": []byte("access_key"),
- "access_secret": []byte("access_secret"),
- "token": []byte(nil),
- },
- },
- },
- "ReadSecretWithNilValueKV2": {
- reason: "Should map the secret even if it has a nil value",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
- vClient: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
- "data": secretWithNilVal}, nil),
- },
- },
- want: want{
- err: nil,
- val: map[string][]byte{
- "access_key": []byte("access_key"),
- "access_secret": []byte("access_secret"),
- "token": []byte(nil),
- },
- },
- },
- "ReadSecretWithTypesKV2": {
- reason: "Should map the secret even if it has other types",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
- vClient: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
- "data": secretWithTypes}, nil),
- },
- },
- want: want{
- err: nil,
- val: map[string][]byte{
- "access_secret": []byte("access_secret"),
- "f32": []byte("2.12"),
- "f64": []byte("2.1234534153423423"),
- "int": []byte("42"),
- "bool": []byte("true"),
- "bt": []byte("Zm9vYmFy"), // base64
- },
- },
- },
- "ReadNestedSecret": {
- reason: "Should map the secret for deeply nested property",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
- data: esv1beta1.ExternalSecretDataRemoteRef{
- Property: "nested",
- },
- vClient: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
- "data": secretWithNestedVal}, nil),
- },
- },
- want: want{
- err: nil,
- val: map[string][]byte{
- "foo": []byte(`{"mhkeih":"yada yada","oke":"yup"}`),
- },
- },
- },
- "ReadDeeplyNestedSecret": {
- reason: "Should map the secret for deeply nested property",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
- data: esv1beta1.ExternalSecretDataRemoteRef{
- Property: "nested.foo",
- },
- vClient: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
- "data": secretWithNestedVal}, nil),
- },
- },
- want: want{
- err: nil,
- val: map[string][]byte{
- "oke": []byte("yup"),
- "mhkeih": []byte("yada yada"),
- },
- },
- },
- "ReadSecretError": {
- reason: "Should return error if vault client fails to read secret.",
- args: args{
- store: makeSecretStore().Spec.Provider.Vault,
- vClient: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(nil, errBoom),
- },
- },
- want: want{
- err: fmt.Errorf(errReadSecret, errBoom),
- },
- },
- }
- for name, tc := range cases {
- t.Run(name, func(t *testing.T) {
- vStore := &client{
- kube: tc.args.kube,
- logical: tc.args.vClient,
- store: tc.args.store,
- namespace: tc.args.ns,
- }
- val, err := vStore.GetSecretMap(context.Background(), tc.args.data)
- if diff := cmp.Diff(tc.want.err, err, EquateErrors()); diff != "" {
- t.Errorf("\n%s\nvault.GetSecretMap(...): -want error, +got error:\n%s", tc.reason, diff)
- }
- if diff := cmp.Diff(tc.want.val, val); diff != "" {
- t.Errorf("\n%s\nvault.GetSecretMap(...): -want val, +got val:\n%s", tc.reason, diff)
- }
- })
- }
- }
- func newListWithContextFn(secrets map[string]interface{}) func(ctx context.Context, path string) (*vault.Secret, error) {
- return func(ctx context.Context, path string) (*vault.Secret, error) {
- path = strings.TrimPrefix(path, "secret/metadata/")
- if path == "" {
- path = "default"
- }
- data, ok := secrets[path]
- if !ok {
- return nil, errors.New("Secret not found")
- }
- meta := data.(map[string]interface{})
- ans := meta["metadata"].(map[string]interface{})
- secret := &vault.Secret{
- Data: map[string]interface{}{
- "keys": ans["keys"],
- },
- }
- return secret, nil
- }
- }
- func newReadtWithContextFn(secrets map[string]interface{}) func(ctx context.Context, path string, data map[string][]string) (*vault.Secret, error) {
- return func(ctx context.Context, path string, d map[string][]string) (*vault.Secret, error) {
- path = strings.TrimPrefix(path, "secret/data/")
- path = strings.TrimPrefix(path, "secret/metadata/")
- if path == "" {
- path = "default"
- }
- data, ok := secrets[path]
- if !ok {
- return nil, errors.New("Secret not found")
- }
- meta := data.(map[string]interface{})
- metadata := meta["metadata"].(map[string]interface{})
- content := map[string]interface{}{
- "data": meta["data"],
- "custom_metadata": metadata["custom_metadata"],
- }
- secret := &vault.Secret{
- Data: content,
- }
- return secret, nil
- }
- }
- 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"
- secret := map[string]interface{}{
- "secret1": map[string]interface{}{
- "metadata": map[string]interface{}{
- "custom_metadata": map[string]interface{}{
- "foo": "bar",
- },
- },
- "data": map[string]interface{}{
- "access_key": "access_key",
- "access_secret": "access_secret",
- },
- },
- "secret2": map[string]interface{}{
- "metadata": map[string]interface{}{
- "custom_metadata": map[string]interface{}{
- "foo": "baz",
- },
- },
- "data": map[string]interface{}{
- "access_key": "access_key2",
- "access_secret": "access_secret2",
- },
- },
- "secret3": map[string]interface{}{
- "metadata": map[string]interface{}{
- "custom_metadata": map[string]interface{}{
- "foo": "baz",
- },
- },
- "data": nil,
- },
- "tag": map[string]interface{}{
- "metadata": map[string]interface{}{
- "custom_metadata": map[string]interface{}{
- "foo": "baz",
- },
- },
- "data": map[string]interface{}{
- "access_key": "unfetched",
- "access_secret": "unfetched",
- },
- },
- "path/1": map[string]interface{}{
- "metadata": map[string]interface{}{
- "custom_metadata": map[string]interface{}{
- "foo": "path",
- },
- },
- "data": map[string]interface{}{
- "access_key": "path1",
- "access_secret": "path1",
- },
- },
- "path/2": map[string]interface{}{
- "metadata": map[string]interface{}{
- "custom_metadata": map[string]interface{}{
- "foo": "path",
- },
- },
- "data": map[string]interface{}{
- "access_key": "path2",
- "access_secret": "path2",
- },
- },
- "default": map[string]interface{}{
- "data": map[string]interface{}{
- "empty": "true",
- },
- "metadata": map[string]interface{}{
- "keys": []interface{}{"secret1", "secret2", "secret3", "tag", "path/"},
- },
- },
- "path/": map[string]interface{}{
- "data": map[string]interface{}{
- "empty": "true",
- },
- "metadata": map[string]interface{}{
- "keys": []interface{}{"1", "2"},
- },
- },
- }
- type args struct {
- store *esv1beta1.VaultProvider
- kube kclient.Client
- vLogical util.Logical
- ns string
- data esv1beta1.ExternalSecretFind
- }
- type want struct {
- err error
- val map[string][]byte
- }
- cases := map[string]struct {
- reason string
- args args
- want want
- }{
- "FindByName": {
- reason: "should map multiple secrets matching name",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
- vLogical: &fake.Logical{
- ListWithContextFn: newListWithContextFn(secret),
- ReadWithDataWithContextFn: newReadtWithContextFn(secret),
- },
- data: esv1beta1.ExternalSecretFind{
- Name: &esv1beta1.FindName{
- RegExp: "secret.*",
- },
- },
- },
- want: want{
- err: nil,
- val: map[string][]byte{
- "secret1": secret1Bytes,
- "secret2": secret2Bytes,
- },
- },
- },
- "FindByTag": {
- reason: "should map multiple secrets matching tags",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
- vLogical: &fake.Logical{
- ListWithContextFn: newListWithContextFn(secret),
- ReadWithDataWithContextFn: newReadtWithContextFn(secret),
- },
- data: esv1beta1.ExternalSecretFind{
- Tags: map[string]string{
- "foo": "baz",
- },
- },
- },
- want: want{
- err: nil,
- val: map[string][]byte{
- "tag": tagBytes,
- "secret2": secret2Bytes,
- },
- },
- },
- "FilterByPath": {
- reason: "should filter secrets based on path",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
- vLogical: &fake.Logical{
- ListWithContextFn: newListWithContextFn(secret),
- ReadWithDataWithContextFn: newReadtWithContextFn(secret),
- },
- data: esv1beta1.ExternalSecretFind{
- Path: &path,
- Tags: map[string]string{
- "foo": "path",
- },
- },
- },
- want: want{
- err: nil,
- val: map[string][]byte{
- "path/1": path1Bytes,
- "path/2": path2Bytes,
- },
- },
- },
- "FailIfKv1": {
- reason: "should not work if using kv1 store",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
- vLogical: &fake.Logical{
- ListWithContextFn: newListWithContextFn(secret),
- ReadWithDataWithContextFn: newReadtWithContextFn(secret),
- },
- data: esv1beta1.ExternalSecretFind{
- Tags: map[string]string{
- "foo": "baz",
- },
- },
- },
- want: want{
- err: errors.New(errUnsupportedKvVersion),
- },
- },
- "MetadataNotFound": {
- reason: "metadata secret not found",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
- vLogical: &fake.Logical{
- ListWithContextFn: newListWithContextFn(secret),
- ReadWithDataWithContextFn: func(ctx context.Context, path string, d map[string][]string) (*vault.Secret, error) {
- return nil, nil
- },
- },
- data: esv1beta1.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.GetSecretMap(...): -want error, +got error:\n%s", tc.reason, diff)
- }
- if diff := cmp.Diff(tc.want.val, val); diff != "" {
- t.Errorf("\n%s\nvault.GetSecretMap(...): -want val, +got val:\n%s", tc.reason, diff)
- }
- })
- }
- }
- func TestGetSecretPath(t *testing.T) {
- storeV2 := makeValidSecretStore()
- storeV2NoPath := storeV2.DeepCopy()
- multiPath := "secret/path"
- storeV2.Spec.Provider.Vault.Path = &multiPath
- storeV2NoPath.Spec.Provider.Vault.Path = nil
- storeV1 := makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1)
- storeV1NoPath := storeV1.DeepCopy()
- storeV1.Spec.Provider.Vault.Path = &multiPath
- storeV1NoPath.Spec.Provider.Vault.Path = nil
- type args struct {
- store *esv1beta1.VaultProvider
- path string
- expected string
- }
- cases := map[string]struct {
- reason string
- args args
- }{
- "PathWithoutFormatV2": {
- reason: "path should compose with mount point if set",
- args: args{
- store: storeV2.Spec.Provider.Vault,
- path: "secret/path/data/test",
- expected: "secret/path/data/test",
- },
- },
- "PathWithoutFormatV2_NoData": {
- reason: "path should compose with mount point if set without data",
- args: args{
- store: storeV2.Spec.Provider.Vault,
- path: "secret/path/test",
- expected: "secret/path/data/test",
- },
- },
- "PathWithoutFormatV2_NoPath": {
- reason: "if no mountpoint and no data available, needs to be set in second element",
- args: args{
- store: storeV2NoPath.Spec.Provider.Vault,
- path: "secret/test/big/path",
- expected: "secret/data/test/big/path",
- },
- },
- "PathWithoutFormatV2_NoPathWithData": {
- reason: "if data is available, should respect order",
- args: args{
- store: storeV2NoPath.Spec.Provider.Vault,
- path: "secret/test/data/not/the/first/and/data/twice",
- expected: "secret/test/data/not/the/first/and/data/twice",
- },
- },
- "PathWithoutFormatV1": {
- reason: "v1 mountpoint should be added but not enforce 'data'",
- args: args{
- store: storeV1.Spec.Provider.Vault,
- path: "secret/path/test",
- expected: "secret/path/test",
- },
- },
- "PathWithoutFormatV1_NoPath": {
- reason: "Should not append any path information if v1 with no mountpoint",
- args: args{
- store: storeV1NoPath.Spec.Provider.Vault,
- path: "secret/test",
- expected: "secret/test",
- },
- },
- "WithoutPathButMountpointV2": {
- reason: "Mountpoint needs to be set in addition to data",
- args: args{
- store: storeV2.Spec.Provider.Vault,
- path: "test",
- expected: "secret/path/data/test",
- },
- },
- "WithoutPathButMountpointV1": {
- reason: "Mountpoint needs to be set in addition to data",
- args: args{
- store: storeV1.Spec.Provider.Vault,
- path: "test",
- expected: "secret/path/test",
- },
- },
- }
- for name, tc := range cases {
- t.Run(name, func(t *testing.T) {
- vStore := &client{
- store: tc.args.store,
- }
- want := vStore.buildPath(tc.args.path)
- if diff := cmp.Diff(want, tc.args.expected); diff != "" {
- t.Errorf("\n%s\nvault.buildPath(...): -want expected, +got error:\n%s", tc.reason, diff)
- }
- })
- }
- }
- func TestValidateStore(t *testing.T) {
- type args struct {
- auth esv1beta1.VaultAuth
- }
- tests := []struct {
- name string
- args args
- wantErr bool
- }{
- {
- name: "empty auth",
- args: args{},
- },
- {
- name: "invalid approle with namespace",
- args: args{
- auth: esv1beta1.VaultAuth{
- AppRole: &esv1beta1.VaultAppRole{
- SecretRef: esmeta.SecretKeySelector{
- Namespace: pointer.String("invalid"),
- },
- },
- },
- },
- wantErr: true,
- },
- {
- name: "invalid approle with roleId and no roleRef",
- args: args{
- auth: esv1beta1.VaultAuth{
- AppRole: &esv1beta1.VaultAppRole{
- RoleID: "",
- RoleRef: nil,
- },
- },
- },
- wantErr: true,
- },
- {
- name: "valid approle with roleId and no roleRef",
- args: args{
- auth: esv1beta1.VaultAuth{
- AppRole: &esv1beta1.VaultAppRole{
- RoleID: "fake-value",
- },
- },
- },
- wantErr: false,
- },
- {
- name: "valid approle with roleId and no roleRef",
- args: args{
- auth: esv1beta1.VaultAuth{
- AppRole: &esv1beta1.VaultAppRole{
- RoleRef: &esmeta.SecretKeySelector{
- Name: "fake-value",
- },
- },
- },
- },
- wantErr: false,
- },
- {
- name: "invalid clientcert",
- args: args{
- auth: esv1beta1.VaultAuth{
- Cert: &esv1beta1.VaultCertAuth{
- ClientCert: esmeta.SecretKeySelector{
- Namespace: pointer.String("invalid"),
- },
- },
- },
- },
- wantErr: true,
- },
- {
- name: "invalid cert secret",
- args: args{
- auth: esv1beta1.VaultAuth{
- Cert: &esv1beta1.VaultCertAuth{
- SecretRef: esmeta.SecretKeySelector{
- Namespace: pointer.String("invalid"),
- },
- },
- },
- },
- wantErr: true,
- },
- {
- name: "invalid jwt secret",
- args: args{
- auth: esv1beta1.VaultAuth{
- Jwt: &esv1beta1.VaultJwtAuth{
- SecretRef: &esmeta.SecretKeySelector{
- Namespace: pointer.String("invalid"),
- },
- },
- },
- },
- wantErr: true,
- },
- {
- name: "invalid kubernetes sa",
- args: args{
- auth: esv1beta1.VaultAuth{
- Kubernetes: &esv1beta1.VaultKubernetesAuth{
- ServiceAccountRef: &esmeta.ServiceAccountSelector{
- Namespace: pointer.String("invalid"),
- },
- },
- },
- },
- wantErr: true,
- },
- {
- name: "invalid kubernetes secret",
- args: args{
- auth: esv1beta1.VaultAuth{
- Kubernetes: &esv1beta1.VaultKubernetesAuth{
- SecretRef: &esmeta.SecretKeySelector{
- Namespace: pointer.String("invalid"),
- },
- },
- },
- },
- wantErr: true,
- },
- {
- name: "invalid ldap secret",
- args: args{
- auth: esv1beta1.VaultAuth{
- Ldap: &esv1beta1.VaultLdapAuth{
- SecretRef: esmeta.SecretKeySelector{
- Namespace: pointer.String("invalid"),
- },
- },
- },
- },
- wantErr: true,
- },
- {
- name: "invalid token secret",
- args: args{
- auth: esv1beta1.VaultAuth{
- TokenSecretRef: &esmeta.SecretKeySelector{
- Namespace: pointer.String("invalid"),
- },
- },
- },
- wantErr: true,
- },
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- c := &Connector{
- NewVaultClient: nil,
- }
- store := &esv1beta1.SecretStore{
- Spec: esv1beta1.SecretStoreSpec{
- Provider: &esv1beta1.SecretStoreProvider{
- Vault: &esv1beta1.VaultProvider{
- Auth: tt.args.auth,
- },
- },
- },
- }
- if err := c.ValidateStore(store); (err != nil) != tt.wantErr {
- t.Errorf("connector.ValidateStore() error = %v, wantErr %v", err, tt.wantErr)
- }
- })
- }
- }
- type fakeRef struct {
- key string
- property string
- }
- func (f fakeRef) GetRemoteKey() string {
- return f.key
- }
- func (f fakeRef) GetProperty() string {
- return f.property
- }
- func TestDeleteSecret(t *testing.T) {
- type args struct {
- store *esv1beta1.VaultProvider
- vLogical util.Logical
- }
- type want struct {
- err error
- }
- tests := map[string]struct {
- reason string
- args args
- ref *fakeRef
- want want
- value []byte
- }{
- "DeleteSecretNoOp": {
- reason: "No secret is because it does not exist",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(nil, nil),
- WriteWithContextFn: fake.ExpectWriteWithContextNoCall(),
- DeleteWithContextFn: fake.ExpectDeleteWithContextNoCall(),
- },
- },
- want: want{
- err: nil,
- },
- },
- "DeleteSecretFailIfError": {
- reason: "No secret is because it does not exist",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(nil, fmt.Errorf("failed to read")),
- WriteWithContextFn: fake.ExpectWriteWithContextNoCall(),
- DeleteWithContextFn: fake.ExpectDeleteWithContextNoCall(),
- },
- },
- want: want{
- err: fmt.Errorf("failed to read"),
- },
- },
- "DeleteSecretNotManaged": {
- reason: "No secret is because it does not exist",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
- "data": map[string]interface{}{
- "fake-key": "fake-value",
- },
- "custom_metadata": map[string]interface{}{
- "managed-by": "another-secret-tool",
- },
- }, nil),
- WriteWithContextFn: fake.ExpectWriteWithContextNoCall(),
- DeleteWithContextFn: fake.NewDeleteWithContextFn(nil, nil),
- },
- },
- want: want{
- err: nil,
- },
- },
- "DeleteSecretSuccess": {
- reason: "No secret is because it does not exist",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
- "data": map[string]interface{}{
- "fake-key": "fake-value",
- },
- "custom_metadata": map[string]interface{}{
- "managed-by": "external-secrets",
- },
- }, nil),
- WriteWithContextFn: fake.ExpectWriteWithContextNoCall(),
- DeleteWithContextFn: fake.NewDeleteWithContextFn(nil, nil),
- },
- },
- want: want{
- err: nil,
- },
- },
- "DeleteSecretError": {
- reason: "No secret is because it does not exist",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
- "data": map[string]interface{}{
- "fake-key": "fake-value",
- },
- "custom_metadata": map[string]interface{}{
- "managed-by": "external-secrets",
- },
- }, nil),
- WriteWithContextFn: fake.ExpectWriteWithContextNoCall(),
- DeleteWithContextFn: fake.NewDeleteWithContextFn(nil, fmt.Errorf("failed to delete")),
- },
- },
- want: want{
- err: fmt.Errorf("failed to delete"),
- },
- },
- "DeleteSecretUpdateProperty": {
- reason: "Secret should only be updated if Property is set",
- ref: &fakeRef{key: "secret", property: "fake-key"},
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
- "data": map[string]interface{}{
- "fake-key": "fake-value",
- "foo": "bar",
- },
- "custom_metadata": map[string]interface{}{
- "managed-by": "external-secrets",
- },
- }, nil),
- WriteWithContextFn: fake.ExpectWriteWithContextValue(map[string]interface{}{"data": map[string]interface{}{"foo": "bar"}}),
- DeleteWithContextFn: fake.ExpectDeleteWithContextNoCall(),
- },
- },
- want: want{
- err: nil,
- },
- },
- "DeleteSecretIfNoOtherProperties": {
- reason: "Secret should only be deleted if no other properties are set",
- ref: &fakeRef{key: "secret", property: "foo"},
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
- "data": map[string]interface{}{
- "foo": "bar",
- },
- "custom_metadata": map[string]interface{}{
- "managed-by": "external-secrets",
- },
- }, nil),
- WriteWithContextFn: fake.ExpectWriteWithContextNoCall(),
- DeleteWithContextFn: fake.NewDeleteWithContextFn(nil, nil),
- },
- },
- want: want{
- err: nil,
- },
- },
- }
- for name, tc := range tests {
- t.Run(name, func(t *testing.T) {
- ref := fakeRef{key: "secret", property: ""}
- if tc.ref != nil {
- ref = *tc.ref
- }
- client := &client{
- logical: tc.args.vLogical,
- store: tc.args.store,
- }
- err := client.DeleteSecret(context.Background(), ref)
- // Error nil XOR tc.want.err nil
- if ((err == nil) || (tc.want.err == nil)) && !((err == nil) && (tc.want.err == nil)) {
- t.Errorf("\nTesting DeleteSecret:\nName: %v\nReason: %v\nWant error: %v\nGot error: %v", name, tc.reason, tc.want.err, err)
- }
- // if errors are the same type but their contents do not match
- if err != nil && tc.want.err != nil {
- if !strings.Contains(err.Error(), tc.want.err.Error()) {
- t.Errorf("\nTesting DeleteSecret:\nName: %v\nReason: %v\nWant error: %v\nGot error got nil", name, tc.reason, tc.want.err)
- }
- }
- })
- }
- }
- func TestSetSecret(t *testing.T) {
- noPermission := errors.New("no permission")
- type args struct {
- store *esv1beta1.VaultProvider
- vLogical util.Logical
- }
- type want struct {
- err error
- }
- tests := map[string]struct {
- reason string
- args args
- want want
- ref *fakeRef
- value []byte
- }{
- "SetSecret": {
- reason: "secret is successfully set, with no existing vault secret",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(nil, nil),
- WriteWithContextFn: fake.NewWriteWithContextFn(nil, nil),
- },
- },
- want: want{
- err: nil,
- },
- },
- "SetSecretWithWriteError": {
- reason: "secret cannot be pushed if write fails",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(nil, nil),
- WriteWithContextFn: fake.NewWriteWithContextFn(nil, noPermission),
- },
- },
- want: want{
- err: noPermission,
- },
- },
- "SetSecretEqualsPushSecret": {
- reason: "vault secret kv equals secret to push kv",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
- "data": map[string]interface{}{
- "fake-key": "fake-value",
- },
- "custom_metadata": map[string]interface{}{
- "managed-by": "external-secrets",
- },
- }, nil),
- },
- },
- want: want{
- err: nil,
- },
- },
- "PushSecretProperty": {
- reason: "push secret with property adds the property",
- value: []byte("fake-value"),
- ref: &fakeRef{key: "secret", property: "foo"},
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
- "data": map[string]interface{}{
- "fake-key": "fake-value",
- },
- "custom_metadata": map[string]interface{}{
- "managed-by": "external-secrets",
- },
- }, nil),
- WriteWithContextFn: fake.ExpectWriteWithContextValue(map[string]interface{}{"data": map[string]interface{}{"fake-key": "fake-value", "foo": "fake-value"}}),
- },
- },
- want: want{
- err: nil,
- },
- },
- "PushSecretUpdateProperty": {
- reason: "push secret with property only updates the property",
- value: []byte("new-value"),
- ref: &fakeRef{key: "secret", property: "foo"},
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
- "data": map[string]interface{}{
- "foo": "fake-value",
- },
- "custom_metadata": map[string]interface{}{
- "managed-by": "external-secrets",
- },
- }, nil),
- WriteWithContextFn: fake.ExpectWriteWithContextValue(map[string]interface{}{"data": map[string]interface{}{"foo": "new-value"}}),
- },
- },
- want: want{
- err: nil,
- },
- },
- "PushSecretPropertyNoUpdate": {
- reason: "push secret with property only updates the property",
- value: []byte("fake-value"),
- ref: &fakeRef{key: "secret", property: "foo"},
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
- "data": map[string]interface{}{
- "foo": "fake-value",
- },
- "custom_metadata": map[string]interface{}{
- "managed-by": "external-secrets",
- },
- }, nil),
- WriteWithContextFn: fake.ExpectWriteWithContextNoCall(),
- },
- },
- want: want{
- err: nil,
- },
- },
- "SetSecretErrorReadingSecret": {
- reason: "error occurs if secret cannot be read",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(nil, noPermission),
- },
- },
- want: want{
- err: fmt.Errorf(errReadSecret, noPermission),
- },
- },
- "SetSecretNotManagedByESO": {
- reason: "a secret not managed by ESO cannot be updated",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV2).Spec.Provider.Vault,
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
- "data": map[string]interface{}{
- "fake-key": "fake-value2",
- "custom_metadata": map[string]interface{}{
- "managed-by": "not-external-secrets",
- },
- },
- }, nil),
- },
- },
- want: want{
- err: errors.New("secret not managed by external-secrets"),
- },
- },
- }
- for name, tc := range tests {
- t.Run(name, func(t *testing.T) {
- ref := fakeRef{key: "secret", property: ""}
- if tc.ref != nil {
- ref = *tc.ref
- }
- client := &client{
- logical: tc.args.vLogical,
- store: tc.args.store,
- }
- val := tc.value
- if val == nil {
- val = []byte(`{"fake-key":"fake-value"}`)
- }
- err := client.PushSecret(context.Background(), val, ref)
- // Error nil XOR tc.want.err nil
- if ((err == nil) || (tc.want.err == nil)) && !((err == nil) && (tc.want.err == nil)) {
- t.Errorf("\nTesting SetSecret:\nName: %v\nReason: %v\nWant error: %v\nGot error: %v", name, tc.reason, tc.want.err, err)
- }
- // if errors are the same type but their contents do not match
- if err != nil && tc.want.err != nil {
- if !strings.Contains(err.Error(), tc.want.err.Error()) {
- t.Errorf("\nTesting SetSecret:\nName: %v\nReason: %v\nWant error: %v\nGot error got nil", name, tc.reason, tc.want.err)
- }
- }
- })
- }
- }
- // EquateErrors returns true if the supplied errors are of the same type and
- // produce identical strings. This mirrors the error comparison behavior of
- // https://github.com/go-test/deep, which most Crossplane tests targeted before
- // we switched to go-cmp.
- //
- // This differs from cmpopts.EquateErrors, which does not test for error strings
- // and instead returns whether one error 'is' (in the errors.Is sense) the
- // other.
- func EquateErrors() cmp.Option {
- return cmp.Comparer(func(a, b error) bool {
- if a == nil || b == nil {
- return a == nil && b == nil
- }
- av := reflect.ValueOf(a)
- bv := reflect.ValueOf(b)
- if av.Type() != bv.Type() {
- return false
- }
- return a.Error() == b.Error()
- })
- }
|