You are here

Home » API reference » Search API Autocomplete 8 » IntegrationTest.php

class IntegrationTest in Search API Autocomplete 8

Tests the functionality of the whole module from a user's perspective.

@group search_api_autocomplete

Hierarchy

Expanded class hierarchy of IntegrationTest

File

tests/src/FunctionalJavascript/IntegrationTest.php, line 18

Namespace

Drupal\Tests\search_api_autocomplete\FunctionalJavascript
View source 
class IntegrationTest extends IntegrationTestBase {
  use ExampleContentTrait;

  /**
   * {@inheritdoc}
   */
  public static $modules = [
    'search_api_autocomplete_test',
  ];

  /**
   * The ID of the search index used in this test.
   *
   * @var string
   */
  protected $indexId = 'autocomplete_search_index';

  /**
   * The ID of the search entity created for this test.
   *
   * @var string
   */
  protected $searchId = 'search_api_autocomplete_test_view';

  /**
   * An admin user used for the tests.
   *
   * @var \Drupal\user\UserInterface
   */
  protected $adminUser;

  /**
   * A normal (non-admin) user used for the tests.
   *
   * @var \Drupal\user\UserInterface
   */
  protected $normalUser;

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $permissions = [
      'administer search_api',
      'administer search_api_autocomplete',
      'administer permissions',
      'view test entity',
    ];
    $this->adminUser = $this
      ->drupalCreateUser($permissions);
    $this->normalUser = $this
      ->drupalCreateUser();
    $this
      ->setUpExampleStructure();
    $this
      ->insertExampleContent();
  }

  /**
   * Tests the complete functionality of the module via the UI.
   */
  public function testModule() {
    $this
      ->drupalLogin($this->adminUser);
    $this
      ->enableSearch();
    $this
      ->configureSearch();
    $this
      ->checkEntityDependencies();
    $this
      ->checkSearchAutocomplete();
    $this
      ->checkSearchAutocomplete(TRUE);
    $this
      ->checkLiveResultsAutocomplete();
    $this
      ->checkCustomAutocompleteScript();
    $this
      ->checkHooks();
    $this
      ->checkPluginCacheClear();
    $this
      ->checkAutocompleteAccess();
    $this
      ->checkAdminAccess();
  }

  /**
   * Goes to the index's "Autocomplete" tab and creates/enables the test search.
   */
  protected function enableSearch() {
    $assert_session = $this
      ->assertSession();
    $this
      ->drupalGet($this
      ->getAdminPath());

    // Check whether all expected groups and searches are present.
    $assert_session
      ->pageTextContains('Search views');
    $assert_session
      ->pageTextContains('Searches provided by Views');
    $assert_session
      ->pageTextContains('Search API Autocomplete Test view');
    $assert_session
      ->pageTextContains('Test search');
    $assert_session
      ->pageTextContains('Autocomplete test module search');

    // Enable all Views searches (just one).
    $assert_session
      ->checkboxNotChecked("searches[{$this->searchId}]");
    $this
      ->click('table[data-drupal-selector="edit-search-views-searches"] > thead > tr > th.select-all input.form-checkbox');
    $assert_session
      ->checkboxChecked("searches[{$this->searchId}]");
    $this
      ->click('[data-drupal-selector="edit-actions-submit"]');
    $this
      ->logPageChange(NULL, 'POST');
    $assert_session
      ->pageTextContains('The settings have been saved. Please remember to set the permissions for the newly enabled searches.');
  }

  /**
   * Configures the test search via the UI.
   */
  protected function configureSearch() {
    $assert_session = $this
      ->assertSession();
    $this
      ->click('.dropbutton-action a[href$="/edit"]');
    $this
      ->logPageChange();
    $assert_session
      ->addressEquals($this
      ->getAdminPath('edit'));

    // The "Server" suggester shouldn't be available at that point.
    $assert_session
      ->elementExists('css', 'input[name="suggesters[enabled][search_api_autocomplete_test]"]');
    $assert_session
      ->elementNotExists('css', 'input[name="suggesters[enabled][server]"]');
    $assert_session
      ->elementNotExists('css', 'input[name="suggesters[enabled][custom_script]"]');

    // Make the test backend support autocomplete so that the "Server" suggester
    // becomes available.
    $callback = [
      TestsHelper::class,
      'getSupportedFeatures',
    ];
    $this
      ->setMethodOverride('backend', 'getSupportedFeatures', $callback);
    $callback = [
      TestsHelper::class,
      'getAutocompleteSuggestions',
    ];
    $this
      ->setMethodOverride('backend', 'getAutocompleteSuggestions', $callback);

    // After refreshing, the "Server" suggester should now be available. But by
    // default, it should not be checked (one of the others should be the only
    // one). The "Custom scripts" suggester should not be available.
    $this
      ->getSession()
      ->reload();
    $this
      ->logPageChange();
    $assert_session
      ->checkboxNotChecked('suggesters[enabled][server]');
    $assert_session
      ->elementNotExists('css', 'input[name="suggesters[enabled][custom_script]"]');

    // The "Server" suggester's config form is hidden by default, but displayed
    // once we check its "Enabled" checkbox.
    $this
      ->assertNotVisible('css', 'details[data-drupal-selector="edit-suggesters-settings-server"]');
    $this
      ->click('input[name="suggesters[enabled][server]"]');
    $this
      ->assertVisible('css', 'details[data-drupal-selector="edit-suggesters-settings-server"]');
    $page = $this
      ->getSession()
      ->getPage();
    $page
      ->findButton('Show row weights')
      ->click();
    $page
      ->find('css', 'details[data-drupal-selector="edit-suggesters-settings-server"] > summary')
      ->click();

    // Submit the form with some values for all fields.
    $edit = [
      'suggesters[enabled][live_results]' => FALSE,
      'suggesters[enabled][search_api_autocomplete_test]' => TRUE,
      'suggesters[weights][search_api_autocomplete_test][limit]' => '3',
      'suggesters[weights][server][limit]' => '3',
      'suggesters[weights][search_api_autocomplete_test][weight]' => '0',
      'suggesters[weights][server][weight]' => '10',
      'suggesters[settings][server][fields][name]' => FALSE,
      'suggesters[settings][server][fields][body]' => TRUE,
      'search_settings[displays][selected][default]' => FALSE,
      'options[limit]' => '5',
      'options[min_length]' => '2',
      'options[show_count]' => TRUE,
      'options[delay]' => '1000',
    ];
    $this
      ->submitForm($edit, 'Save');
  }

  /**
   * Verifies that the search entity's dependencies were calculated correctly.
   */
  protected function checkEntityDependencies() {

    /** @var \Drupal\search_api_autocomplete\SearchInterface $search */
    $search = Search::load($this->searchId);
    $expected = [
      'config' => [
        'search_api.index.autocomplete_search_index',
        "views.view.{$this->searchId}",
      ],
      'module' => [
        'search_api_autocomplete',
        'search_api_autocomplete_test',
        'views',
      ],
    ];
    $dependencies = $search
      ->getDependencies();
    ksort($dependencies);
    sort($dependencies['config']);
    sort($dependencies['module']);
    $this
      ->assertEquals($expected, $dependencies);
  }

  /**
   * Tests autocompletion in the search form.
   *
   * @param bool $click_url_suggestion
   *   (optional) TRUE to click the URL-based suggestion, FALSE to click one of
   *   the "normal" search keys suggestions.
   */
  protected function checkSearchAutocomplete($click_url_suggestion = FALSE) {
    $assert_session = $this
      ->assertSession();
    $this
      ->drupalGet('search-api-autocomplete-test');
    $assert_session
      ->elementAttributeContains('css', 'input[data-drupal-selector="edit-keys"]', 'data-search-api-autocomplete-search', $this->searchId);
    $elements = $this
      ->getAutocompleteSuggestions();
    $suggestions = [];
    $suggestion_elements = [];
    foreach ($elements as $element) {
      $label = $this
        ->getElementText($element, '.autocomplete-suggestion-label');
      $user_input = $this
        ->getElementText($element, '.autocomplete-suggestion-user-input');
      $suffix = $this
        ->getElementText($element, '.autocomplete-suggestion-suggestion-suffix');
      $count = $this
        ->getElementText($element, '.autocomplete-suggestion-results-count');
      $keys = $label . $user_input . $suffix;
      $suggestions[] = [
        'keys' => $keys,
        'count' => $count,
      ];
      $suggestion_elements[$keys] = $element;
    }
    $expected = [
      [
        'keys' => 'Tést-suggester-1',
        'count' => 1,
      ],
      [
        'keys' => 'Tést-suggester-2',
        'count' => 2,
      ],
      [
        'keys' => 'Tést-suggester-url',
        'count' => NULL,
      ],
      [
        'keys' => 'Tést-backend-1',
        'count' => 1,
      ],
      [
        'keys' => 'Tést-backend-2',
        'count' => 2,
      ],
    ];
    $this
      ->assertEquals($expected, $suggestions);

    // Make sure the query looks as it should.

    /** @var \Drupal\search_api\Query\QueryInterface $query */
    list($query) = $this
      ->getMethodArguments('backend', 'getAutocompleteSuggestions');
    $this
      ->assertFalse($query
      ->wasAborted());
    $this
      ->assertEquals([
      'body',
    ], $query
      ->getFulltextFields());
    $this
      ->assertEquals([
      'en',
    ], array_values($query
      ->getLanguages()));
    if ($click_url_suggestion) {

      // Click the URL suggestion and verify it correctly redirects the browser
      // to that URL.
      $suggestion_elements['Tést-suggester-url']
        ->click();
      $this
        ->logPageChange();
      $assert_session
        ->addressEquals("/user/{$this->adminUser->id()}");
      return;
    }

    // Click one of the search key suggestions. The form should now auto-submit.
    $keys = 'Tést-suggester-1';
    $suggestion_elements[$keys]
      ->click();
    $this
      ->logPageChange();
    $keys = urlencode($keys);

    // @todo Replace with $assert_session->addressMatches() (and prepend "^")
    //   once we depend on Drupal 9.1+.
    $this
      ->assertRegExp("#/search-api-autocomplete-test\\?(?:.*&)?keys={$keys}#", $this
      ->getUrl());

    // Check that autocomplete in the "Name" filter works, too, and that it sets
    // the correct fields on the query.
    $this
      ->getAutocompleteSuggestions('edit-name-value');
    list($query) = $this
      ->getMethodArguments('suggester', 'getAutocompleteSuggestions');
    $this
      ->assertEquals([
      'name',
    ], $query
      ->getFulltextFields());
  }

  /**
   * Tests autocomplete with the "Live results" suggester.
   */
  protected function checkLiveResultsAutocomplete() {
    $assert_session = $this
      ->assertSession();

    // First, enable "Live results" as the only suggester.
    $this
      ->drupalGet($this
      ->getAdminPath('edit'));
    $page = $this
      ->getSession()
      ->getPage();
    $this
      ->click('input[name="suggesters[enabled][live_results]"]');
    $page
      ->find('css', 'details[data-drupal-selector="edit-suggesters-settings-live-results"] > summary')
      ->click();
    $edit = [
      'suggesters[enabled][live_results]' => TRUE,
      'suggesters[enabled][search_api_autocomplete_test]' => FALSE,
      'suggesters[enabled][server]' => FALSE,
      'suggesters[settings][live_results][fields][name]' => FALSE,
      'suggesters[settings][live_results][fields][body]' => TRUE,
    ];
    $this
      ->submitForm($edit, 'Save');
    $assert_session
      ->pageTextContains('The autocompletion settings for the search have been saved.');

    // Then, set an appropriate search method for the test backend.
    $callback = [
      TestsHelper::class,
      'search',
    ];
    $this
      ->setMethodOverride('backend', 'search', $callback);

    // Get the autocompletion results.
    $this
      ->drupalGet('search-api-autocomplete-test');
    $suggestions = [];
    foreach ($this
      ->getAutocompleteSuggestions() as $element) {
      $label = $this
        ->getElementText($element, '.autocomplete-suggestion-label');
      $suggestions[$label] = $element;
    }

    // Make sure the suggestions are as expected.
    $expected = [
      $this->entities[3]
        ->label(),
      $this->entities[4]
        ->label(),
      $this->entities[2]
        ->label(),
    ];
    $this
      ->assertEquals($expected, array_keys($suggestions));

    // Make sure all the search query settings were as expected.

    /** @var \Drupal\search_api\Query\QueryInterface $query */
    $query = $this
      ->getMethodArguments('backend', 'search')[0];
    $this
      ->assertInstanceOf(QueryInterface::class, $query);
    $this
      ->assertEquals(0, $query
      ->getOption('offset'));
    $this
      ->assertEquals(5, $query
      ->getOption('limit'));
    $this
      ->assertEquals([
      'body',
    ], $query
      ->getFulltextFields());
    $this
      ->assertEquals('Tést', $query
      ->getOriginalKeys());

    // Click on one of the suggestions and verify it takes us to the expected
    // page.
    $suggestions[$this->entities[3]
      ->label()]
      ->click();
    $this
      ->logPageChange();
    $path = $this->entities[3]
      ->toUrl()
      ->getInternalPath();
    $assert_session
      ->addressEquals('/' . $path);
  }

  /**
   * Tests whether using a custom autocomplete script is properly supported.
   *
   * @see \Drupal\search_api_autocomplete\Plugin\search_api_autocomplete\suggester\CustomScript
   */
  protected function checkCustomAutocompleteScript() {
    $assert_session = $this
      ->assertSession();
    \Drupal::configFactory()
      ->getEditable('search_api_autocomplete.settings')
      ->set('enable_custom_scripts', TRUE)
      ->save();
    $this
      ->drupalGet($this
      ->getAdminPath('edit'));

    // This gets the request path to the "tests" directory.
    $path = str_replace(DRUPAL_ROOT, '', dirname(dirname(__DIR__)));
    $path .= '/search_api_autocomplete_test/core/custom_autocomplete_script.php';
    $this
      ->click('input[name="suggesters[enabled][custom_script]"]');
    $page = $this
      ->getSession()
      ->getPage();
    $page
      ->find('css', 'details[data-drupal-selector="edit-suggesters-settings-custom-script"] > summary')
      ->click();
    $edit = [
      'suggesters[enabled][custom_script]' => TRUE,
      'suggesters[settings][custom_script][path]' => $path,
    ];
    $this
      ->submitForm($edit, 'Save');
    $this
      ->drupalGet('search-api-autocomplete-test');
    $assert_session
      ->elementAttributeContains('css', 'input[data-drupal-selector="edit-keys"]', 'data-search-api-autocomplete-search', $this->searchId);
    $elements = $this
      ->getAutocompleteSuggestions();
    $this
      ->assertCount(4, $elements);
    $suggestions = [];
    foreach ($elements as $element) {
      $suggestions[] = $element
        ->getText();
    }
    sort($suggestions);
    $expected = [
      'display: page',
      'filter: keys',
      'q: Tést',
      "search_api_autocomplete_search: {$this->searchId}",
    ];
    $this
      ->assertEquals($expected, $suggestions, 'Unexpected suggestions returned by custom script.');
    $this
      ->drupalGet($this
      ->getAdminPath('edit'));
    $page = $this
      ->getSession()
      ->getPage();
    $page
      ->find('css', 'details[data-drupal-selector="edit-suggesters-settings-custom-script"] > summary')
      ->click();
    $edit = [
      'suggesters[settings][custom_script][path]' => '',
      'suggesters[enabled][custom_script]' => FALSE,
    ];
    $this
      ->submitForm($edit, 'Save');
  }

  /**
   * Checks that the module's hooks work as expected.
   */
  protected function checkHooks() {
    $assert_session = $this
      ->assertSession();
    \Drupal::getContainer()
      ->get('module_installer')
      ->install([
      'search_api_autocomplete_test_hooks',
    ]);
    $this
      ->drupalGet($this
      ->getAdminPath());
    $assert_session
      ->pageTextContains('The Siren');
    $assert_session
      ->pageTextContains('Planet Hell');
    $assert_session
      ->pageTextNotContains('Search views');
    $assert_session
      ->pageTextNotContains('Searches provided by Views');
    $this
      ->drupalGet($this
      ->getAdminPath('edit'));
    $assert_session
      ->pageTextContains('Wish I Had an Angel');
    $assert_session
      ->pageTextNotContains('Test suggester');
    $this
      ->drupalGet('search-api-autocomplete-test');
    $assert_session
      ->pageTextContains("Creek Mary's Blood");
    $autocomplete_path = "search_api_autocomplete/{$this->searchId}";
    $this
      ->drupalGet($autocomplete_path, [
      'query' => [
        'q' => 'test',
      ],
    ]);
    $assert_session
      ->responseContains('dark chest of wonders');
    \Drupal::getContainer()
      ->get('module_installer')
      ->uninstall([
      'search_api_autocomplete_test_hooks',
    ]);
  }

  /**
   * Verifies that creating or deleting a view clears the search plugin cache.
   */
  protected function checkPluginCacheClear() {
    $assert_session = $this
      ->assertSession();
    $new_view_label = 'Search plugin cache test';
    $this
      ->drupalGet($this
      ->getAdminPath());
    $assert_session
      ->pageTextNotContains($new_view_label);
    $view = View::load('search_api_autocomplete_test_view')
      ->createDuplicate();
    $view
      ->set('id', 'search_plugin_cache_test');
    $view
      ->set('label', $new_view_label);
    $display = $view
      ->get('display');
    $display['page']['display_options']['path'] = 'some/new/path';
    $view
      ->set('display', $display);
    $view
      ->save();
    $this
      ->drupalGet($this
      ->getAdminPath());
    $assert_session
      ->pageTextContains($new_view_label);
    $view
      ->delete();
    $this
      ->drupalGet($this
      ->getAdminPath());
    $assert_session
      ->pageTextNotContains($new_view_label);
  }

  /**
   * Verifies that autocomplete is only applied after access checks.
   */
  protected function checkAutocompleteAccess() {
    $assert_session = $this
      ->assertSession();

    // Make sure autocomplete functionality is only available for users with the
    // right permission.
    $users = [
      'non-admin' => $this->normalUser,
      'anonymous' => NULL,
    ];
    $permission = "use search_api_autocomplete for {$this->searchId}";
    $autocomplete_path = "search_api_autocomplete/{$this->searchId}";
    foreach ($users as $user_type => $account) {
      $this
        ->drupalLogout();
      if ($account) {
        $this
          ->drupalLogin($account);
      }
      $this
        ->drupalGet('search-api-autocomplete-test');
      $element = $assert_session
        ->elementExists('css', 'input[data-drupal-selector="edit-keys"]');
      $this
        ->assertFalse($element
        ->hasAttribute('data-search-api-autocomplete-search'), "Autocomplete should not be enabled for {$user_type} user without the necessary permission.");
      $this
        ->assertFalse($element
        ->hasClass('form-autocomplete'), "Autocomplete should not be enabled for {$user_type} user without the necessary permission.");
      $this
        ->drupalGet($autocomplete_path, [
        'query' => [
          'q' => 'test',
        ],
      ]);
      $assert_session
        ->pageTextContains('Access denied');
      $assert_session
        ->pageTextContains('You are not authorized to access this page.');
      $rid = $account ? 'authenticated' : 'anonymous';
      $role = Role::load($rid);
      $role
        ->grantPermission($permission);
      $role
        ->save();
      $this
        ->drupalGet('search-api-autocomplete-test');
      $element = $assert_session
        ->elementExists('css', 'input[data-drupal-selector="edit-keys"]');
      $this
        ->assertTrue($element
        ->hasAttribute('data-search-api-autocomplete-search'), "Autocomplete should not be enabled for {$user_type} user without the necessary permission.");

      // @todo Remove check once we depend on Drupal 9.0+.
      if (method_exists($this, 'assertStringContainsString')) {
        $this
          ->assertStringContainsString($this->searchId, $element
          ->getAttribute('data-search-api-autocomplete-search'), "Autocomplete should not be enabled for {$user_type} user without the necessary permission.");
      }
      else {
        $this
          ->assertContains($this->searchId, $element
          ->getAttribute('data-search-api-autocomplete-search'), "Autocomplete should not be enabled for {$user_type} user without the necessary permission.");
      }
      $this
        ->assertTrue($element
        ->hasClass('form-autocomplete'), "Autocomplete should not be enabled for {$user_type} user without the necessary permission.");
      $this
        ->drupalGet($autocomplete_path, [
        'query' => [
          'q' => 'test',
        ],
      ]);
    }
    $this
      ->drupalLogin($this->adminUser);
  }

  /**
   * Verifies that admin pages are properly protected.
   */
  protected function checkAdminAccess() {
    $assert_session = $this
      ->assertSession();

    // Make sure anonymous and non-admin users cannot access admin pages.
    $users = [
      'non-admin' => $this->normalUser,
      'anonymous' => NULL,
    ];
    $paths = [
      'index overview' => $this
        ->getAdminPath(),
      'search edit form' => $this
        ->getAdminPath('edit'),
      'search delete form' => $this
        ->getAdminPath('delete'),
    ];
    foreach ($users as $user_type => $account) {
      $this
        ->drupalLogout();
      if ($account) {
        $this
          ->drupalLogin($account);
      }
      foreach ($paths as $label => $path) {
        $this
          ->drupalGet($path);
        $assert_session
          ->pageTextContains('Access denied');
        $assert_session
          ->pageTextContains('You are not authorized to access this page.');
      }
    }
    $this
      ->drupalLogin($this->adminUser);
  }

  /**
   * Returns the path of an admin page.
   *
   * @param string|null $page
   *   (optional) Either "edit" or "delete" to get the path of the respective
   *   search form, or NULL for the index's "Autocomplete" tab.
   * @param string|null $search_id
   *   (optional) The ID of the search to link to, if a page is specified. NULL
   *   to use the default search used by this test.
   *
   * @return string
   *   The internal path to the specified page.
   */
  protected function getAdminPath($page = NULL, $search_id = NULL) {
    $path = 'admin/config/search/search-api/index/autocomplete_search_index/autocomplete';
    if ($page !== NULL) {
      if ($search_id === NULL) {
        $search_id = $this->searchId;
      }
      $path .= "/{$search_id}/{$page}";
    }
    return $path;
  }

  /**
   * Logs a page change, if HTML output logging is enabled.
   *
   * The base class only logs requests when the drupalGet() or drupalPost()
   * methods are used, so we need to implement this ourselves for other page
   * changes.
   *
   * To enable HTML output logging, create some file where links to the logged
   * pages should be placed and set the "BROWSERTEST_OUTPUT_FILE" environment
   * variable to that file's path.
   *
   * @param string|null $url
   *   (optional) The URL requested, if not the current URL.
   * @param string $method
   *   (optional) The HTTP method used for the request.
   *
   * @see \Drupal\Tests\BrowserTestBase::drupalGet()
   * @see \Drupal\Tests\BrowserTestBase::setUp()
   */
  protected function logPageChange($url = NULL, $method = 'GET') {
    $session = $this
      ->getSession();
    $driver = $session
      ->getDriver();
    if (!$this->htmlOutputEnabled || $driver instanceof GoutteDriver) {
      return;
    }
    $current_url = $session
      ->getCurrentUrl();
    $url = $url ?: $current_url;
    $html_output = "{$method} request to: {$url}<hr />Ending URL: {$current_url}";
    $html_output .= '<hr />' . $session
      ->getPage()
      ->getContent();
    $html_output .= $this
      ->getHtmlOutputHeaders();
    $this
      ->htmlOutput($html_output);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AssertHelperTrait::castSafeStrings protected static function Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::assertCacheTag protected function Asserts whether an expected cache tag was present in the last response.
AssertLegacyTrait::assertElementNotPresent protected function Asserts that the element with the given CSS selector is not present.
AssertLegacyTrait::assertElementPresent protected function Asserts that the element with the given CSS selector is present.
AssertLegacyTrait::assertEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertLegacyTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertLegacyTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertLegacyTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertLegacyTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertLegacyTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertLegacyTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertLegacyTrait::assertHeader protected function Checks that current response header equals value.
AssertLegacyTrait::assertIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead.
AssertLegacyTrait::assertIdenticalObject protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertLink protected function Passes if a link with the specified label is found.
AssertLegacyTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertLegacyTrait::assertNoCacheTag protected function Asserts whether an expected cache tag was absent in the last response.
AssertLegacyTrait::assertNoEscaped protected function Passes if the raw text is not found escaped on the loaded page.
AssertLegacyTrait::assertNoField protected function Asserts that a field does NOT exist with the given name or ID.
AssertLegacyTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertLegacyTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertLegacyTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertLegacyTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertLegacyTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertLegacyTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertLegacyTrait::assertNoOption protected function Asserts that a select option does NOT exist in the current page.
AssertLegacyTrait::assertNoPattern protected function Triggers a pass if the Perl regex pattern is not found in the raw content.
AssertLegacyTrait::assertNoRaw protected function Passes if the raw text IS not found on the loaded page, fail otherwise. 1
AssertLegacyTrait::assertNotEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text. 1
AssertLegacyTrait::assertNotIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertLegacyTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertLegacyTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertLegacyTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertLegacyTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertLegacyTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise. 1
AssertLegacyTrait::assertResponse protected function Asserts the page responds with the specified response code. 1
AssertLegacyTrait::assertText protected function Passes if the page (with HTML stripped) contains the text. 1
AssertLegacyTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertLegacyTrait::assertTitle protected function Pass if the page title is the given string.
AssertLegacyTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertLegacyTrait::assertUrl protected function Passes if the internal browser's URL matches the given path.
AssertLegacyTrait::buildXPathQuery protected function Builds an XPath query.
AssertLegacyTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertLegacyTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertLegacyTrait::getRawContent protected function Gets the current raw content.
AssertLegacyTrait::pass protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::verbose 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::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
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::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
BrowserTestBase::drupalGetHeader protected function Gets the value of an HTTP response header.
BrowserTestBase::drupalGetHeaders Deprecated protected function Returns all response headers.
BrowserTestBase::filePreDeleteCallback public static function Ensures test files are deletable.
BrowserTestBase::getDefaultDriverInstance protected function Gets an instance of the default Mink driver.
BrowserTestBase::getHttpClient protected function Obtain the HTTP client for the system under test.
BrowserTestBase::getOptions protected function Helper function to get the options of select field.
BrowserTestBase::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received. Overrides BrowserHtmlDebugTrait::getResponseLogHandler
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::installDrupal public function Installs Drupal into the Simpletest site. 1
BrowserTestBase::registerSessions protected function Registers additional Mink sessions.
BrowserTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for drupalPostForm().
BrowserTestBase::xpath protected function Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__construct public function 1
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
ExampleContentTrait::$entities protected property The generated test entities, keyed by ID.
ExampleContentTrait::$ids protected property The Search API item IDs of the generated entities.
ExampleContentTrait::addTestEntity protected function Creates and saves a test entity with the given values.
ExampleContentTrait::getItemIds protected function Returns the item IDs for the given entity IDs. 1
ExampleContentTrait::indexItems protected function Indexes all (unindexed) items on the specified index.
ExampleContentTrait::insertExampleContent protected function Creates several test entities.
ExampleContentTrait::removeTestEntity protected function Deletes the test entity with the given ID.
ExampleContentTrait::setUpExampleStructure protected function Sets up the necessary bundles on the test entity type.
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::$configDirectories Deprecated protected property The config directories used in this test.
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. 2
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::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. 23
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.
IntegrationTest::$adminUser protected property An admin user used for the tests.
IntegrationTest::$indexId protected property The ID of the search index used in this test.
IntegrationTest::$modules public static property Modules to enable. Overrides BrowserTestBase::$modules
IntegrationTest::$normalUser protected property A normal (non-admin) user used for the tests.
IntegrationTest::$searchId protected property The ID of the search entity created for this test. Overrides IntegrationTestBase::$searchId
IntegrationTest::checkAdminAccess protected function Verifies that admin pages are properly protected.
IntegrationTest::checkAutocompleteAccess protected function Verifies that autocomplete is only applied after access checks.
IntegrationTest::checkCustomAutocompleteScript protected function Tests whether using a custom autocomplete script is properly supported.
IntegrationTest::checkEntityDependencies protected function Verifies that the search entity's dependencies were calculated correctly.
IntegrationTest::checkHooks protected function Checks that the module's hooks work as expected.
IntegrationTest::checkLiveResultsAutocomplete protected function Tests autocomplete with the "Live results" suggester.
IntegrationTest::checkPluginCacheClear protected function Verifies that creating or deleting a view clears the search plugin cache.
IntegrationTest::checkSearchAutocomplete protected function Tests autocompletion in the search form.
IntegrationTest::configureSearch protected function Configures the test search via the UI.
IntegrationTest::enableSearch protected function Goes to the index's "Autocomplete" tab and creates/enables the test search.
IntegrationTest::getAdminPath protected function Returns the path of an admin page. Overrides IntegrationTestBase::getAdminPath
IntegrationTest::logPageChange protected function Logs a page change, if HTML output logging is enabled. Overrides IntegrationTestBase::logPageChange
IntegrationTest::setUp protected function Overrides BrowserTestBase::setUp
IntegrationTest::testModule public function Tests the complete functionality of the module via the UI.
IntegrationTestBase::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
IntegrationTestBase::assertNotVisible protected function Asserts that the specified element exists but is not visible.
IntegrationTestBase::assertVisible protected function Asserts that the specified element exists and is visible.
IntegrationTestBase::getAutocompleteSuggestions protected function Retrieves autocomplete suggestions from a field on the current page.
IntegrationTestBase::getElementText protected function Retrieves the text contents of a descendant of the given element.
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
PhpunitCompatibilityTrait::getMock Deprecated public function Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated public function Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
PluginTestTrait::getCalledMethods protected function Retrieves the methods called on a given plugin.
PluginTestTrait::getMethodArguments protected function Retrieves the arguments of a certain method called on the given plugin.
PluginTestTrait::setError protected function Sets an exception to be thrown on calls to the given method.
PluginTestTrait::setMethodOverride protected function Overrides a method for a certain plugin.
PluginTestTrait::setReturnValue protected function Sets the return value for a certain method on a test plugin.
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. 3
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. 2
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. 2
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::buildUrl protected function Builds an a 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::drupalGet protected function Retrieves a Drupal path or an absolute path. 3
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 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::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.
WebDriverTestBase::$disableCssAnimations protected property Disables CSS animations in tests for more reliable testing.
WebDriverTestBase::$minkDefaultDriverClass protected property To use a legacy phantomjs based approach, please use PhantomJSDriver::class. Overrides BrowserTestBase::$minkDefaultDriverClass 2
WebDriverTestBase::assertElementNotVisible Deprecated protected function Asserts that the element with the given CSS selector is not visible.
WebDriverTestBase::assertElementVisible Deprecated protected function Asserts that the element with the given CSS selector is visible.
WebDriverTestBase::assertJsCondition protected function Waits for the given time or until the given JS condition becomes TRUE.
WebDriverTestBase::assertSession public function Returns WebAssert object. Overrides UiHelperTrait::assertSession 1
WebDriverTestBase::createScreenshot protected function Creates a screenshot.
WebDriverTestBase::getDrupalSettings protected function Gets the current Drupal javascript settings and parses into an array. Overrides BrowserTestBase::getDrupalSettings
WebDriverTestBase::getHtmlOutputHeaders protected function Returns headers in HTML output format. Overrides BrowserHtmlDebugTrait::getHtmlOutputHeaders
WebDriverTestBase::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. Overrides BrowserTestBase::getMinkDriverArgs
WebDriverTestBase::initFrontPage protected function Visits the front page when initializing Mink. Overrides BrowserTestBase::initFrontPage
WebDriverTestBase::initMink protected function Initializes Mink sessions. Overrides BrowserTestBase::initMink 1
WebDriverTestBase::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. Overrides FunctionalTestSetupTrait::installModulesFromClassProperty
WebDriverTestBase::tearDown protected function Overrides BrowserTestBase::tearDown 1
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.