should.go

// Package should is simply a rewording of the assertion
// functions in the assertions package.
package should

import "github.com/smarty/assertions"

var (
	AlmostEqual            = assertions.ShouldAlmostEqual
	BeBetween              = assertions.ShouldBeBetween
	BeBetweenOrEqual       = assertions.ShouldBeBetweenOrEqual
	BeBlank                = assertions.ShouldBeBlank
	BeChronological        = assertions.ShouldBeChronological
	BeEmpty                = assertions.ShouldBeEmpty
	BeError                = assertions.ShouldBeError
	BeFalse                = assertions.ShouldBeFalse
	BeGreaterThan          = assertions.ShouldBeGreaterThan
	BeGreaterThanOrEqualTo = assertions.ShouldBeGreaterThanOrEqualTo
	BeIn                   = assertions.ShouldBeIn
	BeLessThan             = assertions.ShouldBeLessThan
	BeLessThanOrEqualTo    = assertions.ShouldBeLessThanOrEqualTo
	BeNil                  = assertions.ShouldBeNil
	BeTrue                 = assertions.ShouldBeTrue
	BeZeroValue            = assertions.ShouldBeZeroValue
	Contain                = assertions.ShouldContain
	ContainKey             = assertions.ShouldContainKey
	ContainSubstring       = assertions.ShouldContainSubstring
	EndWith                = assertions.ShouldEndWith
	Equal                  = assertions.ShouldEqual
	EqualJSON              = assertions.ShouldEqualJSON
	EqualTrimSpace         = assertions.ShouldEqualTrimSpace
	EqualWithout           = assertions.ShouldEqualWithout
	HappenAfter            = assertions.ShouldHappenAfter
	HappenBefore           = assertions.ShouldHappenBefore
	HappenBetween          = assertions.ShouldHappenBetween
	HappenOnOrAfter        = assertions.ShouldHappenOnOrAfter
	HappenOnOrBefore       = assertions.ShouldHappenOnOrBefore
	HappenOnOrBetween      = assertions.ShouldHappenOnOrBetween
	HappenWithin           = assertions.ShouldHappenWithin
	HaveLength             = assertions.ShouldHaveLength
	HaveSameTypeAs         = assertions.ShouldHaveSameTypeAs
	Implement              = assertions.ShouldImplement
	NotAlmostEqual         = assertions.ShouldNotAlmostEqual
	NotBeBetween           = assertions.ShouldNotBeBetween
	NotBeBetweenOrEqual    = assertions.ShouldNotBeBetweenOrEqual
	NotBeBlank             = assertions.ShouldNotBeBlank
	NotBeChronological     = assertions.ShouldNotBeChronological
	NotBeEmpty             = assertions.ShouldNotBeEmpty
	NotBeIn                = assertions.ShouldNotBeIn
	NotBeNil               = assertions.ShouldNotBeNil
	NotBeZeroValue         = assertions.ShouldNotBeZeroValue
	NotContain             = assertions.ShouldNotContain
	NotContainKey          = assertions.ShouldNotContainKey
	NotContainSubstring    = assertions.ShouldNotContainSubstring
	NotEndWith             = assertions.ShouldNotEndWith
	NotEqual               = assertions.ShouldNotEqual
	NotHappenOnOrBetween   = assertions.ShouldNotHappenOnOrBetween
	NotHappenWithin        = assertions.ShouldNotHappenWithin
	NotHaveSameTypeAs      = assertions.ShouldNotHaveSameTypeAs
	NotImplement           = assertions.ShouldNotImplement
	NotPanic               = assertions.ShouldNotPanic
	NotPanicWith           = assertions.ShouldNotPanicWith
	NotPointTo             = assertions.ShouldNotPointTo
	NotResemble            = assertions.ShouldNotResemble
	NotStartWith           = assertions.ShouldNotStartWith
	Panic                  = assertions.ShouldPanic
	PanicWith              = assertions.ShouldPanicWith
	PointTo                = assertions.ShouldPointTo
	Resemble               = assertions.ShouldResemble
	StartWith              = assertions.ShouldStartWith
	Wrap                   = assertions.ShouldWrap
)

// So is a variation on other such functions/methods in this module.
// Since it is defined alongside all these assertion definitions it allows
// performing assertions in tests with a single import of this package.
// Example:
// should.So(t, 1, should.Equal, 1)
func So(t testingT, actual any, assertion assertions.SoFunc, expected ...any) {
	if ok, result := assertions.So(actual, assertion, expected...); !ok {
		t.Helper()
		t.Errorf("\n%s", result)
	}
}

type testingT interface {
	Helper()
	Errorf(string, ...any)
}