provider_test.go 25 KB

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