Merge branch '12.5'

* 12.5:
  Add tests for randomized execution order
  Add test for empty test suite
  Ignore unhappy paths that will become obsolete after refactoring to enumeration (for $order parameter) and boolean (for $orderDefects parameter)
  We should be able to assume that every Test is also a Reorderable
  Add tests for ordering tests by duration
  Fix CS/WS issues
  Initial work on new end-to-end tests for test suite sorting
  Delete code that was only used by tests in PHPUnit's own test suite (but still run twice for the entire test suite for each test suite that is run)
  Delete existing tests for test reordering

Author: sebastianbergmann

src/Runner/TestSuiteSorter.php

@@ -13,6 +13,7 @@
 use function array_merge;
 use function array_reverse;
 use function array_splice;
+use function assert;
 use function count;
 use function in_array;
 use function max;
@@ -57,16 +58,6 @@ final class TestSuiteSorter
     private array $defectSortOrder = [];
     private readonly ResultCache $cache;
 
-    /**
-     * @var array<string> A list of normalized names of tests before reordering
-     */
-    private array $originalExecutionOrder = [];
-
-    /**
-     * @var array<string> A list of normalized names of tests affected by reordering
-     */
-    private array $executionOrder = [];
-
     public function __construct(?ResultCache $cache = null)
     {
         $this->cache = $cache ?? new NullResultCache;
@@ -75,7 +66,7 @@ public function __construct(?ResultCache $cache = null)
     /**
      * @throws Exception
      */
-    public function reorderTestsInSuite(Test $suite, int $order, bool $resolveDependencies, int $orderDefects, bool $isRootTestSuite = true): void
+    public function reorderTestsInSuite(Test $suite, int $order, bool $resolveDependencies, int $orderDefects): void
     {
         $allowedOrders = [
             self::ORDER_DEFAULT,
@@ -86,7 +77,9 @@ public function reorderTestsInSuite(Test $suite, int $order, bool $resolveDepend
         ];
 
         if (!in_array($order, $allowedOrders, true)) {
+            // @codeCoverageIgnoreStart
             throw new InvalidOrderException;
+            // @codeCoverageIgnoreEnd
         }
 
         $allowedOrderDefects = [
@@ -95,16 +88,14 @@ public function reorderTestsInSuite(Test $suite, int $order, bool $resolveDepend
         ];
 
         if (!in_array($orderDefects, $allowedOrderDefects, true)) {
+            // @codeCoverageIgnoreStart
             throw new InvalidOrderException;
-        }
-
-        if ($isRootTestSuite) {
-            $this->originalExecutionOrder = $this->calculateTestExecutionOrder($suite);
+            // @codeCoverageIgnoreEnd
         }
 
         if ($suite instanceof TestSuite) {
             foreach ($suite as $_suite) {
-                $this->reorderTestsInSuite($_suite, $order, $resolveDependencies, $orderDefects, false);
+                $this->reorderTestsInSuite($_suite, $order, $resolveDependencies, $orderDefects);
             }
 
             if ($orderDefects === self::ORDER_DEFECTS_FIRST) {
@@ -113,26 +104,6 @@ public function reorderTestsInSuite(Test $suite, int $order, bool $resolveDepend
 
             $this->sort($suite, $order, $resolveDependencies, $orderDefects);
         }
-
-        if ($isRootTestSuite) {
-            $this->executionOrder = $this->calculateTestExecutionOrder($suite);
-        }
-    }
-
-    /**
-     * @return array<string>
-     */
-    public function getOriginalExecutionOrder(): array
-    {
-        return $this->originalExecutionOrder;
-    }
-
-    /**
-     * @return array<string>
-     */
-    public function getExecutionOrder(): array
-    {
-        return $this->executionOrder;
     }
 
     private function sort(TestSuite $suite, int $order, bool $resolveDependencies, int $orderDefects): void
@@ -260,9 +231,8 @@ private function sortBySize(array $tests): array
      */
     private function cmpDefectPriorityAndTime(Test $a, Test $b): int
     {
-        if (!($a instanceof Reorderable && $b instanceof Reorderable)) {
-            return 0;
-        }
+        assert($a instanceof Reorderable);
+        assert($b instanceof Reorderable);
 
         $priorityA = $this->defectSortOrder[$a->sortId()] ?? 0;
         $priorityB = $this->defectSortOrder[$b->sortId()] ?? 0;
@@ -340,24 +310,4 @@ private function resolveDependencies(array $tests): array
 
         return array_merge($newTestOrder, $tests);
     }
-
-    /**
-     * @return array<string>
-     */
-    private function calculateTestExecutionOrder(Test $suite): array
-    {
-        $tests = [];
-
-        if ($suite instanceof TestSuite) {
-            foreach ($suite->tests() as $test) {
-                if (!$test instanceof TestSuite && $test instanceof Reorderable) {
-                    $tests[] = $test->sortId();
-                } else {
-                    $tests = array_merge($tests, $this->calculateTestExecutionOrder($test));
-                }
-            }
-        }
-
-        return $tests;
-    }
 }