ConfigTest.php 5.73 KB
Newer Older
Ketan's avatar
Ketan committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155
<?php
/**
 * Copyright © Magento, Inc. All rights reserved.
 * See COPYING.txt for license details.
 */

namespace Magento\Backend\Model\Search;

use Magento\Backend\App\Area\FrontNameResolver;
use Magento\Framework\App\Area;
use Magento\Framework\App\AreaList;
use Magento\Framework\App\Cache\State;
use Magento\Framework\App\Config\FileResolver;
use Magento\Framework\AuthorizationInterface;
use Magento\Framework\Config\FileIteratorFactory;
use Magento\Framework\Config\ScopeInterface;
use Magento\TestFramework\Helper\Bootstrap;

/**
 * @magentoAppArea adminhtml
 * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
 * @SuppressWarnings(PHPMD.StaticAccess)
 */
class ConfigTest extends \PHPUnit\Framework\TestCase
{
    /**
     * @dataProvider loadDataProvider
     * @magentoConfigFixture current_store general/store_information/name Foo
     */
    public function testLoad($query, $expectedResult)
    {
        /** @var \Magento\Backend\Model\Search\Config $configSearch */
        $configSearch = $this->getConfigSearchInstance();
        $configSearch->setQuery($query);
        $configSearch->load();

        /** SUT Execution */
        $searchResults = $configSearch->getResults();

        /** Ensure that search results are correct */
        $this->assertCount(count($expectedResult), $searchResults, 'Quantity of search result items is invalid.');
        foreach ($expectedResult as $itemIndex => $expectedItem) {
            /** Validate URL to item */
            $elementPathParts = explode('/', $expectedItem['id']);
            // filter empty values
            $elementPathParts = array_values(array_filter($elementPathParts));
            foreach ($elementPathParts as $elementPathPart) {
                $this->assertContains($elementPathPart, $searchResults[$itemIndex]['url'], 'Item URL is invalid.');
            }
            unset($searchResults[$itemIndex]['url']);

            /** Validate other item data */
            $this->assertEquals($expectedItem, $searchResults[$itemIndex], "Data of item #$itemIndex is invalid.");
        }
    }

    /**
     * @return \Magento\Backend\Model\Search\Config
     */
    private function getConfigSearchInstance()
    {
        Bootstrap::getInstance()->reinitialize([
            State::PARAM_BAN_CACHE => true,
        ]);
        Bootstrap::getObjectManager()
            ->get(ScopeInterface::class)
            ->setCurrentScope(FrontNameResolver::AREA_CODE);
        Bootstrap::getObjectManager()->get(AreaList::class)
            ->getArea(FrontNameResolver::AREA_CODE)
            ->load(Area::PART_CONFIG);

        Bootstrap::getObjectManager()->configure([
            'preferences' => [
                AuthorizationInterface::class => \Magento\Backend\Model\Search\AuthorizationMock::class
            ]
        ]);

        $fileResolverMock = $this->getMockBuilder(FileResolver::class)->disableOriginalConstructor()->getMock();
        $fileIteratorFactory = Bootstrap::getObjectManager()->get(FileIteratorFactory::class);
        $fileIterator = $fileIteratorFactory->create(
            [__DIR__ . '/_files/test_config.xml']
        );
        $fileResolverMock->expects($this->any())->method('get')->will($this->returnValue($fileIterator));

        $objectManager = Bootstrap::getObjectManager();
        /** @var \Magento\Config\Model\Config\Structure\Reader $structureReader */
        $structureReader = $objectManager->create(
            \Magento\Config\Model\Config\Structure\Reader::class,
            ['fileResolver' => $fileResolverMock]
        );
        /** @var \Magento\Config\Model\Config\Structure\Data $structureData */
        $structureData = $objectManager->create(
            \Magento\Config\Model\Config\Structure\Data::class,
            ['reader' => $structureReader]
        );
        /** @var \Magento\Config\Model\Config\Structure $structure  */
        $structure = $objectManager->create(
            \Magento\Config\Model\Config\Structure::class,
            ['structureData' => $structureData]
        );

        return $objectManager->create(
            \Magento\Backend\Model\Search\Config::class,
            ['configStructure' => $structure]
        );
    }

    /**
     * @return array
     */
    public static function loadDataProvider()
    {
        return [
            'Search by field name' => [
                'Test Field',
                [
                    [
                        'id'          => 'test_section/test_group/test_field_1',
                        'type'        => null,
                        'name'        => 'Test Field',
                        'description' => ' / Test Tab / Test Section / Test Group',
                    ],
                    [
                        'id'          => 'test_section/test_group/test_field_2',
                        'type'        => null,
                        'name'        => 'Test Field',
                        'description' => ' / Test Tab / Test Section / Test Group',
                    ],
                ],
            ],
            'Search by group name' => [
                'Test Group',
                [
                    [
                        'id'          => 'test_section/test_group',
                        'type'        => null,
                        'name'        => 'Test Group',
                        'description' => ' / Test Tab / Test Section',
                    ],
                ],
            ],
            'Search by section name' => [
                'Test Section',
                [
                    [
                        'id'          => '/test_section',
                        'type'        => null,
                        'name'        => 'Test Section',
                        'description' => ' / Test Tab',
                    ],
                ],
            ],
        ];
    }
}