stdpgtest

Documentation

Overview

Package stdpgtest provides testing against a postgresql database.

Index

• func NewPgxTestDB(tb testing.TB, migrator pgtestdb.Migrator, setupConnStr string, ...) *pgtestdb.Config
• func SetupPgxPool(ctx context.Context, tb testing.TB, snapshotFile, connString string) *pgxpool.Pool
• type SnapshotMigrater
  • func (m SnapshotMigrater[T]) Hash() (string, error)
  • func (m SnapshotMigrater[T]) Migrate(ctx context.Context, db T, _ pgtestdb.Config) error

Functions

func NewPgxTestDB

func NewPgxTestDB(
	tb testing.TB,
	migrator pgtestdb.Migrator,
	setupConnStr string,
	testRole *pgtestdb.Role,
) *pgtestdb.Config

NewPgxTestDB will use the pgtestdb package to migrate, creates a isolated database and returns the connection string to that database..

func SetupPgxPool

func SetupPgxPool(ctx context.Context, tb testing.TB, snapshotFile, connString string) *pgxpool.Pool

SetupPgxPool will init a isolated test database from a connection string and a snapshot sql file.

Types

type SnapshotMigrater

type SnapshotMigrater[T interface {
	ExecContext(ctx context.Context, query string, args ...any) (sql.Result, error)
}] string

SnapshotMigrater loads a migration from a postgres dump file.

func (SnapshotMigrater[T]) Hash

func (m SnapshotMigrater[T]) Hash() (string, error)

Hash implements the migrater interface.

func (SnapshotMigrater[T]) Migrate

func (m SnapshotMigrater[T]) Migrate(ctx context.Context, db T, _ pgtestdb.Config) error

Migrate performs the actual migration.