aboutsummaryrefslogtreecommitdiffstats
path: root/check/check_test.go
blob: 86649cf7b35e5d69598182c2cc711fb008573232 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
package check

import (
	"errors"
	"fmt"
	"os"
	"strings"
	"testing"

	"git.eugenetriguba.com/checkmate"
	"git.eugenetriguba.com/checkmate/internal/cmtest"
)

type checkFn func(t checkmate.TestingT, args []any) bool

func wrappedCheckNil(t checkmate.TestingT, args []any) bool {
	if len(args) > 1 {
		return Nil(t, args[0], args[1:]...)
	} else {
		return Nil(t, args[0])
	}
}

func wrappedCheckNotNil(t checkmate.TestingT, args []any) bool {
	if len(args) > 1 {
		return NotNil(t, args[0], args[1:]...)
	} else {
		return NotNil(t, args[0])
	}
}

func wrappedCheckTrue(t checkmate.TestingT, args []any) bool {
	if len(args) > 1 {
		return True(t, args[0].(bool), args[1:]...)
	} else {
		return True(t, args[0].(bool))
	}
}

func wrappedCheckFalse(t checkmate.TestingT, args []any) bool {
	if len(args) > 1 {
		return False(t, args[0].(bool), args[1:]...)
	} else {
		return False(t, args[0].(bool))
	}
}

func wrappedCheckDeepEqual(t checkmate.TestingT, args []any) bool {
	if len(args) > 2 {
		return DeepEqual(t, args[0], args[1], args[2:]...)
	} else {
		return DeepEqual(t, args[0], args[1])
	}
}

func wrappedCheckNotDeepEqual(t checkmate.TestingT, args []any) bool {
	if len(args) > 2 {
		return NotDeepEqual(t, args[0], args[1], args[2:]...)
	} else {
		return NotDeepEqual(t, args[0], args[1])
	}
}

func wrappedCheckErrorIs(t checkmate.TestingT, args []any) bool {
	if len(args) > 2 {
		return ErrorIs(t, args[0].(error), args[1].(error), args[2:]...)
	} else {
		return ErrorIs(t, args[0].(error), args[1].(error))
	}
}

func wrappedCheckNotErrorIs(t checkmate.TestingT, args []any) bool {
	if len(args) > 2 {
		return NotErrorIs(t, args[0].(error), args[1].(error), args[2:]...)
	} else {
		return NotErrorIs(t, args[0].(error), args[1].(error))
	}
}

func wrappedCheckErrorContains(t checkmate.TestingT, args []any) bool {
	if len(args) > 2 {
		return ErrorContains(t, args[0].(error), args[1].(string), args[2:]...)
	} else {
		return ErrorContains(t, args[0].(error), args[1].(string))
	}
}

func wrappedCheckNotErrorContains(t checkmate.TestingT, args []any) bool {
	if len(args) > 2 {
		return NotErrorContains(t, args[0].(error), args[1].(string), args[2:]...)
	} else {
		return NotErrorContains(t, args[0].(error), args[1].(string))
	}
}

func wrappedCheckEqual(t checkmate.TestingT, args []any) bool {
	if len(args) > 2 {
		return Equal(t, args[0], args[1], args[2:]...)
	} else {
		return Equal(t, args[0], args[1])
	}
}

func wrappedCheckNotEqual(t checkmate.TestingT, args []any) bool {
	if len(args) > 2 {
		return NotEqual(t, args[0], args[1], args[2:]...)
	} else {
		return NotEqual(t, args[0], args[1])
	}
}

func wrappedCheckContains(t checkmate.TestingT, args []any) bool {
	if len(args) > 2 {
		return Contains(t, args[0], args[1], args[2:]...)
	} else {
		return Contains(t, args[0], args[1])
	}
}

func wrappedCheckNotContains(t checkmate.TestingT, args []any) bool {
	if len(args) > 2 {
		return NotContains(t, args[0], args[1], args[2:]...)
	} else {
		return NotContains(t, args[0], args[1])
	}
}

var passingTestFns = []struct {
	name string
	fn   checkFn
	args []any
}{
	{"CheckNil", wrappedCheckNil, []any{nil}},
	{"CheckNotNil", wrappedCheckNotNil, []any{1}},
	{"CheckTrue", wrappedCheckTrue, []any{true}},
	{"CheckFalse", wrappedCheckFalse, []any{false}},
	{"CheckErrorIs", wrappedCheckErrorIs, []any{os.ErrExist, os.ErrExist}},
	{"CheckNotErrorIs", wrappedCheckNotErrorIs, []any{os.ErrExist, os.ErrClosed}},
	{"CheckErrorContains", wrappedCheckErrorContains, []any{errors.New("error 1"), "error 1"}},
	{"CheckNotErrorContains", wrappedCheckNotErrorContains, []any{errors.New("error 1"), "error 2"}},
	{"CheckDeepEqual", wrappedCheckDeepEqual, []any{5, 5}},
	{"CheckNotDeepEqual", wrappedCheckNotDeepEqual, []any{5, 6}},
	{"CheckEqual", wrappedCheckEqual, []any{5, 5}},
	{"CheckNotEqual", wrappedCheckNotEqual, []any{5, 10}},
	{"CheckContains - Substr", wrappedCheckContains, []any{"hello world", "world"}},
	{"CheckContains - Slice", wrappedCheckContains, []any{[]string{"hello", "world"}, "world"}},
	{"CheckContains - Array", wrappedCheckContains, []any{[2]string{"hello", "world"}, "world"}},
	{"CheckContains - Map", wrappedCheckContains, []any{map[string]int{"hello": 1, "world": 2}, "world"}},
	{"CheckContains - Pointer to String", wrappedCheckContains, []any{func() *string { s := "hello world"; return &s }(), "world"}},
	{"CheckContains - Pointer to Slice", wrappedCheckContains, []any{func() *[]string { s := []string{"hello", "world"}; return &s }(), "world"}},
	{"CheckNotContains - Substr", wrappedCheckNotContains, []any{"hello world", "goodbye"}},
	{"CheckNotContains - Slice", wrappedCheckNotContains, []any{[]string{"hello", "world"}, "goodbye"}},
	{"CheckNotContains - Array", wrappedCheckNotContains, []any{[2]string{"hello", "world"}, "goodbye"}},
	{"CheckNotContains - Map", wrappedCheckNotContains, []any{map[string]int{"hello": 1, "world": 2}, "goodbye"}},
	{"CheckNotContains - Pointer to String", wrappedCheckNotContains, []any{func() *string { s := "hello world"; return &s }(), "goodbye"}},
}

var failingTestFns = []struct {
	name string
	fn   checkFn
	args []any
}{
	{"CheckNil", wrappedCheckNil, []any{1}},
	{"CheckNotNil", wrappedCheckNotNil, []any{nil}},
	{"CheckTrue", wrappedCheckTrue, []any{false}},
	{"CheckFalse", wrappedCheckFalse, []any{true}},
	{"CheckErrorIs", wrappedCheckErrorIs, []any{errors.New("error 1"), errors.New("error 2")}},
	{"CheckNotErrorIs", wrappedCheckNotErrorIs, []any{os.ErrClosed, os.ErrClosed}},
	{"CheckErrorContains", wrappedCheckErrorContains, []any{errors.New("error 1"), "error 2"}},
	{"CheckNotErrorContains", wrappedCheckNotErrorContains, []any{errors.New("error 1"), "error 1"}},
	{"CheckDeepEqual", wrappedCheckDeepEqual, []any{5, 10}},
	{"CheckNotDeepEqual", wrappedCheckNotDeepEqual, []any{5, 5}},
	{"CheckEqual", wrappedCheckEqual, []any{5, 10}},
	{"CheckNotEqual", wrappedCheckNotEqual, []any{5, 5}},
	{"CheckContains - Substr not found", wrappedCheckContains, []any{"hello world", "goodbye"}},
	{"CheckContains - Slice item not found", wrappedCheckContains, []any{[]string{"hello", "world"}, "goodbye"}},
	{"CheckContains - Array item not found", wrappedCheckContains, []any{[2]string{"hello", "world"}, "goodbye"}},
	{"CheckContains - Map key not found", wrappedCheckContains, []any{map[string]int{"hello": 1}, "goodbye"}},
	{"CheckNotContains - Substr found", wrappedCheckNotContains, []any{"hello world", "world"}},
	{"CheckNotContains - Slice item found", wrappedCheckNotContains, []any{[]string{"hello", "world"}, "world"}},
	{"CheckNotContains - Array item found", wrappedCheckNotContains, []any{[2]string{"hello", "world"}, "world"}},
	{"CheckNotContains - Map key found", wrappedCheckNotContains, []any{map[string]int{"hello": 1, "world": 2}, "world"}},
}

func TestOptionalMessageAndArgs(t *testing.T) {
	testCases := []struct {
		name         string
		args         []any
		expectedLogs []string
	}{
		{"Plain message", []any{"my message"}, []string{"my message"}},
		{"Message with format placeholders", []any{"my message: %d", 5}, []string{"my message: 5"}},
		{
			"Invalid message type",
			[]any{5},
			[]string{
				"checkmate: check called with a non-string message, using default message",
				"check failed",
			},
		},
	}

	for _, testFn := range failingTestFns {
		for _, testCase := range testCases {
			testName := fmt.Sprintf("%s: %s", testFn.name, testCase.name)
			t.Run(testName, func(t *testing.T) {
				mockT := &cmtest.MockT{}

				testFn.fn(mockT, append(testFn.args, testCase.args...))

				if len(mockT.Logs) != len(testCase.expectedLogs) {
					t.Errorf(
						"%s: expected %d (%v) log messages but got %d (%v)",
						testName, len(testCase.expectedLogs),
						testCase.expectedLogs, len(mockT.Logs), mockT.Logs,
					)
				}
				if len(mockT.Logs) == len(testCase.expectedLogs) {
					for i, expectedLogMsg := range testCase.expectedLogs {
						if mockT.Logs[i] != expectedLogMsg {
							t.Errorf(
								"%s: expected log message '%s', got '%s'",
								testName, expectedLogMsg, mockT.Logs[i],
							)
						}
					}
				}
			})
		}
	}
}

func TestCheckFnsCallHelper(t *testing.T) {
	for _, testFn := range passingTestFns {
		t.Run(testFn.name, func(t *testing.T) {
			mockHelperT := &cmtest.MockHelperT{}

			testFn.fn(mockHelperT, testFn.args)

			if !mockHelperT.HelperCalled {
				t.Errorf("%s: expected HelperT to be called", testFn.name)
			}
		})
	}
}

func TestCheckFnsShouldNotFailOrEmitLogsOnSuccess(t *testing.T) {
	for _, testFn := range passingTestFns {
		t.Run(testFn.name, func(t *testing.T) {
			mockT := &cmtest.MockT{}
			testFn.fn(mockT, testFn.args)

			if mockT.FailNowCalled || mockT.FailCalled {
				t.Fatalf(
					"%s: fail called, expected the test to not be failed on true condition",
					testFn.name,
				)
			}
			if len(mockT.Logs) > 0 {
				t.Fatalf(
					"%s: %v logs emitted, expected the test to not emit any logs on true condition",
					testFn.name, mockT.Logs,
				)
			}
		})
	}
}

func TestCheckEqual(t *testing.T) {
	testCases := []struct {
		name        string
		actual      any
		expected    any
		shouldFail  bool
		logMessages []string
	}{
		{"EqualIntegers", 5, 5, false, []string{}},
		{"UnequalIntegers", 5, 10, true, []string{"expected 5 to equal 10"}},
		{"EqualFloats", 5.123, 5.123, false, []string{}},
		{"UnequalFloats", 5.123, 5.1234, true, []string{"expected 5.123 to equal 5.1234"}},
		{"EqualStrings", "test", "test", false, []string{}},
		{"UnequalStrings", "test", "fail", true, []string{"expected test to equal fail"}},
		{"EqualBooleans", true, true, false, []string{}},
		{"UnequalBooleans", false, true, true, []string{"expected false to equal true"}},
	}

	for _, tc := range testCases {
		t.Run(tc.name, func(t *testing.T) {
			mockT := &cmtest.MockT{}
			Equal(mockT, tc.actual, tc.expected)

			if mockT.FailCalled != tc.shouldFail {
				t.Errorf(
					"%s: FailCalled = %v, want %v",
					tc.name, mockT.FailCalled, tc.shouldFail,
				)
			}
			if len(mockT.Logs) != len(tc.logMessages) {
				t.Errorf(
					"%s: expected %d (%v) log messages but got %d (%v)",
					tc.name, len(mockT.Logs), mockT.Logs, len(tc.logMessages), tc.logMessages,
				)
			}
			if len(mockT.Logs) == len(tc.logMessages) {
				for i, expectedLogMsg := range tc.logMessages {
					if mockT.Logs[i] != expectedLogMsg {
						t.Errorf(
							"%s: expected log message '%s', got '%s'",
							tc.name, expectedLogMsg, mockT.Logs[0],
						)
					}
				}
			}
		})
	}
}

func TestCheckDeepEqual(t *testing.T) {
	type TestStruct struct {
		Name string
		Age  int
	}

	t.Run("Equal structs", func(t *testing.T) {
		mockT := &cmtest.MockT{}
		DeepEqual(mockT, TestStruct{"Alice", 30}, TestStruct{"Alice", 30})
		if mockT.FailCalled {
			t.Error("CheckDeepEqual failed when it should have passed")
		}
	})

	t.Run("Not equal structs", func(t *testing.T) {
		mockT := &cmtest.MockT{}
		DeepEqual(mockT, TestStruct{"Alice", 30}, TestStruct{"Bob", 30})
		if !mockT.FailCalled {
			t.Error("CheckDeepEqual passed when it should have failed")
		}
		if len(mockT.Logs) == 0 || !containsDiffMessage(mockT.Logs[0]) {
			t.Error("CheckDeepEqual did not log the correct diff message")
		}
	})
}

func containsDiffMessage(log string) bool {
	return strings.Contains(log, "(-expected +actual)")
}

func TestCheckErrorIsChecksErrTree(t *testing.T) {
	mockT := &cmtest.MockT{}
	actual := fmt.Errorf("wrapped: %w", os.ErrInvalid)
	expected := os.ErrInvalid

	ErrorIs(mockT, actual, expected)

	if mockT.FailNowCalled {
		t.Fatal("CheckErrorIs failed when it should have passed")
	}
}

func TestCheckReturnValues(t *testing.T) {
	t.Run("should return true on true condition", func(t *testing.T) {
		mockT := &cmtest.MockT{}

		passed := check(mockT, true)

		if !passed {
			t.Fatal("Check should have returned true on true condition")
		}
	})

	t.Run("should return false on false condition", func(t *testing.T) {
		mockT := &cmtest.MockT{}

		passed := check(mockT, false)

		if passed {
			t.Fatal("Check should have returned false on false condition")
		}
	})
}

func TestCheckNilForNilPointer(t *testing.T) {
	mockT := &cmtest.MockT{}
	var value *cmtest.MockT = nil

	passed := Nil(mockT, value)

	if !passed {
		t.Fatal("check.Nil should have returned true for nil pointer")
	}
}

func TestCheckContainsErrorCases(t *testing.T) {
	t.Run("String container with non-string item", func(t *testing.T) {
		mockT := &cmtest.MockT{}
		passed := Contains(mockT, "hello world", 123)

		if passed {
			t.Error("Contains should fail when string container has non-string item")
		}
		if len(mockT.Logs) == 0 || !strings.Contains(mockT.Logs[0], "item must be string") {
			t.Errorf("Expected error message about item type, got: %v", mockT.Logs)
		}
	})

	t.Run("Unsupported container type", func(t *testing.T) {
		mockT := &cmtest.MockT{}
		passed := Contains(mockT, 123, 1)

		if passed {
			t.Error("Contains should fail for unsupported container type")
		}
		if len(mockT.Logs) == 0 || !strings.Contains(mockT.Logs[0], "unsupported container type") {
			t.Errorf("Expected error message about unsupported type, got: %v", mockT.Logs)
		}
	})
}

func TestCheckNotContainsErrorCases(t *testing.T) {
	t.Run("String container with non-string item", func(t *testing.T) {
		mockT := &cmtest.MockT{}
		passed := NotContains(mockT, "hello world", 123)

		if passed {
			t.Error("NotContains should fail when string container has non-string item")
		}
		if len(mockT.Logs) == 0 || !strings.Contains(mockT.Logs[0], "item must be string") {
			t.Errorf("Expected error message about item type, got: %v", mockT.Logs)
		}
	})

	t.Run("Unsupported container type", func(t *testing.T) {
		mockT := &cmtest.MockT{}
		passed := NotContains(mockT, 123, 1)

		if passed {
			t.Error("NotContains should fail for unsupported container type")
		}
		if len(mockT.Logs) == 0 || !strings.Contains(mockT.Logs[0], "unsupported container type") {
			t.Errorf("Expected error message about unsupported type, got: %v", mockT.Logs)
		}
	})
}