Improve error messages

sebastianbergmann · Jan 10, 2023 · 83eaffa · 83eaffa
1 parent a06279f
commit 83eaffa
Show file tree

Hide file tree

Showing 3 changed files with 51 additions and 23 deletions.
diff --git a/src/Runner/StandardTestSuiteLoader.php b/src/Runner/StandardTestSuiteLoader.php
@@ -47,7 +47,13 @@ public function load(string $suiteClassFile): ReflectionClass
             );
 
             if (empty($loadedClasses)) {
-                throw $this->exceptionFor($suiteClassName, $suiteClassFile);
+                throw new Exception(
+                    sprintf(
+                        'Class %s could not be found in %s',
+                        $suiteClassName,
+                        $suiteClassFile
+                    )
+                );
             }
         }
 
@@ -66,7 +72,13 @@ public function load(string $suiteClassFile): ReflectionClass
         }
 
         if (!class_exists($suiteClassName, false)) {
-            throw $this->exceptionFor($suiteClassName, $suiteClassFile);
+            throw new Exception(
+                sprintf(
+                    'Class %s could not be found in %s',
+                    $suiteClassName,
+                    $suiteClassFile
+                )
+            );
         }
 
         try {
@@ -81,7 +93,17 @@ public function load(string $suiteClassFile): ReflectionClass
         }
         // @codeCoverageIgnoreEnd
 
-        if ($class->isSubclassOf(TestCase::class) && !$class->isAbstract()) {
+        if ($class->isSubclassOf(TestCase::class)) {
+            if ($class->isAbstract()) {
+                throw new Exception(
+                    sprintf(
+                        'Class %s declared in %s is abstract',
+                        $suiteClassName,
+                        $suiteClassFile
+                    )
+                );
+            }
+
             return $class;
         }
 
@@ -91,34 +113,40 @@ public function load(string $suiteClassFile): ReflectionClass
                 // @codeCoverageIgnoreStart
             } catch (ReflectionException $e) {
                 throw new Exception(
-                    $e->getMessage(),
-                    $e->getCode(),
-                    $e
+                    sprintf(
+                        'Method %s::suite() declared in %s is abstract',
+                        $suiteClassName,
+                        $suiteClassFile
+                    )
                 );
             }
-            // @codeCoverageIgnoreEnd
 
-            if (!$method->isAbstract() && $method->isPublic() && $method->isStatic()) {
-                return $class;
+            if (!$method->isPublic()) {
+                throw new Exception(
+                    sprintf(
+                        'Method %s::suite() declared in %s is not public',
+                        $suiteClassName,
+                        $suiteClassFile
+                    )
+                );
+            }
+
+            if (!$method->isStatic()) {
+                throw new Exception(
+                    sprintf(
+                        'Method %s::suite() declared in %s is not static',
+                        $suiteClassName,
+                        $suiteClassFile
+                    )
+                );
             }
         }
 
-        throw $this->exceptionFor($suiteClassName, $suiteClassFile);
+        return $class;
     }
 
     public function reload(ReflectionClass $aClass): ReflectionClass
     {
         return $aClass;
     }
-
-    private function exceptionFor(string $className, string $filename): Exception
-    {
-        return new Exception(
-            sprintf(
-                "Class '%s' could not be found in '%s'.",
-                $className,
-                $filename
-            )
-        );
-    }
 }
diff --git a/tests/end-to-end/generic/abstract-test-class-with-test-suffix.phpt b/tests/end-to-end/generic/abstract-test-class-with-test-suffix.phpt
@@ -9,4 +9,4 @@ $_SERVER['argv'][] = __DIR__ . '/../../_files/AbstractTest.php';
 require_once __DIR__ . '/../../bootstrap.php';
 PHPUnit\TextUI\Command::main();
 --EXPECTF--
-Class 'PHPUnit\TestFixture\AbstractTest' could not be found in '%sAbstractTest.php'.
+Class PHPUnit\TestFixture\AbstractTest declared in %sAbstractTest.php is abstract
diff --git a/tests/end-to-end/generic/abstract-test-class-without-test-suffix.phpt b/tests/end-to-end/generic/abstract-test-class-without-test-suffix.phpt
@@ -9,4 +9,4 @@ $_SERVER['argv'][] = __DIR__ . '/../../_files/AbstractTestCase.php';
 require_once __DIR__ . '/../../bootstrap.php';
 PHPUnit\TextUI\Command::main();
 --EXPECTF--
-Class 'PHPUnit\TestFixture\AbstractTestCase' could not be found in '%sAbstractTestCase.php'.
+Class PHPUnit\TestFixture\AbstractTestCase declared in %sAbstractTestCase.php is abstract