test(inflation): add additional burn test cases

[k-yang]

Purpose / Abstract

• add negative test cases
• add total supply check
• Closes test(inflation-burn): Use bank total supply queries to validate state changes in MsgBurn #1825

Summary by CodeRabbit

• Tests
  • Enhanced test coverage for coin burning scenarios, including cases with insufficient funds.
  • Added validation for coin amounts before and after burning in tests.

[coderabbitai]

Walkthrough

This update enhances the testing framework for the coin burning functionality, specifically focusing on the verification of state changes through bank total supply queries and handling scenarios with insufficient funds. It introduces comprehensive test cases in both keeper_test.go and msg_server_test.go to ensure the robustness of coin burning and supply management within the system.

Changes

Files	Change Summary
.../keeper/keeper_test.go	Updated TestBurn to include test cases for burning coins with balance verification and error handling.
.../keeper/msg_server_test.go	Added TestMsgBurn_NotEnoughCoins to check error handling when attempting to burn more coins than available.

Assessment against linked issues

Objective	Addressed	Explanation
test(inflation-burn): Use bank total supply queries to validate state changes in MsgBurn (#1825)	✅

🐇🎉
To the codebase, we hop and leap,
Burning coins, not too steep.
With tests in place, we verify,
No coin too many, nor supply too shy.
In our digital burrow, we keep it tight,
Ensuring every burn is just right. 🎇
🐇💻

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

---

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit-tests for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit tests for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit tests.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• The JSON schema for the configuration file is available here.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

[coderabbitai]

Review Status

Actionable comments generated: 1

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between db4ee51 and 476fad4.

Files selected for processing (2)

• x/inflation/keeper/keeper_test.go (1 hunks)
• x/inflation/keeper/msg_server_test.go (1 hunks)

Additional comments: 2

x/inflation/keeper/keeper_test.go (1)

• 23-40: The addition of mintCoin and burnCoin fields in the test struct, along with the new test cases, enhances the coverage of the TestBurn function. These changes effectively test both successful and failure scenarios, including the critical case of attempting to burn more coins than are available. This aligns well with the PR objectives to improve test coverage around coin burning operations.

x/inflation/keeper/msg_server_test.go (1)

• 95-113: The new test function TestMsgBurn_NotEnoughCoins is a valuable addition to the test suite, specifically targeting the scenario where there are insufficient funds to perform a burn operation. This test ensures that the system correctly handles such cases by not altering the total supply and returning the appropriate error message. This aligns with the PR objectives to enhance test coverage for error handling in coin burning operations.

It's well-structured and follows best practices for testing error conditions. The explicit check for the error message and the unchanged supply amount after the failed operation are particularly noteworthy, as they directly validate the system's behavior in response to the attempted operation.

[coderabbitai]

The logic for minting coins, sending them to the sender, burning coins, and then checking the supply before and after the burn operation is correctly implemented. However, it's important to ensure that the GetSupply method accurately reflects changes in the total supply of coins, especially after burning operations. This is crucial for validating the state changes as intended by the PR objectives.

One minor suggestion for improvement is to add comments explaining the purpose of each major step (minting, sending, burning, and verifying) within the test cases. This can enhance readability and maintainability for future contributors.

+ // Mint coins and send them to the sender's account
  require.NoError(t,
      nibiruApp.BankKeeper.MintCoins(
          ctx, types.ModuleName, sdk.NewCoins(tc.mintCoin)))
  require.NoError(t,
      nibiruApp.BankKeeper.SendCoinsFromModuleToAccount(
          ctx, types.ModuleName, tc.sender, sdk.NewCoins(tc.mintCoin)),
  )

+ // Verify the supply matches the minted amount
  supply := nibiruApp.BankKeeper.GetSupply(ctx, "unibi")
  require.Equal(t, tc.mintCoin.Amount, supply.Amount)

+ // Attempt to burn coins and verify the outcome
  err := nibiruApp.InflationKeeper.Burn(ctx, sdk.NewCoins(tc.burnCoin), tc.sender)
  supply = nibiruApp.BankKeeper.GetSupply(ctx, "unibi")
  if tc.expectedErr != nil {
      require.EqualError(t, err, tc.expectedErr.Error())
      require.Equal(t, tc.mintCoin.Amount, supply.Amount)
  } else {
      require.NoError(t, err)
      require.Equal(t, sdk.ZeroInt(), supply.Amount)
  }

---

Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.

Suggested change

	// mint and send money to the sender
	require.NoError(t,
	nibiruApp.BankKeeper.MintCoins(
	ctx, types.ModuleName, sdk.NewCoins(tc.burnCoin)))
	ctx, types.ModuleName, sdk.NewCoins(tc.mintCoin)))
	require.NoError(t,
	nibiruApp.BankKeeper.SendCoinsFromModuleToAccount(
	ctx, types.ModuleName, tc.sender, sdk.NewCoins(tc.burnCoin)),
	ctx, types.ModuleName, tc.sender, sdk.NewCoins(tc.mintCoin)),
	)
	supply := nibiruApp.BankKeeper.GetSupply(ctx, "unibi")
	require.Equal(t, tc.mintCoin.Amount, supply.Amount)
	// Burn coins
	err := nibiruApp.InflationKeeper.Burn(ctx, sdk.NewCoins(tc.burnCoin), tc.sender)
	supply = nibiruApp.BankKeeper.GetSupply(ctx, "unibi")
	if tc.expectedErr != nil {
	require.EqualError(t, err, tc.expectedErr.Error())
	require.Equal(t, tc.mintCoin.Amount, supply.Amount)
	} else {
	require.NoError(t, err)
	require.Equal(t, sdk.ZeroInt(), supply.Amount)
	// Mint coins and send them to the sender's account
	require.NoError(t,
	nibiruApp.BankKeeper.MintCoins(
	ctx, types.ModuleName, sdk.NewCoins(tc.mintCoin)))
	require.NoError(t,
	nibiruApp.BankKeeper.SendCoinsFromModuleToAccount(
	ctx, types.ModuleName, tc.sender, sdk.NewCoins(tc.mintCoin)),
	)
	// Verify the supply matches the minted amount
	supply := nibiruApp.BankKeeper.GetSupply(ctx, "unibi")
	require.Equal(t, tc.mintCoin.Amount, supply.Amount)
	// Attempt to burn coins and verify the outcome
	err := nibiruApp.InflationKeeper.Burn(ctx, sdk.NewCoins(tc.burnCoin), tc.sender)
	supply = nibiruApp.BankKeeper.GetSupply(ctx, "unibi")
	if tc.expectedErr != nil {
	require.EqualError(t, err, tc.expectedErr.Error())
	require.Equal(t, tc.mintCoin.Amount, supply.Amount)
	} else {
	require.NoError(t, err)
	require.Equal(t, sdk.ZeroInt(), supply.Amount)