FluidTemplateContentObjectTest.php

Go to the documentation of this file.

<?php
namespace TYPO3\CMS\Frontend\Tests\Unit\ContentObject;

/*
 * 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\Page\PageRenderer;
use TYPO3\CMS\Core\TypoScript\TypoScriptService;
use TYPO3\CMS\Core\Utility\GeneralUtility;
use TYPO3\CMS\Extbase\Mvc\Request;
use TYPO3\CMS\Fluid\View\StandaloneView;
use TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer;
use TYPO3\CMS\Frontend\ContentObject\FluidTemplateContentObject;
use TYPO3Fluid\Fluid\View\TemplateView;

class FluidTemplateContentObjectTest extends \TYPO3\TestingFramework\Core\Unit\UnitTestCase
{
    protected $singletonInstances = [];

    protected $subject = null;

    protected $contentObjectRenderer = null;

    protected $standaloneView = null;

    protected $request = null;

    protected function setUp()
    {
        $this->singletonInstances = GeneralUtility::getSingletonInstances();
        $this->contentObjectRenderer = $this->getMockBuilder(
            \TYPO3\CMS\Frontend\ContentObject\ContentObjectRenderer::class
        )->getMock();
        $this->subject = $this->getAccessibleMock(
            \TYPO3\CMS\Frontend\ContentObject\FluidTemplateContentObject::class,
            ['initializeStandaloneViewInstance'],
            [$this->contentObjectRenderer]
        );
        $tsfe = $this->createMock(\TYPO3\CMS\Frontend\Controller\TypoScriptFrontendController::class);
        $tsfe->tmpl = $this->getMockBuilder(\TYPO3\CMS\Core\TypoScript\TemplateService::class)->getMock();
        $GLOBALS['TSFE'] = $tsfe;
    }

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

    protected function addMockViewToSubject()
    {
        $this->standaloneView = $this->createMock(\TYPO3\CMS\Fluid\View\StandaloneView::class);
        $this->request = $this->getMockBuilder(\TYPO3\CMS\Extbase\Mvc\Request::class)->getMock();
        $this->standaloneView
            ->expects($this->any())
            ->method('getRequest')
            ->will($this->returnValue($this->request));
        $this->subject->_set('view', $this->standaloneView);
    }

    public function constructSetsContentObjectRenderer()
    {
        $this->assertSame($this->contentObjectRenderer, $this->subject->getContentObjectRenderer());
    }

    public function renderCallsInitializeStandaloneViewInstance()
    {
        $this->addMockViewToSubject();
        $this->subject
            ->expects($this->once())
            ->method('initializeStandaloneViewInstance');
        $this->subject->render([]);
    }

    public function renderCallsTemplateServiceGetFileNameForGivenTemplateFile()
    {
        $this->addMockViewToSubject();
        $templateService = $GLOBALS['TSFE']->tmpl;
        $templateService
            ->expects($this->any())
            ->method('getFileName')
            ->with('foo');
        $this->subject->render(['file' => 'foo']);
    }

    public function renderCallsStandardWrapForGivenTemplateFileWithStandardWrap()
    {
        $this->addMockViewToSubject();
        $this->contentObjectRenderer
            ->expects($this->any())
            ->method('stdWrap')
            ->with('foo', ['bar' => 'baz']);
        $this->subject->render(['file' => 'foo', 'file.' => ['bar' => 'baz']]);
    }

    public function renderCallsStandardWrapForGivenTemplateRootPathsWithStandardWrap()
    {
        $this->addMockViewToSubject();
        $this->contentObjectRenderer
            ->expects($this->at(0))
            ->method('stdWrap')
            ->with('dummyPath', ['wrap' => '|5/']);
        $this->contentObjectRenderer
            ->expects($this->at(1))
            ->method('stdWrap')
            ->with('', ['field' => 'someField']);
        $this->subject->render(
            [
                'templateName' => 'foobar',
                'templateRootPaths.' => [
                    10 => 'dummyPath',
                    '10.' => [
                        'wrap' => '|5/',
                    ],
                    15 => 'dummyPath6/',
                    '25.' => [
                        'field' => 'someField',
                    ],
                ]
            ]
        );
    }

    public function renderSetsTemplateFileInView()
    {
        $this->addMockViewToSubject();
        $templateService = $GLOBALS['TSFE']->tmpl;
        $templateService
            ->expects($this->any())
            ->method('getFileName')
            ->with('foo')
            ->will($this->returnValue('bar'));
        $this->standaloneView
            ->expects($this->any())
            ->method('setTemplatePathAndFilename')
            ->with(PATH_site . 'bar');
        $this->subject->render(['file' => 'foo']);
    }

    public function renderSetsTemplateFileByTemplateInView()
    {
        $this->addMockViewToSubject();

        $this->contentObjectRenderer
            ->expects($this->any())
            ->method('cObjGetSingle')
            ->with('FILE', ['file' => PATH_site . 'foo/bar.html'])
            ->will($this->returnValue('baz'));

        $this->standaloneView
            ->expects($this->any())
            ->method('setTemplateSource')
            ->with('baz');

        $this->subject->render([
            'template' => 'FILE',
            'template.' => [
                'file' => PATH_site . 'foo/bar.html'
            ]
        ]);
    }

    public function renderSetsTemplateFileByTemplateNameInView()
    {
        $this->addMockViewToSubject();

        $this->standaloneView
            ->expects($this->any())
            ->method('getFormat')
            ->will($this->returnValue('html'));
        $this->standaloneView
            ->expects($this->once())
            ->method('setTemplate')
            ->with('foo');

        $this->subject->render(
            [
            'templateName' => 'foo',
            'templateRootPaths.' => [
                0 => 'dummyPath1/',
                1 => 'dummyPath2/']
            ]
        );
    }

    public function renderSetsTemplateFileByTemplateNameStdWrapInView()
    {
        $this->addMockViewToSubject();

        $this->contentObjectRenderer
            ->expects($this->once())
            ->method('stdWrap')
            ->with('TEXT', ['value' => 'bar'])
            ->will($this->returnValue('bar'));
        $this->standaloneView
            ->expects($this->any())
            ->method('getFormat')
            ->will($this->returnValue('html'));
        $this->standaloneView
            ->expects($this->once())
            ->method('setTemplate')
            ->with('bar');

        $this->subject->render(
            [
            'templateName' => 'TEXT',
            'templateName.' => ['value' => 'bar'],
            'templateRootPaths.' => [
                0 => 'dummyPath1/',
                1 => 'dummyPath2/']
            ]
        );
    }

    public function renderSetsLayoutRootPathInView()
    {
        $this->addMockViewToSubject();
        $this->standaloneView
            ->expects($this->once())
            ->method('setLayoutRootPaths')
            ->with([PATH_site . 'foo/bar.html']);
        $this->subject->render(['layoutRootPath' => 'foo/bar.html']);
    }

    public function renderCallsStandardWrapForLayoutRootPath()
    {
        $this->addMockViewToSubject();
        $this->contentObjectRenderer
            ->expects($this->once())
            ->method('stdWrap')
            ->with('foo', ['bar' => 'baz']);
        $this->subject->render(['layoutRootPath' => 'foo', 'layoutRootPath.' => ['bar' => 'baz']]);
    }

    public function layoutRootPathsHasStdWrapSupport()
    {
        $this->addMockViewToSubject();
        $this->contentObjectRenderer
            ->expects($this->at(0))
            ->method('stdWrap')
            ->with('FILE', ['file' => 'foo/bar.html']);
        $this->subject->render(
            [
                'layoutRootPaths.' => [
                    10 => 'FILE',
                    '10.' => [
                        'file' => 'foo/bar.html',
                    ],
                    20 => 'foo/bar2.html',
                ]
            ]
        );
    }

    public function fallbacksForLayoutRootPathAreSet()
    {
        $this->addMockViewToSubject();
        $this->standaloneView
            ->expects($this->once())
            ->method('setLayoutRootPaths')
            ->with([10 => PATH_site . 'foo/bar.html', 20 => PATH_site . 'foo/bar2.html']);
        $this->subject->render(['layoutRootPaths.' => [10 => 'foo/bar.html', 20 => 'foo/bar2.html']]);
    }

    public function fallbacksForLayoutRootPathAreAppendedToLayoutRootPath()
    {
        $this->addMockViewToSubject();
        $this->standaloneView
            ->expects($this->once())
            ->method('setLayoutRootPaths')
            ->with([0 => PATH_site . 'foo/main.html', 10 => PATH_site . 'foo/bar.html', 20 => PATH_site . 'foo/bar2.html']);
        $this->subject->render(['layoutRootPath' => 'foo/main.html', 'layoutRootPaths.' => [10 => 'foo/bar.html', 20 => 'foo/bar2.html']]);
    }

    public function renderSetsPartialRootPathInView()
    {
        $this->addMockViewToSubject();
        $this->standaloneView
            ->expects($this->once())
            ->method('setPartialRootPaths')
            ->with([PATH_site . 'foo/bar.html']);
        $this->subject->render(['partialRootPath' => 'foo/bar.html']);
    }

    public function partialRootPathsHasStdWrapSupport()
    {
        $this->addMockViewToSubject();
        $this->contentObjectRenderer
            ->expects($this->at(0))
            ->method('stdWrap')
            ->with('FILE', ['file' => 'foo/bar.html']);
        $this->subject->render(
            [
                'partialRootPaths.' => [
                    10 => 'FILE',
                    '10.' => [
                        'file' => 'foo/bar.html',
                    ],
                    20 => 'foo/bar2.html',
                ]
            ]
        );
    }

    public function renderCallsStandardWrapForPartialRootPath()
    {
        $this->addMockViewToSubject();
        $this->contentObjectRenderer
            ->expects($this->once())
            ->method('stdWrap')
            ->with('foo', ['bar' => 'baz']);
        $this->subject->render(['partialRootPath' => 'foo', 'partialRootPath.' => ['bar' => 'baz']]);
    }

    public function fallbacksForPartialRootPathAreSet()
    {
        $this->addMockViewToSubject();
        $this->standaloneView
            ->expects($this->once())
            ->method('setPartialRootPaths')
            ->with([10 => PATH_site . 'foo', 20 => PATH_site . 'bar']);
        $this->subject->render(['partialRootPaths.' => [10 => 'foo', 20 => 'bar']]);
    }

    public function fallbacksForPartialRootPathAreAppendedToPartialRootPath()
    {
        $this->addMockViewToSubject();
        $this->standaloneView
            ->expects($this->once())
            ->method('setPartialRootPaths')
            ->with([0 => PATH_site . 'main', 10 => PATH_site . 'foo', 20 => PATH_site . 'bar']);
        $this->subject->render(['partialRootPath' => 'main', 'partialRootPaths.' => [10 => 'foo', 20 => 'bar']]);
    }

    public function renderSetsFormatInView()
    {
        $this->addMockViewToSubject();
        $this->standaloneView
            ->expects($this->once())
            ->method('setFormat')
            ->with('xml');
        $this->subject->render(['format' => 'xml']);
    }

    public function renderCallsStandardWrapForFormat()
    {
        $this->addMockViewToSubject();
        $this->contentObjectRenderer
            ->expects($this->once())
            ->method('stdWrap')
            ->with('foo', ['bar' => 'baz']);
        $this->subject->render(['format' => 'foo', 'format.' => ['bar' => 'baz']]);
    }

    public function renderSetsExtbasePluginNameInRequest()
    {
        $this->addMockViewToSubject();
        $this->request
            ->expects($this->once())
            ->method('setPluginName')
            ->with('foo');
        $configuration = [
            'extbase.' => [
                'pluginName' => 'foo',
            ],
        ];
        $this->subject->render($configuration);
    }

    public function renderCallsStandardWrapForExtbasePluginName()
    {
        $this->addMockViewToSubject();
        $this->contentObjectRenderer
            ->expects($this->once())
            ->method('stdWrap')
            ->with('foo', ['bar' => 'baz']);
        $configuration = [
            'extbase.' => [
                'pluginName' => 'foo',
                'pluginName.' => [
                    'bar' => 'baz',
                ],
            ],
        ];
        $this->subject->render($configuration);
    }

    public function renderSetsExtbaseControllerExtensionNameInRequest()
    {
        $this->addMockViewToSubject();
        $this->request
            ->expects($this->once())
            ->method('setControllerExtensionName')
            ->with('foo');
        $configuration = [
            'extbase.' => [
                'controllerExtensionName' => 'foo',
            ],
        ];
        $this->subject->render($configuration);
    }

    public function renderCallsStandardWrapForExtbaseControllerExtensionName()
    {
        $this->addMockViewToSubject();
        $this->contentObjectRenderer
            ->expects($this->once())
            ->method('stdWrap')
            ->with('foo', ['bar' => 'baz']);
        $configuration = [
            'extbase.' => [
                'controllerExtensionName' => 'foo',
                'controllerExtensionName.' => [
                    'bar' => 'baz',
                ],
            ],
        ];
        $this->subject->render($configuration);
    }

    public function renderSetsExtbaseControllerNameInRequest()
    {
        $this->addMockViewToSubject();
        $this->request
            ->expects($this->once())
            ->method('setControllerName')
            ->with('foo');
        $configuration = [
            'extbase.' => [
                'controllerName' => 'foo',
            ],
        ];
        $this->subject->render($configuration);
    }

    public function renderCallsStandardWrapForExtbaseControllerName()
    {
        $this->addMockViewToSubject();
        $this->contentObjectRenderer
            ->expects($this->once())
            ->method('stdWrap')
            ->with('foo', ['bar' => 'baz']);
        $configuration = [
            'extbase.' => [
                'controllerName' => 'foo',
                'controllerName.' => [
                    'bar' => 'baz',
                ],
            ],
        ];
        $this->subject->render($configuration);
    }

    public function renderSetsExtbaseControllerActionNameInRequest()
    {
        $this->addMockViewToSubject();
        $this->request
            ->expects($this->once())
            ->method('setControllerActionName')
            ->with('foo');
        $configuration = [
            'extbase.' => [
                'controllerActionName' => 'foo',
            ],
        ];
        $this->subject->render($configuration);
    }

    public function renderCallsStandardWrapForExtbaseControllerActionName()
    {
        $this->addMockViewToSubject();
        $this->contentObjectRenderer
            ->expects($this->once())
            ->method('stdWrap')
            ->with('foo', ['bar' => 'baz']);
        $configuration = [
            'extbase.' => [
                'controllerActionName' => 'foo',
                'controllerActionName.' => [
                    'bar' => 'baz',
                ],
            ],
        ];
        $this->subject->render($configuration);
    }

    public function renderAssignsSettingsArrayToView()
    {
        $this->addMockViewToSubject();

        $configuration = [
            'settings.' => [
                'foo' => 'value',
                'bar.' => [
                    'baz' => 'value2',
                ],
            ],
        ];

        $expectedSettingsToBeSet = [
            'foo' => 'value',
            'bar' => [
                'baz' => 'value2',
            ],
        ];

        $typoScriptServiceMock = $this->getMockBuilder(TypoScriptService::class)->getMock();
        $typoScriptServiceMock
            ->expects($this->once())
            ->method('convertTypoScriptArrayToPlainArray')
            ->with($configuration['settings.'])
            ->will($this->returnValue($expectedSettingsToBeSet));
        GeneralUtility::addInstance(TypoScriptService::class, $typoScriptServiceMock);

        $this->standaloneView
            ->expects($this->at(1))
            ->method('assign')
            ->with('settings', $expectedSettingsToBeSet);

        $this->subject->render($configuration);
    }

    public function renderThrowsExceptionForNotAllowedVariableData()
    {
        $this->addMockViewToSubject();
        $configuration = [
            'variables.' => [
                'data' => 'foo',
                'data.' => [
                    'bar' => 'baz',
                ],
            ],
        ];
        $this->expectException(\InvalidArgumentException::class);
        $this->expectExceptionCode(1288095720);
        $this->subject->render($configuration);
    }

    public function renderThrowsExceptionForNotAllowedVariableCurrent()
    {
        $this->addMockViewToSubject();
        $configuration = [
            'variables.' => [
                'current' => 'foo',
                'current.' => [
                    'bar' => 'baz',
                ],
            ],
        ];
        $this->expectException(\InvalidArgumentException::class);
        $this->expectExceptionCode(1288095720);
        $this->subject->render($configuration);
    }

    public function renderCallsCObjGetSingleForAllowedVariable()
    {
        $this->addMockViewToSubject();
        $configuration = [
            'variables.' => [
                'aVar' => 'TEXT',
                'aVar.' => [
                    'value' => 'foo',
                ],
            ],
        ];
        $this->contentObjectRenderer
            ->expects($this->once())
            ->method('cObjGetSingle')
            ->with('TEXT', ['value' => 'foo']);
        $this->subject->render($configuration);
    }

    public function renderAssignsRenderedContentObjectVariableToView()
    {
        $this->addMockViewToSubject();
        $configuration = [
            'variables.' => [
                'aVar' => 'TEXT',
                'aVar.' => [
                    'value' => 'foo',
                ],
            ],
        ];
        $this->contentObjectRenderer
            ->expects($this->once())
            ->method('cObjGetSingle')
            ->will($this->returnValue('foo'));
        $this->standaloneView
            ->expects($this->once())
            ->method('assignMultiple')
            ->with(['aVar' => 'foo', 'data' => [], 'current' => null]);
        $this->subject->render($configuration);
    }

    public function renderAssignsContentObjectRendererDataToView()
    {
        $this->addMockViewToSubject();
        $this->contentObjectRenderer->data = ['foo'];
        $this->standaloneView
            ->expects($this->once())
            ->method('assignMultiple')
            ->with(['data' => ['foo'], 'current' => null]);
        $this->subject->render([]);
    }

    public function renderAssignsContentObjectRendererCurrentValueToView()
    {
        $this->addMockViewToSubject();
        $this->contentObjectRenderer->data = ['currentKey' => 'currentValue'];
        $this->contentObjectRenderer->currentValKey = 'currentKey';
        $this->standaloneView
            ->expects($this->once())
            ->method('assignMultiple')
            ->with(['data' => ['currentKey' => 'currentValue'], 'current' => 'currentValue']);
        $this->subject->render([]);
    }

    public function renderCallsRenderOnStandaloneViewie()
    {
        $this->addMockViewToSubject();
        $this->standaloneView
            ->expects($this->once())
            ->method('render');
        $this->subject->render([]);
    }

    public function renderCallsStandardWrapOnResultStringIfGivenInConfiguration()
    {
        $this->addMockViewToSubject();
        $configuration = [
            'stdWrap.' => [
                'foo' => 'bar',
            ],
        ];
        $this->standaloneView
            ->expects($this->any())
            ->method('render')
            ->will($this->returnValue('baz'));
        $this->contentObjectRenderer
            ->expects($this->once())
            ->method('stdWrap')
            ->with('baz', ['foo' => 'bar']);
        $this->subject->render($configuration);
    }

    public function renderFluidTemplateAssetsIntoPageRendererRendersAndAttachesAssets($viewMock, $expectedHeader, $expectedFooter)
    {
        $pageRendererMock = $this->getMockBuilder(PageRenderer::class)->setMethods(['addHeaderData', 'addFooterData'])->getMock();
        if (!empty(trim($expectedHeader))) {
            $pageRendererMock->expects($this->once())->method('addHeaderData')->with($expectedHeader);
        } else {
            $pageRendererMock->expects($this->never())->method('addHeaderData');
        }
        if (!empty(trim($expectedFooter))) {
            $pageRendererMock->expects($this->once())->method('addFooterData')->with($expectedFooter);
        } else {
            $pageRendererMock->expects($this->never())->method('addFooterData');
        }
        $subject = $this->getMockBuilder(FluidTemplateContentObject::class)->setMethods(['getPageRenderer'])->disableOriginalConstructor()->getMock();
        $subject->expects($this->once())->method('getPageRenderer')->willReturn($pageRendererMock);
        $viewProperty = new \ReflectionProperty($subject, 'view');
        $viewProperty->setAccessible(true);
        $viewProperty->setValue($subject, $viewMock);

        $method = new \ReflectionMethod($subject, 'renderFluidTemplateAssetsIntoPageRenderer');
        $method->setAccessible(true);
        $method->invoke($subject);
    }

    public function headerAssetDataProvider()
    {
        $viewWithHeaderData = $this->getMockBuilder(TemplateView::class)->setMethods(['renderSection'])->disableOriginalConstructor()->getMock();
        $viewWithHeaderData->expects($this->at(0))->method('renderSection')->with('HeaderAssets', $this->anything(), true)->willReturn('custom-header-data');
        $viewWithHeaderData->expects($this->at(1))->method('renderSection')->with('FooterAssets', $this->anything(), true)->willReturn(null);
        $viewWithFooterData = $this->getMockBuilder(TemplateView::class)->setMethods(['renderSection'])->disableOriginalConstructor()->getMock();
        $viewWithFooterData->expects($this->at(0))->method('renderSection')->with('HeaderAssets', $this->anything(), true)->willReturn(null);
        $viewWithFooterData->expects($this->at(1))->method('renderSection')->with('FooterAssets', $this->anything(), true)->willReturn('custom-footer-data');
        $viewWithBothData = $this->getMockBuilder(TemplateView::class)->setMethods(['renderSection'])->disableOriginalConstructor()->getMock();
        $viewWithBothData->expects($this->at(0))->method('renderSection')->with('HeaderAssets', $this->anything(), true)->willReturn('custom-header-data');
        $viewWithBothData->expects($this->at(1))->method('renderSection')->with('FooterAssets', $this->anything(), true)->willReturn('custom-footer-data');
        return [
            [$viewWithHeaderData, 'custom-header-data', null],
            [$viewWithFooterData, null, 'custom-footer-data'],
            [$viewWithBothData, 'custom-header-data', 'custom-footer-data']
        ];
    }
}