VisibilityFilterTest.php

Go to the documentation of this file.

<?php
namespace Magento\CatalogSearch\Model\Search\FilterMapper;

use Magento\Framework\Search\Request\Filter\Term;
use Magento\Store\Model\StoreManagerInterface;
use Magento\Framework\App\ResourceConnection;
use Magento\Eav\Model\Config as EavConfig;
use Magento\Eav\Model\Entity\Attribute\AbstractAttribute;
use Magento\Framework\Search\Adapter\Mysql\ConditionManager;
use Magento\Framework\DB\Select;

class VisibilityFilterTest extends \PHPUnit\Framework\TestCase
{
    private $objectManager;

    private $resource;

    private $conditionManager;

    private $storeManager;

    private $eavConfigMock;

    private $visibilityFilter;

    private $answerToLifeTheUniverseAndEverything = 42;

    protected function setUp()
    {
        $this->objectManager = \Magento\TestFramework\Helper\Bootstrap::getObjectManager();
        $this->resource = $this->objectManager->create(ResourceConnection::class);
        $this->conditionManager = $this->objectManager->create(ConditionManager::class);
        $this->storeManager = $this->objectManager->create(StoreManagerInterface::class);

        $this->eavConfigMock = $this->getMockBuilder(EavConfig::class)
            ->disableOriginalConstructor()
            ->getMock();

        $this->visibilityFilter = $this->objectManager->create(
            VisibilityFilter::class,
            [
                'eavConfig' => $this->eavConfigMock
            ]
        );
    }

    public function testApplyWithWrongType()
    {
        $select = $this->resource->getConnection()->select();
        $filter = $this->mockFilter();

        $this->visibilityFilter->apply($select, $filter, 'Luke, I am your father!');
    }

    public function testApplyFilterAsWhere()
    {
        $select = $this->resource->getConnection()->select();
        $select->from(
            ['some_index' => 'some_table'],
            ['entity_id' => 'entity_id']
        );

        $filter = $this->mockFilter();
        $attribute = $this->mockAttribute();

        $this->eavConfigMock
            ->method('getAttribute')
            ->willReturn($attribute);

        $resultSelect = $this->visibilityFilter->apply($select, $filter, VisibilityFilter::FILTER_BY_WHERE);
        $expectedSelect = $this->getExpectedSelectForWhereFilter();

        $this->assertEquals(
            (string) $expectedSelect,
            (string) $resultSelect,
            'Select queries must be the same'
        );
    }

    public function testApplyFilterAsJoin()
    {
        $select = $this->resource->getConnection()->select();
        $select->from(
            ['some_index' => 'some_table'],
            ['entity_id' => 'entity_id']
        );

        $filter = $this->mockFilter();
        $attribute = $this->mockAttribute();

        $this->eavConfigMock
            ->method('getAttribute')
            ->willReturn($attribute);

        $resultSelect = $this->visibilityFilter->apply($select, $filter, VisibilityFilter::FILTER_BY_JOIN);
        $expectedSelect = $this->getExpectedSelectForJoinFilter();

        $this->assertEquals(
            (string) $expectedSelect,
            (string) $resultSelect,
            'Select queries must be the same'
        );
    }

    private function getExpectedSelectForWhereFilter()
    {
        $filter = $this->mockFilter();
        $select = $this->resource->getConnection()->select();
        $select->from(
            ['some_index' => 'some_table'],
            ['entity_id' => 'entity_id']
        )->where(
            $this->conditionManager->combineQueries(
                [
                    $this->conditionManager->generateCondition(
                        'some_index.attribute_id',
                        '=',
                        $this->answerToLifeTheUniverseAndEverything
                    ),
                    $this->conditionManager->generateCondition(
                        'some_index.value',
                        is_array($filter->getValue()) ? 'in' : '=',
                        $filter->getValue()
                    ),
                    $this->conditionManager->generateCondition(
                        'some_index.store_id',
                        '=',
                        $this->storeManager->getStore()->getId()
                    ),
                ],
                Select::SQL_AND
            )
        );

        return $select;
    }

    private function getExpectedSelectForJoinFilter()
    {
        $filter = $this->mockFilter();
        $select = $this->resource->getConnection()->select();
        $select->from(
            ['some_index' => 'some_table'],
            ['entity_id' => 'entity_id']
        )->joinInner(
            ['visibility_filter' => $this->resource->getTableName('catalog_product_index_eav')],
            $this->conditionManager->combineQueries(
                [
                    'some_index.entity_id = visibility_filter.entity_id',
                    $this->conditionManager->generateCondition(
                        'visibility_filter.attribute_id',
                        '=',
                        $this->answerToLifeTheUniverseAndEverything
                    ),
                    $this->conditionManager->generateCondition(
                        'visibility_filter.value',
                        is_array($filter->getValue()) ? 'in' : '=',
                        $filter->getValue()
                    ),
                    $this->conditionManager->generateCondition(
                        'visibility_filter.store_id',
                        '=',
                        $this->storeManager->getStore()->getId()
                    ),
                ],
                Select::SQL_AND
            ),
            []
        );

        return $select;
    }

    private function mockFilter()
    {
        return $this->getMockBuilder(Term::class)
            ->setConstructorArgs(['name2', [42, 450], 'visibility'])
            ->setMethods(null)
            ->getMock();
    }

    private function mockAttribute()
    {
        $attribute  = $this->getMockBuilder(AbstractAttribute::class)
            ->disableOriginalConstructor()
            ->setMethods(['getId'])
            ->getMockForAbstractClass();

        $attribute
            ->method('getId')
            ->willReturn($this->answerToLifeTheUniverseAndEverything);

        return $attribute;
    }
}