testutil

Documentation

Overview

Package testutil contains helper functions for unit tests.

Index

• func AssertProtoEqual(t *testing.T, expected, actual any, msgAndArgs ...any) bool
• func AssertProtoJSONEqual(t *testing.T, expected string, protoMsg any, msgAndArgs ...any) bool
• func AssertProtoJSONFileEqual(t *testing.T, file string, protoMsg any, msgAndArgs ...any) bool
• func CaptureLogs(t *testing.T, f func()) string
• func ModRoot() string
• func WithTestGCS(t *testing.T, bucket string, handler func() error) error
• func WithTestMinIO(t *testing.T, bucket string, handler func(endpoint string) error) error
• func WithTestPostgres(handler func(dsn string) error) error

Functions

func AssertProtoEqual

func AssertProtoEqual(t *testing.T, expected, actual any, msgAndArgs ...any) bool

AssertProtoEqual asserts that two protobuf messages equal. Slices of messages are also supported.

func AssertProtoJSONEqual

func AssertProtoJSONEqual(t *testing.T, expected string, protoMsg any, msgAndArgs ...any) bool

AssertProtoJSONEqual asserts that a protobuf message matches the given JSON. The protoMsg can also be a slice of protobuf messages.

func AssertProtoJSONFileEqual

func AssertProtoJSONFileEqual(
	t *testing.T, file string, protoMsg any, msgAndArgs ...any,
) bool

AssertProtoJSONFileEqual asserts that a protobuf message (or slice of messages) matches the given reference JSON file.

To update a reference JSON file, pass the test argument '-update'. This will overwrite the reference output to match the current behavior.

func CaptureLogs

func CaptureLogs(t *testing.T, f func()) string

CaptureLogs captures any logs made during the test. Time will be stripped. Any tests that use it should not be run in parallel.

func ModRoot

func ModRoot() string

ModRoot returns the directory containing the go.mod file.

func WithTestGCS

func WithTestGCS(t *testing.T, bucket string, handler func() error) error

WithTestGCS starts a GCS storage emulator.

func WithTestMinIO

func WithTestMinIO(t *testing.T, bucket string, handler func(endpoint string) error) error

WithTestMinIO starts a test MinIO server

func WithTestPostgres

func WithTestPostgres(handler func(dsn string) error) error

WithTestPostgres starts a test DB and runs the given handler with the connection to it.