secret

Documentation

Overview

Package secret is a generated GoMock package.

Index

• func GetSecret[T any](ctx context.Context, client Client, name string) (T, error)
• func SaveSecret[T any](ctx context.Context, client Client, name string, value T) error
• type Client
• type ErrInvalid
  • func (e *ErrInvalid) Error() string
  • func (e *ErrInvalid) Is(target error) bool
• type ErrNotFound
  • func (e *ErrNotFound) Error() string
  • func (e *ErrNotFound) Is(target error) bool
• type MockClient
  • func NewMockClient(ctrl *gomock.Controller) *MockClient
  • func (m *MockClient) Delete(arg0 context.Context, arg1 string) error
  • func (m *MockClient) EXPECT() *MockClientMockRecorder
  • func (m *MockClient) Get(arg0 context.Context, arg1 string) ([]byte, error)
  • func (m *MockClient) Save(arg0 context.Context, arg1 string, arg2 []byte) error
• type MockClientDeleteCall
  • func (c *MockClientDeleteCall) Do(f func(context.Context, string) error) *MockClientDeleteCall
  • func (c *MockClientDeleteCall) DoAndReturn(f func(context.Context, string) error) *MockClientDeleteCall
  • func (c *MockClientDeleteCall) Return(arg0 error) *MockClientDeleteCall
• type MockClientGetCall
  • func (c *MockClientGetCall) Do(f func(context.Context, string) ([]byte, error)) *MockClientGetCall
  • func (c *MockClientGetCall) DoAndReturn(f func(context.Context, string) ([]byte, error)) *MockClientGetCall
  • func (c *MockClientGetCall) Return(arg0 []byte, arg1 error) *MockClientGetCall
• type MockClientMockRecorder
  • func (mr *MockClientMockRecorder) Delete(arg0, arg1 any) *MockClientDeleteCall
  • func (mr *MockClientMockRecorder) Get(arg0, arg1 any) *MockClientGetCall
  • func (mr *MockClientMockRecorder) Save(arg0, arg1, arg2 any) *MockClientSaveCall
• type MockClientSaveCall
  • func (c *MockClientSaveCall) Do(f func(context.Context, string, []byte) error) *MockClientSaveCall
  • func (c *MockClientSaveCall) DoAndReturn(f func(context.Context, string, []byte) error) *MockClientSaveCall
  • func (c *MockClientSaveCall) Return(arg0 error) *MockClientSaveCall

Functions

func GetSecret

func GetSecret[T any](ctx context.Context, client Client, name string) (T, error)

GetSecret retrieves a secret using secret client and returns it as a generic type, returning an error if the retrieval or unmarshalling fails.

func SaveSecret

func SaveSecret[T any](ctx context.Context, client Client, name string, value T) error

SaveSecret saves a secret value using secret client, marshalling it to JSON first.

Types

type Client

type Client interface {
	// Save creates or updates secret.
	// Returns ErrInvalid in case of invalid input.
	Save(ctx context.Context, name string, value []byte) error

	// Delete deletes the secret with the given name.
	Delete(ctx context.Context, name string) error

	// Get gets secret name if present else returns an error.
	// Returns ErrNotFound in case of invalid input.
	Get(ctx context.Context, name string) ([]byte, error)
}

Client is an interface to implement secret operations.

type ErrInvalid

type ErrInvalid struct {
	Message string
}

ErrInvalid represents error when resource inputs are invalid.

func (*ErrInvalid) Error

func (e *ErrInvalid) Error() string

Error returns a string representation of the error.

func (*ErrInvalid) Is

func (e *ErrInvalid) Is(target error) bool

Is checks if the target error is of type ErrInvalid and if the message of the target error is equal to the message of the current error or if the message of the target error is empty.

type ErrNotFound

type ErrNotFound struct {
}

ErrNotFound represents error when resource is missing.

func (*ErrNotFound) Error

func (e *ErrNotFound) Error() string

Error returns the error message.

func (*ErrNotFound) Is

func (e *ErrNotFound) Is(target error) bool

Is checks if the error is of type ErrNotFound.

type MockClient

type MockClient struct {
	// contains filtered or unexported fields
}

MockClient is a mock of Client interface.

func NewMockClient

func NewMockClient(ctrl *gomock.Controller) *MockClient

NewMockClient creates a new mock instance.

func (*MockClient) Delete

func (m *MockClient) Delete(arg0 context.Context, arg1 string) error

Delete mocks base method.

func (*MockClient) EXPECT

func (m *MockClient) EXPECT() *MockClientMockRecorder

EXPECT returns an object that allows the caller to indicate expected use.

func (*MockClient) Get

func (m *MockClient) Get(arg0 context.Context, arg1 string) ([]byte, error)

Get mocks base method.

func (*MockClient) Save

func (m *MockClient) Save(arg0 context.Context, arg1 string, arg2 []byte) error

Save mocks base method.

type MockClientDeleteCall

type MockClientDeleteCall struct {
	*gomock.Call
}

MockClientDeleteCall wrap *gomock.Call

func (*MockClientDeleteCall) Do

func (c *MockClientDeleteCall) Do(f func(context.Context, string) error) *MockClientDeleteCall

Do rewrite *gomock.Call.Do

func (*MockClientDeleteCall) DoAndReturn

func (c *MockClientDeleteCall) DoAndReturn(f func(context.Context, string) error) *MockClientDeleteCall

DoAndReturn rewrite *gomock.Call.DoAndReturn

func (*MockClientDeleteCall) Return

func (c *MockClientDeleteCall) Return(arg0 error) *MockClientDeleteCall

Return rewrite *gomock.Call.Return

type MockClientGetCall

type MockClientGetCall struct {
	*gomock.Call
}

MockClientGetCall wrap *gomock.Call

func (*MockClientGetCall) Do

func (c *MockClientGetCall) Do(f func(context.Context, string) ([]byte, error)) *MockClientGetCall

Do rewrite *gomock.Call.Do

func (*MockClientGetCall) DoAndReturn

func (c *MockClientGetCall) DoAndReturn(f func(context.Context, string) ([]byte, error)) *MockClientGetCall

DoAndReturn rewrite *gomock.Call.DoAndReturn

func (*MockClientGetCall) Return

func (c *MockClientGetCall) Return(arg0 []byte, arg1 error) *MockClientGetCall

Return rewrite *gomock.Call.Return

type MockClientMockRecorder

type MockClientMockRecorder struct {
	// contains filtered or unexported fields
}

MockClientMockRecorder is the mock recorder for MockClient.

func (*MockClientMockRecorder) Delete

func (mr *MockClientMockRecorder) Delete(arg0, arg1 any) *MockClientDeleteCall

Delete indicates an expected call of Delete.

func (*MockClientMockRecorder) Get

func (mr *MockClientMockRecorder) Get(arg0, arg1 any) *MockClientGetCall

Get indicates an expected call of Get.

func (*MockClientMockRecorder) Save

func (mr *MockClientMockRecorder) Save(arg0, arg1, arg2 any) *MockClientSaveCall

Save indicates an expected call of Save.

type MockClientSaveCall

type MockClientSaveCall struct {
	*gomock.Call
}

MockClientSaveCall wrap *gomock.Call

func (*MockClientSaveCall) Do

func (c *MockClientSaveCall) Do(f func(context.Context, string, []byte) error) *MockClientSaveCall

Do rewrite *gomock.Call.Do

func (*MockClientSaveCall) DoAndReturn

func (c *MockClientSaveCall) DoAndReturn(f func(context.Context, string, []byte) error) *MockClientSaveCall

DoAndReturn rewrite *gomock.Call.DoAndReturn

func (*MockClientSaveCall) Return

func (c *MockClientSaveCall) Return(arg0 error) *MockClientSaveCall

Return rewrite *gomock.Call.Return