AspectFactoryTest.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\Core\Tests\Unit\Routing\Aspect;
 
use Prophecy\PhpUnit\ProphecyTrait;
use Prophecy\Prophecy\ObjectProphecy;
use ‪TYPO3\CMS\Core\Context\Context;
use ‪TYPO3\CMS\Core\Routing\Aspect\AspectFactory;
use ‪TYPO3\CMS\Core\Routing\Aspect\AspectInterface;
use ‪TYPO3\CMS\Core\Routing\Aspect\PersistedMappableAspectInterface;
use ‪TYPO3\CMS\Core\Site\Entity\Site;
use ‪TYPO3\CMS\Core\Site\Entity\SiteLanguage;
use TYPO3\TestingFramework\Core\Unit\UnitTestCase;
 
class ‪AspectFactoryTest extends UnitTestCase
{
    use ProphecyTrait;
 
    protected ?‪AspectFactory ‪$subject;
 
    protected ObjectProphecy ‪$languageProphecy;
 
    protected ObjectProphecy ‪$siteProphecy;
 
    protected ?string ‪$persistedMockClass;
    protected ?string ‪$aspectMockClass;
 
    protected function ‪setUp(): void
    {
        parent::setUp();
        $this->languageProphecy = $this->prophesize(
            SiteLanguage::class
        );
        $this->siteProphecy = $this->prophesize(
            Site::class
        );
        $this->persistedMockClass = get_class($this->createMock(
            PersistedMappableAspectInterface::class
        ));
        $this->aspectMockClass = get_class($this->createMock(
            AspectInterface::class
        ));
        ‪$GLOBALS['TYPO3_CONF_VARS']['SYS']['routing']['aspects'] = [
            'Persisted' => ‪$this->persistedMockClass,
            'Aspect' => ‪$this->aspectMockClass,
        ];
        $contextMock = $this->getMockBuilder(Context::class)
            ->disableOriginalConstructor()
            ->getMock();
        $this->subject = new ‪AspectFactory($contextMock);
    }
 
    protected function ‪tearDown(): void
    {
        unset($this->subject, $this->languageProphecy, $this->persistedMockClass, $this->aspectMockClass);
        parent::tearDown();
    }
 
    public function ‪createAspectsThrowsExceptionOnMissingType(): void
    {
        $this->expectException(\InvalidArgumentException::class);
        $this->expectExceptionCode(1538079481);
        $this->subject->createAspects(
            ['a' => []],
            $this->languageProphecy->reveal(),
            $this->siteProphecy->reveal()
        );
    }
 
    public function ‪createAspectsThrowsExceptionOnUnregisteredType(): void
    {
        $this->expectException(\OutOfRangeException::class);
        $this->expectExceptionCode(1538079482);
        $this->subject->createAspects(
            ['a' => ['type' => 'Undefined']],
            $this->languageProphecy->reveal(),
            $this->siteProphecy->reveal()
        );
    }
 
    public function ‪aspectsDataProvider(): array
    {
        return [
            'single aspect' => [
                [
                    'a' => ['type' => 'Aspect'],
                ],
                [
                    'a' => AspectInterface::class,
                ],
            ],
            'both non-persisted' => [
                [
                    'a' => ['type' => 'Aspect'],
                    'b' => ['type' => 'Aspect'],
                ],
                [
                    'a' => AspectInterface::class,
                    'b' => AspectInterface::class,
                ],
            ],
            'both persisted' => [
                [
                    'a' => ['type' => 'Persisted'],
                    'b' => ['type' => 'Persisted'],
                ],
                [
                    'a' => PersistedMappableAspectInterface::class,
                    'b' => PersistedMappableAspectInterface::class,
                ],
            ],
            // persisted shall be sorted to the end
            'first persisted, second non-persisted' => [
                [
                    'a' => ['type' => 'Persisted'],
                    'b' => ['type' => 'Aspect'],
                ],
                [
                    'b' => AspectInterface::class,
                    'a' => PersistedMappableAspectInterface::class,
                ],
            ],
            // persisted shall be sorted to the end
            'many persisted, many non-persisted' => [
                [
                    'a' => ['type' => 'Persisted'],
                    'b' => ['type' => 'Aspect'],
                    'c' => ['type' => 'Persisted'],
                    'd' => ['type' => 'Aspect'],
                ],
                [
                    'b' => AspectInterface::class,
                    'd' => AspectInterface::class,
                    'a' => PersistedMappableAspectInterface::class,
                    'c' => PersistedMappableAspectInterface::class,
                ],
            ],
        ];
    }
 
    public function ‪aspectsAreCreatedAndSorted(array $settings, array $expectation): void
    {
        $aspects = $this->subject->createAspects(
            $settings,
            $this->languageProphecy->reveal(),
            $this->siteProphecy->reveal()
        );
        self::assertSame(array_keys($aspects), array_keys($expectation));
        array_walk($aspects, static function ($aspect, $key) use ($expectation) {
            static::assertInstanceOf($expectation[$key], $aspect);
        });
    }
}