pgtest

Documentation

Index

• func ApplyMigrations(t testing.TB, db *sql.DB, source fs.FS)
• func CreateDatabase(t testing.TB, db *sql.DB, databaseName, testDatabaseTemplateName string)
• func CreateTemplateDatabase(flags Flags, migrations fs.FS) error
• func DatabaseName(t testing.TB) string
• func DropDatabase(t testing.TB, db *sql.DB, databaseName string, force bool)
• func InitTestDatabase(t testing.TB, opts ...Option) *sql.DB
• type Flags
  • func FlagsFromEnv(t testing.TB, paths ...string) Flags
• type Option
  • func WithApplyMigrations(source fs.FS) Option
  • func WithConfigFiles(files ...string) Option
  • func WithFlags(flags Flags) Option

Functions

func ApplyMigrations

func ApplyMigrations(t testing.TB, db *sql.DB, source fs.FS)

ApplyMigrations applies migration to a provided database

func CreateDatabase

func CreateDatabase(t testing.TB, db *sql.DB, databaseName, testDatabaseTemplateName string)

CreateDatabase creates a new database within a PostgreSQL connection

func CreateTemplateDatabase

func CreateTemplateDatabase(flags Flags, migrations fs.FS) error

func DatabaseName

func DatabaseName(t testing.TB) string

DatabaseName creates a new database name with a random suffix.

func DropDatabase

func DropDatabase(t testing.TB, db *sql.DB, databaseName string, force bool)

DropDatabase drops database

func InitTestDatabase

func InitTestDatabase(t testing.TB, opts ...Option) *sql.DB

InitTestDatabase creates initializes a new dummy database in s PostgreSQL server

Types

type Flags

type Flags struct {
	Postgres             postgres.Flags `kong:"embed"`
	TestDatabaseTemplate string         `` /* 156-byte string literal not displayed */
}

func FlagsFromEnv

func FlagsFromEnv(t testing.TB, paths ...string) Flags

FlagsFromEnv returns an instance of flags.Postgres populated from environment variables or .env files.

type Option

type Option func(*config)

func WithApplyMigrations

func WithApplyMigrations(source fs.FS) Option

func WithConfigFiles

func WithConfigFiles(files ...string) Option

func WithFlags

func WithFlags(flags Flags) Option