Undefined array key "comment_closer"

[joachim-n]

Describe the bug

I use PHPCS as part of the unit tests for https://github.com/drupal-code-builder/drupal-code-builder. The code that runs PHPCS is within a custom PHPUnit constraint class: https://github.com/drupal-code-builder/drupal-code-builder/blob/4.5.x/Test/Constraint/CodeAdheresToCodingStandards.php

I've tried updating PHPCS to 4.0.0, and now when I run my tests I get this error:

1) /Users/joachim/Sites/dcb-repos-9/vendor/slevomat/coding-standard/SlevomatCodingStandard/Helpers/DocCommentHelper.php:70
Undefined array key "comment_closer"


Triggered by:

* DrupalCodeBuilder\Test\Unit\ComponentContentEntityType10Test::testContentEntityTypeFunctionalityOptions#owner
  /Users/joachim/Sites/dcb-repos-9/repos/drupal-code-builder/Test/Unit/ComponentContentEntityType10Test.php:179

I get this by running the tests in the one test class:

 vendor/bin/phpunit repos/drupal-code-builder/Test/Unit/ComponentContentEntityType10Test.php  --stop-on-defect 

What's really weird is that if I run JUST the test that is causing the error, it passes:

vendor/bin/phpunit repos/drupal-code-builder/Test/Unit/ComponentContentEntityType10Test.php  --stop-on-defect --filter=testEntityTypeWithTranslation

Versions (please complete the following information)

Operating System	MacOS 13.7.8
PHP version	8.3.8
PHP_CodeSniffer version	4.0.0
Standard	custom
Install type	Composer local

Additional context

Add any other context about the problem here.

Please confirm

• I have searched the issue list and am not opening a duplicate issue.
• I have read the Contribution Guidelines and this is not a support question.
• I confirm that this bug is a bug in PHP_CodeSniffer and not in one of the external standards.
• I have verified the issue still exists in the 4.x branch of PHP_CodeSniffer.

[jrfnl]

@joachim-n Could you please post a small code sample with which the issue is reproducable ?

I can also see straight off that the actual notice is coming from the SlevomatCodingStandard/Helpers/DocCommentHelper.php file, not from PHPCS itself, so I would be curious to hear if you did any investigating on whether Slevomat is at fault here or PHPCS ?
I remember another issue related to comment handling with PHPCS 4.x was posted a little while back in the Slevomat standard.

Also keep the following change in PHPCS 4.0 in mind:

All T_DOC_COMMENT_* tokens will now have the comment_opener and comment_closer indexes set.
This should allow for more flexibility for sniffs examining aspects of docblocks.

Source: https://github.com/PHPCSStandards/PHP_CodeSniffer/wiki/Version-4.0-Developer-Upgrade-Guide#other-tokenizer-changes

This may mean that some sniffs may need updating to account for comment tokens, other than the opener/closer, having those indexes.

[joachim-n]

I can confirm that if I add the sniff SlevomatCodingStandard.Commenting.ForbiddenComments to the excluded sniffs list, then everything works fine.

So you're right that it's in Slevomat, but the fact that it only fails when more than one test is run and passes on a single test made me think it was something not being cleaned up in the framework.

I'm also really confused why it fails after about 6 tests (if I run just that one test class) or 30 (if I run the whole test suite). All the tests will be looking at PHP code with comments in it.

The class \SlevomatCodingStandard\Helpers\SniffLocalCache looks a bit suspicious to me, but as it has absolutely no code comments explaining its working or its intention, I don't understand what it's trying to do.

[jrfnl]

@joachim-n I suggest you open an issue in the Slevomat repo with these questions. And possibly one for the Drupal repo about the test framework as they are not using the PHPCS native abstract test case.

To be honest, I don't see anything here which needs attention in the PHPCS repo.

[joachim-n]

And possibly one for the Drupal repo about the test framework as they are not using the PHPCS native abstract test case.

Do you mean in drupal/coder for their tests that cover their custom sniffs?

[jrfnl]

Do you mean in drupal/coder for their tests that cover their custom sniffs?

I do.

[joachim-n]

Done: https://www.drupal.org/project/coder/issues/3556694

[jrfnl]

@joachim-n Just saw the ticket. Let me be clear: I'm not recommending drupal/coder use the PHPCS native test framework. Whether a project does or doesn't is completely up to them.

All I was saying is that as drupal/coder does not use the PHPCS native test framework, debugging issues related to the test framework and potential caching artifacts when running the tests, is something which belongs in the drupal/coder repo, not in the PHPCS repo.