Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/Simon-Busch/echidna-coverage

Last synced: about 9 hours ago
JSON representation

Host: GitHub
URL: https://github.com/Simon-Busch/echidna-coverage
Owner: Simon-Busch
Created: 2024-12-07T12:30:34.000Z (2 months ago)
Default Branch: main
Last Pushed: 2025-02-02T04:27:23.000Z (10 days ago)
Last Synced: 2025-02-02T05:20:28.838Z (10 days ago)
Language: TypeScript
Size: 50.8 KB
Stars: 1
Watchers: 2
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: readme.md

Awesome Lists containing this project

evm-fuzzing-resources - Echidna Coverage Reporter - A TypeScript tool to parse and analyze Echidna code coverage reports for Solidity smart contracts, by [0xsi](https://x.com/_0xsi) (Tooling / Utils)
evm-fuzzing-resources - Echidna Coverage Reporter - A TypeScript tool to parse and analyze Echidna code coverage reports for Solidity smart contracts, by [0xsi](https://x.com/_0xsi) (Tooling / Utils)

README

# Echidna Coverage Reporter

A TypeScript tool to parse and analyze Echidna code coverage reports for Solidity smart contracts.

## Features

- Parse Echidna coverage output files
- Generate coverage reports by contract and function
- Track covered, uncovered, and reverted functions
- Multiple output formats (table/JSON)
- Coverage threshold checks
- Detailed verbose reporting option

## Installation

```bash
brew install Simon-busch/echidna-coverage/echidna-coverage
```

## Usage

Basic usage:

```bash
echidna-coverage -f ./coverage.txt
```

With all options:

```bash
echidna-coverage -vv --format table -t 90 --contract /TestContract.sol
```

## Options

- -v, --verbose: Show detailed output including uncovered functions
- -vv, --very-verbose: verbose mode + add logs of untouched lines and reverted lines
- -f, --file ``: Path to a specfic coverage file.txt
- -ef, --echidna-folder ``: path to the root of your directory containing the `echidna` folder. Defaults to ".". Accept `echidna` or `corpusDir` as default
- --format ``: Output format - 'table' or 'json' (default: table)
- -t, --threshold ``: Coverage threshold percentage (default: 70)
- -h, --help: Show help message
- -c, --contract: filter by contract name matching. This accepts either a contract name or an array of contracts such as: `-c "[contractA.sol, contractB.sol]"` or `-c contractA.sol`
- -cm, --condensed-mode: condensed mode only returning the % covered per file
- -af, -all-function: show all functions coverage, default to trimm off view and pure functions. Default false

## Output Example

### Using condensed mode

```bash
══════════════════════════════════════════════════
📄 File: vaults/Test.sol
══════════════════════════════════════════════════
97.14 %
```

### Using normal mode ( default )

```bash
══════════════════════════════════════════════════
📄 File: vaults/TestContract.sol
══════════════════════════════════════════════════
┌────────────────────────────┬────────┐
│ (index) │ Values │
├────────────────────────────┼────────┤
│ totalFunctions │ 37 │
│ fullyCoveredFunctions │ 32 │
│ coveredLines │ 209 │
│ revertedLines │ 0 │
│ untouchedLines │ 6 │
│ functionCoveragePercentage │ 86.49 │
│ lineCoveragePercentage │ 97.21 │
└────────────────────────────┴────────┘
══════════════════════════════════════════════════
```

### Using verbose mode (-v)

⚠️ Not fully covered functions:
┌─────────┬────────────────────────────────────────────┬─────────┬──────────┬────────────────┐
│ (index) │ functionName │ touched │ reverted │ untouchedLines │
├─────────┼────────────────────────────────────────────┼─────────┼──────────┼────────────────┤
│ 0 │ '_getData_' │ true │ false │ 1 │
│ 1 │ '_init_' │ true │ false │ 1 │
│ 2 │ '_harvestRewards' │ true │ false │ 1 │
│ 3 │ 'totalAssets' │ true │ false │ 2 │
│ 4 │ '_autoCompoundHook' │ false │ false │ 1 │
└─────────┴────────────────────────────────────────────┴─────────┴──────────┴────────────────┘
══════════════════════════════════════════════════
```

### Using very-verbose mode (-vv)

Function: _getData_
❌ Untouched lines:
assembly {

Function: _init_
❌ Untouched lines:
revert("CollVault: 0 address");

Function: _harvestRewards
❌ Untouched lines:
iVault.stake(netRewards);

Function: totalAssets
❌ Untouched lines:
address[] memory currentRewardTokens,
uint currentRewardTokensLength

Function: _autoCompoundHook
❌ Untouched lines:
return (_rewards, _token);
══════════════════════════════════════════════════
```

## Note

- Test and scripts files are filtered out
- View function and pure are trimmed out, as they are not relevant

## Contributing

1. Fork the repository
2. Create your feature branch
3. Submit a pull request

## License

MIT