utils_test.go 33 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415
  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-v2/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. esv1 "github.com/external-secrets/external-secrets/apis/externalsecrets/v1"
  26. esv1alpha1 "github.com/external-secrets/external-secrets/apis/externalsecrets/v1alpha1"
  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: "c461202a18e99215f121936fb2452e03843828e448a00a53f285a6fc",
  47. },
  48. {
  49. name: "We accept a simple scalar value, i.e. string",
  50. input: "hello there",
  51. want: "f78681ec611ebaeea0689bff6c7812a83ff98a7faba986d9af76c999",
  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: "9c717e13e4281db3cdad3f56c6e7faab1d7029c4b4fbbf12fbec9b1e",
  59. },
  60. {
  61. name: "map also works",
  62. input: map[string][]byte{
  63. "foo": []byte("value1"),
  64. "bar": []byte("value2"),
  65. },
  66. want: "1bed8bcbcb4547ffe19a19cd47d9078e84aa6598266d86b99f992d64",
  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 esv1.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: esv1.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: esv1.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: esv1.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: esv1.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 esv1.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: esv1.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: esv1.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: esv1.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 esv1.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: esv1.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: esv1.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: esv1.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: esv1.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: esv1.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: esv1.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 []esv1.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: "using double merge",
  420. args: args{
  421. operations: []esv1.ExternalSecretRewrite{
  422. {
  423. Merge: &esv1.ExternalSecretRewriteMerge{
  424. Strategy: esv1.ExternalSecretRewriteMergeStrategyJSON,
  425. ConflictPolicy: esv1.ExternalSecretRewriteMergeConflictPolicyIgnore,
  426. Into: "merged",
  427. Priority: []string{"a"},
  428. },
  429. },
  430. {
  431. Merge: &esv1.ExternalSecretRewriteMerge{
  432. Strategy: esv1.ExternalSecretRewriteMergeStrategyExtract,
  433. ConflictPolicy: esv1.ExternalSecretRewriteMergeConflictPolicyIgnore,
  434. Priority: []string{"b"},
  435. },
  436. },
  437. },
  438. in: map[string][]byte{
  439. "a": []byte(`{"host": "dba", "pass": "yola", "port": 123}`),
  440. "b": []byte(`{"host": "dbb", "pass": "yolb"}`),
  441. },
  442. },
  443. want: map[string][]byte{
  444. "host": []byte("dbb"),
  445. "pass": []byte("yolb"),
  446. "port": []byte("123"),
  447. },
  448. },
  449. {
  450. name: "using regexp and merge",
  451. args: args{
  452. operations: []esv1.ExternalSecretRewrite{
  453. {
  454. Regexp: &esv1.ExternalSecretRewriteRegexp{
  455. Source: "db/(.*)",
  456. Target: "$1",
  457. },
  458. },
  459. {
  460. Merge: &esv1.ExternalSecretRewriteMerge{
  461. Strategy: esv1.ExternalSecretRewriteMergeStrategyJSON,
  462. ConflictPolicy: esv1.ExternalSecretRewriteMergeConflictPolicyIgnore,
  463. Into: "merged",
  464. Priority: []string{"a"},
  465. },
  466. },
  467. },
  468. in: map[string][]byte{
  469. "db/a": []byte(`{"host": "dba.example.com"}`),
  470. "db/b": []byte(`{"host": "dbb.example.com", "pass": "yolo"}`),
  471. },
  472. },
  473. want: map[string][]byte{
  474. "a": []byte(`{"host": "dba.example.com"}`),
  475. "b": []byte(`{"host": "dbb.example.com", "pass": "yolo"}`),
  476. "merged": []byte(`{"host":"dba.example.com","pass":"yolo"}`),
  477. },
  478. },
  479. {
  480. name: "replace of a single key",
  481. args: args{
  482. operations: []esv1.ExternalSecretRewrite{
  483. {
  484. Regexp: &esv1.ExternalSecretRewriteRegexp{
  485. Source: "-",
  486. Target: "_",
  487. },
  488. },
  489. },
  490. in: map[string][]byte{
  491. "foo-bar": []byte("bar"),
  492. },
  493. },
  494. want: map[string][]byte{
  495. "foo_bar": []byte("bar"),
  496. },
  497. },
  498. {
  499. name: "no operation",
  500. args: args{
  501. operations: []esv1.ExternalSecretRewrite{
  502. {
  503. Regexp: &esv1.ExternalSecretRewriteRegexp{
  504. Source: "hello",
  505. Target: "world",
  506. },
  507. },
  508. },
  509. in: map[string][]byte{
  510. "foo": []byte("bar"),
  511. },
  512. },
  513. want: map[string][]byte{
  514. "foo": []byte("bar"),
  515. },
  516. },
  517. {
  518. name: "removing prefix from keys",
  519. args: args{
  520. operations: []esv1.ExternalSecretRewrite{
  521. {
  522. Regexp: &esv1.ExternalSecretRewriteRegexp{
  523. Source: "^my/initial/path/",
  524. Target: "",
  525. },
  526. },
  527. },
  528. in: map[string][]byte{
  529. "my/initial/path/foo": []byte("bar"),
  530. },
  531. },
  532. want: map[string][]byte{
  533. "foo": []byte("bar"),
  534. },
  535. },
  536. {
  537. name: "using un-named capture groups",
  538. args: args{
  539. operations: []esv1.ExternalSecretRewrite{
  540. {
  541. Regexp: &esv1.ExternalSecretRewriteRegexp{
  542. Source: "f(.*)o",
  543. Target: "a_new_path_$1",
  544. },
  545. },
  546. },
  547. in: map[string][]byte{
  548. "foo": []byte("bar"),
  549. "foodaloo": []byte("barr"),
  550. },
  551. },
  552. want: map[string][]byte{
  553. "a_new_path_o": []byte("bar"),
  554. "a_new_path_oodalo": []byte("barr"),
  555. },
  556. },
  557. {
  558. name: "using named and numbered capture groups",
  559. args: args{
  560. operations: []esv1.ExternalSecretRewrite{
  561. {
  562. Regexp: &esv1.ExternalSecretRewriteRegexp{
  563. Source: "f(?P<content>.*)o",
  564. Target: "a_new_path_${content}_${1}",
  565. },
  566. },
  567. },
  568. in: map[string][]byte{
  569. "foo": []byte("bar"),
  570. "floo": []byte("barr"),
  571. },
  572. },
  573. want: map[string][]byte{
  574. "a_new_path_o_o": []byte("bar"),
  575. "a_new_path_lo_lo": []byte("barr"),
  576. },
  577. },
  578. {
  579. name: "using sequenced rewrite operations",
  580. args: args{
  581. operations: []esv1.ExternalSecretRewrite{
  582. {
  583. Regexp: &esv1.ExternalSecretRewriteRegexp{
  584. Source: "my/(.*?)/bar/(.*)",
  585. Target: "$1-$2",
  586. },
  587. },
  588. {
  589. Regexp: &esv1.ExternalSecretRewriteRegexp{
  590. Source: "-",
  591. Target: "_",
  592. },
  593. },
  594. {
  595. Regexp: &esv1.ExternalSecretRewriteRegexp{
  596. Source: "ass",
  597. Target: "***",
  598. },
  599. },
  600. },
  601. in: map[string][]byte{
  602. "my/app/bar/key": []byte("bar"),
  603. "my/app/bar/password": []byte("barr"),
  604. },
  605. },
  606. want: map[string][]byte{
  607. "app_key": []byte("bar"),
  608. "app_p***word": []byte("barr"),
  609. },
  610. },
  611. {
  612. name: "using transform rewrite operation to create env var format keys",
  613. args: args{
  614. operations: []esv1.ExternalSecretRewrite{
  615. {
  616. Regexp: &esv1.ExternalSecretRewriteRegexp{
  617. Source: "my/(.*?)/bar/(.*)",
  618. Target: "$1-$2",
  619. },
  620. },
  621. {
  622. Transform: &esv1.ExternalSecretRewriteTransform{
  623. Template: `{{ .value | upper | replace "-" "_" }}`,
  624. },
  625. },
  626. },
  627. in: map[string][]byte{
  628. "my/app/bar/key": []byte("bar"),
  629. },
  630. },
  631. want: map[string][]byte{
  632. "APP_KEY": []byte("bar"),
  633. },
  634. },
  635. }
  636. for _, tt := range tests {
  637. t.Run(tt.name, func(t *testing.T) {
  638. got, err := RewriteMap(tt.args.operations, tt.args.in)
  639. if (err != nil) != tt.wantErr {
  640. t.Errorf("RewriteMap() error = %v, wantErr %v", err, tt.wantErr)
  641. return
  642. }
  643. if !reflect.DeepEqual(got, tt.want) {
  644. t.Errorf("RewriteMap() = %v, want %v", got, tt.want)
  645. }
  646. })
  647. }
  648. }
  649. func TestRewriteMerge(t *testing.T) {
  650. type args struct {
  651. operation esv1.ExternalSecretRewriteMerge
  652. in map[string][]byte
  653. }
  654. tests := []struct {
  655. name string
  656. args args
  657. want map[string][]byte
  658. wantErr bool
  659. }{
  660. {
  661. name: "using empty merge",
  662. args: args{
  663. operation: esv1.ExternalSecretRewriteMerge{},
  664. in: map[string][]byte{
  665. "mongo-credentials": []byte(`{"username": "foz", "password": "baz"}`),
  666. "redis-credentials": []byte(`{"host": "redis.example.com", "port": "6379"}`),
  667. },
  668. },
  669. want: map[string][]byte{
  670. "username": []byte("foz"),
  671. "password": []byte("baz"),
  672. "host": []byte("redis.example.com"),
  673. "port": []byte("6379"),
  674. },
  675. wantErr: false,
  676. },
  677. {
  678. name: "using priority",
  679. args: args{
  680. operation: esv1.ExternalSecretRewriteMerge{
  681. ConflictPolicy: esv1.ExternalSecretRewriteMergeConflictPolicyIgnore,
  682. Priority: []string{"mongo-credentials", "redis-credentials"},
  683. },
  684. in: map[string][]byte{
  685. "redis-credentials": []byte(`{"host": "redis.example.com", "port": "6379"}`),
  686. "mongo-credentials": []byte(`{"username": "foz", "password": "baz"}`),
  687. "other-credentials": []byte(`{"key": "value", "host": "other.example.com"}`),
  688. },
  689. },
  690. want: map[string][]byte{
  691. "username": []byte("foz"),
  692. "password": []byte("baz"),
  693. "host": []byte("redis.example.com"),
  694. "port": []byte("6379"),
  695. "key": []byte("value"),
  696. },
  697. wantErr: false,
  698. },
  699. {
  700. name: "using priority with keys not in input",
  701. args: args{
  702. operation: esv1.ExternalSecretRewriteMerge{
  703. ConflictPolicy: esv1.ExternalSecretRewriteMergeConflictPolicyIgnore,
  704. Priority: []string{"non-existent-key", "another-missing-key", "mongo-credentials"},
  705. },
  706. in: map[string][]byte{
  707. "mongo-credentials": []byte(`{"username": "foz", "password": "baz"}`),
  708. "redis-credentials": []byte(`{"host": "redis.example.com", "port": "6379"}`),
  709. },
  710. },
  711. want: nil,
  712. wantErr: true,
  713. },
  714. {
  715. name: "using conflict policy error",
  716. args: args{
  717. operation: esv1.ExternalSecretRewriteMerge{
  718. ConflictPolicy: esv1.ExternalSecretRewriteMergeConflictPolicyError,
  719. },
  720. in: map[string][]byte{
  721. "mongo-credentials": []byte(`{"username": "foz", "password": "baz"}`),
  722. "redis-credentials": []byte(`{"username": "redis", "port": "6379"}`),
  723. },
  724. },
  725. want: nil,
  726. wantErr: true,
  727. },
  728. {
  729. name: "using JSON strategy",
  730. args: args{
  731. operation: esv1.ExternalSecretRewriteMerge{
  732. Strategy: esv1.ExternalSecretRewriteMergeStrategyJSON,
  733. Into: "credentials",
  734. },
  735. in: map[string][]byte{
  736. "mongo-credentials": []byte(`{"username": "foz", "password": "baz"}`),
  737. "redis-credentials": []byte(`{"host": "redis.example.com", "port": "6379"}`),
  738. },
  739. },
  740. want: map[string][]byte{
  741. "mongo-credentials": []byte(`{"username": "foz", "password": "baz"}`),
  742. "redis-credentials": []byte(`{"host": "redis.example.com", "port": "6379"}`),
  743. "credentials": func() []byte {
  744. expected := map[string]interface{}{
  745. "username": "foz",
  746. "password": "baz",
  747. "host": "redis.example.com",
  748. "port": "6379",
  749. }
  750. b, _ := json.Marshal(expected)
  751. return b
  752. }(),
  753. },
  754. wantErr: false,
  755. },
  756. {
  757. name: "using JSON strategy without into",
  758. args: args{
  759. operation: esv1.ExternalSecretRewriteMerge{
  760. Strategy: esv1.ExternalSecretRewriteMergeStrategyJSON,
  761. },
  762. in: map[string][]byte{
  763. "mongo-credentials": []byte(`{"username": "foz", "password": "baz"}`),
  764. "redis-credentials": []byte(`{"host": "redis.example.com", "port": "6379"}`),
  765. },
  766. },
  767. want: nil,
  768. wantErr: true,
  769. },
  770. {
  771. name: "with invalid JSON",
  772. args: args{
  773. operation: esv1.ExternalSecretRewriteMerge{},
  774. in: map[string][]byte{
  775. "invalid-json": []byte(`{"username": "foz", "password": "baz"`),
  776. },
  777. },
  778. want: nil,
  779. wantErr: true,
  780. },
  781. }
  782. for _, tt := range tests {
  783. t.Run(tt.name, func(t *testing.T) {
  784. got, err := RewriteMerge(tt.args.operation, tt.args.in)
  785. if (err != nil) != tt.wantErr {
  786. t.Errorf("RewriteMerge() error = %v, wantErr %v", err, tt.wantErr)
  787. return
  788. }
  789. if !reflect.DeepEqual(got, tt.want) {
  790. t.Errorf("RewriteMerge() = %v, want %v", got, tt.want)
  791. }
  792. })
  793. }
  794. }
  795. func TestReverse(t *testing.T) {
  796. type args struct {
  797. strategy esv1alpha1.PushSecretConversionStrategy
  798. in string
  799. }
  800. tests := []struct {
  801. name string
  802. args args
  803. want string
  804. }{
  805. {
  806. name: "do not change the key when using the None strategy",
  807. args: args{
  808. strategy: esv1alpha1.PushSecretConversionNone,
  809. in: keyWithEncodedInvalidChars,
  810. },
  811. want: keyWithEncodedInvalidChars,
  812. },
  813. {
  814. name: "reverse an unicode encoded key",
  815. args: args{
  816. strategy: esv1alpha1.PushSecretConversionReverseUnicode,
  817. in: keyWithEncodedInvalidChars,
  818. },
  819. want: keyWithInvalidChars,
  820. },
  821. {
  822. name: "do not attempt to decode an invalid unicode representation",
  823. args: args{
  824. strategy: esv1alpha1.PushSecretConversionReverseUnicode,
  825. in: "_U0xxx_x_U005b_",
  826. },
  827. want: "_U0xxx_x[",
  828. },
  829. }
  830. for _, tt := range tests {
  831. t.Run(tt.name, func(t *testing.T) {
  832. if got := reverse(tt.args.strategy, tt.args.in); got != tt.want {
  833. t.Errorf("reverse() = %v, want %v", got, tt.want)
  834. }
  835. })
  836. }
  837. }
  838. func TestFetchValueFromMetadata(t *testing.T) {
  839. type args struct {
  840. key string
  841. data *apiextensionsv1.JSON
  842. def any
  843. }
  844. type testCase struct {
  845. name string
  846. args args
  847. wantT any
  848. wantErr bool
  849. }
  850. tests := []testCase{
  851. {
  852. name: "plain dig for an existing key",
  853. args: args{
  854. key: "key",
  855. data: &apiextensionsv1.JSON{
  856. Raw: []byte(
  857. `{"key": "value"}`,
  858. ),
  859. },
  860. def: "def",
  861. },
  862. wantT: "value",
  863. wantErr: false,
  864. },
  865. {
  866. name: "return default if key not found",
  867. args: args{
  868. key: "key2",
  869. data: &apiextensionsv1.JSON{
  870. Raw: []byte(
  871. `{"key": "value"}`,
  872. ),
  873. },
  874. def: "def",
  875. },
  876. wantT: "def",
  877. wantErr: false,
  878. },
  879. {
  880. name: "use a different type",
  881. args: args{
  882. key: "key",
  883. data: &apiextensionsv1.JSON{
  884. Raw: []byte(
  885. `{"key": 123}`,
  886. ),
  887. },
  888. def: 1234,
  889. },
  890. wantT: float64(123), // unmarshal is always float64
  891. wantErr: false,
  892. },
  893. {
  894. name: "digging deeper",
  895. args: args{
  896. key: "key2",
  897. data: &apiextensionsv1.JSON{
  898. Raw: []byte(
  899. `{"key": {"key2": "value"}}`,
  900. ),
  901. },
  902. def: "",
  903. },
  904. wantT: "value",
  905. wantErr: false,
  906. },
  907. {
  908. name: "digging for a slice",
  909. args: args{
  910. key: "topics",
  911. data: &apiextensionsv1.JSON{
  912. Raw: []byte(
  913. `{"topics": ["topic1", "topic2"]}`,
  914. ),
  915. },
  916. def: []string{},
  917. },
  918. wantT: []any{"topic1", "topic2"}, // we don't have deep type matching so it's not an []string{} but []any.
  919. wantErr: false,
  920. },
  921. }
  922. for _, tt := range tests {
  923. t.Run(tt.name, func(t *testing.T) {
  924. gotT, err := FetchValueFromMetadata(tt.args.key, tt.args.data, tt.args.def)
  925. if (err != nil) != tt.wantErr {
  926. t.Errorf("FetchValueFromMetadata() error = %v, wantErr %v", err, tt.wantErr)
  927. return
  928. }
  929. assert.Equal(t, tt.wantT, gotT)
  930. })
  931. }
  932. }
  933. func TestGetByteValue(t *testing.T) {
  934. type args struct {
  935. data any
  936. }
  937. type testCase struct {
  938. name string
  939. args args
  940. want []byte
  941. wantErr bool
  942. }
  943. tests := []testCase{
  944. {
  945. name: "string",
  946. args: args{
  947. data: "value",
  948. },
  949. want: []byte("value"),
  950. wantErr: false,
  951. },
  952. {
  953. name: "map of any",
  954. args: args{
  955. data: map[string]any{
  956. "key": "value",
  957. },
  958. },
  959. want: []byte(`{"key":"value"}`),
  960. wantErr: false,
  961. },
  962. {
  963. name: "slice of string",
  964. args: args{
  965. data: []string{"value1", "value2"},
  966. },
  967. want: []byte("value1\nvalue2"),
  968. wantErr: false,
  969. },
  970. {
  971. name: "json.RawMessage",
  972. args: args{
  973. data: json.RawMessage(`{"key":"value"}`),
  974. },
  975. want: []byte(`{"key":"value"}`),
  976. wantErr: false,
  977. },
  978. {
  979. name: "float64",
  980. args: args{
  981. data: 123.45,
  982. },
  983. want: []byte("123.45"),
  984. wantErr: false,
  985. },
  986. {
  987. name: "json.Number",
  988. args: args{
  989. data: json.Number("123.45"),
  990. },
  991. want: []byte("123.45"),
  992. wantErr: false,
  993. },
  994. {
  995. name: "slice of any",
  996. args: args{
  997. data: []any{"value1", "value2"},
  998. },
  999. want: []byte(`["value1","value2"]`),
  1000. wantErr: false,
  1001. },
  1002. {
  1003. name: "boolean",
  1004. args: args{
  1005. data: true,
  1006. },
  1007. want: []byte("true"),
  1008. wantErr: false,
  1009. },
  1010. {
  1011. name: "nil",
  1012. args: args{
  1013. data: nil,
  1014. },
  1015. want: []byte(nil),
  1016. wantErr: false,
  1017. },
  1018. }
  1019. for _, tt := range tests {
  1020. t.Run(tt.name, func(t *testing.T) {
  1021. got, err := GetByteValue(tt.args.data)
  1022. if (err != nil) != tt.wantErr {
  1023. t.Errorf("GetByteValue() error = %v, wantErr %v", err, tt.wantErr)
  1024. return
  1025. }
  1026. if !reflect.DeepEqual(got, tt.want) {
  1027. t.Errorf("GetByteValue() = %v, want %v", got, tt.want)
  1028. }
  1029. })
  1030. }
  1031. }
  1032. func TestCompareStringAndByteSlices(t *testing.T) {
  1033. type args struct {
  1034. stringValue *string
  1035. byteValueSlice []byte
  1036. }
  1037. type testCase struct {
  1038. name string
  1039. args args
  1040. want bool
  1041. wantErr bool
  1042. }
  1043. tests := []testCase{
  1044. {
  1045. name: "same contents",
  1046. args: args{
  1047. stringValue: aws.String("value"),
  1048. byteValueSlice: []byte("value"),
  1049. },
  1050. want: true,
  1051. wantErr: true,
  1052. }, {
  1053. name: "different contents",
  1054. args: args{
  1055. stringValue: aws.String("value89"),
  1056. byteValueSlice: []byte("value"),
  1057. },
  1058. want: true,
  1059. wantErr: false,
  1060. }, {
  1061. name: "same contents with random",
  1062. args: args{
  1063. stringValue: aws.String("value89!3#@212"),
  1064. byteValueSlice: []byte("value89!3#@212"),
  1065. },
  1066. want: true,
  1067. wantErr: true,
  1068. }, {
  1069. name: "check Nil",
  1070. args: args{
  1071. stringValue: nil,
  1072. byteValueSlice: []byte("value89!3#@212"),
  1073. },
  1074. want: false,
  1075. wantErr: false,
  1076. },
  1077. }
  1078. for _, tt := range tests {
  1079. t.Run(tt.name, func(t *testing.T) {
  1080. got := CompareStringAndByteSlices(tt.args.stringValue, tt.args.byteValueSlice)
  1081. if got != tt.wantErr {
  1082. t.Errorf("CompareStringAndByteSlices() got = %v, want = %v", got, tt.wantErr)
  1083. return
  1084. }
  1085. })
  1086. }
  1087. }
  1088. func TestValidateSecretSelector(t *testing.T) {
  1089. tests := []struct {
  1090. desc string
  1091. store esv1.GenericStore
  1092. ref esmetav1.SecretKeySelector
  1093. expected error
  1094. }{
  1095. {
  1096. desc: "cluster secret store with namespace reference",
  1097. store: &esv1.ClusterSecretStore{
  1098. TypeMeta: metav1.TypeMeta{
  1099. Kind: esv1.ClusterSecretStoreKind,
  1100. },
  1101. },
  1102. ref: esmetav1.SecretKeySelector{
  1103. Namespace: Ptr("test"),
  1104. },
  1105. expected: nil,
  1106. },
  1107. {
  1108. desc: "secret store without namespace reference",
  1109. store: &esv1.SecretStore{
  1110. TypeMeta: metav1.TypeMeta{
  1111. Kind: esv1.SecretStoreKind,
  1112. },
  1113. },
  1114. ref: esmetav1.SecretKeySelector{},
  1115. expected: nil,
  1116. },
  1117. {
  1118. desc: "secret store with the same namespace reference",
  1119. store: &esv1.SecretStore{
  1120. TypeMeta: metav1.TypeMeta{
  1121. Kind: esv1.SecretStoreKind,
  1122. },
  1123. ObjectMeta: metav1.ObjectMeta{
  1124. Namespace: "test",
  1125. },
  1126. },
  1127. ref: esmetav1.SecretKeySelector{
  1128. Namespace: Ptr("test"),
  1129. },
  1130. expected: nil,
  1131. },
  1132. {
  1133. desc: "cluster secret store without namespace reference",
  1134. store: &esv1.ClusterSecretStore{
  1135. TypeMeta: metav1.TypeMeta{
  1136. Kind: esv1.ClusterSecretStoreKind,
  1137. },
  1138. },
  1139. ref: esmetav1.SecretKeySelector{},
  1140. expected: errRequireNamespace,
  1141. },
  1142. {
  1143. desc: "secret store with the different namespace reference",
  1144. store: &esv1.SecretStore{
  1145. TypeMeta: metav1.TypeMeta{
  1146. Kind: esv1.SecretStoreKind,
  1147. },
  1148. ObjectMeta: metav1.ObjectMeta{
  1149. Namespace: "test",
  1150. },
  1151. },
  1152. ref: esmetav1.SecretKeySelector{
  1153. Namespace: Ptr("different"),
  1154. },
  1155. expected: errNamespaceNotAllowed,
  1156. },
  1157. }
  1158. for _, tt := range tests {
  1159. t.Run(tt.desc, func(t *testing.T) {
  1160. got := ValidateSecretSelector(tt.store, tt.ref)
  1161. if !errors.Is(got, tt.expected) {
  1162. t.Errorf("ValidateSecretSelector() got = %v, want = %v", got, tt.expected)
  1163. return
  1164. }
  1165. })
  1166. }
  1167. }
  1168. func TestValidateReferentSecretSelector(t *testing.T) {
  1169. tests := []struct {
  1170. desc string
  1171. store esv1.GenericStore
  1172. ref esmetav1.SecretKeySelector
  1173. expected error
  1174. }{
  1175. {
  1176. desc: "cluster secret store with namespace reference",
  1177. store: &esv1.ClusterSecretStore{
  1178. TypeMeta: metav1.TypeMeta{
  1179. Kind: esv1.ClusterSecretStoreKind,
  1180. },
  1181. },
  1182. ref: esmetav1.SecretKeySelector{
  1183. Namespace: Ptr("test"),
  1184. },
  1185. expected: nil,
  1186. },
  1187. {
  1188. desc: "secret store without namespace reference",
  1189. store: &esv1.SecretStore{
  1190. TypeMeta: metav1.TypeMeta{
  1191. Kind: esv1.SecretStoreKind,
  1192. },
  1193. },
  1194. ref: esmetav1.SecretKeySelector{},
  1195. expected: nil,
  1196. },
  1197. {
  1198. desc: "secret store with the same namespace reference",
  1199. store: &esv1.SecretStore{
  1200. TypeMeta: metav1.TypeMeta{
  1201. Kind: esv1.SecretStoreKind,
  1202. },
  1203. ObjectMeta: metav1.ObjectMeta{
  1204. Namespace: "test",
  1205. },
  1206. },
  1207. ref: esmetav1.SecretKeySelector{
  1208. Namespace: Ptr("test"),
  1209. },
  1210. expected: nil,
  1211. },
  1212. {
  1213. desc: "secret store with the different namespace reference",
  1214. store: &esv1.SecretStore{
  1215. TypeMeta: metav1.TypeMeta{
  1216. Kind: esv1.SecretStoreKind,
  1217. },
  1218. ObjectMeta: metav1.ObjectMeta{
  1219. Namespace: "test",
  1220. },
  1221. },
  1222. ref: esmetav1.SecretKeySelector{
  1223. Namespace: Ptr("different"),
  1224. },
  1225. expected: errNamespaceNotAllowed,
  1226. },
  1227. }
  1228. for _, tt := range tests {
  1229. t.Run(tt.desc, func(t *testing.T) {
  1230. got := ValidateReferentSecretSelector(tt.store, tt.ref)
  1231. if !errors.Is(got, tt.expected) {
  1232. t.Errorf("ValidateReferentSecretSelector() got = %v, want = %v", got, tt.expected)
  1233. return
  1234. }
  1235. })
  1236. }
  1237. }
  1238. func TestValidateServiceAccountSelector(t *testing.T) {
  1239. tests := []struct {
  1240. desc string
  1241. store esv1.GenericStore
  1242. ref esmetav1.ServiceAccountSelector
  1243. expected error
  1244. }{
  1245. {
  1246. desc: "cluster secret store with namespace reference",
  1247. store: &esv1.ClusterSecretStore{
  1248. TypeMeta: metav1.TypeMeta{
  1249. Kind: esv1.ClusterSecretStoreKind,
  1250. },
  1251. },
  1252. ref: esmetav1.ServiceAccountSelector{
  1253. Namespace: Ptr("test"),
  1254. },
  1255. expected: nil,
  1256. },
  1257. {
  1258. desc: "secret store without namespace reference",
  1259. store: &esv1.SecretStore{
  1260. TypeMeta: metav1.TypeMeta{
  1261. Kind: esv1.SecretStoreKind,
  1262. },
  1263. },
  1264. ref: esmetav1.ServiceAccountSelector{},
  1265. expected: nil,
  1266. },
  1267. {
  1268. desc: "secret store with the same namespace reference",
  1269. store: &esv1.SecretStore{
  1270. TypeMeta: metav1.TypeMeta{
  1271. Kind: esv1.SecretStoreKind,
  1272. },
  1273. ObjectMeta: metav1.ObjectMeta{
  1274. Namespace: "test",
  1275. },
  1276. },
  1277. ref: esmetav1.ServiceAccountSelector{
  1278. Namespace: Ptr("test"),
  1279. },
  1280. expected: nil,
  1281. },
  1282. {
  1283. desc: "cluster secret store without namespace reference",
  1284. store: &esv1.ClusterSecretStore{
  1285. TypeMeta: metav1.TypeMeta{
  1286. Kind: esv1.ClusterSecretStoreKind,
  1287. },
  1288. },
  1289. ref: esmetav1.ServiceAccountSelector{},
  1290. expected: errRequireNamespace,
  1291. },
  1292. {
  1293. desc: "secret store with the different namespace reference",
  1294. store: &esv1.SecretStore{
  1295. TypeMeta: metav1.TypeMeta{
  1296. Kind: esv1.SecretStoreKind,
  1297. },
  1298. ObjectMeta: metav1.ObjectMeta{
  1299. Namespace: "test",
  1300. },
  1301. },
  1302. ref: esmetav1.ServiceAccountSelector{
  1303. Namespace: Ptr("different"),
  1304. },
  1305. expected: errNamespaceNotAllowed,
  1306. },
  1307. }
  1308. for _, tt := range tests {
  1309. t.Run(tt.desc, func(t *testing.T) {
  1310. got := ValidateServiceAccountSelector(tt.store, tt.ref)
  1311. if !errors.Is(got, tt.expected) {
  1312. t.Errorf("ValidateServiceAccountSelector() got = %v, want = %v", got, tt.expected)
  1313. return
  1314. }
  1315. })
  1316. }
  1317. }
  1318. func TestValidateReferentServiceAccountSelector(t *testing.T) {
  1319. tests := []struct {
  1320. desc string
  1321. store esv1.GenericStore
  1322. ref esmetav1.ServiceAccountSelector
  1323. expected error
  1324. }{
  1325. {
  1326. desc: "cluster secret store with namespace reference",
  1327. store: &esv1.ClusterSecretStore{
  1328. TypeMeta: metav1.TypeMeta{
  1329. Kind: esv1.ClusterSecretStoreKind,
  1330. },
  1331. },
  1332. ref: esmetav1.ServiceAccountSelector{
  1333. Namespace: Ptr("test"),
  1334. },
  1335. expected: nil,
  1336. },
  1337. {
  1338. desc: "secret store without namespace reference",
  1339. store: &esv1.SecretStore{
  1340. TypeMeta: metav1.TypeMeta{
  1341. Kind: esv1.SecretStoreKind,
  1342. },
  1343. },
  1344. ref: esmetav1.ServiceAccountSelector{},
  1345. expected: nil,
  1346. },
  1347. {
  1348. desc: "secret store with the same namespace reference",
  1349. store: &esv1.SecretStore{
  1350. TypeMeta: metav1.TypeMeta{
  1351. Kind: esv1.SecretStoreKind,
  1352. },
  1353. ObjectMeta: metav1.ObjectMeta{
  1354. Namespace: "test",
  1355. },
  1356. },
  1357. ref: esmetav1.ServiceAccountSelector{
  1358. Namespace: Ptr("test"),
  1359. },
  1360. expected: nil,
  1361. },
  1362. {
  1363. desc: "secret store with the different namespace reference",
  1364. store: &esv1.SecretStore{
  1365. TypeMeta: metav1.TypeMeta{
  1366. Kind: esv1.SecretStoreKind,
  1367. },
  1368. ObjectMeta: metav1.ObjectMeta{
  1369. Namespace: "test",
  1370. },
  1371. },
  1372. ref: esmetav1.ServiceAccountSelector{
  1373. Namespace: Ptr("different"),
  1374. },
  1375. expected: errNamespaceNotAllowed,
  1376. },
  1377. }
  1378. for _, tt := range tests {
  1379. t.Run(tt.desc, func(t *testing.T) {
  1380. got := ValidateReferentServiceAccountSelector(tt.store, tt.ref)
  1381. if !errors.Is(got, tt.expected) {
  1382. t.Errorf("ValidateReferentServiceAccountSelector() got = %v, want = %v", got, tt.expected)
  1383. return
  1384. }
  1385. })
  1386. }
  1387. }