ExtensionServiceTest.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Extbase\Tests\Unit\Service;

class ExtensionServiceTest extends \TYPO3\CMS\Core\Tests\UnitTestCase {

    protected $mockConfigurationManager;

    protected $extensionService;

    public function setUp() {
        $GLOBALS['TYPO3_DB'] = $this->getMock('TYPO3\\CMS\\Core\\Database\\DatabaseConnection', array('fullQuoteStr', 'exec_SELECTgetRows'));
        $GLOBALS['TSFE'] = new \stdClass();
        $this->extensionService = $this->getAccessibleMock('TYPO3\CMS\Extbase\Service\ExtensionService', array('dummy'));
        $this->mockConfigurationManager = $this->getMock('TYPO3\\CMS\\Extbase\\Configuration\\ConfigurationManagerInterface');
        $this->extensionService->_set('configurationManager', $this->mockConfigurationManager);
        $GLOBALS['TYPO3_CONF_VARS']['EXTCONF']['extbase']['extensions'] = array(
            'ExtensionName' => array(
                'plugins' => array(
                    'SomePlugin' => array(
                        'controllers' => array(
                            'ControllerName' => array(
                                'actions' => array('index', 'otherAction')
                            )
                        )
                    ),
                    'ThirdPlugin' => array(
                        'controllers' => array(
                            'ControllerName' => array(
                                'actions' => array('otherAction', 'thirdAction')
                            )
                        )
                    )
                )
            ),
            'SomeOtherExtensionName' => array(
                'plugins' => array(
                    'SecondPlugin' => array(
                        'controllers' => array(
                            'ControllerName' => array(
                                'actions' => array('index', 'otherAction')
                            ),
                            'SecondControllerName' => array(
                                'actions' => array('someAction', 'someOtherAction'),
                                'nonCacheableActions' => array('someOtherAction')
                            )
                        )
                    )
                )
            )
        );
    }

    public function getPluginNamespaceDataProvider() {
        return array(
            array('SomeExtension', 'SomePlugin', 'tx_someextension_someplugin'),
            array('NonExistingExtension', 'SomePlugin', 'tx_nonexistingextension_someplugin'),
            array('Invalid', '', 'tx_invalid_')
        );
    }

    public function getPluginNamespaceTests($extensionName, $pluginName, $expectedResult) {
        $this->mockConfigurationManager->expects($this->once())->method('getConfiguration')->will($this->returnValue(array()));
        $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(array('view' => array('pluginNamespace' => 'overridden_plugin_namespace'))));
        $expectedResult = 'overridden_plugin_namespace';
        $actualResult = $this->extensionService->getPluginNamespace('SomeExtension', 'SomePlugin');
        $this->assertEquals($expectedResult, $actualResult);
    }

    public function getPluginNameByActionDataProvider() {
        return array(
            array('ExtensionName', 'ControllerName', 'someNonExistingAction', NULL),
            array('ExtensionName', 'ControllerName', 'index', 'SomePlugin'),
            array('ExtensionName', 'ControllerName', 'thirdAction', 'ThirdPlugin'),
            array('eXtEnSiOnNaMe', 'cOnTrOlLeRnAmE', 'thirdAction', NULL),
            array('eXtEnSiOnNaMe', 'cOnTrOlLeRnAmE', 'ThIrDaCtIoN', NULL),
            array('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(array('view' => array('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->mockConfigurationManager->expects($this->once())->method('getConfiguration')->with(\TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface::CONFIGURATION_TYPE_FRAMEWORK)->will($this->returnValue(array('view' => array('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(array('extensionName' => 'CurrentExtension', 'pluginName' => 'CurrentPlugin', 'controllerConfiguration' => array('ControllerName' => array('actions' => array('otherAction'))))));
        $actualResult = $this->extensionService->getPluginNameByAction('CurrentExtension', 'ControllerName', 'otherAction');
        $expectedResult = 'CurrentPlugin';
        $this->assertEquals($expectedResult, $actualResult);
    }

    public function isActionCacheableReturnsTrueByDefault() {
        $mockConfiguration = array();
        $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 = array(
            'controllerConfiguration' => array(
                'SomeController' => array(
                    'nonCacheableActions' => array('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(array('view' => array('defaultPid' => 0))));
        $this->assertNull($this->extensionService->getTargetPidByPlugin('ExtensionName', 'PluginName'));
    }

    public function getTargetPidByPluginSignatureReturnsTheConfiguredDefaultPid() {
        $this->mockConfigurationManager->expects($this->once())->method('getConfiguration')->will($this->returnValue(array('view' => array('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(array('view' => array('defaultPid' => 'auto'))));
        $pluginSignature = 'extensionname_someplugin';
        $GLOBALS['TSFE']->sys_page = $this->getMock('TYPO3\\CMS\\Frontend\\Page\\PageRepository', array('enableFields'));
        $GLOBALS['TSFE']->sys_page->expects($this->once())->method('enableFields')->with('tt_content')->will($this->returnValue(' AND enable_fields'));
        $GLOBALS['TYPO3_DB']->expects($this->once())->method('fullQuoteStr')->with($pluginSignature, 'tt_content')->will($this->returnValue('"pluginSignature"'));
        $GLOBALS['TYPO3_DB']->expects($this->once())->method('exec_SELECTgetRows')->with('pid', 'tt_content', 'list_type="pluginSignature" AND CType="list" AND enable_fields AND sys_language_uid=', '', '')->will($this->returnValue(array(array('pid' => '321'))));
        $expectedResult = 321;
        $actualResult = $this->extensionService->getTargetPidByPlugin('ExtensionName', 'SomePlugin');
        $this->assertEquals($expectedResult, $actualResult);
    }

    public function getTargetPidByPluginSignatureReturnsNullIfTargetPidCouldNotBeDetermined() {
        $this->mockConfigurationManager->expects($this->once())->method('getConfiguration')->will($this->returnValue(array('view' => array('defaultPid' => 'auto'))));
        $GLOBALS['TSFE']->sys_page = $this->getMock('TYPO3\\CMS\\Frontend\\Page\\PageRepository', array('enableFields'));
        $GLOBALS['TSFE']->sys_page->expects($this->once())->method('enableFields')->will($this->returnValue(' AND enable_fields'));
        $GLOBALS['TYPO3_DB']->expects($this->once())->method('fullQuoteStr')->will($this->returnValue('"pluginSignature"'));
        $GLOBALS['TYPO3_DB']->expects($this->once())->method('exec_SELECTgetRows')->will($this->returnValue(array()));
        $this->assertNull($this->extensionService->getTargetPidByPlugin('ExtensionName', 'SomePlugin'));
    }

    public function getTargetPidByPluginSignatureThrowsExceptionIfMoreThanOneTargetPidsWereFound() {
        $this->mockConfigurationManager->expects($this->once())->method('getConfiguration')->will($this->returnValue(array('view' => array('defaultPid' => 'auto'))));
        $GLOBALS['TSFE']->sys_page = $this->getMock('TYPO3\\CMS\\Frontend\\Page\\PageRepository', array('enableFields'));
        $GLOBALS['TSFE']->sys_page->expects($this->once())->method('enableFields')->will($this->returnValue(' AND enable_fields'));
        $GLOBALS['TYPO3_DB']->expects($this->once())->method('fullQuoteStr')->will($this->returnValue('"pluginSignature"'));
        $GLOBALS['TYPO3_DB']->expects($this->once())->method('exec_SELECTgetRows')->will($this->returnValue(array(array('pid' => 123), array('pid' => 124))));
        $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);
    }
}