class HelpTopicSearchTest in Drupal 9

Same name and namespace in other branches

8 core/modules/help_topics/tests/src/Functional/HelpTopicSearchTest.php \Drupal\Tests\help_topics\Functional\HelpTopicSearchTest

Verifies help topic search.

@group help_topics

Hierarchy

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

Expanded class hierarchy of HelpTopicSearchTest

File

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

Namespace

Drupal\Tests\help_topics\Functional

View source

class HelpTopicSearchTest extends HelpTopicTranslatedTestBase {
  use CronRunTrait;

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

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

  /**
   * {@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' => 'notawordenglish',
    ], 'Search');
    $this
      ->assertSearchResultsCount(0);
    $this
      ->assertSession()
      ->pageTextContains('is not fully indexed');

    // 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' => 'notawordenglish',
    ], 'Search');
    $this
      ->assertSearchResultsCount(1);
    $this
      ->assertSession()
      ->pageTextNotContains('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' => 'notawordenglish',
    ], 'Search');
    $this
      ->assertSearchResultsCount(1);
    $session
      ->linkExists('Foo in English title wcsrefsdf');

    // Same for German.
    $this
      ->drupalGet('search/help', [
      'language' => $german,
    ]);
    $this
      ->submitForm([
      'keys' => 'notawordgerman',
    ], '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' => 'notawordgerman',
    ], 'Search');
    $this
      ->assertSearchResultsCount(0);
    $session
      ->pageTextContains('no results');

    // Same for German.
    $this
      ->drupalGet('search/help', [
      'language' => $german,
    ]);
    $this
      ->submitForm([
      'keys' => 'notawordenglish',
    ], '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' => 'nonworditem',
    ], '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' => 'nonwordgerman',
    ], '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' => 'nonworditem',
    ], 'Search');
    $this
      ->assertSearchResultsCount(1);
    $session
      ->linkExists('ABC Help Test module');

    // Same for German.
    $this
      ->drupalGet('admin/help', [
      'language' => $german,
    ]);
    $this
      ->submitForm([
      'keys' => 'nonwordgerman',
    ], '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' => 'nonworditem',
    ], 'Search');
    $this
      ->assertSearchResultsCount(1);
    $session
      ->linkExists('ABC Help Test module');
    $this
      ->drupalGet('search/help');
    $this
      ->submitForm([
      'keys' => 'notawordenglish',
    ], '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' => 'nonworditem',
    ], '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()
      ->pageTextContains('The selected modules have been uninstalled.');
    $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()
      ->pageTextContains('The selected modules have been uninstalled.');
    $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.
   */
  protected function assertSearchResultsCount($count) {
    $this
      ->assertSession()
      ->elementsCount('css', '.help_search-results > li', $count);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AssertLegacyTrait::assert Deprecated	protected	function
AssertLegacyTrait::assertCacheTag Deprecated	protected	function	Asserts whether an expected cache tag was present in the last response.
AssertLegacyTrait::assertElementNotPresent Deprecated	protected	function	Asserts that the element with the given CSS selector is not present.
AssertLegacyTrait::assertElementPresent Deprecated	protected	function	Asserts that the element with the given CSS selector is present.
AssertLegacyTrait::assertEqual Deprecated	protected	function
AssertLegacyTrait::assertEscaped Deprecated	protected	function	Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertLegacyTrait::assertField Deprecated	protected	function	Asserts that a field exists with the given name or ID.
AssertLegacyTrait::assertFieldById Deprecated	protected	function	Asserts that a field exists with the given ID and value.
AssertLegacyTrait::assertFieldByName Deprecated	protected	function	Asserts that a field exists with the given name and value.
AssertLegacyTrait::assertFieldByXPath Deprecated	protected	function	Asserts that a field exists in the current page by the given XPath.
AssertLegacyTrait::assertFieldChecked Deprecated	protected	function	Asserts that a checkbox field in the current page is checked.
AssertLegacyTrait::assertFieldsByValue Deprecated	protected	function	Asserts that a field exists in the current page with a given Xpath result.
AssertLegacyTrait::assertHeader Deprecated	protected	function	Checks that current response header equals value.
AssertLegacyTrait::assertIdentical Deprecated	protected	function
AssertLegacyTrait::assertIdenticalObject Deprecated	protected	function
AssertLegacyTrait::assertLink Deprecated	protected	function	Passes if a link with the specified label is found.
AssertLegacyTrait::assertLinkByHref Deprecated	protected	function	Passes if a link containing a given href (part) is found.
AssertLegacyTrait::assertNoCacheTag Deprecated	protected	function	Asserts whether an expected cache tag was absent in the last response.
AssertLegacyTrait::assertNoEscaped Deprecated	protected	function	Passes if the raw text is not found escaped on the loaded page.
AssertLegacyTrait::assertNoField Deprecated	protected	function	Asserts that a field does NOT exist with the given name or ID.
AssertLegacyTrait::assertNoFieldById Deprecated	protected	function	Asserts that a field does not exist with the given ID and value.
AssertLegacyTrait::assertNoFieldByName Deprecated	protected	function	Asserts that a field does not exist with the given name and value.
AssertLegacyTrait::assertNoFieldByXPath Deprecated	protected	function	Asserts that a field does not exist or its value does not match, by XPath.
AssertLegacyTrait::assertNoFieldChecked Deprecated	protected	function	Asserts that a checkbox field in the current page is not checked.
AssertLegacyTrait::assertNoLink Deprecated	protected	function	Passes if a link with the specified label is not found.
AssertLegacyTrait::assertNoLinkByHref Deprecated	protected	function	Passes if a link containing a given href (part) is not found.
AssertLegacyTrait::assertNoOption Deprecated	protected	function	Asserts that a select option does NOT exist in the current page.
AssertLegacyTrait::assertNoPattern Deprecated	protected	function	Triggers a pass if the Perl regex pattern is not found in the raw content.
AssertLegacyTrait::assertNoRaw Deprecated	protected	function	Passes if the raw text IS not found on the loaded page, fail otherwise.
AssertLegacyTrait::assertNotEqual Deprecated	protected	function
AssertLegacyTrait::assertNoText Deprecated	protected	function	Passes if the page (with HTML stripped) does not contains the text.
AssertLegacyTrait::assertNotIdentical Deprecated	protected	function
AssertLegacyTrait::assertNoUniqueText Deprecated	protected	function	Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertLegacyTrait::assertOption Deprecated	protected	function	Asserts that a select option in the current page exists.
AssertLegacyTrait::assertOptionByText Deprecated	protected	function	Asserts that a select option with the visible text exists.
AssertLegacyTrait::assertOptionSelected Deprecated	protected	function	Asserts that a select option in the current page is checked.
AssertLegacyTrait::assertPattern Deprecated	protected	function	Triggers a pass if the Perl regex pattern is found in the raw content.
AssertLegacyTrait::assertRaw Deprecated	protected	function	Passes if the raw text IS found on the loaded page, fail otherwise.
AssertLegacyTrait::assertResponse Deprecated	protected	function	Asserts the page responds with the specified response code.
AssertLegacyTrait::assertText Deprecated	protected	function	Passes if the page (with HTML stripped) contains the text.
AssertLegacyTrait::assertTextHelper Deprecated	protected	function	Helper for assertText and assertNoText.
AssertLegacyTrait::assertTitle Deprecated	protected	function	Pass if the page title is the given string.
AssertLegacyTrait::assertUniqueText Deprecated	protected	function	Passes if the text is found ONLY ONCE on the text version of the page.
AssertLegacyTrait::assertUrl Deprecated	protected	function	Passes if the internal browser's URL matches the given path.
AssertLegacyTrait::buildXPathQuery Deprecated	protected	function	Builds an XPath query.
AssertLegacyTrait::constructFieldXpath Deprecated	protected	function	Helper: Constructs an XPath for the given set of attributes and value.
AssertLegacyTrait::getAllOptions Deprecated	protected	function	Get all option elements, including nested options, in a select.
AssertLegacyTrait::getRawContent Deprecated	protected	function	Gets the current raw content.
AssertLegacyTrait::pass Deprecated	protected	function
AssertLegacyTrait::verbose Deprecated	protected	function
BlockCreationTrait::placeBlock	protected	function	Creates a block instance based on default settings. Aliased as: drupalPlaceBlock
BrowserHtmlDebugTrait::$htmlOutputBaseUrl	protected	property	The Base URI to use for links to the output files.
BrowserHtmlDebugTrait::$htmlOutputClassName	protected	property	Class name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounter	protected	property	Counter for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounterStorage	protected	property	Counter storage for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputDirectory	protected	property	Directory name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputEnabled	protected	property	HTML output output enabled.
BrowserHtmlDebugTrait::$htmlOutputFile	protected	property	The file name to write the list of URLs to.
BrowserHtmlDebugTrait::$htmlOutputTestId	protected	property	HTML output test ID.
BrowserHtmlDebugTrait::formatHtmlOutputHeaders	protected	function	Formats HTTP headers as string for HTML output logging.
BrowserHtmlDebugTrait::getHtmlOutputHeaders	protected	function	Returns headers in HTML output format.	1
BrowserHtmlDebugTrait::getResponseLogHandler	protected	function	Provides a Guzzle middleware handler to log every response received.
BrowserHtmlDebugTrait::htmlOutput	protected	function	Logs a HTML output message in a text file.
BrowserHtmlDebugTrait::initBrowserOutputFile	protected	function	Creates the directory to store browser output.
BrowserTestBase::$baseUrl	protected	property	The base URL.
BrowserTestBase::$configImporter	protected	property	The config importer that can be used in a test.
BrowserTestBase::$customTranslations	protected	property	An array of custom translations suitable for drupal_rewrite_settings().
BrowserTestBase::$databasePrefix	protected	property	The database prefix of this test run.
BrowserTestBase::$mink	protected	property	Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs	protected	property	Mink default driver params.
BrowserTestBase::$minkDefaultDriverClass	protected	property	Mink class for the default driver to use.	1
BrowserTestBase::$originalContainer	protected	property	The original container.
BrowserTestBase::$originalShutdownCallbacks	protected	property	The original array of shutdown function callbacks.
BrowserTestBase::$preserveGlobalState	protected	property
BrowserTestBase::$profile	protected	property	The profile to install as a basis for testing.	39
BrowserTestBase::$root	protected	property	The app root.
BrowserTestBase::$runTestInSeparateProcess	protected	property	Browser tests are run in separate processes to prevent collisions between code that may be loaded by tests.
BrowserTestBase::$timeLimit	protected	property	Time limit in seconds for the test.
BrowserTestBase::$translationFilesDirectory	protected	property	The translation file directory for the test environment.
BrowserTestBase::cleanupEnvironment	protected	function	Clean up the Simpletest environment.
BrowserTestBase::config	protected	function	Configuration accessor for tests. Returns non-overridden configuration.
BrowserTestBase::drupalGetHeader Deprecated	protected	function	Gets the value of an HTTP response header.
BrowserTestBase::filePreDeleteCallback	public static	function	Ensures test files are deletable.
BrowserTestBase::getDefaultDriverInstance	protected	function	Gets an instance of the default Mink driver.
BrowserTestBase::getDrupalSettings	protected	function	Gets the JavaScript drupalSettings variable for the currently-loaded page.	1
BrowserTestBase::getHttpClient	protected	function	Obtain the HTTP client for the system under test.
BrowserTestBase::getMinkDriverArgs	protected	function	Get the Mink driver args from an environment variable, if it is set. Can be overridden in a derived class so it is possible to use a different value for a subset of tests, e.g. the JavaScript tests.	1
BrowserTestBase::getOptions	protected	function	Helper function to get the options of select field.
BrowserTestBase::getSession	public	function	Returns Mink session.
BrowserTestBase::getSessionCookies	protected	function	Get session cookies from current session.
BrowserTestBase::getTestMethodCaller	protected	function	Retrieves the current calling line in the class under test. Overrides BrowserHtmlDebugTrait::getTestMethodCaller
BrowserTestBase::initFrontPage	protected	function	Visits the front page when initializing Mink.	3
BrowserTestBase::initMink	protected	function	Initializes Mink sessions.	1
BrowserTestBase::installDrupal	public	function	Installs Drupal into the Simpletest site.	1
BrowserTestBase::registerSessions	protected	function	Registers additional Mink sessions.
BrowserTestBase::setUpAppRoot	protected	function	Sets up the root application path.
BrowserTestBase::setUpBeforeClass	public static	function		1
BrowserTestBase::tearDown	protected	function		3
BrowserTestBase::translatePostValues	protected	function	Transforms a nested array into a flat array suitable for submitForm().
BrowserTestBase::xpath	protected	function	Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__sleep	public	function	Prevents serializing any properties.
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.
ContentTypeCreationTrait::createContentType	protected	function	Creates a custom content type based on default settings. Aliased as: drupalCreateContentType	1
CronRunTrait::cronRun	protected	function	Runs cron on the test site.
ExtensionListTestTrait::getModulePath	protected	function	Gets the path for the specified module.
ExtensionListTestTrait::getThemePath	protected	function	Gets the path for the specified theme.
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix	protected	property	The flag to set 'apcu_ensure_unique_prefix' setting.	1
FunctionalTestSetupTrait::$classLoader	protected	property	The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$rootUser	protected	property	The "#1" admin user.
FunctionalTestSetupTrait::doInstall	protected	function	Execute the non-interactive installer.	1
FunctionalTestSetupTrait::getDatabaseTypes	protected	function	Returns all supported database driver installer objects.
FunctionalTestSetupTrait::initConfig	protected	function	Initialize various configurations post-installation.	1
FunctionalTestSetupTrait::initKernel	protected	function	Initializes the kernel after installation.
FunctionalTestSetupTrait::initSettings	protected	function	Initialize settings created during install.
FunctionalTestSetupTrait::initUserSession	protected	function	Initializes user 1 for the site to be installed.
FunctionalTestSetupTrait::installDefaultThemeFromClassProperty	protected	function	Installs the default theme defined by `static::$defaultTheme` when needed.
FunctionalTestSetupTrait::installModulesFromClassProperty	protected	function	Install modules defined by `static::$modules`.	1
FunctionalTestSetupTrait::prepareEnvironment	protected	function	Prepares the current environment for running the test.	20
FunctionalTestSetupTrait::prepareRequestForGenerator	protected	function	Creates a mock request and sets it on the generator.
FunctionalTestSetupTrait::prepareSettings	protected	function	Prepares site settings and services before installation.	2
FunctionalTestSetupTrait::rebuildAll	protected	function	Resets and rebuilds the environment after setup.
FunctionalTestSetupTrait::rebuildContainer	protected	function	Rebuilds \Drupal::getContainer().
FunctionalTestSetupTrait::resetAll	protected	function	Resets all data structures after having enabled new modules.
FunctionalTestSetupTrait::setContainerParameter	protected	function	Changes parameters in the services.yml file.
FunctionalTestSetupTrait::setupBaseUrl	protected	function	Sets up the base URL based upon the environment variable.
FunctionalTestSetupTrait::writeSettings	protected	function	Rewrites the settings.php file of the test site.	1
HelpTopicSearchTest::$defaultTheme	protected	property	The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
HelpTopicSearchTest::$modules	protected static	property	Modules to enable. Overrides HelpTopicTranslatedTestBase::$modules
HelpTopicSearchTest::assertSearchResultsCount	protected	function	Asserts that help search returned the expected number of results.
HelpTopicSearchTest::setUp	protected	function	Overrides HelpTopicTranslatedTestBase::setUp
HelpTopicSearchTest::testHelpSearch	public	function	Tests help topic search.
HelpTopicSearchTest::testUninstall	public	function	Tests uninstalling the help_topics module.
HelpTopicSearchTest::testUninstallSearch	public	function	Tests uninstalling the search module.
HelpTopicTranslatedTestBase::installParameters	protected	function	Returns the parameters that will be used when Simpletest installs Drupal. Overrides FunctionalTestSetupTrait::installParameters
NodeCreationTrait::createNode	protected	function	Creates a node based on default settings. Aliased as: drupalCreateNode
NodeCreationTrait::getNodeByTitle	public	function	Get a node from the database based on its title. Aliased as: drupalGetNodeByTitle
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.
RefreshVariablesTrait::refreshVariables	protected	function	Refreshes in-memory configuration and state information.	1
SessionTestTrait::$sessionName	protected	property	The name of the session cookie.
SessionTestTrait::generateSessionName	protected	function	Generates a session cookie name.
SessionTestTrait::getSessionName	protected	function	Returns the session name in use on the child site.
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.	1
TestRequirementsTrait::getDrupalRoot	protected static	function	Returns the Drupal root directory.
TestSetupTrait::$configSchemaCheckerExclusions	protected static	property	An array of config object names that are excluded from schema checking.
TestSetupTrait::$container	protected	property	The dependency injection container used in the test.
TestSetupTrait::$kernel	protected	property	The DrupalKernel instance used in the test.
TestSetupTrait::$originalSite	protected	property	The site directory of the original parent site.
TestSetupTrait::$privateFilesDirectory	protected	property	The private file directory for the test environment.
TestSetupTrait::$publicFilesDirectory	protected	property	The public file directory for the test environment.
TestSetupTrait::$siteDirectory	protected	property	The site directory of this test run.
TestSetupTrait::$strictConfigSchema	protected	property	Set to TRUE to strict check all configuration saved.	1
TestSetupTrait::$tempFilesDirectory	protected	property	The temporary file directory for the test environment.
TestSetupTrait::$testId	protected	property	The test run ID.
TestSetupTrait::changeDatabasePrefix	protected	function	Changes the database connection to the prefixed one.
TestSetupTrait::getConfigSchemaExclusions	protected	function	Gets the config schema exclusions for this test.
TestSetupTrait::getDatabaseConnection	public static	function	Returns the database connection to the site running Simpletest.
TestSetupTrait::prepareDatabasePrefix	protected	function	Generates a database prefix for running tests.	1
UiHelperTrait::$loggedInUser	protected	property	The current user logged in using the Mink controlled browser.
UiHelperTrait::$maximumMetaRefreshCount	protected	property	The number of meta refresh redirects to follow, or NULL if unlimited.
UiHelperTrait::$metaRefreshCount	protected	property	The number of meta refresh redirects followed during ::drupalGet().
UiHelperTrait::assertSession	public	function	Returns WebAssert object.	1
UiHelperTrait::buildUrl	protected	function	Builds an absolute URL from a system path or a URL object.
UiHelperTrait::checkForMetaRefresh	protected	function	Checks for meta refresh tag and if found call drupalGet() recursively.
UiHelperTrait::click	protected	function	Clicks the element with the given CSS selector.
UiHelperTrait::clickLink	protected	function	Follows a link by complete name.
UiHelperTrait::cssSelect	protected	function	Searches elements using a CSS selector in the raw content.
UiHelperTrait::cssSelectToXpath	protected	function	Translates a CSS expression to its XPath equivalent.
UiHelperTrait::drupalGet	protected	function	Retrieves a Drupal path or an absolute path.	2
UiHelperTrait::drupalLogin	protected	function	Logs in a user using the Mink controlled browser.
UiHelperTrait::drupalLogout	protected	function	Logs a user out of the Mink controlled browser and confirms.
UiHelperTrait::drupalPostForm Deprecated	protected	function	Executes a form submission.
UiHelperTrait::drupalUserIsLoggedIn	protected	function	Returns whether a given user account is logged in.
UiHelperTrait::getAbsoluteUrl	protected	function	Takes a path and returns an absolute path.
UiHelperTrait::getTextContent	protected	function	Retrieves the plain-text content from the current page.
UiHelperTrait::getUrl	protected	function	Get the current URL from the browser.
UiHelperTrait::isTestUsingGuzzleClient	protected	function	Determines if test is using DrupalTestBrowser.
UiHelperTrait::prepareRequest	protected	function	Prepare for a request to testing site.	1
UiHelperTrait::submitForm	protected	function	Fills and submits a form.
UserCreationTrait::checkPermissions	protected	function	Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole	protected	function	Creates an administrative role.
UserCreationTrait::createRole	protected	function	Creates a role with specified permissions. Aliased as: drupalCreateRole
UserCreationTrait::createUser	protected	function	Create a user with a given set of permissions. Aliased as: drupalCreateUser
UserCreationTrait::grantPermissions	protected	function	Grant permissions to a user role.
UserCreationTrait::setCurrentUser	protected	function	Switch the current logged in user.
UserCreationTrait::setUpCurrentUser	protected	function	Creates a random user account and sets it as current user.
XdebugRequestTrait::extractCookiesFromRequest	protected	function	Adds xdebug cookies, from request setup.

You are here

class HelpTopicSearchTest in Drupal 9

Hierarchy

File

Namespace

Members

API Navigation