mirror of
https://github.com/Codappix/search_core.git
synced 2024-12-22 18:16:11 +01:00
Merge remote-tracking branch 'origin/develop' into feature/switch-from-ttcontent-to-pages
This commit is contained in:
commit
36777c700b
15 changed files with 820 additions and 49 deletions
|
@ -87,7 +87,7 @@ class Facet implements FacetInterface
|
|||
}
|
||||
|
||||
foreach ($this->buckets as $bucket) {
|
||||
$this->options[] = new FacetOption($bucket);
|
||||
$this->options[$bucket['key']] = new FacetOption($bucket);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
@ -20,8 +20,11 @@ namespace Codappix\SearchCore\Connection\Elasticsearch;
|
|||
* 02110-1301, USA.
|
||||
*/
|
||||
|
||||
use Codappix\SearchCore\Configuration\ConfigurationContainerInterface;
|
||||
use Codappix\SearchCore\Configuration\InvalidArgumentException;
|
||||
use Elastica\Exception\ResponseException;
|
||||
use TYPO3\CMS\Core\SingletonInterface as Singleton;
|
||||
use TYPO3\CMS\Core\Utility\GeneralUtility;
|
||||
use TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface;
|
||||
|
||||
/**
|
||||
|
@ -31,6 +34,19 @@ use TYPO3\CMS\Extbase\Configuration\ConfigurationManagerInterface;
|
|||
*/
|
||||
class IndexFactory implements Singleton
|
||||
{
|
||||
/**
|
||||
* @var ConfigurationContainerInterface
|
||||
*/
|
||||
protected $configuration;
|
||||
|
||||
/**
|
||||
* @param ConfigurationContainerInterface $configuration
|
||||
*/
|
||||
public function __construct(ConfigurationContainerInterface $configuration)
|
||||
{
|
||||
$this->configuration = $configuration;
|
||||
}
|
||||
|
||||
/**
|
||||
* Get an index bases on TYPO3 table name.
|
||||
*
|
||||
|
@ -41,19 +57,52 @@ class IndexFactory implements Singleton
|
|||
*/
|
||||
public function getIndex(Connection $connection, $documentType)
|
||||
{
|
||||
// TODO: Fetch index name from configuration, based on $documentType.
|
||||
$index = $connection->getClient()->getIndex('typo3content');
|
||||
|
||||
try {
|
||||
// TODO: Provide configuration?!
|
||||
// http://elastica.io/getting-started/storing-and-indexing-documents.html#section-analysis
|
||||
$index->create();
|
||||
} catch (ResponseException $exception) {
|
||||
if (stripos($exception->getMessage(), 'already exists') === false) {
|
||||
throw $exception;
|
||||
}
|
||||
if ($index->exists() === false) {
|
||||
$index->create($this->getConfigurationFor($documentType));
|
||||
}
|
||||
|
||||
return $index;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string $documentType
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
protected function getConfigurationFor($documentType)
|
||||
{
|
||||
try {
|
||||
$configuration = $this->configuration->get('indexing.' . $documentType . '.index');
|
||||
|
||||
if (isset($configuration['analysis']['analyzer'])) {
|
||||
foreach ($configuration['analysis']['analyzer'] as $key => $analyzer) {
|
||||
$configuration['analysis']['analyzer'][$key] = $this->prepareAnalyzerConfiguration($analyzer);
|
||||
}
|
||||
}
|
||||
|
||||
return $configuration;
|
||||
} catch (InvalidArgumentException $e) {
|
||||
return [];
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array $analyzer
|
||||
*
|
||||
* @return array
|
||||
*/
|
||||
protected function prepareAnalyzerConfiguration(array $analyzer)
|
||||
{
|
||||
$fieldsToExplode = ['char_filter', 'filter'];
|
||||
|
||||
foreach ($fieldsToExplode as $fieldToExplode) {
|
||||
if (isset($analyzer[$fieldToExplode])) {
|
||||
$analyzer[$fieldToExplode] = GeneralUtility::trimExplode(',', $analyzer[$fieldToExplode], true);
|
||||
}
|
||||
}
|
||||
|
||||
return $analyzer;
|
||||
}
|
||||
}
|
||||
|
|
|
@ -53,7 +53,13 @@ class MappingFactory implements Singleton
|
|||
{
|
||||
$mapping = new \Elastica\Type\Mapping();
|
||||
$mapping->setType($type);
|
||||
$mapping->setProperties($this->getConfiguration($type->getName()));
|
||||
|
||||
$configuration = $this->getConfiguration($type->getName());
|
||||
if (isset($configuration['_all'])) {
|
||||
$mapping->setAllField($configuration['_all']);
|
||||
unset($configuration['_all']);
|
||||
}
|
||||
$mapping->setProperties($configuration);
|
||||
|
||||
return $mapping;
|
||||
}
|
||||
|
|
|
@ -140,7 +140,7 @@ class SearchResult implements SearchResultInterface
|
|||
}
|
||||
|
||||
foreach ($this->result->getAggregations() as $aggregationName => $aggregation) {
|
||||
$this->facets[] = $this->objectManager->get(Facet::class, $aggregationName, $aggregation);
|
||||
$this->facets[$aggregationName] = $this->objectManager->get(Facet::class, $aggregationName, $aggregation);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
|
|
@ -41,4 +41,11 @@ interface SearchRequestInterface
|
|||
* @return array
|
||||
*/
|
||||
public function getFilter();
|
||||
|
||||
/**
|
||||
* Defines how many results should be fetched.
|
||||
*
|
||||
* @return int
|
||||
*/
|
||||
public function getSize();
|
||||
}
|
||||
|
|
|
@ -110,8 +110,7 @@ abstract class AbstractIndexer implements IndexerInterface
|
|||
protected function getRecordGenerator()
|
||||
{
|
||||
$offset = 0;
|
||||
// TODO: Make configurable.
|
||||
$limit = 50;
|
||||
$limit = $this->getLimit();
|
||||
|
||||
while (($records = $this->getRecords($offset, $limit)) !== []) {
|
||||
yield $records;
|
||||
|
@ -145,6 +144,17 @@ abstract class AbstractIndexer implements IndexerInterface
|
|||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Returns the limit to use to fetch records.
|
||||
*
|
||||
* @return int
|
||||
*/
|
||||
protected function getLimit()
|
||||
{
|
||||
// TODO: Make configurable.
|
||||
return 50;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param int $offset
|
||||
* @param int $limit
|
||||
|
|
|
@ -35,6 +35,11 @@ class SearchRequest implements SearchRequestInterface
|
|||
*/
|
||||
protected $query = '';
|
||||
|
||||
/**
|
||||
* @var int
|
||||
*/
|
||||
protected $size = 10;
|
||||
|
||||
/**
|
||||
* @var array
|
||||
*/
|
||||
|
@ -112,4 +117,20 @@ class SearchRequest implements SearchRequestInterface
|
|||
{
|
||||
return $this->facets;
|
||||
}
|
||||
|
||||
/**
|
||||
* @return int
|
||||
*/
|
||||
public function getSize()
|
||||
{
|
||||
return $this->size;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param int $size
|
||||
*/
|
||||
public function setSize($size)
|
||||
{
|
||||
$this->size = (int) $size;
|
||||
}
|
||||
}
|
||||
|
|
|
@ -20,6 +20,8 @@ namespace Codappix\SearchCore\Domain\Search;
|
|||
* 02110-1301, USA.
|
||||
*/
|
||||
|
||||
use Codappix\SearchCore\Configuration\ConfigurationContainerInterface;
|
||||
use Codappix\SearchCore\Configuration\InvalidArgumentException;
|
||||
use Codappix\SearchCore\Connection\ConnectionInterface;
|
||||
use Codappix\SearchCore\Connection\Elasticsearch\Query;
|
||||
use Codappix\SearchCore\Connection\SearchRequestInterface;
|
||||
|
@ -32,6 +34,11 @@ class QueryFactory
|
|||
*/
|
||||
protected $logger;
|
||||
|
||||
/**
|
||||
* @var ConfigurationContainerInterface
|
||||
*/
|
||||
protected $configuration;
|
||||
|
||||
/**
|
||||
* @var array
|
||||
*/
|
||||
|
@ -39,13 +46,21 @@ class QueryFactory
|
|||
|
||||
/**
|
||||
* @param \TYPO3\CMS\Core\Log\LogManager $logManager
|
||||
* @param ConfigurationContainerInterface $configuration
|
||||
*/
|
||||
public function __construct(\TYPO3\CMS\Core\Log\LogManager $logManager)
|
||||
{
|
||||
public function __construct(
|
||||
\TYPO3\CMS\Core\Log\LogManager $logManager,
|
||||
ConfigurationContainerInterface $configuration
|
||||
) {
|
||||
$this->logger = $logManager->getLogger(__CLASS__);
|
||||
$this->configuration = $configuration;
|
||||
}
|
||||
|
||||
/**
|
||||
* TODO: This is not in scope Elasticsearch, therefore it should not return
|
||||
* \Elastica\Query, but decide to use a more specific QueryFactory like
|
||||
* ElasticaQueryFactory, once the second query is added?
|
||||
*
|
||||
* @param SearchRequestInterface $searchRequest
|
||||
*
|
||||
* @return \Elastica\Query
|
||||
|
@ -58,39 +73,103 @@ class QueryFactory
|
|||
/**
|
||||
* @param SearchRequestInterface $searchRequest
|
||||
*
|
||||
* TODO: This is not in scope Elasticsearch, therefore should not return elastica.
|
||||
* @return \Elastica\Query
|
||||
*/
|
||||
protected function createElasticaQuery(SearchRequestInterface $searchRequest)
|
||||
{
|
||||
$this->addSize($searchRequest);
|
||||
$this->addSearch($searchRequest);
|
||||
$this->addBoosts($searchRequest);
|
||||
$this->addFilter($searchRequest);
|
||||
$this->addFacets($searchRequest);
|
||||
|
||||
// Use last, as it might change structure of query.
|
||||
// Better approach would be something like DQL to generate query and build result in the end.
|
||||
$this->addFactorBoost();
|
||||
|
||||
$this->logger->debug('Generated elasticsearch query.', [$this->query]);
|
||||
return new \Elastica\Query($this->query);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param SearchRequestInterface $searchRequest
|
||||
*/
|
||||
protected function addSize(SearchRequestInterface $searchRequest)
|
||||
{
|
||||
$this->query = ArrayUtility::arrayMergeRecursiveOverrule($this->query, [
|
||||
'from' => 0,
|
||||
'size' => $searchRequest->getSize(),
|
||||
]);
|
||||
}
|
||||
|
||||
/**
|
||||
* @param SearchRequestInterface $searchRequest
|
||||
*/
|
||||
protected function addSearch(SearchRequestInterface $searchRequest)
|
||||
{
|
||||
$this->query = ArrayUtility::setValueByPath(
|
||||
$this->query,
|
||||
'query.bool.must.0.match._all.query',
|
||||
$searchRequest->getSearchTerm()
|
||||
);
|
||||
|
||||
$minimumShouldMatch = $this->configuration->getIfExists('searching.minimumShouldMatch');
|
||||
if ($minimumShouldMatch) {
|
||||
$this->query = ArrayUtility::setValueByPath(
|
||||
$this->query,
|
||||
'query.bool.must.0.match._all.minimum_should_match',
|
||||
$minimumShouldMatch
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @param SearchRequestInterface $searchRequest
|
||||
*/
|
||||
protected function addBoosts(SearchRequestInterface $searchRequest)
|
||||
{
|
||||
try {
|
||||
$fields = $this->configuration->get('searching.boost');
|
||||
} catch (InvalidArgumentException $e) {
|
||||
return;
|
||||
}
|
||||
|
||||
$boostQueryParts = [];
|
||||
|
||||
foreach ($fields as $fieldName => $boostValue) {
|
||||
$boostQueryParts[] = [
|
||||
'match' => [
|
||||
$fieldName => [
|
||||
'query' => $searchRequest->getSearchTerm(),
|
||||
'boost' => $boostValue,
|
||||
],
|
||||
],
|
||||
];
|
||||
}
|
||||
|
||||
$this->query = ArrayUtility::arrayMergeRecursiveOverrule($this->query, [
|
||||
'query' => [
|
||||
'bool' => [
|
||||
'must' => [
|
||||
[
|
||||
'match' => [
|
||||
'_all' => $searchRequest->getSearchTerm()
|
||||
],
|
||||
],
|
||||
],
|
||||
'should' => $boostQueryParts,
|
||||
],
|
||||
],
|
||||
]);
|
||||
}
|
||||
|
||||
protected function addFactorBoost()
|
||||
{
|
||||
try {
|
||||
$this->query['query'] = [
|
||||
'function_score' => [
|
||||
'query' => $this->query['query'],
|
||||
'field_value_factor' => $this->configuration->get('searching.fieldValueFactor'),
|
||||
],
|
||||
];
|
||||
} catch (InvalidArgumentException $e) {
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* @param SearchRequestInterface $searchRequest
|
||||
*/
|
||||
|
|
|
@ -69,11 +69,24 @@ class SearchService
|
|||
*/
|
||||
public function search(SearchRequestInterface $searchRequest)
|
||||
{
|
||||
$this->addSize($searchRequest);
|
||||
$this->addConfiguredFacets($searchRequest);
|
||||
|
||||
return $this->connection->search($searchRequest);
|
||||
}
|
||||
|
||||
/**
|
||||
* Add configured size of search result items to request.
|
||||
*
|
||||
* @param SearchRequestInterface $searchRequest
|
||||
*/
|
||||
protected function addSize(SearchRequestInterface $searchRequest)
|
||||
{
|
||||
$searchRequest->setSize(
|
||||
$this->configuration->getIfExists('searching.size') ?: 10
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* Add facets from configuration to request.
|
||||
*
|
||||
|
|
|
@ -204,11 +204,60 @@ options are available:
|
|||
makes building a facet possible.
|
||||
|
||||
|
||||
.. _index:
|
||||
|
||||
``index``
|
||||
"""""""""
|
||||
|
||||
Used by: Elasticsearch connection while indexing.
|
||||
|
||||
Define index for Elasticsearch, have a look at the official docs: https://www.elastic.co/guide/en/elasticsearch/reference/5.2/indices-create-index.html
|
||||
|
||||
Example::
|
||||
|
||||
plugin.tx_searchcore.settings.indexing.tt_content.index {
|
||||
analysis {
|
||||
analyzer {
|
||||
ngram4 {
|
||||
type = custom
|
||||
tokenizer = ngram4
|
||||
char_filter = html_strip
|
||||
filter = lowercase, asciifolding
|
||||
}
|
||||
}
|
||||
|
||||
tokenizer {
|
||||
ngram4 {
|
||||
type = ngram
|
||||
min_gram = 4
|
||||
max_gram = 4
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
``char_filter`` and ``filter`` are a comma separated list of options.
|
||||
|
||||
.. _configuration_options_search:
|
||||
|
||||
Searching
|
||||
^^^^^^^^^
|
||||
|
||||
.. _size:
|
||||
|
||||
``size``
|
||||
""""""""
|
||||
|
||||
Used by: Elasticsearch connection while building search query.
|
||||
|
||||
Defined how many search results should be fetched to be available in search result.
|
||||
|
||||
Example::
|
||||
|
||||
plugin.tx_searchcore.settings.searching.size = 50
|
||||
|
||||
Default if not configured is 10.
|
||||
|
||||
.. _facets:
|
||||
|
||||
``facets``
|
||||
|
@ -229,3 +278,54 @@ Searching
|
|||
|
||||
The above example will provide a facet with options for all found ``CType`` results together
|
||||
with a count.
|
||||
|
||||
.. _minimumShouldMatch:
|
||||
|
||||
``minimumShouldMatch``
|
||||
""""""""""""""""""""""
|
||||
|
||||
Used by: Elasticsearch connection while building search query.
|
||||
|
||||
Define the minimum match for Elasticsearch, have a look at the official docs: https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-minimum-should-match.html
|
||||
|
||||
Example::
|
||||
|
||||
plugin.tx_searchcore.settings.searching.minimumShouldMatch = 50%
|
||||
|
||||
.. _boost:
|
||||
|
||||
``boost``
|
||||
"""""""""
|
||||
|
||||
Used by: Elasticsearch connection while building search query.
|
||||
|
||||
Define fields that should boost the score for results.
|
||||
|
||||
Example::
|
||||
|
||||
plugin.tx_searchcore.settings.searching.boost {
|
||||
search_title = 3
|
||||
search_abstract = 1.5
|
||||
}
|
||||
|
||||
For further information take a look at
|
||||
https://www.elastic.co/guide/en/elasticsearch/guide/2.x/_boosting_query_clauses.html
|
||||
|
||||
.. _fieldValueFactor:
|
||||
|
||||
``fieldValueFactor``
|
||||
""""""""""""""""""""
|
||||
|
||||
Used by: Elasticsearch connection while building search query.
|
||||
|
||||
Define a field to use as a factor for scoring. The configuration is passed through to elastic
|
||||
search ``field_value_factor``, see: https://www.elastic.co/guide/en/elasticsearch/reference/5.2/query-dsl-function-score-query.html#function-field-value-factor
|
||||
|
||||
Example::
|
||||
|
||||
plugin.tx_searchcore.settings.searching.field_value_factor {
|
||||
field = rootlineLevel
|
||||
modifier = reciprocal
|
||||
factor = 2
|
||||
missing = 1
|
||||
}
|
||||
|
|
|
@ -78,16 +78,16 @@ class FilterTest extends AbstractFunctionalTestCase
|
|||
|
||||
$this->assertSame(1, count($result->getFacets()), 'Did not receive the single defined facet.');
|
||||
|
||||
$facet = $result->getFacets()[0];
|
||||
$facet = current($result->getFacets());
|
||||
$this->assertSame('contentTypes', $facet->getName(), 'Name of facet was not as expected.');
|
||||
$this->assertSame('CType', $facet->getField(), 'Field of facet was not expected.');
|
||||
|
||||
$options = $facet->getOptions();
|
||||
$this->assertSame(2, count($options), 'Did not receive the expected number of possible options for facet.');
|
||||
$option = $options[0];
|
||||
$option = $options['HTML'];
|
||||
$this->assertSame('HTML', $option->getName(), 'Option did not have expected Name.');
|
||||
$this->assertSame(1, $option->getCount(), 'Option did not have expected count.');
|
||||
$option = $options[1];
|
||||
$option = $options['Header'];
|
||||
$this->assertSame('Header', $option->getName(), 'Option did not have expected Name.');
|
||||
$this->assertSame(1, $option->getCount(), 'Option did not have expected count.');
|
||||
}
|
||||
|
|
132
Tests/Unit/Connection/Elasticsearch/IndexFactoryTest.php
Normal file
132
Tests/Unit/Connection/Elasticsearch/IndexFactoryTest.php
Normal file
|
@ -0,0 +1,132 @@
|
|||
<?php
|
||||
namespace Codappix\SearchCore\Tests\Unit\Connection\Elasticsearch;
|
||||
|
||||
/*
|
||||
* Copyright (C) 2017 Daniel Siepmann <coding@daniel-siepmann.de>
|
||||
*
|
||||
* This program is free software; you can redistribute it and/or
|
||||
* modify it under the terms of the GNU General Public License
|
||||
* as published by the Free Software Foundation; either version 2
|
||||
* of the License, or (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with this program; if not, write to the Free Software
|
||||
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
|
||||
* 02110-1301, USA.
|
||||
*/
|
||||
|
||||
use Codappix\SearchCore\Configuration\ConfigurationContainerInterface;
|
||||
use Codappix\SearchCore\Connection\Elasticsearch\Connection;
|
||||
use Codappix\SearchCore\Connection\Elasticsearch\IndexFactory;
|
||||
use Codappix\SearchCore\Tests\Unit\AbstractUnitTestCase;
|
||||
|
||||
class IndexFactoryTest extends AbstractUnitTestCase
|
||||
{
|
||||
/**
|
||||
* @var IndexFactory
|
||||
*/
|
||||
protected $subject;
|
||||
|
||||
public function setUp()
|
||||
{
|
||||
parent::setUp();
|
||||
|
||||
$this->configuration = $this->getMockBuilder(ConfigurationContainerInterface::class)->getMock();
|
||||
$this->subject = new IndexFactory($this->configuration);
|
||||
}
|
||||
|
||||
/**
|
||||
* @test
|
||||
*/
|
||||
public function indexIsNotCreatedIfAlreadyExisting()
|
||||
{
|
||||
$indexMock = $this->getMockBuilder(\Elastica\Index::class)
|
||||
->disableOriginalConstructor()
|
||||
->getMock();
|
||||
$indexMock->expects($this->once())
|
||||
->method('exists')
|
||||
->willReturn(true);
|
||||
$indexMock->expects($this->never())
|
||||
->method('create');
|
||||
$clientMock = $this->getMockBuilder(\Elastica\Client::class)
|
||||
->disableOriginalConstructor()
|
||||
->getMock();
|
||||
$clientMock->expects($this->once())
|
||||
->method('getIndex')
|
||||
->with('typo3content')
|
||||
->willReturn($indexMock);
|
||||
$connection = $this->getMockBuilder(Connection::class)
|
||||
->disableOriginalConstructor()
|
||||
->getMock();
|
||||
$connection->expects($this->once())
|
||||
->method('getClient')
|
||||
->willReturn($clientMock);
|
||||
|
||||
$this->subject->getIndex($connection, 'someIndex');
|
||||
}
|
||||
|
||||
/**
|
||||
* @test
|
||||
*/
|
||||
public function typoScriptConfigurationIsProvidedToIndex()
|
||||
{
|
||||
$configuration = [
|
||||
'analysis' => [
|
||||
'analyzer' => [
|
||||
'ngram4' => [
|
||||
'type' => 'custom',
|
||||
'tokenizer' => 'ngram4',
|
||||
'char_filter' => 'html_strip',
|
||||
'filter' => 'lowercase, , asciifolding',
|
||||
],
|
||||
],
|
||||
'tokenizer' => [
|
||||
'ngram4' => [
|
||||
'type' => 'ngram',
|
||||
'min_gram' => 4,
|
||||
'max_gram' => 4,
|
||||
],
|
||||
],
|
||||
],
|
||||
];
|
||||
|
||||
$expectedConfiguration = $configuration;
|
||||
$expectedConfiguration['analysis']['analyzer']['ngram4']['char_filter'] = ['html_strip'];
|
||||
$expectedConfiguration['analysis']['analyzer']['ngram4']['filter'] = ['lowercase', 'asciifolding'];
|
||||
|
||||
$indexMock = $this->getMockBuilder(\Elastica\Index::class)
|
||||
->disableOriginalConstructor()
|
||||
->getMock();
|
||||
$indexMock->expects($this->once())
|
||||
->method('exists')
|
||||
->willReturn(false);
|
||||
$indexMock->expects($this->once())
|
||||
->method('create')
|
||||
->with($expectedConfiguration);
|
||||
$clientMock = $this->getMockBuilder(\Elastica\Client::class)
|
||||
->disableOriginalConstructor()
|
||||
->getMock();
|
||||
$clientMock->expects($this->once())
|
||||
->method('getIndex')
|
||||
->with('typo3content')
|
||||
->willReturn($indexMock);
|
||||
$connection = $this->getMockBuilder(Connection::class)
|
||||
->disableOriginalConstructor()
|
||||
->getMock();
|
||||
$connection->expects($this->once())
|
||||
->method('getClient')
|
||||
->willReturn($clientMock);
|
||||
|
||||
$this->configuration->expects($this->once())
|
||||
->method('get')
|
||||
->with('indexing.someIndex.index')
|
||||
->willReturn($configuration);
|
||||
|
||||
$this->subject->getIndex($connection, 'someIndex');
|
||||
}
|
||||
}
|
86
Tests/Unit/Connection/Elasticsearch/MappingFactoryTest.php
Normal file
86
Tests/Unit/Connection/Elasticsearch/MappingFactoryTest.php
Normal file
|
@ -0,0 +1,86 @@
|
|||
<?php
|
||||
namespace Codappix\SearchCore\Tests\Unit\Connection\Elasticsearch;
|
||||
|
||||
/*
|
||||
* Copyright (C) 2017 Daniel Siepmann <coding@daniel-siepmann.de>
|
||||
*
|
||||
* This program is free software; you can redistribute it and/or
|
||||
* modify it under the terms of the GNU General Public License
|
||||
* as published by the Free Software Foundation; either version 2
|
||||
* of the License, or (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with this program; if not, write to the Free Software
|
||||
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
|
||||
* 02110-1301, USA.
|
||||
*/
|
||||
|
||||
use Codappix\SearchCore\Configuration\ConfigurationContainerInterface;
|
||||
use Codappix\SearchCore\Connection\Elasticsearch\MappingFactory;
|
||||
use Codappix\SearchCore\Tests\Unit\AbstractUnitTestCase;
|
||||
|
||||
class MappingFactoryTest extends AbstractUnitTestCase
|
||||
{
|
||||
/**
|
||||
* @var MappingFactory
|
||||
*/
|
||||
protected $subject;
|
||||
|
||||
public function setUp()
|
||||
{
|
||||
parent::setUp();
|
||||
|
||||
$this->configuration = $this->getMockBuilder(ConfigurationContainerInterface::class)->getMock();
|
||||
$this->subject = new MappingFactory($this->configuration);
|
||||
}
|
||||
|
||||
/**
|
||||
* @test
|
||||
*/
|
||||
public function typoScriptConfigurationIsProvidedToIndex()
|
||||
{
|
||||
$indexName = 'someIndex';
|
||||
$configuration = [
|
||||
'_all' => [
|
||||
'type' => 'text',
|
||||
'analyzer' => 'ngram4',
|
||||
],
|
||||
'channel' => [
|
||||
'type' => 'keyword',
|
||||
],
|
||||
];
|
||||
$type = $this->getMockBuilder(\Elastica\Type::class)
|
||||
->disableOriginalConstructor()
|
||||
->getMock();
|
||||
$type->expects($this->any())
|
||||
->method('getName')
|
||||
->willReturn($indexName);
|
||||
$this->configuration->expects($this->once())
|
||||
->method('get')
|
||||
->with('indexing.' . $indexName . '.mapping')
|
||||
->willReturn($configuration);
|
||||
|
||||
$mapping = $this->subject->getMapping($type)->toArray()[$indexName];
|
||||
$this->assertArraySubset(
|
||||
[
|
||||
'_all' => $configuration['_all']
|
||||
],
|
||||
$mapping,
|
||||
true,
|
||||
'Configuration of _all field was not set for mapping.'
|
||||
);
|
||||
$this->assertArraySubset(
|
||||
[
|
||||
'channel' => $configuration['channel']
|
||||
],
|
||||
$mapping['properties'],
|
||||
true,
|
||||
'Configuration for properties was not set for mapping.'
|
||||
);
|
||||
}
|
||||
}
|
|
@ -20,6 +20,8 @@ namespace Codappix\SearchCore\Tests\Unit\Domain\Search;
|
|||
* 02110-1301, USA.
|
||||
*/
|
||||
|
||||
use Codappix\SearchCore\Configuration\ConfigurationContainerInterface;
|
||||
use Codappix\SearchCore\Configuration\InvalidArgumentException;
|
||||
use Codappix\SearchCore\Domain\Model\FacetRequest;
|
||||
use Codappix\SearchCore\Domain\Model\SearchRequest;
|
||||
use Codappix\SearchCore\Domain\Search\QueryFactory;
|
||||
|
@ -32,11 +34,17 @@ class QueryFactoryTest extends AbstractUnitTestCase
|
|||
*/
|
||||
protected $subject;
|
||||
|
||||
/**
|
||||
* @var ConfigurationContainerInterface
|
||||
*/
|
||||
protected $configuration;
|
||||
|
||||
public function setUp()
|
||||
{
|
||||
parent::setUp();
|
||||
|
||||
$this->subject = new QueryFactory($this->getMockedLogger());
|
||||
$this->configuration = $this->getMockBuilder(ConfigurationContainerInterface::class)->getMock();
|
||||
$this->subject = new QueryFactory($this->getMockedLogger(), $this->configuration);
|
||||
}
|
||||
|
||||
/**
|
||||
|
@ -46,6 +54,10 @@ class QueryFactoryTest extends AbstractUnitTestCase
|
|||
{
|
||||
$searchRequest = new SearchRequest('SearchWord');
|
||||
|
||||
$this->configuration->expects($this->any())
|
||||
->method('get')
|
||||
->will($this->throwException(new InvalidArgumentException));
|
||||
|
||||
$query = $this->subject->create($searchRequest);
|
||||
$this->assertInstanceOf(
|
||||
\Elastica\Query::class,
|
||||
|
@ -59,6 +71,10 @@ class QueryFactoryTest extends AbstractUnitTestCase
|
|||
*/
|
||||
public function filterIsAddedToQuery()
|
||||
{
|
||||
$this->configuration->expects($this->any())
|
||||
->method('get')
|
||||
->will($this->throwException(new InvalidArgumentException));
|
||||
|
||||
$searchRequest = new SearchRequest('SearchWord');
|
||||
$searchRequest->setFilter(['field' => 'content']);
|
||||
|
||||
|
@ -77,6 +93,10 @@ class QueryFactoryTest extends AbstractUnitTestCase
|
|||
*/
|
||||
public function emptyFilterIsNotAddedToQuery()
|
||||
{
|
||||
$this->configuration->expects($this->any())
|
||||
->method('get')
|
||||
->will($this->throwException(new InvalidArgumentException));
|
||||
|
||||
$searchRequest = new SearchRequest('SearchWord');
|
||||
$searchRequest->setFilter([
|
||||
'field' => '',
|
||||
|
@ -97,32 +117,14 @@ class QueryFactoryTest extends AbstractUnitTestCase
|
|||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* @test
|
||||
*/
|
||||
public function userInputIsAlwaysString()
|
||||
{
|
||||
$searchRequest = new SearchRequest(10);
|
||||
$searchRequest->setFilter(['field' => 20]);
|
||||
|
||||
$query = $this->subject->create($searchRequest);
|
||||
$this->assertSame(
|
||||
'10',
|
||||
$query->toArray()['query']['bool']['must'][0]['match']['_all'],
|
||||
'Search word was not escaped as expected.'
|
||||
);
|
||||
$this->assertSame(
|
||||
'20',
|
||||
$query->toArray()['query']['bool']['filter'][0]['term']['field'],
|
||||
'Search word was not escaped as expected.'
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* @test
|
||||
*/
|
||||
public function facetsAreAddedToQuery()
|
||||
{
|
||||
$this->configuration->expects($this->any())
|
||||
->method('get')
|
||||
->will($this->throwException(new InvalidArgumentException));
|
||||
$searchRequest = new SearchRequest('SearchWord');
|
||||
$searchRequest->addFacet(new FacetRequest('Identifier', 'FieldName'));
|
||||
$searchRequest->addFacet(new FacetRequest('Identifier 2', 'FieldName 2'));
|
||||
|
@ -145,4 +147,175 @@ class QueryFactoryTest extends AbstractUnitTestCase
|
|||
'Facets were not added to query.'
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* @test
|
||||
*/
|
||||
public function sizeIsAddedToQuery()
|
||||
{
|
||||
$this->configuration->expects($this->any())
|
||||
->method('get')
|
||||
->will($this->throwException(new InvalidArgumentException));
|
||||
$searchRequest = new SearchRequest('SearchWord');
|
||||
$searchRequest->setSize(45);
|
||||
|
||||
$query = $this->subject->create($searchRequest);
|
||||
$this->assertSame(
|
||||
45,
|
||||
$query->toArray()['size'],
|
||||
'Size was not added to query.'
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* @test
|
||||
*/
|
||||
public function searchTermIsAddedToQuery()
|
||||
{
|
||||
$searchRequest = new SearchRequest('SearchWord');
|
||||
$this->configuration->expects($this->any())
|
||||
->method('get')
|
||||
->will($this->throwException(new InvalidArgumentException));
|
||||
$query = $this->subject->create($searchRequest);
|
||||
|
||||
$this->assertSame(
|
||||
[
|
||||
'bool' => [
|
||||
'must' => [
|
||||
[
|
||||
'match' => [
|
||||
'_all' => [
|
||||
'query' => 'SearchWord',
|
||||
],
|
||||
],
|
||||
],
|
||||
],
|
||||
],
|
||||
],
|
||||
$query->toArray()['query'],
|
||||
'Search term was not added to query as expected.'
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* @test
|
||||
*/
|
||||
public function minimumShouldMatchIsAddedToQuery()
|
||||
{
|
||||
$searchRequest = new SearchRequest('SearchWord');
|
||||
$this->configuration->expects($this->once())
|
||||
->method('getIfExists')
|
||||
->with('searching.minimumShouldMatch')
|
||||
->willReturn('50%');
|
||||
$this->configuration->expects($this->any())
|
||||
->method('get')
|
||||
->will($this->throwException(new InvalidArgumentException));
|
||||
$query = $this->subject->create($searchRequest);
|
||||
|
||||
$this->assertArraySubset(
|
||||
[
|
||||
'bool' => [
|
||||
'must' => [
|
||||
[
|
||||
'match' => [
|
||||
'_all' => [
|
||||
'minimum_should_match' => '50%',
|
||||
],
|
||||
],
|
||||
],
|
||||
],
|
||||
],
|
||||
],
|
||||
$query->toArray()['query'],
|
||||
'minimum_should_match was not added to query as configured.'
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* @test
|
||||
*/
|
||||
public function boostsAreAddedToQuery()
|
||||
{
|
||||
$searchRequest = new SearchRequest('SearchWord');
|
||||
|
||||
$this->configuration->expects($this->exactly(2))
|
||||
->method('get')
|
||||
->withConsecutive(['searching.boost'], ['searching.fieldValueFactor'])
|
||||
->will($this->onConsecutiveCalls(
|
||||
[
|
||||
'search_title' => 3,
|
||||
'search_abstract' => 1.5,
|
||||
],
|
||||
$this->throwException(new InvalidArgumentException)
|
||||
));
|
||||
|
||||
$query = $this->subject->create($searchRequest);
|
||||
$this->assertSame(
|
||||
[
|
||||
[
|
||||
'match' => [
|
||||
'search_title' => [
|
||||
'query' => 'SearchWord',
|
||||
'boost' => 3,
|
||||
],
|
||||
],
|
||||
],
|
||||
[
|
||||
'match' => [
|
||||
'search_abstract' => [
|
||||
'query' => 'SearchWord',
|
||||
'boost' => 1.5,
|
||||
],
|
||||
],
|
||||
],
|
||||
],
|
||||
$query->toArray()['query']['bool']['should'],
|
||||
'Boosts were not added to query.'
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* @test
|
||||
*/
|
||||
public function factorBoostIsAddedToQuery()
|
||||
{
|
||||
$searchRequest = new SearchRequest('SearchWord');
|
||||
$fieldConfig = [
|
||||
'field' => 'rootlineLevel',
|
||||
'modifier' => 'reciprocal',
|
||||
'factor' => '2',
|
||||
'missing' => '1',
|
||||
];
|
||||
$this->configuration->expects($this->exactly(2))
|
||||
->method('get')
|
||||
->withConsecutive(['searching.boost'], ['searching.fieldValueFactor'])
|
||||
->will($this->onConsecutiveCalls(
|
||||
$this->throwException(new InvalidArgumentException),
|
||||
$fieldConfig
|
||||
));
|
||||
|
||||
$query = $this->subject->create($searchRequest);
|
||||
$this->assertSame(
|
||||
[
|
||||
'function_score' => [
|
||||
'query' => [
|
||||
'bool' => [
|
||||
'must' => [
|
||||
[
|
||||
'match' => [
|
||||
'_all' => [
|
||||
'query' => 'SearchWord',
|
||||
],
|
||||
],
|
||||
],
|
||||
],
|
||||
],
|
||||
],
|
||||
'field_value_factor' => $fieldConfig,
|
||||
],
|
||||
],
|
||||
$query->toArray()['query'],
|
||||
'Boosts were not added to query.'
|
||||
);
|
||||
}
|
||||
}
|
||||
|
|
95
Tests/Unit/Domain/Search/SearchServiceTest.php
Normal file
95
Tests/Unit/Domain/Search/SearchServiceTest.php
Normal file
|
@ -0,0 +1,95 @@
|
|||
<?php
|
||||
namespace Copyright\SearchCore\Tests\Unit\Domain\Search;
|
||||
|
||||
/*
|
||||
* Copyright (C) 2017 Daniel Siepmann <coding@daniel-siepmann.de>
|
||||
*
|
||||
* This program is free software; you can redistribute it and/or
|
||||
* modify it under the terms of the GNU General Public License
|
||||
* as published by the Free Software Foundation; either version 2
|
||||
* of the License, or (at your option) any later version.
|
||||
*
|
||||
* This program is distributed in the hope that it will be useful,
|
||||
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
* GNU General Public License for more details.
|
||||
*
|
||||
* You should have received a copy of the GNU General Public License
|
||||
* along with this program; if not, write to the Free Software
|
||||
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
|
||||
* 02110-1301, USA.
|
||||
*/
|
||||
|
||||
use Codappix\SearchCore\Configuration\ConfigurationContainerInterface;
|
||||
use Codappix\SearchCore\Connection\ConnectionInterface;
|
||||
use Codappix\SearchCore\Domain\Model\SearchRequest;
|
||||
use Codappix\SearchCore\Domain\Search\SearchService;
|
||||
use Codappix\SearchCore\Tests\Unit\AbstractUnitTestCase;
|
||||
use TYPO3\CMS\Extbase\Object\ObjectManagerInterface;
|
||||
|
||||
class SearchServiceTest extends AbstractUnitTestCase
|
||||
{
|
||||
/**
|
||||
* @var SearchService
|
||||
*/
|
||||
protected $subject;
|
||||
|
||||
public function setUp()
|
||||
{
|
||||
parent::setUp();
|
||||
|
||||
$this->connection = $this->getMockBuilder(ConnectionInterface::class)
|
||||
->disableOriginalConstructor()
|
||||
->getMock();
|
||||
$this->configuration = $this->getMockBuilder(ConfigurationContainerInterface::class)
|
||||
->disableOriginalConstructor()
|
||||
->getMock();
|
||||
$this->objectManager = $this->getMockBuilder(ObjectManagerInterface::class)
|
||||
->disableOriginalConstructor()
|
||||
->getMock();
|
||||
|
||||
$this->subject = new SearchService(
|
||||
$this->connection,
|
||||
$this->configuration,
|
||||
$this->objectManager
|
||||
);
|
||||
}
|
||||
|
||||
/**
|
||||
* @test
|
||||
*/
|
||||
public function sizeIsAddedFromConfiguration()
|
||||
{
|
||||
$this->configuration->expects($this->exactly(2))
|
||||
->method('getIfExists')
|
||||
->withConsecutive(['searching.size'], ['searching.facets'])
|
||||
->will($this->onConsecutiveCalls(45, null));
|
||||
$this->connection->expects($this->once())
|
||||
->method('search')
|
||||
->with($this->callback(function ($searchRequest) {
|
||||
return $searchRequest->getSize() === 45;
|
||||
}));
|
||||
|
||||
$searchRequest = new SearchRequest('SearchWord');
|
||||
$this->subject->search($searchRequest);
|
||||
}
|
||||
|
||||
/**
|
||||
* @test
|
||||
*/
|
||||
public function defaultSizeIsAddedIfNothingIsConfigured()
|
||||
{
|
||||
$this->configuration->expects($this->exactly(2))
|
||||
->method('getIfExists')
|
||||
->withConsecutive(['searching.size'], ['searching.facets'])
|
||||
->will($this->onConsecutiveCalls(null, null));
|
||||
$this->connection->expects($this->once())
|
||||
->method('search')
|
||||
->with($this->callback(function ($searchRequest) {
|
||||
return $searchRequest->getSize() === 10;
|
||||
}));
|
||||
|
||||
$searchRequest = new SearchRequest('SearchWord');
|
||||
$this->subject->search($searchRequest);
|
||||
}
|
||||
}
|
Loading…
Reference in a new issue