test: standardize test function names across codebase by Ifechukwudaniel · Pull Request #731 · OpenZeppelin/rust-contracts-stylus

Ifechukwudaniel · 2025-07-09T15:24:24Z

This PR standardizes test function names across the codebase to follow a consistent naming pattern:

function_name_description for successful cases
function_name_revert_when_condition for expected reverts

This improves clarity, consistency and makes it easier to understand the purpose of each test at a glance.

Closes: 491

Checklist:

Tests updated or renamed as needed
Documentation (N/A)
Changelog updated

netlify · 2025-07-09T15:24:30Z

✅ Deploy Preview for contracts-stylus canceled.

Name	Link
🔨 Latest commit	`5f67019`
🔍 Latest deploy log	https://app.netlify.com/projects/contracts-stylus/deploys/68c88a8faaae9100087be283

Ifechukwudaniel · 2025-07-11T13:58:27Z

@0xNeshi , @bidzyyys , @qalisander

Ifechukwudaniel · 2025-07-14T21:54:32Z

@0xNeshi, can you please review this so I can do the next one

0xNeshi · 2025-07-15T08:34:04Z

Hey @Ifechukwudaniel , appreciate the enthusiasm! We're currently under a huge workload, and will review the PR as soon as it is reduced. Thanks!

0xNeshi

Good job. Left some comments.

0xNeshi

Please resolve merge conflicts

0xNeshi · 2025-08-08T09:24:42Z

@@ -544,7 +548,7 @@ async fn error_invalid_array_length_in_batch_mint(
 }


Change errors_when_invalid_receiver_contract_in_batch_mint to mint_batch_reverts_when_receiver_invalid

0xNeshi · 2025-08-08T09:25:10Z

@@ -544,7 +548,7 @@ async fn error_invalid_array_length_in_batch_mint(
 }



Change error_invalid_array_length_in_batch_mint to mint_batch_reverts_when_array_length_invalid

qalisander

Good work!

I see the second part of convention function_name_revert_when_condition is not applicable for crypto library. Namely revert_when syntax relates to smart contracts domain only.

qalisander · 2025-08-09T08:01:52Z


    #[test]
-    fn add() {
+    fn add_succeeds_for_field_elements() {


These two test cases have an inconsistent description: "succeeds_for_field_elements" and "succeeds_with_expected_value" but test cases are quite similar.

@0xNeshi is "description" mandatory in our convention for successful tests? (function_name_description).
Can't we leave it as "" here??xD

I'm ok with leaving just add for simple test cases OR ones that test the same function from multiple vectors

Ifechukwudaniel · 2025-08-16T20:34:39Z

On it, i will complete it

Co-authored-by: Nenad <nenad.misic@openzeppelin.com>

chore: control test names

1810acb

Ifechukwudaniel requested review from 0xNeshi, bidzyyys and qalisander as code owners July 9, 2025 15:24

Ifechukwudaniel marked this pull request as draft July 9, 2025 15:24

Ifechukwudaniel added 7 commits July 9, 2025 18:09

chore: owners test renamed

e625615

chore: code format

61c48c5

chore: vesting and erc1155

f5a8242

chore: renamed tests

c3e7115

chore: fixed more test names

038508c

chore: renamed test in crypto lib

786ede3

Merge branch 'main' into test-names

2ee5493

Ifechukwudaniel marked this pull request as ready for review July 11, 2025 13:52

Ifechukwudaniel marked this pull request as draft July 11, 2025 15:42

Ifechukwudaniel added 4 commits July 11, 2025 15:43

chore: control , ecdsa, erc20 test names

c82e524

chore: flash mint

5ee29ea

chore:safe test and vesting

ba93906

chore: testname changes

1d7e41d

Ifechukwudaniel marked this pull request as ready for review July 12, 2025 14:39

Ifechukwudaniel added 4 commits July 12, 2025 15:27

chore: fixed test

c5f996a

chore: fixes

c41bca0

chore: fmt

7d1ffa5

chore: erc20-permit

ef16231

0xNeshi mentioned this pull request Jul 14, 2025

[Wizard]: Add Erc4626 template #561

Open

1 task

0xNeshi reviewed Aug 7, 2025

View reviewed changes

0xNeshi reviewed Aug 8, 2025

View reviewed changes

Comment thread examples/access-control/tests/access_control.rs Outdated

Comment thread examples/access-control/tests/access_control.rs Outdated

Comment thread examples/access-control/tests/access_control.rs Outdated

Comment thread examples/access-control/tests/access_control.rs Outdated

0xNeshi reviewed Aug 8, 2025

View reviewed changes

Merge branch 'main' into test-names

9969136

qalisander reviewed Aug 9, 2025

View reviewed changes

Ifechukwudaniel and others added 23 commits August 20, 2025 19:31

Update contracts/src/access/ownable.rs

082c279

Co-authored-by: Nenad <nenad.misic@openzeppelin.com>

Merge branch 'main' into test-names

5e835f2

Update examples/erc1155/tests/erc1155.rs

ad36e94

Co-authored-by: Nenad <nenad.misic@openzeppelin.com>

Update contracts/src/token/erc20/extensions/flash_mint.rs

d083fcb

Co-authored-by: Nenad <nenad.misic@openzeppelin.com>

Update examples/erc1155/tests/erc1155.rs

ecf8c5c

Co-authored-by: Nenad <nenad.misic@openzeppelin.com>

Update contracts/src/token/erc20/extensions/capped.rs

4c86d6e

Co-authored-by: Nenad <nenad.misic@openzeppelin.com>

Update examples/access-control/tests/access_control.rs

53bc2bb

Co-authored-by: Nenad <nenad.misic@openzeppelin.com>

Update contracts/src/access/ownable_two_step.rs

683ddd8

Co-authored-by: Nenad <nenad.misic@openzeppelin.com>

Update examples/access-control/tests/access_control.rs

c35f9c0

Co-authored-by: Nenad <nenad.misic@openzeppelin.com>

Update contracts/src/token/erc721/extensions/consecutive.rs

92e0c83

Co-authored-by: Nenad <nenad.misic@openzeppelin.com>

chore: code format

3b59973

Update examples/access-control/tests/access_control.rs

ef45964

Co-authored-by: Nenad <nenad.misic@openzeppelin.com>

Update examples/access-control/tests/access_control.rs

5208b09

Co-authored-by: Nenad <nenad.misic@openzeppelin.com>

chore: format

a2eefc3

chore: fixes

66fb548

chore: fixes

01fb0c2

chore: remove interface_id test in this file. It's not useful

604b1b3

chore:format

b3ac34c

chore: removed _transfer_ownership_updates_owner_storage testcase

c32fbe2

Merge branch 'main' into test-names

fff060c

chore: erc1155 or erc20

4835bf4

chore: burnable and erc1155

597708b

Merge branch 'main' into test-names

5f67019

		@@ -544,7 +548,7 @@ async fn error_invalid_array_length_in_batch_mint(
		}

Conversation

Ifechukwudaniel commented Jul 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

netlify Bot commented Jul 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for contracts-stylus canceled.

Uh oh!

Ifechukwudaniel commented Jul 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Ifechukwudaniel commented Jul 14, 2025

Uh oh!

0xNeshi commented Jul 15, 2025

Uh oh!

0xNeshi left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

0xNeshi left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

0xNeshi Aug 8, 2025

Choose a reason for hiding this comment

Uh oh!

0xNeshi Aug 8, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

qalisander left a comment

Choose a reason for hiding this comment

Uh oh!

qalisander Aug 9, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

0xNeshi Aug 11, 2025

Choose a reason for hiding this comment

Uh oh!

Ifechukwudaniel commented Aug 16, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Ifechukwudaniel commented Jul 9, 2025 •

edited

Loading

netlify Bot commented Jul 9, 2025 •

edited

Loading

Ifechukwudaniel commented Jul 11, 2025 •

edited

Loading

qalisander Aug 9, 2025 •

edited

Loading