riverdbtest

type TestSchemaOpts struct {
	// LineTargetVersions specify target versions for migration lines being
	// migrated. By default all lines are migrated all the way up, but this lets
	// tests migrate to an only partially applied version. This option is rarely
	// required.
	LineTargetVersions map[string]int

	// Lines are migration lines to run. By default, the migration lines
	// specified by the driver's GetMigrationDefaultLines function are run.
	//
	// Set to an empty non-nil slice like `[]string{}` to run no migrations.
	Lines []string

	// ProcurePool returns a database pool that will be set to the input driver
	// using Driver.PoolSet. This is an optional parameter and should usuall be
	// left unset. It exists for use with SQLite to generate a database pool for
	// use in testing after a test schema is available because unlike other
	// databases, test schemas in SQLite (which are actually test databases) are
	// not available between databases.
	//
	// The input schema is the name of the test schema to use. After the pool's
	// been procured, it'll either be migrated to current version or have its
	// tables truncated, depending on whether it's been reused or not.
	//
	// Returns a database pool (*sql.DB for SQLite) and a "user-facing schema
	// name", which is the schema used in River operations. In practice, this is
	// an empty string for SQLite because unlike other databases, schemas can't
	// be reference by their qualified name (operations must use `river_job`
	// instead of `schema.river_job`).
	ProcurePool func(ctx context.Context, schema string) (any, string)
	// contains filtered or unexported fields
}

type TestTxOpts struct {
	// DisableSchemaSharing prevents test transactions from trying to share a
	// schema, and instead falls back to procuring schemas for each transaction
	// run using TestSchema. This is meant for environments where parallelism
	// doesn't work as well, like SQLite, which will emit "busy" errors when
	// multiple clients try to share a schema, even when they're in separate
	// transactions.
	DisableSchemaSharing bool

	// IsTestTxHelper should be set to true for if TestTx is being called from
	// within a secondary helper that's in a common testing package. This causes
	// an extra stack frame to be skipped when determining the name of the test
	// schema being used for test transactions. So instead of `riverdbtest` or
	// `riverprodbtest` we get the real name of the package being tested (e.g.
	// `river` or `riverpro`).
	IsTestTxHelper bool

	// ProcurePool returns a database pool that will be set to the input driver
	// using Driver.PoolSet. This is an optional parameter and should usually be
	// left unset. It exists for use with SQLite to generate a database pool for
	// use in testing after a test schema is available because unlike other
	// databases, test schemas in SQLite (which are actually test databases) are
	// not available between databases.
	//
	// The input schema is the name of the test schema to use. After the pool's
	// been procured, it'll either be migrated to current version or have its
	// tables truncated, depending on whether it's been reused or not.
	//
	// Returns a database pool (*sql.DB for SQLite) and a "user-facing schema
	// name", which is the schema used in River operations. In practice, this is
	// an empty string for SQLite because unlike other databases, schemas can't
	// be reference by their qualified name (operations must use `river_job`
	// instead of `schema.river_job`).
	ProcurePool func(ctx context.Context, schema string) (any, string)
	// contains filtered or unexported fields
}