diff options
| author | Eugene Triguba <eugenetriguba@gmail.com> | 2024-01-27 21:58:54 -0500 |
|---|---|---|
| committer | Eugene Triguba <eugenetriguba@gmail.com> | 2024-01-27 21:58:54 -0500 |
| commit | efd0607baf4621aabc4cbf4b1fd12c703634275b (patch) | |
| tree | 4e7b6ff85d67cc6d595cf70cf6dd3e5a50611dd3 /assert/assert.go | |
| download | checkmate-efd0607baf4621aabc4cbf4b1fd12c703634275b.zip | |
Initial Commit
Diffstat (limited to 'assert/assert.go')
| -rw-r--r-- | assert/assert.go | 88 |
1 files changed, 88 insertions, 0 deletions
diff --git a/assert/assert.go b/assert/assert.go new file mode 100644 index 0000000..e2dd404 --- /dev/null +++ b/assert/assert.go @@ -0,0 +1,88 @@ +package assert + +import ( + "fmt" + + "github.com/google/go-cmp/cmp" +) + +// AssertDeepEqual checks if two values are deeply equal using Google's +// go-cmp cmp.Equal. If they are not equal, it logs the differences using +// cmp.Diff. An optional message and arguments for any format placeholders +// in that message can be provided for if a failure occurs. +func AssertDeepEqual(t TestingT, actual, expected any, msgAndArgs ...any) { + t.Helper() + if diff := cmp.Diff(expected, actual); diff != "" { + if len(msgAndArgs) == 0 { + msgAndArgs = []any{"mismatch (-expected +actual):\n%s", diff} + } + Assert(t, false, msgAndArgs...) + } +} + +// AssertEqual checks if two primitive values are equal. An optional +// message and arguments for any format placeholders in that message +// can be provided for if a failure occurs. +func AssertEqual(t TestingT, actual, expected any, msgAndArgs ...any) { + t.Helper() + if actual != expected { + if len(msgAndArgs) == 0 { + msgAndArgs = []any{"expected %v to equal %v", expected, actual} + } + Assert(t, false, msgAndArgs...) + } +} + +// AssertNotEqual checks if two values are not equal. It fails the test if +// the values are equal. An optional message and arguments for any format +// placeholders in that message can be provided if a failure occurs. +func AssertNotEqual(t TestingT, actual, expected any, msgAndArgs ...any) { + t.Helper() + if actual == expected { + if len(msgAndArgs) == 0 { + msgAndArgs = []any{"expected %v to not equal %v", expected, actual} + } + Assert(t, false, msgAndArgs...) + } +} + +// AssertLenEqual checks if the length of a given slice or array equals the +// expected length. It fails the test if the lengths are not equal. An optional +// message and arguments for any format placeholders in that message can be provided +// if a failure occurs. +func AssertLenEqual[T any](t TestingT, l []T, expectedLen int, msgAndArgs ...any) { + t.Helper() + if len(msgAndArgs) == 0 { + msgAndArgs = []any{"expected %v to have len %d, got len %d", l, len(l), expectedLen} + } + Assert(t, len(l) == expectedLen, msgAndArgs...) +} + +// Assert checks a boolean condition and fails the test if the condition is false. +// This is a general-purpose assertion function used to validate if a condition holds true. +// An optional message and arguments for any format placeholders in that message +// can be provided if a failure occurs. +func Assert(t TestingT, condition bool, msgAndArgs ...any) { + t.Helper() + if !condition { + message := "assertion failed" + if len(msgAndArgs) > 0 { + switch msgAndArgs[0].(type) { + case string: + message = fmt.Sprintf(msgAndArgs[0].(string), msgAndArgs[1:]...) + default: + t.Log("checkmate: Assert called with a non-string message, using default message") + } + } + t.Log(message) + t.FailNow() + } +} + +// The subset of testing.T which is used by the +// checkmate package. +type TestingT interface { + Helper() + Log(args ...any) + FailNow() +} |