Merge pull request #255 from multiversx/feat/refactor_enable_epochs_h…

…andler

Feat/refactor enable epochs handler

core/epochFlags.go

@@ -0,0 +1,25 @@
+package core
+
+import (
+	"fmt"
+
+	"github.com/multiversx/mx-chain-core-go/core/check"
+)
+
+// EnableEpochFlag defines a flag specific to the enableEpochs.toml
+type EnableEpochFlag string
+
+// CheckHandlerCompatibility checks if the provided handler is compatible with this mx-chain-core-go version
+func CheckHandlerCompatibility(handler EnableEpochsHandler, requiredFlags []EnableEpochFlag) error {
+	if check.IfNil(handler) {
+		return ErrNilEnableEpochsHandler
+	}
+
+	for _, flag := range requiredFlags {
+		if !handler.IsFlagDefined(flag) {
+			return fmt.Errorf("%w for flag %s", ErrInvalidEnableEpochsHandler, flag)
+		}
+	}
+
+	return nil
+}

core/epochFlags_test.go

@@ -0,0 +1,45 @@
+package core_test
+
+import (
+	"errors"
+	"strings"
+	"testing"
+
+	"github.com/multiversx/mx-chain-core-go/core"
+	"github.com/multiversx/mx-chain-core-go/core/mock"
+	"github.com/stretchr/testify/require"
+)
+
+func TestCheckHandlerCompatibility(t *testing.T) {
+	t.Parallel()
+
+	err := core.CheckHandlerCompatibility(nil, []core.EnableEpochFlag{})
+	require.Equal(t, core.ErrNilEnableEpochsHandler, err)
+
+	testFlags := []core.EnableEpochFlag{"f0", "f1", "f2"}
+	allFlagsDefinedHandler := &mock.EnableEpochsHandlerStub{
+		IsFlagDefinedCalled: func(flag core.EnableEpochFlag) bool {
+			return true
+		},
+	}
+	err = core.CheckHandlerCompatibility(allFlagsDefinedHandler, testFlags)
+	require.Nil(t, err)
+
+	allFlagsUndefinedHandler := &mock.EnableEpochsHandlerStub{
+		IsFlagDefinedCalled: func(flag core.EnableEpochFlag) bool {
+			return false
+		},
+	}
+	err = core.CheckHandlerCompatibility(allFlagsUndefinedHandler, testFlags)
+	require.True(t, errors.Is(err, core.ErrInvalidEnableEpochsHandler))
+
+	missingFlag := testFlags[1]
+	oneFlagUndefinedHandler := &mock.EnableEpochsHandlerStub{
+		IsFlagDefinedCalled: func(flag core.EnableEpochFlag) bool {
+			return flag != missingFlag
+		},
+	}
+	err = core.CheckHandlerCompatibility(oneFlagUndefinedHandler, testFlags)
+	require.True(t, errors.Is(err, core.ErrInvalidEnableEpochsHandler))
+	require.True(t, strings.Contains(err.Error(), string(missingFlag)))
+}

core/errors.go

@@ -19,7 +19,7 @@ var ErrInvalidValue = errors.New("invalid value provided")
 // ErrNilInputData signals that a nil data has been provided
 var ErrNilInputData = errors.New("nil input data")
 
-//ErrNilUrl signals that the provided url is empty
+// ErrNilUrl signals that the provided url is empty
 var ErrNilUrl = errors.New("url is empty")
 
 // ErrPemFileIsInvalid signals that a pem file is invalid
@@ -118,3 +118,6 @@ var ErrDBIsClosed = errors.New("DB is closed")
 
 // ErrNilEnableEpochsHandler signals that a nil enable epochs handler has been provided
 var ErrNilEnableEpochsHandler = errors.New("nil enable epochs handler")
+
+// ErrInvalidEnableEpochsHandler signals that an invalid enable epochs handler has been provided
+var ErrInvalidEnableEpochsHandler = errors.New("invalid enable epochs handler")

core/export_test.go

@@ -2,10 +2,42 @@ package core
 
 import "time"
 
+// GetContainingDuration -
 func (sw *StopWatch) GetContainingDuration() (map[string]time.Duration, []string) {
 	return sw.getContainingDuration()
 }
 
+// GetIdentifiers -
+func (sw *StopWatch) GetIdentifiers() []string {
+	return sw.identifiers
+}
+
+// SetIdentifiers -
+func (sw *StopWatch) SetIdentifiers(identifiers []string) {
+	sw.identifiers = identifiers
+}
+
+// GetStarted -
+func (sw *StopWatch) GetStarted(identifier string) (time.Time, bool) {
+	s, has := sw.started[identifier]
+	return s, has
+}
+
+// GetElapsed -
+func (sw *StopWatch) GetElapsed(identifier string) (time.Duration, bool) {
+	e, has := sw.elapsed[identifier]
+	return e, has
+}
+
+// SetElapsed -
+func (sw *StopWatch) SetElapsed(identifier string, duration time.Duration) {
+	sw.elapsed[identifier] = duration
+}
+
+// SplitExponentFraction -
 func SplitExponentFraction(val string) (string, string) {
 	return splitExponentFraction(val)
 }
+
+// TestAutoBalanceDataTriesFlag -
+const TestAutoBalanceDataTriesFlag = autoBalanceDataTriesFlag

core/file.go

@@ -5,7 +5,7 @@ import (
 	"encoding/json"
 	"encoding/pem"
 	"fmt"
-	"io/ioutil"
+	"io"
 	"os"
 	"path/filepath"
 	"strings"
@@ -152,7 +152,7 @@ func LoadSkPkFromPemFile(relativePath string, skIndex int) ([]byte, string, erro
 		_ = file.Close()
 	}()
 
-	buff, err := ioutil.ReadAll(file)
+	buff, err := io.ReadAll(file)
 	if err != nil {
 		return nil, "", fmt.Errorf("%w while reading %s file", err, relativePath)
 	}
@@ -200,7 +200,7 @@ func LoadAllKeysFromPemFile(relativePath string) ([][]byte, []string, error) {
 		_ = file.Close()
 	}()
 
-	buff, err := ioutil.ReadAll(file)
+	buff, err := io.ReadAll(file)
 	if err != nil {
 		return nil, nil, fmt.Errorf("%w while reading %s file", err, relativePath)
 	}

core/file_test.go

@@ -3,7 +3,6 @@ package core_test
 import (
 	"encoding/json"
 	"errors"
-	"io/ioutil"
 	"os"
 	"path/filepath"
 	"strings"
@@ -146,7 +145,7 @@ func TestLoadJSonFile_FileExitsShouldPass(t *testing.T) {
 
 	data, _ := json.MarshalIndent(TestStruct{A: 0, B: 0}, "", " ")
 
-	_ = ioutil.WriteFile(fileName, data, 0644)
+	_ = os.WriteFile(fileName, data, 0644)
 
 	err = file.Close()
 	assert.Nil(t, err)

core/interface.go

@@ -144,6 +144,9 @@ type TrieNodeVersionVerifier interface {
 
 // EnableEpochsHandler defines the behavior of a component that can return if a feature is enabled or not
 type EnableEpochsHandler interface {
-	IsAutoBalanceDataTriesEnabled() bool
+	IsFlagDefined(flag EnableEpochFlag) bool
+	IsFlagEnabled(flag EnableEpochFlag) bool
+	IsFlagEnabledInEpoch(flag EnableEpochFlag, epoch uint32) bool
+	GetActivationEpoch(flag EnableEpochFlag) uint32
 	IsInterfaceNil() bool
 }

core/loggingFunctions_test.go

@@ -1,9 +1,10 @@
-package core
+package core_test
 
 import (
 	"fmt"
 	"testing"
 
+	"github.com/multiversx/mx-chain-core-go/core"
 	"github.com/multiversx/mx-chain-core-go/core/mock"
 	"github.com/stretchr/testify/require"
 )
@@ -18,12 +19,12 @@ func TestDumpGoRoutinesToLogShouldNotPanic(t *testing.T) {
 		}
 	}()
 
-	DumpGoRoutinesToLog(0, &mock.LoggerMock{})
+	core.DumpGoRoutinesToLog(0, &mock.LoggerMock{})
 }
 
 func TestGetRunningGoRoutines(t *testing.T) {
 	t.Parallel()
 
-	res := GetRunningGoRoutines(&mock.LoggerMock{})
+	res := core.GetRunningGoRoutines(&mock.LoggerMock{})
 	require.NotNil(t, res)
 }

core/mock/enableEpochsHandlerStub.go

@@ -0,0 +1,48 @@
+package mock
+
+import "github.com/multiversx/mx-chain-core-go/core"
+
+// EnableEpochsHandlerStub -
+type EnableEpochsHandlerStub struct {
+	IsFlagDefinedCalled        func(flag core.EnableEpochFlag) bool
+	IsFlagEnabledCalled        func(flag core.EnableEpochFlag) bool
+	IsFlagEnabledInEpochCalled func(flag core.EnableEpochFlag, epoch uint32) bool
+	GetActivationEpochCalled   func(flag core.EnableEpochFlag) uint32
+}
+
+// IsFlagDefined -
+func (stub *EnableEpochsHandlerStub) IsFlagDefined(flag core.EnableEpochFlag) bool {
+	if stub.IsFlagDefinedCalled != nil {
+		return stub.IsFlagDefinedCalled(flag)
+	}
+	return false
+}
+
+// IsFlagEnabled -
+func (stub *EnableEpochsHandlerStub) IsFlagEnabled(flag core.EnableEpochFlag) bool {
+	if stub.IsFlagEnabledCalled != nil {
+		return stub.IsFlagEnabledCalled(flag)
+	}
+	return false
+}
+
+// IsFlagEnabledInEpoch -
+func (stub *EnableEpochsHandlerStub) IsFlagEnabledInEpoch(flag core.EnableEpochFlag, epoch uint32) bool {
+	if stub.IsFlagEnabledInEpochCalled != nil {
+		return stub.IsFlagEnabledInEpochCalled(flag, epoch)
+	}
+	return false
+}
+
+// GetActivationEpoch -
+func (stub *EnableEpochsHandlerStub) GetActivationEpoch(flag core.EnableEpochFlag) uint32 {
+	if stub.GetActivationEpochCalled != nil {
+		return stub.GetActivationEpochCalled(flag)
+	}
+	return 0
+}
+
+// IsInterfaceNil -
+func (stub *EnableEpochsHandlerStub) IsInterfaceNil() bool {
+	return stub == nil
+}