provider_test.go 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708
  1. /*
  2. Copyright © The ESO Authors
  3. Licensed under the Apache License, Version 2.0 (the "License");
  4. you may not use this file except in compliance with the License.
  5. You may obtain a copy of the License at
  6. https://www.apache.org/licenses/LICENSE-2.0
  7. Unless required by applicable law or agreed to in writing, software
  8. distributed under the License is distributed on an "AS IS" BASIS,
  9. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  10. See the License for the specific language governing permissions and
  11. limitations under the License.
  12. */
  13. package secretserver
  14. import (
  15. "context"
  16. "math/rand"
  17. "testing"
  18. "github.com/DelineaXPM/tss-sdk-go/v3/server"
  19. "github.com/stretchr/testify/assert"
  20. corev1 "k8s.io/api/core/v1"
  21. kubeErrors "k8s.io/apimachinery/pkg/api/errors"
  22. metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
  23. kubeClient "sigs.k8s.io/controller-runtime/pkg/client"
  24. clientfake "sigs.k8s.io/controller-runtime/pkg/client/fake"
  25. esv1 "github.com/external-secrets/external-secrets/apis/externalsecrets/v1"
  26. v1 "github.com/external-secrets/external-secrets/apis/meta/v1"
  27. "github.com/external-secrets/external-secrets/runtime/esutils"
  28. )
  29. func TestDoesConfigDependOnNamespace(t *testing.T) {
  30. tests := map[string]struct {
  31. cfg esv1.SecretServerProvider
  32. want bool
  33. }{
  34. "true when Username references a secret without explicit namespace": {
  35. cfg: esv1.SecretServerProvider{
  36. Username: &esv1.SecretServerProviderRef{
  37. SecretRef: &v1.SecretKeySelector{Name: "foo"},
  38. },
  39. Password: &esv1.SecretServerProviderRef{SecretRef: nil},
  40. },
  41. want: true,
  42. },
  43. "true when password references a secret without explicit namespace": {
  44. cfg: esv1.SecretServerProvider{
  45. Username: &esv1.SecretServerProviderRef{SecretRef: nil},
  46. Password: &esv1.SecretServerProviderRef{
  47. SecretRef: &v1.SecretKeySelector{Name: "foo"},
  48. },
  49. },
  50. want: true,
  51. },
  52. "false when neither Username or Password reference a secret": {
  53. cfg: esv1.SecretServerProvider{
  54. Username: &esv1.SecretServerProviderRef{SecretRef: nil},
  55. Password: &esv1.SecretServerProviderRef{SecretRef: nil},
  56. },
  57. want: false,
  58. },
  59. }
  60. for name, tc := range tests {
  61. t.Run(name, func(t *testing.T) {
  62. got := doesConfigDependOnNamespace(&tc.cfg)
  63. assert.Equal(t, tc.want, got)
  64. })
  65. }
  66. }
  67. func TestValidateStore(t *testing.T) {
  68. validSecretRefUsingValue := makeSecretRefUsingValue("foo")
  69. ambiguousSecretRef := &esv1.SecretServerProviderRef{
  70. SecretRef: &v1.SecretKeySelector{Name: "foo"}, Value: "foo",
  71. }
  72. testURL := "https://example.com"
  73. tests := map[string]struct {
  74. cfg esv1.SecretServerProvider
  75. want error
  76. }{
  77. "invalid without username": {
  78. cfg: esv1.SecretServerProvider{
  79. Username: nil,
  80. Password: validSecretRefUsingValue,
  81. ServerURL: testURL,
  82. },
  83. want: errEmptyUserName,
  84. },
  85. "invalid without password": {
  86. cfg: esv1.SecretServerProvider{
  87. Username: validSecretRefUsingValue,
  88. Password: nil,
  89. ServerURL: testURL,
  90. },
  91. want: errEmptyPassword,
  92. },
  93. "invalid without serverURL": {
  94. cfg: esv1.SecretServerProvider{
  95. Username: validSecretRefUsingValue,
  96. Password: validSecretRefUsingValue,
  97. /*ServerURL: testURL,*/
  98. },
  99. want: errEmptyServerURL,
  100. },
  101. "invalid with ambiguous Username": {
  102. cfg: esv1.SecretServerProvider{
  103. Username: ambiguousSecretRef,
  104. Password: validSecretRefUsingValue,
  105. ServerURL: testURL,
  106. },
  107. want: errSecretRefAndValueConflict,
  108. },
  109. "invalid with ambiguous Password": {
  110. cfg: esv1.SecretServerProvider{
  111. Username: validSecretRefUsingValue,
  112. Password: ambiguousSecretRef,
  113. ServerURL: testURL,
  114. },
  115. want: errSecretRefAndValueConflict,
  116. },
  117. "invalid with invalid Username": {
  118. cfg: esv1.SecretServerProvider{
  119. Username: makeSecretRefUsingValue(""),
  120. Password: validSecretRefUsingValue,
  121. ServerURL: testURL,
  122. },
  123. want: errSecretRefAndValueMissing,
  124. },
  125. "invalid with invalid Password": {
  126. cfg: esv1.SecretServerProvider{
  127. Username: validSecretRefUsingValue,
  128. Password: makeSecretRefUsingValue(""),
  129. ServerURL: testURL,
  130. },
  131. want: errSecretRefAndValueMissing,
  132. },
  133. "valid with tenant/clientID/clientSecret": {
  134. cfg: esv1.SecretServerProvider{
  135. Username: validSecretRefUsingValue,
  136. Password: validSecretRefUsingValue,
  137. ServerURL: testURL,
  138. },
  139. want: nil,
  140. },
  141. }
  142. for name, tc := range tests {
  143. t.Run(name, func(t *testing.T) {
  144. s := esv1.SecretStore{
  145. Spec: esv1.SecretStoreSpec{
  146. Provider: &esv1.SecretStoreProvider{
  147. SecretServer: &tc.cfg,
  148. },
  149. },
  150. }
  151. p := &Provider{}
  152. _, got := p.ValidateStore(&s)
  153. assert.Equal(t, tc.want, got)
  154. })
  155. }
  156. }
  157. func TestNewClient(t *testing.T) {
  158. userNameKey := "username"
  159. userNameValue := "foo"
  160. passwordKey := "password"
  161. passwordValue := generateRandomString()
  162. domain := "domain1"
  163. clientSecret := &corev1.Secret{
  164. ObjectMeta: metav1.ObjectMeta{Name: "foo", Namespace: "default"},
  165. Data: map[string][]byte{
  166. userNameKey: []byte(userNameValue),
  167. passwordKey: []byte(passwordValue),
  168. },
  169. }
  170. validProvider := &esv1.SecretServerProvider{
  171. Username: makeSecretRefUsingRef(clientSecret.Name, userNameKey),
  172. Password: makeSecretRefUsingRef(clientSecret.Name, passwordKey),
  173. ServerURL: "https://example.com",
  174. }
  175. clientSecretWithDomain := &corev1.Secret{
  176. ObjectMeta: metav1.ObjectMeta{Name: "with-domain", Namespace: "default"},
  177. Data: map[string][]byte{
  178. userNameKey: []byte(userNameValue),
  179. passwordKey: []byte(passwordValue),
  180. domain: []byte(domain),
  181. },
  182. }
  183. validProviderWithDomain := &esv1.SecretServerProvider{
  184. Username: makeSecretRefUsingRef(clientSecretWithDomain.Name, userNameKey),
  185. Password: makeSecretRefUsingRef(clientSecretWithDomain.Name, passwordKey),
  186. Domain: domain,
  187. ServerURL: "https://example.com",
  188. }
  189. // Valid test CA certificate
  190. testCABundle := []byte(`-----BEGIN CERTIFICATE-----
  191. MIIDHTCCAgWgAwIBAgIRAKC4yxy9QGocND+6avTf7BgwDQYJKoZIhvcNAQELBQAw
  192. EjEQMA4GA1UEChMHQWNtZSBDbzAeFw0yMTAzMjAyMDA4MDhaFw0yMTAzMjAyMDM4
  193. MDhaMBIxEDAOBgNVBAoTB0FjbWUgQ28wggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAw
  194. ggEKAoIBAQC3o6/JdZEqNbqNRkopHhJtJG5c4qS5d0tQ/kZYpfD/v/izAYum4Nzj
  195. aG15owr92/11W0pxPUliRLti3y6iScTs+ofm2D7p4UXj/Fnho/2xoWSOoWAodgvW
  196. Y8jh8A0LQALZiV/9QsrJdXZdS47DYZLsQ3z9yFC/CdXkg1l7AQ3fIVGKdrQBr9kE
  197. 1gEDqnKfRxXI8DEQKXr+CKPUwCAytegmy0SHp53zNAvY+kopHytzmJpXLoEhxq4e
  198. ugHe52vXHdh/HJ9VjNp0xOH1waAgAGxHlltCW0PVd5AJ0SXROBS/a3V9sZCbCrJa
  199. YOOonQSEswveSv6PcG9AHvpNPot2Xs6hAgMBAAGjbjBsMA4GA1UdDwEB/wQEAwIC
  200. pDATBgNVHSUEDDAKBggrBgEFBQcDATAPBgNVHRMBAf8EBTADAQH/MB0GA1UdDgQW
  201. BBR00805mrpoonp95RmC3B6oLl+cGTAVBgNVHREEDjAMggpnb29ibGUuY29tMA0G
  202. CSqGSIb3DQEBCwUAA4IBAQAipc1b6JrEDayPjpz5GM5krcI8dCWVd8re0a9bGjjN
  203. ioWGlu/eTr5El0ffwCNZ2WLmL9rewfHf/bMvYz3ioFZJ2OTxfazqYXNggQz6cMfa
  204. lbedDCdt5XLVX2TyerGvFram+9Uyvk3l0uM7rZnwAmdirG4Tv94QRaD3q4xTj/c0
  205. mv+AggtK0aRFb9o47z/BypLdk5mhbf3Mmr88C8XBzEnfdYyf4JpTlZrYLBmDCu5d
  206. 9RLLsjXxhag8xqMtd1uLUM8XOTGzVWacw8iGY+CTtBKqyA+AE6/bDwZvEwVtsKtC
  207. QJ85ioEpy00NioqcF0WyMZH80uMsPycfpnl5uF7RkW8u
  208. -----END CERTIFICATE-----`)
  209. caSecretName := "ca-secret"
  210. caSecretKey := "ca.crt"
  211. caSecret := &corev1.Secret{
  212. ObjectMeta: metav1.ObjectMeta{Name: caSecretName, Namespace: "default"},
  213. Data: map[string][]byte{
  214. caSecretKey: testCABundle,
  215. },
  216. }
  217. caConfigMapName := "ca-configmap"
  218. caConfigMapKey := "ca.crt"
  219. caConfigMap := &corev1.ConfigMap{
  220. ObjectMeta: metav1.ObjectMeta{Name: caConfigMapName, Namespace: "default"},
  221. Data: map[string]string{
  222. caConfigMapKey: string(testCABundle),
  223. },
  224. }
  225. tests := map[string]struct {
  226. store esv1.GenericStore // leave nil for namespaced store
  227. provider *esv1.SecretServerProvider // discarded when store is set
  228. kube kubeClient.Client
  229. errCheck func(t *testing.T, err error)
  230. }{
  231. "missing provider config": {
  232. provider: nil,
  233. errCheck: func(t *testing.T, err error) {
  234. assert.ErrorIs(t, err, errInvalidSpec)
  235. },
  236. },
  237. "namespace-dependent cluster secret store": {
  238. store: &esv1.ClusterSecretStore{
  239. TypeMeta: metav1.TypeMeta{Kind: esv1.ClusterSecretStoreKind},
  240. Spec: esv1.SecretStoreSpec{
  241. Provider: &esv1.SecretStoreProvider{
  242. SecretServer: validProvider,
  243. },
  244. },
  245. },
  246. errCheck: func(t *testing.T, err error) {
  247. assert.ErrorIs(t, err, errClusterStoreRequiresNamespace)
  248. },
  249. },
  250. "dangling password ref": {
  251. provider: &esv1.SecretServerProvider{
  252. Username: validProvider.Username,
  253. Password: makeSecretRefUsingRef("typo", passwordKey),
  254. ServerURL: validProvider.ServerURL,
  255. },
  256. kube: clientfake.NewClientBuilder().WithObjects(clientSecret).Build(),
  257. errCheck: func(t *testing.T, err error) {
  258. assert.True(t, kubeErrors.IsNotFound(err))
  259. },
  260. },
  261. "dangling username ref": {
  262. provider: &esv1.SecretServerProvider{
  263. Username: makeSecretRefUsingRef("typo", userNameKey),
  264. Password: validProvider.Password,
  265. ServerURL: validProvider.ServerURL,
  266. },
  267. kube: clientfake.NewClientBuilder().WithObjects(clientSecret).Build(),
  268. errCheck: func(t *testing.T, err error) {
  269. assert.True(t, kubeErrors.IsNotFound(err))
  270. },
  271. },
  272. "secret ref without name": {
  273. provider: &esv1.SecretServerProvider{
  274. Username: makeSecretRefUsingRef("", userNameKey),
  275. Password: validProvider.Password,
  276. ServerURL: validProvider.ServerURL,
  277. },
  278. kube: clientfake.NewClientBuilder().WithObjects(clientSecret).Build(),
  279. errCheck: func(t *testing.T, err error) {
  280. assert.ErrorIs(t, err, errMissingSecretName)
  281. },
  282. },
  283. "secret ref without key": {
  284. provider: &esv1.SecretServerProvider{
  285. Username: validProvider.Password,
  286. Password: makeSecretRefUsingRef(clientSecret.Name, ""),
  287. ServerURL: validProvider.ServerURL,
  288. },
  289. kube: clientfake.NewClientBuilder().WithObjects(clientSecret).Build(),
  290. errCheck: func(t *testing.T, err error) {
  291. assert.ErrorIs(t, err, errMissingSecretKey)
  292. },
  293. },
  294. "secret ref with non-existent keys": {
  295. provider: &esv1.SecretServerProvider{
  296. Username: makeSecretRefUsingRef(clientSecret.Name, "typo"),
  297. Password: makeSecretRefUsingRef(clientSecret.Name, passwordKey),
  298. ServerURL: validProvider.ServerURL,
  299. },
  300. kube: clientfake.NewClientBuilder().WithObjects(clientSecret).Build(),
  301. errCheck: func(t *testing.T, err error) {
  302. assert.EqualError(t, err, "cannot find secret data for key: \"typo\"")
  303. },
  304. },
  305. "valid secret refs": {
  306. provider: validProvider,
  307. kube: clientfake.NewClientBuilder().WithObjects(clientSecret).Build(),
  308. },
  309. "secret values": {
  310. provider: &esv1.SecretServerProvider{
  311. Username: makeSecretRefUsingValue(userNameValue),
  312. Password: makeSecretRefUsingValue(passwordValue),
  313. ServerURL: validProvider.ServerURL,
  314. },
  315. kube: clientfake.NewClientBuilder().WithObjects(clientSecret).Build(),
  316. },
  317. "cluster secret store": {
  318. store: &esv1.ClusterSecretStore{
  319. TypeMeta: metav1.TypeMeta{Kind: esv1.ClusterSecretStoreKind},
  320. Spec: esv1.SecretStoreSpec{
  321. Provider: &esv1.SecretStoreProvider{
  322. SecretServer: &esv1.SecretServerProvider{
  323. Username: makeSecretRefUsingNamespacedRef(clientSecret.Namespace, clientSecret.Name, userNameKey),
  324. Password: makeSecretRefUsingNamespacedRef(clientSecret.Namespace, clientSecret.Name, passwordKey),
  325. ServerURL: validProvider.ServerURL,
  326. },
  327. },
  328. },
  329. },
  330. kube: clientfake.NewClientBuilder().WithObjects(clientSecret).Build(),
  331. },
  332. "cluster secret store with domain": {
  333. store: &esv1.ClusterSecretStore{
  334. TypeMeta: metav1.TypeMeta{Kind: esv1.ClusterSecretStoreKind},
  335. Spec: esv1.SecretStoreSpec{
  336. Provider: &esv1.SecretStoreProvider{
  337. SecretServer: &esv1.SecretServerProvider{
  338. Username: makeSecretRefUsingNamespacedRef(clientSecretWithDomain.Namespace, clientSecretWithDomain.Name, userNameKey),
  339. Password: makeSecretRefUsingNamespacedRef(clientSecretWithDomain.Namespace, clientSecretWithDomain.Name, passwordKey),
  340. Domain: validProviderWithDomain.Domain,
  341. ServerURL: validProviderWithDomain.ServerURL,
  342. },
  343. },
  344. },
  345. },
  346. kube: clientfake.NewClientBuilder().WithObjects(clientSecret, clientSecretWithDomain).Build(),
  347. },
  348. "valid with CABundle and CAProvider using Secret": {
  349. provider: &esv1.SecretServerProvider{
  350. Username: validProvider.Username,
  351. Password: validProvider.Password,
  352. ServerURL: validProvider.ServerURL,
  353. CABundle: testCABundle,
  354. CAProvider: &esv1.CAProvider{
  355. Type: esv1.CAProviderTypeSecret,
  356. Name: caSecretName,
  357. Key: caSecretKey,
  358. },
  359. },
  360. kube: clientfake.NewClientBuilder().WithObjects(clientSecret, caSecret).Build(),
  361. },
  362. "valid with CABundle and CAProvider using ConfigMap": {
  363. provider: &esv1.SecretServerProvider{
  364. Username: validProvider.Username,
  365. Password: validProvider.Password,
  366. ServerURL: validProvider.ServerURL,
  367. CABundle: testCABundle,
  368. CAProvider: &esv1.CAProvider{
  369. Type: esv1.CAProviderTypeConfigMap,
  370. Name: caConfigMapName,
  371. Key: caConfigMapKey,
  372. },
  373. },
  374. kube: clientfake.NewClientBuilder().WithObjects(clientSecret, caConfigMap).Build(),
  375. },
  376. "CABundle without CAProvider is ignored": {
  377. provider: &esv1.SecretServerProvider{
  378. Username: validProvider.Username,
  379. Password: validProvider.Password,
  380. ServerURL: validProvider.ServerURL,
  381. CABundle: testCABundle,
  382. },
  383. kube: clientfake.NewClientBuilder().WithObjects(clientSecret).Build(),
  384. },
  385. "CAProvider without CABundle is ignored": {
  386. provider: &esv1.SecretServerProvider{
  387. Username: validProvider.Username,
  388. Password: validProvider.Password,
  389. ServerURL: validProvider.ServerURL,
  390. CAProvider: &esv1.CAProvider{
  391. Type: esv1.CAProviderTypeSecret,
  392. Name: caSecretName,
  393. Key: caSecretKey,
  394. },
  395. },
  396. kube: clientfake.NewClientBuilder().WithObjects(clientSecret, caSecret).Build(),
  397. },
  398. "invalid CABundle format with CAProvider": {
  399. provider: &esv1.SecretServerProvider{
  400. Username: validProvider.Username,
  401. Password: validProvider.Password,
  402. ServerURL: validProvider.ServerURL,
  403. CABundle: []byte("invalid certificate data"),
  404. CAProvider: &esv1.CAProvider{
  405. Type: esv1.CAProviderTypeSecret,
  406. Name: caSecretName,
  407. Key: caSecretKey,
  408. },
  409. },
  410. kube: clientfake.NewClientBuilder().WithObjects(clientSecret, caSecret).Build(),
  411. errCheck: func(t *testing.T, err error) {
  412. assert.Error(t, err)
  413. assert.Contains(t, err.Error(), "failed to decode ca bundle")
  414. },
  415. },
  416. "missing CAProvider Secret with valid CABundle": {
  417. provider: &esv1.SecretServerProvider{
  418. Username: validProvider.Username,
  419. Password: validProvider.Password,
  420. ServerURL: validProvider.ServerURL,
  421. CABundle: testCABundle,
  422. CAProvider: &esv1.CAProvider{
  423. Type: esv1.CAProviderTypeSecret,
  424. Name: "non-existent-secret",
  425. Key: caSecretKey,
  426. },
  427. },
  428. kube: clientfake.NewClientBuilder().WithObjects(clientSecret).Build(),
  429. // CABundle takes precedence, so even if the secret doesn't exist, CABundle is used
  430. },
  431. "only CAProvider without CABundle is ignored": {
  432. provider: &esv1.SecretServerProvider{
  433. Username: validProvider.Username,
  434. Password: validProvider.Password,
  435. ServerURL: validProvider.ServerURL,
  436. CAProvider: &esv1.CAProvider{
  437. Type: esv1.CAProviderTypeSecret,
  438. Name: caSecretName,
  439. Key: caSecretKey,
  440. },
  441. },
  442. kube: clientfake.NewClientBuilder().WithObjects(clientSecret, caSecret).Build(),
  443. // No error expected because both CABundle AND CAProvider must be set for TLS config
  444. },
  445. "cluster secret store with CABundle and CAProvider": {
  446. store: &esv1.ClusterSecretStore{
  447. TypeMeta: metav1.TypeMeta{Kind: esv1.ClusterSecretStoreKind},
  448. Spec: esv1.SecretStoreSpec{
  449. Provider: &esv1.SecretStoreProvider{
  450. SecretServer: &esv1.SecretServerProvider{
  451. Username: makeSecretRefUsingNamespacedRef(clientSecret.Namespace, clientSecret.Name, userNameKey),
  452. Password: makeSecretRefUsingNamespacedRef(clientSecret.Namespace, clientSecret.Name, passwordKey),
  453. ServerURL: validProvider.ServerURL,
  454. CABundle: testCABundle,
  455. CAProvider: &esv1.CAProvider{
  456. Type: esv1.CAProviderTypeSecret,
  457. Name: caSecretName,
  458. Key: caSecretKey,
  459. Namespace: esutils.Ptr("default"),
  460. },
  461. },
  462. },
  463. },
  464. },
  465. kube: clientfake.NewClientBuilder().WithObjects(clientSecret, caSecret).Build(),
  466. },
  467. }
  468. for name, tc := range tests {
  469. t.Run(name, func(t *testing.T) {
  470. p := &Provider{}
  471. store := tc.store
  472. if store == nil {
  473. store = &esv1.SecretStore{
  474. TypeMeta: metav1.TypeMeta{Kind: esv1.SecretStoreKind},
  475. Spec: esv1.SecretStoreSpec{
  476. Provider: &esv1.SecretStoreProvider{
  477. SecretServer: tc.provider,
  478. },
  479. },
  480. }
  481. }
  482. sc, err := p.NewClient(context.Background(), store, tc.kube, clientSecret.Namespace)
  483. if tc.errCheck == nil {
  484. assert.NoError(t, err)
  485. delineaClient, ok := sc.(*client)
  486. assert.True(t, ok)
  487. secretServerClient, ok := delineaClient.api.(*server.Server)
  488. assert.True(t, ok)
  489. expectedCredentials := server.UserCredential{
  490. Username: userNameValue,
  491. Password: passwordValue,
  492. }
  493. if name == "cluster secret store with domain" {
  494. expectedCredentials.Domain = domain
  495. }
  496. assert.Equal(t, expectedCredentials, secretServerClient.Configuration.Credentials)
  497. } else {
  498. assert.Nil(t, sc)
  499. tc.errCheck(t, err)
  500. }
  501. })
  502. }
  503. }
  504. func makeSecretRefUsingNamespacedRef(namespace, name, key string) *esv1.SecretServerProviderRef {
  505. return &esv1.SecretServerProviderRef{
  506. SecretRef: &v1.SecretKeySelector{Namespace: esutils.Ptr(namespace), Name: name, Key: key},
  507. }
  508. }
  509. func makeSecretRefUsingValue(val string) *esv1.SecretServerProviderRef {
  510. return &esv1.SecretServerProviderRef{Value: val}
  511. }
  512. func makeSecretRefUsingRef(name, key string) *esv1.SecretServerProviderRef {
  513. return &esv1.SecretServerProviderRef{
  514. SecretRef: &v1.SecretKeySelector{Name: name, Key: key},
  515. }
  516. }
  517. func generateRandomString() string {
  518. var letters = []rune("abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789")
  519. b := make([]rune, 10)
  520. for i := range b {
  521. b[i] = letters[rand.Intn(len(letters))]
  522. }
  523. return string(b)
  524. }
  525. // TestValidateStoreSecretRef tests the validateStoreSecretRef function.
  526. func TestValidateStoreSecretRef(t *testing.T) {
  527. tests := map[string]struct {
  528. store esv1.GenericStore
  529. ref *esv1.SecretServerProviderRef
  530. wantErr error
  531. }{
  532. "valid secret ref for SecretStore": {
  533. store: &esv1.SecretStore{
  534. ObjectMeta: metav1.ObjectMeta{
  535. Name: "test-store",
  536. Namespace: "default",
  537. },
  538. },
  539. ref: &esv1.SecretServerProviderRef{
  540. SecretRef: &v1.SecretKeySelector{
  541. Name: "secret-name",
  542. Key: "secret-key",
  543. },
  544. },
  545. wantErr: nil,
  546. },
  547. "error when secret ref missing name": {
  548. store: &esv1.SecretStore{
  549. ObjectMeta: metav1.ObjectMeta{
  550. Name: "test-store",
  551. Namespace: "default",
  552. },
  553. },
  554. ref: &esv1.SecretServerProviderRef{
  555. SecretRef: &v1.SecretKeySelector{
  556. Name: "",
  557. Key: "secret-key",
  558. },
  559. },
  560. wantErr: errMissingSecretName,
  561. },
  562. "error when secret ref missing key": {
  563. store: &esv1.SecretStore{
  564. ObjectMeta: metav1.ObjectMeta{
  565. Name: "test-store",
  566. Namespace: "default",
  567. },
  568. },
  569. ref: &esv1.SecretServerProviderRef{
  570. SecretRef: &v1.SecretKeySelector{
  571. Name: "secret-name",
  572. Key: "",
  573. },
  574. },
  575. wantErr: errMissingSecretKey,
  576. },
  577. "error when both value and secret ref are set": {
  578. store: &esv1.SecretStore{
  579. ObjectMeta: metav1.ObjectMeta{
  580. Name: "test-store",
  581. Namespace: "default",
  582. },
  583. },
  584. ref: &esv1.SecretServerProviderRef{
  585. SecretRef: &v1.SecretKeySelector{
  586. Name: "secret-name",
  587. Key: "secret-key",
  588. },
  589. Value: "some-value",
  590. },
  591. wantErr: errSecretRefAndValueConflict,
  592. },
  593. }
  594. for name, tc := range tests {
  595. t.Run(name, func(t *testing.T) {
  596. err := validateStoreSecretRef(tc.store, tc.ref)
  597. if tc.wantErr == nil {
  598. assert.NoError(t, err)
  599. } else {
  600. assert.ErrorIs(t, err, tc.wantErr)
  601. }
  602. })
  603. }
  604. }
  605. // TestCapabilities tests the Capabilities function.
  606. func TestCapabilities(t *testing.T) {
  607. tests := map[string]struct {
  608. want esv1.SecretStoreCapabilities
  609. }{
  610. "returns ReadOnly capability": {
  611. want: esv1.SecretStoreReadOnly,
  612. },
  613. }
  614. for name, tc := range tests {
  615. t.Run(name, func(t *testing.T) {
  616. p := &Provider{}
  617. got := p.Capabilities()
  618. assert.Equal(t, tc.want, got)
  619. // Edge: call Capabilities on nil Provider
  620. var nilP *Provider
  621. if nilP != nil {
  622. assert.Equal(t, esv1.SecretStoreReadOnly, nilP.Capabilities())
  623. }
  624. })
  625. }
  626. }
  627. // TestNewProvider tests the NewProvider function.
  628. func TestNewProvider(t *testing.T) {
  629. tests := map[string]struct {
  630. want esv1.Provider
  631. }{
  632. "creates a new provider instance": {
  633. want: &Provider{},
  634. },
  635. }
  636. for name, tc := range tests {
  637. t.Run(name, func(t *testing.T) {
  638. got := NewProvider()
  639. assert.NotNil(t, got)
  640. assert.IsType(t, tc.want, got)
  641. // Edge: call NewProvider multiple times
  642. got2 := NewProvider()
  643. assert.IsType(t, tc.want, got2)
  644. })
  645. }
  646. }
  647. // TestProviderSpec tests the ProviderSpec function.
  648. func TestProviderSpec(t *testing.T) {
  649. tests := map[string]struct {
  650. wantType *esv1.SecretStoreProvider
  651. }{
  652. "returns correct provider spec": {
  653. wantType: &esv1.SecretStoreProvider{
  654. SecretServer: &esv1.SecretServerProvider{},
  655. },
  656. },
  657. }
  658. for name, tc := range tests {
  659. t.Run(name, func(t *testing.T) {
  660. got := ProviderSpec()
  661. assert.NotNil(t, got)
  662. assert.NotNil(t, got.SecretServer)
  663. assert.IsType(t, tc.wantType, got)
  664. // Ensure ProviderSpec returns a fresh instance (no shared mutable state)
  665. // Mutate the returned object and verify a subsequent call is unaffected.
  666. got.SecretServer.ServerURL = "http://modified.local"
  667. got2 := ProviderSpec()
  668. assert.IsType(t, tc.wantType, got2)
  669. // If ProviderSpec reused a shared object, this would be equal.
  670. assert.NotEqual(t, got.SecretServer.ServerURL, got2.SecretServer.ServerURL)
  671. })
  672. }
  673. }