You are here

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

class ConfigImporterTest in Zircon Profile 8.0

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

Tests importing configuration from files into active configuration.

@group config

Hierarchy

Expanded class hierarchy of ConfigImporterTest

File

core/modules/config/src/Tests/ConfigImporterTest.php, line 22
Contains \Drupal\config\Tests\ConfigImporterTest.

Namespace

Drupal\config\Tests
View source 
class ConfigImporterTest extends KernelTestBase {

  /**
   * Config Importer object used for testing.
   *
   * @var \Drupal\Core\Config\ConfigImporter
   */
  protected $configImporter;

  /**
   * Modules to enable.
   *
   * @var array
   */
  public static $modules = array(
    'config_test',
    'system',
    'config_import_test',
  );
  protected function setUp() {
    parent::setUp();
    $this
      ->installConfig(array(
      'config_test',
    ));

    // Installing config_test's default configuration pollutes the global
    // variable being used for recording hook invocations by this test already,
    // so it has to be cleared out manually.
    unset($GLOBALS['hook_config_test']);
    $this
      ->copyConfig($this->container
      ->get('config.storage'), $this->container
      ->get('config.storage.sync'));

    // Set up the ConfigImporter object for testing.
    $storage_comparer = new StorageComparer($this->container
      ->get('config.storage.sync'), $this->container
      ->get('config.storage'), $this->container
      ->get('config.manager'));
    $this->configImporter = new ConfigImporter($storage_comparer
      ->createChangelist(), $this->container
      ->get('event_dispatcher'), $this->container
      ->get('config.manager'), $this->container
      ->get('lock'), $this->container
      ->get('config.typed'), $this->container
      ->get('module_handler'), $this->container
      ->get('module_installer'), $this->container
      ->get('theme_handler'), $this->container
      ->get('string_translation'));
  }

  /**
   * Tests omission of module APIs for bare configuration operations.
   */
  function testNoImport() {
    $dynamic_name = 'config_test.dynamic.dotted.default';

    // Verify the default configuration values exist.
    $config = $this
      ->config($dynamic_name);
    $this
      ->assertIdentical($config
      ->get('id'), 'dotted.default');

    // Verify that a bare $this->config() does not involve module APIs.
    $this
      ->assertFalse(isset($GLOBALS['hook_config_test']));
  }

  /**
   * Tests that trying to import from an empty sync configuration directory
   * fails.
   */
  function testEmptyImportFails() {
    try {
      $this->container
        ->get('config.storage.sync')
        ->deleteAll();
      $this->configImporter
        ->reset()
        ->import();
      $this
        ->fail('ConfigImporterException thrown, successfully stopping an empty import.');
    } catch (ConfigImporterException $e) {
      $this
        ->pass('ConfigImporterException thrown, successfully stopping an empty import.');
    }
  }

  /**
   * Tests verification of site UUID before importing configuration.
   */
  function testSiteUuidValidate() {
    $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);
    try {
      $this->configImporter
        ->reset()
        ->import();
      $this
        ->fail('ConfigImporterException not thrown, invalid import was not stopped due to mis-matching site UUID.');
    } catch (ConfigImporterException $e) {
      $this
        ->assertEqual($e
        ->getMessage(), 'There were errors validating the config synchronization.');
      $error_log = $this->configImporter
        ->getErrors();
      $expected = array(
        'Site UUID in source storage does not match the target storage.',
      );
      $this
        ->assertEqual($expected, $error_log);
    }
  }

  /**
   * Tests deletion of configuration during import.
   */
  function testDeleted() {
    $dynamic_name = 'config_test.dynamic.dotted.default';
    $storage = $this->container
      ->get('config.storage');
    $sync = $this->container
      ->get('config.storage.sync');

    // Verify the default configuration values exist.
    $config = $this
      ->config($dynamic_name);
    $this
      ->assertIdentical($config
      ->get('id'), 'dotted.default');

    // Delete the file from the sync directory.
    $sync
      ->delete($dynamic_name);

    // Import.
    $this->configImporter
      ->reset()
      ->import();

    // Verify the file has been removed.
    $this
      ->assertIdentical($storage
      ->read($dynamic_name), FALSE);
    $config = $this
      ->config($dynamic_name);
    $this
      ->assertIdentical($config
      ->get('id'), NULL);

    // Verify that appropriate module API hooks have been invoked.
    $this
      ->assertTrue(isset($GLOBALS['hook_config_test']['load']));
    $this
      ->assertFalse(isset($GLOBALS['hook_config_test']['presave']));
    $this
      ->assertFalse(isset($GLOBALS['hook_config_test']['insert']));
    $this
      ->assertFalse(isset($GLOBALS['hook_config_test']['update']));
    $this
      ->assertTrue(isset($GLOBALS['hook_config_test']['predelete']));
    $this
      ->assertTrue(isset($GLOBALS['hook_config_test']['delete']));
    $this
      ->assertFalse($this->configImporter
      ->hasUnprocessedConfigurationChanges());
    $logs = $this->configImporter
      ->getErrors();
    $this
      ->assertEqual(count($logs), 0);
  }

  /**
   * Tests creation of configuration during import.
   */
  function testNew() {
    $dynamic_name = 'config_test.dynamic.new';
    $storage = $this->container
      ->get('config.storage');
    $sync = $this->container
      ->get('config.storage.sync');

    // Verify the configuration to create does not exist yet.
    $this
      ->assertIdentical($storage
      ->exists($dynamic_name), FALSE, $dynamic_name . ' not 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.');

    // Import.
    $this->configImporter
      ->reset()
      ->import();

    // Verify the values appeared.
    $config = $this
      ->config($dynamic_name);
    $this
      ->assertIdentical($config
      ->get('label'), $original_dynamic_data['label']);

    // Verify that appropriate module API hooks have been invoked.
    $this
      ->assertFalse(isset($GLOBALS['hook_config_test']['load']));
    $this
      ->assertTrue(isset($GLOBALS['hook_config_test']['presave']));
    $this
      ->assertTrue(isset($GLOBALS['hook_config_test']['insert']));
    $this
      ->assertFalse(isset($GLOBALS['hook_config_test']['update']));
    $this
      ->assertFalse(isset($GLOBALS['hook_config_test']['predelete']));
    $this
      ->assertFalse(isset($GLOBALS['hook_config_test']['delete']));

    // Verify that hook_config_import_steps_alter() can add steps to
    // configuration synchronization.
    $this
      ->assertTrue(isset($GLOBALS['hook_config_test']['config_import_steps_alter']));

    // Verify that there is nothing more to import.
    $this
      ->assertFalse($this->configImporter
      ->hasUnprocessedConfigurationChanges());
    $logs = $this->configImporter
      ->getErrors();
    $this
      ->assertEqual(count($logs), 0);
  }

  /**
   * Tests that secondary writes are overwritten.
   */
  function testSecondaryWritePrimaryFirst() {
    $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(
      'id' => 'primary',
      'label' => 'Primary',
      'weight' => 0,
      'uuid' => $uuid
        ->generate(),
    );
    $sync
      ->write($name_primary, $values_primary);
    $values_secondary = array(
      'id' => 'secondary',
      'label' => 'Secondary Sync',
      'weight' => 0,
      'uuid' => $uuid
        ->generate(),
      // Add a dependency on primary, to ensure that is synced first.
      'dependencies' => array(
        'config' => array(
          $name_primary,
        ),
      ),
    );
    $sync
      ->write($name_secondary, $values_secondary);

    // Import.
    $this->configImporter
      ->reset()
      ->import();
    $entity_storage = \Drupal::entityManager()
      ->getStorage('config_test');
    $primary = $entity_storage
      ->load('primary');
    $this
      ->assertEqual($primary
      ->id(), 'primary');
    $this
      ->assertEqual($primary
      ->uuid(), $values_primary['uuid']);
    $this
      ->assertEqual($primary
      ->label(), $values_primary['label']);
    $secondary = $entity_storage
      ->load('secondary');
    $this
      ->assertEqual($secondary
      ->id(), 'secondary');
    $this
      ->assertEqual($secondary
      ->uuid(), $values_secondary['uuid']);
    $this
      ->assertEqual($secondary
      ->label(), $values_secondary['label']);
    $logs = $this->configImporter
      ->getErrors();
    $this
      ->assertEqual(count($logs), 1);
    $this
      ->assertEqual($logs[0], SafeMarkup::format('Deleted and replaced configuration entity "@name"', array(
      '@name' => $name_secondary,
    )));
  }

  /**
   * Tests that secondary writes are overwritten.
   */
  function testSecondaryWriteSecondaryFirst() {
    $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(
      'id' => 'primary',
      'label' => 'Primary',
      'weight' => 0,
      'uuid' => $uuid
        ->generate(),
      // Add a dependency on secondary, so that is synced first.
      'dependencies' => array(
        'config' => array(
          $name_secondary,
        ),
      ),
    );
    $sync
      ->write($name_primary, $values_primary);
    $values_secondary = array(
      'id' => 'secondary',
      'label' => 'Secondary Sync',
      'weight' => 0,
      'uuid' => $uuid
        ->generate(),
    );
    $sync
      ->write($name_secondary, $values_secondary);

    // Import.
    $this->configImporter
      ->reset()
      ->import();
    $entity_storage = \Drupal::entityManager()
      ->getStorage('config_test');
    $primary = $entity_storage
      ->load('primary');
    $this
      ->assertEqual($primary
      ->id(), 'primary');
    $this
      ->assertEqual($primary
      ->uuid(), $values_primary['uuid']);
    $this
      ->assertEqual($primary
      ->label(), $values_primary['label']);
    $secondary = $entity_storage
      ->load('secondary');
    $this
      ->assertEqual($secondary
      ->id(), 'secondary');
    $this
      ->assertEqual($secondary
      ->uuid(), $values_secondary['uuid']);
    $this
      ->assertEqual($secondary
      ->label(), $values_secondary['label']);
    $logs = $this->configImporter
      ->getErrors();
    $this
      ->assertEqual(count($logs), 1);
    $this
      ->assertEqual($logs[0], Html::escape("Unexpected error during import with operation create for {$name_primary}: 'config_test' entity with ID 'secondary' already exists."));
  }

  /**
   * Tests that secondary updates for deleted files work as expected.
   */
  function testSecondaryUpdateDeletedDeleterFirst() {
    $name_deleter = 'config_test.dynamic.deleter';
    $name_deletee = 'config_test.dynamic.deletee';
    $name_other = 'config_test.dynamic.other';
    $storage = $this->container
      ->get('config.storage');
    $sync = $this->container
      ->get('config.storage.sync');
    $uuid = $this->container
      ->get('uuid');
    $values_deleter = array(
      'id' => 'deleter',
      'label' => 'Deleter',
      'weight' => 0,
      'uuid' => $uuid
        ->generate(),
    );
    $storage
      ->write($name_deleter, $values_deleter);
    $values_deleter['label'] = 'Updated Deleter';
    $sync
      ->write($name_deleter, $values_deleter);
    $values_deletee = array(
      'id' => 'deletee',
      'label' => 'Deletee',
      'weight' => 0,
      'uuid' => $uuid
        ->generate(),
      // Add a dependency on deleter, to make sure that is synced first.
      'dependencies' => array(
        'config' => array(
          $name_deleter,
        ),
      ),
    );
    $storage
      ->write($name_deletee, $values_deletee);
    $values_deletee['label'] = 'Updated Deletee';
    $sync
      ->write($name_deletee, $values_deletee);

    // Ensure that import will continue after the error.
    $values_other = array(
      'id' => 'other',
      'label' => 'Other',
      'weight' => 0,
      'uuid' => $uuid
        ->generate(),
      // Add a dependency on deleter, to make sure that is synced first. This
      // will also be synced after the deletee due to alphabetical ordering.
      'dependencies' => array(
        'config' => array(
          $name_deleter,
        ),
      ),
    );
    $storage
      ->write($name_other, $values_other);
    $values_other['label'] = 'Updated other';
    $sync
      ->write($name_other, $values_other);

    // Check update changelist order.
    $updates = $this->configImporter
      ->reset()
      ->getStorageComparer()
      ->getChangelist('update');
    $expected = array(
      $name_deleter,
      $name_deletee,
      $name_other,
    );
    $this
      ->assertIdentical($expected, $updates);

    // Import.
    $this->configImporter
      ->import();
    $entity_storage = \Drupal::entityManager()
      ->getStorage('config_test');
    $deleter = $entity_storage
      ->load('deleter');
    $this
      ->assertEqual($deleter
      ->id(), 'deleter');
    $this
      ->assertEqual($deleter
      ->uuid(), $values_deleter['uuid']);
    $this
      ->assertEqual($deleter
      ->label(), $values_deleter['label']);

    // The deletee was deleted in
    // \Drupal\config_test\Entity\ConfigTest::postSave().
    $this
      ->assertFalse($entity_storage
      ->load('deletee'));
    $other = $entity_storage
      ->load('other');
    $this
      ->assertEqual($other
      ->id(), 'other');
    $this
      ->assertEqual($other
      ->uuid(), $values_other['uuid']);
    $this
      ->assertEqual($other
      ->label(), $values_other['label']);
    $logs = $this->configImporter
      ->getErrors();
    $this
      ->assertEqual(count($logs), 1);
    $this
      ->assertEqual($logs[0], SafeMarkup::format('Update target "@name" is missing.', array(
      '@name' => $name_deletee,
    )));
  }

  /**
   * Tests that secondary updates for deleted files work as expected.
   *
   * This test is completely hypothetical since we only support full
   * configuration tree imports. Therefore, any configuration updates that cause
   * secondary deletes should be reflected already in the staged configuration.
   */
  function testSecondaryUpdateDeletedDeleteeFirst() {
    $name_deleter = 'config_test.dynamic.deleter';
    $name_deletee = 'config_test.dynamic.deletee';
    $storage = $this->container
      ->get('config.storage');
    $sync = $this->container
      ->get('config.storage.sync');
    $uuid = $this->container
      ->get('uuid');
    $values_deleter = array(
      'id' => 'deleter',
      'label' => 'Deleter',
      'weight' => 0,
      'uuid' => $uuid
        ->generate(),
      // Add a dependency on deletee, to make sure that is synced first.
      'dependencies' => array(
        'config' => array(
          $name_deletee,
        ),
      ),
    );
    $storage
      ->write($name_deleter, $values_deleter);
    $values_deleter['label'] = 'Updated Deleter';
    $sync
      ->write($name_deleter, $values_deleter);
    $values_deletee = array(
      'id' => 'deletee',
      'label' => 'Deletee',
      'weight' => 0,
      'uuid' => $uuid
        ->generate(),
    );
    $storage
      ->write($name_deletee, $values_deletee);
    $values_deletee['label'] = 'Updated Deletee';
    $sync
      ->write($name_deletee, $values_deletee);

    // Import.
    $this->configImporter
      ->reset()
      ->import();
    $entity_storage = \Drupal::entityManager()
      ->getStorage('config_test');

    // Both entities are deleted. ConfigTest::postSave() causes updates of the
    // deleter entity to delete the deletee entity. Since the deleter depends on
    // the deletee, removing the deletee causes the deleter to be removed.
    $this
      ->assertFalse($entity_storage
      ->load('deleter'));
    $this
      ->assertFalse($entity_storage
      ->load('deletee'));
    $logs = $this->configImporter
      ->getErrors();
    $this
      ->assertEqual(count($logs), 0);
  }

  /**
   * Tests that secondary deletes for deleted files work as expected.
   */
  function testSecondaryDeletedDeleteeSecond() {
    $name_deleter = 'config_test.dynamic.deleter';
    $name_deletee = 'config_test.dynamic.deletee';
    $storage = $this->container
      ->get('config.storage');
    $uuid = $this->container
      ->get('uuid');
    $values_deleter = array(
      'id' => 'deleter',
      'label' => 'Deleter',
      'weight' => 0,
      'uuid' => $uuid
        ->generate(),
      // Add a dependency on deletee, to make sure this delete is synced first.
      'dependencies' => array(
        'config' => array(
          $name_deletee,
        ),
      ),
    );
    $storage
      ->write($name_deleter, $values_deleter);
    $values_deletee = array(
      'id' => 'deletee',
      'label' => 'Deletee',
      'weight' => 0,
      'uuid' => $uuid
        ->generate(),
    );
    $storage
      ->write($name_deletee, $values_deletee);

    // Import.
    $this->configImporter
      ->reset()
      ->import();
    $entity_storage = \Drupal::entityManager()
      ->getStorage('config_test');
    $this
      ->assertFalse($entity_storage
      ->load('deleter'));
    $this
      ->assertFalse($entity_storage
      ->load('deletee'));

    // The deletee entity does not exist as the delete worked and although the
    // delete occurred in \Drupal\config_test\Entity\ConfigTest::postDelete()
    // this does not matter.
    $logs = $this->configImporter
      ->getErrors();
    $this
      ->assertEqual(count($logs), 0);
  }

  /**
   * Tests updating of configuration during import.
   */
  function testUpdated() {
    $name = 'config_test.system';
    $dynamic_name = 'config_test.dynamic.dotted.default';
    $storage = $this->container
      ->get('config.storage');
    $sync = $this->container
      ->get('config.storage.sync');

    // Verify that the configuration objects to import exist.
    $this
      ->assertIdentical($storage
      ->exists($name), TRUE, $name . ' found.');
    $this
      ->assertIdentical($storage
      ->exists($dynamic_name), TRUE, $dynamic_name . ' found.');

    // Replace the file content of the existing configuration objects in the
    // sync directory.
    $original_name_data = array(
      'foo' => 'beer',
    );
    $sync
      ->write($name, $original_name_data);
    $original_dynamic_data = $storage
      ->read($dynamic_name);
    $original_dynamic_data['label'] = 'Updated';
    $sync
      ->write($dynamic_name, $original_dynamic_data);

    // Verify the active configuration still returns the default values.
    $config = $this
      ->config($name);
    $this
      ->assertIdentical($config
      ->get('foo'), 'bar');
    $config = $this
      ->config($dynamic_name);
    $this
      ->assertIdentical($config
      ->get('label'), 'Default');

    // Import.
    $this->configImporter
      ->reset()
      ->import();

    // Verify the values were updated.
    \Drupal::configFactory()
      ->reset($name);
    $config = $this
      ->config($name);
    $this
      ->assertIdentical($config
      ->get('foo'), 'beer');
    $config = $this
      ->config($dynamic_name);
    $this
      ->assertIdentical($config
      ->get('label'), 'Updated');

    // Verify that the original file content is still the same.
    $this
      ->assertIdentical($sync
      ->read($name), $original_name_data);
    $this
      ->assertIdentical($sync
      ->read($dynamic_name), $original_dynamic_data);

    // Verify that appropriate module API hooks have been invoked.
    $this
      ->assertTrue(isset($GLOBALS['hook_config_test']['load']));
    $this
      ->assertTrue(isset($GLOBALS['hook_config_test']['presave']));
    $this
      ->assertFalse(isset($GLOBALS['hook_config_test']['insert']));
    $this
      ->assertTrue(isset($GLOBALS['hook_config_test']['update']));
    $this
      ->assertFalse(isset($GLOBALS['hook_config_test']['predelete']));
    $this
      ->assertFalse(isset($GLOBALS['hook_config_test']['delete']));

    // Verify that there is nothing more to import.
    $this
      ->assertFalse($this->configImporter
      ->hasUnprocessedConfigurationChanges());
    $logs = $this->configImporter
      ->getErrors();
    $this
      ->assertEqual(count($logs), 0);
  }

  /**
   * Tests the isInstallable method()
   */
  function testIsInstallable() {
    $config_name = 'config_test.dynamic.isinstallable';
    $this
      ->assertFalse($this->container
      ->get('config.storage')
      ->exists($config_name));
    \Drupal::state()
      ->set('config_test.isinstallable', TRUE);
    $this
      ->installConfig(array(
      'config_test',
    ));
    $this
      ->assertTrue($this->container
      ->get('config.storage')
      ->exists($config_name));
  }

  /**
   * Tests dependency validation during configuration import.
   *
   * @see \Drupal\Core\EventSubscriber\ConfigImportSubscriber
   * @see \Drupal\Core\Config\ConfigImporter::createExtensionChangelist()
   */
  public function testUnmetDependency() {
    $storage = $this->container
      ->get('config.storage');
    $sync = $this->container
      ->get('config.storage.sync');

    // Test an unknown configuration owner.
    $sync
      ->write('unknown.config', [
      'test' => 'test',
    ]);

    // Make a config entity have unmet dependencies.
    $config_entity_data = $sync
      ->read('config_test.dynamic.dotted.default');
    $config_entity_data['dependencies'] = [
      'module' => [
        'unknown',
      ],
    ];
    $sync
      ->write('config_test.dynamic.dotted.module', $config_entity_data);
    $config_entity_data['dependencies'] = [
      'theme' => [
        'unknown',
      ],
    ];
    $sync
      ->write('config_test.dynamic.dotted.theme', $config_entity_data);
    $config_entity_data['dependencies'] = [
      'config' => [
        'unknown',
      ],
    ];
    $sync
      ->write('config_test.dynamic.dotted.config', $config_entity_data);

    // Make an active config depend on something that is missing in sync.
    // The whole configuration needs to be consistent, not only the updated one.
    $config_entity_data['dependencies'] = [];
    $storage
      ->write('config_test.dynamic.dotted.deleted', $config_entity_data);
    $config_entity_data['dependencies'] = [
      'config' => [
        'config_test.dynamic.dotted.deleted',
      ],
    ];
    $storage
      ->write('config_test.dynamic.dotted.existing', $config_entity_data);
    $sync
      ->write('config_test.dynamic.dotted.existing', $config_entity_data);
    $extensions = $sync
      ->read('core.extension');

    // Add a module and a theme that do not exist.
    $extensions['module']['unknown_module'] = 0;
    $extensions['theme']['unknown_theme'] = 0;

    // Add a module and a theme that depend on uninstalled extensions.
    $extensions['module']['book'] = 0;
    $extensions['theme']['bartik'] = 0;
    $sync
      ->write('core.extension', $extensions);
    try {
      $this->configImporter
        ->reset()
        ->import();
      $this
        ->fail('ConfigImporterException not thrown; an invalid import was not stopped due to missing dependencies.');
    } catch (ConfigImporterException $e) {
      $this
        ->assertEqual($e
        ->getMessage(), 'There were errors validating the config synchronization.');
      $error_log = $this->configImporter
        ->getErrors();
      $expected = [
        'Unable to install the <em class="placeholder">unknown_module</em> module since it does not exist.',
        'Unable to install the <em class="placeholder">Book</em> module since it requires the <em class="placeholder">Node, Text, Field, Filter, User</em> modules.',
        'Unable to install the <em class="placeholder">unknown_theme</em> theme since it does not exist.',
        'Unable to install the <em class="placeholder">Bartik</em> theme since it requires the <em class="placeholder">Classy</em> theme.',
        'Configuration <em class="placeholder">config_test.dynamic.dotted.config</em> depends on the <em class="placeholder">unknown</em> configuration that will not exist after import.',
        'Configuration <em class="placeholder">config_test.dynamic.dotted.existing</em> depends on the <em class="placeholder">config_test.dynamic.dotted.deleted</em> configuration that will not exist after import.',
        'Configuration <em class="placeholder">config_test.dynamic.dotted.module</em> depends on the <em class="placeholder">unknown</em> module that will not be installed after import.',
        'Configuration <em class="placeholder">config_test.dynamic.dotted.theme</em> depends on the <em class="placeholder">unknown</em> theme that will not be installed after import.',
        'Configuration <em class="placeholder">unknown.config</em> depends on the <em class="placeholder">unknown</em> extension that will not be installed after import.',
      ];
      foreach ($expected as $expected_message) {
        $this
          ->assertTrue(in_array($expected_message, $error_log), $expected_message);
      }
    }

    // Make a config entity have mulitple unmet dependencies.
    $config_entity_data = $sync
      ->read('config_test.dynamic.dotted.default');
    $config_entity_data['dependencies'] = [
      'module' => [
        'unknown',
        'dblog',
      ],
    ];
    $sync
      ->write('config_test.dynamic.dotted.module', $config_entity_data);
    $config_entity_data['dependencies'] = [
      'theme' => [
        'unknown',
        'seven',
      ],
    ];
    $sync
      ->write('config_test.dynamic.dotted.theme', $config_entity_data);
    $config_entity_data['dependencies'] = [
      'config' => [
        'unknown',
        'unknown2',
      ],
    ];
    $sync
      ->write('config_test.dynamic.dotted.config', $config_entity_data);
    try {
      $this->configImporter
        ->reset()
        ->import();
      $this
        ->fail('ConfigImporterException not thrown, invalid import was not stopped due to missing dependencies.');
    } catch (ConfigImporterException $e) {
      $this
        ->assertEqual($e
        ->getMessage(), 'There were errors validating the config synchronization.');
      $error_log = $this->configImporter
        ->getErrors();
      $expected = [
        'Configuration <em class="placeholder">config_test.dynamic.dotted.config</em> depends on configuration (<em class="placeholder">unknown, unknown2</em>) that will not exist after import.',
        'Configuration <em class="placeholder">config_test.dynamic.dotted.module</em> depends on modules (<em class="placeholder">unknown, Database Logging</em>) that will not be installed after import.',
        'Configuration <em class="placeholder">config_test.dynamic.dotted.theme</em> depends on themes (<em class="placeholder">unknown, Seven</em>) that will not be installed after import.',
      ];
      foreach ($expected as $expected_message) {
        $this
          ->assertTrue(in_array($expected_message, $error_log), $expected_message);
      }
    }
  }

  /**
   * Tests missing core.extension during configuration import.
   *
   * @see \Drupal\Core\EventSubscriber\ConfigImportSubscriber
   */
  public function testMissingCoreExtension() {
    $sync = $this->container
      ->get('config.storage.sync');
    $sync
      ->delete('core.extension');
    try {
      $this->configImporter
        ->reset()
        ->import();
      $this
        ->fail('ConfigImporterException not thrown, invalid import was not stopped due to missing dependencies.');
    } catch (ConfigImporterException $e) {
      $this
        ->assertEqual($e
        ->getMessage(), 'There were errors validating the config synchronization.');
      $error_log = $this->configImporter
        ->getErrors();
      $this
        ->assertEqual([
        'The core.extension configuration does not exist.',
      ], $error_log);
    }
  }

  /**
   * Tests install profile validation during configuration import.
   *
   * @see \Drupal\Core\EventSubscriber\ConfigImportSubscriber
   */
  public function testInstallProfile() {
    $sync = $this->container
      ->get('config.storage.sync');
    $extensions = $sync
      ->read('core.extension');

    // Add an install profile.
    $extensions['module']['standard'] = 0;
    $sync
      ->write('core.extension', $extensions);
    try {
      $this->configImporter
        ->reset()
        ->import();
      $this
        ->fail('ConfigImporterException not thrown; an invalid import was not stopped due to missing dependencies.');
    } catch (ConfigImporterException $e) {
      $this
        ->assertEqual($e
        ->getMessage(), 'There were errors validating the config synchronization.');
      $error_log = $this->configImporter
        ->getErrors();

      // Install profiles should not even be scanned at this point.
      $this
        ->assertEqual([
        'Unable to install the <em class="placeholder">standard</em> module since it does not exist.',
      ], $error_log);
    }
  }

  /**
   * Tests config_get_config_directory().
   */
  public function testConfigGetConfigDirectory() {
    $directory = config_get_config_directory(CONFIG_SYNC_DIRECTORY);
    $this
      ->assertEqual($this->configDirectories[CONFIG_SYNC_DIRECTORY], $directory);
    $message = 'Calling config_get_config_directory() with CONFIG_ACTIVE_DIRECTORY results in an exception.';
    try {
      config_get_config_directory(CONFIG_ACTIVE_DIRECTORY);
      $this
        ->fail($message);
    } catch (\Exception $e) {
      $this
        ->pass($message);
    }
  }

}

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.
ConfigImporterTest::$configImporter protected property Config Importer object used for testing. Overrides TestBase::$configImporter
ConfigImporterTest::$modules public static property Modules to enable. Overrides KernelTestBase::$modules
ConfigImporterTest::setUp protected function Performs setup tasks before each individual test method is run. Overrides KernelTestBase::setUp
ConfigImporterTest::testConfigGetConfigDirectory public function Tests config_get_config_directory().
ConfigImporterTest::testDeleted function Tests deletion of configuration during import.
ConfigImporterTest::testEmptyImportFails function Tests that trying to import from an empty sync configuration directory fails.
ConfigImporterTest::testInstallProfile public function Tests install profile validation during configuration import.
ConfigImporterTest::testIsInstallable function Tests the isInstallable method()
ConfigImporterTest::testMissingCoreExtension public function Tests missing core.extension during configuration import.
ConfigImporterTest::testNew function Tests creation of configuration during import.
ConfigImporterTest::testNoImport function Tests omission of module APIs for bare configuration operations.
ConfigImporterTest::testSecondaryDeletedDeleteeSecond function Tests that secondary deletes for deleted files work as expected.
ConfigImporterTest::testSecondaryUpdateDeletedDeleteeFirst function Tests that secondary updates for deleted files work as expected.
ConfigImporterTest::testSecondaryUpdateDeletedDeleterFirst function Tests that secondary updates for deleted files work as expected.
ConfigImporterTest::testSecondaryWritePrimaryFirst function Tests that secondary writes are overwritten.
ConfigImporterTest::testSecondaryWriteSecondaryFirst function Tests that secondary writes are overwritten.
ConfigImporterTest::testSiteUuidValidate function Tests verification of site UUID before importing configuration.
ConfigImporterTest::testUnmetDependency public function Tests dependency validation during configuration import.
ConfigImporterTest::testUpdated function Tests updating of configuration during import.
KernelTestBase::$configDirectories protected property The configuration directories for this test run.
KernelTestBase::$keyValueFactory protected property A KeyValueMemoryFactory instance to use when building the container.
KernelTestBase::$moduleFiles private property
KernelTestBase::$streamWrappers protected property Array of registered stream wrappers.
KernelTestBase::$themeFiles private property
KernelTestBase::beforePrepareEnvironment protected function Act on global state information before the environment is altered for a test. Overrides TestBase::beforePrepareEnvironment
KernelTestBase::containerBuild public function Sets up the base service container for this test. 12
KernelTestBase::defaultLanguageData protected function Provides the data for setting the default language on the container. 1
KernelTestBase::disableModules protected function Disables modules for this test.
KernelTestBase::enableModules protected function Enables modules for this test.
KernelTestBase::installConfig protected function Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema protected function Installs the storage schema for a specific entity type.
KernelTestBase::installSchema protected function Installs a specific table from a module schema definition.
KernelTestBase::prepareConfigDirectories protected function Create and set new configuration directories. 1
KernelTestBase::registerStreamWrapper protected function Registers a stream wrapper for this test.
KernelTestBase::render protected function Renders a render array.
KernelTestBase::tearDown protected function Performs cleanup tasks after each individual test method has been run. Overrides TestBase::tearDown
KernelTestBase::__construct function Constructor for Test. Overrides TestBase::__construct
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::$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::$kernel protected property The DrupalKernel instance used in the test. 1
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::$originalShutdownCallbacks protected property The original array of shutdown function callbacks. 1
TestBase::$originalSite protected property The site directory of the original parent site.
TestBase::$originalUser protected property The original user, before testing began. 1
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::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.