eltest

README

eltest - Elephant test

Support library for writing elephant tests.

Takes care of setting up Postgres and Minio containers for intergration tests. See tests for usage, and don't miss setting up TestMain() in your own service:

func TestMain(m *testing.M) {
	code := m.Run()

	err := eltest.PurgeBackingServices()
	if err != nil {
		log.Printf("failed to purge backing services: %v", err)
	}

	os.Exit(code)
}

Documentation

Index

• func Bootstrap[T BackingService](id string, srv T) (T, error)
• func Must(t T, err error, actionFormat string, a ...any)
• func PurgeBackingServices() error
• type BackingService
• type Minio
  • func NewMinio(t T) *Minio
  • func (m *Minio) Client() (*minio.Client, error)
  • func (m *Minio) CreateBucket(t T, ctx context.Context, prefix string) string
  • func (m *Minio) Environment() MinioEnvironment
  • func (m *Minio) Purge(pool *dockertest.Pool) error
  • func (m *Minio) SetUp(pool *dockertest.Pool) error
• type MinioEnvironment
• type PGEnvironment
  • func (env *PGEnvironment) Migrator(t T, ctx context.Context, conn *pgx.Conn) *migrate.Migrator
• type Postgres
  • func NewPostgres(t T) *Postgres
  • func (pg *Postgres) Database(t T, migrations fs.FS, runMigrations bool) PGEnvironment
  • func (pg *Postgres) Purge(pool *dockertest.Pool) error
  • func (pg *Postgres) SetUp(pool *dockertest.Pool) error
• type T

Functions

func Bootstrap

func Bootstrap[T BackingService](id string, srv T) (T, error)

func Must

func Must(t T, err error, actionFormat string, a ...any)

func PurgeBackingServices

func PurgeBackingServices() error

Types

type BackingService

type BackingService interface {
	SetUp(pool *dockertest.Pool) error
	Purge(pool *dockertest.Pool) error
}

type Minio

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

func NewMinio

func NewMinio(t T) *Minio

func (*Minio) Client

func (m *Minio) Client() (*minio.Client, error)

func (*Minio) CreateBucket

func (m *Minio) CreateBucket(t T, ctx context.Context, prefix string) string

CreateBucket with the given prefix and a suffix based on the test name.

func (*Minio) Environment

func (m *Minio) Environment() MinioEnvironment

func (*Minio) Purge

func (m *Minio) Purge(pool *dockertest.Pool) error

func (*Minio) SetUp

func (m *Minio) SetUp(pool *dockertest.Pool) error

type MinioEnvironment

type MinioEnvironment struct {
	Endpoint string
	ID       string
	Secret   string
}

type PGEnvironment

type PGEnvironment struct {
	PostgresURI string
	// contains filtered or unexported fields
}

func (*PGEnvironment) Migrator

func (env *PGEnvironment) Migrator(t T, ctx context.Context, conn *pgx.Conn) *migrate.Migrator

type Postgres

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

func NewPostgres

func NewPostgres(t T) *Postgres

func (*Postgres) Database

func (pg *Postgres) Database(
	t T,
	migrations fs.FS,
	runMigrations bool,
) PGEnvironment

func (*Postgres) Purge

func (pg *Postgres) Purge(pool *dockertest.Pool) error

func (*Postgres) SetUp

func (pg *Postgres) SetUp(pool *dockertest.Pool) error

type T

type T interface {
	Name() string
	Helper()
	Fatalf(format string, args ...any)
}