Improve code coverage through annotations

[sarthak-19]

The current code coverage metrics are as follows :

and can be improved by addressing the following issues:

1. Ignore Coverage for Non-Critical Code Blocks:

   • Certain ubiquitous code blocks, such as:

     if ( ! defined( 'ABSPATH' ) ) {
         exit;
     } 

     These blocks can be excluded from code coverage by adding // @codeCoverageIgnoreStart and // @codeCoverageIgnoreEnd annotations.

2. Exclude Plugin Bootstrap Files from Coverage:

   • Files like plugin bootstrap files only include logic that is already tested elsewhere.
   • Evaluate marking uninstall.php as indirectly tested and decide whether similar exclusions are needed for files like hooks.php.

3. Add Missing @covers Annotations:

   • Ensure all tests have proper @covers annotations to map them to the code they validate. For instance:
     • \Test_OD_URL_Metric::test_constructor is missing a @covers ::get_uuid annotation.

4. Add Missing Tests:

   • Identify areas of the codebase that are not currently tested and write additional tests to improve overall coverage.

These changes aim to focus coverage metrics on critical functionality and ensure more accurate and meaningful reports, improving code quality and maintainability.

cc : @westonruter

[westonruter]

Ignore Coverage for Non-Critical Code Blocks:

See #1815

[westonruter]

Work underway for Optimization Detective in #1817.

[westonruter]

• decide whether similar exclusions are needed for files like hooks.php

See #1817 (comment). We could avoid adding coverage-exclusion comments if we ensure that no plugins define any functions in their hooks.php. If they simply call add_action() and add_filter() in hooks.php, then coverage could be obtained by adding a test that removes all actions and filters, does a require on the hooks.php file, and then asserts that the actions and filters are present.

[sarthak-19]

Work underway for Dominant Color Images in #1837