all repos

x @ da217b4426264b3ac4861ce9411bcff61cb3426b

go extra()

x/is/is_test.go(view raw)

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
package is_test

import (
	"errors"
	"fmt"
	"io/fs"
	"math/rand/v2"
	"reflect"
	"testing"
	"time"

	"olexsmir.xyz/x/is"
)

func TestEqual(t *testing.T) {
	t.Run("equal", func(t *testing.T) {
		now := time.Now()
		val := 420

		tests := map[string]struct{ got, expected any }{
			"int":          {69, 69},
			"string":       {"hello", "hello"},
			"bool":         {true, true},
			"struct":       {intType{1}, intType{1}},
			"pointer":      {&val, &val},
			"nil":          {nil, nil},
			"nil pointer":  {(*int)(nil), (*int)(nil)},
			"nil map":      {map[string]int(nil), map[string]int(nil)},
			"nil chan":     {(chan int)(nil), (chan int)(nil)},
			"nil slice":    {[]int(nil), []int(nil)},
			"byte slice":   {[]byte("abc"), []byte("abc")},
			"int slice":    {[]int{1, 2}, []int{1, 2}},
			"string slice": {[]string{"a", "b"}, []string{"a", "b"}},
			"empty map":    {map[string]int{}, map[string]int{}},
			"map":          {map[string]int{"a": 1}, map[string]int{"a": 1}},
			"time.Time":    {now, now},
		}
		for tname, tt := range tests {
			t.Run(tname, func(t *testing.T) {
				ft := &fakeT{}
				is.Equal(ft, tt.expected, tt.got)
				if ft.failed {
					t.Errorf("failed: %s", ft.msg)
				}
			})
		}
	})

	t.Run("non-equal", func(t *testing.T) {
		now := time.Now()
		val1, val2 := 69, 420
		tests := map[string]struct {
			expected, got any
			expectedMsg   string
		}{
			"int":             {228, 1337, `expected: 228, got: 1337`},
			"string":          {"hello", "world", `expected: "hello", got: "world"`},
			"bool":            {true, false, "expected: true, got: false"},
			"struct":          {intType{1}, intType{2}, `expected: is_test.intType{v:1}, got: is_test.intType{v:2}`},
			"pointer":         {&val1, &val2, ``},
			"nil/non-nil":     {nil, 2, `expected: <nil>, got: 2`},
			"non-nil/nil":     {2, nil, `expected: 2, got: <nil>`},
			"nil slice/empty": {[]int(nil), []int{}, `expected: []int(nil), got: []int{}`},
			"int slice":       {[]int{1, 2}, []int{2, 1}, `expected: []int{1, 2}, got: []int{2, 1}`},
			"byte slice":      {[]byte("abc"), []byte("def"), `expected: []byte{0x61, 0x62, 0x63}, got: []byte{0x64, 0x65, 0x66}`},
			"chan":            {make(chan int), make(chan int), ``},
			"string slice":    {[]string{"a", "b"}, []string{"b", "a"}, `expected: []string{"a", "b"}, got: []string{"b", "a"}`},
			"map":             {map[string]int{"a": 1}, map[string]int{"a": 2}, `expected: map[string]int{"a":1}, got: map[string]int{"a":2}`},
			"time.Time":       {now, now.Add(time.Second), ``},
		}

		for tname, tt := range tests {
			t.Run(tname, func(t *testing.T) {
				ft := &fakeT{}
				is.Equal(ft, tt.expected, tt.got)
				shouldHaveFailed(t, ft)
				if tt.expectedMsg != "" {
					expectMsg(t, ft, tt.expectedMsg)
				}
			})
		}
	})

	t.Run("implements equaler", func(t *testing.T) {
		ft := &fakeT{}
		val1, val2 := newRandomy(1), newRandomy(1)
		is.Equal(ft, val1, val2)
		if ft.failed {
			t.Errorf("%#v == %#v: should have passed", val1, val2)
		}
	})

	t.Run("implements equaler, not empty", func(t *testing.T) {
		ft := &fakeT{}
		val1, val2 := newRandomy(1), newRandomy(2)
		is.Equal(ft, val1, val2)
		shouldHaveFailed(t, ft)
	})

	t.Run("time.Time", func(t *testing.T) {
		ft := &fakeT{}
		val1 := time.Date(2022, 1, 3, 0, 0, 18, 0, time.UTC)
		val2 := time.Date(2022, 1, 3, 5, 0, 18, 0, time.FixedZone("UTC+5", 5*3600))
		is.Equal(ft, val1, val1)
		if ft.failed {
			t.Errorf("%#v == %#v: should have passed", val1, val2)
		}
	})
}

func TestErr(t *testing.T) {
	t.Run("expected nil, got nil", func(t *testing.T) {
		ft := &fakeT{}
		is.Err(ft, nil, nil)
		if ft.failed {
			t.Errorf("failed: %s", ft.msg)
		}
	})

	t.Run("expected nil, got error", func(t *testing.T) {
		ft := &fakeT{}
		is.Err(ft, errors.New("an error"), nil)

		shouldBeFatal(t, ft)
		shouldHaveFailed(t, ft)
		expectMsg(t, ft, "unexpected error: an error")
	})

	t.Run("expected error, got nil", func(t *testing.T) {
		ft := &fakeT{}
		is.Err(ft, nil, errors.New("err"))

		shouldHaveFailed(t, ft)
		expectMsg(t, ft, `got: <nil>, expected: error`)
	})

	t.Run("expected error, got same error", func(t *testing.T) {
		ft := &fakeT{}
		err := errors.New("an error")
		is.Err(ft, err, err)
		if ft.failed {
			t.Errorf("failed: %s", ft.msg)
		}
	})

	t.Run("expected error, got different error", func(t *testing.T) {
		ft := &fakeT{}
		err1 := errors.New("an error")
		err2 := errors.New("second error")
		is.Err(ft, err1, err2)

		shouldHaveFailed(t, ft)
		shouldBeFatal(t, ft)
		expectMsg(t, ft, `expected: *errors.errorString(an error), got: *errors.errorString(second error)`)
	})

	t.Run("expected error, got error of different type", func(t *testing.T) {
		ft := &fakeT{}
		err1 := errors.New("an error")
		err2 := errType("my error")
		is.Err(ft, err1, err2)

		shouldHaveFailed(t, ft)
		shouldBeFatal(t, ft)
		expectMsg(t, ft, `expected: *errors.errorString(an error), got: is_test.errType(my error)`)
	})

	t.Run("expected error, got wrapped error", func(t *testing.T) {
		ft := &fakeT{}
		err := errors.New("an error")
		werr := fmt.Errorf("wrapped: %w", err)
		is.Err(ft, werr, err)
		if ft.failed {
			t.Errorf("failed: %s", ft.msg)
		}
	})

	t.Run("got error, string", func(t *testing.T) {
		ft := &fakeT{}
		is.Err(ft, errors.New("test string"), "test string")
		if ft.failed {
			t.Errorf("failed: %s", ft.msg)
		}
	})

	t.Run("got error, partial string", func(t *testing.T) {
		ft := &fakeT{}
		is.Err(ft, errors.New("test string"), "string")
		if ft.failed {
			t.Errorf("failed: %s", ft.msg)
		}
	})

	t.Run("got error, not containing string", func(t *testing.T) {
		ft := &fakeT{}
		is.Err(ft, errors.New("test string"), "asdfasdf")

		shouldHaveFailed(t, ft)
		shouldBeFatal(t, ft)
		expectMsg(t, ft, `expected: "test string", got: "asdfasdf"`)
	})

	t.Run("got custom type, same types", func(t *testing.T) {
		ft := &fakeT{}
		err := errType("custom error")
		is.Err(ft, err, err)
		if ft.failed {
			t.Errorf("failed: %s", ft.msg)
		}
	})

	t.Run("got custom type, different types", func(t *testing.T) {
		ft := &fakeT{}
		err := errType("custom error")
		is.Err(ft, err, reflect.TypeFor[*fs.PathError]())
		shouldHaveFailed(t, ft)
		shouldBeFatal(t, ft)
		expectMsg(t, ft, `expected: *fs.PathError, got: is_test.errType`)
	})

	t.Run("unexpected type", func(t *testing.T) {
		ft := &fakeT{}
		is.Err(ft, errors.New("asdf"), 0)
		shouldHaveFailed(t, ft)
		shouldBeFatal(t, ft)
		expectMsg(t, ft, `unexpected type: int`)
	})
}

func expectMsg(t *testing.T, ft *fakeT, expectedMsg string) {
	t.Helper()
	if ft.msg != expectedMsg {
		t.Errorf("expected msg: %q; got: %q", expectedMsg, ft.msg)
	}
}

func shouldBeFatal(t *testing.T, ft *fakeT) {
	t.Helper()
	if !ft.fatal {
		t.Error("should be fatal")
	}
}

func shouldHaveFailed(t *testing.T, ft *fakeT) {
	t.Helper()
	if !ft.failed {
		t.Error("should have failed")
	}
}

// helper types ---

type intType struct{ v int }

type randomy struct {
	val int
	rnd float64
}

func newRandomy(val int) randomy           { return randomy{val, rand.Float64()} }
func (n randomy) Equal(other randomy) bool { return n.val == other.val }

type errType string

func (e errType) Error() string { return string(e) }

// mockT ----

type fakeT struct {
	testing.TB
	failed bool
	fatal  bool
	msg    string
}

func (m *fakeT) Helper() {}

func (m *fakeT) Log(a ...any) { fmt.Println(a...) }

func (m *fakeT) Fatal(args ...any) {
	m.fatal = true
	m.Error(args...)
}

func (m *fakeT) Fatalf(format string, args ...any) {
	m.fatal = true
	m.Errorf(format, args...)
}

func (m *fakeT) Error(args ...any) {
	m.failed = true
	m.msg = fmt.Sprint(args...)
}

func (m *fakeT) Errorf(format string, args ...any) {
	m.failed = true
	m.msg = fmt.Sprintf(format, args...)
}