Merge pull request #67 from andrewnicols/testsMustHaveNamePattern

Test files must be named _test.php
moodlehq · Sep 22, 2023 · 0a4fc09 · 0a4fc09
2 parents 163c65d + 9d80834
commit 0a4fc09
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 6 deletions.
diff --git a/moodle/Tests/MoodleUtilTest.php b/moodle/Tests/MoodleUtilTest.php
@@ -476,27 +476,39 @@ public static function isUnitTestProvider(): array
     {
         return [
             'Not in tests directory' => [
-                'value' => '/path/to/standard/file.php',
+                'value' => '/path/to/standard/file_test.php',
                 'return' => false,
             ],
             'In tests directory' => [
-                'value' => '/path/to/standard/tests/file.php',
+                'value' => '/path/to/standard/tests/file_test.php',
                 'return' => true,
             ],
+            'In tests directory but missing _test suffix' => [
+                'value' => '/path/to/standard/tests/file.php',
+                'return' => false,
+            ],
+            'In tests directory but some idiot put a _test.php suffix on a directory' => [
+                'value' => '/path/to/standard/tests/some_test.php/file.php',
+                'return' => false,
+            ],
             'In test sub-directory' => [
-                'value' => '/path/to/standard/tests/sub/file.php',
+                'value' => '/path/to/standard/tests/sub/file_test.php',
                 'return' => true,
             ],
+            'In test sub-directory but missing _test suffix' => [
+                'value' => '/path/to/standard/tests/sub/file.php',
+                'return' => false,
+            ],
             'Generator' => [
-                'value' => '/path/to/standard/tests/generator/file.php',
+                'value' => '/path/to/standard/tests/generator/file_test.php',
                 'return' => false,
             ],
             'Fixture' => [
-                'value' => '/path/to/standard/tests/fixtures/file.php',
+                'value' => '/path/to/standard/tests/fixtures/file_test.php',
                 'return' => false,
             ],
             'Behat' => [
-                'value' => '/path/to/standard/tests/behat/behat_test_file.php',
+                'value' => '/path/to/standard/tests/behat/behat_test_file_test.php',
                 'return' => false,
             ],
         ];

diff --git a/moodle/Util/MoodleUtil.php b/moodle/Util/MoodleUtil.php
@@ -384,6 +384,11 @@ public static function getMoodleRoot(File $file = null, bool $selfPath = true) {
      */
     public static function isUnitTest(File $phpcsFile): bool
     {
+        // If the file isn't called, _test.php, nothing to check.
+        if (stripos(basename($phpcsFile->getFilename()), '_test.php') === false) {
+            return false;
+        }
+
         // If the file isn't under tests directory, nothing to check.
         if (stripos($phpcsFile->getFilename(), '/tests/') === false) {
             return false;