ConverterTest.php 4.23 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 156 157 158 159 160 161
<?php
/**
 * Copyright © Magento, Inc. All rights reserved.
 * See COPYING.txt for license details.
 */
namespace Magento\Ui\Config;

use Magento\TestFramework\Helper\Bootstrap;
use Magento\Framework\Config\FileIterator;
use Magento\Framework\Filesystem\DriverPool;
use Magento\Framework\Filesystem\File\ReadFactory;

class ConverterTest extends \PHPUnit\Framework\TestCase
{
    /**
     * @var Converter
     */
    private $converter;

    /**
     * @var string
     */
    private $fixturePath;

    public function setUp()
    {
        $objectManager = Bootstrap::getObjectManager();
        $this->converter = $objectManager->create(Converter::class);
        $this->fixturePath = realpath(__DIR__ . '/../_files/view/ui_component');
    }

    /**
     * @param string $componentName
     * @return void
     * @dataProvider getComponentNameDataProvider
     */
    public function testConvert($componentName)
    {
        $expectedResult = $this->getExpectedResult($componentName);

        $fixtureFiles = $this->getFixtureFiles($componentName);
        foreach ($fixtureFiles as $filePath => $fileContent) {
            $dom = new \DOMDocument();
            $dom->loadXML($fileContent);
            $actualResult = $this->converter->convert($dom);

            if (isset($actualResult[Converter::DATA_ATTRIBUTES_KEY])) {
                unset($actualResult[Converter::DATA_ATTRIBUTES_KEY]);
            }

            $this->assertEquals(
                $expectedResult,
                $actualResult,
                "Wrong '{$this->getTypeByPath($filePath)}' configuration for '{$componentName}' Ui Component" . PHP_EOL
            );
        }
    }

    public function getComponentNameDataProvider()
    {
        return [
            ['action'],
            ['actionDelete'],
            ['actions'],
            ['actionsColumn'],
            ['bookmark'],
            ['boolean'],
            ['button'],
            ['checkbox'],
            ['checkboxset'],
            ['column'],
            ['columns'],
            ['columnsControls'],
            ['component'],
            ['dataSource'],
            ['date'],
            ['dynamicRows'],
            ['email'],
            ['exportButton'],
            ['field'],
            ['fieldset'],
            ['file'],
            ['fileUploader'],
            ['filterDate'],
            ['filterInput'],
            ['filterRange'],
            ['filters'],
            ['form'],
            ['hidden'],
            ['htmlContent'],
            ['imageUploader'],
            ['input'],
            ['insertForm'],
            ['insertListing'],
            ['listing'],
            ['listingToolbar'],
            ['massaction'],
            ['modal'],
            ['multiline'],
            ['multiselect'],
            ['paging'],
            ['radioset'],
            ['range'],
            ['select'],
            ['selectionsColumn'],
            ['tab'],
            ['text'],
            ['textarea'],
            ['wysiwyg'],
        ];
    }

    /**
     * Retrieve fixture files by $componentName
     *
     * @param string $componentName
     * @return FileIterator
     */
    private function getFixtureFiles($componentName)
    {
        $realPaths = [];
        foreach (['semantic', 'mixed', 'arbitrary'] as $filePath) {
            $realPaths[] = $this->fixturePath . '/' . $filePath . '/' . $componentName . '.xml';
        }
        return new FileIterator(new ReadFactory(new DriverPool), $realPaths);
    }

    /**
     * Retrieve expected result by $componentName
     *
     * @param string $componentName
     * @return array
     */
    private function getExpectedResult($componentName)
    {
        $filename = $this->fixturePath . '/expected/' . $componentName . '.php';
        if (is_file($filename)) {
            return include($filename);
        }

        return [];
    }

    /**
     * Retrieve fixture type by file path
     *
     * @param string $path
     * @return string
     */
    private function getTypeByPath($path)
    {
        $result = '';
        $pos = strpos($path, $this->fixturePath);
        if ($pos !== false) {
            $restParts = explode('/', substr($path, strlen($this->fixturePath) + 1));
            $result = array_shift($restParts);
        }

        return $result;
    }
}