testutil

Documentation

Overview

Package testutil implements various utilities to reduce boilerplate in unit tests a la testify.

Index

• func AreProtoEqual[T proto.Message](expected T, found T, message string, args ...any) error
• func AreProtoSlicesEqual[T proto.Message](expected []T, found []T, sorter SortFunction[T], message string, args ...any) error
• func RequireEqualEmptyNil(t *testing.T, expected, actual interface{}, msgAndArgs ...interface{})
• func RequireProtoEqual[T proto.Message](t *testing.T, expected T, found T, message string, args ...any)
• func RequireProtoSlicesEqual[T proto.Message](t *testing.T, expected []T, found []T, sorter SortFunction[T], message string, ...)
• func RequireWithin(t *testing.T, runner func(t *testing.T), timeout time.Duration)
• type SortFunction

Functions

func AreProtoEqual

func AreProtoEqual[T proto.Message](expected T, found T, message string, args ...any) error

AreProtoEqual returns whether the expected and required protocol buffer messages are equal, via proto.Equal. If the messages are not equal, returns an error.

func AreProtoSlicesEqual

func AreProtoSlicesEqual[T proto.Message](expected []T, found []T, sorter SortFunction[T], message string, args ...any) error

AreProtoSlicesEqual returns whether the slices of protocol buffers are equal via protocol buffer comparison.

func RequireEqualEmptyNil

func RequireEqualEmptyNil(t *testing.T, expected, actual interface{}, msgAndArgs ...interface{})

RequireEqualEmptyNil is a version of require.Equal, but considers nil slices/maps to be equal to empty slices/maps.

func RequireProtoEqual

func RequireProtoEqual[T proto.Message](t *testing.T, expected T, found T, message string, args ...any)

RequireProtoEqual ensures that the expected and required protocol buffer messages are equal, via proto.Equal.

func RequireProtoSlicesEqual

func RequireProtoSlicesEqual[T proto.Message](t *testing.T, expected []T, found []T, sorter SortFunction[T], message string, args ...any)

RequireProtoSlicesEqual ensures that the expected slices of protocol buffers are equal. The sort function is used to sort the messages before comparison.

func RequireWithin

func RequireWithin(t *testing.T, runner func(t *testing.T), timeout time.Duration)

RequireWithin requires that the runner complete its execution within the specified duration.

Types

type SortFunction

type SortFunction[T proto.Message] func(first T, second T) int

SortFunction is a sorting function used for ordering two protocol buffers. Returns an integer representing the order, same as strings.Compare.