This repository has been archived on 2025-01-19. You can view files and clone it, but you cannot make any changes to it's state, such as pushing and creating new issues, pull requests or comments.
drupalcampbristol/core/modules/search/src/Tests/SearchRankingTest.php

280 lines
10 KiB
PHP

<?php
/**
* @file
* Contains \Drupal\search\Tests\SearchRankingTest.
*/
namespace Drupal\search\Tests;
use Drupal\comment\Plugin\Field\FieldType\CommentItemInterface;
use Drupal\comment\Tests\CommentTestTrait;
use Drupal\Core\Url;
/**
* Indexes content and tests ranking factors.
*
* @group search
*/
class SearchRankingTest extends SearchTestBase {
use CommentTestTrait;
/**
* The node search page.
*
* @var \Drupal\search\SearchPageInterface
*/
protected $nodeSearch;
/**
* Modules to enable.
*
* @var array
*/
public static $modules = array('statistics', 'comment');
protected function setUp() {
parent::setUp();
// Create a plugin instance.
$this->nodeSearch = entity_load('search_page', 'node_search');
// Login with sufficient privileges.
$this->drupalLogin($this->drupalCreateUser(array('post comments', 'skip comment approval', 'create page content', 'administer search')));
}
public function testRankings() {
// Add a comment field.
$this->addDefaultCommentField('node', 'page');
// Build a list of the rankings to test.
$node_ranks = array('sticky', 'promote', 'relevance', 'recent', 'comments', 'views');
// Create nodes for testing.
$nodes = array();
foreach ($node_ranks as $node_rank) {
$settings = array(
'type' => 'page',
'comment' => array(array(
'status' => CommentItemInterface::HIDDEN,
)),
'title' => 'Drupal rocks',
'body' => array(array('value' => "Drupal's search rocks")),
// Node is one day old.
'created' => REQUEST_TIME - 24 * 3600,
'sticky' => 0,
'promote' => 0,
);
foreach (array(0, 1) as $num) {
if ($num == 1) {
switch ($node_rank) {
case 'sticky':
case 'promote':
$settings[$node_rank] = 1;
break;
case 'relevance':
$settings['body'][0]['value'] .= " really rocks";
break;
case 'recent':
// Node is 1 hour hold.
$settings['created'] = REQUEST_TIME - 3600;
break;
case 'comments':
$settings['comment'][0]['status'] = CommentItemInterface::OPEN;
break;
}
}
$nodes[$node_rank][$num] = $this->drupalCreateNode($settings);
}
}
// Add a comment to one of the nodes.
$edit = array();
$edit['subject[0][value]'] = 'my comment title';
$edit['comment_body[0][value]'] = 'some random comment';
$this->drupalGet('comment/reply/node/' . $nodes['comments'][1]->id() . '/comment');
$this->drupalPostForm(NULL, $edit, t('Preview'));
$this->drupalPostForm(NULL, $edit, t('Save'));
// Enable counting of statistics.
$this->config('statistics.settings')->set('count_content_views', 1)->save();
// Simulating content views is kind of difficult in the test. Leave that
// to the Statistics module. So instead go ahead and manually update the
// counter for this node.
$nid = $nodes['views'][1]->id();
db_insert('node_counter')
->fields(array('totalcount' => 5, 'daycount' => 5, 'timestamp' => REQUEST_TIME, 'nid' => $nid))
->execute();
// Run cron to update the search index and comment/statistics totals.
$this->cronRun();
// Test that the settings form displays the content ranking section.
$this->drupalGet('admin/config/search/pages/manage/node_search');
$this->assertText(t('Content ranking'));
// Check that all rankings are visible and set to 0.
foreach ($node_ranks as $node_rank) {
$this->assertTrue($this->xpath('//select[@id="edit-rankings-' . $node_rank . '-value"]//option[@value="0"]'), 'Select list to prioritize ' . $node_rank . ' for node ranks is visible and set to 0.');
}
// Test each of the possible rankings.
$edit = array();
foreach ($node_ranks as $node_rank) {
// Enable the ranking we are testing.
$edit['rankings[' . $node_rank . '][value]'] = 10;
$this->drupalPostForm('admin/config/search/pages/manage/node_search', $edit, t('Save search page'));
$this->drupalGet('admin/config/search/pages/manage/node_search');
$this->assertTrue($this->xpath('//select[@id="edit-rankings-' . $node_rank . '-value"]//option[@value="10"]'), 'Select list to prioritize ' . $node_rank . ' for node ranks is visible and set to 10.');
// Reload the plugin to get the up-to-date values.
$this->nodeSearch = entity_load('search_page', 'node_search');
// Do the search and assert the results.
$this->nodeSearch->getPlugin()->setSearch('rocks', array(), array());
$set = $this->nodeSearch->getPlugin()->execute();
$this->assertEqual($set[0]['node']->id(), $nodes[$node_rank][1]->id(), 'Search ranking "' . $node_rank . '" order.');
// Clear this ranking for the next test.
$edit['rankings[' . $node_rank . '][value]'] = 0;
}
// Save the final node_rank change then check that all rankings are visible
// and have been set back to 0.
$this->drupalPostForm('admin/config/search/pages/manage/node_search', $edit, t('Save search page'));
$this->drupalGet('admin/config/search/pages/manage/node_search');
foreach ($node_ranks as $node_rank) {
$this->assertTrue($this->xpath('//select[@id="edit-rankings-' . $node_rank . '-value"]//option[@value="0"]'), 'Select list to prioritize ' . $node_rank . ' for node ranks is visible and set to 0.');
}
// Try with sticky, then promoted. This is a test for issue
// https://www.drupal.org/node/771596.
$node_ranks = array(
'sticky' => 10,
'promote' => 1,
'relevance' => 0,
'recent' => 0,
'comments' => 0,
'views' => 0,
);
$configuration = $this->nodeSearch->getPlugin()->getConfiguration();
foreach ($node_ranks as $var => $value) {
$configuration['rankings'][$var] = $value;
}
$this->nodeSearch->getPlugin()->setConfiguration($configuration);
$this->nodeSearch->save();
// Do the search and assert the results. The sticky node should show up
// first, then the promoted node, then all the rest.
$this->nodeSearch->getPlugin()->setSearch('rocks', array(), array());
$set = $this->nodeSearch->getPlugin()->execute();
$this->assertEqual($set[0]['node']->id(), $nodes['sticky'][1]->id(), 'Search ranking for sticky first worked.');
$this->assertEqual($set[1]['node']->id(), $nodes['promote'][1]->id(), 'Search ranking for promoted second worked.');
// Try with recent, then comments. This is a test for issues
// https://www.drupal.org/node/771596 and
// https://www.drupal.org/node/303574.
$node_ranks = array(
'sticky' => 0,
'promote' => 0,
'relevance' => 0,
'recent' => 10,
'comments' => 1,
'views' => 0,
);
$configuration = $this->nodeSearch->getPlugin()->getConfiguration();
foreach ($node_ranks as $var => $value) {
$configuration['rankings'][$var] = $value;
}
$this->nodeSearch->getPlugin()->setConfiguration($configuration);
$this->nodeSearch->save();
// Do the search and assert the results. The recent node should show up
// first, then the commented node, then all the rest.
$this->nodeSearch->getPlugin()->setSearch('rocks', array(), array());
$set = $this->nodeSearch->getPlugin()->execute();
$this->assertEqual($set[0]['node']->id(), $nodes['recent'][1]->id(), 'Search ranking for recent first worked.');
$this->assertEqual($set[1]['node']->id(), $nodes['comments'][1]->id(), 'Search ranking for comments second worked.');
}
/**
* Test rankings of HTML tags.
*/
public function testHTMLRankings() {
$full_html_format = entity_create('filter_format', array(
'format' => 'full_html',
'name' => 'Full HTML',
));
$full_html_format->save();
// Test HTML tags with different weights.
$sorted_tags = array('h1', 'h2', 'h3', 'h4', 'a', 'h5', 'h6', 'notag');
$shuffled_tags = $sorted_tags;
// Shuffle tags to ensure HTML tags are ranked properly.
shuffle($shuffled_tags);
$settings = array(
'type' => 'page',
'title' => 'Simple node',
);
$nodes = array();
foreach ($shuffled_tags as $tag) {
switch ($tag) {
case 'a':
$settings['body'] = array(array('value' => \Drupal::l('Drupal Rocks', new Url('<front>')), 'format' => 'full_html'));
break;
case 'notag':
$settings['body'] = array(array('value' => 'Drupal Rocks'));
break;
default:
$settings['body'] = array(array('value' => "<$tag>Drupal Rocks</$tag>", 'format' => 'full_html'));
break;
}
$nodes[$tag] = $this->drupalCreateNode($settings);
}
// Update the search index.
$this->nodeSearch->getPlugin()->updateIndex();
search_update_totals();
$this->nodeSearch->getPlugin()->setSearch('rocks', array(), array());
// Do the search and assert the results.
$set = $this->nodeSearch->getPlugin()->execute();
// Test the ranking of each tag.
foreach ($sorted_tags as $tag_rank => $tag) {
// Assert the results.
if ($tag == 'notag') {
$this->assertEqual($set[$tag_rank]['node']->id(), $nodes[$tag]->id(), 'Search tag ranking for plain text order.');
} else {
$this->assertEqual($set[$tag_rank]['node']->id(), $nodes[$tag]->id(), 'Search tag ranking for "&lt;' . $sorted_tags[$tag_rank] . '&gt;" order.');
}
}
// Test tags with the same weight against the sorted tags.
$unsorted_tags = array('u', 'b', 'i', 'strong', 'em');
foreach ($unsorted_tags as $tag) {
$settings['body'] = array(array('value' => "<$tag>Drupal Rocks</$tag>", 'format' => 'full_html'));
$node = $this->drupalCreateNode($settings);
// Update the search index.
$this->nodeSearch->getPlugin()->updateIndex();
search_update_totals();
$this->nodeSearch->getPlugin()->setSearch('rocks', array(), array());
// Do the search and assert the results.
$set = $this->nodeSearch->getPlugin()->execute();
// Ranking should always be second to last.
$set = array_slice($set, -2, 1);
// Assert the results.
$this->assertEqual($set[0]['node']->id(), $node->id(), 'Search tag ranking for "&lt;' . $tag . '&gt;" order.');
// Delete node so it doesn't show up in subsequent search results.
$node->delete();
}
}
}