class SearchMatchTest
Same name in other branches
- 8.9.x core/modules/search/tests/src/Kernel/SearchMatchTest.php \Drupal\Tests\search\Kernel\SearchMatchTest
- 10 core/modules/search/tests/src/Kernel/SearchMatchTest.php \Drupal\Tests\search\Kernel\SearchMatchTest
- 11.x core/modules/search/tests/src/Kernel/SearchMatchTest.php \Drupal\Tests\search\Kernel\SearchMatchTest
Indexes content and queries it.
@group search
Hierarchy
- class \Drupal\KernelTests\KernelTestBase extends \PHPUnit\Framework\TestCase implements \Drupal\Core\DependencyInjection\ServiceProviderInterface uses \Drupal\KernelTests\AssertLegacyTrait, \Drupal\KernelTests\AssertContentTrait, \Drupal\Tests\RandomGeneratorTrait, \Drupal\Tests\ConfigTestTrait, \Drupal\Tests\ExtensionListTestTrait, \Drupal\Tests\TestRequirementsTrait, \Drupal\Tests\Traits\PhpUnitWarnings, \Drupal\Tests\PhpUnitCompatibilityTrait, \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait
- class \Drupal\Tests\search\Kernel\SearchMatchTest extends \Drupal\KernelTests\KernelTestBase
Expanded class hierarchy of SearchMatchTest
File
-
core/
modules/ search/ tests/ src/ Kernel/ SearchMatchTest.php, line 16
Namespace
Drupal\Tests\search\KernelView source
class SearchMatchTest extends KernelTestBase {
// The search index can contain different types of content. Typically the type
// is 'node'. Here we test with _test_ and _test2_ as the type.
const SEARCH_TYPE = '_test_';
const SEARCH_TYPE_2 = '_test2_';
const SEARCH_TYPE_JPN = '_test3_';
/**
* Modules to enable.
*
* @var array
*/
protected static $modules = [
'search',
];
/**
* {@inheritdoc}
*/
protected function setUp() : void {
parent::setUp();
$this->installSchema('search', [
'search_index',
'search_dataset',
'search_total',
]);
$this->installConfig([
'search',
]);
}
/**
* Tests search indexing.
*/
public function testMatching() {
$this->_setup();
$this->_testQueries();
}
/**
* Set up a small index of items to test against.
*/
public function _setup() {
$this->config('search.settings')
->set('index.minimum_word_size', 3)
->save();
$search_index = \Drupal::service('search.index');
assert($search_index instanceof SearchIndexInterface);
for ($i = 1; $i <= 7; ++$i) {
$search_index->index(static::SEARCH_TYPE, $i, LanguageInterface::LANGCODE_NOT_SPECIFIED, $this->getText($i));
}
for ($i = 1; $i <= 5; ++$i) {
$search_index->index(static::SEARCH_TYPE_2, $i + 7, LanguageInterface::LANGCODE_NOT_SPECIFIED, $this->getText2($i));
}
// No getText builder function for Japanese text; just a simple array.
foreach ([
13 => '以呂波耳・ほへとち。リヌルヲ。',
14 => 'ドルーパルが大好きよ!',
15 => 'コーヒーとケーキ',
] as $i => $jpn) {
$search_index->index(static::SEARCH_TYPE_JPN, $i, LanguageInterface::LANGCODE_NOT_SPECIFIED, $jpn);
}
}
/**
* _test_: Helper method for generating snippets of content.
*
* Generated items to test against:
* 1 ipsum
* 2 dolore sit
* 3 sit am ut
* 4 am ut enim am
* 5 ut enim am minim veniam
* 6 enim am minim veniam es cillum
* 7 am minim veniam es cillum dolore eu
*/
public function getText($n) {
$words = explode(' ', "Ipsum dolore sit am. Ut enim am minim veniam. Es cillum dolore eu.");
return implode(' ', array_slice($words, $n - 1, $n));
}
/**
* _test2_: Helper method for generating snippets of content.
*
* Generated items to test against:
* 8 dear
* 9 king philip
* 10 philip came over
* 11 came over from germany
* 12 over from germany swimming
*/
public function getText2($n) {
$words = explode(' ', "Dear King Philip came over from Germany swimming.");
return implode(' ', array_slice($words, $n - 1, $n));
}
/**
* Run predefine queries looking for indexed terms.
*/
public function _testQueries() {
// Note: OR queries that include short words in OR groups are only accepted
// if the ORed terms are ANDed with at least one long word in the rest of
// the query. Examples:
// - enim dolore OR ut = enim (dolore OR ut) = (enim dolor) OR (enim ut)
// is good, and
// - dolore OR ut = (dolore) OR (ut)
// is bad. This is a design limitation to avoid full table scans.
$queries = [
// Simple AND queries.
'ipsum' => [
1,
],
'enim' => [
4,
5,
6,
],
'xxxxx' => [],
'enim minim' => [
5,
6,
],
'enim xxxxx' => [],
'dolore eu' => [
7,
],
'dolore xx' => [],
'ut minim' => [
5,
],
'xx minim' => [],
'enim veniam am minim ut' => [
5,
],
// Simple OR and AND/OR queries.
'dolore OR ipsum' => [
1,
2,
7,
],
'dolore OR xxxxx' => [
2,
7,
],
'dolore OR ipsum OR enim' => [
1,
2,
4,
5,
6,
7,
],
'ipsum OR dolore sit OR cillum' => [
2,
7,
],
'minim dolore OR ipsum' => [
7,
],
'dolore OR ipsum veniam' => [
7,
],
'minim dolore OR ipsum OR enim' => [
5,
6,
7,
],
'dolore xx OR yy' => [],
'xxxxx dolore OR ipsum' => [],
// Sequence of OR queries.
'minim' => [
5,
6,
7,
],
'minim OR xxxx' => [
5,
6,
7,
],
'minim OR xxxx OR minim' => [
5,
6,
7,
],
'minim OR xxxx minim' => [
5,
6,
7,
],
'minim OR xxxx minim OR yyyy' => [
5,
6,
7,
],
'minim OR xxxx minim OR cillum' => [
6,
7,
5,
],
'minim OR xxxx minim OR xxxx' => [
5,
6,
7,
],
// Negative queries.
'dolore -sit' => [
7,
],
'dolore -eu' => [
2,
],
'dolore -xxxxx' => [
2,
7,
],
'dolore -xx' => [
2,
7,
],
// Phrase queries.
'"dolore sit"' => [
2,
],
'"sit dolore"' => [],
'"am minim veniam es"' => [
6,
7,
],
'"minim am veniam es"' => [],
// Mixed queries.
'"am minim veniam es" OR dolore' => [
2,
6,
7,
],
'"minim am veniam es" OR "dolore sit"' => [
2,
],
'"minim am veniam es" OR "sit dolore"' => [],
'"am minim veniam es" -eu' => [
6,
],
'"am minim veniam" -"cillum dolore"' => [
5,
6,
],
'"am minim veniam" -"dolore cillum"' => [
5,
6,
7,
],
'xxxxx "minim am veniam es" OR dolore' => [],
'xx "minim am veniam es" OR dolore' => [],
];
$connection = Database::getConnection();
foreach ($queries as $query => $results) {
$result = $connection->select('search_index', 'i')
->extend(SearchQuery::class)
->searchExpression($query, static::SEARCH_TYPE)
->execute();
$set = $result ? $result->fetchAll() : [];
$this->_testQueryMatching($query, $set, $results);
$this->_testQueryScores($query, $set, $results);
}
// These queries are run against the second index type, SEARCH_TYPE_2.
$queries = [
// Simple AND queries.
'ipsum' => [],
'enim' => [],
'enim minim' => [],
'dear' => [
8,
],
'germany' => [
11,
12,
],
];
foreach ($queries as $query => $results) {
$result = $connection->select('search_index', 'i')
->extend(SearchQuery::class)
->searchExpression($query, static::SEARCH_TYPE_2)
->execute();
$set = $result ? $result->fetchAll() : [];
$this->_testQueryMatching($query, $set, $results);
$this->_testQueryScores($query, $set, $results);
}
// These queries are run against the third index type, SEARCH_TYPE_JPN.
$queries = [
// Simple AND queries.
'呂波耳' => [
13,
],
'以呂波耳' => [
13,
],
'ほへと ヌルヲ' => [
13,
],
'とちリ' => [],
'ドルーパル' => [
14,
],
'パルが大' => [
14,
],
'コーヒー' => [
15,
],
'ヒーキ' => [],
];
foreach ($queries as $query => $results) {
$result = $connection->select('search_index', 'i')
->extend(SearchQuery::class)
->searchExpression($query, static::SEARCH_TYPE_JPN)
->execute();
$set = $result ? $result->fetchAll() : [];
$this->_testQueryMatching($query, $set, $results);
$this->_testQueryScores($query, $set, $results);
}
}
/**
* Tests the matching abilities of the engine.
*
* Verify if a query produces the correct results.
*/
public function _testQueryMatching($query, $set, $results) {
// Get result IDs.
$found = [];
foreach ($set as $item) {
$found[] = $item->sid;
}
// Compare $results and $found.
sort($found);
sort($results);
$this->assertEquals($found, $results, "Query matching '{$query}'");
}
/**
* Tests the scoring abilities of the engine.
*
* Verify if a query produces normalized, monotonous scores.
*/
public function _testQueryScores($query, $set, $results) {
// Get result scores.
$scores = [];
foreach ($set as $item) {
$scores[] = $item->calculated_score;
}
// Check order.
$sorted = $scores;
sort($sorted);
$this->assertEquals($scores, array_reverse($sorted), "Query order '{$query}'");
// Check range.
$this->assertTrue(!count($scores) || min($scores) > 0.0 && max($scores) <= 1.0001, "Query scoring '{$query}'");
}
}
Members
Title Sort descending | Deprecated | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|---|
AssertContentTrait::$content | protected | property | The current raw content. | |||
AssertContentTrait::$drupalSettings | protected | property | The drupalSettings value from the current raw $content. | |||
AssertContentTrait::$elements | protected | property | The XML structure parsed from the current raw $content. | 1 | ||
AssertContentTrait::$plainTextContent | protected | property | The plain-text content of raw $content (text nodes). | |||
AssertContentTrait::assertEscaped | protected | function | Passes if the raw text IS found escaped on the loaded page, fail otherwise. | |||
AssertContentTrait::assertField | protected | function | Asserts that a field exists with the given name or ID. | |||
AssertContentTrait::assertFieldById | protected | function | Asserts that a field exists with the given ID and value. | |||
AssertContentTrait::assertFieldByName | protected | function | Asserts that a field exists with the given name and value. | |||
AssertContentTrait::assertFieldByXPath | protected | function | Asserts that a field exists in the current page by the given XPath. | |||
AssertContentTrait::assertFieldChecked | protected | function | Asserts that a checkbox field in the current page is checked. | |||
AssertContentTrait::assertFieldsByValue | protected | function | Asserts that a field exists in the current page with a given Xpath result. | |||
AssertContentTrait::assertLink | protected | function | Passes if a link with the specified label is found. | |||
AssertContentTrait::assertLinkByHref | protected | function | Passes if a link containing a given href (part) is found. | |||
AssertContentTrait::assertNoDuplicateIds | protected | function | Asserts that each HTML ID is used for just a single element. | |||
AssertContentTrait::assertNoEscaped | protected | function | Passes if raw text IS NOT found escaped on loaded page, fail otherwise. | |||
AssertContentTrait::assertNoField | protected | function | Asserts that a field does not exist with the given name or ID. | |||
AssertContentTrait::assertNoFieldById | protected | function | Asserts that a field does not exist with the given ID and value. | |||
AssertContentTrait::assertNoFieldByName | protected | function | Asserts that a field does not exist with the given name and value. | |||
AssertContentTrait::assertNoFieldByXPath | protected | function | Asserts that a field does not exist or its value does not match, by XPath. | |||
AssertContentTrait::assertNoFieldChecked | protected | function | Asserts that a checkbox field in the current page is not checked. | |||
AssertContentTrait::assertNoLink | protected | function | Passes if a link with the specified label is not found. | |||
AssertContentTrait::assertNoLinkByHref | protected | function | Passes if a link containing a given href (part) is not found. | |||
AssertContentTrait::assertNoLinkByHrefInMainRegion | protected | function | Passes if a link containing a given href is not found in the main region. | |||
AssertContentTrait::assertNoOption | protected | function | Asserts that a select option in the current page does not exist. | |||
AssertContentTrait::assertNoOptionSelected | protected | function | Asserts that a select option in the current page is not checked. | |||
AssertContentTrait::assertNoPattern | protected | function | Triggers a pass if the perl regex pattern is not found in raw content. | |||
AssertContentTrait::assertNoRaw | protected | function | Passes if the raw text is NOT found on the loaded page, fail otherwise. | |||
AssertContentTrait::assertNoText | protected | function | Passes if the page (with HTML stripped) does not contains the text. | |||
AssertContentTrait::assertNoTitle | protected | function | Pass if the page title is not the given string. | |||
AssertContentTrait::assertNoUniqueText | protected | function | Passes if the text is found MORE THAN ONCE on the text version of the page. | |||
AssertContentTrait::assertOption | protected | function | Asserts that a select option in the current page exists. | |||
AssertContentTrait::assertOptionByText | protected | function | Asserts that a select option with the visible text exists. | |||
AssertContentTrait::assertOptionSelected | protected | function | Asserts that a select option in the current page is checked. | |||
AssertContentTrait::assertOptionSelectedWithDrupalSelector | protected | function | Asserts that a select option in the current page is checked. | |||
AssertContentTrait::assertOptionWithDrupalSelector | protected | function | Asserts that a select option in the current page exists. | |||
AssertContentTrait::assertPattern | protected | function | Triggers a pass if the Perl regex pattern is found in the raw content. | |||
AssertContentTrait::assertRaw | protected | function | Passes if the raw text IS found on the loaded page, fail otherwise. | |||
AssertContentTrait::assertText | protected | function | Passes if the page (with HTML stripped) contains the text. | |||
AssertContentTrait::assertTextHelper | protected | function | Helper for assertText and assertNoText. | |||
AssertContentTrait::assertTextPattern | protected | function | Asserts that a Perl regex pattern is found in the plain-text content. | |||
AssertContentTrait::assertThemeOutput | protected | function | Asserts themed output. | |||
AssertContentTrait::assertTitle | protected | function | Pass if the page title is the given string. | |||
AssertContentTrait::assertUniqueText | protected | function | Passes if the text is found ONLY ONCE on the text version of the page. | |||
AssertContentTrait::assertUniqueTextHelper | protected | function | Helper for assertUniqueText and assertNoUniqueText. | |||
AssertContentTrait::buildXPathQuery | protected | function | Builds an XPath query. | |||
AssertContentTrait::constructFieldXpath | protected | function | Helper: Constructs an XPath for the given set of attributes and value. | |||
AssertContentTrait::cssSelect | protected | function | Searches elements using a CSS selector in the raw content. | |||
AssertContentTrait::getAllOptions | protected | function | Get all option elements, including nested options, in a select. | |||
AssertContentTrait::getDrupalSettings | protected | function | Gets the value of drupalSettings for the currently-loaded page. | |||
AssertContentTrait::getRawContent | protected | function | Gets the current raw content. | |||
AssertContentTrait::getSelectedItem | protected | function | Get the selected value from a select field. | |||
AssertContentTrait::getTextContent | protected | function | Retrieves the plain-text content from the current raw content. | |||
AssertContentTrait::getUrl | protected | function | Get the current URL from the cURL handler. | 1 | ||
AssertContentTrait::parse | protected | function | Parse content returned from curlExec using DOM and SimpleXML. | |||
AssertContentTrait::removeWhiteSpace | protected | function | Removes all white-space between HTML tags from the raw content. | |||
AssertContentTrait::setDrupalSettings | protected | function | Sets the value of drupalSettings for the currently-loaded page. | |||
AssertContentTrait::setRawContent | protected | function | Sets the raw content (e.g. HTML). | |||
AssertContentTrait::xpath | protected | function | Performs an xpath search on the contents of the internal browser. | |||
AssertLegacyTrait::assert | Deprecated | protected | function | |||
AssertLegacyTrait::assertEqual | Deprecated | protected | function | |||
AssertLegacyTrait::assertIdentical | Deprecated | protected | function | |||
AssertLegacyTrait::assertIdenticalObject | Deprecated | protected | function | |||
AssertLegacyTrait::assertNotEqual | Deprecated | protected | function | |||
AssertLegacyTrait::assertNotIdentical | Deprecated | protected | function | |||
AssertLegacyTrait::pass | Deprecated | protected | function | |||
AssertLegacyTrait::verbose | Deprecated | protected | function | |||
ConfigTestTrait::configImporter | protected | function | Returns a ConfigImporter object to import test configuration. | |||
ConfigTestTrait::copyConfig | protected | function | Copies configuration objects from source storage to target storage. | |||
ExtensionListTestTrait::getModulePath | protected | function | Gets the path for the specified module. | |||
ExtensionListTestTrait::getThemePath | protected | function | Gets the path for the specified theme. | |||
KernelTestBase::$backupGlobals | protected | property | Back up and restore any global variables that may be changed by tests. | |||
KernelTestBase::$backupStaticAttributes | protected | property | Back up and restore static class properties that may be changed by tests. | |||
KernelTestBase::$backupStaticAttributesBlacklist | protected | property | Contains a few static class properties for performance. | |||
KernelTestBase::$classLoader | protected | property | ||||
KernelTestBase::$configImporter | protected | property | @todo Move into Config test base class. | 6 | ||
KernelTestBase::$configSchemaCheckerExclusions | protected static | property | An array of config object names that are excluded from schema checking. | |||
KernelTestBase::$container | protected | property | ||||
KernelTestBase::$databasePrefix | protected | property | ||||
KernelTestBase::$keyValue | protected | property | The key_value service that must persist between container rebuilds. | |||
KernelTestBase::$preserveGlobalState | protected | property | Do not forward any global state from the parent process to the processes that run the actual tests. |
|||
KernelTestBase::$root | protected | property | The app root. | |||
KernelTestBase::$runTestInSeparateProcess | protected | property | Kernel tests are run in separate processes because they allow autoloading of code from extensions. Running the test in a separate process isolates this behavior from other tests. Subclasses should not override this property. |
|||
KernelTestBase::$siteDirectory | protected | property | ||||
KernelTestBase::$strictConfigSchema | protected | property | Set to TRUE to strict check all configuration saved. | 7 | ||
KernelTestBase::$vfsRoot | protected | property | The virtual filesystem root directory. | |||
KernelTestBase::assertPostConditions | protected | function | 1 | |||
KernelTestBase::bootEnvironment | protected | function | Bootstraps a basic test environment. | |||
KernelTestBase::bootKernel | private | function | Bootstraps a kernel for a test. | |||
KernelTestBase::config | protected | function | Configuration accessor for tests. Returns non-overridden configuration. | |||
KernelTestBase::disableModules | protected | function | Disables modules for this test. | |||
KernelTestBase::enableModules | protected | function | Enables modules for this test. | |||
KernelTestBase::getConfigSchemaExclusions | protected | function | Gets the config schema exclusions for this test. | |||
KernelTestBase::getDatabaseConnectionInfo | protected | function | Returns the Database connection info to be used for this test. | 3 | ||
KernelTestBase::getDatabasePrefix | public | function | ||||
KernelTestBase::getExtensionsForModules | private | function | Returns Extension objects for $modules to enable. | |||
KernelTestBase::getModulesToEnable | private static | function | Returns the modules to enable for this test. | |||
KernelTestBase::initFileCache | protected | function | Initializes the FileCache component. | |||
KernelTestBase::installConfig | protected | function | Installs default configuration for a given list of modules. | |||
KernelTestBase::installEntitySchema | protected | function | Installs the storage schema for a specific entity type. | |||
KernelTestBase::installSchema | protected | function | Installs database tables from a module schema definition. | |||
KernelTestBase::register | public | function | Registers test-specific services. | Overrides ServiceProviderInterface::register | 26 | |
KernelTestBase::render | protected | function | Renders a render array. | 1 | ||
KernelTestBase::setInstallProfile | protected | function | Sets the install profile and rebuilds the container to update it. | |||
KernelTestBase::setSetting | protected | function | Sets an in-memory Settings variable. | |||
KernelTestBase::setUpBeforeClass | public static | function | 1 | |||
KernelTestBase::setUpFilesystem | protected | function | Sets up the filesystem, so things like the file directory. | 3 | ||
KernelTestBase::stop | protected | function | Stops test execution. | |||
KernelTestBase::tearDown | protected | function | 5 | |||
KernelTestBase::tearDownCloseDatabaseConnection | public | function | @after | |||
KernelTestBase::vfsDump | protected | function | Dumps the current state of the virtual filesystem to STDOUT. | |||
KernelTestBase::__sleep | public | function | Prevents serializing any properties. | |||
PhpUnitWarnings::$deprecationWarnings | private static | property | Deprecation warnings from PHPUnit to raise with @trigger_error(). | |||
PhpUnitWarnings::addWarning | public | function | Converts PHPUnit deprecation warnings to E_USER_DEPRECATED. | |||
RandomGeneratorTrait::$randomGenerator | protected | property | The random generator. | |||
RandomGeneratorTrait::getRandomGenerator | protected | function | Gets the random generator for the utility methods. | |||
RandomGeneratorTrait::randomMachineName | protected | function | Generates a unique random string containing letters and numbers. | 1 | ||
RandomGeneratorTrait::randomObject | public | function | Generates a random PHP object. | |||
RandomGeneratorTrait::randomString | public | function | Generates a pseudo-random string of ASCII characters of codes 32 to 126. | |||
RandomGeneratorTrait::randomStringValidate | public | function | Callback for random string validation. | |||
SearchMatchTest::$modules | protected static | property | Modules to enable. | Overrides KernelTestBase::$modules | ||
SearchMatchTest::getText | public | function | _test_: Helper method for generating snippets of content. | |||
SearchMatchTest::getText2 | public | function | _test2_: Helper method for generating snippets of content. | |||
SearchMatchTest::SEARCH_TYPE | constant | |||||
SearchMatchTest::SEARCH_TYPE_2 | constant | |||||
SearchMatchTest::SEARCH_TYPE_JPN | constant | |||||
SearchMatchTest::setUp | protected | function | Overrides KernelTestBase::setUp | |||
SearchMatchTest::testMatching | public | function | Tests search indexing. | |||
SearchMatchTest::_setup | public | function | Set up a small index of items to test against. | |||
SearchMatchTest::_testQueries | public | function | Run predefine queries looking for indexed terms. | |||
SearchMatchTest::_testQueryMatching | public | function | Tests the matching abilities of the engine. | |||
SearchMatchTest::_testQueryScores | public | function | Tests the scoring abilities of the engine. | |||
StorageCopyTrait::replaceStorageContents | protected static | function | Copy the configuration from one storage to another and remove stale items. | |||
TestRequirementsTrait::checkModuleRequirements | private | function | Checks missing module requirements. | |||
TestRequirementsTrait::checkRequirements | protected | function | Check module requirements for the Drupal use case. | |||
TestRequirementsTrait::getDrupalRoot | protected static | function | Returns the Drupal root directory. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.