BackendFormProtectionTest.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Core\Tests\Unit\FormProtection;

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

    protected $subject;

    protected $singletonInstances;

    public function setUp() {
        $this->singletonInstances = \TYPO3\CMS\Core\Utility\GeneralUtility::getSingletonInstances();

        $GLOBALS['BE_USER'] = $this->getMock(
            'TYPO3\\CMS\\Core\\Authentication\\BackendUserAuthentication',
            array('getSessionData', 'setAndSaveSessionData')
        );
        $GLOBALS['BE_USER']->user['uid'] = 1;

        $this->subject = $this->getAccessibleMock(
            'TYPO3\\CMS\\Core\\FormProtection\BackendFormProtection',
            array('acquireLock', 'releaseLock', 'getLanguageService', 'isAjaxRequest')
        );
    }

    public function tearDown() {
        \TYPO3\CMS\Core\Utility\GeneralUtility::resetSingletonInstances($this->singletonInstances);
        parent::tearDown();
    }

    // Utility functions

    protected function getBackendUser() {
        return $GLOBALS['BE_USER'];
    }

    // Tests for the utility functions

    public function getBackendUserReturnsInstanceOfBackendUserAuthenticationClass() {
        $this->assertInstanceOf(
            'TYPO3\\CMS\\Core\\Authentication\BackendUserAuthentication',
            $this->getBackendUser()
        );
    }

    // Tests concerning the reading and saving of the tokens

    public function retrieveTokenReadsTokenFromSessionData() {
        $this->getBackendUser()
            ->expects($this->once())
            ->method('getSessionData')
            ->with('formSessionToken')
            ->will($this->returnValue(array()));
        $this->subject->_call('retrieveSessionToken');
    }

    public function tokenFromSessionDataIsAvailableForValidateToken() {
        $sessionToken = '881ffea2159ac72182557b79dc0c723f5a8d20136f9fab56cdd4f8b3a1dbcfcd';
        $formName = 'foo';
        $action = 'edit';
        $formInstanceName = '42';

        $tokenId = \TYPO3\CMS\Core\Utility\GeneralUtility::hmac(
            $formName . $action . $formInstanceName . $sessionToken
        );

        $this->getBackendUser()
            ->expects($this->atLeastOnce())
            ->method('getSessionData')
            ->with('formSessionToken')
            ->will($this->returnValue($sessionToken));

        $this->subject->_call('retrieveSessionToken');

        $this->assertTrue(
            $this->subject->validateToken($tokenId, $formName, $action, $formInstanceName)
        );
    }

    public function restoreSessionTokenFromRegistryThrowsExceptionIfSessionTokenIsEmpty() {
        $registryMock = $this->getMock('TYPO3\\CMS\\Core\\Registry');
        $this->subject->injectRegistry($registryMock);
        $this->subject->setSessionTokenFromRegistry();
    }

    public function persistSessionTokenWritesTokenToSession() {
        $sessionToken = $this->getUniqueId('test_');
        $this->subject->_set('sessionToken', $sessionToken);
        $this->getBackendUser()
            ->expects($this->once())
            ->method('setAndSaveSessionData')
            ->with('formSessionToken', $sessionToken);
        $this->subject->persistSessionToken();
    }


    // Tests concerning createValidationErrorMessage

    public function createValidationErrorMessageAddsFlashMessage() {
        $flashMessageServiceMock = $this->getMock('TYPO3\\CMS\\Core\\Messaging\\FlashMessageService');
        \TYPO3\CMS\Core\Utility\GeneralUtility::setSingletonInstance(
            'TYPO3\\CMS\\Core\\Messaging\\FlashMessageService',
            $flashMessageServiceMock
        );
        $flashMessageQueueMock = $this->getMock(
            'TYPO3\\CMS\\Core\\Messaging\\FlashMessageQueue',
            array(),
            array(),
            '',
            FALSE
        );
        $flashMessageServiceMock
            ->expects($this->once())
            ->method('getMessageQueueByIdentifier')
            ->will($this->returnValue($flashMessageQueueMock));
        $flashMessageQueueMock
            ->expects($this->once())
            ->method('enqueue')
            ->with($this->isInstanceOf('TYPO3\\CMS\\Core\\Messaging\\FlashMessage'))
            ->will($this->returnCallback(array($this, 'enqueueFlashMessageCallback')));

        $languageServiceMock = $this->getMock('TYPO3\CMS\Lang\LanguageService', array(), array(), '', FALSE);
        $languageServiceMock->expects($this->once())->method('sL')->will($this->returnValue('foo'));
        $this->subject->expects($this->once())->method('getLanguageService')->will($this->returnValue($languageServiceMock));

        $this->subject->_call('createValidationErrorMessage');
    }

    public function enqueueFlashMessageCallback(\TYPO3\CMS\Core\Messaging\FlashMessage $flashMessage) {
        $this->assertEquals(\TYPO3\CMS\Core\Messaging\FlashMessage::ERROR, $flashMessage->getSeverity());
    }

    public function createValidationErrorMessageAddsErrorFlashMessageButNotInSessionInAjaxRequest() {
        $flashMessageServiceMock = $this->getMock('TYPO3\\CMS\\Core\\Messaging\\FlashMessageService');
        \TYPO3\CMS\Core\Utility\GeneralUtility::setSingletonInstance(
            'TYPO3\\CMS\\Core\\Messaging\\FlashMessageService',
            $flashMessageServiceMock
        );
        $flashMessageQueueMock = $this->getMock(
            'TYPO3\\CMS\\Core\\Messaging\\FlashMessageQueue',
            array(),
            array(),
            '',
            FALSE
        );
        $flashMessageServiceMock
            ->expects($this->once())
            ->method('getMessageQueueByIdentifier')
            ->will($this->returnValue($flashMessageQueueMock));
        $flashMessageQueueMock
            ->expects($this->once())
            ->method('enqueue')
            ->with($this->isInstanceOf('TYPO3\\CMS\\Core\\Messaging\\FlashMessage'))
            ->will($this->returnCallback(array($this, 'enqueueAjaxFlashMessageCallback')));

        $languageServiceMock = $this->getMock('TYPO3\CMS\Lang\LanguageService', array(), array(), '', FALSE);
        $languageServiceMock->expects($this->once())->method('sL')->will($this->returnValue('foo'));
        $this->subject->expects($this->once())->method('getLanguageService')->will($this->returnValue($languageServiceMock));

        $this->subject->expects($this->any())->method('isAjaxRequest')->will($this->returnValue(TRUE));
        $this->subject->_call('createValidationErrorMessage');
    }

    public function enqueueAjaxFlashMessageCallback(\TYPO3\CMS\Core\Messaging\FlashMessage $flashMessage) {
        $this->assertFalse($flashMessage->isSessionMessage());
    }
}