Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Search: Add unit test for PopularSearchTerms model #17739

Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
95 changes: 95 additions & 0 deletions app/code/Magento/Search/Test/Unit/Model/PopularSearchTermsTest.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types=1);

namespace Magento\Search\Test\Unit\Model;

use Magento\Framework\App\Config\ScopeConfigInterface;
use Magento\Search\Model\PopularSearchTerms;
use Magento\Search\Model\ResourceModel\Query\Collection;
use Magento\Store\Model\ScopeInterface;

/**
* @covers \Magento\Search\Model\PopularSearchTerms
*/
class PopularSearchTermsTest extends \PHPUnit\Framework\TestCase
{
/**
* Testable Object
*
* @var PopularSearchTerms
*/
private $popularSearchTerms;

/**
* @var ScopeConfigInterface|\PHPUnit_Framework_MockObject_MockObject
*/
private $scopeConfigMock;

/**
* @var Collection|\PHPUnit_Framework_MockObject_MockObject
*/
private $queryCollectionMock;

/**
* Set Up
*
* @return void
*/
protected function setUp()
{
$this->scopeConfigMock = $this->createMock(ScopeConfigInterface::class);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a recommendation for the future. If you are not going to reuse properties in different methods, it's a good idea to use local method variables instead of class properties.

$this->queryCollectionMock = $this->createMock(Collection::class);
$this->popularSearchTerms = new PopularSearchTerms($this->scopeConfigMock, $this->queryCollectionMock);
}

/**
* Test isCacheableDataProvider method
*
* @dataProvider isCacheableDataProvider
*
* @param string $term
* @param array $terms
* @param $expected $terms
*
* @return void
*/
public function testIsCacheable($term, $terms, $expected)
{
$storeId = 7;
$pageSize = 25;

$this->scopeConfigMock->expects($this->once())->method('getValue')
->with(
PopularSearchTerms::XML_PATH_MAX_COUNT_CACHEABLE_SEARCH_TERMS,
ScopeInterface::SCOPE_STORE,
$storeId
)->willReturn($pageSize);
$this->queryCollectionMock->expects($this->once())->method('setPopularQueryFilter')->with($storeId)
->willReturnSelf();
$this->queryCollectionMock->expects($this->once())->method('setPageSize')->with($pageSize)
->willReturnSelf();
$this->queryCollectionMock->expects($this->once())->method('load')->willReturnSelf();
$this->queryCollectionMock->expects($this->once())->method('getColumnValues')->with('query_text')
->willReturn($terms);

$actual = $this->popularSearchTerms->isCacheable($term, $storeId);
self::assertEquals($expected, $actual);
}

/**
* @return array
*/
public function isCacheableDataProvider()
{
return [
['test01', [], false],
['test02', ['test01', 'test02'], true],
['test03', ['test01', 'test02'], false],
['test04', ['test04'], true],
];
}
}