Add more comments about namespace detection

sebastianbergmann · Aug 11, 2022 · 2bdc999 · 2bdc999
1 parent c1f34a7
commit 2bdc999
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 1 deletion.
diff --git a/src/Framework/TestSuite.php b/src/Framework/TestSuite.php
@@ -473,6 +473,7 @@ public function addTestFile(string $filename): void
                         $this->addTest($method->invoke(null, $className));
                     }
                 } elseif ($class->implementsInterface(Test::class)) {
+                    // Do we have modern namespacing ('Foo\Bar\WhizBangTest') or old-school namespacing ('Foo_Bar_WhizBangTest')?
                     $isPsr0            = (!$class->inNamespace()) && (strpos($class->getName(), '_') !== false);
                     $expectedClassName = $isPsr0 ? $className : $shortName;
 

diff --git a/src/Runner/StandardTestSuiteLoader.php b/src/Runner/StandardTestSuiteLoader.php
@@ -52,16 +52,18 @@ public function load(string $suiteClassFile): ReflectionClass
         }
 
         if (!class_exists($suiteClassName, false)) {
-            // this block will handle namespaced classes
+            // Perhaps this file defines a class inside a namespace? Let's check...
             $offset = 0 - strlen($suiteClassName);
 
             foreach ($loadedClasses as $loadedClass) {
+                // Detect modern namespace (eg './tests/Foo/Bar/WhizBangTest.php' <=> 'Foo\Bar\WhizBangTest')
                 if (stripos(substr($loadedClass, $offset - 1), '\\' . $suiteClassName) === 0) {
                     $suiteClassName = $loadedClass;
 
                     break;
                 }
 
+                // Detect old-school namespace (eg 'tests/Foo/Bar/WhizBangTest.php' <=> 'Foo_Bar_WhizBangTest'; #5020)
                 if (stripos(substr($loadedClass, $offset - 1), '_' . $suiteClassName) === 0) {
                     $suiteClassName = $loadedClass;