tests: add test for ReceiveEnabled set to false #6054

bznein · 2024-03-22T16:19:12Z

Description

Adds a test for ReceiveEnabled set to false

closes: #1913

Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.

Summary by CodeRabbit

Tests
- Added new test cases in the transfer module to simulate scenarios with receiving disabled, ensuring robust handling of control flow based on the ReceiveEnabled parameter.

coderabbitai · 2024-03-22T16:19:18Z

Walkthrough

The recent update introduces two additional test cases within the TestOnRecvPacket function of the KeeperTestSuite module, specifically targeting scenarios where IBC transfers are disabled. These tests are designed to validate the module's behavior when the ReceiveEnabled flag is set to false, ensuring that transfers are correctly halted and that the system reacts as expected under these constrained conditions.

Changes

File Path	Change Summary
`.../transfer/keeper/relay_test.go`	Added two test cases in `TestOnRecvPacket` for scenarios with `ReceiveEnabled` set to false.

Assessment against linked issues

Objective	Addressed	Explanation
Add test cases for `apps/transfer` failing with sends/receives disabled (#1913)	✅
Migrate unit tests to use entrypoints for methods on light client module to improve code coverage (#6001)	❌	The changes are specific to the `apps/transfer` module and do not directly relate to light clients.
Add e2e test coverage for relay after IBC genesis restart upgrade, including client updates (#3476)	❌	The update focuses on testing the `ReceiveEnabled` flag within the transfer module.
Align testing package behavior with expected ABCI handler flow through refactoring and new functions (#3997)	❌	Changes are confined to adding test cases and do not involve ABCI handler flow adjustments.

Related issues

Move client state testing to light client module entry points #6001: Although this PR does not directly address the migration of unit tests for light client modules, it demonstrates an ongoing effort to improve test coverage, which is in line with the objective of enhancing code quality and reliability.
Add performABCIHandler to testing pkg to replace internal logic of SendMsgs/NextBlock #3997: While the PR does not tackle the issue of aligning testing package behavior with the expected ABCI handler flow, it contributes to the broader goal of ensuring the robustness and correctness of the testing framework within the IBC module.

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

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.

bznein · 2024-03-22T16:19:49Z

modules/apps/transfer/keeper/relay_test.go

+			}, false, false,
+		},
+		{
+			"failure: receive is disabled - chainB is source",


I'm not familiar enough with the codebase to know if this case is needed. Happy to delete it in case it is not :)

I think it's not strictly necessary but should do no harm in including it!

I think I would remove just to keep it the test tight and clean, but will not fight over it. :)

I removed it :) I was a bit on the verge, not being familiar enough with the codebase.

coderabbitai

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yml

Commits

Files that changed from the base of the PR and between 5514d56 and bd7ce46.

Files selected for processing (1)

modules/apps/transfer/keeper/relay_test.go (1 hunks)

Additional comments: 1

modules/apps/transfer/keeper/relay_test.go (1)

340-358: The addition of test cases to verify the behavior when ReceiveEnabled is set to false is a valuable enhancement to the test suite. It's crucial to ensure that the system behaves as expected under these conditions, aligning with the operational requirements outlined in the linked issue Add tests cases for disabled IBC transfers #1913. These tests effectively simulate scenarios where receiving IBC transfers is disabled, contributing significantly to the robustness of the test suite.

However, it's important to also verify the state of the system after the test execution, especially for the second test case where expEscrowAmount is set despite receiving being disabled. Ensure that the system's state aligns with expectations, such as checking if the escrow amount remains unchanged or if any other state variables are affected by the disabled receive functionality.

chatton

LGTM! Thanks @bznein ❤️

chatton · 2024-03-25T08:45:44Z

modules/apps/transfer/keeper/relay_test.go

+			}, false, false,
+		},
+		{
+			"failure: receive is disabled - chainB is source",


I think it's not strictly necessary but should do no harm in including it!

crodriguezvega

Thanks, @bznein!

crodriguezvega · 2024-03-25T10:41:53Z

modules/apps/transfer/keeper/relay_test.go

+			}, false, false,
+		},
+		{
+			"failure: receive is disabled - chainB is source",


I think I would remove just to keep it the test tight and clean, but will not fight over it. :)

coderabbitai

Review Status

Actionable comments generated: 0

Configuration used: .coderabbit.yml

Commits

Files that changed from the base of the PR and between bd7ce46 and d3daaa5.

Files selected for processing (1)

modules/apps/transfer/keeper/relay_test.go (1 hunks)

Files skipped from review as they are similar to previous changes (1)

modules/apps/transfer/keeper/relay_test.go

bznein added 6 commits March 19, 2024 07:09

Add test case for ReceiveEneabled set to false

321d9d5

Merge branch 'cosmos:main' into main

71f48a7

Added test for case recvIsSource=true

7cde40f

Add escrowAmount to chainB for test with isRecvSource=true

e1dca9e

Run linter

62289b4

Changed test description

bd7ce46

bznein requested review from colin-axner, AdityaSripal, damiannolan and chatton as code owners March 22, 2024 16:19

bznein commented Mar 22, 2024

View reviewed changes

coderabbitai bot reviewed Mar 22, 2024

View reviewed changes

chatton approved these changes Mar 25, 2024

View reviewed changes

crodriguezvega approved these changes Mar 25, 2024

View reviewed changes

Removed testcase for recvIsSource=true

d3daaa5

coderabbitai bot reviewed Mar 25, 2024

View reviewed changes

chatton merged commit 572d8e8 into cosmos:main Mar 25, 2024
72 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

tests: add test for ReceiveEnabled set to false #6054

tests: add test for ReceiveEnabled set to false #6054

bznein commented Mar 22, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Mar 22, 2024 •

edited

Loading

Walkthrough

Changes

Assessment against linked issues

Related issues

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

CodeRabbit Discord Community

bznein Mar 22, 2024

chatton Mar 25, 2024

crodriguezvega Mar 25, 2024

bznein Mar 25, 2024

coderabbitai bot left a comment

chatton left a comment

chatton Mar 25, 2024

crodriguezvega left a comment

crodriguezvega Mar 25, 2024

coderabbitai bot left a comment

tests: add test for ReceiveEnabled set to false #6054

tests: add test for ReceiveEnabled set to false #6054

Conversation

bznein commented Mar 22, 2024 • edited by coderabbitai bot Loading

Description

Summary by CodeRabbit

Summary by CodeRabbit

coderabbitai bot commented Mar 22, 2024 • edited Loading

Walkthrough

Changes

Assessment against linked issues

Related issues

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

CodeRabbit Discord Community

bznein Mar 22, 2024

Choose a reason for hiding this comment

chatton Mar 25, 2024

Choose a reason for hiding this comment

crodriguezvega Mar 25, 2024

Choose a reason for hiding this comment

bznein Mar 25, 2024

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

chatton left a comment

Choose a reason for hiding this comment

chatton Mar 25, 2024

Choose a reason for hiding this comment

crodriguezvega left a comment

Choose a reason for hiding this comment

crodriguezvega Mar 25, 2024

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

bznein commented Mar 22, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Mar 22, 2024 •

edited

Loading

CodeRabbit Configration File (`.coderabbit.yaml`)