-
Notifications
You must be signed in to change notification settings - Fork 0
/
stepCheckState.go
463 lines (405 loc) · 14.2 KB
/
stepCheckState.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
package scenexec
import (
"bytes"
"encoding/hex"
"fmt"
"math/big"
"strings"
oj "github.com/multiversx/mx-chain-scenario-go/orderedjson"
er "github.com/multiversx/mx-chain-scenario-go/scenario/expression/reconstructor"
scenmodel "github.com/multiversx/mx-chain-scenario-go/scenario/model"
worldmock "github.com/multiversx/mx-chain-scenario-go/worldmock"
"github.com/multiversx/mx-chain-scenario-go/worldmock/esdtconvert"
"github.com/multiversx/mx-chain-core-go/core"
"github.com/multiversx/mx-chain-core-go/data/esdt"
vmcommon "github.com/multiversx/mx-chain-vm-common-go"
)
// ExecuteCheckStateStep executes a CheckStateStep defined by the current scenario.
func (ae *ScenarioExecutor) ExecuteCheckStateStep(step *scenmodel.CheckStateStep) error {
if len(step.Comment) > 0 {
log.Trace("CheckStateStep", "comment", step.Comment)
}
baseErrMsg := checkStateBaseErrorMsg(step)
return ae.checkAccounts(baseErrMsg, step.CheckAccounts)
}
func checkStateBaseErrorMsg(step *scenmodel.CheckStateStep) string {
if len(step.CheckStateIdent) > 0 {
return fmt.Sprintf("Check state \"%s\":", step.CheckStateIdent)
}
return "Check state:"
}
func (ae *ScenarioExecutor) checkAccounts(baseErrMsg string, checkAccounts *scenmodel.CheckAccounts) error {
if !checkAccounts.MoreAccountsAllowed {
for worldAcctAddr := range ae.World.AcctMap {
postAcctMatch := scenmodel.FindCheckAccount(checkAccounts.Accounts, []byte(worldAcctAddr))
if postAcctMatch == nil && !bytes.Equal([]byte(worldAcctAddr), vmcommon.SystemAccountAddress) {
return fmt.Errorf("%s unexpected account address: %s",
baseErrMsg,
ae.exprReconstructor.Reconstruct(
[]byte(worldAcctAddr),
er.AddressHint))
}
}
}
for _, expectedAcct := range checkAccounts.Accounts {
matchingAcct, isMatch := ae.World.AcctMap[string(expectedAcct.Address.Value)]
if !isMatch {
return fmt.Errorf("%s account %s expected but not found after running test",
baseErrMsg,
expectedAcct.Address.Original)
}
if !bytes.Equal(matchingAcct.Address, expectedAcct.Address.Value) {
return fmt.Errorf("%s bad account address %s",
baseErrMsg,
ae.exprReconstructor.Reconstruct(
matchingAcct.Address,
er.AddressHint))
}
if !expectedAcct.Nonce.Check(matchingAcct.Nonce) {
return fmt.Errorf("%s bad account nonce. Account: %s. Want: \"%s\". Have: \"%d\"",
baseErrMsg,
expectedAcct.Address.Original,
expectedAcct.Nonce.Original,
matchingAcct.Nonce)
}
if !expectedAcct.Balance.Check(matchingAcct.Balance) {
return fmt.Errorf("%s bad account balance. Account: %s. Want: \"%s\". Have: \"%s\"",
baseErrMsg,
expectedAcct.Address.Original,
expectedAcct.Balance.Original,
ae.exprReconstructor.ReconstructFromBigInt(matchingAcct.Balance))
}
if !expectedAcct.Username.Check(matchingAcct.Username) {
return fmt.Errorf("%s bad account username. Account: %s. Want: %s. Have: \"%s\"",
baseErrMsg,
expectedAcct.Address.Original,
oj.JSONString(expectedAcct.Username.Original),
ae.exprReconstructor.Reconstruct(
matchingAcct.Username,
er.StrHint))
}
if !expectedAcct.Code.Check(matchingAcct.Code) {
return fmt.Errorf("%s bad account code. Account: %s. Want: %s. Have: \"%s\"",
baseErrMsg,
expectedAcct.Address.Original,
oj.JSONString(expectedAcct.Code.Original),
ae.exprReconstructor.Reconstruct(
matchingAcct.Code,
er.CodeHint))
}
if !expectedAcct.CodeMetadata.IsUnspecified() &&
!expectedAcct.CodeMetadata.Check(matchingAcct.CodeMetadata) {
return fmt.Errorf("%s bad account code metadata. Account: %s. Want: %s. Have: \"%s\"",
baseErrMsg,
expectedAcct.Address.Original,
oj.JSONString(expectedAcct.CodeMetadata.Original),
ae.exprReconstructor.Reconstruct(
matchingAcct.CodeMetadata,
er.HexHint))
}
if !expectedAcct.Owner.IsUnspecified() && !bytes.Equal(matchingAcct.OwnerAddress, expectedAcct.Owner.Value) {
return fmt.Errorf("%s bad account owner. Account: %s. Want: %s. Have: \"%s\"",
baseErrMsg,
expectedAcct.Address.Original,
oj.JSONString(expectedAcct.Owner.Original),
ae.exprReconstructor.Reconstruct(
matchingAcct.OwnerAddress,
er.AddressHint))
}
// currently ignoring asyncCallData that is unspecified in the json
if !expectedAcct.AsyncCallData.IsUnspecified() &&
!expectedAcct.AsyncCallData.Check([]byte(matchingAcct.AsyncCallData)) {
return fmt.Errorf("%s bad async call data. Account: %s. Want: [%s]. Have: [%s]",
baseErrMsg,
expectedAcct.Address.Original,
expectedAcct.AsyncCallData.Original,
matchingAcct.AsyncCallData)
}
err := ae.checkAccountStorage(baseErrMsg, expectedAcct, matchingAcct)
if err != nil {
return err
}
err = ae.checkAccountESDT(baseErrMsg, expectedAcct, matchingAcct)
if err != nil {
return err
}
}
return nil
}
func (ae *ScenarioExecutor) checkAccountStorage(baseErrMsg string, expectedAcct *scenmodel.CheckAccount, matchingAcct *worldmock.Account) error {
if expectedAcct.IgnoreStorage {
return nil
}
expectedStorage := make(map[string]scenmodel.JSONCheckBytes)
for _, stkvp := range expectedAcct.CheckStorage {
expectedStorage[string(stkvp.Key.Value)] = stkvp.CheckValue
}
allKeys := make(map[string]bool)
for k := range expectedStorage {
allKeys[k] = true
}
for k := range matchingAcct.Storage {
allKeys[k] = true
}
storageError := ""
for k := range allKeys {
// ignore all reserved keys
if strings.HasPrefix(k, core.ProtectedKeyPrefix) {
continue
}
want, specified := expectedStorage[k]
if !specified {
if expectedAcct.MoreStorageAllowed {
// if `"+": ""` was written in the test, any unspecified entries are allowed,
// which is equivalent to treating them all as "*".
want = scenmodel.JSONCheckBytesStar()
} else {
// otherwise, by default, any unexpected storage key leads to a test failure
want = scenmodel.JSONCheckBytesUnspecified()
}
}
have := matchingAcct.StorageValue(k)
if !want.Check(have) {
storageError += fmt.Sprintf(
"\n for key %s: Want: %s. Have: \"%s\"",
ae.exprReconstructor.Reconstruct([]byte(k), er.NoHint),
oj.JSONString(want.Original),
ae.exprReconstructor.Reconstruct(have, er.NoHint))
}
}
if len(storageError) > 0 {
return fmt.Errorf("%s wrong account storage for account \"%s\":%s",
baseErrMsg,
expectedAcct.Address.Original, storageError)
}
return nil
}
func (ae *ScenarioExecutor) checkAccountESDT(baseErrMsg string, expectedAcct *scenmodel.CheckAccount, matchingAcct *worldmock.Account) error {
if expectedAcct.IgnoreESDT {
return nil
}
systemAccStorage := make(map[string][]byte)
systemAcc, exists := ae.World.AcctMap[string(vmcommon.SystemAccountAddress)]
if exists {
systemAccStorage = systemAcc.Storage
}
accountAddress := expectedAcct.Address.Original
expectedTokens := getExpectedTokens(expectedAcct)
accountTokens, err := esdtconvert.GetFullMockESDTData(matchingAcct.Storage, systemAccStorage)
if err != nil {
return err
}
allTokenNames := make(map[string]bool)
for tokenName := range expectedTokens {
allTokenNames[tokenName] = true
}
for tokenName := range accountTokens {
allTokenNames[tokenName] = true
}
var errs []error
for tokenName := range allTokenNames {
expectedToken := expectedTokens[tokenName]
accountToken := accountTokens[tokenName]
if expectedToken == nil {
expectedToken = &scenmodel.CheckESDTData{
TokenIdentifier: scenmodel.JSONBytesFromString{
Value: []byte(tokenName),
Original: ae.exprReconstructor.Reconstruct([]byte(tokenName), er.StrHint),
},
Instances: []*scenmodel.CheckESDTInstance{},
LastNonce: scenmodel.JSONCheckUint64{Value: 0, Original: ""},
Roles: []string{},
}
} else if accountToken == nil {
accountToken = &esdtconvert.MockESDTData{
TokenIdentifier: []byte(tokenName),
Instances: []*esdt.ESDigitalToken{},
LastNonce: 0,
Roles: [][]byte{},
}
}
errs = append(errs, ae.checkTokenState(accountAddress, tokenName, expectedToken, accountToken)...)
}
errorString := makeErrorString(errs)
if len(errorString) > 0 {
return fmt.Errorf("%s mismatch for account \"%s\":%s", baseErrMsg, accountAddress, errorString)
}
return nil
}
func getExpectedTokens(expectedAcct *scenmodel.CheckAccount) map[string]*scenmodel.CheckESDTData {
expectedTokens := make(map[string]*scenmodel.CheckESDTData)
for _, expectedTokenData := range expectedAcct.CheckESDTData {
tokenName := expectedTokenData.TokenIdentifier.Value
expectedTokens[string(tokenName)] = expectedTokenData
}
return expectedTokens
}
func (ae *ScenarioExecutor) checkTokenState(
accountAddress string,
tokenName string,
expectedToken *scenmodel.CheckESDTData,
accountToken *esdtconvert.MockESDTData,
) []error {
var errors []error
errors = append(errors, ae.checkTokenInstances(accountAddress, tokenName, expectedToken, accountToken)...)
if !expectedToken.LastNonce.Check(accountToken.LastNonce) {
errors = append(errors, fmt.Errorf("bad account ESDT last nonce. Account: %s. Token: %s. Want: \"%s\". Have: %d",
accountAddress,
tokenName,
expectedToken.LastNonce.Original,
accountToken.LastNonce))
}
errors = append(errors, checkTokenRoles(accountAddress, tokenName, expectedToken, accountToken)...)
return errors
}
func (ae *ScenarioExecutor) checkTokenInstances(
_ string,
tokenName string,
expectedToken *scenmodel.CheckESDTData,
accountToken *esdtconvert.MockESDTData,
) []error {
var errors []error
allNonces := make(map[uint64]bool)
expectedInstances := make(map[uint64]*scenmodel.CheckESDTInstance)
accountInstances := make(map[uint64]*esdt.ESDigitalToken)
for _, expectedInstance := range expectedToken.Instances {
nonce := expectedInstance.Nonce.Value
allNonces[nonce] = true
expectedInstances[nonce] = expectedInstance
}
for _, accountInstance := range accountToken.Instances {
nonce := accountInstance.TokenMetaData.Nonce
allNonces[nonce] = true
accountInstances[nonce] = accountInstance
}
for nonce := range allNonces {
expectedInstance := expectedInstances[nonce]
accountInstance := accountInstances[nonce]
if expectedInstance == nil {
expectedInstance = &scenmodel.CheckESDTInstance{
Nonce: scenmodel.JSONUint64{Value: nonce, Original: ""},
Balance: scenmodel.JSONCheckBigInt{Value: big.NewInt(0), Original: ""},
}
} else if accountInstance == nil {
accountInstance = &esdt.ESDigitalToken{
Value: big.NewInt(0),
TokenMetaData: &esdt.MetaData{
Name: []byte(tokenName),
Nonce: nonce,
},
}
}
if !expectedInstance.Balance.Check(accountInstance.Value) {
errors = append(errors, fmt.Errorf(
"for token: %s, nonce: %d: Bad balance. Want: \"%s\". Have: \"%d\"",
tokenName,
nonce,
expectedInstance.Balance.Original,
accountInstance.Value))
}
if !expectedInstance.Creator.IsUnspecified() &&
!expectedInstance.Creator.Check(accountInstance.TokenMetaData.Creator) {
errors = append(errors, fmt.Errorf(
"for token: %s, nonce: %d: Bad creator. Want: %s. Have: \"%s\"",
tokenName,
nonce,
objectStringOrDefault(expectedInstance.Creator.Original),
ae.exprReconstructor.Reconstruct(
accountInstance.TokenMetaData.Creator,
er.AddressHint)))
}
if !expectedInstance.Royalties.IsUnspecified() &&
!expectedInstance.Royalties.Check(uint64(accountInstance.TokenMetaData.Royalties)) {
errors = append(errors, fmt.Errorf(
"for token: %s, nonce: %d: Bad royalties. Want: \"%s\". Have: \"%s\"",
tokenName,
nonce,
expectedInstance.Royalties.Original,
ae.exprReconstructor.ReconstructFromUint64(
uint64(accountInstance.TokenMetaData.Royalties))))
}
if !expectedInstance.Hash.IsUnspecified() &&
!expectedInstance.Hash.Check(accountInstance.TokenMetaData.Hash) {
errors = append(errors, fmt.Errorf(
"for token: %s, nonce: %d: Bad hash. Want: %s. Have: %s",
tokenName,
nonce,
objectStringOrDefault(expectedInstance.Hash.Original),
ae.exprReconstructor.Reconstruct(
accountInstance.TokenMetaData.Hash,
er.NoHint)))
}
if !expectedInstance.Uris.IsUnspecified() &&
!expectedInstance.Uris.CheckList(accountInstance.TokenMetaData.URIs) {
// in this case unspecified is interpreted as *
errors = append(errors, fmt.Errorf(
"for token: %s, nonce: %d: Bad URI. Want: %s. Have: %s",
tokenName,
nonce,
checkBytesListPretty(expectedInstance.Uris),
ae.exprReconstructor.ReconstructList(accountInstance.TokenMetaData.URIs, er.StrHint)))
}
if !expectedInstance.Attributes.IsUnspecified() &&
!expectedInstance.Attributes.Check(accountInstance.TokenMetaData.Attributes) {
errors = append(errors, fmt.Errorf(
"for token: %s, nonce: %d: Bad attributes. Want: \"0x%s (%s)\". Have: \"%s\"",
tokenName,
nonce,
hex.EncodeToString(jsonToBytes(expectedInstance.Attributes.Original)),
objectStringOrDefault(expectedInstance.Attributes.Original),
ae.exprReconstructor.Reconstruct(
accountInstance.TokenMetaData.Attributes,
er.NoHint)))
}
}
return errors
}
func checkTokenRoles(
accountAddress string,
tokenName string,
expectedToken *scenmodel.CheckESDTData,
accountToken *esdtconvert.MockESDTData) []error {
var errors []error
allRoles := make(map[string]bool)
expectedRoles := make(map[string]bool)
accountRoles := make(map[string]bool)
for _, expectedRole := range expectedToken.Roles {
allRoles[expectedRole] = true
expectedRoles[expectedRole] = true
}
for _, accountRole := range accountToken.Roles {
allRoles[string(accountRole)] = true
accountRoles[string(accountRole)] = true
}
for role := range allRoles {
if !expectedRoles[role] {
errors = append(errors, fmt.Errorf("unexpected ESDT role. Account: %s. Token: %s. Role: %s",
accountAddress,
tokenName,
role))
}
if !accountRoles[role] {
errors = append(errors, fmt.Errorf("missing ESDT role. Account: %s. Token: %s. Role: %s",
accountAddress,
tokenName,
role))
}
}
return errors
}
func makeErrorString(errors []error) string {
errorString := ""
for _, err := range errors {
errorString += "\n " + err.Error()
}
return errorString
}
func objectStringOrDefault(obj oj.OJsonObject) string {
if obj == nil {
return ""
}
return oj.JSONString(obj)
}
func jsonToBytes(obj oj.OJsonObject) []byte {
return []byte(objectStringOrDefault(obj))
}