test(server/v2/cometbft): Add abci unit tests #21020

hieuvubk · 2024-07-22T11:34:28Z

Description

Closes: #20484

Create MockStore, NewMockReaderMap without prune & snapshot options
Add test for all func in abci.go
Proposal test failing block on: refactor(server/v2): Update prepare & process proposal #21237

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, you can find examples of the prefixes below:
confirmed ! in the type prefix if API or client breaking change
targeted the correct branch (see PR Targeting)
provided a link to the relevant issue or specification
reviewed "Files changed" and left comments if necessary
included the necessary unit and integration tests
added a changelog entry to CHANGELOG.md
updated the relevant documentation or specification, including comments for documenting Go code
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.

Please see Pull Request Reviewer section in the contributing guide for more information on how to review a pull request.

I have...

confirmed the correct type prefix in the PR title
confirmed all author checklist items have been addressed
reviewed state machine logic, API design and naming, documentation is accurate, tests and test coverage

Summary by CodeRabbit

New Features
- Introduced a comprehensive suite of unit tests for the ABCI functionalities of the CometBFT consensus engine, covering initialization, block finalization, transaction checking, proposal handling, and vote extensions.
- Added a mock implementation for controlled read access to the RootStore, enhancing testing and version management capabilities.
- Implemented a mock storage system for testing interactions with a versioned database.
Bug Fixes
- Enhanced the robustness of consensus logic through thorough testing, ensuring correct behavior in various edge cases.
Chores
- Updated module dependencies for improved structure and functionality, including the addition of a new testing framework.

coderabbitai · 2024-07-22T11:34:34Z

Walkthrough

The changes include the addition of unit tests for the CometBFT framework, specifically targeting the ABCI functionality. New mock implementations for storage, reader, and mempool interfaces are introduced to facilitate testing. Updates are also made to the dependency management in the go.mod files, enhancing the structure and testing capabilities of the CometBFT components for comprehensive functionality coverage.

Changes

Files	Change Summary
`server/v2/cometbft/abci_test.go`	Introduced unit tests for ABCI functionality, covering consensus mechanisms, transaction handling, and state management. Implemented helper functions for streamlined testing.
`server/v2/cometbft/go.mod`	Added module replacements and a new dependency for `cosmossdk.io/server/v2/stf`. Updated and removed the requirement for `github.com/stretchr/testify`.
`simapp/v2/go.mod`	Updated the dependency version for `cosmossdk.io/server/v2/stf` to a specific version.
`server/v2/cometbft/internal/mock/mock_reader.go`	Defined a mock read-only interface for accessing data from a RootStore. Introduced `ReaderMap` and `MockReader` for structured read operations.
`server/v2/cometbft/internal/mock/mock_store.go`	Implemented a mock storage system for testing, simulating database operations with version control and commit management features.
`server/v2/cometbft/internal/mock/mock_mempool.go`	Created a mock mempool interface for testing, allowing for the simulation of transaction handling without a real mempool implementation.

Assessment against linked issues

Objective	Addressed	Explanation
server/v2/cometbft needs unit tests with mocks (20484)	✅

Possibly related PRs

fix(stf/branch/memiter): Fix Iter validity #21556: The changes in this PR involve modifications to iterator methods in the changeset struct, which may relate to the testing framework introduced in the main PR, as both involve aspects of state management and iteration within the CometBFT framework.
refactor(core): re-add handlers #21575: This PR enhances the message handling system in the appmodulev2 package, which could be relevant to the testing of transaction handling in the main PR, as both involve the processing of messages and transactions within the consensus engine.

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 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 using 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.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

server/v2/cometbft/mock/mock_store.go

julienrbrt · 2024-07-22T12:33:53Z

server/v2/stf/helper.go

imho we shouldn't expose those APIs. We wouldn't want anyone to use this (even if we say it is for test only).

that hard, need someway to access to state inside 😅

coderabbitai

Actionable comments posted: 0

Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 667c1e2 and 5578d48.

Files selected for processing (2)

server/v2/cometbft/go.mod (6 hunks)
simapp/v2/go.mod (1 hunks)

Files skipped from review due to trivial changes (1)

simapp/v2/go.mod

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

server/v2/cometbft/go.mod

…into hieu/comet_mock

coderabbitai

Actionable comments posted: 0

Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 5578d48 and f5325d9.

Files selected for processing (1)

server/v2/cometbft/abci_test.go (1 hunks)

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

server/v2/cometbft/abci_test.go

julienrbrt

Nice work!!

coderabbitai

Actionable comments posted: 0

Review details

Configuration used: .coderabbit.yml
Review profile: CHILL

Commits

Files that changed from the base of the PR and between f5325d9 and 96d6f5b.

Files selected for processing (1)

server/v2/cometbft/abci_test.go (1 hunks)

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

server/v2/cometbft/abci_test.go

Co-authored-by: Julien Robert <julien@rbrt.fr> (cherry picked from commit ac53e33) # Conflicts: # server/v2/cometbft/go.mod # server/v2/stf/mock/tx.go # simapp/v2/go.mod

Co-authored-by: Hieu Vu <72878483+hieuvubk@users.noreply.github.com> Co-authored-by: Julien Robert <julien@rbrt.fr>

hieuvubk added 7 commits July 11, 2024 17:25

coding

f294fff

fixing

cbd05ce

go mod tidy all

587023f

remove fmt

116e283

helpers

462efb0

mock store

b17533e

add some tests

2375aa7

github-actions bot added C:Store C:server/v2 C:server/v2 stf C:server/v2 cometbft labels Jul 22, 2024

hieuvubk changed the title ~~Hieu/comet mock~~ test(server/v2/cometbft): Add abci unit tests Jul 22, 2024

github-advanced-security bot found potential problems Jul 22, 2024

View reviewed changes

server/v2/cometbft/mock/mock_store.go Fixed Show fixed Hide fixed

server/v2/cometbft/mock/mock_store.go Fixed Show fixed Hide fixed

julienrbrt reviewed Jul 22, 2024

View reviewed changes

tac0turtle removed the C:server/v2 label Jul 30, 2024

hieuvubk added 3 commits August 5, 2024 16:17

testing

44548be

Merge branch 'main' into hieu/comet_mock

eede22f

test InitChain & FinalizeBlock

d008afd

github-actions bot added C:server/v2 Issues related to server/v2 C:server/v2 appmanager labels Aug 6, 2024

hieuvubk added 8 commits August 7, 2024 16:48

extend vote

9d604c9

vote

d4866d9

merge main

9bfe6fe

check tx & prepare proposal

07f4fa3

process proposal

ee055b8

mock mempool

35787e2

merge main

71c4570

clean up

7bf135c

github-actions bot removed the C:server/v2 appmanager label Aug 14, 2024

julienrbrt added the backport/v0.52.x PR scheduled for inclusion in the v0.52's next stable release label Sep 9, 2024

coderabbitai bot reviewed Sep 9, 2024

View reviewed changes

julienrbrt and others added 3 commits September 9, 2024 11:10

Merge branch 'main' into hieu/comet_mock

0add40f

update max block gas

f4e1fa4

Merge branch 'hieu/comet_mock' of https://github.com/cosmos/cosmos-sdk …

f5325d9

…into hieu/comet_mock

coderabbitai bot reviewed Sep 9, 2024

View reviewed changes

update

12be6e4

julienrbrt approved these changes Sep 9, 2024

View reviewed changes

Merge branch 'main' into hieu/comet_mock

96d6f5b

julienrbrt enabled auto-merge September 9, 2024 10:00

coderabbitai bot reviewed Sep 9, 2024

View reviewed changes

Merge branch 'main' into hieu/comet_mock

8f7c343

julienrbrt added this pull request to the merge queue Sep 9, 2024

Merged via the queue into main with commit ac53e33 Sep 9, 2024
71 of 72 checks passed

julienrbrt deleted the hieu/comet_mock branch September 9, 2024 10:38

mergify bot mentioned this pull request Sep 9, 2024

test(server/v2/cometbft): Add abci unit tests (backport #21020) #21605

Merged

12 tasks

julienrbrt added a commit that referenced this pull request Sep 9, 2024

test(server/v2/cometbft): Add abci unit tests (backport #21020) (#21605)

0eb9540

Co-authored-by: Hieu Vu <72878483+hieuvubk@users.noreply.github.com> Co-authored-by: Julien Robert <julien@rbrt.fr>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

test(server/v2/cometbft): Add abci unit tests #21020

test(server/v2/cometbft): Add abci unit tests #21020

hieuvubk commented Jul 22, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jul 22, 2024 •

edited

Loading

Walkthrough

Changes

Assessment against linked issues

Possibly related PRs

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

julienrbrt Jul 22, 2024

hieuvubk Jul 23, 2024

coderabbitai bot left a comment

coderabbitai bot left a comment

julienrbrt left a comment

coderabbitai bot left a comment

test(server/v2/cometbft): Add abci unit tests #21020

test(server/v2/cometbft): Add abci unit tests #21020

Conversation

hieuvubk commented Jul 22, 2024 • edited by coderabbitai bot Loading

Description

Author Checklist

Reviewers Checklist

Summary by CodeRabbit

coderabbitai bot commented Jul 22, 2024 • edited Loading

Walkthrough

Changes

Assessment against linked issues

Possibly related PRs

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

Documentation and Community

julienrbrt Jul 22, 2024

Choose a reason for hiding this comment

hieuvubk Jul 23, 2024

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

julienrbrt left a comment

Choose a reason for hiding this comment

coderabbitai bot left a comment

Choose a reason for hiding this comment

hieuvubk commented Jul 22, 2024 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jul 22, 2024 •

edited

Loading