Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Show the output of the LCOV report in the README #1093

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Show the output of the LCOV report in the README #1093

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,9 +58,9 @@ Echidna should find a call sequence that falsifies `echidna_sometimesfalse` and

### Collecting and visualizing coverage

After finishing a campaign, Echidna can save a coverage maximizing **corpus** in a special directory specified with the `corpusDir` config option. This directory will contain two entries: (1) a directory named `coverage` with JSON files that can be replayed by Echidna and (2) a plain-text file named `covered.txt`, a copy of the source code with coverage annotations.
After finishing a campaign, Echidna can save a coverage maximizing **corpus** in a special directory specified with the `corpusDir` config option. This directory will contain two entries: (1) a directory named `coverage` with JSON files that can be replayed by Echidna and a set of human-readable documens to visualize coverage.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

there is a typo documens -> documents


If you run `tests/solidity/basic/flags.sol` example, Echidna will save a few files serialized transactions in the `coverage` directory and a `covered.$(date +%s).txt` file with the following lines:
For instance, if you run `tests/solidity/basic/flags.sol` example, Echidna will save a few files serialized transactions in the `coverage` directory and a `covered.$(date +%s).txt` file with the following lines:

```text
*r | function set0(int val) public returns (bool){
Expand All @@ -81,6 +81,10 @@ Our tool signals each execution trace in the corpus with the following "line mar
* `o` if an execution ended with an out-of-gas error
* `e` if an execution ended with any other error (zero division, assertion failure, etc)

The same information is available in an html file (`covered.$(date +%s).html`) for improved navigation. Finally, we support for lcov output for visualizing coverage. To generate an html file with the complete set of tested contracts, you need to use [`genhtml`](https://manpages.ubuntu.com/manpages/xenial/man1/genhtml.1.html):

<a href="https://github.com/crytic/echidna/assets/31542053/d0203d8f-2aea-405a-8bdd-5f12897a5cfb"><img src="https://github.com/crytic/echidna/assets/31542053/d0203d8f-2aea-405a-8bdd-5f12897a5cfb" width="450"/></a>

### Support for smart contract build systems

Echidna can test contracts compiled with different smart contract build systems, including [Truffle](https://truffleframework.com/) or [hardhat](https://hardhat.org/) using [crytic-compile](https://github.com/crytic/crytic-compile). To invoke echidna with the current compilation framework, use `echidna .`.
Expand Down