add tests for cron module

Author: cboh4

go.mod

@@ -74,6 +74,7 @@ require (
 	github.com/cosmos/cosmos-proto v1.0.0-beta.5
 	github.com/cosmos/rosetta v0.50.4
 	github.com/gogo/protobuf v1.3.2
+	github.com/golang/mock v1.6.0
 	github.com/hashicorp/go-metrics v0.5.3
 	github.com/scrtlabs/tm-secret-enclave v1.12.3-implicit-hash
 	golang.org/x/xerrors v0.0.0-20231012003039-104605ab7028
@@ -139,7 +140,6 @@ require (
 	github.com/gogo/googleapis v1.4.1 // indirect
 	github.com/golang/glog v1.2.3 // indirect
 	github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da // indirect
-	github.com/golang/mock v1.6.0 // indirect
 	github.com/golang/snappy v0.0.4 // indirect
 	github.com/google/btree v1.1.3 // indirect
 	github.com/google/flatbuffers v2.0.8+incompatible // indirect

proto/secret/cron/schedule.proto

@@ -24,7 +24,7 @@ message Schedule {
   // Last execution's block height
   uint64 last_execute_height = 4;
   // Stage when messages will be executed
-  ExecutionStage execution_stage = 5;
+  // ExecutionStage execution_stage = 5;
 }
 
 // Defines the contract and the message to pass

testutil/common/nullify/nullify.go

@@ -0,0 +1,57 @@
+// Package nullify provides methods to init nil values structs for test assertion.
+package nullify
+
+import (
+	"reflect"
+	"unsafe"
+
+	sdk "github.com/cosmos/cosmos-sdk/types"
+)
+
+var (
+	coinType  = reflect.TypeOf(sdk.Coin{})
+	coinsType = reflect.TypeOf(sdk.Coins{})
+)
+
+// Fill analyze all struct fields and slices with
+// reflection and initialize the nil and empty slices,
+// structs, and pointers.
+func Fill(x interface{}) interface{} {
+	v := reflect.Indirect(reflect.ValueOf(x))
+	switch v.Kind() {
+	case reflect.Slice:
+		for i := 0; i < v.Len(); i++ {
+			obj := v.Index(i)
+			objPt := reflect.NewAt(obj.Type(), unsafe.Pointer(obj.UnsafeAddr())).Interface()
+			objPt = Fill(objPt)
+			obj.Set(reflect.ValueOf(objPt))
+		}
+	case reflect.Struct:
+		for i := 0; i < v.NumField(); i++ {
+			f := reflect.Indirect(v.Field(i))
+			if !f.CanSet() {
+				continue
+			}
+			switch f.Kind() {
+			case reflect.Slice:
+				f.Set(reflect.MakeSlice(f.Type(), 0, 0))
+			case reflect.Struct:
+				switch f.Type() {
+				case coinType:
+					coin := reflect.New(coinType).Interface()
+					s := reflect.ValueOf(coin).Elem()
+					f.Set(s)
+				case coinsType:
+					coins := reflect.New(coinsType).Interface()
+					s := reflect.ValueOf(coins).Elem()
+					f.Set(s)
+				default:
+					objPt := reflect.NewAt(f.Type(), unsafe.Pointer(f.UnsafeAddr())).Interface()
+					s := Fill(objPt)
+					f.Set(reflect.ValueOf(s))
+				}
+			}
+		}
+	}
+	return reflect.Indirect(v).Interface()
+}

testutil/cron/keeper/cron.go

@@ -0,0 +1,62 @@
+package keeper
+
+import (
+	"sync"
+	"testing"
+
+	"cosmossdk.io/log"
+	metrics2 "cosmossdk.io/store/metrics"
+	db2 "github.com/cosmos/cosmos-db"
+	authtypes "github.com/cosmos/cosmos-sdk/x/auth/types"
+
+	"cosmossdk.io/store"
+	storetypes "cosmossdk.io/store/types"
+	tmproto "github.com/cometbft/cometbft/proto/tendermint/types"
+	"github.com/cosmos/cosmos-sdk/codec"
+	codectypes "github.com/cosmos/cosmos-sdk/codec/types"
+	sdk "github.com/cosmos/cosmos-sdk/types"
+	"github.com/stretchr/testify/require"
+
+	"github.com/scrtlabs/SecretNetwork/x/cron/keeper"
+	"github.com/scrtlabs/SecretNetwork/x/cron/types"
+)
+
+var configOnce sync.Once
+
+func CronKeeper(t testing.TB, accountKeeper types.AccountKeeper) (*keeper.Keeper, sdk.Context) {
+	configOnce.Do(func() {
+		config := sdk.GetConfig()
+		config.SetBech32PrefixForAccount("secret", "secretpub")
+		config.SetBech32PrefixForValidator("secretvaloper", "secretvaloperpub")
+		config.SetBech32PrefixForConsensusNode("secretvalcons", "secretvalconspub")
+		config.Seal()
+	})
+
+	storeKey := storetypes.NewKVStoreKey(types.StoreKey)
+	memStoreKey := storetypes.NewMemoryStoreKey(types.MemStoreKey)
+
+	db := db2.NewMemDB()
+	stateStore := store.NewCommitMultiStore(db, log.NewNopLogger(), metrics2.NewNoOpMetrics())
+	stateStore.MountStoreWithDB(storeKey, storetypes.StoreTypeIAVL, db)
+	stateStore.MountStoreWithDB(memStoreKey, storetypes.StoreTypeMemory, nil)
+	require.NoError(t, stateStore.LoadLatestVersion())
+
+	registry := codectypes.NewInterfaceRegistry()
+	cdc := codec.NewProtoCodec(registry)
+
+	k := keeper.NewKeeper(
+		cdc,
+		storeKey,
+		memStoreKey,
+		accountKeeper,
+		authtypes.NewModuleAddress(types.ModuleName).String(),
+	)
+
+	ctx := sdk.NewContext(stateStore, tmproto.Header{}, false, log.NewNopLogger())
+
+	// Initialize params
+	err := k.SetParams(ctx, types.DefaultParams())
+	require.NoError(t, err)
+
+	return k, ctx
+}

testutil/mocks/cron/types/expected_keepers.go

@@ -0,0 +1,5 @@
+// Package testutil provides testing utilities for the SecretNetwork project.
+package testutil
+
+// TestOwnerAddress is a test address used in tests
+const TestOwnerAddress = "secret1g9v8s0uzndfrq7l0l5t8h8q3q3q3q3q3q3q3q3"

testutil/testutil.go

@@ -3,9 +3,7 @@ package compute
 import (
 	"context"
 	"crypto/sha256"
-	"encoding/hex"
 	"encoding/json"
-	"fmt"
 
 	"github.com/grpc-ecosystem/grpc-gateway/runtime"
 	"github.com/spf13/cobra"
@@ -227,7 +225,6 @@ func (am AppModule) EndBlock(c context.Context) error {
 	}
 	hash := sha256.Sum256(cron_data)
 
-	fmt.Printf("Hash of the executed msgs in the next round: %+v\n", hex.EncodeToString(hash[:]))
 	err = tmenclave.SetImplicitHash(hash[:])
 	if err != nil {
 		ctx.Logger().Error("Failed to set implicit hash %+v", err)

x/compute/module.go

@@ -11,7 +11,7 @@ import (
 func InitGenesis(ctx sdk.Context, k keeper.Keeper, genState types.GenesisState) {
 	// Set all the schedules
 	for _, elem := range genState.ScheduleList {
-		err := k.AddSchedule(ctx, elem.Name, elem.Period, elem.Msgs, elem.ExecutionStage)
+		err := k.AddSchedule(ctx, elem.Name, elem.Period, elem.Msgs)
 		if err != nil {
 			panic(err)
 		}

x/cron/genesis.go

@@ -0,0 +1,38 @@
+package cron_test
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/require"
+
+	"github.com/scrtlabs/SecretNetwork/testutil/common/nullify"
+	"github.com/scrtlabs/SecretNetwork/testutil/cron/keeper"
+	"github.com/scrtlabs/SecretNetwork/x/cron"
+	"github.com/scrtlabs/SecretNetwork/x/cron/types"
+)
+
+func TestGenesis(t *testing.T) {
+	k, ctx := keeper.CronKeeper(t, nil)
+
+	genesisState := types.GenesisState{
+		Params: types.DefaultParams(),
+		ScheduleList: []types.Schedule{
+			{
+				Name:              "a",
+				Period:            5,
+				Msgs:              nil,
+				LastExecuteHeight: uint64(ctx.BlockHeight()), //nolint:gosec
+			},
+		},
+	}
+
+	cron.InitGenesis(ctx, *k, genesisState)
+	got := cron.ExportGenesis(ctx, *k)
+	require.NotNil(t, got)
+
+	nullify.Fill(&genesisState)
+	nullify.Fill(got)
+
+	require.Equal(t, genesisState.Params, got.Params)
+	require.ElementsMatch(t, genesisState.ScheduleList, got.ScheduleList)
+}

x/cron/genesis_test.go

@@ -0,0 +1,22 @@
+package keeper_test
+
+import (
+	"testing"
+
+	testkeeper "github.com/scrtlabs/SecretNetwork/testutil/cron/keeper"
+
+	"github.com/stretchr/testify/require"
+
+	"github.com/scrtlabs/SecretNetwork/x/cron/types"
+)
+
+func TestParamsQuery(t *testing.T) {
+	keeper, ctx := testkeeper.CronKeeper(t, nil)
+	params := types.DefaultParams()
+	err := keeper.SetParams(ctx, params)
+	require.NoError(t, err)
+
+	response, err := keeper.Params(ctx, &types.QueryParamsRequest{})
+	require.NoError(t, err)
+	require.Equal(t, &types.QueryParamsResponse{Params: params}, response)
+}