-
Notifications
You must be signed in to change notification settings - Fork 107
/
e2e.go
347 lines (304 loc) · 9.62 KB
/
e2e.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
// Package e2e implements the Oasis e2e test scenarios.
package e2e
import (
"bytes"
"encoding/json"
"fmt"
"path/filepath"
flag "github.com/spf13/pflag"
"github.com/oasisprotocol/oasis-core/go/common/logging"
"github.com/oasisprotocol/oasis-core/go/consensus/api/transaction"
consensusGenesis "github.com/oasisprotocol/oasis-core/go/consensus/genesis"
genesisFile "github.com/oasisprotocol/oasis-core/go/genesis/file"
cmdCommon "github.com/oasisprotocol/oasis-core/go/oasis-node/cmd/common"
cmdNode "github.com/oasisprotocol/oasis-core/go/oasis-node/cmd/node"
"github.com/oasisprotocol/oasis-core/go/oasis-test-runner/cmd"
"github.com/oasisprotocol/oasis-core/go/oasis-test-runner/env"
"github.com/oasisprotocol/oasis-core/go/oasis-test-runner/oasis"
"github.com/oasisprotocol/oasis-core/go/oasis-test-runner/oasis/cli"
"github.com/oasisprotocol/oasis-core/go/oasis-test-runner/scenario"
)
const (
// cfgNodeBinary is the path to oasis-node executable.
cfgNodeBinary = "node.binary"
)
// E2eParamsDummy is a dummy instance of E2E used to register global e2e flags.
var E2eParamsDummy *E2E = NewE2E("")
// E2E is a base scenario for oasis-node end-to-end tests.
type E2E struct {
Net *oasis.Network
Flags *env.ParameterFlagSet
Logger *logging.Logger
name string
}
// NewE2E creates a new base scenario for oasis-node end-to-end tests.
func NewE2E(name string) *E2E {
// Empty scenario name is used for registering global parameters only.
fullName := "e2e"
if name != "" {
fullName += "/" + name
}
sc := &E2E{
name: fullName,
Logger: logging.GetLogger("scenario/" + fullName),
Flags: env.NewParameterFlagSet(fullName, flag.ContinueOnError),
}
sc.Flags.String(cfgNodeBinary, "oasis-node", "path to the node binary")
return sc
}
// Implements scenario.Scenario.
func (sc *E2E) Clone() E2E {
return E2E{
Net: sc.Net,
Flags: sc.Flags.Clone(),
Logger: sc.Logger,
name: sc.name,
}
}
// Implements scenario.Scenario.
func (sc *E2E) Name() string {
return sc.name
}
// Implements scenario.Scenario.
func (sc *E2E) Parameters() *env.ParameterFlagSet {
return sc.Flags
}
// Implements scenario.Scenario.
func (sc *E2E) PreInit(childEnv *env.Env) error {
return nil
}
// Implements scenario.Scenario.
func (sc *E2E) Fixture() (*oasis.NetworkFixture, error) {
nodeBinary, _ := sc.Flags.GetString(cfgNodeBinary)
return &oasis.NetworkFixture{
Network: oasis.NetworkCfg{
NodeBinary: nodeBinary,
Consensus: consensusGenesis.Genesis{
Parameters: consensusGenesis.Parameters{
GasCosts: transaction.Costs{
consensusGenesis.GasOpTxByte: 1,
},
},
},
},
Entities: []oasis.EntityCfg{
{IsDebugTestEntity: true},
{},
},
Validators: []oasis.ValidatorFixture{
{Entity: 1, Consensus: oasis.ConsensusFixture{EnableConsensusRPCWorker: true}},
{Entity: 1, Consensus: oasis.ConsensusFixture{EnableConsensusRPCWorker: true}},
{Entity: 1, Consensus: oasis.ConsensusFixture{EnableConsensusRPCWorker: true}},
},
Seeds: []oasis.SeedFixture{{}},
}, nil
}
// Implements scenario.Scenario.
func (sc *E2E) Init(childEnv *env.Env, net *oasis.Network) error {
sc.Net = net
return nil
}
// ResetConsensusState removes all consensus state, preserving runtime storage and node-local
// storage databases.
func (sc *E2E) ResetConsensusState(childEnv *env.Env) error {
doClean := func(dataDir string, cleanArgs []string) error {
args := append([]string{
"unsafe-reset",
"--" + cmdCommon.CfgDataDir, dataDir,
}, cleanArgs...)
return cli.RunSubCommand(childEnv, sc.Logger, "unsafe-reset", sc.Net.Config().NodeBinary, args)
}
for _, val := range sc.Net.Validators() {
if err := doClean(val.DataDir(), nil); err != nil {
return err
}
}
for _, cw := range sc.Net.ComputeWorkers() {
if err := doClean(cw.DataDir(), nil); err != nil {
return err
}
}
for _, cl := range sc.Net.Clients() {
if err := doClean(cl.DataDir(), nil); err != nil {
return err
}
}
for _, bz := range sc.Net.Byzantine() {
if err := doClean(bz.DataDir(), nil); err != nil {
return err
}
}
for _, se := range sc.Net.Sentries() {
if err := doClean(se.DataDir(), nil); err != nil {
return err
}
}
for _, sw := range sc.Net.StorageWorkers() {
if err := doClean(sw.DataDir(), []string{"--" + cmdNode.CfgPreserveMKVSDatabase}); err != nil {
return err
}
}
for _, kw := range sc.Net.Keymanagers() {
if err := doClean(kw.DataDir(), []string{"--" + cmdNode.CfgPreserveLocalStorage}); err != nil {
return err
}
}
return nil
}
// DumpRestoreNetwork first dumps the current network state and then attempts to restore it.
func (sc *E2E) DumpRestoreNetwork(childEnv *env.Env, fixture *oasis.NetworkFixture, doDbDump bool) error {
// Dump-restore network.
sc.Logger.Info("dumping network state",
"child", childEnv,
)
dumpPath := filepath.Join(childEnv.Dir(), "genesis_dump.json")
args := []string{
"genesis", "dump",
"--height", "0",
"--genesis.file", dumpPath,
"--address", "unix:" + sc.Net.Validators()[0].SocketPath(),
}
if err := cli.RunSubCommand(childEnv, sc.Logger, "genesis-dump", sc.Net.Config().NodeBinary, args); err != nil {
return fmt.Errorf("scenario/e2e/dump_restore: failed to dump state: %w", err)
}
// Stop the network.
sc.Logger.Info("stopping the network")
sc.Net.Stop()
if doDbDump {
if err := sc.dumpDatabase(childEnv, fixture, dumpPath); err != nil {
return fmt.Errorf("scenario/e2e/dump_restore: failed to dump database: %w", err)
}
}
if len(sc.Net.StorageWorkers()) > 0 {
// Dump storage.
args = []string{
"debug", "storage", "export",
"--genesis.file", dumpPath,
"--datadir", sc.Net.StorageWorkers()[0].DataDir(),
"--storage.export.dir", filepath.Join(childEnv.Dir(), "storage_dumps"),
"--debug.dont_blame_oasis",
"--debug.allow_test_keys",
}
if err := cli.RunSubCommand(childEnv, sc.Logger, "storage-dump", sc.Net.Config().NodeBinary, args); err != nil {
return fmt.Errorf("scenario/e2e/dump_restore: failed to dump storage: %w", err)
}
}
// Reset all the state back to the vanilla state.
if err := sc.ResetConsensusState(childEnv); err != nil {
return fmt.Errorf("scenario/e2e/dump_restore: failed to clean tendemint storage: %w", err)
}
// Start the network and the client again.
sc.Logger.Info("starting the network again")
fixture.Network.GenesisFile = dumpPath
// Make sure to not overwrite entities.
for i, entity := range fixture.Entities {
if !entity.IsDebugTestEntity {
fixture.Entities[i].Restore = true
}
}
var err error
if sc.Net, err = fixture.Create(childEnv); err != nil {
return err
}
// If network is used, enable shorter per-node socket paths, because some e2e test datadir
// exceed maximum unix socket path length.
sc.Net.Config().UseShortGrpcSocketPaths = true
return nil
}
func (sc *E2E) dumpDatabase(childEnv *env.Env, fixture *oasis.NetworkFixture, exportPath string) error {
// Load the existing export.
eFp, err := genesisFile.NewFileProvider(exportPath)
if err != nil {
return fmt.Errorf("failed to instantiate file provider (export): %w", err)
}
exportedDoc, err := eFp.GetGenesisDocument()
if err != nil {
return fmt.Errorf("failed to get genesis doc (export): %w", err)
}
sc.Logger.Info("dumping via debug dumpdb")
// Dump the state with the debug command off one of the validators.
dbDumpPath := filepath.Join(childEnv.Dir(), "debug_dump.json")
args := []string{
"debug", "dumpdb",
"--datadir", sc.Net.Validators()[0].DataDir(),
"-g", sc.Net.GenesisPath(),
"--dump.version", fmt.Sprintf("%d", exportedDoc.Height),
"--dump.output", dbDumpPath,
"--debug.dont_blame_oasis",
"--debug.allow_test_keys",
}
if err = cli.RunSubCommand(childEnv, sc.Logger, "debug-dump", sc.Net.Config().NodeBinary, args); err != nil {
return fmt.Errorf("failed to dump database: %w", err)
}
// Load the dumped state.
fp, err := genesisFile.NewFileProvider(dbDumpPath)
if err != nil {
return fmt.Errorf("failed to instantiate file provider (db): %w", err)
}
dbDoc, err := fp.GetGenesisDocument()
if err != nil {
return fmt.Errorf("failed to get genesis doc (dump): %w", err)
}
// Compare the two documents for approximate equality. Note: Certain
// fields will be different, so those are fixed up before the comparison.
dbDoc.EpochTime.Base = exportedDoc.EpochTime.Base
dbDoc.Time = exportedDoc.Time
dbRaw, err := json.Marshal(dbDoc)
if err != nil {
return fmt.Errorf("failed to marshal fixed up dump: %w", err)
}
expRaw, err := json.Marshal(exportedDoc)
if err != nil {
return fmt.Errorf("failed to re-marshal export doc: %w", err)
}
if !bytes.Equal(expRaw, dbRaw) {
return fmt.Errorf("dump does not match state export")
}
return nil
}
func (sc *E2E) finishWithoutChild() error {
var err error
select {
case err = <-sc.Net.Errors():
return err
default:
return sc.Net.CheckLogWatchers()
}
}
// RegisterScenarios registers all end-to-end scenarios.
func RegisterScenarios() error {
// Register non-scenario-specific parameters.
cmd.RegisterScenarioParams(E2eParamsDummy.Name(), E2eParamsDummy.Parameters())
// Register default scenarios which are executed, if no test names provided.
for _, s := range []scenario.Scenario{
// Registry CLI test.
RegistryCLI,
// Stake CLI test.
StakeCLI,
// Gas fees tests.
GasFeesStaking,
GasFeesStakingDumpRestore,
// Identity CLI test.
IdentityCLI,
// Genesis file test.
GenesisFile,
// Node upgrade tests.
NodeUpgrade,
NodeUpgradeCancel,
// Debonding entries from genesis test.
Debond,
// Early query test.
EarlyQuery,
// Consensus state sync.
ConsensusStateSync,
// Multiple seeds test.
MultipleSeeds,
// Seed API test.
SeedAPI,
} {
if err := cmd.Register(s); err != nil {
return err
}
}
return nil
}