-
Notifications
You must be signed in to change notification settings - Fork 95
/
root.go
439 lines (377 loc) · 11.8 KB
/
root.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
// Copyright 2020 Coinbase, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
package cmd
import (
"context"
"fmt"
"log"
"os"
"os/signal"
"path"
"runtime"
"runtime/pprof"
"syscall"
"github.com/coinbase/rosetta-cli/configuration"
"github.com/coinbase/rosetta-sdk-go/utils"
"github.com/fatih/color"
"github.com/spf13/cobra"
)
const (
// configEnvKey is an env variable name that sets a config file location
configEnvKey = "ROSETTA_CONFIGURATION_FILE"
)
var (
rootCmd = &cobra.Command{
Use: "rosetta-cli",
Short: "CLI for the Rosetta API",
PersistentPreRunE: rootPreRun,
}
configurationFile string
cpuProfile string
memProfile string
blockProfile string
onlineURL string
offlineURL string
startIndex int64
endIndex int64
dataResultFile string
constructionResultFile string
dataDirectory string
inMemoryMode bool
tableSize int64
// Config is the populated *configuration.Configuration from
// the configurationFile. If none is provided, this is set
// to the default settings.
Config *configuration.Configuration
// Context is the context to use for this invocation of the cli.
Context context.Context
// SignalReceived is set to true when a signal causes us to exit. This makes
// determining the error message to show on exit much more easy.
SignalReceived = false
// cpuProfileCleanup is called after the root command is executed to
// cleanup a running cpu profile.
cpuProfileCleanup func()
// blockProfileCleanup is called after the root command is executed to
// cleanup a running block profile.
blockProfileCleanup func()
// OnlyChanges is a boolean indicating if only the balance changes should be
// logged to the console.
OnlyChanges bool
// allSpecs is a boolean indicating whether check:spec should verify only Coinbase
// spec requirements, or the minimum requirements as well.
checkAllSpecs bool
// If non-empty, used to validate that /network/options matches the contents of the file
// located at this path. The intended use case is someone previously ran
// utils:asserter-configuration `asserterConfigurationFile`, so the validation is being done
// against the same file (or an identical copy of that file at this path). This file contains a
// snapshot of /network/options (and some other unrelated configuration options), so this will
// trigger validation of the current /network/options against that. See
// utils:asserter-configuration for more details.
//
// The main goal is to verify these core configuration options don't change across releases,
// which has caused production incidents in the past. This can be used for both check:data
// and check:construction.
asserterConfigurationFile string
)
// rootPreRun is executed before the root command runs and sets up cpu
// profiling.
//
// Bassed on https://golang.org/pkg/runtime/pprof/#hdr-Profiling_a_Go_program
func rootPreRun(*cobra.Command, []string) error {
if cpuProfile != "" {
f, err := os.Create(path.Clean(cpuProfile))
if err != nil {
return fmt.Errorf("%w: unable to create CPU profile file", err)
}
if err := pprof.StartCPUProfile(f); err != nil {
if err := f.Close(); err != nil {
log.Printf("error while closing cpu profile file: %v\n", err)
}
return err
}
cpuProfileCleanup = func() {
pprof.StopCPUProfile()
if err := f.Close(); err != nil {
log.Printf("error while closing cpu profile file: %v\n", err)
}
}
}
if blockProfile != "" {
runtime.SetBlockProfileRate(1)
f, err := os.Create(path.Clean(blockProfile))
if err != nil {
return fmt.Errorf("%w: unable to create block profile file", err)
}
p := pprof.Lookup("block")
blockProfileCleanup = func() {
if err := p.WriteTo(f, 0); err != nil {
log.Printf("error while writing block profile file: %v\n", err)
}
if err := f.Close(); err != nil {
log.Printf("error while closing block profile file: %v\n", err)
}
}
}
return nil
}
// rootPostRun is executed after the root command runs and performs memory
// profiling.
func rootPostRun() {
if cpuProfileCleanup != nil {
cpuProfileCleanup()
}
if blockProfileCleanup != nil {
blockProfileCleanup()
}
if memProfile != "" {
f, err := os.Create(path.Clean(memProfile))
if err != nil {
log.Printf("error while creating mem-profile file: %v", err)
return
}
defer func() {
if err := f.Close(); err != nil {
log.Printf("error while closing mem-profile file: %v", err)
}
}()
runtime.GC()
if err := pprof.WriteHeapProfile(f); err != nil {
log.Printf("error while writing heap profile: %v", err)
}
}
}
// Execute handles all invocations of the
// rosetta-cli cmd.
func Execute() error {
defer rootPostRun()
return rootCmd.Execute()
}
func init() {
cobra.OnInitialize(initConfig)
rootFlags := rootCmd.PersistentFlags()
rootFlags.StringVar(
&configurationFile,
"configuration-file",
"",
`Configuration file that provides connection and test settings.
If you would like to generate a starter configuration file (populated
with the defaults), run rosetta-cli configuration:create.
Any fields not populated in the configuration file will be populated with
default values.`,
)
rootFlags.StringVar(
&cpuProfile,
"cpu-profile",
"",
`Save the pprof cpu profile in the specified file`,
)
rootFlags.StringVar(
&memProfile,
"mem-profile",
"",
`Save the pprof mem profile in the specified file`,
)
rootFlags.StringVar(
&blockProfile,
"block-profile",
"",
`Save the pprof block profile in the specified file`,
)
rootCmd.AddCommand(versionCmd)
// Configuration Commands
rootCmd.AddCommand(configurationCreateCmd)
rootCmd.AddCommand(configurationValidateCmd)
// Check commands
checkDataCmd.Flags().StringVar(
&asserterConfigurationFile,
"asserter-configuration-file",
"", // Default to skip validation
`Check that /network/options matches contents of file at this path`,
)
checkDataCmd.Flags().StringVar(
&onlineURL,
"online-url",
"",
"Override online node url in configuration file",
)
checkDataCmd.Flags().Int64Var(
&startIndex,
"start-block",
-1,
`Start-block is the block height to start syncing from. This will override the start_index from configuration file`,
)
checkDataCmd.Flags().Int64Var(
&endIndex,
"end-block",
-1,
`End-block configures the syncer to stop once reaching a particular block height. This will override the index from configuration file`,
)
checkDataCmd.Flags().StringVar(
&dataResultFile,
"result-file",
"",
"Result-file configures the location of validation result. This will override the results_output_file from configuration file",
)
checkDataCmd.Flags().StringVar(
&dataDirectory,
"data-dir",
"",
"Data-dir configures the location of logs and data for validation. This will override the data_directory from configuration file",
)
checkDataCmd.Flags().Int64Var(
&tableSize,
"table-size",
-1,
"Table-size configures the TableSize for badger DB. If table-size != -1, this will override the table_size from configuration file",
)
checkDataCmd.Flags().BoolVar(
&inMemoryMode,
"in-memory-mode",
false,
"In-memory-mode configures badger DB inMeomry option. Only when in-memory-mode=true, this will override the all_in_memory_enabled",
)
rootCmd.AddCommand(checkDataCmd)
checkConstructionCmd.Flags().StringVar(
&asserterConfigurationFile,
"asserter-configuration-file",
"", // Default to skip validation
`Check that /network/options matches contents of file at this path`,
)
checkConstructionCmd.Flags().StringVar(
&onlineURL,
"online-url",
"",
"Override online node url in configuration file",
)
checkConstructionCmd.Flags().StringVar(
&offlineURL,
"offline-url",
"",
"Override offline node url in configuration file",
)
checkConstructionCmd.Flags().StringVar(
&constructionResultFile,
"result-file",
"",
"Result-file configures the location of validation result. This will override the results_output_file from configuration file",
)
rootCmd.AddCommand(checkConstructionCmd)
// View Commands
viewBlockCmd.Flags().BoolVar(
&OnlyChanges,
"only-changes",
false,
`Only print balance changes for accounts in the block`,
)
rootCmd.AddCommand(viewBlockCmd)
rootCmd.AddCommand(viewAccountCmd)
rootCmd.AddCommand(viewNetworksCmd)
// Utils
rootCmd.AddCommand(utilsAsserterConfigurationCmd)
rootCmd.AddCommand(utilsTrainZstdCmd)
// Benchmark commands
rootCmd.AddCommand(checkPerfCmd)
// check:spec
checkSpecCmd.Flags().BoolVar(
&checkAllSpecs,
"all",
false,
`Verify both minimum and Coinbase spec requirements`,
)
rootCmd.AddCommand(checkSpecCmd)
}
func initConfig() {
Context = context.Background()
var err error
// Use path provided by the environment variable if config path arg is not set.
// Default configuration will be used if the env var is not
if len(configurationFile) == 0 {
configurationFile = os.Getenv(configEnvKey)
}
if len(configurationFile) == 0 {
Config = configuration.DefaultConfiguration()
} else {
Config, err = configuration.LoadConfiguration(Context, configurationFile)
}
if err != nil {
log.Fatalf("%s: unable to load configuration", err.Error())
}
// Override node url in configuration file when it's explicitly set via CLI
if len(onlineURL) != 0 {
Config.OnlineURL = onlineURL
}
if len(offlineURL) != 0 {
Config.Construction.OfflineURL = offlineURL
}
// Override start and end syncing index in configuration file when it's explicitly set via CLI
if startIndex != -1 {
Config.Data.StartIndex = &startIndex
// Configures rosetta-cli to lookup the balance of newly seen accounts at the
// parent block before applying operations. Otherwise the balance will be 0.
Config.Data.InitialBalanceFetchDisabled = false
}
if endIndex != -1 {
Config.Data.EndConditions.Index = &endIndex
}
if len(dataResultFile) != 0 {
Config.Data.ResultsOutputFile = dataResultFile
}
if len(constructionResultFile) != 0 {
Config.Construction.ResultsOutputFile = constructionResultFile
}
if len(dataDirectory) != 0 {
Config.DataDirectory = dataDirectory
}
if inMemoryMode {
Config.AllInMemoryEnabled = inMemoryMode
}
if tableSize >= 2 && tableSize <= 100 {
Config.TableSize = &tableSize
} else if tableSize != -1 {
log.Fatalf("table-size %d is not in the range [2, 100], please check your input", tableSize)
}
}
func ensureDataDirectoryExists() {
// If data directory is not specified, we use a temporary directory
// and delete its contents when execution is complete.
if len(Config.DataDirectory) == 0 {
tmpDir, err := utils.CreateTempDir()
if err != nil {
log.Fatalf("%s: unable to create temporary directory", err.Error())
}
Config.DataDirectory = tmpDir
}
}
// handleSignals handles OS signals so we can ensure we close database
// correctly. We call multiple sigListeners because we
// may need to cancel more than 1 context.
func handleSignals(listeners *[]context.CancelFunc) {
sigs := make(chan os.Signal, 1)
signal.Notify(sigs, syscall.SIGINT, syscall.SIGTERM)
go func() {
sig := <-sigs
color.Red("Received signal: %s", sig)
SignalReceived = true
for _, listener := range *listeners {
listener()
}
}()
}
var versionCmd = &cobra.Command{
Use: "version",
Short: "Print rosetta-cli version",
Run: func(cmd *cobra.Command, args []string) {
fmt.Println("v0.9.0")
},
}