AbstractComponentTest.php

Go to the documentation of this file.

<?php
namespace Magento\Ui\Test\Unit\Component;

use PHPUnit_Framework_MockObject_MockObject as MockObject;
use Magento\Framework\View\Element\UiComponent\ContextInterface;
use Magento\Framework\View\Element\UiComponent\ContentType\ContentTypeInterface;
use Magento\Framework\View\Element\UiComponentInterface;

class AbstractComponentTest extends \PHPUnit\Framework\TestCase
{
    protected $abstractComponent;

    protected $contextMock;

    protected function setUp()
    {
        $this->contextMock = $this->createMock(\Magento\Framework\View\Element\UiComponent\ContextInterface::class);
        $this->contextMock->expects($this->never())->method('getProcessor');
        $this->abstractComponent = $this->getMockBuilder(\Magento\Ui\Component\AbstractComponent::class)
            ->enableOriginalConstructor()
            ->setMethods(['getComponentName'])
            ->setConstructorArgs(['context' => $this->contextMock])
            ->getMock();
    }

    public function testGetContext()
    {
        $this->assertSame($this->contextMock, $this->abstractComponent->getContext());
    }

    public function testGetName()
    {
        $name = 'some name';
        $this->abstractComponent->setData('name', $name);
        $this->assertEquals($name, $this->abstractComponent->getName());
    }

    protected function initTestRender($renderResult)
    {
        $template = 'template';
        $this->abstractComponent->setData('template', $template);

        $renderEngineMock = $this->createMock(ContentTypeInterface::class);
        $renderEngineMock->expects($this->once())
            ->method('render')
            ->with($this->abstractComponent, $template . '.xhtml')
            ->willReturn($renderResult);

        $this->contextMock->expects($this->once())
            ->method('getRenderEngine')
            ->willReturn($renderEngineMock);
    }

    public function testRender()
    {
        $renderResult = 'some html code';
        $this->initTestRender($renderResult);
        $this->assertEquals($renderResult, $this->abstractComponent->render());
    }

    public function testGetComponentNotExists()
    {
        $this->assertNull($this->abstractComponent->getComponent('nameComponent'));
    }

    public function testGetChildComponentsEmptyArray()
    {
        $this->assertEquals([], $this->abstractComponent->getChildComponents());
    }

    public function testAddGetChildComponents()
    {
        $uiComponentMock = $this->createMock(\Magento\Framework\View\Element\UiComponentInterface::class);
        $name = 'componentName';

        $this->abstractComponent->addComponent($name, $uiComponentMock);
        $this->assertEquals($uiComponentMock, $this->abstractComponent->getComponent($name));
    }

    public function testGetChildComponents()
    {
        $uiComponentMock = $this->createMock(\Magento\Framework\View\Element\UiComponentInterface::class);
        $name = 'componentName';
        $expectedResult = [$name => $uiComponentMock];

        $this->abstractComponent->addComponent($name, $uiComponentMock);
        $this->assertEquals($expectedResult, $this->abstractComponent->getChildComponents());
    }

    public function testRenderChildComponentNotExists()
    {
        $this->assertEquals(null, $this->abstractComponent->renderChildComponent('someComponent'));
    }

    public function testRenderChildComponent()
    {
        $name = 'componentName';
        $expectedResult = 'some html code';
        $uiComponentMock = $this->createMock(\Magento\Framework\View\Element\UiComponentInterface::class);
        $uiComponentMock->expects($this->once())
            ->method('render')
            ->willReturn($expectedResult);

        $this->abstractComponent->addComponent($name, $uiComponentMock);
        $this->assertEquals($expectedResult, $this->abstractComponent->renderChildComponent($name));
    }

    public function testGetTemplate()
    {
        $template = 'sample';
        $this->abstractComponent->setData('template', $template);

        $this->assertEquals($template . '.xhtml', $this->abstractComponent->getTemplate());
    }

    public function testGetConfiguration($config, array $expectedResult)
    {
        $this->abstractComponent->setData('config', $config);
        $this->assertSame($expectedResult, $this->abstractComponent->getConfiguration());
    }

    public function getConfigurationDataProvider()
    {
        return [
            ['config' => null, 'expectedResult' => []],
            ['config' => [], 'expectedResult' => []],
            ['config' => ['visible' => true], 'expectedResult' => ['visible' => true]],
        ];
    }

    public function testGetJsConfig(array $jsConfig, array $expectedResult)
    {
        $namespace = 'my_namespace';
        $uiComponentMock = $this->getMockBuilder(\Magento\Framework\View\Element\UiComponentInterface::class)
            ->setMethods(['getData'])
            ->getMockForAbstractClass();
        $uiComponentMock->expects($this->once())
            ->method('getData')
            ->with('js_config')
            ->willReturnOnConsecutiveCalls($jsConfig);
        $uiComponentMock->expects($this->any())
            ->method('getContext')
            ->willReturn($this->contextMock);
        $this->contextMock->expects($this->any())
            ->method('getNamespace')
            ->willReturn($namespace);

        $this->assertEquals($expectedResult, $this->abstractComponent->getJsConfig($uiComponentMock));
    }

    public function getJsConfigDataProvider()
    {
        return [
            [
                'jsConfig' => [],
                'expectedResult' => ['extends' => 'my_namespace']
            ],
            [
                'jsConfig' => ['name' => 'test'],
                'expectedResult' => ['name' => 'test', 'extends' => 'my_namespace']
            ],
            [
                'jsConfig' => ['name' => 'test', 'extends' => 'some_extends'],
                'expectedResult' => ['name' => 'test', 'extends' => 'some_extends']
            ],
        ];
    }
}