9.5/_extension_service_test_8php_source.html

<?php

declare(strict_types = 1);

namespace ‪TYPO3\CMS\Extbase\Tests\Unit\Service;


/*

 * 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 Doctrine\DBAL\Statement;

use Prophecy\Argument;

use Prophecy\Prophecy\ObjectProphecy;

use ‪TYPO3\CMS\Core\Database\Connection;

use ‪TYPO3\CMS\Core\Database\ConnectionPool;

use ‪TYPO3\CMS\Core\Database\Query\Expression\ExpressionBuilder;

use ‪TYPO3\CMS\Core\Database\Query\QueryBuilder;

use ‪TYPO3\CMS\Core\Tests\Unit\Database\Mocks\MockPlatform;

use ‪TYPO3\CMS\Core\Utility\GeneralUtility;

use ‪TYPO3\CMS\Extbase\Exception;

use TYPO3\TestingFramework\Core\Unit\UnitTestCase;


class ‪ExtensionServiceTest extends UnitTestCase

{

    protected ‪$mockConfigurationManager;


    protected ‪$extensionService;


    protected ‪$resetSingletonInstances = true;


    protected function ‪setUp()

    {

        ‪$GLOBALS['TSFE'] = new \stdClass();

        $this->extensionService = $this->getAccessibleMock(\‪TYPO3\CMS\‪Extbase\Service\ExtensionService::class, ['dummy']);

        $this->mockConfigurationManager = $this->createMock(\‪TYPO3\CMS\‪Extbase\Configuration\ConfigurationManagerInterface::class);

        $this->extensionService->_set('configurationManager', $this->mockConfigurationManager);

        ‪$GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['extbase']['extensions'] = [

            'ExtensionName' => [

                'plugins' => [

                    'SomePlugin' => [

                        'controllers' => [

                            'ControllerName' => [

                                'actions' => ['index', 'otherAction']

                            ]

                        ]

                    ],

                    'ThirdPlugin' => [

                        'controllers' => [

                            'ControllerName' => [

                                'actions' => ['otherAction', 'thirdAction']

                            ]

                        ]

                    ]

                ]

            ],

            'SomeOtherExtensionName' => [

                'plugins' => [

                    'SecondPlugin' => [

                        'controllers' => [

                            'ControllerName' => [

                                'actions' => ['index', 'otherAction']

                            ],

                            'SecondControllerName' => [

                                'actions' => ['someAction', 'someOtherAction'],

                                'nonCacheableActions' => ['someOtherAction']

                            ]

                        ]

                    ]

                ]

            ]

        ];

    }


    protected function ‪getMockDatabaseConnection(): ObjectProphecy

    {

        $connection = $this->prophesize(Connection::class);

        $connection->getDatabasePlatform()->willReturn(new ‪MockPlatform());

        $connection->getExpressionBuilder()->willReturn(new ‪ExpressionBuilder($connection->reveal()));

        $connection->quoteIdentifier(Argument::cetera())->willReturnArgument(0);


        $queryBuilder = new ‪QueryBuilder(

            $connection->reveal(),

            null,

            new \Doctrine\DBAL\Query\‪QueryBuilder($connection->reveal())

        );


        $connectionPool = $this->prophesize(ConnectionPool::class);

        $connectionPool->getQueryBuilderForTable('tt_content')->willReturn($queryBuilder);

        GeneralUtility::addInstance(ConnectionPool::class, $connectionPool->reveal());


        return $connection;

    }


    public function ‪getPluginNamespaceDataProvider()

    {

        return [

            ['SomeExtension', 'SomePlugin', 'tx_someextension_someplugin'],

            ['NonExistingExtension', 'SomePlugin', 'tx_nonexistingextension_someplugin'],

            ['Invalid', '', 'tx_invalid_']

        ];

    }


    public function ‪getPluginNamespaceTests($extensionName, $pluginName, $expectedResult)

    {

        $this->mockConfigurationManager->expects($this->once())->method('getConfiguration')->will($this->returnValue([]));

        $actualResult = $this->extensionService->getPluginNamespace($extensionName, $pluginName);

        $this->assertEquals($expectedResult, $actualResult, 'Failing for extension: "' . $extensionName . '", plugin: "' . $pluginName . '"');

    }


    public function ‪pluginNamespaceCanBeOverridden()

    {

        $this->mockConfigurationManager->expects($this->once())->method('getConfiguration')->with(\‪TYPO3\CMS\‪Extbase\Configuration\ConfigurationManagerInterface::CONFIGURATION_TYPE_FRAMEWORK, 'SomeExtension', 'SomePlugin')->will($this->returnValue(['view' => ['pluginNamespace' => 'overridden_plugin_namespace']]));

        $expectedResult = 'overridden_plugin_namespace';

        $actualResult = $this->extensionService->getPluginNamespace('SomeExtension', 'SomePlugin');

        $this->assertEquals($expectedResult, $actualResult);

    }


    public function ‪getPluginNameByActionDataProvider()

    {

        return [

            ['ExtensionName', 'ControllerName', 'someNonExistingAction', null],

            ['ExtensionName', 'ControllerName', 'index', 'SomePlugin'],

            ['ExtensionName', 'ControllerName', 'thirdAction', 'ThirdPlugin'],

            ['eXtEnSiOnNaMe', 'cOnTrOlLeRnAmE', 'thirdAction', null],

            ['eXtEnSiOnNaMe', 'cOnTrOlLeRnAmE', 'ThIrDaCtIoN', null],

            ['SomeOtherExtensionName', 'ControllerName', 'otherAction', 'SecondPlugin']

        ];

    }


    public function ‪getPluginNameByActionTests($extensionName, $controllerName, $actionName, $expectedResult)

    {

        $this->mockConfigurationManager->expects($this->once())->method('getConfiguration')->with(\‪TYPO3\CMS\‪Extbase\Configuration\ConfigurationManagerInterface::CONFIGURATION_TYPE_FRAMEWORK)->will($this->returnValue(['view' => ['pluginNamespace' => 'overridden_plugin_namespace']]));

        $actualResult = $this->extensionService->getPluginNameByAction($extensionName, $controllerName, $actionName);

        $this->assertEquals($expectedResult, $actualResult, 'Failing for $extensionName: "' . $extensionName . '", $controllerName: "' . $controllerName . '", $actionName: "' . $actionName . '" - ');

    }


    public function ‪getPluginNameByActionThrowsExceptionIfMoreThanOnePluginMatches()

    {

        $this->expectException(Exception::class);

        $this->expectExceptionCode(1280825466);

        $this->mockConfigurationManager->expects($this->once())->method('getConfiguration')->with(\‪TYPO3\CMS\‪Extbase\Configuration\ConfigurationManagerInterface::CONFIGURATION_TYPE_FRAMEWORK)->will($this->returnValue(['view' => ['pluginNamespace' => 'overridden_plugin_namespace']]));

        $this->extensionService->getPluginNameByAction('ExtensionName', 'ControllerName', 'otherAction');

    }


    public function ‪getPluginNameByActionReturnsCurrentIfItCanHandleTheActionEvenIfMoreThanOnePluginMatches()

    {

        $this->mockConfigurationManager->expects($this->once())->method('getConfiguration')->with(\‪TYPO3\CMS\‪Extbase\Configuration\ConfigurationManagerInterface::CONFIGURATION_TYPE_FRAMEWORK)->will($this->returnValue(['extensionName' => 'CurrentExtension', 'pluginName' => 'CurrentPlugin', 'controllerConfiguration' => ['ControllerName' => ['actions' => ['otherAction']]]]));

        $actualResult = $this->extensionService->getPluginNameByAction('CurrentExtension', 'ControllerName', 'otherAction');

        $expectedResult = 'CurrentPlugin';

        $this->assertEquals($expectedResult, $actualResult);

    }


    public function ‪isActionCacheableReturnsTrueByDefault()

    {

        $mockConfiguration = [];

        $this->mockConfigurationManager->expects($this->any())->method('getConfiguration')->will($this->returnValue($mockConfiguration));

        $actualResult = $this->extensionService->isActionCacheable('SomeExtension', 'SomePlugin', 'SomeController', 'someAction');

        $this->assertTrue($actualResult);

    }


    public function ‪isActionCacheableReturnsFalseIfActionIsNotCacheable()

    {

        $mockConfiguration = [

            'controllerConfiguration' => [

                'SomeController' => [

                    'nonCacheableActions' => ['someAction']

                ]

            ]

        ];

        $this->mockConfigurationManager->expects($this->any())->method('getConfiguration')->will($this->returnValue($mockConfiguration));

        $actualResult = $this->extensionService->isActionCacheable('SomeExtension', 'SomePlugin', 'SomeController', 'someAction');

        $this->assertFalse($actualResult);

    }


    public function ‪getTargetPidByPluginSignatureReturnsNullIfConfigurationManagerIsNotInitialized()

    {

        $this->mockConfigurationManager->expects($this->once())->method('getConfiguration')->will($this->returnValue(null));

        $this->assertNull($this->extensionService->getTargetPidByPlugin('ExtensionName', 'PluginName'));

    }


    public function ‪getTargetPidByPluginSignatureReturnsNullIfDefaultPidIsZero()

    {

        $this->mockConfigurationManager->expects($this->once())->method('getConfiguration')->will($this->returnValue(['view' => ['defaultPid' => 0]]));

        $this->assertNull($this->extensionService->getTargetPidByPlugin('ExtensionName', 'PluginName'));

    }


    public function ‪getTargetPidByPluginSignatureReturnsTheConfiguredDefaultPid()

    {

        $this->mockConfigurationManager->expects($this->once())->method('getConfiguration')->will($this->returnValue(['view' => ['defaultPid' => 123]]));

        $expectedResult = 123;

        $actualResult = $this->extensionService->getTargetPidByPlugin('ExtensionName', 'SomePlugin');

        $this->assertEquals($expectedResult, $actualResult);

    }


    public function ‪getTargetPidByPluginSignatureDeterminesTheTargetPidIfDefaultPidIsAuto()

    {

        $this->mockConfigurationManager->expects($this->once())->method('getConfiguration')->will(

            $this->returnValue(['view' => ['defaultPid' => 'auto']])

        );

        $expectedResult = 321;


        $statement = $this->prophesize(Statement::class);

        $statement->fetchAll()->shouldBeCalled()->willReturn([['pid' => (string)$expectedResult]]);


        $connection = $this->‪getMockDatabaseConnection();

        $connection->executeQuery(

            'SELECT pid FROM tt_content WHERE (list_type = :dcValue1) AND (CType = :dcValue2) AND (sys_language_uid = :dcValue3) LIMIT 2',

            ['dcValue1' => 'extensionname_someplugin', 'dcValue2' => 'list', 'dcValue3' => 0],

            Argument::cetera()

        )->shouldBeCalled()->willReturn($statement->reveal());


        $actualResult = $this->extensionService->getTargetPidByPlugin('ExtensionName', 'SomePlugin');

        $this->assertEquals($expectedResult, $actualResult);

    }


    public function ‪getTargetPidByPluginSignatureReturnsNullIfTargetPidCouldNotBeDetermined()

    {

        $this->mockConfigurationManager->expects($this->once())->method('getConfiguration')->will(

            $this->returnValue(['view' => ['defaultPid' => 'auto']])

        );


        $statement = $this->prophesize(Statement::class);

        $statement->fetchAll()->shouldBeCalled()->willReturn([]);


        $connection = $this->‪getMockDatabaseConnection();

        $connection->executeQuery(

            'SELECT pid FROM tt_content WHERE (list_type = :dcValue1) AND (CType = :dcValue2) AND (sys_language_uid = :dcValue3) LIMIT 2',

            ['dcValue1' => 'extensionname_someplugin', 'dcValue2' => 'list', 'dcValue3' => 0],

            Argument::cetera()

        )->shouldBeCalled()->willReturn($statement->reveal());


        $this->assertNull($this->extensionService->getTargetPidByPlugin('ExtensionName', 'SomePlugin'));

    }


    public function ‪getTargetPidByPluginSignatureThrowsExceptionIfMoreThanOneTargetPidsWereFound()

    {

        $this->expectException(Exception::class);

        $this->expectExceptionCode(1280773643);


        $this->mockConfigurationManager->expects($this->once())->method('getConfiguration')->will(

            $this->returnValue(['view' => ['defaultPid' => 'auto']])

        );


        $statement = $this->prophesize(Statement::class);

        $statement->fetchAll()->shouldBeCalled()->willReturn([['pid' => 123], ['pid' => 124]]);


        $connection = $this->‪getMockDatabaseConnection();

        $connection->executeQuery(

            'SELECT pid FROM tt_content WHERE (list_type = :dcValue1) AND (CType = :dcValue2) AND (sys_language_uid = :dcValue3) LIMIT 2',

            ['dcValue1' => 'extensionname_someplugin', 'dcValue2' => 'list', 'dcValue3' => 0],

            Argument::cetera()

        )->shouldBeCalled()->willReturn($statement->reveal());


        $this->expectException(\‪TYPO3\CMS\‪Extbase\Exception::class);

        $this->expectExceptionCode(1280773643);


        $this->extensionService->getTargetPidByPlugin('ExtensionName', 'SomePlugin');

    }


    public function ‪getDefaultControllerNameByPluginReturnsNullIfGivenExtensionCantBeFound()

    {

        $this->assertNull($this->extensionService->getDefaultControllerNameByPlugin('NonExistingExtensionName', 'SomePlugin'));

    }


    public function ‪getDefaultControllerNameByPluginReturnsNullIfGivenPluginCantBeFound()

    {

        $this->assertNull($this->extensionService->getDefaultControllerNameByPlugin('ExtensionName', 'NonExistingPlugin'));

    }


    public function ‪getDefaultControllerNameByPluginReturnsFirstControllerNameOfGivenPlugin()

    {

        $expectedResult = 'ControllerName';

        $actualResult = $this->extensionService->getDefaultControllerNameByPlugin('ExtensionName', 'SomePlugin');

        $this->assertEquals($expectedResult, $actualResult);

    }


    public function ‪getDefaultActionNameByPluginAndControllerReturnsNullIfGivenExtensionCantBeFound()

    {

        $this->assertNull($this->extensionService->getDefaultActionNameByPluginAndController('NonExistingExtensionName', 'SomePlugin', 'ControllerName'));

    }


    public function ‪getDefaultActionNameByPluginAndControllerReturnsNullIfGivenPluginCantBeFound()

    {

        $this->assertNull($this->extensionService->getDefaultActionNameByPluginAndController('ExtensionName', 'NonExistingPlugin', 'ControllerName'));

    }


    public function ‪getDefaultActionNameByPluginAndControllerReturnsNullIfGivenControllerCantBeFound()

    {

        $this->assertNull($this->extensionService->getDefaultActionNameByPluginAndController('ExtensionName', 'SomePlugin', 'NonExistingControllerName'));

    }


    public function ‪getDefaultActionNameByPluginAndControllerReturnsFirstActionNameOfGivenController()

    {

        $expectedResult = 'someAction';

        $actualResult = $this->extensionService->getDefaultActionNameByPluginAndController('SomeOtherExtensionName', 'SecondPlugin', 'SecondControllerName');

        $this->assertEquals($expectedResult, $actualResult);

    }

}