dbtestutil

Documentation

Index

• func DumpOnFailure(t testing.TB, connectionURL string)
• func NewDB(t testing.TB, opts ...Option) (database.Store, pubsub.Pubsub)
• func NewDBWithSQLDB(t testing.TB, opts ...Option) (database.Store, pubsub.Pubsub, *sql.DB)
• func Open() (string, func(), error)
• func OpenContainerized(port int) (string, func(), error)
• func PGDump(dbURL string) ([]byte, error)
• func PGDumpSchemaOnly(dbURL string) ([]byte, error)
• func WillUsePostgres() bool
• type Connector
  • func (c *Connector) Connect(_ context.Context) (driver.Conn, error)
  • func (c *Connector) Dialer(dialer pq.Dialer)
  • func (c *Connector) Driver() driver.Driver
• type DBTx
  • func StartTx(t *testing.T, db database.Store, opts *database.TxOptions) *DBTx
  • func (tx *DBTx) Done() error
• type Driver
  • func NewDriver() *Driver
  • func (d *Driver) Close()
  • func (d *Driver) Connector(name string) (driver.Connector, error)
  • func (d *Driver) Open(name string) (driver.Conn, error)
• type Option
  • func WithDumpOnFailure() Option
  • func WithLogger(logger slog.Logger) Option
  • func WithTimezone(tz string) Option
  • func WithURL(u string) Option

Functions

func DumpOnFailure

func DumpOnFailure(t testing.TB, connectionURL string)

DumpOnFailure exports the database referenced by connectionURL to a file corresponding to the current test, with a suffix indicating the time the test was run. To import this into a new database (assuming you have already run make test-postgres-docker):

• Create a new test database: go run ./scripts/migrate-ci/main.go and note the database name it outputs
• Import the file into the above database: psql 'postgres://postgres:postgres@127.0.0.1:5432/<dbname>?sslmode=disable' -f <path to file.test.sql>
• Run a dev server against that database: ./scripts/coder-dev.sh server --postgres-url='postgres://postgres:postgres@127.0.0.1:5432/<dbname>?sslmode=disable'

func NewDB

func NewDB(t testing.TB, opts ...Option) (database.Store, pubsub.Pubsub)

func NewDBWithSQLDB

func NewDBWithSQLDB(t testing.TB, opts ...Option) (database.Store, pubsub.Pubsub, *sql.DB)

func Open

func Open() (string, func(), error)

Open creates a new PostgreSQL database instance. With DB_FROM environment variable set, it clones a database from the provided template. With the environment variable unset, it creates a new Docker container running postgres.

func OpenContainerized

func OpenContainerized(port int) (string, func(), error)

OpenContainerized creates a new PostgreSQL server using a Docker container. If port is nonzero, forward host traffic to that port to the database. If port is zero, allocate a free port from the OS.

func PGDump

func PGDump(dbURL string) ([]byte, error)

PGDump runs pg_dump against dbURL and returns the output. It is used by DumpOnFailure().

func PGDumpSchemaOnly

func PGDumpSchemaOnly(dbURL string) ([]byte, error)

PGDumpSchemaOnly is for use by gen/dump only. It runs pg_dump against dbURL and sets a consistent timezone and encoding.

func WillUsePostgres

func WillUsePostgres() bool

WillUsePostgres returns true if a call to NewDB() will return a real, postgres-backed Store and Pubsub.

Types

type Connector

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

func (*Connector) Connect

func (c *Connector) Connect(_ context.Context) (driver.Conn, error)

func (*Connector) Dialer

func (c *Connector) Dialer(dialer pq.Dialer)

func (*Connector) Driver

func (c *Connector) Driver() driver.Driver

type DBTx

type DBTx struct {
	database.Store
	// contains filtered or unexported fields
}

func StartTx

func StartTx(t *testing.T, db database.Store, opts *database.TxOptions) *DBTx

StartTx starts a transaction and returns a DBTx object. This allows running 2 transactions concurrently in a test more easily. Example:

a := StartTx(t, db, opts)
b := StartTx(t, db, opts)

a.GetUsers(...)
b.GetUsers(...)

require.NoError(t, a.Done()

func (*DBTx) Done

func (tx *DBTx) Done() error

Done can only be called once. If you call it twice, it will panic.

type Driver

type Driver struct {
	Connections chan driver.Conn
}

func NewDriver

func NewDriver() *Driver

func (*Driver) Close

func (d *Driver) Close()

func (*Driver) Connector

func (d *Driver) Connector(name string) (driver.Connector, error)

func (*Driver) Open

func (d *Driver) Open(name string) (driver.Conn, error)

type Option

type Option func(*options)

func WithDumpOnFailure

func WithDumpOnFailure() Option

WithDumpOnFailure will dump the entire database on test failure.

func WithLogger

func WithLogger(logger slog.Logger) Option

func WithTimezone

func WithTimezone(tz string) Option

WithTimezone sets the database to the defined timezone.

func WithURL

func WithURL(u string) Option