preloader

Documentation

Index

• Variables
• type Error
• type Preloader
  • func New(name string, sysDeps *system.SystemDependencies) (*Preloader, error)
  • func (p *Preloader) AddImage(ctx context.Context, image string) error
  • func (p *Preloader) Cleanup(ctx context.Context) error
  • func (p *Preloader) EmptyImages(ctx context.Context) error
  • func (p *Preloader) GetImages() []string
  • func (p *Preloader) RemoveImage(ctx context.Context, image string) error

Variables

var (
	ErrPreloaderNameAlreadyExists = errors.New("PreloaderNameAlreadyExists", "preloader name '%s' already exists")
)

Types

type Error

type Error = errors.Error

type Preloader

type Preloader struct {
	Name   string   `json:"name"`
	Images []string `json:"images"`
	*system.SystemDependencies
}

Preloader is a struct that contains the list of preloaded images. A preloader makes sure that the images are preloaded before the test suite starts. Hint: If you use a Preloader per test suite, you can save resources

func New

func New(name string, sysDeps *system.SystemDependencies) (*Preloader, error)

New creates a new preloader

func (*Preloader) AddImage

func (p *Preloader) AddImage(ctx context.Context, image string) error

AddImage adds an image to the list of preloaded images

func (*Preloader) Cleanup

func (p *Preloader) Cleanup(ctx context.Context) error

func (*Preloader) EmptyImages

func (p *Preloader) EmptyImages(ctx context.Context) error

EmptyImages empties the list of preloaded images

func (*Preloader) GetImages

func (p *Preloader) GetImages() []string

Images returns the list of preloaded images

func (*Preloader) RemoveImage

func (p *Preloader) RemoveImage(ctx context.Context, image string) error

RemoveImage removes an image from the list of preloaded images