pgtesting

Documentation

Index

• func NewDB(t *testing.T, dbName string) *pgxpool.Pool
• type DockerContainerConfig
• type DockerizedPostgres
  • func StartDockerContainer(cfg DockerContainerConfig) (_ *DockerizedPostgres, teardownFn func(), err error)

Functions

func NewDB

func NewDB(t *testing.T, dbName string) *pgxpool.Pool

NewDB creates a new database named as a sanitized dbName. It returns a connection pool to this database. It must be called after StartDockerContainer.

Types

type DockerContainerConfig

type DockerContainerConfig struct {
	// DBName is the name of the postgres database.
	DBName string

	// Version is the Postgres version ran in the container (default is 13).
	Version string

	// Expire container that takes more than `Expire` seconds running.
	// It is very important to use when you are debugging and killed the
	// process before the call the teardown or if a panic happens.
	Expire uint
}

type DockerizedPostgres

type DockerizedPostgres struct {
	Pool *pgxpool.Pool
	Port string
}

func StartDockerContainer

func StartDockerContainer(cfg DockerContainerConfig) (_ *DockerizedPostgres, teardownFn func(), err error)