satellitedbtest

Documentation

Index

• func Bench(b *testing.B, bench func(b *testing.B, db satellite.DB))
• func NewPostgres(log *zap.Logger, schema string) (satellite.DB, error)
• func PostgresDefined() error
• func Run(t *testing.T, test func(t *testing.T, db satellite.DB))
• func SchemaName(testname, category string, index int, schemaSuffix string) string
• func SchemaSuffix() string
• type Database
• type SatelliteDatabases
  • func Databases() []SatelliteDatabases
• type SchemaDB
  • func (db *SchemaDB) Close() error
  • func (db *SchemaDB) CreateTables() error
  • func (db *SchemaDB) TestDBAccess() *dbx.DB

Functions

func Bench

func Bench(b *testing.B, bench func(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 NewPostgres

func NewPostgres(log *zap.Logger, schema string) (satellite.DB, error)

NewPostgres returns the default postgres satellite.DB for testing.

func PostgresDefined

func PostgresDefined() error

PostgresDefined returns an error when the --postgres-test-db or STORJ_POSTGRES_TEST is not set for tests.

func Run

func Run(t *testing.T, test func(t *testing.T, db satellite.DB))

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 Database

type Database struct {
	Name    string
	URL     string
	Message string
}

Database describes a test database

type SatelliteDatabases

type SatelliteDatabases struct {
	MasterDB  Database
	PointerDB Database
}

SatelliteDatabases maybe name can be better

func Databases

func Databases() []SatelliteDatabases

Databases returns default databases.

type SchemaDB

type SchemaDB struct {
	satellite.DB

	Schema   string
	AutoDrop bool
}

SchemaDB implements automatic schema handling for satellite.DB

func (*SchemaDB) Close

func (db *SchemaDB) Close() error

Close closes the database and drops the schema, when `AutoDrop` is set.

func (*SchemaDB) CreateTables

func (db *SchemaDB) CreateTables() error

CreateTables creates the schema and creates tables.

func (*SchemaDB) TestDBAccess

func (db *SchemaDB) TestDBAccess() *dbx.DB

TestDBAccess for raw database access, should not be used outside of migration tests.