MethodCallMatcherTest.php

Go to the documentation of this file.

<?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!
 */
 
namespace ‪TYPO3\CMS\Install\Tests\Unit\ExtensionScanner\Php\Matcher;
 
use PhpParser\NodeTraverser;
use PhpParser\NodeVisitor\NameResolver;
use PhpParser\ParserFactory;
use PhpParser\PhpVersion;
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\Attributes\Test;
use ‪TYPO3\CMS\Install\ExtensionScanner\Php\Matcher\MethodCallMatcher;
use TYPO3\TestingFramework\Core\Unit\UnitTestCase;
 
final class ‪MethodCallMatcherTest extends UnitTestCase
{
    #[Test]
    public function ‪hitsFromFixtureAreFound(): void
    {
        ‪$parser = (new ParserFactory())->createForVersion(PhpVersion::fromComponents(8, 2));
        $fixtureFile = __DIR__ . '/Fixtures/MethodCallMatcherFixture.php';
        $statements = ‪$parser->parse(file_get_contents($fixtureFile));
 
        $traverser = new NodeTraverser();
        $traverser->addVisitor(new NameResolver());
 
        $configuration = [
            'TYPO3\CMS\Backend\Clipboard\Clipboard->confirmMsg' => [
                'numberOfMandatoryArguments' => 4,
                'maximumNumberOfArguments' => 5,
                'restFiles' => [
                    'Breaking-80700-DeprecatedFunctionalityRemoved.rst',
                ],
            ],
        ];
        $subject = new ‪MethodCallMatcher($configuration);
        $traverser->addVisitor($subject);
        $traverser->traverse($statements);
        $expectedHitLineNumbers = [
            28,
            30,
            33,
            35,
        ];
        $actualHitLineNumbers = [];
        foreach ($subject->getMatches() as $hit) {
            $actualHitLineNumbers[] = $hit['line'];
        }
        self::assertEquals($expectedHitLineNumbers, $actualHitLineNumbers);
    }
 
    #[Test]
    public function ‪matchIsIgnoredIfIgnoreFileIsSet(): void
    {
        $phpCode = <<<'EOC'
<?php
class foo
{
    public function aTest()
    {
        // This valid match should not match since the entire file is ignored
        $foo->confirmMsg('arg1', 'arg2', 'arg3', 'arg4');
    }
}
EOC;
 
        ‪$parser = (new ParserFactory())->createForVersion(PhpVersion::fromComponents(8, 2));
        $statements = ‪$parser->parse($phpCode);
 
        $traverser = new NodeTraverser();
        $configuration = [
            'TYPO3\CMS\Backend\Clipboard\Clipboard->confirmMsg' => [
                'numberOfMandatoryArguments' => 4,
                'maximumNumberOfArguments' => 5,
                'restFiles' => [
                    'Breaking-80700-DeprecatedFunctionalityRemoved.rst',
                ],
            ],
        ];
        $subject = new ‪MethodCallMatcher($configuration);
        $traverser->addVisitor($subject);
        $traverser->traverse($statements);
 
        self::assertEmpty($subject->getMatches());
    }
 
    public static function ‪matchesReturnsExpectedRestFilesDataProvider(): array
    {
        return [
            'two rest candidates with same number of arguments' => [
                [
                    'Foo->aMethod' => [
                        'numberOfMandatoryArguments' => 0,
                        'maximumNumberOfArguments' => 0,
                        'restFiles' => [
                            'Foo-1.rst',
                            'Foo-2.rst',
                        ],
                    ],
                    'Bar->aMethod' => [
                        'numberOfMandatoryArguments' => 0,
                        'maximumNumberOfArguments' => 0,
                        'restFiles' => [
                            'Bar-1.rst',
                            'Bar-2.rst',
                        ],
                    ],
                ],
                '<?php
                $someVar->aMethod();',
                [
                    0 => [
                        'restFiles' => [
                            'Foo-1.rst',
                            'Foo-2.rst',
                            'Bar-1.rst',
                            'Bar-2.rst',
                        ],
                    ],
                ],
            ],
            'two candidates, only one hits because second candidate needs one argument' => [
                [
                    'Foo->aMethod' => [
                        'numberOfMandatoryArguments' => 0,
                        'maximumNumberOfArguments' => 3,
                        'restFiles' => [
                            'Foo-1.rst',
                        ],
                    ],
                    'Bar->aMethod' => [
                        'numberOfMandatoryArguments' => 1,
                        'maximumNumberOfArguments' => 3,
                        'restFiles' => [
                            'Bar-1.rst',
                        ],
                    ],
                ],
                '<?php
                $someVar->aMethod();',
                [
                    0 => [
                        'restFiles' => [
                            'Foo-1.rst',
                        ],
                    ],
                ],
            ],
            'three candidates, first and second hits' => [
                [
                    'Foo->aMethod' => [
                        'numberOfMandatoryArguments' => 2,
                        'maximumNumberOfArguments' => 4,
                        'restFiles' => [
                            'Foo-1.rst',
                        ],
                    ],
                    'Bar->aMethod' => [
                        'numberOfMandatoryArguments' => 1,
                        'maximumNumberOfArguments' => 4,
                        'restFiles' => [
                            'Bar-1.rst',
                        ],
                    ],
                    'FooBar->aMethod' => [
                        'numberOfMandatoryArguments' => 3,
                        'maximumNumberOfArguments' => 4,
                        'restFiles' => [
                            'FooBar-1.rst',
                        ],
                    ],
                ],
                '<?php
                $someVar->aMethod(\'arg1\', \'arg2\');',
                [
                    0 => [
                        'restFiles' => [
                            'Foo-1.rst',
                            'Bar-1.rst',
                        ],
                    ],
                ],
            ],
            'one candidate, does not hit, not enough arguments given' => [
                [
                    'Foo->aMethod' => [
                        'numberOfMandatoryArguments' => 1,
                        'maximumNumberOfArguments' => 3,
                        'restFiles' => [
                            'Foo-1.rst',
                        ],
                    ],
                ],
                '<?php
                $someVar->aMethod();',
                [], // no hit
            ],
            'too many arguments given' => [
                [
                    'Foo->aMethod' => [
                        'numberOfMandatoryArguments' => 1,
                        'maximumNumberOfArguments' => 1,
                        'restFiles' => [
                            'Foo-1.rst',
                        ],
                    ],
                ],
                '<?php
                $someVar->aMethod($foo, $bar);',
                [], // no hit
            ],
            'method call using argument unpacking' => [
                [
                    'Foo->aMethod' => [
                        'numberOfMandatoryArguments' => 2,
                        'maximumNumberOfArguments' => 2,
                        'restFiles' => [
                            'Foo-1.rst',
                        ],
                    ],
                ],
                '<?php
                $args = [\'arg1\', \'arg2\', \'arg3\'];
                $someVar->aMethod(...$args);',
                [
                    0 => [
                        'restFiles' => [
                            'Foo-1.rst',
                        ],
                    ],
                ],
            ],
            'method call using argument unpacking with more than max number of args given arguments' => [
                [
                    'Foo->aMethod' => [
                        'numberOfMandatoryArguments' => 2,
                        'maximumNumberOfArguments' => 2,
                        'restFiles' => [
                            'Foo-1.rst',
                        ],
                    ],
                ],
                '<?php
                $args1 = [\'arg1\', \'arg2\', \'arg3\'];
                $args2 = [\'arg4\', \'arg5\', \'arg6\'];
                $args3 = [\'arg7\', \'arg8\', \'arg9\'];
                $someVar->aMethod(...$args1, ...$args2, ...$args3);',
                [
                    0 => [
                        'restFiles' => [
                            'Foo-1.rst',
                        ],
                    ],
                ],
            ],
            'double linked .rst file is returned only once' => [
                [
                    'Foo->aMethod' => [
                        'numberOfMandatoryArguments' => 1,
                        'maximumNumberOfArguments' => 2,
                        'restFiles' => [
                            'aRest.rst',
                        ],
                    ],
                    'Bar->aMethod' => [
                        'numberOfMandatoryArguments' => 1,
                        'maximumNumberOfArguments' => 2,
                        'restFiles' => [
                            'aRest.rst',
                        ],
                    ],
                ],
                '<?php
                $someVar->aMethod(\'foo\');',
                [
                    0 => [
                        'restFiles' => [
                            'aRest.rst',
                        ],
                    ],
                ],
            ],
        ];
    }
 
    #[DataProvider('matchesReturnsExpectedRestFilesDataProvider')]
    #[Test]
    public function ‪matchesReturnsExpectedRestFiles(array $configuration, string $phpCode, array $expected): void
    {
        ‪$parser = (new ParserFactory())->createForVersion(PhpVersion::fromComponents(8, 2));
        $statements = ‪$parser->parse($phpCode);
 
        $subject = new ‪MethodCallMatcher($configuration);
 
        $traverser = new NodeTraverser();
        $traverser->addVisitor($subject);
        $traverser->traverse($statements);
 
        $result = $subject->getMatches();
        if (isset($expected[0], $result[0])) {
            self::assertEquals($expected[0]['restFiles'], $result[0]['restFiles']);
        } else {
            self::assertEquals($expected, $result);
        }
    }
}