f

Documentation

Overview

Package f contains the most useful type-safe fluent assertion functions.

It also provides the FailureMessage type which you can use for creating your own fluent assertions.

At last, you may embed a Fluent* type to extend it with additional assertion functions.

Index

• type FailureMessage
  • func (msg FailureMessage) Assert(t interface{ ... }, args ...any) bool
  • func (msg FailureMessage) Assertf(t interface{ ... }, format string, args ...any) bool
  • func (msg FailureMessage) Require(t interface{ ... }, args ...any) bool
  • func (msg FailureMessage) Requiref(t interface{ ... }, format string, args ...any) bool
• type FluentComparable
  • func Comparable[T comparable](got T) FluentComparable[T]
  • func (x FluentComparable[T]) Equal(want T) FailureMessage
  • func (x FluentComparable[T]) NotEqual(want T) FailureMessage
• type FluentObj
  • func Obj[T any](got T) FluentObj[T]
  • func (x FluentObj[T]) Check(fn func(got T) string) FailureMessage
  • func (x FluentObj[T]) DeepEqual(want T, opts ...cmp.Option) FailureMessage
  • func (x FluentObj[T]) NonZero() FailureMessage
  • func (x FluentObj[T]) NotDeepEqual(want T, opts ...cmp.Option) FailureMessage
  • func (x FluentObj[T]) Should(pred func(got T) bool) FailureMessage
  • func (x FluentObj[T]) ShouldNot(fn func(got T) bool) FailureMessage
  • func (x FluentObj[T]) Zero() FailureMessage

Types

type FailureMessage

type FailureMessage string

FailureMessage encapsulates failure message that can by emitted using objects compatible with the testing.TB interface.

func (FailureMessage) Assert

func (msg FailureMessage) Assert(t interface{ Error(args ...any) }, args ...any) bool

Assert calls t.Error if the failure message is not empty.

func (FailureMessage) Assertf

func (msg FailureMessage) Assertf(t interface {
	Errorf(format string, args ...any)
}, format string, args ...any,
) bool

Assertf calls t.Errorf if the failure message is not empty.

func (FailureMessage) Require

func (msg FailureMessage) Require(t interface{ Fatal(args ...any) }, args ...any) bool

Require calls t.Fatal if the failure message is not empty.

func (FailureMessage) Requiref

func (msg FailureMessage) Requiref(t interface {
	Fatalf(format string, args ...any)
}, format string, args ...any,
) bool

Requiref calls t.Fatalf if the failure message is not empty.

type FluentComparable

type FluentComparable[T comparable] struct {
	FluentObj[T]
}

FluentComparable encapsulates assertions for comparable object.

func Comparable

func Comparable[T comparable](got T) FluentComparable[T]

Comparable is used for testing a comparable object.

func (FluentComparable[T]) Equal

func (x FluentComparable[T]) Equal(want T) FailureMessage

Equal tests if the objects are equal using == operator.

func (FluentComparable[T]) NotEqual

func (x FluentComparable[T]) NotEqual(want T) FailureMessage

NotEqual tests if the objects are equal using == operator.

type FluentObj

type FluentObj[T any] struct {
	Got T
}

FluentObj encapsulates assertions for any object.

func Obj

func Obj[T any](got T) FluentObj[T]

Obj is used for testing any object.

func (FluentObj[T]) Check

func (x FluentObj[T]) Check(fn func(got T) string) FailureMessage

Check tests the object using the provided function

func (FluentObj[T]) DeepEqual

func (x FluentObj[T]) DeepEqual(want T, opts ...cmp.Option) FailureMessage

DeepEqual tests if the objects are deep equal using github.com/google/go-cmp/cmp.

func (FluentObj[T]) NonZero

func (x FluentObj[T]) NonZero() FailureMessage

NonZero tests if the object is a non-zero value.

func (FluentObj[T]) NotDeepEqual

func (x FluentObj[T]) NotDeepEqual(want T, opts ...cmp.Option) FailureMessage

NotDeepEqual tests if the objects are not deep equal using github.com/google/go-cmp/cmp.

func (FluentObj[T]) Should

func (x FluentObj[T]) Should(pred func(got T) bool) FailureMessage

Should tests if the object meets the predicate criteria.

func (FluentObj[T]) ShouldNot

func (x FluentObj[T]) ShouldNot(fn func(got T) bool) FailureMessage

ShouldNot tests if the object does not the predicate criteria.

func (FluentObj[T]) Zero

func (x FluentObj[T]) Zero() FailureMessage

Zero tests if the object is a zero value.