ref: Add/Sub Assignment Operations + e2e-tests.sh #467

0xNeshi · 2024-12-26T10:03:16Z

Resolves #445, Resolves #444

PR Checklist

Tests
Documentation
Changelog

…internally

netlify · 2024-12-26T10:03:36Z

✅ Deploy Preview for contracts-stylus canceled.

Name	Link
🔨 Latest commit	`c5c7be5`
🔍 Latest deploy log	https://app.netlify.com/sites/contracts-stylus/deploys/6773bc6601658c0008e64e64

contracts/src/utils/nonces.rs

codecov · 2024-12-26T10:07:48Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.6%. Comparing base (3205fc7) to head (c5c7be5).

Additional details and impacted files

Files with missing lines	Coverage Δ
contracts/src/access/control.rs	`98.5% <ø> (ø)`
contracts/src/access/ownable.rs	`94.1% <ø> (ø)`
contracts/src/access/ownable_two_step.rs	`99.2% <ø> (ø)`
contracts/src/finance/vesting_wallet.rs	`55.6% <ø> (ø)`
...racts/src/token/erc1155/extensions/metadata_uri.rs	`78.5% <ø> (ø)`
contracts/src/token/erc1155/extensions/supply.rs	`81.1% <ø> (ø)`
...tracts/src/token/erc1155/extensions/uri_storage.rs	`98.2% <ø> (ø)`
contracts/src/token/erc1155/mod.rs	`96.9% <ø> (ø)`
contracts/src/token/erc20/extensions/capped.rs	`83.3% <ø> (ø)`
contracts/src/token/erc20/extensions/metadata.rs	`22.2% <ø> (ø)`
... and 12 more

0xNeshi · 2024-12-26T19:35:07Z

scripts/e2e-tests.sh

+    cargo test --features std,e2e --test "*"
+else
+    cargo test --features std,e2e "$@"
+fi


The script can now be called in the following ways:

if no arguments are passed, the behavior is the same as before

otherwise, pass whatever arguments are present to cargo test directly

We can now easily filter for even unit tests with this script.

This should cover most of our testing needs.

NOTE: feel free to suggest or add any additional feature you think might be useful.
NOTE 2: we don't seem to be needing std feature for e2e tests.

Another option is to omit the if-statement, and just call cargo test --features e2e "$@", passing whatever arguments to the command. In our e2e workflow, we'd then call the script like ./scripts/e2e-tests.sh --test "*".

I'd be more in favor of this approach, but my first instinct was to keep the existing behavior as much as possible, and only change it after discussing it with you guys.

At this point it's really a matter of taste

Let's leave right now the current behaviour.

I'm curious what will be different in devex with these changes?

Basically, it lets you call this script as if you were to call cargo test, meaning it enables you to do all the funky filtering stuff

The current implementation is the simplest one, with the most straightforward way to use.

Updating the script to support invocations like:

./scripts/e2e-tests.sh erc721 error_when_minting_token_id_twice

Would make it very complex if we also wanted to support passing other valid args/flags to cargo test, or to the test binary.

But actually what I like very much in your approach, is that if we spell ./scripts/e2e-tests.sh --help it will print docs for cargo sub commands. So no need to bother ourselves with script's documentation

Can you clarify the last sentence?

Let's keep your changes

Can you clarify the last sentence?

I mean, that we can print valid documentation for e2e-test.sh script, since we're just forwarding arguments to cargo test:

./scripts/e2e-tests.sh --help

Does the script then have your blessing? 😄

bidzyyys

I believe we can apply #[allow(clippy::used_underscore_binding)] for the whole contracts library

bidzyyys

Left some comments, good job @0xNeshi

CHANGELOG.md

contracts/src/utils/nonces.rs

CHANGELOG.md

Co-authored-by: Daniel Bigos <[email protected]>

contracts/src/access/control.rs

bidzyyys

Almost ready to merge!

contracts/src/utils/nonces.rs

contracts/src/access/control.rs

bidzyyys

LGTM!

contracts/src/finance/vesting_wallet.rs

bidzyyys · 2024-12-30T16:45:33Z

scripts/e2e-tests.sh

+    cargo test --features std,e2e --test "*"
+else
+    cargo test --features std,e2e "$@"
+fi


Let's leave right now the current behaviour.

qalisander

Good job!

qalisander · 2024-12-30T16:58:47Z

scripts/e2e-tests.sh

+    cargo test --features std,e2e --test "*"
+else
+    cargo test --features std,e2e "$@"
+fi


I'm curious what will be different in devex with these changes?

scripts/e2e-tests.sh

examples/erc20/src/lib.rs

contracts/src/utils/math/storage.rs

contracts/src/access/control.rs

…es internally Refs: 84fceef.

Refs: 07ebad3.

qalisander

LGTM

0xNeshi added 9 commits December 26, 2024 09:30

docs: add warning to pause/unpause in examples

34e8883

test: update e2e-tests script

cce990b

docs: add warning to pause/unpause in erc1155 example

3054d65

docs: add missing eyre module import in README example

fff4210

ref: explicitly import eyre::Result in e2e accounts.rs

5fbb8aa

ref: use assign unchecked traits in erc20::update

3406681

docs: update docs for nonces contract

75d3e1b

ref: reuse logic in use_checked_nonce

a264c90

ref: update AddAssignUnchecked and SubAssignUnchecked to cast values …

84fceef

…internally

0xNeshi self-assigned this Dec 26, 2024

0xNeshi requested review from bidzyyys and qalisander as code owners December 26, 2024 10:03

chore: add missing PR ids to changelog

627fd17

0xNeshi commented Dec 26, 2024

View reviewed changes

contracts/src/utils/nonces.rs Outdated Show resolved Hide resolved

docs: add links explaining undefined behavior

dbfc6cb

ref: address 'clippy::used_underscore_binding' warnings

a3d5470

0xNeshi requested a review from ggonzalez94 December 26, 2024 18:39

0xNeshi added 2 commits December 26, 2024 20:17

test: simplify e2e-tests.sh

f51bc08

test: update comments in e2e-tests.sh

da89ce4

0xNeshi commented Dec 26, 2024

View reviewed changes

bidzyyys reviewed Dec 27, 2024

View reviewed changes

bidzyyys self-requested a review December 27, 2024 08:36

bidzyyys reviewed Dec 27, 2024

View reviewed changes

0xNeshi commented Dec 27, 2024

View reviewed changes

CHANGELOG.md Outdated Show resolved Hide resolved

0xNeshi and others added 2 commits December 27, 2024 10:02

docs: Apply comment updates from code review

c858b28

Co-authored-by: Daniel Bigos <[email protected]>

docs: change F link to plain code

fa3956a

0xNeshi commented Dec 27, 2024

View reviewed changes

contracts/src/access/control.rs Show resolved Hide resolved

docs: format in nonces

33f834e

Merge branch 'main' into return-res-refactor

59c1ead

bidzyyys self-requested a review December 27, 2024 11:04

bidzyyys reviewed Dec 27, 2024

View reviewed changes

contracts/src/utils/nonces.rs Outdated Show resolved Hide resolved

contracts/src/utils/nonces.rs Outdated Show resolved Hide resolved

contracts/src/access/control.rs Show resolved Hide resolved

0xNeshi added 2 commits December 30, 2024 08:56

feat: now panics on exceeding

b5e7bec

docs: align Nonce docs to existing convention

ad9732d

0xNeshi requested a review from bidzyyys December 30, 2024 07:57

ci: remove std feature from e2e-tests.sh

26f7c59

bidzyyys approved these changes Dec 30, 2024

View reviewed changes

qalisander reviewed Dec 30, 2024

View reviewed changes

0xNeshi added 2 commits December 31, 2024 08:31

test: remove dir navigation from e2e-tests.sh

07ebad3

revert: update AddAssignUnchecked and SubAssignUnchecked to cast valu…

c3a1599

…es internally Refs: 84fceef.

0xNeshi requested a review from qalisander December 31, 2024 07:34

revert: remove dir navigation from e2e-tests.sh

c5c7be5

Refs: 07ebad3.

qalisander approved these changes Dec 31, 2024

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ref: Add/Sub Assignment Operations + e2e-tests.sh #467

ref: Add/Sub Assignment Operations + e2e-tests.sh #467

0xNeshi commented Dec 26, 2024 •

edited

Loading

netlify bot commented Dec 26, 2024 •

edited

Loading

codecov bot commented Dec 26, 2024 •

edited

Loading

0xNeshi Dec 26, 2024 •

edited

Loading

0xNeshi Dec 27, 2024 •

edited

Loading

bidzyyys Dec 30, 2024

qalisander Dec 30, 2024 •

edited

Loading

0xNeshi Dec 31, 2024

0xNeshi Dec 31, 2024

qalisander Dec 31, 2024 •

edited

Loading

qalisander Dec 31, 2024 •

edited

Loading

0xNeshi Dec 31, 2024

qalisander Dec 31, 2024

bidzyyys left a comment

bidzyyys left a comment

bidzyyys left a comment

bidzyyys left a comment

bidzyyys Dec 30, 2024

qalisander left a comment

qalisander Dec 30, 2024 •

edited

Loading

qalisander left a comment

ref: Add/Sub Assignment Operations + e2e-tests.sh #467

Are you sure you want to change the base?

ref: Add/Sub Assignment Operations + e2e-tests.sh #467

Conversation

0xNeshi commented Dec 26, 2024 • edited Loading

PR Checklist

netlify bot commented Dec 26, 2024 • edited Loading

✅ Deploy Preview for contracts-stylus canceled.

codecov bot commented Dec 26, 2024 • edited Loading

Codecov Report

0xNeshi Dec 26, 2024 • edited Loading

Choose a reason for hiding this comment

0xNeshi Dec 27, 2024 • edited Loading

Choose a reason for hiding this comment

bidzyyys Dec 30, 2024

Choose a reason for hiding this comment

qalisander Dec 30, 2024 • edited Loading

Choose a reason for hiding this comment

0xNeshi Dec 31, 2024

Choose a reason for hiding this comment

0xNeshi Dec 31, 2024

Choose a reason for hiding this comment

qalisander Dec 31, 2024 • edited Loading

Choose a reason for hiding this comment

qalisander Dec 31, 2024 • edited Loading

Choose a reason for hiding this comment

0xNeshi Dec 31, 2024

Choose a reason for hiding this comment

qalisander Dec 31, 2024

Choose a reason for hiding this comment

bidzyyys left a comment

Choose a reason for hiding this comment

bidzyyys left a comment

Choose a reason for hiding this comment

bidzyyys left a comment

Choose a reason for hiding this comment

bidzyyys left a comment

Choose a reason for hiding this comment

bidzyyys Dec 30, 2024

Choose a reason for hiding this comment

qalisander left a comment

Choose a reason for hiding this comment

qalisander Dec 30, 2024 • edited Loading

Choose a reason for hiding this comment

qalisander left a comment

Choose a reason for hiding this comment

0xNeshi commented Dec 26, 2024 •

edited

Loading

netlify bot commented Dec 26, 2024 •

edited

Loading

codecov bot commented Dec 26, 2024 •

edited

Loading

0xNeshi Dec 26, 2024 •

edited

Loading

0xNeshi Dec 27, 2024 •

edited

Loading

qalisander Dec 30, 2024 •

edited

Loading

qalisander Dec 31, 2024 •

edited

Loading

qalisander Dec 31, 2024 •

edited

Loading

qalisander Dec 30, 2024 •

edited

Loading