Enable coverage in CI

[Wauplin]

Related to #977.

Draft mode since it's not close to be reviewed :D

[HuggingFaceDocBuilderDev]

The documentation is not available anymore as the PR was closed or merged.

[Wauplin]

Update: code coverage is now working as expected on the ./src/huggingface_face folder !

Coverage is measured at ~80% (see codecov report). At the moment, most branch/compare sections of codecov are broken. I suspect this is because it tries to compare against main branch that has cov reports only on the tests/ folder. I tried to "erase repo coverage content" from the settings page since previous reports were unrelevant but I think I don't have the rights to do it.

I also made a refactoring of python-tests.yml workflow to leverage even more the github matrix and avoid duplication of steps. I think it would be easier to review it directly from the file instead of looking at the diff. In theory I kept exactly the same steps for each build (+add the cov reports).

@LysandreJik @osanseviero @adrinjalali could you please have a look at it ? Thanks in advance 🙂 🙏

EDIT: I also enabled comments from codecov in PRs. Let's see and if it's too annoying we will remove them.

[Wauplin]

The workaround I used to get proper coverage is to run tests from the ./src folder and using python -m pytest instead of pytest. My understanding is that it "forces" python to import huggingface_hub from the current directory in priority (since ./src/huggingface_hub has same name) instead of the installed one.

Then I updated the "./tests/" target to "../tests/" and created a "../coverage.xml" report.

[adrinjalali]

BTW, the paths-ignore could also be removed, we've moved those folders out of this repo.

Thankss a bunch for this. Let's see what it does then.

[adrinjalali]

I tried to "erase repo coverage content" from the settings page since previous reports were unrelevant but I think I don't have the rights to do it.

I couldn't figure out how to give you those permissions, but I deleted the content there.