FormDataCompilerTest.php

Go to the documentation of this file.

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

/*
 * 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 Prophecy\Prophecy\ObjectProphecy;
use TYPO3\CMS\Backend\Form\FormDataCompiler;
use TYPO3\CMS\Backend\Form\FormDataGroupInterface;

class FormDataCompilerTest extends \TYPO3\TestingFramework\Core\Unit\UnitTestCase
{
    protected $subject;

    protected $formDataGroupProphecy;

    protected function setUp()
    {
        $this->formDataGroupProphecy = $this->prophesize(FormDataGroupInterface::class);
        $this->subject = new FormDataCompiler($this->formDataGroupProphecy->reveal());
    }

    public function compileThrowsExceptionIfInputContainsKeysNotValidInResult()
    {
        $input = [
            'foo' => 'bar',
        ];
        $this->expectException(\InvalidArgumentException::class);
        $this->expectExceptionCode(1440601540);
        $this->subject->compile($input);
    }

    public function compileThrowsExceptionAtUnknownCommand()
    {
        $input = [
            'command' => 'unknownCommand',
        ];
        $this->expectException(\InvalidArgumentException::class);
        $this->expectExceptionCode(1437653136);
        $this->subject->compile($input);
    }

    public function compileThrowsExceptionIfNoTableNameGiven()
    {
        $input = [
            'tableName' => '',
        ];
        $this->expectException(\InvalidArgumentException::class);
        $this->expectExceptionCode(1437654409);
        $this->subject->compile($input);
    }

    public function compileThrowsExceptionIfUidIsNotAnInteger()
    {
        $input = [
            'vanillaUid' => 'foo123',
        ];
        $this->expectException(\InvalidArgumentException::class);
        $this->expectExceptionCode(1437654247);
        $this->subject->compile($input);
    }

    public function compileThrowsExceptionIfCommandIsEditAndUidIsNegative()
    {
        $input = [
            'command' => 'edit',
            'vanillaUid' => -100,
        ];
        $this->expectException(\InvalidArgumentException::class);
        $this->expectExceptionCode(1437654332);
        $this->subject->compile($input);
    }

    public function compileReturnsResultArrayWithInputDataSet()
    {
        $input = [
            'tableName' => 'pages',
            'vanillaUid' => 123,
            'command' => 'edit',
        ];
        $this->formDataGroupProphecy->compile(Argument::cetera())->willReturnArgument(0);
        $result = $this->subject->compile($input);
        $this->assertEquals('pages', $result['tableName']);
        $this->assertEquals(123, $result['vanillaUid']);
        $this->assertEquals('edit', $result['command']);
    }

    public function compileReturnsResultArrayWithAdditionalDataFormFormDataGroup()
    {
        $this->formDataGroupProphecy->compile(Argument::cetera())->will(function ($arguments) {
            $result = $arguments[0];
            $result['databaseRow'] = 'newData';
            return $result;
        });
        $result = $this->subject->compile([]);
        $this->assertEquals('newData', $result['databaseRow']);
    }

    public function compileThrowsExceptionIfFormDataGroupDoesNotReturnArray()
    {
        $this->formDataGroupProphecy->compile(Argument::cetera())->willReturn(null);
        $this->expectException(\UnexpectedValueException::class);
        $this->expectExceptionCode(1446664764);
        $this->subject->compile([]);
    }

    public function compileThrowsExceptionIfRenderDataIsNotEmpty()
    {
        $this->formDataGroupProphecy->compile(Argument::cetera())->willReturn([
            'renderData' => [ 'foo' ],
        ]);
        $this->expectException(\RuntimeException::class);
        $this->expectExceptionCode(1485201279);
        $this->subject->compile([]);
    }

    public function compileThrowsExceptionIfFormDataGroupRemovedKeysFromResultArray()
    {
        $this->formDataGroupProphecy->compile(Argument::cetera())->will(function ($arguments) {
            $result = $arguments[0];
            unset($result['tableName']);
            return $result;
        });
        $this->expectException(\UnexpectedValueException::class);
        $this->expectExceptionCode(1438079402);
        $this->subject->compile([]);
    }

    public function compileThrowsExceptionIfFormDataGroupAddedKeysToResultArray()
    {
        $this->formDataGroupProphecy->compile(Argument::cetera())->will(function ($arguments) {
            $result = $arguments[0];
            $result['newKey'] = 'newData';
            return $result;
        });
        $this->expectException(\UnexpectedValueException::class);
        $this->expectExceptionCode(1438079402);
        $this->subject->compile([]);
    }
}