/
home
/
sjslayjy
/
public_html
/
theweavenest
/
vendor
/
phpunit
/
phpunit
/
tests
/
unit
/
Runner
/
Upload File
HOME
<?php declare(strict_types=1); /* * This file is part of PHPUnit. * * (c) Sebastian Bergmann <sebastian@phpunit.de> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */ namespace PHPUnit\Runner; use function mt_srand; use function sprintf; use MultiDependencyTest; use NotReorderableTest; use PHPUnit\Framework\TestCase; use PHPUnit\Framework\TestSuite; use PHPUnit\TestFixture\EmptyTestCaseTest; use PHPUnit\TestFixture\FailureTest; use PHPUnit\TestFixture\Success; use PHPUnit\TestFixture\TestWithDifferentSizes; /** * @testdox Reordering test execution * * @group test-reorder * * @small */ final class TestSuiteSorterTest extends TestCase { /** * Constants to improve clarity of @dataprovider. */ private const IGNORE_DEPENDENCIES = false; private const RESOLVE_DEPENDENCIES = true; private const MULTIDEPENDENCYTEST_EXECUTION_ORDER = [ MultiDependencyTest::class . '::testOne', MultiDependencyTest::class . '::testTwo', MultiDependencyTest::class . '::testThree', MultiDependencyTest::class . '::testFour', MultiDependencyTest::class . '::testFive', ]; public function testThrowsExceptionWhenUsingInvalidOrderOption(): void { $suite = new TestSuite; $suite->addTestSuite(MultiDependencyTest::class); $sorter = new TestSuiteSorter; $this->expectException(Exception::class); $this->expectExceptionMessage('$order must be one of TestSuiteSorter::ORDER_[DEFAULT|REVERSED|RANDOMIZED|DURATION|SIZE]'); $sorter->reorderTestsInSuite($suite, -1, false, TestSuiteSorter::ORDER_DEFAULT); } public function testThrowsExceptionWhenUsingInvalidOrderDefectsOption(): void { $suite = new TestSuite; $suite->addTestSuite(MultiDependencyTest::class); $sorter = new TestSuiteSorter; $this->expectException(Exception::class); $this->expectExceptionMessage('$orderDefects must be one of TestSuiteSorter::ORDER_DEFAULT, TestSuiteSorter::ORDER_DEFECTS_FIRST'); $sorter->reorderTestsInSuite($suite, TestSuiteSorter::ORDER_DEFAULT, false, -1); } /** * @testdox Empty TestSuite not affected (order=$order, resolve=$resolveDependencies, defects=$orderDefects) * * @dataProvider suiteSorterOptionPermutationsProvider */ public function testShouldNotAffectEmptyTestSuite(int $order, bool $resolveDependencies, int $orderDefects): void { $sorter = new TestSuiteSorter; $suite = new TestSuite; $sorter->reorderTestsInSuite($suite, $order, $resolveDependencies, $orderDefects); $this->assertEmpty($suite->tests()); $this->assertEmpty($sorter->getOriginalExecutionOrder()); $this->assertEmpty($sorter->getExecutionOrder()); } /** * @dataProvider commonSorterOptionsProvider */ public function testBasicExecutionOrderOptions(int $order, bool $resolveDependencies, array $expectedOrder): void { $suite = new TestSuite; $suite->addTestSuite(MultiDependencyTest::class); $sorter = new TestSuiteSorter; $sorter->reorderTestsInSuite($suite, $order, $resolveDependencies, TestSuiteSorter::ORDER_DEFAULT); $this->assertSame(self::MULTIDEPENDENCYTEST_EXECUTION_ORDER, $sorter->getOriginalExecutionOrder()); $this->assertSame($expectedOrder, $sorter->getExecutionOrder()); } public function testCanSetRandomizationWithASeed(): void { $suite = new TestSuite; $suite->addTestSuite(MultiDependencyTest::class); $sorter = new TestSuiteSorter; mt_srand(54321); $sorter->reorderTestsInSuite($suite, TestSuiteSorter::ORDER_RANDOMIZED, false, TestSuiteSorter::ORDER_DEFAULT); $expectedOrder = [ MultiDependencyTest::class . '::testTwo', MultiDependencyTest::class . '::testFour', MultiDependencyTest::class . '::testFive', MultiDependencyTest::class . '::testThree', MultiDependencyTest::class . '::testOne', ]; $this->assertSame($expectedOrder, $sorter->getExecutionOrder()); } public function testCanSetRandomizationWithASeedAndResolveDependencies(): void { $suite = new TestSuite; $suite->addTestSuite(MultiDependencyTest::class); $sorter = new TestSuiteSorter; mt_srand(54321); $sorter->reorderTestsInSuite($suite, TestSuiteSorter::ORDER_RANDOMIZED, true, TestSuiteSorter::ORDER_DEFAULT); $expectedOrder = [ MultiDependencyTest::class . '::testTwo', MultiDependencyTest::class . '::testFive', MultiDependencyTest::class . '::testOne', MultiDependencyTest::class . '::testThree', MultiDependencyTest::class . '::testFour', ]; $this->assertSame($expectedOrder, $sorter->getExecutionOrder()); } /** * @dataProvider orderDurationWithoutCacheProvider */ public function testOrderDurationWithoutCache(bool $resolveDependencies, array $expected): void { $suite = new TestSuite; $suite->addTestSuite(MultiDependencyTest::class); $sorter = new TestSuiteSorter; $sorter->reorderTestsInSuite( $suite, TestSuiteSorter::ORDER_DURATION, $resolveDependencies, TestSuiteSorter::ORDER_DEFAULT, ); $this->assertSame($expected, $sorter->getExecutionOrder()); } public function orderDurationWithoutCacheProvider(): array { return [ 'dependency-ignore' => [ self::IGNORE_DEPENDENCIES, [ MultiDependencyTest::class . '::testOne', MultiDependencyTest::class . '::testTwo', MultiDependencyTest::class . '::testThree', MultiDependencyTest::class . '::testFour', MultiDependencyTest::class . '::testFive', ], ], 'dependency-resolve' => [ self::RESOLVE_DEPENDENCIES, [ MultiDependencyTest::class . '::testOne', MultiDependencyTest::class . '::testTwo', MultiDependencyTest::class . '::testThree', MultiDependencyTest::class . '::testFour', MultiDependencyTest::class . '::testFive', ], ], ]; } /** * @dataProvider orderDurationWithCacheProvider */ public function testOrderDurationWithCache(bool $resolveDependencies, array $testTimes, array $expected): void { $suite = new TestSuite; $suite->addTestSuite(MultiDependencyTest::class); $cache = new DefaultTestResultCache; foreach ($testTimes as $testName => $time) { $cache->setTime(MultiDependencyTest::class . '::' . $testName, $time); } $sorter = new TestSuiteSorter($cache); $sorter->reorderTestsInSuite( $suite, TestSuiteSorter::ORDER_DURATION, $resolveDependencies, TestSuiteSorter::ORDER_DEFAULT, ); $this->assertSame($expected, $sorter->getExecutionOrder()); } public function orderDurationWithCacheProvider(): array { return [ 'duration-same-dependency-ignore' => [ self::IGNORE_DEPENDENCIES, [ 'testOne' => 1, 'testTwo' => 1, 'testThree' => 1, 'testFour' => 1, 'testFive' => 1, ], [ MultiDependencyTest::class . '::testOne', MultiDependencyTest::class . '::testTwo', MultiDependencyTest::class . '::testThree', MultiDependencyTest::class . '::testFour', MultiDependencyTest::class . '::testFive', ], ], 'duration-same-dependency-resolve' => [ self::RESOLVE_DEPENDENCIES, [ 'testOne' => 1, 'testTwo' => 1, 'testThree' => 1, 'testFour' => 1, 'testFive' => 1, ], [ MultiDependencyTest::class . '::testOne', MultiDependencyTest::class . '::testTwo', MultiDependencyTest::class . '::testThree', MultiDependencyTest::class . '::testFour', MultiDependencyTest::class . '::testFive', ], ], 'duration-different-dependency-ignore' => [ self::IGNORE_DEPENDENCIES, [ 'testOne' => 5, 'testTwo' => 3, 'testThree' => 4, 'testFour' => 1, 'testFive' => 2, ], [ MultiDependencyTest::class . '::testFour', MultiDependencyTest::class . '::testFive', MultiDependencyTest::class . '::testTwo', MultiDependencyTest::class . '::testThree', MultiDependencyTest::class . '::testOne', ], ], 'duration-different-dependency-resolve' => [ self::RESOLVE_DEPENDENCIES, [ 'testOne' => 5, 'testTwo' => 3, 'testThree' => 4, 'testFour' => 1, 'testFive' => 2, ], [ MultiDependencyTest::class . '::testFive', MultiDependencyTest::class . '::testTwo', MultiDependencyTest::class . '::testOne', MultiDependencyTest::class . '::testThree', MultiDependencyTest::class . '::testFour', ], ], ]; } /** * @dataProvider defectsSorterOptionsProvider */ public function testSuiteSorterDefectsOptions(int $order, bool $resolveDependencies, array $runState, array $expected): void { $suite = new TestSuite; $suite->addTestSuite(MultiDependencyTest::class); $cache = new DefaultTestResultCache; foreach ($runState as $testName => $data) { $cache->setState(MultiDependencyTest::class . '::' . $testName, $data['state']); $cache->setTime(MultiDependencyTest::class . '::' . $testName, $data['time']); } $sorter = new TestSuiteSorter($cache); $sorter->reorderTestsInSuite($suite, $order, $resolveDependencies, TestSuiteSorter::ORDER_DEFECTS_FIRST); $this->assertSame($expected, $sorter->getExecutionOrder()); } /** * A @dataprovider for basic execution reordering options based on MultiDependencyTest. * * This class has the following relevant properties: * * - it has five tests 'testOne' ... 'testFive' * - 'testThree' @depends on both 'testOne' and 'testTwo' * - 'testFour' @depends on 'MultiDependencyTest::testThree' to test FQN @depends * - 'testFive' has no dependencies */ public function commonSorterOptionsProvider(): array { return [ 'default' => [ TestSuiteSorter::ORDER_DEFAULT, self::IGNORE_DEPENDENCIES, [ MultiDependencyTest::class . '::testOne', MultiDependencyTest::class . '::testTwo', MultiDependencyTest::class . '::testThree', MultiDependencyTest::class . '::testFour', MultiDependencyTest::class . '::testFive', ], ], // Activating dependency resolution should have no effect under normal circumstances 'resolve default' => [ TestSuiteSorter::ORDER_DEFAULT, self::RESOLVE_DEPENDENCIES, [ MultiDependencyTest::class . '::testOne', MultiDependencyTest::class . '::testTwo', MultiDependencyTest::class . '::testThree', MultiDependencyTest::class . '::testFour', MultiDependencyTest::class . '::testFive', ], ], // Reversing without checks should give a simple reverse order 'reverse' => [ TestSuiteSorter::ORDER_REVERSED, self::IGNORE_DEPENDENCIES, [ MultiDependencyTest::class . '::testFive', MultiDependencyTest::class . '::testFour', MultiDependencyTest::class . '::testThree', MultiDependencyTest::class . '::testTwo', MultiDependencyTest::class . '::testOne', ], ], // Reversing with resolution still allows testFive to move to front, testTwo before testOne 'resolve reverse' => [ TestSuiteSorter::ORDER_REVERSED, self::RESOLVE_DEPENDENCIES, [ MultiDependencyTest::class . '::testFive', MultiDependencyTest::class . '::testTwo', MultiDependencyTest::class . '::testOne', MultiDependencyTest::class . '::testThree', MultiDependencyTest::class . '::testFour', ], ], ]; } /** * A @dataprovider for testing defects execution reordering options based on MultiDependencyTest. * * This class has the following relevant properties: * * - it has five tests 'testOne' ... 'testFive' * - 'testThree' @depends on both 'testOne' and 'testTwo' * - 'testFour' @depends on 'MultiDependencyTest::testThree' to test FQN @depends * - 'testFive' has no dependencies */ public function defectsSorterOptionsProvider(): array { return [ // The most simple situation should work as normal 'default, no defects' => [ TestSuiteSorter::ORDER_DEFAULT, self::IGNORE_DEPENDENCIES, [ 'testOne' => ['state' => BaseTestRunner::STATUS_PASSED, 'time' => 1], 'testTwo' => ['state' => BaseTestRunner::STATUS_PASSED, 'time' => 1], 'testThree' => ['state' => BaseTestRunner::STATUS_PASSED, 'time' => 1], 'testFour' => ['state' => BaseTestRunner::STATUS_PASSED, 'time' => 1], 'testFive' => ['state' => BaseTestRunner::STATUS_PASSED, 'time' => 1], ], [ MultiDependencyTest::class . '::testOne', MultiDependencyTest::class . '::testTwo', MultiDependencyTest::class . '::testThree', MultiDependencyTest::class . '::testFour', MultiDependencyTest::class . '::testFive', ], ], // Running with an empty cache should not spook the TestSuiteSorter 'default, empty result cache' => [ TestSuiteSorter::ORDER_DEFAULT, self::IGNORE_DEPENDENCIES, [ // empty result cache ], [ MultiDependencyTest::class . '::testOne', MultiDependencyTest::class . '::testTwo', MultiDependencyTest::class . '::testThree', MultiDependencyTest::class . '::testFour', MultiDependencyTest::class . '::testFive', ], ], // testFive is independent and can be moved to the front 'default, testFive skipped' => [ TestSuiteSorter::ORDER_DEFAULT, self::IGNORE_DEPENDENCIES, [ 'testOne' => ['state' => BaseTestRunner::STATUS_PASSED, 'time' => 1], 'testTwo' => ['state' => BaseTestRunner::STATUS_PASSED, 'time' => 1], 'testThree' => ['state' => BaseTestRunner::STATUS_PASSED, 'time' => 1], 'testFour' => ['state' => BaseTestRunner::STATUS_PASSED, 'time' => 1], 'testFive' => ['state' => BaseTestRunner::STATUS_SKIPPED, 'time' => 1], ], [ MultiDependencyTest::class . '::testFive', MultiDependencyTest::class . '::testOne', MultiDependencyTest::class . '::testTwo', MultiDependencyTest::class . '::testThree', MultiDependencyTest::class . '::testFour', ], ], // Defects in testFive and testTwo, but the faster testFive should be run first 'default, testTwo testFive skipped' => [ TestSuiteSorter::ORDER_DEFAULT, self::IGNORE_DEPENDENCIES, [ 'testOne' => ['state' => BaseTestRunner::STATUS_PASSED, 'time' => 1], 'testTwo' => ['state' => BaseTestRunner::STATUS_SKIPPED, 'time' => 1], 'testThree' => ['state' => BaseTestRunner::STATUS_PASSED, 'time' => 1], 'testFour' => ['state' => BaseTestRunner::STATUS_PASSED, 'time' => 1], 'testFive' => ['state' => BaseTestRunner::STATUS_SKIPPED, 'time' => 0], ], [ MultiDependencyTest::class . '::testFive', MultiDependencyTest::class . '::testTwo', MultiDependencyTest::class . '::testOne', MultiDependencyTest::class . '::testThree', MultiDependencyTest::class . '::testFour', ], ], // Skipping testThree will move it to the front when ignoring dependencies 'default, testThree skipped' => [ TestSuiteSorter::ORDER_DEFAULT, self::IGNORE_DEPENDENCIES, [ 'testOne' => ['state' => BaseTestRunner::STATUS_PASSED, 'time' => 1], 'testTwo' => ['state' => BaseTestRunner::STATUS_PASSED, 'time' => 1], 'testThree' => ['state' => BaseTestRunner::STATUS_SKIPPED, 'time' => 1], 'testFour' => ['state' => BaseTestRunner::STATUS_PASSED, 'time' => 1], 'testFive' => ['state' => BaseTestRunner::STATUS_PASSED, 'time' => 1], ], [ MultiDependencyTest::class . '::testThree', MultiDependencyTest::class . '::testOne', MultiDependencyTest::class . '::testTwo', MultiDependencyTest::class . '::testFour', MultiDependencyTest::class . '::testFive', ], ], // Skipping testThree will move it to the front but behind its dependencies 'default resolve, testThree skipped' => [ TestSuiteSorter::ORDER_DEFAULT, self::RESOLVE_DEPENDENCIES, [ 'testOne' => ['state' => BaseTestRunner::STATUS_PASSED, 'time' => 1], 'testTwo' => ['state' => BaseTestRunner::STATUS_PASSED, 'time' => 1], 'testThree' => ['state' => BaseTestRunner::STATUS_SKIPPED, 'time' => 1], 'testFour' => ['state' => BaseTestRunner::STATUS_PASSED, 'time' => 1], 'testFive' => ['state' => BaseTestRunner::STATUS_PASSED, 'time' => 1], ], [ MultiDependencyTest::class . '::testOne', MultiDependencyTest::class . '::testTwo', MultiDependencyTest::class . '::testThree', MultiDependencyTest::class . '::testFour', MultiDependencyTest::class . '::testFive', ], ], // Skipping testThree will move it to the front and keep the others reversed 'reverse, testThree skipped' => [ TestSuiteSorter::ORDER_REVERSED, self::IGNORE_DEPENDENCIES, [ 'testOne' => ['state' => BaseTestRunner::STATUS_PASSED, 'time' => 1], 'testTwo' => ['state' => BaseTestRunner::STATUS_PASSED, 'time' => 1], 'testThree' => ['state' => BaseTestRunner::STATUS_SKIPPED, 'time' => 1], 'testFour' => ['state' => BaseTestRunner::STATUS_PASSED, 'time' => 1], 'testFive' => ['state' => BaseTestRunner::STATUS_PASSED, 'time' => 1], ], [ MultiDependencyTest::class . '::testThree', MultiDependencyTest::class . '::testFive', MultiDependencyTest::class . '::testFour', MultiDependencyTest::class . '::testTwo', MultiDependencyTest::class . '::testOne', ], ], // Demonstrate a limit of the dependency resolver: after sorting defects to the front, // the resolver will mark testFive done before testThree because of dependencies 'default resolve, testThree skipped, testFive fast' => [ TestSuiteSorter::ORDER_DEFAULT, self::RESOLVE_DEPENDENCIES, [ 'testOne' => ['state' => BaseTestRunner::STATUS_PASSED, 'time' => 1], 'testTwo' => ['state' => BaseTestRunner::STATUS_PASSED, 'time' => 1], 'testThree' => ['state' => BaseTestRunner::STATUS_SKIPPED, 'time' => 0], 'testFour' => ['state' => BaseTestRunner::STATUS_PASSED, 'time' => 1], 'testFive' => ['state' => BaseTestRunner::STATUS_SKIPPED, 'time' => 1], ], [ MultiDependencyTest::class . '::testFive', MultiDependencyTest::class . '::testOne', MultiDependencyTest::class . '::testTwo', MultiDependencyTest::class . '::testThree', MultiDependencyTest::class . '::testFour', ], ], // Torture test // - incomplete TestResultCache // - skipped testThree: will move it to the front as far as possible // - testOne and testTwo are required before testThree, but can be reversed locally // - testFive is independent will remain reversed up front 'reverse resolve, testThree skipped' => [ TestSuiteSorter::ORDER_REVERSED, self::RESOLVE_DEPENDENCIES, [ 'testOne' => ['state' => BaseTestRunner::STATUS_PASSED, 'time' => 1], 'testTwo' => ['state' => BaseTestRunner::STATUS_PASSED, 'time' => 1], 'testThree' => ['state' => BaseTestRunner::STATUS_SKIPPED, 'time' => 1], ], [ MultiDependencyTest::class . '::testFive', MultiDependencyTest::class . '::testTwo', MultiDependencyTest::class . '::testOne', MultiDependencyTest::class . '::testThree', MultiDependencyTest::class . '::testFour', ], ], // Make sure the dependency resolver is not confused by failing tests. // Scenario: Four has a @depends on Three and fails. Result: Three is still run first // testFive also fails but can be moved around freely and will be up front. 'depends first, then defects' => [ TestSuiteSorter::ORDER_DEFAULT, self::RESOLVE_DEPENDENCIES, [ 'testOne' => ['state' => BaseTestRunner::STATUS_PASSED, 'time' => 1], 'testTwo' => ['state' => BaseTestRunner::STATUS_PASSED, 'time' => 1], 'testThree' => ['state' => BaseTestRunner::STATUS_PASSED, 'time' => 1], 'testFour' => ['state' => BaseTestRunner::STATUS_FAILURE, 'time' => 1], 'testFive' => ['state' => BaseTestRunner::STATUS_FAILURE, 'time' => 1], ], [ MultiDependencyTest::class . '::testFive', MultiDependencyTest::class . '::testOne', MultiDependencyTest::class . '::testTwo', MultiDependencyTest::class . '::testThree', MultiDependencyTest::class . '::testFour', ], ], ]; } /** * @see https://github.com/lstrojny/phpunit-clever-and-smart/issues/38 */ public function testCanHandleSuiteWithEmptyTestCase(): void { $suite = new TestSuite; $suite->addTestSuite(EmptyTestCaseTest::class); $sorter = new TestSuiteSorter; $sorter->reorderTestsInSuite($suite, TestSuiteSorter::ORDER_DEFAULT, false, TestSuiteSorter::ORDER_DEFAULT); $this->assertSame(EmptyTestCaseTest::class, $suite->tests()[0]->getName()); $this->assertSame( sprintf( 'No tests found in class "%s".', EmptyTestCaseTest::class, ), $suite->tests()[0]->tests()[0]->getMessage(), ); } public function suiteSorterOptionPermutationsProvider(): array { $orderValues = [TestSuiteSorter::ORDER_DEFAULT, TestSuiteSorter::ORDER_REVERSED, TestSuiteSorter::ORDER_RANDOMIZED]; $resolveValues = [false, true]; $orderDefectsValues = [TestSuiteSorter::ORDER_DEFAULT, TestSuiteSorter::ORDER_DEFECTS_FIRST]; $data = []; foreach ($orderValues as $order) { foreach ($resolveValues as $resolve) { foreach ($orderDefectsValues as $orderDefects) { $data[] = [$order, $resolve, $orderDefects]; } } } return $data; } public function testOrderBySize(): void { $suite = new TestSuite; $suite->addTestSuite(TestWithDifferentSizes::class); $sorter = new TestSuiteSorter; $sorter->reorderTestsInSuite($suite, TestSuiteSorter::ORDER_SIZE, true, TestSuiteSorter::ORDER_DEFAULT); $expectedOrder = [ TestWithDifferentSizes::class . '::testDataProviderWithSizeSmall with data set #0', TestWithDifferentSizes::class . '::testDataProviderWithSizeSmall with data set #1', TestWithDifferentSizes::class . '::testDataProviderWithSizeMedium with data set #0', TestWithDifferentSizes::class . '::testDataProviderWithSizeMedium with data set #1', TestWithDifferentSizes::class . '::testWithSizeMedium', TestWithDifferentSizes::class . '::testWithSizeLarge', TestWithDifferentSizes::class . '::testWithSizeSmall', TestWithDifferentSizes::class . '::testWithSizeUnknown', ]; $this->assertSame($expectedOrder, $sorter->getExecutionOrder()); } public function testSorterQuietlyIgnoresNonReorderable(): void { $suite = new TestSuite; $testCollection = [new Success, new NotReorderableTest, new FailureTest]; $suite->setTests($testCollection); $sorter = new TestSuiteSorter; $sorter->reorderTestsInSuite($suite, TestSuiteSorter::ORDER_DURATION, true, TestSuiteSorter::ORDER_DEFECTS_FIRST); $this->assertEquals($testCollection, $suite->tests()); } }