DataProviderCollectionTest.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\Backend\Tests\Unit\View\BackendLayout;
 
use PHPUnit\Framework\Attributes\Test;
use ‪TYPO3\CMS\Backend\View\BackendLayout\BackendLayout;
use ‪TYPO3\CMS\Backend\View\BackendLayout\DataProviderCollection;
use ‪TYPO3\CMS\Backend\View\BackendLayout\DefaultDataProvider;
use ‪TYPO3\CMS\Core\Utility\StringUtility;
use TYPO3\TestingFramework\Core\Unit\UnitTestCase;
 
final class ‪DataProviderCollectionTest extends UnitTestCase
{
    protected ‪DataProviderCollection ‪$dataProviderCollection;
 
    protected function ‪setUp(): void
    {
        parent::setUp();
        $this->dataProviderCollection = new ‪DataProviderCollection();
    }
 
    #[Test]
    public function ‪invalidIdentifierIsRecognizedOnAdding(): void
    {
        $this->expectException(\UnexpectedValueException::class);
        $this->expectExceptionCode(1381597629);
        ‪$identifier = ‪StringUtility::getUniqueId('identifier__');
        $dataProviderMock = $this->getMockBuilder(\stdClass::class)->getMock();
 
        $this->dataProviderCollection->add(‪$identifier, get_class($dataProviderMock));
    }
 
    #[Test]
    public function ‪invalidInterfaceIsRecognizedOnAdding(): void
    {
        $this->expectException(\LogicException::class);
        $this->expectExceptionCode(1381269811);
        ‪$identifier = ‪StringUtility::getUniqueId('identifier');
        $dataProviderMock = $this->getMockBuilder(\stdClass::class)->getMock();
 
        $this->dataProviderCollection->add(‪$identifier, get_class($dataProviderMock));
    }
 
    #[Test]
    public function ‪defaultBackendLayoutIsFound(): void
    {
        $backendLayoutIdentifier = ‪StringUtility::getUniqueId('identifier');
 
        $dataProviderMock = $this->getMockBuilder(DefaultDataProvider::class)
            ->onlyMethods(['getBackendLayout'])
            ->disableOriginalConstructor()
            ->getMock();
        $backendLayoutMock = $this->getMockBuilder(BackendLayout::class)
            ->onlyMethods(['getIdentifier'])
            ->disableOriginalConstructor()
            ->getMock();
        $backendLayoutMock->method('getIdentifier')->willReturn($backendLayoutIdentifier);
        $dataProviderMock->expects(self::once())->method('getBackendLayout')->willReturn($backendLayoutMock);
 
        $this->dataProviderCollection->add('default', $dataProviderMock);
        $providedBackendLayout = $this->dataProviderCollection->getBackendLayout($backendLayoutIdentifier, 123);
 
        self::assertNotNull($providedBackendLayout);
        self::assertEquals($backendLayoutIdentifier, $providedBackendLayout->getIdentifier());
    }
 
    #[Test]
    public function ‪providedBackendLayoutIsFound(): void
    {
        $dataProviderIdentifier = ‪StringUtility::getUniqueId('custom');
        $backendLayoutIdentifier = ‪StringUtility::getUniqueId('identifier');
 
        $dataProviderMock = $this->getMockBuilder(DefaultDataProvider::class)
            ->onlyMethods(['getBackendLayout'])
            ->disableOriginalConstructor()
            ->getMock();
        $backendLayoutMock = $this->getMockBuilder(BackendLayout::class)
            ->onlyMethods(['getIdentifier'])
            ->disableOriginalConstructor()
            ->getMock();
        $backendLayoutMock->method('getIdentifier')->willReturn($backendLayoutIdentifier);
        $dataProviderMock->expects(self::once())->method('getBackendLayout')->willReturn($backendLayoutMock);
 
        $this->dataProviderCollection->add($dataProviderIdentifier, $dataProviderMock);
        $providedBackendLayout = $this->dataProviderCollection->getBackendLayout($dataProviderIdentifier . '__' . $backendLayoutIdentifier, 123);
 
        self::assertNotNull($providedBackendLayout);
        self::assertEquals($backendLayoutIdentifier, $providedBackendLayout->getIdentifier());
    }
}