assert

README

Assert Package

The assert package provides helper functions for writing tests in Go. It offers detailed error messages and diffs for failed assertions.

Installation

To install the package, use:

go get github.com/r2k1/assert

Example

Here's a sample usage of the assert package:

// Check for equality
assert.Equal(t, actual, expected, "Person objects should be equal")
// Error:    Not equal
// Message:  Person objects should be equal
// Expected: assert.Person{Name:"Alice", Age:30}
// Actual:   assert.Person{Name:"Alice", Age:25}
// Diff:     {
//         -   Age: 25,
//         +   Age: 30,
//         }

// Stop test execution if not equal
assert.MustEqual(t, doSomething(), nil)
// Error:    Not equal
// Expected: <nil>
// Actual:   &errors.errorString{s:"failed to do something!"}}

Documentation

Index

• func Equal[T any](t testing.TB, actual, expected T, msgAndArgs ...any) bool
• func MustEqual[T any](t testing.TB, actual, expected T)
• func MustNotEqual[T any](t testing.TB, actual, expected T)
• func NotEqual[T any](t testing.TB, actual, expected T, msgAndArgs ...any) bool

Functions

func Equal

func Equal[T any](t testing.TB, actual, expected T, msgAndArgs ...any) bool

Equal checks if two objects of any type are equal and reports an error if they are not.

func MustEqual

func MustEqual[T any](t testing.TB, actual, expected T)

MustEqual asserts that two objects are equal and stops test execution if they are not.

func MustNotEqual

func MustNotEqual[T any](t testing.TB, actual, expected T)

MustNotEqual asserts that two objects are not equal and stops test execution if they are not.

func NotEqual

func NotEqual[T any](t testing.TB, actual, expected T, msgAndArgs ...any) bool

NotEqual checks if two objects of any type are not equal and reports an error if they are.