SearchPageTextTest.php in Drupal 8

Namespace

Drupal\Tests\search\Functional

File

core/modules/search/tests/src/Functional/SearchPageTextTest.php

<?php

namespace Drupal\Tests\search\Functional;

use Drupal\Component\Utility\Html;
use Drupal\Component\Utility\Unicode;
use Drupal\Tests\BrowserTestBase;

/**
 * Tests the search help text and search page text.
 *
 * @group search
 */
class SearchPageTextTest extends BrowserTestBase {

  /**
   * {@inheritdoc}
   */
  protected static $modules = [
    'block',
    'node',
    'search',
  ];

  /**
   * {@inheritdoc}
   */
  protected $defaultTheme = 'stark';

  /**
   * A user with permission to use advanced search.
   *
   * @var \Drupal\user\UserInterface
   */
  protected $searchingUser;

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this
      ->drupalCreateContentType([
      'type' => 'page',
      'name' => 'Basic page',
    ]);

    // Create user.
    $this->searchingUser = $this
      ->drupalCreateUser([
      'search content',
      'access user profiles',
      'use advanced search',
    ]);
    $this
      ->drupalPlaceBlock('local_tasks_block');
    $this
      ->drupalPlaceBlock('page_title_block');
  }

  /**
   * Tests for XSS in search module local task.
   *
   * This is a regression test for https://www.drupal.org/node/2338081
   */
  public function testSearchLabelXSS() {
    $this
      ->drupalLogin($this
      ->drupalCreateUser([
      'administer search',
    ]));
    $keys['label'] = '<script>alert("Don\'t Panic");</script>';
    $this
      ->drupalPostForm('admin/config/search/pages/manage/node_search', $keys, t('Save search page'));
    $this
      ->drupalLogin($this->searchingUser);
    $this
      ->drupalGet('search/node');
    $this
      ->assertEscaped($keys['label']);
  }

  /**
   * Tests the failed search text, and various other text on the search page.
   */
  public function testSearchText() {
    $this
      ->drupalLogin($this->searchingUser);
    $this
      ->drupalGet('search/node');
    $this
      ->assertText(t('Enter your keywords'));
    $this
      ->assertText(t('Search'));
    $this
      ->assertTitle('Search | Drupal');
    $edit = [];
    $search_terms = 'bike shed ' . $this
      ->randomMachineName();
    $edit['keys'] = $search_terms;
    $this
      ->drupalPostForm('search/node', $edit, t('Search'));
    $this
      ->assertText('search yielded no results');
    $this
      ->assertText(t('Search'));
    $title_source = 'Search for @keywords | Drupal';
    $this
      ->assertTitle('Search for ' . Unicode::truncate($search_terms, 60, TRUE, TRUE) . ' | Drupal');
    $this
      ->assertNoText('Node', 'Erroneous tab and breadcrumb text is not present');
    $this
      ->assertNoText(t('Node'), 'Erroneous translated tab and breadcrumb text is not present');
    $this
      ->assertText(t('Content'), 'Tab and breadcrumb text is present');
    $this
      ->clickLink('Search help');
    $this
      ->assertText('Search help', 'Correct title is on search help page');
    $this
      ->assertText('Use upper-case OR to get more results', 'Correct text is on content search help page');

    // Search for a longer text, and see that it is in the title, truncated.
    $edit = [];
    $search_terms = 'Every word is like an unnecessary stain on silence and nothingness.';
    $edit['keys'] = $search_terms;
    $this
      ->drupalPostForm('search/node', $edit, t('Search'));
    $this
      ->assertTitle('Search for Every word is like an unnecessary stain on silence and… | Drupal');

    // Search for a string with a lot of special characters.
    $search_terms = 'Hear nothing > "see nothing" `feel' . " '1982.";
    $edit['keys'] = $search_terms;
    $this
      ->drupalPostForm('search/node', $edit, t('Search'));
    $actual_title = $this
      ->xpath('//title')[0]
      ->getText();
    $this
      ->assertEqual($actual_title, Html::decodeEntities(t($title_source, [
      '@keywords' => Unicode::truncate($search_terms, 60, TRUE, TRUE),
    ])), 'Search page title is correct');
    $edit['keys'] = $this->searchingUser
      ->getAccountName();
    $this
      ->drupalPostForm('search/user', $edit, t('Search'));
    $this
      ->assertText(t('Search'));
    $this
      ->assertTitle('Search for ' . Unicode::truncate($this->searchingUser
      ->getAccountName(), 60, TRUE, TRUE) . ' | Drupal');
    $this
      ->clickLink('Search help');
    $this
      ->assertText('Search help', 'Correct title is on search help page');
    $this
      ->assertText('user names and partial user names', 'Correct text is on user search help page');

    // Test that search keywords containing slashes are correctly loaded
    // from the GET params and displayed in the search form.
    $arg = $this
      ->randomMachineName() . '/' . $this
      ->randomMachineName();
    $this
      ->drupalGet('search/node', [
      'query' => [
        'keys' => $arg,
      ],
    ]);
    $input = $this
      ->xpath("//input[@id='edit-keys' and @value='{$arg}']");
    $this
      ->assertFalse(empty($input), 'Search keys with a / are correctly set as the default value in the search box.');

    // Test a search input exceeding the limit of AND/OR combinations to test
    // the Denial-of-Service protection.
    $limit = $this
      ->config('search.settings')
      ->get('and_or_limit');
    $keys = [];
    for ($i = 0; $i < $limit + 1; $i++) {

      // Use a key of 4 characters to ensure we never generate 'AND' or 'OR'.
      $keys[] = $this
        ->randomMachineName(4);
      if ($i % 2 == 0) {
        $keys[] = 'OR';
      }
    }
    $edit['keys'] = implode(' ', $keys);
    $this
      ->drupalPostForm('search/node', $edit, t('Search'));
    $this
      ->assertRaw(t('Your search used too many AND/OR expressions. Only the first @count terms were included in this search.', [
      '@count' => $limit,
    ]));

    // Test that a search on Node or User with no keywords entered generates
    // the "Please enter some keywords" message.
    $this
      ->drupalPostForm('search/node', [], t('Search'));
    $this
      ->assertText(t('Please enter some keywords'), 'With no keywords entered, message is displayed on node page');
    $this
      ->drupalPostForm('search/user', [], t('Search'));
    $this
      ->assertText(t('Please enter some keywords'), 'With no keywords entered, message is displayed on user page');

    // Make sure the "Please enter some keywords" message is NOT displayed if
    // you use "or" words or phrases in Advanced Search.
    $this
      ->drupalPostForm('search/node', [
      'or' => $this
        ->randomMachineName() . ' ' . $this
        ->randomMachineName(),
    ], 'edit-submit--2');
    $this
      ->assertNoText(t('Please enter some keywords'), 'With advanced OR keywords entered, no keywords message is not displayed on node page');
    $this
      ->drupalPostForm('search/node', [
      'phrase' => '"' . $this
        ->randomMachineName() . '" "' . $this
        ->randomMachineName() . '"',
    ], 'edit-submit--2');
    $this
      ->assertNoText(t('Please enter some keywords'), 'With advanced phrase entered, no keywords message is not displayed on node page');

    // Verify that if you search for a too-short keyword, you get the right
    // message, and that if after that you search for a longer keyword, you
    // do not still see the message.
    $this
      ->drupalPostForm('search/node', [
      'keys' => $this
        ->randomMachineName(1),
    ], t('Search'));
    $this
      ->assertText('You must include at least one keyword', 'Keyword message is displayed when searching for short word');
    $this
      ->assertNoText(t('Please enter some keywords'), 'With short word entered, no keywords message is not displayed');
    $this
      ->drupalPostForm(NULL, [
      'keys' => $this
        ->randomMachineName(),
    ], t('Search'));
    $this
      ->assertNoText('You must include at least one keyword', 'Keyword message is not displayed when searching for long word after short word search');

    // Test that if you search for a URL with .. in it, you still end up at
    // the search page. See issue https://www.drupal.org/node/890058.
    $this
      ->drupalPostForm('search/node', [
      'keys' => '../../admin',
    ], t('Search'));
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertText('no results', 'Searching for ../../admin with non-admin user gives you a no search results page');

    // Test that if you search for a URL starting with "./", you still end up
    // at the search page. See issue https://www.drupal.org/node/1421560.
    $this
      ->drupalPostForm('search/node', [
      'keys' => '.something',
    ], t('Search'));
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->assertText('no results', 'Searching for .something gives you a no search results page');
  }

}

Classes

Name	Description
SearchPageTextTest	Tests the search help text and search page text.