oracle_test.go 22 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786
  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 oracle
  13. import (
  14. "context"
  15. "crypto/rand"
  16. "crypto/rsa"
  17. "crypto/x509"
  18. "encoding/base64"
  19. "encoding/pem"
  20. "errors"
  21. "reflect"
  22. "strings"
  23. "testing"
  24. "time"
  25. "github.com/oracle/oci-go-sdk/v65/common"
  26. "github.com/oracle/oci-go-sdk/v65/secrets"
  27. "github.com/oracle/oci-go-sdk/v65/vault"
  28. "github.com/stretchr/testify/assert"
  29. corev1 "k8s.io/api/core/v1"
  30. metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
  31. "k8s.io/apimachinery/pkg/runtime"
  32. "k8s.io/utils/ptr"
  33. clientfake "sigs.k8s.io/controller-runtime/pkg/client/fake"
  34. esv1 "github.com/external-secrets/external-secrets/apis/externalsecrets/v1"
  35. esv1alpha1 "github.com/external-secrets/external-secrets/apis/externalsecrets/v1alpha1"
  36. esmeta "github.com/external-secrets/external-secrets/apis/meta/v1"
  37. fakeoracle "github.com/external-secrets/external-secrets/pkg/provider/oracle/fake"
  38. testingfake "github.com/external-secrets/external-secrets/pkg/provider/testing/fake"
  39. )
  40. const (
  41. vaultOCID = "vault-OCID"
  42. region = "some-region"
  43. tenant = "a-tenant"
  44. userOCID = "user-OCID"
  45. secretKey = "key"
  46. secretName = "name"
  47. )
  48. type vaultTestCase struct {
  49. mockClient *fakeoracle.OracleMockClient
  50. apiInput *secrets.GetSecretBundleByNameRequest
  51. apiOutput *secrets.GetSecretBundleByNameResponse
  52. ref *esv1.ExternalSecretDataRemoteRef
  53. apiErr error
  54. expectError string
  55. expectedSecret string
  56. // for testing secretmap
  57. expectedData map[string][]byte
  58. }
  59. func makeValidVaultTestCase() *vaultTestCase {
  60. smtc := vaultTestCase{
  61. mockClient: &fakeoracle.OracleMockClient{},
  62. apiInput: makeValidAPIInput(),
  63. ref: makeValidRef(),
  64. apiOutput: makeValidAPIOutput(),
  65. apiErr: nil,
  66. expectError: "",
  67. expectedSecret: "",
  68. expectedData: map[string][]byte{},
  69. }
  70. smtc.mockClient.WithValue(*smtc.apiInput, *smtc.apiOutput, smtc.apiErr)
  71. return &smtc
  72. }
  73. func makeValidRef() *esv1.ExternalSecretDataRemoteRef {
  74. return &esv1.ExternalSecretDataRemoteRef{
  75. Key: "test-secret",
  76. Version: "default",
  77. }
  78. }
  79. func makeValidAPIInput() *secrets.GetSecretBundleByNameRequest {
  80. return &secrets.GetSecretBundleByNameRequest{
  81. SecretName: ptr.To("test-secret"),
  82. VaultId: ptr.To("test-vault"),
  83. }
  84. }
  85. func makeValidAPIOutput() *secrets.GetSecretBundleByNameResponse {
  86. return &secrets.GetSecretBundleByNameResponse{
  87. SecretBundle: secrets.SecretBundle{},
  88. }
  89. }
  90. func makeValidVaultTestCaseCustom(tweaks ...func(smtc *vaultTestCase)) *vaultTestCase {
  91. smtc := makeValidVaultTestCase()
  92. for _, fn := range tweaks {
  93. fn(smtc)
  94. }
  95. smtc.mockClient.WithValue(*smtc.apiInput, *smtc.apiOutput, smtc.apiErr)
  96. return smtc
  97. }
  98. // This case can be shared by both GetSecret and GetSecretMap tests.
  99. // bad case: set apiErr.
  100. var setAPIErr = func(smtc *vaultTestCase) {
  101. smtc.apiErr = errors.New("oh no")
  102. smtc.expectError = "oh no"
  103. }
  104. var setNilMockClient = func(smtc *vaultTestCase) {
  105. smtc.mockClient = nil
  106. smtc.expectError = errUninitalizedOracleProvider
  107. }
  108. func TestOracleVaultGetSecret(t *testing.T) {
  109. secretValue := "changedvalue"
  110. // good case: default version is set
  111. // key is passed in, output is sent back
  112. setSecretString := func(smtc *vaultTestCase) {
  113. smtc.apiOutput = &secrets.GetSecretBundleByNameResponse{
  114. SecretBundle: secrets.SecretBundle{
  115. SecretId: ptr.To("test-id"),
  116. VersionNumber: ptr.To(int64(1)),
  117. SecretBundleContent: secrets.Base64SecretBundleContentDetails{
  118. Content: ptr.To(base64.StdEncoding.EncodeToString([]byte(secretValue))),
  119. },
  120. },
  121. }
  122. smtc.expectedSecret = secretValue
  123. }
  124. successCases := []*vaultTestCase{
  125. makeValidVaultTestCaseCustom(setAPIErr),
  126. makeValidVaultTestCaseCustom(setNilMockClient),
  127. makeValidVaultTestCaseCustom(setSecretString),
  128. }
  129. sm := VaultManagementService{}
  130. for k, v := range successCases {
  131. sm.Client = v.mockClient
  132. out, err := sm.GetSecret(context.Background(), *v.ref)
  133. if !ErrorContains(err, v.expectError) {
  134. t.Errorf("[%d] unexpected error: %s, expected: '%s'", k, err.Error(), v.expectError)
  135. }
  136. if string(out) != v.expectedSecret {
  137. t.Errorf("[%d] unexpected secret: expected %s, got %s", k, v.expectedSecret, string(out))
  138. }
  139. }
  140. }
  141. func TestGetSecretMap(t *testing.T) {
  142. // good case: default version & deserialization
  143. setDeserialization := func(smtc *vaultTestCase) {
  144. smtc.apiOutput.SecretBundleContent = secrets.Base64SecretBundleContentDetails{
  145. Content: ptr.To(base64.StdEncoding.EncodeToString([]byte(`{"foo":"bar"}`))),
  146. }
  147. smtc.expectedData["foo"] = []byte("bar")
  148. }
  149. // bad case: invalid json
  150. setInvalidJSON := func(smtc *vaultTestCase) {
  151. smtc.apiOutput.SecretBundleContent = secrets.Base64SecretBundleContentDetails{
  152. Content: ptr.To(base64.StdEncoding.EncodeToString([]byte(`-----------------`))),
  153. }
  154. smtc.expectError = "unable to unmarshal secret"
  155. }
  156. successCases := []*vaultTestCase{
  157. makeValidVaultTestCaseCustom(setDeserialization),
  158. makeValidVaultTestCaseCustom(setInvalidJSON),
  159. makeValidVaultTestCaseCustom(setNilMockClient),
  160. makeValidVaultTestCaseCustom(setAPIErr),
  161. }
  162. sm := VaultManagementService{}
  163. for k, v := range successCases {
  164. sm.Client = v.mockClient
  165. out, err := sm.GetSecretMap(context.Background(), *v.ref)
  166. if !ErrorContains(err, v.expectError) {
  167. t.Errorf("[%d] unexpected error: %s, expected: '%s'", k, err.Error(), v.expectError)
  168. }
  169. if err == nil && !reflect.DeepEqual(out, v.expectedData) {
  170. t.Errorf("[%d] unexpected secret data: expected %#v, got %#v", k, v.expectedData, out)
  171. }
  172. }
  173. }
  174. func ErrorContains(out error, want string) bool {
  175. if out == nil {
  176. return want == ""
  177. }
  178. if want == "" {
  179. return false
  180. }
  181. return strings.Contains(out.Error(), want)
  182. }
  183. type storeModifier func(*esv1.SecretStore) *esv1.SecretStore
  184. func makeSecretStore(vault, region string, fn ...storeModifier) *esv1.SecretStore {
  185. store := &esv1.SecretStore{
  186. Spec: esv1.SecretStoreSpec{
  187. Provider: &esv1.SecretStoreProvider{
  188. Oracle: &esv1.OracleProvider{
  189. Vault: vault,
  190. Region: region,
  191. },
  192. },
  193. },
  194. }
  195. for _, f := range fn {
  196. store = f(store)
  197. }
  198. return store
  199. }
  200. func withSecretAuth(user, tenancy string) storeModifier {
  201. return func(store *esv1.SecretStore) *esv1.SecretStore {
  202. store.Spec.Provider.Oracle.Auth = &esv1.OracleAuth{
  203. User: user,
  204. Tenancy: tenancy,
  205. }
  206. return store
  207. }
  208. }
  209. func withPrivateKey(name, key string, namespace *string) storeModifier {
  210. return func(store *esv1.SecretStore) *esv1.SecretStore {
  211. store.Spec.Provider.Oracle.Auth.SecretRef.PrivateKey = esmeta.SecretKeySelector{
  212. Name: name,
  213. Key: key,
  214. Namespace: namespace,
  215. }
  216. return store
  217. }
  218. }
  219. func withFingerprint(name, key string, namespace *string) storeModifier {
  220. return func(store *esv1.SecretStore) *esv1.SecretStore {
  221. store.Spec.Provider.Oracle.Auth.SecretRef.Fingerprint = esmeta.SecretKeySelector{
  222. Name: name,
  223. Key: key,
  224. Namespace: namespace,
  225. }
  226. return store
  227. }
  228. }
  229. type ValidateStoreTestCase struct {
  230. store *esv1.SecretStore
  231. err error
  232. }
  233. func TestValidateStore(t *testing.T) {
  234. namespace := "my-namespace"
  235. testCases := []ValidateStoreTestCase{
  236. {
  237. store: makeSecretStore("", region),
  238. err: errors.New("vault cannot be empty"),
  239. },
  240. {
  241. store: makeSecretStore(vaultOCID, ""),
  242. err: errors.New("region cannot be empty"),
  243. },
  244. {
  245. store: makeSecretStore(vaultOCID, region, withSecretAuth("", tenant)),
  246. err: errors.New("user cannot be empty"),
  247. },
  248. {
  249. store: makeSecretStore(vaultOCID, region, withSecretAuth(userOCID, "")),
  250. err: errors.New("tenant cannot be empty"),
  251. },
  252. {
  253. store: makeSecretStore(vaultOCID, region, withSecretAuth(userOCID, tenant), withPrivateKey("", secretKey, nil)),
  254. err: errors.New("privateKey.name cannot be empty"),
  255. },
  256. {
  257. store: makeSecretStore(vaultOCID, region, withSecretAuth(userOCID, tenant), withPrivateKey(secretName, secretKey, &namespace)),
  258. err: errors.New("namespace should either be empty or match the namespace of the SecretStore for a namespaced SecretStore"),
  259. },
  260. {
  261. store: makeSecretStore(vaultOCID, region, withSecretAuth(userOCID, tenant), withPrivateKey(secretName, "", nil)),
  262. err: errors.New("privateKey.key cannot be empty"),
  263. },
  264. {
  265. store: makeSecretStore(vaultOCID, region, withSecretAuth(userOCID, tenant), withPrivateKey(secretName, secretKey, nil), withFingerprint("", secretKey, nil)),
  266. err: errors.New("fingerprint.name cannot be empty"),
  267. },
  268. {
  269. store: makeSecretStore(vaultOCID, region, withSecretAuth(userOCID, tenant), withPrivateKey(secretName, secretKey, nil), withFingerprint(secretName, secretKey, &namespace)),
  270. err: errors.New("namespace should either be empty or match the namespace of the SecretStore for a namespaced SecretStore"),
  271. },
  272. {
  273. store: makeSecretStore(vaultOCID, region, withSecretAuth(userOCID, tenant), withPrivateKey(secretName, secretKey, nil), withFingerprint(secretName, "", nil)),
  274. err: errors.New("fingerprint.key cannot be empty"),
  275. },
  276. {
  277. store: makeSecretStore(vaultOCID, region),
  278. err: nil,
  279. },
  280. }
  281. p := VaultManagementService{}
  282. for _, tc := range testCases {
  283. _, err := p.ValidateStore(tc.store)
  284. if tc.err != nil && err != nil && err.Error() != tc.err.Error() {
  285. t.Errorf("test failed! want %v, got %v", tc.err, err)
  286. } else if tc.err == nil && err != nil {
  287. t.Errorf("want nil got err %v", err)
  288. } else if tc.err != nil && err == nil {
  289. t.Errorf("want err %v got nil", tc.err)
  290. }
  291. }
  292. }
  293. func TestVaultManagementServiceNewClient(t *testing.T) {
  294. t.Parallel()
  295. namespace := "default"
  296. authSecretName := "oracle-auth"
  297. auth := &esv1.OracleAuth{
  298. User: "user",
  299. Tenancy: "tenancy",
  300. SecretRef: esv1.OracleSecretRef{
  301. PrivateKey: esmeta.SecretKeySelector{
  302. Name: authSecretName,
  303. Key: "privateKey",
  304. },
  305. Fingerprint: esmeta.SecretKeySelector{
  306. Name: authSecretName,
  307. Key: "fingerprint",
  308. },
  309. },
  310. }
  311. tests := []struct {
  312. desc string
  313. secretStore *esv1.SecretStore
  314. expectedErr string
  315. }{
  316. {
  317. desc: "no retry settings",
  318. secretStore: &esv1.SecretStore{
  319. Spec: esv1.SecretStoreSpec{
  320. Provider: &esv1.SecretStoreProvider{
  321. Oracle: &esv1.OracleProvider{
  322. Vault: vaultOCID,
  323. Region: region,
  324. Auth: auth,
  325. },
  326. },
  327. },
  328. },
  329. },
  330. {
  331. desc: "fill all the retry settings",
  332. secretStore: &esv1.SecretStore{
  333. Spec: esv1.SecretStoreSpec{
  334. Provider: &esv1.SecretStoreProvider{
  335. Oracle: &esv1.OracleProvider{
  336. Vault: vaultOCID,
  337. Region: region,
  338. Auth: auth,
  339. },
  340. },
  341. RetrySettings: &esv1.SecretStoreRetrySettings{
  342. RetryInterval: ptr.To("1s"),
  343. MaxRetries: ptr.To(int32(5)),
  344. },
  345. },
  346. },
  347. },
  348. {
  349. desc: "partially configure the retry settings - retry interval",
  350. secretStore: &esv1.SecretStore{
  351. Spec: esv1.SecretStoreSpec{
  352. Provider: &esv1.SecretStoreProvider{
  353. Oracle: &esv1.OracleProvider{
  354. Vault: vaultOCID,
  355. Region: region,
  356. Auth: auth,
  357. },
  358. },
  359. RetrySettings: &esv1.SecretStoreRetrySettings{
  360. RetryInterval: ptr.To("1s"),
  361. },
  362. },
  363. },
  364. },
  365. {
  366. desc: "partially configure the retry settings - max retries",
  367. secretStore: &esv1.SecretStore{
  368. Spec: esv1.SecretStoreSpec{
  369. Provider: &esv1.SecretStoreProvider{
  370. Oracle: &esv1.OracleProvider{
  371. Vault: vaultOCID,
  372. Region: region,
  373. Auth: auth,
  374. },
  375. },
  376. RetrySettings: &esv1.SecretStoreRetrySettings{
  377. MaxRetries: ptr.To(int32(5)),
  378. },
  379. },
  380. },
  381. },
  382. {
  383. desc: "auth secret does not exist",
  384. secretStore: &esv1.SecretStore{
  385. Spec: esv1.SecretStoreSpec{
  386. Provider: &esv1.SecretStoreProvider{
  387. Oracle: &esv1.OracleProvider{
  388. Vault: vaultOCID,
  389. Region: region,
  390. Auth: &esv1.OracleAuth{
  391. User: "user",
  392. Tenancy: "tenancy",
  393. SecretRef: esv1.OracleSecretRef{
  394. PrivateKey: esmeta.SecretKeySelector{
  395. Name: "non-existing-secret",
  396. Key: "privateKey",
  397. },
  398. Fingerprint: esmeta.SecretKeySelector{
  399. Name: "non-existing-secret",
  400. Key: "fingerprint",
  401. },
  402. },
  403. },
  404. },
  405. },
  406. RetrySettings: &esv1.SecretStoreRetrySettings{
  407. RetryInterval: ptr.To("invalid"),
  408. },
  409. },
  410. },
  411. expectedErr: `cannot get Kubernetes secret "non-existing-secret" from namespace "default": secrets "non-existing-secret" not found`,
  412. },
  413. {
  414. desc: "invalid retry interval",
  415. secretStore: &esv1.SecretStore{
  416. Spec: esv1.SecretStoreSpec{
  417. Provider: &esv1.SecretStoreProvider{
  418. Oracle: &esv1.OracleProvider{
  419. Vault: vaultOCID,
  420. Region: region,
  421. Auth: auth,
  422. },
  423. },
  424. RetrySettings: &esv1.SecretStoreRetrySettings{
  425. RetryInterval: ptr.To("invalid"),
  426. },
  427. },
  428. },
  429. expectedErr: "cannot setup new oracle client: time: invalid duration",
  430. },
  431. }
  432. for _, tc := range tests {
  433. t.Run(tc.desc, func(t *testing.T) {
  434. provider := &VaultManagementService{
  435. Client: &fakeoracle.OracleMockClient{},
  436. KmsVaultClient: nil,
  437. vault: vaultOCID,
  438. }
  439. pk, err := rsa.GenerateKey(rand.Reader, 2048)
  440. if err != nil {
  441. t.Fatalf("failed to create a private key: %v", err)
  442. }
  443. schema := runtime.NewScheme()
  444. if err := corev1.AddToScheme(schema); err != nil {
  445. t.Fatalf("failed to add to schema: %v", err)
  446. }
  447. builder := clientfake.NewClientBuilder().WithRuntimeObjects(&corev1.Secret{
  448. ObjectMeta: metav1.ObjectMeta{
  449. Name: authSecretName,
  450. Namespace: namespace,
  451. },
  452. Data: map[string][]byte{
  453. "privateKey": pem.EncodeToMemory(&pem.Block{
  454. Type: "RSA PRIVATE KEY",
  455. Bytes: x509.MarshalPKCS1PrivateKey(pk),
  456. }),
  457. "fingerprint": []byte("fingerprint"),
  458. },
  459. })
  460. _, err = provider.NewClient(context.Background(), tc.secretStore, builder.Build(), namespace)
  461. if err != nil {
  462. if tc.expectedErr == "" {
  463. t.Fatalf("failed to call NewClient: %v", err)
  464. }
  465. if !strings.Contains(err.Error(), tc.expectedErr) {
  466. t.Fatalf("received an unexpected error: %q should have contained %q", err.Error(), tc.expectedErr)
  467. }
  468. return
  469. }
  470. if tc.expectedErr != "" {
  471. t.Fatalf("expeceted to receive an error but got nil")
  472. }
  473. })
  474. }
  475. }
  476. func TestOracleVaultGetAllSecrets(t *testing.T) {
  477. var testCases = map[string]struct {
  478. vms *VaultManagementService
  479. ref esv1.ExternalSecretFind
  480. result map[string][]byte
  481. }{
  482. "filters secrets that don't match the pattern": {
  483. &VaultManagementService{
  484. Client: &fakeoracle.OracleMockClient{
  485. SecretBundles: map[string]secrets.SecretBundle{
  486. s1id: s1bundle,
  487. s2id: s2bundle,
  488. },
  489. },
  490. VaultClient: &fakeoracle.OracleMockVaultClient{
  491. SecretSummaries: []vault.SecretSummary{
  492. s1summary,
  493. s2summary,
  494. },
  495. },
  496. },
  497. esv1.ExternalSecretFind{
  498. Name: &esv1.FindName{
  499. RegExp: "^test.*",
  500. },
  501. },
  502. map[string][]byte{
  503. s1id: []byte(s1id),
  504. },
  505. },
  506. "filters secrets that are deleting": {
  507. &VaultManagementService{
  508. Client: &fakeoracle.OracleMockClient{
  509. SecretBundles: map[string]secrets.SecretBundle{
  510. s1id: s1bundle,
  511. s2id: s2bundle,
  512. s3id: s3bundle,
  513. },
  514. },
  515. VaultClient: &fakeoracle.OracleMockVaultClient{
  516. SecretSummaries: []vault.SecretSummary{
  517. s1summary,
  518. s2summary,
  519. s3summary,
  520. },
  521. },
  522. },
  523. esv1.ExternalSecretFind{
  524. Name: &esv1.FindName{
  525. RegExp: ".*",
  526. },
  527. },
  528. map[string][]byte{
  529. s1id: []byte(s1id),
  530. s2id: []byte(s2id),
  531. },
  532. },
  533. }
  534. for name, testCase := range testCases {
  535. t.Run(name, func(t *testing.T) {
  536. result, err := testCase.vms.GetAllSecrets(context.Background(), testCase.ref)
  537. assert.NoError(t, err)
  538. assert.EqualValues(t, testCase.result, result)
  539. })
  540. }
  541. }
  542. func TestOracleVaultPushSecret(t *testing.T) {
  543. testSecretKey := "test-secret-key"
  544. encryptionKey := "must-not-be-blank-for-push"
  545. var testCases = map[string]struct {
  546. vms *VaultManagementService
  547. data testingfake.PushSecretData
  548. validator func(service *VaultManagementService) bool
  549. content string
  550. }{
  551. "create a secret if not exists": {
  552. &VaultManagementService{
  553. encryptionKey: encryptionKey,
  554. Client: &fakeoracle.OracleMockClient{
  555. SecretBundles: map[string]secrets.SecretBundle{
  556. s2id: s2bundle,
  557. },
  558. },
  559. VaultClient: &fakeoracle.OracleMockVaultClient{},
  560. },
  561. testingfake.PushSecretData{
  562. SecretKey: testSecretKey,
  563. RemoteKey: s1id,
  564. },
  565. func(vms *VaultManagementService) bool {
  566. return vms.VaultClient.(*fakeoracle.OracleMockVaultClient).CreatedCount == 1
  567. },
  568. "created",
  569. },
  570. "create a json secret if not exists": {
  571. &VaultManagementService{
  572. encryptionKey: encryptionKey,
  573. Client: &fakeoracle.OracleMockClient{
  574. SecretBundles: map[string]secrets.SecretBundle{
  575. s2id: s2bundle,
  576. },
  577. },
  578. VaultClient: &fakeoracle.OracleMockVaultClient{},
  579. },
  580. testingfake.PushSecretData{
  581. SecretKey: testSecretKey,
  582. RemoteKey: s1id,
  583. },
  584. func(vms *VaultManagementService) bool {
  585. return vms.VaultClient.(*fakeoracle.OracleMockVaultClient).CreatedCount == 1
  586. },
  587. "{'key-a':'secret-a', 'key-b': 'secret-b'}",
  588. },
  589. "update a secret if exists": {
  590. &VaultManagementService{
  591. encryptionKey: encryptionKey,
  592. Client: &fakeoracle.OracleMockClient{
  593. SecretBundles: map[string]secrets.SecretBundle{
  594. s1id: s1bundle,
  595. s2id: s2bundle,
  596. },
  597. },
  598. VaultClient: &fakeoracle.OracleMockVaultClient{},
  599. },
  600. testingfake.PushSecretData{
  601. SecretKey: testSecretKey,
  602. RemoteKey: s1id,
  603. },
  604. func(vms *VaultManagementService) bool {
  605. return vms.VaultClient.(*fakeoracle.OracleMockVaultClient).UpdatedCount == 1
  606. },
  607. "updated",
  608. },
  609. "neither create nor update if secret content is unchanged": {
  610. &VaultManagementService{
  611. encryptionKey: encryptionKey,
  612. Client: &fakeoracle.OracleMockClient{
  613. SecretBundles: map[string]secrets.SecretBundle{
  614. s1id: s1bundle,
  615. s2id: s2bundle,
  616. },
  617. },
  618. VaultClient: &fakeoracle.OracleMockVaultClient{},
  619. },
  620. testingfake.PushSecretData{
  621. SecretKey: testSecretKey,
  622. RemoteKey: s1id,
  623. },
  624. func(vms *VaultManagementService) bool {
  625. return vms.VaultClient.(*fakeoracle.OracleMockVaultClient).UpdatedCount == 0 &&
  626. vms.VaultClient.(*fakeoracle.OracleMockVaultClient).CreatedCount == 0
  627. },
  628. s1id,
  629. },
  630. }
  631. for name, testCase := range testCases {
  632. t.Run(name, func(t *testing.T) {
  633. s := &corev1.Secret{Data: map[string][]byte{testSecretKey: []byte(testCase.content)}}
  634. err := testCase.vms.PushSecret(context.Background(), s, testCase.data)
  635. assert.NoError(t, err)
  636. assert.True(t, testCase.validator(testCase.vms))
  637. })
  638. }
  639. }
  640. func TestOracleVaultDeleteSecret(t *testing.T) {
  641. var testCases = map[string]struct {
  642. vms *VaultManagementService
  643. remoteRef esv1.PushSecretRemoteRef
  644. validator func(service *VaultManagementService) bool
  645. }{
  646. "do not delete if secret not found": {
  647. &VaultManagementService{
  648. Client: &fakeoracle.OracleMockClient{
  649. SecretBundles: map[string]secrets.SecretBundle{
  650. s1id: s1bundle,
  651. },
  652. },
  653. VaultClient: &fakeoracle.OracleMockVaultClient{},
  654. },
  655. esv1alpha1.PushSecretRemoteRef{
  656. RemoteKey: s2id,
  657. },
  658. func(vms *VaultManagementService) bool {
  659. return vms.VaultClient.(*fakeoracle.OracleMockVaultClient).DeletedCount == 0
  660. },
  661. },
  662. "do not delete if secret os already deleting": {
  663. &VaultManagementService{
  664. Client: &fakeoracle.OracleMockClient{
  665. SecretBundles: map[string]secrets.SecretBundle{
  666. s1id: s1bundle,
  667. s3id: s3bundle,
  668. },
  669. },
  670. VaultClient: &fakeoracle.OracleMockVaultClient{},
  671. },
  672. esv1alpha1.PushSecretRemoteRef{
  673. RemoteKey: s3id,
  674. },
  675. func(vms *VaultManagementService) bool {
  676. return vms.VaultClient.(*fakeoracle.OracleMockVaultClient).DeletedCount == 0
  677. },
  678. },
  679. "delete existing secret": {
  680. &VaultManagementService{
  681. Client: &fakeoracle.OracleMockClient{
  682. SecretBundles: map[string]secrets.SecretBundle{
  683. s1id: s1bundle,
  684. s3id: s3bundle,
  685. },
  686. },
  687. VaultClient: &fakeoracle.OracleMockVaultClient{},
  688. },
  689. esv1alpha1.PushSecretRemoteRef{
  690. RemoteKey: s1id,
  691. },
  692. func(vms *VaultManagementService) bool {
  693. return vms.VaultClient.(*fakeoracle.OracleMockVaultClient).DeletedCount == 1
  694. },
  695. },
  696. }
  697. for name, testCase := range testCases {
  698. t.Run(name, func(t *testing.T) {
  699. err := testCase.vms.DeleteSecret(context.Background(), testCase.remoteRef)
  700. assert.NoError(t, err)
  701. assert.True(t, testCase.validator(testCase.vms))
  702. })
  703. }
  704. }
  705. var (
  706. s1id = "test1"
  707. s2id = "mysecret"
  708. s3id = "deleting"
  709. s1bundle = makeSecretBundle(s1id, false)
  710. s2bundle = makeSecretBundle(s2id, false)
  711. s3bundle = makeSecretBundle(s3id, true)
  712. s1summary = makeSecretSummary(s1id, false)
  713. s2summary = makeSecretSummary(s2id, false)
  714. s3summary = makeSecretSummary(s3id, true)
  715. )
  716. func makeSecretBundle(id string, deleting bool) secrets.SecretBundle {
  717. var deletionTime *common.SDKTime
  718. if deleting {
  719. deletionTime = &common.SDKTime{
  720. Time: time.Now(),
  721. }
  722. }
  723. return secrets.SecretBundle{
  724. SecretId: &id,
  725. SecretBundleContent: secrets.Base64SecretBundleContentDetails{
  726. Content: ptr.To(base64.StdEncoding.EncodeToString([]byte(id))),
  727. },
  728. TimeOfDeletion: deletionTime,
  729. }
  730. }
  731. func makeSecretSummary(id string, deleting bool) vault.SecretSummary {
  732. var deletionTime *common.SDKTime
  733. if deleting {
  734. deletionTime = &common.SDKTime{
  735. Time: time.Now(),
  736. }
  737. }
  738. return vault.SecretSummary{
  739. Id: &id,
  740. SecretName: &id,
  741. TimeOfDeletion: deletionTime,
  742. }
  743. }