-
Notifications
You must be signed in to change notification settings - Fork 2
/
util_test.go
506 lines (459 loc) · 14.3 KB
/
util_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
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
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
package pokemonbattlelib
import (
"errors"
"fmt"
"reflect"
"strings"
"github.com/onsi/gomega/types"
)
// Gomega custom matchers, see: https://onsi.github.io/gomega/#adding-your-own-matchers
// Used for custom gomega matchers. Checks to see if a is probably the same pokemon as b based on values that are unlikely to change as a result of a transaction.
func comparePokemon(a, b *Pokemon) bool {
return a == b
}
// Helper struct for finding differences in objects for testing
type diff struct {
expected interface{} // The expected value
got interface{} // The actual value received
}
// Creates a diff of expected fields vs received fields in same-type transactions
// Also returns the number of fields that were compared
func transactionDiff(expected, got Transaction) map[string]diff {
// types that must match exactly, including zeroed values
exactMatchTypes := []reflect.Type{
reflect.TypeOf(true),
reflect.TypeOf(FailMiss),
reflect.TypeOf(WeatherClearSkies),
reflect.TypeOf(StatusNone),
}
result := make(map[string]diff)
rA := reflect.ValueOf(expected)
rB := reflect.ValueOf(got)
for i := 0; i < rA.NumField(); i++ {
typeField := rA.Type().Field(i)
rfA := rA.Field(i)
rfB := rB.FieldByName(typeField.Name)
if !rfB.IsValid() {
result[typeField.Name] = diff{
expected: rfA.Interface(),
got: "invalid reflection value",
}
continue
}
if rfA.Type() != rfB.Type() {
result[typeField.Name] = diff{
expected: rfA.Type(),
got: rfB.Type(),
}
continue
}
if rfA.Type() == reflect.TypeOf(&Pokemon{}) {
a := rfA.Interface().(*Pokemon)
b := rfB.Interface().(*Pokemon)
if !comparePokemon(a, b) {
result[typeField.Name] = diff{
expected: a,
got: b,
}
}
continue
} else if rfA.Kind() == reflect.Struct || rfA.Kind() == reflect.Interface || rfA.Kind() == reflect.Map || rfA.Kind() == reflect.Array || rfA.Kind() == reflect.Slice {
if !reflect.DeepEqual(rfA.Interface(), rfB.Interface()) {
result[typeField.Name] = diff{
expected: rfA.Interface(),
got: rfB.Interface(),
}
}
} else if rfA.Type() == reflect.TypeOf(&Move{}) {
if !rfA.IsNil() && !rfB.IsNil() {
mvA := rfA.Interface().(*Move)
mvB := rfB.Interface().(*Move)
if mvA.Id != mvB.Id {
result[typeField.Name] = diff{
expected: mvA.String(),
got: mvB.String(),
}
}
}
} else {
// Special case to allow fields with primitive types or nil pointers to be ignored when comparing.
// If either A or B is a type's zero value, or nil, it won't bother comparing them.
// For example, you should be able to omit Damage from the expected DamageTransaction if you don't want to check that.
// Example use case: Expect(transactions).ToNot(HaveTransaction(DamageTransaction{}))
mustExactMatch := false
for _, t := range exactMatchTypes {
if t == rfA.Type() {
mustExactMatch = true
break
}
}
if rfA.Kind() == reflect.Ptr {
if !rfA.IsNil() && !rfB.IsNil() {
if !reflect.DeepEqual(rfA.Interface(), rfB.Interface()) {
result[typeField.Name] = diff{
expected: rfA.Interface(),
got: rfB.Interface(),
}
}
}
} else if mustExactMatch {
if !reflect.DeepEqual(rfA.Interface(), rfB.Interface()) {
result[typeField.Name] = diff{
expected: rfA.Interface(),
got: rfB.Interface(),
}
}
} else if rfA.Interface() != reflect.Zero(rfA.Type()).Interface() && rfB.Interface() != reflect.Zero(rfB.Type()).Interface() {
if !reflect.DeepEqual(rfA.Interface(), rfB.Interface()) {
result[typeField.Name] = diff{
expected: rfA.Interface(),
got: rfB.Interface(),
}
}
}
}
}
return result
}
// Used for custom gomega matchers.
func compareTransaction(a, b Transaction) bool {
if reflect.TypeOf(a) != reflect.TypeOf(b) {
return false
}
return len(transactionDiff(a, b)) == 0
}
// Used for custom gomega matchers for failure messages. Uses reflection to find the index of the first
// transaction with a matching type, and how many transactions match the type. Returns (-1, 0) if not found.
func findCountTransactionIdxWithMatchingType(transactions []Transaction, a Transaction) (first int, count int) {
first = -1
for i, t := range transactions {
if reflect.TypeOf(t) == reflect.TypeOf(a) {
count++
if first == -1 {
first = i
}
}
}
return first, count
}
// Gets the closest transaction to the desired one, and return a diff in fields
func getClosestTransaction(check []Transaction, want Transaction) map[string]diff {
var best map[string]diff
bestDiff := 999
for _, t := range check {
if reflect.TypeOf(t) != reflect.TypeOf(want) {
continue
}
result := transactionDiff(want, t)
if len(result) < bestDiff {
bestDiff = len(result)
best = result
}
}
return best
}
// Creates a text representation of the diff result of transactions
func getDiffText(check []Transaction, want Transaction) string {
diffText := ""
closest := getClosestTransaction(check, want)
total := reflect.ValueOf(want).NumField()
for name, val := range closest {
diffText += fmt.Sprintf("- %s\nExpected: %v\nReceived: %v\n", name, val.expected, val.got)
}
return fmt.Sprintf("%T has %d/%d fields that do not match:\n%s", want, len(closest), total, diffText)
}
// Given a sequence of transactions, match if a given transaction is present in the sequence.
type singleTransactionMatcher struct {
expected Transaction
}
// Check to see if this transaction occured.
func HaveTransaction(expected Transaction) types.GomegaMatcher {
return &singleTransactionMatcher{
expected: expected,
}
}
func (matcher *singleTransactionMatcher) Match(actual interface{}) (success bool, err error) {
switch transactions := actual.(type) {
case []Transaction:
for _, t := range transactions {
if compareTransaction(t, matcher.expected) {
return true, nil
}
}
return false, nil
default:
return false, errors.New("Was not given a []Transaction")
}
}
func (matcher *singleTransactionMatcher) FailureMessage(actual interface{}) (message string) {
switch transactions := actual.(type) {
case []Transaction:
first, count := findCountTransactionIdxWithMatchingType(transactions, matcher.expected)
if first == -1 {
gotText := ""
for _, t := range transactions {
gotText += fmt.Sprintf("- %T\n", t)
}
return fmt.Sprintf("Expected the sequence of transactions to include %T, but received:\n%s",
matcher.expected,
gotText,
)
} else if count == 1 {
return getDiffText(transactions, matcher.expected)
} else {
diffText := getDiffText(transactions, matcher.expected)
return fmt.Sprintf("The closest of %d total %s", count, diffText)
}
default:
return fmt.Sprintf("Actual's type is %T, when it should be []Transaction", actual)
}
}
func (matcher *singleTransactionMatcher) NegatedFailureMessage(actual interface{}) (message string) {
return fmt.Sprintf("Expected the sequence of transactions NOT to include: %T",
matcher.expected,
)
}
func orderedTransactionDiffLine(idx int, t Transaction) string {
line := fmt.Sprintf("%d. %T", idx+1, t)
switch tt := t.(type) {
case UseMoveTransaction:
line += fmt.Sprintf(" - User<%s> | Receiver<%s> | Move: %s",
tt.User,
tt.Target,
tt.Move,
)
case DamageTransaction:
line += fmt.Sprintf(" - Target<%s> | Damage: %d",
tt.Target,
tt.Damage,
)
case InflictStatusTransaction:
line += fmt.Sprintf(" - Target<%s> | Status: %s",
tt.Target,
tt.StatusEffect)
}
line += "\n"
return line
}
// Given a sequence of transactions, match if a given set of transactions is present in the sequence, and the order matches.
type orderedTransactionMatcher struct {
expected []Transaction
}
// Check to see if these transactions occured in this order.
func HaveTransactionsInOrder(expected ...Transaction) types.GomegaMatcher {
return &orderedTransactionMatcher{
expected: expected,
}
}
func checkTransactionOrder(check, want []Transaction) (success bool, diffText string) {
i := 0
fails := make([]Transaction, 0)
for _, t := range check {
if i == len(want) {
break
}
if reflect.TypeOf(t) != reflect.TypeOf(want[i]) {
continue
}
d := transactionDiff(want[i], t)
if len(d) == 0 {
i += 1
fails = make([]Transaction, 0)
} else {
fails = append(fails, t)
}
}
if i == len(want) {
return true, ""
}
diffText = getDiffText(fails, want[i])
return false, diffText
}
func (matcher *orderedTransactionMatcher) Match(actual interface{}) (success bool, err error) {
switch t := actual.(type) {
case []Transaction:
if len(t) < len(matcher.expected) {
return false, fmt.Errorf("Received %d, but expected at least %d transactions.", len(matcher.expected), len(t))
}
result, _ := checkTransactionOrder(t, matcher.expected)
return result, nil
default:
return false, errors.New("Was not given a []Transaction")
}
}
func (matcher *orderedTransactionMatcher) FailureMessage(actual interface{}) (message string) {
wantOrder := ""
for i, t := range matcher.expected {
wantOrder += orderedTransactionDiffLine(i, t)
}
switch transactions := actual.(type) {
case []Transaction:
gotOrder := ""
for i, t := range transactions {
gotOrder += orderedTransactionDiffLine(i, t)
}
msg := fmt.Sprintf("Expected the sequence of transactions to have these transactions in this order:\n%s"+
"\nReceived the following transactions:\n%s",
wantOrder, gotOrder,
)
_, result := checkTransactionOrder(transactions, matcher.expected)
return fmt.Sprintf("%s\nThe closest transaction that failed to match is shown below:\n%s", msg, result)
default:
return fmt.Sprintf("Actual's type is %T, when it should be []Transaction", actual)
}
}
func (matcher *orderedTransactionMatcher) NegatedFailureMessage(actual interface{}) (message string) {
seq := []string{}
for i, t := range matcher.expected {
seq = append(seq, fmt.Sprintf("%d: %T: %+v", i, t, t))
}
return fmt.Sprintf("Expected the sequence of transactions to NOT have these transactions in this order:\n%s",
strings.Join(seq, "\n"),
)
}
type usedMoveMatcher struct {
user target
move *Move
}
// Check if a Pokemon used any move
func UsedAnyMove(user target) types.GomegaMatcher {
return &usedMoveMatcher{
user: user,
}
}
// Check if a Pokemon attacked with a specific move
func UsedMove(user target, move *Move) types.GomegaMatcher {
return &usedMoveMatcher{
user: user,
move: move,
}
}
func (m *usedMoveMatcher) Match(actual interface{}) (bool, error) {
switch transactions := actual.(type) {
case []Transaction:
for _, t := range transactions {
if v, ok := t.(UseMoveTransaction); ok {
if m.move == nil && v.User == m.user {
return true, nil
}
if m.move != nil && v.User == m.user && m.move.Id == v.Move.Id {
return true, nil
}
}
}
return false, nil
}
return false, errors.New("Was not given a []Transaction")
}
func (m *usedMoveMatcher) FailureMessage(actual interface{}) string {
if m.move == nil {
return fmt.Sprintf("%s did not use any move.\n", m.user)
}
return fmt.Sprintf("%s did not use %s.", m.user, m.move)
}
func (m *usedMoveMatcher) NegatedFailureMessage(actual interface{}) string {
if m.move == nil {
return fmt.Sprintf("%s used a move.\n", m.user)
}
return fmt.Sprintf("%s used the move %s.", m.user, m.move)
}
/* Tools for testing the library */
// Check for damage dealt (if any) by a Pokemon in battle
func DamageDealt(t []Transaction, user target) int {
var usemove *UseMoveTransaction
var start int
for i := start; i < len(t); i++ {
if v, ok := t[i].(UseMoveTransaction); !ok {
continue
} else if v.User == user {
usemove = &v
break
}
}
if usemove == nil {
// This might work better as a gomega matcher
return -1 // failure, pokemon did not use a move
}
for i := start; i < len(t); i++ {
if d, ok := t[i].(DamageTransaction); ok {
if d.Move == usemove.Move {
return int(d.Damage)
}
}
}
return -2 // failure, move was used but did not deal damage
}
// Custom RNG struct which allows for predictable RNG output in a battle
type TestRNG struct {
rolls []bool
rounds int
}
func (g *TestRNG) SetSeed(uint) {}
func (g *TestRNG) Get(min, max int) int {
return max
}
func (g *TestRNG) Roll(x, y int) bool {
v := g.rolls[g.rounds%len(g.rolls)]
g.rounds += 1
return v
}
// Never rolls random effects
func NeverRNG() *TestRNG {
return &TestRNG{rolls: []bool{false}}
}
// Always rolls random effects
func AlwaysRNG() *TestRNG {
return &TestRNG{rolls: []bool{true}}
}
// Always hit, never crit
func SimpleRNG() *TestRNG {
return &TestRNG{rolls: []bool{true, false}}
}
// Create a single Battle. A single battle is a battle where only 1 pokemon is sent out at a time, and there can only be 2 parties.
// This function should only be used in tests.
func NewSingleBattle(p1 *Party, a1 *Agent, p2 *Party, a2 *Agent) *Battle {
b := NewBattle()
b.AddParty(p1, a1, 0)
b.AddParty(p2, a2, 1)
return b
}
// Create a single Battle with only 1 pokemon in each party.
// This function should only be used in tests.
func New1v1Battle(p1 *Pokemon, a1 *Agent, p2 *Pokemon, a2 *Agent) *Battle {
return NewSingleBattle(NewOccupiedParty(p1), a1, NewOccupiedParty(p2), a2)
}
// Create a double Battle. A double battle is a battle where 2 pokemon are sent out at a time, and there can be 2-4 parties.
// This function should only be used in tests.
func NewDoubleBattle(p1 *Party, a1 *Agent, p2 *Party, a2 *Agent) *Battle {
b := NewBattleOfType(BattleTypeDouble)
b.AddParty(p1, a1, 0)
b.AddParty(p2, a2, 1)
return b
}
// Create a double Battle with only 2 pokemon in each party.
// This function should only be used in tests.
func New2v2Battle(p1a, p1b *Pokemon, a1 *Agent, p2a, p2b *Pokemon, a2 *Agent) *Battle {
p1 := NewOccupiedParty(p1a, p1b)
p2 := NewOccupiedParty(p2a, p2b)
return NewDoubleBattle(p1, a1, p2, a2)
}
// Deprecated: Creates a new party to store Pokemon and assigns them to a team
// This function should only be used in tests.
func newBattlePartyOld(agent *Agent, team int) *battleParty {
return &battleParty{
Party: NewParty(),
Agent: agent,
activePokemon: make(map[uint]uint),
team: team,
}
}
// Creates a new party and fills it out with the passed Pokemon
// This function should only be used in tests.
func newOccupiedBattleParty(agent *Agent, team int, pkmn ...*Pokemon) *battleParty {
party := newBattlePartyOld(agent, team)
err := party.AddPokemon(pkmn...)
if err != nil {
panic(err)
}
return party
}