vault_test.go 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629
  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 vault
  13. import (
  14. "bytes"
  15. "context"
  16. "encoding/json"
  17. "errors"
  18. "fmt"
  19. "io/ioutil"
  20. "net/http"
  21. "testing"
  22. "github.com/crossplane/crossplane-runtime/pkg/test"
  23. "github.com/google/go-cmp/cmp"
  24. vault "github.com/hashicorp/vault/api"
  25. corev1 "k8s.io/api/core/v1"
  26. metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
  27. kclient "sigs.k8s.io/controller-runtime/pkg/client"
  28. esv1alpha1 "github.com/external-secrets/external-secrets/apis/externalsecrets/v1alpha1"
  29. esmeta "github.com/external-secrets/external-secrets/apis/meta/v1"
  30. "github.com/external-secrets/external-secrets/pkg/provider/vault/fake"
  31. )
  32. const (
  33. tokenSecretName = "example-secret-token"
  34. secretDataString = "some-creds"
  35. )
  36. func makeValidSecretStoreWithVersion(v esv1alpha1.VaultKVStoreVersion) *esv1alpha1.SecretStore {
  37. return &esv1alpha1.SecretStore{
  38. ObjectMeta: metav1.ObjectMeta{
  39. Name: "vault-store",
  40. Namespace: "default",
  41. },
  42. Spec: esv1alpha1.SecretStoreSpec{
  43. Provider: &esv1alpha1.SecretStoreProvider{
  44. Vault: &esv1alpha1.VaultProvider{
  45. Server: "vault.example.com",
  46. Path: "secret",
  47. Version: v,
  48. Auth: esv1alpha1.VaultAuth{
  49. Kubernetes: &esv1alpha1.VaultKubernetesAuth{
  50. Path: "kubernetes",
  51. Role: "kubernetes-auth-role",
  52. ServiceAccountRef: &esmeta.ServiceAccountSelector{
  53. Name: "example-sa",
  54. },
  55. },
  56. },
  57. },
  58. },
  59. },
  60. }
  61. }
  62. func makeValidSecretStore() *esv1alpha1.SecretStore {
  63. return makeValidSecretStoreWithVersion(esv1alpha1.VaultKVStoreV2)
  64. }
  65. func makeValidSecretStoreWithCerts() *esv1alpha1.SecretStore {
  66. return &esv1alpha1.SecretStore{
  67. ObjectMeta: metav1.ObjectMeta{
  68. Name: "vault-store",
  69. Namespace: "default",
  70. },
  71. Spec: esv1alpha1.SecretStoreSpec{
  72. Provider: &esv1alpha1.SecretStoreProvider{
  73. Vault: &esv1alpha1.VaultProvider{
  74. Server: "vault.example.com",
  75. Path: "secret",
  76. Version: esv1alpha1.VaultKVStoreV2,
  77. Auth: esv1alpha1.VaultAuth{
  78. Cert: &esv1alpha1.VaultCertAuth{
  79. ClientCert: esmeta.SecretKeySelector{
  80. Name: "tls-auth-certs",
  81. Key: "tls.crt",
  82. },
  83. SecretRef: esmeta.SecretKeySelector{
  84. Name: "tls-auth-certs",
  85. Key: "tls.key",
  86. },
  87. },
  88. },
  89. },
  90. },
  91. },
  92. }
  93. }
  94. func makeValidSecretStoreWithK8sCerts(isSecret bool) *esv1alpha1.SecretStore {
  95. store := makeSecretStore()
  96. caProvider := &esv1alpha1.CAProvider{
  97. Name: "vault-cert",
  98. Key: "cert",
  99. }
  100. if isSecret {
  101. caProvider.Type = "Secret"
  102. } else {
  103. caProvider.Type = "ConfigMap"
  104. }
  105. store.Spec.Provider.Vault.CAProvider = caProvider
  106. return store
  107. }
  108. type secretStoreTweakFn func(s *esv1alpha1.SecretStore)
  109. func makeSecretStore(tweaks ...secretStoreTweakFn) *esv1alpha1.SecretStore {
  110. store := makeValidSecretStore()
  111. for _, fn := range tweaks {
  112. fn(store)
  113. }
  114. return store
  115. }
  116. func newVaultResponse(data *vault.Secret) *vault.Response {
  117. jsonData, _ := json.Marshal(data)
  118. return &vault.Response{
  119. Response: &http.Response{
  120. Body: ioutil.NopCloser(bytes.NewReader(jsonData)),
  121. },
  122. }
  123. }
  124. func newVaultResponseWithData(data map[string]interface{}) *vault.Response {
  125. return newVaultResponse(&vault.Secret{
  126. Data: data,
  127. })
  128. }
  129. func newVaultTokenIDResponse(token string) *vault.Response {
  130. return newVaultResponseWithData(map[string]interface{}{
  131. "id": token,
  132. })
  133. }
  134. type args struct {
  135. newClientFunc func(c *vault.Config) (Client, error)
  136. store esv1alpha1.GenericStore
  137. kube kclient.Client
  138. ns string
  139. }
  140. type want struct {
  141. err error
  142. }
  143. type testCase struct {
  144. reason string
  145. args args
  146. want want
  147. }
  148. func clientWithLoginMock(c *vault.Config) (Client, error) {
  149. return &fake.VaultClient{
  150. MockNewRequest: fake.NewMockNewRequestFn(&vault.Request{}),
  151. MockRawRequestWithContext: fake.NewMockRawRequestWithContextFn(
  152. newVaultTokenIDResponse("test-token"), nil, func(got *vault.Request) error { return nil }),
  153. MockSetToken: fake.NewSetTokenFn(),
  154. }, nil
  155. }
  156. func kubeMockWithSecretTokenAndServiceAcc(obj kclient.Object) error {
  157. if o, ok := obj.(*corev1.ServiceAccount); ok {
  158. o.Secrets = []corev1.ObjectReference{
  159. {
  160. Name: tokenSecretName,
  161. },
  162. }
  163. return nil
  164. }
  165. if o, ok := obj.(*corev1.Secret); ok {
  166. o.Data = map[string][]byte{
  167. "token": []byte(secretDataString),
  168. }
  169. return nil
  170. }
  171. return nil
  172. }
  173. func TestNewVault(t *testing.T) {
  174. errBoom := errors.New("boom")
  175. secretClientKey := []byte(`-----BEGIN RSA PRIVATE KEY-----
  176. MIIEpAIBAAKCAQEArfZ4HV1obFVlVNiA24tX/UOakqRnEtWXpIvaOsMaPGvvODgGe4XnyJGO32idPv85sIr7vDH9p+OhactVlJV1fu5SZoZ7pg4jTCLqVDCb3IRD++yik2Sw58YayNe3HiaCTsJQWeMXLzfaqOeyk6bEpBCJo09+3QxUWxijgJ7YZCb+Gi8pf3ZWeSZG+rGNNvXHmTs1Yu1H849SYXu+uJOd/R3ZSTw8CxFe4eTLgbCnPf6tgA8Sg2hc+CAZxunPP2JLZWbiJXxjNRoypso6MAJ1FRkx5sTJiLg6UoLvd95/S/lCVOR2PDlM1hg7ox8VEd4QHky7tLx7gji/5hHQKJQSTwIDAQABAoIBAQCYPICQ8hVX+MNcpLrfZenycR7sBYNOMC0silbH5cUn6yzFfgHuRxi3pOnrCJnTb3cE0BvMbdMVAVdYReD2znSsR9NEdZvvjZ/GGSgH1SIQsI7t//+mDQ/jRLJb4KsXb4vJcLLwdpLrd22bMmhMXjzndrF8gSz8NLX9omozPM8RlLxjzPzYOdlX/Zw8V68qQH2Ic04KbtnCwyAUIgAJxYtn/uYB8lzILBkyzQqwhQKkDDZQ0wbZT0hP6z+HgsdifwQvHG1GZAgCuzzyXrL/4TgDaDhYdMVoBA4+HPmzqm5MkBvjH4oqroxjRofUroVix0OGXZJMI1OJ0z/ubzmwCq5BAoGBANqbwzAydUJs0P+GFL94K/Y6tXULKA2c9N0crbxoxheobRpuJvhpW1ZE/9UGpaYX1Rw3nW4x+Jwvt83YkgHAlR4LgEwDvdJPZobybfqifQDiraUO0t62Crn8mSxOsFCugtRIFniwnX67w3uKxiSdCZYbJGs9JEDTpxRG/PSWq3QlAoGBAMu3zOv1PJAhOky7VcxFxWQPEMY+t2PA/sneD01/qgGuhlTwL4QlpywmBqXcI070dcvcBkP0flnWI7y5cnuE1+55twmsrvfaS8s1+AYje0b35DsaF2vtKuJrXC0AGKP+/eiycd9cbvVW2GWOxE7Ui76Mj95MARK8ZNjt0wJagQhjAoGASm9dD80uhhadN1RFPkjB1054OMk6sx/tdFhug8e9I5MSyzwUguME2aQW5EcmIh7dToVVUo8rUqsgz7NdS8FyRM+vuLJRcQneJDbp4bxwCdwlOh2JCZI8psVutlp4yJATNgrxs9iXV+7BChDflNnvyK+nP+iKrpQiwNHHEdU3vg0CgYEAvEpwD4+loJn1psJn9NxwK6F5IaMKIhtZ4/9pKXpcCh3jb1JouL2MnFOxRVAJGor87aW57Mlol2RDt8W4OM56PqMlOL3xIokUEQka66GT6e5pdu8QwuJ9BrWwhq9WFw4yZQe6FHb836qbbJLegvYVC9QjjZW2UDjtBUwcAkrghH0CgYBUMmMOCwIfMEtMaWxZRGdxRabazLhn7TXhBpVTuv7WouPaXYd7ZGjCTMKAuVa/E4afBlxgemnqBuX90gHpK/dDmn9l+lp8GZey0grJ7G0x5HEMiKziaX5PrgAcKbQ70m9ZNZ1deYhsC05X8rHNexZB6ns7Yms9L7qnlAy51ZH2zw==
  177. -----END RSA PRIVATE KEY-----`)
  178. clientCrt := []byte(`-----BEGIN CERTIFICATE-----
  179. MIICsTCCAZkCFEJJ4daz5sxkFlzq9n1djLEuG7bmMA0GCSqGSIb3DQEBCwUAMBMxETAPBgNVBAMMCHZhdWx0LWNhMB4XDTIxMDcyMDA4MTQxM1oXDTIyMDcyMDA4MTQxM1owFzEVMBMGA1UEAwwMdmF1bHQtY2xpZW50MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArfZ4HV1obFVlVNiA24tX/UOakqRnEtWXpIvaOsMaPGvvODgGe4XnyJGO32idPv85sIr7vDH9p+OhactVlJV1fu5SZoZ7pg4jTCLqVDCb3IRD++yik2Sw58YayNe3HiaCTsJQWeMXLzfaqOeyk6bEpBCJo09+3QxUWxijgJ7YZCb+Gi8pf3ZWeSZG+rGNNvXHmTs1Yu1H849SYXu+uJOd/R3ZSTw8CxFe4eTLgbCnPf6tgA8Sg2hc+CAZxunPP2JLZWbiJXxjNRoypso6MAJ1FRkx5sTJiLg6UoLvd95/S/lCVOR2PDlM1hg7ox8VEd4QHky7tLx7gji/5hHQKJQSTwIDAQABMA0GCSqGSIb3DQEBCwUAA4IBAQAsDYKtzScIA7bqIOmqF8rr+oLSjRhPt5OfT+KGNdXk8G3VAy1ED2tyCHaRNC7dPLq4EvcxbIXQnXPy1iZMofriGbFPAcQ2fyWUesAD6bYSpI+bYxwz6Ebb93hU5nc/FyXg8yh0kgiGbY3MrACPjxqP2+z5kcOC3u3hx3SZylgW7TeOXDTdqSbNfH1b+1rR/bVNgQQshjhU9d+c4Yv/t0u07uykBhHLWZDSnYiAeOZ8+mWuOSDkcZHE1zznx74fWgtN0zRDtr0L0w9evT9R2CnNSZGxXcEQxAlQ7SL/Jyw82TFCGEw0L4jj7jjvx0N5J8KX/DulUDE9vuVyQEJ88Epe
  180. -----END CERTIFICATE-----
  181. `)
  182. secretData := []byte(secretDataString)
  183. cases := map[string]testCase{
  184. "InvalidVaultStore": {
  185. reason: "Should return error if given an invalid vault store.",
  186. args: args{
  187. store: &esv1alpha1.SecretStore{},
  188. },
  189. want: want{
  190. err: errors.New(errVaultStore),
  191. },
  192. },
  193. "AddVaultStoreCertsError": {
  194. reason: "Should return error if given an invalid CA certificate.",
  195. args: args{
  196. store: makeSecretStore(func(s *esv1alpha1.SecretStore) {
  197. s.Spec.Provider.Vault.CABundle = []byte("badcertdata")
  198. }),
  199. },
  200. want: want{
  201. err: errors.New(errVaultCert),
  202. },
  203. },
  204. "VaultAuthFormatError": {
  205. reason: "Should return error if no valid authentication method is given.",
  206. args: args{
  207. store: makeSecretStore(func(s *esv1alpha1.SecretStore) {
  208. s.Spec.Provider.Vault.Auth = esv1alpha1.VaultAuth{}
  209. }),
  210. },
  211. want: want{
  212. err: errors.New(errAuthFormat),
  213. },
  214. },
  215. "GetKubeServiceAccountError": {
  216. reason: "Should return error if fetching kubernetes secret fails.",
  217. args: args{
  218. store: makeSecretStore(),
  219. kube: &test.MockClient{
  220. MockGet: test.NewMockGetFn(errBoom),
  221. },
  222. },
  223. want: want{
  224. err: fmt.Errorf(errGetKubeSA, "example-sa", errBoom),
  225. },
  226. },
  227. "GetKubeSecretError": {
  228. reason: "Should return error if fetching kubernetes secret fails.",
  229. args: args{
  230. store: makeSecretStore(func(s *esv1alpha1.SecretStore) {
  231. s.Spec.Provider.Vault.Auth.Kubernetes.ServiceAccountRef = nil
  232. s.Spec.Provider.Vault.Auth.Kubernetes.SecretRef = &esmeta.SecretKeySelector{
  233. Name: "vault-secret",
  234. Key: "key",
  235. }
  236. }),
  237. kube: &test.MockClient{
  238. MockGet: test.NewMockGetFn(errBoom),
  239. },
  240. },
  241. want: want{
  242. err: fmt.Errorf(errGetKubeSecret, "vault-secret", errBoom),
  243. },
  244. },
  245. "SuccessfulVaultStore": {
  246. reason: "Should return a Vault provider successfully",
  247. args: args{
  248. store: makeSecretStore(),
  249. kube: &test.MockClient{
  250. MockGet: test.NewMockGetFn(nil, kubeMockWithSecretTokenAndServiceAcc),
  251. },
  252. newClientFunc: func(c *vault.Config) (Client, error) {
  253. return &fake.VaultClient{
  254. MockNewRequest: fake.NewMockNewRequestFn(&vault.Request{}),
  255. MockRawRequestWithContext: fake.NewMockRawRequestWithContextFn(
  256. newVaultTokenIDResponse("test-token"), nil, func(got *vault.Request) error {
  257. kubeRole := makeValidSecretStore().Spec.Provider.Vault.Auth.Kubernetes.Role
  258. want := kubeParameters(kubeRole, string(secretData))
  259. if diff := cmp.Diff(want, got.Obj); diff != "" {
  260. t.Errorf("RawRequestWithContext(...): -want, +got:\n%s", diff)
  261. }
  262. return nil
  263. }),
  264. MockSetToken: fake.NewSetTokenFn(),
  265. MockToken: fake.NewTokenFn(""),
  266. MockClearToken: fake.NewClearTokenFn(),
  267. }, nil
  268. },
  269. },
  270. want: want{
  271. err: nil,
  272. },
  273. },
  274. "SuccessfulVaultStoreWithCertAuth": {
  275. reason: "Should return a Vault provider successfully",
  276. args: args{
  277. store: makeValidSecretStoreWithCerts(),
  278. kube: &test.MockClient{
  279. MockGet: test.NewMockGetFn(nil, func(obj kclient.Object) error {
  280. if o, ok := obj.(*corev1.Secret); ok {
  281. o.Data = map[string][]byte{
  282. "tls.key": secretClientKey,
  283. "tls.crt": clientCrt,
  284. }
  285. return nil
  286. }
  287. return nil
  288. }),
  289. },
  290. newClientFunc: clientWithLoginMock,
  291. },
  292. want: want{
  293. err: nil,
  294. },
  295. },
  296. "SuccessfulVaultStoreWithK8sCertSecret": {
  297. reason: "Should return a Vault prodvider with the cert from k8s",
  298. args: args{
  299. store: makeValidSecretStoreWithK8sCerts(true),
  300. kube: &test.MockClient{
  301. MockGet: test.NewMockGetFn(nil, func(obj kclient.Object) error {
  302. if o, ok := obj.(*corev1.Secret); ok {
  303. o.Data = map[string][]byte{
  304. "cert": clientCrt,
  305. "token": secretData,
  306. }
  307. return nil
  308. }
  309. if o, ok := obj.(*corev1.ServiceAccount); ok {
  310. o.Secrets = []corev1.ObjectReference{
  311. {
  312. Name: tokenSecretName,
  313. },
  314. }
  315. return nil
  316. }
  317. return nil
  318. }),
  319. },
  320. newClientFunc: clientWithLoginMock,
  321. },
  322. want: want{
  323. err: nil,
  324. },
  325. },
  326. "GetCertSecretKeyMissingError": {
  327. reason: "Should return an error if the secret key is missing",
  328. args: args{
  329. store: makeValidSecretStoreWithK8sCerts(true),
  330. kube: &test.MockClient{
  331. MockGet: test.NewMockGetFn(nil, kubeMockWithSecretTokenAndServiceAcc),
  332. },
  333. newClientFunc: clientWithLoginMock,
  334. },
  335. want: want{
  336. err: fmt.Errorf(errVaultCert, errors.New(`cannot find secret data for key: "cert"`)),
  337. },
  338. },
  339. "SuccessfulVaultStoreWithK8sCertConfigMap": {
  340. reason: "Should return a Vault prodvider with the cert from k8s",
  341. args: args{
  342. store: makeValidSecretStoreWithK8sCerts(false),
  343. kube: &test.MockClient{
  344. MockGet: test.NewMockGetFn(nil, func(obj kclient.Object) error {
  345. if o, ok := obj.(*corev1.ConfigMap); ok {
  346. o.Data = map[string]string{
  347. "cert": string(clientCrt),
  348. }
  349. return nil
  350. }
  351. if o, ok := obj.(*corev1.ServiceAccount); ok {
  352. o.Secrets = []corev1.ObjectReference{
  353. {
  354. Name: tokenSecretName,
  355. },
  356. }
  357. return nil
  358. }
  359. if o, ok := obj.(*corev1.Secret); ok {
  360. o.Data = map[string][]byte{
  361. "token": secretData,
  362. }
  363. return nil
  364. }
  365. return nil
  366. }),
  367. },
  368. newClientFunc: clientWithLoginMock,
  369. },
  370. want: want{
  371. err: nil,
  372. },
  373. },
  374. "GetCertConfigMapMissingError": {
  375. reason: "Should return an error if the config map key is missing",
  376. args: args{
  377. store: makeValidSecretStoreWithK8sCerts(false),
  378. kube: &test.MockClient{
  379. MockGet: test.NewMockGetFn(nil, func(obj kclient.Object) error {
  380. if o, ok := obj.(*corev1.ServiceAccount); ok {
  381. o.Secrets = []corev1.ObjectReference{
  382. {
  383. Name: tokenSecretName,
  384. },
  385. }
  386. return nil
  387. }
  388. if o, ok := obj.(*corev1.Secret); ok {
  389. o.Data = map[string][]byte{
  390. "token": secretData,
  391. }
  392. return nil
  393. }
  394. return nil
  395. }),
  396. },
  397. newClientFunc: clientWithLoginMock,
  398. },
  399. want: want{
  400. err: fmt.Errorf(errConfigMapFmt, "cert"),
  401. },
  402. },
  403. "GetCertificateFormatError": {
  404. reason: "Should return error if client certificate is in wrong format.",
  405. args: args{
  406. store: makeValidSecretStoreWithCerts(),
  407. kube: &test.MockClient{
  408. MockGet: test.NewMockGetFn(nil, func(obj kclient.Object) error {
  409. if o, ok := obj.(*corev1.Secret); ok {
  410. o.Data = map[string][]byte{
  411. "tls.key": secretClientKey,
  412. "tls.crt": []byte("cert with mistak"),
  413. }
  414. return nil
  415. }
  416. return nil
  417. }),
  418. },
  419. newClientFunc: clientWithLoginMock,
  420. },
  421. want: want{
  422. err: fmt.Errorf(errClientTLSAuth, "tls: failed to find any PEM data in certificate input"),
  423. },
  424. },
  425. "GetKeyFormatError": {
  426. reason: "Should return error if client key is in wrong format.",
  427. args: args{
  428. store: makeValidSecretStoreWithCerts(),
  429. kube: &test.MockClient{
  430. MockGet: test.NewMockGetFn(nil, func(obj kclient.Object) error {
  431. if o, ok := obj.(*corev1.Secret); ok {
  432. o.Data = map[string][]byte{
  433. "tls.key": []byte("key with mistake"),
  434. "tls.crt": clientCrt,
  435. }
  436. return nil
  437. }
  438. return nil
  439. }),
  440. },
  441. newClientFunc: clientWithLoginMock,
  442. },
  443. want: want{
  444. err: fmt.Errorf(errClientTLSAuth, "tls: failed to find any PEM data in key input"),
  445. },
  446. },
  447. }
  448. for name, tc := range cases {
  449. t.Run(name, func(t *testing.T) {
  450. vaultTest(t, name, tc)
  451. })
  452. }
  453. }
  454. func vaultTest(t *testing.T, name string, tc testCase) {
  455. conn := &connector{
  456. newVaultClient: tc.args.newClientFunc,
  457. }
  458. if tc.args.newClientFunc == nil {
  459. conn.newVaultClient = newVaultClient
  460. }
  461. _, err := conn.NewClient(context.Background(), tc.args.store, tc.args.kube, tc.args.ns)
  462. if diff := cmp.Diff(tc.want.err, err, test.EquateErrors()); diff != "" {
  463. t.Errorf("\n%s\nvault.New(...): -want error, +got error:\n%s", tc.reason, diff)
  464. }
  465. }
  466. func TestGetSecretMap(t *testing.T) {
  467. errBoom := errors.New("boom")
  468. secret := map[string]interface{}{
  469. "access_key": "access_key",
  470. "access_secret": "access_secret",
  471. }
  472. secretWithNilVal := map[string]interface{}{
  473. "access_key": "access_key",
  474. "access_secret": "access_secret",
  475. "token": nil,
  476. }
  477. type args struct {
  478. store *esv1alpha1.VaultProvider
  479. kube kclient.Client
  480. vClient Client
  481. ns string
  482. data esv1alpha1.ExternalSecretDataRemoteRef
  483. }
  484. type want struct {
  485. err error
  486. }
  487. cases := map[string]struct {
  488. reason string
  489. args args
  490. want want
  491. }{
  492. "ReadSecretKV1": {
  493. reason: "Should map the secret even if it has a nil value",
  494. args: args{
  495. store: makeValidSecretStoreWithVersion(esv1alpha1.VaultKVStoreV1).Spec.Provider.Vault,
  496. vClient: &fake.VaultClient{
  497. MockNewRequest: fake.NewMockNewRequestFn(&vault.Request{}),
  498. MockRawRequestWithContext: fake.NewMockRawRequestWithContextFn(
  499. newVaultResponseWithData(secret), nil,
  500. ),
  501. },
  502. },
  503. want: want{
  504. err: nil,
  505. },
  506. },
  507. "ReadSecretKV2": {
  508. reason: "Should map the secret even if it has a nil value",
  509. args: args{
  510. store: makeValidSecretStoreWithVersion(esv1alpha1.VaultKVStoreV2).Spec.Provider.Vault,
  511. vClient: &fake.VaultClient{
  512. MockNewRequest: fake.NewMockNewRequestFn(&vault.Request{}),
  513. MockRawRequestWithContext: fake.NewMockRawRequestWithContextFn(
  514. newVaultResponseWithData(
  515. map[string]interface{}{
  516. "data": secret,
  517. },
  518. ), nil,
  519. ),
  520. },
  521. },
  522. want: want{
  523. err: nil,
  524. },
  525. },
  526. "ReadSecretWithNilValueKV1": {
  527. reason: "Should map the secret even if it has a nil value",
  528. args: args{
  529. store: makeValidSecretStoreWithVersion(esv1alpha1.VaultKVStoreV1).Spec.Provider.Vault,
  530. vClient: &fake.VaultClient{
  531. MockNewRequest: fake.NewMockNewRequestFn(&vault.Request{}),
  532. MockRawRequestWithContext: fake.NewMockRawRequestWithContextFn(
  533. newVaultResponseWithData(secretWithNilVal), nil,
  534. ),
  535. },
  536. },
  537. want: want{
  538. err: nil,
  539. },
  540. },
  541. "ReadSecretWithNilValueKV2": {
  542. reason: "Should map the secret even if it has a nil value",
  543. args: args{
  544. store: makeValidSecretStoreWithVersion(esv1alpha1.VaultKVStoreV2).Spec.Provider.Vault,
  545. vClient: &fake.VaultClient{
  546. MockNewRequest: fake.NewMockNewRequestFn(&vault.Request{}),
  547. MockRawRequestWithContext: fake.NewMockRawRequestWithContextFn(
  548. newVaultResponseWithData(
  549. map[string]interface{}{
  550. "data": secretWithNilVal,
  551. },
  552. ), nil,
  553. ),
  554. },
  555. },
  556. want: want{
  557. err: nil,
  558. },
  559. },
  560. "ReadSecretError": {
  561. reason: "Should return error if vault client fails to read secret.",
  562. args: args{
  563. store: makeSecretStore().Spec.Provider.Vault,
  564. vClient: &fake.VaultClient{
  565. MockNewRequest: fake.NewMockNewRequestFn(&vault.Request{}),
  566. MockRawRequestWithContext: fake.NewMockRawRequestWithContextFn(nil, errBoom),
  567. },
  568. },
  569. want: want{
  570. err: fmt.Errorf(errReadSecret, errBoom),
  571. },
  572. },
  573. }
  574. for name, tc := range cases {
  575. t.Run(name, func(t *testing.T) {
  576. vStore := &client{
  577. kube: tc.args.kube,
  578. client: tc.args.vClient,
  579. store: tc.args.store,
  580. namespace: tc.args.ns,
  581. }
  582. _, err := vStore.GetSecretMap(context.Background(), tc.args.data)
  583. if diff := cmp.Diff(tc.want.err, err, test.EquateErrors()); diff != "" {
  584. t.Errorf("\n%s\nvault.GetSecretMap(...): -want error, +got error:\n%s", tc.reason, diff)
  585. }
  586. })
  587. }
  588. }