tc

README

Testcontainer factories

Test container factories are sweet.DepFactory implementations that bootstrap starting containers for testing.

The containers

• clean themselves up after tests
• start up ready to serve traffic
  • client tests should never have to call time.Sleep before testing
  • client tests should never fail due to a container dependency not being ready
• start tests as soon as they're ready to serve traffic
  • client tests should not be waiting because a factory is calling time.Sleep

Links

• Project overview and related information

Documentation

Index

• func NewContainer(t *testing.T, ctx context.Context, c Container) testcontainers.Container
• func NewFactory(ctx context.Context, c Container) func(t *testing.T) testcontainers.Container
• type Container

Functions

func NewContainer

func NewContainer(t *testing.T, ctx context.Context, c Container) testcontainers.Container

NewContainer sets up and runs a docker container for the given image.

The container is cleaned up when the test ends.

func NewFactory

func NewFactory(ctx context.Context, c Container) func(t *testing.T) testcontainers.Container

NewFactory generates a sweet compatible DepFactory that spins up Redis test containers of the given image.

Types

type Container

type Container interface {
	Request() testcontainers.ContainerRequest
	Close(ctx context.Context, container testcontainers.Container) error
}