Commit 4af52ed
Add forge-std compatible assertion aliases for easier integration
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.1 parent d346d8e commit 4af52ed
1 file changed
+57
-0
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
439 | 439 | | |
440 | 440 | | |
441 | 441 | | |
| 442 | + | |
| 443 | + | |
| 444 | + | |
| 445 | + | |
| 446 | + | |
| 447 | + | |
| 448 | + | |
| 449 | + | |
| 450 | + | |
| 451 | + | |
| 452 | + | |
| 453 | + | |
| 454 | + | |
| 455 | + | |
| 456 | + | |
| 457 | + | |
| 458 | + | |
| 459 | + | |
| 460 | + | |
| 461 | + | |
| 462 | + | |
| 463 | + | |
| 464 | + | |
| 465 | + | |
| 466 | + | |
| 467 | + | |
| 468 | + | |
| 469 | + | |
| 470 | + | |
| 471 | + | |
| 472 | + | |
| 473 | + | |
| 474 | + | |
| 475 | + | |
| 476 | + | |
| 477 | + | |
| 478 | + | |
| 479 | + | |
| 480 | + | |
| 481 | + | |
| 482 | + | |
| 483 | + | |
| 484 | + | |
| 485 | + | |
| 486 | + | |
| 487 | + | |
| 488 | + | |
| 489 | + | |
| 490 | + | |
| 491 | + | |
| 492 | + | |
| 493 | + | |
| 494 | + | |
| 495 | + | |
| 496 | + | |
| 497 | + | |
| 498 | + | |
442 | 499 | | |
443 | 500 | | |
444 | 501 | | |
| |||
0 commit comments