MethodArgumentUnusedMatcherTest.php

<?php
declare(strict_types = 1);
namespace TYPO3\CMS\Install\Tests\Unit\ExtensionScanner\Php\Matcher;

/*
 * 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\NodeTraverser;
use PhpParser\NodeVisitor\NameResolver;
use PhpParser\ParserFactory;
use TYPO3\CMS\Install\ExtensionScanner\Php\Matcher\MethodArgumentUnusedMatcher;
use TYPO3\TestingFramework\Core\Unit\UnitTestCase;

/**
 * Test case
 */
class MethodArgumentUnusedMatcherTest extends UnitTestCase
{
    /**
     * @test
     */
    public function hitsFromFixtureAreFound()
    {
        $parser = (new ParserFactory())->create(ParserFactory::PREFER_PHP7);
        $fixtureFile = __DIR__ . '/Fixtures/MethodArgumentUnusedMatcherFixture.php';
        $statements = $parser->parse(file_get_contents($fixtureFile));

        $traverser = new NodeTraverser();
        $traverser->addVisitor(new NameResolver());

        $configuration = [
            'TYPO3\CMS\Core\Html\RteHtmlParser->RTE_transform' => [
                'unusedArgumentNumbers' => [ 2 ],
                'restFiles' => [
                    'Breaking-80700-DeprecatedFunctionalityRemoved.rst',
                    'Deprecation-79341-MethodsRelatedToRichtextConfiguration.rst',
                ],
            ],
        ];
        $subject = new MethodArgumentUnusedMatcher($configuration);
        $traverser->addVisitor($subject);
        $traverser->traverse($statements);
        $expectedHitLineNumbers = [
            26,
            27,
        ];
        $actualHitLineNumbers = [];
        foreach ($subject->getMatches() as $hit) {
            $actualHitLineNumbers[] = $hit['line'];
        }
        $this->assertEquals($expectedHitLineNumbers, $actualHitLineNumbers);
    }

    /**
     * @return array
     */
    public function matchesReturnsExpectedRestFilesDataProvider()
    {
        return [
            'two rest candidates with same number of arguments' => [
                [
                    'Foo->aMethod' => [
                        'unusedArgumentNumbers' => [ 1 ],
                        'restFiles' => [
                            'Foo-1.rst',
                            'Foo-2.rst',
                        ],
                    ],
                    'Bar->aMethod' => [
                        'unusedArgumentNumbers' => [ 1 ],
                        'restFiles' => [
                            'Bar-1.rst',
                            'Bar-2.rst',
                        ],
                    ],
                ],
                '<?php
                $someVar->aMethod(\'foo\');',
                [
                    0 => [
                        'restFiles' => [
                            'Foo-1.rst',
                            'Foo-2.rst',
                            'Bar-1.rst',
                            'Bar-2.rst',
                        ],
                    ],
                ],
            ],
            'two candidates, multiple matches' => [
                [
                    'Foo->aMethod' => [
                        'unusedArgumentNumbers' => [ 1, 2 ],
                        'restFiles' => [
                            'Foo-1.rst',
                        ],
                    ],
                    'Bar->aMethod' => [
                        'unusedArgumentNumbers' => [ 3 ],
                        'restFiles' => [
                            'Bar-1.rst',
                        ],
                    ],
                ],
                '<?php
                $someVar->aMethod(\'arg1\', \'arg2\', \'arg3\');',
                [
                    0 => [
                        'restFiles' => [
                            'Foo-1.rst',
                            'Bar-1.rst',
                        ],
                    ],
                ],
            ],
            'one candidate, no hit, not enough arguments' => [
                [
                    'Foo->aMethod' => [
                        'unusedArgumentNumbers' => [ 2, 3 ],
                        'restFiles' => [
                            'Foo-1.rst',
                        ],
                    ],
                ],
                '<?php
                $someVar->aMethod(\'arg1\');',
                [], // no hit
            ],
            'one candidate, no hit, given as null is ok' => [
                [
                    'Foo->aMethod' => [
                        'unusedArgumentNumbers' => [ 2, 3 ],
                        'restFiles' => [
                            'Foo-1.rst',
                        ],
                    ],
                ],
                '<?php
                $someVar->aMethod(\'arg1\', null, null);',
                [], // no hit
            ],
            'one match, third argument still given not null' => [
                [
                    'Foo->aMethod' => [
                        'unusedArgumentNumbers' => [ 2, 3 ],
                        'restFiles' => [
                            'aRest.rst',
                        ],
                    ],
                ],
                '<?php
                $someVar->aMethod(\'arg1\', null, \'arg3\');',
                [
                    0 => [
                        'restFiles' => [
                            'aRest.rst',
                        ],
                    ],
                ],
            ],
            'no match, scanning ignored as soon as argument unpacking is used' => [
                [
                    'Foo->aMethod' => [
                        'unusedArgumentNumbers' => [ 1, 3 ],
                        'restFiles' => [
                            'Foo-1.rst',
                        ],
                    ],
                ],
                '<?php
                $args1 = [\'arg1\', \'arg2\', \'arg3\'];
                $args2 = [\'arg4\', \'arg5\', \'arg6\'];
                $args3 = [\'arg7\', \'arg8\', \'arg9\'];
                $someVar->aMethod(...$args1, ...$args2, ...$args3);',
                [],
            ],
            'double linked .rst file is returned only once' => [
                [
                    'Foo->aMethod' => [
                        'unusedArgumentNumbers' => [ 1 ],
                        'restFiles' => [
                            'aRest.rst',
                        ],
                    ],
                    'Bar->aMethod' => [
                        'unusedArgumentNumbers' => [ 1 ],
                        'restFiles' => [
                            'aRest.rst',
                        ],
                    ],
                ],
                '<?php
                $someVar->aMethod(\'foo\');',
                [
                    0 => [
                        'restFiles' => [
                            'aRest.rst',
                        ],
                    ],
                ],
            ],
       ];
    }

    /**
     * @test
     * @dataProvider matchesReturnsExpectedRestFilesDataProvider
     */
    public function matchesReturnsExpectedRestFiles(array $configuration, string $phpCode, array $expected)
    {
        $parser = (new ParserFactory())->create(ParserFactory::ONLY_PHP7);
        $statements = $parser->parse($phpCode);

        $subject = new MethodArgumentUnusedMatcher($configuration);

        $traverser = new NodeTraverser();
        $traverser->addVisitor($subject);
        $traverser->traverse($statements);

        $result = $subject->getMatches();
        if (isset($expected[0], $result[0])) {
            $this->assertEquals($expected[0]['restFiles'], $result[0]['restFiles']);
        } else {
            $this->assertEquals($expected, $result);
        }
    }
}