class HelpTopicSearchTest in Drupal 10

Verifies help topic search.

@group help_topics

Hierarchy

• class \Drupal\Tests\BrowserTestBase extends \PHPUnit\Framework\TestCase uses \Drupal\Tests\PhpUnitCompatibilityTrait, \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, FunctionalTestSetupTrait, TestSetupTrait, BlockCreationTrait, ConfigTestTrait, ExtensionListTestTrait, ContentTypeCreationTrait, NodeCreationTrait, RandomGeneratorTrait, TestRequirementsTrait, PhpUnitWarnings, UiHelperTrait, UserCreationTrait, XdebugRequestTrait
  • class \Drupal\Tests\help_topics\Functional\HelpTopicTranslatedTestBase
    • class \Drupal\Tests\help_topics\Functional\HelpTopicSearchTest uses CronRunTrait

File

core/modules/help_topics/tests/src/Functional/HelpTopicSearchTest.php, line 16

Namespace

Drupal\Tests\help_topics\Functional

class HelpTopicSearchTest extends HelpTopicTranslatedTestBase {
  use CronRunTrait;

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

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

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();

    // Log in.
    $this
      ->drupalLogin($this
      ->createUser([
      'access administration pages',
      'administer site configuration',
      'view the administration theme',
      'administer permissions',
      'administer languages',
      'administer search',
      'access test help',
      'search content',
    ]));

    // Add English language and set to default.
    $this
      ->drupalGet('admin/config/regional/language/add');
    $this
      ->submitForm([
      'predefined_langcode' => 'en',
    ], 'Add language');
    $this
      ->drupalGet('admin/config/regional/language');
    $this
      ->submitForm([
      'site_default_language' => 'en',
    ], 'Save configuration');

    // When default language is changed, the container is rebuilt in the child
    // site, so a rebuild in the main site is required to use the new container
    // here.
    $this
      ->rebuildContainer();

    // Before running cron, verify that a search returns no results and shows
    // warning.
    $this
      ->drupalGet('search/help');
    $this
      ->submitForm([
      'keys' => 'not-a-word-english',
    ], 'Search');
    $this
      ->assertSearchResultsCount(0);
    $this
      ->assertSession()
      ->statusMessageContains('Help search is not fully indexed', 'warning');

    // Run cron until the topics are fully indexed, with a limit of 100 runs
    // to avoid infinite loops.
    $num_runs = 100;
    $plugin = HelpSearch::create($this->container, [], 'help_search', []);
    do {
      $this
        ->cronRun();
      $remaining = $plugin
        ->indexStatus()['remaining'];
    } while (--$num_runs && $remaining);
    $this
      ->assertNotEmpty($num_runs);
    $this
      ->assertEmpty($remaining);

    // Visit the Search settings page and verify it says 100% indexed.
    $this
      ->drupalGet('admin/config/search/pages');
    $this
      ->assertSession()
      ->pageTextContains('100% of the site has been indexed');

    // Search and verify there is no warning.
    $this
      ->drupalGet('search/help');
    $this
      ->submitForm([
      'keys' => 'not-a-word-english',
    ], 'Search');
    $this
      ->assertSearchResultsCount(1);
    $this
      ->assertSession()
      ->statusMessageNotContains('Help search is not fully indexed');
  }

  /**
   * Tests help topic search.
   */
  public function testHelpSearch() {
    $german = \Drupal::languageManager()
      ->getLanguage('de');
    $session = $this
      ->assertSession();

    // Verify that when we search in English for a word that is only in
    // English text, we find the topic. Note that these "words" are provided
    // by the topics that come from
    // \Drupal\help_topics_test\Plugin\HelpSection\TestHelpSection.
    $this
      ->drupalGet('search/help');
    $this
      ->submitForm([
      'keys' => 'not-a-word-english',
    ], 'Search');
    $this
      ->assertSearchResultsCount(1);
    $session
      ->linkExists('Foo in English title wcsrefsdf');

    // Same for German.
    $this
      ->drupalGet('search/help', [
      'language' => $german,
    ]);
    $this
      ->submitForm([
      'keys' => 'not-a-word-german',
    ], 'Search');
    $this
      ->assertSearchResultsCount(1);
    $session
      ->linkExists('Foomm Foreign heading');

    // Verify when we search in English for a word that only exists in German,
    // we get no results.
    $this
      ->drupalGet('search/help');
    $this
      ->submitForm([
      'keys' => 'not-a-word-german',
    ], 'Search');
    $this
      ->assertSearchResultsCount(0);
    $session
      ->pageTextContains('no results');

    // Same for German.
    $this
      ->drupalGet('search/help', [
      'language' => $german,
    ]);
    $this
      ->submitForm([
      'keys' => 'not-a-word-english',
    ], 'Search');
    $this
      ->assertSearchResultsCount(0);
    $session
      ->pageTextContains('no results');

    // Verify when we search in English for a word that exists in one topic
    // in English and a different topic in German, we only get the one English
    // topic.
    $this
      ->drupalGet('search/help');
    $this
      ->submitForm([
      'keys' => 'sqruct',
    ], 'Search');
    $this
      ->assertSearchResultsCount(1);
    $session
      ->linkExists('Foo in English title wcsrefsdf');

    // Same for German.
    $this
      ->drupalGet('search/help', [
      'language' => $german,
    ]);
    $this
      ->submitForm([
      'keys' => 'asdrsad',
    ], 'Search');
    $this
      ->assertSearchResultsCount(1);
    $session
      ->linkExists('Foomm Foreign heading');

    // All of the above tests used the TestHelpSection plugin. Also verify
    // that we can search for translated regular help topics, in both English
    // and German.
    $this
      ->drupalGet('search/help');
    $this
      ->submitForm([
      'keys' => 'non-word-item',
    ], 'Search');
    $this
      ->assertSearchResultsCount(1);
    $session
      ->linkExists('ABC Help Test module');

    // Click the link and verify we ended up on the topic page.
    $this
      ->clickLink('ABC Help Test module');
    $session
      ->pageTextContains('This is a test');
    $this
      ->drupalGet('search/help', [
      'language' => $german,
    ]);
    $this
      ->submitForm([
      'keys' => 'non-word-german',
    ], 'Search');
    $this
      ->assertSearchResultsCount(1);
    $session
      ->linkExists('ABC-Hilfetestmodul');
    $this
      ->clickLink('ABC-Hilfetestmodul');
    $session
      ->pageTextContains('Übersetzung testen.');

    // Verify that we can search from the admin/help page.
    $this
      ->drupalGet('admin/help');
    $session
      ->pageTextContains('Search help');
    $this
      ->submitForm([
      'keys' => 'non-word-item',
    ], 'Search');
    $this
      ->assertSearchResultsCount(1);
    $session
      ->linkExists('ABC Help Test module');

    // Same for German.
    $this
      ->drupalGet('admin/help', [
      'language' => $german,
    ]);
    $this
      ->submitForm([
      'keys' => 'non-word-german',
    ], 'Search');
    $this
      ->assertSearchResultsCount(1);
    $session
      ->linkExists('ABC-Hilfetestmodul');

    // Verify we can search for title text (other searches used text
    // that was part of the body).
    $this
      ->drupalGet('search/help');
    $this
      ->submitForm([
      'keys' => 'wcsrefsdf',
    ], 'Search');
    $this
      ->assertSearchResultsCount(1);
    $session
      ->linkExists('Foo in English title wcsrefsdf');
    $this
      ->drupalGet('admin/help', [
      'language' => $german,
    ]);
    $this
      ->submitForm([
      'keys' => 'sdeeeee',
    ], 'Search');
    $this
      ->assertSearchResultsCount(1);
    $session
      ->linkExists('Barmm Foreign sdeeeee');

    // Just changing the title and running cron is not enough to reindex so
    // 'sdeeeee' still hits a match. The content is updated because the help
    // topic is rendered each time.
    \Drupal::state()
      ->set('help_topics_test:translated_title', 'Updated translated title');
    $this
      ->cronRun();
    $this
      ->drupalGet('admin/help', [
      'language' => $german,
    ]);
    $this
      ->submitForm([
      'keys' => 'sdeeeee',
    ], 'Search');
    $this
      ->assertSearchResultsCount(1);
    $session
      ->linkExists('Updated translated title');

    // Searching for the updated test shouldn't produce a match.
    $this
      ->drupalGet('admin/help', [
      'language' => $german,
    ]);
    $this
      ->submitForm([
      'keys' => 'translated title',
    ], 'Search');
    $this
      ->assertSearchResultsCount(0);

    // Clear the caches and re-run cron - this should re-index the help.
    $this
      ->rebuildAll();
    $this
      ->cronRun();
    $this
      ->drupalGet('admin/help', [
      'language' => $german,
    ]);
    $this
      ->submitForm([
      'keys' => 'sdeeeee',
    ], 'Search');
    $this
      ->assertSearchResultsCount(0);
    $this
      ->drupalGet('admin/help', [
      'language' => $german,
    ]);
    $this
      ->submitForm([
      'keys' => 'translated title',
    ], 'Search');
    $this
      ->assertSearchResultsCount(1);
    $session
      ->linkExists('Updated translated title');

    // Verify the cache tags and contexts.
    $session
      ->responseHeaderContains('X-Drupal-Cache-Tags', 'config:search.page.help_search');
    $session
      ->responseHeaderContains('X-Drupal-Cache-Tags', 'search_index:help_search');
    $session
      ->responseHeaderContains('X-Drupal-Cache-Contexts', 'user.permissions');
    $session
      ->responseHeaderContains('X-Drupal-Cache-Contexts', 'languages:language_interface');

    // Log in as a user that does not have permission to see TestHelpSection
    // items, and verify they can still search for help topics but not see these
    // items.
    $this
      ->drupalLogin($this
      ->createUser([
      'access administration pages',
      'administer site configuration',
      'view the administration theme',
      'administer permissions',
      'administer languages',
      'administer search',
      'search content',
    ]));
    $this
      ->drupalGet('admin/help');
    $session
      ->pageTextContains('Search help');
    $this
      ->drupalGet('search/help');
    $this
      ->submitForm([
      'keys' => 'non-word-item',
    ], 'Search');
    $this
      ->assertSearchResultsCount(1);
    $session
      ->linkExists('ABC Help Test module');
    $this
      ->drupalGet('search/help');
    $this
      ->submitForm([
      'keys' => 'not-a-word-english',
    ], 'Search');
    $this
      ->assertSearchResultsCount(0);
    $session
      ->pageTextContains('no results');

    // Uninstall the test module and verify its topics are immediately not
    // searchable.
    \Drupal::service('module_installer')
      ->uninstall([
      'help_topics_test',
    ]);
    $this
      ->drupalGet('search/help');
    $this
      ->submitForm([
      'keys' => 'non-word-item',
    ], 'Search');
    $this
      ->assertSearchResultsCount(0);
  }

  /**
   * Tests uninstalling the help_topics module.
   */
  public function testUninstall() {
    \Drupal::service('module_installer')
      ->uninstall([
      'help_topics_test',
    ]);

    // Ensure we can uninstall help_topics and use the help system without
    // breaking.
    $this
      ->drupalLogin($this->rootUser);
    $edit = [];
    $edit['uninstall[help_topics]'] = TRUE;
    $this
      ->drupalGet('admin/modules/uninstall');
    $this
      ->submitForm($edit, 'Uninstall');
    $this
      ->submitForm([], 'Uninstall');
    $this
      ->assertSession()
      ->statusMessageContains('The selected modules have been uninstalled.', 'status');
    $this
      ->drupalGet('admin/help');
    $this
      ->assertSession()
      ->statusCodeEquals(200);
  }

  /**
   * Tests uninstalling the search module.
   */
  public function testUninstallSearch() {

    // Ensure we can uninstall search and use the help system without
    // breaking.
    $this
      ->drupalLogin($this->rootUser);
    $edit = [];
    $edit['uninstall[search]'] = TRUE;
    $this
      ->drupalGet('admin/modules/uninstall');
    $this
      ->submitForm($edit, 'Uninstall');
    $this
      ->submitForm([], 'Uninstall');
    $this
      ->assertSession()
      ->statusMessageContains('The selected modules have been uninstalled.', 'status');
    $this
      ->drupalGet('admin/help');
    $this
      ->assertSession()
      ->statusCodeEquals(200);

    // Rebuild the container to reflect the latest changes.
    $this
      ->rebuildContainer();
    $this
      ->assertTrue(\Drupal::moduleHandler()
      ->moduleExists('help_topics'), 'The help_topics module is still installed.');
    $this
      ->assertFalse(\Drupal::moduleHandler()
      ->moduleExists('search'), 'The search module is uninstalled.');
  }

  /**
   * Asserts that help search returned the expected number of results.
   *
   * @param int $count
   *   The expected number of search results.
   *
   * @internal
   */
  protected function assertSearchResultsCount(int $count) : void {
    $this
      ->assertSession()
      ->elementsCount('css', '.help_search-results > li', $count);
  }

}