// package assert contains functions for checking values in unit tests.
//
// The functions in this package will log messages and mark tests as failed,
// not bail out of the test immediately, but rather return a boolean of whether
// or not the check passed.
//
// For analogues which stop the test and lose the boolean return value, see
// package assert/must.
package assert

import (
	"testing"

	"github.com/google/go-cmp/cmp"
)

// Equal asserts that two values compare as equal.
func Equal(t testing.TB, actual, expect any) bool {
	t.Helper()
	if !cmp.Equal(actual, expect) {
		t.Errorf(`
Equal check failed
------------------
actual:
%v

expect:
%v

diff:
%s`[1:],
			actual,
			expect,
			cmp.Diff(expect, actual),
		)
		return false
	}
	return true
}

// NotEqual asserts that two values compare as unequal.
func NotEqual(t testing.TB, actual, expect any) bool {
	t.Helper()
	if cmp.Equal(actual, expect) {
		t.Errorf(`
NotEqual check failed
---------------------
value:
%v`[1:],
			expect,
		)
		return false
	}
	return true
}