add hook test

go.mod

@@ -150,6 +150,7 @@ require (
 	github.com/spf13/afero v1.9.5 // indirect
 	github.com/spf13/jwalterweatherman v1.1.0 // indirect
 	github.com/spf13/viper v1.16.0 // indirect
+	github.com/stretchr/objx v0.5.0 // indirect
 	github.com/subosito/gotenv v1.4.2 // indirect
 	github.com/syndtr/goleveldb v1.0.1-0.20220721030215-126854af5e6d // indirect
 	github.com/tendermint/go-amino v0.16.0 // indirect

x/epochs/keeper/hooks_test.go

@@ -0,0 +1,96 @@
+package keeper_test
+
+import (
+	"fmt"
+	sdk "github.com/cosmos/cosmos-sdk/types"
+	"github.com/mycel-domain/mycel/x/epochs/types"
+	"strconv"
+	"time"
+)
+
+type MockHooks struct{}
+
+const (
+	EpochIdentifier           = types.DayEpochId
+	BeforeEpochStartEventType = "BeforeEpochStart"
+	AfterEpochEndEventType    = "AfterEpochEnd"
+)
+
+func (h *MockHooks) AfterEpochEnd(ctx sdk.Context, epochIdentifier string, epochNumber int64) {
+	if epochIdentifier == EpochIdentifier {
+		ctx.EventManager().EmitEvent(
+			sdk.NewEvent(
+				AfterEpochEndEventType,
+				sdk.NewAttribute("epochIdentifier", epochIdentifier),
+				sdk.NewAttribute("epochNumber", strconv.FormatInt(epochNumber, 10)),
+			),
+		)
+	}
+}
+
+func (h *MockHooks) BeforeEpochStart(ctx sdk.Context, epochIdentifier string, epochNumber int64) {
+	if epochIdentifier == EpochIdentifier {
+		ctx.EventManager().EmitEvent(
+			sdk.NewEvent(
+				BeforeEpochStartEventType,
+				sdk.NewAttribute("epochIdentifier", epochIdentifier),
+				sdk.NewAttribute("epochNumber", strconv.FormatInt(epochNumber, 10)),
+			),
+		)
+	}
+}
+
+func (suite *KeeperTestSuite) TestAfterEpochHooks() {
+	var (
+		now = time.Now()
+		// oneDayDuration = time.Hour * 24
+	)
+	testCases := []struct {
+		expEpochNumber string
+		expEventIndex  int
+		expEventType   string
+
+		fn func()
+	}{
+		{
+			expEpochNumber: "1",
+			expEventIndex:  1,
+			expEventType:   BeforeEpochStartEventType,
+			fn: func() {
+				// Begin first block
+				suite.ctx = suite.ctx.WithBlockHeight(2).WithBlockTime(now.Add(time.Second))
+				suite.app.EpochsKeeper.BeginBlocker(suite.ctx)
+
+				// Check if curent epoch is expected
+				epochInfo, found := suite.app.EpochsKeeper.GetEpochInfo(suite.ctx, types.DayEpochId)
+				suite.Require().True(found)
+				suite.Require().Equal(int64(1), epochInfo.CurrentEpoch)
+			},
+		},
+	}
+
+	for i, tc := range testCases {
+		suite.Run(fmt.Sprintf("Case %d", i), func() {
+			suite.SetupTest()
+
+			// Remove hooks
+			suite.app.EpochsKeeper.RemoveHooks()
+
+			_ = tc
+
+			// Register hooks
+			hook := new(MockHooks)
+			suite.app.EpochsKeeper.SetHooks(hook)
+
+			// Run test Case
+			tc.fn()
+
+			// Check events
+			event := suite.ctx.EventManager().Events()[tc.expEventIndex]
+			suite.Require().Equal(tc.expEventType, event.Type)
+			suite.Require().Equal(EpochIdentifier, event.Attributes[0].Value)
+			suite.Require().Equal(tc.expEpochNumber, event.Attributes[1].Value)
+		})
+	}
+
+}

x/epochs/keeper/keeper.go

@@ -52,6 +52,12 @@ func (k *Keeper) SetHooks(eh types.EpochHooks) *Keeper {
 	return k
 }
 
+// Remove all hooks. Only used for testing.
+func (k *Keeper) RemoveHooks() *Keeper {
+	k.hooks = nil
+	return k
+}
+
 func (k Keeper) Logger(ctx sdk.Context) log.Logger {
 	return ctx.Logger().With("module", fmt.Sprintf("x/%s", types.ModuleName))
 }

x/epochs/types/expected_keepers.go

@@ -16,10 +16,3 @@ type BankKeeper interface {
 	SpendableCoins(ctx sdk.Context, addr sdk.AccAddress) sdk.Coins
 	// Methods imported from bank should be defined here
 }
-
-type EpochHooks interface {
-	// the first block whose timestamp is after the duration is counted as the end of the epoch
-	AfterEpochEnd(ctx sdk.Context, epochIdentifier string, epochNumber int64)
-	// new epoch is next block of epoch end block
-	BeforeEpochStart(ctx sdk.Context, epochIdentifier string, epochNumber int64)
-}

x/epochs/types/hooks.go

@@ -4,10 +4,16 @@ import (
 	sdk "github.com/cosmos/cosmos-sdk/types"
 )
 
+type EpochHooks interface {
+	// the first block whose timestamp is after the duration is counted as the end of the epoch
+	AfterEpochEnd(ctx sdk.Context, epochIdentifier string, epochNumber int64)
+	// new epoch is next block of epoch end block
+	BeforeEpochStart(ctx sdk.Context, epochIdentifier string, epochNumber int64)
+}
 
 var _ EpochHooks = MultiEpochHooks{}
 
-// combine multiple epoch hooks, all hook functions are run in array sequence
+// combine multiple gamm hooks, all hook functions are run in array sequence.
 type MultiEpochHooks []EpochHooks
 
 func NewMultiEpochHooks(hooks ...EpochHooks) MultiEpochHooks {
@@ -28,4 +34,5 @@ func (h MultiEpochHooks) BeforeEpochStart(ctx sdk.Context, epochIdentifier strin
 	for i := range h {
 		h[i].BeforeEpochStart(ctx, epochIdentifier, epochNumber)
 	}
+
 }