test: Add an e2e test that reproduces the chain halt

p-offtermatt commented 4 months ago

Description

Closes: #XXXX

The test case uses the default config, except it sets the MaxValidators to 2.

Run the test locally by running

go run ./tests/e2e/... --tc active-set-changes

These are the steps to reproduce the chain halt:

Start the provider chain and a consumer
Jail an active set validator. This will a) take that validator outside of the active set and b) put an inactive validator into the active set. This step will cause a chain halt.

The chain halt will make the test time out. You can look at the provider nodes logs by running

docker exec interchain-security-instance cat provi/validatoralice/logs

and they should include this:

CONSENSUS FAILURE!!! err="more validators than maxValidators found"

Author Checklist

All items are required. Please add a note to the item if the item is not applicable and please add links to any relevant follow up issues.

I have...

[ ] Included the correct type prefix in the PR title
[ ] Targeted the correct branch (see PR Targeting)
[ ] Provided a link to the relevant issue or specification
[ ] Reviewed "Files changed" and left comments if necessary
[ ] Confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add your handle next to the items reviewed if you only reviewed selected items.

I have...

[ ] Confirmed the correct type prefix in the PR title
[ ] Confirmed all author checklist items have been addressed
[ ] Confirmed that this PR does not change production code

Summary by CodeRabbit

New Features
- Introduced a new test configuration for scenarios with a small number of maximum validators.
- Added a new E2E test for active set changes to ensure protocol stability.
Chores
- Added a nightly E2E test job for active set changes in the CI workflow.

coderabbitai[bot] commented 4 months ago

Walkthrough

## Walkthrough The changes introduce a new test configuration type `SmallMaxValidatorsTestCfg` to ensure the protocol functions correctly when the number of validators exceeds the maximum allowed. This includes adding the "active-set-changes" test case and corresponding steps, integrating this test into the nightly E2E workflow, and creating a specific Go function to handle the active set changes. ## Changes | File(s) | Change Summary | |-----------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------| | `tests/e2e/config.go` | Introduced `SmallMaxValidatorsTestCfg` configuration type and `SmallMaxValidatorsTestConfig()` function for setting specific test settings. | | `tests/e2e/main.go` | Added "active-set-changes" to `stepChoices` map and included "too-many-validators" in the list of predefined tests. | | `tests/e2e/steps_active_set_changes.go` | Added `stepsActiveSetChanges` function to set up and test active set changes. | | `.github/workflows/nightly-e2e.yml` | Added `active-set-changes-test` job to run E2E tests for active set changes using Go version 1.21. | ## Sequence Diagram(s) ```mermaid sequenceDiagram participant Developer participant GitHub Actions participant E2E Test Suite participant Provider Chain participant Validators Developer->>GitHub Actions: Push code changes GitHub Actions->>E2E Test Suite: Trigger nightly-e2e.yml workflow E2E Test Suite->>Provider Chain: Setup provider chain for active set changes E2E Test Suite->>Validators: Apply SmallMaxValidatorsTestCfg Validators->>E2E Test Suite: Execute active set change tests E2E Test Suite->>GitHub Actions: Report test results GitHub Actions->>Developer: Notify test results ```

Recent review details

**Configuration used: .coderabbit.yml** **Review profile: CHILL**

Commits

Files that changed from the base of the PR and between 00555efb19f4adc5ebf536a9a21f45c56866713b and 641e143ec5f270a0cc4e4ff52cd4aa81203d54a6.

Files selected for processing (2)

* .github/workflows/nightly-e2e.yml (2 hunks) * tests/e2e/main.go (2 hunks)

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

* tests/e2e/main.go

Additional comments not posted (2)

.github/workflows/nightly-e2e.yml (2)
`296-311`: The configuration for the `active-set-changes-test` job is consistent with other test jobs in terms of Go version and setup steps. --- `331-332`: Correctly added `active-set-changes-test` to the dependency list for the `nightly-test-fail` job.

--- 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](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code 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 testing code 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 testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` 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 an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@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. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - 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/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

insumity commented 3 months ago

Does it make sense to also add this test in the nightly tests?

p-offtermatt commented 3 months ago

Ah, great idea! I was thinking it's probably not right to run it on every commit, but nightly seems good

sainoe commented 3 months ago

LGTM. Great work!

cosmos / interchain-security