provider_test.go 24 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716
  1. /*
  2. Licensed under the Apache License, Version 2.0 (the "License");
  3. you may not use this file except in compliance with the License.
  4. You may obtain a copy of the License at
  5. http://www.apache.org/licenses/LICENSE-2.0
  6. Unless required by applicable law or agreed to in writing, software
  7. distributed under the License is distributed on an "AS IS" BASIS,
  8. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  9. See the License for the specific language governing permissions and
  10. limitations under the License.
  11. */
  12. package ibm
  13. import (
  14. "context"
  15. "fmt"
  16. "reflect"
  17. "strings"
  18. "testing"
  19. "github.com/IBM/go-sdk-core/v5/core"
  20. sm "github.com/IBM/secrets-manager-go-sdk/secretsmanagerv1"
  21. "github.com/crossplane/crossplane-runtime/pkg/test"
  22. corev1 "k8s.io/api/core/v1"
  23. utilpointer "k8s.io/utils/pointer"
  24. kclient "sigs.k8s.io/controller-runtime/pkg/client"
  25. esv1beta1 "github.com/external-secrets/external-secrets/apis/externalsecrets/v1beta1"
  26. v1 "github.com/external-secrets/external-secrets/apis/meta/v1"
  27. fakesm "github.com/external-secrets/external-secrets/pkg/provider/ibm/fake"
  28. )
  29. const (
  30. errExpectedErr = "wanted error got nil"
  31. secretKey = "test-secret"
  32. )
  33. type secretManagerTestCase struct {
  34. mockClient *fakesm.IBMMockClient
  35. apiInput *sm.GetSecretOptions
  36. apiOutput *sm.GetSecret
  37. ref *esv1beta1.ExternalSecretDataRemoteRef
  38. serviceURL *string
  39. apiErr error
  40. expectError string
  41. expectedSecret string
  42. // for testing secretmap
  43. expectedData map[string][]byte
  44. }
  45. func makeValidSecretManagerTestCase() *secretManagerTestCase {
  46. smtc := secretManagerTestCase{
  47. mockClient: &fakesm.IBMMockClient{},
  48. apiInput: makeValidAPIInput(),
  49. ref: makeValidRef(),
  50. apiOutput: makeValidAPIOutput(),
  51. serviceURL: nil,
  52. apiErr: nil,
  53. expectError: "",
  54. expectedSecret: "",
  55. expectedData: map[string][]byte{},
  56. }
  57. smtc.mockClient.WithValue(smtc.apiInput, smtc.apiOutput, smtc.apiErr)
  58. return &smtc
  59. }
  60. func makeValidRef() *esv1beta1.ExternalSecretDataRemoteRef {
  61. return &esv1beta1.ExternalSecretDataRemoteRef{
  62. Key: secretKey,
  63. Version: "default",
  64. }
  65. }
  66. func makeValidAPIInput() *sm.GetSecretOptions {
  67. return &sm.GetSecretOptions{
  68. SecretType: core.StringPtr(sm.GetSecretOptionsSecretTypeArbitraryConst),
  69. ID: utilpointer.StringPtr(secretKey),
  70. }
  71. }
  72. func makeValidAPIOutput() *sm.GetSecret {
  73. secretData := make(map[string]interface{})
  74. secretData["payload"] = ""
  75. return &sm.GetSecret{
  76. Resources: []sm.SecretResourceIntf{
  77. &sm.SecretResource{
  78. SecretType: utilpointer.StringPtr("testytype"),
  79. Name: utilpointer.StringPtr("testyname"),
  80. SecretData: secretData,
  81. },
  82. },
  83. }
  84. }
  85. func makeValidSecretManagerTestCaseCustom(tweaks ...func(smtc *secretManagerTestCase)) *secretManagerTestCase {
  86. smtc := makeValidSecretManagerTestCase()
  87. for _, fn := range tweaks {
  88. fn(smtc)
  89. }
  90. smtc.mockClient.WithValue(smtc.apiInput, smtc.apiOutput, smtc.apiErr)
  91. return smtc
  92. }
  93. // This case can be shared by both GetSecret and GetSecretMap tests.
  94. // bad case: set apiErr.
  95. var setAPIErr = func(smtc *secretManagerTestCase) {
  96. smtc.apiErr = fmt.Errorf("oh no")
  97. smtc.expectError = "oh no"
  98. }
  99. var setNilMockClient = func(smtc *secretManagerTestCase) {
  100. smtc.mockClient = nil
  101. smtc.expectError = errUninitalizedIBMProvider
  102. }
  103. // simple tests for Validate Store.
  104. func TestValidateStore(t *testing.T) {
  105. p := providerIBM{}
  106. store := &esv1beta1.SecretStore{
  107. Spec: esv1beta1.SecretStoreSpec{
  108. Provider: &esv1beta1.SecretStoreProvider{
  109. IBM: &esv1beta1.IBMProvider{},
  110. },
  111. },
  112. }
  113. err := p.ValidateStore(store)
  114. if err == nil {
  115. t.Errorf(errExpectedErr)
  116. } else if err.Error() != "serviceURL is required" {
  117. t.Errorf("service URL test failed")
  118. }
  119. url := "my-url"
  120. store.Spec.Provider.IBM.ServiceURL = &url
  121. var nilProfile esv1beta1.IBMAuthContainerAuth
  122. store.Spec.Provider.IBM.Auth.ContainerAuth = nilProfile
  123. err = p.ValidateStore(store)
  124. if err == nil {
  125. t.Errorf(errExpectedErr)
  126. } else if err.Error() != "secretAPIKey.name cannot be empty" {
  127. t.Errorf("KeySelector test failed: expected secret name is required, got %v", err)
  128. }
  129. store.Spec.Provider.IBM.Auth.SecretRef.SecretAPIKey.Name = "foo"
  130. store.Spec.Provider.IBM.Auth.SecretRef.SecretAPIKey.Key = "bar"
  131. ns := "ns-one"
  132. store.Spec.Provider.IBM.Auth.SecretRef.SecretAPIKey.Namespace = &ns
  133. err = p.ValidateStore(store)
  134. if err == nil {
  135. t.Errorf(errExpectedErr)
  136. } else if err.Error() != "namespace not allowed with namespaced SecretStore" {
  137. t.Errorf("KeySelector test failed: expected namespace not allowed, got %v", err)
  138. }
  139. // add container auth test
  140. store.Spec.Provider.IBM = &esv1beta1.IBMProvider{}
  141. store.Spec.Provider.IBM.ServiceURL = &url
  142. store.Spec.Provider.IBM.Auth.ContainerAuth.Profile = "Trusted IAM Profile"
  143. store.Spec.Provider.IBM.Auth.ContainerAuth.TokenLocation = "/a/path/to/nowhere/that/should/exist"
  144. err = p.ValidateStore(store)
  145. expected := "cannot read container auth token"
  146. if !ErrorContains(err, expected) {
  147. t.Errorf("ProfileSelector test failed: %s, expected: '%s'", err.Error(), expected)
  148. }
  149. }
  150. // test the sm<->gcp interface
  151. // make sure correct values are passed and errors are handled accordingly.
  152. func TestIBMSecretManagerGetSecret(t *testing.T) {
  153. secretData := make(map[string]interface{})
  154. secretString := "changedvalue"
  155. secretPassword := "P@ssw0rd"
  156. secretAPIKey := "01234567890"
  157. secretCertificate := "certificate_value"
  158. secretData["payload"] = secretString
  159. secretData["password"] = secretPassword
  160. secretData["certificate"] = secretCertificate
  161. // good case: default version is set
  162. // key is passed in, output is sent back
  163. setSecretString := func(smtc *secretManagerTestCase) {
  164. resources := []sm.SecretResourceIntf{
  165. &sm.SecretResource{
  166. SecretType: utilpointer.StringPtr("testytype"),
  167. Name: utilpointer.StringPtr("testyname"),
  168. SecretData: secretData,
  169. }}
  170. smtc.apiOutput.Resources = resources
  171. smtc.expectedSecret = secretString
  172. }
  173. // good case: custom version set
  174. setCustomKey := func(smtc *secretManagerTestCase) {
  175. resources := []sm.SecretResourceIntf{
  176. &sm.SecretResource{
  177. SecretType: utilpointer.StringPtr("testytype"),
  178. Name: utilpointer.StringPtr("testyname"),
  179. SecretData: secretData,
  180. }}
  181. smtc.ref.Key = "testyname"
  182. smtc.apiInput.ID = utilpointer.StringPtr("testyname")
  183. smtc.apiOutput.Resources = resources
  184. smtc.expectedSecret = secretString
  185. }
  186. // bad case: username_password type without property
  187. secretUserPass := "username_password/test-secret"
  188. badSecretUserPass := func(smtc *secretManagerTestCase) {
  189. resources := []sm.SecretResourceIntf{
  190. &sm.SecretResource{
  191. SecretType: utilpointer.StringPtr(sm.CreateSecretOptionsSecretTypeUsernamePasswordConst),
  192. Name: utilpointer.StringPtr("testyname"),
  193. SecretData: secretData,
  194. }}
  195. smtc.apiInput.SecretType = core.StringPtr(sm.CreateSecretOptionsSecretTypeUsernamePasswordConst)
  196. smtc.apiOutput.Resources = resources
  197. smtc.ref.Key = secretUserPass
  198. smtc.expectError = "remoteRef.property required for secret type username_password"
  199. }
  200. // good case: username_password type with property
  201. setSecretUserPass := func(smtc *secretManagerTestCase) {
  202. resources := []sm.SecretResourceIntf{
  203. &sm.SecretResource{
  204. SecretType: utilpointer.StringPtr(sm.CreateSecretOptionsSecretTypeUsernamePasswordConst),
  205. Name: utilpointer.StringPtr("testyname"),
  206. SecretData: secretData,
  207. }}
  208. smtc.apiInput.SecretType = core.StringPtr(sm.CreateSecretOptionsSecretTypeUsernamePasswordConst)
  209. smtc.apiOutput.Resources = resources
  210. smtc.ref.Key = secretUserPass
  211. smtc.ref.Property = "password"
  212. smtc.expectedSecret = secretPassword
  213. }
  214. // good case: iam_credenatials type
  215. setSecretIam := func(smtc *secretManagerTestCase) {
  216. resources := []sm.SecretResourceIntf{
  217. &sm.SecretResource{
  218. SecretType: utilpointer.StringPtr(sm.CreateSecretOptionsSecretTypeIamCredentialsConst),
  219. Name: utilpointer.StringPtr("testyname"),
  220. APIKey: utilpointer.StringPtr(secretAPIKey),
  221. }}
  222. smtc.apiInput.SecretType = core.StringPtr(sm.CreateSecretOptionsSecretTypeIamCredentialsConst)
  223. smtc.apiOutput.Resources = resources
  224. smtc.ref.Key = "iam_credentials/test-secret"
  225. smtc.expectedSecret = secretAPIKey
  226. }
  227. funcSetCertSecretTest := func(certType string, good bool) func(*secretManagerTestCase) {
  228. return func(smtc *secretManagerTestCase) {
  229. resources := []sm.SecretResourceIntf{
  230. &sm.SecretResource{
  231. SecretType: utilpointer.StringPtr(certType),
  232. Name: utilpointer.StringPtr("testyname"),
  233. SecretData: secretData,
  234. }}
  235. smtc.apiInput.SecretType = core.StringPtr(certType)
  236. smtc.apiOutput.Resources = resources
  237. smtc.ref.Key = certType + "/" + secretKey
  238. if good {
  239. smtc.ref.Property = "certificate"
  240. smtc.expectedSecret = secretCertificate
  241. } else {
  242. smtc.expectError = "remoteRef.property required for secret type " + certType
  243. }
  244. }
  245. }
  246. // good case: imported_cert type with property
  247. setSecretCert := funcSetCertSecretTest(sm.CreateSecretOptionsSecretTypeImportedCertConst, true)
  248. // bad case: imported_cert type without property
  249. badSecretCert := funcSetCertSecretTest(sm.CreateSecretOptionsSecretTypeImportedCertConst, false)
  250. // good case: public_cert type with property
  251. setSecretPublicCert := funcSetCertSecretTest(sm.CreateSecretOptionsSecretTypePublicCertConst, true)
  252. // bad case: public_cert type without property
  253. badSecretPublicCert := funcSetCertSecretTest(sm.CreateSecretOptionsSecretTypePublicCertConst, false)
  254. // good case: private_cert type with property
  255. setSecretPrivateCert := funcSetCertSecretTest(sm.CreateSecretOptionsSecretTypePrivateCertConst, true)
  256. // bad case: private_cert type without property
  257. badSecretPrivateCert := funcSetCertSecretTest(sm.CreateSecretOptionsSecretTypePrivateCertConst, false)
  258. secretDataKV := make(map[string]interface{})
  259. secretKVPayload := make(map[string]interface{})
  260. secretKVPayload["key1"] = "val1"
  261. secretDataKV["payload"] = secretKVPayload
  262. secretDataKVComplex := make(map[string]interface{})
  263. secretKVComplex := `{"key1":"val1","key2":"val2","key3":"val3","keyC":{"keyC1":"valC1", "keyC2":"valC2"}, "special.log": "file-content"}`
  264. secretDataKVComplex["payload"] = secretKVComplex
  265. secretKV := "kv/test-secret"
  266. // bad case: kv type with key which is not in payload
  267. badSecretKV := func(smtc *secretManagerTestCase) {
  268. resources := []sm.SecretResourceIntf{
  269. &sm.SecretResource{
  270. SecretType: utilpointer.StringPtr(sm.CreateSecretOptionsSecretTypeKvConst),
  271. Name: utilpointer.StringPtr("testyname"),
  272. SecretData: secretDataKV,
  273. }}
  274. smtc.apiInput.SecretType = core.StringPtr(sm.CreateSecretOptionsSecretTypeKvConst)
  275. smtc.apiOutput.Resources = resources
  276. smtc.ref.Key = secretKV
  277. smtc.ref.Property = "other-key"
  278. smtc.expectError = "key other-key does not exist in secret kv/test-secret"
  279. }
  280. // good case: kv type with property
  281. setSecretKV := func(smtc *secretManagerTestCase) {
  282. resources := []sm.SecretResourceIntf{
  283. &sm.SecretResource{
  284. SecretType: utilpointer.StringPtr(sm.CreateSecretOptionsSecretTypeKvConst),
  285. Name: utilpointer.StringPtr("testyname"),
  286. SecretData: secretDataKV,
  287. }}
  288. smtc.apiInput.SecretType = core.StringPtr(sm.CreateSecretOptionsSecretTypeKvConst)
  289. smtc.apiOutput.Resources = resources
  290. smtc.ref.Key = secretKV
  291. smtc.ref.Property = "key1"
  292. smtc.expectedSecret = "val1"
  293. }
  294. // good case: kv type with property, returns specific value
  295. setSecretKVWithKey := func(smtc *secretManagerTestCase) {
  296. resources := []sm.SecretResourceIntf{
  297. &sm.SecretResource{
  298. SecretType: utilpointer.StringPtr(sm.CreateSecretOptionsSecretTypeKvConst),
  299. Name: utilpointer.StringPtr("testyname"),
  300. SecretData: secretDataKVComplex,
  301. }}
  302. smtc.apiInput.SecretType = core.StringPtr(sm.CreateSecretOptionsSecretTypeKvConst)
  303. smtc.apiOutput.Resources = resources
  304. smtc.ref.Key = secretKV
  305. smtc.ref.Property = "key2"
  306. smtc.expectedSecret = "val2"
  307. }
  308. // good case: kv type with property and path, returns specific value
  309. setSecretKVWithKeyPath := func(smtc *secretManagerTestCase) {
  310. resources := []sm.SecretResourceIntf{
  311. &sm.SecretResource{
  312. SecretType: utilpointer.StringPtr(sm.CreateSecretOptionsSecretTypeKvConst),
  313. Name: utilpointer.StringPtr("testyname"),
  314. SecretData: secretDataKVComplex,
  315. }}
  316. smtc.apiInput.SecretType = core.StringPtr(sm.CreateSecretOptionsSecretTypeKvConst)
  317. smtc.apiOutput.Resources = resources
  318. smtc.ref.Key = secretKV
  319. smtc.ref.Property = "keyC.keyC2"
  320. smtc.expectedSecret = "valC2"
  321. }
  322. // good case: kv type with property and dot, returns specific value
  323. setSecretKVWithKeyDot := func(smtc *secretManagerTestCase) {
  324. resources := []sm.SecretResourceIntf{
  325. &sm.SecretResource{
  326. SecretType: utilpointer.StringPtr(sm.CreateSecretOptionsSecretTypeKvConst),
  327. Name: utilpointer.StringPtr("testyname"),
  328. SecretData: secretDataKVComplex,
  329. }}
  330. smtc.apiInput.SecretType = core.StringPtr(sm.CreateSecretOptionsSecretTypeKvConst)
  331. smtc.apiOutput.Resources = resources
  332. smtc.ref.Key = secretKV
  333. smtc.ref.Property = "special.log"
  334. smtc.expectedSecret = "file-content"
  335. }
  336. // good case: kv type without property, returns all
  337. setSecretKVWithOutKey := func(smtc *secretManagerTestCase) {
  338. resources := []sm.SecretResourceIntf{
  339. &sm.SecretResource{
  340. SecretType: utilpointer.StringPtr(sm.CreateSecretOptionsSecretTypeKvConst),
  341. Name: utilpointer.StringPtr("testyname"),
  342. SecretData: secretDataKVComplex,
  343. }}
  344. smtc.apiInput.SecretType = core.StringPtr(sm.CreateSecretOptionsSecretTypeKvConst)
  345. smtc.apiOutput.Resources = resources
  346. smtc.ref.Key = secretKV
  347. smtc.expectedSecret = secretKVComplex
  348. }
  349. successCases := []*secretManagerTestCase{
  350. makeValidSecretManagerTestCase(),
  351. makeValidSecretManagerTestCaseCustom(setSecretString),
  352. makeValidSecretManagerTestCaseCustom(setCustomKey),
  353. makeValidSecretManagerTestCaseCustom(setAPIErr),
  354. makeValidSecretManagerTestCaseCustom(setNilMockClient),
  355. makeValidSecretManagerTestCaseCustom(badSecretUserPass),
  356. makeValidSecretManagerTestCaseCustom(setSecretUserPass),
  357. makeValidSecretManagerTestCaseCustom(setSecretIam),
  358. makeValidSecretManagerTestCaseCustom(setSecretCert),
  359. makeValidSecretManagerTestCaseCustom(badSecretCert),
  360. makeValidSecretManagerTestCaseCustom(setSecretKV),
  361. makeValidSecretManagerTestCaseCustom(setSecretKVWithKey),
  362. makeValidSecretManagerTestCaseCustom(setSecretKVWithKeyPath),
  363. makeValidSecretManagerTestCaseCustom(setSecretKVWithKeyDot),
  364. makeValidSecretManagerTestCaseCustom(setSecretKVWithOutKey),
  365. makeValidSecretManagerTestCaseCustom(badSecretKV),
  366. makeValidSecretManagerTestCaseCustom(setSecretPublicCert),
  367. makeValidSecretManagerTestCaseCustom(badSecretPublicCert),
  368. makeValidSecretManagerTestCaseCustom(setSecretPrivateCert),
  369. makeValidSecretManagerTestCaseCustom(badSecretPrivateCert),
  370. }
  371. sm := providerIBM{}
  372. for k, v := range successCases {
  373. sm.IBMClient = v.mockClient
  374. out, err := sm.GetSecret(context.Background(), *v.ref)
  375. if !ErrorContains(err, v.expectError) {
  376. t.Errorf("[%d] unexpected error: %s, expected: '%s'", k, err.Error(), v.expectError)
  377. }
  378. if string(out) != v.expectedSecret {
  379. t.Errorf("[%d] unexpected secret: expected %s, got %s", k, v.expectedSecret, string(out))
  380. }
  381. }
  382. }
  383. func TestGetSecretMap(t *testing.T) {
  384. secretKeyName := "kv/test-secret"
  385. secretUsername := "user1"
  386. secretPassword := "P@ssw0rd"
  387. secretAPIKey := "01234567890"
  388. secretCertificate := "certificate_value"
  389. secretPrivateKey := "private_key_value"
  390. secretIntermediate := "intermediate_value"
  391. secretComplex := map[string]interface{}{
  392. "key1": "val1",
  393. "key2": "val2",
  394. "keyC": map[string]interface{}{
  395. "keyC1": map[string]string{
  396. "keyA": "valA",
  397. "keyB": "valB",
  398. },
  399. },
  400. }
  401. // good case: default version & deserialization
  402. setDeserialization := func(smtc *secretManagerTestCase) {
  403. secretData := make(map[string]interface{})
  404. secretData["payload"] = `{"foo":"bar"}`
  405. resources := []sm.SecretResourceIntf{
  406. &sm.SecretResource{
  407. SecretType: utilpointer.StringPtr("testytype"),
  408. Name: utilpointer.StringPtr("testyname"),
  409. SecretData: secretData,
  410. }}
  411. smtc.apiOutput.Resources = resources
  412. smtc.expectedData["foo"] = []byte("bar")
  413. }
  414. // bad case: invalid json
  415. setInvalidJSON := func(smtc *secretManagerTestCase) {
  416. secretData := make(map[string]interface{})
  417. secretData["payload"] = `-----------------`
  418. resources := []sm.SecretResourceIntf{
  419. &sm.SecretResource{
  420. SecretType: utilpointer.StringPtr("testytype"),
  421. Name: utilpointer.StringPtr("testyname"),
  422. SecretData: secretData,
  423. }}
  424. smtc.apiOutput.Resources = resources
  425. smtc.expectError = "unable to unmarshal secret: invalid character '-' in numeric literal"
  426. }
  427. // good case: username_password
  428. setSecretUserPass := func(smtc *secretManagerTestCase) {
  429. secretData := make(map[string]interface{})
  430. secretData["username"] = secretUsername
  431. secretData["password"] = secretPassword
  432. resources := []sm.SecretResourceIntf{
  433. &sm.SecretResource{
  434. SecretType: utilpointer.StringPtr(sm.CreateSecretOptionsSecretTypeUsernamePasswordConst),
  435. Name: utilpointer.StringPtr("testyname"),
  436. SecretData: secretData,
  437. }}
  438. smtc.apiInput.SecretType = core.StringPtr(sm.CreateSecretOptionsSecretTypeUsernamePasswordConst)
  439. smtc.apiOutput.Resources = resources
  440. smtc.ref.Key = "username_password/test-secret"
  441. smtc.expectedData["username"] = []byte(secretUsername)
  442. smtc.expectedData["password"] = []byte(secretPassword)
  443. }
  444. // good case: iam_credentials
  445. setSecretIam := func(smtc *secretManagerTestCase) {
  446. resources := []sm.SecretResourceIntf{
  447. &sm.SecretResource{
  448. SecretType: utilpointer.StringPtr(sm.CreateSecretOptionsSecretTypeIamCredentialsConst),
  449. Name: utilpointer.StringPtr("testyname"),
  450. APIKey: utilpointer.StringPtr(secretAPIKey),
  451. }}
  452. smtc.apiInput.SecretType = core.StringPtr(sm.CreateSecretOptionsSecretTypeIamCredentialsConst)
  453. smtc.apiOutput.Resources = resources
  454. smtc.ref.Key = "iam_credentials/test-secret"
  455. smtc.expectedData["apikey"] = []byte(secretAPIKey)
  456. }
  457. funcCertTest := func(certType string) func(*secretManagerTestCase) {
  458. return func(smtc *secretManagerTestCase) {
  459. secretData := make(map[string]interface{})
  460. secretData["certificate"] = secretCertificate
  461. secretData["private_key"] = secretPrivateKey
  462. secretData["intermediate"] = secretIntermediate
  463. resources := []sm.SecretResourceIntf{
  464. &sm.SecretResource{
  465. SecretType: utilpointer.StringPtr(certType),
  466. Name: utilpointer.StringPtr("testyname"),
  467. SecretData: secretData,
  468. }}
  469. smtc.apiInput.SecretType = core.StringPtr(certType)
  470. smtc.apiOutput.Resources = resources
  471. smtc.ref.Key = certType + "/test-secret"
  472. smtc.expectedData["certificate"] = []byte(secretCertificate)
  473. smtc.expectedData["private_key"] = []byte(secretPrivateKey)
  474. smtc.expectedData["intermediate"] = []byte(secretIntermediate)
  475. }
  476. }
  477. // good case: imported_cert
  478. setSecretCert := funcCertTest(sm.CreateSecretOptionsSecretTypeImportedCertConst)
  479. // good case: public_cert
  480. setSecretPublicCert := funcCertTest(sm.CreateSecretOptionsSecretTypePublicCertConst)
  481. // good case: public_cert
  482. setSecretPrivateCert := funcCertTest(sm.CreateSecretOptionsSecretTypePrivateCertConst)
  483. // good case: kv, no property, return entire payload as key:value pairs
  484. setSecretKV := func(smtc *secretManagerTestCase) {
  485. secretData := make(map[string]interface{})
  486. secretData["payload"] = secretComplex
  487. resources := []sm.SecretResourceIntf{
  488. &sm.SecretResource{
  489. SecretType: utilpointer.StringPtr(sm.CreateSecretOptionsSecretTypeKvConst),
  490. Name: utilpointer.StringPtr("testyname"),
  491. SecretData: secretData,
  492. }}
  493. smtc.apiInput.SecretType = core.StringPtr(sm.CreateSecretOptionsSecretTypeKvConst)
  494. smtc.apiOutput.Resources = resources
  495. smtc.ref.Key = secretKeyName
  496. smtc.expectedData["key1"] = []byte("val1")
  497. smtc.expectedData["key2"] = []byte("val2")
  498. smtc.expectedData["keyC"] = []byte(`{"keyC1":{"keyA":"valA","keyB":"valB"}}`)
  499. }
  500. // good case: kv, with property
  501. setSecretKVWithProperty := func(smtc *secretManagerTestCase) {
  502. secretData := make(map[string]interface{})
  503. secretData["payload"] = secretComplex
  504. resources := []sm.SecretResourceIntf{
  505. &sm.SecretResource{
  506. SecretType: utilpointer.StringPtr(sm.CreateSecretOptionsSecretTypeKvConst),
  507. Name: utilpointer.StringPtr("testyname"),
  508. SecretData: secretData,
  509. }}
  510. smtc.apiInput.SecretType = core.StringPtr(sm.CreateSecretOptionsSecretTypeKvConst)
  511. smtc.ref.Property = "keyC"
  512. smtc.apiOutput.Resources = resources
  513. smtc.ref.Key = secretKeyName
  514. smtc.expectedData["keyC1"] = []byte(`{"keyA":"valA","keyB":"valB"}`)
  515. }
  516. // good case: kv, with property and path
  517. setSecretKVWithPathAndProperty := func(smtc *secretManagerTestCase) {
  518. secretData := make(map[string]interface{})
  519. secretData["payload"] = secretComplex
  520. resources := []sm.SecretResourceIntf{
  521. &sm.SecretResource{
  522. SecretType: utilpointer.StringPtr(sm.CreateSecretOptionsSecretTypeKvConst),
  523. Name: utilpointer.StringPtr("testyname"),
  524. SecretData: secretData,
  525. }}
  526. smtc.apiInput.SecretType = core.StringPtr(sm.CreateSecretOptionsSecretTypeKvConst)
  527. smtc.ref.Property = "keyC.keyC1"
  528. smtc.apiOutput.Resources = resources
  529. smtc.ref.Key = secretKeyName
  530. smtc.expectedData["keyA"] = []byte("valA")
  531. smtc.expectedData["keyB"] = []byte("valB")
  532. }
  533. // bad case: kv, with property and path
  534. badSecretKVWithUnknownProperty := func(smtc *secretManagerTestCase) {
  535. secretData := make(map[string]interface{})
  536. secretData["payload"] = secretComplex
  537. resources := []sm.SecretResourceIntf{
  538. &sm.SecretResource{
  539. SecretType: utilpointer.StringPtr(sm.CreateSecretOptionsSecretTypeKvConst),
  540. Name: utilpointer.StringPtr("testyname"),
  541. SecretData: secretData,
  542. }}
  543. smtc.apiInput.SecretType = core.StringPtr(sm.CreateSecretOptionsSecretTypeKvConst)
  544. smtc.ref.Property = "unknown.property"
  545. smtc.apiOutput.Resources = resources
  546. smtc.ref.Key = secretKeyName
  547. smtc.expectError = "key unknown.property does not exist in secret kv/test-secret"
  548. }
  549. successCases := []*secretManagerTestCase{
  550. makeValidSecretManagerTestCaseCustom(setDeserialization),
  551. makeValidSecretManagerTestCaseCustom(setInvalidJSON),
  552. makeValidSecretManagerTestCaseCustom(setNilMockClient),
  553. makeValidSecretManagerTestCaseCustom(setAPIErr),
  554. makeValidSecretManagerTestCaseCustom(setSecretUserPass),
  555. makeValidSecretManagerTestCaseCustom(setSecretIam),
  556. makeValidSecretManagerTestCaseCustom(setSecretCert),
  557. makeValidSecretManagerTestCaseCustom(setSecretKV),
  558. makeValidSecretManagerTestCaseCustom(setSecretKVWithProperty),
  559. makeValidSecretManagerTestCaseCustom(setSecretKVWithPathAndProperty),
  560. makeValidSecretManagerTestCaseCustom(badSecretKVWithUnknownProperty),
  561. makeValidSecretManagerTestCaseCustom(setSecretPublicCert),
  562. makeValidSecretManagerTestCaseCustom(setSecretPrivateCert),
  563. }
  564. sm := providerIBM{}
  565. for k, v := range successCases {
  566. sm.IBMClient = v.mockClient
  567. out, err := sm.GetSecretMap(context.Background(), *v.ref)
  568. if !ErrorContains(err, v.expectError) {
  569. t.Errorf("[%d] unexpected error: %s, expected: '%s'", k, err.Error(), v.expectError)
  570. }
  571. if err == nil && !reflect.DeepEqual(out, v.expectedData) {
  572. t.Errorf("[%d] unexpected secret data: expected %#v, got %#v", k, v.expectedData, out)
  573. }
  574. }
  575. }
  576. func TestValidRetryInput(t *testing.T) {
  577. sm := providerIBM{}
  578. invalid := "Invalid"
  579. serviceURL := "http://fake-service-url.cool"
  580. spec := &esv1beta1.SecretStore{
  581. Spec: esv1beta1.SecretStoreSpec{
  582. Provider: &esv1beta1.SecretStoreProvider{
  583. IBM: &esv1beta1.IBMProvider{
  584. Auth: esv1beta1.IBMAuth{
  585. SecretRef: esv1beta1.IBMAuthSecretRef{
  586. SecretAPIKey: v1.SecretKeySelector{
  587. Name: "fake-secret",
  588. Key: "fake-key",
  589. },
  590. },
  591. },
  592. ServiceURL: &serviceURL,
  593. },
  594. },
  595. RetrySettings: &esv1beta1.SecretStoreRetrySettings{
  596. RetryInterval: &invalid,
  597. },
  598. },
  599. }
  600. expected := fmt.Sprintf("cannot setup new ibm client: time: invalid duration %q", invalid)
  601. ctx := context.TODO()
  602. kube := &test.MockClient{
  603. MockGet: test.NewMockGetFn(nil, func(obj kclient.Object) error {
  604. if o, ok := obj.(*corev1.Secret); ok {
  605. o.Data = map[string][]byte{
  606. "fake-key": []byte("ImAFakeApiKey"),
  607. }
  608. return nil
  609. }
  610. return nil
  611. }),
  612. }
  613. _, err := sm.NewClient(ctx, spec, kube, "default")
  614. if !ErrorContains(err, expected) {
  615. t.Errorf("CheckValidRetryInput unexpected error: %s, expected: '%s'", err.Error(), expected)
  616. }
  617. }
  618. func ErrorContains(out error, want string) bool {
  619. if out == nil {
  620. return want == ""
  621. }
  622. if want == "" {
  623. return false
  624. }
  625. return strings.Contains(out.Error(), want)
  626. }