9.5/_mvc_property_mapping_configuration_service_test_8php_source.html

<?php

namespace ‪TYPO3\CMS\Extbase\Tests\Unit\Mvc\Controller;


/*

 * 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!

 */


use ‪TYPO3\CMS\Core\Error\Http\BadRequestException;

use ‪TYPO3\CMS\Extbase\Mvc\Controller\MvcPropertyMappingConfigurationService;

use ‪TYPO3\CMS\Extbase\Security\Exception\InvalidArgumentForHashGenerationException;

use TYPO3\TestingFramework\Core\Unit\UnitTestCase;


class ‪MvcPropertyMappingConfigurationServiceTest extends UnitTestCase

{

    public function ‪dataProviderForgenerateTrustedPropertiesToken()

    {

        return [

            'Simple Case - Empty' => [

                [],

                [],

            ],

            'Simple Case - Single Value' => [

                ['field1'],

                ['field1' => 1],

            ],

            'Simple Case - Two Values' => [

                ['field1', 'field2'],

                [

                    'field1' => 1,

                    'field2' => 1

                ],

            ],

            'Recursion' => [

                ['field1', 'field[subfield1]', 'field[subfield2]'],

                [

                    'field1' => 1,

                    'field' => [

                        'subfield1' => 1,

                        'subfield2' => 1

                    ]

                ],

            ],

            'recursion with duplicated field name' => [

                ['field1', 'field[subfield1]', 'field[subfield2]', 'field1'],

                [

                    'field1' => 1,

                    'field' => [

                        'subfield1' => 1,

                        'subfield2' => 1

                    ]

                ],

            ],

            'Recursion with un-named fields at the end (...[]). There, they should be made explicit by increasing the counter' => [

                ['field1', 'field[subfield1][]', 'field[subfield1][]', 'field[subfield2]'],

                [

                    'field1' => 1,

                    'field' => [

                        'subfield1' => [

                            0 => 1,

                            1 => 1

                        ],

                        'subfield2' => 1

                    ]

                ],

            ],

        ];

    }


    public function ‪dataProviderForgenerateTrustedPropertiesTokenWithUnallowedValues()

    {

        return [

            'Overriding form fields (string overridden by array) - 1' => [

                ['field1', 'field2', 'field2[bla]', 'field2[blubb]'],

                1255072196

            ],

            'Overriding form fields (string overridden by array) - 2' => [

                ['field1', 'field2[bla]', 'field2[bla][blubb][blubb]'],

                1255072196

            ],

            'Overriding form fields (array overridden by string) - 1' => [

                ['field1', 'field2[bla]', 'field2[blubb]', 'field2'],

                1255072587

            ],

            'Overriding form fields (array overridden by string) - 2' => [

                ['field1', 'field2[bla][blubb][blubb]', 'field2[bla]'],

                1255072587

            ],

            'Empty [] not as last argument' => [

                ['field1', 'field2[][bla]'],

                1255072832

            ]


        ];

    }


    public function ‪generateTrustedPropertiesTokenGeneratesTheCorrectHashesInNormalOperation($input, $expected)

    {

        $requestHashService = $this->getMockBuilder(\‪TYPO3\CMS\‪Extbase\Mvc\Controller\MvcPropertyMappingConfigurationService::class)

            ->setMethods(['serializeAndHashFormFieldArray'])

            ->getMock();

        $requestHashService->expects($this->once())->method('serializeAndHashFormFieldArray')->with($expected);

        $requestHashService->generateTrustedPropertiesToken($input);

    }


    public function ‪generateTrustedPropertiesTokenThrowsExceptionInWrongCases($input, $expectExceptionCode)

    {

        $this->expectException(InvalidArgumentForHashGenerationException::class);

        $this->expectExceptionCode($expectExceptionCode);

        $requestHashService = $this->getMockBuilder(\‪TYPO3\CMS\‪Extbase\Mvc\Controller\MvcPropertyMappingConfigurationService::class)

            ->setMethods(['serializeAndHashFormFieldArray'])

            ->getMock();

        $requestHashService->generateTrustedPropertiesToken($input);

    }


    public function ‪serializeAndHashFormFieldArrayWorks()

    {

        $formFieldArray = [

            'bla' => [

                'blubb' => 1,

                'hu' => 1

            ]

        ];

        $mockHash = '12345';


        $hashService = $this->getMockBuilder($this->buildAccessibleProxy(\‪TYPO3\CMS\‪Extbase\Mvc\Controller\MvcPropertyMappingConfigurationService::class))

            ->setMethods(['appendHmac'])

            ->getMock();

        $hashService->expects($this->once())->method('appendHmac')->with(serialize($formFieldArray))->will($this->returnValue(serialize($formFieldArray) . $mockHash));


        $requestHashService = $this->getMockBuilder($this->buildAccessibleProxy(\‪TYPO3\CMS\‪Extbase\Mvc\Controller\MvcPropertyMappingConfigurationService::class))

            ->setMethods(['dummy'])

            ->getMock();

        $requestHashService->_set('hashService', $hashService);


        $expected = serialize($formFieldArray) . $mockHash;

        $actual = $requestHashService->_call('serializeAndHashFormFieldArray', $formFieldArray);

        $this->assertEquals($expected, $actual);

    }


    public function ‪initializePropertyMappingConfigurationDoesNothingIfTrustedPropertiesAreNotSet()

    {

        $request = $this->getMockBuilder(\‪TYPO3\CMS\‪Extbase\Mvc\Request::class)->setMethods(['getInternalArgument'])->disableOriginalConstructor()->getMock();

        $request->expects($this->any())->method('getInternalArgument')->with('__trustedProperties')->will($this->returnValue(null));

        $arguments = new \TYPO3\CMS\Extbase\Mvc\Controller\Arguments();


        $requestHashService = new \TYPO3\CMS\Extbase\Mvc\Controller\MvcPropertyMappingConfigurationService;

        $requestHashService->initializePropertyMappingConfigurationFromRequest($request, $arguments);

    }


    public function ‪initializePropertyMappingConfigurationThrowsBadRequestExceptionOnInvalidHmac()

    {

        $this->expectException(BadRequestException::class);

        $this->expectExceptionCode(1581862822);


        $request = $this->getMockBuilder(\‪TYPO3\CMS\‪Extbase\Mvc\Request::class)->setMethods(['getInternalArgument'])->disableOriginalConstructor()->getMock();

        $request->expects(self::any())->method('getInternalArgument')->with('__trustedProperties')->willReturn('string with less than 40 characters');

        $arguments = new \TYPO3\CMS\Extbase\Mvc\Controller\Arguments();


        $hashService = new \TYPO3\CMS\Extbase\Security\Cryptography\HashService();

        $requestHashService = new ‪MvcPropertyMappingConfigurationService;

        $requestHashService->‪injectHashService($hashService);

        $requestHashService->initializePropertyMappingConfigurationFromRequest($request, $arguments);

    }


    public function ‪initializePropertyMappingConfigurationReturnsEarlyIfNoTrustedPropertiesAreSet()

    {

        $trustedProperties = [

            'foo' => 1

        ];

        $this->‪initializePropertyMappingConfiguration($trustedProperties);

    }


    public function ‪initializePropertyMappingConfigurationReturnsEarlyIfArgumentIsUnknown()

    {

        $trustedProperties = [

            'nonExistingArgument' => 1

        ];

        $arguments = $this->‪initializePropertyMappingConfiguration($trustedProperties);

        $this->assertFalse($arguments->hasArgument('nonExistingArgument'));

    }


    public function ‪initializePropertyMappingConfigurationSetsModificationAllowedIfIdentityPropertyIsSet()

    {

        $trustedProperties = [

            'foo' => [

                '__identity' => 1,

                'nested' => [

                    '__identity' => 1,

                ]

            ]

        ];

        $arguments = $this->‪initializePropertyMappingConfiguration($trustedProperties);

        $propertyMappingConfiguration = $arguments->getArgument('foo')->getPropertyMappingConfiguration();

        $this->assertTrue($propertyMappingConfiguration->getConfigurationValue(\‪TYPO3\CMS\‪Extbase\Property\TypeConverter\PersistentObjectConverter::class, \‪TYPO3\CMS\‪Extbase\Property\TypeConverter\PersistentObjectConverter::CONFIGURATION_MODIFICATION_ALLOWED), 'ConfigurationValue is not CONFIGURATION_MODIFICATION_ALLOWED at line ' . __LINE__);

        $this->assertNull($propertyMappingConfiguration->getConfigurationValue(\‪TYPO3\CMS\‪Extbase\Property\TypeConverter\PersistentObjectConverter::class, \‪TYPO3\CMS\‪Extbase\Property\TypeConverter\PersistentObjectConverter::CONFIGURATION_CREATION_ALLOWED), 'ConfigurationValue is not NULL at line ' . __LINE__);

        $this->assertFalse($propertyMappingConfiguration->shouldMap('someProperty'), 'Value is not FALSE at line ' . __LINE__);


        $this->assertTrue($propertyMappingConfiguration->forProperty('nested')->getConfigurationValue(\‪TYPO3\CMS\‪Extbase\Property\TypeConverter\PersistentObjectConverter::class, \‪TYPO3\CMS\‪Extbase\Property\TypeConverter\PersistentObjectConverter::CONFIGURATION_MODIFICATION_ALLOWED), 'ConfigurationValue is not CONFIGURATION_MODIFICATION_ALLOWED at line ' . __LINE__);

        $this->assertNull($propertyMappingConfiguration->forProperty('nested')->getConfigurationValue(\‪TYPO3\CMS\‪Extbase\Property\TypeConverter\PersistentObjectConverter::class, \‪TYPO3\CMS\‪Extbase\Property\TypeConverter\PersistentObjectConverter::CONFIGURATION_CREATION_ALLOWED), 'ConfigurationValue is not NULL at line ' . __LINE__);

        $this->assertFalse($propertyMappingConfiguration->forProperty('nested')->shouldMap('someProperty'), 'Value is not FALSE at line ' . __LINE__);

    }


    public function ‪initializePropertyMappingConfigurationSetsCreationAllowedIfIdentityPropertyIsNotSet()

    {

        $trustedProperties = [

            'foo' => [

                'bar' => []

            ]

        ];

        $arguments = $this->‪initializePropertyMappingConfiguration($trustedProperties);

        $propertyMappingConfiguration = $arguments->getArgument('foo')->getPropertyMappingConfiguration();

        $this->assertNull($propertyMappingConfiguration->getConfigurationValue(\‪TYPO3\CMS\‪Extbase\Property\TypeConverter\PersistentObjectConverter::class, \‪TYPO3\CMS\‪Extbase\Property\TypeConverter\PersistentObjectConverter::CONFIGURATION_MODIFICATION_ALLOWED));

        $this->assertTrue($propertyMappingConfiguration->getConfigurationValue(\‪TYPO3\CMS\‪Extbase\Property\TypeConverter\PersistentObjectConverter::class, \‪TYPO3\CMS\‪Extbase\Property\TypeConverter\PersistentObjectConverter::CONFIGURATION_CREATION_ALLOWED));

        $this->assertFalse($propertyMappingConfiguration->shouldMap('someProperty'));


        $this->assertNull($propertyMappingConfiguration->forProperty('bar')->getConfigurationValue(\‪TYPO3\CMS\‪Extbase\Property\TypeConverter\PersistentObjectConverter::class, \‪TYPO3\CMS\‪Extbase\Property\TypeConverter\PersistentObjectConverter::CONFIGURATION_MODIFICATION_ALLOWED));

        $this->assertTrue($propertyMappingConfiguration->forProperty('bar')->getConfigurationValue(\‪TYPO3\CMS\‪Extbase\Property\TypeConverter\PersistentObjectConverter::class, \‪TYPO3\CMS\‪Extbase\Property\TypeConverter\PersistentObjectConverter::CONFIGURATION_CREATION_ALLOWED));

        $this->assertFalse($propertyMappingConfiguration->forProperty('bar')->shouldMap('someProperty'));

    }


    public function ‪initializePropertyMappingConfigurationSetsAllowedFields()

    {

        $trustedProperties = [

            'foo' => [

                'bar' => 1

            ]

        ];

        $arguments = $this->‪initializePropertyMappingConfiguration($trustedProperties);

        $propertyMappingConfiguration = $arguments->getArgument('foo')->getPropertyMappingConfiguration();

        $this->assertFalse($propertyMappingConfiguration->shouldMap('someProperty'));

        $this->assertTrue($propertyMappingConfiguration->shouldMap('bar'));

    }


    public function ‪initializePropertyMappingConfigurationSetsAllowedFieldsRecursively()

    {

        $trustedProperties = [

            'foo' => [

                'bar' => [

                    'foo' => 1

                ]

            ]

        ];

        $arguments = $this->‪initializePropertyMappingConfiguration($trustedProperties);

        $propertyMappingConfiguration = $arguments->getArgument('foo')->getPropertyMappingConfiguration();

        $this->assertFalse($propertyMappingConfiguration->shouldMap('someProperty'));

        $this->assertTrue($propertyMappingConfiguration->shouldMap('bar'));

        $this->assertTrue($propertyMappingConfiguration->forProperty('bar')->shouldMap('foo'));

    }


    protected function ‪initializePropertyMappingConfiguration(array $trustedProperties)

    {

        $request = $this->getMockBuilder(\‪TYPO3\CMS\‪Extbase\Mvc\Request::class)->setMethods(['getInternalArgument'])->disableOriginalConstructor()->getMock();

        $request->expects($this->any())->method('getInternalArgument')->with('__trustedProperties')->will($this->returnValue('fooTrustedProperties'));


        $mockHashService = $this->getMockBuilder(\‪TYPO3\CMS\‪Extbase\Security\Cryptography\HashService::class)

            ->setMethods(['validateAndStripHmac'])

            ->getMock();

        $mockHashService->expects($this->once())->method('validateAndStripHmac')->with('fooTrustedProperties')->will($this->returnValue(serialize($trustedProperties)));


        $requestHashService = $this->getAccessibleMock(\‪TYPO3\CMS\‪Extbase\Mvc\Controller\MvcPropertyMappingConfigurationService::class, ['dummy']);

        $requestHashService->_set('hashService', $mockHashService);


        $mockObjectManager = $this->createMock(\‪TYPO3\CMS\‪Extbase\Object\ObjectManagerInterface::class);

        $mockArgument = $this->getAccessibleMock(\‪TYPO3\CMS\‪Extbase\Mvc\Controller\Argument::class, ['getName'], [], '', false);


        $propertyMappingConfiguration = new \TYPO3\CMS\Extbase\Mvc\Controller\MvcPropertyMappingConfiguration();


        $mockArgument->_set('propertyMappingConfiguration', $propertyMappingConfiguration);

        $mockArgument->expects($this->any())->method('getName')->will($this->returnValue('foo'));

        $mockObjectManager->expects($this->once())->method('get')->with(\‪TYPO3\CMS\‪Extbase\Mvc\Controller\Argument::class)->will($this->returnValue($mockArgument));


        $arguments = $this->getAccessibleMock(\‪TYPO3\CMS\‪Extbase\Mvc\Controller\Arguments::class, ['dummy']);

        $arguments->_set('objectManager', $mockObjectManager);

        $arguments->addNewArgument('foo');


        $requestHashService->initializePropertyMappingConfigurationFromRequest($request, $arguments);


        return $arguments;

    }

}