refactor(tests/e2e-evm): Restructure ABI tests for extensibility & reduce duplication #2031
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
Fallback tests are not run on each function but rather only for the specific fallback. This means whether or not to run the test is determined by only the receive and fallback functions, without any other ABI function.
Previously used type assertions to bypass certain TypeScript issues with test cases, along with using any & unsafe assignments. This resolves the types to be properly valid and enforced to prevent any potential errors.
Changes from including a field in each test case from conditionally running the case, to building the cases dynamically. This allows for logical grouping of test cases and organization with logic instead of using comments. Slightly less explicit for each test case, but with the grouping of test cases, it reduces the mental overhead of figuring out when each test case is run.
Resolves use type casting and unsafe access, validation of revert errors for matches and types
Previously runs all the time, which is currently okay with the current single testing contract that includes both functions. This conditionally adds these test cases if the respective functions exist so we can test additional contract behavior that may not have these functions and may produce a different error.
Most of these issues are intentional and are okay to ignore. This also sets the solhint ignoreConstructors option to true for the func-visibility rule, as we are using solidity >=0.7.0
drklee3
commented
Oct 10, 2024
| "extends": "solhint:recommended" | ||
| "extends": "solhint:recommended", | ||
| "rules": { | ||
| "func-visibility": ["warn", { "ignoreConstructors": true }] |
There was a problem hiding this comment.
There was a problem hiding this comment.
tyty I did not know about this configuration
drklee3
requested review from
rhuairahrighairidh,
karzak,
pirtleshell,
nddeluca,
DracoLi,
evgeniy-scherbina,
sesheffield,
boodyvo and
lbayas
as code owners
drklee3
removed request for
DracoLi,
lbayas,
rhuairahrighairidh,
karzak,
sesheffield,
boodyvo,
pirtleshell and
evgeniy-scherbina
Long errors are truncated and difficult to determine the issue otherwise
nddeluca
reviewed
Oct 15, 2024
| @@ -10,6 +10,7 @@ import "hardhat-ignore-warnings"; | |||
| // Chai setup | |||
| // | |||
| chai.use(chaiAsPromised); | |||
| chai.config.truncateThreshold = 0; | |||
There was a problem hiding this comment.
❤️ Idk why I didn't find this setting, so much nicer without any truncation
nddeluca
reviewed
Oct 15, 2024
| const expectedMatch = /call not allowed to disabled contract/; | ||
| expect(expectedMatch.test(revertDetail), `expected ${revertDetail} to match ${expectedMatch}`).to.be.true; | ||
| const expectedMatch = "call not allowed to disabled contract"; | ||
| expect(revertDetail).to.equal(revertDetail, `expected ${revertDetail} to match ${expectedMatch}`); |
There was a problem hiding this comment.
Nice simplification -- we may have to change it back at some point though, but let's keep for now.
The error response of viem for hardhat, kvtool, etc can be a bit different so I meant to only match the revert message here. Unfortunately, chai doesn't have a great matcher for regex like testify.
nddeluca
reviewed
Oct 15, 2024
| mockAddress = (await hre.viem.deployContract(mockContractName)).address; | ||
|
|
||
| const mockArtifact = await hre.artifacts.readArtifact(mockContractName); | ||
| if (isHex(mockArtifact.deployedBytecode)) { |
nddeluca
reviewed
Oct 15, 2024
| @@ -52,7 +59,7 @@ contract Caller { | |||
| // High level caller | |||
| // | |||
| contract NoopCaller { | |||
| NoopNoReceiveNoFallback target; | |||
| NoopNoReceiveNoFallback private target; | |||
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.
Description