| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689 |
- /*
- Copyright © The ESO Authors
- Licensed under the Apache License, Version 2.0 (the "License");
- you may not use this file except in compliance with the License.
- You may obtain a copy of the License at
- https://www.apache.org/licenses/LICENSE-2.0
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
- */
- package 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"
- 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/providers/v1/onepassword/fake"
- "github.com/external-secrets/external-secrets/runtime/esutils/metadata"
- )
- const (
- // vaults and items.
- myVault, myVaultID = "my-vault", "my-vault-id"
- myItem, myItemID = "my-item", "my-item-id"
- myNativeItemID = "gdpvdudxrico74msloimk7qjna"
- 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: "native item ID: one vault, one item, one field",
- provider: &ProviderOnePassword{
- vaults: map[string]int{myVault: 1},
- client: fake.NewMockClient().
- AddPredictableVault(myVault).
- AppendItem(myVaultID, onepassword.Item{
- ID: myNativeItemID,
- Title: "My App (Production)",
- Vault: onepassword.ItemVault{ID: myVaultID},
- }).
- AppendItemField(myVaultID, myNativeItemID, onepassword.ItemField{
- Label: key1,
- Value: value1,
- }),
- },
- checks: []check{
- {
- checkNote: "find by native item ID",
- findItemName: myNativeItemID,
- expectedErr: nil,
- expectedItem: &onepassword.Item{
- ID: myNativeItemID,
- Title: "My App (Production)",
- Vault: onepassword.ItemVault{ID: myVaultID},
- 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: new("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: new("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: new(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: new(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: new("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: new(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: new(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: new(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: new("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 TestIsNativeItemID(t *testing.T) {
- tests := []struct {
- name string
- input string
- expected bool
- }{
- {"valid native ID", "gdpvdudxrico74msloimk7qjna", true},
- {"valid native ID all letters", "abcdefghijklmnopqrstuvwxyz", true},
- {"valid native ID with digits", "abcdefghij0123456789abcdef", true},
- {"too short", "gdpvdudxrico74msloimk7qjn", false},
- {"too long", "gdpvdudxrico74msloimk7qjnaa", false},
- {"empty string", "", false},
- {"contains uppercase", "Gdpvdudxrico74msloimk7qjna", false},
- {"contains special char", "gdpvdudxrico7-msloimk7qjna", false},
- {"RFC 4122 UUID", "687adbe7-e6d2-4059-9a62-dbb95d291143", false},
- {"item title", "My App (Production)", false},
- }
- for _, tt := range tests {
- t.Run(tt.name, func(t *testing.T) {
- got := isNativeItemID(tt.input)
- if got != tt.expected {
- t.Errorf("isNativeItemID(%q) = %v, want %v", tt.input, got, tt.expected)
- }
- })
- }
- }
- 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 any, itemUUID, vaultQuery string) error {
- return nil
- }
- func (m *mockClient) LoadStructFromItemByTitle(config any, itemTitle, vaultQuery string) error {
- return nil
- }
- func (m *mockClient) LoadStructFromItem(config any, itemQuery, vaultQuery string) error {
- return nil
- }
- func (m *mockClient) LoadStruct(config any) error { return nil }
- func TestDeleteSecretWithEmptySections(t *testing.T) {
- const vaultName = "vault1"
- vault := onepassword.Vault{
- ID: vaultName,
- Name: vaultName,
- }
- t.Run("item with empty section should be deleted when last field is removed", func(t *testing.T) {
- deleteCalled := false
- updateCalled := false
- mockClient := fake.NewMockClient()
- mockClient.MockVaults = map[string][]onepassword.Vault{
- vaultName: {vault},
- }
- mockClient.MockItems = map[string][]onepassword.Item{
- vaultName: {
- {
- ID: "item-id",
- Title: "test-item",
- Vault: onepassword.ItemVault{ID: vaultName},
- Sections: []*onepassword.ItemSection{
- {ID: "", Label: ""},
- },
- },
- },
- }
- mockClient.MockItemFields = map[string]map[string][]*onepassword.ItemField{
- vaultName: {
- "item-id": {
- {ID: "field-1", Label: "password", Value: "secret"},
- },
- },
- }
- mockClient.DeleteItemValidateFunc = func(item *onepassword.Item, s string) error {
- deleteCalled = true
- return nil
- }
- mockClient.UpdateItemValidateFunc = func(item *onepassword.Item, s string) (*onepassword.Item, error) {
- updateCalled = true
- return item, nil
- }
- provider := &ProviderOnePassword{
- vaults: map[string]int{vaultName: 1},
- client: mockClient,
- }
- err := provider.DeleteSecret(context.Background(), fakeRef{
- key: "test-item",
- prop: "password",
- })
- if err != nil {
- t.Errorf("expected no error, got %v", err)
- }
- if !deleteCalled {
- t.Error("expected DeleteItem to be called when item has no fields and only empty sections")
- }
- if updateCalled {
- t.Error("expected UpdateItem not to be called")
- }
- })
- t.Run("item not found should not error", func(t *testing.T) {
- mockClient := fake.NewMockClient()
- mockClient.MockVaults = map[string][]onepassword.Vault{
- vaultName: {vault},
- }
- mockClient.MockItems = map[string][]onepassword.Item{
- vaultName: {},
- }
- provider := &ProviderOnePassword{
- vaults: map[string]int{vaultName: 1},
- client: mockClient,
- }
- err := provider.DeleteSecret(context.Background(), fakeRef{
- key: "non-existent-item",
- prop: "password",
- })
- if err != nil {
- t.Errorf("expected no error when item not found, got %v", err)
- }
- })
- }
- 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)
- }
- })
- }
- }
|