FormDefinitionArrayConverterTest.php

Go to the documentation of this file.

<?php
 
declare(strict_types=1);
 
/*
 * 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!
 */
 
namespace ‪TYPO3\CMS\Form\Tests\Unit\Mvc\Property\TypeConverter;
 
use PHPUnit\Framework\Attributes\Test;
use ‪TYPO3\CMS\Core\Crypto\HashService;
use ‪TYPO3\CMS\Form\Domain\Configuration\Exception\PropertyException;
use ‪TYPO3\CMS\Form\Domain\Configuration\FormDefinitionValidationService;
use ‪TYPO3\CMS\Form\Mvc\Property\TypeConverter\FormDefinitionArrayConverter;
use ‪TYPO3\CMS\Form\Type\FormDefinitionArray;
use TYPO3\TestingFramework\Core\Unit\UnitTestCase;
 
final class ‪FormDefinitionArrayConverterTest extends UnitTestCase
{
    protected bool ‪$resetSingletonInstances = true;
    protected ‪HashService ‪$hashService;
 
    public function ‪setUp(): void
    {
        parent::setUp();
        ‪$GLOBALS['TYPO3_CONF_VARS']['SYS']['encryptionKey'] = '12345';
        $this->hashService = new ‪HashService();
    }
 
    #[Test]
    public function ‪convertsJsonStringToFormDefinitionArray(): void
    {
        $sessionToken = '123';
 
        $data = [
            'prototypeName' => 'standard',
            'identifier' => 'test',
            'type' => 'Text',
            'enabled' => false,
            'properties' => [
                'options' => [
                    [
                        '_label' => 'label',
                        '_value' => 'value',
                    ],
                ],
            ],
            '_orig_prototypeName' => [
                'value' => 'standard',
                'hmac' => $this->hashService->hmac(serialize(['test', 'prototypeName', 'standard']), $sessionToken),
            ],
            '_orig_identifier' => [
                'value' => 'test',
                'hmac' => $this->hashService->hmac(serialize(['test', 'identifier', 'test']), $sessionToken),
            ],
        ];
 
        $typeConverter = $this->getAccessibleMock(FormDefinitionArrayConverter::class, ['getFormDefinitionValidationService', 'retrieveSessionToken'], callOriginalConstructor: false);
        $formDefinitionValidationServiceMock = $this->createMock(FormDefinitionValidationService::class);
        $formDefinitionValidationServiceMock->expects(self::atLeastOnce())->method('validateFormDefinitionProperties')->with(self::anything());
        $formDefinitionValidationServiceMock->method('isPropertyValueEqualToHistoricalValue')->with(self::anything())->willReturn(true);
 
        $typeConverter->method(
            'retrieveSessionToken'
        )->willReturn($sessionToken);
 
        $typeConverter->method(
            'getFormDefinitionValidationService'
        )->willReturn($formDefinitionValidationServiceMock);
 
        $input = json_encode($data);
        $expected = [
            'prototypeName' => 'standard',
            'identifier' => 'test',
            'type' => 'Text',
            'enabled' => false,
            'properties' => [
                'options' => [
                    'value' => 'label',
                ],
            ],
        ];
        $result = $typeConverter->convertFrom($input, FormDefinitionArray::class);
 
        self::assertInstanceOf(FormDefinitionArray::class, $result);
        self::assertSame($expected, $result->getArrayCopy());
    }
 
    #[Test]
    public function ‪convertFromThrowsExceptionIfJsonIsInvalid(): void
    {
        $this->expectException(PropertyException::class);
        $this->expectExceptionCode(1512578002);
 
        $typeConverter = new ‪FormDefinitionArrayConverter();
        $input = '{"francine":"stan",';
 
        $typeConverter->convertFrom($input, FormDefinitionArray::class);
    }
 
    #[Test]
    public function ‪transformMultiValueElementsForFormFrameworkTransformValues(): void
    {
        $typeConverter = $this->getAccessibleMock(FormDefinitionArrayConverter::class, null, [], '', false);
 
        $input = [
            'foo1' => 'bar',
            'foo2' => [
                'foo3' => [
                    [
                        '_label' => 'xxx1',
                        '_value' => 'yyy1',
                    ],
                    [
                        '_label' => 'xxx2',
                        '_value' => 'yyy2',
                    ],
                    [
                        '_label' => 'xxx3',
                        '_value' => 'yyy2',
                    ],
                ],
                '_label' => 'xxx',
                '_value' => 'yyy',
            ],
            '_label' => 'xxx',
            '_value' => 'yyy',
        ];
 
        $expected = [
            'foo1' => 'bar',
            'foo2' => [
                'foo3' => [
                    'yyy1' => 'xxx1',
                    'yyy2' => 'xxx3',
                ],
                '_label' => 'xxx',
                '_value' => 'yyy',
            ],
            '_label' => 'xxx',
            '_value' => 'yyy',
        ];
 
        self::assertSame($expected, $typeConverter->_call('transformMultiValueElementsForFormFramework', $input));
    }
 
    #[Test]
    public function ‪convertFromThrowsExceptionIfPrototypeNameWasChanged(): void
    {
        $this->expectException(PropertyException::class);
        $this->expectExceptionCode(1528538322);
 
        $sessionToken = '123';
        $typeConverter = $this->getAccessibleMock(FormDefinitionArrayConverter::class, ['retrieveSessionToken'], [], '', false);
 
        $typeConverter->method(
            'retrieveSessionToken'
        )->willReturn($sessionToken);
 
        $input = [
            'prototypeName' => 'foo',
            'identifier' => 'test',
            '_orig_prototypeName' => [
                'value' => 'standard',
                'hmac' => $this->hashService->hmac(serialize(['test', 'prototypeName', 'standard']), $sessionToken),
            ],
            '_orig_identifier' => [
                'value' => 'test',
                'hmac' => $this->hashService->hmac(serialize(['test', 'identifier', 'test']), $sessionToken),
            ],
        ];
 
        $typeConverter->convertFrom(json_encode($input), FormDefinitionArray::class);
    }
 
    #[Test]
    public function ‪convertFromThrowsExceptionIfIdentifierWasChanged(): void
    {
        $this->expectException(PropertyException::class);
        $this->expectExceptionCode(1528538322);
 
        $sessionToken = '123';
        $typeConverter = $this->getAccessibleMock(FormDefinitionArrayConverter::class, ['retrieveSessionToken'], [], '', false);
 
        $typeConverter->method(
            'retrieveSessionToken'
        )->willReturn($sessionToken);
 
        $input = [
            'prototypeName' => 'standard',
            'identifier' => 'xxx',
            '_orig_prototypeName' => [
                'value' => 'standard',
                'hmac' => $this->hashService->hmac(serialize(['test', 'prototypeName', 'standard']), $sessionToken),
            ],
            '_orig_identifier' => [
                'value' => 'test',
                'hmac' => $this->hashService->hmac(serialize(['test', 'prototypeName', 'test']), $sessionToken),
            ],
        ];
 
        $typeConverter->convertFrom(json_encode($input), FormDefinitionArray::class);
    }
}