testMethodPrefixChecker.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
use PhpParser\Node;
use PhpParser\NodeTraverser;
use PhpParser\NodeVisitorAbstract;
use PhpParser\ParserFactory;
use PhpParser\PhpVersion;
use Symfony\Component\Console\Output\ConsoleOutput;
 
require_once __DIR__ . '/../../vendor/autoload.php';
 
class NodeVisitor extends NodeVisitorAbstract
{
    public array ‪$matches = [];
 
    public function ‪enterNode(Node $node): void
    {
        if (($node instanceof Node\Stmt\ClassMethod) && str_starts_with($node->name->name, 'test')) {
            $this->matches[$node->getLine()] = $node->name->name;
        }
    }
}
 
‪$parser = (new ParserFactory())->createForVersion(PhpVersion::fromComponents(8, 2));
 
‪$finder = new Symfony\Component\Finder\Finder();
‪$finder->files()
    ->in([
        __DIR__ . '/../../typo3/sysext/*/Tests/Unit/',
        __DIR__ . '/../../typo3/sysext/*/Tests/UnitDeprecated/',
        __DIR__ . '/../../typo3/sysext/*/Tests/Functional/',
    ])
    ->name('/Test\.php$/');
 
‪$output = new ConsoleOutput();
 
‪$errors = [];
foreach (‪$finder as $file) {
    try {
        $ast = ‪$parser->parse($file->getContents());
    } catch (Error $error) {
        ‪$output->writeln('<error>Parse error: ' . $error->getMessage() . '</error>');
        exit(1);
    }
 
    $visitor = new NodeVisitor();
 
    $traverser = new NodeTraverser();
    $traverser->addVisitor($visitor);
 
    $ast = $traverser->traverse($ast);
 
    if (!empty($visitor->matches)) {
        ‪$errors[$file->getRealPath()] = $visitor->matches;
        ‪$output->write('<error>F</error>');
    } else {
        ‪$output->write('<fg=green>.</>');
    }
}
 
‪$output->writeln('');
 
if (!empty(‪$errors)) {
    ‪$output->writeln('');
 
    foreach (‪$errors as $file => $matchesPerLine) {
        ‪$output->writeln('');
        ‪$output->writeln('<error>Method shoud not start "test". Use @test phpDoc annotation instead. Found in ' . $file . '</error>');
 
        foreach ($matchesPerLine as $line => $methodName) {
            ‪$output->writeln('Method:' . $methodName . ' Line:' . $line);
        }
    }
    exit(1);
}
 
exit(0);