chore: remove baseapp and `sdk.Context` fully from x/upgrade #23396

aljo242 · 2025-01-15T16:39:31Z

Description

Closes: #XXXX

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

Release Notes

New Features
- Introduced a new testing package coretesting with enhanced test environment support.
- Improved context handling in testing infrastructure.
Refactoring
- Updated test suites to use new testing environment.
- Removed dependencies on baseapp in multiple modules.
- Streamlined context and query client initialization.
Chores
- Updated module dependencies and replace directives.
- Reorganized import statements across multiple files.
Testing
- Enhanced test coverage for upgrade, auth, and circuit modules.
- Improved test environment configuration and context management.

…p-upgrade

coderabbitai · 2025-01-15T16:39:39Z

📝 Walkthrough

Walkthrough

This pull request introduces significant changes to the Cosmos SDK testing infrastructure, focusing on creating a new coretesting package and updating various test suites across different modules. The changes primarily involve replacing baseapp dependencies with a more modular testing approach, introducing a new TestBranchService, and updating context handling in test environments. The modifications streamline testing processes and reduce dependencies on specific application implementations.

Changes

File	Change Summary
`core/testing/branch.go`	Added new `TestBranchService` with `Execute` and `ExecuteWithGasLimit` methods.
`core/testing/environment.go`	Updated `TestEnvironment` to initialize `BranchService` with `TestBranchService{}`.
`go.mod`	Added local replace directive for `cosmossdk.io/core/testing`.
`tests/integration/bank/app_test.go`	Updated test configurations and added transaction encoder/decoder setups.
`tests/integration/baseapp/block_gas_test.go`	Added transaction encoder/decoder setups for `bapp`.
`x/auth/ante/testutil_test.go`	Removed `baseapp` and simplified environment setup.
`x/auth/keeper/deterministic_test.go`	Updated imports and query helper initialization.
`x/auth/keeper/grpc_query_test.go`	Updated context handling in query tests.
`x/auth/keeper/keeper_test.go`	Refactored test suite to use new context and environment setup.
`x/auth/tx/config/depinject.go`	Removed `BaseAppOption` references and imports.
`x/circuit/go.mod`	Restructured replace directives for improved readability.
`x/upgrade/go.mod`	Updated dependency management and replace directives.
`x/upgrade/keeper/abci_test.go`	Refactored test suite with new context handling.
`x/upgrade/keeper/grpc_query_test.go`	Updated context and environment setup for queries.
`x/upgrade/keeper/keeper.go`	Clarified comments regarding `versionModifier`.
`x/upgrade/keeper/keeper_test.go`	Refactored test suite structure and initialization.

Suggested labels

C:server/v2

Suggested reviewers

julienrbrt
tac0turtle
sontrinh16
akhilkumarpilli

Possibly related PRs

chore(x/authz)!: Remove account keeper dependency #21632: Changes in the main PR introduce a new testing package and a TestBranchService struct, which may relate to the removal of the account keeper dependency in this PR, as both involve modifications to service structures and testing frameworks.
refactor(tests/integration): Port distribution integration tests to server v2 #22667: The refactoring of integration tests in this PR may relate to the new testing package introduced in the main PR, as both aim to improve the testing framework and service interactions.
chore: remove baseapp from x/accounts #23355: The removal of the baseapp from x/accounts in this PR may connect to the new testing structures in the main PR, as both involve enhancements to service management and testing capabilities.

📜 Recent review details

Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 31034f9 and b537e0a.

⛔ Files ignored due to path filters (3)

go.sum is excluded by !**/*.sum
x/circuit/go.sum is excluded by !**/*.sum
x/upgrade/go.sum is excluded by !**/*.sum

📒 Files selected for processing (3)

go.mod (1 hunks)
x/circuit/go.mod (1 hunks)
x/upgrade/go.mod (2 hunks)

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

go.mod
x/upgrade/go.mod
x/circuit/go.mod

⏰ Context from checks skipped due to timeout of 90000ms (1)

GitHub Check: Summary

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>, please review it.
- 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @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 generate docstrings to generate docstrings for this PR. (Beta)
@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.

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (4)

core/testing/branch.go (2)
18-25: Consider implementing actual gas tracking in ExecuteWithGasLimit.

The current implementation always returns the input gasLimit without tracking actual gas consumption, which might be misleading in tests that rely on accurate gas measurements.
 func (bs TestBranchService) ExecuteWithGasLimit(
 	ctx context.Context,
 	gasLimit uint64,
 	f func(ctx context.Context) error,
 ) (gasUsed uint64, err error) {
 	unwrap(ctx) // check that this is a testing context
-	return gasLimit, f(ctx)
+	err = f(ctx)
+	// Return a portion of gasLimit to simulate actual consumption
+	gasUsed = gasLimit / 2
+	return gasUsed, err
}
9-11: Add documentation for exported types and methods.

The TestBranchService type and its methods are exported but lack documentation comments. This makes it harder for other developers to understand their purpose and usage.
+// TestBranchService implements branch.Service for testing purposes.
 var _ branch.Service = &TestBranchService{}

+// TestBranchService provides a minimal implementation of branch.Service for testing.
 type TestBranchService struct{}
x/upgrade/keeper/keeper.go (1)
Line range hint 440-449: Consider adding error handling for nil versionModifier.

The code checks for nil versionModifier but doesn't handle potential errors from AppVersion() and SetAppVersion() consistently.

Consider this implementation:
 if k.versionModifier != nil {
     currentAppVersion, err := k.versionModifier.AppVersion(ctx)
     if err != nil {
         return err
     }
-
-    if err := k.versionModifier.SetAppVersion(ctx, currentAppVersion+1); err != nil {
-        return err
-    }
+    return k.versionModifier.SetAppVersion(ctx, currentAppVersion+1)
 }
x/upgrade/keeper/abci_test.go (1)
71-85: Consider adding validation in version modifier.

The mocked version modifier implementation could benefit from basic validation.

Consider adding validation:
 func (m *mockedVersionModifier) SetAppVersion(_ context.Context, u uint64) error {
+    if u < m.version {
+        return fmt.Errorf("cannot decrease version from %d to %d", m.version, u)
+    }
     m.version = u
     return nil
 }

📜 Review details

Configuration used: .coderabbit.yml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 7f827c5 and 06da05e.

⛔ Files ignored due to path filters (3)

go.sum is excluded by !**/*.sum
x/circuit/go.sum is excluded by !**/*.sum
x/upgrade/go.sum is excluded by !**/*.sum

📒 Files selected for processing (16)

core/testing/branch.go (1 hunks)
core/testing/environment.go (1 hunks)
go.mod (1 hunks)
tests/integration/bank/app_test.go (2 hunks)
tests/integration/baseapp/block_gas_test.go (1 hunks)
x/auth/ante/testutil_test.go (1 hunks)
x/auth/keeper/deterministic_test.go (3 hunks)
x/auth/keeper/grpc_query_test.go (2 hunks)
x/auth/keeper/keeper_test.go (5 hunks)
x/auth/tx/config/depinject.go (0 hunks)
x/circuit/go.mod (1 hunks)
x/upgrade/go.mod (2 hunks)
x/upgrade/keeper/abci_test.go (16 hunks)
x/upgrade/keeper/grpc_query_test.go (5 hunks)
x/upgrade/keeper/keeper.go (3 hunks)
x/upgrade/keeper/keeper_test.go (7 hunks)

💤 Files with no reviewable changes (1)

x/auth/tx/config/depinject.go

✅ Files skipped from review due to trivial changes (2)

x/auth/keeper/grpc_query_test.go
x/circuit/go.mod

🧰 Additional context used

📓 Path-based instructions (11)

x/auth/ante/testutil_test.go (2)