| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565 |
- /*
- Copyright © 2025 ESO Maintainer Team
- Licensed under the Apache License, Version 2.0 (the "License");
- you may not use this file except in compliance with the License.
- You may obtain a copy of the License at
- https://www.apache.org/licenses/LICENSE-2.0
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
- */
- package onepassword
- import (
- "context"
- "encoding/json"
- "errors"
- "fmt"
- "reflect"
- "testing"
- "github.com/1Password/connect-sdk-go/onepassword"
- corev1 "k8s.io/api/core/v1"
- apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
- metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
- pointer "k8s.io/utils/ptr"
- esv1 "github.com/external-secrets/external-secrets/apis/externalsecrets/v1"
- esmeta "github.com/external-secrets/external-secrets/apis/meta/v1"
- "github.com/external-secrets/external-secrets/pkg/provider/onepassword/fake"
- "github.com/external-secrets/external-secrets/pkg/utils/metadata"
- )
- const (
- // vaults and items.
- myVault, myVaultID, myVaultUUID = "my-vault", "my-vault-id", "39c31136-d086-47e9-a52c-8fe330d2669a"
- myItem, myItemID, myItemUUID = "my-item", "my-item-id", "687adbe7-e6d2-4059-9a62-dbb95d291143"
- mySharedVault, mySharedVaultID = "my-shared-vault", "my-shared-vault-id"
- mySharedItem, mySharedItemID = "my-shared-item", "my-shared-item-id"
- myOtherVault, myOtherVaultID = "my-other-vault", "my-other-vault-id"
- myOtherItem, myOtherItemID = "my-other-item", "my-other-item-id"
- myNonMatchingVault, myNonMatchingVaultID = "my-non-matching-vault", "my-non-matching-vault-id"
- myNonMatchingItem, myNonMatchingItemID = "my-non-matching-item", "my-non-matching-item-id"
- // fields and files.
- key1, key2, key3, key4 = "key1", "key2", "key3", "key4"
- value1, value2, value3, value4 = "value1", "value2", "value3", "value4"
- sharedKey1, sharedValue1 = "sharedkey1", "sharedvalue1"
- otherKey1 = "otherkey1"
- filePNG, filePNGID = "file.png", "file-id"
- myFilePNG, myFilePNGID, myContents = "my-file.png", "my-file-id", "my-contents"
- mySecondFileTXT, mySecondFileTXTID = "my-second-file.txt", "my-second-file-id"
- mySecondContents = "my-second-contents"
- myFile2PNG, myFile2TXT = "my-file-2.png", "my-file-2.txt"
- myFile2ID, myContents2 = "my-file-2-id", "my-contents-2"
- myOtherFilePNG, myOtherFilePNGID = "my-other-file.png", "my-other-file-id"
- myOtherContents = "my-other-contents"
- nonMatchingFilePNG, nonMatchingFilePNGID = "non-matching-file.png", "non-matching-file-id"
- nonMatchingContents = "non-matching-contents"
- // other.
- mySecret, token, password = "my-secret", "token", "password"
- one, two, three = "one", "two", "three"
- connectHost = "https://example.com"
- setupCheckFormat = "Setup: '%s', Check: '%s'"
- getSecretMapErrFormat = "%s: onepassword.GetSecretMap(...): -expected, +got:\n-%#v\n+%#v\n"
- getSecretErrFormat = "%s: onepassword.GetSecret(...): -expected, +got:\n-%#v\n+%#v\n"
- getAllSecretsErrFormat = "%s: onepassword.GetAllSecrets(...): -expected, +got:\n-%#v\n+%#v\n"
- validateStoreErrFormat = "%s: onepassword.validateStore(...): -expected, +got:\n-%#v\n+%#v\n"
- findItemErrFormat = "%s: onepassword.findItem(...): -expected, +got:\n-%#v\n+%#v\n"
- errFromErrMsgF = "%w: %s"
- errDoesNotMatchMsgF = "%s: error did not match: -expected, +got:\\n-%#v\\n+%#v\\n"
- )
- func TestFindItem(t *testing.T) {
- type check struct {
- checkNote string
- findItemName string
- expectedItem *onepassword.Item
- expectedErr error
- }
- type testCase struct {
- setupNote string
- provider *ProviderOnePassword
- checks []check
- }
- testCases := []testCase{
- {
- setupNote: "valid basic: one vault, one item, one field",
- provider: &ProviderOnePassword{
- vaults: map[string]int{myVault: 1},
- client: fake.NewMockClient().
- AddPredictableVault(myVault).
- AddPredictableItemWithField(myVault, myItem, key1, value1),
- },
- checks: []check{
- {
- checkNote: "pass",
- findItemName: myItem,
- expectedErr: nil,
- expectedItem: &onepassword.Item{
- ID: myItemID,
- Title: myItem,
- Vault: onepassword.ItemVault{ID: myVaultID},
- Fields: []*onepassword.ItemField{
- {
- Label: key1,
- Value: value1,
- },
- },
- },
- },
- },
- },
- {
- setupNote: "uuid: valid basic: one vault, one item, one field",
- provider: &ProviderOnePassword{
- vaults: map[string]int{myVaultUUID: 1},
- client: fake.NewMockClient().
- AddPredictableVaultUUID(myVaultUUID).
- AddPredictableItemWithFieldUUID(myVaultUUID, myItemUUID, key1, value1),
- },
- checks: []check{
- {
- checkNote: "pass",
- findItemName: myItemUUID,
- expectedErr: nil,
- expectedItem: &onepassword.Item{
- ID: myItemUUID,
- Title: myItemUUID,
- Vault: onepassword.ItemVault{ID: myVaultUUID},
- Fields: []*onepassword.ItemField{
- {
- Label: key1,
- Value: value1,
- },
- },
- },
- },
- },
- },
- {
- setupNote: "multiple vaults, multiple items",
- provider: &ProviderOnePassword{
- vaults: map[string]int{myVault: 1, mySharedVault: 2},
- client: fake.NewMockClient().
- AddPredictableVault(myVault).
- AddPredictableItemWithField(myVault, myItem, key1, value1).
- AddPredictableVault(mySharedVault).
- AddPredictableItemWithField(mySharedVault, mySharedItem, sharedKey1, sharedValue1),
- },
- checks: []check{
- {
- checkNote: "can still get myItem",
- findItemName: myItem,
- expectedErr: nil,
- expectedItem: &onepassword.Item{
- ID: myItemID,
- Title: myItem,
- Vault: onepassword.ItemVault{ID: myVaultID},
- Fields: []*onepassword.ItemField{
- {
- Label: key1,
- Value: value1,
- },
- },
- },
- },
- {
- checkNote: "can also get mySharedItem",
- findItemName: mySharedItem,
- expectedErr: nil,
- expectedItem: &onepassword.Item{
- ID: mySharedItemID,
- Title: mySharedItem,
- Vault: onepassword.ItemVault{ID: mySharedVaultID},
- Fields: []*onepassword.ItemField{
- {
- Label: sharedKey1,
- Value: sharedValue1,
- },
- },
- },
- },
- },
- },
- {
- setupNote: "multiple vault matches when should be one",
- provider: &ProviderOnePassword{
- vaults: map[string]int{myVault: 1, mySharedVault: 2},
- client: fake.NewMockClient().
- AppendVault(myVault, onepassword.Vault{
- ID: myVaultID,
- Name: myVault,
- }).
- AppendVault(myVault, onepassword.Vault{
- ID: "my-vault-extra-match-id",
- Name: "my-vault-extra-match",
- }),
- },
- checks: []check{
- {
- checkNote: "two vaults",
- findItemName: myItem,
- expectedErr: errors.New("key not found in 1Password Vaults: my-item in: map[my-shared-vault:2 my-vault:1]"),
- },
- },
- },
- {
- setupNote: "no item matches when should be one",
- provider: &ProviderOnePassword{
- vaults: map[string]int{myVault: 1},
- client: fake.NewMockClient().
- AddPredictableVault(myVault),
- },
- checks: []check{
- {
- checkNote: "no exist",
- findItemName: "my-item-no-exist",
- expectedErr: fmt.Errorf("%w: my-item-no-exist in: map[my-vault:1]", ErrKeyNotFound),
- },
- },
- },
- {
- setupNote: "multiple item matches when should be one",
- provider: &ProviderOnePassword{
- vaults: map[string]int{myVault: 1},
- client: fake.NewMockClient().
- AddPredictableVault(myVault).
- AddPredictableItemWithField(myVault, myItem, key1, value1).
- AppendItem(myVaultID, onepassword.Item{
- ID: "asdf",
- Title: myItem,
- Vault: onepassword.ItemVault{ID: myVaultID},
- }),
- },
- checks: []check{
- {
- checkNote: "multiple match",
- findItemName: myItem,
- expectedErr: fmt.Errorf(errFromErrMsgF, ErrExpectedOneItem, "'my-item', got 2"),
- },
- },
- },
- {
- setupNote: "ordered vaults",
- provider: &ProviderOnePassword{
- vaults: map[string]int{myVault: 1, mySharedVault: 2, myOtherVault: 3},
- client: fake.NewMockClient().
- AddPredictableVault(myVault).
- AddPredictableVault(mySharedVault).
- AddPredictableVault(myOtherVault).
- // // my-item
- // returned: my-item in my-vault
- AddPredictableItemWithField(myVault, myItem, key1, value1).
- // preempted: my-item in my-shared-vault
- AppendItem(mySharedVaultID, onepassword.Item{
- ID: myItemID,
- Title: myItem,
- Vault: onepassword.ItemVault{ID: mySharedVaultID},
- }).
- AppendItemField(mySharedVaultID, myItemID, onepassword.ItemField{
- Label: key1,
- Value: "value1-from-my-shared-vault",
- }).
- // preempted: my-item in my-other-vault
- AppendItem(myOtherVaultID, onepassword.Item{
- ID: myItemID,
- Title: myItem,
- Vault: onepassword.ItemVault{ID: myOtherVaultID},
- }).
- AppendItemField(myOtherVaultID, myItemID, onepassword.ItemField{
- Label: key1,
- Value: "value1-from-my-other-vault",
- }).
- // // my-shared-item
- // returned: my-shared-item in my-shared-vault
- AddPredictableItemWithField(mySharedVault, mySharedItem, sharedKey1, "sharedvalue1-from-my-shared-vault").
- // preempted: my-shared-item in my-other-vault
- AppendItem(myOtherVaultID, onepassword.Item{
- ID: mySharedItemID,
- Title: mySharedItem,
- Vault: onepassword.ItemVault{ID: myOtherVaultID},
- }).
- AppendItemField(myOtherVaultID, mySharedItemID, onepassword.ItemField{
- Label: sharedKey1,
- Value: "sharedvalue1-from-my-other-vault",
- }).
- // // my-other-item
- // returned: my-other-item in my-other-vault
- AddPredictableItemWithField(myOtherVault, myOtherItem, otherKey1, "othervalue1-from-my-other-vault"),
- },
- checks: []check{
- {
- // my-item in all three vaults, gets the one from my-vault
- checkNote: "gets item from my-vault",
- findItemName: myItem,
- expectedErr: nil,
- expectedItem: &onepassword.Item{
- ID: myItemID,
- Title: myItem,
- Vault: onepassword.ItemVault{ID: myVaultID},
- Fields: []*onepassword.ItemField{
- {
- Label: key1,
- Value: value1,
- },
- },
- },
- },
- {
- // my-shared-item in my-shared-vault and my-other-vault, gets the one from my-shared-vault
- checkNote: "gets item from my-shared-vault",
- findItemName: mySharedItem,
- expectedErr: nil,
- expectedItem: &onepassword.Item{
- ID: mySharedItemID,
- Title: mySharedItem,
- Vault: onepassword.ItemVault{ID: mySharedVaultID},
- Fields: []*onepassword.ItemField{
- {
- Label: sharedKey1,
- Value: "sharedvalue1-from-my-shared-vault",
- },
- },
- },
- },
- {
- // my-other-item in my-other-vault
- checkNote: "gets item from my-other-vault",
- findItemName: myOtherItem,
- expectedErr: nil,
- expectedItem: &onepassword.Item{
- ID: myOtherItemID,
- Title: myOtherItem,
- Vault: onepassword.ItemVault{ID: myOtherVaultID},
- Fields: []*onepassword.ItemField{
- {
- Label: otherKey1,
- Value: "othervalue1-from-my-other-vault",
- },
- },
- },
- },
- },
- },
- }
- // run the tests
- for num, tc := range testCases {
- t.Run(fmt.Sprintf("test-%d", num), func(t *testing.T) {
- for _, check := range tc.checks {
- got, err := tc.provider.findItem(check.findItemName)
- notes := fmt.Sprintf(setupCheckFormat, tc.setupNote, check.checkNote)
- if check.expectedErr == nil && err != nil {
- // expected no error, got one
- t.Errorf(findItemErrFormat, notes, nil, err)
- }
- if check.expectedErr != nil && err == nil {
- // expected an error, didn't get one
- t.Errorf(findItemErrFormat, notes, check.expectedErr.Error(), nil)
- }
- if check.expectedErr != nil && err != nil && err.Error() != check.expectedErr.Error() {
- // expected an error, got the wrong one
- t.Errorf(findItemErrFormat, notes, check.expectedErr.Error(), err.Error())
- }
- if check.expectedItem != nil {
- if !reflect.DeepEqual(check.expectedItem, got) {
- // expected a predefined item, got something else
- t.Errorf(findItemErrFormat, notes, check.expectedItem, got)
- }
- }
- }
- })
- }
- }
- func TestValidateStore(t *testing.T) {
- type testCase struct {
- checkNote string
- store *esv1.SecretStore
- clusterStore *esv1.ClusterSecretStore
- expectedErr error
- }
- testCases := []testCase{
- {
- checkNote: "invalid: nil provider",
- store: &esv1.SecretStore{
- TypeMeta: metav1.TypeMeta{
- Kind: "SecretStore",
- },
- Spec: esv1.SecretStoreSpec{
- Provider: nil,
- },
- },
- expectedErr: fmt.Errorf(errOnePasswordStore, errors.New(errOnePasswordStoreNilSpecProvider)),
- },
- {
- checkNote: "invalid: nil OnePassword provider spec",
- store: &esv1.SecretStore{
- TypeMeta: metav1.TypeMeta{
- Kind: "SecretStore",
- },
- Spec: esv1.SecretStoreSpec{
- Provider: &esv1.SecretStoreProvider{
- OnePassword: nil,
- },
- },
- },
- expectedErr: fmt.Errorf(errOnePasswordStore, errors.New(errOnePasswordStoreNilSpecProviderOnePassword)),
- },
- {
- checkNote: "valid secretStore",
- store: &esv1.SecretStore{
- TypeMeta: metav1.TypeMeta{
- Kind: "SecretStore",
- },
- Spec: esv1.SecretStoreSpec{
- Provider: &esv1.SecretStoreProvider{
- OnePassword: &esv1.OnePasswordProvider{
- Auth: &esv1.OnePasswordAuth{
- SecretRef: &esv1.OnePasswordAuthSecretRef{
- ConnectToken: esmeta.SecretKeySelector{
- Name: mySecret,
- Key: token,
- },
- },
- },
- ConnectHost: connectHost,
- Vaults: map[string]int{
- myVault: 1,
- },
- },
- },
- },
- },
- expectedErr: nil,
- },
- {
- checkNote: "invalid: illegal namespace on SecretStore",
- store: &esv1.SecretStore{
- TypeMeta: metav1.TypeMeta{
- Kind: "SecretStore",
- },
- Spec: esv1.SecretStoreSpec{
- Provider: &esv1.SecretStoreProvider{
- OnePassword: &esv1.OnePasswordProvider{
- Auth: &esv1.OnePasswordAuth{
- SecretRef: &esv1.OnePasswordAuthSecretRef{
- ConnectToken: esmeta.SecretKeySelector{
- Name: mySecret,
- Namespace: pointer.To("my-namespace"),
- Key: token,
- },
- },
- },
- ConnectHost: connectHost,
- Vaults: map[string]int{
- myVault: 1,
- myOtherVault: 2,
- },
- },
- },
- },
- },
- expectedErr: fmt.Errorf(errOnePasswordStore, errors.New("namespace should either be empty or match the namespace of the SecretStore for a namespaced SecretStore")),
- },
- {
- checkNote: "invalid: more than one vault with the same number",
- store: &esv1.SecretStore{
- TypeMeta: metav1.TypeMeta{
- Kind: "SecretStore",
- },
- Spec: esv1.SecretStoreSpec{
- Provider: &esv1.SecretStoreProvider{
- OnePassword: &esv1.OnePasswordProvider{
- Auth: &esv1.OnePasswordAuth{
- SecretRef: &esv1.OnePasswordAuthSecretRef{
- ConnectToken: esmeta.SecretKeySelector{
- Name: mySecret,
- Key: token,
- },
- },
- },
- ConnectHost: connectHost,
- Vaults: map[string]int{
- myVault: 1,
- myOtherVault: 1,
- },
- },
- },
- },
- },
- expectedErr: fmt.Errorf(errOnePasswordStore, errors.New(errOnePasswordStoreNonUniqueVaultNumbers)),
- },
- {
- checkNote: "valid: clusterSecretStore",
- clusterStore: &esv1.ClusterSecretStore{
- TypeMeta: metav1.TypeMeta{
- Kind: "ClusterSecretStore",
- },
- Spec: esv1.SecretStoreSpec{
- Provider: &esv1.SecretStoreProvider{
- OnePassword: &esv1.OnePasswordProvider{
- Auth: &esv1.OnePasswordAuth{
- SecretRef: &esv1.OnePasswordAuthSecretRef{
- ConnectToken: esmeta.SecretKeySelector{
- Name: mySecret,
- Namespace: pointer.To("my-namespace"),
- Key: token,
- },
- },
- },
- ConnectHost: connectHost,
- Vaults: map[string]int{
- myVault: 1,
- },
- },
- },
- },
- },
- expectedErr: nil,
- },
- {
- checkNote: "invalid: clusterSecretStore without namespace",
- clusterStore: &esv1.ClusterSecretStore{
- TypeMeta: metav1.TypeMeta{
- Kind: "ClusterSecretStore",
- },
- Spec: esv1.SecretStoreSpec{
- Provider: &esv1.SecretStoreProvider{
- OnePassword: &esv1.OnePasswordProvider{
- Auth: &esv1.OnePasswordAuth{
- SecretRef: &esv1.OnePasswordAuthSecretRef{
- ConnectToken: esmeta.SecretKeySelector{
- Name: mySecret,
- Key: token,
- },
- },
- },
- ConnectHost: connectHost,
- Vaults: map[string]int{
- myVault: 1,
- myOtherVault: 2,
- },
- },
- },
- },
- },
- expectedErr: fmt.Errorf(errOnePasswordStore, errors.New("cluster scope requires namespace")),
- },
- {
- checkNote: "invalid: missing connectTokenSecretRef.name",
- store: &esv1.SecretStore{
- TypeMeta: metav1.TypeMeta{
- Kind: "SecretStore",
- },
- Spec: esv1.SecretStoreSpec{
- Provider: &esv1.SecretStoreProvider{
- OnePassword: &esv1.OnePasswordProvider{
- Auth: &esv1.OnePasswordAuth{
- SecretRef: &esv1.OnePasswordAuthSecretRef{
- ConnectToken: esmeta.SecretKeySelector{
- Key: token,
- },
- },
- },
- ConnectHost: connectHost,
- Vaults: map[string]int{
- myVault: 1,
- myOtherVault: 2,
- },
- },
- },
- },
- },
- expectedErr: fmt.Errorf(errOnePasswordStore, errors.New(errOnePasswordStoreMissingRefName)),
- },
- {
- checkNote: "invalid: missing connectTokenSecretRef.key",
- store: &esv1.SecretStore{
- TypeMeta: metav1.TypeMeta{
- Kind: "SecretStore",
- },
- Spec: esv1.SecretStoreSpec{
- Provider: &esv1.SecretStoreProvider{
- OnePassword: &esv1.OnePasswordProvider{
- Auth: &esv1.OnePasswordAuth{
- SecretRef: &esv1.OnePasswordAuthSecretRef{
- ConnectToken: esmeta.SecretKeySelector{
- Name: mySecret,
- },
- },
- },
- ConnectHost: connectHost,
- Vaults: map[string]int{
- myVault: 1,
- myOtherVault: 2,
- },
- },
- },
- },
- },
- expectedErr: fmt.Errorf(errOnePasswordStore, errors.New(errOnePasswordStoreMissingRefKey)),
- },
- {
- checkNote: "invalid: at least one vault",
- store: &esv1.SecretStore{
- TypeMeta: metav1.TypeMeta{
- Kind: "SecretStore",
- },
- Spec: esv1.SecretStoreSpec{
- Provider: &esv1.SecretStoreProvider{
- OnePassword: &esv1.OnePasswordProvider{
- Auth: &esv1.OnePasswordAuth{
- SecretRef: &esv1.OnePasswordAuthSecretRef{
- ConnectToken: esmeta.SecretKeySelector{
- Name: mySecret,
- Key: token,
- },
- },
- },
- ConnectHost: connectHost,
- Vaults: map[string]int{},
- },
- },
- },
- },
- expectedErr: fmt.Errorf(errOnePasswordStore, errors.New(errOnePasswordStoreAtLeastOneVault)),
- },
- {
- checkNote: "invalid: url",
- store: &esv1.SecretStore{
- TypeMeta: metav1.TypeMeta{
- Kind: "SecretStore",
- },
- Spec: esv1.SecretStoreSpec{
- Provider: &esv1.SecretStoreProvider{
- OnePassword: &esv1.OnePasswordProvider{
- Auth: &esv1.OnePasswordAuth{
- SecretRef: &esv1.OnePasswordAuthSecretRef{
- ConnectToken: esmeta.SecretKeySelector{
- Name: mySecret,
- Key: token,
- },
- },
- },
- ConnectHost: ":/invalid.invalid",
- Vaults: map[string]int{
- myVault: 1,
- },
- },
- },
- },
- },
- expectedErr: fmt.Errorf(errOnePasswordStore, fmt.Errorf(errOnePasswordStoreInvalidConnectHost, errors.New("parse \":/invalid.invalid\": missing protocol scheme"))),
- },
- }
- // run the tests
- for _, tc := range testCases {
- var err error
- if tc.store == nil {
- err = validateStore(tc.clusterStore)
- } else {
- err = validateStore(tc.store)
- }
- notes := fmt.Sprintf("Check: '%s'", tc.checkNote)
- if tc.expectedErr == nil && err != nil {
- // expected no error, got one
- t.Errorf(validateStoreErrFormat, notes, nil, err)
- }
- if tc.expectedErr != nil && err == nil {
- // expected an error, didn't get one
- t.Errorf(validateStoreErrFormat, notes, tc.expectedErr.Error(), nil)
- }
- if tc.expectedErr != nil && err != nil && err.Error() != tc.expectedErr.Error() {
- // expected an error, got the wrong one
- t.Errorf(validateStoreErrFormat, notes, tc.expectedErr.Error(), err.Error())
- }
- }
- }
- // most functionality is tested in TestFindItem
- //
- // here we just check that an empty Property defaults to "password",
- // files are loaded, and
- // the data or errors are properly returned
- func TestGetSecret(t *testing.T) {
- type check struct {
- checkNote string
- ref esv1.ExternalSecretDataRemoteRef
- expectedValue string
- expectedErr error
- }
- type testCase struct {
- setupNote string
- provider *ProviderOnePassword
- checks []check
- }
- testCases := []testCase{
- {
- setupNote: "one vault, one item, two fields",
- provider: &ProviderOnePassword{
- vaults: map[string]int{myVault: 1},
- client: fake.NewMockClient().
- AddPredictableVault(myVault).
- AppendItem(myVaultID, onepassword.Item{
- ID: myItemID,
- Title: myItem,
- Vault: onepassword.ItemVault{ID: myVaultID},
- Files: []*onepassword.File{
- {
- ID: myFilePNGID,
- Name: myFilePNG,
- },
- },
- }).
- AppendItemField(myVaultID, myItemID, onepassword.ItemField{
- Label: password,
- Value: value2,
- }).
- AppendItemField(myVaultID, myItemID, onepassword.ItemField{
- Label: key1,
- Value: value1,
- }).
- SetFileContents(myFilePNG, []byte(myContents)),
- },
- checks: []check{
- {
- checkNote: key1,
- ref: esv1.ExternalSecretDataRemoteRef{
- Key: myItem,
- Property: key1,
- },
- expectedValue: value1,
- expectedErr: nil,
- },
- {
- checkNote: key1 + " with prefix",
- ref: esv1.ExternalSecretDataRemoteRef{
- Key: myItem,
- Property: fieldPrefix + prefixSplitter + key1,
- },
- expectedValue: value1,
- expectedErr: nil,
- },
- {
- checkNote: "'password' (defaulted property)",
- ref: esv1.ExternalSecretDataRemoteRef{
- Key: myItem,
- },
- expectedValue: value2,
- expectedErr: nil,
- },
- {
- checkNote: "'ref.version' not implemented",
- ref: esv1.ExternalSecretDataRemoteRef{
- Key: myItem,
- Property: key1,
- Version: "123",
- },
- expectedErr: errors.New(errVersionNotImplemented),
- },
- {
- checkNote: "file named my-file.png with prefix",
- ref: esv1.ExternalSecretDataRemoteRef{
- Key: myItem,
- Property: filePrefix + prefixSplitter + myFilePNG,
- },
- expectedValue: myContents,
- expectedErr: nil,
- },
- },
- },
- {
- setupNote: "files are loaded",
- provider: &ProviderOnePassword{
- vaults: map[string]int{myVault: 1},
- client: fake.NewMockClient().
- AddPredictableVault(myVault).
- AppendItem(myVaultID, onepassword.Item{
- ID: myItemID,
- Title: myItem,
- Vault: onepassword.ItemVault{ID: myVaultID},
- Category: documentCategory,
- Files: []*onepassword.File{
- {
- ID: myFilePNGID,
- Name: myFilePNG,
- },
- },
- }).
- AppendItemField(myVaultID, myItemID, onepassword.ItemField{
- Label: key1,
- Value: value2,
- }).
- SetFileContents(myFilePNG, []byte(myContents)),
- },
- checks: []check{
- {
- checkNote: "field named password",
- ref: esv1.ExternalSecretDataRemoteRef{
- Key: myItem,
- Property: fieldPrefix + prefixSplitter + key1,
- },
- expectedValue: value2,
- expectedErr: nil,
- },
- {
- checkNote: "file named my-file.png",
- ref: esv1.ExternalSecretDataRemoteRef{
- Key: myItem,
- Property: myFilePNG,
- },
- expectedValue: myContents,
- expectedErr: nil,
- },
- {
- checkNote: "file named my-file.png with prefix",
- ref: esv1.ExternalSecretDataRemoteRef{
- Key: myItem,
- Property: filePrefix + prefixSplitter + myFilePNG,
- },
- expectedValue: myContents,
- expectedErr: nil,
- },
- {
- checkNote: "empty ref.Property",
- ref: esv1.ExternalSecretDataRemoteRef{
- Key: myItem,
- },
- expectedValue: myContents,
- expectedErr: nil,
- },
- {
- checkNote: "file non existent",
- ref: esv1.ExternalSecretDataRemoteRef{
- Key: myItem,
- Property: "you-cant-find-me.png",
- },
- expectedErr: fmt.Errorf(errDocumentNotFound, errors.New("'my-item', 'you-cant-find-me.png'")),
- },
- {
- checkNote: "file non existent with prefix",
- ref: esv1.ExternalSecretDataRemoteRef{
- Key: myItem,
- Property: "file/you-cant-find-me.png",
- },
- expectedErr: fmt.Errorf(errDocumentNotFound, errors.New("'my-item', 'you-cant-find-me.png'")),
- },
- },
- },
- {
- setupNote: "one vault, one item, two fields w/ same Label",
- provider: &ProviderOnePassword{
- vaults: map[string]int{myVault: 1},
- client: fake.NewMockClient().
- AddPredictableVault(myVault).
- AddPredictableItemWithField(myVault, myItem, key1, value1).
- AppendItemField(myVaultID, myItemID, onepassword.ItemField{
- Label: key1,
- Value: value2,
- }),
- },
- checks: []check{
- {
- checkNote: key1,
- ref: esv1.ExternalSecretDataRemoteRef{
- Key: myItem,
- Property: key1,
- },
- expectedErr: fmt.Errorf(errFromErrMsgF, ErrExpectedOneField, "'key1' in 'my-item', got 2"),
- },
- },
- },
- }
- // run the tests
- for _, tc := range testCases {
- for _, check := range tc.checks {
- got, err := tc.provider.GetSecret(context.Background(), check.ref)
- notes := fmt.Sprintf(setupCheckFormat, tc.setupNote, check.checkNote)
- if check.expectedErr == nil && err != nil {
- // expected no error, got one
- t.Errorf(getSecretErrFormat, notes, nil, err)
- }
- if check.expectedErr != nil && err == nil {
- // expected an error, didn't get one
- t.Errorf(getSecretErrFormat, notes, check.expectedErr.Error(), nil)
- }
- if check.expectedErr != nil && err != nil && err.Error() != check.expectedErr.Error() {
- // expected an error, got the wrong one
- t.Errorf(getSecretErrFormat, notes, check.expectedErr.Error(), err.Error())
- }
- if check.expectedValue != "" {
- if check.expectedValue != string(got) {
- // expected a predefined value, got something else
- t.Errorf(getSecretErrFormat, notes, check.expectedValue, string(got))
- }
- }
- }
- }
- }
- // most functionality is tested in TestFindItem. here we just check:
- //
- // all keys are fetched and the map is compiled correctly,
- // files are loaded, and the data or errors are properly returned.
- func TestGetSecretMap(t *testing.T) {
- type check struct {
- checkNote string
- ref esv1.ExternalSecretDataRemoteRef
- expectedMap map[string][]byte
- expectedErr error
- }
- type testCase struct {
- setupNote string
- provider *ProviderOnePassword
- checks []check
- }
- testCases := []testCase{
- {
- setupNote: "one vault, one item, two fields",
- provider: &ProviderOnePassword{
- vaults: map[string]int{myVault: 1},
- client: fake.NewMockClient().
- AddPredictableVault(myVault).
- AppendItem(myVaultID, onepassword.Item{
- ID: myItemID,
- Title: myItem,
- Vault: onepassword.ItemVault{ID: myVaultID},
- Files: []*onepassword.File{
- {
- ID: myFilePNGID,
- Name: myFilePNG,
- },
- {
- ID: myFile2ID,
- Name: myFile2PNG,
- },
- },
- }).
- AppendItemField(myVaultID, myItemID, onepassword.ItemField{
- Label: key1,
- Value: value1,
- }).
- AppendItemField(myVaultID, myItemID, onepassword.ItemField{
- Label: password,
- Value: value2,
- }).
- SetFileContents(myFilePNG, []byte(myContents)).
- SetFileContents(myFile2PNG, []byte(myContents2)),
- },
- checks: []check{
- {
- checkNote: "all Properties",
- ref: esv1.ExternalSecretDataRemoteRef{
- Key: myItem,
- },
- expectedMap: map[string][]byte{
- key1: []byte(value1),
- password: []byte(value2),
- },
- expectedErr: nil,
- },
- {
- checkNote: "limit by Property",
- ref: esv1.ExternalSecretDataRemoteRef{
- Key: myItem,
- Property: password,
- },
- expectedMap: map[string][]byte{
- password: []byte(value2),
- },
- expectedErr: nil,
- },
- {
- checkNote: "'ref.version' not implemented",
- ref: esv1.ExternalSecretDataRemoteRef{
- Key: myItem,
- Property: key1,
- Version: "123",
- },
- expectedErr: errors.New(errVersionNotImplemented),
- },
- {
- checkNote: "limit by Property with prefix",
- ref: esv1.ExternalSecretDataRemoteRef{
- Key: myItem,
- Property: filePrefix + prefixSplitter + myFilePNG,
- },
- expectedMap: map[string][]byte{
- myFilePNG: []byte(myContents),
- },
- expectedErr: nil,
- },
- },
- },
- {
- setupNote: "files",
- provider: &ProviderOnePassword{
- vaults: map[string]int{myVault: 1},
- client: fake.NewMockClient().
- AddPredictableVault(myVault).
- AppendItem(myVaultID, onepassword.Item{
- ID: myItemID,
- Title: myItem,
- Vault: onepassword.ItemVault{ID: myVaultID},
- Category: documentCategory,
- Files: []*onepassword.File{
- {
- ID: myFilePNGID,
- Name: myFilePNG,
- },
- {
- ID: myFile2ID,
- Name: myFile2PNG,
- },
- },
- }).
- AppendItemField(myVaultID, myItemID, onepassword.ItemField{
- Label: key1,
- Value: value2,
- }).
- SetFileContents(myFilePNG, []byte(myContents)).
- SetFileContents(myFile2PNG, []byte(myContents2)),
- },
- checks: []check{
- {
- checkNote: "all Properties",
- ref: esv1.ExternalSecretDataRemoteRef{
- Key: myItem,
- },
- expectedMap: map[string][]byte{
- myFilePNG: []byte(myContents),
- myFile2PNG: []byte(myContents2),
- },
- expectedErr: nil,
- },
- {
- checkNote: "limit by Property",
- ref: esv1.ExternalSecretDataRemoteRef{
- Key: myItem,
- Property: myFilePNG,
- },
- expectedMap: map[string][]byte{
- myFilePNG: []byte(myContents),
- },
- expectedErr: nil,
- },
- {
- checkNote: "limit by Property with prefix",
- ref: esv1.ExternalSecretDataRemoteRef{
- Key: myItem,
- Property: filePrefix + prefixSplitter + myFilePNG,
- },
- expectedMap: map[string][]byte{
- myFilePNG: []byte(myContents),
- },
- expectedErr: nil,
- },
- {
- checkNote: "get field limit by Property",
- ref: esv1.ExternalSecretDataRemoteRef{
- Key: myItem,
- Property: fieldPrefix + prefixSplitter + key1,
- },
- expectedMap: map[string][]byte{
- key1: []byte(value2),
- },
- expectedErr: nil,
- },
- },
- },
- {
- setupNote: "one vault, one item, two fields w/ same Label",
- provider: &ProviderOnePassword{
- vaults: map[string]int{myVault: 1},
- client: fake.NewMockClient().
- AddPredictableVault(myVault).
- AddPredictableItemWithField(myVault, myItem, key1, value1).
- AppendItemField(myVaultID, myItemID, onepassword.ItemField{
- Label: key1,
- Value: value2,
- }),
- },
- checks: []check{
- {
- checkNote: key1,
- ref: esv1.ExternalSecretDataRemoteRef{
- Key: myItem,
- },
- expectedMap: nil,
- expectedErr: fmt.Errorf(errFromErrMsgF, ErrExpectedOneField, "'key1' in 'my-item', got 2"),
- },
- },
- },
- }
- // run the tests
- for _, tc := range testCases {
- for _, check := range tc.checks {
- gotMap, err := tc.provider.GetSecretMap(context.Background(), check.ref)
- notes := fmt.Sprintf(setupCheckFormat, tc.setupNote, check.checkNote)
- if check.expectedErr == nil && err != nil {
- // expected no error, got one
- t.Errorf(getSecretMapErrFormat, notes, nil, err)
- }
- if check.expectedErr != nil && err == nil {
- // expected an error, didn't get one
- t.Errorf(getSecretMapErrFormat, notes, check.expectedErr.Error(), nil)
- }
- if check.expectedErr != nil && err != nil && err.Error() != check.expectedErr.Error() {
- // expected an error, got the wrong one
- t.Errorf(getSecretMapErrFormat, notes, check.expectedErr.Error(), err.Error())
- }
- if !reflect.DeepEqual(check.expectedMap, gotMap) {
- // expected a predefined map, got something else
- t.Errorf(getSecretMapErrFormat, notes, check.expectedMap, gotMap)
- }
- }
- }
- }
- func TestGetAllSecrets(t *testing.T) {
- type check struct {
- checkNote string
- ref esv1.ExternalSecretFind
- expectedMap map[string][]byte
- expectedErr error
- }
- type testCase struct {
- setupNote string
- provider *ProviderOnePassword
- checks []check
- }
- testCases := []testCase{
- {
- setupNote: "three vaults, three items, all different field Labels",
- provider: &ProviderOnePassword{
- vaults: map[string]int{myVault: 1, myOtherVault: 2, myNonMatchingVault: 3},
- client: fake.NewMockClient().
- AddPredictableVault(myVault).
- AddPredictableItemWithField(myVault, myItem, key1, value1).
- AppendItemField(myVaultID, myItemID, onepassword.ItemField{
- Label: key2,
- Value: value2,
- }).
- AddPredictableVault(myOtherVault).
- AddPredictableItemWithField(myOtherVault, myOtherItem, key3, value3).
- AppendItemField(myOtherVaultID, myOtherItemID, onepassword.ItemField{
- Label: key4,
- Value: value4,
- }).
- AddPredictableVault(myNonMatchingVault).
- AddPredictableItemWithField(myNonMatchingVault, myNonMatchingItem, "non-matching5", "value5").
- AppendItemField(myNonMatchingVaultID, myNonMatchingItemID, onepassword.ItemField{
- Label: "non-matching6",
- Value: "value6",
- }),
- },
- checks: []check{
- {
- checkNote: "find some with path only",
- ref: esv1.ExternalSecretFind{
- Path: pointer.To(myItem),
- },
- expectedMap: map[string][]byte{
- key1: []byte(value1),
- key2: []byte(value2),
- },
- expectedErr: nil,
- },
- {
- checkNote: "find most with regex 'key*'",
- ref: esv1.ExternalSecretFind{
- Name: &esv1.FindName{
- RegExp: "key*",
- },
- },
- expectedMap: map[string][]byte{
- key1: []byte(value1),
- key2: []byte(value2),
- key3: []byte(value3),
- key4: []byte(value4),
- },
- expectedErr: nil,
- },
- {
- checkNote: "find some with regex 'key*' and path 'my-other-item'",
- ref: esv1.ExternalSecretFind{
- Name: &esv1.FindName{
- RegExp: "key*",
- },
- Path: pointer.To(myOtherItem),
- },
- expectedMap: map[string][]byte{
- key3: []byte(value3),
- key4: []byte(value4),
- },
- expectedErr: nil,
- },
- {
- checkNote: "find none with regex 'asdf*'",
- ref: esv1.ExternalSecretFind{
- Name: &esv1.FindName{
- RegExp: "asdf*",
- },
- },
- expectedMap: map[string][]byte{},
- expectedErr: nil,
- },
- {
- checkNote: "find none with path 'no-exist'",
- ref: esv1.ExternalSecretFind{
- Name: &esv1.FindName{
- RegExp: "key*",
- },
- Path: pointer.To("no-exist"),
- },
- expectedMap: map[string][]byte{},
- expectedErr: nil,
- },
- },
- },
- {
- setupNote: "one vault, three items, find by tags",
- provider: &ProviderOnePassword{
- vaults: map[string]int{myVault: 1},
- client: fake.NewMockClient().
- AddPredictableVault(myVault).
- AppendItem(myVaultID, onepassword.Item{
- ID: myItemID,
- Title: myItem,
- Tags: []string{"foo", "bar"},
- Vault: onepassword.ItemVault{ID: myVaultID},
- }).
- AppendItemField(myVaultID, myItemID, onepassword.ItemField{
- Label: key1,
- Value: value1,
- }).
- AppendItemField(myVaultID, myItemID, onepassword.ItemField{
- Label: key2,
- Value: value2,
- }).
- AppendItem(myVaultID, onepassword.Item{
- ID: "my-item-id-2",
- Title: "my-item-2",
- Vault: onepassword.ItemVault{ID: myVaultID},
- Tags: []string{"foo", "baz"},
- }).
- AppendItemField(myVaultID, "my-item-id-2", onepassword.ItemField{
- Label: key3,
- Value: value3,
- }).
- AppendItem(myVaultID, onepassword.Item{
- ID: "my-item-id-3",
- Title: "my-item-3",
- Vault: onepassword.ItemVault{ID: myVaultID},
- Tags: []string{"bang", "bing"},
- }).
- AppendItemField(myVaultID, "my-item-id-3", onepassword.ItemField{
- Label: key4,
- Value: value4,
- }),
- },
- checks: []check{
- {
- checkNote: "find with tags",
- ref: esv1.ExternalSecretFind{
- Path: pointer.To(myItem),
- Tags: map[string]string{
- "foo": "true",
- "bar": "true",
- },
- },
- expectedMap: map[string][]byte{
- key1: []byte(value1),
- key2: []byte(value2),
- },
- expectedErr: nil,
- },
- {
- checkNote: "find with tags and get all",
- ref: esv1.ExternalSecretFind{
- Path: pointer.To(myItem),
- Tags: map[string]string{
- "foo": "true",
- },
- },
- expectedMap: map[string][]byte{
- key1: []byte(value1),
- key2: []byte(value2),
- key3: []byte(value3),
- },
- expectedErr: nil,
- },
- },
- },
- {
- setupNote: "3 vaults, 4 items, 5 files",
- provider: &ProviderOnePassword{
- vaults: map[string]int{myVault: 1, myOtherVault: 2, myNonMatchingVault: 3},
- client: fake.NewMockClient().
- // my-vault
- AddPredictableVault(myVault).
- AppendItem(myVaultID, onepassword.Item{
- ID: myItemID,
- Title: myItem,
- Vault: onepassword.ItemVault{ID: myVaultID},
- Category: documentCategory,
- Files: []*onepassword.File{
- {
- ID: myFilePNGID,
- Name: myFilePNG,
- },
- {
- ID: mySecondFileTXTID,
- Name: mySecondFileTXT,
- },
- },
- }).
- SetFileContents(myFilePNG, []byte(myContents)).
- SetFileContents(mySecondFileTXT, []byte(mySecondContents)).
- AppendItem(myVaultID, onepassword.Item{
- ID: "my-item-2-id",
- Title: "my-item-2",
- Vault: onepassword.ItemVault{ID: myVaultID},
- Category: documentCategory,
- Files: []*onepassword.File{
- {
- ID: myFile2ID,
- Name: myFile2TXT,
- },
- },
- }).
- SetFileContents(myFile2TXT, []byte(myContents2)).
- // my-other-vault
- AddPredictableVault(myOtherVault).
- AppendItem(myOtherVaultID, onepassword.Item{
- ID: myOtherItemID,
- Title: myOtherItem,
- Vault: onepassword.ItemVault{ID: myOtherVaultID},
- Category: documentCategory,
- Files: []*onepassword.File{
- {
- ID: myOtherFilePNGID,
- Name: myOtherFilePNG,
- },
- },
- }).
- SetFileContents(myOtherFilePNG, []byte(myOtherContents)).
- // my-non-matching-vault
- AddPredictableVault(myNonMatchingVault).
- AppendItem(myNonMatchingVaultID, onepassword.Item{
- ID: myNonMatchingItemID,
- Title: myNonMatchingItem,
- Vault: onepassword.ItemVault{ID: myNonMatchingVaultID},
- Category: documentCategory,
- Files: []*onepassword.File{
- {
- ID: nonMatchingFilePNGID,
- Name: nonMatchingFilePNG,
- },
- },
- }).
- SetFileContents(nonMatchingFilePNG, []byte(nonMatchingContents)),
- },
- checks: []check{
- {
- checkNote: "find most with regex '^my-*'",
- ref: esv1.ExternalSecretFind{
- Name: &esv1.FindName{
- RegExp: "^my-*",
- },
- },
- expectedMap: map[string][]byte{
- myFilePNG: []byte(myContents),
- mySecondFileTXT: []byte(mySecondContents),
- myFile2TXT: []byte(myContents2),
- myOtherFilePNG: []byte(myOtherContents),
- },
- expectedErr: nil,
- },
- {
- checkNote: "find some with regex '^my-*' and path 'my-other-item'",
- ref: esv1.ExternalSecretFind{
- Name: &esv1.FindName{
- RegExp: "^my-*",
- },
- Path: pointer.To(myOtherItem),
- },
- expectedMap: map[string][]byte{
- myOtherFilePNG: []byte(myOtherContents),
- },
- expectedErr: nil,
- },
- {
- checkNote: "find none with regex '^asdf*'",
- ref: esv1.ExternalSecretFind{
- Name: &esv1.FindName{
- RegExp: "^asdf*",
- },
- },
- expectedMap: map[string][]byte{},
- expectedErr: nil,
- },
- {
- checkNote: "find none with path 'no-exist'",
- ref: esv1.ExternalSecretFind{
- Name: &esv1.FindName{
- RegExp: "^my-*",
- },
- Path: pointer.To("no-exist"),
- },
- expectedMap: map[string][]byte{},
- expectedErr: nil,
- },
- },
- },
- {
- setupNote: "two fields/files with same name, first one wins",
- provider: &ProviderOnePassword{
- vaults: map[string]int{myVault: 1, myOtherVault: 2},
- client: fake.NewMockClient().
- // my-vault
- AddPredictableVault(myVault).
- AddPredictableItemWithField(myVault, myItem, key1, value1).
- AddPredictableItemWithField(myVault, "my-second-item", key1, "value-second").
- AppendItem(myVaultID, onepassword.Item{
- ID: "file-item-id",
- Title: "file-item",
- Vault: onepassword.ItemVault{ID: myVaultID},
- Category: documentCategory,
- Files: []*onepassword.File{
- {
- ID: filePNGID,
- Name: filePNG,
- },
- },
- }).
- SetFileContents(filePNG, []byte(myContents)).
- AppendItem(myVaultID, onepassword.Item{
- ID: "file-item-2-id",
- Title: "file-item-2",
- Vault: onepassword.ItemVault{ID: myVaultID},
- Category: documentCategory,
- Files: []*onepassword.File{
- {
- ID: "file-2-id",
- Name: filePNG,
- },
- },
- }).
- // my-other-vault
- AddPredictableVault(myOtherVault).
- AddPredictableItemWithField(myOtherVault, myOtherItem, key1, "value-other").
- AppendItem(myOtherVaultID, onepassword.Item{
- ID: "file-item-other-id",
- Title: "file-item-other",
- Vault: onepassword.ItemVault{ID: myOtherVaultID},
- Category: documentCategory,
- Files: []*onepassword.File{
- {
- ID: "other-file-id",
- Name: filePNG,
- },
- },
- }),
- },
- checks: []check{
- {
- checkNote: "find fields with regex '^key*'",
- ref: esv1.ExternalSecretFind{
- Name: &esv1.FindName{
- RegExp: "^key*",
- },
- },
- expectedMap: map[string][]byte{
- key1: []byte(value1),
- },
- expectedErr: nil,
- },
- {
- checkNote: "find files with regex '^file*item*'",
- ref: esv1.ExternalSecretFind{
- Name: &esv1.FindName{
- RegExp: "^file*",
- },
- },
- expectedMap: map[string][]byte{
- filePNG: []byte(myContents),
- },
- expectedErr: nil,
- },
- },
- },
- }
- // run the tests
- for _, tc := range testCases {
- for _, check := range tc.checks {
- gotMap, err := tc.provider.GetAllSecrets(context.Background(), check.ref)
- notes := fmt.Sprintf(setupCheckFormat, tc.setupNote, check.checkNote)
- if check.expectedErr == nil && err != nil {
- // expected no error, got one
- t.Fatalf(getAllSecretsErrFormat, notes, nil, err)
- }
- if check.expectedErr != nil && err == nil {
- // expected an error, didn't get one
- t.Errorf(getAllSecretsErrFormat, notes, check.expectedErr.Error(), nil)
- }
- if check.expectedErr != nil && err != nil && err.Error() != check.expectedErr.Error() {
- // expected an error, got the wrong one
- t.Errorf(getAllSecretsErrFormat, notes, check.expectedErr.Error(), err.Error())
- }
- if !reflect.DeepEqual(check.expectedMap, gotMap) {
- // expected a predefined map, got something else
- t.Errorf(getAllSecretsErrFormat, notes, check.expectedMap, gotMap)
- }
- }
- }
- }
- func TestSortVaults(t *testing.T) {
- type testCase struct {
- vaults map[string]int
- expected []string
- }
- testCases := []testCase{
- {
- vaults: map[string]int{
- one: 1,
- three: 3,
- two: 2,
- },
- expected: []string{
- one,
- two,
- three,
- },
- },
- {
- vaults: map[string]int{
- "four": 100,
- one: 1,
- three: 3,
- two: 2,
- },
- expected: []string{
- one,
- two,
- three,
- "four",
- },
- },
- }
- // run the tests
- for _, tc := range testCases {
- got := sortVaults(tc.vaults)
- if !reflect.DeepEqual(got, tc.expected) {
- t.Errorf("onepassword.sortVaults(...): -expected, +got:\n-%#v\n+%#v\n", tc.expected, got)
- }
- }
- }
- func TestHasUniqueVaultNumbers(t *testing.T) {
- type testCase struct {
- vaults map[string]int
- expected bool
- }
- testCases := []testCase{
- {
- vaults: map[string]int{
- one: 1,
- three: 3,
- two: 2,
- },
- expected: true,
- },
- {
- vaults: map[string]int{
- "four": 100,
- one: 1,
- three: 3,
- two: 2,
- "eight": 100,
- },
- expected: false,
- },
- {
- vaults: map[string]int{
- one: 1,
- "1": 1,
- three: 3,
- two: 2,
- },
- expected: false,
- },
- }
- // run the tests
- for _, tc := range testCases {
- got := hasUniqueVaultNumbers(tc.vaults)
- if got != tc.expected {
- t.Errorf("onepassword.hasUniqueVaultNumbers(...): -expected, +got:\n-%#v\n+%#v\n", tc.expected, got)
- }
- }
- }
- type fakeRef struct {
- key string
- prop string
- secretKey string
- metadata *apiextensionsv1.JSON
- }
- func (f fakeRef) GetRemoteKey() string {
- return f.key
- }
- func (f fakeRef) GetProperty() string {
- return f.prop
- }
- func (f fakeRef) GetSecretKey() string {
- return f.secretKey
- }
- func (f fakeRef) GetMetadata() *apiextensionsv1.JSON {
- return f.metadata
- }
- func validateItem(t *testing.T, expectedItem, actualItem *onepassword.Item) {
- t.Helper()
- if !reflect.DeepEqual(expectedItem, actualItem) {
- t.Errorf("expected item %v, got %v", expectedItem, actualItem)
- }
- }
- func TestProviderOnePasswordCreateItem(t *testing.T) {
- type testCase struct {
- vaults map[string]int
- expectedErr error
- setupNote string
- val []byte
- createValidateFunc func(*testing.T, *onepassword.Item, string) (*onepassword.Item, error)
- ref esv1.PushSecretData
- }
- const vaultName = "vault1"
- const fallbackVaultName = "vault2"
- thridPartyErr := errors.New("third party error")
- metadata := &metadata.PushSecretMetadata[PushSecretMetadataSpec]{
- APIVersion: metadata.APIVersion,
- Kind: metadata.Kind,
- Spec: PushSecretMetadataSpec{
- Tags: []string{"tag1", "tag2"},
- Vault: fallbackVaultName,
- },
- }
- metadataRaw, _ := json.Marshal(metadata)
- testCases := []testCase{
- {
- setupNote: "standard create",
- val: []byte("value"),
- ref: fakeRef{
- key: "testing",
- prop: "prop",
- },
- expectedErr: nil,
- vaults: map[string]int{
- vaultName: 1,
- fallbackVaultName: 2,
- },
- createValidateFunc: func(t *testing.T, item *onepassword.Item, s string) (*onepassword.Item, error) {
- validateItem(t, &onepassword.Item{
- Title: "testing",
- Category: onepassword.Server,
- Vault: onepassword.ItemVault{
- ID: vaultName,
- },
- Fields: []*onepassword.ItemField{
- generateNewItemField("prop", "value"),
- },
- }, item)
- return item, nil
- },
- },
- {
- setupNote: "standard create with no property",
- val: []byte("value2"),
- ref: fakeRef{
- key: "testing2",
- prop: "",
- },
- vaults: map[string]int{
- vaultName: 2,
- },
- createValidateFunc: func(t *testing.T, item *onepassword.Item, s string) (*onepassword.Item, error) {
- validateItem(t, &onepassword.Item{
- Title: "testing2",
- Category: onepassword.Server,
- Vault: onepassword.ItemVault{
- ID: vaultName,
- },
- Fields: []*onepassword.ItemField{
- generateNewItemField("password", "value2"),
- },
- }, item)
- return item, nil
- },
- },
- {
- setupNote: "no vaults",
- val: []byte("value"),
- ref: fakeRef{
- key: "testing",
- prop: "prop",
- },
- vaults: map[string]int{},
- expectedErr: ErrNoVaults,
- createValidateFunc: func(t *testing.T, item *onepassword.Item, s string) (*onepassword.Item, error) {
- t.Errorf("onepassword.createItem(...): should not have been called")
- return nil, nil
- },
- },
- {
- setupNote: "error on create",
- val: []byte("testing"),
- ref: fakeRef{
- key: "another",
- prop: "property",
- },
- vaults: map[string]int{
- vaultName: 1,
- },
- expectedErr: thridPartyErr,
- createValidateFunc: func(t *testing.T, item *onepassword.Item, s string) (*onepassword.Item, error) {
- validateItem(t, &onepassword.Item{
- Title: "another",
- Category: onepassword.Server,
- Vault: onepassword.ItemVault{
- ID: vaultName,
- },
- Fields: []*onepassword.ItemField{
- generateNewItemField("property", "testing"),
- },
- }, item)
- return nil, thridPartyErr
- },
- },
- {
- setupNote: "valid metadata overrides",
- val: []byte("testing"),
- ref: fakeRef{
- key: "another",
- prop: "property",
- metadata: &apiextensionsv1.JSON{
- Raw: metadataRaw,
- },
- },
- vaults: map[string]int{
- vaultName: 1,
- fallbackVaultName: 2,
- },
- expectedErr: nil,
- createValidateFunc: func(t *testing.T, item *onepassword.Item, s string) (*onepassword.Item, error) {
- validateItem(t, &onepassword.Item{
- Title: "another",
- Category: onepassword.Server,
- Vault: onepassword.ItemVault{
- ID: fallbackVaultName,
- },
- Fields: []*onepassword.ItemField{
- generateNewItemField("property", "testing"),
- },
- Tags: []string{"tag1", "tag2"},
- }, item)
- return item, nil
- },
- },
- }
- provider := &ProviderOnePassword{}
- for _, tc := range testCases {
- // setup
- mockClient := fake.NewMockClient()
- mockClient.CreateItemValidateFunc = func(item *onepassword.Item, s string) (*onepassword.Item, error) {
- i, e := tc.createValidateFunc(t, item, s)
- return i, e
- }
- provider.client = mockClient
- provider.vaults = tc.vaults
- err := provider.createItem(tc.val, tc.ref)
- if !errors.Is(err, tc.expectedErr) {
- t.Errorf(errDoesNotMatchMsgF, tc.setupNote, tc.expectedErr, err)
- }
- }
- }
- func TestProviderOnePasswordDeleteItem(t *testing.T) {
- type testCase struct {
- inputFields []*onepassword.ItemField
- fieldName string
- expectedErr error
- expectedFields []*onepassword.ItemField
- setupNote string
- }
- field1, field2, field3, field4 := "field1", "field2", "field3", "field4"
- testCases := []testCase{
- {
- setupNote: "one field to remove",
- inputFields: []*onepassword.ItemField{
- {
- ID: field1,
- Label: field1,
- Type: onepassword.FieldTypeAddress,
- },
- {
- ID: field2,
- Label: field2,
- Type: onepassword.FieldTypeString,
- },
- {
- ID: field3,
- Label: field3,
- Type: onepassword.FieldTypeConcealed,
- },
- },
- fieldName: field2,
- expectedFields: []*onepassword.ItemField{
- {
- ID: field1,
- Label: field1,
- Type: onepassword.FieldTypeAddress,
- },
- {
- ID: field3,
- Label: field3,
- Type: onepassword.FieldTypeConcealed,
- },
- },
- },
- {
- setupNote: "no fields to remove",
- inputFields: []*onepassword.ItemField{
- {
- ID: field1,
- Label: field1,
- Type: onepassword.FieldTypeAddress,
- },
- {
- ID: field2,
- Label: field2,
- Type: onepassword.FieldTypeString,
- },
- {
- ID: field3,
- Label: field3,
- Type: onepassword.FieldTypeConcealed,
- },
- },
- expectedErr: nil,
- fieldName: field4,
- expectedFields: []*onepassword.ItemField{
- {
- ID: field1,
- Label: field1,
- Type: onepassword.FieldTypeAddress,
- },
- {
- ID: field2,
- Label: field2,
- Type: onepassword.FieldTypeString,
- },
- {
- ID: field3,
- Label: field3,
- Type: onepassword.FieldTypeConcealed,
- },
- },
- },
- {
- setupNote: "multiple fields to remove",
- inputFields: []*onepassword.ItemField{
- {
- ID: field3,
- Label: field3,
- Type: onepassword.FieldTypeConcealed,
- },
- {
- ID: field1,
- Label: field1,
- Type: onepassword.FieldTypeAddress,
- },
- {
- ID: field3,
- Label: field3,
- Type: onepassword.FieldTypeCreditCardType,
- },
- {
- ID: field2,
- Label: field2,
- Type: onepassword.FieldTypeString,
- },
- {
- ID: field3,
- Label: field3,
- Type: onepassword.FieldTypeGender,
- },
- },
- fieldName: field3,
- expectedErr: ErrExpectedOneField,
- expectedFields: nil,
- },
- }
- // run the tests
- for _, tc := range testCases {
- actualOutput, err := deleteField(tc.inputFields, tc.fieldName)
- if len(actualOutput) != len(tc.expectedFields) {
- t.Errorf("%s: length fields did not match: -expected, +got:\n-%#v\n+%#v\n", tc.setupNote, tc.expectedFields, actualOutput)
- return
- }
- if !errors.Is(err, tc.expectedErr) {
- t.Errorf(errDoesNotMatchMsgF, tc.setupNote, tc.expectedErr, err)
- }
- for i, check := range tc.expectedFields {
- if len(actualOutput) <= i {
- continue
- }
- if !reflect.DeepEqual(check, actualOutput[i]) {
- t.Errorf("%s: fields at position %d did not match: -expected, +got:\n-%#v\n+%#v\n", tc.setupNote, i, check, actualOutput[i])
- }
- }
- }
- }
- func TestUpdateFields(t *testing.T) {
- type testCase struct {
- inputFields []*onepassword.ItemField
- fieldName string
- newVal string
- expectedErr error
- expectedFields []*onepassword.ItemField
- setupNote string
- }
- field1, field2, field3, field4 := "field1", "field2", "field3", "field4"
- testCases := []testCase{
- {
- setupNote: "one field to update",
- inputFields: []*onepassword.ItemField{
- {
- ID: field1,
- Label: field1,
- Value: value1,
- Type: onepassword.FieldTypeAddress,
- },
- {
- ID: field2,
- Label: field2,
- Value: value2,
- Type: onepassword.FieldTypeString,
- },
- {
- ID: field3,
- Label: field3,
- Value: value3,
- Type: onepassword.FieldTypeConcealed,
- },
- },
- fieldName: field2,
- newVal: "testing",
- expectedFields: []*onepassword.ItemField{
- {
- ID: field1,
- Label: field1,
- Value: value1,
- Type: onepassword.FieldTypeAddress,
- },
- {
- ID: field2,
- Label: field2,
- Value: "testing",
- Type: onepassword.FieldTypeString,
- },
- {
- ID: field3,
- Label: field3,
- Value: value3,
- Type: onepassword.FieldTypeConcealed,
- },
- },
- },
- {
- setupNote: "add field",
- inputFields: []*onepassword.ItemField{
- {
- ID: field1,
- Value: value1,
- Label: field1,
- Type: onepassword.FieldTypeAddress,
- },
- {
- ID: field2,
- Label: field2,
- Value: value2,
- Type: onepassword.FieldTypeString,
- },
- },
- fieldName: field4,
- newVal: value4,
- expectedFields: []*onepassword.ItemField{
- {
- ID: field1,
- Label: field1,
- Value: value1,
- Type: onepassword.FieldTypeAddress,
- },
- {
- ID: field2,
- Label: field2,
- Value: value2,
- Type: onepassword.FieldTypeString,
- },
- {
- Label: field4,
- Value: value4,
- Type: onepassword.FieldTypeConcealed,
- },
- },
- },
- {
- setupNote: "no changes",
- inputFields: []*onepassword.ItemField{
- {
- ID: field1,
- Label: field1,
- Value: value1,
- Type: onepassword.FieldTypeAddress,
- },
- {
- ID: field2,
- Label: field2,
- Value: value2,
- Type: onepassword.FieldTypeString,
- },
- },
- fieldName: field1,
- newVal: value1,
- expectedErr: nil,
- expectedFields: []*onepassword.ItemField{
- {
- ID: field1,
- Label: field1,
- Value: value1,
- Type: onepassword.FieldTypeAddress,
- },
- {
- ID: field2,
- Label: field2,
- Value: value2,
- Type: onepassword.FieldTypeString,
- },
- },
- },
- {
- setupNote: "multiple fields to remove",
- inputFields: []*onepassword.ItemField{
- {
- ID: field3,
- Label: field3,
- Value: value3,
- Type: onepassword.FieldTypeConcealed,
- },
- {
- ID: field1,
- Label: field1,
- Value: value1,
- Type: onepassword.FieldTypeAddress,
- },
- {
- ID: field3,
- Label: field3,
- Value: value3,
- Type: onepassword.FieldTypeCreditCardType,
- },
- {
- ID: field2,
- Label: field2,
- Value: value2,
- Type: onepassword.FieldTypeString,
- },
- {
- ID: field3,
- Label: field3,
- Value: value3,
- Type: onepassword.FieldTypeGender,
- },
- },
- fieldName: field3,
- expectedErr: ErrExpectedOneField,
- expectedFields: nil,
- },
- }
- // run the tests
- for _, tc := range testCases {
- actualOutput, err := updateFieldValue(tc.inputFields, tc.fieldName, tc.newVal)
- if len(actualOutput) != len(tc.expectedFields) {
- t.Errorf("%s: length fields did not match: -expected, +got:\n-%#v\n+%#v\n", tc.setupNote, tc.expectedFields, actualOutput)
- return
- }
- if !errors.Is(err, tc.expectedErr) {
- t.Errorf(errDoesNotMatchMsgF, tc.setupNote, tc.expectedErr, err)
- }
- for i, check := range tc.expectedFields {
- if len(actualOutput) <= i {
- continue
- }
- if !reflect.DeepEqual(check, actualOutput[i]) {
- t.Errorf("%s: fields at position %d did not match: -expected, +got:\n-%#v\n+%#v\n", tc.setupNote, i, check, actualOutput[i])
- }
- }
- }
- }
- func TestGenerateNewItemField(t *testing.T) {
- field := generateNewItemField("property", "testing")
- if !reflect.DeepEqual(field, &onepassword.ItemField{
- Label: "property",
- Type: onepassword.FieldTypeConcealed,
- Value: "testing",
- }) {
- t.Errorf("field did not match: -expected, +got:\n-%#v\n+%#v\n", &onepassword.ItemField{
- Label: "property",
- Type: onepassword.FieldTypeConcealed,
- Value: "testing",
- }, field)
- }
- }
- func TestProviderOnePasswordPushSecret(t *testing.T) {
- // Most logic is tested in the createItem and updateField functions
- // This test is just to make sure the correct functions are called.
- // the correct values are passed to them, and errors are propagated
- type testCase struct {
- vaults map[string]int
- expectedErr error
- setupNote string
- existingItems []onepassword.Item
- val *corev1.Secret
- existingItemsFields map[string][]*onepassword.ItemField
- createValidateFunc func(*onepassword.Item, string) (*onepassword.Item, error)
- updateValidateFunc func(*onepassword.Item, string) (*onepassword.Item, error)
- ref fakeRef
- }
- var (
- vaultName = "vault1"
- vault = onepassword.Vault{
- ID: vaultName,
- }
- )
- metadata := &metadata.PushSecretMetadata[PushSecretMetadataSpec]{
- APIVersion: metadata.APIVersion,
- Kind: metadata.Kind,
- Spec: PushSecretMetadataSpec{
- Tags: []string{"tag1", "tag2"},
- },
- }
- metadataRaw, _ := json.Marshal(metadata)
- testCases := []testCase{
- {
- vaults: map[string]int{
- vaultName: 1,
- },
- expectedErr: ErrExpectedOneItem,
- setupNote: "find item error",
- existingItems: []onepassword.Item{
- {
- Title: key1,
- }, {
- Title: key1,
- }, // can be empty, testing for error with length
- },
- ref: fakeRef{
- key: key1,
- secretKey: key1,
- },
- val: &corev1.Secret{Data: map[string][]byte{key1: []byte("testing")}},
- },
- {
- setupNote: "create item error",
- expectedErr: ErrNoVaults,
- val: &corev1.Secret{Data: map[string][]byte{key1: []byte("testing")}},
- ref: fakeRef{secretKey: key1},
- vaults: nil,
- },
- {
- setupNote: "key not in data",
- expectedErr: ErrKeyNotFound,
- val: &corev1.Secret{Data: map[string][]byte{}},
- ref: fakeRef{secretKey: key1},
- vaults: nil,
- },
- {
- setupNote: "create item success",
- expectedErr: nil,
- val: &corev1.Secret{Data: map[string][]byte{
- key1: []byte("testing"),
- }},
- ref: fakeRef{
- key: key1,
- prop: "prop",
- secretKey: key1,
- },
- vaults: map[string]int{
- vaultName: 1,
- },
- createValidateFunc: func(item *onepassword.Item, s string) (*onepassword.Item, error) {
- validateItem(t, &onepassword.Item{
- Title: key1,
- Category: onepassword.Server,
- Vault: onepassword.ItemVault{
- ID: vaultName,
- },
- Fields: []*onepassword.ItemField{
- generateNewItemField("prop", "testing"),
- },
- }, item)
- return item, nil
- },
- },
- {
- setupNote: "update fields error",
- expectedErr: ErrExpectedOneField,
- val: &corev1.Secret{Data: map[string][]byte{
- "key2": []byte("testing"),
- }},
- ref: fakeRef{
- key: key1,
- prop: "prop",
- secretKey: "key2",
- },
- vaults: map[string]int{
- vaultName: 1,
- },
- existingItemsFields: map[string][]*onepassword.ItemField{
- key1: {
- {
- Label: "prop",
- },
- {
- Label: "prop",
- },
- },
- },
- existingItems: []onepassword.Item{
- {
- Vault: onepassword.ItemVault{
- ID: vaultName,
- },
- ID: key1,
- Title: key1,
- },
- },
- },
- {
- setupNote: "standard update",
- expectedErr: nil,
- val: &corev1.Secret{Data: map[string][]byte{
- "key3": []byte("testing2"),
- }},
- ref: fakeRef{
- key: key1,
- prop: "",
- secretKey: "key3",
- },
- vaults: map[string]int{
- vaultName: 1,
- },
- existingItemsFields: map[string][]*onepassword.ItemField{
- key1: {
- {
- Label: "not-prop",
- },
- },
- },
- updateValidateFunc: func(item *onepassword.Item, s string) (*onepassword.Item, error) {
- expectedItem := &onepassword.Item{
- Vault: onepassword.ItemVault{
- ID: vaultName,
- },
- ID: key1,
- Title: key1,
- Fields: []*onepassword.ItemField{
- {
- Label: "not-prop",
- },
- {
- Label: "password",
- Value: "testing2",
- Type: onepassword.FieldTypeConcealed,
- },
- },
- }
- validateItem(t, expectedItem, item)
- return expectedItem, nil
- },
- existingItems: []onepassword.Item{
- {
- Vault: onepassword.ItemVault{
- ID: vaultName,
- },
- ID: key1,
- Title: key1,
- },
- },
- },
- {
- setupNote: "create item with metadata overwrites success",
- expectedErr: nil,
- val: &corev1.Secret{Data: map[string][]byte{
- key1: []byte("testing"),
- }},
- ref: fakeRef{
- key: key1,
- prop: "prop",
- secretKey: key1,
- metadata: &apiextensionsv1.JSON{
- Raw: metadataRaw,
- },
- },
- vaults: map[string]int{
- vaultName: 1,
- },
- createValidateFunc: func(item *onepassword.Item, s string) (*onepassword.Item, error) {
- validateItem(t, &onepassword.Item{
- Title: key1,
- Category: onepassword.Server,
- Vault: onepassword.ItemVault{
- ID: vaultName,
- },
- Fields: []*onepassword.ItemField{
- generateNewItemField("prop", "testing"),
- },
- Tags: []string{"tag1", "tag2"},
- }, item)
- return item, nil
- },
- },
- }
- provider := &ProviderOnePassword{}
- for _, tc := range testCases {
- t.Run(tc.setupNote, func(t *testing.T) {
- // setup
- mockClient := fake.NewMockClient()
- mockClient.MockVaults = map[string][]onepassword.Vault{
- vaultName: {vault},
- }
- mockClient.MockItems = map[string][]onepassword.Item{
- vaultName: tc.existingItems,
- }
- mockClient.MockItemFields = map[string]map[string][]*onepassword.ItemField{
- vaultName: tc.existingItemsFields,
- }
- mockClient.CreateItemValidateFunc = func(item *onepassword.Item, s string) (*onepassword.Item, error) {
- return tc.createValidateFunc(item, s)
- }
- mockClient.UpdateItemValidateFunc = func(item *onepassword.Item, s string) (*onepassword.Item, error) {
- return tc.updateValidateFunc(item, s)
- }
- provider.client = mockClient
- provider.vaults = tc.vaults
- err := provider.PushSecret(context.Background(), tc.val, tc.ref)
- if !errors.Is(err, tc.expectedErr) {
- t.Errorf(errDoesNotMatchMsgF, tc.setupNote, tc.expectedErr, err)
- }
- })
- }
- }
- // mockClient implements connect.Client interface for testing.
- type mockClient struct {
- getItemsFunc func(vaultQuery string) ([]onepassword.Item, error)
- }
- func (m *mockClient) GetVaults() ([]onepassword.Vault, error) { return nil, nil }
- func (m *mockClient) GetVault(uuid string) (*onepassword.Vault, error) { return nil, nil }
- func (m *mockClient) GetVaultByUUID(uuid string) (*onepassword.Vault, error) { return nil, nil }
- func (m *mockClient) GetVaultByTitle(title string) (*onepassword.Vault, error) { return nil, nil }
- func (m *mockClient) GetVaultsByTitle(uuid string) ([]onepassword.Vault, error) { return nil, nil }
- func (m *mockClient) GetItems(vaultQuery string) ([]onepassword.Item, error) {
- if m.getItemsFunc != nil {
- return m.getItemsFunc(vaultQuery)
- }
- return nil, nil
- }
- func (m *mockClient) GetItem(itemQuery, vaultQuery string) (*onepassword.Item, error) {
- return nil, nil
- }
- func (m *mockClient) GetItemByUUID(uuid, vaultQuery string) (*onepassword.Item, error) {
- return nil, nil
- }
- func (m *mockClient) GetItemByTitle(title, vaultQuery string) (*onepassword.Item, error) {
- return nil, nil
- }
- func (m *mockClient) GetItemsByTitle(title, vaultQuery string) ([]onepassword.Item, error) {
- return nil, nil
- }
- func (m *mockClient) CreateItem(item *onepassword.Item, vaultQuery string) (*onepassword.Item, error) {
- return nil, nil
- }
- func (m *mockClient) UpdateItem(item *onepassword.Item, vaultQuery string) (*onepassword.Item, error) {
- return nil, nil
- }
- func (m *mockClient) DeleteItem(item *onepassword.Item, vaultQuery string) error { return nil }
- func (m *mockClient) DeleteItemByID(itemUUID, vaultQuery string) error { return nil }
- func (m *mockClient) DeleteItemByTitle(title, vaultQuery string) error { return nil }
- func (m *mockClient) GetFiles(itemQuery, vaultQuery string) ([]onepassword.File, error) {
- return nil, nil
- }
- func (m *mockClient) GetFile(uuid, itemQuery, vaultQuery string) (*onepassword.File, error) {
- return nil, nil
- }
- func (m *mockClient) GetFileContent(file *onepassword.File) ([]byte, error) { return nil, nil }
- func (m *mockClient) DownloadFile(file *onepassword.File, targetDirectory string, overwrite bool) (string, error) {
- return "", nil
- }
- func (m *mockClient) LoadStructFromItemByUUID(config interface{}, itemUUID, vaultQuery string) error {
- return nil
- }
- func (m *mockClient) LoadStructFromItemByTitle(config interface{}, itemTitle, vaultQuery string) error {
- return nil
- }
- func (m *mockClient) LoadStructFromItem(config interface{}, itemQuery, vaultQuery string) error {
- return nil
- }
- func (m *mockClient) LoadStruct(config interface{}) error { return nil }
- func TestRetryClient(t *testing.T) {
- tests := []struct {
- name string
- err error
- shouldRetry bool
- expectErr bool
- }{
- {
- name: "403 auth error should retry",
- err: errors.New("status 403: Authorization failed"),
- shouldRetry: true,
- expectErr: true,
- },
- {
- name: "other error should not retry",
- err: errors.New("status 500: Internal Server Error"),
- shouldRetry: false,
- expectErr: true,
- },
- {
- name: "nil error should not retry",
- err: nil,
- shouldRetry: false,
- expectErr: false,
- },
- }
- for _, tc := range tests {
- t.Run(tc.name, func(t *testing.T) {
- callCount := 0
- mockClient := &mockClient{
- getItemsFunc: func(vaultQuery string) ([]onepassword.Item, error) {
- callCount++
- return nil, tc.err
- },
- }
- retryClient := newRetryClient(mockClient)
- _, err := retryClient.GetItems("test-vault")
- if tc.expectErr && err == nil {
- t.Errorf("expected error but got none")
- }
- if !tc.expectErr && err != nil {
- t.Errorf("expected no error but got: %v", err)
- }
- expectedCalls := 1
- if tc.shouldRetry {
- expectedCalls = 3 // Initial call + 2 retries (3 steps configured in retry backoff)
- }
- if callCount < expectedCalls {
- t.Errorf("expected at least %d calls but got %d", expectedCalls, callCount)
- }
- })
- }
- }
- func TestIs403AuthError(t *testing.T) {
- tests := []struct {
- name string
- err error
- expected bool
- }{
- {
- name: "nil error",
- err: nil,
- expected: false,
- },
- {
- name: "403 auth error",
- err: errors.New("status 403: Authorization failed"),
- expected: true,
- },
- {
- name: "other error",
- err: errors.New("status 500: Internal Server Error"),
- expected: false,
- },
- {
- name: "partial match",
- err: errors.New("403: some other message"),
- expected: false,
- },
- }
- for _, tc := range tests {
- t.Run(tc.name, func(t *testing.T) {
- result := is403AuthError(tc.err)
- if result != tc.expected {
- t.Errorf("expected %v but got %v", tc.expected, result)
- }
- })
- }
- }
|