test_helpers

Documentation

Overview

Helpers for managing Tarantool process for testing purposes.

Package introduces go helpers for starting a tarantool process and validating Tarantool version. Helpers are based on os/exec calls. Retries to connect test tarantool instance handled explicitly, see tarantool/go-tarantool#136.

Tarantool's instance Lua scripts use environment variables to configure box.cfg. Listen port is set in the end of script so it is possible to connect only if every other thing was set up already.

Index

• func CheckEqualBoxErrors(t *testing.T, expected tarantool.BoxError, actual tarantool.BoxError)
• func CheckPoolStatuses(args interface{}) error
• func ConnectWithValidation(t testing.TB, server string, opts tarantool.Opts) *tarantool.Connection
• func DeleteRecordByKey(t *testing.T, conn tarantool.Connector, space interface{}, index interface{}, ...)
• func InsertOnInstance(server string, connOpts tarantool.Opts, space interface{}, tuple interface{}) error
• func InsertOnInstances(servers []string, connOpts tarantool.Opts, space interface{}, ...) error
• func IsTarantoolVersionLess(majorMin uint64, minorMin uint64, patchMin uint64) (bool, error)
• func ProcessListenOnInstance(args interface{}) error
• func RestartTarantool(inst *TarantoolInstance) error
• func Retry(f func(interface{}) error, args interface{}, count int, timeout time.Duration) error
• func SetClusterRO(servers []string, connOpts tarantool.Opts, roles []bool) error
• func SetInstanceRO(server string, connOpts tarantool.Opts, isReplica bool) error
• func SkipIfErrorExtendedInfoUnsupported(t *testing.T)
• func SkipIfErrorMessagePackTypeUnsupported(t *testing.T)
• func SkipIfFeatureDropped(t *testing.T, feature string, major, minor, patch uint64)
• func SkipIfFeatureSupported(t *testing.T, feature string, major, minor, patch uint64)
• func SkipIfFeatureUnsupported(t *testing.T, feature string, major, minor, patch uint64)
• func SkipIfGreaterOrEqual(t *testing.T, reason string, major, minor, patch uint64)
• func SkipIfIdSupported(t *testing.T)
• func SkipIfIdUnsupported(t *testing.T)
• func SkipIfLess(t *testing.T, reason string, major, minor, patch uint64)
• func SkipIfSQLUnsupported(t testing.TB)
• func SkipIfStreamsUnsupported(t *testing.T)
• func SkipIfWatchersSupported(t *testing.T)
• func SkipIfWatchersUnsupported(t *testing.T)
• func StopTarantool(inst TarantoolInstance)
• func StopTarantoolInstances(instances []TarantoolInstance)
• func StopTarantoolWithCleanup(inst TarantoolInstance)
• func WaitUntilReconnected(conn *tarantool.Connection, retries uint, timeout time.Duration) bool
• type CheckStatusesArgs
• type ListenOnInstanceArgs
• type StartOpts
• type StrangerRequest
  • func NewStrangerRequest() *StrangerRequest
  • func (sr *StrangerRequest) Async() bool
  • func (sr *StrangerRequest) Body(resolver tarantool.SchemaResolver, enc *encoder) error
  • func (sr *StrangerRequest) Code() int32
  • func (sr *StrangerRequest) Conn() *tarantool.Connection
  • func (sr *StrangerRequest) Ctx() context.Context
• type TarantoolInstance
  • func StartTarantool(startOpts StartOpts) (TarantoolInstance, error)
  • func StartTarantoolInstances(servers []string, workDirs []string, opts StartOpts) ([]TarantoolInstance, error)

Functions

func CheckEqualBoxErrors

func CheckEqualBoxErrors(t *testing.T, expected tarantool.BoxError, actual tarantool.BoxError)

CheckEqualBoxErrors checks equivalence of tarantool.BoxError objects.

Tarantool errors are not comparable by nature:

tarantool> msgpack.decode(mp_error_repr) == msgpack.decode(mp_error_repr) --- - false ...

Tarantool error file and line could differ even between different patches.

So we check equivalence of all attributes except for Line and File. For Line and File, we check that they are filled with some non-default values (lines are counted starting with 1 and empty file path is not expected too).

func CheckPoolStatuses

func CheckPoolStatuses(args interface{}) error

func ConnectWithValidation

func ConnectWithValidation(t testing.TB,
	server string,
	opts tarantool.Opts) *tarantool.Connection

ConnectWithValidation tries to connect to a Tarantool instance. It returns a valid connection if it is successful, otherwise finishes a test with an error.

func DeleteRecordByKey

func DeleteRecordByKey(t *testing.T, conn tarantool.Connector,
	space interface{}, index interface{}, key []interface{})

func InsertOnInstance

func InsertOnInstance(server string, connOpts tarantool.Opts, space interface{}, tuple interface{}) error

func InsertOnInstances

func InsertOnInstances(servers []string, connOpts tarantool.Opts, space interface{}, tuple interface{}) error

func IsTarantoolVersionLess

func IsTarantoolVersionLess(majorMin uint64, minorMin uint64, patchMin uint64) (bool, error)

IsTarantoolVersionLess checks if tarantool version is less than passed <major.minor.patch>. Returns error if failed to extract version.

func ProcessListenOnInstance

func ProcessListenOnInstance(args interface{}) error

ProcessListenOnInstance helper calls "return box.cfg.listen" as many times as there are servers in the connection pool with specified mode. For RO mode expected received ports equals to replica ports. For RW mode expected received ports equals to master ports. For PreferRO mode expected received ports equals to replica ports or to all ports. For PreferRW mode expected received ports equals to master ports or to all ports.

func RestartTarantool

func RestartTarantool(inst *TarantoolInstance) error

RestartTarantool restarts a tarantool instance for tests with specifies parameters (refer to StartOpts) which were specified in inst parameter. inst is a tarantool instance that was started by StartTarantool. Rewrites inst.Cmd.Process to stop instance with StopTarantool. Process must be stopped with StopTarantool.

func Retry

func Retry(f func(interface{}) error, args interface{}, count int, timeout time.Duration) error

func SetClusterRO

func SetClusterRO(servers []string, connOpts tarantool.Opts, roles []bool) error

func SetInstanceRO

func SetInstanceRO(server string, connOpts tarantool.Opts, isReplica bool) error

func SkipIfErrorExtendedInfoUnsupported

func SkipIfErrorExtendedInfoUnsupported(t *testing.T)

SkipIfErrorExtendedInfoUnsupported skips test run if Tarantool without IPROTO_ERROR (0x52) support is used.

func SkipIfErrorMessagePackTypeUnsupported

func SkipIfErrorMessagePackTypeUnsupported(t *testing.T)

SkipIfErrorMessagePackTypeUnsupported skips test run if Tarantool without MP_ERROR type over iproto support is used.

func SkipIfFeatureDropped

func SkipIfFeatureDropped(t *testing.T, feature string, major, minor, patch uint64)

SkipIfFeatureDropped skips test run if Tarantool had dropped support of a feature.

func SkipIfFeatureSupported

func SkipIfFeatureSupported(t *testing.T, feature string, major, minor, patch uint64)

SkipIfFeatureSupported skips test run if Tarantool supports a feature. Helper if useful when we want to test if everything is alright on older versions.

func SkipIfFeatureUnsupported

func SkipIfFeatureUnsupported(t *testing.T, feature string, major, minor, patch uint64)

SkipIfFeatureUnsupported skips test run if Tarantool does not yet support a feature.

func SkipIfGreaterOrEqual

func SkipIfGreaterOrEqual(t *testing.T, reason string, major, minor, patch uint64)

SkipIfGreaterOrEqual skips test run if Tarantool version is greater or equal than expected.

func SkipIfIdSupported

func SkipIfIdSupported(t *testing.T)

SkipIfIdSupported skips test run if Tarantool with IPROTO_ID support is used. Skip is useful for tests validating that protocol info is processed as expected even for pre-IPROTO_ID instances.

func SkipIfIdUnsupported

func SkipIfIdUnsupported(t *testing.T)

SkipIfIdUnsupported skips test run if Tarantool without IPROTO_ID support is used.

func SkipIfLess

func SkipIfLess(t *testing.T, reason string, major, minor, patch uint64)

SkipIfLess skips test run if Tarantool version is less than expected.

func SkipIfSQLUnsupported

func SkipIfSQLUnsupported(t testing.TB)

func SkipIfStreamsUnsupported

func SkipIfStreamsUnsupported(t *testing.T)

SkipOfStreamsUnsupported skips test run if Tarantool without streams support is used.

func SkipIfWatchersSupported

func SkipIfWatchersSupported(t *testing.T)

SkipIfWatchersSupported skips test run if Tarantool with watchers support is used.

func SkipIfWatchersUnsupported

func SkipIfWatchersUnsupported(t *testing.T)

SkipOfStreamsUnsupported skips test run if Tarantool without watchers support is used.

func StopTarantool

func StopTarantool(inst TarantoolInstance)

StopTarantool stops a tarantool instance started with StartTarantool. Waits until any resources associated with the process is released. If something went wrong, fails.

func StopTarantoolInstances

func StopTarantoolInstances(instances []TarantoolInstance)

func StopTarantoolWithCleanup

func StopTarantoolWithCleanup(inst TarantoolInstance)

StopTarantoolWithCleanup stops a tarantool instance started with StartTarantool. Waits until any resources associated with the process is released. Cleans work directory after stop. If something went wrong, fails.

func WaitUntilReconnected

func WaitUntilReconnected(conn *tarantool.Connection, retries uint, timeout time.Duration) bool

WaitUntilReconnected waits until connection is reestablished. Returns false in case of connection is not in the connected state after specified retries count, true otherwise.

Types

type CheckStatusesArgs

type CheckStatusesArgs struct {
	ConnPool           *connection_pool.ConnectionPool
	Servers            []string
	Mode               connection_pool.Mode
	ExpectedPoolStatus bool
	ExpectedStatuses   map[string]bool
}

type ListenOnInstanceArgs

type ListenOnInstanceArgs struct {
	ConnPool      *connection_pool.ConnectionPool
	Mode          connection_pool.Mode
	ServersNumber int
	ExpectedPorts map[string]bool
}

type StartOpts

type StartOpts struct {
	// Auth is an authentication method for a Tarantool instance.
	Auth tarantool.Auth

	// InitScript is a Lua script for tarantool to run on start.
	InitScript string

	// Listen is box.cfg listen parameter for tarantool.
	// Use this address to connect to tarantool after configuration.
	// https://www.tarantool.io/en/doc/latest/reference/configuration/#cfg-basic-listen
	Listen string

	// ClientServer changes a host to connect to test startup of a Tarantool
	// instance. By default, it uses Listen value as the host for the connection.
	ClientServer string

	// ClientTransport changes Opts.Transport for a connection that checks startup
	// of a Tarantool instance.
	ClientTransport string

	// ClientSsl changes Opts.Ssl for a connection that checks startup of
	// a Tarantool instance.
	ClientSsl tarantool.SslOpts

	// WorkDir is box.cfg work_dir parameter for a Tarantool instance:
	// a folder to store data files. If not specified, helpers create a
	// new temporary directory.
	// Folder must be unique for each Tarantool process used simultaneously.
	// https://www.tarantool.io/en/doc/latest/reference/configuration/#confval-work_dir
	WorkDir string

	// SslCertsDir is a path to a directory with SSL certificates. It will be
	// copied to the working directory.
	SslCertsDir string

	// User is a username used to connect to tarantool.
	// All required grants must be given in InitScript.
	User string

	// Pass is a password for specified User.
	Pass string

	// WaitStart is a time to wait before starting to ping tarantool.
	WaitStart time.Duration

	// ConnectRetry is a count of retry attempts to ping tarantool. If the
	// value < 0 then there will be no ping tarantool at all.
	ConnectRetry int

	// RetryTimeout is a time between tarantool ping retries.
	RetryTimeout time.Duration

	// MemtxUseMvccEngine is flag to enable transactional
	// manager if set to true.
	MemtxUseMvccEngine bool
}

type StrangerRequest

type StrangerRequest struct {
}

func NewStrangerRequest

func NewStrangerRequest() *StrangerRequest

func (*StrangerRequest) Async

func (sr *StrangerRequest) Async() bool

func (*StrangerRequest) Body

func (sr *StrangerRequest) Body(resolver tarantool.SchemaResolver, enc *encoder) error

func (*StrangerRequest) Code

func (sr *StrangerRequest) Code() int32

func (*StrangerRequest) Conn

func (sr *StrangerRequest) Conn() *tarantool.Connection

func (*StrangerRequest) Ctx

func (sr *StrangerRequest) Ctx() context.Context

type TarantoolInstance

type TarantoolInstance struct {
	// Cmd is a Tarantool command. Used to kill Tarantool process.
	Cmd *exec.Cmd

	// Options for restarting a tarantool instance.
	Opts StartOpts
}

TarantoolInstance is a data for instance graceful shutdown and cleanup.

func StartTarantool

func StartTarantool(startOpts StartOpts) (TarantoolInstance, error)

StartTarantool starts a tarantool instance for tests with specifies parameters (refer to StartOpts). Process must be stopped with StopTarantool.

func StartTarantoolInstances

func StartTarantoolInstances(servers []string, workDirs []string, opts StartOpts) ([]TarantoolInstance, error)