testutil

Documentation

Overview

Package testutil provides testing helpers.

Index

• func AssertEqual[T types.Type](tb testtb.TB, expected, actual T) bool
• func AssertEqualSlices[T types.Type](tb testtb.TB, expected, actual []T) bool
• func AssertNotEqual[T types.Type](tb testtb.TB, expected, actual T) bool
• func AssertNotEqualSlices[T types.Type](tb testtb.TB, expected, actual []T) bool
• func CollectionName(tb testtb.TB) string
• func CompareAndSetByPathNum[T types.CompositeTypeInterface](tb testtb.TB, expected, actual T, delta float64, path types.Path)
• func CompareAndSetByPathTime[T types.CompositeTypeInterface](tb testtb.TB, expected, actual T, delta time.Duration, path types.Path)
• func Ctx(tb testtb.TB) context.Context
• func DatabaseName(tb testtb.TB) string
• func Dump[T types.Type](tb testtb.TB, o T) string
• func DumpSlice[T types.Type](tb testtb.TB, s []T) string
• func GetByPath[T types.CompositeTypeInterface](tb testtb.TB, comp T, path types.Path) any
• func IndentJSON(tb testtb.TB, b []byte) []byte
• func LevelLogger(tb testtb.TB, level zap.AtomicLevel) *zap.Logger
• func Logger(tb testtb.TB) *zap.Logger
• func MustParseDumpFile(path ...string) []byte
• func ParseDump(tb testtb.TB, s string) []byte
• func ParseDumpFile(tb testtb.TB, path ...string) []byte
• func PostgreSQLURL(tb testtb.TB, opts *PostgreSQLURLOpts) string
• func SetByPath[T types.CompositeTypeInterface](tb testtb.TB, comp T, value any, path types.Path)
• type PostgreSQLURLOpts

Functions

func AssertEqual

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

AssertEqual asserts that two BSON values are equal.

func AssertEqualSlices

func AssertEqualSlices[T types.Type](tb testtb.TB, expected, actual []T) bool

AssertEqualSlices asserts that two BSON slices are equal.

func AssertNotEqual

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

AssertNotEqual asserts that two BSON values are not equal.

func AssertNotEqualSlices

func AssertNotEqualSlices[T types.Type](tb testtb.TB, expected, actual []T) bool

AssertNotEqualSlices asserts that two BSON slices are not equal.

func CollectionName

func CollectionName(tb testtb.TB) string

CollectionName returns a stable FerretDB collection name for that test.

It should be called only once per test.

func CompareAndSetByPathNum

func CompareAndSetByPathNum[T types.CompositeTypeInterface](tb testtb.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

func CompareAndSetByPathTime[T types.CompositeTypeInterface](tb testtb.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 testtb.TB) context.Context

Ctx returns test context. It is canceled when test is finished or interrupted.

func DatabaseName

func DatabaseName(tb testtb.TB) string

DatabaseName returns a stable FerretDB database name for that test.

It should be called only once per test.

func Dump

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

Dump returns string representation for debugging.

func DumpSlice

func DumpSlice[T types.Type](tb testtb.TB, s []T) string

DumpSlice returns string representation for debugging.

func GetByPath

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

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

func IndentJSON

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

IndentJSON returns an indented form of the JSON input.

func LevelLogger

func LevelLogger(tb testtb.TB, level zap.AtomicLevel) *zap.Logger

LevelLogger returns zap test logger with given level and valid configuration.

func Logger

func Logger(tb testtb.TB) *zap.Logger

Logger returns zap test logger with valid configuration.

func MustParseDumpFile

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

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

func ParseDump

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

ParseDump parses string to bytes, in tests.

func ParseDumpFile

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

ParseDumpFile parses file input to bytes, in tests.

func PostgreSQLURL

func PostgreSQLURL(tb testtb.TB, opts *PostgreSQLURLOpts) string

PostgreSQLURL returns PostgreSQL URL for testing.

TODO remove this function https://github.com/FerretDB/FerretDB/issues/1568

func SetByPath

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

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

The path must exist.

Types

type PostgreSQLURLOpts

type PostgreSQLURLOpts struct {
	// PostgreSQL database name, defaults to `ferretdb`.
	DatabaseName string

	// If set, the pool will use read-only user.
	ReadOnly bool

	// Extra query parameters.
	Params map[string]string
}

PostgreSQLURLOpts represents PostgreSQLURL options.