Server : Apache System : Linux server2.corals.io 4.18.0-348.2.1.el8_5.x86_64 #1 SMP Mon Nov 15 09:17:08 EST 2021 x86_64 User : corals ( 1002) PHP Version : 7.4.33 Disable Function : exec,passthru,shell_exec,system Directory : /home/corals/old/vendor/magento/module-elasticsearch-7/Test/Unit/Model/Client/ |
<?php
/**
* Copyright © Magento, Inc. All rights reserved.
* See COPYING.txt for license details.
*/
declare(strict_types=1);
namespace Magento\Elasticsearch7\Test\Unit\Model\Client;
use Elasticsearch\Client;
use Elasticsearch\Namespaces\IndicesNamespace;
use Magento\AdvancedSearch\Model\Client\ClientInterface as ElasticsearchClient;
use Magento\Elasticsearch\Model\Adapter\FieldMapper\AddDefaultSearchField;
use Magento\Elasticsearch7\Model\Adapter\DynamicTemplates\IntegerMapper;
use Magento\Elasticsearch7\Model\Adapter\DynamicTemplates\PositionMapper;
use Magento\Elasticsearch7\Model\Adapter\DynamicTemplates\PriceMapper;
use Magento\Elasticsearch7\Model\Adapter\DynamicTemplates\StringMapper;
use Magento\Elasticsearch7\Model\Adapter\DynamicTemplatesProvider;
use Magento\Elasticsearch7\Model\Client\Elasticsearch;
use Magento\Framework\Exception\LocalizedException;
use Magento\Framework\TestFramework\Unit\Helper\ObjectManager as ObjectManagerHelper;
use PHPUnit\Framework\MockObject\MockObject;
use PHPUnit\Framework\TestCase;
/**
* Class ElasticsearchTest to test Elasticsearch 7
*/
class ElasticsearchTest extends TestCase
{
/**
* @var ElasticsearchClient
*/
private $model;
/**
* @var Client|MockObject
*/
private $elasticsearchClientMock;
/**
* @var IndicesNamespace|MockObject
*/
private $indicesMock;
/**
* @var ObjectManagerHelper
*/
private $objectManager;
/**
* Setup
*
* @return void
*/
protected function setUp(): void
{
$this->elasticsearchClientMock = $this->getMockBuilder(Client::class)
->setMethods(
[
'indices',
'ping',
'bulk',
'search',
'scroll',
'suggest',
'info',
]
)
->disableOriginalConstructor()
->getMock();
$this->indicesMock = $this->getMockBuilder(IndicesNamespace::class)
->setMethods(
[
'exists',
'getSettings',
'create',
'delete',
'putMapping',
'deleteMapping',
'getMapping',
'stats',
'updateAliases',
'existsAlias',
'getAlias',
]
)
->disableOriginalConstructor()
->getMock();
$this->elasticsearchClientMock->expects($this->any())
->method('indices')
->willReturn($this->indicesMock);
$this->elasticsearchClientMock->expects($this->any())
->method('ping')
->willReturn(true);
$this->elasticsearchClientMock->expects($this->any())
->method('info')
->willReturn(['version' => ['number' => '7.0.0']]);
$this->objectManager = new ObjectManagerHelper($this);
$dynamicTemplatesProvider = new DynamicTemplatesProvider(
[
new PriceMapper(),
new PositionMapper(),
new StringMapper(),
new IntegerMapper(),
]
);
$this->model = $this->objectManager->getObject(
Elasticsearch::class,
[
'options' => $this->getOptions(),
'elasticsearchClient' => $this->elasticsearchClientMock,
'fieldsMappingPreprocessors' => [new AddDefaultSearchField()],
'dynamicTemplatesProvider' => $dynamicTemplatesProvider,
]
);
}
public function testConstructorOptionsException()
{
$this->expectException('Magento\Framework\Exception\LocalizedException');
$result = $this->objectManager->getObject(
Elasticsearch::class,
[
'options' => [],
]
);
$this->assertNotNull($result);
}
/**
* Test client creation from the list of options
*/
public function testConstructorWithOptions()
{
$result = $this->objectManager->getObject(
Elasticsearch::class,
[
'options' => $this->getOptions(),
]
);
$this->assertNotNull($result);
}
/**
* Ensure that configuration returns correct url.
*
* @param array $options
* @param string $expectedResult
* @throws LocalizedException
* @throws \ReflectionException
* @dataProvider getOptionsDataProvider
*/
public function testBuildConfig(array $options, $expectedResult): void
{
$buildConfig = new Elasticsearch($options);
$config = $this->getPrivateMethod(Elasticsearch::class, 'buildESConfig');
$result = $config->invoke($buildConfig, $options);
$this->assertEquals($expectedResult, $result['hosts'][0]);
}
/**
* Return private method for elastic search class.
*
* @param $className
* @param $methodName
* @return \ReflectionMethod
* @throws \ReflectionException
*/
private function getPrivateMethod($className, $methodName)
{
$reflector = new \ReflectionClass($className);
$method = $reflector->getMethod($methodName);
$method->setAccessible(true);
return $method;
}
/**
* Get options data provider.
*/
public function getOptionsDataProvider()
{
return [
[
'without_protocol' => [
'hostname' => 'localhost',
'port' => '9200',
'timeout' => 15,
'index' => 'magento2',
'enableAuth' => 0,
],
'expected_result' => 'http://localhost:9200',
],
[
'with_protocol' => [
'hostname' => 'https://localhost',
'port' => '9200',
'timeout' => 15,
'index' => 'magento2',
'enableAuth' => 0,
],
'expected_result' => 'https://localhost:9200',
],
];
}
/**
* Test ping functionality
*/
public function testPing()
{
$this->elasticsearchClientMock->expects($this->once())->method('ping')->willReturn(true);
$this->assertTrue($this->model->ping());
}
/**
* Test validation of connection parameters
*/
public function testTestConnection()
{
$this->elasticsearchClientMock->expects($this->once())->method('ping')->willReturn(true);
$this->assertTrue($this->model->testConnection());
}
/**
* Test validation of connection parameters returns false
*/
public function testTestConnectionFalse()
{
$this->elasticsearchClientMock->expects($this->once())->method('ping')->willReturn(false);
$this->assertTrue($this->model->testConnection());
}
/**
* Test validation of connection parameters
*/
public function testTestConnectionPing()
{
$this->model = $this->objectManager->getObject(
Elasticsearch::class,
[
'options' => $this->getEmptyIndexOption(),
'elasticsearchClient' => $this->elasticsearchClientMock,
]
);
$this->model->ping();
$this->assertTrue($this->model->testConnection());
}
/**
* Test bulkQuery() method
*/
public function testBulkQuery()
{
$this->elasticsearchClientMock->expects($this->once())
->method('bulk')
->with([]);
$this->model->bulkQuery([]);
}
/**
* Test createIndex() method, case when such index exists
*/
public function testCreateIndexExists()
{
$this->indicesMock->expects($this->once())
->method('create')
->with(
[
'index' => 'indexName',
'body' => [],
]
);
$this->model->createIndex('indexName', []);
}
/**
* Test deleteIndex() method.
*/
public function testDeleteIndex()
{
$this->indicesMock->expects($this->once())
->method('delete')
->with(['index' => 'indexName']);
$this->model->deleteIndex('indexName');
}
/**
* Test isEmptyIndex() method.
*/
public function testIsEmptyIndex()
{
$indexName = 'magento2_index';
$stats['indices'][$indexName]['primaries']['docs']['count'] = 0;
$this->indicesMock->expects($this->once())
->method('stats')
->with(['index' => $indexName, 'metric' => 'docs'])
->willReturn($stats);
$this->assertTrue($this->model->isEmptyIndex($indexName));
}
/**
* Test isEmptyIndex() method returns false.
*/
public function testIsEmptyIndexFalse()
{
$indexName = 'magento2_index';
$stats['indices'][$indexName]['primaries']['docs']['count'] = 1;
$this->indicesMock->expects($this->once())
->method('stats')
->with(['index' => $indexName, 'metric' => 'docs'])
->willReturn($stats);
$this->assertFalse($this->model->isEmptyIndex($indexName));
}
/**
* Test updateAlias() method with new index.
*/
public function testUpdateAlias()
{
$alias = 'alias1';
$index = 'index1';
$params['body']['actions'][] = ['add' => ['alias' => $alias, 'index' => $index]];
$this->indicesMock->expects($this->once())
->method('updateAliases')
->with($params);
$this->model->updateAlias($alias, $index);
}
/**
* Test updateAlias() method with new and old index.
*/
public function testUpdateAliasRemoveOldIndex()
{
$alias = 'alias1';
$newIndex = 'index1';
$oldIndex = 'indexOld';
$params['body']['actions'][] = ['remove' => ['alias' => $alias, 'index' => $oldIndex]];
$params['body']['actions'][] = ['add' => ['alias' => $alias, 'index' => $newIndex]];
$this->indicesMock->expects($this->once())
->method('updateAliases')
->with($params);
$this->model->updateAlias($alias, $newIndex, $oldIndex);
}
/**
* Test indexExists() method, case when no such index exists
*/
public function testIndexExists()
{
$this->indicesMock->expects($this->once())
->method('exists')
->with(['index' => 'indexName'])
->willReturn(true);
$this->model->indexExists('indexName');
}
/**
* Tests existsAlias() method checking for alias.
*/
public function testExistsAlias()
{
$alias = 'alias1';
$params = ['name' => $alias];
$this->indicesMock->expects($this->once())
->method('existsAlias')
->with($params)
->willReturn(true);
$this->assertTrue($this->model->existsAlias($alias));
}
/**
* Tests existsAlias() method checking for alias and index.
*/
public function testExistsAliasWithIndex()
{
$alias = 'alias1';
$index = 'index1';
$params = ['name' => $alias, 'index' => $index];
$this->indicesMock->expects($this->once())
->method('existsAlias')
->with($params)
->willReturn(true);
$this->assertTrue($this->model->existsAlias($alias, $index));
}
/**
* Test getAlias() method.
*/
public function testGetAlias()
{
$alias = 'alias1';
$params = ['name' => $alias];
$this->indicesMock->expects($this->once())
->method('getAlias')
->with($params)
->willReturn([]);
$this->assertEquals([], $this->model->getAlias($alias));
}
/**
* Test createIndexIfNotExists() method, case when operation fails
*/
public function testCreateIndexFailure()
{
$this->expectException('Exception');
$this->indicesMock->expects($this->once())
->method('create')
->with(
[
'index' => 'indexName',
'body' => [],
]
)
->willThrowException(new \Exception('Something went wrong'));
$this->model->createIndex('indexName', []);
}
/**
* Test testAddFieldsMapping() method
*/
public function testAddFieldsMapping()
{
$this->indicesMock->expects($this->once())
->method('putMapping')
->with(
[
'index' => 'indexName',
'type' => 'product',
'include_type_name' => true,
'body' => [
'product' => [
'properties' => [
'_search' => [
'type' => 'text',
],
'name' => [
'type' => 'text',
],
],
'dynamic_templates' => [
[
'price_mapping' => [
'match' => 'price_*',
'match_mapping_type' => 'string',
'mapping' => [
'type' => 'double',
'store' => true,
],
],
],
[
'position_mapping' => [
'match' => 'position_*',
'match_mapping_type' => 'string',
'mapping' => [
'type' => 'integer',
'index' => true,
],
],
],
[
'string_mapping' => [
'match' => '*',
'match_mapping_type' => 'string',
'mapping' => [
'type' => 'text',
'index' => true,
'copy_to' => '_search',
],
],
],
[
'integer_mapping' => [
'match_mapping_type' => 'long',
'mapping' => [
'type' => 'integer',
],
],
],
],
],
],
]
);
$this->model->addFieldsMapping(
[
'name' => [
'type' => 'text',
],
],
'indexName',
'product'
);
}
/**
* Test testAddFieldsMapping() method
*/
public function testAddFieldsMappingFailure()
{
$this->expectException('Exception');
$this->indicesMock->expects($this->once())
->method('putMapping')
->with(
[
'index' => 'indexName',
'type' => 'product',
'include_type_name' => true,
'body' => [
'product' => [
'properties' => [
'_search' => [
'type' => 'text',
],
'name' => [
'type' => 'text',
],
],
'dynamic_templates' => [
[
'price_mapping' => [
'match' => 'price_*',
'match_mapping_type' => 'string',
'mapping' => [
'type' => 'double',
'store' => true,
],
],
],
[
'position_mapping' => [
'match' => 'position_*',
'match_mapping_type' => 'string',
'mapping' => [
'type' => 'integer',
'index' => true,
],
],
],
[
'string_mapping' => [
'match' => '*',
'match_mapping_type' => 'string',
'mapping' => [
'type' => 'text',
'index' => true,
'copy_to' => '_search',
],
],
],
[
'integer_mapping' => [
'match_mapping_type' => 'long',
'mapping' => [
'type' => 'integer',
],
],
],
],
],
],
]
)
->willThrowException(new \Exception('Something went wrong'));
$this->model->addFieldsMapping(
[
'name' => [
'type' => 'text',
],
],
'indexName',
'product'
);
}
/**
* Test deleteMapping() method
*/
public function testDeleteMapping()
{
$this->indicesMock->expects($this->once())
->method('deleteMapping')
->with(
[
'index' => 'indexName',
'type' => 'product',
]
);
$this->model->deleteMapping(
'indexName',
'product'
);
}
/**
* Test deleteMapping() method
*/
public function testDeleteMappingFailure()
{
$this->expectException('Exception');
$this->indicesMock->expects($this->once())
->method('deleteMapping')
->with(
[
'index' => 'indexName',
'type' => 'product',
]
)
->willThrowException(new \Exception('Something went wrong'));
$this->model->deleteMapping(
'indexName',
'product'
);
}
/**
* Test get Elasticsearch mapping process.
*
* @return void
*/
public function testGetMapping(): void
{
$params = ['index' => 'indexName'];
$this->indicesMock->expects($this->once())
->method('getMapping')
->with($params)
->willReturn([]);
$this->model->getMapping($params);
}
/**
* Test query() method
*
* @return void
*/
public function testQuery()
{
$query = ['test phrase query'];
$this->elasticsearchClientMock->expects($this->once())
->method('search')
->with($query)
->willReturn([]);
$this->assertEquals([], $this->model->query($query));
}
/**
* Test suggest() method
*
* @return void
*/
public function testSuggest()
{
$query = ['query'];
$this->elasticsearchClientMock->expects($this->once())
->method('suggest')
->willReturn([]);
$this->assertEquals([], $this->model->suggest($query));
}
/**
* Get elasticsearch client options
*
* @return array
*/
protected function getOptions()
{
return [
'hostname' => 'localhost',
'port' => '9200',
'timeout' => 15,
'index' => 'magento2',
'enableAuth' => 1,
'username' => 'user',
'password' => 'passwd',
];
}
/**
* @return array
*/
private function getEmptyIndexOption()
{
return [
'hostname' => 'localhost',
'port' => '9200',
'index' => '',
'timeout' => 15,
'enableAuth' => 1,
'username' => 'user',
'password' => 'passwd',
];
}
}