| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463 |
- /*
- 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"
- pointer "k8s.io/utils/ptr"
- 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"
- testingfake "github.com/external-secrets/external-secrets/pkg/provider/testing/fake"
- 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),
- },
- },
- "InvalidRetrySettings": {
- reason: "Should return error if given an invalid Retry Interval.",
- args: args{
- store: makeSecretStore(func(s *esv1beta1.SecretStore) {
- s.Spec.RetrySettings = &esv1beta1.SecretStoreRetrySettings{
- MaxRetries: pointer.To(int32(3)),
- RetryInterval: pointer.To("not-an-interval"),
- }
- }),
- },
- want: want{
- err: errors.New("time: invalid duration \"not-an-interval\""),
- },
- },
- "ValidRetrySettings": {
- reason: "Should return a Vault provider with custom retry settings",
- args: args{
- store: makeSecretStore(func(s *esv1beta1.SecretStore) {
- s.Spec.RetrySettings = &esv1beta1.SecretStoreRetrySettings{
- MaxRetries: pointer.To(int32(3)),
- RetryInterval: pointer.To("10m"),
- }
- }),
- ns: "default",
- kube: clientfake.NewClientBuilder().Build(),
- corev1: utilfake.NewCreateTokenMock().WithToken("ok"),
- newClientFunc: fake.ClientWithLoginMock,
- },
- want: want{
- err: nil,
- },
- },
- "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", "default", 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",
- Namespace: "default",
- },
- 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",
- Namespace: "default",
- },
- 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"),
- },
- },
- "ClientTlsInvalidCertificatesError": {
- reason: "Should return error if client key is in wrong format.",
- args: args{
- store: makeSecretStore(func(s *esv1beta1.SecretStore) {
- s.Spec.Provider.Vault.ClientTLS = esv1beta1.VaultClientTLS{
- CertSecretRef: &esmeta.SecretKeySelector{
- Name: "tls-auth-certs",
- },
- KeySecretRef: &esmeta.SecretKeySelector{
- Name: "tls-auth-certs",
- },
- }
- }),
- 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(),
- corev1: utilfake.NewCreateTokenMock().WithToken("ok"),
- newClientFunc: fake.ClientWithLoginMock,
- },
- want: want{
- err: fmt.Errorf(errClientTLSAuth, "tls: failed to find any PEM data in key input"),
- },
- },
- "SuccessfulVaultStoreValidClientTls": {
- reason: "Should return a Vault provider with the cert from k8s",
- args: args{
- store: makeSecretStore(func(s *esv1beta1.SecretStore) {
- s.Spec.Provider.Vault.ClientTLS = esv1beta1.VaultClientTLS{
- CertSecretRef: &esmeta.SecretKeySelector{
- Name: "tls-auth-certs",
- },
- KeySecretRef: &esmeta.SecretKeySelector{
- Name: "tls-auth-certs",
- },
- }
- }),
- 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(),
- corev1: utilfake.NewCreateTokenMock().WithToken("ok"),
- newClientFunc: fake.ClientWithLoginMock,
- },
- want: want{
- err: nil,
- },
- },
- }
- 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",
- }
- secretWithSpecialCharacter := map[string]interface{}{
- "access_key": "acc<ess_&ke.,y",
- "access_secret": "acce&?ss_s>ecret",
- }
- 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"),
- },
- },
- },
- "ReadSecretWithSpecialCharactersKV1": {
- 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(secretWithSpecialCharacter, nil),
- },
- },
- want: want{
- err: nil,
- val: map[string][]byte{
- "access_key": []byte("acc<ess_&ke.,y"),
- "access_secret": []byte("acce&?ss_s>ecret"),
- },
- },
- },
- "ReadSecretWithSpecialCharactersKV2": {
- 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": secretWithSpecialCharacter,
- }, nil),
- },
- },
- want: want{
- err: nil,
- val: map[string][]byte{
- "access_key": []byte("acc<ess_&ke.,y"),
- "access_secret": []byte("acce&?ss_s>ecret"),
- },
- },
- },
- "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
- clientTLS esv1beta1.VaultClientTLS
- }
- 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.To("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.To("invalid"),
- },
- },
- },
- },
- wantErr: true,
- },
- {
- name: "invalid cert secret",
- args: args{
- auth: esv1beta1.VaultAuth{
- Cert: &esv1beta1.VaultCertAuth{
- SecretRef: esmeta.SecretKeySelector{
- Namespace: pointer.To("invalid"),
- },
- },
- },
- },
- wantErr: true,
- },
- {
- name: "invalid jwt secret",
- args: args{
- auth: esv1beta1.VaultAuth{
- Jwt: &esv1beta1.VaultJwtAuth{
- SecretRef: &esmeta.SecretKeySelector{
- Namespace: pointer.To("invalid"),
- },
- },
- },
- },
- wantErr: true,
- },
- {
- name: "invalid kubernetes sa",
- args: args{
- auth: esv1beta1.VaultAuth{
- Kubernetes: &esv1beta1.VaultKubernetesAuth{
- ServiceAccountRef: &esmeta.ServiceAccountSelector{
- Namespace: pointer.To("invalid"),
- },
- },
- },
- },
- wantErr: true,
- },
- {
- name: "invalid kubernetes secret",
- args: args{
- auth: esv1beta1.VaultAuth{
- Kubernetes: &esv1beta1.VaultKubernetesAuth{
- SecretRef: &esmeta.SecretKeySelector{
- Namespace: pointer.To("invalid"),
- },
- },
- },
- },
- wantErr: true,
- },
- {
- name: "invalid ldap secret",
- args: args{
- auth: esv1beta1.VaultAuth{
- Ldap: &esv1beta1.VaultLdapAuth{
- SecretRef: esmeta.SecretKeySelector{
- Namespace: pointer.To("invalid"),
- },
- },
- },
- },
- wantErr: true,
- },
- {
- name: "invalid userpass secret",
- args: args{
- auth: esv1beta1.VaultAuth{
- UserPass: &esv1beta1.VaultUserPassAuth{
- SecretRef: esmeta.SecretKeySelector{
- Namespace: pointer.To("invalid"),
- },
- },
- },
- },
- wantErr: true,
- },
- {
- name: "invalid token secret",
- args: args{
- auth: esv1beta1.VaultAuth{
- TokenSecretRef: &esmeta.SecretKeySelector{
- Namespace: pointer.To("invalid"),
- },
- },
- },
- wantErr: true,
- },
- {
- name: "valid clientTls config",
- args: args{
- auth: esv1beta1.VaultAuth{
- AppRole: &esv1beta1.VaultAppRole{
- RoleRef: &esmeta.SecretKeySelector{
- Name: "fake-value",
- },
- },
- },
- clientTLS: esv1beta1.VaultClientTLS{
- CertSecretRef: &esmeta.SecretKeySelector{
- Name: "tls-auth-certs",
- },
- KeySecretRef: &esmeta.SecretKeySelector{
- Name: "tls-auth-certs",
- },
- },
- },
- wantErr: false,
- },
- {
- name: "invalid clientTls config, missing SecretRef",
- args: args{
- auth: esv1beta1.VaultAuth{
- AppRole: &esv1beta1.VaultAppRole{
- RoleRef: &esmeta.SecretKeySelector{
- Name: "fake-value",
- },
- },
- },
- clientTLS: esv1beta1.VaultClientTLS{
- CertSecretRef: &esmeta.SecretKeySelector{
- Name: "tls-auth-certs",
- },
- },
- },
- wantErr: true,
- },
- {
- name: "invalid clientTls config, missing ClientCert",
- args: args{
- auth: esv1beta1.VaultAuth{
- AppRole: &esv1beta1.VaultAppRole{
- RoleRef: &esmeta.SecretKeySelector{
- Name: "fake-value",
- },
- },
- },
- clientTLS: esv1beta1.VaultClientTLS{
- KeySecretRef: &esmeta.SecretKeySelector{
- Name: "tls-auth-certs",
- },
- },
- },
- 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,
- ClientTLS: tt.args.clientTLS,
- },
- },
- },
- }
- if err := c.ValidateStore(store); (err != nil) != tt.wantErr {
- t.Errorf("connector.ValidateStore() error = %v, wantErr %v", err, tt.wantErr)
- }
- })
- }
- }
- 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 *testingfake.PushSecretData
- want want
- value []byte
- }{
- "DeleteSecretNoOpKV1": {
- reason: "No secret is because it does not exist",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(nil, nil),
- WriteWithContextFn: fake.ExpectWriteWithContextNoCall(),
- DeleteWithContextFn: fake.ExpectDeleteWithContextNoCall(),
- },
- },
- want: want{
- err: nil,
- },
- },
- "DeleteSecretNoOpKV2": {
- 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,
- },
- },
- "DeleteSecretFailIfErrorKV1": {
- reason: "No secret is because it does not exist",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).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"),
- },
- },
- "DeleteSecretFailIfErrorKV2": {
- 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"),
- },
- },
- "DeleteSecretNotManagedKV1": {
- reason: "No secret is because it does not exist",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(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,
- },
- },
- "DeleteSecretNotManagedKV2": {
- 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,
- },
- },
- "DeleteSecretSuccessKV1": {
- reason: "No secret is because it does not exist",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(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,
- },
- },
- "DeleteSecretSuccessKV2": {
- 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,
- },
- },
- "DeleteSecretErrorKV1": {
- reason: "No secret is because it does not exist",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(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"),
- },
- },
- "DeleteSecretErrorKV2": {
- 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"),
- },
- },
- "DeleteSecretUpdatePropertyKV1": {
- reason: "Secret should only be updated if Property is set",
- ref: &testingfake.PushSecretData{RemoteKey: "secret", Property: "fake-key"},
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(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{}{
- "foo": "bar",
- "custom_metadata": map[string]interface{}{
- "managed-by": "external-secrets",
- }}),
- DeleteWithContextFn: fake.ExpectDeleteWithContextNoCall(),
- },
- },
- want: want{
- err: nil,
- },
- },
- "DeleteSecretUpdatePropertyKV2": {
- reason: "Secret should only be updated if Property is set",
- ref: &testingfake.PushSecretData{RemoteKey: "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,
- },
- },
- "DeleteSecretIfNoOtherPropertiesKV1": {
- reason: "Secret should only be deleted if no other properties are set",
- ref: &testingfake.PushSecretData{RemoteKey: "secret", Property: "foo"},
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(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,
- },
- },
- "DeleteSecretIfNoOtherPropertiesKV2": {
- reason: "Secret should only be deleted if no other properties are set",
- ref: &testingfake.PushSecretData{RemoteKey: "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 := testingfake.PushSecretData{RemoteKey: "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 TestPushSecret(t *testing.T) {
- secretKey := "secret-key"
- 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
- data *testingfake.PushSecretData
- value []byte
- }{
- "SetSecretKV1": {
- reason: "secret is successfully set, with no existing vault secret",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(nil, nil),
- WriteWithContextFn: fake.NewWriteWithContextFn(nil, nil),
- },
- },
- want: want{
- err: nil,
- },
- },
- "SetSecretKV2": {
- 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,
- },
- },
- "SetSecretWithWriteErrorKV1": {
- reason: "secret cannot be pushed if write fails",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(nil, nil),
- WriteWithContextFn: fake.NewWriteWithContextFn(nil, noPermission),
- },
- },
- want: want{
- err: noPermission,
- },
- },
- "SetSecretWithWriteErrorKV2": {
- 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,
- },
- },
- "SetSecretEqualsPushSecretV1": {
- reason: "vault secret kv equals secret to push kv",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
- "fake-key": "fake-value",
- "custom_metadata": map[string]interface{}{
- "managed-by": "external-secrets",
- },
- }, nil),
- },
- },
- want: want{
- err: nil,
- },
- },
- "SetSecretEqualsPushSecretV2": {
- 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,
- },
- },
- "PushSecretPropertyKV1": {
- reason: "push secret with property adds the property",
- value: []byte("fake-value"),
- data: &testingfake.PushSecretData{SecretKey: secretKey, RemoteKey: "secret", Property: "foo"},
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
- "fake-key": "fake-value",
- "custom_metadata": map[string]interface{}{
- "managed-by": "external-secrets",
- },
- }, nil),
- WriteWithContextFn: fake.ExpectWriteWithContextValue(map[string]interface{}{
- "fake-key": "fake-value",
- "custom_metadata": map[string]string{
- "managed-by": "external-secrets",
- },
- "foo": "fake-value",
- }),
- },
- },
- want: want{
- err: nil,
- },
- },
- "PushSecretPropertyKV2": {
- reason: "push secret with property adds the property",
- value: []byte("fake-value"),
- data: &testingfake.PushSecretData{SecretKey: secretKey, RemoteKey: "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,
- },
- },
- "PushSecretUpdatePropertyKV1": {
- reason: "push secret with property only updates the property",
- value: []byte("new-value"),
- data: &testingfake.PushSecretData{SecretKey: secretKey, RemoteKey: "secret", Property: "foo"},
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
- "foo": "fake-value",
- "custom_metadata": map[string]interface{}{
- "managed-by": "external-secrets",
- },
- }, nil),
- WriteWithContextFn: fake.ExpectWriteWithContextValue(map[string]interface{}{
- "foo": "new-value",
- "custom_metadata": map[string]string{
- "managed-by": "external-secrets",
- },
- }),
- },
- },
- want: want{
- err: nil,
- },
- },
- "PushSecretUpdatePropertyKV2": {
- reason: "push secret with property only updates the property",
- value: []byte("new-value"),
- data: &testingfake.PushSecretData{SecretKey: secretKey, RemoteKey: "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,
- },
- },
- "PushSecretPropertyNoUpdateKV1": {
- reason: "push secret with property only updates the property",
- value: []byte("fake-value"),
- data: &testingfake.PushSecretData{SecretKey: secretKey, RemoteKey: "secret", Property: "foo"},
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(map[string]interface{}{
- "foo": "fake-value",
- "custom_metadata": map[string]interface{}{
- "managed-by": "external-secrets",
- },
- }, nil),
- WriteWithContextFn: fake.ExpectWriteWithContextNoCall(),
- },
- },
- want: want{
- err: nil,
- },
- },
- "PushSecretPropertyNoUpdateKV2": {
- reason: "push secret with property only updates the property",
- value: []byte("fake-value"),
- data: &testingfake.PushSecretData{SecretKey: secretKey, RemoteKey: "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,
- },
- },
- "SetSecretErrorReadingSecretKV1": {
- reason: "error occurs if secret cannot be read",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(nil, noPermission),
- },
- },
- want: want{
- err: fmt.Errorf(errReadSecret, noPermission),
- },
- },
- "SetSecretErrorReadingSecretKV2": {
- 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),
- },
- },
- "SetSecretNotManagedByESOV1": {
- reason: "a secret not managed by ESO cannot be updated",
- args: args{
- store: makeValidSecretStoreWithVersion(esv1beta1.VaultKVStoreV1).Spec.Provider.Vault,
- vLogical: &fake.Logical{
- ReadWithDataWithContextFn: fake.NewReadWithContextFn(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"),
- },
- },
- "SetSecretNotManagedByESOV2": {
- 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) {
- data := testingfake.PushSecretData{SecretKey: secretKey, RemoteKey: "secret", Property: ""}
- if tc.data != nil {
- data = *tc.data
- }
- client := &client{
- logical: tc.args.vLogical,
- store: tc.args.store,
- }
- val := tc.value
- if val == nil {
- val = []byte(`{"fake-key":"fake-value"}`)
- }
- s := &corev1.Secret{Data: map[string][]byte{secretKey: val}}
- err := client.PushSecret(context.Background(), s, data)
- // 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()
- })
- }
|