Integrate test coverage with nile-coverage

[ericnordelo]

Fixes #455

PR Checklist

• configure test coverage check on CI
• add test coverage badge on README

[ericnordelo]

I made the PR ready for review, just adding the tox coverage environment because only an organization admin can add the integration with codecov.io (badge included).

As it is, this PR allows run coverage using tox -e coverage.

This can be tested locally already after cairo-lang 0.10.1 release.

NOTE: merging this PR will close #455, even when we don't have the integration with CI and the Badge.

[martriay]

code looks good! let's wait for @frangio for the setup. will try it out.

[martriay]

should we add a rule to require PRs to maintain the coverage?

[ericnordelo]

I assumed this would be part of the CI action that I have no permission to add (integrating with codecov). I left that part to @frangio (because the solidity contracts repo is also integrated with codecov and this check), but I can work on it if needed.

[frangio]

Yes this should be handled by Codecov.

[martriay]

does it make sense to run the tests a second time? should we simply run coverage?

[ericnordelo]

I think running coverage is enough because the VM used for this is almost the same one that comes default with cairo (the difference, for now, is just storing the touched program counters), so tests are run for coverage in the same environment in practice.

[martriay]

It didn't work for me :(

[ericnordelo]

It didn't work for me :(

I forgot to add that this plugin requires python 3.9 (it doesn't work with 3.8 because of these str functions). I will remove these functions and add support for 3.8 tomorrow because it still makes sense in my opinion.

[ericnordelo]

I forgot to add that this plugin requires python 3.9 (it doesn't work with 3.8 because of these str functions). I will remove these functions and add support for 3.8 tomorrow because it still makes sense in my opinion.

This should be fixed in version 0.2.1 (set in last commit).

[frangio]

I've installed the Codecov GitHub App in this repository. I think you still need to set up Step 4 in this guide. (Note that the CODECOV_TOKEN is not necessary because we are using GitHub Actions, this is mentioned in Step 2.)

[codecov]

Codecov Report

❗ No coverage uploaded for pull request base (main@c480259). Click here to learn what that means.
Patch has no changes to coverable lines.

❗ Current head ad4061b differs from pull request most recent head 6c66e24. Consider uploading reports for the commit 6c66e24 to get more accurate results

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #494   +/-   ##
=======================================
  Coverage        ?   96.82%           
=======================================
  Files           ?       28           
  Lines           ?     1419           
  Branches        ?        0           
=======================================
  Hits            ?     1374           
  Misses          ?       45           
  Partials        ?        0           

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

[frangio]

If you prefer, you can disable the Codecov comment in the config file. See our configuration and the docs.

[ericnordelo]

If you prefer, you can disable the Codecov comment in the config file. See our configuration and the docs.

That config is part of the PR already (.codecov.yml).

[martriay]

Left a few questions!

[martriay]

Almost there :)