Add Codecov integration for test coverage tracking

[ivinjabraham]

This PR adds Codecov integration to track code coverage. With this setup, Codecov will automatically analyze test coverage and post comments on PRs, helping us monitor changes in coverage over time. I believe this will be a good incentive to increase our coverage as well.

Requirements

Codecoverage needs a token from their their website. This needs to be put in GitHub secrets as it's referenced in the .yml file as ${{ secrets.CODECOV_TOKEN }}

[davidbtadokoro]

Thanks for bringing up the idea! Like in #109, code coverage is a great idea, and patch-hub currently lacks a solution for this. In kworkflow, we also used Codecov to host the results (generated by kcov, in this case), so I like the idea.

I will tinker a little bit with cargo tarpaulin before considering merging this, as I am not familiar with this solution. I imagine that you chose the "best one", but I just need some time before considering expanding the CI workflows.

Once again, thanks for the marvelous work!

[davidbtadokoro]

Hey @ivinjabraham. I did some research both on tarpaulin and in the workflow in general.

In a nutshell, it seems that tarpaulin is a good choice, and the workflow does the right steps on the right triggers. I left some inline review comments, so please see if you can address them. Feel free to ping me in case of any doubt.

[davidbtadokoro]

Hi, @ivinjabraham, and thanks for the update! I think we are getting near to the merging point, but I just need to check things in the kworkflow org level. In the meantime, I added some simple inline comments, and I replied the comment you made from the last review. See if you can address them, please.

In any case, marvelous work!

[ivinjabraham]

Just to be clear, with v5 there won't be any upload of commits or anything of the like, right? Ideally, Codecov should only be a report hosted somewhere else to see coverage for pushes/PRs.

Correct, using v5 doesn't upload any of our source code. It's solely for uploading the coverage report. However, to associate reports with different refs, it would upload some git metadata such as commit hashes and branch information.

Reference: https://about.codecov.io/security/#does-codecov-store-source-code

[davidbtadokoro]

Correct, using v5 doesn't upload any of our source code. It's solely for uploading the coverage report. However, to associate reports with different refs, it would upload some git metadata such as commit hashes and branch information.

Reference: https://about.codecov.io/security/#does-codecov-store-source-code

On the front of uploading code and such, there are no worries. I was talking about CodeCov trying to push a commit into the repo. I don't know if I am mixing things, but I remember that when I tried v4, it failed due to it not being able to push the commit.

About the rest, everything is looking legit, so I'll clear the front about the org, and come back here.

[ivinjabraham]

I was talking about CodeCov trying to push a commit into the repo.

AFAIK, this should never happen.

[davidbtadokoro]

Hey @ivinjabraham, unfortunately I still didn't solve the matter about a org-level secret for us to go forward with this PR. Everything else is legit, though.

[ivinjabraham]

Thanks for letting me know and no worries! This isn't needed immediately.

[davidbtadokoro]

Hi @ivinjabraham. I put this PR as a draft for the time being, as this isn't urgent ATM.