eltest

package module

v0.2.0-pre4 Latest Latest Go to latest Published: Sep 8, 2025 License: MIT Imports: 16 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/ttab/eltest

Links

Open Source Insights

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[S BackingService](id string, srv S) (S, error)
func BootstrapService[S BackingService](id string, srv S, localTo T) (S, error)
func GetGatewayIP() (net.IP, error)
func GetNetwork() (*docker.Network, 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, network *dockertest.Network) error
type MinioEnvironment
type OpenSearch
- func NewOpenSearch(t T, tag string) *OpenSearch
- func (m *OpenSearch) GetEndpoint() string
- func (m *OpenSearch) Purge(pool *dockertest.Pool) error
- func (m *OpenSearch) SetUp(pool *dockertest.Pool, network *dockertest.Network) error
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, name string, migrations fs.FS, runMigrations bool) PGEnvironment
- func (pg *Postgres) Purge(pool *dockertest.Pool) error
- func (pg *Postgres) SetUp(pool *dockertest.Pool, network *dockertest.Network) error
type T

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Bootstrap ¶

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

func BootstrapService ¶ added in v0.2.0

func BootstrapService[S BackingService](id string, srv S, localTo T) (S, error)

func GetGatewayIP ¶ added in v0.2.0

func GetGatewayIP() (net.IP, error)

func GetNetwork ¶ added in v0.2.0

func GetNetwork() (*docker.Network, 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, network *dockertest.Network) 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, network *dockertest.Network) error

type MinioEnvironment ¶

type MinioEnvironment struct {
	Endpoint string
	ID       string
	Secret   string
}

type OpenSearch ¶ added in v0.2.0

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

func NewOpenSearch ¶ added in v0.2.0

func NewOpenSearch(t T, tag string) *OpenSearch

func (*OpenSearch) GetEndpoint ¶ added in v0.2.0

func (m *OpenSearch) GetEndpoint() string

func (*OpenSearch) Purge ¶ added in v0.2.0

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

func (*OpenSearch) SetUp ¶ added in v0.2.0

func (m *OpenSearch) SetUp(pool *dockertest.Pool, network *dockertest.Network) error

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,
	name string,
	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, network *dockertest.Network) error

type T ¶

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

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL