feat: cost reporting via tests

[lgalabru]

This PR starts addressing #41, by introducing a flag --cost that can be passed when running tests.

➜  counter git:(feat/cost-tracking) ✗ clarinet test --costs

Running file:///Users/ludovic/Coding/clarinet/clarinet-cli/examples/counter/tests/counter_test.ts
* Ensure that counter can be incremented multiples per block, accross multiple blocks ... ok (24ms)

Contract calls cost synthesis
+-----------+------------+------------+-----------------+-------------+----------------+--------------+
| ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM.counter::increment                                        |
+-----------+------------+------------+-----------------+-------------+----------------+--------------+
|           | Runtime    | Read Count | Read Length     | Write Count | Write Length   | Tx per Block |
+-----------+------------+------------+-----------------+-------------+----------------+--------------+
| Max       | 838000     | 5          | 613 bytes       | 1           | 17 bytes       | 1550         |
+-----------+------------+------------+-----------------+-------------+----------------+--------------+
| ST1PQHQKV0RJXZFY1DGX8MNSNYVE3VGZJSRTPGZGM.counter::read-counter                                     |
+-----------+------------+------------+-----------------+-------------+----------------+--------------+
|           | Runtime    | Read Count | Read Length     | Write Count | Write Length   | Tx per Block |
+-----------+------------+------------+-----------------+-------------+----------------+--------------+
| Max       | 617000     | 4          | 613 bytes       | 0           | 0 bytes        | 1937         |
+-----------+------------+------------+-----------------+-------------+----------------+--------------+
| Block Limits                                                                                        |
+-----------+------------+------------+-----------------+-------------+----------------+--------------+
| Mainnet   | 5000000000 | 7750       | 100000000 bytes | 7750        | 15000000 bytes | /            |
+-----------+------------+------------+-----------------+-------------+----------------+--------------+

The costs for every method explicitly invoked when mining tests blocks

        let block = chain.mineBlock([
            Tx.contractCall("counter", "increment", [types.uint(1)], wallet_1.address),
            ...
        ]);

are collected, and rendered in the terminal. If multiple invocations for a given method were collected, the most expensive instance is being displayed.

[codecov-commenter]

Codecov Report

Merging #116 (8d8a5af) into main (21b91e5) will decrease coverage by 0.03%.
The diff coverage is 0.00%.

@@           Coverage Diff            @@
##            main    #116      +/-   ##
========================================
- Coverage   4.21%   4.17%   -0.04%     
========================================
  Files        129     129              
  Lines      27546   27796     +250     
========================================
  Hits        1161    1161              
- Misses     26385   26635     +250     

Flag	Coverage Δ
unittests	4.17% <0.00%> (-0.04%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
src/frontend/cli.rs	0.00% <0.00%> (ø)
src/integrate/events_observer.rs	0.00% <0.00%> (ø)
src/main.rs	25.00% <ø> (ø)
src/runnner/deno.rs	0.00% <0.00%> (ø)
src/runnner/mod.rs	0.00% <0.00%> (ø)

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 21b91e5...8d8a5af. Read the comment docs.

[kyranjamie]

abbreviated flag -c 🤔

[LNow]

This looks great!!
Would it be possible to add % values to this report? So that we won't have to calculate it on a side, to find out if our contract will eat 0.01% or 10% of a whole block execution costs limits.

[lgalabru]

@LNow already the case, the latest version of the reports looks like this:

[LNow]

I love it. @whoabuddy look at this!

[lgalabru]

Screen.Recording.2021-09-16.at.11.33.43.AM.mov

[unclemantis]

Please build into windows binary .msi file. I downloaded the recent msi for x63 and the --costs flag does not work.

Thank you!!!!

[blockstack-devops]

🎉 This PR is included in version 0.17.0 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀