You are here

Home » API reference » Zircon Profile 8.0 » ConfigImportUITest.php

class ConfigImportUITest in Zircon Profile 8.0

Same name and namespace in other branches
  1. 8 core/modules/config/src/Tests/ConfigImportUITest.php \Drupal\config\Tests\ConfigImportUITest

Tests the user interface for importing/exporting configuration.

@group config

Hierarchy

Expanded class hierarchy of ConfigImportUITest

File

core/modules/config/src/Tests/ConfigImportUITest.php, line 20
Contains \Drupal\config\Tests\ConfigImportUITest.

Namespace

Drupal\config\Tests
View source 
class ConfigImportUITest extends WebTestBase {

  /**
   * Modules to install.
   *
   * @var array
   */
  public static $modules = array(
    'config',
    'config_test',
    'config_import_test',
    'text',
    'options',
  );

  /**
   * A user with the 'synchronize configuration' permission.
   *
   * @var \Drupal\user\UserInterface
   */
  protected $webUser;
  protected function setUp() {
    parent::setUp();
    $this->webUser = $this
      ->drupalCreateUser(array(
      'synchronize configuration',
    ));
    $this
      ->drupalLogin($this->webUser);
    $this
      ->copyConfig($this->container
      ->get('config.storage'), $this->container
      ->get('config.storage.sync'));
  }

  /**
   * Tests importing configuration.
   */
  function testImport() {
    $name = 'system.site';
    $dynamic_name = 'config_test.dynamic.new';

    /** @var \Drupal\Core\Config\StorageInterface $sync */
    $sync = $this->container
      ->get('config.storage.sync');
    $this
      ->drupalGet('admin/config/development/configuration');
    $this
      ->assertText('There are no configuration changes to import.');
    $this
      ->assertNoFieldById('edit-submit', t('Import all'));

    // Create updated configuration object.
    $new_site_name = 'Config import test ' . $this
      ->randomString();
    $this
      ->prepareSiteNameUpdate($new_site_name);
    $this
      ->assertIdentical($sync
      ->exists($name), TRUE, $name . ' found.');

    // Create new config entity.
    $original_dynamic_data = array(
      'uuid' => '30df59bd-7b03-4cf7-bb35-d42fc49f0651',
      'langcode' => \Drupal::languageManager()
        ->getDefaultLanguage()
        ->getId(),
      'status' => TRUE,
      'dependencies' => array(),
      'id' => 'new',
      'label' => 'New',
      'weight' => 0,
      'style' => '',
      'size' => '',
      'size_value' => '',
      'protected_property' => '',
    );
    $sync
      ->write($dynamic_name, $original_dynamic_data);
    $this
      ->assertIdentical($sync
      ->exists($dynamic_name), TRUE, $dynamic_name . ' found.');

    // Enable the Action and Ban modules during import. The Ban
    // module is used because it creates a table during the install. The Action
    // module is used because it creates a single simple configuration file
    // during the install.
    $core_extension = $this
      ->config('core.extension')
      ->get();
    $core_extension['module']['action'] = 0;
    $core_extension['module']['ban'] = 0;
    $core_extension['module'] = module_config_sort($core_extension['module']);

    // Bartik is a subtheme of classy so classy must be enabled.
    $core_extension['theme']['classy'] = 0;
    $core_extension['theme']['bartik'] = 0;
    $sync
      ->write('core.extension', $core_extension);

    // Use the install storage so that we can read configuration from modules
    // and themes that are not installed.
    $install_storage = new InstallStorage();

    // Set the Bartik theme as default.
    $system_theme = $this
      ->config('system.theme')
      ->get();
    $system_theme['default'] = 'bartik';
    $sync
      ->write('system.theme', $system_theme);

    // Read the action config from module default config folder.
    $action_settings = $install_storage
      ->read('action.settings');
    $action_settings['recursion_limit'] = 50;
    $sync
      ->write('action.settings', $action_settings);

    // Uninstall the Options and Text modules to ensure that dependencies are
    // handled correctly. Options depends on Text so Text should be installed
    // first. Since they were enabled during the test setup the core.extension
    // file in sync will already contain them.
    \Drupal::service('module_installer')
      ->uninstall(array(
      'text',
      'options',
    ));

    // Set the state system to record installations and uninstallations.
    \Drupal::state()
      ->set('ConfigImportUITest.core.extension.modules_installed', array());
    \Drupal::state()
      ->set('ConfigImportUITest.core.extension.modules_uninstalled', array());

    // Verify that both appear as ready to import.
    $this
      ->drupalGet('admin/config/development/configuration');
    $this
      ->assertRaw('<td>' . $name);
    $this
      ->assertRaw('<td>' . $dynamic_name);
    $this
      ->assertRaw('<td>core.extension');
    $this
      ->assertRaw('<td>system.theme');
    $this
      ->assertRaw('<td>action.settings');
    $this
      ->assertFieldById('edit-submit', t('Import all'));

    // Import and verify that both do not appear anymore.
    $this
      ->drupalPostForm(NULL, array(), t('Import all'));
    $this
      ->assertNoRaw('<td>' . $name);
    $this
      ->assertNoRaw('<td>' . $dynamic_name);
    $this
      ->assertNoRaw('<td>core.extension');
    $this
      ->assertNoRaw('<td>system.theme');
    $this
      ->assertNoRaw('<td>action.settings');
    $this
      ->assertNoFieldById('edit-submit', t('Import all'));

    // Verify that there are no further changes to import.
    $this
      ->assertText(t('There are no configuration changes to import.'));

    // Verify site name has changed.
    $this
      ->assertIdentical($new_site_name, $this
      ->config('system.site')
      ->get('name'));

    // Verify that new config entity exists.
    $this
      ->assertIdentical($original_dynamic_data, $this
      ->config($dynamic_name)
      ->get());

    // Verify the cache got cleared.
    $this
      ->assertTrue(isset($GLOBALS['hook_cache_flush']));
    $this
      ->rebuildContainer();
    $this
      ->assertTrue(\Drupal::moduleHandler()
      ->moduleExists('ban'), 'Ban module installed during import.');
    $this
      ->assertTrue(\Drupal::database()
      ->schema()
      ->tableExists('ban_ip'), 'The database table ban_ip exists.');
    $this
      ->assertTrue(\Drupal::moduleHandler()
      ->moduleExists('action'), 'Action module installed during import.');
    $this
      ->assertTrue(\Drupal::moduleHandler()
      ->moduleExists('options'), 'Options module installed during import.');
    $this
      ->assertTrue(\Drupal::moduleHandler()
      ->moduleExists('text'), 'Text module installed during import.');
    $theme_info = \Drupal::service('theme_handler')
      ->listInfo();
    $this
      ->assertTrue($theme_info['bartik']->status, 'Bartik theme installed during import.');

    // Ensure installations and uninstallation occur as expected.
    $installed = \Drupal::state()
      ->get('ConfigImportUITest.core.extension.modules_installed', array());
    $uninstalled = \Drupal::state()
      ->get('ConfigImportUITest.core.extension.modules_uninstalled', array());
    $expected = array(
      'action',
      'ban',
      'text',
      'options',
    );
    $this
      ->assertIdentical($expected, $installed, 'Action, Ban, Text and Options modules installed in the correct order.');
    $this
      ->assertTrue(empty($uninstalled), 'No modules uninstalled during import');

    // Verify that the action.settings configuration object was only written
    // once during the import process and only with the value set in the staged
    // configuration. This verifies that the module's default configuration is
    // used during configuration import and, additionally, that after installing
    // a module, that configuration is not synced twice.
    $recursion_limit_values = \Drupal::state()
      ->get('ConfigImportUITest.action.settings.recursion_limit', array());
    $this
      ->assertIdentical($recursion_limit_values, array(
      50,
    ));
    $core_extension = $this
      ->config('core.extension')
      ->get();
    unset($core_extension['module']['action']);
    unset($core_extension['module']['ban']);
    unset($core_extension['module']['options']);
    unset($core_extension['module']['text']);
    unset($core_extension['theme']['bartik']);
    $sync
      ->write('core.extension', $core_extension);
    $sync
      ->delete('action.settings');
    $sync
      ->delete('text.settings');
    $system_theme = $this
      ->config('system.theme')
      ->get();
    $system_theme['default'] = 'stark';
    $system_theme['admin'] = 'stark';
    $sync
      ->write('system.theme', $system_theme);

    // Set the state system to record installations and uninstallations.
    \Drupal::state()
      ->set('ConfigImportUITest.core.extension.modules_installed', array());
    \Drupal::state()
      ->set('ConfigImportUITest.core.extension.modules_uninstalled', array());

    // Verify that both appear as ready to import.
    $this
      ->drupalGet('admin/config/development/configuration');
    $this
      ->assertRaw('<td>core.extension');
    $this
      ->assertRaw('<td>system.theme');
    $this
      ->assertRaw('<td>action.settings');

    // Import and verify that both do not appear anymore.
    $this
      ->drupalPostForm(NULL, array(), t('Import all'));
    $this
      ->assertNoRaw('<td>core.extension');
    $this
      ->assertNoRaw('<td>system.theme');
    $this
      ->assertNoRaw('<td>action.settings');
    $this
      ->rebuildContainer();
    $this
      ->assertFalse(\Drupal::moduleHandler()
      ->moduleExists('ban'), 'Ban module uninstalled during import.');
    $this
      ->assertFalse(\Drupal::database()
      ->schema()
      ->tableExists('ban_ip'), 'The database table ban_ip does not exist.');
    $this
      ->assertFalse(\Drupal::moduleHandler()
      ->moduleExists('action'), 'Action module uninstalled during import.');
    $this
      ->assertFalse(\Drupal::moduleHandler()
      ->moduleExists('options'), 'Options module uninstalled during import.');
    $this
      ->assertFalse(\Drupal::moduleHandler()
      ->moduleExists('text'), 'Text module uninstalled during import.');

    // Ensure installations and uninstallation occur as expected.
    $installed = \Drupal::state()
      ->get('ConfigImportUITest.core.extension.modules_installed', array());
    $uninstalled = \Drupal::state()
      ->get('ConfigImportUITest.core.extension.modules_uninstalled', array());
    $expected = array(
      'options',
      'text',
      'ban',
      'action',
    );
    $this
      ->assertIdentical($expected, $uninstalled, 'Options, Text, Ban and Action modules uninstalled in the correct order.');
    $this
      ->assertTrue(empty($installed), 'No modules installed during import');
    $theme_info = \Drupal::service('theme_handler')
      ->listInfo();
    $this
      ->assertFalse(isset($theme_info['bartik']), 'Bartik theme uninstalled during import.');

    // Verify that the action.settings configuration object was only deleted
    // once during the import process.
    $delete_called = \Drupal::state()
      ->get('ConfigImportUITest.action.settings.delete', 0);
    $this
      ->assertIdentical($delete_called, 1, "The action.settings configuration was deleted once during configuration import.");
  }

  /**
   * Tests concurrent importing of configuration.
   */
  function testImportLock() {

    // Create updated configuration object.
    $new_site_name = 'Config import test ' . $this
      ->randomString();
    $this
      ->prepareSiteNameUpdate($new_site_name);

    // Verify that there are configuration differences to import.
    $this
      ->drupalGet('admin/config/development/configuration');
    $this
      ->assertNoText(t('There are no configuration changes to import.'));

    // Acquire a fake-lock on the import mechanism.
    $config_importer = $this
      ->configImporter();
    $this->container
      ->get('lock.persistent')
      ->acquire($config_importer::LOCK_NAME);

    // Attempt to import configuration and verify that an error message appears.
    $this
      ->drupalPostForm(NULL, array(), t('Import all'));
    $this
      ->assertText(t('Another request may be synchronizing configuration already.'));

    // Release the lock, just to keep testing sane.
    $this->container
      ->get('lock.persistent')
      ->release($config_importer::LOCK_NAME);

    // Verify site name has not changed.
    $this
      ->assertNotEqual($new_site_name, $this
      ->config('system.site')
      ->get('name'));
  }

  /**
   * Tests verification of site UUID before importing configuration.
   */
  function testImportSiteUuidValidation() {
    $sync = \Drupal::service('config.storage.sync');

    // Create updated configuration object.
    $config_data = $this
      ->config('system.site')
      ->get();

    // Generate a new site UUID.
    $config_data['uuid'] = \Drupal::service('uuid')
      ->generate();
    $sync
      ->write('system.site', $config_data);

    // Verify that there are configuration differences to import.
    $this
      ->drupalGet('admin/config/development/configuration');
    $this
      ->assertText(t('The staged configuration cannot be imported, because it originates from a different site than this site. You can only synchronize configuration between cloned instances of this site.'));
    $this
      ->assertNoFieldById('edit-submit', t('Import all'));
  }

  /**
   * Tests the screen that shows differences between active and sync.
   */
  function testImportDiff() {
    $sync = $this->container
      ->get('config.storage.sync');
    $config_name = 'config_test.system';
    $change_key = 'foo';
    $remove_key = '404';
    $add_key = 'biff';
    $add_data = '<em>bangpow</em>';
    $change_data = '<p><em>foobar</em></p>';
    $original_data = array(
      'foo' => '<p>foobar</p>',
      'baz' => '<strong>no change</strong>',
      '404' => '<em>herp</em>',
    );

    // Update active storage to have html in config data.
    $this
      ->config($config_name)
      ->setData($original_data)
      ->save();

    // Change a configuration value in sync.
    $sync_data = $original_data;
    $sync_data[$change_key] = $change_data;
    $sync_data[$add_key] = $add_data;
    unset($sync_data[$remove_key]);
    $sync
      ->write($config_name, $sync_data);

    // Load the diff UI and verify that the diff reflects the change.
    $this
      ->drupalGet('admin/config/development/configuration/sync/diff/' . $config_name);
    $this
      ->assertTitle(format_string('View changes of @config_name | Drupal', array(
      '@config_name' => $config_name,
    )));

    // The following assertions do not use $this::assertEscaped() because
    // \Drupal\Component\Diff\DiffFormatter adds markup that signifies what has
    // changed.
    // Changed values are escaped.
    $this
      ->assertText(Html::escape("foo: '<p><em>foobar</em></p>'"));
    $this
      ->assertText(Html::escape("foo: '<p>foobar</p>'"));

    // The no change values are escaped.
    $this
      ->assertText(Html::escape("baz: '<strong>no change</strong>'"));

    // Added value is escaped.
    $this
      ->assertText(Html::escape("biff: '<em>bangpow</em>'"));

    // Deleted value is escaped.
    $this
      ->assertText(Html::escape("404: '<em>herp</em>'"));

    // Reset data back to original, and remove a key
    $sync_data = $original_data;
    unset($sync_data[$remove_key]);
    $sync
      ->write($config_name, $sync_data);

    // Load the diff UI and verify that the diff reflects a removed key.
    $this
      ->drupalGet('admin/config/development/configuration/sync/diff/' . $config_name);

    // The no change values are escaped.
    $this
      ->assertText(Html::escape("foo: '<p>foobar</p>'"));
    $this
      ->assertText(Html::escape("baz: '<strong>no change</strong>'"));

    // Removed key is escaped.
    $this
      ->assertText(Html::escape("404: '<em>herp</em>'"));

    // Reset data back to original and add a key
    $sync_data = $original_data;
    $sync_data[$add_key] = $add_data;
    $sync
      ->write($config_name, $sync_data);

    // Load the diff UI and verify that the diff reflects an added key.
    $this
      ->drupalGet('admin/config/development/configuration/sync/diff/' . $config_name);

    // The no change values are escaped.
    $this
      ->assertText(Html::escape("baz: '<strong>no change</strong>'"));
    $this
      ->assertText(Html::escape("404: '<em>herp</em>'"));

    // Added key is escaped.
    $this
      ->assertText(Html::escape("biff: '<em>bangpow</em>'"));
  }

  /**
   * Tests that multiple validation errors are listed on the page.
   */
  public function testImportValidation() {

    // Set state value so that
    // \Drupal\config_import_test\EventSubscriber::onConfigImportValidate() logs
    // validation errors.
    \Drupal::state()
      ->set('config_import_test.config_import_validate_fail', TRUE);

    // Ensure there is something to import.
    $new_site_name = 'Config import test ' . $this
      ->randomString();
    $this
      ->prepareSiteNameUpdate($new_site_name);
    $this
      ->drupalGet('admin/config/development/configuration');
    $this
      ->assertNoText(t('There are no configuration changes to import.'));
    $this
      ->drupalPostForm(NULL, array(), t('Import all'));

    // Verify that the validation messages appear.
    $this
      ->assertText('The configuration cannot be imported because it failed validation for the following reasons:');
    $this
      ->assertText('Config import validate error 1.');
    $this
      ->assertText('Config import validate error 2.');

    // Verify site name has not changed.
    $this
      ->assertNotEqual($new_site_name, $this
      ->config('system.site')
      ->get('name'));
  }
  public function testConfigUninstallConfigException() {
    $sync = $this->container
      ->get('config.storage.sync');
    $core_extension = $this
      ->config('core.extension')
      ->get();
    unset($core_extension['module']['config']);
    $sync
      ->write('core.extension', $core_extension);
    $this
      ->drupalGet('admin/config/development/configuration');
    $this
      ->assertText('core.extension');

    // Import and verify that both do not appear anymore.
    $this
      ->drupalPostForm(NULL, array(), t('Import all'));
    $this
      ->assertText('Can not uninstall the Configuration module as part of a configuration synchronization through the user interface.');
  }
  function prepareSiteNameUpdate($new_site_name) {
    $sync = $this->container
      ->get('config.storage.sync');

    // Create updated configuration object.
    $config_data = $this
      ->config('system.site')
      ->get();
    $config_data['name'] = $new_site_name;
    $sync
      ->write('system.site', $config_data);
  }

  /**
   * Tests an import that results in an error.
   */
  function testImportErrorLog() {
    $name_primary = 'config_test.dynamic.primary';
    $name_secondary = 'config_test.dynamic.secondary';
    $sync = $this->container
      ->get('config.storage.sync');
    $uuid = $this->container
      ->get('uuid');
    $values_primary = array(
      'uuid' => $uuid
        ->generate(),
      'langcode' => 'en',
      'status' => TRUE,
      'dependencies' => array(),
      'id' => 'primary',
      'label' => 'Primary',
      'weight' => 0,
      'style' => NULL,
      'size' => NULL,
      'size_value' => NULL,
      'protected_property' => NULL,
    );
    $sync
      ->write($name_primary, $values_primary);
    $values_secondary = array(
      'uuid' => $uuid
        ->generate(),
      'langcode' => 'en',
      'status' => TRUE,
      // Add a dependency on primary, to ensure that is synced first.
      'dependencies' => array(
        'config' => array(
          $name_primary,
        ),
      ),
      'id' => 'secondary',
      'label' => 'Secondary Sync',
      'weight' => 0,
      'style' => NULL,
      'size' => NULL,
      'size_value' => NULL,
      'protected_property' => NULL,
    );
    $sync
      ->write($name_secondary, $values_secondary);

    // Verify that there are configuration differences to import.
    $this
      ->drupalGet('admin/config/development/configuration');
    $this
      ->assertNoText(t('There are no configuration changes to import.'));

    // Attempt to import configuration and verify that an error message appears.
    $this
      ->drupalPostForm(NULL, array(), t('Import all'));
    $this
      ->assertText(SafeMarkup::format('Deleted and replaced configuration entity "@name"', array(
      '@name' => $name_secondary,
    )));
    $this
      ->assertText(t('The configuration was imported with errors.'));
    $this
      ->assertNoText(t('The configuration was imported successfully.'));
    $this
      ->assertText(t('There are no configuration changes to import.'));
  }

  /**
   * Tests the config importer cannot delete bundles with existing entities.
   *
   * @see \Drupal\Core\Entity\Event\BundleConfigImportValidate
   */
  public function testEntityBundleDelete() {
    \Drupal::service('module_installer')
      ->install(array(
      'node',
    ));
    $this
      ->copyConfig($this->container
      ->get('config.storage'), $this->container
      ->get('config.storage.sync'));
    $node_type = $this
      ->drupalCreateContentType();
    $node = $this
      ->drupalCreateNode(array(
      'type' => $node_type
        ->id(),
    ));
    $this
      ->drupalGet('admin/config/development/configuration');

    // The node type, body field and entity displays will be scheduled for
    // removal.
    $this
      ->assertText(format_string('node.type.@type', array(
      '@type' => $node_type
        ->id(),
    )));
    $this
      ->assertText(format_string('field.field.node.@type.body', array(
      '@type' => $node_type
        ->id(),
    )));
    $this
      ->assertText(format_string('core.entity_view_display.node.@type.teaser', array(
      '@type' => $node_type
        ->id(),
    )));
    $this
      ->assertText(format_string('core.entity_view_display.node.@type.default', array(
      '@type' => $node_type
        ->id(),
    )));
    $this
      ->assertText(format_string('core.entity_form_display.node.@type.default', array(
      '@type' => $node_type
        ->id(),
    )));

    // Attempt to import configuration and verify that an error message appears
    // and the node type, body field and entity displays are still scheduled for
    // removal.
    $this
      ->drupalPostForm(NULL, array(), t('Import all'));
    $validation_message = t('Entities exist of type %entity_type and %bundle_label %bundle. These entities need to be deleted before importing.', array(
      '%entity_type' => $node
        ->getEntityType()
        ->getLabel(),
      '%bundle_label' => $node
        ->getEntityType()
        ->getBundleLabel(),
      '%bundle' => $node_type
        ->label(),
    ));
    $this
      ->assertRaw($validation_message);
    $this
      ->assertText(format_string('node.type.@type', array(
      '@type' => $node_type
        ->id(),
    )));
    $this
      ->assertText(format_string('field.field.node.@type.body', array(
      '@type' => $node_type
        ->id(),
    )));
    $this
      ->assertText(format_string('core.entity_view_display.node.@type.teaser', array(
      '@type' => $node_type
        ->id(),
    )));
    $this
      ->assertText(format_string('core.entity_view_display.node.@type.default', array(
      '@type' => $node_type
        ->id(),
    )));
    $this
      ->assertText(format_string('core.entity_form_display.node.@type.default', array(
      '@type' => $node_type
        ->id(),
    )));

    // Delete the node and try to import again.
    $node
      ->delete();
    $this
      ->drupalPostForm(NULL, array(), t('Import all'));
    $this
      ->assertNoRaw($validation_message);
    $this
      ->assertText(t('There are no configuration changes to import.'));
    $this
      ->assertNoText(format_string('node.type.@type', array(
      '@type' => $node_type
        ->id(),
    )));
    $this
      ->assertNoText(format_string('field.field.node.@type.body', array(
      '@type' => $node_type
        ->id(),
    )));
    $this
      ->assertNoText(format_string('core.entity_view_display.node.@type.teaser', array(
      '@type' => $node_type
        ->id(),
    )));
    $this
      ->assertNoText(format_string('core.entity_view_display.node.@type.default', array(
      '@type' => $node_type
        ->id(),
    )));
    $this
      ->assertNoText(format_string('core.entity_form_display.node.@type.default', array(
      '@type' => $node_type
        ->id(),
    )));
  }

  /**
   * Tests config importer cannot uninstall extensions which are depended on.
   *
   * @see \Drupal\Core\EventSubscriber\ConfigImportSubscriber
   */
  public function testExtensionValidation() {
    \Drupal::service('module_installer')
      ->install([
      'node',
    ]);
    \Drupal::service('theme_handler')
      ->install([
      'bartik',
    ]);
    $this
      ->rebuildContainer();
    $sync = $this->container
      ->get('config.storage.sync');
    $this
      ->copyConfig($this->container
      ->get('config.storage'), $sync);
    $core = $sync
      ->read('core.extension');

    // Node depends on text.
    unset($core['module']['text']);
    $module_data = system_rebuild_module_data();
    $this
      ->assertTrue(isset($module_data['node']->requires['text']), 'The Node module depends on the Text module.');

    // Bartik depends on classy.
    unset($core['theme']['classy']);
    $theme_data = \Drupal::service('theme_handler')
      ->rebuildThemeData();
    $this
      ->assertTrue(isset($theme_data['bartik']->requires['classy']), 'The Bartik theme depends on the Classy theme.');

    // This module does not exist.
    $core['module']['does_not_exist'] = 0;

    // This theme does not exist.
    $core['theme']['does_not_exist'] = 0;
    $sync
      ->write('core.extension', $core);
    $this
      ->drupalPostForm('admin/config/development/configuration', array(), t('Import all'));
    $this
      ->assertText('The configuration cannot be imported because it failed validation for the following reasons:');
    $this
      ->assertText('Unable to uninstall the Text module since the Node module is installed.');
    $this
      ->assertText('Unable to uninstall the Classy theme since the Bartik theme is installed.');
    $this
      ->assertText('Unable to install the does_not_exist module since it does not exist.');
    $this
      ->assertText('Unable to install the does_not_exist theme since it does not exist.');
  }

}

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. 2
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::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 function Casts MarkupInterface objects into strings.
ConfigImportUITest::$modules public static property Modules to install.
ConfigImportUITest::$webUser protected property A user with the 'synchronize configuration' permission.
ConfigImportUITest::prepareSiteNameUpdate function
ConfigImportUITest::setUp protected function Sets up a Drupal site for running functional and integration tests. Overrides WebTestBase::setUp
ConfigImportUITest::testConfigUninstallConfigException public function
ConfigImportUITest::testEntityBundleDelete public function Tests the config importer cannot delete bundles with existing entities.
ConfigImportUITest::testExtensionValidation public function Tests config importer cannot uninstall extensions which are depended on.
ConfigImportUITest::testImport function Tests importing configuration.
ConfigImportUITest::testImportDiff function Tests the screen that shows differences between active and sync.
ConfigImportUITest::testImportErrorLog function Tests an import that results in an error.
ConfigImportUITest::testImportLock function Tests concurrent importing of configuration.
ConfigImportUITest::testImportSiteUuidValidation function Tests verification of site UUID before importing configuration.
ConfigImportUITest::testImportValidation public function Tests that multiple validation errors are listed on the page.
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.
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.
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.
TestBase::$assertions protected property Assertions thrown in that test case.
TestBase::$configImporter protected property The config importer that can used in a test. 5
TestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
TestBase::$container protected property The dependency injection container used in the 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::$originalProfile protected property The original installation profile.
TestBase::$originalSessionName protected property The name of the session cookie of the test-runner.
TestBase::$originalSettings protected property The settings array.
TestBase::$originalSite protected property The site directory of the original parent site.
TestBase::$privateFilesDirectory protected property The private file directory for the test environment.
TestBase::$publicFilesDirectory protected property The public file directory for the test environment.
TestBase::$results public property Current results of this test case.
TestBase::$siteDirectory protected property The site directory of this test run.
TestBase::$skipClasses protected property This class is skipped when looking for the source of an assertion.
TestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 4
TestBase::$tempFilesDirectory protected property The temporary file directory for the test environment.
TestBase::$testId protected property The test run ID.
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::changeDatabasePrefix private function Changes the database connection to the prefixed one.
TestBase::checkRequirements protected function Checks the matching requirements for Test. 2
TestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
TestBase::configImporter public function Returns a ConfigImporter object to import test importing of configuration. 5
TestBase::copyConfig public function Copies configuration objects from source storage to target storage.
TestBase::deleteAssert public static function Delete an assertion record by message ID.
TestBase::error protected function Fire an error assertion. 3
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 within file_unmanaged_delete_recursive().
TestBase::generatePermutations public static function Converts a list of possible parameters into a stack of permutations.
TestBase::getAssertionCall protected function Cycles through backtrace until the first non-assertion method is found.
TestBase::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
TestBase::getDatabaseConnection public static function Returns the database connection to the site running Simpletest.
TestBase::getDatabasePrefix public function Gets the database prefix.
TestBase::getTempFilesDirectory public function Gets the temporary files directory.
TestBase::insertAssert public static function Store an assertion from outside the testing context.
TestBase::pass protected function Fire an assertion that is always positive.
TestBase::prepareDatabasePrefix private function Generates a database prefix for running tests.
TestBase::prepareEnvironment private function Prepares the current environment for running the test.
TestBase::restoreEnvironment private function Cleans up the test environment and restores the original environment.
TestBase::run public function Run all tests in this class. 1
TestBase::settingsSet protected function Changes in memory settings.
TestBase::storeAssertion protected function Helper method to store an assertion record in the configured database.
TestBase::verbose protected function Logs a verbose message in a text file.
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.
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::$classLoader protected property The class loader to use for installation and initialization of setup.
WebTestBase::$configDirectories protected property The config directories used in this test.
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. 12
WebTestBase::$generatedTestFiles protected property Whether the files were copied to the test files directory.
WebTestBase::$headers protected property The headers of the page currently loaded in the internal browser.
WebTestBase::$kernel protected property The kernel used in this test. Overrides TestBase::$kernel
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. 30
WebTestBase::$redirectCount protected property The number of redirects followed during the handling of a request.
WebTestBase::$rootUser protected property The "#1" admin user.
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::assertCacheContext protected function Asserts whether an expected cache context was present in the last response.
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::assertMail protected function Asserts that the most recently sent email message has the given value.
WebTestBase::assertMailPattern protected function Asserts that the most recently sent email message has the pattern in it.
WebTestBase::assertMailString protected function Asserts that the most recently sent email message has the string in it.
WebTestBase::assertNoBlockAppears protected function Checks to see whether a block does not appears on the page.
WebTestBase::assertNoCacheContext protected function Asserts that a cache context was not present in the last response.
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.
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::cronRun protected function Runs cron in the Drupal installed by Simpletest.
WebTestBase::curlClose protected function Close the cURL handler and unset the handler.
WebTestBase::curlExec protected function Initializes and executes a cURL request. 2
WebTestBase::curlHeaderCallback protected function Reads headers and registers errors received from the tested site.
WebTestBase::curlInitialize protected function Initializes the cURL connection.
WebTestBase::doInstall protected function Execute the non-interactive installer.
WebTestBase::drupalBuildEntityView protected function Builds the renderable view of an entity.
WebTestBase::drupalCompareFiles protected function Compare two files based on size and file name.
WebTestBase::drupalCreateContentType protected function Creates a custom content type based on default settings.
WebTestBase::drupalCreateNode protected function Creates a node based on default settings.
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.
WebTestBase::drupalGetHeaders protected function Gets the HTTP response headers of the requested page.
WebTestBase::drupalGetJSON protected function Retrieves a Drupal path or an absolute path and JSON decodes the result.
WebTestBase::drupalGetMails protected function Gets an array containing all emails sent during this test case.
WebTestBase::drupalGetNodeByTitle function Get a node from the database based on its title.
WebTestBase::drupalGetTestFiles protected function Gets a list of files that can be used in tests.
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::drupalPlaceBlock protected function Creates a block instance based on default settings.
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::getDatabaseTypes protected function Returns all supported database driver installer objects.
WebTestBase::handleForm protected function Handles form input related to drupalPostForm().
WebTestBase::initConfig protected function Initialize various configurations post-installation.
WebTestBase::initKernel protected function Initializes the kernel after installation.
WebTestBase::initSettings protected function Initialize settings created during install.
WebTestBase::initUserSession protected function Initializes user 1 for the site to be installed.
WebTestBase::installModulesFromClassProperty protected function Install modules defined by `static::$modules`.
WebTestBase::installParameters protected function Returns the parameters that will be used when Simpletest installs Drupal. 2
WebTestBase::isInChildSite protected function Returns whether the test is being executed from within a test site.
WebTestBase::prepareRequestForGenerator protected function Creates a mock request and sets it on the generator.
WebTestBase::prepareSettings protected function Prepares site settings and services before installation. 1
WebTestBase::rebuildAll protected function Reset and rebuild the environment after setup.
WebTestBase::rebuildContainer protected function Rebuilds \Drupal::getContainer().
WebTestBase::refreshVariables protected function Refreshes in-memory configuration and state information. 1
WebTestBase::resetAll protected function Resets all data structures after having enabled new modules.
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::setContainerParameter protected function Changes parameters in the services.yml file.
WebTestBase::setHttpResponseDebugCacheabilityHeaders protected function Enables/disables the cacheability headers.
WebTestBase::tearDown protected function Cleans up after testing. Overrides TestBase::tearDown 2
WebTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for WebTestBase::drupalPostForm().
WebTestBase::verboseEmail protected function Outputs to verbose the most recent $count emails sent.
WebTestBase::writeCustomTranslations protected function Writes custom translations to the test site's settings.php.
WebTestBase::writeSettings protected function Rewrites the settings.php file of the test site.
WebTestBase::__construct function Constructor for \Drupal\simpletest\WebTestBase. Overrides TestBase::__construct 1