testing

Documentation

Overview

Package testing provides helpers for running migrations against an ephemeral SQLite database, useful for unit and integration tests.

Importing this package introduces a transitive dependency on the SQLite driver and the migrations engine; tests in production code may want a thinner harness.

Index

• Variables
• func AssertExists(t testing.TB, conn *database.Connection, table string, where map[string]any)
• func AssertMissing(t testing.TB, conn *database.Connection, table string, where map[string]any)
• func MustMigrate(t testing.TB, conn *database.Connection)
• func Require(t testing.TB, err error)
• func SQLite(t testing.TB, options ...Option) (*database.Connection, func())
• type Option
  • func WithLogger(l *logger.Logger) Option
  • func WithMemory(v bool) Option
  • func WithMigrate(v bool) Option
  • func WithRegistry(r *migrations.Registry) Option

Variables

var ErrAssertion = errors.New("testing: assertion failed")

SentinelError ensures errors are not silently dropped.

Functions

func AssertExists

func AssertExists(t testing.TB, conn *database.Connection, table string, where map[string]any)

AssertExists fails if the row matching where does not exist.

func AssertMissing

func AssertMissing(t testing.TB, conn *database.Connection, table string, where map[string]any)

AssertMissing fails if a row matching where exists.

func MustMigrate

func MustMigrate(t testing.TB, conn *database.Connection)

MustMigrate runs the migrator and fails t on error.

func Require

func Require(t testing.TB, err error)

Require fails t if err is non-nil.

func SQLite

func SQLite(t testing.TB, options ...Option) (*database.Connection, func())

SQLite opens a temporary SQLite database, runs all registered migrations, and returns a connection and a cleanup function. Use it inside TestMain or individual tests.

Types

type Option

type Option func(*opts)

Option configures the harness.

func WithLogger

func WithLogger(l *logger.Logger) Option

WithLogger enables SQL logging on the connection.

func WithMemory

func WithMemory(v bool) Option

WithMemory toggles the in-memory database (default true).

func WithMigrate

func WithMigrate(v bool) Option

WithMigrate toggles automatic migration on open.

func WithRegistry

func WithRegistry(r *migrations.Registry) Option

WithRegistry overrides the migrations registry.