testutil

Documentation

Overview

Package testutil provides testing helpers.

Index

• func AssertEqual[T types.Type](tb testing.TB, expected, actual T) bool
• func AssertEqualSlices[T types.Type](tb testing.TB, expected, actual []T) bool
• func AssertNotEqual[T types.Type](tb testing.TB, expected, actual T) bool
• func AssertNotEqualSlices[T types.Type](tb testing.TB, expected, actual []T) bool
• func CollectionName(tb testing.TB) string
• 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 DatabaseName(tb testing.TB) string
• func Dump[T types.Type](tb testing.TB, o T) string
• func DumpSlice[T types.Type](tb testing.TB, s []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 Logger(tb testing.TB, level zap.AtomicLevel) *zap.Logger
• func MustParseDumpFile(path ...string) []byte
• func ParseDump(tb testing.TB, s string) []byte
• func ParseDumpFile(tb testing.TB, path ...string) []byte
• func PostgreSQLURL(tb testing.TB, opts *PostgreSQLURLOpts) string
• func SetByPath[T types.CompositeTypeInterface](tb testing.TB, comp T, value any, path types.Path)
• func TigrisURL(tb testing.TB) string
• func WriteSeedCorpusFile(tb testing.TB, funcName string, b []byte)
• type PostgreSQLURLOpts

Functions

func AssertEqual

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

AssertEqual asserts that two BSON values are equal.

func AssertEqualSlices

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

AssertEqualSlices asserts that two BSON slices are equal.

func AssertNotEqual

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

AssertNotEqual asserts that two BSON values are not equal.

func AssertNotEqualSlices

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

AssertNotEqualSlices asserts that two BSON slices are not equal.

func CollectionName

func CollectionName(tb testing.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 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

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 DatabaseName

func DatabaseName(tb testing.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 testing.TB, o T) string

Dump returns string representation for debugging.

func DumpSlice

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

DumpSlice returns string representation for debugging.

func GetByPath

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

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

IndentJSON returns an indented form of the JSON input.

func Logger

func Logger(tb testing.TB, level zap.AtomicLevel) *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 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 PostgreSQLURL

func PostgreSQLURL(tb testing.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 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 TigrisURL

func TigrisURL(tb testing.TB) string

TigrisURL returns Tigris URL for testing.

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

func WriteSeedCorpusFile

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 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.