check

package
v0.10.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 23, 2025 License: MIT Imports: 19 Imported by: 2

README

The check Package

The check package is designed for performing assertions in Go tests, particularly as a foundational layer for the assert package. It provides functions that return errors instead of boolean values, allowing callers to adjust error messages to a particular context, add more contextual information about the check, improving assertion message comprehension.

Example Usage

You use checks like any other function returning error.

	have := errors.New("test error")

	err := NoError(have, WithTrail("type.field"))

	fmt.Println(err)
	// Output:
	// expected the error to be nil:
	//	trail: type.field
	//	 want: <nil>
	//	 have: "test error"

The main purpose of returning an error from a check, instead of true false like it is in case of assert package is to allow user to customize the message and/or add context.

have := errors.New("test error")

err := NoError(have, WithTrail("type.field"))

err = notice.From(err, "prefix").Append("context", "wow")

fmt.Println(err)
// Output:
// [prefix] expected the error to be nil:
//	   trail: type.field
//	    want: <nil>
//	    have: "test error"
//	context: wow

Documentation

Overview

Package check provides equality toolkit used by assert package.

Index

Examples

Constants

View Source 
const (
	// DefaultParseTimeFormat is default format for dumping [time.Time] values.
	DefaultParseTimeFormat = time.RFC3339Nano

	// DefaultRecentDuration is default duration when comparing recent dates.
	DefaultRecentDuration = 10 * time.Second

	// DefaultDumpTimeFormat is default format for parsing time strings.
	DefaultDumpTimeFormat = time.RFC3339Nano

	// DefaultDumpDepth is default depth when dumping values recursively in log
	// messages.
	DefaultDumpDepth = 6
)

Package wide default configuration.

Variables

View Source 
var (
	// ParseTimeFormat is a configurable format for parsing time strings.
	ParseTimeFormat = DefaultParseTimeFormat

	// RecentDuration is a configurable duration when comparing recent dates.
	RecentDuration = DefaultRecentDuration

	// DumpTimeFormat is configurable format for dumping [time.Time] values.
	DumpTimeFormat = DefaultDumpTimeFormat

	// DumpDepth is a configurable depth when dumping values in log messages.
	DumpDepth = DefaultDumpDepth
)

Package-wide configuration.

View Source 
var (
	// ErrTimeType is returned when time representation is not supported.
	ErrTimeType = fmt.Errorf("not supported time type")

	// ErrTimeParse is used when date parsing fails for whatever reason.
	ErrTimeParse = fmt.Errorf("time parsing")

	// ErrDurType is returned when duration representation is not supported.
	ErrDurType = fmt.Errorf("not supported duration type")

	// ErrDurParse is used when duration parsing fails for whatever reason.
	ErrDurParse = fmt.Errorf("duration parsing")
)

Sentinel errors.

Functions

func After 

func After(date, mark any, opts ...Option) error

After checks "date" is after "mark". Returns nil if it is, otherwise it returns an error with a message indicating the expected and actual values.

The "date" and "mark" may represent dates in the form of a string, int, int64 or time.Time. For string representations the [Options.TimeFormat] is used during parsing and the returned date is always in UTC. The int and int64 types are interpreted as Unix Timestamp, and the date returned is also in UTC.

func AfterOrEqual 

func AfterOrEqual(date, mark any, opts ...Option) error

AfterOrEqual checks "date" is equal or after "mark". Returns nil if it is, otherwise it returns an error with a message indicating the expected and actual values.

The "date" and "mark" may represent dates in the form of a string, int, int64 or time.Time. For string representations the [Options.TimeFormat] is used during parsing and the returned date is always in UTC. The int and int64 types are interpreted as Unix Timestamp, and the date returned is also in UTC.

func Before 

func Before(date, mark any, opts ...Option) error

Before checks "date" is before "mark". Returns nil if it is, otherwise it returns an error with a message indicating the expected and actual values.

The "want" and "have" may represent dates in the form of a string, int, int64 or time.Time. For string representations the [Options.TimeFormat] is used during parsing and the returned date is always in UTC. The int and int64 types are interpreted as Unix Timestamp, and the date returned is also in UTC.

func BeforeOrEqual 

func BeforeOrEqual(date, mark any, opts ...Option) error

BeforeOrEqual checks "date" is equal or before "mark". Returns nil if it is, otherwise it returns an error with a message indicating the expected and actual values.

The "date" and "mark" may represent dates in the form of a string, int, int64 or time.Time. For string representations the [Options.TimeFormat] is used during parsing and the returned date is always in UTC. The int and int64 types are interpreted as Unix Timestamp, and the date returned is also in UTC.

func ChannelWillClose 

func ChannelWillClose[C any](within any, c <-chan C, opts ...Option) error

ChannelWillClose checks channel will be closed "within" given time duration. Returns nil if it was, otherwise returns an error with a message indicating the expected and actual values.

The "within" may represent duration in form of a string, int, int64 or time.Duration.

func Contain 

func Contain(want, have string, opts ...Option) error

Contain checks "want" is a substring of "have". Returns nil if it's, otherwise returns an error with a message indicating the expected and actual values.

func Count 

func Count(count int, what, where any, opts ...Option) error

Count checks there is "count" occurrences of "what" in "where". Returns nil if it's, otherwise it returns an error with a message indicating the expected and actual values.

Currently, only strings are supported.

func DirExist 

func DirExist(pth string, opts ...Option) error

DirExist checks "pth" points to an existing directory. It fails if the path points to a filesystem entry which is not a directory or there is an error when trying to check the path. When it fails it returns an error with a detailed message indicating the expected and actual values.

func Duration 

func Duration(want, have any, opts ...Option) error

Duration checks "want" and "have" durations are equal. Returns nil if they are, otherwise returns an error with a message indicating the expected and actual values.

The "want" and "have" may represent duration in the form of a string, int, int64 or time.Duration.

func Empty 

func Empty(have any, opts ...Option) error

Empty checks if "have" is empty. Returns nil if it's, otherwise it returns an error with a message indicating the expected and actual values.

Empty values are:

  • nil
  • int(0)
  • float64(0)
  • float32(0)
  • false
  • len(array) == 0
  • len(slice) == 0
  • len(map) == 0
  • len(chan) == 0
  • time.Time{}

func Epsilon 

func Epsilon[T constraints.Number](want, epsilon, have T, opts ...Option) error

Epsilon checks the difference between two numbers is within a given delta. Returns nil if it does, otherwise it returns an error with a message indicating the expected and actual values.

func Equal 

func Equal(want, have any, opts ...Option) error

Equal recursively checks both values are equal. Returns nil if they are, otherwise it returns an error with a message indicating the expected and actual values.

Example (Arrays) 
package main

import (
	"fmt"

	"github.com/ctx42/testing/pkg/check"
)

func main() {
	want := [...]int{1, 2, 3}
	have := [...]int{1, 2, 3, 4}

	err := check.Equal(want, have)

	fmt.Println(err)
}

Output:

expected values to be equal:
  want type: [3]int
  have type: [4]int
       want:
             [3]int{
               1,
               2,
               3,
             }
       have:
             [4]int{
               1,
               2,
               3,
               4,
             }
       diff:
             @@ -1,6 +1,5 @@
             -[4]int{
             +[3]int{
                1,
                2,
             -  3,
             -  4,
             +  3,
              }
Example (CustomTrailChecker) 
package main

import (
	"fmt"

	"github.com/ctx42/testing/pkg/check"
)

func main() {
	type T struct {
		Str string
		Any []any
	}

	chk := func(want, have any, opts ...check.Option) error {
		wVal := want.(float64)
		hVal := want.(float64)
		return check.Epsilon(wVal, 0.01, hVal, opts...)
	}
	opt := check.WithTrailChecker("T.Any[1]", chk)

	want := T{Str: "abc", Any: []any{1, 2.123, "abc"}}
	have := T{Str: "abc", Any: []any{1, 2.124, "abc"}}

	err := check.Equal(want, have, opt)

	fmt.Println(err)
}

Output:

 <nil>
Example (CustomTypeChecker) 
package main

import (
	"fmt"

	"github.com/ctx42/testing/pkg/check"
)

func main() {
	type T struct{ value float64 }

	chk := func(want, have any, opts ...check.Option) error {
		w := want.(T)
		h := have.(T)
		return check.Epsilon(w.value, h.value, 0.001, opts...)
	}

	opt := check.WithTypeChecker(T{}, chk)

	want := T{value: 1.2345}
	have := T{value: 1.2346}
	err := check.Equal(want, have, opt)

	fmt.Println(err)
}

Output:

 <nil>
Example (ListVisitedTrails) 
package main

import (
	"fmt"
	"strings"

	"github.com/ctx42/testing/pkg/check"
)

func main() {
	type T struct {
		Int  int
		Next *T
	}

	have := T{1, &T{2, &T{3, &T{42, nil}}}}
	want := T{1, &T{2, &T{3, &T{42, nil}}}}
	trails := make([]string, 0)

	err := check.Equal(want, have, check.WithTrailLog(&trails))

	fmt.Println(err)
	fmt.Println(strings.Join(trails, "\n"))
}

Output:

<nil>
T.Int
T.Next.Int
T.Next.Next.Int
T.Next.Next.Next.Int
T.Next.Next.Next.Next
Example (Maps) 
package main

import (
	"fmt"

	"github.com/ctx42/testing/pkg/check"
)

func main() {
	type T struct {
		Str string
	}

	want := map[int]T{1: {Str: "abc"}, 2: {Str: "xyz"}}
	have := map[int]T{1: {Str: "abc"}, 3: {Str: "xyz"}}

	err := check.Equal(want, have)

	fmt.Println(err)
}

Output:

expected values to be equal:
      trail: map[2]
  want type: map[int]check_test.T
  have type: <nil>
       want:
             map[int]check_test.T{
               1: {
                 Str: "abc",
               },
               3: {
                 Str: "xyz",
               },
             }
       have: nil
Example (RecursiveStructs) 
package main

import (
	"fmt"

	"github.com/ctx42/testing/pkg/check"
)

func main() {
	type T struct {
		Int  int
		Next *T
	}

	have := T{1, &T{2, &T{3, &T{42, nil}}}}
	want := T{1, &T{2, &T{3, &T{4, nil}}}}

	err := check.Equal(want, have)

	fmt.Println(err)
}

Output:

expected values to be equal:
  trail: T.Next.Next.Next.Int
   want: 4
   have: 42
Example (SkipAllUnexportedFields) 
package main

import (
	"fmt"
	"strings"

	"github.com/ctx42/testing/pkg/check"
)

func main() {
	type T struct {
		Int  int
		prv  int
		Next *T
	}

	have := T{1, -1, &T{2, -2, &T{3, -3, &T{42, -4, nil}}}}
	want := T{1, -7, &T{2, -7, &T{3, -7, &T{42, -7, nil}}}}
	trails := make([]string, 0)

	err := check.Equal(
		want,
		have,
		check.WithTrailLog(&trails),
		check.WithSkipUnexported,
	)

	fmt.Println(err)
	fmt.Println(strings.Join(trails, "\n"))
}

Output:

<nil>
T.Int
T.prv <skipped>
T.Next.Int
T.Next.prv <skipped>
T.Next.Next.Int
T.Next.Next.prv <skipped>
T.Next.Next.Next.Int
T.Next.Next.Next.prv <skipped>
T.Next.Next.Next.Next
Example (SkipTrails) 
package main

import (
	"fmt"
	"strings"

	"github.com/ctx42/testing/pkg/check"
)

func main() {
	type T struct {
		Int  int
		Next *T
	}

	have := T{1, &T{2, &T{3, &T{42, nil}}}}
	want := T{1, &T{2, &T{8, &T{42, nil}}}}
	trails := make([]string, 0)

	err := check.Equal(
		want,
		have,
		check.WithTrailLog(&trails),
		check.WithSkipTrail("T.Next.Next.Int"),
	)

	fmt.Println(err)
	fmt.Println(strings.Join(trails, "\n"))
}

Output:

<nil>
T.Int
T.Next.Int
T.Next.Next.Int <skipped>
T.Next.Next.Next.Int
T.Next.Next.Next.Next
Example (Slices) 
package main

import (
	"fmt"

	"github.com/ctx42/testing/pkg/check"
)

func main() {
	want := []int{1, 2, 3}
	have := []int{1, 2, 3, 4}

	err := check.Equal(want, have)

	fmt.Println(err)
}

Output:

expected values to be equal:
  want len: 3
  have len: 4
      want:
            []int{
              1,
              2,
              3,
            }
      have:
            []int{
              1,
              2,
              3,
              4,
            }
      diff:
            @@ -2,5 +2,4 @@
               1,
               2,
            -  3,
            -  4,
            +  3,
             }
Example (Structs) 
package main

import (
	"fmt"

	"github.com/ctx42/testing/pkg/check"
)

func main() {
	type T struct {
		Int int
		Str string
	}

	have := T{Int: 1, Str: "abc"}
	want := T{Int: 2, Str: "xyz"}

	err := check.Equal(want, have)

	fmt.Println(err)
}

Output:

expected values to be equal:
  trail: T.Int
   want: 2
   have: 1
 ---
  trail: T.Str
   want: "xyz"
   have: "abc"
Example (WrongTypes) 
package main

import (
	"fmt"

	"github.com/ctx42/testing/pkg/check"
)

func main() {
	err := check.Equal(42, byte(42), check.WithTrail("type.field"))

	fmt.Println(err)
}

Output:

 expected values to be equal:
      trail: type.field
  want type: int
  have type: uint8
       want: 42
       have: 0x2a ('*')

func Error 

func Error(err error, opts ...Option) error

Error checks "err" is not nil. Returns an error if it's nil.

Example 
package main

import (
	"fmt"

	"github.com/ctx42/testing/pkg/check"
)

func main() {
	err := check.Error(nil)

	fmt.Println(err)
}

Output:

expected non-nil error

func ErrorAs 

func ErrorAs(want any, err error, opts ...Option) error

ErrorAs checks there is an error in the "err" tree that matches the "want" target, and if one is found, sets the target to that error. Returns nil if the target is found, otherwise returns an error with a message indicating the expected and actual values.

func ErrorContain 

func ErrorContain(want string, err error, opts ...Option) error

ErrorContain checks "err" is not nil and its message contains "want". Returns nil if it's, otherwise it returns an error with a message indicating the expected and actual values.

func ErrorEqual 

func ErrorEqual(want string, err error, opts ...Option) error

ErrorEqual checks "err" is not nil and its message equals to "want". Returns nil if it's, otherwise it returns an error with a message indicating the expected and actual values.

func ErrorIs 

func ErrorIs(want, err error, opts ...Option) error

ErrorIs checks whether any error in "err" tree matches the "want" target. Returns nil if it's, otherwise returns an error with a message indicating the expected and actual values.

func ErrorRegexp 

func ErrorRegexp(want any, err error, opts ...Option) error

ErrorRegexp checks "err" is not nil and its message matches the "want" regex. Returns nil if it is, otherwise it returns an error with a message indicating the expected and actual values.

The "want" can be either regular expression string or instance of regexp.Regexp. The fmt.Sprint is used to get string representation of have argument.

func Exact 

func Exact(want, have any, opts ...Option) error

Exact checks "want" and "have" dates are equal and are in the same timezone. Returns nil they are, otherwise returns an error with a message indicating the expected and actual values.

The "want" and "have" may represent dates in the form of a string, int, int64 or time.Time. For string representations the [Options.TimeFormat] is used during parsing and the returned date is always in UTC. The int and int64 types are interpreted as Unix Timestamp, and the date returned is also in UTC.

func ExitCode 

func ExitCode(want int, err error, opts ...Option) error

ExitCode checks "err" is pointer to exec.ExitError with exit code equal to "want". Returns nil if it's, otherwise it returns an error with a message indicating the expected and actual values.

func False 

func False(have bool, opts ...Option) error

False checks "have" is false. Returns nil if it's, otherwise it returns an error with a message indicating the expected and actual values.

func FieldName added in v0.7.0 

func FieldName(ops Options, typeName string) func(fldName string) Option

FieldName returns a helper function which updates [Options.Trail].

It is useful when construction trails in custom struct checkers.

Example: 

func fileCheck(want, have any, opts ...check.Option) error {
	ops := check.DefaultOptions(opts...)
	if err := check.Type(file{}, have, check.WithOptions(ops)); err != nil {
		return err
	}
	w, h := want.(file), have.(file)

	fName := check.FieldName(ops, "file")
	ers := []error{
		check.Equal(w.path, h.path, fName("path")),
		check.Equal(w.pks, h.pks, fName("pks")),
		// Not all fields are compared.
		check.Fields(4, w, fName("{field count}")),
	}
	return notice.Join(ers...)
}

func Fields 

func Fields(want int, s any, opts ...Option) error

Fields checks a struct or pointer to a struct "s" has "want" number of fields. Returns nil if it does, otherwise it returns an error with a message indicating the expected and actual values.

func FileContain 

func FileContain[T Content](want T, pth string, opts ...Option) error

FileContain checks file at "pth" can be read and its string content contains "want". It fails if the path points to a filesystem entry which is not a file or there is an error reading the file. The file is read in full then strings.Contains is used to check it contains "want" string. When it fails it returns an error with a message indicating the expected and actual values.

func FileExist 

func FileExist(pth string, opts ...Option) error

FileExist checks "pth" points to an existing file. Returns an error if the path points to a filesystem entry which is not a file or there is an error when trying to check the path. On success, it returns nil.

func Has 

func Has[T comparable](want T, bag []T, opts ...Option) error

Has checks slice has "want" value. Returns nil if it does, otherwise it returns an error with a message indicating the expected and actual values.

func HasKey 

func HasKey[K comparable, V any](key K, set map[K]V, opts ...Option) (V, error)

HasKey checks the map has a key. If the key exists, it returns its value and nil, otherwise it returns zero-value and an error with a message indicating the expected and actual values.

func HasKeyValue 

func HasKeyValue[K, V comparable](key K, want V, set map[K]V, opts ...Option) error

HasKeyValue checks the map has a key with a given value. Returns nil if it doesn't, otherwise it returns an error with a message indicating the expected and actual values.

func HasNo 

func HasNo[T comparable](want T, set []T, opts ...Option) error

HasNo checks slice does not have the "want" value. Returns nil if it doesn't, otherwise it returns an error with a message indicating the expected and actual values.

func HasNoKey 

func HasNoKey[K comparable, V any](key K, set map[K]V, opts ...Option) error

HasNoKey checks map has no key. Returns nil if it doesn't, otherwise it returns an error with a message indicating the expected and actual values.

func JSON 

func JSON(want, have string, opts ...Option) error

JSON checks that two JSON strings are equivalent. Returns nil if they are, otherwise it returns an error with a message indicating the expected and actual values.

Example: 

check.JSON(`{"hello": "world"}`, `{"foo": "bar"}`)
Example 
package main

import (
	"fmt"

	"github.com/ctx42/testing/pkg/check"
)

func main() {
	want := `{"A": 1, "B": 2}`
	have := `{"A": 1, "B": 3}`

	err := check.JSON(want, have)

	fmt.Println(err)
}

Output:

expected JSON strings to be equal:
  want: {"A":1,"B":2}
  have: {"A":1,"B":3}

func Len 

func Len(want int, have any, opts ...Option) (err error)

Len checks "have" has "want" elements. Returns nil if it has, otherwise it returns an error with a message indicating the expected and actual values.

func MapSubset 

func MapSubset[K comparable, V any](want, have map[K]V, opts ...Option) error

MapSubset checks the "want" is a subset "have". In other words, all keys and their corresponding values in the "want" map must be in the "have" map. It is not an error when the "have" map has some other keys. Returns nil if "want" is a subset of "have", otherwise it returns an error with a message indicating the expected and actual values.

func MapsSubset 

func MapsSubset[K comparable, V any](want, have []map[K]V, opts ...Option) error

MapsSubset checks all the "want" maps are subsets of corresponding "have" maps using MapSubset. Returns nil if all "want" maps are subset of corresponding "have" maps, otherwise it returns an error with a message indicating the expected and actual values.

func Nil 

func Nil(have any, opts ...Option) error

Nil checks "have" is nil. Returns nil if it's, otherwise returns an error with a message indicating the expected and actual values.

func NoDirExist 

func NoDirExist(pth string, opts ...Option) error

NoDirExist checks "pth" points to not existing directory. It fails if the path points to an existing filesystem entry. When it fails it returns an error with a detailed message indicating the expected and actual values.

func NoError 

func NoError(err error, opts ...Option) error

NoError checks "err" is nil. Returns error it's not nil.

Example 
package main

import (
	"errors"
	"fmt"

	"github.com/ctx42/testing/pkg/check"
)

func main() {
	have := errors.New("test error")

	err := check.NoError(have)

	fmt.Println(err)
}

Output:

expected the error to be nil:
  want: <nil>
  have: "test error"
Example (ChangeMessage) 
package main

import (
	"errors"
	"fmt"

	"github.com/ctx42/testing/pkg/check"
	"github.com/ctx42/testing/pkg/notice"
)

func main() {
	have := errors.New("test error")

	err := check.NoError(have, check.WithTrail("type.field"))

	err = notice.From(err, "prefix").Append("context", "wow")

	fmt.Println(err)
}

Output:

[prefix] expected the error to be nil:
    trail: type.field
     want: <nil>
     have: "test error"
  context: wow
Example (WithTrail) 
package main

import (
	"errors"
	"fmt"

	"github.com/ctx42/testing/pkg/check"
)

func main() {
	have := errors.New("test error")

	err := check.NoError(have, check.WithTrail("type.field"))

	fmt.Println(err)
}

Output:

expected the error to be nil:
  trail: type.field
   want: <nil>
   have: "test error"

func NoFileExist 

func NoFileExist(pth string, opts ...Option) error

NoFileExist checks "pth" points to not existing file. Returns an error if the path points to an existing filesystem entry. On success, it returns nil.

func NoPanic 

func NoPanic(fn TestFunc, opts ...Option) error

NoPanic checks "fn" does not panic. Returns nil if it doesn't, otherwise it returns an error with a message with value passed to panic and stack trace.

func NotContain 

func NotContain(want, have string, opts ...Option) error

NotContain checks "want" is not a substring of "have". Returns nil if it's, otherwise returns an error with a message indicating the expected and actual values.

func NotEmpty 

func NotEmpty(have any, opts ...Option) error

NotEmpty checks "have" is not empty. Returns nil if it's otherwise, it returns an error with a message indicating the expected and actual values.

See check.Empty for list of values which are considered empty.

func NotEqual 

func NotEqual(want, have any, opts ...Option) error

NotEqual checks both values are not equal using. Returns nil if they are not, otherwise it returns an error with a message indicating the expected and actual values.

func NotNil 

func NotNil(have any, opts ...Option) error

NotNil checks if "have" is not nil. Returns nil if it is not nil, otherwise returns an error with a message indicating the expected and actual values.

The returned error might be one or more errors joined with errors.Join.

func NotSame 

func NotSame(want, have any, opts ...Option) error

NotSame checks "want" and "have" are generic pointers and that both of them reference the same object. Returns nil if it is, otherwise it returns an error with a message indicating the expected and actual values.

Both arguments must be pointer variables. Pointer variable sameness is determined based on the equality of both type and value.

func NotZero 

func NotZero(have any, opts ...Option) error

NotZero checks "have" is not the zero value for its type. Returns nil if it is, otherwise it returns an error with a message indicating the expected and actual values.

func Panic 

func Panic(fn TestFunc, opts ...Option) error

Panic checks "fn" panics. Returns nil if it does, otherwise it returns an error with a message with value passed to panic and stack trace.

func PanicContain 

func PanicContain(want string, fn TestFunc, opts ...Option) error

PanicContain checks "fn" panics, and the recovered panic value represented as a string contains "want". Returns nil if it does, otherwise it returns an error with a message with value passed to panic and stack trace.

func PanicMsg 

func PanicMsg(fn TestFunc, opts ...Option) (*string, error)

PanicMsg checks "fn" panics, and returns the recovered panic value as a string. If function didn't panic, it returns nil and an error with a detailed message indicating the expected behaviour.

func Recent 

func Recent(have any, opts ...Option) error

Recent checks "have" is within [Options.Recent] from time.Now. Returns nil if it is, otherwise returns an error with a message indicating the expected and actual values.

The "have" may represent date in the form of a string, int, int64 or time.Time. For string representations the [Options.TimeFormat] is used during parsing and the returned date is always in UTC. The int and int64 types are interpreted as Unix Timestamp, and the date returned is also in UTC.

func Regexp 

func Regexp(want, have any, opts ...Option) error

Regexp checks that "want" regexp matches "have". Returns nil if it does, otherwise, it returns an error with a message indicating the expected and actual values.

The "want" can be either regular expression string or instance of regexp.Regexp. The fmt.Sprint is used to get string representation of have argument.

func RegisterTypeChecker added in v0.7.0 

func RegisterTypeChecker(typ any, chk Check)

RegisterTypeChecker globally registers a custom checker for a given type. It panics if a checker for the same type is already registered.

func Same 

func Same(want, have any, opts ...Option) error

Same checks "want" and "have" are generic pointers and that both of them reference the same object. Returns nil if they are, otherwise it returns an error with a message indicating the expected and actual values.

Pointer variable sameness is determined based on the equality of both type and value. It works with pointers to objects, slices, maps and functions. For arrays, it always returns error.

func SliceSubset 

func SliceSubset[V comparable](want, have []V, opts ...Option) error

SliceSubset checks the "have" is a subset "want". In other words, all values in the "want" slice must be in the "have" slice. Returns nil if it does, otherwise returns an error with a message indicating the expected and actual values.

func Time 

func Time(want, have any, opts ...Option) error

Time checks "want" and "have" dates are equal. Returns nil if they are, otherwise returns an error with a message indicating the expected and actual values.

The "want" and "have" may represent dates in the form of a string, int, int64 or time.Time. For string representations the [Options.TimeFormat] is used during parsing and the returned date is always in UTC. The int and int64 types are interpreted as Unix Timestamp, and the date returned is also in UTC.

Example 
package main

import (
	"fmt"
	"time"

	"github.com/ctx42/testing/pkg/check"
)

func main() {
	want := time.Date(2025, 1, 1, 0, 0, 0, 0, time.UTC)
	have := time.Date(2025, 1, 1, 0, 1, 1, 0, time.UTC)

	err := check.Time(want, have)

	fmt.Println(err)
}

Output:

 expected equal dates:
  want: 2025-01-01T00:00:00Z
  have: 2025-01-01T00:01:01Z
  diff: -1m1s

func True 

func True(have bool, opts ...Option) error

True checks "have" is true. Returns nil if it's, otherwise it returns an error with a message indicating the expected and actual values.

func Type 

func Type(want, have any, opts ...Option) error

Type checks that both arguments are of the same type. Returns nil if they are, otherwise it returns an error with a message indicating the expected and actual values.

func Within 

func Within(want, within, have any, opts ...Option) error

Within checks "want" and "have" dates are equal "within" given duration. Returns nil if they are, otherwise returns an error with a message indicating the expected and actual values.

The "want" and "have" may represent dates in the form of a string, int, int64 or time.Time. For string representations the [Options.TimeFormat] is used during parsing and the returned date is always in UTC. The int and int64 types are interpreted as Unix Timestamp, and the date returned is also in UTC.

The "within" may represent duration in the form of a string, int, int64 or time.Duration.

func Zero 

func Zero(have any, opts ...Option) error

Zero checks "have" is the zero value for its type. Returns nil if it is, otherwise, it returns an error with a message indicating the expected and actual values.

func Zone 

func Zone(want, have *time.Location, opts ...Option) error

Zone checks "want" and "have" timezones are equal. Returns nil if they are, otherwise returns an error with a message indicating the expected and actual values.

Note nil time.Location is the same as time.UTC.

Types

type Check 

type Check func(want, have any, opts ...Option) error

Check is signature for generic check function comparing two arguments returning error if they are not. The returned error might be one or more errors joined with errors.Join.

type Content 

type Content interface {
	string | []byte
}

Content declares type constraint for file content.

type Option 

type Option func(Options) Options

Option represents a Check option.

func WithDumper 

func WithDumper(optsD ...dump.Option) Option

WithDumper is Check option setting dump.Config options.

func WithOptions 

func WithOptions(src Options) Option

WithOptions is a Check option which passes all options.

func WithRecent 

func WithRecent(recent time.Duration) Option

WithRecent is a Check option setting duration used to compare recent dates.

func WithSkipTrail 

func WithSkipTrail(skip ...string) Option

WithSkipTrail is a Check option setting trails to skip.

func WithTimeFormat 

func WithTimeFormat(format string) Option

WithTimeFormat is a Check option setting time format when parsing dates.

func WithTrail 

func WithTrail(pth string) Option

WithTrail is a Check option setting initial field/element/key trail.

func WithTrailChecker 

func WithTrailChecker(trail string, chk Check) Option

WithTrailChecker is a Check option setting a custom checker for a given trail.

func WithTrailLog 

func WithTrailLog(list *[]string) Option

WithTrailLog is a Check option turning on a collection of checked fields/elements/keys. The trails are added to the provided slice.

func WithTypeChecker 

func WithTypeChecker(typ any, chk Check) Option

WithTypeChecker is a Check option setting custom checker for a type.

type Options 

type Options struct {
	// Dump configuration.
	Dumper dump.Dump

	// Time format when parsing time strings (default: [time.RFC3339]).
	TimeFormat string

	// Duration when comparing recent dates.
	Recent time.Duration

	// Field/element/key breadcrumb trail being checked.
	Trail string

	// List of visited trails.
	// The skipped trails have " <skipped>" suffix.
	TrailLog *[]string

	// Custom checks to run for a given type.
	TypeCheckers map[reflect.Type]Check

	// Custom checker for given trail.
	TrailCheckers map[string]Check

	// List of trails to skip.
	SkipTrails []string

	// Skips all unexported fields during equality checks.
	SkipUnexported bool
	// contains filtered or unexported fields
}

Options represent options used by Check functions.

func DefaultOptions 

func DefaultOptions(opts ...Option) Options

DefaultOptions returns default Options.

func WithSkipUnexported added in v0.6.0 

func WithSkipUnexported(ops Options) Options

WithSkipUnexported is a Check option instructing equality checks to skip exported fields.

func (Options) ArrTrail added in v0.7.0 

func (ops Options) ArrTrail(kind string, idx int) Options

ArrTrail updates [Options.Trail] with slice or array index considering already existing trail.

Example trails: 

arr[1]
[1]

func (Options) LogTrail added in v0.7.0 

func (ops Options) LogTrail() Options

LogTrail logs non-empty [Options.Trail] to [Options.TrailLog].

func (Options) MapTrail added in v0.7.0 

func (ops Options) MapTrail(key string) Options

MapTrail updates [Options.Trail] with trail of the map value considering already existing trails.

Example trails: 

map[1]
["A"]map[1]
[1]map["A"]
field["A"]

func (Options) StructTrail added in v0.7.0 

func (ops Options) StructTrail(typeName, fldName string) Options

StructTrail updates [Options.Trail] with a struct type and/or field name considering an already existing trail.

Example trails: 

Type.Field
Type.Field.Field
Type.Field[1].Field
Type.Field["A"].Field

type TestFunc 

type TestFunc func()

TestFunc is signature used by check functions dealing with panics.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.