echidna icon indicating copy to clipboard operation
echidna copied to clipboard

Improve Echidna coverage documentation

Open tarunbhm opened this issue 1 year ago • 2 comments

Describe the desired feature

Echidna corpus shows code coverage which can be used to get a sense of the system states explored by echidna. The documentation on coverage can be improved to make it more clear and guide users with common steps to increase coverage.

tarunbhm avatar Mar 27 '23 11:03 tarunbhm

I think we will expand this section: https://github.com/crytic/building-secure-contracts/blob/master/program-analysis/echidna/advanced/collecting-a-corpus.md#collecting-a-corpus

What do you think we should include?

ggrieco-tob avatar Apr 03 '23 07:04 ggrieco-tob

I also found https://github.com/crytic/echidna/tree/master#collecting-and-visualizing-coverage, which explains the meaning of coverage markers in the coverage report.

Currently, the collecting corpus document focuses only on the corpus. It briefly discusses the coverage report, but that is just to verify the effect of corpus seeding. I think we can include a section describing how users can use the coverage report to verify that Echidna is able to run all code paths while testing invariants. We can also create another doc in the advanced or basic category for coverage analysis. It will make Echidna much more effective with full code coverage.

tarunbhm avatar Apr 03 '23 08:04 tarunbhm