Skip to content

Commit

Permalink
Coverage screenshot v2
Browse files Browse the repository at this point in the history
  • Loading branch information
kevin-valerio committed Oct 17, 2024
1 parent 910cdbb commit cfdfe6a
Show file tree
Hide file tree
Showing 5 changed files with 22 additions and 8 deletions.
8 changes: 6 additions & 2 deletions book/documentation/CAMPAIGN.html
Original file line number Diff line number Diff line change
Expand Up @@ -264,8 +264,12 @@ <h4 id="generating-a-coverage-report"><a class="header" href="#generating-a-cove
<p>Some HTML files should then be generated in the path you’ve configured inside your <code>phink.toml</code>. The coverage report
provides a visual representation of tested code areas. Basically, the more green lines, the better. You can find below
an example of the coverage report.</p>
<img src="https://raw.githubusercontent.com/srlabs/phink/refs/heads/main/assets/coverage_1.png" alt="coverage_1"/>
<img src="https://raw.githubusercontent.com/srlabs/phink/refs/heads/main/assets/coverage_2.png" alt="coverage_1" />
<h3 id="coverage-report-example"><a class="header" href="#coverage-report-example">Coverage Report Example</a></h3>
<p><strong>Green Lines</strong>: Code that has been tested.</p>
<p><img src="https://raw.githubusercontent.com/srlabs/phink/refs/heads/main/assets/coverage_1.png" alt="Coverage Report Part 1" /></p>
<p><em>Figure 1: Coverage Report of one specific file.</em></p>
<img src="https://raw.githubusercontent.com/srlabs/phink/refs/heads/main/assets/coverage_2.png" alt="coverage_2" width="400"/>
<p><em>Figure 2: List of fuzzed Rust files from the ink! smart-contract.</em></p>

</main>

Expand Down
8 changes: 6 additions & 2 deletions book/documentation/print.html
Original file line number Diff line number Diff line change
Expand Up @@ -470,8 +470,12 @@ <h4 id="generating-a-coverage-report"><a class="header" href="#generating-a-cove
<p>Some HTML files should then be generated in the path you’ve configured inside your <code>phink.toml</code>. The coverage report
provides a visual representation of tested code areas. Basically, the more green lines, the better. You can find below
an example of the coverage report.</p>
<img src="https://raw.githubusercontent.com/srlabs/phink/refs/heads/main/assets/coverage_1.png" alt="coverage_1"/>
<img src="https://raw.githubusercontent.com/srlabs/phink/refs/heads/main/assets/coverage_2.png" alt="coverage_1" />
<h3 id="coverage-report-example"><a class="header" href="#coverage-report-example">Coverage Report Example</a></h3>
<p><strong>Green Lines</strong>: Code that has been tested.</p>
<p><img src="https://raw.githubusercontent.com/srlabs/phink/refs/heads/main/assets/coverage_1.png" alt="Coverage Report Part 1" /></p>
<p><em>Figure 1: Coverage Report of one specific file.</em></p>
<img src="https://raw.githubusercontent.com/srlabs/phink/refs/heads/main/assets/coverage_2.png" alt="coverage_2" width="400"/>
<p><em>Figure 2: List of fuzzed Rust files from the ink! smart-contract.</em></p>
<div style="break-before: page; page-break-before: always;"></div><h1 id="runtime-integration"><a class="header" href="#runtime-integration">Runtime Integration</a></h1>
<p>Phink provides developers with the flexibility to customize their fuzzing environment through a simple interface. By
editing <code>contract/custom/custom.rs</code> and <code>contract/custom/preferences.rs</code>, developers can tailor the runtime storage and
Expand Down
2 changes: 1 addition & 1 deletion book/documentation/searchindex.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion book/documentation/searchindex.json

Large diffs are not rendered by default.

10 changes: 8 additions & 2 deletions book/src/CAMPAIGN.md
Original file line number Diff line number Diff line change
Expand Up @@ -122,8 +122,14 @@ Some HTML files should then be generated in the path you've configured inside yo
provides a visual representation of tested code areas. Basically, the more green lines, the better. You can find below
an example of the coverage report.

### Coverage Report Example

<img src="https://raw.githubusercontent.com/srlabs/phink/refs/heads/main/assets/coverage_1.png" alt="coverage_1"/>
**Green Lines**: Code that has been tested.

![Coverage Report Part 1](https://raw.githubusercontent.com/srlabs/phink/refs/heads/main/assets/coverage_1.png)

<img src="https://raw.githubusercontent.com/srlabs/phink/refs/heads/main/assets/coverage_2.png" alt="coverage_1" />
*Figure 1: Coverage Report of one specific file.*

<img src="https://raw.githubusercontent.com/srlabs/phink/refs/heads/main/assets/coverage_2.png" alt="coverage_2" width="400"/>

*Figure 2: List of fuzzed Rust files from the ink! smart-contract.*

0 comments on commit cfdfe6a

Please sign in to comment.