oracle_test.go 23 KB

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