FormDefinitionValidationServiceTest.php

Go to the documentation of this file.

<?php
declare(strict_types = 1);
namespace TYPO3\CMS\Form\Tests\Unit\Domain\Configuration;

/*
 * 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 TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Extbase\Object\ObjectManager;
use TYPO3\CMS\Form\Domain\Configuration\ConfigurationService;
use TYPO3\CMS\Form\Domain\Configuration\Exception\PropertyException;
use TYPO3\CMS\Form\Domain\Configuration\FormDefinition\Validators\ValidationDto;
use TYPO3\CMS\Form\Domain\Configuration\FormDefinitionValidationService;
use TYPO3\TestingFramework\Core\Unit\UnitTestCase;

class FormDefinitionValidationServiceTest extends UnitTestCase
{
    protected $singletonInstances = [];

    public function setUp()
    {
        parent::setUp();
        $this->singletonInstances = GeneralUtility::getSingletonInstances();
        $GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey'] = '12345';
    }

    public function tearDown()
    {
        GeneralUtility::resetSingletonInstances($this->singletonInstances);
        parent::tearDown();
    }

    public function validateAllFormElementPropertyValuesByHmacThrowsExceptionIfHmacIsInvalid()
    {
        $this->expectException(PropertyException::class);
        $this->expectExceptionCode(1528588036);

        $typeConverter = $this->getAccessibleMock(FormDefinitionValidationService::class, ['dummy'], [], '', false);

        $prototypeName = 'standard';
        $identifier = 'some-text';

        $sessionToken = '123';

        $validationDto = new ValidationDto($prototypeName, 'Text', $identifier);

        $input = [
            'label' => 'xxx',
            '_orig_label' => [
                'value' => 'aaa',
                'hmac' => GeneralUtility::hmac(serialize([$identifier, 'label', 'aaa']), $sessionToken),
            ],
        ];

        $typeConverter->_call('validateAllFormElementPropertyValuesByHmac', $input, $sessionToken, $validationDto);
    }

    public function validateAllFormElementPropertyValuesByHmacThrowsExceptionIfHmacDoesNotExists()
    {
        $this->expectException(PropertyException::class);
        $this->expectExceptionCode(1528588037);

        $typeConverter = $this->getAccessibleMock(FormDefinitionValidationService::class, ['dummy'], [], '', false);

        $prototypeName = 'standard';
        $identifier = 'some-text';

        $sessionToken = '123';

        $validationDto = new ValidationDto($prototypeName, 'Text', $identifier);

        $input = [
            'label' => 'xxx',
        ];

        $typeConverter->_call('validateAllFormElementPropertyValuesByHmac', $input, $sessionToken, $validationDto);
    }

    public function validateAllFormElementPropertyValuesByHmacThrowsNoExceptionIfHmacIsValid()
    {
        $typeConverter = $this->getAccessibleMock(FormDefinitionValidationService::class, ['dummy'], [], '', false);

        $prototypeName = 'standard';
        $identifier = 'some-text';

        $sessionToken = '123';

        $validationDto = new ValidationDto($prototypeName, 'Text', $identifier);

        $input = [
            'label' => 'aaa',
            '_orig_label' => [
                'value' => 'aaa',
                'hmac' => GeneralUtility::hmac(serialize([$identifier, 'label', 'aaa']), $sessionToken),
            ],
        ];

        $failed = false;
        try {
            $typeConverter->_call(
                'validateAllFormElementPropertyValuesByHmac',
                $input,
                $sessionToken,
                $validationDto
            );
        } catch (PropertyException $e) {
            $failed = true;
        }
        $this->assertFalse($failed);
    }

    public function validateAllPropertyCollectionElementValuesByHmacThrowsExceptionIfHmacIsInvalid()
    {
        $this->expectException(PropertyException::class);
        $this->expectExceptionCode(1528591586);

        $typeConverter = $this->getAccessibleMock(FormDefinitionValidationService::class, ['dummy'], [], '', false);

        $prototypeName = 'standard';
        $identifier = 'some-text';

        $sessionToken = '123';

        $validationDto = new ValidationDto($prototypeName, 'Text', $identifier, null, 'validators');

        $input = [
            'identifier' => 'StringLength',
            '_orig_identifier' => [
                'value' => 'StringLength',
                'hmac' => GeneralUtility::hmac(serialize([$identifier, 'validators', 'StringLength', 'identifier', 'StringLength']), $sessionToken),
            ],
            'options' => [
                'test' => 'xxx',
                '_orig_test' => [
                    'value' => 'aaa',
                    'hmac' => GeneralUtility::hmac(serialize([$identifier, 'validators', 'StringLength', 'options.test', 'aaa']), $sessionToken),
                ],
            ],
        ];

        $typeConverter->_call(
            'validateAllPropertyCollectionElementValuesByHmac',
            $input,
            $sessionToken,
            $validationDto
        );
    }

    public function validateAllPropertyCollectionElementValuesByHmacThrowsExceptionIfHmacDoesNotExists()
    {
        $this->expectException(PropertyException::class);
        $this->expectExceptionCode(1528591585);

        $typeConverter = $this->getAccessibleMock(FormDefinitionValidationService::class, ['dummy'], [], '', false);

        $prototypeName = 'standard';
        $identifier = 'some-text';

        $sessionToken = '123';

        $validationDto = new ValidationDto($prototypeName, 'Text', $identifier, null, 'validators');

        $input = [
            'identifier' => 'StringLength',
            '_orig_identifier' => [
                'value' => 'StringLength',
                'hmac' => GeneralUtility::hmac(serialize([$identifier, 'validators', 'StringLength', 'identifier', 'StringLength']), $sessionToken),
            ],
            'options' => [
                'test' => 'xxx',
            ],
        ];

        $typeConverter->_call(
            'validateAllPropertyCollectionElementValuesByHmac',
            $input,
            $sessionToken,
            $validationDto
        );
    }

    public function validateAllPropertyCollectionElementValuesByHmacThrowsNoExceptionIfHmacIsValid()
    {
        $typeConverter = $this->getAccessibleMock(FormDefinitionValidationService::class, ['dummy'], [], '', false);

        $prototypeName = 'standard';
        $identifier = 'some-text';

        $sessionToken = '123';

        $validationDto = new ValidationDto($prototypeName, 'Text', $identifier, null, 'validators');

        $input = [
            'identifier' => 'StringLength',
            '_orig_identifier' => [
                'value' => 'StringLength',
                'hmac' => GeneralUtility::hmac(serialize([$identifier, 'validators', 'StringLength', 'identifier', 'StringLength']), $sessionToken),
            ],
            'options' => [
                'test' => 'aaa',
                '_orig_test' => [
                    'value' => 'aaa',
                    'hmac' => GeneralUtility::hmac(serialize([$identifier, 'validators', 'StringLength', 'options.test', 'aaa']), $sessionToken),
                ],
            ],
        ];

        $failed = false;
        try {
            $typeConverter->_call(
                'validateAllPropertyCollectionElementValuesByHmac',
                $input,
                $sessionToken,
                $validationDto
            );
        } catch (PropertyException $e) {
            $failed = true;
        }
        $this->assertFalse($failed);
    }

    public function validateAllPropertyValuesFromCreatableFormElement(
        array $mockConfiguration,
        array $formElement,
        string $sessionToken,
        int $exceptionCode,
        ValidationDto $validationDto
    ) {
        $typeConverter = $this->getAccessibleMock(
            FormDefinitionValidationService::class,
            ['getConfigurationService'],
            [],
            '',
            false
        );

        $configurationService = $this->createMock(ConfigurationService::class);
        $configurationService->expects($this->any())
            ->method('isFormElementPropertyDefinedInFormEditorSetup')
            ->willReturn($mockConfiguration['isFormElementPropertyDefinedInFormEditorSetup']);
        $configurationService->expects($this->any())->method(
            'isFormElementPropertyDefinedInPredefinedDefaultsInFormEditorSetup'
        )->willReturn($mockConfiguration['isFormElementPropertyDefinedInPredefinedDefaultsInFormEditorSetup']);
        $configurationService->expects($this->any())
            ->method('getFormElementPredefinedDefaultValueFromFormEditorSetup')
            ->willReturn($mockConfiguration['getFormElementPredefinedDefaultValueFromFormEditorSetup']);
        $typeConverter->expects($this->any())->method('getConfigurationService')->willReturn($configurationService);
        $formDefinitionValidationService = $this->getAccessibleMock(FormDefinitionValidationService::class, ['getConfigurationService']);
        $formDefinitionValidationService->expects($this->any())->method('getConfigurationService')->willReturn($configurationService);
        GeneralUtility::setSingletonInstance(FormDefinitionValidationService::class, $formDefinitionValidationService);
        GeneralUtility::setSingletonInstance(ConfigurationService::class, $configurationService);

        $objectMangerProphecy = $this->prophesize(ObjectManager::class);
        GeneralUtility::setSingletonInstance(ObjectManager::class, $objectMangerProphecy->reveal());

        $objectMangerProphecy
            ->get(ConfigurationService::class)
            ->willReturn($configurationService);

        $returnedExceptionCode = -1;
        try {
            $typeConverter->_call(
                'validateAllPropertyValuesFromCreatableFormElement',
                $formElement,
                $sessionToken,
                $validationDto
            );
        } catch (PropertyException $e) {
            $returnedExceptionCode = $e->getCode();
        }
        $this->assertEquals($returnedExceptionCode, $exceptionCode);
    }

    public function validateAllPropertyValuesFromCreatablePropertyCollectionElement(
        array $mockConfiguration,
        array $formElement,
        string $sessionToken,
        int $exceptionCode,
        ValidationDto $validationDto
    ) {
        $typeConverter = $this->getAccessibleMock(
            FormDefinitionValidationService::class,
            ['getConfigurationService'],
            [],
            '',
            false
        );

        $configurationService = $this->createMock(ConfigurationService::class);
        $configurationService->expects($this->any())
            ->method('isPropertyCollectionPropertyDefinedInFormEditorSetup')
            ->willReturn($mockConfiguration['isPropertyCollectionPropertyDefinedInFormEditorSetup']);
        $configurationService->expects($this->any())->method(
            'isPropertyCollectionPropertyDefinedInPredefinedDefaultsInFormEditorSetup'
        )->willReturn($mockConfiguration['isPropertyCollectionPropertyDefinedInPredefinedDefaultsInFormEditorSetup']);
        $configurationService->expects($this->any())->method(
            'getPropertyCollectionPredefinedDefaultValueFromFormEditorSetup'
        )->willReturn($mockConfiguration['getPropertyCollectionPredefinedDefaultValueFromFormEditorSetup']);
        $typeConverter->expects($this->any())->method('getConfigurationService')->willReturn($configurationService);
        $formDefinitionValidationService = $this->getAccessibleMock(FormDefinitionValidationService::class, ['getConfigurationService']);
        $formDefinitionValidationService->expects($this->any())->method('getConfigurationService')->willReturn($configurationService);
        GeneralUtility::setSingletonInstance(FormDefinitionValidationService::class, $formDefinitionValidationService);
        GeneralUtility::setSingletonInstance(ConfigurationService::class, $configurationService);

        $objectMangerProphecy = $this->prophesize(ObjectManager::class);
        GeneralUtility::setSingletonInstance(ObjectManager::class, $objectMangerProphecy->reveal());

        $objectMangerProphecy
            ->get(ConfigurationService::class)
            ->willReturn($configurationService);

        $returnedExceptionCode = -1;
        try {
            $typeConverter->_call(
                'validateAllPropertyValuesFromCreatablePropertyCollectionElement',
                $formElement,
                $sessionToken,
                $validationDto
            );
        } catch (PropertyException $e) {
            $returnedExceptionCode = $e->getCode();
        }
        $this->assertEquals($returnedExceptionCode, $exceptionCode);
    }

    public function validateAllPropertyValuesFromCreatableFormElementDataProvider(): array
    {
        $encryptionKeyBackup = $GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey'];
        $GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey'] = '12345';

        $sessionToken = '54321';
        $identifier = 'text-1';

        $validationDto = new ValidationDto('standard', 'Text', $identifier);
        $formElement = [
            'test' => 'xxx',
            '_orig_test' => [
                'value' => 'xxx',
                'hmac' => GeneralUtility::hmac(serialize([$identifier, 'test', 'xxx']), $sessionToken),
            ],
        ];

        $invalidFormElement = [
            'test' => 'xxx1',
            '_orig_test' => [
                'value' => 'xxx',
                'hmac' => GeneralUtility::hmac(serialize([$identifier, 'test', 'xxx']), $sessionToken),
            ],
        ];

        // be aware that backup globals does not impact globals used in data providers as these are called before the setUp/tearDown is done
        $GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey'] = $encryptionKeyBackup;

        return [
            [
                [
                    'isFormElementPropertyDefinedInFormEditorSetup' => true,
                    'isFormElementPropertyDefinedInPredefinedDefaultsInFormEditorSetup' => false,
                    'getFormElementPredefinedDefaultValueFromFormEditorSetup' => '',
                ],
                $formElement,
                $sessionToken,
                -1,
                $validationDto
            ],
            [
                [
                    'isFormElementPropertyDefinedInFormEditorSetup' => false,
                    'isFormElementPropertyDefinedInPredefinedDefaultsInFormEditorSetup' => false,
                    'getFormElementPredefinedDefaultValueFromFormEditorSetup' => 'default',
                ],
                $formElement,
                $sessionToken,
                -1,
                $validationDto
            ],
            [
                [
                    'isFormElementPropertyDefinedInFormEditorSetup' => false,
                    'isFormElementPropertyDefinedInPredefinedDefaultsInFormEditorSetup' => false,
                    'getFormElementPredefinedDefaultValueFromFormEditorSetup' => 'default',
                ],
                ['test' => 'xxx'],
                $sessionToken,
                1528588037,
                $validationDto
            ],
            [
                [
                    'isFormElementPropertyDefinedInFormEditorSetup' => false,
                    'isFormElementPropertyDefinedInPredefinedDefaultsInFormEditorSetup' => false,
                    'getFormElementPredefinedDefaultValueFromFormEditorSetup' => 'default',
                ],
                ['test' => 'xxx', '_orig_test' => []],
                $sessionToken,
                1528538222,
                $validationDto
            ],
            [
                [
                    'isFormElementPropertyDefinedInFormEditorSetup' => false,
                    'isFormElementPropertyDefinedInPredefinedDefaultsInFormEditorSetup' => false,
                    'getFormElementPredefinedDefaultValueFromFormEditorSetup' => 'default',
                ],
                ['test' => 'xxx', '_orig_test' => ['hmac' => '4242']],
                $sessionToken,
                1528538252,
                $validationDto
            ],
            [
                [
                    'isFormElementPropertyDefinedInFormEditorSetup' => false,
                    'isFormElementPropertyDefinedInPredefinedDefaultsInFormEditorSetup' => false,
                    'getFormElementPredefinedDefaultValueFromFormEditorSetup' => 'default',
                ],
                $invalidFormElement,
                $sessionToken,
                1528588036,
                $validationDto
            ],

            [
                [
                    'isFormElementPropertyDefinedInFormEditorSetup' => false,
                    'isFormElementPropertyDefinedInPredefinedDefaultsInFormEditorSetup' => true,
                    'getFormElementPredefinedDefaultValueFromFormEditorSetup' => 'xxx',
                ],
                $formElement,
                $sessionToken,
                -1,
                $validationDto
            ],
            [
                [
                    'isFormElementPropertyDefinedInFormEditorSetup' => false,
                    'isFormElementPropertyDefinedInPredefinedDefaultsInFormEditorSetup' => true,
                    'getFormElementPredefinedDefaultValueFromFormEditorSetup' => 'default',
                ],
                $formElement,
                $sessionToken,
                1528588035,
                $validationDto
            ],
        ];
    }

    public function validateAllPropertyValuesFromCreatablePropertyCollectionElementDataProvider(): array
    {
        $encryptionKeyBackup = $GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey'];
        $GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey'] = '12345';

        $sessionToken = '54321';
        $identifier = 'text-1';

        $validationDto = new ValidationDto('standard', 'Text', $identifier, null, 'validators', 'StringLength');
        $formElement = [
            'test' => 'xxx',
            '_orig_test' => [
                'value' => 'xxx',
                'hmac' => GeneralUtility::hmac(serialize([$identifier, 'validators', 'StringLength', 'test', 'xxx']), $sessionToken),
            ],
        ];

        $invalidFormElement = [
            'test' => 'xxx1',
            '_orig_test' => [
                'value' => 'xxx',
                'hmac' => GeneralUtility::hmac(serialize([$identifier, 'validators', 'StringLength', 'test', 'xxx']), $sessionToken),
            ],
        ];

        // be aware that backup globals does not impact globals used in data providers as these are called before the setUp/tearDown is done
        $GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey'] = $encryptionKeyBackup;

        return [
            [
                [
                    'isPropertyCollectionPropertyDefinedInFormEditorSetup' => true,
                    'isPropertyCollectionPropertyDefinedInPredefinedDefaultsInFormEditorSetup' => false,
                    'getPropertyCollectionPredefinedDefaultValueFromFormEditorSetup' => 'default',
                ],
                $formElement,
                $sessionToken,
                -1,
                $validationDto
            ],
            [
                [
                    'isPropertyCollectionPropertyDefinedInFormEditorSetup' => false,
                    'isPropertyCollectionPropertyDefinedInPredefinedDefaultsInFormEditorSetup' => false,
                    'getPropertyCollectionPredefinedDefaultValueFromFormEditorSetup' => 'default',
                ],
                $formElement,
                $sessionToken,
                -1,
                $validationDto
            ],
            [
                [
                    'isPropertyCollectionPropertyDefinedInFormEditorSetup' => false,
                    'isPropertyCollectionPropertyDefinedInPredefinedDefaultsInFormEditorSetup' => false,
                    'getPropertyCollectionPredefinedDefaultValueFromFormEditorSetup' => 'default',
                ],
                ['test' => 'xxx'],
                $sessionToken,
                1528591585,
                $validationDto
            ],
            [
                [
                    'isPropertyCollectionPropertyDefinedInFormEditorSetup' => false,
                    'isPropertyCollectionPropertyDefinedInPredefinedDefaultsInFormEditorSetup' => false,
                    'getPropertyCollectionPredefinedDefaultValueFromFormEditorSetup' => 'default',
                ],
                ['test' => 'xxx', '_orig_test' => []],
                $sessionToken,
                1528538222,
                $validationDto
            ],
            [
                [
                    'isPropertyCollectionPropertyDefinedInFormEditorSetup' => false,
                    'isPropertyCollectionPropertyDefinedInPredefinedDefaultsInFormEditorSetup' => false,
                    'getPropertyCollectionPredefinedDefaultValueFromFormEditorSetup' => 'default',
                ],
                ['test' => 'xxx', '_orig_test' => ['hmac' => '4242']],
                $sessionToken,
                1528538252,
                $validationDto
            ],
            [
                [
                    'isPropertyCollectionPropertyDefinedInFormEditorSetup' => false,
                    'isPropertyCollectionPropertyDefinedInPredefinedDefaultsInFormEditorSetup' => false,
                    'getPropertyCollectionPredefinedDefaultValueFromFormEditorSetup' => 'default',
                ],
                $invalidFormElement,
                $sessionToken,
                1528591586,
                $validationDto
            ],

            [
                [
                    'isPropertyCollectionPropertyDefinedInFormEditorSetup' => false,
                    'isPropertyCollectionPropertyDefinedInPredefinedDefaultsInFormEditorSetup' => true,
                    'getPropertyCollectionPredefinedDefaultValueFromFormEditorSetup' => 'xxx',
                ],
                $formElement,
                $sessionToken,
                -1,
                $validationDto
            ],
            [
                [
                    'isPropertyCollectionPropertyDefinedInFormEditorSetup' => false,
                    'isPropertyCollectionPropertyDefinedInPredefinedDefaultsInFormEditorSetup' => true,
                    'getPropertyCollectionPredefinedDefaultValueFromFormEditorSetup' => 'default',
                ],
                $formElement,
                $sessionToken,
                1528591502,
                $validationDto
            ],
        ];
    }
}