You are here

Home » API reference » Views (for Drupal 7) 8.3 » ViewStorageTest.php

class ViewStorageTest in Views (for Drupal 7) 8.3

Tests the functionality of ViewStorage and ViewStorageController.

Hierarchy

Expanded class hierarchy of ViewStorageTest

See also

Drupal\views\ViewStorage

Drupal\views\ViewStorageController

File

lib/Drupal/views/Tests/ViewStorageTest.php, line 22
Definition of Drupal\views\Tests\ViewStorageTest.

Namespace

Drupal\views\Tests
View source 
class ViewStorageTest extends ViewTestBase {

  /**
   * Properties that should be stored in the configuration.
   *
   * @var array
   */
  protected $config_properties = array(
    'disabled',
    'api_version',
    'module',
    'name',
    'description',
    'tag',
    'base_table',
    'human_name',
    'core',
    'display',
  );

  /**
   * The configuration entity information from entity_get_info().
   *
   * @var array
   */
  protected $info;

  /**
   * The configuration entity storage controller.
   *
   * @var Drupal\views\ViewStorageController
   */
  protected $controller;

  /**
   * Modules to enable.
   *
   * @var array
   */
  public static $modules = array(
    'node',
    'search',
    'comment',
    'taxonomy',
  );
  public static function getInfo() {
    return array(
      'name' => 'Configuration entity CRUD tests',
      'description' => 'Tests the CRUD functionality for ViewStorage.',
      'group' => 'Views',
    );
  }

  /**
   * Tests CRUD operations.
   */
  function testConfigurationEntityCRUD() {

    // Get the configuration entity information and controller.
    $this->info = entity_get_info('view');
    $this->controller = entity_get_controller('view');

    // Confirm that an info array has been returned.
    $this
      ->assertTrue(!empty($this->info) && is_array($this->info), 'The View info array is loaded.');

    // Confirm we have the correct controller class.
    $this
      ->assertTrue($this->controller instanceof ViewStorageController, 'The correct controller is loaded.');

    // CRUD tests.
    $this
      ->loadTests();
    $this
      ->createTests();
    $this
      ->saveTests();
    $this
      ->deleteTests();
    $this
      ->displayTests();
    $this
      ->statusTests();

    // Helper method tests
    $this
      ->displayMethodTests();
  }

  /**
   * Tests loading configuration entities.
   */
  protected function loadTests() {
    $view = $this
      ->loadView('archive');
    $data = config('views.view.archive')
      ->get();

    // Confirm that an actual view object is loaded and that it returns all of
    // expected properties.
    $this
      ->assertTrue($view instanceof ViewStorage, 'Single View instance loaded.');
    foreach ($this->config_properties as $property) {
      $this
        ->assertTrue(isset($view->{$property}), format_string('Property: @property loaded onto View.', array(
        '@property' => $property,
      )));
    }

    // Check the displays have been loaded correctly from config display data.
    $expected_displays = array(
      'default',
      'page_1',
      'block_1',
    );
    $this
      ->assertEqual(array_keys($view->display), $expected_displays, 'The correct display names are present.');

    // Check each ViewDisplay object and confirm that it has the correct key and
    // property values.
    foreach ($view->display as $key => $display) {
      $this
        ->assertEqual($key, $display['id'], 'The display has the correct ID assigned.');

      // Get original display data and confirm that the display options array
      // exists.
      $original_options = $data['display'][$key];
      foreach ($original_options as $orig_key => $value) {
        $this
          ->assertIdentical($display[$orig_key], $value, format_string('@key is identical to saved data', array(
          '@key' => $key,
        )));
      }
    }

    // Fetch data for all configuration entities and default view configurations.
    $all_configuration_entities = $this->controller
      ->load();
    $all_config = config_get_storage_names_with_prefix('views.view');

    // Remove the 'views.view.' prefix from config names for comparision with
    // loaded configuration entities.
    $prefix_map = function ($value) {
      $parts = explode('.', $value);
      return end($parts);
    };

    // Check that the correct number of configuration entities have been loaded.
    $count = count($all_configuration_entities);
    $this
      ->assertEqual($count, count($all_config), format_string('The array of all @count configuration entities is loaded.', array(
      '@count' => $count,
    )));

    // Check that all of these machine names match.
    $this
      ->assertIdentical(array_keys($all_configuration_entities), array_map($prefix_map, $all_config), 'All loaded elements match.');

    // Make sure that loaded default views get a UUID.
    $view = views_get_view('frontpage');
    $this
      ->assertTrue($view->storage
      ->uuid());
  }

  /**
   * Tests creating configuration entities.
   */
  protected function createTests() {

    // Create a new View instance with empty values.
    $created = $this->controller
      ->create(array());
    $this
      ->assertTrue($created instanceof ViewStorage, 'Created object is a View.');

    // Check that the View contains all of the properties.
    foreach ($this->config_properties as $property) {
      $this
        ->assertTrue(property_exists($created, $property), format_string('Property: @property created on View.', array(
        '@property' => $property,
      )));
    }

    // Create a new View instance with config values.
    $values = config('views.view.glossary')
      ->get();
    $created = $this->controller
      ->create($values);
    $this
      ->assertTrue($created instanceof ViewStorage, 'Created object is a View.');

    // Check that the View contains all of the properties.
    $properties = $this->config_properties;

    // Remove display from list.
    array_pop($properties);

    // Test all properties except displays.
    foreach ($properties as $property) {
      $this
        ->assertTrue(isset($created->{$property}), format_string('Property: @property created on View.', array(
        '@property' => $property,
      )));
      $this
        ->assertIdentical($values[$property], $created->{$property}, format_string('Property value: @property matches configuration value.', array(
        '@property' => $property,
      )));
    }

    // Check the UUID of the loaded View.
    $created
      ->set('name', 'glossary_new');
    $created
      ->save();
    $created_loaded = $this
      ->loadView('glossary_new');
    $this
      ->assertIdentical($created
      ->uuid(), $created_loaded
      ->uuid(), 'The created UUID has been saved correctly.');
  }

  /**
   * Tests saving configuration entities.
   */
  protected function saveTests() {
    $view = $this
      ->loadView('archive');

    // Save the newly created view, but modify the name.
    $view
      ->set('name', 'archive_copy');
    $view
      ->set('tag', 'changed');
    $view
      ->save();

    // Load the newly saved config.
    $config = config('views.view.archive_copy');
    $this
      ->assertFalse($config
      ->isNew(), 'New config has been loaded.');
    $this
      ->assertEqual($view->tag, $config
      ->get('tag'), 'A changed value has been saved.');

    // Change a value and save.
    $view->tag = 'changed';
    $view
      ->save();

    // Check values have been written to config.
    $config = config('views.view.archive_copy')
      ->get();
    $this
      ->assertEqual($view->tag, $config['tag'], 'View property saved to config.');

    // Check whether load, save and load produce the same kind of view.
    $values = config('views.view.archive')
      ->get();
    $created = $this->controller
      ->create($values);
    $created
      ->save();
    $created_loaded = $this
      ->loadView($created
      ->id());
    $values_loaded = config('views.view.archive')
      ->get();
    $this
      ->assertTrue(isset($created_loaded->display['default']['display_options']), 'Make sure that the display options exist.');
    $this
      ->assertEqual($created_loaded->display['default']['display_plugin'], 'default', 'Make sure the right display plugin is set.');
    $this
      ->assertEqual($values, $values_loaded, 'The loaded config is the same as the original loaded one.');
  }

  /**
   * Tests deleting configuration entities.
   */
  protected function deleteTests() {
    $view = $this
      ->loadView('tracker');

    // Delete the config.
    $view
      ->delete();
    $config = config('views.view.tracker');
    $this
      ->assertTrue($config
      ->isNew(), 'Deleted config is now new.');
  }

  /**
   * Tests adding, saving, and loading displays on configuration entities.
   */
  protected function displayTests() {

    // Check whether a display can be added and saved to a View.
    $view = $this
      ->loadView('frontpage');
    $view
      ->newDisplay('page', 'Test', 'test');
    $new_display = $view->display['test'];

    // Ensure the right display_plugin is created/instantiated.
    $this
      ->assertEqual($new_display['display_plugin'], 'page', 'New page display "test" uses the right display plugin.');
    $this
      ->assertTrue($view
      ->getExecutable()->displayHandlers[$new_display['id']] instanceof Page, 'New page display "test" uses the right display plugin.');
    $view
      ->set('name', 'frontpage_new');
    $view
      ->save();
    $values = config('views.view.frontpage_new')
      ->get();
    $this
      ->assertTrue(isset($values['display']['test']) && is_array($values['display']['test']), 'New display was saved.');
  }

  /**
   * Tests statuses of configuration entities.
   */
  protected function statusTests() {

    // Test a View can be enabled and disabled again (with a new view).
    $view = $this
      ->loadView('backlinks');

    // The view should already be disabled.
    $view
      ->enable();
    $this
      ->assertTrue($view
      ->isEnabled(), 'A view has been enabled.');

    // Check the saved values.
    $view
      ->save();
    $config = config('views.view.backlinks')
      ->get();
    $this
      ->assertFalse($config['disabled'], 'The changed disabled property was saved.');

    // Disable the view.
    $view
      ->disable();
    $this
      ->assertFalse($view
      ->isEnabled(), 'A view has been disabled.');

    // Check the saved values.
    $view
      ->save();
    $config = config('views.view.backlinks')
      ->get();
    $this
      ->assertTrue($config['disabled'], 'The changed disabled property was saved.');
  }

  /**
   * Loads a single configuration entity from the controller.
   *
   * @param string $view_name
   *   The machine name of the view.
   *
   * @return object Drupal\views\ViewExecutable.
   *   The loaded view object.
   */
  protected function loadView($view_name) {
    $load = $this->controller
      ->load(array(
      $view_name,
    ));
    return reset($load);
  }

  /**
   * Tests the display related functions like getDisplaysList().
   */
  protected function displayMethodTests() {
    $config['display'] = array(
      'page_1' => array(
        'display_options' => array(
          'path' => 'test',
        ),
        'display_plugin' => 'page',
        'id' => 'page_2',
        'display_title' => 'Page 1',
        'position' => 1,
      ),
      'feed_1' => array(
        'display_options' => array(
          'path' => 'test.xml',
        ),
        'display_plugin' => 'feed',
        'id' => 'feed',
        'display_title' => 'Feed',
        'position' => 2,
      ),
      'page_2' => array(
        'display_options' => array(
          'path' => 'test/%/extra',
        ),
        'display_plugin' => 'page',
        'id' => 'page_2',
        'display_title' => 'Page 2',
        'position' => 3,
      ),
    );
    $view = $this->controller
      ->create($config);
    $this
      ->assertEqual($view
      ->getDisplaysList(), array(
      'Feed',
      'Page',
    ), 'Make sure the display admin names are returns in alphabetic order.');

    // Paths with a "%" shouldn't not be linked
    $expected_paths = array();
    $expected_paths[] = l('/test', 'test');
    $expected_paths[] = l('/test.xml', 'test.xml');
    $expected_paths[] = '/test/%/extra';
    $this
      ->assertEqual($view
      ->getPaths(), $expected_paths, 'Make sure the paths in the ui are generated as expected.');

    // Tests Drupal\views\ViewStorage::addDisplay()
    $view = $this->controller
      ->create(array());
    $random_title = $this
      ->randomName();
    $id = $view
      ->addDisplay('page', $random_title);
    $this
      ->assertEqual($id, 'page_1', format_string('Make sure the first display (%id_new) has the expected ID (%id)', array(
      '%id_new' => $id,
      '%id' => 'page_1',
    )));
    $this
      ->assertEqual($view->display[$id]['display_title'], $random_title);
    $random_title = $this
      ->randomName();
    $id = $view
      ->addDisplay('page', $random_title);
    $this
      ->assertEqual($id, 'page_2', format_string('Make sure the second display (%id_new) has the expected ID (%id)', array(
      '%id_new' => $id,
      '%id' => 'page_2',
    )));
    $this
      ->assertEqual($view->display[$id]['display_title'], $random_title);
    $id = $view
      ->addDisplay('page');
    $this
      ->assertEqual($view->display[$id]['display_title'], 'Page 3');

    // Tests Drupal\views\ViewStorage::generateDisplayId().
    // @todo Sadly this method is not public so it cannot be tested.
    // $view = $this->controller->create(array());
    // $this->assertEqual($view->generateDisplayId('default'), 'default', 'The plugin ID for default is always default.');
    // $this->assertEqual($view->generateDisplayId('feed'), 'feed_1', 'The generated ID for the first instance of a plugin type should have an suffix of _1.');
    // $view->addDisplay('feed', 'feed title');
    // $this->assertEqual($view->generateDisplayId('feed'), 'feed_2', 'The generated ID for the first instance of a plugin type should have an suffix of _2.');
    // Tests Drupal\views\ViewStorage::newDisplay().
    $view = $this->controller
      ->create(array());
    $view
      ->newDisplay('default');
    $display = $view
      ->newDisplay('page');
    $this
      ->assertTrue($display instanceof Page);
    $this
      ->assertTrue($view
      ->getExecutable()->displayHandlers['page_1'] instanceof Page);
    $this
      ->assertTrue($view
      ->getExecutable()->displayHandlers['page_1']->default_display instanceof DefaultDisplay);
    $display = $view
      ->newDisplay('page');
    $this
      ->assertTrue($display instanceof Page);
    $this
      ->assertTrue($view
      ->getExecutable()->displayHandlers['page_2'] instanceof Page);
    $this
      ->assertTrue($view
      ->getExecutable()->displayHandlers['page_2']->default_display instanceof DefaultDisplay);
    $display = $view
      ->newDisplay('feed');
    $this
      ->assertTrue($display instanceof Feed);
    $this
      ->assertTrue($view
      ->getExecutable()->displayHandlers['feed_1'] instanceof Feed);
    $this
      ->assertTrue($view
      ->getExecutable()->displayHandlers['feed_1']->default_display instanceof DefaultDisplay);

    // Tests item related methods().
    $view = $this->controller
      ->create(array(
      'base_table' => 'views_test_data',
    ));
    $view
      ->addDisplay('default');
    $view = $view
      ->getExecutable();
    $display_id = 'default';
    $expected_items = array();

    // Tests addItem with getItem.
    // Therefore add one item without any optioins and one item with some
    // options.
    $id1 = $view
      ->addItem($display_id, 'field', 'views_test_data', 'id');
    $item1 = $view
      ->getItem($display_id, 'field', 'id');
    $expected_items[$id1] = $expected_item = array(
      'id' => 'id',
      'table' => 'views_test_data',
      'field' => 'id',
    );
    $this
      ->assertEqual($item1, $expected_item);
    $options = array(
      'alter' => array(
        'text' => $this
          ->randomName(),
      ),
    );
    $id2 = $view
      ->addItem($display_id, 'field', 'views_test_data', 'name', $options);
    $item2 = $view
      ->getItem($display_id, 'field', 'name');
    $expected_items[$id2] = $expected_item = array(
      'id' => 'name',
      'table' => 'views_test_data',
      'field' => 'name',
    ) + $options;
    $this
      ->assertEqual($item2, $expected_item);

    // Tests the expected fields from the previous additions.
    $this
      ->assertEqual($view
      ->getItems('field', $display_id), $expected_items);

    // Alter an existing item via setItem and check the result via getItem
    // and getItems.
    $item = array(
      'alter' => array(
        'text' => $this
          ->randomName(),
      ),
    ) + $item1;
    $expected_items[$id1] = $item;
    $view
      ->setItem($display_id, 'field', $id1, $item);
    $this
      ->assertEqual($view
      ->getItem($display_id, 'field', 'id'), $item);
    $this
      ->assertEqual($view
      ->getItems('field', $display_id), $expected_items);
  }

  /**
   * Tests the createDuplicate() View method.
   */
  public function testCreateDuplicate() {
    $view = views_get_view('archive');
    $copy = $view
      ->createDuplicate();
    $this
      ->assertTrue($copy instanceof ViewStorage, 'The copied object is a View.');

    // Check that the original view and the copy have different UUIDs.
    $this
      ->assertNotIdentical($view->storage
      ->uuid(), $copy
      ->uuid(), 'The copied view has a new UUID.');

    // Check the 'name' (ID) is using the View objects default value ('') as it
    // gets unset.
    $this
      ->assertIdentical($copy
      ->id(), '', 'The ID has been reset.');

    // Check the other properties.
    // @todo Create a reusable property on the base test class for these?
    $config_properties = array(
      'disabled',
      'api_version',
      'description',
      'tag',
      'base_table',
      'human_name',
      'core',
    );
    foreach ($config_properties as $property) {
      $this
        ->assertIdentical($view->storage->{$property}, $copy->{$property}, format_string('@property property is identical.', array(
        '@property' => $property,
      )));
    }

    // Check the displays are the same.
    foreach ($view->storage->display as $id => $display) {

      // assertIdentical will not work here.
      $this
        ->assertEqual($display, $copy->display[$id], format_string('The @display display has been copied correctly.', array(
        '@display' => $id,
      )));
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AssertContentTrait::$content protected property The current raw content.
AssertContentTrait::$drupalSettings protected property The drupalSettings value from the current raw $content.
AssertContentTrait::$elements protected property The XML structure parsed from the current raw $content. 1
AssertContentTrait::$plainTextContent protected property The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink protected function Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds protected function Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped protected function Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertNoField protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected protected function Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern protected function Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw protected function Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle protected function Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText protected function Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern protected function Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput protected function Asserts themed output.
AssertContentTrait::assertTitle protected function Pass if the page title is the given string.
AssertContentTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper protected function Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery protected function Builds an XPath query.
AssertContentTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings protected function Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent protected function Gets the current raw content.
AssertContentTrait::getSelectedItem protected function Get the selected value from a select field.
AssertContentTrait::getTextContent protected function Retrieves the plain-text content from the current raw content.
AssertContentTrait::getUrl protected function Get the current URL from the cURL handler. 1
AssertContentTrait::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace protected function Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings protected function Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent protected function Sets the raw content (e.g. HTML).
AssertContentTrait::xpath protected function Performs an xpath search on the contents of the internal browser.
AssertHelperTrait::castSafeStrings protected static function Casts MarkupInterface objects into strings.
AssertMailTrait::assertMail protected function Asserts that the most recently sent email message has the given value.
AssertMailTrait::assertMailPattern protected function Asserts that the most recently sent email message has the pattern in it.
AssertMailTrait::assertMailString protected function Asserts that the most recently sent email message has the string in it.
AssertMailTrait::getMails protected function Gets an array containing all emails sent during this test case. Aliased as: drupalGetMails
AssertMailTrait::verboseEmail protected function Outputs to verbose the most recent $count emails sent.
AssertPageCacheContextsAndTagsTrait::assertCacheContext protected function Asserts whether an expected cache context was present in the last response.
AssertPageCacheContextsAndTagsTrait::assertCacheContexts protected function Ensures that some cache contexts are present in the current response.
AssertPageCacheContextsAndTagsTrait::assertCacheMaxAge protected function Asserts the max age header.
AssertPageCacheContextsAndTagsTrait::assertCacheTags protected function Ensures that some cache tags are present in the current response.
AssertPageCacheContextsAndTagsTrait::assertNoCacheContext protected function Asserts that a cache context was not present in the last response.
AssertPageCacheContextsAndTagsTrait::assertPageCacheContextsAndTags protected function Asserts page cache miss, then hit for the given URL; checks cache headers.
AssertPageCacheContextsAndTagsTrait::debugCacheTags protected function Provides debug information for cache tags.
AssertPageCacheContextsAndTagsTrait::enablePageCaching protected function Enables page caching.
AssertPageCacheContextsAndTagsTrait::getCacheHeaderValues protected function Gets a specific header value as array.
BlockCreationTrait::placeBlock protected function Creates a block instance based on default settings. Aliased as: drupalPlaceBlock
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. Aliased as: drupalCreateContentType 1
CronRunTrait::cronRun protected function Runs cron on the test site.
EntityViewTrait::buildEntityView protected function Builds the renderable view of an entity. Aliased as: drupalBuildEntityView
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::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. 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.
GeneratePermutationsTrait::generatePermutations public static function Converts a list of possible parameters into a stack of permutations.
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
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.
TestBase::$assertions protected property Assertions thrown in that test case.
TestBase::$configImporter protected property The config importer that can used in a test.
TestBase::$databasePrefix protected property The database prefix of this test run.
TestBase::$dieOnFail public property Whether to die in case any test assertion fails.
TestBase::$httpAuthCredentials protected property HTTP authentication credentials (<username>:<password>).
TestBase::$httpAuthMethod protected property HTTP authentication method (specified as a CURLAUTH_* constant).
TestBase::$originalConf protected property The original configuration (variables), if available.
TestBase::$originalConfig protected property The original configuration (variables).
TestBase::$originalConfigDirectories protected property The original configuration directories.
TestBase::$originalContainer protected property The original container.
TestBase::$originalFileDirectory protected property The original file directory, before it was changed for testing purposes.
TestBase::$originalLanguage protected property The original language.
TestBase::$originalPrefix protected property The original database prefix when running inside Simpletest.
TestBase::$originalSessionName protected property The name of the session cookie of the test-runner.
TestBase::$originalSettings protected property The settings array.
TestBase::$results public property Current results of this test case.
TestBase::$skipClasses protected property This class is skipped when looking for the source of an assertion.
TestBase::$timeLimit protected property Time limit for the test.
TestBase::$translationFilesDirectory protected property The translation file directory for the test environment.
TestBase::$verbose public property TRUE if verbose debugging is enabled.
TestBase::$verboseClassName protected property Safe class name for use in verbose output filenames.
TestBase::$verboseDirectory protected property Directory where verbose output files are put.
TestBase::$verboseDirectoryUrl protected property URL to the verbose output file directory.
TestBase::$verboseId protected property Incrementing identifier for verbose output filenames.
TestBase::assert protected function Internal helper: stores the assert.
TestBase::assertEqual protected function Check to see if two values are equal.
TestBase::assertErrorLogged protected function Asserts that a specific error has been logged to the PHP error log.
TestBase::assertFalse protected function Check to see if a value is false.
TestBase::assertIdentical protected function Check to see if two values are identical.
TestBase::assertIdenticalObject protected function Checks to see if two objects are identical.
TestBase::assertNoErrorsLogged protected function Asserts that no errors have been logged to the PHP error.log thus far.
TestBase::assertNotEqual protected function Check to see if two values are not equal.
TestBase::assertNotIdentical protected function Check to see if two values are not identical.
TestBase::assertNotNull protected function Check to see if a value is not NULL.
TestBase::assertNull protected function Check to see if a value is NULL.
TestBase::assertTrue protected function Check to see if a value is not false.
TestBase::beforePrepareEnvironment protected function Act on global state information before the environment is altered for a test. 1
TestBase::checkRequirements protected function Checks the matching requirements for Test. 1
TestBase::checkTestHierarchyMismatch public function Fail the test if it belongs to a PHPUnit-based framework.
TestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
TestBase::deleteAssert public static function Delete an assertion record by message ID.
TestBase::error protected function Fire an error assertion. 1
TestBase::errorHandler public function Handle errors during test runs.
TestBase::exceptionHandler protected function Handle exceptions.
TestBase::fail protected function Fire an assertion that is always negative.
TestBase::filePreDeleteCallback public static function Ensures test files are deletable.
TestBase::getAssertionCall protected function Cycles through backtrace until the first non-assertion method is found.
TestBase::getDatabasePrefix public function Gets the database prefix.
TestBase::getTempFilesDirectory public function Gets the temporary files directory.
TestBase::insertAssert Deprecated public static function Store an assertion from outside the testing context. 1
TestBase::pass protected function Fire an assertion that is always positive.
TestBase::prepareDatabasePrefix private function Generates a database prefix for running tests. Overrides TestSetupTrait::prepareDatabasePrefix
TestBase::restoreEnvironment private function Cleans up the test environment and restores the original environment.
TestBase::run public function Run all tests in this class. 2
TestBase::settingsSet protected function Changes in memory settings.
TestBase::storeAssertion protected function Helper method to store an assertion record in the configured database. 1
TestBase::verbose protected function Logs a verbose message in a text file.
TestFileCreationTrait::$generatedTestFiles protected property Whether the files were copied to the test files directory.
TestFileCreationTrait::compareFiles protected function Compares two files based on size and file name. Aliased as: drupalCompareFiles
TestFileCreationTrait::generateFile public static function Generates a test file.
TestFileCreationTrait::getTestFiles protected function Gets a list of files that can be used in tests. Aliased as: drupalGetTestFiles
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.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole protected function Creates an administrative role. Aliased as: drupalCreateAdminRole
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.
ViewStorageTest::$config_properties protected property Properties that should be stored in the configuration.
ViewStorageTest::$controller protected property The configuration entity storage controller.
ViewStorageTest::$info protected property The configuration entity information from entity_get_info().
ViewStorageTest::$modules public static property Modules to enable. Overrides ViewTestBase::$modules
ViewStorageTest::createTests protected function Tests creating configuration entities.
ViewStorageTest::deleteTests protected function Tests deleting configuration entities.
ViewStorageTest::displayMethodTests protected function Tests the display related functions like getDisplaysList().
ViewStorageTest::displayTests protected function Tests adding, saving, and loading displays on configuration entities.
ViewStorageTest::getInfo public static function
ViewStorageTest::loadTests protected function Tests loading configuration entities.
ViewStorageTest::loadView protected function Loads a single configuration entity from the controller.
ViewStorageTest::saveTests protected function Tests saving configuration entities.
ViewStorageTest::statusTests protected function Tests statuses of configuration entities.
ViewStorageTest::testConfigurationEntityCRUD function Tests CRUD operations.
ViewStorageTest::testCreateDuplicate public function Tests the createDuplicate() View method.
ViewTestBase::$sort_column protected property
ViewTestBase::$sort_order protected property
ViewTestBase::$view protected property The view to use for the test.
ViewTestBase::assertIdenticalResultset protected function Helper function: verify a result set returned by view.
ViewTestBase::assertIdenticalResultsetHelper protected function
ViewTestBase::assertNotIdenticalResultset protected function Helper function: verify a result set returned by view..
ViewTestBase::createViewFromConfig protected function Creates a new View instance by creating directly from config data.
ViewTestBase::dataSet protected function A very simple test dataset. 6
ViewTestBase::enableViewsTestModule protected function Sets up the views_test_data.module.
ViewTestBase::executeView protected function Helper function to execute a view with debugging.
ViewTestBase::getBasicPageView protected function Build and return a Page view of the views_test_data table.
ViewTestBase::getBasicView protected function Build and return a basic view of the views_test_data table. 14
ViewTestBase::getView protected function Clones the view used in this test and sets the default display.
ViewTestBase::helperButtonHasLabel protected function Helper function to check whether a button with a certain id exists and has a certain label.
ViewTestBase::helperCompareFunction protected function Helper comparison function for orderResultSet().
ViewTestBase::orderResultSet protected function Helper function: order an array of array based on a column.
ViewTestBase::schemaDefinition protected function The schema definition. 4
ViewTestBase::setUp protected function Sets up a Drupal site for running functional and integration tests. Overrides WebTestBase::setUp 51
ViewTestBase::viewsData protected function The views data definition. 20
WebTestBase::$additionalCurlOptions protected property Additional cURL options.
WebTestBase::$assertAjaxHeader protected property Whether or not to assert the presence of the X-Drupal-Ajax-Token.
WebTestBase::$cookieFile protected property The current cookie file used by cURL.
WebTestBase::$cookies protected property The cookies of the page currently loaded in the internal browser.
WebTestBase::$curlCookies protected property Cookies to set on curl requests.
WebTestBase::$curlHandle protected property The handle of the current cURL connection.
WebTestBase::$customTranslations protected property An array of custom translations suitable for drupal_rewrite_settings().
WebTestBase::$dumpHeaders protected property Indicates that headers should be dumped if verbose output is enabled. 1
WebTestBase::$headers protected property The headers of the page currently loaded in the internal browser.
WebTestBase::$loggedInUser protected property The current user logged in using the internal browser.
WebTestBase::$maximumMetaRefreshCount protected property The number of meta refresh redirects to follow, or NULL if unlimited.
WebTestBase::$maximumRedirects protected property The maximum number of redirects to follow when handling responses.
WebTestBase::$metaRefreshCount protected property The number of meta refresh redirects followed during ::drupalGet().
WebTestBase::$originalBatch protected property The original batch, before it was changed for testing purposes.
WebTestBase::$originalShutdownCallbacks protected property The original shutdown handlers array, before it was cleaned for testing. Overrides TestBase::$originalShutdownCallbacks
WebTestBase::$originalUser protected property The original user, before it was changed to a clean uid = 1 for testing. Overrides TestBase::$originalUser
WebTestBase::$profile protected property The profile to install as a basis for testing. 2
WebTestBase::$redirectCount protected property The number of redirects followed during the handling of a request.
WebTestBase::$sessionId protected property The current session ID, if available.
WebTestBase::$url protected property The URL currently loaded in the internal browser.
WebTestBase::addCustomTranslations protected function Queues custom translations to be written to settings.php.
WebTestBase::assertBlockAppears protected function Checks to see whether a block appears on the page.
WebTestBase::assertCacheTag protected function Asserts whether an expected cache tag was present in the last response.
WebTestBase::assertHeader protected function Check if a HTTP response header exists and has the expected value.
WebTestBase::assertNoBlockAppears protected function Checks to see whether a block does not appears on the page.
WebTestBase::assertNoCacheTag protected function Asserts whether an expected cache tag was absent in the last response.
WebTestBase::assertNoResponse protected function Asserts the page did not return the specified response code.
WebTestBase::assertResponse protected function Asserts the page responds with the specified response code. 1
WebTestBase::assertUrl protected function Passes if the internal browser's URL matches the given path.
WebTestBase::buildUrl protected function Builds an a absolute URL from a system path or a URL object.
WebTestBase::checkForMetaRefresh protected function Checks for meta refresh tag and if found call drupalGet() recursively.
WebTestBase::clickLink protected function Follows a link by complete name.
WebTestBase::clickLinkHelper protected function Provides a helper for ::clickLink() and ::clickLinkPartialName().
WebTestBase::clickLinkPartialName protected function Follows a link by partial name.
WebTestBase::curlClose protected function Close the cURL handler and unset the handler.
WebTestBase::curlExec protected function Initializes and executes a cURL request. 1
WebTestBase::curlHeaderCallback protected function Reads headers and registers errors received from the tested site.
WebTestBase::curlInitialize protected function Initializes the cURL connection.
WebTestBase::drupalGet protected function Retrieves a Drupal path or an absolute path. 1
WebTestBase::drupalGetAjax protected function Requests a path or URL in drupal_ajax format and JSON-decodes the response.
WebTestBase::drupalGetHeader protected function Gets the value of an HTTP response header. 1
WebTestBase::drupalGetHeaders protected function Gets the HTTP response headers of the requested page. 1
WebTestBase::drupalGetJSON protected function Retrieves a Drupal path or an absolute path and JSON decodes the result.
WebTestBase::drupalGetWithFormat protected function Retrieves a Drupal path or an absolute path for a given format.
WebTestBase::drupalGetXHR protected function Requests a Drupal path or an absolute path as if it is a XMLHttpRequest.
WebTestBase::drupalHead protected function Retrieves only the headers for a Drupal path or an absolute path.
WebTestBase::drupalLogin protected function Log in a user with the internal browser.
WebTestBase::drupalLogout protected function Logs a user out of the internal browser and confirms.
WebTestBase::drupalPost protected function Perform a POST HTTP request.
WebTestBase::drupalPostAjaxForm protected function Executes an Ajax form submission.
WebTestBase::drupalPostForm protected function Executes a form submission.
WebTestBase::drupalPostWithFormat protected function Performs a POST HTTP request with a specific format.
WebTestBase::drupalProcessAjaxResponse protected function Processes an AJAX response into current content.
WebTestBase::drupalUserIsLoggedIn protected function Returns whether a given user account is logged in.
WebTestBase::findBlockInstance protected function Find a block instance on the page.
WebTestBase::getAbsoluteUrl protected function Takes a path and returns an absolute path.
WebTestBase::getAjaxPageStatePostData protected function Get the Ajax page state from drupalSettings and prepare it for POSTing.
WebTestBase::handleForm protected function Handles form input related to drupalPostForm().
WebTestBase::isInChildSite protected function Returns whether the test is being executed from within a test site.
WebTestBase::restoreBatch protected function Restore the original batch.
WebTestBase::serializePostValues protected function Serialize POST HTTP request values.
WebTestBase::setBatch protected function Preserve the original batch, and instantiate the test batch.
WebTestBase::setHttpResponseDebugCacheabilityHeaders protected function Enables/disables the cacheability headers.
WebTestBase::tearDown protected function Cleans up after testing. Overrides TestBase::tearDown 1
WebTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for WebTestBase::drupalPostForm().
WebTestBase::writeCustomTranslations protected function Writes custom translations to the test site's settings.php.
WebTestBase::__construct public function Constructor for \Drupal\simpletest\WebTestBase. Overrides TestBase::__construct 1
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.