You are here

class SearchConfigSettingsFormTest in Drupal 9

Same name and namespace in other branches
  1. 8 core/modules/search/tests/src/Functional/SearchConfigSettingsFormTest.php \Drupal\Tests\search\Functional\SearchConfigSettingsFormTest

Verify the search config settings form.

@group search

Hierarchy

Expanded class hierarchy of SearchConfigSettingsFormTest

File

core/modules/search/tests/src/Functional/SearchConfigSettingsFormTest.php, line 15

Namespace

Drupal\Tests\search\Functional
View source
class SearchConfigSettingsFormTest extends BrowserTestBase {

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

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

  /**
   * User who can search and administer search.
   *
   * @var \Drupal\user\UserInterface
   */
  protected $searchUser;

  /**
   * Node indexed for searching.
   *
   * @var \Drupal\node\NodeInterface
   */
  protected $searchNode;
  protected function setUp() : void {
    parent::setUp();
    $this
      ->drupalCreateContentType([
      'type' => 'page',
      'name' => 'Basic page',
    ]);

    // Log in as a user that can create and search content.
    $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);

    // Add a single piece of content and index it.
    $node = $this
      ->drupalCreateNode();
    $this->searchNode = $node;

    // Link the node to itself to test that it's only indexed once. The content
    // also needs the word "pizza" so we can use it as the search keyword.
    $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();

    // Enable the search block.
    $this
      ->drupalPlaceBlock('search_form_block');
    $this
      ->drupalPlaceBlock('local_tasks_block');
    $this
      ->drupalPlaceBlock('page_title_block');
  }

  /**
   * Verifies the search settings form.
   */
  public function testSearchSettingsPage() {

    // Test that the settings form displays the correct count of items left to index.
    $this
      ->drupalGet('admin/config/search/pages');
    $this
      ->assertSession()
      ->pageTextContains('There are 0 items left to index.');

    // Test the re-index button.
    $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()
      ->pageTextContains('All search indexes will be rebuilt');
    $this
      ->drupalGet('admin/config/search/pages');
    $this
      ->assertSession()
      ->pageTextContains('There is 1 item left to index.');

    // Test that the form saves with the default values.
    $this
      ->drupalGet('admin/config/search/pages');
    $this
      ->submitForm([], 'Save configuration');
    $this
      ->assertSession()
      ->pageTextContains('The configuration options have been saved.');

    // Test that the form does not save with an invalid word length.
    $edit = [
      'minimum_word_size' => $this
        ->randomMachineName(3),
    ];
    $this
      ->drupalGet('admin/config/search/pages');
    $this
      ->submitForm($edit, 'Save configuration');
    $this
      ->assertSession()
      ->pageTextNotContains('The configuration options have been saved.');

    // Test logging setting. It should be off by default.
    $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');

    // Turn on logging.
    $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');
  }

  /**
   * Verifies plugin-supplied settings form.
   */
  public function testSearchModuleSettingsPage() {
    $this
      ->drupalGet('admin/config/search/pages');
    $this
      ->clickLink('Edit', 1);

    // Ensure that the default setting was picked up from the default config
    $this
      ->assertTrue($this
      ->assertSession()
      ->optionExists('edit-extra-type-settings-boost', 'bi')
      ->isSelected());

    // Change extra type setting and also modify a common search setting.
    $edit = [
      'extra_type_settings[boost]' => 'ii',
    ];
    $this
      ->submitForm($edit, 'Save search page');

    // Ensure that the modifications took effect.
    $this
      ->assertSession()
      ->pageTextContains("The Dummy search type search page has been updated.");
    $this
      ->drupalGet('admin/config/search/pages/manage/dummy_search_type');
    $this
      ->assertTrue($this
      ->assertSession()
      ->optionExists('edit-extra-type-settings-boost', 'ii')
      ->isSelected());
  }

  /**
   * Verifies that you can disable individual search plugins.
   */
  public function testSearchModuleDisabling() {

    // Array of search plugins to test: 'keys' are the keywords to search for,
    // and 'text' is the text to assert is on the results page.
    $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);

    /** @var \Drupal\search\SearchPageInterface[] $entities */
    $entities = SearchPage::loadMultiple();

    // Disable all of the search pages.
    foreach ($entities as $entity) {
      $entity
        ->disable()
        ->save();
    }

    // Test each plugin if it's enabled as the only search plugin.
    foreach ($entities as $entity_id => $entity) {
      $this
        ->setDefaultThroughUi($entity_id);

      // Run a search from the correct search URL.
      $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']);

      // Verify that other plugin search tab labels are not visible.
      foreach ($plugins as $other) {
        if ($other != $entity_id) {
          $path = 'search/' . $entities[$other]
            ->getPath();
          $this
            ->assertSession()
            ->elementNotExists('xpath', '//ul[@class="tabs primary"]/li/a[@data-drupal-link-system-path="' . $path . '"]');
        }
      }

      // Run a search from the search block on the node page. Verify you get
      // to this plugin's search results page.
      $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');

      // Try an invalid search path, which should 404.
      $this
        ->drupalGet('search/not_a_plugin_path');
      $this
        ->assertSession()
        ->statusCodeEquals(404);
      $entity
        ->disable()
        ->save();
    }

    // Set the node search as default.
    $this
      ->setDefaultThroughUi('node_search');

    // Test with all search plugins enabled. When you go to the search
    // page or run search, all plugins should be shown.
    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', '//ul[@class="tabs primary"]/li/a[@data-drupal-link-system-path="' . $path . '"]', $label);
      }
    }
  }

  /**
   * Tests the ordering of search pages on a clean install.
   */
  public function testDefaultSearchPageOrdering() {
    $this
      ->drupalGet('search');
    $elements = $this
      ->xpath('//*[contains(@class, :class)]//a', [
      ':class' => 'tabs primary',
    ]);
    $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'));
  }

  /**
   * Tests multiple search pages of the same type.
   */
  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);

    // Ensure that no search pages are configured.
    $this
      ->drupalGet('admin/config/search/pages');
    $this
      ->assertSession()
      ->pageTextContains('No search pages have been configured.');

    // Add a search page.
    $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()
      ->pageTextContains("The {$first['label']} search page has been added.");

    // Attempt to add a search page with an existing path.
    $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()
      ->pageTextContains('The search page path must be unique.');

    // Add a second search page.
    $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.');

    // Ensure both search pages have their tabs displayed.
    $this
      ->drupalGet('search');
    $elements = $this
      ->xpath('//*[contains(@class, :class)]//a', [
      ':class' => 'tabs primary',
    ]);
    $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'));

    // Switch the weight of the search pages and check the order of the tabs.
    $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('//*[contains(@class, :class)]//a', [
      ':class' => 'tabs primary',
    ]);
    $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'));

    // Check the initial state of the search pages.
    $this
      ->drupalGet('admin/config/search/pages');
    $this
      ->verifySearchPageOperations($first_id, TRUE, FALSE, FALSE, FALSE);
    $this
      ->verifySearchPageOperations($second_id, TRUE, TRUE, TRUE, FALSE);

    // Change the default search page.
    $this
      ->clickLink('Set as default');
    $this
      ->assertSession()
      ->pageTextContains("The default search page is now {$second['label']}. Be sure to check the ordering of your search pages.");
    $this
      ->verifySearchPageOperations($first_id, TRUE, TRUE, TRUE, FALSE);
    $this
      ->verifySearchPageOperations($second_id, TRUE, FALSE, FALSE, FALSE);

    // Disable the first search page.
    $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);

    // Enable the first search page.
    $this
      ->clickLink('Enable');
    $this
      ->assertSession()
      ->statusCodeEquals(200);
    $this
      ->verifySearchPageOperations($first_id, TRUE, TRUE, TRUE, FALSE);
    $this
      ->verifySearchPageOperations($second_id, TRUE, FALSE, FALSE, FALSE);

    // Test deleting.
    $this
      ->clickLink('Delete');
    $this
      ->assertSession()
      ->pageTextContains("Are you sure you want to delete the search page {$first['label']}?");
    $this
      ->submitForm([], 'Delete');
    $this
      ->assertSession()
      ->pageTextContains("The search page {$first['label']} has been deleted.");
    $this
      ->verifySearchPageOperations($first_id, FALSE, FALSE, FALSE, FALSE);
  }

  /**
   * Tests that the enable/disable/default routes are protected from CSRF.
   */
  public function testRouteProtection() {

    // Ensure that the enable and disable routes are protected.
    $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);
  }

  /**
   * Checks that the search page operations match expectations.
   *
   * @param string $id
   *   The search page ID to check.
   * @param bool $edit
   *   Whether the edit link is expected.
   * @param bool $delete
   *   Whether the delete link is expected.
   * @param bool $disable
   *   Whether the disable link is expected.
   * @param bool $enable
   *   Whether the enable link is expected.
   */
  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");
    }
  }

  /**
   * Checks that the default search page matches expectations.
   *
   * @param string $expected
   *   The expected search page.
   * @param string $message
   *   (optional) A message to display with the assertion.
   * @param string $group
   *   (optional) The group this message is in.
   */
  protected function assertDefaultSearch($expected, $message = '', $group = 'Other') {

    /** @var \Drupal\search\SearchPageRepositoryInterface $search_page_repository */
    $search_page_repository = \Drupal::service('search.search_page_repository');
    $this
      ->assertSame($expected, $search_page_repository
      ->getDefaultSearchPage(), $message, $group);
  }

  /**
   * Sets a search page as the default in the UI.
   *
   * @param string $entity_id
   *   The search page entity ID to enable.
   */
  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]));
  }

}

Members

Namesort descending 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
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::installParameters protected function Returns the parameters that will be used when Simpletest installs Drupal. 9
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
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
SearchConfigSettingsFormTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
SearchConfigSettingsFormTest::$modules protected static property Modules to enable. Overrides BrowserTestBase::$modules
SearchConfigSettingsFormTest::$searchNode protected property Node indexed for searching.
SearchConfigSettingsFormTest::$searchUser protected property User who can search and administer search.
SearchConfigSettingsFormTest::assertDefaultSearch protected function Checks that the default search page matches expectations.
SearchConfigSettingsFormTest::setDefaultThroughUi protected function Sets a search page as the default in the UI.
SearchConfigSettingsFormTest::setUp protected function Overrides BrowserTestBase::setUp
SearchConfigSettingsFormTest::testDefaultSearchPageOrdering public function Tests the ordering of search pages on a clean install.
SearchConfigSettingsFormTest::testMultipleSearchPages public function Tests multiple search pages of the same type.
SearchConfigSettingsFormTest::testRouteProtection public function Tests that the enable/disable/default routes are protected from CSRF.
SearchConfigSettingsFormTest::testSearchModuleDisabling public function Verifies that you can disable individual search plugins.
SearchConfigSettingsFormTest::testSearchModuleSettingsPage public function Verifies plugin-supplied settings form.
SearchConfigSettingsFormTest::testSearchSettingsPage public function Verifies the search settings form.
SearchConfigSettingsFormTest::verifySearchPageOperations protected function Checks that the search page operations match expectations.
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.