From 825a63e7bcb70f4f08af179530b2d73fb69aa126 Mon Sep 17 00:00:00 2001
From: Andrew Nicols <andrew@nicols.co.uk>
Date: Wed, 20 Mar 2024 13:13:36 +0800
Subject: [PATCH] Move unit test method Missing Docblock to new code

This allows it to be ignored in phpcs.xml.
---
 moodle/Sniffs/Commenting/MissingDocblockSniff.php        | 9 ++++++++-
 .../Tests/Sniffs/Commenting/MissingDocblockSniffTest.php | 2 +-
 2 files changed, 9 insertions(+), 2 deletions(-)

diff --git a/moodle/Sniffs/Commenting/MissingDocblockSniff.php b/moodle/Sniffs/Commenting/MissingDocblockSniff.php
index 69ccf17..a814b18 100644
--- 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
index fd88aa3..c444f55 100644
--- 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',
                 ],
             ],
         ];