eltest

package module
v0.3.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jul 20, 2026 License: MIT Imports: 16 Imported by: 0

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

Constants

View Source 
const (
	Minio202302 = "RELEASE.2023-02-22T18-23-45Z"
	Minio202509 = "RELEASE.2025-09-07T16-13-09Z"
)
View Source 
const (
	Postgres15_2 = "15.2"
	Postgres17_6 = "17.6-alpine3.22"
)
View Source 
const (
	// ValkeyRepo is the upstream Valkey image. Valkey is a community
	// fork of Redis kept under the BSD 3-clause license and exposes
	// the same RESP protocol, so applications targeting Redis work
	// unchanged.
	ValkeyRepo = "valkey/valkey"

	Valkey8_0 = "8.0"
	Valkey8_1 = "8.1"
)
View Source 
const OpenSearch2_19 = "v2.19.3-2"

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 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, tag string) *Minio

func (*Minio) Client 

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

func (*Minio) CreateBucket 

func (m *Minio) CreateBucket(ctx context.Context, t T, 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
	ContainerEndpoint 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) GetContainerEndpoint added in v0.2.2 

func (m *OpenSearch) GetContainerEndpoint() string

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
	ContainerPostgresURI string
	// contains filtered or unexported fields
}

func (*PGEnvironment) Migrator 

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

type Postgres 

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

func NewPostgres 

func NewPostgres(t T, tag string) *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())
}

type Valkey added in v0.3.0 

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

func NewValkey added in v0.3.0 

func NewValkey(t T, tag string) *Valkey

NewValkey bootstraps a Valkey container shared across tests in the process (or unique to the test if BootstrapService is used directly).

func (*Valkey) Client added in v0.3.0 

func (v *Valkey) Client() *redis.Client

Client returns a fresh go-redis client connected to the Valkey instance from the host. Tests that need redis interactions should call this for each test (or each goroutine) — clients are cheap and returning a shared one would let tests step on each other.

func (*Valkey) Environment added in v0.3.0 

func (v *Valkey) Environment() ValkeyEnvironment

func (*Valkey) Purge added in v0.3.0 

func (v *Valkey) Purge(pool *dockertest.Pool) error

func (*Valkey) SetUp added in v0.3.0 

func (v *Valkey) SetUp(pool *dockertest.Pool, network *dockertest.Network) error

type ValkeyEnvironment added in v0.3.0 

type ValkeyEnvironment struct {
	Addr          string
	ContainerAddr string
}

ValkeyEnvironment carries the addresses tests should use to reach the Valkey instance, both from the host (Addr) and from another container on the eltest network (ContainerAddr).

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.