Tests: Ticket annotations should not include any trailing characters

[jonsurrell]

PHPUnit tests use the @ticket 1234 annotation to reference tickets, but are also used as a PHPUnit group so that tests can be filtered like this:

phpunit --group 1234

Where only tests with the @ticket 1234 will run (or a 1234 group).

Some annotations include additional characters, such as a full stop "." or other details on the ticket line. This breaks the group-based ticket filtering.

Some changes would improve things:

• Trailing characters should be removed from the ticket numbers.
• The ticket to group matching should trim the ticket number from the annotation to match only the initial digits (something like /^\d+/).
• A PHP code sniff could prevent adding extra characters to the ticket number.

[jonsurrell]

Tests with tickets that will not currently match --group filtering as expected:

grep -ER '@ticket\s+[0-9]+[^0-9]' tests/phpunit/tests
tests/phpunit/tests/privacy/wpPrivacyGeneratePersonalDataExportGroupHtml.php:    * @ticket 46895 Updated to remove </h2> from test to avoid Count introducing failure.
tests/phpunit/tests/cron.php:    * @ticket 45976.
tests/phpunit/tests/cron.php:    * @ticket 45976.
tests/phpunit/tests/cron.php:    * @ticket 45976.
tests/phpunit/tests/db.php:                      * @ticket 56933.
tests/phpunit/tests/db.php:                      * @ticket 52506.
tests/phpunit/tests/formatting/date.php:                        // @ticket 56468.

Trac ticket: https://core.trac.wordpress.org/ticket/61238

There's one ticket annotation in an inline comment in a data provider from https://core.trac.wordpress.org/ticket/56468:

(Line 243 here)

​https://github.com/WordPress/wordpress-develop/blob/9614cf53784a8fd4391e4ac5e4156664e4264e7e/tests/phpunit/tests/formatting/date.php#L228-L249

I'm not quite sure what to do with that one.

[jonsurrell]

The ticket matching behavior is well documented:

​https://make.wordpress.org/core/handbook/testing/automated-testing/phpunit/#groups

[SergeyBiryukov]

In 58164:

Tests: Remove trailing characters from @ticket annotations.

Follow-up to [44693], [46209], [54230], [54733], [55151].

Props jonsurrell.
See #61238.

Thanks for the PR! Merged in r58164.

[jonsurrell]

Does anyone know where the @ticket annotations are processed? I found this function, but my changes to that file didn't seem to have any impact:

​https://github.com/WordPress/wordpress-develop/blob/236a7e0fbf12e650f109d62eacd7d90b47832847/tests/phpunit/includes/phpunit6/compat.php#L21-L39

I'd like to see if we could implement this idea:

The ticket to group matching should trim the ticket number from the annotation to match only the initial digits (something like /^\d+/).

Then this would be less likely to break in the future and tickets could include notes:

/**
 * @ticket 123 Make sure the thing isn't broken.
 */

[jonsurrell]

​`@ticket` is a PHPUnit annotation. I thought it was something special.

It doesn't look like something to change at the annotation-handling level.

This seems like something that could have a sniff. I think this ticket can be closed.