test comments

Author: shaspitz

x/ccv/consumer/keeper/keeper_test.go

@@ -136,6 +136,7 @@ func (suite *KeeperTestSuite) SetupCCVChannel() {
 	suite.coordinator.CreateChannels(suite.path)
 }
 
+// TestUnbondingTime tests getter and setter functionality for the unbonding period of a consumer chain
 func TestUnbondingTime(t *testing.T) {
 	consumerKeeper, ctx := testkeeper.GetConsumerKeeperAndCtx(t)
 	_, ok := consumerKeeper.GetUnbondingTime(ctx)
@@ -147,7 +148,7 @@ func TestUnbondingTime(t *testing.T) {
 	require.Equal(t, storedUnbondingPeriod, unbondingPeriod)
 }
 
-// Tests that the provider client managed by the consumer keeper matches the client keeper's client state
+// TestProviderClientMatches tests that the provider client managed by the consumer keeper matches the client keeper's client state
 func (suite *KeeperTestSuite) TestProviderClientMatches() {
 	providerClientID, ok := suite.consumerChain.App.(*appConsumer.App).ConsumerKeeper.GetProviderClientID(suite.ctx)
 	suite.Require().True(ok)
@@ -156,6 +157,7 @@ func (suite *KeeperTestSuite) TestProviderClientMatches() {
 	suite.Require().Equal(suite.providerClient, clientState, "stored client state does not match genesis provider client")
 }
 
+// TestProviderClientID tests getter and setter functionality for the client ID stored on consumer keeper
 func TestProviderClientID(t *testing.T) {
 	consumerKeeper, ctx := testkeeper.GetConsumerKeeperAndCtx(t)
 	_, ok := consumerKeeper.GetProviderClientID(ctx)
@@ -166,6 +168,7 @@ func TestProviderClientID(t *testing.T) {
 	require.Equal(t, "someClientID", clientID)
 }
 
+// TestProviderChannel tests getter and setter functionality for the channel ID stored on consumer keeper
 func TestProviderChannel(t *testing.T) {
 	consumerKeeper, ctx := testkeeper.GetConsumerKeeperAndCtx(t)
 	_, ok := consumerKeeper.GetProviderChannel(ctx)
@@ -176,6 +179,7 @@ func TestProviderChannel(t *testing.T) {
 	require.Equal(t, "channelID", channelID)
 }
 
+// TestPendingChanges tests getter, setter, and delete functionality for pending VSCs on a consumer chain
 func TestPendingChanges(t *testing.T) {
 	pk1, err := cryptocodec.ToTmProtoPublicKey(ed25519.GenPrivKey().PubKey())
 	require.NoError(t, err)
@@ -209,6 +213,7 @@ func TestPendingChanges(t *testing.T) {
 	require.Nil(t, gotPd, "got non-nil pending changes after Delete")
 }
 
+// TestPacketMaturityTime tests getter, setter, and iterator functionality for the packet maturity time of a received VSC packet
 func TestPacketMaturityTime(t *testing.T) {
 	consumerKeeper, ctx := testkeeper.GetConsumerKeeperAndCtx(t)
 	consumerKeeper.SetPacketMaturityTime(ctx, 1, 10)
@@ -236,6 +241,7 @@ func TestPacketMaturityTime(t *testing.T) {
 	})
 }
 
+// TestVerifyProviderChain tests the VerifyProviderChain method for the consumer keeper
 func (suite *KeeperTestSuite) TestVerifyProviderChain() {
 	var connectionHops []string
 	channelID := "channel-0"
@@ -502,6 +508,7 @@ func (suite *KeeperTestSuite) TestValidatorDoubleSigning() {
 	suite.Require().EqualValues(expCommit, gotCommit)
 }
 
+// TestSendSlashPacket tests the functionality of SendSlashPacket and asserts state changes related to that method
 func (suite *KeeperTestSuite) TestSendSlashPacket() {
 	suite.SetupCCVChannel()
 
@@ -582,6 +589,7 @@ func (suite *KeeperTestSuite) TestSendSlashPacket() {
 	suite.Require().Len(requests, 0)
 }
 
+// TestCrossChainValidator tests the getter, setter, and deletion method for cross chain validator records
 func TestCrossChainValidator(t *testing.T) {
 
 	// Construct a keeper with a custom codec
@@ -632,6 +640,7 @@ func TestCrossChainValidator(t *testing.T) {
 	require.False(t, found)
 }
 
+// TestPendingSlashRequests tests the getter, setter, appending method, and deletion method for pending slash requests
 func TestPendingSlashRequests(t *testing.T) {
 	consumerKeeper, ctx := testkeeper.GetConsumerKeeperAndCtx(t)
 

x/ccv/consumer/keeper/params_test.go

@@ -8,6 +8,7 @@ import (
 	"github.com/stretchr/testify/require"
 )
 
+// TestParams tests the default params set for a consumer chain, and related getters/setters
 func TestParams(t *testing.T) {
 	consumerKeeper, ctx := testkeeper.GetConsumerKeeperAndCtx(t)
 	consumerKeeper.SetParams(ctx, types.DefaultParams())

x/ccv/consumer/keeper/relay_test.go

@@ -24,6 +24,7 @@ import (
 	"github.com/tendermint/tendermint/libs/bytes"
 )
 
+// TestOnRecvVSCPacket tests the behavior of OnRecvVSCPacket over various packet scenarios
 func TestOnRecvVSCPacket(t *testing.T) {
 	consumerCCVChannelID := "consumerCCVChannelID"
 	providerCCVChannelID := "providerCCVChannelID"
@@ -200,6 +201,7 @@ func TestOnRecvVSCPacket(t *testing.T) {
 	}
 }
 
+// TestUnbondMaturePackets tests the behavior of UnbondMaturePackets and related state checks
 func (suite *KeeperTestSuite) TestUnbondMaturePackets() {
 	// setup CCV channel
 	suite.SetupCCVChannel()
@@ -290,7 +292,7 @@ func (suite *KeeperTestSuite) TestUnbondMaturePackets() {
 	suite.Require().Equal(uint64(2), commitments[1].Sequence, "did not send VSCMatured packet for VSC packet 2")
 }
 
-// incrementTimeByUnbondingPeriod increments the overall time by jumpPeriod
+// incrementTimeBy increments the overall time by jumpPeriod
 func incrementTimeBy(s *KeeperTestSuite, jumpPeriod time.Duration) {
 	// Get unboding period from staking keeper
 	consumerUnbondingPeriod, found := s.consumerChain.App.(*appConsumer.App).ConsumerKeeper.GetUnbondingTime(s.consumerChain.GetContext())

x/ccv/consumer/keeper/validators_test.go

@@ -20,6 +20,7 @@ import (
 	tmtypes "github.com/tendermint/tendermint/types"
 )
 
+// TestApplyCCValidatorChanges tests the ApplyCCValidatorChanges method for a consumer keeper
 func TestApplyCCValidatorChanges(t *testing.T) {
 	// Construct a keeper with a custom codec
 	_, storeKey, paramsSubspace, ctx := testkeeper.SetupInMemKeeper(t)

x/ccv/consumer/types/genesis_test.go

@@ -29,6 +29,8 @@ var (
 	upgradePath = []string{"upgrade", "upgradedIBCState"}
 )
 
+// TestValidateInitialGenesisState tests a NewInitialGenesisState instantiation,
+// and its Validate() method over different genesis scenarios
 func TestValidateInitialGenesisState(t *testing.T) {
 	// generate validator public key
 	pubKey, err := testutil.GenPubKey()
@@ -145,6 +147,8 @@ func TestValidateInitialGenesisState(t *testing.T) {
 	}
 }
 
+// TestValidateRestartGenesisState tests a NewRestartGenesisState instantiation,
+// and its Validate() method over different genesis scenarios
 func TestValidateRestartGenesisState(t *testing.T) {
 	// generate validator private/public key
 	pubKey, err := testutil.GenPubKey()

x/ccv/provider/keeper/keeper_test.go

@@ -129,6 +129,7 @@ func TestKeeperTestSuite(t *testing.T) {
 	suite.Run(t, new(KeeperTestSuite))
 }
 
+// TestValsetUpdateBlockHeight tests the getter, setter, and deletion methods for valset updates mapped to block height
 func TestValsetUpdateBlockHeight(t *testing.T) {
 	providerKeeper, ctx := testkeeper.GetProviderKeeperAndCtx(t)
 
@@ -149,6 +150,7 @@ func TestValsetUpdateBlockHeight(t *testing.T) {
 	require.Equal(t, blockHeight, uint64(4))
 }
 
+// TestSlashAcks tests the getter, setter, iteration, and deletion methods for stored slash acknowledgements
 func TestSlashAcks(t *testing.T) {
 	providerKeeper, ctx := testkeeper.GetProviderKeeperAndCtx(t)
 
@@ -190,6 +192,7 @@ func TestSlashAcks(t *testing.T) {
 	require.Len(t, chainsAcks, len(chains))
 }
 
+// TestAppendSlashAck tests the append method for stored slash acknowledgements
 func TestAppendSlashAck(t *testing.T) {
 	providerKeeper, ctx := testkeeper.GetProviderKeeperAndCtx(t)
 
@@ -208,6 +211,7 @@ func TestAppendSlashAck(t *testing.T) {
 	require.Len(t, acks, 1)
 }
 
+// TestPendingVSCs tests the getter, appending, and deletion methods for stored pending VSCs
 func TestPendingVSCs(t *testing.T) {
 	providerKeeper, ctx := testkeeper.GetProviderKeeperAndCtx(t)
 
@@ -261,6 +265,7 @@ func TestPendingVSCs(t *testing.T) {
 	require.False(t, found)
 }
 
+// TestInitHeight tests the getter and setter methods for the stored block heights (on provider) when a given consumer chain was started
 func TestInitHeight(t *testing.T) {
 	providerKeeper, ctx := testkeeper.GetProviderKeeperAndCtx(t)
 
@@ -282,7 +287,7 @@ func TestInitHeight(t *testing.T) {
 	}
 }
 
-// Tests the handling of a double-signing related slash packet, with e2e tests
+// TestHandleSlashPacketDoubleSigning tests the handling of a double-signing related slash packet, with e2e tests
 func (suite *KeeperTestSuite) TestHandleSlashPacketDoubleSigning() {
 	providerKeeper := suite.providerChain.App.(*appProvider.App).ProviderKeeper
 	providerSlashingKeeper := suite.providerChain.App.(*appProvider.App).SlashingKeeper
@@ -323,7 +328,7 @@ func (suite *KeeperTestSuite) TestHandleSlashPacketDoubleSigning() {
 	suite.Require().True(signingInfo.Tombstoned)
 }
 
-// Tests the handling of a double-signing related slash packet, with mocks and unit tests
+// TestHandleSlashPacketDoubleSigning tests the handling of a double-signing related slash packet, with mocks and unit tests
 func TestHandleSlashPacketDoubleSigning(t *testing.T) {
 	ctrl := gomock.NewController(t)
 	defer ctrl.Finish()
@@ -395,6 +400,7 @@ func TestHandleSlashPacketDoubleSigning(t *testing.T) {
 	require.True(t, success)
 }
 
+// TestHandleSlashPacketErrors tests errors for the HandleSlashPacket method in an e2e testing setting
 func (suite *KeeperTestSuite) TestHandleSlashPacketErrors() {
 	providerStakingKeeper := suite.providerChain.App.(*appProvider.App).StakingKeeper
 	ProviderKeeper := suite.providerChain.App.(*appProvider.App).ProviderKeeper