Add draft functionality to buffer TestDox output after reordering

sebastianbergmann · Nov 26, 2018 · 705e3aa · 705e3aa
1 parent d634df7
commit 705e3aa
Show file tree

Hide file tree

Showing 3 changed files with 83 additions and 5 deletions.
diff --git a/src/Runner/TestSuiteSorter.php b/src/Runner/TestSuiteSorter.php
@@ -349,12 +349,10 @@ private function calculateTestExecutionOrder(Test $suite): array
             foreach ($suite->tests() as $test) {
                 if (!($test instanceof TestSuite)) {
                     $tests[] = $this->getNormalizedTestName($test);
+                } else {
+                    $tests = \array_merge($tests, $this->calculateTestExecutionOrder($test));
                 }
             }
-
-            foreach ($suite as $_suite) {
-                $tests = \array_merge($tests, $this->calculateTestExecutionOrder($_suite));
-            }
         }
 
         return $tests;

diff --git a/src/TextUI/TestRunner.php b/src/TextUI/TestRunner.php
@@ -39,6 +39,7 @@
 use PHPUnit\Util\Log\JUnit;
 use PHPUnit\Util\Log\TeamCity;
 use PHPUnit\Util\Printer;
+use PHPUnit\Util\TestDox\CliTestDoxPrinter;
 use PHPUnit\Util\TestDox\HtmlResultPrinter;
 use PHPUnit\Util\TestDox\TextResultPrinter;
 use PHPUnit\Util\TestDox\XmlResultPrinter;
@@ -203,6 +204,7 @@ public function doRun(Test $suite, array $arguments = [], bool $exit = true): Te
             $sorter = new TestSuiteSorter($cache);
 
             $sorter->reorderTestsInSuite($suite, $arguments['executionOrder'], $arguments['resolveDependencies'], $arguments['executionOrderDefects']);
+            $originalExecutionOrder = $sorter->getOriginalExecutionOrder();
 
             unset($sorter);
         }
@@ -309,6 +311,11 @@ public function doRun(Test $suite, array $arguments = [], bool $exit = true): Te
                     $arguments['columns'],
                     $arguments['reverseList']
                 );
+
+                if (isset($originalExecutionOrder) && ($this->printer instanceof CliTestDoxPrinter)) {
+                    /* @var CliTestDoxPrinter */
+                    $this->printer->setOriginalExecutionOrder($originalExecutionOrder);
+                }
             }
         }
 

diff --git a/src/Util/TestDox/CliTestDoxPrinter.php b/src/Util/TestDox/CliTestDoxPrinter.php
@@ -46,13 +46,44 @@ class CliTestDoxPrinter extends ResultPrinter
      */
     private $prettifier;
 
+    /**
+     * @var int The number of test results received from the TestRunner
+     */
+    private $testCount = 0;
+
+    /**
+     * @var int The number of test results already sent to the output
+     */
+    private $testFlushCount = 0;
+
+    /**
+     * @var array Buffer for write()
+     */
+    private $outputBuffer = [];
+
+    /**
+     * @var bool
+     */
+    private $bufferExecutionOrder = false;
+
+    /**
+     * @var array array<string>
+     */
+    private $originalExecutionOrder = [];
+
     public function __construct($out = null, bool $verbose = false, $colors = self::COLOR_DEFAULT, bool $debug = false, $numberOfColumns = 80, bool $reverse = false)
     {
         parent::__construct($out, $verbose, $colors, $debug, $numberOfColumns, $reverse);
 
         $this->prettifier = new NamePrettifier;
     }
 
+    public function setOriginalExecutionOrder(array $order): void
+    {
+        $this->originalExecutionOrder = $order;
+        $this->bufferExecutionOrder   = !empty($order);
+    }
+
     public function startTest(Test $test): void
     {
         if (!$test instanceof TestCase && !$test instanceof PhptTestCase && !$test instanceof TestSuite) {
@@ -96,7 +127,20 @@ public function endTest(Test $test, float $time): void
 
         $this->currentTestResult->setRuntime($time);
 
-        $this->write($this->currentTestResult->toString($this->previousTestResult, $this->verbose));
+        $testName = '';
+        if ($test instanceof PhptTestCase) {
+            $testName = $test->getName();
+            $this->testCount++;
+        } elseif ($test instanceof TestCase) {
+            $testName = $test->getName(true);
+
+            if (\strpos($testName, '::') === false) {
+                $testName = \get_class($test) . '::' . $testName;
+            }
+            $this->testCount++;
+        }
+
+        $this->writeOriginalExecutionOrder($testName, $this->currentTestResult->toString($this->previousTestResult, $this->verbose));
 
         $this->previousTestResult = $this->currentTestResult;
 
@@ -156,6 +200,35 @@ public function addSkippedTest(Test $test, \Throwable $t, float $time): void
         );
     }
 
+    public function writeOriginalExecutionOrder(string $testname, string $msg): void
+    {
+        if (!$this->bufferExecutionOrder) {
+            $this->write($msg);
+
+            return;
+        }
+
+        if ($testname == $this->originalExecutionOrder[$this->testFlushCount]) {
+            $this->write($msg);
+            $this->testFlushCount++;
+
+            while (isset($this->outputBuffer[$this->originalExecutionOrder[$this->testFlushCount]])) {
+//                $this->write("** flushing {$this->originalExecutionOrder[$this->testFlushCount]}\n");
+                foreach($this->outputBuffer[$this->originalExecutionOrder[$this->testFlushCount++]] as $line) {
+                    $this->write($line);
+                }
+            }
+        } else {
+//            parent::write("** buffering $testname\n");
+            $this->outputBuffer[$testname][] = $msg;
+        }
+    }
+
+    public function write(string $msg): void
+    {
+        parent::write($msg);
+    }
+
     public function writeProgress(string $progress): void
     {
     }