Add @cover annotation in test-load file and add support for codecov

[sarthak-19]

Summary

This PR adds @cover annotation for test cases and add .yml file that can be used to configure codecov for automated test coverage in github actions.

Addresses #1284

Relevant technical choices

I've addressed the following file plugins/webp-uploads/tests/test-load.php for adding @cover annotation, if the approach is approved will extend this to other files.

[swissspidy]

@sarthak-19 Welcome, and thanks for opening this! I just stumbled upon the PR and left a couple of comments for things that caught my eye.

[sarthak-19]

@sarthak-19 Welcome, and thanks for opening this! I just stumbled upon the PR and left a couple of comments for things that caught my eye.

@swissspidy Thank you so much for the feedback. I've addressed those and looking forward to keep improving 😄

[pbearne]

I am really glad to see I have been try to get into core ten+ years

[sarthak-19]

Note the new coverage matrix variable which is only set to true for one configuration. This would be better than having to test against a specific PHP version everywhere. Yes, I think running coverage on the most recent PHP version would be best as it should complete the fastest. So maybe do it in PHP 8.2?

Apologies for the delayed response, made the suggested changes.
Does this works or any other changes are to be made, highly appreciate your insights here.

cc : @westonruter

[westonruter]

@sarthak-19 That looks right!

[github-actions]

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the props-bot label.

Unlinked Accounts

The following contributors have not linked their GitHub and WordPress.org accounts: @sarthak.jaiswal@rtCamp.com.

Contributors, please read how to link your accounts to ensure your work is properly credited in WordPress releases.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Unlinked contributors: sarthak.jaiswal@rtCamp.com.

Co-authored-by: sarthak-19 <sarthak8858@git.wordpress.org>
Co-authored-by: westonruter <westonruter@git.wordpress.org>
Co-authored-by: swissspidy <swissspidy@git.wordpress.org>
Co-authored-by: felixarntz <flixos90@git.wordpress.org>
Co-authored-by: pbearne <pbearne@git.wordpress.org>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.

[felixarntz]

@sarthak-19 Thank you for the PR! This looks quite solid, a few suggestions and questions.

[westonruter]

FYI: I've added the CODECOV_TOKEN to the repository secrets.

[westonruter]

I suppose the one job will continue to fail since this PR was opened from a fork. I'll leave it to Felix to approve and merge.

[felixarntz]

Thanks for the PR @sarthak-19, LGTM!

Before we merge though: Doesn't one of us has to configure / set up this project on https://about.codecov.io/ first? 🤔

[westonruter]

@felixarntz I believe it's all already configured according to the steps listed at https://app.codecov.io/gh/WordPress/performance

The only thing outstanding is the third step, which is to merge into the preferred branch:

I'll do so now!

[westonruter]

Alas, no: https://github.com/WordPress/performance/actions/runs/11823769472/job/32943781732

[westonruter]

I've been chatting with @thelovekesh about what's going on.

For one, we're missing some additional -- arg separators since we're passing from npm to composer and then to phpunit. So here:

performance/.github/workflows/php-test-plugins.yml

Line 77 in 745c145

npm run test-php -- --coverage-clover=coverage-${{ github.sha }}.xml

performance/.github/workflows/php-test-plugins.yml

Line 84 in 745c145

npm run test-php-multisite -- --coverage-clover=coverage-multisite-${{ github.sha }}.xml

These need to instead be, respectively:

npm run test-php -- -- --coverage-clover=coverage-${{ github.sha }}.xml 

and

npm run test-php-multisite -- -- --coverage-clover=coverage-multisite-${{ github.sha }}.xml

Additionally, the coverage report for each plugin is getting overwritten to the same XML file. There needs to be separate XML files generated for each plugin.

Lovekesh has some additional thoughts.

[westonruter]

I've opened #1652 to disable Codecov for the time being.