refactor: Type hint test execution methods to return TestResult objects.

Author: elwafa

src/Facades/VoltTest.php

@@ -12,7 +12,7 @@
  * @method static \VoltTest\VoltTest getVoltTest()
  * @method static \VoltTest\Laravel\VoltTestManager addTestFromClass(string|VoltTestCase $className)
  * @method static Collection getScenarios() :
- * @method static mixed run(bool $streamOutput = false)
+ * @method static \VoltTest\TestResult run(bool $streamOutput = false)
  *
  * @see \VoltTest\Laravel\VoltTestManager
  */

src/Testing/Listener/VoltTestListener.php

@@ -6,6 +6,7 @@
 
 use PHPUnit\Event\Test\Finished;
 use PHPUnit\Event\Test\FinishedSubscriber;
+use VoltTest\TestResult;
 
 class VoltTestListener implements FinishedSubscriber
 {
@@ -22,12 +23,8 @@ public function notify(Finished $event): void
     /**
      * Print the performance result to the console.
      */
-    protected function printResult(string $testName, mixed $result): void
+    protected function printResult(string $testName, TestResult $result): void
     {
-        // Check if result has the expected methods (duck typing)
-        if (! method_exists($result, 'getTotalRequests')) {
-            return;
-        }
 
         $output = "\n\n";
         $output .= "----------------------------------------------------------------------\n";
@@ -53,6 +50,7 @@ protected function shortenTestName(string $testName): string
         if (preg_match('/::(\w+)/', $testName, $matches)) {
             return $matches[1];
         }
+
         return $testName;
     }
 }

src/Testing/PerformanceTestCase.php

@@ -8,6 +8,7 @@
 use VoltTest\Laravel\Contracts\VoltTestCase as VoltTestCaseInterface;
 use VoltTest\Laravel\Facades\VoltTest;
 use VoltTest\Laravel\Testing\Assertions\VoltTestAssertions;
+use VoltTest\TestResult;
 
 /**
  * Base test case for VoltTest performance testing with PHPUnit.
@@ -278,7 +279,7 @@ public function createApplication()
     protected function runVoltTest(
         VoltTestCaseInterface $testClass,
         array $options = []
-    ): mixed {
+    ): TestResult {
         try {
             // Apply default options
             $options = array_merge([
@@ -331,7 +332,7 @@ protected function applyVoltTestOptions(array $options): void
     /**
      * Quick helper to run a simple URL load test.
      */
-    protected function loadTestUrl(string $url, array $options = []): mixed
+    protected function loadTestUrl(string $url, array $options = []): TestResult
     {
         $testClass = new class ($url) implements VoltTestCaseInterface {
             public function __construct(private string $url)
@@ -358,7 +359,7 @@ protected function loadTestApi(
         string $method = 'GET',
         array $data = [],
         array $options = []
-    ): mixed {
+    ): TestResult {
         $testClass = new class ($endpoint, $method, $data) implements VoltTestCaseInterface {
             public function __construct(
                 private string $endpoint,

src/VoltTestManager.php

@@ -8,6 +8,7 @@
 use Illuminate\Support\Collection;
 use VoltTest\Laravel\Contracts\VoltTestCase;
 use VoltTest\Laravel\Scenarios\LaravelScenario;
+use VoltTest\TestResult;
 use VoltTest\VoltTest;
 
 class VoltTestManager
@@ -101,9 +102,9 @@ public function scenario(string $name): LaravelScenario
      *
      * @param bool $streamOutput
      *
-     * @return mixed
+     * @return TestResult
      * */
-    public function run(bool $streamOutput = false): mixed
+    public function run(bool $streamOutput = false): TestResult
     {
         return $this->voltTest->run($streamOutput);
     }