Move unit test method Missing Docblock to new code

This allows it to be ignored in phpcs.xml.
moodlehq · Mar 20, 2024 · 825a63e · 825a63e
1 parent 24bc48a
commit 825a63e
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 2 deletions.
diff --git a/moodle/Sniffs/Commenting/MissingDocblockSniff.php b/moodle/Sniffs/Commenting/MissingDocblockSniff.php
@@ -180,7 +180,14 @@ protected function processFunctions(File $phpcsFile, int $stackPtr): void {
             $objectName = TokenUtil::getObjectName($phpcsFile, $typePtr);
             $objectType = TokenUtil::getObjectType($phpcsFile, $typePtr);
 
-            if ($extendsOrImplements) {
+            if ($isUnitTestFile) {
+                $phpcsFile->addWarning(
+                    'Missing docblock for %s %s',
+                    $typePtr,
+                    'MissingTestDescription',
+                    [$objectType, $objectName]
+                );
+            } elseif ($extendsOrImplements) {
                 $phpcsFile->addWarning('Missing docblock for %s %s', $typePtr, 'Missing', [$objectType, $objectName]);
             } else {
                 $phpcsFile->addError('Missing docblock for %s %s', $typePtr, 'Missing', [$objectType, $objectName]);

diff --git a/moodle/Tests/Sniffs/Commenting/MissingDocblockSniffTest.php b/moodle/Tests/Sniffs/Commenting/MissingDocblockSniffTest.php
@@ -136,7 +136,7 @@ public static function docblockCorrectnessProvider(): array {
                     3 => 'Missing docblock for class example_test',
                 ],
                 'warnings' => [
-                    12 => 'Missing docblock for function test_the_thing',
+                    12 => 'Missing unit test docblock for function test_the_thing',
                 ],
             ],
         ];