-
Notifications
You must be signed in to change notification settings - Fork 0
/
expectation.messagetype.event_test.go
270 lines (256 loc) · 7.43 KB
/
expectation.messagetype.event_test.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
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
package testkit_test
import (
"context"
"github.com/dogmatiq/dogma"
. "github.com/dogmatiq/dogma/fixtures"
. "github.com/dogmatiq/enginekit/enginetest/stubs"
. "github.com/dogmatiq/testkit"
"github.com/dogmatiq/testkit/engine"
"github.com/dogmatiq/testkit/internal/testingmock"
g "github.com/onsi/ginkgo/v2"
. "github.com/onsi/gomega"
)
var _ = g.Describe("func ToRecordEventType()", func() {
var (
testingT *testingmock.T
app dogma.Application
)
g.BeforeEach(func() {
testingT = &testingmock.T{
FailSilently: true,
}
app = &ApplicationStub{
ConfigureFunc: func(c dogma.ApplicationConfigurer) {
c.Identity("<app>", "ef25ca55-2ace-40b5-9c2d-c53f5a80908a")
c.RegisterAggregate(&AggregateMessageHandlerStub{
ConfigureFunc: func(c dogma.AggregateConfigurer) {
c.Identity("<aggregate>", "bef4f7fd-cd2a-4e10-9c52-691d389847b3")
c.Routes(
dogma.HandlesCommand[MessageR](), // R = record an event
dogma.HandlesCommand[MessageN](), // N = do nothing
dogma.RecordsEvent[MessageE](),
dogma.RecordsEvent[*MessageE](), // pointer, used to test type similarity
dogma.RecordsEvent[MessageX](),
)
},
RouteCommandToInstanceFunc: func(dogma.Command) string {
return "<instance>"
},
HandleCommandFunc: func(
_ dogma.AggregateRoot,
s dogma.AggregateCommandScope,
m dogma.Command,
) {
if _, ok := m.(MessageR); ok {
s.RecordEvent(MessageE1)
}
},
})
c.RegisterProcess(&ProcessMessageHandlerStub{
ConfigureFunc: func(c dogma.ProcessConfigurer) {
c.Identity("<process>", "6a2146fa-00e5-49a3-acd8-fb0a6451a8ff")
c.Routes(
dogma.HandlesEvent[MessageE](), // E = execute a command
dogma.HandlesEvent[MessageO](), // O = only consumed, never produced
dogma.ExecutesCommand[MessageN](),
)
},
RouteEventToInstanceFunc: func(
context.Context,
dogma.Event,
) (string, bool, error) {
return "<instance>", true, nil
},
HandleEventFunc: func(
_ context.Context,
_ dogma.ProcessRoot,
s dogma.ProcessEventScope,
m dogma.Event,
) error {
if _, ok := m.(MessageE); ok {
s.ExecuteCommand(MessageN1)
}
return nil
},
})
},
}
})
g.DescribeTable(
"expectation behavior",
func(
a Action,
e Expectation,
ok bool,
rm reportMatcher,
options ...TestOption,
) {
test := Begin(testingT, app, options...)
test.Expect(a, e)
rm(testingT)
Expect(testingT.Failed()).To(Equal(!ok))
},
g.Entry(
"event type recorded as expected",
ExecuteCommand(MessageR1),
ToRecordEventType[MessageE](),
expectPass,
expectReport(
`✓ record any 'fixtures.MessageE' event`,
),
),
g.Entry(
"no matching event type recorded",
ExecuteCommand(MessageR1),
ToRecordEventType[MessageX](),
expectFail,
expectReport(
`✗ record any 'fixtures.MessageX' event`,
``,
` | EXPLANATION`,
` | none of the engaged handlers recorded a matching event`,
` | `,
` | SUGGESTIONS`,
` | • enable integration handlers using the EnableHandlerType() option`,
` | • verify the logic within the '<aggregate>' aggregate message handler`,
),
),
g.Entry(
"no matching event type recorded and all relevant handler types disabled",
ExecuteCommand(MessageR1),
ToRecordEventType[MessageX](),
expectFail,
expectReport(
`✗ record any 'fixtures.MessageX' event`,
``,
` | EXPLANATION`,
` | no relevant handler types were enabled`,
` | `,
` | SUGGESTIONS`,
` | • enable aggregate handlers using the EnableHandlerType() option`,
` | • enable integration handlers using the EnableHandlerType() option`,
),
WithUnsafeOperationOptions(
engine.EnableAggregates(false),
engine.EnableIntegrations(false),
),
),
g.Entry(
"no matching event type recorded and no relevant handler types engaged",
ExecuteCommand(MessageR1),
ToRecordEventType[MessageX](),
expectFail,
expectReport(
`✗ record any 'fixtures.MessageX' event`,
``,
` | EXPLANATION`,
` | no relevant handlers (aggregate or integration) were engaged`,
` | `,
` | SUGGESTIONS`,
` | • enable aggregate handlers using the EnableHandlerType() option`,
` | • check the application's routing configuration`,
),
WithUnsafeOperationOptions(
engine.EnableAggregates(false),
engine.EnableIntegrations(true),
),
),
g.Entry(
"no messages produced at all",
ExecuteCommand(MessageN1),
ToRecordEventType[MessageX](),
expectFail,
expectReport(
`✗ record any 'fixtures.MessageX' event`,
``,
` | EXPLANATION`,
` | no messages were produced at all`,
` | `,
` | SUGGESTIONS`,
` | • enable integration handlers using the EnableHandlerType() option`,
` | • verify the logic within the '<aggregate>' aggregate message handler`,
),
),
g.Entry(
"no events recorded at all",
RecordEvent(MessageE1),
ToRecordEventType[MessageX](),
expectFail,
expectReport(
`✗ record any 'fixtures.MessageX' event`,
``,
` | EXPLANATION`,
` | no events were recorded at all`,
` | `,
` | SUGGESTIONS`,
` | • enable integration handlers using the EnableHandlerType() option`,
` | • verify the logic within the '<aggregate>' aggregate message handler`,
),
),
g.Entry(
"event of a similar type recorded",
ExecuteCommand(MessageR1),
ToRecordEventType[*MessageE](), // note: message type is pointer
expectFail,
expectReport(
`✗ record any '*fixtures.MessageE' event`,
``,
` | EXPLANATION`,
` | an event of a similar type was recorded by the '<aggregate>' aggregate message handler`,
` | `,
` | SUGGESTIONS`,
` | • check the message type, should it be a pointer?`,
` | `,
` | MESSAGE TYPE DIFF`,
` | [-*-]fixtures.MessageE`,
),
),
g.Entry(
"does not include an explanation when negated and a sibling expectation passes",
ExecuteCommand(MessageR1),
NoneOf(
ToRecordEventType[MessageE](),
ToRecordEventType[MessageX](),
),
expectFail,
expectReport(
`✗ none of (1 of the expectations passed unexpectedly)`,
` ✓ record any 'fixtures.MessageE' event`,
` ✗ record any 'fixtures.MessageX' event`,
),
),
)
g.It("fails the test if the message type is unrecognized", func() {
test := Begin(testingT, app)
test.Expect(
noop,
ToRecordEventType[MessageU](),
)
Expect(testingT.Failed()).To(BeTrue())
Expect(testingT.Logs).To(ContainElement(
"an event of type fixtures.MessageU can never be recorded, the application does not use this message type",
))
})
g.It("fails the test if the message type is not an event", func() {
test := Begin(testingT, app)
test.Expect(
noop,
ToRecordEventType[MessageR](),
)
Expect(testingT.Failed()).To(BeTrue())
Expect(testingT.Logs).To(ContainElement(
"fixtures.MessageR is a command, it can never be recorded as an event",
))
})
g.It("fails the test if the message type is not produced by any handlers", func() {
test := Begin(testingT, app)
test.Expect(
noop,
ToRecordEventType[MessageO](),
)
Expect(testingT.Failed()).To(BeTrue())
Expect(testingT.Logs).To(ContainElement(
"no handlers record events of type fixtures.MessageO, it is only ever consumed",
))
})
})