ct

Documentation

Index

• Constants
• type IntroFunction
• type OutroFunction
• type TestDbParameters
  • func NewTestDbParameters(envVarNamePrefix string) (p *TestDbParameters, err error)
• type TestSuite
  • func NewTestSuite(t *testing.T, envVarNamePrefix string, intro []IntroFunction, ...) (ts *TestSuite, err error)
  • func (ts *TestSuite) GetHandle() (db *sql.DB)
  • func (ts *TestSuite) GetSchema() (schema string)
  • func (ts *TestSuite) Run()
• type TestedFunction

Constants

const (
	EnvVarNameBase_NetProtocol = "PROTO"  // E.g. "tcp".
	EnvVarNameBase_Driver      = "DRIVER" // E.g. "mysql".
	EnvVarNameBase_Host        = "HOST"   // E.g. "localhost".
	EnvVarNameBase_Port        = "PORT"   // E.g. "3306".
	EnvVarNameBase_Database    = "DB"
	EnvVarNameBase_User        = "USER"
	EnvVarNameBase_Password    = "PWD"
)

const (
	ErrTestedFunctionsAreNotSet = "tested functions are not set"
	ErrUnknownSqlDriver         = "unknown SQL driver: %v"
	ErrConnectionIsNull         = "connection is null"
)

const (
	DriverMySQL      = "mysql"
	DriverPostgreSQL = "postgres"
)

List of supported SQL drivers.

Types

type IntroFunction

type IntroFunction func(*TestSuite) error

type OutroFunction

type OutroFunction func(*TestSuite) error

type TestDbParameters

type TestDbParameters struct {
	NetworkProtocol string // E.g. "tcp".
	Driver          string // E.g. "mysql".
	Host            string // E.g. "localhost".
	Port            string // E.g. "3306".
	DB              string
	User            string
	Pwd             string
}

TestDbParameters are parameters of a test database.

func NewTestDbParameters

func NewTestDbParameters(envVarNamePrefix string) (p *TestDbParameters, err error)

type TestSuite

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

TestSuite is a suite of several tests. To run the tests create a test suite and use the 'Run' method.

Test suite automatically connects to and disconnects from the test database, runs an "intro" function, then runs all the tests (tested functions), and then runs the "outro" function. Intro-function is used to prepare tested database objects, e.g. to create tables and data. Outro-function is used to clean up the mess in the database after the tests, e.g. to delete data and tables.

func NewTestSuite

func NewTestSuite(
	t *testing.T,
	envVarNamePrefix string,
	intro []IntroFunction,
	testedFunctions []*TestedFunction,
	outro []OutroFunction,
) (ts *TestSuite, err error)

func (*TestSuite) GetHandle

func (ts *TestSuite) GetHandle() (db *sql.DB)

GetHandle returns the SQL database handle.

func (*TestSuite) GetSchema

func (ts *TestSuite) GetSchema() (schema string)

GetSchema returns the database schema.

func (*TestSuite) Run

func (ts *TestSuite) Run()

Run runs all the tests (tested functions).

type TestedFunction

type TestedFunction struct {
	Name string
	Func func(t *testing.T)
}