store

type Component ¶

type Component struct {
	Memory *MemoryComponent
	Dynamo *DynamoComponent
}

Component is the top level aggregate of all store components.

func NewComponent() *Component

func (c *Component) New(ctx context.Context, conf *Config) (domain.Store, error)

func (c *Component) Settings() *Config

type Config ¶

type Config struct {
	Type   string `description:"The type of data store to use for results tracking."`
	Memory *MemoryConfig
	Dynamo *DynamoConfig
}

Config is the top level aggregate of all store implemenations.

func (*Config) Name() string

type DynamoComponent ¶

type DynamoComponent struct {
	DynamoDB *awscmp.DynamoDBComponent
}

DynamoComponent implements the component interface for the in-memory option.

func NewDynamoComponent() *DynamoComponent

func (c *DynamoComponent) New(ctx context.Context, conf *DynamoConfig) (domain.Store, error)

func (c *DynamoComponent) Settings() *DynamoConfig

type DynamoConf ¶

type DynamoConf struct {
	*awscmp.DynamoDBConfig
}

DynamoConf wraps the original config to add a name.

func (*DynamoConf) Name() string

type DynamoConfig ¶

type DynamoConfig struct {
	TableName    string `description:"The name of the DynamoDB table to use."`
	PartitionKey string `description:"Name of the table partition key."`
	TTLKey       string `description:"Name of the TTL key."`
	AWS          *DynamoConf
}

DynamoConfig contains all settings for the in-memory component.

func (*DynamoConfig) Name() string

type DynamoDB ¶

type DynamoDB struct {
	Client           dynamodbiface.DynamoDBAPI
	TableName        string
	PartitionKeyName string
	TTLKeyName       string
}

DynamoDB implements store using AWS DynamoDB.

func (s *DynamoDB) Load(ctx context.Context, identifier string) ([]domain.Finding, error)

func (s *DynamoDB) Mark(ctx context.Context, identifier string) error

func (s *DynamoDB) Set(ctx context.Context, identifier string, findings []domain.Finding) error

type Memory ¶

type Memory struct {
	Map sync.Map
}

Memory is an in-memory implementation of the store. This may be used for cases where only one instance of the service is running but is not compatible with multi-node deployments.

Note: This implementation does not clean up after itself and will grow unbounded over time. This is not for production use.

func (s *Memory) Load(ctx context.Context, identifier string) ([]domain.Finding, error)

func (s *Memory) Mark(ctx context.Context, identifier string) error

func (s *Memory) Set(ctx context.Context, identifier string, findings []domain.Finding) error

type MemoryComponent ¶

type MemoryComponent struct{}

MemoryComponent implements the component interface for the in-memory option.

func NewMemoryComponent() *MemoryComponent

func (*MemoryComponent) New(ctx context.Context, conf *MemoryConfig) (domain.Store, error)

func (*MemoryComponent) Settings() *MemoryConfig

type MemoryConfig ¶

type MemoryConfig struct{}

MemoryConfig contains all settings for the in-memory component.

func (*MemoryConfig) Name() string