class ConfigImportUITest in Drupal 9

Same name and namespace in other branches

8 core/modules/config/tests/src/Functional/ConfigImportUITest.php \Drupal\Tests\config\Functional\ConfigImportUITest

Tests the user interface for importing configuration.

@group config

Hierarchy

class \Drupal\Tests\BrowserTestBase extends \PHPUnit\Framework\TestCase uses \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, FunctionalTestSetupTrait, TestSetupTrait, AssertLegacyTrait, BlockCreationTrait, ConfigTestTrait, ExtensionListTestTrait, ContentTypeCreationTrait, NodeCreationTrait, PhpUnitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait, PhpUnitWarnings, UiHelperTrait, UserCreationTrait, XdebugRequestTrait
- class \Drupal\Tests\config\Functional\ConfigImportUITest

Expanded class hierarchy of ConfigImportUITest

File

core/modules/config/tests/src/Functional/ConfigImportUITest.php, line 13

Namespace

Drupal\Tests\config\Functional

View source

class ConfigImportUITest extends BrowserTestBase {

  /**
   * Modules to install.
   *
   * @var array
   */
  protected static $modules = [
    'config',
    'config_test',
    'config_import_test',
    'text',
    'options',
  ];

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

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

  /**
   * Tests importing configuration.
   */
  public 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
      ->assertSession()
      ->pageTextContains('There are no configuration changes to import.');
    $this
      ->assertSession()
      ->buttonNotExists('Import all');

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

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

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

    // Bartik is a subtheme of Stable so Stable must be enabled.
    $core_extension['theme']['stable'] = 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 automated_cron config from module default config folder.
    $settings = $install_storage
      ->read('automated_cron.settings');
    $settings['interval'] = 10000;
    $sync
      ->write('automated_cron.settings', $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([
      'text',
      'options',
    ]);

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

    // Verify that both appear as ready to import.
    $this
      ->drupalGet('admin/config/development/configuration');
    $this
      ->assertSession()
      ->responseContains('<td>' . $name);
    $this
      ->assertSession()
      ->responseContains('<td>' . $dynamic_name);
    $this
      ->assertSession()
      ->responseContains('<td>core.extension');
    $this
      ->assertSession()
      ->responseContains('<td>system.theme');
    $this
      ->assertSession()
      ->responseContains('<td>automated_cron.settings');
    $this
      ->assertSession()
      ->buttonExists('Import all');

    // Import and verify that both do not appear anymore.
    $this
      ->submitForm([], 'Import all');
    $this
      ->assertSession()
      ->responseNotContains('<td>' . $name);
    $this
      ->assertSession()
      ->responseNotContains('<td>' . $dynamic_name);
    $this
      ->assertSession()
      ->responseNotContains('<td>core.extension');
    $this
      ->assertSession()
      ->responseNotContains('<td>system.theme');
    $this
      ->assertSession()
      ->responseNotContains('<td>automated_cron.settings');
    $this
      ->assertSession()
      ->buttonNotExists('Import all');

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

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

    // Verify that new config entity exists.
    $this
      ->assertSame($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('automated_cron'), 'Automated Cron 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.');
    $this
      ->assertTrue(\Drupal::service('theme_handler')
      ->themeExists('bartik'), 'Bartik theme installed during import.');

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

    // Verify that the automated_cron 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.
    $interval_values = \Drupal::state()
      ->get('ConfigImportUITest.automated_cron.settings.interval', []);
    $this
      ->assertSame([
      10000,
    ], $interval_values);
    $core_extension = $this
      ->config('core.extension')
      ->get();
    unset($core_extension['module']['automated_cron']);
    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('automated_cron.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', []);
    \Drupal::state()
      ->set('ConfigImportUITest.core.extension.modules_uninstalled', []);

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

    // Import and verify that both do not appear anymore.
    $this
      ->submitForm([], 'Import all');
    $this
      ->assertSession()
      ->responseNotContains('<td>core.extension');
    $this
      ->assertSession()
      ->responseNotContains('<td>system.theme');
    $this
      ->assertSession()
      ->responseNotContains('<td>automated_cron.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('automated_cron'), 'Automated cron 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', []);
    $uninstalled = \Drupal::state()
      ->get('ConfigImportUITest.core.extension.modules_uninstalled', []);
    $expected = [
      'options',
      'text',
      'ban',
      'automated_cron',
    ];
    $this
      ->assertSame($expected, $uninstalled, 'Options, Text, Ban and Automated Cron 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 automated_cron.settings configuration object was only
    // deleted once during the import process.
    $delete_called = \Drupal::state()
      ->get('ConfigImportUITest.automated_cron.settings.delete', 0);
    $this
      ->assertSame(1, $delete_called, "The automated_cron.settings configuration was deleted once during configuration import.");
  }

  /**
   * Tests concurrent importing of configuration.
   */
  public 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
      ->assertSession()
      ->pageTextNotContains('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
      ->submitForm([], 'Import all');
    $this
      ->assertSession()
      ->pageTextContains('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
      ->assertNotEquals($this
      ->config('system.site')
      ->get('name'), $new_site_name);
  }

  /**
   * Tests verification of site UUID before importing configuration.
   */
  public 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
      ->assertSession()
      ->pageTextContains('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
      ->assertSession()
      ->buttonNotExists('Import all');
  }

  /**
   * Tests the screen that shows differences between active and sync.
   */
  public 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 = [
      '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
      ->assertSession()
      ->responseNotContains('&amp;nbsp;');
    $this
      ->assertSession()
      ->titleEquals("View changes of {$config_name} | Drupal");

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

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

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

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

    // Verify diff colors are displayed.
    $result = $this
      ->xpath('//table[contains(@class, :class)]', [
      ':class' => 'diff',
    ]);
    $this
      ->assertCount(1, $result, "Diff UI is displaying colors.");

    // 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
      ->assertSession()
      ->pageTextContains("foo: '<p>foobar</p>'");
    $this
      ->assertSession()
      ->pageTextContains("baz: '<strong>no change</strong>'");

    // Removed key is escaped.
    $this
      ->assertSession()
      ->pageTextContains("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
      ->assertSession()
      ->pageTextContains("baz: '<strong>no change</strong>'");
    $this
      ->assertSession()
      ->pageTextContains("404: '<em>herp</em>'");

    // Added key is escaped.
    $this
      ->assertSession()
      ->pageTextContains("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
      ->assertSession()
      ->pageTextNotContains('There are no configuration changes to import.');
    $this
      ->submitForm([], 'Import all');

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

    // Verify site name has not changed.
    $this
      ->assertNotEquals($this
      ->config('system.site')
      ->get('name'), $new_site_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
      ->assertSession()
      ->pageTextContains('core.extension');

    // Import and verify that both do not appear anymore.
    $this
      ->submitForm([], 'Import all');
    $this
      ->assertSession()
      ->pageTextContains('Can not uninstall the Configuration module as part of a configuration synchronization through the user interface.');
  }
  public 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.
   */
  public 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 = [
      'uuid' => $uuid
        ->generate(),
      'langcode' => 'en',
      'status' => TRUE,
      'dependencies' => [],
      'id' => 'primary',
      'label' => 'Primary',
      'weight' => 0,
      'style' => NULL,
      'size' => NULL,
      'size_value' => NULL,
      'protected_property' => NULL,
    ];
    $sync
      ->write($name_primary, $values_primary);
    $values_secondary = [
      'uuid' => $uuid
        ->generate(),
      'langcode' => 'en',
      'status' => TRUE,
      // Add a dependency on primary, to ensure that is synced first.
      'dependencies' => [
        'config' => [
          $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
      ->assertSession()
      ->pageTextNotContains('There are no configuration changes to import.');

    // Attempt to import configuration and verify that an error message appears.
    $this
      ->submitForm([], 'Import all');
    $this
      ->assertSession()
      ->pageTextContains('Deleted and replaced configuration entity "' . $name_secondary . '"');
    $this
      ->assertSession()
      ->pageTextContains('The configuration was imported with errors.');
    $this
      ->assertSession()
      ->pageTextNotContains('The configuration was imported successfully.');
    $this
      ->assertSession()
      ->pageTextContains('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([
      'node',
    ]);
    $this
      ->copyConfig($this->container
      ->get('config.storage'), $this->container
      ->get('config.storage.sync'));
    $node_type = $this
      ->drupalCreateContentType();
    $node = $this
      ->drupalCreateNode([
      'type' => $node_type
        ->id(),
    ]);
    $this
      ->drupalGet('admin/config/development/configuration');

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

    // 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
      ->submitForm([], 'Import all');
    $validation_message = "Entities exist of type {$node->getEntityType()->getLabel()} and {$node->getEntityType()->getBundleLabel()} {$node_type->label()}. These entities need to be deleted before importing.";
    $this
      ->assertSession()
      ->pageTextContains($validation_message);
    $this
      ->assertSession()
      ->pageTextContains('node.type.' . $node_type
      ->id());
    $this
      ->assertSession()
      ->pageTextContains('field.field.node.' . $node_type
      ->id() . '.body');
    $this
      ->assertSession()
      ->pageTextContains('core.entity_view_display.node.' . $node_type
      ->id() . '.teaser');
    $this
      ->assertSession()
      ->pageTextContains('core.entity_view_display.node.' . $node_type
      ->id() . '.default');
    $this
      ->assertSession()
      ->pageTextContains('core.entity_form_display.node.' . $node_type
      ->id() . '.default');

    // Delete the node and try to import again.
    $node
      ->delete();
    $this
      ->submitForm([], 'Import all');
    $this
      ->assertSession()
      ->pageTextNotContains($validation_message);
    $this
      ->assertSession()
      ->pageTextContains('There are no configuration changes to import.');
    $this
      ->assertSession()
      ->pageTextNotContains('node.type.' . $node_type
      ->id());
    $this
      ->assertSession()
      ->pageTextNotContains('field.field.node.' . $node_type
      ->id() . '.body');
    $this
      ->assertSession()
      ->pageTextNotContains('core.entity_view_display.node.' . $node_type
      ->id() . '.teaser');
    $this
      ->assertSession()
      ->pageTextNotContains('core.entity_view_display.node.' . $node_type
      ->id() . '.default');
    $this
      ->assertSession()
      ->pageTextNotContains('core.entity_form_display.node.' . $node_type
      ->id() . '.default');
  }

  /**
   * 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_installer')
      ->install([
      'test_subtheme',
    ]);
    $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 = $this->container
      ->get('extension.list.module')
      ->getList();
    $this
      ->assertTrue(isset($module_data['node']->requires['text']), 'The Node module depends on the Text module.');

    // Bartik depends on Stable.
    unset($core['theme']['test_basetheme']);
    $theme_data = \Drupal::service('theme_handler')
      ->rebuildThemeData();
    $this
      ->assertTrue(isset($theme_data['test_subtheme']->requires['test_basetheme']), 'The Test Subtheme theme depends on the Test Basetheme 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
      ->drupalGet('admin/config/development/configuration');
    $this
      ->submitForm([], 'Import all');
    $this
      ->assertSession()
      ->pageTextContains('The configuration cannot be imported because it failed validation for the following reasons:');
    $this
      ->assertSession()
      ->pageTextContains('Unable to uninstall the Text module since the Node module is installed.');
    $this
      ->assertSession()
      ->pageTextContains('Unable to uninstall the Theme test base theme theme since the Theme test subtheme theme is installed.');
    $this
      ->assertSession()
      ->pageTextContains('Unable to install the does_not_exist module since it does not exist.');
    $this
      ->assertSession()
      ->pageTextContains('Unable to install the does_not_exist theme since it does not exist.');
  }

  /**
   * Tests that errors set in the batch and on the ConfigImporter are merged.
   */
  public function testBatchErrors() {
    $new_site_name = 'Config import test ' . $this
      ->randomString();
    $this
      ->prepareSiteNameUpdate($new_site_name);
    \Drupal::state()
      ->set('config_import_steps_alter.error', TRUE);
    $this
      ->drupalGet('admin/config/development/configuration');
    $this
      ->submitForm([], 'Import all');
    $this
      ->assertSession()
      ->responseContains('_config_import_test_config_import_steps_alter batch error');
    $this
      ->assertSession()
      ->responseContains('_config_import_test_config_import_steps_alter ConfigImporter error');
    $this
      ->assertSession()
      ->responseContains('The configuration was imported with errors.');
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AssertLegacyTrait::assert Deprecated	protected	function
AssertLegacyTrait::assertCacheTag Deprecated	protected	function	Asserts whether an expected cache tag was present in the last response.
AssertLegacyTrait::assertElementNotPresent Deprecated	protected	function	Asserts that the element with the given CSS selector is not present.
AssertLegacyTrait::assertElementPresent Deprecated	protected	function	Asserts that the element with the given CSS selector is present.
AssertLegacyTrait::assertEqual Deprecated	protected	function
AssertLegacyTrait::assertEscaped Deprecated	protected	function	Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertLegacyTrait::assertField Deprecated	protected	function	Asserts that a field exists with the given name or ID.
AssertLegacyTrait::assertFieldById Deprecated	protected	function	Asserts that a field exists with the given ID and value.
AssertLegacyTrait::assertFieldByName Deprecated	protected	function	Asserts that a field exists with the given name and value.
AssertLegacyTrait::assertFieldByXPath Deprecated	protected	function	Asserts that a field exists in the current page by the given XPath.
AssertLegacyTrait::assertFieldChecked Deprecated	protected	function	Asserts that a checkbox field in the current page is checked.
AssertLegacyTrait::assertFieldsByValue Deprecated	protected	function	Asserts that a field exists in the current page with a given Xpath result.
AssertLegacyTrait::assertHeader Deprecated	protected	function	Checks that current response header equals value.
AssertLegacyTrait::assertIdentical Deprecated	protected	function
AssertLegacyTrait::assertIdenticalObject Deprecated	protected	function
AssertLegacyTrait::assertLink Deprecated	protected	function	Passes if a link with the specified label is found.
AssertLegacyTrait::assertLinkByHref Deprecated	protected	function	Passes if a link containing a given href (part) is found.
AssertLegacyTrait::assertNoCacheTag Deprecated	protected	function	Asserts whether an expected cache tag was absent in the last response.
AssertLegacyTrait::assertNoEscaped Deprecated	protected	function	Passes if the raw text is not found escaped on the loaded page.
AssertLegacyTrait::assertNoField Deprecated	protected	function	Asserts that a field does NOT exist with the given name or ID.
AssertLegacyTrait::assertNoFieldById Deprecated	protected	function	Asserts that a field does not exist with the given ID and value.
AssertLegacyTrait::assertNoFieldByName Deprecated	protected	function	Asserts that a field does not exist with the given name and value.
AssertLegacyTrait::assertNoFieldByXPath Deprecated	protected	function	Asserts that a field does not exist or its value does not match, by XPath.
AssertLegacyTrait::assertNoFieldChecked Deprecated	protected	function	Asserts that a checkbox field in the current page is not checked.
AssertLegacyTrait::assertNoLink Deprecated	protected	function	Passes if a link with the specified label is not found.
AssertLegacyTrait::assertNoLinkByHref Deprecated	protected	function	Passes if a link containing a given href (part) is not found.
AssertLegacyTrait::assertNoOption Deprecated	protected	function	Asserts that a select option does NOT exist in the current page.
AssertLegacyTrait::assertNoPattern Deprecated	protected	function	Triggers a pass if the Perl regex pattern is not found in the raw content.
AssertLegacyTrait::assertNoRaw Deprecated	protected	function	Passes if the raw text IS not found on the loaded page, fail otherwise.
AssertLegacyTrait::assertNotEqual Deprecated	protected	function
AssertLegacyTrait::assertNoText Deprecated	protected	function	Passes if the page (with HTML stripped) does not contains the text.
AssertLegacyTrait::assertNotIdentical Deprecated	protected	function
AssertLegacyTrait::assertNoUniqueText Deprecated	protected	function	Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertLegacyTrait::assertOption Deprecated	protected	function	Asserts that a select option in the current page exists.
AssertLegacyTrait::assertOptionByText Deprecated	protected	function	Asserts that a select option with the visible text exists.
AssertLegacyTrait::assertOptionSelected Deprecated	protected	function	Asserts that a select option in the current page is checked.
AssertLegacyTrait::assertPattern Deprecated	protected	function	Triggers a pass if the Perl regex pattern is found in the raw content.
AssertLegacyTrait::assertRaw Deprecated	protected	function	Passes if the raw text IS found on the loaded page, fail otherwise.
AssertLegacyTrait::assertResponse Deprecated	protected	function	Asserts the page responds with the specified response code.
AssertLegacyTrait::assertText Deprecated	protected	function	Passes if the page (with HTML stripped) contains the text.
AssertLegacyTrait::assertTextHelper Deprecated	protected	function	Helper for assertText and assertNoText.
AssertLegacyTrait::assertTitle Deprecated	protected	function	Pass if the page title is the given string.
AssertLegacyTrait::assertUniqueText Deprecated	protected	function	Passes if the text is found ONLY ONCE on the text version of the page.
AssertLegacyTrait::assertUrl Deprecated	protected	function	Passes if the internal browser's URL matches the given path.
AssertLegacyTrait::buildXPathQuery Deprecated	protected	function	Builds an XPath query.
AssertLegacyTrait::constructFieldXpath Deprecated	protected	function	Helper: Constructs an XPath for the given set of attributes and value.
AssertLegacyTrait::getAllOptions Deprecated	protected	function	Get all option elements, including nested options, in a select.
AssertLegacyTrait::getRawContent Deprecated	protected	function	Gets the current raw content.
AssertLegacyTrait::pass Deprecated	protected	function
AssertLegacyTrait::verbose Deprecated	protected	function
BlockCreationTrait::placeBlock	protected	function	Creates a block instance based on default settings. Aliased as: drupalPlaceBlock
BrowserHtmlDebugTrait::$htmlOutputBaseUrl	protected	property	The Base URI to use for links to the output files.
BrowserHtmlDebugTrait::$htmlOutputClassName	protected	property	Class name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounter	protected	property	Counter for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounterStorage	protected	property	Counter storage for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputDirectory	protected	property	Directory name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputEnabled	protected	property	HTML output output enabled.
BrowserHtmlDebugTrait::$htmlOutputFile	protected	property	The file name to write the list of URLs to.
BrowserHtmlDebugTrait::$htmlOutputTestId	protected	property	HTML output test ID.
BrowserHtmlDebugTrait::formatHtmlOutputHeaders	protected	function	Formats HTTP headers as string for HTML output logging.
BrowserHtmlDebugTrait::getHtmlOutputHeaders	protected	function	Returns headers in HTML output format.	1
BrowserHtmlDebugTrait::getResponseLogHandler	protected	function	Provides a Guzzle middleware handler to log every response received.
BrowserHtmlDebugTrait::htmlOutput	protected	function	Logs a HTML output message in a text file.
BrowserHtmlDebugTrait::initBrowserOutputFile	protected	function	Creates the directory to store browser output.
BrowserTestBase::$baseUrl	protected	property	The base URL.
BrowserTestBase::$configImporter	protected	property	The config importer that can be used in a test.
BrowserTestBase::$customTranslations	protected	property	An array of custom translations suitable for drupal_rewrite_settings().
BrowserTestBase::$databasePrefix	protected	property	The database prefix of this test run.
BrowserTestBase::$mink	protected	property	Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs	protected	property	Mink default driver params.
BrowserTestBase::$minkDefaultDriverClass	protected	property	Mink class for the default driver to use.	1
BrowserTestBase::$originalContainer	protected	property	The original container.
BrowserTestBase::$originalShutdownCallbacks	protected	property	The original array of shutdown function callbacks.
BrowserTestBase::$preserveGlobalState	protected	property
BrowserTestBase::$profile	protected	property	The profile to install as a basis for testing.	39
BrowserTestBase::$root	protected	property	The app root.
BrowserTestBase::$runTestInSeparateProcess	protected	property	Browser tests are run in separate processes to prevent collisions between code that may be loaded by tests.
BrowserTestBase::$timeLimit	protected	property	Time limit in seconds for the test.
BrowserTestBase::$translationFilesDirectory	protected	property	The translation file directory for the test environment.
BrowserTestBase::cleanupEnvironment	protected	function	Clean up the Simpletest environment.
BrowserTestBase::config	protected	function	Configuration accessor for tests. Returns non-overridden configuration.
BrowserTestBase::drupalGetHeader Deprecated	protected	function	Gets the value of an HTTP response header.
BrowserTestBase::filePreDeleteCallback	public static	function	Ensures test files are deletable.
BrowserTestBase::getDefaultDriverInstance	protected	function	Gets an instance of the default Mink driver.
BrowserTestBase::getDrupalSettings	protected	function	Gets the JavaScript drupalSettings variable for the currently-loaded page.	1
BrowserTestBase::getHttpClient	protected	function	Obtain the HTTP client for the system under test.
BrowserTestBase::getMinkDriverArgs	protected	function	Get the Mink driver args from an environment variable, if it is set. Can be overridden in a derived class so it is possible to use a different value for a subset of tests, e.g. the JavaScript tests.	1
BrowserTestBase::getOptions	protected	function	Helper function to get the options of select field.
BrowserTestBase::getSession	public	function	Returns Mink session.
BrowserTestBase::getSessionCookies	protected	function	Get session cookies from current session.
BrowserTestBase::getTestMethodCaller	protected	function	Retrieves the current calling line in the class under test. Overrides BrowserHtmlDebugTrait::getTestMethodCaller
BrowserTestBase::initFrontPage	protected	function	Visits the front page when initializing Mink.	3
BrowserTestBase::initMink	protected	function	Initializes Mink sessions.	1
BrowserTestBase::installDrupal	public	function	Installs Drupal into the Simpletest site.	1
BrowserTestBase::registerSessions	protected	function	Registers additional Mink sessions.
BrowserTestBase::setUpAppRoot	protected	function	Sets up the root application path.
BrowserTestBase::setUpBeforeClass	public static	function		1
BrowserTestBase::tearDown	protected	function		3
BrowserTestBase::translatePostValues	protected	function	Transforms a nested array into a flat array suitable for submitForm().
BrowserTestBase::xpath	protected	function	Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__sleep	public	function	Prevents serializing any properties.
ConfigImportUITest::$defaultTheme	protected	property	The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
ConfigImportUITest::$modules	protected static	property	Modules to install. Overrides BrowserTestBase::$modules
ConfigImportUITest::$webUser	protected	property	A user with the 'synchronize configuration' permission.
ConfigImportUITest::prepareSiteNameUpdate	public	function
ConfigImportUITest::setUp	protected	function	Overrides BrowserTestBase::setUp
ConfigImportUITest::testBatchErrors	public	function	Tests that errors set in the batch and on the ConfigImporter are merged.
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	public	function	Tests importing configuration.
ConfigImportUITest::testImportDiff	public	function	Tests the screen that shows differences between active and sync.
ConfigImportUITest::testImportErrorLog	public	function	Tests an import that results in an error.
ConfigImportUITest::testImportLock	public	function	Tests concurrent importing of configuration.
ConfigImportUITest::testImportSiteUuidValidation	public	function	Tests verification of site UUID before importing configuration.
ConfigImportUITest::testImportValidation	public	function	Tests that multiple validation errors are listed on the page.
ConfigTestTrait::configImporter	protected	function	Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig	protected	function	Copies configuration objects from source storage to target storage.
ContentTypeCreationTrait::createContentType	protected	function	Creates a custom content type based on default settings. Aliased as: drupalCreateContentType	1
ExtensionListTestTrait::getModulePath	protected	function	Gets the path for the specified module.
ExtensionListTestTrait::getThemePath	protected	function	Gets the path for the specified theme.
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix	protected	property	The flag to set 'apcu_ensure_unique_prefix' setting.	1
FunctionalTestSetupTrait::$classLoader	protected	property	The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$rootUser	protected	property	The "#1" admin user.
FunctionalTestSetupTrait::doInstall	protected	function	Execute the non-interactive installer.	1
FunctionalTestSetupTrait::getDatabaseTypes	protected	function	Returns all supported database driver installer objects.
FunctionalTestSetupTrait::initConfig	protected	function	Initialize various configurations post-installation.	1
FunctionalTestSetupTrait::initKernel	protected	function	Initializes the kernel after installation.
FunctionalTestSetupTrait::initSettings	protected	function	Initialize settings created during install.
FunctionalTestSetupTrait::initUserSession	protected	function	Initializes user 1 for the site to be installed.
FunctionalTestSetupTrait::installDefaultThemeFromClassProperty	protected	function	Installs the default theme defined by `static::$defaultTheme` when needed.
FunctionalTestSetupTrait::installModulesFromClassProperty	protected	function	Install modules defined by `static::$modules`.	1
FunctionalTestSetupTrait::installParameters	protected	function	Returns the parameters that will be used when Simpletest installs Drupal.	9
FunctionalTestSetupTrait::prepareEnvironment	protected	function	Prepares the current environment for running the test.	20
FunctionalTestSetupTrait::prepareRequestForGenerator	protected	function	Creates a mock request and sets it on the generator.
FunctionalTestSetupTrait::prepareSettings	protected	function	Prepares site settings and services before installation.	2
FunctionalTestSetupTrait::rebuildAll	protected	function	Resets and rebuilds the environment after setup.
FunctionalTestSetupTrait::rebuildContainer	protected	function	Rebuilds \Drupal::getContainer().
FunctionalTestSetupTrait::resetAll	protected	function	Resets all data structures after having enabled new modules.
FunctionalTestSetupTrait::setContainerParameter	protected	function	Changes parameters in the services.yml file.
FunctionalTestSetupTrait::setupBaseUrl	protected	function	Sets up the base URL based upon the environment variable.
FunctionalTestSetupTrait::writeSettings	protected	function	Rewrites the settings.php file of the test site.	1
NodeCreationTrait::createNode	protected	function	Creates a node based on default settings. Aliased as: drupalCreateNode
NodeCreationTrait::getNodeByTitle	public	function	Get a node from the database based on its title. Aliased as: drupalGetNodeByTitle
PhpUnitWarnings::$deprecationWarnings	private static	property	Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning	public	function	Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
RandomGeneratorTrait::$randomGenerator	protected	property	The random generator.
RandomGeneratorTrait::getRandomGenerator	protected	function	Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName	protected	function	Generates a unique random string containing letters and numbers.	1
RandomGeneratorTrait::randomObject	public	function	Generates a random PHP object.
RandomGeneratorTrait::randomString	public	function	Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate	public	function	Callback for random string validation.
RefreshVariablesTrait::refreshVariables	protected	function	Refreshes in-memory configuration and state information.	1
SessionTestTrait::$sessionName	protected	property	The name of the session cookie.
SessionTestTrait::generateSessionName	protected	function	Generates a session cookie name.
SessionTestTrait::getSessionName	protected	function	Returns the session name in use on the child site.
StorageCopyTrait::replaceStorageContents	protected static	function	Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements	private	function	Checks missing module requirements.
TestRequirementsTrait::checkRequirements	protected	function	Check module requirements for the Drupal use case.	1
TestRequirementsTrait::getDrupalRoot	protected static	function	Returns the Drupal root directory.
TestSetupTrait::$configSchemaCheckerExclusions	protected static	property	An array of config object names that are excluded from schema checking.
TestSetupTrait::$container	protected	property	The dependency injection container used in the test.
TestSetupTrait::$kernel	protected	property	The DrupalKernel instance used in the test.
TestSetupTrait::$originalSite	protected	property	The site directory of the original parent site.
TestSetupTrait::$privateFilesDirectory	protected	property	The private file directory for the test environment.
TestSetupTrait::$publicFilesDirectory	protected	property	The public file directory for the test environment.
TestSetupTrait::$siteDirectory	protected	property	The site directory of this test run.
TestSetupTrait::$strictConfigSchema	protected	property	Set to TRUE to strict check all configuration saved.	1
TestSetupTrait::$tempFilesDirectory	protected	property	The temporary file directory for the test environment.
TestSetupTrait::$testId	protected	property	The test run ID.
TestSetupTrait::changeDatabasePrefix	protected	function	Changes the database connection to the prefixed one.
TestSetupTrait::getConfigSchemaExclusions	protected	function	Gets the config schema exclusions for this test.
TestSetupTrait::getDatabaseConnection	public static	function	Returns the database connection to the site running Simpletest.
TestSetupTrait::prepareDatabasePrefix	protected	function	Generates a database prefix for running tests.	1
UiHelperTrait::$loggedInUser	protected	property	The current user logged in using the Mink controlled browser.
UiHelperTrait::$maximumMetaRefreshCount	protected	property	The number of meta refresh redirects to follow, or NULL if unlimited.
UiHelperTrait::$metaRefreshCount	protected	property	The number of meta refresh redirects followed during ::drupalGet().
UiHelperTrait::assertSession	public	function	Returns WebAssert object.	1
UiHelperTrait::buildUrl	protected	function	Builds an absolute URL from a system path or a URL object.
UiHelperTrait::checkForMetaRefresh	protected	function	Checks for meta refresh tag and if found call drupalGet() recursively.
UiHelperTrait::click	protected	function	Clicks the element with the given CSS selector.
UiHelperTrait::clickLink	protected	function	Follows a link by complete name.
UiHelperTrait::cssSelect	protected	function	Searches elements using a CSS selector in the raw content.
UiHelperTrait::cssSelectToXpath	protected	function	Translates a CSS expression to its XPath equivalent.
UiHelperTrait::drupalGet	protected	function	Retrieves a Drupal path or an absolute path.	2
UiHelperTrait::drupalLogin	protected	function	Logs in a user using the Mink controlled browser.
UiHelperTrait::drupalLogout	protected	function	Logs a user out of the Mink controlled browser and confirms.
UiHelperTrait::drupalPostForm Deprecated	protected	function	Executes a form submission.
UiHelperTrait::drupalUserIsLoggedIn	protected	function	Returns whether a given user account is logged in.
UiHelperTrait::getAbsoluteUrl	protected	function	Takes a path and returns an absolute path.
UiHelperTrait::getTextContent	protected	function	Retrieves the plain-text content from the current page.
UiHelperTrait::getUrl	protected	function	Get the current URL from the browser.
UiHelperTrait::isTestUsingGuzzleClient	protected	function	Determines if test is using DrupalTestBrowser.
UiHelperTrait::prepareRequest	protected	function	Prepare for a request to testing site.	1
UiHelperTrait::submitForm	protected	function	Fills and submits a form.
UserCreationTrait::checkPermissions	protected	function	Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole	protected	function	Creates an administrative role.
UserCreationTrait::createRole	protected	function	Creates a role with specified permissions. Aliased as: drupalCreateRole
UserCreationTrait::createUser	protected	function	Create a user with a given set of permissions. Aliased as: drupalCreateUser
UserCreationTrait::grantPermissions	protected	function	Grant permissions to a user role.
UserCreationTrait::setCurrentUser	protected	function	Switch the current logged in user.
UserCreationTrait::setUpCurrentUser	protected	function	Creates a random user account and sets it as current user.
XdebugRequestTrait::extractCookiesFromRequest	protected	function	Adds xdebug cookies, from request setup.

You are here

class ConfigImportUITest in Drupal 9

Hierarchy

File

Namespace

Members

API Navigation