AbstractViewHelperTest.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Fluid\Tests\Unit\Core\ViewHelper;

/*
 * 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\Extbase\Mvc\Request;
use TYPO3\CMS\Extbase\Reflection\ReflectionService;
use TYPO3\CMS\Fluid\Core\Exception;
use TYPO3\CMS\Fluid\Tests\Unit\Core\Fixtures\TestViewHelper;
use TYPO3\CMS\Fluid\Tests\Unit\Core\Rendering\RenderingContextFixture;
use TYPO3Fluid\Fluid\Core\Variables\StandardVariableProvider;
use TYPO3Fluid\Fluid\Core\ViewHelper\ViewHelperVariableContainer;

class AbstractViewHelperTest extends \TYPO3\TestingFramework\Core\Unit\UnitTestCase
{
    protected $mockReflectionService;

    protected $fixtureMethodParameters = [
        'param1' => [
            'position' => 0,
            'optional' => false,
            'type' => 'integer',
            'defaultValue' => null
        ],
        'param2' => [
            'position' => 1,
            'optional' => false,
            'type' => 'array',
            'array' => true,
            'defaultValue' => null
        ],
        'param3' => [
            'position' => 2,
            'optional' => true,
            'type' => 'string',
            'array' => false,
            'defaultValue' => 'default'
        ],
    ];

    protected $fixtureMethodTags = [
        'param' => [
            'integer $param1 P1 Stuff',
            'array $param2 P2 Stuff',
            'string $param3 P3 Stuff'
        ]
    ];

    protected function setUp()
    {
        $this->mockReflectionService = $this->createMock(\TYPO3\CMS\Extbase\Reflection\ReflectionService::class);
    }

    public function registerRenderMethodArgumentsThrowsExceptionOnMissingType(array $arguments, $expectsException = false)
    {
        $reflectionService = $this->getMockBuilder(ReflectionService::class)
            ->setMethods(['getMethodParameters', 'getMethodTagsValues'])
            ->getMock();
        $reflectionService->expects($this->once())->method('getMethodParameters')->willReturn(
            [
                'param1' => [
                    'position' => 0,
                    'byReference' => false,
                    'optional' => false,
                    'allowsNull' => true
                ]
            ]
        );
        $reflectionService->expects($this->once())->method('getMethodTagsValues')->willReturn([]);
        $fixture = $this->getAccessibleMock(TestViewHelper::class, ['render']);
        $fixture->injectReflectionService($reflectionService);
        $this->expectException(Exception::class);
        $this->callInaccessibleMethod($fixture, 'registerRenderMethodArguments');
    }

    public function callRenderMethodBehavesAsExpected(array $arguments, $expectsException = false)
    {
        $reflectionService = $this->getMockBuilder(ReflectionService::class)
            ->setMethods(['getMethodParameters', 'getMethodTagsValues'])
            ->getMock();
        $reflectionService->expects($this->once())->method('getMethodParameters')->willReturn(
            [
                'param1' => [
                    'position' => 0,
                    'type' => 'integer',
                    'byReference' => false,
                    'array' => false,
                    'optional' => false,
                    'allowsNull' => true
                ],
                'param2' => [
                    'position' => 1,
                    'type' => 'array',
                    'byReference' => false,
                    'array' => true,
                    'optional' => false,
                    'allowsNull' => true
                ],
                'param3' => [
                    'position' => 2,
                    'type' => 'string',
                    'byReference' => false,
                    'array' => false,
                    'optional' => false,
                    'allowsNull' => true
                ],
            ]
        );
        $reflectionService->expects($this->once())->method('getMethodTagsValues')->willReturn(
            []
        );
        $fixture = $this->getAccessibleMock(TestViewHelper::class, ['render']);
        $namedArguments = array_combine(['param1', 'param2', 'param3'], $arguments);
        $fixture->injectReflectionService($reflectionService);
        $this->callInaccessibleMethod($fixture, 'registerRenderMethodArguments');
        $fixture->setArguments($namedArguments);
        if ($expectsException) {
            $exception = new \TYPO3Fluid\Fluid\Core\ViewHelper\Exception('test', 1476108352);
            $this->expectException(get_class($exception));
            $fixture->expects($this->once())->method('render')->willThrowException($exception);
            $this->assertEquals('test', $this->callInaccessibleMethod($fixture, 'callRenderMethod'));
        } else {
            $fixture->expects($this->once())
                ->method('render')
                ->with($arguments[0], $arguments[1], $arguments[2])
                ->willReturn('okay');
            $this->assertEquals('okay', $this->callInaccessibleMethod($fixture, 'callRenderMethod'));
        }
    }

    public function getCallRenderMethodTestValues()
    {
        return [
            [[3, ['bar'], 'baz'], false],
            [[2, ['baz'], 'bar'], false],
            [[3, ['bar'], 'baz'], true],
        ];
    }

    public function prepareArgumentsCallsInitializeArguments()
    {
        $viewHelper = $this->getAccessibleMock(\TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper::class, ['render', 'initializeArguments'], [], '', false);
        $this->mockReflectionService->method('getMethodParameters')->willReturn([]);
        $viewHelper->injectReflectionService($this->mockReflectionService);

        $viewHelper->expects($this->once())->method('initializeArguments');

        $viewHelper->prepareArguments();
    }

    public function prepareArgumentsRegistersAnnotationBasedArgumentsWithDescriptionIfDebugModeIsEnabled()
    {
        $dataCacheMock = $this->createMock(\TYPO3\CMS\Core\Cache\Frontend\VariableFrontend::class);
        $dataCacheMock->expects($this->any())->method('has')->will($this->returnValue(true));
        $dataCacheMock->expects($this->any())->method('get')->will($this->returnValue([]));

        $viewHelper = new \TYPO3\CMS\Fluid\Tests\Unit\Core\Fixtures\TestViewHelper();

        $this->mockReflectionService->expects($this->once())->method('getMethodParameters')->with(\TYPO3\CMS\Fluid\Tests\Unit\Core\Fixtures\TestViewHelper::class, 'render')->will($this->returnValue($this->fixtureMethodParameters));
        $this->mockReflectionService->expects($this->once())->method('getMethodTagsValues')->with(\TYPO3\CMS\Fluid\Tests\Unit\Core\Fixtures\TestViewHelper::class, 'render')->will($this->returnValue($this->fixtureMethodTags));
        $viewHelper->injectReflectionService($this->mockReflectionService);

        $expected = [
            'param1' => new \TYPO3\CMS\Fluid\Core\ViewHelper\ArgumentDefinition('param1', 'integer', 'P1 Stuff', true, null, true),
            'param2' => new \TYPO3\CMS\Fluid\Core\ViewHelper\ArgumentDefinition('param2', 'array', 'P2 Stuff', true, null, true),
            'param3' => new \TYPO3\CMS\Fluid\Core\ViewHelper\ArgumentDefinition('param3', 'string', 'P3 Stuff', false, 'default', true),
        ];

        $this->assertEquals($expected, $viewHelper->prepareArguments(), 'Annotation based arguments were not registered.');
    }

    public function validateArgumentsCallsPrepareArguments()
    {
        $viewHelper = $this->getAccessibleMock(\TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper::class, ['render', 'prepareArguments'], [], '', false);
        $viewHelper->injectReflectionService($this->mockReflectionService);

        $viewHelper->expects($this->once())->method('prepareArguments')->will($this->returnValue([]));

        $viewHelper->validateArguments();
    }

    public function validateArgumentsAcceptsAllObjectsImplemtingArrayAccessAsAnArray()
    {
        $viewHelper = $this->getAccessibleMock(\TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper::class, ['render', 'prepareArguments'], [], '', false);

        $viewHelper->setArguments(['test' => new \ArrayObject]);
        $viewHelper->expects($this->once())->method('prepareArguments')->will($this->returnValue(['test' => new \TYPO3\CMS\Fluid\Core\ViewHelper\ArgumentDefinition('test', 'array', false, 'documentation')]));
        $viewHelper->validateArguments();
    }

    public function validateArgumentsCallsTheRightValidators()
    {
        $viewHelper = $this->getAccessibleMock(\TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper::class, ['render', 'prepareArguments'], [], '', false);
        $viewHelper->injectReflectionService($this->mockReflectionService);

        $viewHelper->setArguments(['test' => 'Value of argument']);

        $viewHelper->expects($this->once())->method('prepareArguments')->will($this->returnValue([
            'test' => new \TYPO3\CMS\Fluid\Core\ViewHelper\ArgumentDefinition('test', 'string', false, 'documentation')
        ]));

        $viewHelper->validateArguments();
    }

    public function validateArgumentsCallsTheRightValidatorsAndThrowsExceptionIfValidationIsWrong()
    {
        $viewHelper = $this->getAccessibleMock(\TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper::class, ['render', 'prepareArguments'], [], '', false);
        $viewHelper->injectReflectionService($this->mockReflectionService);

        $this->expectException(\InvalidArgumentException::class);
        $this->expectExceptionCode(1256475113);

        $viewHelper->setArguments(['test' => 'test']);

        $viewHelper->expects($this->once())->method('prepareArguments')->will($this->returnValue([
            'test' => new \TYPO3\CMS\Fluid\Core\ViewHelper\ArgumentDefinition('test', 'stdClass', false, 'documentation')
        ]));

        $viewHelper->validateArguments();
    }

    public function initializeArgumentsAndRenderCallsTheCorrectSequenceOfMethods()
    {
        $viewHelper = $this->getAccessibleMock(\TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper::class, ['validateArguments', 'initialize', 'callRenderMethod']);
        $viewHelper->expects($this->at(0))->method('validateArguments');
        $viewHelper->expects($this->at(1))->method('initialize');
        $viewHelper->expects($this->at(2))->method('callRenderMethod')->will($this->returnValue('Output'));

        $expectedOutput = 'Output';
        $actualOutput = $viewHelper->initializeArgumentsAndRender(['argument1' => 'value1']);
        $this->assertEquals($expectedOutput, $actualOutput);
    }

    public function setRenderingContextShouldSetInnerVariables()
    {
        $templateVariableContainer = $this->createMock(StandardVariableProvider::class);
        $viewHelperVariableContainer = $this->createMock(ViewHelperVariableContainer::class);
        $controllerContext = $this->getMockBuilder(\TYPO3\CMS\Extbase\Mvc\Controller\ControllerContext::class)
            ->setMethods(['getRequest'])
            ->disableOriginalConstructor()
            ->getMock();
        $controllerContext->expects($this->atLeastOnce())->method('getRequest')->willReturn($this->createMock(Request::class));

        $renderingContext = $this->getAccessibleMock(RenderingContextFixture::class, ['getControllerContext']);
        $renderingContext->expects($this->any())->method('getControllerContext')->willReturn($controllerContext);
        $renderingContext->setVariableProvider($templateVariableContainer);
        $renderingContext->_set('viewHelperVariableContainer', $viewHelperVariableContainer);
        $renderingContext->setControllerContext($controllerContext);

        $viewHelper = $this->getAccessibleMock(\TYPO3\CMS\Fluid\Core\ViewHelper\AbstractViewHelper::class, ['render', 'prepareArguments'], [], '', false);

        $viewHelper->setRenderingContext($renderingContext);

        $this->assertSame($viewHelper->_get('templateVariableContainer'), $templateVariableContainer);
        $this->assertSame($viewHelper->_get('viewHelperVariableContainer'), $viewHelperVariableContainer);
        $this->assertSame($viewHelper->_get('controllerContext'), $controllerContext);
    }
}