| 12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220 |
- /*
- Licensed under the Apache License, Version 2.0 (the "License");
- you may not use this file except in compliance with the License.
- You may obtain a copy of the License at
- http://www.apache.org/licenses/LICENSE-2.0
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
- */
- package ibm
- import (
- "context"
- "encoding/json"
- "errors"
- "fmt"
- "reflect"
- "strconv"
- "strings"
- "testing"
- "github.com/IBM/go-sdk-core/v5/core"
- sm "github.com/IBM/secrets-manager-go-sdk/v2/secretsmanagerv2"
- "github.com/go-openapi/strfmt"
- corev1 "k8s.io/api/core/v1"
- metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
- utilpointer "k8s.io/utils/ptr"
- clientfake "sigs.k8s.io/controller-runtime/pkg/client/fake"
- esv1beta1 "github.com/external-secrets/external-secrets/apis/externalsecrets/v1beta1"
- v1 "github.com/external-secrets/external-secrets/apis/meta/v1"
- fakesm "github.com/external-secrets/external-secrets/pkg/provider/ibm/fake"
- )
- const (
- errExpectedErr = "wanted error got nil"
- secretKey = "test-secret"
- secretUUID = "d5deb37a-7883-4fe2-a5e7-3c15420adc76"
- iamCredentialsSecret = "iam_credentials/"
- )
- type secretManagerTestCase struct {
- name string
- mockClient *fakesm.IBMMockClient
- apiInput *sm.GetSecretOptions
- apiOutput sm.SecretIntf
- getByNameInput *sm.GetSecretByNameTypeOptions
- getByNameOutput sm.SecretIntf
- getByNameError error
- ref *esv1beta1.ExternalSecretDataRemoteRef
- serviceURL *string
- apiErr error
- expectError string
- expectedSecret string
- // for testing secretmap
- expectedData map[string][]byte
- }
- func makeValidSecretManagerTestCase() *secretManagerTestCase {
- smtc := secretManagerTestCase{
- mockClient: &fakesm.IBMMockClient{},
- apiInput: makeValidAPIInput(),
- ref: makeValidRef(),
- apiOutput: makeValidAPIOutput(),
- getByNameInput: makeValidGetByNameInput(),
- getByNameOutput: makeValidAPIOutput(),
- getByNameError: nil,
- serviceURL: nil,
- apiErr: nil,
- expectError: "",
- expectedSecret: "",
- expectedData: map[string][]byte{},
- }
- mcParams := fakesm.IBMMockClientParams{
- GetSecretOptions: smtc.apiInput,
- GetSecretOutput: smtc.apiOutput,
- GetSecretErr: smtc.apiErr,
- GetSecretByNameOptions: smtc.getByNameInput,
- GetSecretByNameOutput: smtc.getByNameOutput,
- GetSecretByNameErr: smtc.getByNameError,
- }
- smtc.mockClient.WithValue(mcParams)
- return &smtc
- }
- func makeValidRef() *esv1beta1.ExternalSecretDataRemoteRef {
- return &esv1beta1.ExternalSecretDataRemoteRef{
- Key: secretUUID,
- Version: "default",
- }
- }
- func makeValidAPIInput() *sm.GetSecretOptions {
- return &sm.GetSecretOptions{
- ID: utilpointer.To(secretUUID),
- }
- }
- func makeValidAPIOutput() sm.SecretIntf {
- secret := &sm.Secret{
- SecretType: utilpointer.To(sm.Secret_SecretType_Arbitrary),
- Name: utilpointer.To("testyname"),
- ID: utilpointer.To(secretUUID),
- }
- var i sm.SecretIntf = secret
- return i
- }
- func makeValidGetByNameInput() *sm.GetSecretByNameTypeOptions {
- return &sm.GetSecretByNameTypeOptions{}
- }
- func makeValidSecretManagerTestCaseCustom(tweaks ...func(smtc *secretManagerTestCase)) *secretManagerTestCase {
- smtc := makeValidSecretManagerTestCase()
- for _, fn := range tweaks {
- fn(smtc)
- }
- mcParams := fakesm.IBMMockClientParams{
- GetSecretOptions: smtc.apiInput,
- GetSecretOutput: smtc.apiOutput,
- GetSecretErr: smtc.apiErr,
- GetSecretByNameOptions: smtc.getByNameInput,
- GetSecretByNameOutput: smtc.getByNameOutput,
- GetSecretByNameErr: smtc.apiErr,
- }
- smtc.mockClient.WithValue(mcParams)
- return smtc
- }
- // This case can be shared by both GetSecret and GetSecretMap tests.
- // bad case: set apiErr.
- var setAPIErr = func(smtc *secretManagerTestCase) {
- smtc.apiErr = errors.New("oh no")
- smtc.expectError = "oh no"
- }
- var setNilMockClient = func(smtc *secretManagerTestCase) {
- smtc.mockClient = nil
- smtc.expectError = errUninitializedIBMProvider
- }
- // simple tests for Validate Store.
- func TestValidateStore(t *testing.T) {
- p := providerIBM{}
- store := &esv1beta1.SecretStore{
- Spec: esv1beta1.SecretStoreSpec{
- Provider: &esv1beta1.SecretStoreProvider{
- IBM: &esv1beta1.IBMProvider{},
- },
- },
- }
- _, err := p.ValidateStore(store)
- if err == nil {
- t.Error(errExpectedErr)
- } else if err.Error() != "serviceURL is required" {
- t.Errorf("service URL test failed")
- }
- url := "my-url"
- store.Spec.Provider.IBM.ServiceURL = &url
- _, err = p.ValidateStore(store)
- if err == nil {
- t.Error(errExpectedErr)
- } else if err.Error() != "missing auth method" {
- t.Errorf("KeySelector test failed: expected missing auth method, got %v", err)
- }
- ns := "ns-one"
- store.Spec.Provider.IBM.Auth.SecretRef = &esv1beta1.IBMAuthSecretRef{
- SecretAPIKey: v1.SecretKeySelector{
- Name: "foo",
- Key: "bar",
- Namespace: &ns,
- },
- }
- _, err = p.ValidateStore(store)
- if err == nil {
- t.Error(errExpectedErr)
- } else if err.Error() != "namespace should either be empty or match the namespace of the SecretStore for a namespaced SecretStore" {
- t.Errorf("KeySelector test failed: expected namespace not allowed, got %v", err)
- }
- // add container auth test
- store = &esv1beta1.SecretStore{
- Spec: esv1beta1.SecretStoreSpec{
- Provider: &esv1beta1.SecretStoreProvider{
- IBM: &esv1beta1.IBMProvider{
- ServiceURL: &url,
- Auth: esv1beta1.IBMAuth{
- ContainerAuth: &esv1beta1.IBMAuthContainerAuth{
- Profile: "Trusted IAM Profile",
- TokenLocation: "/a/path/to/nowhere/that/should/exist",
- },
- },
- },
- },
- },
- }
- _, err = p.ValidateStore(store)
- expected := "cannot read container auth token"
- if !ErrorContains(err, expected) {
- t.Errorf("ProfileSelector test failed: %s, expected: '%s'", err.Error(), expected)
- }
- }
- // test the sm<->gcp interface
- // make sure correct values are passed and errors are handled accordingly.
- func TestIBMSecretManagerGetSecret(t *testing.T) {
- secretString := "changedvalue"
- secretUsername := "userName"
- secretPassword := "P@ssw0rd"
- secretAPIKey := "01234567890"
- secretCertificate := "certificate_value"
- // good case: default version is set
- // key is passed in, output is sent back
- setSecretString := func(smtc *secretManagerTestCase) {
- secret := &sm.ArbitrarySecret{
- SecretType: utilpointer.To(sm.Secret_SecretType_Arbitrary),
- Name: utilpointer.To("testyname"),
- ID: utilpointer.To(secretUUID),
- Payload: &secretString,
- }
- smtc.name = "good case: default version is set"
- smtc.apiOutput = secret
- smtc.apiInput.ID = utilpointer.To(secretUUID)
- smtc.expectedSecret = secretString
- }
- // good case: custom version set
- setCustomKey := func(smtc *secretManagerTestCase) {
- secret := &sm.ArbitrarySecret{
- SecretType: utilpointer.To(sm.Secret_SecretType_Arbitrary),
- Name: utilpointer.To("testyname"),
- ID: utilpointer.To(secretUUID),
- Payload: &secretString,
- }
- smtc.name = "good case: custom version set"
- smtc.ref.Key = "arbitrary/" + secretUUID
- smtc.apiInput.ID = utilpointer.To(secretUUID)
- smtc.apiOutput = secret
- smtc.expectedSecret = secretString
- }
- // bad case: arbitrary type secret which is destroyed
- badArbitSecret := func(smtc *secretManagerTestCase) {
- secret := &sm.ArbitrarySecret{
- SecretType: utilpointer.To(sm.Secret_SecretType_Arbitrary),
- Name: utilpointer.To("testyname"),
- ID: utilpointer.To(secretUUID),
- }
- smtc.name = "bad case: arbitrary type without property"
- smtc.apiInput.ID = utilpointer.To(secretUUID)
- smtc.apiOutput = secret
- smtc.ref.Key = secretUUID
- smtc.expectError = "key payload does not exist in secret " + secretUUID
- }
- // bad case: username_password type without property
- secretUserPass := "username_password/" + secretUUID
- badSecretUserPass := func(smtc *secretManagerTestCase) {
- secret := &sm.UsernamePasswordSecret{
- SecretType: utilpointer.To(sm.Secret_SecretType_UsernamePassword),
- Name: utilpointer.To("testyname"),
- ID: utilpointer.To(secretUUID),
- Username: &secretUsername,
- Password: &secretPassword,
- }
- smtc.name = "bad case: username_password type without property"
- smtc.apiInput.ID = utilpointer.To(secretUUID)
- smtc.apiOutput = secret
- smtc.ref.Key = secretUserPass
- smtc.expectError = "remoteRef.property required for secret type username_password"
- }
- // good case: username_password type with property
- funcSetUserPass := func(secretName, property, name string) func(smtc *secretManagerTestCase) {
- return func(smtc *secretManagerTestCase) {
- secret := &sm.UsernamePasswordSecret{
- SecretType: utilpointer.To(sm.Secret_SecretType_UsernamePassword),
- Name: utilpointer.To("testyname"),
- ID: utilpointer.To(secretUUID),
- Username: &secretUsername,
- Password: &secretPassword,
- }
- smtc.name = name
- smtc.apiInput.ID = utilpointer.To(secretUUID)
- smtc.apiOutput = secret
- smtc.ref.Key = "username_password/" + secretName
- smtc.ref.Property = property
- if property == "username" {
- smtc.expectedSecret = secretUsername
- } else {
- smtc.expectedSecret = secretPassword
- }
- }
- }
- setSecretUserPassByID := funcSetUserPass(secretUUID, "username", "good case: username_password type - get username by ID")
- // good case: iam_credentials type
- funcSetSecretIam := func(secretName, name string) func(*secretManagerTestCase) {
- return func(smtc *secretManagerTestCase) {
- secret := &sm.IAMCredentialsSecret{
- SecretType: utilpointer.To(sm.Secret_SecretType_IamCredentials),
- Name: utilpointer.To("testyname"),
- ID: utilpointer.To(secretUUID),
- ApiKey: utilpointer.To(secretAPIKey),
- }
- smtc.apiInput.ID = utilpointer.To(secretUUID)
- smtc.name = name
- smtc.apiOutput = secret
- smtc.ref.Key = iamCredentialsSecret + secretName
- smtc.expectedSecret = secretAPIKey
- }
- }
- setSecretIamByID := funcSetSecretIam(secretUUID, "good case: iam_credenatials type - get API Key by ID")
- // good case: iam_credentials type - get API Key by name, providing the secret group ID
- funcSetSecretIamNew := func(secretName, groupName, name string) func(*secretManagerTestCase) {
- return func(smtc *secretManagerTestCase) {
- secret := &sm.IAMCredentialsSecret{
- SecretType: utilpointer.To(sm.Secret_SecretType_IamCredentials),
- Name: utilpointer.To("testyname"),
- ID: utilpointer.To(secretUUID),
- ApiKey: utilpointer.To(secretAPIKey),
- }
- smtc.getByNameInput.Name = &secretName
- smtc.getByNameInput.SecretGroupName = &groupName
- smtc.getByNameInput.SecretType = utilpointer.To(sm.Secret_SecretType_IamCredentials)
- smtc.name = name
- smtc.getByNameOutput = secret
- smtc.ref.Key = groupName + "/" + iamCredentialsSecret + secretName
- smtc.expectedSecret = secretAPIKey
- }
- }
- setSecretIamByNameNew := funcSetSecretIamNew("testyname", "testGroup", "good case: iam_credenatials type - get API Key by name - new mechanism")
- // good case: service_credentials type
- dummySrvCreds := &sm.ServiceCredentialsSecretCredentials{
- Apikey: &secretAPIKey,
- }
- funcSetSecretSrvCred := func(secretName, name string) func(*secretManagerTestCase) {
- return func(smtc *secretManagerTestCase) {
- secret := &sm.ServiceCredentialsSecret{
- SecretType: utilpointer.To(sm.Secret_SecretType_ServiceCredentials),
- Name: utilpointer.To("testyname"),
- ID: utilpointer.To(secretUUID),
- Credentials: dummySrvCreds,
- }
- smtc.apiInput.ID = utilpointer.To(secretUUID)
- smtc.name = name
- smtc.apiOutput = secret
- smtc.ref.Key = "service_credentials/" + secretName
- smtc.expectedSecret = "{\"apikey\":\"01234567890\"}"
- }
- }
- setSecretSrvCredByID := funcSetSecretSrvCred(secretUUID, "good case: service_credentials type - get creds by ID")
- funcSetCertSecretTest := func(secret sm.SecretIntf, name, certType string, good bool) func(*secretManagerTestCase) {
- return func(smtc *secretManagerTestCase) {
- smtc.name = name
- smtc.apiInput.ID = utilpointer.To(secretUUID)
- smtc.apiOutput = secret
- smtc.ref.Key = certType + "/" + secretUUID
- if good {
- smtc.ref.Property = "certificate"
- smtc.expectedSecret = secretCertificate
- } else {
- smtc.expectError = "remoteRef.property required for secret type " + certType
- }
- }
- }
- // good case: imported_cert type with property
- importedCert := &sm.ImportedCertificate{
- SecretType: utilpointer.To(sm.Secret_SecretType_ImportedCert),
- Name: utilpointer.To("testyname"),
- ID: utilpointer.To(secretUUID),
- Certificate: utilpointer.To(secretCertificate),
- Intermediate: utilpointer.To("intermediate"),
- PrivateKey: utilpointer.To("private_key"),
- }
- setSecretCert := funcSetCertSecretTest(importedCert, "good case: imported_cert type with property", sm.Secret_SecretType_ImportedCert, true)
- // good case: imported_cert type without a private_key
- importedCertNoPvtKey := func(smtc *secretManagerTestCase) {
- secret := &sm.ImportedCertificate{
- SecretType: utilpointer.To(sm.Secret_SecretType_ImportedCert),
- Name: utilpointer.To("testyname"),
- ID: utilpointer.To(secretUUID),
- Certificate: utilpointer.To(secretCertificate),
- }
- smtc.name = "good case: imported cert without private key"
- smtc.apiInput.ID = utilpointer.To(secretUUID)
- smtc.apiOutput = secret
- smtc.ref.Key = "imported_cert/" + secretUUID
- smtc.ref.Property = "private_key"
- smtc.expectedSecret = ""
- }
- // bad case: imported_cert type without property
- badSecretCert := funcSetCertSecretTest(importedCert, "bad case: imported_cert type without property", sm.Secret_SecretType_ImportedCert, false)
- // good case: public_cert type with property
- publicCert := &sm.PublicCertificate{
- SecretType: utilpointer.To(sm.Secret_SecretType_PublicCert),
- Name: utilpointer.To("testyname"),
- ID: utilpointer.To(secretUUID),
- Certificate: utilpointer.To(secretCertificate),
- Intermediate: utilpointer.To("intermediate"),
- PrivateKey: utilpointer.To("private_key"),
- }
- setSecretPublicCert := funcSetCertSecretTest(publicCert, "good case: public_cert type with property", sm.Secret_SecretType_PublicCert, true)
- // bad case: public_cert type without property
- badSecretPublicCert := funcSetCertSecretTest(publicCert, "bad case: public_cert type without property", sm.Secret_SecretType_PublicCert, false)
- // good case: private_cert type with property
- privateCert := &sm.PrivateCertificate{
- SecretType: utilpointer.To(sm.Secret_SecretType_PublicCert),
- Name: utilpointer.To("testyname"),
- ID: utilpointer.To(secretUUID),
- Certificate: utilpointer.To(secretCertificate),
- PrivateKey: utilpointer.To("private_key"),
- }
- setSecretPrivateCert := funcSetCertSecretTest(privateCert, "good case: private_cert type with property", sm.Secret_SecretType_PrivateCert, true)
- // bad case: private_cert type without property
- badSecretPrivateCert := funcSetCertSecretTest(privateCert, "bad case: private_cert type without property", sm.Secret_SecretType_PrivateCert, false)
- secretDataKV := make(map[string]any)
- secretDataKV["key1"] = "val1"
- secretDataKVComplex := make(map[string]any)
- secretKVComplex := `{"key1":"val1","key2":"val2","key3":"val3","keyC":{"keyC1":"valC1","keyC2":"valC2"},"special.log":"file-content"}`
- json.Unmarshal([]byte(secretKVComplex), &secretDataKVComplex)
- secretKV := "kv/" + secretUUID
- // bad case: kv type with key which is not in payload
- badSecretKV := func(smtc *secretManagerTestCase) {
- secret := &sm.KVSecret{
- SecretType: utilpointer.To(sm.Secret_SecretType_Kv),
- Name: utilpointer.To("testyname"),
- ID: utilpointer.To(secretUUID),
- Data: secretDataKV,
- }
- smtc.name = "bad case: kv type with key which is not in payload"
- smtc.apiInput.ID = utilpointer.To(secretUUID)
- smtc.apiOutput = secret
- smtc.ref.Key = secretKV
- smtc.ref.Property = "other-key"
- smtc.expectError = "key other-key does not exist in secret kv/" + secretUUID
- }
- // good case: kv type with property
- setSecretKV := func(smtc *secretManagerTestCase) {
- secret := &sm.KVSecret{
- SecretType: utilpointer.To(sm.Secret_SecretType_Kv),
- Name: utilpointer.To("testyname"),
- ID: utilpointer.To(secretUUID),
- Data: secretDataKV,
- }
- smtc.name = "good case: kv type with property"
- smtc.apiInput.ID = utilpointer.To(secretUUID)
- smtc.apiOutput = secret
- smtc.ref.Key = secretKV
- smtc.ref.Property = "key1"
- smtc.expectedSecret = "val1"
- }
- // good case: kv type with property, returns specific value
- setSecretKVWithKey := func(smtc *secretManagerTestCase) {
- secret := &sm.KVSecret{
- SecretType: utilpointer.To(sm.Secret_SecretType_Kv),
- Name: utilpointer.To("testyname"),
- ID: utilpointer.To(secretUUID),
- Data: secretDataKVComplex,
- }
- smtc.name = "good case: kv type with property, returns specific value"
- smtc.apiInput.ID = utilpointer.To(secretUUID)
- smtc.apiOutput = secret
- smtc.ref.Key = secretKV
- smtc.ref.Property = "key2"
- smtc.expectedSecret = "val2"
- }
- // good case: kv type with property and path, returns specific value
- setSecretKVWithKeyPath := func(smtc *secretManagerTestCase) {
- secret := &sm.KVSecret{
- SecretType: utilpointer.To(sm.Secret_SecretType_Kv),
- Name: utilpointer.To("testyname"),
- ID: utilpointer.To(secretUUID),
- Data: secretDataKVComplex,
- }
- smtc.name = "good case: kv type with property and path, returns specific value"
- smtc.apiInput.ID = utilpointer.To(secretUUID)
- smtc.apiOutput = secret
- smtc.ref.Key = secretKV
- smtc.ref.Property = "keyC.keyC2"
- smtc.expectedSecret = "valC2"
- }
- // good case: kv type with property and dot, returns specific value
- setSecretKVWithKeyDot := func(smtc *secretManagerTestCase) {
- secret := &sm.KVSecret{
- SecretType: utilpointer.To(sm.Secret_SecretType_Kv),
- Name: utilpointer.To("testyname"),
- ID: utilpointer.To(secretUUID),
- Data: secretDataKVComplex,
- }
- smtc.name = "good case: kv type with property and dot, returns specific value"
- smtc.apiInput.ID = utilpointer.To(secretUUID)
- smtc.apiOutput = secret
- smtc.ref.Key = secretKV
- smtc.ref.Property = "special.log"
- smtc.expectedSecret = "file-content"
- }
- // good case: kv type without property, returns all
- setSecretKVWithOutKey := func(smtc *secretManagerTestCase) {
- secret := &sm.KVSecret{
- SecretType: utilpointer.To(sm.Secret_SecretType_Kv),
- Name: utilpointer.To("testyname"),
- ID: utilpointer.To(secretUUID),
- Data: secretDataKVComplex,
- }
- smtc.name = "good case: kv type without property, returns all"
- smtc.apiInput.ID = utilpointer.To(secretUUID)
- smtc.apiOutput = secret
- smtc.ref.Key = secretKV
- smtc.expectedSecret = secretKVComplex
- }
- successCases := []*secretManagerTestCase{
- makeValidSecretManagerTestCaseCustom(setSecretString),
- makeValidSecretManagerTestCaseCustom(setCustomKey),
- makeValidSecretManagerTestCaseCustom(badArbitSecret),
- makeValidSecretManagerTestCaseCustom(setAPIErr),
- makeValidSecretManagerTestCaseCustom(setNilMockClient),
- makeValidSecretManagerTestCaseCustom(badSecretUserPass),
- makeValidSecretManagerTestCaseCustom(setSecretUserPassByID),
- makeValidSecretManagerTestCaseCustom(setSecretIamByID),
- makeValidSecretManagerTestCaseCustom(setSecretCert),
- makeValidSecretManagerTestCaseCustom(setSecretKV),
- makeValidSecretManagerTestCaseCustom(setSecretKVWithKey),
- makeValidSecretManagerTestCaseCustom(setSecretKVWithKeyPath),
- makeValidSecretManagerTestCaseCustom(setSecretKVWithKeyDot),
- makeValidSecretManagerTestCaseCustom(setSecretKVWithOutKey),
- makeValidSecretManagerTestCaseCustom(badSecretKV),
- makeValidSecretManagerTestCaseCustom(badSecretCert),
- makeValidSecretManagerTestCaseCustom(importedCertNoPvtKey),
- makeValidSecretManagerTestCaseCustom(setSecretPublicCert),
- makeValidSecretManagerTestCaseCustom(badSecretPublicCert),
- makeValidSecretManagerTestCaseCustom(setSecretPrivateCert),
- makeValidSecretManagerTestCaseCustom(badSecretPrivateCert),
- makeValidSecretManagerTestCaseCustom(setSecretIamByNameNew),
- makeValidSecretManagerTestCaseCustom(setSecretSrvCredByID),
- }
- sm := providerIBM{}
- for _, v := range successCases {
- t.Run(v.name, func(t *testing.T) {
- sm.IBMClient = v.mockClient
- out, err := sm.GetSecret(context.Background(), *v.ref)
- if !ErrorContains(err, v.expectError) {
- t.Errorf("unexpected error:\n%s, expected:\n'%s'", err.Error(), v.expectError)
- }
- if string(out) != v.expectedSecret {
- t.Errorf("unexpected secret: expected:\n%s\ngot:\n%s", v.expectedSecret, string(out))
- }
- })
- }
- }
- func TestGetSecretMap(t *testing.T) {
- secretUsername := "user1"
- secretPassword := "P@ssw0rd"
- secretAPIKey := "01234567890"
- nilValue := "<nil>"
- secretCertificate := "certificate_value"
- secretPrivateKey := "private_key_value"
- secretIntermediate := "intermediate_value"
- timeValue := "0001-01-01T00:00:00.000Z"
- secretComplex := map[string]any{
- "key1": "val1",
- "key2": "val2",
- "keyC": map[string]any{
- "keyC1": map[string]string{
- "keyA": "valA",
- "keyB": "valB",
- },
- },
- }
- dummySrvCreds := &sm.ServiceCredentialsSecretCredentials{
- Apikey: &secretAPIKey,
- }
- // good case: arbitrary
- setArbitrary := func(smtc *secretManagerTestCase) {
- payload := `{"foo":"bar"}`
- secret := &sm.ArbitrarySecret{
- Name: utilpointer.To("testyname"),
- ID: utilpointer.To(secretUUID),
- SecretType: utilpointer.To(sm.Secret_SecretType_Arbitrary),
- Payload: &payload,
- }
- smtc.name = "good case: arbitrary"
- smtc.apiInput.ID = utilpointer.To(secretUUID)
- smtc.apiOutput = secret
- smtc.ref.Key = secretUUID
- smtc.expectedData["arbitrary"] = []byte(payload)
- }
- // good case: username_password
- setSecretUserPass := func(smtc *secretManagerTestCase) {
- secret := &sm.UsernamePasswordSecret{
- Name: utilpointer.To("testyname"),
- ID: utilpointer.To(secretUUID),
- SecretType: utilpointer.To(sm.Secret_SecretType_UsernamePassword),
- Username: &secretUsername,
- Password: &secretPassword,
- }
- smtc.name = "good case: username_password"
- smtc.apiInput.ID = utilpointer.To(secretUUID)
- smtc.apiOutput = secret
- smtc.ref.Key = "username_password/" + secretUUID
- smtc.expectedData["username"] = []byte(secretUsername)
- smtc.expectedData["password"] = []byte(secretPassword)
- }
- // good case: iam_credentials
- setSecretIam := func(smtc *secretManagerTestCase) {
- secret := &sm.IAMCredentialsSecret{
- Name: utilpointer.To("testyname"),
- ID: utilpointer.To(secretUUID),
- SecretType: utilpointer.To(sm.Secret_SecretType_IamCredentials),
- ApiKey: utilpointer.To(secretAPIKey),
- }
- smtc.name = "good case: iam_credentials"
- smtc.apiInput.ID = utilpointer.To(secretUUID)
- smtc.apiOutput = secret
- smtc.ref.Key = iamCredentialsSecret + secretUUID
- smtc.expectedData["apikey"] = []byte(secretAPIKey)
- }
- // good case: iam_credentials by name using new mechanism
- setSecretIamByName := func(smtc *secretManagerTestCase) {
- secret := &sm.IAMCredentialsSecret{
- Name: utilpointer.To("testyname"),
- ID: utilpointer.To(secretUUID),
- SecretType: utilpointer.To(sm.Secret_SecretType_IamCredentials),
- ApiKey: utilpointer.To(secretAPIKey),
- }
- smtc.name = "good case: iam_credentials by name using new mechanism"
- smtc.getByNameInput.Name = utilpointer.To("testyname")
- smtc.getByNameInput.SecretGroupName = utilpointer.To("groupName")
- smtc.getByNameInput.SecretType = utilpointer.To(sm.Secret_SecretType_IamCredentials)
- smtc.getByNameOutput = secret
- smtc.apiOutput = secret
- smtc.ref.Key = "groupName/" + iamCredentialsSecret + "testyname"
- smtc.expectedData["apikey"] = []byte(secretAPIKey)
- }
- // bad case: iam_credentials of a destroyed secret
- badSecretIam := func(smtc *secretManagerTestCase) {
- secret := &sm.IAMCredentialsSecret{
- Name: utilpointer.To("testyname"),
- ID: utilpointer.To(secretUUID),
- SecretType: utilpointer.To(sm.Secret_SecretType_IamCredentials),
- }
- smtc.name = "bad case: iam_credentials of a destroyed secret"
- smtc.apiInput.ID = utilpointer.To(secretUUID)
- smtc.apiOutput = secret
- smtc.ref.Key = iamCredentialsSecret + secretUUID
- smtc.expectError = "key api_key does not exist in secret " + secretUUID
- }
- funcCertTest := func(secret sm.SecretIntf, name, certType string) func(*secretManagerTestCase) {
- return func(smtc *secretManagerTestCase) {
- smtc.name = name
- smtc.apiInput.ID = utilpointer.To(secretUUID)
- smtc.apiOutput = secret
- smtc.ref.Key = certType + "/" + secretUUID
- smtc.expectedData["certificate"] = []byte(secretCertificate)
- smtc.expectedData["private_key"] = []byte(secretPrivateKey)
- smtc.expectedData["intermediate"] = []byte(secretIntermediate)
- }
- }
- // good case: service_credentials
- setSecretSrvCreds := func(smtc *secretManagerTestCase) {
- secret := &sm.ServiceCredentialsSecret{
- Name: utilpointer.To("testyname"),
- ID: utilpointer.To(secretUUID),
- SecretType: utilpointer.To(sm.Secret_SecretType_IamCredentials),
- Credentials: dummySrvCreds,
- }
- smtc.name = "good case: service_credentials"
- smtc.apiInput.ID = utilpointer.To(secretUUID)
- smtc.apiOutput = secret
- smtc.ref.Key = "service_credentials/" + secretUUID
- smtc.expectedData["credentials"] = []byte(fmt.Sprintf("%+v", map[string]string{"apikey": secretAPIKey}))
- }
- // good case: imported_cert
- importedCert := &sm.ImportedCertificate{
- SecretType: utilpointer.To(sm.Secret_SecretType_ImportedCert),
- Name: utilpointer.To("testyname"),
- ID: utilpointer.To(secretUUID),
- Certificate: utilpointer.To(secretCertificate),
- Intermediate: utilpointer.To(secretIntermediate),
- PrivateKey: utilpointer.To(secretPrivateKey),
- }
- setSecretCert := funcCertTest(importedCert, "good case: imported_cert", sm.Secret_SecretType_ImportedCert)
- // good case: public_cert
- publicCert := &sm.PublicCertificate{
- SecretType: utilpointer.To(sm.Secret_SecretType_PublicCert),
- Name: utilpointer.To("testyname"),
- ID: utilpointer.To(secretUUID),
- Certificate: utilpointer.To(secretCertificate),
- Intermediate: utilpointer.To(secretIntermediate),
- PrivateKey: utilpointer.To(secretPrivateKey),
- }
- setSecretPublicCert := funcCertTest(publicCert, "good case: public_cert", sm.Secret_SecretType_PublicCert)
- // good case: private_cert
- setSecretPrivateCert := func(smtc *secretManagerTestCase) {
- secret := &sm.PrivateCertificate{
- Name: utilpointer.To("testyname"),
- ID: utilpointer.To(secretUUID),
- SecretType: utilpointer.To(sm.Secret_SecretType_PrivateCert),
- Certificate: &secretCertificate,
- PrivateKey: &secretPrivateKey,
- }
- smtc.name = "good case: private_cert"
- smtc.apiInput.ID = utilpointer.To(secretUUID)
- smtc.apiOutput = secret
- smtc.ref.Key = "private_cert/" + secretUUID
- smtc.expectedData["certificate"] = []byte(secretCertificate)
- smtc.expectedData["private_key"] = []byte(secretPrivateKey)
- }
- // good case: arbitrary with metadata
- setArbitraryWithMetadata := func(smtc *secretManagerTestCase) {
- payload := `{"foo":"bar"}`
- secret := &sm.ArbitrarySecret{
- CreatedBy: utilpointer.To("testCreatedBy"),
- CreatedAt: &strfmt.DateTime{},
- Downloaded: utilpointer.To(false),
- Labels: []string{"abc", "def", "xyz"},
- LocksTotal: utilpointer.To(int64(20)),
- Payload: &payload,
- }
- smtc.name = "good case: arbitrary with metadata"
- smtc.apiInput.ID = utilpointer.To(secretUUID)
- smtc.apiOutput = secret
- smtc.ref.Key = secretUUID
- smtc.ref.MetadataPolicy = esv1beta1.ExternalSecretMetadataPolicyFetch
- smtc.expectedData = map[string][]byte{
- "arbitrary": []byte(payload),
- "created_at": []byte(timeValue),
- "created_by": []byte(*secret.CreatedBy),
- "crn": []byte(nilValue),
- "downloaded": []byte(strconv.FormatBool(*secret.Downloaded)),
- "id": []byte(nilValue),
- "labels": []byte("[" + strings.Join(secret.Labels, " ") + "]"),
- "locks_total": []byte(strconv.Itoa(int(*secret.LocksTotal))),
- "payload": []byte(payload),
- "secret_group_id": []byte(nilValue),
- "secret_type": []byte(nilValue),
- "updated_at": []byte(nilValue),
- "versions_total": []byte(nilValue),
- }
- }
- // good case: iam_credentials with metadata
- setSecretIamWithMetadata := func(smtc *secretManagerTestCase) {
- secret := &sm.IAMCredentialsSecret{
- CreatedBy: utilpointer.To("testCreatedBy"),
- CreatedAt: &strfmt.DateTime{},
- Downloaded: utilpointer.To(false),
- Labels: []string{"abc", "def", "xyz"},
- LocksTotal: utilpointer.To(int64(20)),
- ApiKey: utilpointer.To(secretAPIKey),
- }
- smtc.name = "good case: iam_credentials with metadata"
- smtc.apiInput.ID = utilpointer.To(secretUUID)
- smtc.apiOutput = secret
- smtc.ref.Key = iamCredentialsSecret + secretUUID
- smtc.ref.MetadataPolicy = esv1beta1.ExternalSecretMetadataPolicyFetch
- smtc.expectedData = map[string][]byte{
- "api_key": []byte(secretAPIKey),
- "apikey": []byte(secretAPIKey),
- "created_at": []byte(timeValue),
- "created_by": []byte(*secret.CreatedBy),
- "crn": []byte(nilValue),
- "downloaded": []byte(strconv.FormatBool(*secret.Downloaded)),
- "id": []byte(nilValue),
- "labels": []byte("[" + strings.Join(secret.Labels, " ") + "]"),
- "locks_total": []byte(strconv.Itoa(int(*secret.LocksTotal))),
- "reuse_api_key": []byte(nilValue),
- "secret_group_id": []byte(nilValue),
- "secret_type": []byte(nilValue),
- "ttl": []byte(nilValue),
- "updated_at": []byte(nilValue),
- "versions_total": []byte(nilValue),
- }
- }
- // "good case: username_password with metadata
- setSecretUserPassWithMetadata := func(smtc *secretManagerTestCase) {
- secret := &sm.UsernamePasswordSecret{
- CreatedBy: utilpointer.To("testCreatedBy"),
- CreatedAt: &strfmt.DateTime{},
- Downloaded: utilpointer.To(false),
- Labels: []string{"abc", "def", "xyz"},
- LocksTotal: utilpointer.To(int64(20)),
- Username: &secretUsername,
- Password: &secretPassword,
- }
- smtc.name = "good case: username_password with metadata"
- smtc.apiInput.ID = utilpointer.To(secretUUID)
- smtc.apiOutput = secret
- smtc.ref.Key = "username_password/" + secretUUID
- smtc.expectedData["username"] = []byte(secretUsername)
- smtc.expectedData["password"] = []byte(secretPassword)
- smtc.ref.MetadataPolicy = esv1beta1.ExternalSecretMetadataPolicyFetch
- smtc.expectedData = map[string][]byte{
- "created_at": []byte(timeValue),
- "created_by": []byte(*secret.CreatedBy),
- "crn": []byte(nilValue),
- "downloaded": []byte(strconv.FormatBool(*secret.Downloaded)),
- "id": []byte(nilValue),
- "labels": []byte("[" + strings.Join(secret.Labels, " ") + "]"),
- "locks_total": []byte(strconv.Itoa(int(*secret.LocksTotal))),
- "password": []byte(secretPassword),
- "rotation": []byte(nilValue),
- "secret_group_id": []byte(nilValue),
- "secret_type": []byte(nilValue),
- "updated_at": []byte(nilValue),
- "username": []byte(secretUsername),
- "versions_total": []byte(nilValue),
- }
- }
- // good case: imported_cert with metadata
- setimportedCertWithMetadata := func(smtc *secretManagerTestCase) {
- secret := &sm.ImportedCertificate{
- CreatedBy: utilpointer.To("testCreatedBy"),
- CreatedAt: &strfmt.DateTime{},
- Downloaded: utilpointer.To(false),
- Labels: []string{"abc", "def", "xyz"},
- LocksTotal: utilpointer.To(int64(20)),
- Certificate: utilpointer.To(secretCertificate),
- Intermediate: utilpointer.To(secretIntermediate),
- PrivateKey: utilpointer.To(secretPrivateKey),
- }
- smtc.name = "good case: imported_cert with metadata"
- smtc.apiInput.ID = utilpointer.To(secretUUID)
- smtc.apiOutput = secret
- smtc.ref.Key = "imported_cert" + "/" + secretUUID
- smtc.ref.MetadataPolicy = esv1beta1.ExternalSecretMetadataPolicyFetch
- smtc.expectedData = map[string][]byte{
- "certificate": []byte(secretCertificate),
- "created_at": []byte(timeValue),
- "created_by": []byte(*secret.CreatedBy),
- "crn": []byte(nilValue),
- "downloaded": []byte(strconv.FormatBool(*secret.Downloaded)),
- "expiration_date": []byte(nilValue),
- "id": []byte(nilValue),
- "intermediate": []byte(secretIntermediate),
- "intermediate_included": []byte(nilValue),
- "issuer": []byte(nilValue),
- "labels": []byte("[" + strings.Join(secret.Labels, " ") + "]"),
- "locks_total": []byte(strconv.Itoa(int(*secret.LocksTotal))),
- "private_key": []byte(secretPrivateKey),
- "private_key_included": []byte(nilValue),
- "secret_group_id": []byte(nilValue),
- "secret_type": []byte(nilValue),
- "serial_number": []byte(nilValue),
- "signing_algorithm": []byte(nilValue),
- "updated_at": []byte(nilValue),
- "validity": []byte(nilValue),
- "versions_total": []byte(nilValue),
- }
- }
- // good case: imported_cert without a private_key
- setimportedCertWithNoPvtKey := func(smtc *secretManagerTestCase) {
- secret := &sm.ImportedCertificate{
- CreatedBy: utilpointer.To("testCreatedBy"),
- CreatedAt: &strfmt.DateTime{},
- Downloaded: utilpointer.To(false),
- Labels: []string{"abc", "def", "xyz"},
- LocksTotal: utilpointer.To(int64(20)),
- Certificate: utilpointer.To(secretCertificate),
- Intermediate: utilpointer.To(secretIntermediate),
- }
- smtc.name = "good case: imported_cert without private key"
- smtc.apiInput.ID = utilpointer.To(secretUUID)
- smtc.apiOutput = secret
- smtc.ref.Key = "imported_cert/" + secretUUID
- smtc.expectedData = map[string][]byte{
- "certificate": []byte(secretCertificate),
- "intermediate": []byte(secretIntermediate),
- "private_key": []byte(""),
- }
- }
- // good case: public_cert with metadata
- setPublicCertWithMetadata := func(smtc *secretManagerTestCase) {
- secret := &sm.PublicCertificate{
- CreatedBy: utilpointer.To("testCreatedBy"),
- CreatedAt: &strfmt.DateTime{},
- Downloaded: utilpointer.To(false),
- Labels: []string{"abc", "def", "xyz"},
- LocksTotal: utilpointer.To(int64(20)),
- Certificate: utilpointer.To(secretCertificate),
- Intermediate: utilpointer.To(secretIntermediate),
- PrivateKey: utilpointer.To(secretPrivateKey),
- }
- smtc.name = "good case: public_cert with metadata"
- smtc.apiInput.ID = utilpointer.To(secretUUID)
- smtc.apiOutput = secret
- smtc.ref.Key = "public_cert" + "/" + secretUUID
- smtc.ref.MetadataPolicy = esv1beta1.ExternalSecretMetadataPolicyFetch
- smtc.expectedData = map[string][]byte{
- "certificate": []byte(secretCertificate),
- "common_name": []byte(nilValue),
- "created_at": []byte(timeValue),
- "created_by": []byte(*secret.CreatedBy),
- "crn": []byte(nilValue),
- "downloaded": []byte(strconv.FormatBool(*secret.Downloaded)),
- "id": []byte(nilValue),
- "intermediate": []byte(secretIntermediate),
- "key_algorithm": []byte(nilValue),
- "labels": []byte("[" + strings.Join(secret.Labels, " ") + "]"),
- "locks_total": []byte(strconv.Itoa(int(*secret.LocksTotal))),
- "private_key": []byte(secretPrivateKey),
- "rotation": []byte(nilValue),
- "secret_group_id": []byte(nilValue),
- "secret_type": []byte(nilValue),
- "updated_at": []byte(nilValue),
- "versions_total": []byte(nilValue),
- }
- }
- // good case: private_cert with metadata
- setPrivateCertWithMetadata := func(smtc *secretManagerTestCase) {
- secret := &sm.PrivateCertificate{
- CreatedBy: utilpointer.To("testCreatedBy"),
- CreatedAt: &strfmt.DateTime{},
- Downloaded: utilpointer.To(false),
- Labels: []string{"abc", "def", "xyz"},
- LocksTotal: utilpointer.To(int64(20)),
- Certificate: utilpointer.To(secretCertificate),
- PrivateKey: utilpointer.To(secretPrivateKey),
- }
- smtc.name = "good case: private_cert with metadata"
- smtc.apiInput.ID = utilpointer.To(secretUUID)
- smtc.apiOutput = secret
- smtc.ref.Key = "private_cert" + "/" + secretUUID
- smtc.ref.MetadataPolicy = esv1beta1.ExternalSecretMetadataPolicyFetch
- smtc.expectedData = map[string][]byte{
- "certificate": []byte(secretCertificate),
- "certificate_template": []byte(nilValue),
- "common_name": []byte(nilValue),
- "created_at": []byte(timeValue),
- "created_by": []byte(*secret.CreatedBy),
- "crn": []byte(nilValue),
- "downloaded": []byte(strconv.FormatBool(*secret.Downloaded)),
- "expiration_date": []byte(nilValue),
- "id": []byte(nilValue),
- "issuer": []byte(nilValue),
- "labels": []byte("[" + strings.Join(secret.Labels, " ") + "]"),
- "locks_total": []byte(strconv.Itoa(int(*secret.LocksTotal))),
- "private_key": []byte(secretPrivateKey),
- "secret_group_id": []byte(nilValue),
- "secret_type": []byte(nilValue),
- "serial_number": []byte(nilValue),
- "signing_algorithm": []byte(nilValue),
- "updated_at": []byte(nilValue),
- "validity": []byte(nilValue),
- "versions_total": []byte(nilValue),
- }
- }
- // good case: kv with property and metadata
- setSecretKVWithMetadata := func(smtc *secretManagerTestCase) {
- secret := &sm.KVSecret{
- CreatedBy: utilpointer.To("testCreatedBy"),
- CreatedAt: &strfmt.DateTime{},
- Downloaded: utilpointer.To(false),
- Labels: []string{"abc", "def", "xyz"},
- LocksTotal: utilpointer.To(int64(20)),
- Data: secretComplex,
- }
- smtc.name = "good case: kv, with property and with metadata"
- smtc.apiInput.ID = core.StringPtr(secretUUID)
- smtc.apiOutput = secret
- smtc.ref.Key = "kv/" + secretUUID
- smtc.ref.MetadataPolicy = esv1beta1.ExternalSecretMetadataPolicyFetch
- smtc.expectedData = map[string][]byte{
- "created_at": []byte(timeValue),
- "created_by": []byte(*secret.CreatedBy),
- "crn": []byte(nilValue),
- "data": []byte("map[key1:val1 key2:val2 keyC:map[keyC1:map[keyA:valA keyB:valB]]]"),
- "downloaded": []byte(strconv.FormatBool(*secret.Downloaded)),
- "id": []byte(nilValue),
- "key1": []byte("val1"),
- "key2": []byte("val2"),
- "keyC": []byte(`{"keyC1":{"keyA":"valA","keyB":"valB"}}`),
- "labels": []byte("[" + strings.Join(secret.Labels, " ") + "]"),
- "locks_total": []byte(strconv.Itoa(int(*secret.LocksTotal))),
- "secret_group_id": []byte(nilValue),
- "secret_type": []byte(nilValue),
- "updated_at": []byte(nilValue),
- "versions_total": []byte(nilValue),
- }
- }
- // good case: iam_credentials without metadata
- setSecretIamWithoutMetadata := func(smtc *secretManagerTestCase) {
- secret := &sm.IAMCredentialsSecret{
- CreatedBy: utilpointer.To("testCreatedBy"),
- CreatedAt: &strfmt.DateTime{},
- Downloaded: utilpointer.To(false),
- Labels: []string{"abc", "def", "xyz"},
- LocksTotal: utilpointer.To(int64(20)),
- ApiKey: utilpointer.To(secretAPIKey),
- }
- smtc.name = "good case: iam_credentials without metadata"
- smtc.apiInput.ID = utilpointer.To(secretUUID)
- smtc.apiOutput = secret
- smtc.ref.Key = iamCredentialsSecret + secretUUID
- smtc.ref.MetadataPolicy = esv1beta1.ExternalSecretMetadataPolicyNone
- smtc.expectedData = map[string][]byte{
- "apikey": []byte(secretAPIKey),
- }
- }
- secretKeyKV := "kv/" + secretUUID
- // good case: kv, no property, return entire payload as key:value pairs
- setSecretKV := func(smtc *secretManagerTestCase) {
- secret := &sm.KVSecret{
- Name: utilpointer.To("testyname"),
- ID: utilpointer.To(secretUUID),
- SecretType: utilpointer.To(sm.Secret_SecretType_Kv),
- Data: secretComplex,
- }
- smtc.name = "good case: kv, no property, return entire payload as key:value pairs"
- smtc.apiInput.ID = core.StringPtr(secretUUID)
- smtc.apiOutput = secret
- smtc.ref.Key = secretKeyKV
- smtc.expectedData["key1"] = []byte("val1")
- smtc.expectedData["key2"] = []byte("val2")
- smtc.expectedData["keyC"] = []byte(`{"keyC1":{"keyA":"valA","keyB":"valB"}}`)
- }
- // good case: kv, with property
- setSecretKVWithProperty := func(smtc *secretManagerTestCase) {
- secret := &sm.KVSecret{
- Name: utilpointer.To("d5deb37a-7883-4fe2-a5e7-3c15420adc76"),
- ID: utilpointer.To(secretUUID),
- SecretType: utilpointer.To(sm.Secret_SecretType_Kv),
- Data: secretComplex,
- }
- smtc.name = "good case: kv, with property"
- smtc.apiInput.ID = core.StringPtr(secretUUID)
- smtc.ref.Property = "keyC"
- smtc.apiOutput = secret
- smtc.ref.Key = secretKeyKV
- smtc.expectedData["keyC1"] = []byte(`{"keyA":"valA","keyB":"valB"}`)
- }
- // good case: kv, with property and path
- setSecretKVWithPathAndProperty := func(smtc *secretManagerTestCase) {
- secret := &sm.KVSecret{
- Name: utilpointer.To(secretUUID),
- ID: utilpointer.To(secretUUID),
- SecretType: utilpointer.To(sm.Secret_SecretType_Kv),
- Data: secretComplex,
- }
- smtc.name = "good case: kv, with property and path"
- smtc.apiInput.ID = core.StringPtr(secretUUID)
- smtc.ref.Property = "keyC.keyC1"
- smtc.apiOutput = secret
- smtc.ref.Key = secretKeyKV
- smtc.expectedData["keyA"] = []byte("valA")
- smtc.expectedData["keyB"] = []byte("valB")
- }
- // bad case: kv, with property and path
- badSecretKVWithUnknownProperty := func(smtc *secretManagerTestCase) {
- secret := &sm.KVSecret{
- Name: utilpointer.To("testyname"),
- ID: utilpointer.To(secretUUID),
- SecretType: utilpointer.To(sm.Secret_SecretType_Kv),
- Data: secretComplex,
- }
- smtc.name = "bad case: kv, with property and path"
- smtc.apiInput.ID = core.StringPtr(secretUUID)
- smtc.ref.Property = "unknown.property"
- smtc.apiOutput = secret
- smtc.ref.Key = secretKeyKV
- smtc.expectError = "key unknown.property does not exist in secret " + secretKeyKV
- }
- successCases := []*secretManagerTestCase{
- makeValidSecretManagerTestCaseCustom(badSecretIam),
- makeValidSecretManagerTestCaseCustom(setSecretSrvCreds),
- makeValidSecretManagerTestCaseCustom(setArbitrary),
- makeValidSecretManagerTestCaseCustom(setNilMockClient),
- makeValidSecretManagerTestCaseCustom(setAPIErr),
- makeValidSecretManagerTestCaseCustom(setSecretUserPass),
- makeValidSecretManagerTestCaseCustom(setSecretIam),
- makeValidSecretManagerTestCaseCustom(setSecretCert),
- makeValidSecretManagerTestCaseCustom(setSecretKV),
- makeValidSecretManagerTestCaseCustom(setSecretKVWithProperty),
- makeValidSecretManagerTestCaseCustom(setSecretKVWithPathAndProperty),
- makeValidSecretManagerTestCaseCustom(badSecretKVWithUnknownProperty),
- makeValidSecretManagerTestCaseCustom(setSecretPublicCert),
- makeValidSecretManagerTestCaseCustom(setSecretPrivateCert),
- makeValidSecretManagerTestCaseCustom(setimportedCertWithNoPvtKey),
- makeValidSecretManagerTestCaseCustom(setSecretIamWithMetadata),
- makeValidSecretManagerTestCaseCustom(setArbitraryWithMetadata),
- makeValidSecretManagerTestCaseCustom(setSecretUserPassWithMetadata),
- makeValidSecretManagerTestCaseCustom(setimportedCertWithMetadata),
- makeValidSecretManagerTestCaseCustom(setPublicCertWithMetadata),
- makeValidSecretManagerTestCaseCustom(setPrivateCertWithMetadata),
- makeValidSecretManagerTestCaseCustom(setSecretKVWithMetadata),
- makeValidSecretManagerTestCaseCustom(setSecretIamWithoutMetadata),
- makeValidSecretManagerTestCaseCustom(setSecretIamByName),
- }
- sm := providerIBM{}
- for _, v := range successCases {
- t.Run(v.name, func(t *testing.T) {
- sm.IBMClient = v.mockClient
- out, err := sm.GetSecretMap(context.Background(), *v.ref)
- if !ErrorContains(err, v.expectError) {
- t.Errorf("unexpected error: %s, expected: '%s'", err.Error(), v.expectError)
- }
- if err == nil && !reflect.DeepEqual(out, v.expectedData) {
- t.Errorf("unexpected secret data: expected:\n%+v\ngot:\n%+v", v.expectedData, out)
- }
- })
- }
- }
- func TestValidRetryInput(t *testing.T) {
- sm := providerIBM{}
- invalid := "Invalid"
- serviceURL := "http://fake-service-url.cool"
- spec := &esv1beta1.SecretStore{
- Spec: esv1beta1.SecretStoreSpec{
- Provider: &esv1beta1.SecretStoreProvider{
- IBM: &esv1beta1.IBMProvider{
- Auth: esv1beta1.IBMAuth{
- SecretRef: &esv1beta1.IBMAuthSecretRef{
- SecretAPIKey: v1.SecretKeySelector{
- Name: "fake-secret",
- Key: "fake-key",
- },
- },
- },
- ServiceURL: &serviceURL,
- },
- },
- RetrySettings: &esv1beta1.SecretStoreRetrySettings{
- RetryInterval: &invalid,
- },
- },
- }
- expected := fmt.Sprintf("cannot setup new ibm client: time: invalid duration %q", invalid)
- ctx := context.TODO()
- kube := clientfake.NewClientBuilder().WithObjects(&corev1.Secret{
- ObjectMeta: metav1.ObjectMeta{
- Name: "fake-secret",
- Namespace: "default",
- },
- Data: map[string][]byte{
- "fake-key": []byte("ImAFakeApiKey"),
- },
- }).Build()
- _, err := sm.NewClient(ctx, spec, kube, "default")
- if !ErrorContains(err, expected) {
- t.Errorf("CheckValidRetryInput unexpected error: %s, expected: '%s'", err.Error(), expected)
- }
- }
- func ErrorContains(out error, want string) bool {
- if out == nil {
- return want == ""
- }
- if want == "" {
- return false
- }
- return strings.Contains(out.Error(), want)
- }
|