/
events.go
230 lines (216 loc) · 7.25 KB
/
events.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
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
// Copyright © 2019 The Things Network Foundation, The Things Industries B.V.
//
// 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 assertions
import (
"context"
"fmt"
"time"
"github.com/smartystreets/assertions"
"go.thethings.network/lorawan-stack/v3/pkg/events"
"go.thethings.network/lorawan-stack/v3/pkg/util/test"
)
const (
needEventAssertionCompatible = "This assertion requires a func(events.Event) bool-compatible comparison type (you provided %T)."
needEventCompatible = "This assertion requires a Event-compatible comparison type (you provided %T)."
needEventBuilderCompatible = "This assertion requires an EventBuilder-compatible comparison type (you provided %T)."
needEventChannelCompatible = "This assertion requires a events.Channel-compatible or <-chan test.EventPubSubPublishRequest-compatible comparison type (you provided %T)."
)
// ShouldResembleEvent is used to assert that an events.Event resembles another events.Event.
func ShouldResembleEvent(actual interface{}, expected ...interface{}) string {
if len(expected) != 1 {
return fmt.Sprintf(needExactValues, 1, len(expected))
}
ee, ok := expected[0].(events.Event)
if !ok {
return fmt.Sprintf(needEventCompatible, expected[0])
}
ae, ok := actual.(events.Event)
if !ok {
return fmt.Sprintf(needEventCompatible, actual)
}
ep, err := events.Proto(ee)
if s := assertions.ShouldBeNil(err); s != success {
return s
}
ap, err := events.Proto(ae)
if s := assertions.ShouldBeNil(err); s != success {
return s
}
ap.Time = time.Time{}
ep.Time = time.Time{}
ap.Authentication = nil
ep.Authentication = nil
ap.UserAgent = ""
ep.UserAgent = ""
ap.RemoteIP = ""
ep.RemoteIP = ""
return ShouldResemble(ap, ep)
}
// ShouldResembleEventBuilder is used to assert that an events.Builder resembles another events.Builder.
func ShouldResembleEventBuilder(actual interface{}, expected ...interface{}) string {
if len(expected) != 1 {
return fmt.Sprintf(needExactValues, 1, len(expected))
}
ed, ok := expected[0].(events.Builder)
if !ok {
return fmt.Sprintf(needEventBuilderCompatible, expected[0])
}
ad, ok := actual.(events.Builder)
if !ok {
return fmt.Sprintf(needEventBuilderCompatible, actual)
}
ctx := context.Background()
return ShouldResembleEvent(ad.New(ctx), ed.New(ctx))
}
// ShouldResembleEventBuilders is like ShouldResembleEventBuilders, but for events.Builders
func ShouldResembleEventBuilders(actual interface{}, expected ...interface{}) string {
if len(expected) != 1 {
return fmt.Sprintf(needExactValues, 1, len(expected))
}
eds, ok := expected[0].(events.Builders)
if !ok {
return fmt.Sprintf(needEventBuilderCompatible, expected[0])
}
ads, ok := actual.(events.Builders)
if !ok {
return fmt.Sprintf(needEventBuilderCompatible, actual)
}
ctx := context.Background()
if s := assertions.ShouldHaveLength(ads, len(eds)); s != success {
return s
}
for i, ad := range ads {
if s := ShouldResembleEvent(ad.New(ctx), eds[i].New(ctx)); s != success {
return fmt.Sprintf("Mismatch in event definition %d: %s", i, s)
}
}
return success
}
var eventTimeout = test.Delay << 7
func receiveEvent(v interface{}) (events.Event, string) {
switch ch := v.(type) {
case <-chan events.Event:
select {
case <-time.After(eventTimeout):
return nil, fmt.Sprintf("Timed out while waiting for event to arrive")
case ev := <-ch:
return ev, success
}
case <-chan test.EventPubSubPublishRequest:
select {
case <-time.After(eventTimeout):
return nil, fmt.Sprintf("Timed out while waiting for event publish request to arrive")
case req := <-ch:
select {
case <-time.After(eventTimeout):
return nil, fmt.Sprintf("Timed out while waiting for event publish response to be processed")
case req.Response <- struct{}{}:
}
return req.Event, success
}
}
return nil, fmt.Sprintf(needEventChannelCompatible, v)
}
// ShouldReceiveEventFunc receives 3 parameters. The first being a channel of either events.Event or test.EventPubSubPublishRequest,
// the second being the equality function of type func(events.Event, events.Event) bool and third being the expected events.Event.
func ShouldReceiveEventFunc(actual interface{}, expected ...interface{}) string {
if len(expected) != 2 {
return fmt.Sprintf(needExactValues, 2, len(expected))
}
eq, ok := expected[0].(func(events.Event, events.Event) bool)
if !ok {
return fmt.Sprintf(needEventAssertionCompatible, expected[0])
}
ee, ok := expected[1].(events.Event)
if !ok {
return fmt.Sprintf(needEventCompatible, expected[1])
}
ae, s := receiveEvent(actual)
if s != success {
return s
}
return assertions.ShouldBeTrue(eq(ae, ee))
}
// ShouldReceiveEventResembling is like ShouldReceiveEventFunc, but uses same resemblance function as ShouldResembleEvent.
func ShouldReceiveEventResembling(actual interface{}, expected ...interface{}) string {
if len(expected) != 1 {
return fmt.Sprintf(needExactValues, 1, len(expected))
}
ae, s := receiveEvent(actual)
if s != success {
return s
}
return ShouldResembleEvent(ae, expected[0])
}
func eventSlice(vs ...interface{}) ([]events.Event, string) {
var evs []events.Event
for _, v := range vs {
ev, ok := v.(events.Event)
if ok {
evs = append(evs, ev)
continue
}
r, ok := test.WrapRanger(v)
if !ok {
return nil, fmt.Sprintf("Cannot range over values of type %T", v)
}
s := success
r.Range(func(_, v interface{}) bool {
ev, ok := v.(events.Event)
if !ok {
s = fmt.Sprintf(needEventCompatible, v)
return false
}
evs = append(evs, ev)
return true
})
if s != success {
return nil, s
}
}
return evs, success
}
// ShouldReceiveEventsFunc is like ShouldReceiveEventFunc, but allows for several expected events to be specified.
// Expected events should be passed as variadic parameters, which can be wrapped any collection of events.Event, that test.WrapRanger can range over.
func ShouldReceiveEventsFunc(actual interface{}, expected ...interface{}) string {
if len(expected) < 2 {
return fmt.Sprintf(needAtLeastValues, 2, len(expected))
}
evs, s := eventSlice(expected[1:]...)
if s != success {
return s
}
for i, exp := range evs {
if s := ShouldReceiveEventFunc(actual, expected[0], exp); s != success {
return fmt.Sprintf("Mismatch in event number %d: %s", i, s)
}
}
return success
}
// ShouldReceiveEventsFunc is like ShouldReceiveEventsFunc, but uses same resemblance function as ShouldResembleEvent.
func ShouldReceiveEventsResembling(actual interface{}, expected ...interface{}) string {
if len(expected) == 0 {
return fmt.Sprintf(needAtLeastValues, 1, len(expected))
}
evs, s := eventSlice(expected...)
if s != success {
return s
}
for i, exp := range evs {
if s := ShouldReceiveEventResembling(actual, exp); s != success {
return fmt.Sprintf("Mismatch in event number %d: %s", i, s)
}
}
return success
}