secretsmanager_test.go 46 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421
  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 secretsmanager
  13. import (
  14. "context"
  15. "errors"
  16. "fmt"
  17. "reflect"
  18. "strings"
  19. "testing"
  20. "time"
  21. "github.com/aws/aws-sdk-go/aws"
  22. "github.com/aws/aws-sdk-go/aws/awserr"
  23. "github.com/aws/aws-sdk-go/aws/credentials"
  24. "github.com/aws/aws-sdk-go/aws/request"
  25. "github.com/aws/aws-sdk-go/aws/session"
  26. awssm "github.com/aws/aws-sdk-go/service/secretsmanager"
  27. "github.com/google/go-cmp/cmp"
  28. "github.com/stretchr/testify/assert"
  29. corev1 "k8s.io/api/core/v1"
  30. apiextensionsv1 "k8s.io/apiextensions-apiserver/pkg/apis/apiextensions/v1"
  31. metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
  32. "k8s.io/utils/ptr"
  33. esv1beta1 "github.com/external-secrets/external-secrets/apis/externalsecrets/v1beta1"
  34. fakesm "github.com/external-secrets/external-secrets/pkg/provider/aws/secretsmanager/fake"
  35. "github.com/external-secrets/external-secrets/pkg/provider/aws/util"
  36. "github.com/external-secrets/external-secrets/pkg/provider/testing/fake"
  37. )
  38. type secretsManagerTestCase struct {
  39. fakeClient *fakesm.Client
  40. apiInput *awssm.GetSecretValueInput
  41. apiOutput *awssm.GetSecretValueOutput
  42. remoteRef *esv1beta1.ExternalSecretDataRemoteRef
  43. apiErr error
  44. expectError string
  45. expectedSecret string
  46. // for testing secretmap
  47. expectedData map[string][]byte
  48. // for testing caching
  49. expectedCounter *int
  50. }
  51. const unexpectedErrorString = "[%d] unexpected error: %s, expected: '%s'"
  52. const (
  53. tagname1 = "tagname1"
  54. tagvalue1 = "tagvalue1"
  55. tagname2 = "tagname2"
  56. tagvalue2 = "tagvalue2"
  57. )
  58. func makeValidSecretsManagerTestCase() *secretsManagerTestCase {
  59. smtc := secretsManagerTestCase{
  60. fakeClient: fakesm.NewClient(),
  61. apiInput: makeValidAPIInput(),
  62. remoteRef: makeValidRemoteRef(),
  63. apiOutput: makeValidAPIOutput(),
  64. apiErr: nil,
  65. expectError: "",
  66. expectedSecret: "",
  67. expectedData: map[string][]byte{},
  68. }
  69. smtc.fakeClient.WithValue(smtc.apiInput, smtc.apiOutput, smtc.apiErr)
  70. return &smtc
  71. }
  72. func makeValidRemoteRef() *esv1beta1.ExternalSecretDataRemoteRef {
  73. return &esv1beta1.ExternalSecretDataRemoteRef{
  74. Key: "/baz",
  75. Version: "AWSCURRENT",
  76. }
  77. }
  78. func makeValidAPIInput() *awssm.GetSecretValueInput {
  79. return &awssm.GetSecretValueInput{
  80. SecretId: aws.String("/baz"),
  81. VersionStage: aws.String("AWSCURRENT"),
  82. }
  83. }
  84. func makeValidAPIOutput() *awssm.GetSecretValueOutput {
  85. return &awssm.GetSecretValueOutput{
  86. SecretString: aws.String(""),
  87. }
  88. }
  89. func makeValidSecretsManagerTestCaseCustom(tweaks ...func(smtc *secretsManagerTestCase)) *secretsManagerTestCase {
  90. smtc := makeValidSecretsManagerTestCase()
  91. for _, fn := range tweaks {
  92. fn(smtc)
  93. }
  94. smtc.fakeClient.WithValue(smtc.apiInput, smtc.apiOutput, smtc.apiErr)
  95. return smtc
  96. }
  97. // This case can be shared by both GetSecret and GetSecretMap tests.
  98. // bad case: set apiErr.
  99. var setAPIErr = func(smtc *secretsManagerTestCase) {
  100. smtc.apiErr = errors.New("oh no")
  101. smtc.expectError = "oh no"
  102. }
  103. // test the sm<->aws interface
  104. // make sure correct values are passed and errors are handled accordingly.
  105. func TestSecretsManagerGetSecret(t *testing.T) {
  106. // good case: default version is set
  107. // key is passed in, output is sent back
  108. setSecretString := func(smtc *secretsManagerTestCase) {
  109. smtc.apiOutput.SecretString = aws.String("testtesttest")
  110. smtc.expectedSecret = "testtesttest"
  111. }
  112. // good case: extract property
  113. // Testing that the property exists in the SecretString
  114. setRemoteRefPropertyExistsInKey := func(smtc *secretsManagerTestCase) {
  115. smtc.remoteRef.Property = "/shmoo"
  116. smtc.apiOutput.SecretString = aws.String(`{"/shmoo": "bang"}`)
  117. smtc.expectedSecret = "bang"
  118. }
  119. // bad case: missing property
  120. setRemoteRefMissingProperty := func(smtc *secretsManagerTestCase) {
  121. smtc.remoteRef.Property = "INVALPROP"
  122. smtc.expectError = "key INVALPROP does not exist in secret"
  123. }
  124. // bad case: extract property failure due to invalid json
  125. setRemoteRefMissingPropertyInvalidJSON := func(smtc *secretsManagerTestCase) {
  126. smtc.remoteRef.Property = "INVALPROP"
  127. smtc.apiOutput.SecretString = aws.String(`------`)
  128. smtc.expectError = "key INVALPROP does not exist in secret"
  129. }
  130. // good case: set .SecretString to nil but set binary with value
  131. setSecretBinaryNotSecretString := func(smtc *secretsManagerTestCase) {
  132. smtc.apiOutput.SecretBinary = []byte("yesplease")
  133. // needs to be set as nil, empty quotes ("") is considered existing
  134. smtc.apiOutput.SecretString = nil
  135. smtc.expectedSecret = "yesplease"
  136. }
  137. // bad case: both .SecretString and .SecretBinary are nil
  138. setSecretBinaryAndSecretStringToNil := func(smtc *secretsManagerTestCase) {
  139. smtc.apiOutput.SecretBinary = nil
  140. smtc.apiOutput.SecretString = nil
  141. smtc.expectError = "no secret string nor binary for key"
  142. }
  143. // good case: secretOut.SecretBinary JSON parsing
  144. setNestedSecretValueJSONParsing := func(smtc *secretsManagerTestCase) {
  145. smtc.apiOutput.SecretString = nil
  146. smtc.apiOutput.SecretBinary = []byte(`{"foobar":{"baz":"nestedval"}}`)
  147. smtc.remoteRef.Property = "foobar.baz"
  148. smtc.expectedSecret = "nestedval"
  149. }
  150. // good case: secretOut.SecretBinary no JSON parsing if name on key
  151. setSecretValueWithDot := func(smtc *secretsManagerTestCase) {
  152. smtc.apiOutput.SecretString = nil
  153. smtc.apiOutput.SecretBinary = []byte(`{"foobar.baz":"nestedval"}`)
  154. smtc.remoteRef.Property = "foobar.baz"
  155. smtc.expectedSecret = "nestedval"
  156. }
  157. // good case: custom version stage set
  158. setCustomVersionStage := func(smtc *secretsManagerTestCase) {
  159. smtc.apiInput.VersionStage = aws.String("1234")
  160. smtc.remoteRef.Version = "1234"
  161. smtc.apiOutput.SecretString = aws.String("FOOBA!")
  162. smtc.expectedSecret = "FOOBA!"
  163. }
  164. // good case: custom version id set
  165. setCustomVersionID := func(smtc *secretsManagerTestCase) {
  166. smtc.apiInput.VersionStage = nil
  167. smtc.apiInput.VersionId = aws.String("1234-5678")
  168. smtc.remoteRef.Version = "uuid/1234-5678"
  169. smtc.apiOutput.SecretString = aws.String("myvalue")
  170. smtc.expectedSecret = "myvalue"
  171. }
  172. fetchMetadata := func(smtc *secretsManagerTestCase) {
  173. smtc.remoteRef.MetadataPolicy = esv1beta1.ExternalSecretMetadataPolicyFetch
  174. describeSecretOutput := &awssm.DescribeSecretOutput{
  175. Tags: getTagSlice(),
  176. }
  177. smtc.fakeClient.DescribeSecretWithContextFn = fakesm.NewDescribeSecretWithContextFn(describeSecretOutput, nil)
  178. jsonTags, _ := util.SecretTagsToJSONString(getTagSlice())
  179. smtc.apiOutput.SecretString = &jsonTags
  180. smtc.expectedSecret = jsonTags
  181. }
  182. fetchMetadataProperty := func(smtc *secretsManagerTestCase) {
  183. smtc.remoteRef.MetadataPolicy = esv1beta1.ExternalSecretMetadataPolicyFetch
  184. describeSecretOutput := &awssm.DescribeSecretOutput{
  185. Tags: getTagSlice(),
  186. }
  187. smtc.fakeClient.DescribeSecretWithContextFn = fakesm.NewDescribeSecretWithContextFn(describeSecretOutput, nil)
  188. smtc.remoteRef.Property = tagname2
  189. jsonTags, _ := util.SecretTagsToJSONString(getTagSlice())
  190. smtc.apiOutput.SecretString = &jsonTags
  191. smtc.expectedSecret = tagvalue2
  192. }
  193. failMetadataWrongProperty := func(smtc *secretsManagerTestCase) {
  194. smtc.remoteRef.MetadataPolicy = esv1beta1.ExternalSecretMetadataPolicyFetch
  195. describeSecretOutput := &awssm.DescribeSecretOutput{
  196. Tags: getTagSlice(),
  197. }
  198. smtc.fakeClient.DescribeSecretWithContextFn = fakesm.NewDescribeSecretWithContextFn(describeSecretOutput, nil)
  199. smtc.remoteRef.Property = "fail"
  200. jsonTags, _ := util.SecretTagsToJSONString(getTagSlice())
  201. smtc.apiOutput.SecretString = &jsonTags
  202. smtc.expectError = "key fail does not exist in secret /baz"
  203. }
  204. successCases := []*secretsManagerTestCase{
  205. makeValidSecretsManagerTestCase(),
  206. makeValidSecretsManagerTestCaseCustom(setSecretString),
  207. makeValidSecretsManagerTestCaseCustom(setRemoteRefPropertyExistsInKey),
  208. makeValidSecretsManagerTestCaseCustom(setRemoteRefMissingProperty),
  209. makeValidSecretsManagerTestCaseCustom(setRemoteRefMissingPropertyInvalidJSON),
  210. makeValidSecretsManagerTestCaseCustom(setSecretBinaryNotSecretString),
  211. makeValidSecretsManagerTestCaseCustom(setSecretBinaryAndSecretStringToNil),
  212. makeValidSecretsManagerTestCaseCustom(setNestedSecretValueJSONParsing),
  213. makeValidSecretsManagerTestCaseCustom(setSecretValueWithDot),
  214. makeValidSecretsManagerTestCaseCustom(setCustomVersionStage),
  215. makeValidSecretsManagerTestCaseCustom(setCustomVersionID),
  216. makeValidSecretsManagerTestCaseCustom(setAPIErr),
  217. makeValidSecretsManagerTestCaseCustom(fetchMetadata),
  218. makeValidSecretsManagerTestCaseCustom(fetchMetadataProperty),
  219. makeValidSecretsManagerTestCaseCustom(failMetadataWrongProperty),
  220. }
  221. for k, v := range successCases {
  222. sm := SecretsManager{
  223. cache: make(map[string]*awssm.GetSecretValueOutput),
  224. client: v.fakeClient,
  225. }
  226. out, err := sm.GetSecret(context.Background(), *v.remoteRef)
  227. if !ErrorContains(err, v.expectError) {
  228. t.Errorf(unexpectedErrorString, k, err.Error(), v.expectError)
  229. }
  230. if err == nil && string(out) != v.expectedSecret {
  231. t.Errorf("[%d] unexpected secret: expected %s, got %s", k, v.expectedSecret, string(out))
  232. }
  233. }
  234. }
  235. func TestCaching(t *testing.T) {
  236. fakeClient := fakesm.NewClient()
  237. // good case: first call, since we are using the same key, results should be cached and the counter should not go
  238. // over 1
  239. firstCall := func(smtc *secretsManagerTestCase) {
  240. smtc.apiOutput.SecretString = aws.String(`{"foo":"bar", "bar":"vodka"}`)
  241. smtc.remoteRef.Property = "foo"
  242. smtc.expectedSecret = "bar"
  243. smtc.expectedCounter = aws.Int(1)
  244. smtc.fakeClient = fakeClient
  245. }
  246. secondCall := func(smtc *secretsManagerTestCase) {
  247. smtc.apiOutput.SecretString = aws.String(`{"foo":"bar", "bar":"vodka"}`)
  248. smtc.remoteRef.Property = "bar"
  249. smtc.expectedSecret = "vodka"
  250. smtc.expectedCounter = aws.Int(1)
  251. smtc.fakeClient = fakeClient
  252. }
  253. notCachedCall := func(smtc *secretsManagerTestCase) {
  254. smtc.apiOutput.SecretString = aws.String(`{"sheldon":"bazinga", "bar":"foo"}`)
  255. smtc.remoteRef.Property = "sheldon"
  256. smtc.expectedSecret = "bazinga"
  257. smtc.expectedCounter = aws.Int(2)
  258. smtc.fakeClient = fakeClient
  259. smtc.apiInput.SecretId = aws.String("xyz")
  260. smtc.remoteRef.Key = "xyz" // it should reset the cache since the key is different
  261. }
  262. cachedCases := []*secretsManagerTestCase{
  263. makeValidSecretsManagerTestCaseCustom(firstCall),
  264. makeValidSecretsManagerTestCaseCustom(firstCall),
  265. makeValidSecretsManagerTestCaseCustom(secondCall),
  266. makeValidSecretsManagerTestCaseCustom(notCachedCall),
  267. }
  268. sm := SecretsManager{
  269. cache: make(map[string]*awssm.GetSecretValueOutput),
  270. }
  271. for k, v := range cachedCases {
  272. sm.client = v.fakeClient
  273. out, err := sm.GetSecret(context.Background(), *v.remoteRef)
  274. if !ErrorContains(err, v.expectError) {
  275. t.Errorf(unexpectedErrorString, k, err.Error(), v.expectError)
  276. }
  277. if err == nil && string(out) != v.expectedSecret {
  278. t.Errorf("[%d] unexpected secret: expected %s, got %s", k, v.expectedSecret, string(out))
  279. }
  280. if v.expectedCounter != nil && v.fakeClient.ExecutionCounter != *v.expectedCounter {
  281. t.Errorf("[%d] unexpected counter value: expected %d, got %d", k, v.expectedCounter, v.fakeClient.ExecutionCounter)
  282. }
  283. }
  284. }
  285. func TestGetSecretMap(t *testing.T) {
  286. // good case: default version & deserialization
  287. setDeserialization := func(smtc *secretsManagerTestCase) {
  288. smtc.apiOutput.SecretString = aws.String(`{"foo":"bar"}`)
  289. smtc.expectedData["foo"] = []byte("bar")
  290. }
  291. // good case: nested json
  292. setNestedJSON := func(smtc *secretsManagerTestCase) {
  293. smtc.apiOutput.SecretString = aws.String(`{"foobar":{"baz":"nestedval"}}`)
  294. smtc.expectedData["foobar"] = []byte("{\"baz\":\"nestedval\"}")
  295. }
  296. // good case: caching
  297. cachedMap := func(smtc *secretsManagerTestCase) {
  298. smtc.apiOutput.SecretString = aws.String(`{"foo":"bar", "plus": "one"}`)
  299. smtc.expectedData["foo"] = []byte("bar")
  300. smtc.expectedData["plus"] = []byte("one")
  301. smtc.expectedCounter = aws.Int(1)
  302. }
  303. // bad case: invalid json
  304. setInvalidJSON := func(smtc *secretsManagerTestCase) {
  305. smtc.apiOutput.SecretString = aws.String(`-----------------`)
  306. smtc.expectError = "unable to unmarshal secret"
  307. }
  308. successCases := []*secretsManagerTestCase{
  309. makeValidSecretsManagerTestCaseCustom(setDeserialization),
  310. makeValidSecretsManagerTestCaseCustom(setNestedJSON),
  311. makeValidSecretsManagerTestCaseCustom(setAPIErr),
  312. makeValidSecretsManagerTestCaseCustom(setInvalidJSON),
  313. makeValidSecretsManagerTestCaseCustom(cachedMap),
  314. }
  315. for k, v := range successCases {
  316. sm := SecretsManager{
  317. cache: make(map[string]*awssm.GetSecretValueOutput),
  318. client: v.fakeClient,
  319. }
  320. out, err := sm.GetSecretMap(context.Background(), *v.remoteRef)
  321. if !ErrorContains(err, v.expectError) {
  322. t.Errorf(unexpectedErrorString, k, err.Error(), v.expectError)
  323. }
  324. if err == nil && !cmp.Equal(out, v.expectedData) {
  325. t.Errorf("[%d] unexpected secret data: expected %#v, got %#v", k, v.expectedData, out)
  326. }
  327. if v.expectedCounter != nil && v.fakeClient.ExecutionCounter != *v.expectedCounter {
  328. t.Errorf("[%d] unexpected counter value: expected %d, got %d", k, v.expectedCounter, v.fakeClient.ExecutionCounter)
  329. }
  330. }
  331. }
  332. func ErrorContains(out error, want string) bool {
  333. if out == nil {
  334. return want == ""
  335. }
  336. if want == "" {
  337. return false
  338. }
  339. return strings.Contains(out.Error(), want)
  340. }
  341. func TestSetSecret(t *testing.T) {
  342. managedBy := managedBy
  343. notManagedBy := "not-managed-by"
  344. secretKey := "fake-secret-key"
  345. secretValue := []byte("fake-value")
  346. fakeSecret := &corev1.Secret{
  347. Data: map[string][]byte{
  348. secretKey: secretValue,
  349. },
  350. }
  351. externalSecrets := externalSecrets
  352. noPermission := errors.New("no permission")
  353. arn := "arn:aws:secretsmanager:us-east-1:702902267788:secret:foo-bar5-Robbgh"
  354. getSecretCorrectErr := awssm.ResourceNotFoundException{}
  355. getSecretWrongErr := awssm.InvalidRequestException{}
  356. secretOutput := &awssm.CreateSecretOutput{
  357. ARN: &arn,
  358. }
  359. externalSecretsTag := []*awssm.Tag{
  360. {
  361. Key: &managedBy,
  362. Value: &externalSecrets,
  363. },
  364. }
  365. externalSecretsTagFaulty := []*awssm.Tag{
  366. {
  367. Key: &notManagedBy,
  368. Value: &externalSecrets,
  369. },
  370. }
  371. tagSecretOutput := &awssm.DescribeSecretOutput{
  372. ARN: &arn,
  373. Tags: externalSecretsTag,
  374. }
  375. tagSecretOutputFaulty := &awssm.DescribeSecretOutput{
  376. ARN: &arn,
  377. Tags: externalSecretsTagFaulty,
  378. }
  379. initialVersion := "00000000-0000-0000-0000-000000000001"
  380. defaultVersion := "00000000-0000-0000-0000-000000000002"
  381. defaultUpdatedVersion := "00000000-0000-0000-0000-000000000003"
  382. randomUUIDVersion := "c2812e8d-84ce-4858-abec-7163d8ab312b"
  383. randomUUIDVersionIncremented := "c2812e8d-84ce-4858-abec-7163d8ab312c"
  384. unparsableVersion := "IAM UNPARSABLE"
  385. secretValueOutput := &awssm.GetSecretValueOutput{
  386. ARN: &arn,
  387. VersionId: &defaultVersion,
  388. }
  389. secretValueOutput2 := &awssm.GetSecretValueOutput{
  390. ARN: &arn,
  391. SecretBinary: secretValue,
  392. VersionId: &defaultVersion,
  393. }
  394. type params struct {
  395. s string
  396. b []byte
  397. version *string
  398. }
  399. secretValueOutputFrom := func(params params) *awssm.GetSecretValueOutput {
  400. var version *string
  401. if params.version == nil {
  402. version = &defaultVersion
  403. } else {
  404. version = params.version
  405. }
  406. return &awssm.GetSecretValueOutput{
  407. ARN: &arn,
  408. SecretString: &params.s,
  409. SecretBinary: params.b,
  410. VersionId: version,
  411. }
  412. }
  413. blankSecretValueOutput := &awssm.GetSecretValueOutput{}
  414. putSecretOutput := &awssm.PutSecretValueOutput{
  415. ARN: &arn,
  416. }
  417. pushSecretDataWithoutProperty := fake.PushSecretData{SecretKey: secretKey, RemoteKey: "fake-key", Property: ""}
  418. pushSecretDataWithMetadata := fake.PushSecretData{SecretKey: secretKey, RemoteKey: "fake-key", Property: "", Metadata: &apiextensionsv1.JSON{
  419. Raw: []byte(`{"secretPushFormat": "string"}`),
  420. }}
  421. pushSecretDataWithProperty := fake.PushSecretData{SecretKey: secretKey, RemoteKey: "fake-key", Property: "other-fake-property"}
  422. type args struct {
  423. store *esv1beta1.AWSProvider
  424. client fakesm.Client
  425. pushSecretData fake.PushSecretData
  426. }
  427. type want struct {
  428. err error
  429. }
  430. tests := map[string]struct {
  431. reason string
  432. args args
  433. want want
  434. }{
  435. "SetSecretSucceedsWithExistingSecret": {
  436. reason: "a secret can be pushed to aws secrets manager when it already exists",
  437. args: args{
  438. store: makeValidSecretStore().Spec.Provider.AWS,
  439. client: fakesm.Client{
  440. GetSecretValueWithContextFn: fakesm.NewGetSecretValueWithContextFn(secretValueOutput, nil),
  441. CreateSecretWithContextFn: fakesm.NewCreateSecretWithContextFn(secretOutput, nil),
  442. PutSecretValueWithContextFn: fakesm.NewPutSecretValueWithContextFn(putSecretOutput, nil),
  443. DescribeSecretWithContextFn: fakesm.NewDescribeSecretWithContextFn(tagSecretOutput, nil),
  444. },
  445. pushSecretData: pushSecretDataWithoutProperty,
  446. },
  447. want: want{
  448. err: nil,
  449. },
  450. },
  451. "SetSecretSucceedsWithExistingSecretAndStringFormat": {
  452. reason: "a secret can be pushed to aws secrets manager when it already exists",
  453. args: args{
  454. store: makeValidSecretStore().Spec.Provider.AWS,
  455. client: fakesm.Client{
  456. GetSecretValueWithContextFn: fakesm.NewGetSecretValueWithContextFn(secretValueOutput, nil),
  457. CreateSecretWithContextFn: fakesm.NewCreateSecretWithContextFn(secretOutput, nil),
  458. PutSecretValueWithContextFn: fakesm.NewPutSecretValueWithContextFn(putSecretOutput, nil),
  459. DescribeSecretWithContextFn: fakesm.NewDescribeSecretWithContextFn(tagSecretOutput, nil),
  460. },
  461. pushSecretData: pushSecretDataWithMetadata,
  462. },
  463. want: want{
  464. err: nil,
  465. },
  466. },
  467. "SetSecretSucceedsWithNewSecret": {
  468. reason: "a secret can be pushed to aws secrets manager if it doesn't already exist",
  469. args: args{
  470. store: makeValidSecretStore().Spec.Provider.AWS,
  471. client: fakesm.Client{
  472. GetSecretValueWithContextFn: fakesm.NewGetSecretValueWithContextFn(blankSecretValueOutput, &getSecretCorrectErr),
  473. CreateSecretWithContextFn: fakesm.NewCreateSecretWithContextFn(secretOutput, nil),
  474. },
  475. pushSecretData: pushSecretDataWithoutProperty,
  476. },
  477. want: want{
  478. err: nil,
  479. },
  480. },
  481. "SetSecretWithPropertySucceedsWithNewSecret": {
  482. reason: "if a new secret is pushed to aws sm and a pushSecretData property is specified, create a json secret with the pushSecretData property as a key",
  483. args: args{
  484. store: makeValidSecretStore().Spec.Provider.AWS,
  485. client: fakesm.Client{
  486. GetSecretValueWithContextFn: fakesm.NewGetSecretValueWithContextFn(blankSecretValueOutput, &getSecretCorrectErr),
  487. CreateSecretWithContextFn: fakesm.NewCreateSecretWithContextFn(secretOutput, nil, []byte(`{"other-fake-property":"fake-value"}`)),
  488. },
  489. pushSecretData: pushSecretDataWithProperty,
  490. },
  491. want: want{
  492. err: nil,
  493. },
  494. },
  495. "SetSecretWithPropertySucceedsWithExistingSecretAndNewPropertyBinary": {
  496. reason: "when a pushSecretData property is specified, this property will be added to the sm secret if it is currently absent (sm secret is binary)",
  497. args: args{
  498. store: makeValidSecretStore().Spec.Provider.AWS,
  499. client: fakesm.Client{
  500. GetSecretValueWithContextFn: fakesm.NewGetSecretValueWithContextFn(secretValueOutputFrom(params{b: []byte((`{"fake-property":"fake-value"}`))}), nil),
  501. DescribeSecretWithContextFn: fakesm.NewDescribeSecretWithContextFn(tagSecretOutput, nil),
  502. PutSecretValueWithContextFn: fakesm.NewPutSecretValueWithContextFn(putSecretOutput, nil, fakesm.ExpectedPutSecretValueInput{
  503. SecretBinary: []byte(`{"fake-property":"fake-value","other-fake-property":"fake-value"}`),
  504. Version: &defaultUpdatedVersion,
  505. }),
  506. },
  507. pushSecretData: pushSecretDataWithProperty,
  508. },
  509. want: want{
  510. err: nil,
  511. },
  512. },
  513. "SetSecretWithPropertySucceedsWithExistingSecretAndRandomUUIDVersion": {
  514. reason: "When a secret version is not specified, the client sets a random uuid by default. We should treat a version that can't be parsed to an int as not having a version",
  515. args: args{
  516. store: makeValidSecretStore().Spec.Provider.AWS,
  517. client: fakesm.Client{
  518. GetSecretValueWithContextFn: fakesm.NewGetSecretValueWithContextFn(secretValueOutputFrom(params{
  519. b: []byte((`{"fake-property":"fake-value"}`)),
  520. version: &randomUUIDVersion,
  521. }), nil),
  522. DescribeSecretWithContextFn: fakesm.NewDescribeSecretWithContextFn(tagSecretOutput, nil),
  523. PutSecretValueWithContextFn: fakesm.NewPutSecretValueWithContextFn(putSecretOutput, nil, fakesm.ExpectedPutSecretValueInput{
  524. SecretBinary: []byte(`{"fake-property":"fake-value","other-fake-property":"fake-value"}`),
  525. Version: &randomUUIDVersionIncremented,
  526. }),
  527. },
  528. pushSecretData: pushSecretDataWithProperty,
  529. },
  530. want: want{
  531. err: nil,
  532. },
  533. },
  534. "SetSecretWithPropertySucceedsWithExistingSecretAndVersionThatCantBeParsed": {
  535. reason: "A manually set secret version doesn't have to be a UUID, we only support UUID secret versions though",
  536. args: args{
  537. store: makeValidSecretStore().Spec.Provider.AWS,
  538. client: fakesm.Client{
  539. GetSecretValueWithContextFn: fakesm.NewGetSecretValueWithContextFn(secretValueOutputFrom(params{
  540. b: []byte((`{"fake-property":"fake-value"}`)),
  541. version: &unparsableVersion,
  542. }), nil),
  543. DescribeSecretWithContextFn: fakesm.NewDescribeSecretWithContextFn(tagSecretOutput, nil),
  544. PutSecretValueWithContextFn: fakesm.NewPutSecretValueWithContextFn(putSecretOutput, nil, fakesm.ExpectedPutSecretValueInput{
  545. SecretBinary: []byte(`{"fake-property":"fake-value","other-fake-property":"fake-value"}`),
  546. Version: &initialVersion,
  547. }),
  548. },
  549. pushSecretData: pushSecretDataWithProperty,
  550. },
  551. want: want{
  552. err: fmt.Errorf("expected secret version in AWS SSM to be a UUID but got '%s'", unparsableVersion),
  553. },
  554. },
  555. "SetSecretWithPropertySucceedsWithExistingSecretAndAbsentVersion": {
  556. reason: "When a secret version is not specified, set it to 1",
  557. args: args{
  558. store: makeValidSecretStore().Spec.Provider.AWS,
  559. client: fakesm.Client{
  560. GetSecretValueWithContextFn: fakesm.NewGetSecretValueWithContextFn(&awssm.GetSecretValueOutput{
  561. ARN: &arn,
  562. SecretBinary: []byte((`{"fake-property":"fake-value"}`)),
  563. }, nil),
  564. DescribeSecretWithContextFn: fakesm.NewDescribeSecretWithContextFn(tagSecretOutput, nil),
  565. PutSecretValueWithContextFn: fakesm.NewPutSecretValueWithContextFn(putSecretOutput, nil, fakesm.ExpectedPutSecretValueInput{
  566. SecretBinary: []byte(`{"fake-property":"fake-value","other-fake-property":"fake-value"}`),
  567. Version: &initialVersion,
  568. }),
  569. },
  570. pushSecretData: pushSecretDataWithProperty,
  571. },
  572. want: want{
  573. err: nil,
  574. },
  575. },
  576. "SetSecretWithPropertySucceedsWithExistingSecretAndNewPropertyString": {
  577. reason: "when a pushSecretData property is specified, this property will be added to the sm secret if it is currently absent (sm secret is a string)",
  578. args: args{
  579. store: makeValidSecretStore().Spec.Provider.AWS,
  580. client: fakesm.Client{
  581. GetSecretValueWithContextFn: fakesm.NewGetSecretValueWithContextFn(secretValueOutputFrom(params{s: `{"fake-property":"fake-value"}`}), nil),
  582. DescribeSecretWithContextFn: fakesm.NewDescribeSecretWithContextFn(tagSecretOutput, nil),
  583. PutSecretValueWithContextFn: fakesm.NewPutSecretValueWithContextFn(putSecretOutput, nil, fakesm.ExpectedPutSecretValueInput{
  584. SecretBinary: []byte(`{"fake-property":"fake-value","other-fake-property":"fake-value"}`),
  585. Version: &defaultUpdatedVersion,
  586. }),
  587. },
  588. pushSecretData: pushSecretDataWithProperty,
  589. },
  590. want: want{
  591. err: nil,
  592. },
  593. },
  594. "SetSecretWithPropertySucceedsWithExistingSecretAndNewPropertyWithDot": {
  595. reason: "when a pushSecretData property is specified, this property will be added to the sm secret if it is currently absent (pushSecretData property is a sub-object)",
  596. args: args{
  597. store: makeValidSecretStore().Spec.Provider.AWS,
  598. client: fakesm.Client{
  599. GetSecretValueWithContextFn: fakesm.NewGetSecretValueWithContextFn(secretValueOutputFrom(params{s: `{"fake-property":{"fake-property":"fake-value"}}`}), nil),
  600. DescribeSecretWithContextFn: fakesm.NewDescribeSecretWithContextFn(tagSecretOutput, nil),
  601. PutSecretValueWithContextFn: fakesm.NewPutSecretValueWithContextFn(putSecretOutput, nil, fakesm.ExpectedPutSecretValueInput{
  602. SecretBinary: []byte(`{"fake-property":{"fake-property":"fake-value","other-fake-property":"fake-value"}}`),
  603. Version: &defaultUpdatedVersion,
  604. }),
  605. },
  606. pushSecretData: fake.PushSecretData{SecretKey: secretKey, RemoteKey: "fake-key", Property: "fake-property.other-fake-property"},
  607. },
  608. want: want{
  609. err: nil,
  610. },
  611. },
  612. "SetSecretWithPropertyFailsExistingNonJsonSecret": {
  613. reason: "setting a pushSecretData property is only supported for json secrets",
  614. args: args{
  615. store: makeValidSecretStore().Spec.Provider.AWS,
  616. client: fakesm.Client{
  617. GetSecretValueWithContextFn: fakesm.NewGetSecretValueWithContextFn(secretValueOutputFrom(params{s: `non-json-secret`}), nil),
  618. DescribeSecretWithContextFn: fakesm.NewDescribeSecretWithContextFn(tagSecretOutput, nil),
  619. },
  620. pushSecretData: pushSecretDataWithProperty,
  621. },
  622. want: want{
  623. err: errors.New("PushSecret for aws secrets manager with a pushSecretData property requires a json secret"),
  624. },
  625. },
  626. "SetSecretCreateSecretFails": {
  627. reason: "CreateSecretWithContext returns an error if it fails",
  628. args: args{
  629. store: makeValidSecretStore().Spec.Provider.AWS,
  630. client: fakesm.Client{
  631. GetSecretValueWithContextFn: fakesm.NewGetSecretValueWithContextFn(blankSecretValueOutput, &getSecretCorrectErr),
  632. CreateSecretWithContextFn: fakesm.NewCreateSecretWithContextFn(nil, noPermission),
  633. },
  634. pushSecretData: pushSecretDataWithoutProperty,
  635. },
  636. want: want{
  637. err: noPermission,
  638. },
  639. },
  640. "SetSecretGetSecretFails": {
  641. reason: "GetSecretValueWithContext returns an error if it fails",
  642. args: args{
  643. store: makeValidSecretStore().Spec.Provider.AWS,
  644. client: fakesm.Client{
  645. GetSecretValueWithContextFn: fakesm.NewGetSecretValueWithContextFn(blankSecretValueOutput, noPermission),
  646. },
  647. pushSecretData: pushSecretDataWithoutProperty,
  648. },
  649. want: want{
  650. err: noPermission,
  651. },
  652. },
  653. "SetSecretWillNotPushSameSecret": {
  654. reason: "secret with the same value will not be pushed",
  655. args: args{
  656. store: makeValidSecretStore().Spec.Provider.AWS,
  657. client: fakesm.Client{
  658. GetSecretValueWithContextFn: fakesm.NewGetSecretValueWithContextFn(secretValueOutput2, nil),
  659. DescribeSecretWithContextFn: fakesm.NewDescribeSecretWithContextFn(tagSecretOutput, nil),
  660. },
  661. pushSecretData: pushSecretDataWithoutProperty,
  662. },
  663. want: want{
  664. err: nil,
  665. },
  666. },
  667. "SetSecretPutSecretValueFails": {
  668. reason: "PutSecretValueWithContext returns an error if it fails",
  669. args: args{
  670. store: makeValidSecretStore().Spec.Provider.AWS,
  671. client: fakesm.Client{
  672. GetSecretValueWithContextFn: fakesm.NewGetSecretValueWithContextFn(secretValueOutput, nil),
  673. PutSecretValueWithContextFn: fakesm.NewPutSecretValueWithContextFn(nil, noPermission),
  674. DescribeSecretWithContextFn: fakesm.NewDescribeSecretWithContextFn(tagSecretOutput, nil),
  675. },
  676. pushSecretData: pushSecretDataWithoutProperty,
  677. },
  678. want: want{
  679. err: noPermission,
  680. },
  681. },
  682. "SetSecretWrongGetSecretErrFails": {
  683. reason: "GetSecretValueWithContext errors out when anything except awssm.ErrCodeResourceNotFoundException",
  684. args: args{
  685. store: makeValidSecretStore().Spec.Provider.AWS,
  686. client: fakesm.Client{
  687. GetSecretValueWithContextFn: fakesm.NewGetSecretValueWithContextFn(blankSecretValueOutput, &getSecretWrongErr),
  688. },
  689. pushSecretData: pushSecretDataWithoutProperty,
  690. },
  691. want: want{
  692. err: &getSecretWrongErr,
  693. },
  694. },
  695. "SetSecretDescribeSecretFails": {
  696. reason: "secret cannot be described",
  697. args: args{
  698. store: makeValidSecretStore().Spec.Provider.AWS,
  699. client: fakesm.Client{
  700. GetSecretValueWithContextFn: fakesm.NewGetSecretValueWithContextFn(secretValueOutput, nil),
  701. DescribeSecretWithContextFn: fakesm.NewDescribeSecretWithContextFn(nil, noPermission),
  702. },
  703. pushSecretData: pushSecretDataWithoutProperty,
  704. },
  705. want: want{
  706. err: noPermission,
  707. },
  708. },
  709. "SetSecretDoesNotOverwriteUntaggedSecret": {
  710. reason: "secret cannot be described",
  711. args: args{
  712. store: makeValidSecretStore().Spec.Provider.AWS,
  713. client: fakesm.Client{
  714. GetSecretValueWithContextFn: fakesm.NewGetSecretValueWithContextFn(secretValueOutput, nil),
  715. DescribeSecretWithContextFn: fakesm.NewDescribeSecretWithContextFn(tagSecretOutputFaulty, nil),
  716. },
  717. pushSecretData: pushSecretDataWithoutProperty,
  718. },
  719. want: want{
  720. err: errors.New("secret not managed by external-secrets"),
  721. },
  722. },
  723. }
  724. for name, tc := range tests {
  725. t.Run(name, func(t *testing.T) {
  726. sm := SecretsManager{
  727. client: &tc.args.client,
  728. }
  729. err := sm.PushSecret(context.Background(), fakeSecret, tc.args.pushSecretData)
  730. // Error nil XOR tc.want.err nil
  731. if ((err == nil) || (tc.want.err == nil)) && !((err == nil) && (tc.want.err == nil)) {
  732. t.Errorf("\nTesting SetSecret:\nName: %v\nReason: %v\nWant error: %v\nGot error: %v", name, tc.reason, tc.want.err, err)
  733. }
  734. // if errors are the same type but their contents do not match
  735. if err != nil && tc.want.err != nil {
  736. if !strings.Contains(err.Error(), tc.want.err.Error()) {
  737. t.Errorf("\nTesting SetSecret:\nName: %v\nReason: %v\nWant error: %v\nGot error got nil", name, tc.reason, tc.want.err)
  738. }
  739. }
  740. })
  741. }
  742. }
  743. func TestDeleteSecret(t *testing.T) {
  744. fakeClient := fakesm.Client{}
  745. managed := managedBy
  746. manager := externalSecrets
  747. secretTag := awssm.Tag{
  748. Key: &managed,
  749. Value: &manager,
  750. }
  751. type args struct {
  752. client fakesm.Client
  753. config esv1beta1.SecretsManager
  754. getSecretOutput *awssm.GetSecretValueOutput
  755. describeSecretOutput *awssm.DescribeSecretOutput
  756. deleteSecretOutput *awssm.DeleteSecretOutput
  757. getSecretErr error
  758. describeSecretErr error
  759. deleteSecretErr error
  760. }
  761. type want struct {
  762. err error
  763. }
  764. type testCase struct {
  765. args args
  766. want want
  767. reason string
  768. }
  769. tests := map[string]testCase{
  770. "Deletes Successfully": {
  771. args: args{
  772. client: fakeClient,
  773. config: esv1beta1.SecretsManager{},
  774. getSecretOutput: &awssm.GetSecretValueOutput{},
  775. describeSecretOutput: &awssm.DescribeSecretOutput{
  776. Tags: []*awssm.Tag{&secretTag},
  777. },
  778. deleteSecretOutput: &awssm.DeleteSecretOutput{},
  779. getSecretErr: nil,
  780. describeSecretErr: nil,
  781. deleteSecretErr: nil,
  782. },
  783. want: want{
  784. err: nil,
  785. },
  786. reason: "",
  787. },
  788. "Deletes Successfully with ForceDeleteWithoutRecovery": {
  789. args: args{
  790. client: fakeClient,
  791. config: esv1beta1.SecretsManager{
  792. ForceDeleteWithoutRecovery: true,
  793. },
  794. getSecretOutput: &awssm.GetSecretValueOutput{},
  795. describeSecretOutput: &awssm.DescribeSecretOutput{
  796. Tags: []*awssm.Tag{&secretTag},
  797. },
  798. deleteSecretOutput: &awssm.DeleteSecretOutput{
  799. DeletionDate: aws.Time(time.Now()),
  800. },
  801. getSecretErr: nil,
  802. describeSecretErr: nil,
  803. deleteSecretErr: nil,
  804. },
  805. want: want{
  806. err: nil,
  807. },
  808. reason: "",
  809. },
  810. "Not Managed by ESO": {
  811. args: args{
  812. client: fakeClient,
  813. config: esv1beta1.SecretsManager{},
  814. getSecretOutput: &awssm.GetSecretValueOutput{},
  815. describeSecretOutput: &awssm.DescribeSecretOutput{
  816. Tags: []*awssm.Tag{},
  817. },
  818. deleteSecretOutput: &awssm.DeleteSecretOutput{},
  819. getSecretErr: nil,
  820. describeSecretErr: nil,
  821. deleteSecretErr: nil,
  822. },
  823. want: want{
  824. err: nil,
  825. },
  826. reason: "",
  827. },
  828. "Invalid Recovery Window": {
  829. args: args{
  830. client: fakesm.Client{},
  831. config: esv1beta1.SecretsManager{
  832. RecoveryWindowInDays: 1,
  833. },
  834. getSecretOutput: &awssm.GetSecretValueOutput{},
  835. describeSecretOutput: &awssm.DescribeSecretOutput{
  836. Tags: []*awssm.Tag{&secretTag},
  837. },
  838. deleteSecretOutput: &awssm.DeleteSecretOutput{},
  839. getSecretErr: nil,
  840. describeSecretErr: nil,
  841. deleteSecretErr: nil,
  842. },
  843. want: want{
  844. err: errors.New("invalid DeleteSecretInput: RecoveryWindowInDays must be between 7 and 30 days"),
  845. },
  846. reason: "",
  847. },
  848. "RecoveryWindowInDays is supplied with ForceDeleteWithoutRecovery": {
  849. args: args{
  850. client: fakesm.Client{},
  851. config: esv1beta1.SecretsManager{
  852. RecoveryWindowInDays: 7,
  853. ForceDeleteWithoutRecovery: true,
  854. },
  855. getSecretOutput: &awssm.GetSecretValueOutput{},
  856. describeSecretOutput: &awssm.DescribeSecretOutput{
  857. Tags: []*awssm.Tag{&secretTag},
  858. },
  859. deleteSecretOutput: &awssm.DeleteSecretOutput{},
  860. getSecretErr: nil,
  861. describeSecretErr: nil,
  862. deleteSecretErr: nil,
  863. },
  864. want: want{
  865. err: errors.New("invalid DeleteSecretInput: ForceDeleteWithoutRecovery conflicts with RecoveryWindowInDays"),
  866. },
  867. reason: "",
  868. },
  869. "Failed to get Tags": {
  870. args: args{
  871. client: fakeClient,
  872. config: esv1beta1.SecretsManager{},
  873. getSecretOutput: &awssm.GetSecretValueOutput{},
  874. describeSecretOutput: nil,
  875. deleteSecretOutput: nil,
  876. getSecretErr: nil,
  877. describeSecretErr: errors.New("failed to get tags"),
  878. deleteSecretErr: nil,
  879. },
  880. want: want{
  881. err: errors.New("failed to get tags"),
  882. },
  883. reason: "",
  884. },
  885. "Secret Not Found": {
  886. args: args{
  887. client: fakeClient,
  888. config: esv1beta1.SecretsManager{},
  889. getSecretOutput: nil,
  890. describeSecretOutput: nil,
  891. deleteSecretOutput: nil,
  892. getSecretErr: awserr.New(awssm.ErrCodeResourceNotFoundException, "not here, sorry dude", nil),
  893. describeSecretErr: nil,
  894. deleteSecretErr: nil,
  895. },
  896. want: want{
  897. err: nil,
  898. },
  899. },
  900. "Not expected AWS error": {
  901. args: args{
  902. client: fakeClient,
  903. config: esv1beta1.SecretsManager{},
  904. getSecretOutput: nil,
  905. describeSecretOutput: nil,
  906. deleteSecretOutput: nil,
  907. getSecretErr: awserr.New(awssm.ErrCodeEncryptionFailure, "aws unavailable", nil),
  908. describeSecretErr: nil,
  909. deleteSecretErr: nil,
  910. },
  911. want: want{
  912. err: errors.New("aws unavailable"),
  913. },
  914. },
  915. "unexpected error": {
  916. args: args{
  917. client: fakeClient,
  918. config: esv1beta1.SecretsManager{},
  919. getSecretOutput: nil,
  920. describeSecretOutput: nil,
  921. deleteSecretOutput: nil,
  922. getSecretErr: errors.New("timeout"),
  923. describeSecretErr: nil,
  924. deleteSecretErr: nil,
  925. },
  926. want: want{
  927. err: errors.New("timeout"),
  928. },
  929. },
  930. }
  931. for name, tc := range tests {
  932. t.Run(name, func(t *testing.T) {
  933. ref := fake.PushSecretData{RemoteKey: "fake-key"}
  934. sm := SecretsManager{
  935. client: &tc.args.client,
  936. config: &tc.args.config,
  937. }
  938. tc.args.client.GetSecretValueWithContextFn = fakesm.NewGetSecretValueWithContextFn(tc.args.getSecretOutput, tc.args.getSecretErr)
  939. tc.args.client.DescribeSecretWithContextFn = fakesm.NewDescribeSecretWithContextFn(tc.args.describeSecretOutput, tc.args.describeSecretErr)
  940. tc.args.client.DeleteSecretWithContextFn = fakesm.NewDeleteSecretWithContextFn(tc.args.deleteSecretOutput, tc.args.deleteSecretErr)
  941. err := sm.DeleteSecret(context.TODO(), ref)
  942. t.Logf("DeleteSecret error: %v", err)
  943. // Error nil XOR tc.want.err nil
  944. if ((err == nil) || (tc.want.err == nil)) && !((err == nil) && (tc.want.err == nil)) {
  945. t.Errorf("\nTesting DeleteSecret:\nName: %v\nReason: %v\nWant error: %v\nGot error: %v", name, tc.reason, tc.want.err, err)
  946. }
  947. // if errors are the same type but their contents do not match
  948. if err != nil && tc.want.err != nil {
  949. if !strings.Contains(err.Error(), tc.want.err.Error()) {
  950. t.Errorf("\nTesting DeleteSecret:\nName: %v\nReason: %v\nWant error: %v\nGot error got nil", name, tc.reason, tc.want.err)
  951. }
  952. }
  953. })
  954. }
  955. }
  956. func makeValidSecretStore() *esv1beta1.SecretStore {
  957. return &esv1beta1.SecretStore{
  958. ObjectMeta: metav1.ObjectMeta{
  959. Name: "aws-secret-store",
  960. Namespace: "default",
  961. },
  962. Spec: esv1beta1.SecretStoreSpec{
  963. Provider: &esv1beta1.SecretStoreProvider{
  964. AWS: &esv1beta1.AWSProvider{
  965. Service: esv1beta1.AWSServiceSecretsManager,
  966. Region: "eu-west-2",
  967. },
  968. },
  969. },
  970. }
  971. }
  972. func getTagSlice() []*awssm.Tag {
  973. tagKey1 := tagname1
  974. tagValue1 := tagvalue1
  975. tagKey2 := tagname2
  976. tagValue2 := tagvalue2
  977. return []*awssm.Tag{
  978. {
  979. Key: &tagKey1,
  980. Value: &tagValue1,
  981. },
  982. {
  983. Key: &tagKey2,
  984. Value: &tagValue2,
  985. },
  986. }
  987. }
  988. func TestSecretsManagerGetAllSecrets(t *testing.T) {
  989. ctx := context.Background()
  990. errBoom := errors.New("boom")
  991. secretName := "my-secret"
  992. secretVersion := "AWSCURRENT"
  993. secretPath := "/path/to/secret"
  994. secretValue := "secret value"
  995. secretTags := map[string]string{
  996. "foo": "bar",
  997. }
  998. // Test cases
  999. testCases := []struct {
  1000. name string
  1001. ref esv1beta1.ExternalSecretFind
  1002. secretName string
  1003. secretVersion string
  1004. secretValue string
  1005. fetchError error
  1006. listSecretsFn func(ctx context.Context, input *awssm.ListSecretsInput, opts ...request.Option) (*awssm.ListSecretsOutput, error)
  1007. expectedData map[string][]byte
  1008. expectedError string
  1009. }{
  1010. {
  1011. name: "Matching secrets found",
  1012. ref: esv1beta1.ExternalSecretFind{
  1013. Name: &esv1beta1.FindName{
  1014. RegExp: secretName,
  1015. },
  1016. Path: ptr.To(secretPath),
  1017. },
  1018. secretName: secretName,
  1019. secretVersion: secretVersion,
  1020. secretValue: secretValue,
  1021. listSecretsFn: func(ctx context.Context, input *awssm.ListSecretsInput, opts ...request.Option) (*awssm.ListSecretsOutput, error) {
  1022. assert.Len(t, input.Filters, 1)
  1023. assert.Equal(t, "name", *input.Filters[0].Key)
  1024. assert.Equal(t, secretPath, *input.Filters[0].Values[0])
  1025. return &awssm.ListSecretsOutput{
  1026. SecretList: []*awssm.SecretListEntry{
  1027. {
  1028. Name: ptr.To(secretName),
  1029. },
  1030. },
  1031. }, nil
  1032. },
  1033. expectedData: map[string][]byte{
  1034. secretName: []byte(secretValue),
  1035. },
  1036. expectedError: "",
  1037. },
  1038. {
  1039. name: "Error occurred while fetching secret value",
  1040. ref: esv1beta1.ExternalSecretFind{
  1041. Name: &esv1beta1.FindName{
  1042. RegExp: secretName,
  1043. },
  1044. Path: ptr.To(secretPath),
  1045. },
  1046. secretName: secretName,
  1047. secretVersion: secretVersion,
  1048. secretValue: secretValue,
  1049. fetchError: errBoom,
  1050. listSecretsFn: func(ctx context.Context, input *awssm.ListSecretsInput, opts ...request.Option) (*awssm.ListSecretsOutput, error) {
  1051. return &awssm.ListSecretsOutput{
  1052. SecretList: []*awssm.SecretListEntry{
  1053. {
  1054. Name: ptr.To(secretName),
  1055. },
  1056. },
  1057. }, nil
  1058. },
  1059. expectedData: nil,
  1060. expectedError: errBoom.Error(),
  1061. },
  1062. {
  1063. name: "regexp: error occurred while listing secrets",
  1064. ref: esv1beta1.ExternalSecretFind{
  1065. Name: &esv1beta1.FindName{
  1066. RegExp: secretName,
  1067. },
  1068. },
  1069. listSecretsFn: func(ctx context.Context, input *awssm.ListSecretsInput, opts ...request.Option) (*awssm.ListSecretsOutput, error) {
  1070. return nil, errBoom
  1071. },
  1072. expectedData: nil,
  1073. expectedError: errBoom.Error(),
  1074. },
  1075. {
  1076. name: "regep: no matching secrets found",
  1077. ref: esv1beta1.ExternalSecretFind{
  1078. Name: &esv1beta1.FindName{
  1079. RegExp: secretName,
  1080. },
  1081. },
  1082. listSecretsFn: func(ctx context.Context, input *awssm.ListSecretsInput, opts ...request.Option) (*awssm.ListSecretsOutput, error) {
  1083. return &awssm.ListSecretsOutput{
  1084. SecretList: []*awssm.SecretListEntry{
  1085. {
  1086. Name: ptr.To("other-secret"),
  1087. },
  1088. },
  1089. }, nil
  1090. },
  1091. expectedData: make(map[string][]byte),
  1092. expectedError: "",
  1093. },
  1094. {
  1095. name: "invalid regexp",
  1096. ref: esv1beta1.ExternalSecretFind{
  1097. Name: &esv1beta1.FindName{
  1098. RegExp: "[",
  1099. },
  1100. },
  1101. expectedData: nil,
  1102. expectedError: "could not compile find.name.regexp [[]: error parsing regexp: missing closing ]: `[`",
  1103. },
  1104. {
  1105. name: "tags: Matching secrets found",
  1106. ref: esv1beta1.ExternalSecretFind{
  1107. Tags: secretTags,
  1108. },
  1109. secretName: secretName,
  1110. secretVersion: secretVersion,
  1111. secretValue: secretValue,
  1112. listSecretsFn: func(ctx context.Context, input *awssm.ListSecretsInput, opts ...request.Option) (*awssm.ListSecretsOutput, error) {
  1113. assert.Len(t, input.Filters, 2)
  1114. assert.Equal(t, "tag-key", *input.Filters[0].Key)
  1115. assert.Equal(t, "foo", *input.Filters[0].Values[0])
  1116. assert.Equal(t, "tag-value", *input.Filters[1].Key)
  1117. assert.Equal(t, "bar", *input.Filters[1].Values[0])
  1118. return &awssm.ListSecretsOutput{
  1119. SecretList: []*awssm.SecretListEntry{
  1120. {
  1121. Name: ptr.To(secretName),
  1122. },
  1123. },
  1124. }, nil
  1125. },
  1126. expectedData: map[string][]byte{
  1127. secretName: []byte(secretValue),
  1128. },
  1129. expectedError: "",
  1130. },
  1131. {
  1132. name: "tags: error occurred while fetching secret value",
  1133. ref: esv1beta1.ExternalSecretFind{
  1134. Tags: secretTags,
  1135. },
  1136. secretName: secretName,
  1137. secretVersion: secretVersion,
  1138. secretValue: secretValue,
  1139. fetchError: errBoom,
  1140. listSecretsFn: func(ctx context.Context, input *awssm.ListSecretsInput, opts ...request.Option) (*awssm.ListSecretsOutput, error) {
  1141. return &awssm.ListSecretsOutput{
  1142. SecretList: []*awssm.SecretListEntry{
  1143. {
  1144. Name: ptr.To(secretName),
  1145. },
  1146. },
  1147. }, nil
  1148. },
  1149. expectedData: nil,
  1150. expectedError: errBoom.Error(),
  1151. },
  1152. {
  1153. name: "tags: error occurred while listing secrets",
  1154. ref: esv1beta1.ExternalSecretFind{
  1155. Tags: secretTags,
  1156. },
  1157. listSecretsFn: func(ctx context.Context, input *awssm.ListSecretsInput, opts ...request.Option) (*awssm.ListSecretsOutput, error) {
  1158. return nil, errBoom
  1159. },
  1160. expectedData: nil,
  1161. expectedError: errBoom.Error(),
  1162. },
  1163. }
  1164. for _, tc := range testCases {
  1165. t.Run(tc.name, func(t *testing.T) {
  1166. fc := fakesm.NewClient()
  1167. fc.ListSecretsFn = tc.listSecretsFn
  1168. fc.WithValue(&awssm.GetSecretValueInput{
  1169. SecretId: ptr.To(tc.secretName),
  1170. VersionStage: ptr.To(tc.secretVersion),
  1171. }, &awssm.GetSecretValueOutput{
  1172. Name: ptr.To(tc.secretName),
  1173. VersionStages: []*string{ptr.To(tc.secretVersion)},
  1174. SecretBinary: []byte(tc.secretValue),
  1175. }, tc.fetchError)
  1176. sm := SecretsManager{
  1177. client: fc,
  1178. cache: make(map[string]*awssm.GetSecretValueOutput),
  1179. }
  1180. data, err := sm.GetAllSecrets(ctx, tc.ref)
  1181. if err != nil && err.Error() != tc.expectedError {
  1182. t.Errorf("unexpected error: got %v, want %v", err, tc.expectedError)
  1183. }
  1184. if !reflect.DeepEqual(data, tc.expectedData) {
  1185. t.Errorf("unexpected data: got %v, want %v", data, tc.expectedData)
  1186. }
  1187. })
  1188. }
  1189. }
  1190. func TestSecretsManagerValidate(t *testing.T) {
  1191. type fields struct {
  1192. sess *session.Session
  1193. referentAuth bool
  1194. }
  1195. validSession, _ := session.NewSession(aws.NewConfig().WithCredentials(credentials.NewStaticCredentials("fake", "fake", "fake")))
  1196. invalidSession, _ := session.NewSession(aws.NewConfig().WithCredentials(credentials.NewCredentials(&FakeCredProvider{
  1197. retrieveFunc: func() (credentials.Value, error) {
  1198. return credentials.Value{}, errors.New("invalid credentials")
  1199. },
  1200. })))
  1201. tests := []struct {
  1202. name string
  1203. fields fields
  1204. want esv1beta1.ValidationResult
  1205. wantErr bool
  1206. }{
  1207. {
  1208. name: "ReferentAuth should always return unknown",
  1209. fields: fields{
  1210. referentAuth: true,
  1211. },
  1212. want: esv1beta1.ValidationResultUnknown,
  1213. },
  1214. {
  1215. name: "Valid credentials should return ready",
  1216. fields: fields{
  1217. sess: validSession,
  1218. },
  1219. want: esv1beta1.ValidationResultReady,
  1220. },
  1221. {
  1222. name: "Invalid credentials should return error",
  1223. fields: fields{
  1224. sess: invalidSession,
  1225. },
  1226. want: esv1beta1.ValidationResultError,
  1227. wantErr: true,
  1228. },
  1229. }
  1230. for _, tt := range tests {
  1231. t.Run(tt.name, func(t *testing.T) {
  1232. sm := &SecretsManager{
  1233. sess: tt.fields.sess,
  1234. referentAuth: tt.fields.referentAuth,
  1235. }
  1236. got, err := sm.Validate()
  1237. if (err != nil) != tt.wantErr {
  1238. t.Errorf("SecretsManager.Validate() error = %v, wantErr %v", err, tt.wantErr)
  1239. return
  1240. }
  1241. if !reflect.DeepEqual(got, tt.want) {
  1242. t.Errorf("SecretsManager.Validate() = %v, want %v", got, tt.want)
  1243. }
  1244. })
  1245. }
  1246. }
  1247. func TestSecretExists(t *testing.T) {
  1248. arn := "arn:aws:secretsmanager:us-east-1:702902267788:secret:foo-bar5-Robbgh"
  1249. defaultVersion := "00000000-0000-0000-0000-000000000002"
  1250. secretValueOutput := &awssm.GetSecretValueOutput{
  1251. ARN: &arn,
  1252. VersionId: &defaultVersion,
  1253. }
  1254. blankSecretValueOutput := &awssm.GetSecretValueOutput{}
  1255. getSecretCorrectErr := awssm.ResourceNotFoundException{}
  1256. getSecretWrongErr := awssm.InvalidRequestException{}
  1257. pushSecretDataWithoutProperty := fake.PushSecretData{SecretKey: "fake-secret-key", RemoteKey: "fake-key", Property: ""}
  1258. type args struct {
  1259. store *esv1beta1.AWSProvider
  1260. client fakesm.Client
  1261. pushSecretData fake.PushSecretData
  1262. }
  1263. type want struct {
  1264. err error
  1265. wantError bool
  1266. }
  1267. tests := map[string]struct {
  1268. args args
  1269. want want
  1270. }{
  1271. "SecretExistsReturnsTrueForExistingSecret": {
  1272. args: args{
  1273. store: makeValidSecretStore().Spec.Provider.AWS,
  1274. client: fakesm.Client{
  1275. GetSecretValueWithContextFn: fakesm.NewGetSecretValueWithContextFn(secretValueOutput, nil),
  1276. },
  1277. pushSecretData: pushSecretDataWithoutProperty,
  1278. },
  1279. want: want{
  1280. err: nil,
  1281. wantError: true,
  1282. },
  1283. },
  1284. "SecretExistsReturnsFalseForNonExistingSecret": {
  1285. args: args{
  1286. store: makeValidSecretStore().Spec.Provider.AWS,
  1287. client: fakesm.Client{
  1288. GetSecretValueWithContextFn: fakesm.NewGetSecretValueWithContextFn(blankSecretValueOutput, &getSecretCorrectErr),
  1289. },
  1290. pushSecretData: pushSecretDataWithoutProperty,
  1291. },
  1292. want: want{
  1293. err: nil,
  1294. wantError: false,
  1295. },
  1296. },
  1297. "SecretExistsReturnsFalseForErroredSecret": {
  1298. args: args{
  1299. store: makeValidSecretStore().Spec.Provider.AWS,
  1300. client: fakesm.Client{
  1301. GetSecretValueWithContextFn: fakesm.NewGetSecretValueWithContextFn(blankSecretValueOutput, &getSecretWrongErr),
  1302. },
  1303. pushSecretData: pushSecretDataWithoutProperty,
  1304. },
  1305. want: want{
  1306. err: &getSecretWrongErr,
  1307. wantError: false,
  1308. },
  1309. },
  1310. }
  1311. for name, tc := range tests {
  1312. t.Run(name, func(t *testing.T) {
  1313. sm := &SecretsManager{
  1314. client: &tc.args.client,
  1315. }
  1316. got, err := sm.SecretExists(context.Background(), tc.args.pushSecretData)
  1317. assert.Equal(
  1318. t,
  1319. tc.want,
  1320. want{
  1321. err: err,
  1322. wantError: got,
  1323. })
  1324. })
  1325. }
  1326. }
  1327. // FakeCredProvider implements the AWS credentials.Provider interface
  1328. // It is used to inject an error into the AWS session to cause a
  1329. // validation error.
  1330. type FakeCredProvider struct {
  1331. retrieveFunc func() (credentials.Value, error)
  1332. }
  1333. func (f *FakeCredProvider) Retrieve() (credentials.Value, error) {
  1334. return f.retrieveFunc()
  1335. }
  1336. func (f *FakeCredProvider) IsExpired() bool {
  1337. return true
  1338. }