Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore: cleanup baseapp tests #14162

Merged
merged 18 commits into from
Dec 6, 2022
Merged

chore: cleanup baseapp tests #14162

merged 18 commits into from
Dec 6, 2022

Conversation

alexanderbez
Copy link
Contributor

@alexanderbez alexanderbez commented Dec 5, 2022 •
edited
Loading

Description

BaseApp is arguably one of the most important components of the SDK. The tests within this package:

  • Are pretty disorganized and pretty difficult to follow
  • Exist within files that are misnomers
  • Have mixed usage of suites/testing setup

Changelog

This PR cleans up the organization and lints so the tests are easier to follow.

  • Moves all ABCI related tests to abci_test.go
  • Moves all baseapp (non explicit ABCI tests) to baseapp_test.go
  • Moves utility stuff for testing to utils_test.go
  • Consolidates test setup

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
  • added ! to 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
  • followed the guidelines for building modules
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • included comments for documenting Go code
  • updated the relevant documentation 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 ! in the type prefix if API or client breaking change
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic
  • reviewed API design and naming
  • reviewed documentation is accurate
  • reviewed tests and test coverage
  • manually tested (if applicable)

@alexanderbez alexanderbez marked this pull request as ready for review December 5, 2022 20:04
@alexanderbez alexanderbez requested a review from a team as a code owner December 5, 2022 20:04
@alexanderbez alexanderbez enabled auto-merge (squash) December 5, 2022 20:06
@julienrbrt julienrbrt added the backport/v0.47.x PR scheduled for inclusion in the v0.47's next stable release label Dec 5, 2022
github-advanced-security[bot]
github-advanced-security bot found potential problems Dec 5, 2022
View reviewed changes
baseapp/abci.go
@@ -173,7 +173,7 @@

// add block gas meter
var gasMeter sdk.GasMeter
if maxGas := app.getMaximumBlockGas(app.deliverState.ctx); maxGas > 0 {
if maxGas := app.GetMaximumBlockGas(app.deliverState.ctx); maxGas > 0 {

Check warning

Code scanning / CodeQL

Panic in BeginBock or EndBlock consensus methods

Possible panics in BeginBock- or EndBlock-related consensus methods could cause a chain halt
julienrbrt
julienrbrt approved these changes Dec 6, 2022
View reviewed changes
Copy link
Member

@julienrbrt julienrbrt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm. Is there a reason to have made some methods public?

@alexanderbez
Copy link
Contributor Author

lgtm. Is there a reason to have made some methods public?

Yeah, so all the base app tests are under package baseapp_test and some existing tests were under baseapp, so when everything was moved over, they needed to be made public, which is fine IMO as they're not mutative.

@julienrbrt
Copy link
Member

lgtm. Is there a reason to have made some methods public?

Yeah, so all the base app tests are under package baseapp_test and some existing tests were under baseapp, so when everything was moved over, they needed to be made public, which is fine IMO as they're not mutative.

I think we can create a _test.go file too for avoiding exporting it: like https://github.com/cosmos/cosmos-sdk/blob/main/x/gov/keeper/export_test.go. But if it's okay to have it exported then it's fine 👍🏾

@sonarqubecloud
Copy link

sonarqubecloud bot commented Dec 6, 2022

[Cosmos SDK] SonarCloud Quality Gate failed.    Quality Gate failed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

66.7% 66.7% Coverage
0.0% 0.0% Duplication

@alexanderbez alexanderbez merged commit 66dd2be into main Dec 6, 2022
@alexanderbez alexanderbez deleted the bez/baseapp-tests-refactor branch December 6, 2022 16:52
@mergify mergify bot mentioned this pull request Dec 6, 2022
Merged
mergify bot pushed a commit that referenced this pull request Dec 6, 2022
@alexanderbez @mergify
chore: cleanup baseapp tests (#14162)
74b306d 
(cherry picked from commit 66dd2be)

# Conflicts:
#	baseapp/abci_test.go
#	baseapp/deliver_tx_test.go
alexanderbez pushed a commit that referenced this pull request Dec 6, 2022
@mergify
chore: cleanup baseapp tests (backport #14162) (#14180)
c61cf09
@alexanderbez alexanderbez mentioned this pull request Dec 13, 2022
Merged
@0xstepit 0xstepit mentioned this pull request Jul 1, 2024
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@julienrbrt julienrbrt julienrbrt approved these changes

Assignees
No one assigned
Labels
backport/v0.47.x PR scheduled for inclusion in the v0.47's next stable release C:x/authz
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@alexanderbez @julienrbrt @tac0turtle