fix(dot): no error logged for init check (#2502)

- Rename `NodeInitialized` to `IsNodeInitialised`
- Rename `nodeInitialised` to `isNodeInitialised`
- Do not log `IsNodeInitialised` error

Author: qdm12

cmd/gossamer/config.go

@@ -519,7 +519,7 @@ func setDotGlobalConfigFromFlags(ctx *cli.Context, cfg *dot.GlobalConfig) error
 
 func setDotGlobalConfigName(ctx *cli.Context, tomlCfg *ctoml.Config, cfg *dot.GlobalConfig) error {
 	globalBasePath := utils.ExpandDir(cfg.BasePath)
-	initialised := dot.NodeInitialized(globalBasePath)
+	initialised := dot.IsNodeInitialised(globalBasePath)
 
 	// consider the --name flag as higher priority
 	if ctx.GlobalString(NameFlag.Name) != "" {

cmd/gossamer/main.go

@@ -226,7 +226,7 @@ func gossamerAction(ctx *cli.Context) error {
 	// from createDotConfig because dot config should not include expanded path)
 	cfg.Global.BasePath = utils.ExpandDir(cfg.Global.BasePath)
 
-	if !dot.NodeInitialized(cfg.Global.BasePath) {
+	if !dot.IsNodeInitialised(cfg.Global.BasePath) {
 		// initialise node (initialise state database and load genesis data)
 		err = dot.InitNode(cfg)
 		if err != nil {
@@ -320,8 +320,7 @@ func initAction(ctx *cli.Context) error {
 	// from createDotConfig because dot config should not include expanded path)
 	cfg.Global.BasePath = utils.ExpandDir(cfg.Global.BasePath)
 	// check if node has been initialised (expected false - no warning log)
-	if dot.NodeInitialized(cfg.Global.BasePath) {
-
+	if dot.IsNodeInitialised(cfg.Global.BasePath) {
 		// use --force value to force initialise the node
 		force := ctx.Bool(ForceFlag.Name)
 

dot/mock_node_builder_test.go

@@ -50,7 +50,7 @@ type Node struct {
 //go:generate mockgen -source=node.go -destination=mock_node_builder_test.go -package=$GOPACKAGE
 
 type nodeBuilderIface interface {
-	nodeInitialised(string) error
+	isNodeInitialised(basepath string) error
 	initNode(config *Config) error
 	createStateService(config *Config) (*state.Service, error)
 	createNetworkService(cfg *Config, stateSrvc *state.Service, telemetryMailer telemetry.Client) (*network.Service,
@@ -76,19 +76,17 @@ var _ nodeBuilderIface = (*nodeBuilder)(nil)
 
 type nodeBuilder struct{}
 
-// NodeInitialized returns true if, within the configured data directory for the
-// node, the state database has been created and the genesis data has been loaded
-func NodeInitialized(basepath string) bool {
+// IsNodeInitialised returns true if, within the configured data directory for the
+// node, the state database has been created and the genesis data can been loaded
+func IsNodeInitialised(basepath string) bool {
 	nodeInstance := nodeBuilder{}
-	err := nodeInstance.nodeInitialised(basepath)
-	if err != nil {
-		logger.Errorf("failed to initialise node from base path %s: %s", basepath, err)
-		return false
-	}
-	return true
+	err := nodeInstance.isNodeInitialised(basepath)
+	return err == nil
 }
 
-func (*nodeBuilder) nodeInitialised(basepath string) error {
+// isNodeInitialised returns nil if the node is successfully initialised
+// and an error otherwise.
+func (*nodeBuilder) isNodeInitialised(basepath string) error {
 	// check if key registry exists
 	registry := filepath.Join(basepath, utils.DefaultDatabaseDir, "KEYREGISTRY")
 
@@ -235,7 +233,7 @@ func newNode(cfg *Config,
 		debug.SetGCPercent(prev)
 	}
 
-	if builder.nodeInitialised(cfg.Global.BasePath) != nil {
+	if builder.isNodeInitialised(cfg.Global.BasePath) != nil {
 		err := builder.initNode(cfg)
 		if err != nil {
 			return nil, fmt.Errorf("cannot initialise node: %w", err)

dot/node.go

@@ -68,13 +68,13 @@ func TestNodeInitializedIntegration(t *testing.T) {
 
 	cfg.Init.Genesis = genFile
 
-	result := NodeInitialized(cfg.Global.BasePath)
+	result := IsNodeInitialised(cfg.Global.BasePath)
 	require.False(t, result)
 
 	err := InitNode(cfg)
 	require.NoError(t, err)
 
-	result = NodeInitialized(cfg.Global.BasePath)
+	result = IsNodeInitialised(cfg.Global.BasePath)
 	require.True(t, result)
 }
 

dot/node_integration_test.go

@@ -154,7 +154,7 @@ func TestNewNode(t *testing.T) {
 	mockServiceRegistry.EXPECT().RegisterService(gomock.Any()).Times(8)
 
 	m := NewMocknodeBuilderIface(ctrl)
-	m.EXPECT().nodeInitialised(dotConfig.Global.BasePath).Return(nil)
+	m.EXPECT().isNodeInitialised(dotConfig.Global.BasePath).Return(nil)
 	m.EXPECT().createStateService(dotConfig).DoAndReturn(func(cfg *Config) (*state.Service, error) {
 		stateSrvc := state.NewService(config)
 		// create genesis from configuration file
@@ -285,7 +285,7 @@ func TestNodeInitialized(t *testing.T) {
 	}
 	for _, tt := range tests {
 		t.Run(tt.name, func(t *testing.T) {
-			got := NodeInitialized(tt.basepath)
+			got := IsNodeInitialised(tt.basepath)
 			assert.Equal(t, tt.want, got)
 		})
 	}