Add forge-std compatible assertion aliases for easier integration#67
Open
omarinuwa wants to merge 1 commit intocrytic:mainfrom
Open
Add forge-std compatible assertion aliases for easier integration#67omarinuwa wants to merge 1 commit intocrytic:mainfrom
omarinuwa wants to merge 1 commit intocrytic:mainfrom
Conversation
|
Omar Inuwa seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account. You have signed the CLA already but the status is still pending? Let us recheck it. |
This PR adds assertion function aliases that match forge-std/Test.sol
naming conventions, resolving naming conflicts and enabling seamless
integration with existing Foundry codebases.
Problem:
When integrating crytic/properties with existing Foundry projects, many
assertion helpers collided with forge-std/Test.sol, making it difficult
to use both libraries together. Specific conflicts:
- assertWithMsg (crytic) vs assertTrue (forge-std)
- assertGte (crytic) vs assertGe (forge-std)
- assertLte (crytic) vs assertLe (forge-std)
- assertNeq (crytic) vs assertNotEq (forge-std)
Solution:
Added 8 new assertion function aliases in PropertiesHelper.sol that
delegate to existing implementations:
- assertTrue() - alias for assertWithMsg()
- assertFalse() - new function for asserting false conditions
- assertNotEq() - alias for assertNeq() (uint256 and int256)
- assertGe() - alias for assertGte() (uint256 and int256)
- assertLe() - alias for assertLte() (uint256 and int256)
Benefits:
- Users can now inherit from both PropertiesAsserts and forge-std Test
without naming conflicts
- Both naming conventions work side-by-side
- 100% backward compatible - existing code continues to work
- No breaking changes to existing properties
- Easier onboarding for Foundry developers
Example usage:
```solidity
contract MyTest is MyToken, CryticERC20BasicProperties, Test {
function test_example() public {
// Both styles work!
assertTrue(balance > 0, "Has balance"); // forge-std style
assertWithMsg(balance > 0, "Has balance"); // crytic style
assertGe(balance, 100, "At least 100"); // forge-std style
assertGte(balance, 100, "At least 100"); // crytic style
}
}
```
This change makes crytic/properties fully compatible with Foundry's
standard testing patterns, lowering the barrier to adoption.
4af52ed to
832d59a
Compare
This file contains hidden or 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
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 adds assertion function aliases that match forge-std/Test.sol naming conventions, resolving naming conflicts and enabling seamless integration with existing Foundry codebases.
Problem:
When integrating crytic/properties with existing Foundry projects, many assertion helpers collided with forge-std/Test.sol, making it difficult to use both libraries together. Specific conflicts:
Solution:
Added 8 new assertion function aliases in PropertiesHelper.sol that delegate to existing implementations:
Benefits:
This change makes crytic/properties fully compatible with Foundry's standard testing patterns, lowering the barrier to adoption.