fixtures

Documentation

Index

• func AddFixtureSetFactory(ctx context.Context, group string, factory FixtureSetsFactory) error
• func AddFixtureSetPostProcessorFactory(ctx context.Context, factories ...PostProcessorFactory) error
• func GetValueId(value any) (any, bool)
• type AutoNumbered
  • func NewAutoNumbered() AutoNumbered
  • func NewAutoNumberedFrom(initial uint) AutoNumbered
• type ByteSequence
  • func NewByteSequence(seed string) ByteSequence
• type Container
  • func ProvideContainer(ctx context.Context) (*Container, error)
  • func (c *Container) AddFixtureSetFactory(group string, factory FixtureSetsFactory)
  • func (c *Container) AddPostProcessorFactories(factory ...PostProcessorFactory)
  • func (c *Container) Build(ctx context.Context, config cfg.Config, logger log.Logger) (FixtureLoader, error)
• type FixtureLoader
  • func NewFixtureLoader(ctx context.Context, config cfg.Config, logger log.Logger, ...) (FixtureLoader, error)
  • func NewFixtureLoaderDisabled(logger log.Logger) FixtureLoader
• type FixtureSet
  • func NewSimpleFixtureSet[T any](fixtures NamedFixtures[T], writer FixtureWriter, options ...FixtureSetOption) FixtureSet
• type FixtureSetFactory
• type FixtureSetOption
  • func WithEnabled(enabled bool) FixtureSetOption
• type FixtureSetSettings
  • func NewFixtureSetSettings(options ...FixtureSetOption) *FixtureSetSettings
• type FixtureSetsFactory
  • func NewFixtureSetsFactory(factories ...FixtureSetFactory) FixtureSetsFactory
• type FixtureWriter
• type NamedFixture
  • func NewNamedFixture[T any](name string, value T) *NamedFixture[T]
• type NamedFixtures
  • func GetNamedFixtures(container any) []NamedFixtures[any]
  • func (l NamedFixtures[T]) All() []any
  • func (l NamedFixtures[T]) CountIf(f func(elem T) bool) int
  • func (l NamedFixtures[T]) FindAll(f func(elem T) bool) []T
  • func (l NamedFixtures[T]) FindFirst(f func(elem T) bool) (T, bool)
  • func (l NamedFixtures[T]) GetValueById(id any) T
  • func (l NamedFixtures[T]) GetValueByName(name string) T
  • func (l NamedFixtures[T]) Len() int
• type NumberSequence
  • func NewNumberSequence() NumberSequence
  • func NewNumberSequenceFrom(initial uint) NumberSequence
• type PostProcessor
• type PostProcessorFactory
• type UuidSequence
  • func NewUuidSequence(seed string) UuidSequence

Functions

func AddFixtureSetFactory

func AddFixtureSetFactory(ctx context.Context, group string, factory FixtureSetsFactory) error

func AddFixtureSetPostProcessorFactory

func AddFixtureSetPostProcessorFactory(ctx context.Context, factories ...PostProcessorFactory) error

func GetValueId

func GetValueId(value any) (any, bool)

Types

type AutoNumbered

type AutoNumbered NumberSequence

AutoNumbered is the old name for a NumberSequence

Deprecated: use NumberSequence instead

func NewAutoNumbered

func NewAutoNumbered() AutoNumbered

NewAutoNumbered is the old name for NewNumberSequence

Deprecated: use NewNumberSequence instead

func NewAutoNumberedFrom

func NewAutoNumberedFrom(initial uint) AutoNumbered

NewAutoNumberedFrom is the old name for NewNumberSequenceFrom

Deprecated: use NewNumberSequenceFrom instead

type ByteSequence

type ByteSequence interface {
	io.Reader
	// GetBytes returns a slice of n bytes filled with random-looking data.
	GetBytes(n int) []byte
}

func NewByteSequence

func NewByteSequence(seed string) ByteSequence

NewByteSequence provides a way to generate random-looking values for fixtures from a given seed. A possible use case would be to provide the name of the fixture set you are creating as the seed to get distinct values from other fixture sets, but having deterministic values compared to just generating random bytes for example.

type Container

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

func ProvideContainer

func ProvideContainer(ctx context.Context) (*Container, error)

func (*Container) AddFixtureSetFactory

func (c *Container) AddFixtureSetFactory(group string, factory FixtureSetsFactory)

func (*Container) AddPostProcessorFactories

func (c *Container) AddPostProcessorFactories(factory ...PostProcessorFactory)

func (*Container) Build

func (c *Container) Build(ctx context.Context, config cfg.Config, logger log.Logger) (FixtureLoader, error)

type FixtureLoader

type FixtureLoader interface {
	Load(ctx context.Context) error
}

func NewFixtureLoader

func NewFixtureLoader(ctx context.Context, config cfg.Config, logger log.Logger, fixtureSets map[string][]FixtureSet, postProcessors []PostProcessor) (FixtureLoader, error)

func NewFixtureLoaderDisabled

func NewFixtureLoaderDisabled(logger log.Logger) FixtureLoader

type FixtureSet

type FixtureSet interface {
	Write(ctx context.Context) error
}

func NewSimpleFixtureSet

func NewSimpleFixtureSet[T any](fixtures NamedFixtures[T], writer FixtureWriter, options ...FixtureSetOption) FixtureSet

type FixtureSetFactory

type FixtureSetFactory func(ctx context.Context, config cfg.Config, logger log.Logger) (FixtureSet, error)

type FixtureSetOption

type FixtureSetOption func(settings *FixtureSetSettings)

func WithEnabled

func WithEnabled(enabled bool) FixtureSetOption

type FixtureSetSettings

type FixtureSetSettings struct {
	Enabled bool
}

func NewFixtureSetSettings

func NewFixtureSetSettings(options ...FixtureSetOption) *FixtureSetSettings

type FixtureSetsFactory

type FixtureSetsFactory func(ctx context.Context, config cfg.Config, logger log.Logger, group string) ([]FixtureSet, error)

func NewFixtureSetsFactory

func NewFixtureSetsFactory(factories ...FixtureSetFactory) FixtureSetsFactory

type FixtureWriter

type FixtureWriter interface {
	Write(ctx context.Context, fixtures []any) error
}

type NamedFixture

type NamedFixture[T any] struct {
	Name  string
	Value T
}

func NewNamedFixture

func NewNamedFixture[T any](name string, value T) *NamedFixture[T]

type NamedFixtures

type NamedFixtures[T any] []*NamedFixture[T]

func GetNamedFixtures

func GetNamedFixtures(container any) []NamedFixtures[any]

func (NamedFixtures[T]) All

func (l NamedFixtures[T]) All() []any

All specifically returns a []any instead of a []T, so the fixture loader code doesn't complain that it can't cast a []T to []any

func (NamedFixtures[T]) CountIf

func (l NamedFixtures[T]) CountIf(f func(elem T) bool) int

func (NamedFixtures[T]) FindAll

func (l NamedFixtures[T]) FindAll(f func(elem T) bool) []T

func (NamedFixtures[T]) FindFirst

func (l NamedFixtures[T]) FindFirst(f func(elem T) bool) (T, bool)

func (NamedFixtures[T]) GetValueById

func (l NamedFixtures[T]) GetValueById(id any) T

func (NamedFixtures[T]) GetValueByName

func (l NamedFixtures[T]) GetValueByName(name string) T

func (NamedFixtures[T]) Len

func (l NamedFixtures[T]) Len() int

type NumberSequence

type NumberSequence interface {
	// GetNextInt returns the next number in the sequence as an integer
	GetNextInt() int
	// GetNextUint returns the next number in the sequence as an unsigned integer
	GetNextUint() uint
	// GetNextId is the same as GetNextUint, but returns a pointer to the result.
	// The returned id can be used to get a fresh id for a fixture if you don't want to
	// assign specific ids.
	GetNextId() *uint
	// GetNext is the old name of GetNextId
	// Deprecated: use GetNextId instead
	GetNext() *uint
}

func NewNumberSequence

func NewNumberSequence() NumberSequence

func NewNumberSequenceFrom

func NewNumberSequenceFrom(initial uint) NumberSequence

type PostProcessor

type PostProcessor interface {
	Process(ctx context.Context) error
}

type PostProcessorFactory

type PostProcessorFactory func(ctx context.Context, config cfg.Config, logger log.Logger) (PostProcessor, error)

type UuidSequence

type UuidSequence interface {
	uuid.Uuid
}

func NewUuidSequence

func NewUuidSequence(seed string) UuidSequence

NewUuidSequence provides a way to generate random-looking UUIDs for fixtures from a given seed. Use this for fixtures instead of generating random UUIDs to create distinct keys easily while also keeping the fixtures deterministic. A unique seed is required for each fixture set to ensure there are no collisions between the generated UUIDs.