spawner

Documentation

Overview

Package spawner implements the Spawner service to launch arbitrary binaries for use in tests.

Index

• func New(poolMaxWait time.Duration) (pb.SpawnerServiceServer, error)
• func NewPostgres(ctx context.Context, dockerTag string, ttl time.Duration) (*pb.PostgresResponse, func(context.Context) error, error)
• func NewPostgresT(ctx context.Context, tb testing.TB, dockerTag string, ttl time.Duration) *pb.PostgresResponse
• func NewT(tb testing.TB, poolMaxWait time.Duration) pb.SpawnerServiceServer

Functions

func New

func New(poolMaxWait time.Duration) (pb.SpawnerServiceServer, error)

New returns a newly constructed SpawnerServiceServer. Set poolMaxWait to 0 to use the default dockertest.Pool value (1 minute at time of writing).

func NewPostgres

func NewPostgres(ctx context.Context, dockerTag string, ttl time.Duration) (*pb.PostgresResponse, func(context.Context) error, error)

NewPostgres spawns a new PostgreSQL instance. The returned cleanup function MUST be called to kill the instance.

func NewPostgresT

func NewPostgresT(ctx context.Context, tb testing.TB, dockerTag string, ttl time.Duration) *pb.PostgresResponse

NewPostgresT is equivalent to NewPostGres() except that failures to spawn are reported on tb.Fatal(), and Kill() is called in tb.Cleanup().

func NewT

func NewT(tb testing.TB, poolMaxWait time.Duration) pb.SpawnerServiceServer

NewT is a convenience function for using New() in Go tests. All errors are reported on tb.Fatal().