ArgumentTest.php

Go to the documentation of this file.

<?php
 
/*
 * 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\Mvc\Controller;
 
use ‪TYPO3\CMS\Extbase\Error\Error;
use ‪TYPO3\CMS\Extbase\Error\Result;
use ‪TYPO3\CMS\Extbase\Mvc\Controller\Argument;
use ‪TYPO3\CMS\Extbase\Mvc\Controller\MvcPropertyMappingConfiguration;
use ‪TYPO3\CMS\Extbase\Property\PropertyMapper;
use ‪TYPO3\CMS\Extbase\Property\TypeConverter\PersistentObjectConverter;
use ‪TYPO3\CMS\Extbase\Validation\Validator\ValidatorInterface;
use TYPO3\TestingFramework\Core\Unit\UnitTestCase;
 
class ‪ArgumentTest extends UnitTestCase
{
    protected ‪$simpleValueArgument;
 
    protected ‪$objectArgument;
 
    protected ‪$mockPropertyMapper;
 
    protected ‪$mockConfigurationBuilder;
 
    protected ‪$mockConfiguration;
 
    protected function ‪setUp(): void
    {
        parent::setUp();
        $this->simpleValueArgument = new ‪Argument('someName', 'string');
        $this->objectArgument = new ‪Argument('someName', 'DateTime');
        $this->mockPropertyMapper = $this->createMock(PropertyMapper::class);
        $this->simpleValueArgument->injectPropertyMapper($this->mockPropertyMapper);
        $this->objectArgument->injectPropertyMapper($this->mockPropertyMapper);
        $this->mockConfiguration = new ‪MvcPropertyMappingConfiguration();
        $propertyMappingConfiguration = new ‪MvcPropertyMappingConfiguration();
        $this->simpleValueArgument->injectPropertyMappingConfiguration($propertyMappingConfiguration);
        $this->objectArgument->injectPropertyMappingConfiguration($propertyMappingConfiguration);
    }
 
    public function ‪constructingArgumentWithoutNameThrowsException(): void
    {
        $this->expectException(\InvalidArgumentException::class);
        $this->expectExceptionCode(1232551853);
        new ‪Argument('', 'Text');
    }
 
    public function ‪constructingArgumentWithInvalidNameThrowsException(): void
    {
        $this->expectException(\InvalidArgumentException::class);
        $this->expectExceptionCode(1187951688);
        new Argument(new \ArrayObject(), 'Text');
    }
 
    public function ‪passingDataTypeToConstructorReallySetsTheDataType(): void
    {
        self::assertEquals('string', $this->simpleValueArgument->getDataType(), 'The specified data type has not been set correctly.');
        self::assertEquals('someName', $this->simpleValueArgument->getName(), 'The specified name has not been set correctly.');
    }
 
    public function ‪setShortNameProvidesFluentInterface(): void
    {
        $returnedArgument = $this->simpleValueArgument->setShortName('x');
        self::assertSame($this->simpleValueArgument, $returnedArgument, 'The returned argument is not the original argument.');
    }
 
    public function ‪invalidShortNames(): array
    {
        return [
            [''],
            ['as'],
            [5]
        ];
    }
 
    public function ‪shortNameShouldThrowExceptionIfInvalid($invalidShortName): void
    {
        $this->expectException(\InvalidArgumentException::class);
        $this->expectExceptionCode(1195824959);
        $this->simpleValueArgument->setShortName($invalidShortName);
    }
 
    public function ‪shortNameCanBeRetrievedAgain(): void
    {
        $this->simpleValueArgument->setShortName('x');
        self::assertEquals('x', $this->simpleValueArgument->getShortName());
    }
 
    public function ‪setRequiredShouldProvideFluentInterfaceAndReallySetRequiredState(): void
    {
        $returnedArgument = $this->simpleValueArgument->setRequired(true);
        self::assertSame($this->simpleValueArgument, $returnedArgument, 'The returned argument is not the original argument.');
        self::assertTrue($this->simpleValueArgument->isRequired());
    }
 
    public function ‪setDefaultValueShouldProvideFluentInterfaceAndReallySetDefaultValue(): void
    {
        $returnedArgument = $this->simpleValueArgument->setDefaultValue('default');
        self::assertSame($this->simpleValueArgument, $returnedArgument, 'The returned argument is not the original argument.');
        self::assertSame('default', $this->simpleValueArgument->getDefaultValue());
    }
 
    public function ‪setValidatorShouldProvideFluentInterfaceAndReallySetValidator(): void
    {
        $mockValidator = $this->createMock(ValidatorInterface::class);
        $returnedArgument = $this->simpleValueArgument->setValidator($mockValidator);
        self::assertSame($this->simpleValueArgument, $returnedArgument, 'The returned argument is not the original argument.');
        self::assertSame($mockValidator, $this->simpleValueArgument->getValidator());
    }
 
    public function ‪setValueProvidesFluentInterface(): void
    {
        $returnedArgument = $this->simpleValueArgument->setValue(null);
        self::assertSame($this->simpleValueArgument, $returnedArgument, 'The returned argument is not the original argument.');
    }
 
    public function ‪setValueUsesNullAsIs(): void
    {
        $this->simpleValueArgument = new Argument('dummy', 'string');
        $this->simpleValueArgument->setValue(null);
        self::assertNull($this->simpleValueArgument->getValue());
    }
 
    public function ‪setValueUsesMatchingInstanceAsIs(): void
    {
        $this->mockPropertyMapper->expects(self::never())->method('convert');
        $this->objectArgument->setValue(new \DateTime());
    }
 
    protected function ‪setupPropertyMapperAndSetValue(): Argument
    {
        $this->mockPropertyMapper->expects(self::once())->method('convert')->with('someRawValue', 'string', $this->mockConfiguration)->willReturn('convertedValue');
        $this->mockPropertyMapper->expects(self::once())->method('getMessages')->willReturn(new Result());
        return $this->simpleValueArgument->setValue('someRawValue');
    }
 
    public function ‪setValueShouldCallPropertyMapperCorrectlyAndStoreResultInValue(): void
    {
        $this->‪setupPropertyMapperAndSetValue();
        self::assertSame('convertedValue', $this->simpleValueArgument->getValue());
        self::assertTrue($this->simpleValueArgument->isValid());
    }
 
    public function ‪setValueShouldBeFluentInterface(): void
    {
        self::assertSame($this->simpleValueArgument, $this->‪setupPropertyMapperAndSetValue());
    }
 
    public function ‪setValueShouldSetValidationErrorsIfValidatorIsSetAndValidationFailed(): void
    {
        $error = new Error('Some Error', 1234);
        $mockValidator = $this->getMockBuilder(ValidatorInterface::class)
            ->setMethods(['validate', 'getOptions'])
            ->getMock();
        $validationMessages = new Result();
        $validationMessages->addError($error);
        $mockValidator->expects(self::once())->method('validate')->with('convertedValue')->willReturn($validationMessages);
        $this->simpleValueArgument->setValidator($mockValidator);
        $this->‪setupPropertyMapperAndSetValue();
        self::assertFalse($this->simpleValueArgument->isValid());
        self::assertEquals([$error], $this->simpleValueArgument->validate()->getErrors());
    }
 
    public function ‪defaultPropertyMappingConfigurationDoesNotAllowCreationOrModificationOfObjects(): void
    {
        self::assertNull($this->simpleValueArgument->getPropertyMappingConfiguration()->getConfigurationValue(PersistentObjectConverter::class, ‪PersistentObjectConverter::CONFIGURATION_CREATION_ALLOWED));
        self::assertNull($this->simpleValueArgument->getPropertyMappingConfiguration()->getConfigurationValue(PersistentObjectConverter::class, ‪PersistentObjectConverter::CONFIGURATION_MODIFICATION_ALLOWED));
    }
}