You are here

Home » API reference » Configuration Synchronizer 8.2 » UpdateModeTest.php

class UpdateModeTest in Configuration Synchronizer 8.2

Tests importing configuration entities using various import modes.

@group config_sync

Hierarchy

Expanded class hierarchy of UpdateModeTest

File

tests/src/Kernel/UpdateModeTest.php, line 21

Namespace

Drupal\Tests\config_sync\Kernel
View source 
class UpdateModeTest extends KernelTestBase {
  use ConfigSnapshotStorageTrait;
  protected $preserveGlobalState = TRUE;

  /**
   * Storage for the test module's snapshot.
   *
   * @var \Drupal\Core\Config\StorageInterface
   */
  protected $testSnapshotStorage;

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

  /**
   * Names of test module node types.
   *
   * @var array
   */
  protected $nodeTypeNames = [
    1 => 'config_sync_test_1',
    2 => 'config_sync_test_2',
    3 => 'config_sync_test_3',
    4 => 'config_sync_test_4',
  ];

  /**
   * Names of test module config items.
   *
   * @var array
   */
  protected $configNames = [];

  /**
   * Modules to enable.
   *
   * @var array
   */
  public static $modules = [
    'system',
    'field',
    'filter',
    'text',
    'user',
    'node',
    'config_distro',
    'config_filter',
    'config_merge',
    'config_normalizer',
    'config_provider',
    'config_snapshot',
    'config_update',
    'config_sync',
    'config_sync_test',
  ];
  protected function setUp() {
    parent::setUp();
    $this
      ->installEntitySchema('node');
    $this
      ->installEntitySchema('config_snapshot');
    $this
      ->installConfig([
      'system',
      'user',
      'field',
      'filter',
      'text',
      'node',
      'config_sync_test',
    ]);

    // Refresh the extension snapshot, since this won't have been done on
    // module install.
    $this->container
      ->get('config_sync.snapshotter')
      ->refreshExtensionSnapshot('module', [
      'config_sync_test',
    ], ConfigSyncSnapshotterInterface::SNAPSHOT_MODE_INSTALL);

    // Load and customize the node type provided by config_sync_test_1 module.
    $content_type_1 = NodeType::load($this->nodeTypeNames[1]);
    $content_type_1
      ->set('name', 'Custom name')
      ->set('description', 'Prior description')
      ->set('help', 'Custom help')
      ->save();

    // Load the configuration snapshot for the test module.
    $test_module_snapshot = ConfigSnapshot::load(ConfigSyncSnapshotterInterface::CONFIG_SNAPSHOT_SET . '.module.config_sync_test');

    // Load and customize the node type snapshot, simulating a prior install
    // state.
    $this->configNames[1] = $content_type_1
      ->getEntityType()
      ->getConfigPrefix() . '.' . $content_type_1
      ->id();
    $content_type_1_snapshot = $test_module_snapshot
      ->getItem(StorageInterface::DEFAULT_COLLECTION, $this->configNames[1]);
    $content_type_1_snapshot['name'] = 'Prior name';
    $content_type_1_snapshot['description'] = 'Prior description';
    $test_module_snapshot
      ->setItem(StorageInterface::DEFAULT_COLLECTION, $this->configNames[1], $content_type_1_snapshot)
      ->save();

    // Remove the second node type from both the snapshot and the active
    // configuration. This simulates an item that is newly provided.
    $content_type_2 = NodeType::load($this->nodeTypeNames[2]);
    $this->configNames[2] = $content_type_2
      ->getEntityType()
      ->getConfigPrefix() . '.' . $content_type_2
      ->id();
    $test_module_snapshot
      ->clearItem(StorageInterface::DEFAULT_COLLECTION, $this->configNames[2])
      ->save();
    $content_type_2
      ->delete();

    // Delete the third node type. This covers an item installed and
    // later deleted.
    $content_type_3 = NodeType::load($this->nodeTypeNames[3]);
    $this->configNames[3] = $content_type_3
      ->getEntityType()
      ->getConfigPrefix() . '.' . $content_type_3
      ->id();
    $content_type_3
      ->delete($this->nodeTypeNames[3]);

    // Modify the fourth node. This covers an item that has been customized and
    // for which no update is available.
    $content_type_4 = NodeType::load($this->nodeTypeNames[4]);
    $this->configNames[4] = $content_type_4
      ->getEntityType()
      ->getConfigPrefix() . '.' . $content_type_4
      ->id();
    $content_type_4
      ->set('name', 'Custom name')
      ->save();
    $this->testSnapshotStorage = $this
      ->getConfigSnapshotStorage(ConfigSyncSnapshotterInterface::CONFIG_SNAPSHOT_SET, 'module', 'config_sync_test');

    // We deleted the snapshot for config_sync_test_2.
    $expected_snapshot_items = $this->configNames;
    unset($expected_snapshot_items[2]);
    $expected_snapshot_items = array_values($expected_snapshot_items);
    $snapshot_items = $this->testSnapshotStorage
      ->listAll();
    $this
      ->assertSame($snapshot_items, $expected_snapshot_items, 'Snapshot items match those expected.');
  }
  protected function setUpdateMode($update_mode) {
    $this->container
      ->get('state')
      ->set('config_sync.update_mode', $update_mode);

    // Rebuild the container to update the config distro storage.
    $this->container
      ->get('kernel')
      ->rebuildContainer();

    // Set up the ConfigImporter object for testing.
    $storage_comparer = new StorageComparer($this->container
      ->get('config_distro.storage.distro'), $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'));
  }
  public function testUpdateModeMerge() {

    // Set update mode to merge.
    $this
      ->setUpdateMode(ConfigSyncListerInterface::UPDATE_MODE_MERGE);
    $creates = $this->configImporter
      ->getUnprocessedConfiguration('create');
    $updates = $this->configImporter
      ->getUnprocessedConfiguration('update');
    $this
      ->assertEquals(0, count($this->configImporter
      ->getUnprocessedConfiguration('delete')), 'There are no configuration items to delete.');

    // node.type.config_sync_test_2 was deleted from both the snapshot and
    // the active configuration and so should be created.
    // node.type.config_sync_test_3 was deleted from active but should not be
    // restored since it is snapshotted.
    $expected_creates = [
      $this->configNames[2],
    ];
    $this
      ->assertSame($creates, $expected_creates, 'Create operations match those expected.');

    // For node.type.config_sync_test_1, the snapshot differs from the current
    // provided value and not all of the differences are customized in the
    // active configuration.
    $expected_updates = [
      $this->configNames[1],
    ];
    $this
      ->assertSame($updates, $expected_updates, 'Update operations match those expected.');
    $this->configImporter
      ->import();
    $this->container
      ->get('event_dispatcher')
      ->dispatch(ConfigDistroEvents::IMPORT);

    // Verify that the expected config changes were made.
    $node_type_1 = NodeType::load($this->nodeTypeNames[1]);
    $this
      ->assertEquals('Custom name', $node_type_1
      ->label());
    $this
      ->assertEquals('Provided description', $node_type_1
      ->get('description'));
    $this
      ->assertEquals('Custom help', $node_type_1
      ->get('help'));
    $this
      ->verifySnapshot();
  }
  public function testUpdateModePartialReset() {

    // Set update mode to partial reset.
    $this
      ->setUpdateMode(ConfigSyncListerInterface::UPDATE_MODE_PARTIAL_RESET);
    $creates = $this->configImporter
      ->getUnprocessedConfiguration('create');
    $updates = $this->configImporter
      ->getUnprocessedConfiguration('update');
    $this
      ->assertEquals(0, count($this->configImporter
      ->getUnprocessedConfiguration('delete')), 'There are no configuration items to delete.');

    // node.type.config_sync_test_2 was deleted from both the snapshot and
    // the active configuration and so should be created.
    // node.type.config_sync_test_3 was deleted from active but should not be
    // restored since it is snapshotted.
    $expected_creates = [
      $this->configNames[2],
    ];
    $this
      ->assertSame($creates, $expected_creates, 'Create operations match those expected.');

    // For node.type.config_sync_test_1, the snapshot differs from the current
    // provided value.
    $expected_updates = [
      $this->configNames[1],
    ];
    $this
      ->assertSame($updates, $expected_updates, 'Update operations match those expected.');
    $this->configImporter
      ->import();
    $this->container
      ->get('event_dispatcher')
      ->dispatch(ConfigDistroEvents::IMPORT);

    // Verify that the expected config changes were made.
    $node_type_1 = NodeType::load($this->nodeTypeNames[1]);
    $this
      ->assertEquals('Provided name', $node_type_1
      ->label());
    $this
      ->assertEquals('Provided description', $node_type_1
      ->get('description'));
    $this
      ->assertEquals('Provided help', $node_type_1
      ->get('help'));
    $this
      ->verifySnapshot();
  }
  public function testUpdateModeFullReset() {

    // Set update mode to partial reset.
    $this
      ->setUpdateMode(ConfigSyncListerInterface::UPDATE_MODE_FULL_RESET);
    $creates = $this->configImporter
      ->getUnprocessedConfiguration('create');
    $updates = $this->configImporter
      ->getUnprocessedConfiguration('update');
    $this
      ->assertEquals(0, count($this->configImporter
      ->getUnprocessedConfiguration('delete')), 'There are no configuration items to delete.');

    // node.type.config_sync_test_2 was deleted from both the snapshot and
    // the active configuration and so should be created.
    // node.type.config_sync_test_3 was deleted from active and should be
    // restored even though it is snapshotted.
    $expected_creates = [
      $this->configNames[2],
      $this->configNames[3],
    ];
    $this
      ->assertSame($creates, $expected_creates, 'Create operations match those expected.');

    // For node.type.config_sync_test_1, the snapshot differs from the current
    // provided value and from the active value.
    // For node.type.config_sync_test_4, the snapshot differs from the active
    // value.
    $expected_updates = [
      $this->configNames[1],
      $this->configNames[4],
    ];
    $this
      ->assertSame($updates, $expected_updates, 'Update operations match those expected.');
    $this->configImporter
      ->import();
    $this->container
      ->get('event_dispatcher')
      ->dispatch(ConfigDistroEvents::IMPORT);

    // Verify that all provided items are at their provided state.
    foreach (array_keys($this->configNames) as $index) {
      $node_type = NodeType::load($this->nodeTypeNames[$index]);
      $this
        ->assertEquals('Provided name', $node_type
        ->label());
      $this
        ->assertEquals('Provided description', $node_type
        ->get('description'));
      $this
        ->assertEquals('Provided help', $node_type
        ->get('help'));
    }
    $this
      ->verifySnapshot();
  }
  protected function verifySnapshot() {

    // Verify that all provided items are now snapshotted.
    $expected_snapshot_items = array_values($this->configNames);
    $test_snapshot_storage = $this
      ->getConfigSnapshotStorage(ConfigSyncSnapshotterInterface::CONFIG_SNAPSHOT_SET, 'module', 'config_sync_test');
    $snapshot_items = $test_snapshot_storage
      ->listAll();
    $this
      ->assertSame($snapshot_items, $expected_snapshot_items, 'Snapshot items match those expected.');

    // Verify that the snapshot is now fully updated.
    $extension_storage = $this->container
      ->get('config_update.extension_storage');
    foreach (array_keys($this->configNames) as $index) {
      $this
        ->assertEquals($extension_storage
        ->read($this->configNames[$index]), $test_snapshot_storage
        ->read($this->configNames[$index]));
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AssertContentTrait::$content protected property The current raw content.
AssertContentTrait::$drupalSettings protected property The drupalSettings value from the current raw $content.
AssertContentTrait::$elements protected property The XML structure parsed from the current raw $content. 1
AssertContentTrait::$plainTextContent protected property The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink protected function Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds protected function Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped protected function Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertNoField protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected protected function Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern protected function Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw protected function Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle protected function Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText protected function Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern protected function Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput protected function Asserts themed output.
AssertContentTrait::assertTitle protected function Pass if the page title is the given string.
AssertContentTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper protected function Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery protected function Builds an XPath query.
AssertContentTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings protected function Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent protected function Gets the current raw content.
AssertContentTrait::getSelectedItem protected function Get the selected value from a select field.
AssertContentTrait::getTextContent protected function Retrieves the plain-text content from the current raw content.
AssertContentTrait::getUrl protected function Get the current URL from the cURL handler. 1
AssertContentTrait::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace protected function Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings protected function Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent protected function Sets the raw content (e.g. HTML).
AssertContentTrait::xpath protected function Performs an xpath search on the contents of the internal browser.
AssertHelperTrait::castSafeStrings protected static function Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::assertEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertSame() instead.
AssertLegacyTrait::assertIdenticalObject protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertEquals() instead.
AssertLegacyTrait::assertNotEqual protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotEquals() instead.
AssertLegacyTrait::assertNotIdentical protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertNotSame() instead.
AssertLegacyTrait::pass protected function Deprecated Scheduled for removal in Drupal 10.0.0. Use self::assertTrue() instead.
AssertLegacyTrait::verbose protected function
ConfigSnapshotStorageTrait::getConfigSnapshotStorage protected function Returns a configuration snapshot storage service.
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.
KernelTestBase::$backupGlobals protected property Back up and restore any global variables that may be changed by tests.
KernelTestBase::$backupStaticAttributes protected property Back up and restore static class properties that may be changed by tests.
KernelTestBase::$backupStaticAttributesBlacklist protected property Contains a few static class properties for performance.
KernelTestBase::$classLoader protected property
KernelTestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$root protected property The app root.
KernelTestBase::$runTestInSeparateProcess protected property Kernel tests are run in separate processes because they allow autoloading of code from extensions. Running the test in a separate process isolates this behavior from other tests. Subclasses should not override this property.
KernelTestBase::$siteDirectory protected property
KernelTestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 6
KernelTestBase::$vfsRoot protected property The virtual filesystem root directory.
KernelTestBase::assertPostConditions protected function 1
KernelTestBase::bootEnvironment protected function Bootstraps a basic test environment.
KernelTestBase::bootKernel private function Bootstraps a kernel for a test.
KernelTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::disableModules protected function Disables modules for this test.
KernelTestBase::enableModules protected function Enables modules for this test.
KernelTestBase::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo protected function Returns the Database connection info to be used for this test. 1
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to enable.
KernelTestBase::getModulesToEnable private static function Returns the modules to enable for this test.
KernelTestBase::initFileCache protected function Initializes the FileCache component.
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 database tables from a module schema definition.
KernelTestBase::isTestInIsolation Deprecated protected function Returns whether the current test method is running in a separate process.
KernelTestBase::prepareTemplate protected function
KernelTestBase::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 26
KernelTestBase::render protected function Renders a render array. 1
KernelTestBase::setInstallProfile protected function Sets the install profile and rebuilds the container to update it.
KernelTestBase::setSetting protected function Sets an in-memory Settings variable.
KernelTestBase::setUpBeforeClass public static function 1
KernelTestBase::setUpFilesystem protected function Sets up the filesystem, so things like the file directory. 2
KernelTestBase::stop protected function Stops test execution.
KernelTestBase::tearDown protected function 6
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__get Deprecated public function BC: Automatically resolve former KernelTestBase class properties.
KernelTestBase::__sleep public function Prevents serializing any properties.
PhpunitCompatibilityTrait::getMock Deprecated public function Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated public function Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
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.
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.
UpdateModeTest::$configImporter protected property Config Importer object used for testing. Overrides KernelTestBase::$configImporter
UpdateModeTest::$configNames protected property Names of test module config items.
UpdateModeTest::$modules public static property Modules to enable. Overrides KernelTestBase::$modules
UpdateModeTest::$nodeTypeNames protected property Names of test module node types.
UpdateModeTest::$preserveGlobalState protected property Do not forward any global state from the parent process to the processes that run the actual tests. Overrides KernelTestBase::$preserveGlobalState
UpdateModeTest::$testSnapshotStorage protected property Storage for the test module's snapshot.
UpdateModeTest::setUp protected function Overrides KernelTestBase::setUp
UpdateModeTest::setUpdateMode protected function
UpdateModeTest::testUpdateModeFullReset public function
UpdateModeTest::testUpdateModeMerge public function
UpdateModeTest::testUpdateModePartialReset public function
UpdateModeTest::verifySnapshot protected function