forked from ava-labs/avalanche-network-runner
-
Notifications
You must be signed in to change notification settings - Fork 0
/
snapshot.go
369 lines (355 loc) · 11.7 KB
/
snapshot.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
package local
import (
"context"
"encoding/json"
"errors"
"fmt"
"os"
"path/filepath"
"strings"
"syscall"
"github.com/MetalBlockchain/metal-network-runner/api"
"github.com/MetalBlockchain/metal-network-runner/network"
"github.com/MetalBlockchain/metal-network-runner/network/node"
"github.com/MetalBlockchain/metal-network-runner/utils"
"github.com/MetalBlockchain/metalgo/config"
"github.com/MetalBlockchain/metalgo/ids"
"github.com/MetalBlockchain/metalgo/utils/constants"
"github.com/MetalBlockchain/metalgo/utils/logging"
dircopy "github.com/otiai10/copy"
"golang.org/x/exp/maps"
)
const (
deprecatedBuildDirKey = "build-dir"
deprecatedWhitelistedSubnetsKey = "whitelisted-subnets"
)
// NetworkState defines dynamic network information not available on blockchain db
type NetworkState struct {
// Map from subnet id to elastic subnet tx id
SubnetID2ElasticSubnetID map[string]string `json:"subnetID2ElasticSubnetID"`
}
// snapshots generated using older ANR versions may contain deprecated avago flags
func fixDeprecatedAvagoFlags(flags map[string]interface{}) error {
if vIntf, ok := flags[deprecatedWhitelistedSubnetsKey]; ok {
v, ok := vIntf.(string)
if !ok {
return fmt.Errorf("expected %q to be of type string but got %T", deprecatedWhitelistedSubnetsKey, vIntf)
}
if v != "" {
flags[config.TrackSubnetsKey] = v
}
delete(flags, deprecatedWhitelistedSubnetsKey)
}
if vIntf, ok := flags[deprecatedBuildDirKey]; ok {
v, ok := vIntf.(string)
if !ok {
return fmt.Errorf("expected %q to be of type string but got %T", deprecatedBuildDirKey, vIntf)
}
if v != "" {
flags[config.PluginDirKey] = filepath.Join(v, "plugins")
}
delete(flags, deprecatedBuildDirKey)
}
return nil
}
// NewNetwork returns a new network from the given snapshot
func NewNetworkFromSnapshot(
log logging.Logger,
snapshotName string,
rootDir string,
snapshotsDir string,
binaryPath string,
pluginDir string,
chainConfigs map[string]string,
upgradeConfigs map[string]string,
subnetConfigs map[string]string,
flags map[string]interface{},
reassignPortsIfUsed bool,
) (network.Network, error) {
net, err := newNetwork(
log,
api.NewAPIClient,
&nodeProcessCreator{
colorPicker: utils.NewColorPicker(),
log: log,
stdout: os.Stdout,
stderr: os.Stderr,
},
rootDir,
snapshotsDir,
reassignPortsIfUsed,
)
if err != nil {
return net, err
}
err = net.loadSnapshot(
context.Background(),
snapshotName,
binaryPath,
pluginDir,
chainConfigs,
upgradeConfigs,
subnetConfigs,
flags,
)
return net, err
}
// Save network snapshot
// Network is stopped in order to do a safe preservation
func (ln *localNetwork) SaveSnapshot(ctx context.Context, snapshotName string) (string, error) {
ln.lock.Lock()
defer ln.lock.Unlock()
if ln.stopCalled() {
return "", network.ErrStopped
}
if len(snapshotName) == 0 {
return "", fmt.Errorf("invalid snapshotName %q", snapshotName)
}
// check if snapshot already exists
snapshotDir := filepath.Join(ln.snapshotsDir, snapshotPrefix+snapshotName)
if _, err := os.Stat(snapshotDir); err == nil {
return "", fmt.Errorf("snapshot %q already exists", snapshotName)
}
// keep copy of node info that will be removed by stop
nodesConfig := map[string]node.Config{}
nodesDBDir := map[string]string{}
for nodeName, node := range ln.nodes {
nodeConfig := node.config
// depending on how the user generated the config, different nodes config flags
// may point to the same map, so we made a copy to avoid always modifying the same value
nodeConfig.Flags = maps.Clone(nodeConfig.Flags)
nodesConfig[nodeName] = nodeConfig
nodesDBDir[nodeName] = node.GetDbDir()
}
// we change nodeConfig.Flags so as to preserve in snapshot the current node ports
for nodeName, nodeConfig := range nodesConfig {
nodeConfig.Flags[config.HTTPPortKey] = ln.nodes[nodeName].GetAPIPort()
nodeConfig.Flags[config.StakingPortKey] = ln.nodes[nodeName].GetP2PPort()
}
// make copy of network flags
networkConfigFlags := maps.Clone(ln.flags)
// remove all data dir, log dir references
delete(networkConfigFlags, config.DataDirKey)
delete(networkConfigFlags, config.LogsDirKey)
for nodeName, nodeConfig := range nodesConfig {
if nodeConfig.ConfigFile != "" {
var err error
nodeConfig.ConfigFile, err = utils.SetJSONKey(nodeConfig.ConfigFile, config.LogsDirKey, "")
if err != nil {
return "", err
}
}
delete(nodeConfig.Flags, config.DataDirKey)
delete(nodeConfig.Flags, config.LogsDirKey)
nodesConfig[nodeName] = nodeConfig
}
// stop network to safely save snapshot
if err := ln.stop(ctx); err != nil {
return "", err
}
syscall.Sync()
// create main snapshot dirs
snapshotDBDir := filepath.Join(snapshotDir, defaultDBSubdir)
if err := os.MkdirAll(snapshotDBDir, os.ModePerm); err != nil {
return "", err
}
// save db
for _, nodeConfig := range nodesConfig {
sourceDBDir, ok := nodesDBDir[nodeConfig.Name]
if !ok {
return "", fmt.Errorf("failure obtaining db path for node %q", nodeConfig.Name)
}
sourceDBDir = filepath.Join(sourceDBDir, constants.NetworkName(ln.networkID))
targetDBDir := filepath.Join(filepath.Join(snapshotDBDir, nodeConfig.Name), constants.NetworkName(ln.networkID))
if err := dircopy.Copy(sourceDBDir, targetDBDir); err != nil {
return "", fmt.Errorf("failure saving node %q db dir: %w", nodeConfig.Name, err)
}
}
// save network conf
networkConfig := network.Config{
Genesis: string(ln.genesis),
Flags: networkConfigFlags,
NodeConfigs: []node.Config{},
BinaryPath: ln.binaryPath,
ChainConfigFiles: ln.chainConfigFiles,
UpgradeConfigFiles: ln.upgradeConfigFiles,
SubnetConfigFiles: ln.subnetConfigFiles,
}
// no need to save this, will be generated automatically on snapshot load
networkConfig.NodeConfigs = append(networkConfig.NodeConfigs, maps.Values(nodesConfig)...)
networkConfigJSON, err := json.MarshalIndent(networkConfig, "", " ")
if err != nil {
return "", err
}
if err := createFileAndWrite(filepath.Join(snapshotDir, "network.json"), networkConfigJSON); err != nil {
return "", err
}
// save dynamic part of network not available on blockchain
subnetID2ElasticSubnetID := map[string]string{}
for subnetID, elasticSubnetID := range ln.subnetID2ElasticSubnetID {
subnetID2ElasticSubnetID[subnetID.String()] = elasticSubnetID.String()
}
networkState := NetworkState{
SubnetID2ElasticSubnetID: subnetID2ElasticSubnetID,
}
networkStateJSON, err := json.MarshalIndent(networkState, "", " ")
if err != nil {
return "", err
}
if err := createFileAndWrite(filepath.Join(snapshotDir, "state.json"), networkStateJSON); err != nil {
return "", err
}
return snapshotDir, nil
}
// start network from snapshot
func (ln *localNetwork) loadSnapshot(
ctx context.Context,
snapshotName string,
binaryPath string,
pluginDir string,
chainConfigs map[string]string,
upgradeConfigs map[string]string,
subnetConfigs map[string]string,
flags map[string]interface{},
) error {
ln.lock.Lock()
defer ln.lock.Unlock()
snapshotDir := filepath.Join(ln.snapshotsDir, snapshotPrefix+snapshotName)
snapshotDBDir := filepath.Join(snapshotDir, defaultDBSubdir)
_, err := os.Stat(snapshotDir)
if err != nil {
if errors.Is(err, os.ErrNotExist) {
return ErrSnapshotNotFound
} else {
return fmt.Errorf("failure accessing snapshot %q: %w", snapshotName, err)
}
}
// load network config
networkConfigJSON, err := os.ReadFile(filepath.Join(snapshotDir, "network.json"))
if err != nil {
return fmt.Errorf("failure reading network config file from snapshot: %w", err)
}
networkConfig := network.Config{}
if err := json.Unmarshal(networkConfigJSON, &networkConfig); err != nil {
return fmt.Errorf("failure unmarshaling network config from snapshot: %w", err)
}
// fix deprecated avago flags
if err := fixDeprecatedAvagoFlags(networkConfig.Flags); err != nil {
return err
}
for i := range networkConfig.NodeConfigs {
if err := fixDeprecatedAvagoFlags(networkConfig.NodeConfigs[i].Flags); err != nil {
return err
}
}
// add flags
for i := range networkConfig.NodeConfigs {
for k, v := range flags {
networkConfig.NodeConfigs[i].Flags[k] = v
}
}
// load db
for _, nodeConfig := range networkConfig.NodeConfigs {
sourceDBDir := filepath.Join(snapshotDBDir, nodeConfig.Name)
targetDBDir := filepath.Join(filepath.Join(ln.rootDir, nodeConfig.Name), defaultDBSubdir)
if err := dircopy.Copy(sourceDBDir, targetDBDir); err != nil {
return fmt.Errorf("failure loading node %q db dir: %w", nodeConfig.Name, err)
}
nodeConfig.Flags[config.DBPathKey] = targetDBDir
}
// replace binary path
if binaryPath != "" {
for i := range networkConfig.NodeConfigs {
networkConfig.NodeConfigs[i].BinaryPath = binaryPath
}
}
// replace plugin dir
if pluginDir != "" {
for i := range networkConfig.NodeConfigs {
networkConfig.NodeConfigs[i].Flags[config.PluginDirKey] = pluginDir
}
}
// add chain configs and upgrade configs
for i := range networkConfig.NodeConfigs {
if networkConfig.NodeConfigs[i].ChainConfigFiles == nil {
networkConfig.NodeConfigs[i].ChainConfigFiles = map[string]string{}
}
if networkConfig.NodeConfigs[i].UpgradeConfigFiles == nil {
networkConfig.NodeConfigs[i].UpgradeConfigFiles = map[string]string{}
}
if networkConfig.NodeConfigs[i].SubnetConfigFiles == nil {
networkConfig.NodeConfigs[i].SubnetConfigFiles = map[string]string{}
}
for k, v := range chainConfigs {
networkConfig.NodeConfigs[i].ChainConfigFiles[k] = v
}
for k, v := range upgradeConfigs {
networkConfig.NodeConfigs[i].UpgradeConfigFiles[k] = v
}
for k, v := range subnetConfigs {
networkConfig.NodeConfigs[i].SubnetConfigFiles[k] = v
}
}
// load network state not available at blockchain db
networkStateJSON, err := os.ReadFile(filepath.Join(snapshotDir, "state.json"))
if err != nil {
if !errors.Is(err, os.ErrNotExist) {
return fmt.Errorf("failure reading network state file from snapshot: %w", err)
}
ln.log.Warn("network state file not found on snapshot")
} else {
networkState := NetworkState{}
if err := json.Unmarshal(networkStateJSON, &networkState); err != nil {
return fmt.Errorf("failure unmarshaling network state from snapshot: %w", err)
}
ln.subnetID2ElasticSubnetID = map[ids.ID]ids.ID{}
for subnetIDStr, elasticSubnetIDStr := range networkState.SubnetID2ElasticSubnetID {
subnetID, err := ids.FromString(subnetIDStr)
if err != nil {
return err
}
elasticSubnetID, err := ids.FromString(elasticSubnetIDStr)
if err != nil {
return err
}
ln.subnetID2ElasticSubnetID[subnetID] = elasticSubnetID
}
}
return ln.loadConfig(ctx, networkConfig)
}
// Remove network snapshot
func (ln *localNetwork) RemoveSnapshot(snapshotName string) error {
snapshotDir := filepath.Join(ln.snapshotsDir, snapshotPrefix+snapshotName)
_, err := os.Stat(snapshotDir)
if err != nil {
if errors.Is(err, os.ErrNotExist) {
return ErrSnapshotNotFound
} else {
return fmt.Errorf("failure accessing snapshot %q: %w", snapshotName, err)
}
}
if err := os.RemoveAll(snapshotDir); err != nil {
return fmt.Errorf("failure removing snapshot path %q: %w", snapshotDir, err)
}
return nil
}
// Get network snapshots
func (ln *localNetwork) GetSnapshotNames() ([]string, error) {
_, err := os.Stat(ln.snapshotsDir)
if err != nil {
if errors.Is(err, os.ErrNotExist) {
return nil, fmt.Errorf("snapshots dir %q does not exists", ln.snapshotsDir)
} else {
return nil, fmt.Errorf("failure accessing snapshots dir %q: %w", ln.snapshotsDir, err)
}
}
matches, err := filepath.Glob(filepath.Join(ln.snapshotsDir, snapshotPrefix+"*"))
if err != nil {
return nil, err
}
snapshots := []string{}
for _, match := range matches {
snapshots = append(snapshots, strings.TrimPrefix(filepath.Base(match), snapshotPrefix))
}
return snapshots, nil
}