Add coverage to our test workflow

[ggonzalez94]

Fixes #1129

Description

• Add --coverage flag to the test step
• Upload report to codecov(token is already configured in GH secrets)
• Format the workflow file to make it more readable

I was planning to add this in our next milestone, but it was much easier than I expected. I tested it on my branch and the coverage report was generated and uploaded to codecov, but since cairo-coveragedoes not support branch coverage yet, I don't know exactly what the final report looks like(we will see once it is merged to main)

[ericnordelo]

Should we define rules and add a codecov configuration file similar to what we have in solidity?

[ggonzalez94]

@ericnordelo it is not needed to have an initial coverage report, but I did take the opportunity and added a codecov.ymlfile to the repo which should make things better. Let me know what you think. Once we have more data we should refine what our thresholds are.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.35%. Comparing base (387637e) to head (ec7fc8e).
Report is 159 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff            @@
##           main    #1152       +/-   ##
=========================================
+ Coverage      0   89.35%   +89.35%     
=========================================
  Files         0       55       +55     
  Lines         0     1334     +1334     
=========================================
+ Hits          0     1192     +1192     
- Misses        0      142      +142     

see 3 files with indirect coverage changes

---

Continue to review full report in Codecov by Sentry.

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

[ericnordelo]

LGTM!

[andrew-fleming]

LGTM! I just left a question