abstract class ViewTestBase in Drupal 9
Same name and namespace in other branches
- 8 core/modules/views/tests/src/Functional/ViewTestBase.php \Drupal\Tests\views\Functional\ViewTestBase
- 10 core/modules/views/tests/src/Functional/ViewTestBase.php \Drupal\Tests\views\Functional\ViewTestBase
Defines a base class for Views testing in the full web test environment.
Use this base test class if you need to emulate a full Drupal installation. When possible, ViewsKernelTestBase should be used instead. Both base classes include the same methods.
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\views\Functional\ViewTestBase uses ViewResultAssertionTrait
 
Expanded class hierarchy of ViewTestBase
See also
\Drupal\Tests\views\Kernel\ViewsKernelTestBase
70 files declare their use of ViewTestBase
- AccessTest.php in core/modules/ views/ tests/ src/ Functional/ Plugin/ AccessTest.php 
- AreaHTTPStatusCodeTest.php in core/modules/ views/ tests/ src/ Functional/ Handler/ AreaHTTPStatusCodeTest.php 
- AreaTest.php in core/modules/ views/ tests/ src/ Functional/ Handler/ AreaTest.php 
- AreaTitleWebTest.php in core/modules/ views/ tests/ src/ Functional/ Handler/ AreaTitleWebTest.php 
- ArgumentDefaultTest.php in core/modules/ views/ tests/ src/ Functional/ Plugin/ ArgumentDefaultTest.php 
File
- core/modules/ views/ tests/ src/ Functional/ ViewTestBase.php, line 21 
Namespace
Drupal\Tests\views\FunctionalView source
abstract class ViewTestBase extends BrowserTestBase {
  use ViewResultAssertionTrait;
  /**
   * Modules to enable.
   *
   * @var array
   */
  protected static $modules = [
    'views',
    'views_test_config',
  ];
  protected function setUp($import_test_views = TRUE) {
    parent::setUp();
    if ($import_test_views) {
      ViewTestData::createTestViews(static::class, [
        'views_test_config',
      ]);
    }
  }
  /**
   * Sets up the views_test_data.module.
   *
   * Because the schema of views_test_data.module is dependent on the test
   * using it, it cannot be enabled normally.
   */
  protected function enableViewsTestModule() {
    // Define the schema and views data variable before enabling the test module.
    \Drupal::state()
      ->set('views_test_data_schema', $this
      ->schemaDefinition());
    \Drupal::state()
      ->set('views_test_data_views_data', $this
      ->viewsData());
    \Drupal::service('module_installer')
      ->install([
      'views_test_data',
    ]);
    $this
      ->resetAll();
    $this
      ->rebuildContainer();
    $this->container
      ->get('module_handler')
      ->reload();
    // Load the test dataset.
    $data_set = $this
      ->dataSet();
    $query = Database::getConnection()
      ->insert('views_test_data')
      ->fields(array_keys($data_set[0]));
    foreach ($data_set as $record) {
      $query
        ->values($record);
    }
    $query
      ->execute();
  }
  /**
   * Orders a nested array containing a result set based on a given column.
   *
   * @param array $result_set
   *   An array of rows from a result set, with each row as an associative
   *   array keyed by column name.
   * @param string $column
   *   The column name by which to sort the result set.
   * @param bool $reverse
   *   (optional) Boolean indicating whether to sort the result set in reverse
   *   order. Defaults to FALSE.
   *
   * @return array
   *   The sorted result set.
   */
  protected function orderResultSet($result_set, $column, $reverse = FALSE) {
    $order = $reverse ? -1 : 1;
    usort($result_set, function ($a, $b) use ($column, $order) {
      if ($a[$column] == $b[$column]) {
        return 0;
      }
      return $order * ($a[$column] < $b[$column] ? -1 : 1);
    });
    return $result_set;
  }
  /**
   * Asserts the existence of a button with a certain ID and label.
   *
   * @param string $id
   *   The HTML ID of the button
   * @param string $expected_label
   *   The expected label for the button.
   * @param string $message
   *   (optional) A custom message to display with the assertion. If no custom
   *   message is provided, the message will indicate the button label.
   *
   * @throws \Behat\Mink\Exception\ElementNotFoundException
   */
  protected function helperButtonHasLabel($id, $expected_label, $message = 'Label has the expected value: %label.') {
    $xpath = $this
      ->assertSession()
      ->buildXPathQuery('//button[@id=:value]|//input[@id=:value]', [
      ':value' => $id,
    ]);
    $field = $this
      ->getSession()
      ->getPage()
      ->find('xpath', $xpath);
    if (empty($field)) {
      throw new ElementNotFoundException($this
        ->getSession()
        ->getDriver(), 'form field', 'id', $field);
    }
    $this
      ->assertEquals($expected_label, $field
      ->getValue());
  }
  /**
   * Executes a view.
   *
   * @param \Drupal\views\ViewExecutable $view
   *   The view object.
   * @param array $args
   *   (optional) An array of the view arguments to use for the view.
   */
  protected function executeView(ViewExecutable $view, $args = []) {
    // A view does not really work outside of a request scope, due to many
    // dependencies like the current user.
    $view
      ->setDisplay();
    $view
      ->preExecute($args);
    $view
      ->execute();
  }
  /**
   * Returns the schema definition.
   *
   * @internal
   */
  protected function schemaDefinition() {
    return ViewTestData::schemaDefinition();
  }
  /**
   * Returns the views data definition.
   */
  protected function viewsData() {
    return ViewTestData::viewsData();
  }
  /**
   * Returns a very simple test dataset.
   */
  protected function dataSet() {
    return ViewTestData::dataSet();
  }
}Members
| Name   | Modifiers | Type | Description | Overrides | 
|---|---|---|---|---|
| AssertLegacyTrait:: | protected | function | ||
| AssertLegacyTrait:: | protected | function | Asserts whether an expected cache tag was present in the last response. | |
| AssertLegacyTrait:: | protected | function | Asserts that the element with the given CSS selector is not present. | |
| AssertLegacyTrait:: | protected | function | Asserts that the element with the given CSS selector is present. | |
| AssertLegacyTrait:: | protected | function | ||
| AssertLegacyTrait:: | protected | function | Passes if the raw text IS found escaped on the loaded page, fail otherwise. | |
| AssertLegacyTrait:: | protected | function | Asserts that a field exists with the given name or ID. | |
| AssertLegacyTrait:: | protected | function | Asserts that a field exists with the given ID and value. | |
| AssertLegacyTrait:: | protected | function | Asserts that a field exists with the given name and value. | |
| AssertLegacyTrait:: | protected | function | Asserts that a field exists in the current page by the given XPath. | |
| AssertLegacyTrait:: | protected | function | Asserts that a checkbox field in the current page is checked. | |
| AssertLegacyTrait:: | protected | function | Asserts that a field exists in the current page with a given Xpath result. | |
| AssertLegacyTrait:: | protected | function | Checks that current response header equals value. | |
| AssertLegacyTrait:: | protected | function | ||
| AssertLegacyTrait:: | protected | function | ||
| AssertLegacyTrait:: | protected | function | Passes if a link with the specified label is found. | |
| AssertLegacyTrait:: | protected | function | Passes if a link containing a given href (part) is found. | |
| AssertLegacyTrait:: | protected | function | Asserts whether an expected cache tag was absent in the last response. | |
| AssertLegacyTrait:: | protected | function | Passes if the raw text is not found escaped on the loaded page. | |
| AssertLegacyTrait:: | protected | function | Asserts that a field does NOT exist with the given name or ID. | |
| AssertLegacyTrait:: | protected | function | Asserts that a field does not exist with the given ID and value. | |
| AssertLegacyTrait:: | protected | function | Asserts that a field does not exist with the given name and value. | |
| AssertLegacyTrait:: | protected | function | Asserts that a field does not exist or its value does not match, by XPath. | |
| AssertLegacyTrait:: | protected | function | Asserts that a checkbox field in the current page is not checked. | |
| AssertLegacyTrait:: | protected | function | Passes if a link with the specified label is not found. | |
| AssertLegacyTrait:: | protected | function | Passes if a link containing a given href (part) is not found. | |
| AssertLegacyTrait:: | protected | function | Asserts that a select option does NOT exist in the current page. | |
| AssertLegacyTrait:: | protected | function | Triggers a pass if the Perl regex pattern is not found in the raw content. | |
| AssertLegacyTrait:: | protected | function | Passes if the raw text IS not found on the loaded page, fail otherwise. | |
| AssertLegacyTrait:: | protected | function | ||
| AssertLegacyTrait:: | protected | function | Passes if the page (with HTML stripped) does not contains the text. | |
| AssertLegacyTrait:: | protected | function | ||
| AssertLegacyTrait:: | protected | function | Passes if the text is found MORE THAN ONCE on the text version of the page. | |
| AssertLegacyTrait:: | protected | function | Asserts that a select option in the current page exists. | |
| AssertLegacyTrait:: | protected | function | Asserts that a select option with the visible text exists. | |
| AssertLegacyTrait:: | protected | function | Asserts that a select option in the current page is checked. | |
| AssertLegacyTrait:: | protected | function | Triggers a pass if the Perl regex pattern is found in the raw content. | |
| AssertLegacyTrait:: | protected | function | Passes if the raw text IS found on the loaded page, fail otherwise. | |
| AssertLegacyTrait:: | protected | function | Asserts the page responds with the specified response code. | |
| AssertLegacyTrait:: | protected | function | Passes if the page (with HTML stripped) contains the text. | |
| AssertLegacyTrait:: | protected | function | Helper for assertText and assertNoText. | |
| AssertLegacyTrait:: | protected | function | Pass if the page title is the given string. | |
| AssertLegacyTrait:: | protected | function | Passes if the text is found ONLY ONCE on the text version of the page. | |
| AssertLegacyTrait:: | protected | function | Passes if the internal browser's URL matches the given path. | |
| AssertLegacyTrait:: | protected | function | Builds an XPath query. | |
| AssertLegacyTrait:: | protected | function | Helper: Constructs an XPath for the given set of attributes and value. | |
| AssertLegacyTrait:: | protected | function | Get all option elements, including nested options, in a select. | |
| AssertLegacyTrait:: | protected | function | Gets the current raw content. | |
| AssertLegacyTrait:: | protected | function | ||
| AssertLegacyTrait:: | protected | function | ||
| BlockCreationTrait:: | protected | function | Creates a block instance based on default settings. Aliased as: drupalPlaceBlock | |
| BrowserHtmlDebugTrait:: | protected | property | The Base URI to use for links to the output files. | |
| BrowserHtmlDebugTrait:: | protected | property | Class name for HTML output logging. | |
| BrowserHtmlDebugTrait:: | protected | property | Counter for HTML output logging. | |
| BrowserHtmlDebugTrait:: | protected | property | Counter storage for HTML output logging. | |
| BrowserHtmlDebugTrait:: | protected | property | Directory name for HTML output logging. | |
| BrowserHtmlDebugTrait:: | protected | property | HTML output output enabled. | |
| BrowserHtmlDebugTrait:: | protected | property | The file name to write the list of URLs to. | |
| BrowserHtmlDebugTrait:: | protected | property | HTML output test ID. | |
| BrowserHtmlDebugTrait:: | protected | function | Formats HTTP headers as string for HTML output logging. | |
| BrowserHtmlDebugTrait:: | protected | function | Returns headers in HTML output format. | 1 | 
| BrowserHtmlDebugTrait:: | protected | function | Provides a Guzzle middleware handler to log every response received. | |
| BrowserHtmlDebugTrait:: | protected | function | Logs a HTML output message in a text file. | |
| BrowserHtmlDebugTrait:: | protected | function | Creates the directory to store browser output. | |
| BrowserTestBase:: | protected | property | The base URL. | |
| BrowserTestBase:: | protected | property | The config importer that can be used in a test. | |
| BrowserTestBase:: | protected | property | An array of custom translations suitable for drupal_rewrite_settings(). | |
| BrowserTestBase:: | protected | property | The database prefix of this test run. | |
| BrowserTestBase:: | protected | property | The theme to install as the default for testing. | 1,607 | 
| BrowserTestBase:: | protected | property | Mink session manager. | |
| BrowserTestBase:: | protected | property | Mink default driver params. | |
| BrowserTestBase:: | protected | property | Mink class for the default driver to use. | 1 | 
| BrowserTestBase:: | protected | property | The original container. | |
| BrowserTestBase:: | protected | property | The original array of shutdown function callbacks. | |
| BrowserTestBase:: | protected | property | ||
| BrowserTestBase:: | protected | property | The profile to install as a basis for testing. | 39 | 
| BrowserTestBase:: | protected | property | The app root. | |
| BrowserTestBase:: | protected | property | Browser tests are run in separate processes to prevent collisions between code that may be loaded by tests. | |
| BrowserTestBase:: | protected | property | Time limit in seconds for the test. | |
| BrowserTestBase:: | protected | property | The translation file directory for the test environment. | |
| BrowserTestBase:: | protected | function | Clean up the Simpletest environment. | |
| BrowserTestBase:: | protected | function | Configuration accessor for tests. Returns non-overridden configuration. | |
| BrowserTestBase:: | protected | function | Gets the value of an HTTP response header. | |
| BrowserTestBase:: | public static | function | Ensures test files are deletable. | |
| BrowserTestBase:: | protected | function | Gets an instance of the default Mink driver. | |
| BrowserTestBase:: | protected | function | Gets the JavaScript drupalSettings variable for the currently-loaded page. | 1 | 
| BrowserTestBase:: | protected | function | Obtain the HTTP client for the system under test. | |
| BrowserTestBase:: | 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:: | protected | function | Helper function to get the options of select field. | |
| BrowserTestBase:: | public | function | Returns Mink session. | |
| BrowserTestBase:: | protected | function | Get session cookies from current session. | |
| BrowserTestBase:: | protected | function | Retrieves the current calling line in the class under test. Overrides BrowserHtmlDebugTrait:: | |
| BrowserTestBase:: | protected | function | Visits the front page when initializing Mink. | 3 | 
| BrowserTestBase:: | protected | function | Initializes Mink sessions. | 1 | 
| BrowserTestBase:: | public | function | Installs Drupal into the Simpletest site. | 1 | 
| BrowserTestBase:: | protected | function | Registers additional Mink sessions. | |
| BrowserTestBase:: | protected | function | Sets up the root application path. | |
| BrowserTestBase:: | public static | function | 1 | |
| BrowserTestBase:: | protected | function | 3 | |
| BrowserTestBase:: | protected | function | Transforms a nested array into a flat array suitable for submitForm(). | |
| BrowserTestBase:: | protected | function | Performs an xpath search on the contents of the internal browser. | |
| BrowserTestBase:: | public | function | Prevents serializing any properties. | |
| ConfigTestTrait:: | protected | function | Returns a ConfigImporter object to import test configuration. | |
| ConfigTestTrait:: | protected | function | Copies configuration objects from source storage to target storage. | |
| ContentTypeCreationTrait:: | protected | function | Creates a custom content type based on default settings. Aliased as: drupalCreateContentType | 1 | 
| ExtensionListTestTrait:: | protected | function | Gets the path for the specified module. | |
| ExtensionListTestTrait:: | protected | function | Gets the path for the specified theme. | |
| FunctionalTestSetupTrait:: | protected | property | The flag to set 'apcu_ensure_unique_prefix' setting. | 1 | 
| FunctionalTestSetupTrait:: | protected | property | The class loader to use for installation and initialization of setup. | |
| FunctionalTestSetupTrait:: | protected | property | The "#1" admin user. | |
| FunctionalTestSetupTrait:: | protected | function | Execute the non-interactive installer. | 1 | 
| FunctionalTestSetupTrait:: | protected | function | Returns all supported database driver installer objects. | |
| FunctionalTestSetupTrait:: | protected | function | Initialize various configurations post-installation. | 1 | 
| FunctionalTestSetupTrait:: | protected | function | Initializes the kernel after installation. | |
| FunctionalTestSetupTrait:: | protected | function | Initialize settings created during install. | |
| FunctionalTestSetupTrait:: | protected | function | Initializes user 1 for the site to be installed. | |
| FunctionalTestSetupTrait:: | protected | function | Installs the default theme defined by `static::$defaultTheme` when needed. | |
| FunctionalTestSetupTrait:: | protected | function | Install modules defined by `static::$modules`. | 1 | 
| FunctionalTestSetupTrait:: | protected | function | Returns the parameters that will be used when Simpletest installs Drupal. | 9 | 
| FunctionalTestSetupTrait:: | protected | function | Prepares the current environment for running the test. | 20 | 
| FunctionalTestSetupTrait:: | protected | function | Creates a mock request and sets it on the generator. | |
| FunctionalTestSetupTrait:: | protected | function | Prepares site settings and services before installation. | 2 | 
| FunctionalTestSetupTrait:: | protected | function | Resets and rebuilds the environment after setup. | |
| FunctionalTestSetupTrait:: | protected | function | Rebuilds \Drupal::getContainer(). | |
| FunctionalTestSetupTrait:: | protected | function | Resets all data structures after having enabled new modules. | |
| FunctionalTestSetupTrait:: | protected | function | Changes parameters in the services.yml file. | |
| FunctionalTestSetupTrait:: | protected | function | Sets up the base URL based upon the environment variable. | |
| FunctionalTestSetupTrait:: | protected | function | Rewrites the settings.php file of the test site. | 1 | 
| NodeCreationTrait:: | protected | function | Creates a node based on default settings. Aliased as: drupalCreateNode | |
| NodeCreationTrait:: | public | function | Get a node from the database based on its title. Aliased as: drupalGetNodeByTitle | |
| PhpUnitWarnings:: | private static | property | Deprecation warnings from PHPUnit to raise with @trigger_error(). | |
| PhpUnitWarnings:: | public | function | Converts PHPUnit deprecation warnings to E_USER_DEPRECATED. | |
| RandomGeneratorTrait:: | protected | property | The random generator. | |
| RandomGeneratorTrait:: | protected | function | Gets the random generator for the utility methods. | |
| RandomGeneratorTrait:: | protected | function | Generates a unique random string containing letters and numbers. | 1 | 
| RandomGeneratorTrait:: | public | function | Generates a random PHP object. | |
| RandomGeneratorTrait:: | public | function | Generates a pseudo-random string of ASCII characters of codes 32 to 126. | |
| RandomGeneratorTrait:: | public | function | Callback for random string validation. | |
| RefreshVariablesTrait:: | protected | function | Refreshes in-memory configuration and state information. | 1 | 
| SessionTestTrait:: | protected | property | The name of the session cookie. | |
| SessionTestTrait:: | protected | function | Generates a session cookie name. | |
| SessionTestTrait:: | protected | function | Returns the session name in use on the child site. | |
| StorageCopyTrait:: | protected static | function | Copy the configuration from one storage to another and remove stale items. | |
| TestRequirementsTrait:: | private | function | Checks missing module requirements. | |
| TestRequirementsTrait:: | protected | function | Check module requirements for the Drupal use case. | 1 | 
| TestRequirementsTrait:: | protected static | function | Returns the Drupal root directory. | |
| TestSetupTrait:: | protected static | property | An array of config object names that are excluded from schema checking. | |
| TestSetupTrait:: | protected | property | The dependency injection container used in the test. | |
| TestSetupTrait:: | protected | property | The DrupalKernel instance used in the test. | |
| TestSetupTrait:: | protected | property | The site directory of the original parent site. | |
| TestSetupTrait:: | protected | property | The private file directory for the test environment. | |
| TestSetupTrait:: | protected | property | The public file directory for the test environment. | |
| TestSetupTrait:: | protected | property | The site directory of this test run. | |
| TestSetupTrait:: | protected | property | Set to TRUE to strict check all configuration saved. | 1 | 
| TestSetupTrait:: | protected | property | The temporary file directory for the test environment. | |
| TestSetupTrait:: | protected | property | The test run ID. | |
| TestSetupTrait:: | protected | function | Changes the database connection to the prefixed one. | |
| TestSetupTrait:: | protected | function | Gets the config schema exclusions for this test. | |
| TestSetupTrait:: | public static | function | Returns the database connection to the site running Simpletest. | |
| TestSetupTrait:: | protected | function | Generates a database prefix for running tests. | 1 | 
| UiHelperTrait:: | protected | property | The current user logged in using the Mink controlled browser. | |
| UiHelperTrait:: | protected | property | The number of meta refresh redirects to follow, or NULL if unlimited. | |
| UiHelperTrait:: | protected | property | The number of meta refresh redirects followed during ::drupalGet(). | |
| UiHelperTrait:: | public | function | Returns WebAssert object. | 1 | 
| UiHelperTrait:: | protected | function | Builds an absolute URL from a system path or a URL object. | |
| UiHelperTrait:: | protected | function | Checks for meta refresh tag and if found call drupalGet() recursively. | |
| UiHelperTrait:: | protected | function | Clicks the element with the given CSS selector. | |
| UiHelperTrait:: | protected | function | Follows a link by complete name. | |
| UiHelperTrait:: | protected | function | Searches elements using a CSS selector in the raw content. | |
| UiHelperTrait:: | protected | function | Translates a CSS expression to its XPath equivalent. | |
| UiHelperTrait:: | protected | function | Retrieves a Drupal path or an absolute path. | 2 | 
| UiHelperTrait:: | protected | function | Logs in a user using the Mink controlled browser. | |
| UiHelperTrait:: | protected | function | Logs a user out of the Mink controlled browser and confirms. | |
| UiHelperTrait:: | protected | function | Executes a form submission. | |
| UiHelperTrait:: | protected | function | Returns whether a given user account is logged in. | |
| UiHelperTrait:: | protected | function | Takes a path and returns an absolute path. | |
| UiHelperTrait:: | protected | function | Retrieves the plain-text content from the current page. | |
| UiHelperTrait:: | protected | function | Get the current URL from the browser. | |
| UiHelperTrait:: | protected | function | Determines if test is using DrupalTestBrowser. | |
| UiHelperTrait:: | protected | function | Prepare for a request to testing site. | 1 | 
| UiHelperTrait:: | protected | function | Fills and submits a form. | |
| UserCreationTrait:: | protected | function | Checks whether a given list of permission names is valid. | |
| UserCreationTrait:: | protected | function | Creates an administrative role. | |
| UserCreationTrait:: | protected | function | Creates a role with specified permissions. Aliased as: drupalCreateRole | |
| UserCreationTrait:: | protected | function | Create a user with a given set of permissions. Aliased as: drupalCreateUser | |
| UserCreationTrait:: | protected | function | Grant permissions to a user role. | |
| UserCreationTrait:: | protected | function | Switch the current logged in user. | |
| UserCreationTrait:: | protected | function | Creates a random user account and sets it as current user. | |
| ViewResultAssertionTrait:: | protected | function | Verifies that a result set returned by a View matches expected values. | |
| ViewResultAssertionTrait:: | protected | function | Performs View result assertions. | |
| ViewResultAssertionTrait:: | protected | function | Verifies that a result set returned by a View differs from certain values. | |
| ViewTestBase:: | protected static | property | Modules to enable. Overrides BrowserTestBase:: | 79 | 
| ViewTestBase:: | protected | function | Returns a very simple test dataset. | 1 | 
| ViewTestBase:: | protected | function | Sets up the views_test_data.module. | |
| ViewTestBase:: | protected | function | Executes a view. | |
| ViewTestBase:: | protected | function | Asserts the existence of a button with a certain ID and label. | |
| ViewTestBase:: | protected | function | Orders a nested array containing a result set based on a given column. | |
| ViewTestBase:: | protected | function | Returns the schema definition. | 1 | 
| ViewTestBase:: | protected | function | Overrides BrowserTestBase:: | 74 | 
| ViewTestBase:: | protected | function | Returns the views data definition. | 8 | 
| XdebugRequestTrait:: | protected | function | Adds xdebug cookies, from request setup. | 
