fake.go 4.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155
  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 fake
  13. import (
  14. "context"
  15. "sigs.k8s.io/controller-runtime/pkg/client"
  16. esv1beta1 "github.com/external-secrets/external-secrets/apis/externalsecrets/v1beta1"
  17. )
  18. var _ esv1beta1.Provider = &Client{}
  19. // Client is a fake client for testing.
  20. type Client struct {
  21. NewFn func(context.Context, esv1beta1.GenericStore, client.Client, string) (esv1beta1.SecretsClient, error)
  22. GetSecretFn func(context.Context, esv1beta1.ExternalSecretDataRemoteRef) ([]byte, error)
  23. GetSecretMapFn func(context.Context, esv1beta1.ExternalSecretDataRemoteRef) (map[string][]byte, error)
  24. GetAllSecretsFn func(context.Context, esv1beta1.ExternalSecretFind) (map[string][]byte, error)
  25. SetSecretFn func() error
  26. }
  27. // New returns a fake provider/client.
  28. func New() *Client {
  29. v := &Client{
  30. GetSecretFn: func(context.Context, esv1beta1.ExternalSecretDataRemoteRef) ([]byte, error) {
  31. return nil, nil
  32. },
  33. GetSecretMapFn: func(context.Context, esv1beta1.ExternalSecretDataRemoteRef) (map[string][]byte, error) {
  34. return nil, nil
  35. },
  36. GetAllSecretsFn: func(context.Context, esv1beta1.ExternalSecretFind) (map[string][]byte, error) {
  37. return nil, nil
  38. },
  39. SetSecretFn: func() error {
  40. return nil
  41. },
  42. }
  43. v.NewFn = func(context.Context, esv1beta1.GenericStore, client.Client, string) (esv1beta1.SecretsClient, error) {
  44. return v, nil
  45. }
  46. return v
  47. }
  48. // RegisterAs registers the fake client in the schema.
  49. func (v *Client) RegisterAs(provider *esv1beta1.SecretStoreProvider) {
  50. esv1beta1.ForceRegister(v, provider)
  51. }
  52. // GetAllSecrets implements the provider.Provider interface.
  53. func (v *Client) GetAllSecrets(ctx context.Context, ref esv1beta1.ExternalSecretFind) (map[string][]byte, error) {
  54. return v.GetAllSecretsFn(ctx, ref)
  55. }
  56. // Not Implemented SetSecret.
  57. func (v *Client) SetSecret(ctx context.Context, value []byte, remoteRef esv1beta1.PushRemoteRef) error {
  58. return v.SetSecretFn()
  59. }
  60. // GetSecret implements the provider.Provider interface.
  61. func (v *Client) GetSecret(ctx context.Context, ref esv1beta1.ExternalSecretDataRemoteRef) ([]byte, error) {
  62. return v.GetSecretFn(ctx, ref)
  63. }
  64. // WithGetSecret wraps secret data returned by this provider.
  65. func (v *Client) WithGetSecret(secData []byte, err error) *Client {
  66. v.GetSecretFn = func(context.Context, esv1beta1.ExternalSecretDataRemoteRef) ([]byte, error) {
  67. return secData, err
  68. }
  69. return v
  70. }
  71. // GetSecretMap implements the provider.Provider interface.
  72. func (v *Client) GetSecretMap(ctx context.Context, ref esv1beta1.ExternalSecretDataRemoteRef) (map[string][]byte, error) {
  73. return v.GetSecretMapFn(ctx, ref)
  74. }
  75. func (v *Client) Close(ctx context.Context) error {
  76. return nil
  77. }
  78. func (v *Client) Validate() (esv1beta1.ValidationResult, error) {
  79. return esv1beta1.ValidationResultReady, nil
  80. }
  81. func (v *Client) ValidateStore(store esv1beta1.GenericStore) error {
  82. return nil
  83. }
  84. // WithGetSecretMap wraps the secret data map returned by this fake provider.
  85. func (v *Client) WithGetSecretMap(secData map[string][]byte, err error) *Client {
  86. v.GetSecretMapFn = func(context.Context, esv1beta1.ExternalSecretDataRemoteRef) (map[string][]byte, error) {
  87. return secData, err
  88. }
  89. return v
  90. }
  91. // WithGetAllSecrets wraps the secret data map returned by this fake provider.
  92. func (v *Client) WithGetAllSecrets(secData map[string][]byte, err error) *Client {
  93. v.GetAllSecretsFn = func(context.Context, esv1beta1.ExternalSecretFind) (map[string][]byte, error) {
  94. return secData, err
  95. }
  96. return v
  97. }
  98. // WithSetSecret wraps the secret response to the fake provider.
  99. func (v *Client) WithSetSecret(err error) *Client {
  100. v.SetSecretFn = func() error {
  101. return err
  102. }
  103. return v
  104. }
  105. // WithNew wraps the fake provider factory function.
  106. func (v *Client) WithNew(f func(context.Context, esv1beta1.GenericStore, client.Client,
  107. string) (esv1beta1.SecretsClient, error)) *Client {
  108. v.NewFn = f
  109. return v
  110. }
  111. // Capabilities return the provider supported capabilities (ReadOnly, WriteOnly, ReadWrite).
  112. func (v *Client) Capabilities() esv1beta1.SecretStoreCapabilities {
  113. return esv1beta1.SecretStoreReadOnly
  114. }
  115. // NewClient returns a new fake provider.
  116. func (v *Client) NewClient(ctx context.Context, store esv1beta1.GenericStore, kube client.Client, namespace string) (esv1beta1.SecretsClient, error) {
  117. c, err := v.NewFn(ctx, store, kube, namespace)
  118. if err != nil {
  119. return nil, err
  120. }
  121. return c, nil
  122. }
  123. func (v *Client) Reset() {
  124. v.WithNew(func(context.Context, esv1beta1.GenericStore, client.Client,
  125. string) (esv1beta1.SecretsClient, error) {
  126. return v, nil
  127. })
  128. }