FormFrontendControllerTest.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Form\Tests\Unit\Controller;

/*
 * 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 Prophecy\Argument;
use TYPO3\CMS\Extbase\Object\ObjectManager;
use TYPO3\CMS\Form\Controller\FormFrontendController;
use TYPO3\CMS\Form\Domain\Configuration\ConfigurationService;
use TYPO3\CMS\Form\Mvc\Configuration\TypoScriptService;

class FormFrontendControllerTest extends \TYPO3\TestingFramework\Core\Unit\UnitTestCase
{

    public function overrideByFlexFormSettingsReturnsNoOverriddenConfigurationIfFlexformOverridesDisabled()
    {
        $mockController = $this->getAccessibleMock(FormFrontendController::class, [
            'dummy'
        ], [], '', false);

        $configurationServiceProphecy = $this->prophesize(ConfigurationService::class);

        $objectManagerMock = $this->createMock(ObjectManager::class);
        $objectManagerMock
            ->expects($this->any())
            ->method('get')
            ->with(ConfigurationService::class)
            ->willReturn($configurationServiceProphecy->reveal());

        $mockController->_set('objectManager', $objectManagerMock);

        $configurationServiceProphecy->getPrototypeConfiguration(Argument::cetera())->willReturn([
            'finishersDefinition' => [
                'EmailToReceiver' => [
                    'FormEngine' => [
                        'elements' => [
                            'subject' => [],
                            'recipientAddress' => [],
                            'format' => [],
                        ],
                    ],
                ],
            ],
        ]);

        $mockController->_set('settings', [
            'overrideFinishers' => 0,
            'finishers' => [
                'EmailToReceiver' => [
                    'subject' => 'Mesage Subject overridden',
                    'recipientAddress' => 'your.company@example.com overridden',
                    'format' => 'html overridden',
                ],
            ],
        ]);

        $input = [
            'identifier' => 'ext-form-identifier',
            'prototypeName' => 'standard',
            'finishers' => [
                0 => [
                    'identifier' => 'EmailToReceiver',
                    'options' => [
                        'subject' => 'Mesage Subject',
                        'recipientAddress' => 'your.company@example.com',
                        'format' => 'html',
                    ],
                ],
            ],
        ];

        $expected = [
            'identifier' => 'ext-form-identifier',
            'prototypeName' => 'standard',
            'finishers' => [
                0 => [
                    'identifier' => 'EmailToReceiver',
                    'options' => [
                        'subject' => 'Mesage Subject',
                        'recipientAddress' => 'your.company@example.com',
                        'format' => 'html',
                    ],
                ],
            ],
        ];

        $this->assertSame($expected, $mockController->_call('overrideByFlexFormSettings', $input));
    }

    public function overrideByFlexFormSettingsReturnsOverriddenConfigurationIfFlexformOverridesEnabled()
    {
        $mockController = $this->getAccessibleMock(FormFrontendController::class, [
            'dummy'
        ], [], '', false);

        $configurationServiceProphecy = $this->prophesize(ConfigurationService::class);

        $objectManagerMock = $this->createMock(ObjectManager::class);
        $objectManagerMock
            ->expects($this->any())
            ->method('get')
            ->with(ConfigurationService::class)
            ->willReturn($configurationServiceProphecy->reveal());

        $mockController->_set('objectManager', $objectManagerMock);

        $configurationServiceProphecy->getPrototypeConfiguration(Argument::cetera())->willReturn([
            'finishersDefinition' => [
                'EmailToReceiver' => [
                    'FormEngine' => [
                        'elements' => [
                            'subject' => [],
                            'recipientAddress' => [],
                            'format' => [],
                        ],
                    ],
                ],
            ],
        ]);

        $mockController->_set('settings', [
            'overrideFinishers' => 1,
            'finishers' => [
                'EmailToReceiver' => [
                    'subject' => 'Mesage Subject overridden',
                    'recipientAddress' => 'your.company@example.com overridden',
                    'format' => 'html overridden',
                ],
            ],
        ]);

        $input = [
            'identifier' => 'ext-form-identifier',
            'prototypeName' => 'standard',
            'finishers' => [
                0 => [
                    'identifier' => 'EmailToReceiver',
                    'options' => [
                        'subject' => 'Mesage Subject',
                        'recipientAddress' => 'your.company@example.com',
                        'format' => 'html',
                    ],
                ],
            ],
        ];

        $expected = [
            'identifier' => 'ext-form-identifier',
            'prototypeName' => 'standard',
            'finishers' => [
                0 => [
                    'identifier' => 'EmailToReceiver',
                    'options' => [
                        'subject' => 'Mesage Subject overridden',
                        'recipientAddress' => 'your.company@example.com overridden',
                        'format' => 'html overridden',
                    ],
                ],
            ],
        ];

        $this->assertSame($expected, $mockController->_call('overrideByFlexFormSettings', $input));
    }

    public function overrideByFlexFormSettingsReturnsNotOverriddenConfigurationKeyIfFlexformOverridesAreNotRepresentedInFormEngineConfiguration()
    {
        $mockController = $this->getAccessibleMock(FormFrontendController::class, [
            'dummy'
        ], [], '', false);

        $configurationServiceProphecy = $this->prophesize(ConfigurationService::class);

        $objectManagerMock = $this->createMock(ObjectManager::class);
        $objectManagerMock
            ->expects($this->any())
            ->method('get')
            ->with(ConfigurationService::class)
            ->willReturn($configurationServiceProphecy->reveal());

        $mockController->_set('objectManager', $objectManagerMock);

        $configurationServiceProphecy->getPrototypeConfiguration(Argument::cetera())->willReturn([
            'finishersDefinition' => [
                'EmailToReceiver' => [
                    'FormEngine' => [
                        'elements' => [
                            'subject' => [],
                            'recipientAddress' => [],
                        ],
                    ],
                ],
            ],
        ]);

        $mockController->_set('settings', [
            'overrideFinishers' => 1,
            'finishers' => [
                'EmailToReceiver' => [
                    'subject' => 'Mesage Subject overridden',
                    'recipientAddress' => 'your.company@example.com overridden',
                    'format' => 'html overridden',
                ],
            ],
        ]);

        $input = [
            'identifier' => 'ext-form-identifier',
            'prototypeName' => 'standard',
            'finishers' => [
                0 => [
                    'identifier' => 'EmailToReceiver',
                    'options' => [
                        'subject' => 'Mesage Subject',
                        'recipientAddress' => 'your.company@example.com',
                        'format' => 'html',
                    ],
                ],
            ],
        ];

        $expected = [
            'identifier' => 'ext-form-identifier',
            'prototypeName' => 'standard',
            'finishers' => [
                0 => [
                    'identifier' => 'EmailToReceiver',
                    'options' => [
                        'subject' => 'Mesage Subject overridden',
                        'recipientAddress' => 'your.company@example.com overridden',
                        'format' => 'html',
                    ],
                ],
            ],
        ];

        $this->assertSame($expected, $mockController->_call('overrideByFlexFormSettings', $input));
    }

    public function overrideByTypoScriptSettingsReturnsNotOverriddenConfigurationIfNoTypoScriptOverridesExists()
    {
        $mockController = $this->getAccessibleMock(FormFrontendController::class, [
            'dummy'
        ], [], '', false);

        $typoScriptServiceProphecy = $this->prophesize(TypoScriptService::class);

        $objectManagerMock = $this->createMock(ObjectManager::class);
        $objectManagerMock
            ->expects($this->any())
            ->method('get')
            ->with(TypoScriptService::class)
            ->willReturn($typoScriptServiceProphecy->reveal());

        $mockController->_set('objectManager', $objectManagerMock);

        $typoScriptServiceProphecy
            ->resolvePossibleTypoScriptConfiguration(Argument::cetera())
            ->willReturnArgument(0);

        $mockController->_set('settings', [
            'formDefinitionOverrides' => [
            ],
        ]);

        $input = [
            'identifier' => 'ext-form-identifier',
            'prototypeName' => 'standard',
            'label' => 'Label',
            'renderables' => [
                0 => [
                    'identifier' => 'page-1',
                    'type' => 'Page',
                    'label' => 'Label',
                    'renderables' => [
                        0 => [
                            'identifier' => 'text-1',
                            'type' => 'Text',
                            'label' => 'Label',
                        ],
                    ],
                ],
            ],
        ];

        $expected = [
            'identifier' => 'ext-form-identifier',
            'prototypeName' => 'standard',
            'label' => 'Label',
            'renderables' => [
                0 => [
                    'identifier' => 'page-1',
                    'type' => 'Page',
                    'label' => 'Label',
                    'renderables' => [
                        0 => [
                            'identifier' => 'text-1',
                            'type' => 'Text',
                            'label' => 'Label',
                        ],
                    ],
                ],
            ],
        ];

        $this->assertSame($expected, $mockController->_call('overrideByTypoScriptSettings', $input));
    }

    public function overrideByTypoScriptSettingsReturnsOverriddenConfigurationIfTypoScriptOverridesExists()
    {
        $mockController = $this->getAccessibleMock(FormFrontendController::class, [
            'dummy'
        ], [], '', false);

        $typoScriptServiceProphecy = $this->prophesize(TypoScriptService::class);

        $objectManagerMock = $this->createMock(ObjectManager::class);
        $objectManagerMock
            ->expects($this->any())
            ->method('get')
            ->with(TypoScriptService::class)
            ->willReturn($typoScriptServiceProphecy->reveal());

        $mockController->_set('objectManager', $objectManagerMock);

        $typoScriptServiceProphecy
            ->resolvePossibleTypoScriptConfiguration(Argument::cetera())
            ->willReturnArgument(0);

        $mockController->_set('settings', [
            'formDefinitionOverrides' => [
                'ext-form-identifier' => [
                    'label' => 'Label override',
                    'renderables' => [
                        0 => [
                            'renderables' => [
                                0 => [
                                    'label' => 'Label override',
                                ],
                            ],
                        ],
                    ],
                ],
            ],
        ]);

        $input = [
            'identifier' => 'ext-form-identifier',
            'prototypeName' => 'standard',
            'label' => 'Label',
            'renderables' => [
                0 => [
                    'identifier' => 'page-1',
                    'type' => 'Page',
                    'label' => 'Label',
                    'renderables' => [
                        0 => [
                            'identifier' => 'text-1',
                            'type' => 'Text',
                            'label' => 'Label',
                        ],
                    ],
                ],
            ],
        ];

        $expected = [
            'identifier' => 'ext-form-identifier',
            'prototypeName' => 'standard',
            'label' => 'Label override',
            'renderables' => [
                0 => [
                    'identifier' => 'page-1',
                    'type' => 'Page',
                    'label' => 'Label',
                    'renderables' => [
                        0 => [
                            'identifier' => 'text-1',
                            'type' => 'Text',
                            'label' => 'Label override',
                        ],
                    ],
                ],
            ],
        ];

        $this->assertSame($expected, $mockController->_call('overrideByTypoScriptSettings', $input));
    }
}