testing

Documentation

Index

• func CreateApplication[TServer, TContainer any](creater AppCreater[TServer, TContainer], configName ...string) (TServer, TContainer)
• func CreateApplicationFunc[TServer, TContainer any](creater AppCreaterFunc[TServer, TContainer]) (TServer, TContainer)
• func CreateMongoDBWithDBName(t testing.TB, optMaker MongoOptions) (*mongo.Client, string)
• func CreateMySQL(t testing.TB, optMaker MySQLOptions) (*sql.DB, string)
• func CreateScyllaDB(t testing.TB, optMaker ScyllaDBOptions) *gocql.Session
• func FindConfig(workingDir string, configName ...string) (string, error)
• func FindFile(workingDir string, fileName string) (string, error)
• func GetConfig[T any](t testing.TB, create func(*viper.Viper) (T, error)) T
• func NewAppTestLogger(t testing.TB, level zerolog.Level) (zerolog.Logger, *zltest.Tester)
• func Timeout(t testing.TB, timeout time.Duration) context.Context
• func WorkingDir(t testing.TB) string
• type AppCreater
• type AppCreaterFunc
  • func (h AppCreaterFunc[TServer, TContainer]) Create(ctx context.Context, config *viper.Viper) (TServer, TContainer)
• type MongoOptions
• type MySQLOptions
• type MySQLOptionsData
• type ScyllaDBOptions

Functions

func CreateApplication

func CreateApplication[TServer, TContainer any](creater AppCreater[TServer, TContainer], configName ...string) (TServer, TContainer)

Creates a new instance of application for testing purposes

func CreateApplicationFunc

func CreateApplicationFunc[TServer, TContainer any](creater AppCreaterFunc[TServer, TContainer]) (TServer, TContainer)

TODO: Check if it's needed to document this

func CreateMongoDBWithDBName

func CreateMongoDBWithDBName(t testing.TB, optMaker MongoOptions) (*mongo.Client, string)

func CreateMySQL

func CreateMySQL(t testing.TB, optMaker MySQLOptions) (*sql.DB, string)

func CreateScyllaDB

func CreateScyllaDB(t testing.TB, optMaker ScyllaDBOptions) *gocql.Session

func FindConfig

func FindConfig(workingDir string, configName ...string) (string, error)

Returns directory of config files and error if file doesent exist

func FindFile

func FindFile(workingDir string, fileName string) (string, error)

Returns directory of config file name and error if file doesent exist

func GetConfig

func GetConfig[T any](t testing.TB, create func(*viper.Viper) (T, error)) T

func NewAppTestLogger

func NewAppTestLogger(t testing.TB, level zerolog.Level) (zerolog.Logger, *zltest.Tester)

Returns new instance of zerolog and *zltest.Tester for testing puurposes

func Timeout

func Timeout(t testing.TB, timeout time.Duration) context.Context

func WorkingDir

func WorkingDir(t testing.TB) string

Types

type AppCreater

type AppCreater[TServer, TContainer any] interface {
	Create(context.Context, *viper.Viper) (TServer, TContainer)
}

interface AppCreater Retunrs Server and Container for testing purposes

type AppCreaterFunc

type AppCreaterFunc[TServer, TContainer any] func(context.Context, *viper.Viper) (TServer, TContainer)

Delegates functions for AppCreater

func (AppCreaterFunc[TServer, TContainer]) Create

func (h AppCreaterFunc[TServer, TContainer]) Create(ctx context.Context, config *viper.Viper) (TServer, TContainer)

TODO: Check if it's needed to document this

type MongoOptions

type MongoOptions interface {
	GetOptions() *options.ClientOptions
}

type MySQLOptions

type MySQLOptions interface {
	GetOptions() MySQLOptionsData
}

type MySQLOptionsData

type MySQLOptionsData struct {
	RootUser      string
	RootPass      string
	Host          string
	Net           string
	DB            string
	User          string
	Password      string
	MigrationFile string
}

type ScyllaDBOptions

type ScyllaDBOptions interface {
	GetOptions() *gocql.ClusterConfig
}