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 AtlasDirMigrator
  • func NewAtlasDirMigrator(migrationsDirPath string, atlasEnv string, atlasConfig string, ...) *AtlasDirMigrator
  • func (m *AtlasDirMigrator) Hash() (string, error)
  • func (m *AtlasDirMigrator) Migrate(ctx context.Context, _ *sql.DB, templateConf pgtestdb.Config) error
• type SnapshotMigrator
  • func (m SnapshotMigrator[T]) Hash() (string, error)
  • func (m SnapshotMigrator[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 AtlasDirMigrator

type AtlasDirMigrator struct {
	MigrationsDirPath string
	AtlasEnv          string
	AtlasConfig       string
	// contains filtered or unexported fields
}

AtlasDirMigrator is a pgtestdb.Migrator that uses the `atlas` CLI tool to perform migrations.

atlas migrate apply --url $DB --dir file://$migrationsDirPath

AtlasDirMigrator requires that it runs in an environment where the `atlas` CLI is in the $PATH. It shells out to that program to perform its migrations, as recommended by the Atlas maintainers.

AtlasDirMigrator does not perform any Verify() or Prepare() logic.

func NewAtlasDirMigrator

func NewAtlasDirMigrator(
	migrationsDirPath string,
	atlasEnv string,
	atlasConfig string,
	execute func(ctx context.Context, stdin io.Reader, program string, args ...string) (string, error),
) *AtlasDirMigrator

NewAtlasDirMigrator returns a AtlasDirMigrator, which is a pgtestdb.Migrator that uses the `atlas` CLI tool to perform migrations.

atlas migrate apply --url $DB --dir file://$migrationsDirPath

func (*AtlasDirMigrator) Hash

func (m *AtlasDirMigrator) Hash() (string, error)

func (*AtlasDirMigrator) Migrate

func (m *AtlasDirMigrator) Migrate(
	ctx context.Context,
	_ *sql.DB,
	templateConf pgtestdb.Config,
) error

Migrate shells out to the `atlas` CLI program to migrate the template database.

atlas migrate apply --url $DB --dir file://$migrationsDirPath

type SnapshotMigrator

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

SnapshotMigrator loads a migration from a postgres dump file.

func (SnapshotMigrator[T]) Hash

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

Hash implements the migrater interface.

func (SnapshotMigrator[T]) Migrate

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

Migrate performs the actual migration.