Improvements to Foundry Documentation #317
Merged
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
johspaeth
commented
Nov 27, 2024
urikirsh
reviewed
Dec 4, 2024
docs/cvl/foundry-integration.md
Outdated
| the expected one, the test will still be marked as successful. | ||
|
|
||
| - The call trace for the Foundry integration can be hard to read as it is internally implemented as a parametric CVL rule with case splitting on the method `.selector` of each method. This leads to the call trace containing an `if` statement per fuzz test method. When focusing on a particular test it is helpful to use the `--method <FUZZ_TEST_METHOD_NAME>` [flag](https://docs.certora.com/en/latest/docs/prover/cli/options.html#method-method-signature). |
There was a problem hiding this comment.
It would be very helpful if we can show an example of the problem and how to resolve it:
- An exemplary Foundry test Solidity file with two simple and short tests
- A screenshot of the call trace of these tests showing the parametric rule
- A command line example showing how to focus on the results of a single test
As is, it is hard to understand the text, and our users always complain that there are not enough examples.
There was a problem hiding this comment.
Thanks for the feedback - I added screenshots and links to existing jobs to clarify what we mean here. @urikirsh please re-review.
urikirsh
approved these changes
Dec 10, 2024
Co-authored-by: urikirsh <[email protected]>
Co-authored-by: urikirsh <[email protected]>
Co-authored-by: urikirsh <[email protected]>
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 some information to the foundry integration to clarify simplification on how to use it.