View source
<?php
namespace Drupal\Tests\search\Functional;
use Drupal\Core\Link;
use Drupal\Core\Url;
use Drupal\search\Entity\SearchPage;
use Drupal\Tests\BrowserTestBase;
class SearchConfigSettingsFormTest extends BrowserTestBase {
protected static $modules = [
'block',
'dblog',
'node',
'search',
'search_extra_type',
'test_page_test',
];
protected $defaultTheme = 'stark';
protected $searchUser;
protected $searchNode;
protected function setUp() : void {
parent::setUp();
$this
->drupalCreateContentType([
'type' => 'page',
'name' => 'Basic page',
]);
$this->searchUser = $this
->drupalCreateUser([
'search content',
'administer search',
'administer nodes',
'bypass node access',
'access user profiles',
'administer users',
'administer blocks',
'access site reports',
]);
$this
->drupalLogin($this->searchUser);
$node = $this
->drupalCreateNode();
$this->searchNode = $node;
$body_key = 'body[0][value]';
$edit[$body_key] = Link::fromTextAndUrl($node
->label(), $node
->toUrl())
->toString() . ' pizza sandwich';
$this
->drupalGet('node/' . $node
->id() . '/edit');
$this
->submitForm($edit, 'Save');
$this->container
->get('plugin.manager.search')
->createInstance('node_search')
->updateIndex();
$this
->drupalPlaceBlock('search_form_block');
$this
->drupalPlaceBlock('local_tasks_block', [
'id' => 'local_tasks',
]);
$this
->drupalPlaceBlock('page_title_block');
}
public function testSearchSettingsPage() {
$this
->drupalGet('admin/config/search/pages');
$this
->assertSession()
->pageTextContains('There are 0 items left to index.');
$this
->drupalGet('admin/config/search/pages');
$this
->submitForm([], 'Re-index site');
$this
->assertSession()
->pageTextContains('Are you sure you want to re-index the site');
$this
->drupalGet('admin/config/search/pages/reindex');
$this
->submitForm([], 'Re-index site');
$this
->assertSession()
->statusMessageContains('All search indexes will be rebuilt', 'status');
$this
->drupalGet('admin/config/search/pages');
$this
->assertSession()
->pageTextContains('There is 1 item left to index.');
$this
->drupalGet('admin/config/search/pages');
$this
->submitForm([], 'Save configuration');
$this
->assertSession()
->statusMessageContains('The configuration options have been saved.', 'status');
$edit = [
'minimum_word_size' => $this
->randomMachineName(3),
];
$this
->drupalGet('admin/config/search/pages');
$this
->submitForm($edit, 'Save configuration');
$this
->assertSession()
->statusMessageNotContains('The configuration options have been saved.');
$this
->assertSession()
->statusMessageContains('Minimum word length to index must be a number.', 'error');
$text = $this
->randomMachineName(5);
$this
->drupalGet('search/node');
$this
->submitForm([
'keys' => $text,
], 'Search');
$this
->drupalGet('admin/reports/dblog');
$this
->assertSession()
->linkNotExists('Searched Content for ' . $text . '.', 'Search was not logged');
$edit = [
'logging' => TRUE,
];
$this
->drupalGet('admin/config/search/pages');
$this
->submitForm($edit, 'Save configuration');
$text = $this
->randomMachineName(5);
$this
->drupalGet('search/node');
$this
->submitForm([
'keys' => $text,
], 'Search');
$this
->drupalGet('admin/reports/dblog');
$this
->assertSession()
->linkExists('Searched Content for ' . $text . '.', 0, 'Search was logged');
}
public function testSearchModuleSettingsPage() {
$this
->drupalGet('admin/config/search/pages');
$this
->clickLink('Edit', 1);
$this
->assertTrue($this
->assertSession()
->optionExists('edit-extra-type-settings-boost', 'bi')
->isSelected());
$edit = [
'extra_type_settings[boost]' => 'ii',
];
$this
->submitForm($edit, 'Save search page');
$this
->assertSession()
->statusMessageContains("The Dummy search type search page has been updated.", 'status');
$this
->drupalGet('admin/config/search/pages/manage/dummy_search_type');
$this
->assertTrue($this
->assertSession()
->optionExists('edit-extra-type-settings-boost', 'ii')
->isSelected());
}
public function testSearchModuleDisabling() {
$plugin_info = [
'node_search' => [
'keys' => 'pizza',
'text' => $this->searchNode
->label(),
],
'user_search' => [
'keys' => $this->searchUser
->getAccountName(),
'text' => $this->searchUser
->getEmail(),
],
'dummy_search_type' => [
'keys' => 'foo',
'text' => 'Dummy search snippet to display',
],
];
$plugins = array_keys($plugin_info);
$entities = SearchPage::loadMultiple();
foreach ($entities as $entity) {
$entity
->disable()
->save();
}
foreach ($entities as $entity_id => $entity) {
$this
->setDefaultThroughUi($entity_id);
$info = $plugin_info[$entity_id];
$this
->drupalGet('search/' . $entity
->getPath(), [
'query' => [
'keys' => $info['keys'],
],
]);
$this
->assertSession()
->statusCodeEquals(200);
$this
->assertSession()
->pageTextNotContains('no results');
$this
->assertSession()
->pageTextContains($info['text']);
foreach ($plugins as $other) {
if ($other != $entity_id) {
$path = 'search/' . $entities[$other]
->getPath();
$this
->assertSession()
->elementNotExists('xpath', '//div[@id="block-local-tasks"]//li/a[@data-drupal-link-system-path="' . $path . '"]');
}
}
$terms = [
'keys' => $info['keys'],
];
$this
->drupalGet('node');
$this
->submitForm($terms, 'Search');
$current = $this
->getURL();
$expected = Url::fromRoute('search.view_' . $entity
->id(), [], [
'query' => [
'keys' => $info['keys'],
],
'absolute' => TRUE,
])
->toString();
$this
->assertEquals($expected, $current, 'Block redirected to right search page');
$this
->drupalGet('search/not_a_plugin_path');
$this
->assertSession()
->statusCodeEquals(404);
$entity
->disable()
->save();
}
$this
->setDefaultThroughUi('node_search');
foreach ($entities as $entity) {
$entity
->enable()
->save();
}
\Drupal::service('router.builder')
->rebuild();
$paths = [
[
'path' => 'search/node',
'options' => [
'query' => [
'keys' => 'pizza',
],
],
],
[
'path' => 'search/node',
'options' => [],
],
];
foreach ($paths as $item) {
$this
->drupalGet($item['path'], $item['options']);
foreach ($plugins as $entity_id) {
$path = 'search/' . $entities[$entity_id]
->getPath();
$label = $entities[$entity_id]
->label();
$this
->assertSession()
->elementTextContains('xpath', '//div[@id="block-local-tasks"]//li/a[@data-drupal-link-system-path="' . $path . '"]', $label);
}
}
}
public function testDefaultSearchPageOrdering() {
$this
->drupalGet('search');
$elements = $this
->xpath('//div[@id="block-local-tasks"]//a');
$this
->assertSame(Url::fromRoute('search.view_node_search')
->toString(), $elements[0]
->getAttribute('href'));
$this
->assertSame(Url::fromRoute('search.view_dummy_search_type')
->toString(), $elements[1]
->getAttribute('href'));
$this
->assertSame(Url::fromRoute('search.view_user_search')
->toString(), $elements[2]
->getAttribute('href'));
}
public function testMultipleSearchPages() {
$this
->assertDefaultSearch('node_search', 'The default page is set to the installer default.');
$search_storage = \Drupal::entityTypeManager()
->getStorage('search_page');
$entities = $search_storage
->loadMultiple();
$search_storage
->delete($entities);
$this
->assertDefaultSearch(FALSE);
$this
->drupalGet('admin/config/search/pages');
$this
->assertSession()
->pageTextContains('No search pages have been configured.');
$edit = [];
$edit['search_type'] = 'search_extra_type_search';
$this
->submitForm($edit, 'Add search page');
$this
->assertSession()
->titleEquals('Add new search page | Drupal');
$first = [];
$first['label'] = $this
->randomString();
$first_id = $first['id'] = strtolower($this
->randomMachineName(8));
$first['path'] = strtolower($this
->randomMachineName(8));
$this
->submitForm($first, 'Save');
$this
->assertDefaultSearch($first_id, 'The default page matches the only search page.');
$this
->assertSession()
->statusMessageContains("The {$first['label']} search page has been added.", 'status');
$edit = [];
$edit['search_type'] = 'search_extra_type_search';
$this
->submitForm($edit, 'Add search page');
$edit = [];
$edit['label'] = $this
->randomString();
$edit['id'] = strtolower($this
->randomMachineName(8));
$edit['path'] = $first['path'];
$this
->submitForm($edit, 'Save');
$this
->assertSession()
->statusMessageContains('The search page path must be unique.', 'error');
$second = [];
$second['label'] = $this
->randomString();
$second_id = $second['id'] = strtolower($this
->randomMachineName(8));
$second['path'] = strtolower($this
->randomMachineName(8));
$this
->submitForm($second, 'Save');
$this
->assertDefaultSearch($first_id, 'The default page matches the only search page.');
$this
->drupalGet('search');
$elements = $this
->xpath('//div[@id="block-local-tasks"]//a');
$this
->assertSame(Url::fromRoute('search.view_' . $first_id)
->toString(), $elements[0]
->getAttribute('href'));
$this
->assertSame(Url::fromRoute('search.view_' . $second_id)
->toString(), $elements[1]
->getAttribute('href'));
$edit = [
'entities[' . $first_id . '][weight]' => 10,
'entities[' . $second_id . '][weight]' => -10,
];
$this
->drupalGet('admin/config/search/pages');
$this
->submitForm($edit, 'Save configuration');
$this
->drupalGet('search');
$elements = $this
->xpath('//div[@id="block-local-tasks"]//a');
$this
->assertSame(Url::fromRoute('search.view_' . $second_id)
->toString(), $elements[0]
->getAttribute('href'));
$this
->assertSame(Url::fromRoute('search.view_' . $first_id)
->toString(), $elements[1]
->getAttribute('href'));
$this
->drupalGet('admin/config/search/pages');
$this
->verifySearchPageOperations($first_id, TRUE, FALSE, FALSE, FALSE);
$this
->verifySearchPageOperations($second_id, TRUE, TRUE, TRUE, FALSE);
$this
->clickLink('Set as default');
$this
->assertSession()
->statusMessageContains("The default search page is now {$second['label']}. Be sure to check the ordering of your search pages.", 'status');
$this
->verifySearchPageOperations($first_id, TRUE, TRUE, TRUE, FALSE);
$this
->verifySearchPageOperations($second_id, TRUE, FALSE, FALSE, FALSE);
$this
->clickLink('Disable');
$this
->assertSession()
->statusCodeEquals(200);
$this
->assertSession()
->linkNotExists('Disable');
$this
->verifySearchPageOperations($first_id, TRUE, TRUE, FALSE, TRUE);
$this
->verifySearchPageOperations($second_id, TRUE, FALSE, FALSE, FALSE);
$this
->clickLink('Enable');
$this
->assertSession()
->statusCodeEquals(200);
$this
->verifySearchPageOperations($first_id, TRUE, TRUE, TRUE, FALSE);
$this
->verifySearchPageOperations($second_id, TRUE, FALSE, FALSE, FALSE);
$this
->clickLink('Delete');
$this
->assertSession()
->pageTextContains("Are you sure you want to delete the search page {$first['label']}?");
$this
->submitForm([], 'Delete');
$this
->assertSession()
->statusMessageContains("The search page {$first['label']} has been deleted.", 'status');
$this
->verifySearchPageOperations($first_id, FALSE, FALSE, FALSE, FALSE);
}
public function testRouteProtection() {
$this
->drupalGet('admin/config/search/pages/manage/node_search/enable');
$this
->assertSession()
->statusCodeEquals(403);
$this
->drupalGet('admin/config/search/pages/manage/node_search/disable');
$this
->assertSession()
->statusCodeEquals(403);
$this
->drupalGet('admin/config/search/pages/manage/node_search/set-default');
$this
->assertSession()
->statusCodeEquals(403);
}
protected function verifySearchPageOperations($id, $edit, $delete, $disable, $enable) {
if ($edit) {
$this
->assertSession()
->linkByHrefExists("admin/config/search/pages/manage/{$id}");
}
else {
$this
->assertSession()
->linkByHrefNotExists("admin/config/search/pages/manage/{$id}");
}
if ($delete) {
$this
->assertSession()
->linkByHrefExists("admin/config/search/pages/manage/{$id}/delete");
}
else {
$this
->assertSession()
->linkByHrefNotExists("admin/config/search/pages/manage/{$id}/delete");
}
if ($disable) {
$this
->assertSession()
->linkByHrefExists("admin/config/search/pages/manage/{$id}/disable");
}
else {
$this
->assertSession()
->linkByHrefNotExists("admin/config/search/pages/manage/{$id}/disable");
}
if ($enable) {
$this
->assertSession()
->linkByHrefExists("admin/config/search/pages/manage/{$id}/enable");
}
else {
$this
->assertSession()
->linkByHrefNotExists("admin/config/search/pages/manage/{$id}/enable");
}
}
protected function assertDefaultSearch($expected, string $message = '') : void {
$search_page_repository = \Drupal::service('search.search_page_repository');
$this
->assertSame($expected, $search_page_repository
->getDefaultSearchPage(), $message);
}
protected function setDefaultThroughUi($entity_id) {
$this
->drupalGet('admin/config/search/pages');
preg_match('|href="([^"]+' . $entity_id . '/set-default[^"]+)"|', $this
->getSession()
->getPage()
->getContent(), $matches);
$this
->drupalGet($this
->getAbsoluteUrl($matches[1]));
}
}