Support for Drupal 7 is ending on 5 January 2025—it’s time to migrate to Drupal 10! Learn about the many benefits of Drupal 10 and find migration tools in our resource center.Cleanup of PHPUnit tests.
Some tests are missing @covers and/or @coversDefaultClass documentation. This documentation is necessary for the generation of code coverage analysis. In short we can see which code has test coverage and how much. For more info https://phpunit.de/manual/current/en/code-coverage-analysis.html.
The documentation for the phpunit based test in Drupal can be found in #2057905: [policy, no patch] Discuss the standards for phpunit based tests.
In short:
- In the docblock of the class there needs to be @coversDefaultClass definition.
- In the docblock of a test function there needs to be one or more @covers definitions for every function (from the class being tested) that is being tested in that function.
Comments
Comment #1
Mile23Adding a thing I made to automate finding @covers errors.
Since we use @covers for both coverage and documentation, it's both a documentation and a code quality issue. I think setting this to be a documentation issue will get more traction than phpunit, and changes can be made in beta and rc because it's all in the docblocks.
Comment #2
Mile23Big 'ol patch with a lot of errors fixed: #2418237: Fix incorrect @covers in PHPUnit tests
Comment #3
jhodgdonChanging component. Not really documentation since I think scripts use these things, so they're kind of like annotation.
Comment #12
quietone CreditAttribution: quietone as a volunteer commentedDoing bugsmash triage.
Before the @covers can be added throughout core the policy issue, #2057905: [policy, no patch] Discuss the standards for phpunit based tests in the Coding Standards Project needs to be agreed on and then sniffs added. The use of @covers is listed in the Issue Summary over there, so this should be resolved. So what to do here. This could be closed or postponed. There are no children issue to consider. I think the best option is to close this as outdated and allow those working on adding @covers in the future to start fresh.
Therefore, closing as outdated. If this is incorrect reopen the issue, by setting the status to 'Active', and add a comment explaining what still needs to be done.
Thanks!