satellitedbtest

Documentation

Index

• func Bench(b *testing.B, ...)
• func CreateMasterDB(ctx context.Context, log *zap.Logger, name string, category string, index int, ...) (db satellite.DB, err error)
• func CreateMasterDBOnTopOf(ctx context.Context, log *zap.Logger, tempDB *dbutil.TempDatabase, ...) (db satellite.DB, err error)
• func CreateMetabaseDB(ctx context.Context, log *zap.Logger, name string, category string, index int, ...) (db *metabase.DB, err error)
• func CreateMetabaseDBOnTopOf(ctx context.Context, log *zap.Logger, tempDB *dbutil.TempDatabase, ...) (*metabase.DB, error)
• func CreateTempDB(ctx context.Context, log *zap.Logger, tcfg TempDBSchemaConfig, dbInfo Database) (db *dbutil.TempDatabase, err error)
• func Run(t *testing.T, ...)
• func SchemaName(testname, category string, index int, schemaSuffix string) string
• func SchemaSuffix() string
• type ConfigOption
  • func WithSpanner() ConfigOption
• type Database
• type SatelliteDatabases
  • func Databases() []SatelliteDatabases
• type TempDBSchemaConfig

Functions

func Bench

func Bench(b *testing.B, bench func(ctx *testcontext.Context, b *testing.B, db satellite.DB))

Bench method will iterate over all supported databases. Will establish connection and will create tables for each DB.

func CreateMasterDB

func CreateMasterDB(ctx context.Context, log *zap.Logger, name string, category string, index int, dbInfo Database, applicationName string) (db satellite.DB, err error)

CreateMasterDB creates a new satellite database for testing.

func CreateMasterDBOnTopOf

func CreateMasterDBOnTopOf(ctx context.Context, log *zap.Logger, tempDB *dbutil.TempDatabase, applicationName string) (db satellite.DB, err error)

CreateMasterDBOnTopOf creates a new satellite database on top of an already existing temporary database.

func CreateMetabaseDB

func CreateMetabaseDB(ctx context.Context, log *zap.Logger, name string, category string, index int, dbInfo Database, config metabase.Config) (db *metabase.DB, err error)

CreateMetabaseDB creates a new satellite metabase for testing.

func CreateMetabaseDBOnTopOf

func CreateMetabaseDBOnTopOf(ctx context.Context, log *zap.Logger, tempDB *dbutil.TempDatabase, config metabase.Config) (*metabase.DB, error)

CreateMetabaseDBOnTopOf creates a new metabase on top of an already existing temporary database.

func CreateTempDB

func CreateTempDB(ctx context.Context, log *zap.Logger, tcfg TempDBSchemaConfig, dbInfo Database) (db *dbutil.TempDatabase, err error)

CreateTempDB creates a new temporary database (Cockroach or Postgresql).

func Run

func Run(t *testing.T, test func(ctx *testcontext.Context, t *testing.T, db satellite.DB), configOptions ...ConfigOption)

Run method will iterate over all supported databases. Will establish connection and will create tables for each DB.

func SchemaName

func SchemaName(testname, category string, index int, schemaSuffix string) string

SchemaName returns a properly formatted schema string.

func SchemaSuffix

func SchemaSuffix() string

SchemaSuffix returns a suffix for schemas.

Types

type ConfigOption

type ConfigOption func(c *config)

ConfigOption modifies a satellitedbtest configuration to provide test specific options.

func WithSpanner

func WithSpanner() ConfigOption

WithSpanner configures config to enable tests to run on spanner.

type Database

type Database struct {
	Name    string
	URL     string
	Message string
}

Database describes a test database.

type SatelliteDatabases

type SatelliteDatabases struct {
	Name       string
	MasterDB   Database
	MetabaseDB Database
}

SatelliteDatabases maybe name can be better.

func Databases

func Databases() []SatelliteDatabases

Databases returns default databases.

type TempDBSchemaConfig

type TempDBSchemaConfig struct {
	Name     string
	Category string
	Index    int
}

TempDBSchemaConfig defines parameters required for the temp database.