TestSuiteBuilder.php

<?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\Event\TestSuite;

use function assert;
use function class_exists;
use function count;
use function explode;
use function method_exists;
use function strpos;
use function substr;
use PHPUnit\Event\Code\Test;
use PHPUnit\Event\Code\TestCollection;
use PHPUnit\Event\RuntimeException;
use PHPUnit\Framework\DataProviderTestSuite;
use PHPUnit\Framework\RepeatTestSuite;
use PHPUnit\Framework\TestCase;
use PHPUnit\Framework\TestSuite as FrameworkTestSuite;
use PHPUnit\Runner\Phpt\TestCase as PhptTestCase;
use ReflectionClass;
use ReflectionMethod;

/**
 * @no-named-arguments Parameter names are not covered by the backward compatibility promise for PHPUnit
 *
 * @internal This class is not covered by the backward compatibility promise for PHPUnit
 */
final readonly class TestSuiteBuilder
{
    /**
     * @throws RuntimeException
     */
    public static function from(FrameworkTestSuite $testSuite): TestSuite
    {
        $tests = [];

        self::process($testSuite, $tests);

        if ($testSuite instanceof DataProviderTestSuite) {
            assert(count(explode('::', $testSuite->name())) === 2);
            [$className, $methodName] = explode('::', $testSuite->name());

            assert(class_exists($className));
            assert($methodName !== '' && method_exists($className, $methodName));

            $reflector = new ReflectionMethod($className, $methodName);

            $file = $reflector->getFileName();
            $line = $reflector->getStartLine();

            assert($file !== false);
            assert($line !== false);

            return new TestSuiteForTestMethodWithDataProvider(
                $testSuite->name(),
                $testSuite->count(),
                TestCollection::fromArray($tests),
                $className,
                $methodName,
                $file,
                $line,
            );
        }

        if ($testSuite instanceof RepeatTestSuite) {
            $name = $testSuite->name();

            $separatorPosition = strpos($name, '::');

            assert($separatorPosition !== false);

            $className  = substr($name, 0, $separatorPosition);
            $methodName = substr($name, $separatorPosition + 2);

            $hashPosition = strpos($methodName, '#');

            if ($hashPosition !== false) {
                $methodName = substr($methodName, 0, $hashPosition);
            }

            assert($className !== '' && class_exists($className));
            assert($methodName !== '' && method_exists($className, $methodName));

            $reflector = new ReflectionMethod($className, $methodName);

            $file = $reflector->getFileName();
            $line = $reflector->getStartLine();

            assert($file !== false);
            assert($line !== false);

            return new TestSuiteForRepeatedTestMethod(
                $name,
                $testSuite->count(),
                TestCollection::fromArray($tests),
                $className,
                $methodName,
                $file,
                $line,
            );
        }

        if ($testSuite->isForTestClass()) {
            $testClassName = $testSuite->name();

            assert(class_exists($testClassName));

            $reflector = new ReflectionClass($testClassName);

            $file = $reflector->getFileName();
            $line = $reflector->getStartLine();

            assert($file !== false);
            assert($line !== false);

            return new TestSuiteForTestClass(
                $testClassName,
                $testSuite->count(),
                TestCollection::fromArray($tests),
                $file,
                $line,
            );
        }

        return new TestSuiteWithName(
            $testSuite->name(),
            $testSuite->count(),
            TestCollection::fromArray($tests),
        );
    }

    /**
     * @param list<Test> $tests
     */
    private static function process(FrameworkTestSuite $testSuite, array &$tests): void
    {
        foreach ($testSuite->getIterator() as $test) {
            if ($test instanceof FrameworkTestSuite) {
                self::process($test, $tests);

                continue;
            }

            if ($test instanceof TestCase || $test instanceof PhptTestCase) {
                $tests[] = $test->valueObjectForEvents();
            }
        }
    }
}