client_test.go 46 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497
  1. /*
  2. Copyright © 2025 ESO Maintainer Team
  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 secretmanager
  14. import (
  15. "context"
  16. "errors"
  17. "fmt"
  18. "reflect"
  19. "strings"
  20. "testing"
  21. "cloud.google.com/go/secretmanager/apiv1/secretmanagerpb"
  22. "github.com/googleapis/gax-go/v2"
  23. "github.com/googleapis/gax-go/v2/apierror"
  24. "github.com/stretchr/testify/assert"
  25. "github.com/stretchr/testify/require"
  26. "google.golang.org/grpc/codes"
  27. "google.golang.org/grpc/status"
  28. corev1 "k8s.io/api/core/v1"
  29. apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
  30. pointer "k8s.io/utils/ptr"
  31. esv1 "github.com/external-secrets/external-secrets/apis/externalsecrets/v1"
  32. "github.com/external-secrets/external-secrets/apis/externalsecrets/v1alpha1"
  33. v1 "github.com/external-secrets/external-secrets/apis/meta/v1"
  34. fakesm "github.com/external-secrets/external-secrets/providers/v1/gcp/secretmanager/fake"
  35. testingfake "github.com/external-secrets/external-secrets/runtime/testing/fake"
  36. )
  37. const (
  38. errCallNotFoundAtIndex0 = "index 0 for call not found in the list of calls"
  39. usEast1 = "us-east1"
  40. errInvalidReplicationType = "req.Secret.Replication.Replication was not of type *secretmanagerpb.Replication_UserManaged_ but: %T"
  41. testSecretName = "projects/foo/secret/bar"
  42. managedBy = "managed-by"
  43. externalSecrets = "external-secrets"
  44. )
  45. type secretManagerTestCase struct {
  46. mockClient *fakesm.MockSMClient
  47. apiInput *secretmanagerpb.AccessSecretVersionRequest
  48. apiOutput *secretmanagerpb.AccessSecretVersionResponse
  49. ref *esv1.ExternalSecretDataRemoteRef
  50. projectID string
  51. apiErr error
  52. expectError string
  53. expectedSecret string
  54. // for testing SecretMap
  55. expectedData map[string][]byte
  56. latestEnabledSecretPolicy esv1.SecretVersionSelectionPolicy
  57. }
  58. func makeValidSecretManagerTestCase() *secretManagerTestCase {
  59. smtc := secretManagerTestCase{
  60. mockClient: &fakesm.MockSMClient{},
  61. apiInput: makeValidAPIInput(),
  62. ref: makeValidRef(),
  63. apiOutput: makeValidAPIOutput(),
  64. projectID: "default",
  65. apiErr: nil,
  66. expectError: "",
  67. expectedSecret: "",
  68. expectedData: map[string][]byte{},
  69. latestEnabledSecretPolicy: esv1.SecretVersionSelectionPolicyLatestOrFail,
  70. }
  71. smtc.mockClient.NilClose()
  72. smtc.mockClient.WithValue(context.Background(), smtc.apiInput, smtc.apiOutput, smtc.apiErr)
  73. return &smtc
  74. }
  75. func makeValidRef() *esv1.ExternalSecretDataRemoteRef {
  76. return &esv1.ExternalSecretDataRemoteRef{
  77. Key: "/baz",
  78. Version: "default",
  79. }
  80. }
  81. func makeValidAPIInput() *secretmanagerpb.AccessSecretVersionRequest {
  82. return &secretmanagerpb.AccessSecretVersionRequest{
  83. Name: "projects/default/secrets//baz/versions/default",
  84. }
  85. }
  86. func makeValidAPIOutput() *secretmanagerpb.AccessSecretVersionResponse {
  87. return &secretmanagerpb.AccessSecretVersionResponse{
  88. Payload: &secretmanagerpb.SecretPayload{
  89. Data: []byte{},
  90. },
  91. }
  92. }
  93. func makeValidSecretManagerTestCaseCustom(tweaks ...func(smtc *secretManagerTestCase)) *secretManagerTestCase {
  94. smtc := makeValidSecretManagerTestCase()
  95. for _, fn := range tweaks {
  96. fn(smtc)
  97. }
  98. smtc.mockClient.WithValue(context.Background(), smtc.apiInput, smtc.apiOutput, smtc.apiErr)
  99. return smtc
  100. }
  101. // This case can be shared by both GetSecret and GetSecretMap tests.
  102. // bad case: set apiErr.
  103. var setAPIErr = func(smtc *secretManagerTestCase) {
  104. smtc.apiErr = errors.New("oh no")
  105. smtc.expectError = "oh no"
  106. }
  107. var setNilMockClient = func(smtc *secretManagerTestCase) {
  108. smtc.mockClient = nil
  109. smtc.expectError = "provider GCP is not initialized"
  110. }
  111. // test the sm<->gcp interface
  112. // make sure correct values are passed and errors are handled accordingly.
  113. func TestSecretManagerGetSecret(t *testing.T) {
  114. // good case: default version is set
  115. // key is passed in, output is sent back
  116. setSecretString := func(smtc *secretManagerTestCase) {
  117. smtc.apiOutput.Payload.Data = []byte("testtesttest")
  118. smtc.expectedSecret = "testtesttest"
  119. }
  120. latestSecretDestroyed := func(smtc *secretManagerTestCase) {
  121. // Test the LatestOrFail policy (default behavior)
  122. // Ideally we would test the LatestOrFetch policy, but we don't have a mock for the ListSecretVersions call
  123. // so we can't test that until it's implemented.
  124. smtc.apiErr = status.Error(codes.FailedPrecondition, "DESTROYED state")
  125. smtc.latestEnabledSecretPolicy = esv1.SecretVersionSelectionPolicyLatestOrFail
  126. smtc.expectedSecret = ""
  127. smtc.expectError = smtc.apiErr.Error()
  128. }
  129. secretNotFound := func(smtc *secretManagerTestCase) {
  130. fErr := status.Error(codes.NotFound, "failed")
  131. notFoundError, _ := apierror.FromError(fErr)
  132. smtc.apiErr = notFoundError
  133. smtc.expectedSecret = ""
  134. smtc.expectError = esv1.NoSecretErr.Error()
  135. }
  136. // good case: with a dot in the key name
  137. setDotRef := func(smtc *secretManagerTestCase) {
  138. smtc.ref = &esv1.ExternalSecretDataRemoteRef{
  139. Key: "/baz",
  140. Version: "default",
  141. Property: "name.json",
  142. }
  143. smtc.apiInput.Name = "projects/default/secrets//baz/versions/default"
  144. smtc.apiOutput.Payload.Data = []byte(
  145. `{
  146. "name.json": "Tom",
  147. "friends": [
  148. {"first": "Dale", "last": "Murphy"},
  149. {"first": "Roger", "last": "Craig"},
  150. {"first": "Jane", "last": "Murphy"}
  151. ]
  152. }`)
  153. smtc.expectedSecret = "Tom"
  154. }
  155. // good case: data with
  156. setCustomRef := func(smtc *secretManagerTestCase) {
  157. smtc.ref = &esv1.ExternalSecretDataRemoteRef{
  158. Key: "/baz",
  159. Version: "default",
  160. Property: "name.first",
  161. }
  162. smtc.apiInput.Name = "projects/default/secrets//baz/versions/default"
  163. smtc.apiOutput.Payload.Data = []byte(
  164. `{
  165. "name": {"first": "Tom", "last": "Anderson"},
  166. "friends": [
  167. {"first": "Dale", "last": "Murphy"},
  168. {"first": "Roger", "last": "Craig"},
  169. {"first": "Jane", "last": "Murphy"}
  170. ]
  171. }`)
  172. smtc.expectedSecret = "Tom"
  173. }
  174. // good case: custom version set
  175. setCustomVersion := func(smtc *secretManagerTestCase) {
  176. smtc.ref.Version = "1234"
  177. smtc.apiInput.Name = "projects/default/secrets//baz/versions/1234"
  178. smtc.apiOutput.Payload.Data = []byte("FOOBA!")
  179. smtc.expectedSecret = "FOOBA!"
  180. }
  181. successCases := []*secretManagerTestCase{
  182. makeValidSecretManagerTestCase(),
  183. makeValidSecretManagerTestCaseCustom(setSecretString),
  184. makeValidSecretManagerTestCaseCustom(latestSecretDestroyed),
  185. makeValidSecretManagerTestCaseCustom(secretNotFound),
  186. makeValidSecretManagerTestCaseCustom(setCustomVersion),
  187. makeValidSecretManagerTestCaseCustom(setAPIErr),
  188. makeValidSecretManagerTestCaseCustom(setCustomRef),
  189. makeValidSecretManagerTestCaseCustom(setDotRef),
  190. makeValidSecretManagerTestCaseCustom(setNilMockClient),
  191. }
  192. sm := Client{}
  193. for k, v := range successCases {
  194. sm.store = &esv1.GCPSMProvider{ProjectID: v.projectID, SecretVersionSelectionPolicy: v.latestEnabledSecretPolicy}
  195. sm.smClient = v.mockClient
  196. out, err := sm.GetSecret(context.Background(), *v.ref)
  197. if !ErrorContains(err, v.expectError) {
  198. t.Errorf("[%d] unexpected error: %s, expected: '%s'", k, err.Error(), v.expectError)
  199. }
  200. if err == nil && string(out) != v.expectedSecret {
  201. t.Errorf("[%d] unexpected secret: expected %s, got %s", k, v.expectedSecret, string(out))
  202. }
  203. }
  204. }
  205. func TestGetSecretMetadataPolicyFetch(t *testing.T) {
  206. tests := []struct {
  207. name string
  208. ref esv1.ExternalSecretDataRemoteRef
  209. getSecretMockReturn fakesm.SecretMockReturn
  210. expectedSecret string
  211. expectedErr string
  212. }{
  213. {
  214. name: "annotation is specified",
  215. ref: esv1.ExternalSecretDataRemoteRef{
  216. Key: "bar",
  217. MetadataPolicy: esv1.ExternalSecretMetadataPolicyFetch,
  218. Property: "annotations.managed-by",
  219. },
  220. getSecretMockReturn: fakesm.SecretMockReturn{
  221. Secret: &secretmanagerpb.Secret{
  222. Name: testSecretName,
  223. Annotations: map[string]string{
  224. managedBy: externalSecrets,
  225. },
  226. },
  227. Err: nil,
  228. },
  229. expectedSecret: externalSecrets,
  230. },
  231. {
  232. name: "label is specified",
  233. ref: esv1.ExternalSecretDataRemoteRef{
  234. Key: "bar",
  235. MetadataPolicy: esv1.ExternalSecretMetadataPolicyFetch,
  236. Property: "labels.managed-by",
  237. },
  238. getSecretMockReturn: fakesm.SecretMockReturn{
  239. Secret: &secretmanagerpb.Secret{
  240. Name: testSecretName,
  241. Labels: map[string]string{
  242. managedBy: externalSecrets,
  243. },
  244. },
  245. Err: nil,
  246. },
  247. expectedSecret: externalSecrets,
  248. },
  249. {
  250. name: "annotations is specified",
  251. ref: esv1.ExternalSecretDataRemoteRef{
  252. Key: "bar",
  253. MetadataPolicy: esv1.ExternalSecretMetadataPolicyFetch,
  254. Property: "annotations",
  255. },
  256. getSecretMockReturn: fakesm.SecretMockReturn{
  257. Secret: &secretmanagerpb.Secret{
  258. Name: testSecretName,
  259. Annotations: map[string]string{
  260. "annotationKey1": "annotationValue1",
  261. "annotationKey2": "annotationValue2",
  262. },
  263. Labels: map[string]string{
  264. "labelKey1": "labelValue1",
  265. "labelKey2": "labelValue2",
  266. },
  267. },
  268. Err: nil,
  269. },
  270. expectedSecret: `{"annotationKey1":"annotationValue1","annotationKey2":"annotationValue2"}`,
  271. },
  272. {
  273. name: "labels is specified",
  274. ref: esv1.ExternalSecretDataRemoteRef{
  275. Key: "bar",
  276. MetadataPolicy: esv1.ExternalSecretMetadataPolicyFetch,
  277. Property: "labels",
  278. },
  279. getSecretMockReturn: fakesm.SecretMockReturn{
  280. Secret: &secretmanagerpb.Secret{
  281. Name: testSecretName,
  282. Annotations: map[string]string{
  283. "annotationKey1": "annotationValue1",
  284. "annotationKey2": "annotationValue2",
  285. },
  286. Labels: map[string]string{
  287. "labelKey1": "labelValue1",
  288. "labelKey2": "labelValue2",
  289. },
  290. },
  291. Err: nil,
  292. },
  293. expectedSecret: `{"labelKey1":"labelValue1","labelKey2":"labelValue2"}`,
  294. },
  295. {
  296. name: "no property is specified",
  297. ref: esv1.ExternalSecretDataRemoteRef{
  298. Key: "bar",
  299. MetadataPolicy: esv1.ExternalSecretMetadataPolicyFetch,
  300. },
  301. getSecretMockReturn: fakesm.SecretMockReturn{
  302. Secret: &secretmanagerpb.Secret{
  303. Name: testSecretName,
  304. Labels: map[string]string{
  305. "label-key": "label-value",
  306. },
  307. Annotations: map[string]string{
  308. "annotation-key": "annotation-value",
  309. },
  310. },
  311. Err: nil,
  312. },
  313. expectedSecret: `{"annotations":{"annotation-key":"annotation-value"},"labels":{"label-key":"label-value"}}`,
  314. },
  315. {
  316. name: "annotation does not exist",
  317. ref: esv1.ExternalSecretDataRemoteRef{
  318. Key: "bar",
  319. MetadataPolicy: esv1.ExternalSecretMetadataPolicyFetch,
  320. Property: "annotations.unknown",
  321. },
  322. getSecretMockReturn: fakesm.SecretMockReturn{
  323. Secret: &secretmanagerpb.Secret{
  324. Name: testSecretName,
  325. Annotations: map[string]string{
  326. managedBy: externalSecrets,
  327. },
  328. },
  329. Err: nil,
  330. },
  331. expectedErr: "annotation with key unknown does not exist in secret bar",
  332. },
  333. {
  334. name: "label does not exist",
  335. ref: esv1.ExternalSecretDataRemoteRef{
  336. Key: "bar",
  337. MetadataPolicy: esv1.ExternalSecretMetadataPolicyFetch,
  338. Property: "labels.unknown",
  339. },
  340. getSecretMockReturn: fakesm.SecretMockReturn{
  341. Secret: &secretmanagerpb.Secret{
  342. Name: testSecretName,
  343. Labels: map[string]string{
  344. managedBy: externalSecrets,
  345. },
  346. },
  347. Err: nil,
  348. },
  349. expectedErr: "label with key unknown does not exist in secret bar",
  350. },
  351. {
  352. name: "invalid property",
  353. ref: esv1.ExternalSecretDataRemoteRef{
  354. Key: "bar",
  355. MetadataPolicy: esv1.ExternalSecretMetadataPolicyFetch,
  356. Property: "invalid.managed-by",
  357. },
  358. getSecretMockReturn: fakesm.SecretMockReturn{
  359. Secret: &secretmanagerpb.Secret{
  360. Name: testSecretName,
  361. Labels: map[string]string{
  362. managedBy: externalSecrets,
  363. },
  364. },
  365. Err: nil,
  366. },
  367. expectedErr: "invalid property invalid.managed-by",
  368. },
  369. }
  370. for _, tc := range tests {
  371. t.Run(tc.name, func(t *testing.T) {
  372. smClient := fakesm.MockSMClient{}
  373. smClient.NewGetSecretFn(tc.getSecretMockReturn)
  374. client := Client{
  375. smClient: &smClient,
  376. store: &esv1.GCPSMProvider{
  377. ProjectID: "foo",
  378. },
  379. }
  380. got, err := client.GetSecret(context.TODO(), tc.ref)
  381. if tc.expectedErr != "" {
  382. if err == nil {
  383. t.Fatalf("expected to receive an error but got nit")
  384. }
  385. if !ErrorContains(err, tc.expectedErr) {
  386. t.Fatalf("unexpected error: %s, expected: '%s'", err.Error(), tc.expectedErr)
  387. }
  388. return
  389. }
  390. if err != nil {
  391. t.Fatalf("unexpected error: %s", err)
  392. }
  393. if gotStr := string(got); gotStr != tc.expectedSecret {
  394. t.Fatalf("unexpected secret: expected %s, got %s", tc.expectedSecret, gotStr)
  395. }
  396. })
  397. }
  398. }
  399. func TestDeleteSecret(t *testing.T) {
  400. fErr := status.Error(codes.NotFound, "failed")
  401. notFoundError, _ := apierror.FromError(fErr)
  402. pErr := status.Error(codes.PermissionDenied, "failed")
  403. permissionDeniedError, _ := apierror.FromError(pErr)
  404. fakeClient := fakesm.MockSMClient{}
  405. type args struct {
  406. client fakesm.MockSMClient
  407. getSecretOutput fakesm.SecretMockReturn
  408. deleteSecretErr error
  409. }
  410. type want struct {
  411. err error
  412. }
  413. type testCase struct {
  414. args args
  415. want want
  416. reason string
  417. }
  418. tests := map[string]testCase{
  419. "Deletes Successfully": {
  420. args: args{
  421. client: fakeClient,
  422. getSecretOutput: fakesm.SecretMockReturn{
  423. Secret: &secretmanagerpb.Secret{
  424. Name: testSecretName,
  425. Labels: map[string]string{
  426. managedBy: externalSecrets,
  427. },
  428. },
  429. Err: nil,
  430. },
  431. },
  432. },
  433. "Not Managed by ESO": {
  434. args: args{
  435. client: fakeClient,
  436. getSecretOutput: fakesm.SecretMockReturn{
  437. Secret: &secretmanagerpb.Secret{
  438. Name: testSecretName,
  439. Labels: map[string]string{},
  440. },
  441. Err: nil,
  442. },
  443. },
  444. },
  445. "Secret Not Found": {
  446. args: args{
  447. client: fakeClient,
  448. getSecretOutput: fakesm.SecretMockReturn{
  449. Secret: nil,
  450. Err: notFoundError,
  451. },
  452. },
  453. },
  454. "Random Error": {
  455. args: args{
  456. client: fakeClient,
  457. getSecretOutput: fakesm.SecretMockReturn{
  458. Secret: nil,
  459. Err: errors.New("This errored out"),
  460. },
  461. },
  462. want: want{
  463. err: errors.New("This errored out"),
  464. },
  465. },
  466. "Random GError": {
  467. args: args{
  468. client: fakeClient,
  469. getSecretOutput: fakesm.SecretMockReturn{
  470. Secret: nil,
  471. Err: permissionDeniedError,
  472. },
  473. },
  474. want: want{
  475. err: errors.New("failed"),
  476. },
  477. },
  478. }
  479. for name, tc := range tests {
  480. t.Run(name, func(t *testing.T) {
  481. ref := testingfake.PushSecretData{RemoteKey: "fake-key"}
  482. client := Client{
  483. smClient: &tc.args.client,
  484. store: &esv1.GCPSMProvider{
  485. ProjectID: "foo",
  486. },
  487. }
  488. tc.args.client.NewGetSecretFn(tc.args.getSecretOutput)
  489. tc.args.client.NewDeleteSecretFn(tc.args.deleteSecretErr)
  490. err := client.DeleteSecret(context.TODO(), ref)
  491. // Error nil XOR tc.want.err nil
  492. if ((err == nil) || (tc.want.err == nil)) && !((err == nil) && (tc.want.err == nil)) {
  493. t.Errorf("\nTesting SetSecret:\nName: %v\nReason: %v\nWant error: %v\nGot error: %v", name, tc.reason, tc.want.err, err)
  494. }
  495. // if errors are the same type but their contents do not match
  496. if err != nil && tc.want.err != nil {
  497. if !strings.Contains(err.Error(), tc.want.err.Error()) {
  498. t.Errorf("\nTesting SetSecret:\nName: %v\nReason: %v\nWant error: %v\nGot error got nil", name, tc.reason, tc.want.err)
  499. }
  500. }
  501. })
  502. }
  503. }
  504. func TestPushSecret(t *testing.T) {
  505. secretKey := "secret-key"
  506. remoteKey := "/baz"
  507. notFoundError := status.Error(codes.NotFound, "failed")
  508. notFoundError, _ = apierror.FromError(notFoundError)
  509. canceledError := status.Error(codes.Canceled, "canceled")
  510. canceledError, _ = apierror.FromError(canceledError)
  511. APIerror := errors.New("API Error")
  512. labelError := fmt.Errorf("secret %v is not managed by external secrets", remoteKey)
  513. secret := secretmanagerpb.Secret{
  514. Name: "projects/default/secrets/baz",
  515. Replication: &secretmanagerpb.Replication{
  516. Replication: &secretmanagerpb.Replication_Automatic_{
  517. Automatic: &secretmanagerpb.Replication_Automatic{},
  518. },
  519. },
  520. Labels: map[string]string{
  521. managedBy: externalSecrets,
  522. },
  523. }
  524. secretWithTopics := secretmanagerpb.Secret{
  525. Name: "projects/default/secrets/baz",
  526. Replication: &secretmanagerpb.Replication{
  527. Replication: &secretmanagerpb.Replication_Automatic_{
  528. Automatic: &secretmanagerpb.Replication_Automatic{},
  529. },
  530. },
  531. Labels: map[string]string{
  532. managedBy: externalSecrets,
  533. },
  534. Topics: []*secretmanagerpb.Topic{
  535. {
  536. Name: "topic1",
  537. },
  538. {
  539. Name: "topic2",
  540. },
  541. },
  542. }
  543. wrongLabelSecret := secretmanagerpb.Secret{
  544. Name: "projects/default/secrets/foo-bar",
  545. Replication: &secretmanagerpb.Replication{
  546. Replication: &secretmanagerpb.Replication_Automatic_{
  547. Automatic: &secretmanagerpb.Replication_Automatic{},
  548. },
  549. },
  550. Labels: map[string]string{
  551. managedBy: "not-external-secrets",
  552. },
  553. }
  554. smtc := secretManagerTestCase{
  555. mockClient: &fakesm.MockSMClient{},
  556. apiInput: makeValidAPIInput(),
  557. ref: makeValidRef(),
  558. apiOutput: makeValidAPIOutput(),
  559. projectID: "default",
  560. apiErr: nil,
  561. expectError: "",
  562. expectedSecret: "",
  563. expectedData: map[string][]byte{},
  564. }
  565. var payload = secretmanagerpb.SecretPayload{
  566. Data: []byte("payload"),
  567. }
  568. var payload2 = secretmanagerpb.SecretPayload{
  569. Data: []byte("fake-value"),
  570. }
  571. var res = secretmanagerpb.AccessSecretVersionResponse{
  572. Name: "projects/default/secrets/foo-bar",
  573. Payload: &payload,
  574. }
  575. var res2 = secretmanagerpb.AccessSecretVersionResponse{
  576. Name: "projects/default/secrets/baz",
  577. Payload: &payload2,
  578. }
  579. var secretVersion = secretmanagerpb.SecretVersion{}
  580. type args struct {
  581. store *esv1.GCPSMProvider
  582. mock *fakesm.MockSMClient
  583. Metadata *apiextensionsv1.JSON
  584. GetSecretMockReturn fakesm.SecretMockReturn
  585. UpdateSecretReturn fakesm.SecretMockReturn
  586. AccessSecretVersionMockReturn fakesm.AccessSecretVersionMockReturn
  587. AddSecretVersionMockReturn fakesm.AddSecretVersionMockReturn
  588. CreateSecretMockReturn fakesm.SecretMockReturn
  589. }
  590. type want struct {
  591. err error
  592. req func(*fakesm.MockSMClient) error
  593. }
  594. tests := []struct {
  595. desc string
  596. args args
  597. want want
  598. secret *corev1.Secret
  599. }{
  600. {
  601. desc: "SetSecret successfully pushes a secret",
  602. args: args{
  603. store: &esv1.GCPSMProvider{ProjectID: smtc.projectID},
  604. mock: smtc.mockClient,
  605. GetSecretMockReturn: fakesm.SecretMockReturn{Secret: &secret, Err: nil},
  606. AccessSecretVersionMockReturn: fakesm.AccessSecretVersionMockReturn{Res: &res, Err: nil},
  607. AddSecretVersionMockReturn: fakesm.AddSecretVersionMockReturn{SecretVersion: &secretVersion, Err: nil}},
  608. want: want{
  609. err: nil,
  610. },
  611. },
  612. {
  613. desc: "successfully pushes a secret with metadata",
  614. args: args{
  615. store: &esv1.GCPSMProvider{ProjectID: smtc.projectID},
  616. mock: smtc.mockClient,
  617. Metadata: &apiextensionsv1.JSON{
  618. Raw: []byte(`{
  619. "apiVersion": "kubernetes.external-secrets.io/v1alpha1",
  620. "kind": "PushSecretMetadata",
  621. "spec": {
  622. "annotations": {"annotation-key1":"annotation-value1"},
  623. "labels": {"label-key1":"label-value1"}
  624. }
  625. }`),
  626. },
  627. GetSecretMockReturn: fakesm.SecretMockReturn{Secret: &secret, Err: nil},
  628. UpdateSecretReturn: fakesm.SecretMockReturn{Secret: &secretmanagerpb.Secret{
  629. Name: "projects/default/secrets/baz",
  630. Replication: &secretmanagerpb.Replication{
  631. Replication: &secretmanagerpb.Replication_Automatic_{
  632. Automatic: &secretmanagerpb.Replication_Automatic{},
  633. },
  634. },
  635. Labels: map[string]string{
  636. managedBy: externalSecrets,
  637. "label-key1": "label-value1",
  638. },
  639. Annotations: map[string]string{
  640. "annotation-key1": "annotation-value1",
  641. },
  642. }, Err: nil},
  643. AccessSecretVersionMockReturn: fakesm.AccessSecretVersionMockReturn{Res: &res, Err: nil},
  644. AddSecretVersionMockReturn: fakesm.AddSecretVersionMockReturn{SecretVersion: &secretVersion, Err: nil}},
  645. want: want{
  646. err: nil,
  647. },
  648. },
  649. {
  650. desc: "successfully pushes a secret with defined region",
  651. args: args{
  652. store: &esv1.GCPSMProvider{ProjectID: smtc.projectID},
  653. mock: smtc.mockClient,
  654. Metadata: &apiextensionsv1.JSON{
  655. Raw: []byte(`{
  656. "apiVersion": "kubernetes.external-secrets.io/v1alpha1",
  657. "kind": "PushSecretMetadata",
  658. "spec": {
  659. "replicationLocation": "us-east1"
  660. }
  661. }`),
  662. },
  663. GetSecretMockReturn: fakesm.SecretMockReturn{Secret: nil, Err: notFoundError},
  664. CreateSecretMockReturn: fakesm.SecretMockReturn{Secret: &secretmanagerpb.Secret{
  665. Name: "projects/default/secrets/baz",
  666. Replication: &secretmanagerpb.Replication{
  667. Replication: &secretmanagerpb.Replication_UserManaged_{
  668. UserManaged: &secretmanagerpb.Replication_UserManaged{
  669. Replicas: []*secretmanagerpb.Replication_UserManaged_Replica{
  670. {
  671. Location: usEast1,
  672. },
  673. },
  674. },
  675. },
  676. },
  677. Labels: map[string]string{
  678. managedBy: externalSecrets,
  679. "label-key1": "label-value1",
  680. },
  681. Annotations: map[string]string{
  682. "annotation-key1": "annotation-value1",
  683. },
  684. }, Err: nil},
  685. AccessSecretVersionMockReturn: fakesm.AccessSecretVersionMockReturn{Res: &res, Err: nil},
  686. AddSecretVersionMockReturn: fakesm.AddSecretVersionMockReturn{SecretVersion: &secretVersion, Err: nil}},
  687. want: want{
  688. err: nil,
  689. req: func(m *fakesm.MockSMClient) error {
  690. req, ok := m.CreateSecretCalledWithN[0]
  691. if !ok {
  692. return errors.New(errCallNotFoundAtIndex0)
  693. }
  694. if req.Secret.Replication == nil {
  695. return errors.New("expected replication - found nil")
  696. }
  697. user, ok := req.Secret.Replication.Replication.(*secretmanagerpb.Replication_UserManaged_)
  698. if !ok {
  699. return fmt.Errorf(errInvalidReplicationType, req.Secret.Replication.Replication)
  700. }
  701. if len(user.UserManaged.Replicas) < 1 {
  702. return errors.New("req.Secret.Replication.Replication.Replicas was not empty")
  703. }
  704. if user.UserManaged.Replicas[0].Location != usEast1 {
  705. return fmt.Errorf("req.Secret.Replication.Replicas[0].Location was not equal to us-east-1 but was %s", user.UserManaged.Replicas[0].Location)
  706. }
  707. return nil
  708. },
  709. },
  710. },
  711. {
  712. desc: "dont set replication when pushing regional secrets",
  713. args: args{
  714. store: &esv1.GCPSMProvider{ProjectID: smtc.projectID, Location: "us-east1"},
  715. mock: smtc.mockClient,
  716. Metadata: &apiextensionsv1.JSON{
  717. Raw: []byte(`{
  718. "apiVersion": "kubernetes.external-secrets.io/v1alpha1",
  719. "kind": "PushSecretMetadata",
  720. "spec": {
  721. "replicationLocation": "us-east1"
  722. }
  723. }`),
  724. },
  725. GetSecretMockReturn: fakesm.SecretMockReturn{Secret: nil, Err: notFoundError},
  726. CreateSecretMockReturn: fakesm.SecretMockReturn{Secret: &secretmanagerpb.Secret{
  727. Name: "projects/default/secrets/bangg",
  728. Replication: nil,
  729. Labels: map[string]string{
  730. managedBy: externalSecrets,
  731. "label-key1": "label-value1",
  732. },
  733. Annotations: map[string]string{
  734. "annotation-key1": "annotation-value1",
  735. },
  736. }, Err: nil},
  737. AccessSecretVersionMockReturn: fakesm.AccessSecretVersionMockReturn{Res: &res, Err: nil},
  738. AddSecretVersionMockReturn: fakesm.AddSecretVersionMockReturn{SecretVersion: &secretVersion, Err: nil}},
  739. want: want{
  740. err: nil,
  741. req: func(m *fakesm.MockSMClient) error {
  742. req, ok := m.CreateSecretCalledWithN[0]
  743. if !ok {
  744. return errors.New(errCallNotFoundAtIndex0)
  745. }
  746. if req.Secret.Replication != nil {
  747. return errors.New("expected no replication - found something")
  748. }
  749. return nil
  750. },
  751. },
  752. },
  753. {
  754. desc: "SetSecret successfully pushes a secret with topics",
  755. args: args{
  756. Metadata: &apiextensionsv1.JSON{
  757. Raw: []byte(`{
  758. "apiVersion": "kubernetes.external-secrets.io/v1alpha1",
  759. "kind": "PushSecretMetadata",
  760. "spec": {
  761. "topics": ["topic1", "topic2"]
  762. }
  763. }`),
  764. },
  765. store: &esv1.GCPSMProvider{ProjectID: smtc.projectID},
  766. mock: &fakesm.MockSMClient{}, // the mock should NOT be shared between test cases
  767. CreateSecretMockReturn: fakesm.SecretMockReturn{Secret: &secretWithTopics, Err: nil},
  768. GetSecretMockReturn: fakesm.SecretMockReturn{Secret: nil, Err: notFoundError},
  769. AccessSecretVersionMockReturn: fakesm.AccessSecretVersionMockReturn{Res: &res, Err: nil},
  770. AddSecretVersionMockReturn: fakesm.AddSecretVersionMockReturn{SecretVersion: &secretVersion, Err: nil}},
  771. want: want{
  772. err: nil,
  773. req: func(m *fakesm.MockSMClient) error {
  774. scrt, ok := m.CreateSecretCalledWithN[0]
  775. if !ok {
  776. return errors.New(errCallNotFoundAtIndex0)
  777. }
  778. if scrt.Secret == nil {
  779. return errors.New("index 0 for call was nil")
  780. }
  781. if len(scrt.Secret.Topics) != 2 {
  782. return fmt.Errorf("secret topics count was not 2 but: %d", len(scrt.Secret.Topics))
  783. }
  784. if scrt.Secret.Topics[0].Name != "topic1" {
  785. return fmt.Errorf("secret topic name for 1 was not topic1 but: %s", scrt.Secret.Topics[0].Name)
  786. }
  787. if scrt.Secret.Topics[1].Name != "topic2" {
  788. return fmt.Errorf("secret topic name for 2 was not topic2 but: %s", scrt.Secret.Topics[1].Name)
  789. }
  790. if m.UpdateSecretCallN != 0 {
  791. return fmt.Errorf("updateSecret called with %d", m.UpdateSecretCallN)
  792. }
  793. return nil
  794. },
  795. },
  796. },
  797. {
  798. desc: "secret not pushed if AddSecretVersion errors",
  799. args: args{
  800. store: &esv1.GCPSMProvider{ProjectID: smtc.projectID},
  801. mock: smtc.mockClient,
  802. GetSecretMockReturn: fakesm.SecretMockReturn{Secret: &secret, Err: nil},
  803. AccessSecretVersionMockReturn: fakesm.AccessSecretVersionMockReturn{Res: &res, Err: nil},
  804. AddSecretVersionMockReturn: fakesm.AddSecretVersionMockReturn{SecretVersion: nil, Err: APIerror},
  805. },
  806. want: want{
  807. err: APIerror,
  808. },
  809. },
  810. {
  811. desc: "secret not pushed if AccessSecretVersion errors",
  812. args: args{
  813. store: &esv1.GCPSMProvider{ProjectID: smtc.projectID},
  814. mock: smtc.mockClient,
  815. GetSecretMockReturn: fakesm.SecretMockReturn{Secret: &secret, Err: nil},
  816. AccessSecretVersionMockReturn: fakesm.AccessSecretVersionMockReturn{Res: nil, Err: APIerror},
  817. },
  818. want: want{
  819. err: APIerror,
  820. },
  821. },
  822. {
  823. desc: "secret not pushed if not managed-by external-secrets",
  824. args: args{
  825. store: &esv1.GCPSMProvider{ProjectID: smtc.projectID},
  826. mock: smtc.mockClient,
  827. GetSecretMockReturn: fakesm.SecretMockReturn{Secret: &wrongLabelSecret, Err: nil},
  828. },
  829. want: want{
  830. err: labelError,
  831. },
  832. },
  833. {
  834. desc: "don't push a secret with the same key and value",
  835. args: args{
  836. store: &esv1.GCPSMProvider{ProjectID: smtc.projectID},
  837. mock: smtc.mockClient,
  838. AccessSecretVersionMockReturn: fakesm.AccessSecretVersionMockReturn{Res: &res2, Err: nil},
  839. GetSecretMockReturn: fakesm.SecretMockReturn{Secret: &secret, Err: nil},
  840. },
  841. want: want{
  842. err: nil,
  843. },
  844. },
  845. {
  846. desc: "secret is created if one doesn't already exist",
  847. args: args{
  848. store: &esv1.GCPSMProvider{ProjectID: smtc.projectID},
  849. mock: smtc.mockClient,
  850. GetSecretMockReturn: fakesm.SecretMockReturn{Secret: nil, Err: notFoundError},
  851. AccessSecretVersionMockReturn: fakesm.AccessSecretVersionMockReturn{Res: nil, Err: notFoundError},
  852. AddSecretVersionMockReturn: fakesm.AddSecretVersionMockReturn{SecretVersion: &secretVersion, Err: nil},
  853. CreateSecretMockReturn: fakesm.SecretMockReturn{Secret: &secret, Err: nil},
  854. },
  855. want: want{
  856. err: nil,
  857. },
  858. },
  859. {
  860. desc: "secret not created if CreateSecret returns not found error",
  861. args: args{
  862. store: &esv1.GCPSMProvider{ProjectID: smtc.projectID},
  863. mock: smtc.mockClient,
  864. GetSecretMockReturn: fakesm.SecretMockReturn{Secret: nil, Err: notFoundError},
  865. CreateSecretMockReturn: fakesm.SecretMockReturn{Secret: &secret, Err: notFoundError},
  866. },
  867. want: want{
  868. err: notFoundError,
  869. },
  870. },
  871. {
  872. desc: "secret not created if CreateSecret returns error",
  873. args: args{
  874. store: &esv1.GCPSMProvider{ProjectID: smtc.projectID},
  875. mock: smtc.mockClient,
  876. GetSecretMockReturn: fakesm.SecretMockReturn{Secret: nil, Err: canceledError},
  877. },
  878. want: want{
  879. err: canceledError,
  880. },
  881. },
  882. {
  883. desc: "access secret version for an existing secret returns error",
  884. args: args{
  885. store: &esv1.GCPSMProvider{ProjectID: smtc.projectID},
  886. mock: smtc.mockClient,
  887. GetSecretMockReturn: fakesm.SecretMockReturn{Secret: &secret, Err: nil},
  888. AccessSecretVersionMockReturn: fakesm.AccessSecretVersionMockReturn{Res: nil, Err: canceledError},
  889. },
  890. want: want{
  891. err: canceledError,
  892. },
  893. },
  894. {
  895. desc: "Whole secret is set with no existing GCPSM secret",
  896. args: args{
  897. store: &esv1.GCPSMProvider{ProjectID: smtc.projectID},
  898. mock: smtc.mockClient,
  899. GetSecretMockReturn: fakesm.SecretMockReturn{Secret: &secret, Err: nil},
  900. AccessSecretVersionMockReturn: fakesm.AccessSecretVersionMockReturn{Res: &res, Err: nil},
  901. AddSecretVersionMockReturn: fakesm.AddSecretVersionMockReturn{SecretVersion: &secretVersion, Err: nil}},
  902. want: want{
  903. err: nil,
  904. },
  905. secret: &corev1.Secret{Data: map[string][]byte{"key1": []byte(`value1`), "key2": []byte(`value2`)}},
  906. },
  907. }
  908. for _, tc := range tests {
  909. t.Run(tc.desc, func(t *testing.T) {
  910. tc.args.mock.Cleanup()
  911. tc.args.mock.NewGetSecretFn(tc.args.GetSecretMockReturn)
  912. tc.args.mock.NewUpdateSecretFn(tc.args.UpdateSecretReturn)
  913. tc.args.mock.NewCreateSecretFn(tc.args.CreateSecretMockReturn)
  914. tc.args.mock.NewAccessSecretVersionFn(tc.args.AccessSecretVersionMockReturn)
  915. tc.args.mock.NewAddSecretVersionFn(tc.args.AddSecretVersionMockReturn)
  916. c := Client{
  917. smClient: tc.args.mock,
  918. store: tc.args.store,
  919. }
  920. s := tc.secret
  921. if s == nil {
  922. s = &corev1.Secret{Data: map[string][]byte{secretKey: []byte("fake-value")}}
  923. }
  924. data := testingfake.PushSecretData{
  925. SecretKey: secretKey,
  926. Metadata: tc.args.Metadata,
  927. RemoteKey: "/baz",
  928. }
  929. err := c.PushSecret(context.Background(), s, data)
  930. if err != nil {
  931. if tc.want.err == nil {
  932. t.Errorf("received an unexpected error: %v", err)
  933. }
  934. if got, expected := err.Error(), tc.want.err.Error(); !strings.Contains(got, expected) {
  935. t.Errorf("received an unexpected error: %q should have contained %s", got, expected)
  936. }
  937. return
  938. }
  939. if tc.want.err != nil {
  940. t.Errorf("expected to receive an error but got nil")
  941. }
  942. if tc.want.req != nil {
  943. if err := tc.want.req(tc.args.mock); err != nil {
  944. t.Errorf("received an unexpected error while checking request: %v", err)
  945. }
  946. }
  947. })
  948. }
  949. }
  950. func TestSecretExists(t *testing.T) {
  951. tests := []struct {
  952. name string
  953. ref esv1.PushSecretRemoteRef
  954. getSecretMockReturn fakesm.SecretMockReturn
  955. accessSecretVersionMockReturn fakesm.AccessSecretVersionMockReturn
  956. expectedSecret bool
  957. expectedErr func(t *testing.T, err error)
  958. }{
  959. {
  960. name: "secret exists",
  961. ref: v1alpha1.PushSecretRemoteRef{
  962. RemoteKey: "bar",
  963. },
  964. getSecretMockReturn: fakesm.SecretMockReturn{
  965. Secret: &secretmanagerpb.Secret{
  966. Name: testSecretName,
  967. },
  968. Err: nil,
  969. },
  970. accessSecretVersionMockReturn: fakesm.AccessSecretVersionMockReturn{
  971. Res: &secretmanagerpb.AccessSecretVersionResponse{
  972. Name: "projects/foo/secrets/bar/versions/latest",
  973. Payload: &secretmanagerpb.SecretPayload{
  974. Data: []byte("test-data"),
  975. },
  976. },
  977. Err: nil,
  978. },
  979. expectedSecret: true,
  980. expectedErr: func(t *testing.T, err error) {
  981. require.NoError(t, err)
  982. },
  983. },
  984. {
  985. name: "secret exists but has no versions",
  986. ref: v1alpha1.PushSecretRemoteRef{
  987. RemoteKey: "bar",
  988. },
  989. getSecretMockReturn: fakesm.SecretMockReturn{
  990. Secret: &secretmanagerpb.Secret{
  991. Name: testSecretName,
  992. },
  993. Err: nil,
  994. },
  995. accessSecretVersionMockReturn: fakesm.AccessSecretVersionMockReturn{
  996. Res: nil,
  997. Err: status.Errorf(codes.NotFound, "secret version not found"),
  998. },
  999. expectedSecret: false,
  1000. expectedErr: func(t *testing.T, err error) {
  1001. require.NoError(t, err)
  1002. },
  1003. },
  1004. {
  1005. name: "secret does not exists",
  1006. ref: v1alpha1.PushSecretRemoteRef{
  1007. RemoteKey: "bar",
  1008. },
  1009. getSecretMockReturn: fakesm.SecretMockReturn{
  1010. Secret: nil,
  1011. Err: status.Errorf(codes.NotFound, "secret not found"),
  1012. },
  1013. accessSecretVersionMockReturn: fakesm.AccessSecretVersionMockReturn{},
  1014. expectedSecret: false,
  1015. expectedErr: func(t *testing.T, err error) {
  1016. require.NoError(t, err)
  1017. },
  1018. },
  1019. {
  1020. name: "unexpected error when getting secret",
  1021. ref: v1alpha1.PushSecretRemoteRef{
  1022. RemoteKey: "bar2",
  1023. },
  1024. getSecretMockReturn: fakesm.SecretMockReturn{
  1025. Secret: &secretmanagerpb.Secret{
  1026. Name: testSecretName,
  1027. },
  1028. Err: errors.New("some error"),
  1029. },
  1030. accessSecretVersionMockReturn: fakesm.AccessSecretVersionMockReturn{},
  1031. expectedSecret: false,
  1032. expectedErr: func(t *testing.T, err error) {
  1033. assert.ErrorContains(t, err, "some error")
  1034. },
  1035. },
  1036. {
  1037. name: "unexpected error occurs when accessing secret version",
  1038. ref: v1alpha1.PushSecretRemoteRef{
  1039. RemoteKey: "bar3",
  1040. },
  1041. getSecretMockReturn: fakesm.SecretMockReturn{
  1042. Secret: &secretmanagerpb.Secret{
  1043. Name: testSecretName,
  1044. },
  1045. Err: nil,
  1046. },
  1047. accessSecretVersionMockReturn: fakesm.AccessSecretVersionMockReturn{
  1048. Res: nil,
  1049. Err: errors.New("version access error"),
  1050. },
  1051. expectedSecret: false,
  1052. expectedErr: func(t *testing.T, err error) {
  1053. assert.ErrorContains(t, err, "version access error")
  1054. },
  1055. },
  1056. }
  1057. for _, tc := range tests {
  1058. t.Run(tc.name, func(t *testing.T) {
  1059. smClient := fakesm.MockSMClient{}
  1060. smClient.NewGetSecretFn(tc.getSecretMockReturn)
  1061. smClient.NewAccessSecretVersionFn(tc.accessSecretVersionMockReturn)
  1062. client := Client{
  1063. smClient: &smClient,
  1064. store: &esv1.GCPSMProvider{
  1065. ProjectID: "foo",
  1066. },
  1067. }
  1068. got, err := client.SecretExists(context.TODO(), tc.ref)
  1069. tc.expectedErr(t, err)
  1070. if got != tc.expectedSecret {
  1071. t.Fatalf("unexpected secret: expected %t, got %t", tc.expectedSecret, got)
  1072. }
  1073. })
  1074. }
  1075. }
  1076. func TestPushSecretProperty(t *testing.T) {
  1077. secretKey := "secret-key"
  1078. defaultAddSecretVersionMockReturn := func(gotPayload, expectedPayload string) (*secretmanagerpb.SecretVersion, error) {
  1079. if gotPayload != expectedPayload {
  1080. t.Fatalf("payload does not match: got %s, expected: %s", gotPayload, expectedPayload)
  1081. }
  1082. return nil, nil
  1083. }
  1084. tests := []struct {
  1085. desc string
  1086. payload string
  1087. data testingfake.PushSecretData
  1088. getSecretMockReturn fakesm.SecretMockReturn
  1089. createSecretMockReturn fakesm.SecretMockReturn
  1090. updateSecretMockReturn fakesm.SecretMockReturn
  1091. accessSecretVersionMockReturn fakesm.AccessSecretVersionMockReturn
  1092. addSecretVersionMockReturn func(gotPayload, expectedPayload string) (*secretmanagerpb.SecretVersion, error)
  1093. expectedPayload string
  1094. expectedErr string
  1095. }{
  1096. {
  1097. desc: "Add new key value paris",
  1098. payload: "testValue2",
  1099. data: testingfake.PushSecretData{
  1100. SecretKey: secretKey,
  1101. Property: "testKey2",
  1102. },
  1103. getSecretMockReturn: fakesm.SecretMockReturn{
  1104. Secret: &secretmanagerpb.Secret{
  1105. Labels: map[string]string{
  1106. managedByKey: managedByValue,
  1107. },
  1108. },
  1109. },
  1110. accessSecretVersionMockReturn: fakesm.AccessSecretVersionMockReturn{
  1111. Res: &secretmanagerpb.AccessSecretVersionResponse{
  1112. Payload: &secretmanagerpb.SecretPayload{
  1113. Data: []byte(`{"testKey1":"testValue1"}`),
  1114. },
  1115. },
  1116. },
  1117. addSecretVersionMockReturn: defaultAddSecretVersionMockReturn,
  1118. expectedPayload: `{"testKey1":"testValue1","testKey2":"testValue2"}`,
  1119. },
  1120. {
  1121. desc: "Update existing value",
  1122. payload: "testValue2",
  1123. data: testingfake.PushSecretData{
  1124. SecretKey: secretKey,
  1125. Property: "testKey1.testKey2",
  1126. },
  1127. getSecretMockReturn: fakesm.SecretMockReturn{
  1128. Secret: &secretmanagerpb.Secret{
  1129. Labels: map[string]string{
  1130. managedByKey: managedByValue,
  1131. },
  1132. },
  1133. },
  1134. accessSecretVersionMockReturn: fakesm.AccessSecretVersionMockReturn{
  1135. Res: &secretmanagerpb.AccessSecretVersionResponse{
  1136. Payload: &secretmanagerpb.SecretPayload{
  1137. Data: []byte(`{"testKey1":{"testKey2":"testValue1"}}`),
  1138. },
  1139. },
  1140. },
  1141. addSecretVersionMockReturn: defaultAddSecretVersionMockReturn,
  1142. expectedPayload: `{"testKey1":{"testKey2":"testValue2"}}`,
  1143. },
  1144. {
  1145. desc: "Secret not found",
  1146. payload: "testValue2",
  1147. data: testingfake.PushSecretData{
  1148. SecretKey: secretKey,
  1149. Property: "testKey1.testKey3",
  1150. },
  1151. getSecretMockReturn: fakesm.SecretMockReturn{
  1152. Secret: &secretmanagerpb.Secret{},
  1153. Err: status.Error(codes.NotFound, "failed to find a Secret"),
  1154. },
  1155. createSecretMockReturn: fakesm.SecretMockReturn{
  1156. Secret: &secretmanagerpb.Secret{
  1157. Labels: map[string]string{managedByKey: managedByValue},
  1158. },
  1159. },
  1160. accessSecretVersionMockReturn: fakesm.AccessSecretVersionMockReturn{
  1161. Res: &secretmanagerpb.AccessSecretVersionResponse{
  1162. Payload: &secretmanagerpb.SecretPayload{
  1163. Data: []byte(`{"testKey1":{"testKey2":"testValue1"}}`),
  1164. },
  1165. },
  1166. },
  1167. addSecretVersionMockReturn: defaultAddSecretVersionMockReturn,
  1168. expectedPayload: `{"testKey1":{"testKey2":"testValue1","testKey3":"testValue2"}}`,
  1169. },
  1170. {
  1171. desc: "Secret version is not found",
  1172. payload: "testValue1",
  1173. data: testingfake.PushSecretData{
  1174. SecretKey: secretKey,
  1175. Property: "testKey1",
  1176. },
  1177. getSecretMockReturn: fakesm.SecretMockReturn{
  1178. Secret: &secretmanagerpb.Secret{
  1179. Labels: map[string]string{managedByKey: managedByValue},
  1180. },
  1181. },
  1182. accessSecretVersionMockReturn: fakesm.AccessSecretVersionMockReturn{
  1183. Err: status.Error(codes.NotFound, "failed to find a Secret Version"),
  1184. },
  1185. addSecretVersionMockReturn: defaultAddSecretVersionMockReturn,
  1186. expectedPayload: `{"testKey1":"testValue1"}`,
  1187. },
  1188. {
  1189. desc: "Secret is not managed by the controller",
  1190. payload: "testValue1",
  1191. data: testingfake.PushSecretData{
  1192. SecretKey: secretKey,
  1193. Property: "testKey1.testKey2",
  1194. },
  1195. getSecretMockReturn: fakesm.SecretMockReturn{
  1196. Secret: &secretmanagerpb.Secret{},
  1197. },
  1198. updateSecretMockReturn: fakesm.SecretMockReturn{
  1199. Secret: &secretmanagerpb.Secret{
  1200. Labels: map[string]string{managedByKey: managedByValue},
  1201. },
  1202. },
  1203. accessSecretVersionMockReturn: fakesm.AccessSecretVersionMockReturn{
  1204. Res: &secretmanagerpb.AccessSecretVersionResponse{
  1205. Payload: &secretmanagerpb.SecretPayload{
  1206. Data: []byte(""),
  1207. },
  1208. },
  1209. },
  1210. addSecretVersionMockReturn: defaultAddSecretVersionMockReturn,
  1211. expectedPayload: `{"testKey1":{"testKey2":"testValue1"}}`,
  1212. },
  1213. {
  1214. desc: "Payload is the same with the existing one",
  1215. payload: "testValue1",
  1216. data: testingfake.PushSecretData{
  1217. SecretKey: secretKey,
  1218. Property: "testKey1.testKey2",
  1219. },
  1220. getSecretMockReturn: fakesm.SecretMockReturn{
  1221. Secret: &secretmanagerpb.Secret{
  1222. Labels: map[string]string{
  1223. managedByKey: managedByValue,
  1224. },
  1225. },
  1226. },
  1227. accessSecretVersionMockReturn: fakesm.AccessSecretVersionMockReturn{
  1228. Res: &secretmanagerpb.AccessSecretVersionResponse{
  1229. Payload: &secretmanagerpb.SecretPayload{
  1230. Data: []byte(`{"testKey1":{"testKey2":"testValue1"}}`),
  1231. },
  1232. },
  1233. },
  1234. addSecretVersionMockReturn: func(gotPayload, expectedPayload string) (*secretmanagerpb.SecretVersion, error) {
  1235. return nil, errors.New("should not be called")
  1236. },
  1237. },
  1238. }
  1239. for _, tc := range tests {
  1240. t.Run(tc.desc, func(t *testing.T) {
  1241. smClient := &fakesm.MockSMClient{
  1242. AddSecretFn: func(_ context.Context, req *secretmanagerpb.AddSecretVersionRequest, _ ...gax.CallOption) (*secretmanagerpb.SecretVersion, error) {
  1243. return tc.addSecretVersionMockReturn(string(req.Payload.Data), tc.expectedPayload)
  1244. },
  1245. }
  1246. smClient.NewGetSecretFn(tc.getSecretMockReturn)
  1247. smClient.NewCreateSecretFn(tc.createSecretMockReturn)
  1248. smClient.NewUpdateSecretFn(tc.updateSecretMockReturn)
  1249. smClient.NewAccessSecretVersionFn(tc.accessSecretVersionMockReturn)
  1250. client := Client{
  1251. smClient: smClient,
  1252. store: &esv1.GCPSMProvider{},
  1253. }
  1254. s := &corev1.Secret{Data: map[string][]byte{secretKey: []byte(tc.payload)}}
  1255. err := client.PushSecret(context.Background(), s, tc.data)
  1256. if err != nil {
  1257. if tc.expectedErr == "" {
  1258. t.Fatalf("PushSecret returns unexpected error: %v", err)
  1259. }
  1260. if !strings.Contains(err.Error(), tc.expectedErr) {
  1261. t.Fatalf("PushSecret returns unexpected error: %q should have contained %s", err, tc.expectedErr)
  1262. }
  1263. return
  1264. }
  1265. if tc.expectedErr != "" {
  1266. t.Fatal("PushSecret is expected to return error but got nil")
  1267. }
  1268. })
  1269. }
  1270. }
  1271. func TestGetSecretMap(t *testing.T) {
  1272. // good case: default version & deserialization
  1273. setDeserialization := func(smtc *secretManagerTestCase) {
  1274. smtc.apiOutput.Payload.Data = []byte(`{"foo":"bar"}`)
  1275. smtc.expectedData["foo"] = []byte("bar")
  1276. }
  1277. // bad case: invalid json
  1278. setInvalidJSON := func(smtc *secretManagerTestCase) {
  1279. smtc.apiOutput.Payload.Data = []byte(`-----------------`)
  1280. smtc.expectError = "unable to unmarshal secret"
  1281. }
  1282. // good case: deserialize nested json as []byte, if it's a string, decode the string
  1283. setNestedJSON := func(smtc *secretManagerTestCase) {
  1284. smtc.apiOutput.Payload.Data = []byte(`{"foo":{"bar":"baz"}, "qux": "qu\"z"}`)
  1285. smtc.expectedData["foo"] = []byte(`{"bar":"baz"}`)
  1286. smtc.expectedData["qux"] = []byte("qu\"z")
  1287. }
  1288. successCases := []*secretManagerTestCase{
  1289. makeValidSecretManagerTestCaseCustom(setDeserialization),
  1290. makeValidSecretManagerTestCaseCustom(setAPIErr),
  1291. makeValidSecretManagerTestCaseCustom(setNilMockClient),
  1292. makeValidSecretManagerTestCaseCustom(setInvalidJSON),
  1293. makeValidSecretManagerTestCaseCustom(setNestedJSON),
  1294. }
  1295. sm := Client{}
  1296. for k, v := range successCases {
  1297. sm.store = &esv1.GCPSMProvider{ProjectID: v.projectID}
  1298. sm.smClient = v.mockClient
  1299. out, err := sm.GetSecretMap(context.Background(), *v.ref)
  1300. if !ErrorContains(err, v.expectError) {
  1301. t.Errorf("[%d] unexpected error: %s, expected: '%s'", k, err.Error(), v.expectError)
  1302. }
  1303. if err == nil && !reflect.DeepEqual(out, v.expectedData) {
  1304. t.Errorf("[%d] unexpected secret pushSecretData: expected %#v, got %#v", k, v.expectedData, out)
  1305. }
  1306. }
  1307. }
  1308. func ErrorContains(out error, want string) bool {
  1309. if out == nil {
  1310. return want == ""
  1311. }
  1312. if want == "" {
  1313. return false
  1314. }
  1315. return strings.Contains(out.Error(), want)
  1316. }
  1317. func TestValidateStore(t *testing.T) {
  1318. type args struct {
  1319. auth esv1.GCPSMAuth
  1320. }
  1321. tests := []struct {
  1322. name string
  1323. args args
  1324. wantErr bool
  1325. }{
  1326. {
  1327. name: "empty auth",
  1328. wantErr: false,
  1329. },
  1330. {
  1331. name: "invalid secret data",
  1332. wantErr: true,
  1333. args: args{
  1334. auth: esv1.GCPSMAuth{
  1335. SecretRef: &esv1.GCPSMAuthSecretRef{
  1336. SecretAccessKey: v1.SecretKeySelector{
  1337. Name: "foo",
  1338. Namespace: pointer.To("invalid"),
  1339. },
  1340. },
  1341. },
  1342. },
  1343. },
  1344. {
  1345. name: "invalid wi sa data",
  1346. wantErr: true,
  1347. args: args{
  1348. auth: esv1.GCPSMAuth{
  1349. WorkloadIdentity: &esv1.GCPWorkloadIdentity{
  1350. ServiceAccountRef: v1.ServiceAccountSelector{
  1351. Name: "foo",
  1352. Namespace: pointer.To("invalid"),
  1353. },
  1354. },
  1355. },
  1356. },
  1357. },
  1358. }
  1359. for _, tt := range tests {
  1360. t.Run(tt.name, func(t *testing.T) {
  1361. sm := &Provider{}
  1362. store := &esv1.SecretStore{
  1363. Spec: esv1.SecretStoreSpec{
  1364. Provider: &esv1.SecretStoreProvider{
  1365. GCPSM: &esv1.GCPSMProvider{
  1366. Auth: tt.args.auth,
  1367. },
  1368. },
  1369. },
  1370. }
  1371. if _, err := sm.ValidateStore(store); (err != nil) != tt.wantErr {
  1372. t.Errorf("ProviderGCP.ValidateStore() error = %v, wantErr %v", err, tt.wantErr)
  1373. }
  1374. })
  1375. }
  1376. }
  1377. func TestGetDataByProperty(t *testing.T) {
  1378. tests := []struct {
  1379. desc string
  1380. accessSecretVersionMockReturn fakesm.AccessSecretVersionMockReturn
  1381. ref *esv1.ExternalSecretDataRemoteRef
  1382. wantErr bool
  1383. }{
  1384. {
  1385. desc: "valid json",
  1386. accessSecretVersionMockReturn: fakesm.AccessSecretVersionMockReturn{
  1387. Res: &secretmanagerpb.AccessSecretVersionResponse{
  1388. Payload: &secretmanagerpb.SecretPayload{
  1389. Data: []byte(`{"testKey1":{"testKey2":"testValue1"}}`),
  1390. },
  1391. },
  1392. },
  1393. ref: makeValidRef(),
  1394. wantErr: false,
  1395. },
  1396. {
  1397. desc: "invalid json",
  1398. accessSecretVersionMockReturn: fakesm.AccessSecretVersionMockReturn{
  1399. Res: &secretmanagerpb.AccessSecretVersionResponse{
  1400. Payload: &secretmanagerpb.SecretPayload{
  1401. Data: []byte(`{"testKey1":{"testKey2":"testValue1"},}`),
  1402. },
  1403. },
  1404. },
  1405. ref: makeValidRef(),
  1406. wantErr: true,
  1407. },
  1408. }
  1409. for _, tc := range tests {
  1410. t.Run(tc.desc, func(t *testing.T) {
  1411. _, err := getDataByProperty(tc.accessSecretVersionMockReturn.Res.Payload.Data, tc.ref.Property)
  1412. if (err != nil) != tc.wantErr {
  1413. t.Errorf("getDataByProperty() error = %v, wantErr %v", err, tc.wantErr)
  1414. }
  1415. })
  1416. }
  1417. }