restructure crosschain tests

zeta-chain · Jun 6, 2024 · 8c46698 · 8c46698
1 parent c7333d7
commit 8c46698
Show file tree

Hide file tree

Showing 12 changed files with 463 additions and 474 deletions.
diff --git a/testutil/keeper/authority.go b/testutil/keeper/authority.go
@@ -74,13 +74,9 @@ func AuthorityKeeper(t testing.TB) (*keeper.Keeper, sdk.Context) {
 	return &k, ctx
 }
 
-// MockIsAuthorized mocks the IsAuthorized method of an authority keeper mock
-func MockIsAuthorized(m *mock.Mock, address string, policyType types.PolicyType, isAuthorized bool) {
-	m.On("IsAuthorized", mock.Anything, address, policyType).Return(isAuthorized).Once()
-}
-
-func MockCheckAuthorization(m *mock.Mock, msg sdk.Msg, isAuthorized error) {
-	m.On("CheckAuthorization", mock.Anything, msg).Return(isAuthorized).Once()
+// MockCheckAuthorization mocks the CheckAuthorization method of the authority keeper.
+func MockCheckAuthorization(m *mock.Mock, msg sdk.Msg, authorizationResult error) {
+	m.On("CheckAuthorization", mock.Anything, msg).Return(authorizationResult).Once()
 }
 
 func SetAdminPolicies(ctx sdk.Context, ak *keeper.Keeper) string {

diff --git a/x/authority/keeper/msg_server_add_authorization.go b/x/authority/keeper/msg_server_add_authorization.go
@@ -17,6 +17,7 @@ func (k msgServer) AddAuthorization(
 ) (*types.MsgAddAuthorizationResponse, error) {
 	ctx := sdk.UnwrapSDKContext(goCtx)
 
+	// check if the caller is authorized to add an authorization
 	err := k.CheckAuthorization(ctx, msg)
 	if err != nil {
 		return nil, errorsmod.Wrap(types.ErrUnauthorized, err.Error())

diff --git a/x/authority/keeper/msg_server_remove_authorization.go b/x/authority/keeper/msg_server_remove_authorization.go
@@ -18,6 +18,7 @@ func (k msgServer) RemoveAuthorization(
 ) (*types.MsgRemoveAuthorizationResponse, error) {
 	ctx := sdk.UnwrapSDKContext(goCtx)
 
+	// check if the caller is authorized to remove an authorization
 	err := k.CheckAuthorization(ctx, msg)
 	if err != nil {
 		return nil, errorsmod.Wrap(types.ErrUnauthorized, err.Error())

diff --git a/x/crosschain/keeper/msg_server_abort_stuck_cctx_test.go b/x/crosschain/keeper/msg_server_abort_stuck_cctx_test.go
@@ -20,11 +20,6 @@ func TestMsgServer_AbortStuckCCTX(t *testing.T) {
 		msgServer := crosschainkeeper.NewMsgServerImpl(*k)
 		admin := sample.AccAddress()
 		authorityMock := keepertest.GetCrosschainAuthorityMock(t, k)
-		msg := crosschaintypes.MsgAbortStuckCCTX{
-			Creator:   admin,
-			CctxIndex: sample.GetCctxIndexFromString("cctx_index"),
-		}
-		keepertest.MockCheckAuthorization(&authorityMock.Mock, &msg, nil)
 
 		// create a cctx
 		cctx := sample.CrossChainTx(t, "cctx_index")
@@ -35,6 +30,11 @@ func TestMsgServer_AbortStuckCCTX(t *testing.T) {
 		k.SetCrossChainTx(ctx, *cctx)
 
 		// abort the cctx
+		msg := crosschaintypes.MsgAbortStuckCCTX{
+			Creator:   admin,
+			CctxIndex: sample.GetCctxIndexFromString("cctx_index"),
+		}
+		keepertest.MockCheckAuthorization(&authorityMock.Mock, &msg, nil)
 		_, err := msgServer.AbortStuckCCTX(ctx, &msg)
 
 		require.NoError(t, err)
@@ -51,13 +51,7 @@ func TestMsgServer_AbortStuckCCTX(t *testing.T) {
 
 		msgServer := crosschainkeeper.NewMsgServerImpl(*k)
 		admin := sample.AccAddress()
-		msg := crosschaintypes.MsgAbortStuckCCTX{
-			Creator:   admin,
-			CctxIndex: sample.GetCctxIndexFromString("cctx_index"),
-		}
 		authorityMock := keepertest.GetCrosschainAuthorityMock(t, k)
-		keepertest.MockCheckAuthorization(&authorityMock.Mock, &msg, nil)
-
 		// create a cctx
 		cctx := sample.CrossChainTx(t, "cctx_index")
 		cctx.CctxStatus = &crosschaintypes.Status{
@@ -67,6 +61,11 @@ func TestMsgServer_AbortStuckCCTX(t *testing.T) {
 		k.SetCrossChainTx(ctx, *cctx)
 
 		// abort the cctx
+		msg := crosschaintypes.MsgAbortStuckCCTX{
+			Creator:   admin,
+			CctxIndex: sample.GetCctxIndexFromString("cctx_index"),
+		}
+		keepertest.MockCheckAuthorization(&authorityMock.Mock, &msg, nil)
 		_, err := msgServer.AbortStuckCCTX(ctx, &msg)
 
 		require.NoError(t, err)
@@ -83,12 +82,7 @@ func TestMsgServer_AbortStuckCCTX(t *testing.T) {
 
 		msgServer := crosschainkeeper.NewMsgServerImpl(*k)
 		admin := sample.AccAddress()
-		msg := crosschaintypes.MsgAbortStuckCCTX{
-			Creator:   admin,
-			CctxIndex: sample.GetCctxIndexFromString("cctx_index"),
-		}
 		authorityMock := keepertest.GetCrosschainAuthorityMock(t, k)
-		keepertest.MockCheckAuthorization(&authorityMock.Mock, &msg, nil)
 
 		// create a cctx
 		cctx := sample.CrossChainTx(t, "cctx_index")
@@ -99,6 +93,12 @@ func TestMsgServer_AbortStuckCCTX(t *testing.T) {
 		k.SetCrossChainTx(ctx, *cctx)
 
 		// abort the cctx
+		msg := crosschaintypes.MsgAbortStuckCCTX{
+			Creator:   admin,
+			CctxIndex: sample.GetCctxIndexFromString("cctx_index"),
+		}
+
+		keepertest.MockCheckAuthorization(&authorityMock.Mock, &msg, nil)
 		_, err := msgServer.AbortStuckCCTX(ctx, &msg)
 
 		require.NoError(t, err)
@@ -115,12 +115,7 @@ func TestMsgServer_AbortStuckCCTX(t *testing.T) {
 		msgServer := crosschainkeeper.NewMsgServerImpl(*k)
 
 		admin := sample.AccAddress()
-		msg := crosschaintypes.MsgAbortStuckCCTX{
-			Creator:   admin,
-			CctxIndex: sample.GetCctxIndexFromString("cctx_index"),
-		}
 		authorityMock := keepertest.GetCrosschainAuthorityMock(t, k)
-		keepertest.MockCheckAuthorization(&authorityMock.Mock, &msg, authoritytypes.ErrUnauthorized)
 
 		// create a cctx
 		cctx := sample.CrossChainTx(t, "cctx_index")
@@ -131,6 +126,12 @@ func TestMsgServer_AbortStuckCCTX(t *testing.T) {
 		k.SetCrossChainTx(ctx, *cctx)
 
 		// abort the cctx
+		msg := crosschaintypes.MsgAbortStuckCCTX{
+			Creator:   admin,
+			CctxIndex: sample.GetCctxIndexFromString("cctx_index"),
+		}
+
+		keepertest.MockCheckAuthorization(&authorityMock.Mock, &msg, authoritytypes.ErrUnauthorized)
 		_, err := msgServer.AbortStuckCCTX(ctx, &msg)
 		require.ErrorIs(t, err, authoritytypes.ErrUnauthorized)
 	})
@@ -143,14 +144,13 @@ func TestMsgServer_AbortStuckCCTX(t *testing.T) {
 
 		admin := sample.AccAddress()
 		authorityMock := keepertest.GetCrosschainAuthorityMock(t, k)
+
+		// abort the cctx
 		msg := crosschaintypes.MsgAbortStuckCCTX{
 			Creator:   admin,
 			CctxIndex: sample.GetCctxIndexFromString("cctx_index"),
 		}
-
 		keepertest.MockCheckAuthorization(&authorityMock.Mock, &msg, nil)
-
-		// abort the cctx
 		_, err := msgServer.AbortStuckCCTX(ctx, &msg)
 		require.ErrorIs(t, err, crosschaintypes.ErrCannotFindCctx)
 	})
@@ -163,11 +163,6 @@ func TestMsgServer_AbortStuckCCTX(t *testing.T) {
 
 		admin := sample.AccAddress()
 		authorityMock := keepertest.GetCrosschainAuthorityMock(t, k)
-		msg := crosschaintypes.MsgAbortStuckCCTX{
-			Creator:   admin,
-			CctxIndex: sample.GetCctxIndexFromString("cctx_index"),
-		}
-		keepertest.MockCheckAuthorization(&authorityMock.Mock, &msg, nil)
 
 		// create a cctx
 		cctx := sample.CrossChainTx(t, "cctx_index")
@@ -178,6 +173,11 @@ func TestMsgServer_AbortStuckCCTX(t *testing.T) {
 		k.SetCrossChainTx(ctx, *cctx)
 
 		// abort the cctx
+		msg := crosschaintypes.MsgAbortStuckCCTX{
+			Creator:   admin,
+			CctxIndex: sample.GetCctxIndexFromString("cctx_index"),
+		}
+		keepertest.MockCheckAuthorization(&authorityMock.Mock, &msg, nil)
 		_, err := msgServer.AbortStuckCCTX(ctx, &msg)
 		require.ErrorIs(t, err, crosschaintypes.ErrStatusNotPending)
 	})