pgtest

README

go-pgtest

Import github.com/charlieparkes/go-pgtest.

Example

For a full example, see examples/.

    p, err := pgtest.NewPostgres(ctx)
    pool, err := p.Connect(ctx)
    p.TearDown(ctx)

Documentation

Index

• Constants
• func Columns(i interface{}) []string
• func ValidateModel(ctx context.Context, f *Postgres, databaseName string, i interface{}) error
• func ValidateModels(ctx context.Context, f *Postgres, databaseName string, i ...interface{}) error
• type ConnOpt
  • func ConnOptCreateCopy() ConnOpt
  • func ConnOptDatabase(database string) ConnOpt
  • func ConnOptRole(role string) ConnOpt
• type ConnectionSettings
  • func (cs *ConnectionSettings) Config() (*pgx.ConnConfig, error)
  • func (cs *ConnectionSettings) Connect(ctx context.Context) (*pgx.Conn, error)
  • func (cs *ConnectionSettings) Copy() *ConnectionSettings
  • func (cs *ConnectionSettings) DSN() string
  • func (cs *ConnectionSettings) PoolConfig() (*pgxpool.Config, error)
  • func (cs *ConnectionSettings) String() string
  • func (cs *ConnectionSettings) URL() string
• type Opt
  • func OptExpireAfter(expireAfter uint) Opt
  • func OptLogger(logger *zap.Logger) Opt
  • func OptMounts(mounts []string) Opt
  • func OptName(name string) Opt
  • func OptNetworkName(networkName string) Opt
  • func OptRepo(repo string) Opt
  • func OptSettings(settings *ConnectionSettings) Opt
  • func OptSkipTearDown() Opt
  • func OptTimeoutAfter(timeoutAfter uint) Opt
  • func OptVersion(version string) Opt
• type Postgres
  • func Must(p *Postgres, err error) *Postgres
  • func NewPostgres(ctx context.Context, opts ...Opt) (*Postgres, error)
  • func (f *Postgres) Connect(ctx context.Context, opts ...ConnOpt) (*pgxpool.Pool, error)
  • func (f *Postgres) CopyDatabase(ctx context.Context, source string, target string) error
  • func (f *Postgres) CreateDatabase(ctx context.Context, name string) error
  • func (f *Postgres) DropDatabase(ctx context.Context, name string) error
  • func (f *Postgres) Dump(ctx context.Context, dir string, filename string) error
  • func (f *Postgres) HostName() string
  • func (f *Postgres) LoadSql(ctx context.Context, path string) error
  • func (f *Postgres) LoadSqlPattern(ctx context.Context, pattern string) error
  • func (f *Postgres) MustConnect(ctx context.Context, opts ...ConnOpt) *pgxpool.Pool
  • func (f *Postgres) Ping(ctx context.Context) error
  • func (f *Postgres) PingPsql(ctx context.Context) error
  • func (f *Postgres) Psql(ctx context.Context, cmd []string, mounts []string, quiet bool) (int, error)
  • func (p *Postgres) RecoverTearDown(ctx context.Context)
  • func (f *Postgres) Restore(ctx context.Context, dir string, filename string) error
  • func (f *Postgres) SetUp(ctx context.Context) error
  • func (f *Postgres) Settings() *ConnectionSettings
  • func (f *Postgres) TableColumns(ctx context.Context, database, schema, table string) ([]string, error)
  • func (f *Postgres) TableExists(ctx context.Context, database, schema, table string) (bool, error)
  • func (f *Postgres) Tables(ctx context.Context, database string) ([]string, error)
  • func (p *Postgres) TearDown(ctx context.Context) error
  • func (f *Postgres) WaitForReady(ctx context.Context, d time.Duration) error

Constants

const (
	DEFAULT_POSTGRES_REPO    = "postgres"
	DEFAULT_POSTGRES_VERSION = "13-alpine"
)

Functions

func Columns

func Columns(i interface{}) []string

Given a struct, return the expected column names.

func ValidateModel

func ValidateModel(ctx context.Context, f *Postgres, databaseName string, i interface{}) error

ValidateModel checks that a given struct is a valid representation of a database table.

1. Validate table name (using gorm-style TableName() or name-to-snake)
2. Validate columns exist.

func ValidateModels

func ValidateModels(ctx context.Context, f *Postgres, databaseName string, i ...interface{}) error

ValidateModels checks that the given structs are valid representations of a database tables.

1. Validate table name (using gorm-style TableName() or name-to-snake)
2. Validate columns exist.

Types

type ConnOpt

type ConnOpt func(*connConfig)

func ConnOptCreateCopy

func ConnOptCreateCopy() ConnOpt

func ConnOptDatabase

func ConnOptDatabase(database string) ConnOpt

func ConnOptRole

func ConnOptRole(role string) ConnOpt

type ConnectionSettings

type ConnectionSettings struct {
	Host         string
	Port         string
	User         string
	Password     string
	Database     string
	DisableSSL   bool
	MaxOpenConns int
}

Since you shouldn't create a pgx.ConnConfig from scratch, ConnectionSettings exists to hold all the parameters we'll need to work with throughout the lifecycle of a postgres database throughout tests.

func (*ConnectionSettings) Config

func (cs *ConnectionSettings) Config() (*pgx.ConnConfig, error)

func (*ConnectionSettings) Connect

func (cs *ConnectionSettings) Connect(ctx context.Context) (*pgx.Conn, error)

func (*ConnectionSettings) Copy

func (cs *ConnectionSettings) Copy() *ConnectionSettings

func (*ConnectionSettings) DSN

func (cs *ConnectionSettings) DSN() string

func (*ConnectionSettings) PoolConfig

func (cs *ConnectionSettings) PoolConfig() (*pgxpool.Config, error)

func (*ConnectionSettings) String

func (cs *ConnectionSettings) String() string

func (*ConnectionSettings) URL

func (cs *ConnectionSettings) URL() string

type Opt

type Opt func(*Postgres)

func OptExpireAfter

func OptExpireAfter(expireAfter uint) Opt

Tell docker to kill the container after an unreasonable amount of test time to prevent orphans. Defaults to 600 seconds.

func OptLogger

func OptLogger(logger *zap.Logger) Opt

func OptMounts

func OptMounts(mounts []string) Opt

func OptName

func OptName(name string) Opt

func OptNetworkName

func OptNetworkName(networkName string) Opt

func OptRepo

func OptRepo(repo string) Opt

func OptSettings

func OptSettings(settings *ConnectionSettings) Opt

func OptSkipTearDown

func OptSkipTearDown() Opt

func OptTimeoutAfter

func OptTimeoutAfter(timeoutAfter uint) Opt

Wait this long for operations to execute. Defaults to 30 seconds.

func OptVersion

func OptVersion(version string) Opt

type Postgres

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

func Must

func Must(p *Postgres, err error) *Postgres

func NewPostgres

func NewPostgres(ctx context.Context, opts ...Opt) (*Postgres, error)

func (*Postgres) Connect

func (f *Postgres) Connect(ctx context.Context, opts ...ConnOpt) (*pgxpool.Pool, error)

func (*Postgres) CopyDatabase

func (f *Postgres) CopyDatabase(ctx context.Context, source string, target string) error

CopyDatabase creates a copy of an existing postgres database using `createdb --template={source} {target}` source will default to the primary database

func (*Postgres) CreateDatabase

func (f *Postgres) CreateDatabase(ctx context.Context, name string) error

func (*Postgres) DropDatabase

func (f *Postgres) DropDatabase(ctx context.Context, name string) error

func (*Postgres) Dump

func (f *Postgres) Dump(ctx context.Context, dir string, filename string) error

func (*Postgres) HostName

func (f *Postgres) HostName() string

func (*Postgres) LoadSql

func (f *Postgres) LoadSql(ctx context.Context, path string) error

LoadSql runs a file or directory of *.sql files against the default postgres database.

func (*Postgres) LoadSqlPattern

func (f *Postgres) LoadSqlPattern(ctx context.Context, pattern string) error

LoadSqlPattern finds files matching a custom pattern and runs them against the default database.

func (*Postgres) MustConnect

func (f *Postgres) MustConnect(ctx context.Context, opts ...ConnOpt) *pgxpool.Pool

func (*Postgres) Ping

func (f *Postgres) Ping(ctx context.Context) error

func (*Postgres) PingPsql

func (f *Postgres) PingPsql(ctx context.Context) error

func (*Postgres) Psql

func (f *Postgres) Psql(ctx context.Context, cmd []string, mounts []string, quiet bool) (int, error)

func (*Postgres) RecoverTearDown

func (p *Postgres) RecoverTearDown(ctx context.Context)

func (*Postgres) Restore

func (f *Postgres) Restore(ctx context.Context, dir string, filename string) error

func (*Postgres) SetUp

func (f *Postgres) SetUp(ctx context.Context) error

func (*Postgres) Settings

func (f *Postgres) Settings() *ConnectionSettings

func (*Postgres) TableColumns

func (f *Postgres) TableColumns(ctx context.Context, database, schema, table string) ([]string, error)

func (*Postgres) TableExists

func (f *Postgres) TableExists(ctx context.Context, database, schema, table string) (bool, error)

func (*Postgres) Tables

func (f *Postgres) Tables(ctx context.Context, database string) ([]string, error)

func (*Postgres) TearDown

func (p *Postgres) TearDown(ctx context.Context) error

func (*Postgres) WaitForReady

func (f *Postgres) WaitForReady(ctx context.Context, d time.Duration) error

https://github.com/ory/dockertest/blob/v3/examples/PostgreSQL.md https://stackoverflow.com/a/63011266