[FEATURE]: setup code coverage for local tests & CI · Issue #1587 · juspay/h...

Context

As any other codebase, unit tests are vital to maintain stability & correctness of code..
Currently while the project has some amount of tests, We still don't have a code coverage tracking in place which robs people of some of the incentives for adding tests.
We should aim to add code coverage checks on PR's to add the necessary incentives in place

Objectives

We need unit test runs + code coverage summaries on PR's to get an idea about the diff in code coverage caused by the PR...

For local development people often have their own ways to run & test code locally...
However we would also like to provide a standardized approach via Makefile that has to be consistent with the report generated via CI...

For CI we have shortlisted codecov due to it's open-source friendliness
& locally we prefer to have an lcov based diff generated due to integrations with vscode etc..

Any temporary files generated due to code coverage locally shouldn't be tracked & should be auto-ignored via the .gitignore file (you can update the .gitignore file to do so)

As for testing out your CI changes you can install codecov on your fork to demonstrate a working version of this