Merge pull request #68 from andrewnicols/providerNameContainsParents

Remove parens from dataProvider names
moodlehq · Sep 22, 2023 · c67abee · c67abee
2 parents 0a4fc09 + f634dbf
commit c67abee
Show file tree

Hide file tree

Showing 4 changed files with 56 additions and 0 deletions.
diff --git a/moodle/Sniffs/PHPUnit/TestCaseProviderSniff.php b/moodle/Sniffs/PHPUnit/TestCaseProviderSniff.php
@@ -193,6 +193,24 @@ protected function checkDataProvider(
             );
         }
 
+        if (substr($methodName, -2) === '()') {
+            $fix = $file->addFixableWarning(
+                'Data provider should not end with "()". "%s" provided.',
+                $pointer + 2,
+                'dataProviderSyntaxMethodnameContainsParenthesis',
+                [
+                    $methodName,
+                ]
+            );
+
+            $methodName = substr($methodName, 0, -2);
+            if ($fix) {
+                $file->fixer->beginChangeset();
+                $file->fixer->replaceToken($pointer + 2, $methodName);
+                $file->fixer->endChangeset();
+            }
+        }
+
         // Find the method itself.
         $classPointer = $file->findPrevious(T_CLASS, $pointer - 1);
         $providerPointer = MoodleUtil::findClassMethodPointer($file, $classPointer, $methodName);

diff --git a/moodle/Tests/PHPUnitTestCaseProviderTest.php b/moodle/Tests/PHPUnitTestCaseProviderTest.php
@@ -50,6 +50,14 @@ public function provider_phpunit_data_providers() {
                 'warnings' => [
                 ],
             ],
+            'Provider has Parenthesis' => [
+                'fixture' => 'fixtures/phpunit/provider/provider_parents_test.php',
+                'errors' => [
+                ],
+                'warnings' => [
+                    6 => 'Data provider should not end with "()". "provider()" provided.',
+                ],
+            ],
             'Provider Visibility' => [
                 'fixture' => 'fixtures/phpunit/provider/provider_visibility_test.php',
                 'errors' => [

diff --git a/moodle/Tests/fixtures/phpunit/provider/provider_parents_test.php b/moodle/Tests/fixtures/phpunit/provider/provider_parents_test.php
@@ -0,0 +1,15 @@
+<?php
+defined('MOODLE_INTERNAL') || die(); // Make this always the 1st line in all CS fixtures.
+
+class provider_casing_test extends base_test {
+    /**
+     * @dataProvider provider()
+     */
+    public function test_one(): void {
+        // Nothing to test.
+    }
+
+    public static function provider(): array {
+        return [];
+    }
+}
diff --git a/moodle/Tests/fixtures/phpunit/provider/provider_parents_test.php.fixed b/moodle/Tests/fixtures/phpunit/provider/provider_parents_test.php.fixed
@@ -0,0 +1,15 @@
+<?php
+defined('MOODLE_INTERNAL') || die(); // Make this always the 1st line in all CS fixtures.
+
+class provider_casing_test extends base_test {
+    /**
+     * @dataProvider provider
+     */
+    public function test_one(): void {
+        // Nothing to test.
+    }
+
+    public static function provider(): array {
+        return [];
+    }
+}