ResultTest.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\Extbase\Tests\Unit\Error;
 
use PHPUnit\Framework\MockObject\MockObject;
use ‪TYPO3\CMS\Extbase\Error\Result;
use TYPO3\TestingFramework\Core\Unit\UnitTestCase;
 
class ‪ResultTest extends UnitTestCase
{
    protected ‪Result ‪$result;
 
    protected function ‪setUp(): void
    {
        parent::setUp();
        $this->result = new ‪Result();
    }
 
    public function ‪dataTypes(): array
    {
        return [
            ['Error', 'Errors'],
            ['Warning', 'Warnings'],
            ['Notice', 'Notices'],
        ];
    }
 
    protected function ‪getMockMessage(string $type): MockObject
    {
        return $this->createMock('TYPO3\\CMS\\Extbase\\Error\\' . $type);
    }
 
    public function ‪addedMessagesShouldBeRetrievableAgain(string $dataTypeInSingular, string $dataTypeInPlural): void
    {
        $message = $this->‪getMockMessage($dataTypeInSingular);
        $addMethodName = 'add' . $dataTypeInSingular;
        $this->result->{$addMethodName}($message);
        $getterMethodName = 'get' . $dataTypeInPlural;
        self::assertEquals([$message], $this->result->{$getterMethodName}());
    }
 
    public function ‪getMessageShouldNotBeRecursive(string $dataTypeInSingular, string $dataTypeInPlural): void
    {
        $message = $this->getMockMessage($dataTypeInSingular);
        $addMethodName = 'add' . $dataTypeInSingular;
        $this->result->forProperty('foo')->{$addMethodName}($message);
        $getterMethodName = 'get' . $dataTypeInPlural;
        self::assertEquals([], $this->result->{$getterMethodName}());
    }
 
    public function ‪getFirstMessageShouldReturnFirstMessage(string $dataTypeInSingular, string $dataTypeInPlural): void
    {
        $message1 = $this->getMockMessage($dataTypeInSingular);
        $message2 = $this->getMockMessage($dataTypeInSingular);
        $addMethodName = 'add' . $dataTypeInSingular;
        $this->result->{$addMethodName}($message1);
        $this->result->{$addMethodName}($message2);
        $getterMethodName = 'getFirst' . $dataTypeInSingular;
        self::assertSame($message1, $this->result->{$getterMethodName}());
    }
 
    public function ‪forPropertyShouldReturnSubResult(): void
    {
        $container2 = $this->result->forProperty('foo.bar');
        self::assertInstanceOf(Result::class, $container2);
        self::assertSame($container2, $this->result->forProperty('foo')->forProperty('bar'));
    }
 
    public function ‪forPropertyWithEmptyStringShouldReturnSelf(): void
    {
        $container2 = $this->result->forProperty('');
        self::assertSame($container2, $this->result);
    }
 
    public function ‪forPropertyWithNullShouldReturnSelf(): void
    {
        $container2 = $this->result->forProperty(null);
        self::assertSame($container2, $this->result);
    }
 
    public function ‪hasMessagesShouldReturnTrueIfTopLevelObjectHasMessages(string $dataTypeInSingular, string $dataTypeInPlural): void
    {
        $message = $this->getMockMessage($dataTypeInSingular);
        $addMethodName = 'add' . $dataTypeInSingular;
        $this->result->{$addMethodName}($message);
        $methodName = 'has' . $dataTypeInPlural;
        self::assertTrue($this->result->{$methodName}());
    }
 
    public function ‪hasMessagesShouldReturnTrueIfSubObjectHasErrors(string $dataTypeInSingular, string $dataTypeInPlural): void
    {
        $addMethodName = 'add' . $dataTypeInSingular;
        $methodName = 'has' . $dataTypeInPlural;
        $message = $this->getMockMessage($dataTypeInSingular);
        $this->result->forProperty('foo.bar')->{$addMethodName}($message);
        self::assertTrue($this->result->{$methodName}());
    }
 
    public function ‪hasMessagesShouldReturnFalseIfSubObjectHasNoErrors(string $dataTypeInSingular, string $dataTypeInPlural): void
    {
        $methodName = 'has' . $dataTypeInPlural;
        $this->result->forProperty('foo.baz');
        $this->result->forProperty('foo.bar');
        self::assertFalse($this->result->{$methodName}());
    }
 
    public function ‪getFlattenedMessagesShouldReturnAllSubMessages(string $dataTypeInSingular, string $dataTypeInPlural): void
    {
        $message1 = $this->getMockMessage($dataTypeInSingular);
        $message2 = $this->getMockMessage($dataTypeInSingular);
        $message3 = $this->getMockMessage($dataTypeInSingular);
        $message4 = $this->getMockMessage($dataTypeInSingular);
        $message5 = $this->getMockMessage($dataTypeInSingular);
        $addMethodName = 'add' . $dataTypeInSingular;
        $this->result->forProperty('foo.bar')->{$addMethodName}($message1);
        $this->result->forProperty('foo.baz')->{$addMethodName}($message2);
        $this->result->forProperty('foo')->{$addMethodName}($message3);
        $this->result->{$addMethodName}($message4);
        $this->result->{$addMethodName}($message5);
        $getMethodName = 'getFlattened' . $dataTypeInPlural;
        $expected = [
            '' => [$message4, $message5],
            'foo' => [$message3],
            'foo.bar' => [$message1],
            'foo.baz' => [$message2],
        ];
        self::assertEquals($expected, $this->result->{$getMethodName}());
    }
 
    public function ‪getFlattenedMessagesShouldNotContainEmptyResults(string $dataTypeInSingular, string $dataTypeInPlural): void
    {
        $message1 = $this->getMockMessage($dataTypeInSingular);
        $message2 = $this->getMockMessage($dataTypeInSingular);
        $addMethodName = 'add' . $dataTypeInSingular;
        $this->result->forProperty('foo.bar')->{$addMethodName}($message1);
        $this->result->forProperty('foo.baz')->{$addMethodName}($message2);
        $getMethodName = 'getFlattened' . $dataTypeInPlural;
        $expected = [
            'foo.bar' => [$message1],
            'foo.baz' => [$message2],
        ];
        self::assertEquals($expected, $this->result->{$getMethodName}());
    }
 
    public function ‪mergeShouldMergeTwoResults(): void
    {
        $notice1 = $this->getMockMessage('Notice');
        $notice2 = $this->getMockMessage('Notice');
        $notice3 = $this->getMockMessage('Notice');
        $warning1 = $this->getMockMessage('Warning');
        $warning2 = $this->getMockMessage('Warning');
        $warning3 = $this->getMockMessage('Warning');
        $error1 = $this->getMockMessage('Error');
        $error2 = $this->getMockMessage('Error');
        $error3 = $this->getMockMessage('Error');
        $otherResult = new ‪Result();
        $otherResult->addNotice($notice1);
        $otherResult->forProperty('foo.bar')->addNotice($notice2);
        $this->result->forProperty('foo')->addNotice($notice3);
        $otherResult->addWarning($warning1);
        $this->result->addWarning($warning2);
        $this->result->addWarning($warning3);
        $otherResult->forProperty('foo')->addError($error1);
        $otherResult->forProperty('foo')->addError($error2);
        $otherResult->addError($error3);
        $this->result->merge($otherResult);
        self::assertSame([$notice1], $this->result->getNotices(), 'Notices are not merged correctly without recursion');
        self::assertSame([$notice3], $this->result->forProperty('foo')->getNotices(), 'Original sub-notices are overridden.');
        self::assertSame([$notice2], $this->result->forProperty('foo')->forProperty('bar')->getNotices(), 'Sub-notices are not copied.');
        self::assertSame([$warning2, $warning3, $warning1], $this->result->getWarnings());
        self::assertSame([$error3], $this->result->getErrors());
        self::assertSame([$error1, $error2], $this->result->forProperty('foo')->getErrors());
    }
 
    public function ‪getFirstReturnsFalseOnEmptyResult(): void
    {
        $subject = new ‪Result();
        self::assertFalse($subject->getFirstError());
        self::assertFalse($subject->getFirstNotice());
        self::assertFalse($subject->getFirstWarning());
    }
}