store

Documentation

Index

• type ArtifactoryClient
• type ArtifactoryStore
  • func (s *ArtifactoryStore) Get(stack string, component string, key string) (interface{}, error)
  • func (s *ArtifactoryStore) Set(stack string, component string, key string, value interface{}) error
• type ArtifactoryStoreOptions
• type InMemoryStore
  • func (s *InMemoryStore) Get(stack, component, key string) (interface{}, error)
  • func (s *InMemoryStore) Set(stack, component, key string, value interface{}) error
• type SSMClient
• type SSMStore
  • func (s *SSMStore) Get(stack string, component string, key string) (interface{}, error)
  • func (s *SSMStore) Set(stack string, component string, key string, value interface{}) error
• type SSMStoreOptions
• type Store
  • func NewArtifactoryStore(options ArtifactoryStoreOptions) (Store, error)
  • func NewInMemoryStore() (Store, error)
  • func NewSSMStore(options SSMStoreOptions) (Store, error)
• type StoreConfig
• type StoreFactory
• type StoreRegistry
  • func NewStoreRegistry(config *StoresConfig) (StoreRegistry, error)
• type StoresConfig

Types

type ArtifactoryClient

type ArtifactoryClient interface {
	DownloadFiles(...services.DownloadParams) (int, int, error)
	UploadFiles(artifactory.UploadServiceOptions, ...services.UploadParams) (int, int, error)
}

ArtifactoryClient interface allows us to mock the Artifactory Services Managernager in test with only the methods we are using in the ArtifactoryStore.

type ArtifactoryStore

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

func (*ArtifactoryStore) Get

func (s *ArtifactoryStore) Get(stack string, component string, key string) (interface{}, error)

func (*ArtifactoryStore) Set

func (s *ArtifactoryStore) Set(stack string, component string, key string, value interface{}) error

type ArtifactoryStoreOptions

type ArtifactoryStoreOptions struct {
	AccessToken    *string `mapstructure:"access_token"`
	Prefix         *string `mapstructure:"prefix"`
	RepoName       string  `mapstructure:"repo_name"`
	StackDelimiter *string `mapstructure:"stack_delimiter"`
	URL            string  `mapstructure:"url"`
}

type InMemoryStore

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

InMemoryStore implements the Store interface with an in-memory map

func (*InMemoryStore) Get

func (s *InMemoryStore) Get(stack, component, key string) (interface{}, error)

Get retrieves a value from memory

func (*InMemoryStore) Set

func (s *InMemoryStore) Set(stack, component, key string, value interface{}) error

Set stores a value in memory

type SSMClient

type SSMClient interface {
	PutParameter(ctx context.Context, params *ssm.PutParameterInput, optFns ...func(*ssm.Options)) (*ssm.PutParameterOutput, error)
	GetParameter(ctx context.Context, params *ssm.GetParameterInput, optFns ...func(*ssm.Options)) (*ssm.GetParameterOutput, error)
}

SSMClient interface allows us to mock the AWS SSM client

type SSMStore

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

SSMStore is an implementation of the Store interface for AWS SSM Parameter Store.

func (*SSMStore) Get

func (s *SSMStore) Get(stack string, component string, key string) (interface{}, error)

Get retrieves a value by key from AWS SSM Parameter Store.

func (*SSMStore) Set

func (s *SSMStore) Set(stack string, component string, key string, value interface{}) error

Set stores a key-value pair in AWS SSM Parameter Store.

type SSMStoreOptions

type SSMStoreOptions struct {
	Prefix         *string `mapstructure:"prefix"`
	Region         string  `mapstructure:"region"`
	StackDelimiter *string `mapstructure:"stack_delimiter"`
}

type Store

type Store interface {
	Set(stack string, component string, key string, value interface{}) error
	Get(stack string, component string, key string) (interface{}, error)
}

Store defines the common interface for all store implementations.

func NewArtifactoryStore

func NewArtifactoryStore(options ArtifactoryStoreOptions) (Store, error)

func NewInMemoryStore

func NewInMemoryStore() (Store, error)

NewInMemoryStore initializes a new MemoryStore

func NewSSMStore

func NewSSMStore(options SSMStoreOptions) (Store, error)

NewInMemoryStore initializes a new MemoryStore.

type StoreConfig

type StoreConfig struct {
	Type    string                 `yaml:"type"`
	Options map[string]interface{} `yaml:"options"`
}

type StoreFactory

type StoreFactory func(options map[string]interface{}) (Store, error)

StoreFactory is a function type to initialize a new store.

type StoreRegistry

type StoreRegistry map[string]Store

func NewStoreRegistry

func NewStoreRegistry(config *StoresConfig) (StoreRegistry, error)

type StoresConfig

type StoresConfig = map[string]StoreConfig