-
Notifications
You must be signed in to change notification settings - Fork 100
/
assert.go
209 lines (188 loc) · 5.61 KB
/
assert.go
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
// Copyright 2021-2022 Buf Technologies, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// Package assert is a minimal assert package using generics.
//
// This prevents connect from needing additional dependencies.
package assert
import (
"bytes"
"errors"
"fmt"
"reflect"
"regexp"
"testing"
"github.com/google/go-cmp/cmp"
"google.golang.org/protobuf/testing/protocmp"
)
// Equal asserts that two values are equal.
func Equal[T any](tb testing.TB, got, want T, options ...Option) bool {
tb.Helper()
if cmpEqual(got, want) {
return true
}
report(tb, got, want, "assert.Equal", true /* showWant */, options...)
return false
}
// NotEqual asserts that two values aren't equal.
func NotEqual[T any](tb testing.TB, got, want T, options ...Option) bool {
tb.Helper()
if !cmpEqual(got, want) {
return true
}
report(tb, got, want, "assert.NotEqual", true /* showWant */, options...)
return false
}
// Nil asserts that the value is nil.
func Nil(tb testing.TB, got any, options ...Option) bool {
tb.Helper()
if isNil(got) {
return true
}
report(tb, got, nil, "assert.Nil", false /* showWant */, options...)
return false
}
// NotNil asserts that the value isn't nil.
func NotNil(tb testing.TB, got any, options ...Option) bool {
tb.Helper()
if !isNil(got) {
return true
}
report(tb, got, nil, "assert.NotNil", false /* showWant */, options...)
return false
}
// Zero asserts that the value is its type's zero value.
func Zero[T any](tb testing.TB, got T, options ...Option) bool {
tb.Helper()
var want T
if cmpEqual(got, want) {
return true
}
report(tb, got, want, fmt.Sprintf("assert.Zero (type %T)", got), false /* showWant */, options...)
return false
}
// NotZero asserts that the value is non-zero.
func NotZero[T any](tb testing.TB, got T, options ...Option) bool {
tb.Helper()
var want T
if !cmpEqual(got, want) {
return true
}
report(tb, got, want, fmt.Sprintf("assert.NotZero (type %T)", got), false /* showWant */, options...)
return false
}
// Match asserts that the value matches a regexp.
func Match(tb testing.TB, got, want string, options ...Option) bool {
tb.Helper()
re, err := regexp.Compile(want)
if err != nil {
tb.Fatalf("invalid regexp %q: %v", want, err)
}
if re.MatchString(got) {
return true
}
report(tb, got, want, "assert.Match", true /* showWant */, options...)
return false
}
// ErrorIs asserts that "want" is in "got's" error chain. See the standard
// library's errors package for details on error chains. On failure, output is
// identical to Equal.
func ErrorIs(tb testing.TB, got, want error, options ...Option) bool {
tb.Helper()
if errors.Is(got, want) {
return true
}
report(tb, got, want, "assert.ErrorIs", true /* showWant */, options...)
return false
}
// False asserts that "got" is false.
func False(tb testing.TB, got bool, options ...Option) bool {
tb.Helper()
if !got {
return true
}
report(tb, got, false, "assert.False", false /* showWant */, options...)
return false
}
// True asserts that "got" is true.
func True(tb testing.TB, got bool, options ...Option) bool {
tb.Helper()
if got {
return true
}
report(tb, got, true, "assert.True", false /* showWant */, options...)
return false
}
// Panics asserts that the function called panics.
func Panics(tb testing.TB, panicker func(), options ...Option) {
tb.Helper()
defer func() {
if r := recover(); r == nil {
report(tb, r, nil, "assert.Panic", false /* showWant */, options...)
}
}()
panicker()
}
// An Option configures an assertion.
type Option interface {
// Only option we've needed so far is a formatted message, so we can keep
// this simple.
message() string
}
// Sprintf adds a user-defined message to the assertion's output. The arguments
// are passed directly to fmt.Sprintf for formatting.
//
// If Sprintf is passed multiple times, only the last message is used.
func Sprintf(template string, args ...any) Option {
return &sprintfOption{fmt.Sprintf(template, args...)}
}
type sprintfOption struct {
msg string
}
func (o *sprintfOption) message() string {
return o.msg
}
func report(tb testing.TB, got, want any, desc string, showWant bool, options ...Option) {
tb.Helper()
buffer := &bytes.Buffer{}
if len(options) > 0 {
buffer.WriteString(options[len(options)-1].message())
}
buffer.WriteString("\n")
fmt.Fprintf(buffer, "assertion:\t%s\n", desc)
fmt.Fprintf(buffer, "got:\t%+v\n", got)
if showWant {
fmt.Fprintf(buffer, "want:\t%+v\n", want)
}
tb.Fatal(buffer.String())
}
func isNil(got any) bool {
// Simple case, true only when the user directly passes a literal nil.
if got == nil {
return true
}
// Possibly more complex. Interfaces are a pair of words: a pointer to a type
// and a pointer to a value. Because we're passing got as an interface, it's
// likely that we've gotten a non-nil type and a nil value. This makes got
// itself non-nil, but the user's code passed a nil value.
val := reflect.ValueOf(got)
switch val.Kind() {
case reflect.Chan, reflect.Func, reflect.Interface, reflect.Map, reflect.Ptr, reflect.Slice:
return val.IsNil()
default:
return false
}
}
func cmpEqual(got, want any) bool {
return cmp.Equal(got, want, protocmp.Transform())
}