splitFunctionalTests.php

Go to the documentation of this file.

#!/usr/bin/env php
<?php
declare(strict_types=1);
 
/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */
 
use PhpParser\Comment\Doc;
use PhpParser\Node;
use PhpParser\NodeTraverser;
use PhpParser\NodeVisitor\NameResolver;
use PhpParser\NodeVisitorAbstract;
use PhpParser\ParserFactory;
use Symfony\Component\Console\Input\ArgvInput;
use Symfony\Component\Console\Input\InputArgument;
use Symfony\Component\Console\Input\InputDefinition;
use Symfony\Component\Console\Input\InputOption;
use Symfony\Component\Console\Output\ConsoleOutput;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Finder\Finder;
use Symfony\Component\Finder\SplFileInfo;
 
if (PHP_SAPI !== 'cli') {
    die('Script must be called from command line.' . chr(10));
}
 
require __DIR__ . '/../../vendor/autoload.php';
 
class ‪SplitFunctionalTests
{
    public function ‪execute(): int
    {
        $input = new ArgvInput($_SERVER['argv'], $this->‪getInputDefinition());
        ‪$output = new ConsoleOutput();
 
        // Number of chunks and verbose output
        $numberOfChunks = (int)$input->getArgument('numberOfChunks');
 
        if ($numberOfChunks < 1 || $numberOfChunks > 99) {
            throw new \InvalidArgumentException(
                'Main argument "numberOfChunks" must be at least 1 and maximum 99',
                1528319388
            );
        }
 
        if ($input->hasParameterOption('-v', true) || $input->hasParameterOption('--verbose', true)) {
            ‪$output->setVerbosity(OutputInterface::VERBOSITY_VERBOSE);
        }
 
        // Find functional test files
        $testFiles = (new Finder())
            ->files()
            ->in(__DIR__ . '/../../typo3/sysext/*/Tests/Functional')
            ->name('/Test\.php$/')
            ->sortByName()
        ;
 
        ‪$parser = (new ParserFactory())->create(ParserFactory::ONLY_PHP7);
        $testStats = [];
        foreach ($testFiles as $file) {
            $relativeFilename = $file->getRealPath();
            preg_match('/.*typo3\/sysext\/(.*)$/', $relativeFilename, $matches);
            $relativeFilename = '../../typo3/sysext/' . $matches[1];
 
            $ast = ‪$parser->parse($file->getContents());
            $traverser = new NodeTraverser();
            $visitor = new NameResolver();
            $traverser->addVisitor($visitor);
            $visitor = new ‪FunctionalTestCaseVisitor();
            $traverser->addVisitor($visitor);
            $traverser->traverse($ast);
 
            $fqcn = $visitor->getFqcn();
            $tests = $visitor->getTests();
            if (!empty($tests)) {
                $testStats[$relativeFilename] = 0;
            }
 
            foreach ($tests as $test) {
                if (isset($test['dataProvider'])) {
                    // Test uses a data provider - get number of data sets
                    $dataProviderMethodName = $test['dataProvider'];
                    $methods = (new $fqcn())->$dataProviderMethodName();
                    if ($methods instanceof Generator) {
                        $numberOfDataSets = iterator_count($methods);
                    } else {
                        $numberOfDataSets = count($methods);
                    }
                    $testStats[$relativeFilename] += $numberOfDataSets;
                } else {
                    // Just a single test
                    $testStats[$relativeFilename] += 1;
                }
            }
        }
 
        // Sort test files by number of tests, descending
        arsort($testStats);
 
        $numberOfTestsPerChunk = [];
        $xml = [];
        for ($i = 1; $i <= $numberOfChunks; $i++) {
            $numberOfTestsPerChunk[$i] = 0;
            // An xml parser per target file
            $xml[$i] = new SimpleXMLElement(file_get_contents(__DIR__ . '/../phpunit/FunctionalTests.xml'));
            // Drop existing directory spec
            unset($xml[$i]->testsuites->testsuite->directory);
        }
 
        foreach ($testStats as $testFile => $numberOfTestsInFile) {
            // Sort list of tests per chunk by number of tests, pick lowest as
            // the target of this test file
            asort($numberOfTestsPerChunk);
            reset($numberOfTestsPerChunk);
            $jobFileNumber = key($numberOfTestsPerChunk);
            $xml[$jobFileNumber]->testsuites->testsuite->addChild('directory', $testFile);
            $numberOfTestsPerChunk[$jobFileNumber] = $numberOfTestsPerChunk[$jobFileNumber] + $numberOfTestsInFile;
        }
 
        for ($i = 1; $i <= $numberOfChunks; $i++) {
            // Write phpunit xml files
            file_put_contents(__DIR__ . '/../phpunit/' . 'FunctionalTests-Job-' . $i . '.xml', $xml[$i]->asXml());
        }
 
        if (‪$output->isVerbose()) {
            ‪$output->writeln('Number of test files found: ' . count($testStats));
            ‪$output->writeln('Number of tests found: ' . array_sum($testStats));
            ‪$output->writeln('Number of chunks prepared: ' . $numberOfChunks);
            ksort($numberOfTestsPerChunk);
            foreach ($numberOfTestsPerChunk as $chunkNumber => $testNumber) {
                ‪$output->writeln('Number of tests in chunk ' . $chunkNumber . ': ' . $testNumber);
            }
        }
 
        return 0;
    }
 
    private function ‪getInputDefinition(): InputDefinition
    {
        return new InputDefinition([
            new InputArgument('numberOfChunks', InputArgument::REQUIRED, 'Number of chunks / jobs to create'),
            new InputOption('--verbose', '-v', InputOption::VALUE_NONE, 'Enable verbose output'),
        ]);
    }
}
 
class ‪FunctionalTestCaseVisitor extends NodeVisitorAbstract
{
    private ‪$tests = [];
 
    private ‪$fqcn;
 
    public function ‪enterNode(Node $node): void
    {
        if ($node instanceof Node\Stmt\Class_
            && !$node->isAnonymous()
        ) {
            // The test class full namespace
            $this->fqcn = (string)$node->namespacedName;
        }
 
        if ($node instanceof Node\Stmt\ClassMethod
            && ($docComment = $node->getDocComment()) instanceof Doc
        ) {
            preg_match_all(
                '/\s*\s@(?<annotations>[^\s.].*)\n/',
                $docComment->getText(),
                $matches
            );
            foreach ($matches['annotations'] as $possibleTest) {
                if ($possibleTest === 'test') {
                    // Found a test
                    $test = [
                        'methodName' => $node->name->name,
                    ];
                    foreach ($matches['annotations'] as $possibleDataProvider) {
                        // See if this test has a data provider attached
                        if (str_starts_with($possibleDataProvider, 'dataProvider')) {
                            $test['dataProvider'] = trim(ltrim($possibleDataProvider, 'dataProvider'));
                        }
                    }
                    $this->tests[] = $test;
                }
            }
        }
    }
 
    public function ‪getTests(): array
    {
        return ‪$this->tests;
    }
 
    public function ‪getFqcn(): string
    {
        return ‪$this->fqcn;
    }
}
 
‪$splitFunctionalTests = new ‪SplitFunctionalTests();
exit(‪$splitFunctionalTests->execute());