fake.go 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272
  1. /*
  2. Copyright © The ESO Authors
  3. Licensed under the Apache License, Version 2.0 (the "License");
  4. you may not use this file except in compliance with the License.
  5. You may obtain a copy of the License at
  6. https://www.apache.org/licenses/LICENSE-2.0
  7. Unless required by applicable law or agreed to in writing, software
  8. distributed under the License is distributed on an "AS IS" BASIS,
  9. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  10. See the License for the specific language governing permissions and
  11. limitations under the License.
  12. */
  13. // Package fake provides mock implementations of AWS Secrets Manager interfaces for testing.
  14. // It allows simulating AWS API responses without making actual API calls.
  15. package fake
  16. import (
  17. "bytes"
  18. "context"
  19. "errors"
  20. "fmt"
  21. "time"
  22. awssm "github.com/aws/aws-sdk-go-v2/service/secretsmanager"
  23. "github.com/google/go-cmp/cmp"
  24. "github.com/google/go-cmp/cmp/cmpopts"
  25. )
  26. // Client implements the aws secretsmanager interface.
  27. type Client struct {
  28. ExecutionCounter int
  29. valFn map[string]func(*awssm.GetSecretValueInput) (*awssm.GetSecretValueOutput, error)
  30. CreateSecretFn CreateSecretFn
  31. GetSecretValueFn GetSecretValueFn
  32. PutSecretValueFn PutSecretValueFn
  33. DescribeSecretFn DescribeSecretFn
  34. DeleteSecretFn DeleteSecretFn
  35. ListSecretsFn ListSecretsFn
  36. BatchGetSecretValueFn BatchGetSecretValueFn
  37. TagResourceFn TagResourceFn
  38. UntagResourceFn UntagResourceFn
  39. PutResourcePolicyFn PutResourcePolicyFn
  40. GetResourcePolicyFn GetResourcePolicyFn
  41. DeleteResourcePolicyFn DeleteResourcePolicyFn
  42. }
  43. type CreateSecretFn func(context.Context, *awssm.CreateSecretInput, ...func(*awssm.Options)) (*awssm.CreateSecretOutput, error)
  44. type GetSecretValueFn func(context.Context, *awssm.GetSecretValueInput, ...func(*awssm.Options)) (*awssm.GetSecretValueOutput, error)
  45. type PutSecretValueFn func(context.Context, *awssm.PutSecretValueInput, ...func(*awssm.Options)) (*awssm.PutSecretValueOutput, error)
  46. type DescribeSecretFn func(context.Context, *awssm.DescribeSecretInput, ...func(*awssm.Options)) (*awssm.DescribeSecretOutput, error)
  47. type DeleteSecretFn func(context.Context, *awssm.DeleteSecretInput, ...func(*awssm.Options)) (*awssm.DeleteSecretOutput, error)
  48. type ListSecretsFn func(context.Context, *awssm.ListSecretsInput, ...func(*awssm.Options)) (*awssm.ListSecretsOutput, error)
  49. type BatchGetSecretValueFn func(context.Context, *awssm.BatchGetSecretValueInput, ...func(*awssm.Options)) (*awssm.BatchGetSecretValueOutput, error)
  50. type TagResourceFn func(context.Context, *awssm.TagResourceInput, ...func(*awssm.Options)) (*awssm.TagResourceOutput, error)
  51. type UntagResourceFn func(context.Context, *awssm.UntagResourceInput, ...func(*awssm.Options)) (*awssm.UntagResourceOutput, error)
  52. type PutResourcePolicyFn func(context.Context, *awssm.PutResourcePolicyInput, ...func(*awssm.Options)) (*awssm.PutResourcePolicyOutput, error)
  53. type GetResourcePolicyFn func(context.Context, *awssm.GetResourcePolicyInput, ...func(*awssm.Options)) (*awssm.GetResourcePolicyOutput, error)
  54. type DeleteResourcePolicyFn func(context.Context, *awssm.DeleteResourcePolicyInput, ...func(*awssm.Options)) (*awssm.DeleteResourcePolicyOutput, error)
  55. func (sm *Client) CreateSecret(ctx context.Context, input *awssm.CreateSecretInput, options ...func(*awssm.Options)) (*awssm.CreateSecretOutput, error) {
  56. return sm.CreateSecretFn(ctx, input, options...)
  57. }
  58. func NewCreateSecretFn(output *awssm.CreateSecretOutput, err error, expectedSecretBinary ...[]byte) CreateSecretFn {
  59. return func(ctx context.Context, actualInput *awssm.CreateSecretInput, options ...func(*awssm.Options)) (*awssm.CreateSecretOutput, error) {
  60. if *actualInput.ClientRequestToken != "00000000-0000-0000-0000-000000000001" {
  61. return nil, errors.New("expected the version to be 1 at creation")
  62. }
  63. if len(expectedSecretBinary) == 1 {
  64. if bytes.Equal(actualInput.SecretBinary, expectedSecretBinary[0]) {
  65. return output, err
  66. }
  67. return nil, fmt.Errorf("expected secret to be '%s' but was '%s'", string(expectedSecretBinary[0]), string(actualInput.SecretBinary))
  68. }
  69. return output, err
  70. }
  71. }
  72. func (sm *Client) DeleteSecret(ctx context.Context, input *awssm.DeleteSecretInput, opts ...func(*awssm.Options)) (*awssm.DeleteSecretOutput, error) {
  73. return sm.DeleteSecretFn(ctx, input, opts...)
  74. }
  75. // NewDeleteSecretFn returns a DeleteSecretFn that simulates AWS DeleteSecret API behavior.
  76. func NewDeleteSecretFn(output *awssm.DeleteSecretOutput, err error) DeleteSecretFn {
  77. return func(_ context.Context, input *awssm.DeleteSecretInput, opts ...func(*awssm.Options)) (*awssm.DeleteSecretOutput, error) {
  78. if input.ForceDeleteWithoutRecovery != nil && *input.ForceDeleteWithoutRecovery {
  79. output.DeletionDate = new(time.Now())
  80. }
  81. return output, err
  82. }
  83. }
  84. // NewGetSecretValueFn returns a GetSecretValueFn that returns the provided output and error.
  85. func NewGetSecretValueFn(output *awssm.GetSecretValueOutput, err error) GetSecretValueFn {
  86. return func(_ context.Context, input *awssm.GetSecretValueInput, options ...func(*awssm.Options)) (*awssm.GetSecretValueOutput, error) {
  87. return output, err
  88. }
  89. }
  90. func (sm *Client) PutSecretValue(ctx context.Context, input *awssm.PutSecretValueInput, options ...func(*awssm.Options)) (*awssm.PutSecretValueOutput, error) {
  91. return sm.PutSecretValueFn(ctx, input, options...)
  92. }
  93. type ExpectedPutSecretValueInput struct {
  94. SecretBinary []byte
  95. Version *string
  96. }
  97. func (e ExpectedPutSecretValueInput) assertEquals(actualInput *awssm.PutSecretValueInput) error {
  98. errSecretBinary := e.assertSecretBinary(actualInput)
  99. if errSecretBinary != nil {
  100. return errSecretBinary
  101. }
  102. errSecretVersion := e.assertVersion(actualInput)
  103. if errSecretVersion != nil {
  104. return errSecretVersion
  105. }
  106. return nil
  107. }
  108. func (e ExpectedPutSecretValueInput) assertSecretBinary(actualInput *awssm.PutSecretValueInput) error {
  109. if e.SecretBinary != nil && !bytes.Equal(actualInput.SecretBinary, e.SecretBinary) {
  110. return fmt.Errorf("expected secret to be '%s' but was '%s'", string(e.SecretBinary), string(actualInput.SecretBinary))
  111. }
  112. return nil
  113. }
  114. func (e ExpectedPutSecretValueInput) assertVersion(actualInput *awssm.PutSecretValueInput) error {
  115. if e.Version != nil && (*actualInput.ClientRequestToken != *e.Version) {
  116. return fmt.Errorf("expected version to be '%s', but was '%s'", *e.Version, *actualInput.ClientRequestToken)
  117. }
  118. return nil
  119. }
  120. func NewPutSecretValueFn(output *awssm.PutSecretValueOutput, err error, expectedInput ...ExpectedPutSecretValueInput) PutSecretValueFn {
  121. return func(ctx context.Context, actualInput *awssm.PutSecretValueInput, actualOptions ...func(*awssm.Options)) (*awssm.PutSecretValueOutput, error) {
  122. if len(expectedInput) == 1 {
  123. assertErr := expectedInput[0].assertEquals(actualInput)
  124. if assertErr != nil {
  125. return nil, assertErr
  126. }
  127. }
  128. return output, err
  129. }
  130. }
  131. func (sm *Client) DescribeSecret(ctx context.Context, input *awssm.DescribeSecretInput, options ...func(*awssm.Options)) (*awssm.DescribeSecretOutput, error) {
  132. return sm.DescribeSecretFn(ctx, input, options...)
  133. }
  134. func NewDescribeSecretFn(output *awssm.DescribeSecretOutput, err error) DescribeSecretFn {
  135. return func(ctx context.Context, input *awssm.DescribeSecretInput, options ...func(*awssm.Options)) (*awssm.DescribeSecretOutput, error) {
  136. return output, err
  137. }
  138. }
  139. // NewClient init a new fake client.
  140. func NewClient() *Client {
  141. return &Client{
  142. valFn: make(map[string]func(*awssm.GetSecretValueInput) (*awssm.GetSecretValueOutput, error)),
  143. }
  144. }
  145. func (sm *Client) GetSecretValue(ctx context.Context, in *awssm.GetSecretValueInput, options ...func(*awssm.Options)) (*awssm.GetSecretValueOutput, error) {
  146. // check if there's a direct fake function for this input
  147. if sm.GetSecretValueFn != nil {
  148. return sm.GetSecretValueFn(ctx, in, options...)
  149. }
  150. sm.ExecutionCounter++
  151. if entry, found := sm.valFn[sm.cacheKeyForInput(in)]; found {
  152. return entry(in)
  153. }
  154. return nil, errors.New("test case not found")
  155. }
  156. func (sm *Client) ListSecrets(ctx context.Context, input *awssm.ListSecretsInput, options ...func(*awssm.Options)) (*awssm.ListSecretsOutput, error) {
  157. return sm.ListSecretsFn(ctx, input, options...)
  158. }
  159. func (sm *Client) BatchGetSecretValue(ctx context.Context, in *awssm.BatchGetSecretValueInput, options ...func(*awssm.Options)) (*awssm.BatchGetSecretValueOutput, error) {
  160. return sm.BatchGetSecretValueFn(ctx, in, options...)
  161. }
  162. func (sm *Client) cacheKeyForInput(in *awssm.GetSecretValueInput) string {
  163. var secretID, versionID string
  164. if in.SecretId != nil {
  165. secretID = *in.SecretId
  166. }
  167. if in.VersionId != nil {
  168. versionID = *in.VersionId
  169. }
  170. return fmt.Sprintf("%s#%s", secretID, versionID)
  171. }
  172. func (sm *Client) WithValue(in *awssm.GetSecretValueInput, val *awssm.GetSecretValueOutput, err error) {
  173. sm.valFn[sm.cacheKeyForInput(in)] = func(paramIn *awssm.GetSecretValueInput) (*awssm.GetSecretValueOutput, error) {
  174. if !cmp.Equal(paramIn, in, cmpopts.IgnoreUnexported(awssm.GetSecretValueInput{})) {
  175. return nil, errors.New("unexpected test argument")
  176. }
  177. return val, err
  178. }
  179. }
  180. func (sm *Client) TagResource(ctx context.Context, params *awssm.TagResourceInput, optFns ...func(*awssm.Options)) (*awssm.TagResourceOutput, error) {
  181. return sm.TagResourceFn(ctx, params, optFns...)
  182. }
  183. func NewTagResourceFn(output *awssm.TagResourceOutput, err error, aFunc ...func(input *awssm.TagResourceInput)) TagResourceFn {
  184. return func(ctx context.Context, params *awssm.TagResourceInput, optFns ...func(*awssm.Options)) (*awssm.TagResourceOutput, error) {
  185. for _, f := range aFunc {
  186. f(params)
  187. }
  188. return output, err
  189. }
  190. }
  191. func (sm *Client) UntagResource(ctx context.Context, params *awssm.UntagResourceInput, optFuncs ...func(*awssm.Options)) (*awssm.UntagResourceOutput, error) {
  192. return sm.UntagResourceFn(ctx, params, optFuncs...)
  193. }
  194. func NewUntagResourceFn(output *awssm.UntagResourceOutput, err error, aFunc ...func(input *awssm.UntagResourceInput)) UntagResourceFn {
  195. return func(ctx context.Context, params *awssm.UntagResourceInput, optFuncs ...func(*awssm.Options)) (*awssm.UntagResourceOutput, error) {
  196. for _, f := range aFunc {
  197. f(params)
  198. }
  199. return output, err
  200. }
  201. }
  202. func (sm *Client) PutResourcePolicy(ctx context.Context, params *awssm.PutResourcePolicyInput, optFns ...func(*awssm.Options)) (*awssm.PutResourcePolicyOutput, error) {
  203. return sm.PutResourcePolicyFn(ctx, params, optFns...)
  204. }
  205. func NewPutResourcePolicyFn(output *awssm.PutResourcePolicyOutput, err error, aFunc ...func(input *awssm.PutResourcePolicyInput)) PutResourcePolicyFn {
  206. return func(ctx context.Context, params *awssm.PutResourcePolicyInput, optFns ...func(*awssm.Options)) (*awssm.PutResourcePolicyOutput, error) {
  207. for _, f := range aFunc {
  208. f(params)
  209. }
  210. return output, err
  211. }
  212. }
  213. func (sm *Client) GetResourcePolicy(ctx context.Context, params *awssm.GetResourcePolicyInput, optFns ...func(*awssm.Options)) (*awssm.GetResourcePolicyOutput, error) {
  214. return sm.GetResourcePolicyFn(ctx, params, optFns...)
  215. }
  216. func NewGetResourcePolicyFn(output *awssm.GetResourcePolicyOutput, err error, aFunc ...func(input *awssm.GetResourcePolicyInput)) GetResourcePolicyFn {
  217. return func(ctx context.Context, params *awssm.GetResourcePolicyInput, optFns ...func(*awssm.Options)) (*awssm.GetResourcePolicyOutput, error) {
  218. for _, f := range aFunc {
  219. f(params)
  220. }
  221. return output, err
  222. }
  223. }
  224. func (sm *Client) DeleteResourcePolicy(ctx context.Context, params *awssm.DeleteResourcePolicyInput, optFns ...func(*awssm.Options)) (*awssm.DeleteResourcePolicyOutput, error) {
  225. return sm.DeleteResourcePolicyFn(ctx, params, optFns...)
  226. }
  227. func NewDeleteResourcePolicyFn(output *awssm.DeleteResourcePolicyOutput, err error, aFunc ...func(input *awssm.DeleteResourcePolicyInput)) DeleteResourcePolicyFn {
  228. return func(ctx context.Context, params *awssm.DeleteResourcePolicyInput, optFns ...func(*awssm.Options)) (*awssm.DeleteResourcePolicyOutput, error) {
  229. for _, f := range aFunc {
  230. f(params)
  231. }
  232. return output, err
  233. }
  234. }