test: standardize test function names across codebase #504
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
MukulKolpe
requested review from
bidzyyys,
qalisander and
0xNeshi
as code owners
✅ Deploy Preview for contracts-stylus canceled.
|
bidzyyys
reviewed
Jan 22, 2025
There was a problem hiding this comment.
Great job @MukulKolpe but you have some name collisions both in motsu and E2E tests. Please fix it 🙏
Please check failed CI jobs:
0xNeshi
reviewed
Jan 22, 2025
| @@ -412,26 +412,26 @@ mod tests { | |||
| } | |||
|
|
|||
| #[motsu::test] | |||
| fn default_role_is_default_admin(contract: AccessControl) { | |||
| fn default_admin_role_success(contract: AccessControl) { | |||
There was a problem hiding this comment.
Suggested change
| fn default_admin_role_success(contract: AccessControl) { | |
| fn get_role_admin_returns_default_admin_for_regular_role( | |
| contract: AccessControl, | |
| ) { |
Don't forget the requirements:
function_name_descriptionfor successful tests.
function_name is the name of the function that is being tested, and this should apply to getters as well.
Double check that all the other test names follow this convention.
| let role_admin = contract.get_role_admin(ROLE.into()); | ||
| assert_eq!(role_admin, AccessControl::DEFAULT_ADMIN_ROLE); | ||
| } | ||
|
|
||
| #[motsu::test] | ||
| fn default_admin_roles_admin_is_itself(contract: AccessControl) { | ||
| fn default_admin_role_admin_success(contract: AccessControl) { |
There was a problem hiding this comment.
Suggested change
| fn default_admin_role_admin_success(contract: AccessControl) { | |
| fn get_role_admin_returns_default_admin_for_default_admin_role( | |
| contract: AccessControl, | |
| ) { |
| @@ -522,7 +522,7 @@ mod tests { | |||
| } | |||
|
|
|||
| #[motsu::test] | |||
| fn the_new_admin_can_grant_roles(contract: AccessControl) { | |||
| fn role_admin_change_success_with_new_grant(contract: AccessControl) { | |||
There was a problem hiding this comment.
Suggested change
| fn role_admin_change_success_with_new_grant(contract: AccessControl) { | |
| fn grant_role_succeeds_when_called_by_new_admin(contract: AccessControl) { |
grant_roleis actually being tested here- related to the comment above, make sure that all test case names follow the expected convention
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR standardizes test function names across the codebase following a consistent pattern:
function_name_descriptionfor successful tests.function_name_revert_when_conditionfor tests expecting a revert.Resolves #491
PR Checklist