The highest tagged major version is v2.

testutil

package

v0.5.0 Latest Latest Go to latest Published: Jul 11, 2022 License: Apache-2.0 Imports: 23 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/FerretDB/FerretDB

Links

Open Source Insights

Documentation ¶

Overview ¶

Package testutil provides testing helpers.

Index ¶

func AssertEqual[T types.Type](tb testing.TB, expected, actual T) bool
func AssertNotEqual[T types.Type](tb testing.TB, expected, actual T) bool
func CompareAndSetByPathNum[T types.CompositeTypeInterface](tb testing.TB, expected, actual T, delta float64, path types.Path)
func CompareAndSetByPathTime[T types.CompositeTypeInterface](tb testing.TB, expected, actual T, delta time.Duration, path types.Path)
func Ctx(tb testing.TB) context.Context
func Dump[T types.Type](tb testing.TB, o T) string
func GetByPath[T types.CompositeTypeInterface](tb testing.TB, comp T, path types.Path) any
func IndentJSON(tb testing.TB, b []byte) []byte
func MustParseDumpFile(path ...string) []byte
func ParseDump(tb testing.TB, s string) []byte
func ParseDumpFile(tb testing.TB, path ...string) []byte
func Pool(ctx context.Context, tb testing.TB, opts *PoolOpts, l *zap.Logger) *pgdb.Pool
func PoolConnString(tb testing.TB, opts *PoolOpts) string
func Schema(ctx context.Context, tb testing.TB, pool *pgdb.Pool) string
func SchemaName(tb testing.TB) string
func SetByPath[T types.CompositeTypeInterface](tb testing.TB, comp T, value any, path types.Path)
func Table(ctx context.Context, tb testing.TB, pool *pgdb.Pool, db string) string
func TableName(tb testing.TB) string
func TigrisURL(tb testing.TB) string
func WriteSeedCorpusFile(tb testing.TB, funcName string, b []byte)
type PoolOpts

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func AssertEqual ¶ added in v0.1.0

func AssertEqual[T types.Type](tb testing.TB, expected, actual T) bool

AssertEqual asserts that two BSON values are equal.

func AssertNotEqual ¶ added in v0.1.0

func AssertNotEqual[T types.Type](tb testing.TB, expected, actual T) bool

AssertNotEqual asserts that two BSON values are not equal.

func CompareAndSetByPathNum ¶ added in v0.0.5

func CompareAndSetByPathNum[T types.CompositeTypeInterface](tb testing.TB, expected, actual T, delta float64, path types.Path)

CompareAndSetByPathNum asserts that two values with the same path in two objects (documents or arrays) are within a given numerical delta, then updates the expected object with the actual value.

func CompareAndSetByPathTime ¶ added in v0.0.5

func CompareAndSetByPathTime[T types.CompositeTypeInterface](tb testing.TB, expected, actual T, delta time.Duration, path types.Path)

CompareAndSetByPathTime asserts that two values with the same path in two objects (documents or arrays) are within a given time delta, then updates the expected object with the actual value.

func Ctx ¶

func Ctx(tb testing.TB) context.Context

Ctx returns test context.

func Dump ¶ added in v0.0.6

func Dump[T types.Type](tb testing.TB, o T) string

Dump returns string representation for debugging.

func GetByPath ¶ added in v0.0.5

func GetByPath[T types.CompositeTypeInterface](tb testing.TB, comp T, path types.Path) any

GetByPath returns a value by path - a sequence of indexes and keys.

func IndentJSON ¶ added in v0.4.0

func IndentJSON(tb testing.TB, b []byte) []byte

IndentJSON returns an indented form of the JSON input.

func MustParseDumpFile ¶

func MustParseDumpFile(path ...string) []byte

MustParseDumpFile panics if fails to parse file input to byte array.

func ParseDump ¶

func ParseDump(tb testing.TB, s string) []byte

ParseDump parses string to bytes, in tests.

func ParseDumpFile ¶

func ParseDumpFile(tb testing.TB, path ...string) []byte

ParseDumpFile parses file input to bytes, in tests.

func Pool ¶

func Pool(ctx context.Context, tb testing.TB, opts *PoolOpts, l *zap.Logger) *pgdb.Pool

Pool creates a new connection connection pool for testing.

func PoolConnString ¶ added in v0.5.0

func PoolConnString(tb testing.TB, opts *PoolOpts) string

PoolConnString returns PostgreSQL connection string for testing.

func Schema ¶

func Schema(ctx context.Context, tb testing.TB, pool *pgdb.Pool) string

Schema creates a new FerretDB database / PostgreSQL schema for testing.

Name is stable for that test. It is automatically dropped if test pass.

func SchemaName ¶ added in v0.0.5

func SchemaName(tb testing.TB) string

SchemaName returns a stable schema name for that test.

func SetByPath ¶ added in v0.0.5

func SetByPath[T types.CompositeTypeInterface](tb testing.TB, comp T, value any, path types.Path)

SetByPath sets the value by path - a sequence of indexes and keys.

The path must exist.

func Table ¶ added in v0.1.0

func Table(ctx context.Context, tb testing.TB, pool *pgdb.Pool, db string) string

Table creates FerretDB collection / PostgreSQL table for testing.

Name is stable for that test.

func TableName ¶ added in v0.0.5

func TableName(tb testing.TB) string

TableName returns a stable table name for that test.

func TigrisURL ¶ added in v0.5.0

func TigrisURL(tb testing.TB) string

TigrisURL returns Tigris URL for testing.

func WriteSeedCorpusFile ¶ added in v0.1.0

func WriteSeedCorpusFile(tb testing.TB, funcName string, b []byte)

WriteSeedCorpusFile adds given data to the fuzzing seed corpus for given fuzz function.

It can be an alternative to using f.Add.

Types ¶

type PoolOpts ¶ added in v0.0.5

type PoolOpts struct {
	// If set, the pool will use read-only user.
	ReadOnly bool
}

PoolOpts represents options for creating a connection pool.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL