utils_test.go 27 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230
  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 utils
  13. import (
  14. "encoding/json"
  15. "errors"
  16. "reflect"
  17. "testing"
  18. "time"
  19. "github.com/aws/aws-sdk-go/aws"
  20. "github.com/oracle/oci-go-sdk/v65/vault"
  21. "github.com/stretchr/testify/assert"
  22. v1 "k8s.io/api/core/v1"
  23. apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
  24. metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
  25. esv1alpha1 "github.com/external-secrets/external-secrets/apis/externalsecrets/v1alpha1"
  26. esv1beta1 "github.com/external-secrets/external-secrets/apis/externalsecrets/v1beta1"
  27. esmetav1 "github.com/external-secrets/external-secrets/apis/meta/v1"
  28. )
  29. const (
  30. base64DecodedValue string = "foo%_?bar"
  31. base64EncodedValue string = "Zm9vJV8/YmFy"
  32. base64URLEncodedValue string = "Zm9vJV8_YmFy"
  33. keyWithEmojis string = "😀foo😁bar😂baz😈bing"
  34. keyWithInvalidChars string = "some-array[0].entity"
  35. keyWithEncodedInvalidChars string = "some-array_U005b_0_U005d_.entity"
  36. )
  37. func TestObjectHash(t *testing.T) {
  38. tests := []struct {
  39. name string
  40. input any
  41. want string
  42. }{
  43. {
  44. name: "A nil should be still working",
  45. input: nil,
  46. want: "60046f14c917c18a9a0f923e191ba0dc",
  47. },
  48. {
  49. name: "We accept a simple scalar value, i.e. string",
  50. input: "hello there",
  51. want: "161bc25962da8fed6d2f59922fb642aa",
  52. },
  53. {
  54. name: "A complex object like a secret is not an issue",
  55. input: v1.Secret{Data: map[string][]byte{
  56. "xx": []byte("yyy"),
  57. }},
  58. want: "85eabdeb376371ffc5a658d7a162eba8",
  59. },
  60. {
  61. name: "map also works",
  62. input: map[string][]byte{
  63. "foo": []byte("value1"),
  64. "bar": []byte("value2"),
  65. },
  66. want: "caa0155759a6a9b3b6ada5a6883ee2bb",
  67. },
  68. }
  69. for _, tt := range tests {
  70. t.Run(tt.name, func(t *testing.T) {
  71. if got := ObjectHash(tt.input); got != tt.want {
  72. t.Errorf("ObjectHash() = %v, want %v", got, tt.want)
  73. }
  74. })
  75. }
  76. }
  77. func TestIsNil(t *testing.T) {
  78. tbl := []struct {
  79. name string
  80. val any
  81. exp bool
  82. }{
  83. {
  84. name: "simple nil val",
  85. val: nil,
  86. exp: true,
  87. },
  88. {
  89. name: "nil slice",
  90. val: (*[]struct{})(nil),
  91. exp: true,
  92. },
  93. {
  94. name: "struct pointer",
  95. val: &testing.T{},
  96. exp: false,
  97. },
  98. {
  99. name: "struct",
  100. val: testing.T{},
  101. exp: false,
  102. },
  103. {
  104. name: "slice of struct",
  105. val: []struct{}{{}},
  106. exp: false,
  107. },
  108. {
  109. name: "slice of ptr",
  110. val: []*testing.T{nil},
  111. exp: false,
  112. },
  113. {
  114. name: "slice",
  115. val: []struct{}(nil),
  116. exp: false,
  117. },
  118. {
  119. name: "int default value",
  120. val: 0,
  121. exp: false,
  122. },
  123. {
  124. name: "empty str",
  125. val: "",
  126. exp: false,
  127. },
  128. {
  129. name: "oracle vault",
  130. val: vault.VaultsClient{},
  131. exp: false,
  132. },
  133. {
  134. name: "func",
  135. val: func() {
  136. // noop for testing and to make linter happy
  137. },
  138. exp: false,
  139. },
  140. {
  141. name: "channel",
  142. val: make(chan struct{}),
  143. exp: false,
  144. },
  145. {
  146. name: "map",
  147. val: map[string]string{},
  148. exp: false,
  149. },
  150. }
  151. for _, row := range tbl {
  152. t.Run(row.name, func(t *testing.T) {
  153. res := IsNil(row.val)
  154. if res != row.exp {
  155. t.Errorf("IsNil(%#v)=%t, expected %t", row.val, res, row.exp)
  156. }
  157. })
  158. }
  159. }
  160. func TestConvertKeys(t *testing.T) {
  161. type args struct {
  162. strategy esv1beta1.ExternalSecretConversionStrategy
  163. in map[string][]byte
  164. }
  165. tests := []struct {
  166. name string
  167. args args
  168. want map[string][]byte
  169. wantErr bool
  170. }{
  171. {
  172. name: "convert with special chars",
  173. args: args{
  174. strategy: esv1beta1.ExternalSecretConversionDefault,
  175. in: map[string][]byte{
  176. "foo$bar%baz*bing": []byte(`noop`),
  177. },
  178. },
  179. want: map[string][]byte{
  180. "foo_bar_baz_bing": []byte(`noop`),
  181. },
  182. },
  183. {
  184. name: "error on collision",
  185. args: args{
  186. strategy: esv1beta1.ExternalSecretConversionDefault,
  187. in: map[string][]byte{
  188. "foo$bar%baz*bing": []byte(`noop`),
  189. "foo_bar_baz$bing": []byte(`noop`),
  190. },
  191. },
  192. wantErr: true,
  193. },
  194. {
  195. name: "convert path",
  196. args: args{
  197. strategy: esv1beta1.ExternalSecretConversionDefault,
  198. in: map[string][]byte{
  199. "/foo/bar/baz/bing": []byte(`noop`),
  200. "foo/bar/baz/bing/": []byte(`noop`),
  201. },
  202. },
  203. want: map[string][]byte{
  204. "_foo_bar_baz_bing": []byte(`noop`),
  205. "foo_bar_baz_bing_": []byte(`noop`),
  206. },
  207. },
  208. {
  209. name: "convert unicode",
  210. args: args{
  211. strategy: esv1beta1.ExternalSecretConversionUnicode,
  212. in: map[string][]byte{
  213. keyWithEmojis: []byte(`noop`),
  214. },
  215. },
  216. want: map[string][]byte{
  217. "_U1f600_foo_U1f601_bar_U1f602_baz_U1f608_bing": []byte(`noop`),
  218. },
  219. },
  220. }
  221. for _, tt := range tests {
  222. t.Run(tt.name, func(t *testing.T) {
  223. got, err := ConvertKeys(tt.args.strategy, tt.args.in)
  224. if (err != nil) != tt.wantErr {
  225. t.Errorf("ConvertKeys() error = %v, wantErr %v", err, tt.wantErr)
  226. return
  227. }
  228. if !reflect.DeepEqual(got, tt.want) {
  229. t.Errorf("ConvertKeys() = %v, want %v", got, tt.want)
  230. }
  231. })
  232. }
  233. }
  234. func TestReverseKeys(t *testing.T) {
  235. type args struct {
  236. encodingStrategy esv1beta1.ExternalSecretConversionStrategy
  237. decodingStrategy esv1alpha1.PushSecretConversionStrategy
  238. in map[string][]byte
  239. }
  240. tests := []struct {
  241. name string
  242. args args
  243. want map[string][]byte
  244. wantErr bool
  245. }{
  246. {
  247. name: "encoding and decoding strategy are selecting Unicode conversion and reverse unicode, so the in and want should match, this test covers Unicode characters beyond the Basic Multilingual Plane (BMP)",
  248. args: args{
  249. encodingStrategy: esv1beta1.ExternalSecretConversionUnicode,
  250. decodingStrategy: esv1alpha1.PushSecretConversionReverseUnicode,
  251. in: map[string][]byte{
  252. keyWithEmojis: []byte(`noop`),
  253. },
  254. },
  255. want: map[string][]byte{
  256. keyWithEmojis: []byte(`noop`),
  257. },
  258. },
  259. {
  260. name: "encoding and decoding strategy are selecting Unicode conversion and reverse unicode, so the in and want should match, this test covers Unicode characters in the Basic Multilingual Plane (BMP)",
  261. args: args{
  262. encodingStrategy: esv1beta1.ExternalSecretConversionUnicode,
  263. decodingStrategy: esv1alpha1.PushSecretConversionReverseUnicode,
  264. in: map[string][]byte{
  265. keyWithInvalidChars: []byte(`noop`),
  266. },
  267. },
  268. want: map[string][]byte{
  269. keyWithInvalidChars: []byte(`noop`),
  270. },
  271. },
  272. {
  273. name: "the encoding strategy is selecting Unicode conversion, but the decoding strategy is none, so we want an encoded representation of the content",
  274. args: args{
  275. encodingStrategy: esv1beta1.ExternalSecretConversionUnicode,
  276. decodingStrategy: esv1alpha1.PushSecretConversionNone,
  277. in: map[string][]byte{
  278. keyWithInvalidChars: []byte(`noop`),
  279. },
  280. },
  281. want: map[string][]byte{
  282. keyWithEncodedInvalidChars: []byte(`noop`),
  283. },
  284. },
  285. }
  286. for _, tt := range tests {
  287. t.Run(tt.name, func(t *testing.T) {
  288. got, err := ConvertKeys(tt.args.encodingStrategy, tt.args.in)
  289. if (err != nil) != tt.wantErr {
  290. t.Errorf("ConvertKeys() error = %v, wantErr %v", err, tt.wantErr)
  291. return
  292. }
  293. got, err = ReverseKeys(tt.args.decodingStrategy, got)
  294. if (err != nil) != tt.wantErr {
  295. t.Errorf("ReverseKeys() error = %v, wantErr %v", err, tt.wantErr)
  296. return
  297. }
  298. if !reflect.DeepEqual(got, tt.want) {
  299. t.Errorf("ReverseKeys() = %v, want %v", got, tt.want)
  300. }
  301. })
  302. }
  303. }
  304. func TestDecode(t *testing.T) {
  305. type args struct {
  306. strategy esv1beta1.ExternalSecretDecodingStrategy
  307. in map[string][]byte
  308. }
  309. tests := []struct {
  310. name string
  311. args args
  312. want map[string][]byte
  313. wantErr bool
  314. }{
  315. {
  316. name: "base64 decoded",
  317. args: args{
  318. strategy: esv1beta1.ExternalSecretDecodeBase64,
  319. in: map[string][]byte{
  320. "foo": []byte("YmFy"),
  321. },
  322. },
  323. want: map[string][]byte{
  324. "foo": []byte("bar"),
  325. },
  326. },
  327. {
  328. name: "invalid base64",
  329. args: args{
  330. strategy: esv1beta1.ExternalSecretDecodeBase64,
  331. in: map[string][]byte{
  332. "foo": []byte("foo"),
  333. },
  334. },
  335. wantErr: true,
  336. },
  337. {
  338. name: "base64url decoded",
  339. args: args{
  340. strategy: esv1beta1.ExternalSecretDecodeBase64URL,
  341. in: map[string][]byte{
  342. "foo": []byte(base64URLEncodedValue),
  343. },
  344. },
  345. want: map[string][]byte{
  346. "foo": []byte(base64DecodedValue),
  347. },
  348. },
  349. {
  350. name: "invalid base64url",
  351. args: args{
  352. strategy: esv1beta1.ExternalSecretDecodeBase64URL,
  353. in: map[string][]byte{
  354. "foo": []byte("foo"),
  355. },
  356. },
  357. wantErr: true,
  358. },
  359. {
  360. name: "none",
  361. args: args{
  362. strategy: esv1beta1.ExternalSecretDecodeNone,
  363. in: map[string][]byte{
  364. "foo": []byte(base64URLEncodedValue),
  365. },
  366. },
  367. want: map[string][]byte{
  368. "foo": []byte(base64URLEncodedValue),
  369. },
  370. },
  371. {
  372. name: "auto",
  373. args: args{
  374. strategy: esv1beta1.ExternalSecretDecodeAuto,
  375. in: map[string][]byte{
  376. "b64": []byte(base64EncodedValue),
  377. "invalidb64": []byte("foo"),
  378. "b64url": []byte(base64URLEncodedValue),
  379. },
  380. },
  381. want: map[string][]byte{
  382. "b64": []byte(base64DecodedValue),
  383. "invalidb64": []byte("foo"),
  384. "b64url": []byte(base64DecodedValue),
  385. },
  386. },
  387. }
  388. for _, tt := range tests {
  389. t.Run(tt.name, func(t *testing.T) {
  390. got, err := DecodeMap(tt.args.strategy, tt.args.in)
  391. if (err != nil) != tt.wantErr {
  392. t.Errorf("DecodeMap() error = %v, wantErr %v", err, tt.wantErr)
  393. return
  394. }
  395. if !reflect.DeepEqual(got, tt.want) {
  396. t.Errorf("DecodeMap() = %v, want %v", got, tt.want)
  397. }
  398. })
  399. }
  400. }
  401. func TestValidate(t *testing.T) {
  402. err := NetworkValidate("http://google.com", 10*time.Second)
  403. if err != nil {
  404. t.Errorf("Connection problem: %v", err)
  405. }
  406. }
  407. func TestRewrite(t *testing.T) {
  408. type args struct {
  409. operations []esv1beta1.ExternalSecretRewrite
  410. in map[string][]byte
  411. }
  412. tests := []struct {
  413. name string
  414. args args
  415. want map[string][]byte
  416. wantErr bool
  417. }{
  418. {
  419. name: "replace of a single key",
  420. args: args{
  421. operations: []esv1beta1.ExternalSecretRewrite{
  422. {
  423. Regexp: &esv1beta1.ExternalSecretRewriteRegexp{
  424. Source: "-",
  425. Target: "_",
  426. },
  427. },
  428. },
  429. in: map[string][]byte{
  430. "foo-bar": []byte("bar"),
  431. },
  432. },
  433. want: map[string][]byte{
  434. "foo_bar": []byte("bar"),
  435. },
  436. },
  437. {
  438. name: "no operation",
  439. args: args{
  440. operations: []esv1beta1.ExternalSecretRewrite{
  441. {
  442. Regexp: &esv1beta1.ExternalSecretRewriteRegexp{
  443. Source: "hello",
  444. Target: "world",
  445. },
  446. },
  447. },
  448. in: map[string][]byte{
  449. "foo": []byte("bar"),
  450. },
  451. },
  452. want: map[string][]byte{
  453. "foo": []byte("bar"),
  454. },
  455. },
  456. {
  457. name: "removing prefix from keys",
  458. args: args{
  459. operations: []esv1beta1.ExternalSecretRewrite{
  460. {
  461. Regexp: &esv1beta1.ExternalSecretRewriteRegexp{
  462. Source: "^my/initial/path/",
  463. Target: "",
  464. },
  465. },
  466. },
  467. in: map[string][]byte{
  468. "my/initial/path/foo": []byte("bar"),
  469. },
  470. },
  471. want: map[string][]byte{
  472. "foo": []byte("bar"),
  473. },
  474. },
  475. {
  476. name: "using un-named capture groups",
  477. args: args{
  478. operations: []esv1beta1.ExternalSecretRewrite{
  479. {
  480. Regexp: &esv1beta1.ExternalSecretRewriteRegexp{
  481. Source: "f(.*)o",
  482. Target: "a_new_path_$1",
  483. },
  484. },
  485. },
  486. in: map[string][]byte{
  487. "foo": []byte("bar"),
  488. "foodaloo": []byte("barr"),
  489. },
  490. },
  491. want: map[string][]byte{
  492. "a_new_path_o": []byte("bar"),
  493. "a_new_path_oodalo": []byte("barr"),
  494. },
  495. },
  496. {
  497. name: "using named and numbered capture groups",
  498. args: args{
  499. operations: []esv1beta1.ExternalSecretRewrite{
  500. {
  501. Regexp: &esv1beta1.ExternalSecretRewriteRegexp{
  502. Source: "f(?P<content>.*)o",
  503. Target: "a_new_path_${content}_${1}",
  504. },
  505. },
  506. },
  507. in: map[string][]byte{
  508. "foo": []byte("bar"),
  509. "floo": []byte("barr"),
  510. },
  511. },
  512. want: map[string][]byte{
  513. "a_new_path_o_o": []byte("bar"),
  514. "a_new_path_lo_lo": []byte("barr"),
  515. },
  516. },
  517. {
  518. name: "using sequenced rewrite operations",
  519. args: args{
  520. operations: []esv1beta1.ExternalSecretRewrite{
  521. {
  522. Regexp: &esv1beta1.ExternalSecretRewriteRegexp{
  523. Source: "my/(.*?)/bar/(.*)",
  524. Target: "$1-$2",
  525. },
  526. },
  527. {
  528. Regexp: &esv1beta1.ExternalSecretRewriteRegexp{
  529. Source: "-",
  530. Target: "_",
  531. },
  532. },
  533. {
  534. Regexp: &esv1beta1.ExternalSecretRewriteRegexp{
  535. Source: "ass",
  536. Target: "***",
  537. },
  538. },
  539. },
  540. in: map[string][]byte{
  541. "my/app/bar/key": []byte("bar"),
  542. "my/app/bar/password": []byte("barr"),
  543. },
  544. },
  545. want: map[string][]byte{
  546. "app_key": []byte("bar"),
  547. "app_p***word": []byte("barr"),
  548. },
  549. },
  550. {
  551. name: "using transform rewrite operation to create env var format keys",
  552. args: args{
  553. operations: []esv1beta1.ExternalSecretRewrite{
  554. {
  555. Regexp: &esv1beta1.ExternalSecretRewriteRegexp{
  556. Source: "my/(.*?)/bar/(.*)",
  557. Target: "$1-$2",
  558. },
  559. },
  560. {
  561. Transform: &esv1beta1.ExternalSecretRewriteTransform{
  562. Template: `{{ .value | upper | replace "-" "_" }}`,
  563. },
  564. },
  565. },
  566. in: map[string][]byte{
  567. "my/app/bar/api-key": []byte("bar"),
  568. "my/app/bar/api-password": []byte("barr"),
  569. },
  570. },
  571. want: map[string][]byte{
  572. "APP_API_KEY": []byte("bar"),
  573. "APP_API_PASSWORD": []byte("barr"),
  574. },
  575. },
  576. {
  577. name: "using transform rewrite operation to lower case",
  578. args: args{
  579. operations: []esv1beta1.ExternalSecretRewrite{
  580. {
  581. Transform: &esv1beta1.ExternalSecretRewriteTransform{
  582. Template: `{{ .value | lower }}`,
  583. },
  584. },
  585. },
  586. in: map[string][]byte{
  587. "API_FOO": []byte("bar"),
  588. "KEY_FOO": []byte("barr"),
  589. },
  590. },
  591. want: map[string][]byte{
  592. "api_foo": []byte("bar"),
  593. "key_foo": []byte("barr"),
  594. },
  595. },
  596. }
  597. for _, tt := range tests {
  598. t.Run(tt.name, func(t *testing.T) {
  599. got, err := RewriteMap(tt.args.operations, tt.args.in)
  600. if (err != nil) != tt.wantErr {
  601. t.Errorf("RewriteMap() error = %v, wantErr %v", err, tt.wantErr)
  602. return
  603. }
  604. if !reflect.DeepEqual(got, tt.want) {
  605. t.Errorf("RewriteMap() = %v, want %v", got, tt.want)
  606. }
  607. })
  608. }
  609. }
  610. func TestReverse(t *testing.T) {
  611. type args struct {
  612. strategy esv1alpha1.PushSecretConversionStrategy
  613. in string
  614. }
  615. tests := []struct {
  616. name string
  617. args args
  618. want string
  619. }{
  620. {
  621. name: "do not change the key when using the None strategy",
  622. args: args{
  623. strategy: esv1alpha1.PushSecretConversionNone,
  624. in: keyWithEncodedInvalidChars,
  625. },
  626. want: keyWithEncodedInvalidChars,
  627. },
  628. {
  629. name: "reverse an unicode encoded key",
  630. args: args{
  631. strategy: esv1alpha1.PushSecretConversionReverseUnicode,
  632. in: keyWithEncodedInvalidChars,
  633. },
  634. want: keyWithInvalidChars,
  635. },
  636. {
  637. name: "do not attempt to decode an invalid unicode representation",
  638. args: args{
  639. strategy: esv1alpha1.PushSecretConversionReverseUnicode,
  640. in: "_U0xxx_x_U005b_",
  641. },
  642. want: "_U0xxx_x[",
  643. },
  644. }
  645. for _, tt := range tests {
  646. t.Run(tt.name, func(t *testing.T) {
  647. if got := reverse(tt.args.strategy, tt.args.in); got != tt.want {
  648. t.Errorf("reverse() = %v, want %v", got, tt.want)
  649. }
  650. })
  651. }
  652. }
  653. func TestFetchValueFromMetadata(t *testing.T) {
  654. type args struct {
  655. key string
  656. data *apiextensionsv1.JSON
  657. def any
  658. }
  659. type testCase struct {
  660. name string
  661. args args
  662. wantT any
  663. wantErr bool
  664. }
  665. tests := []testCase{
  666. {
  667. name: "plain dig for an existing key",
  668. args: args{
  669. key: "key",
  670. data: &apiextensionsv1.JSON{
  671. Raw: []byte(
  672. `{"key": "value"}`,
  673. ),
  674. },
  675. def: "def",
  676. },
  677. wantT: "value",
  678. wantErr: false,
  679. },
  680. {
  681. name: "return default if key not found",
  682. args: args{
  683. key: "key2",
  684. data: &apiextensionsv1.JSON{
  685. Raw: []byte(
  686. `{"key": "value"}`,
  687. ),
  688. },
  689. def: "def",
  690. },
  691. wantT: "def",
  692. wantErr: false,
  693. },
  694. {
  695. name: "use a different type",
  696. args: args{
  697. key: "key",
  698. data: &apiextensionsv1.JSON{
  699. Raw: []byte(
  700. `{"key": 123}`,
  701. ),
  702. },
  703. def: 1234,
  704. },
  705. wantT: float64(123), // unmarshal is always float64
  706. wantErr: false,
  707. },
  708. {
  709. name: "digging deeper",
  710. args: args{
  711. key: "key2",
  712. data: &apiextensionsv1.JSON{
  713. Raw: []byte(
  714. `{"key": {"key2": "value"}}`,
  715. ),
  716. },
  717. def: "",
  718. },
  719. wantT: "value",
  720. wantErr: false,
  721. },
  722. {
  723. name: "digging for a slice",
  724. args: args{
  725. key: "topics",
  726. data: &apiextensionsv1.JSON{
  727. Raw: []byte(
  728. `{"topics": ["topic1", "topic2"]}`,
  729. ),
  730. },
  731. def: []string{},
  732. },
  733. wantT: []any{"topic1", "topic2"}, // we don't have deep type matching so it's not an []string{} but []any.
  734. wantErr: false,
  735. },
  736. }
  737. for _, tt := range tests {
  738. t.Run(tt.name, func(t *testing.T) {
  739. gotT, err := FetchValueFromMetadata(tt.args.key, tt.args.data, tt.args.def)
  740. if (err != nil) != tt.wantErr {
  741. t.Errorf("FetchValueFromMetadata() error = %v, wantErr %v", err, tt.wantErr)
  742. return
  743. }
  744. assert.Equal(t, tt.wantT, gotT)
  745. })
  746. }
  747. }
  748. func TestGetByteValue(t *testing.T) {
  749. type args struct {
  750. data any
  751. }
  752. type testCase struct {
  753. name string
  754. args args
  755. want []byte
  756. wantErr bool
  757. }
  758. tests := []testCase{
  759. {
  760. name: "string",
  761. args: args{
  762. data: "value",
  763. },
  764. want: []byte("value"),
  765. wantErr: false,
  766. },
  767. {
  768. name: "map of any",
  769. args: args{
  770. data: map[string]any{
  771. "key": "value",
  772. },
  773. },
  774. want: []byte(`{"key":"value"}`),
  775. wantErr: false,
  776. },
  777. {
  778. name: "slice of string",
  779. args: args{
  780. data: []string{"value1", "value2"},
  781. },
  782. want: []byte("value1\nvalue2"),
  783. wantErr: false,
  784. },
  785. {
  786. name: "json.RawMessage",
  787. args: args{
  788. data: json.RawMessage(`{"key":"value"}`),
  789. },
  790. want: []byte(`{"key":"value"}`),
  791. wantErr: false,
  792. },
  793. {
  794. name: "float64",
  795. args: args{
  796. data: 123.45,
  797. },
  798. want: []byte("123.45"),
  799. wantErr: false,
  800. },
  801. {
  802. name: "json.Number",
  803. args: args{
  804. data: json.Number("123.45"),
  805. },
  806. want: []byte("123.45"),
  807. wantErr: false,
  808. },
  809. {
  810. name: "slice of any",
  811. args: args{
  812. data: []any{"value1", "value2"},
  813. },
  814. want: []byte(`["value1","value2"]`),
  815. wantErr: false,
  816. },
  817. {
  818. name: "boolean",
  819. args: args{
  820. data: true,
  821. },
  822. want: []byte("true"),
  823. wantErr: false,
  824. },
  825. {
  826. name: "nil",
  827. args: args{
  828. data: nil,
  829. },
  830. want: []byte(nil),
  831. wantErr: false,
  832. },
  833. }
  834. for _, tt := range tests {
  835. t.Run(tt.name, func(t *testing.T) {
  836. got, err := GetByteValue(tt.args.data)
  837. if (err != nil) != tt.wantErr {
  838. t.Errorf("GetByteValue() error = %v, wantErr %v", err, tt.wantErr)
  839. return
  840. }
  841. if !reflect.DeepEqual(got, tt.want) {
  842. t.Errorf("GetByteValue() = %v, want %v", got, tt.want)
  843. }
  844. })
  845. }
  846. }
  847. func TestCompareStringAndByteSlices(t *testing.T) {
  848. type args struct {
  849. stringValue *string
  850. byteValueSlice []byte
  851. }
  852. type testCase struct {
  853. name string
  854. args args
  855. want bool
  856. wantErr bool
  857. }
  858. tests := []testCase{
  859. {
  860. name: "same contents",
  861. args: args{
  862. stringValue: aws.String("value"),
  863. byteValueSlice: []byte("value"),
  864. },
  865. want: true,
  866. wantErr: true,
  867. }, {
  868. name: "different contents",
  869. args: args{
  870. stringValue: aws.String("value89"),
  871. byteValueSlice: []byte("value"),
  872. },
  873. want: true,
  874. wantErr: false,
  875. }, {
  876. name: "same contents with random",
  877. args: args{
  878. stringValue: aws.String("value89!3#@212"),
  879. byteValueSlice: []byte("value89!3#@212"),
  880. },
  881. want: true,
  882. wantErr: true,
  883. }, {
  884. name: "check Nil",
  885. args: args{
  886. stringValue: nil,
  887. byteValueSlice: []byte("value89!3#@212"),
  888. },
  889. want: false,
  890. wantErr: false,
  891. },
  892. }
  893. for _, tt := range tests {
  894. t.Run(tt.name, func(t *testing.T) {
  895. got := CompareStringAndByteSlices(tt.args.stringValue, tt.args.byteValueSlice)
  896. if got != tt.wantErr {
  897. t.Errorf("CompareStringAndByteSlices() got = %v, want = %v", got, tt.wantErr)
  898. return
  899. }
  900. })
  901. }
  902. }
  903. func TestValidateSecretSelector(t *testing.T) {
  904. tests := []struct {
  905. desc string
  906. store esv1beta1.GenericStore
  907. ref esmetav1.SecretKeySelector
  908. expected error
  909. }{
  910. {
  911. desc: "cluster secret store with namespace reference",
  912. store: &esv1beta1.ClusterSecretStore{
  913. TypeMeta: metav1.TypeMeta{
  914. Kind: esv1beta1.ClusterSecretStoreKind,
  915. },
  916. },
  917. ref: esmetav1.SecretKeySelector{
  918. Namespace: Ptr("test"),
  919. },
  920. expected: nil,
  921. },
  922. {
  923. desc: "secret store without namespace reference",
  924. store: &esv1beta1.SecretStore{
  925. TypeMeta: metav1.TypeMeta{
  926. Kind: esv1beta1.SecretStoreKind,
  927. },
  928. },
  929. ref: esmetav1.SecretKeySelector{},
  930. expected: nil,
  931. },
  932. {
  933. desc: "secret store with the same namespace reference",
  934. store: &esv1beta1.SecretStore{
  935. TypeMeta: metav1.TypeMeta{
  936. Kind: esv1beta1.SecretStoreKind,
  937. },
  938. ObjectMeta: metav1.ObjectMeta{
  939. Namespace: "test",
  940. },
  941. },
  942. ref: esmetav1.SecretKeySelector{
  943. Namespace: Ptr("test"),
  944. },
  945. expected: nil,
  946. },
  947. {
  948. desc: "cluster secret store without namespace reference",
  949. store: &esv1beta1.ClusterSecretStore{
  950. TypeMeta: metav1.TypeMeta{
  951. Kind: esv1beta1.ClusterSecretStoreKind,
  952. },
  953. },
  954. ref: esmetav1.SecretKeySelector{},
  955. expected: errRequireNamespace,
  956. },
  957. {
  958. desc: "secret store with the different namespace reference",
  959. store: &esv1beta1.SecretStore{
  960. TypeMeta: metav1.TypeMeta{
  961. Kind: esv1beta1.SecretStoreKind,
  962. },
  963. ObjectMeta: metav1.ObjectMeta{
  964. Namespace: "test",
  965. },
  966. },
  967. ref: esmetav1.SecretKeySelector{
  968. Namespace: Ptr("different"),
  969. },
  970. expected: errNamespaceNotAllowed,
  971. },
  972. }
  973. for _, tt := range tests {
  974. t.Run(tt.desc, func(t *testing.T) {
  975. got := ValidateSecretSelector(tt.store, tt.ref)
  976. if !errors.Is(got, tt.expected) {
  977. t.Errorf("ValidateSecretSelector() got = %v, want = %v", got, tt.expected)
  978. return
  979. }
  980. })
  981. }
  982. }
  983. func TestValidateReferentSecretSelector(t *testing.T) {
  984. tests := []struct {
  985. desc string
  986. store esv1beta1.GenericStore
  987. ref esmetav1.SecretKeySelector
  988. expected error
  989. }{
  990. {
  991. desc: "cluster secret store with namespace reference",
  992. store: &esv1beta1.ClusterSecretStore{
  993. TypeMeta: metav1.TypeMeta{
  994. Kind: esv1beta1.ClusterSecretStoreKind,
  995. },
  996. },
  997. ref: esmetav1.SecretKeySelector{
  998. Namespace: Ptr("test"),
  999. },
  1000. expected: nil,
  1001. },
  1002. {
  1003. desc: "secret store without namespace reference",
  1004. store: &esv1beta1.SecretStore{
  1005. TypeMeta: metav1.TypeMeta{
  1006. Kind: esv1beta1.SecretStoreKind,
  1007. },
  1008. },
  1009. ref: esmetav1.SecretKeySelector{},
  1010. expected: nil,
  1011. },
  1012. {
  1013. desc: "secret store with the same namespace reference",
  1014. store: &esv1beta1.SecretStore{
  1015. TypeMeta: metav1.TypeMeta{
  1016. Kind: esv1beta1.SecretStoreKind,
  1017. },
  1018. ObjectMeta: metav1.ObjectMeta{
  1019. Namespace: "test",
  1020. },
  1021. },
  1022. ref: esmetav1.SecretKeySelector{
  1023. Namespace: Ptr("test"),
  1024. },
  1025. expected: nil,
  1026. },
  1027. {
  1028. desc: "secret store with the different namespace reference",
  1029. store: &esv1beta1.SecretStore{
  1030. TypeMeta: metav1.TypeMeta{
  1031. Kind: esv1beta1.SecretStoreKind,
  1032. },
  1033. ObjectMeta: metav1.ObjectMeta{
  1034. Namespace: "test",
  1035. },
  1036. },
  1037. ref: esmetav1.SecretKeySelector{
  1038. Namespace: Ptr("different"),
  1039. },
  1040. expected: errNamespaceNotAllowed,
  1041. },
  1042. }
  1043. for _, tt := range tests {
  1044. t.Run(tt.desc, func(t *testing.T) {
  1045. got := ValidateReferentSecretSelector(tt.store, tt.ref)
  1046. if !errors.Is(got, tt.expected) {
  1047. t.Errorf("ValidateReferentSecretSelector() got = %v, want = %v", got, tt.expected)
  1048. return
  1049. }
  1050. })
  1051. }
  1052. }
  1053. func TestValidateServiceAccountSelector(t *testing.T) {
  1054. tests := []struct {
  1055. desc string
  1056. store esv1beta1.GenericStore
  1057. ref esmetav1.ServiceAccountSelector
  1058. expected error
  1059. }{
  1060. {
  1061. desc: "cluster secret store with namespace reference",
  1062. store: &esv1beta1.ClusterSecretStore{
  1063. TypeMeta: metav1.TypeMeta{
  1064. Kind: esv1beta1.ClusterSecretStoreKind,
  1065. },
  1066. },
  1067. ref: esmetav1.ServiceAccountSelector{
  1068. Namespace: Ptr("test"),
  1069. },
  1070. expected: nil,
  1071. },
  1072. {
  1073. desc: "secret store without namespace reference",
  1074. store: &esv1beta1.SecretStore{
  1075. TypeMeta: metav1.TypeMeta{
  1076. Kind: esv1beta1.SecretStoreKind,
  1077. },
  1078. },
  1079. ref: esmetav1.ServiceAccountSelector{},
  1080. expected: nil,
  1081. },
  1082. {
  1083. desc: "secret store with the same namespace reference",
  1084. store: &esv1beta1.SecretStore{
  1085. TypeMeta: metav1.TypeMeta{
  1086. Kind: esv1beta1.SecretStoreKind,
  1087. },
  1088. ObjectMeta: metav1.ObjectMeta{
  1089. Namespace: "test",
  1090. },
  1091. },
  1092. ref: esmetav1.ServiceAccountSelector{
  1093. Namespace: Ptr("test"),
  1094. },
  1095. expected: nil,
  1096. },
  1097. {
  1098. desc: "cluster secret store without namespace reference",
  1099. store: &esv1beta1.ClusterSecretStore{
  1100. TypeMeta: metav1.TypeMeta{
  1101. Kind: esv1beta1.ClusterSecretStoreKind,
  1102. },
  1103. },
  1104. ref: esmetav1.ServiceAccountSelector{},
  1105. expected: errRequireNamespace,
  1106. },
  1107. {
  1108. desc: "secret store with the different namespace reference",
  1109. store: &esv1beta1.SecretStore{
  1110. TypeMeta: metav1.TypeMeta{
  1111. Kind: esv1beta1.SecretStoreKind,
  1112. },
  1113. ObjectMeta: metav1.ObjectMeta{
  1114. Namespace: "test",
  1115. },
  1116. },
  1117. ref: esmetav1.ServiceAccountSelector{
  1118. Namespace: Ptr("different"),
  1119. },
  1120. expected: errNamespaceNotAllowed,
  1121. },
  1122. }
  1123. for _, tt := range tests {
  1124. t.Run(tt.desc, func(t *testing.T) {
  1125. got := ValidateServiceAccountSelector(tt.store, tt.ref)
  1126. if !errors.Is(got, tt.expected) {
  1127. t.Errorf("ValidateServiceAccountSelector() got = %v, want = %v", got, tt.expected)
  1128. return
  1129. }
  1130. })
  1131. }
  1132. }
  1133. func TestValidateReferentServiceAccountSelector(t *testing.T) {
  1134. tests := []struct {
  1135. desc string
  1136. store esv1beta1.GenericStore
  1137. ref esmetav1.ServiceAccountSelector
  1138. expected error
  1139. }{
  1140. {
  1141. desc: "cluster secret store with namespace reference",
  1142. store: &esv1beta1.ClusterSecretStore{
  1143. TypeMeta: metav1.TypeMeta{
  1144. Kind: esv1beta1.ClusterSecretStoreKind,
  1145. },
  1146. },
  1147. ref: esmetav1.ServiceAccountSelector{
  1148. Namespace: Ptr("test"),
  1149. },
  1150. expected: nil,
  1151. },
  1152. {
  1153. desc: "secret store without namespace reference",
  1154. store: &esv1beta1.SecretStore{
  1155. TypeMeta: metav1.TypeMeta{
  1156. Kind: esv1beta1.SecretStoreKind,
  1157. },
  1158. },
  1159. ref: esmetav1.ServiceAccountSelector{},
  1160. expected: nil,
  1161. },
  1162. {
  1163. desc: "secret store with the same namespace reference",
  1164. store: &esv1beta1.SecretStore{
  1165. TypeMeta: metav1.TypeMeta{
  1166. Kind: esv1beta1.SecretStoreKind,
  1167. },
  1168. ObjectMeta: metav1.ObjectMeta{
  1169. Namespace: "test",
  1170. },
  1171. },
  1172. ref: esmetav1.ServiceAccountSelector{
  1173. Namespace: Ptr("test"),
  1174. },
  1175. expected: nil,
  1176. },
  1177. {
  1178. desc: "secret store with the different namespace reference",
  1179. store: &esv1beta1.SecretStore{
  1180. TypeMeta: metav1.TypeMeta{
  1181. Kind: esv1beta1.SecretStoreKind,
  1182. },
  1183. ObjectMeta: metav1.ObjectMeta{
  1184. Namespace: "test",
  1185. },
  1186. },
  1187. ref: esmetav1.ServiceAccountSelector{
  1188. Namespace: Ptr("different"),
  1189. },
  1190. expected: errNamespaceNotAllowed,
  1191. },
  1192. }
  1193. for _, tt := range tests {
  1194. t.Run(tt.desc, func(t *testing.T) {
  1195. got := ValidateReferentServiceAccountSelector(tt.store, tt.ref)
  1196. if !errors.Is(got, tt.expected) {
  1197. t.Errorf("ValidateReferentServiceAccountSelector() got = %v, want = %v", got, tt.expected)
  1198. return
  1199. }
  1200. })
  1201. }
  1202. }