GenericObjectValidatorTest.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\Validation\Validator;
 
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\Attributes\Test;
use ‪TYPO3\CMS\Extbase\Error\Error;
use ‪TYPO3\CMS\Extbase\Error\Result;
use ‪TYPO3\CMS\Extbase\Validation\Validator\GenericObjectValidator;
use ‪TYPO3\CMS\Extbase\Validation\Validator\ValidatorInterface;
use TYPO3\TestingFramework\Core\Unit\UnitTestCase;
 
final class ‪GenericObjectValidatorTest extends UnitTestCase
{
    #[Test]
    public function ‪validatorShouldReturnErrorsIfTheValueIsNoObjectAndNotNull(): void
    {
        self::assertTrue((new ‪GenericObjectValidator())->validate('foo')->hasErrors());
    }
 
    #[Test]
    public function ‪validatorShouldReturnNoErrorsIfTheValueIsNull(): void
    {
        self::assertFalse((new ‪GenericObjectValidator())->validate(null)->hasErrors());
    }
 
    public static function ‪dataProviderForValidator(): array
    {
        $error1 = new ‪Error('error1', 1);
        $error2 = new ‪Error('error2', 2);
        $emptyResult1 = new ‪Result();
        $emptyResult2 = new ‪Result();
        $resultWithError1 = new ‪Result();
        $resultWithError1->addError($error1);
        $resultWithError2 = new ‪Result();
        $resultWithError2->addError($error2);
        $objectWithPrivateProperties = new class () {
            protected $foo = 'foovalue';
            protected $bar = 'barvalue';
 
            public function getFoo(): string
            {
                return $this->foo;
            }
 
            public function getBar(): string
            {
                return $this->bar;
            }
        };
 
        return [
            // If no errors happened, this is shown
            [$objectWithPrivateProperties, $emptyResult1, $emptyResult2, []],
            // If errors on two properties happened, they are merged together.
            [$objectWithPrivateProperties, $resultWithError1, $resultWithError2, ['foo' => [$error1], 'bar' => [$error2]]],
        ];
    }
 
    #[DataProvider('dataProviderForValidator')]
    #[Test]
    public function ‪validateChecksAllPropertiesForWhichAPropertyValidatorExists($objectToBeValidated, $validationResultForFoo, $validationResultForBar, ‪$errors): void
    {
        ‪$validator = new ‪GenericObjectValidator();
 
        $validatorForFoo = $this->getMockBuilder(ValidatorInterface::class)
            ->onlyMethods(['validate', 'getOptions', 'setOptions'])
            ->getMock();
        $validatorForFoo->expects(self::once())->method('validate')->with('foovalue')->willReturn($validationResultForFoo);
 
        $validatorForBar = $this->getMockBuilder(ValidatorInterface::class)
            ->onlyMethods(['validate', 'getOptions', 'setOptions'])
            ->getMock();
        $validatorForBar->expects(self::once())->method('validate')->with('barvalue')->willReturn($validationResultForBar);
 
        ‪$validator->addPropertyValidator('foo', $validatorForFoo);
        ‪$validator->addPropertyValidator('bar', $validatorForBar);
 
        self::assertEquals(‪$errors, ‪$validator->validate($objectToBeValidated)->getFlattenedErrors());
    }
 
    #[Test]
    public function ‪validateCanHandleRecursiveTargetsWithoutEndlessLooping(): void
    {
        $A = new class () {
            public $b;
        };
 
        $B = new class () {
            public $a;
        };
 
        $A->b = $B;
        $B->a = $A;
 
        $aValidator = new ‪GenericObjectValidator();
        $bValidator = new ‪GenericObjectValidator();
 
        $aValidator->addPropertyValidator('b', $bValidator);
        $bValidator->addPropertyValidator('a', $aValidator);
 
        self::assertFalse($aValidator->validate($A)->hasErrors());
    }
 
    #[Test]
    public function ‪validateDetectsFailuresInRecursiveTargetsI(): void
    {
        $A = new class () {
            public $b;
        };
 
        $B = new class () {
            public $a;
            public $uuid = 0xF;
        };
 
        $A->b = $B;
        $B->a = $A;
        $aValidator = new ‪GenericObjectValidator();
        $bValidator = new ‪GenericObjectValidator();
 
        $aValidator->addPropertyValidator('b', $bValidator);
        $bValidator->addPropertyValidator('a', $aValidator);
        $error = new ‪Error('error1', 123);
        $result = new ‪Result();
        $result->addError($error);
 
        $mockUuidValidator = $this->getMockBuilder(ValidatorInterface::class)
            ->onlyMethods(['validate', 'getOptions', 'setOptions'])
            ->getMock();
        $mockUuidValidator->method('validate')->with(15)->willReturn($result);
        $bValidator->addPropertyValidator('uuid', $mockUuidValidator);
 
        self::assertSame(['b.uuid' => [$error]], $aValidator->validate($A)->getFlattenedErrors());
    }
 
    #[Test]
    public function ‪validateDetectsFailuresInRecursiveTargetsII(): void
    {
        $A = new class () {
            public $b;
            public $uuid = 0xF;
        };
 
        $B = new class () {
            public $a;
            public $uuid = 0xF;
        };
 
        $A->b = $B;
        $B->a = $A;
        $aValidator = new ‪GenericObjectValidator();
        $bValidator = new ‪GenericObjectValidator();
 
        $aValidator->addPropertyValidator('b', $bValidator);
        $bValidator->addPropertyValidator('a', $aValidator);
        $error1 = new ‪Error('error1', 123);
        $result1 = new ‪Result();
        $result1->addError($error1);
 
        $mockUuidValidator = $this->getMockBuilder(ValidatorInterface::class)
            ->onlyMethods(['validate', 'getOptions', 'setOptions'])
            ->getMock();
        $mockUuidValidator->method('validate')->with(15)->willReturn($result1);
        $aValidator->addPropertyValidator('uuid', $mockUuidValidator);
        $bValidator->addPropertyValidator('uuid', $mockUuidValidator);
 
        self::assertSame(['b.uuid' => [$error1], 'uuid' => [$error1]], $aValidator->validate($A)->getFlattenedErrors());
    }
 
    #[Test]
    public function ‪validateDetectsFailuresInRecursiveTargetsIII(): void
    {
        // Create to test-entities. Use the same uuid to make the same validator trigger on both objects
        $A = new class () {
            public $b;
            public $uuid = 0xF;
        };
 
        $B = new class () {
            public $a;
            public $uuid = 0xF;
        };
 
        $A->b = $B;
        $B->a = $A;
        $aValidator = new ‪GenericObjectValidator();
        $bValidator = new ‪GenericObjectValidator();
 
        $error1 = new ‪Error('error1', 123);
        $result1 = new ‪Result();
        $result1->addError($error1);
 
        $mockValidatorUuidNot0xF = $this->getMockBuilder(ValidatorInterface::class)
            ->onlyMethods(['validate', 'getOptions', 'setOptions'])
            ->getMock();
        $mockValidatorUuidNot0xF
            ->method('validate')->with(0xF)->willReturn($result1);
 
        $aValidator->addPropertyValidator('uuid', $mockValidatorUuidNot0xF);
        $bValidator->addPropertyValidator('uuid', $mockValidatorUuidNot0xF);
        $aValidator->addPropertyValidator('b', $bValidator);
        $bValidator->addPropertyValidator('a', $aValidator);
 
        // assert that the validation error is being reported for both objects
        self::assertSame(
            ['uuid' => [$error1], 'b.uuid' => [$error1], 'b.a.uuid' => [$error1]],
            $aValidator->validate($A)->getFlattenedErrors()
        );
    }
}