function ConfigExportImportUITest::testExportImportCollections

Tests an export and import of collections.

File

core/modules/config/tests/src/Functional/ConfigExportImportUITest.php, line 225

Class

ConfigExportImportUITest

Tests the user interface for importing/exporting configuration.

Namespace

Code

public function testExportImportCollections() : void {
  /** @var \Drupal\Core\Config\StorageInterface $active_storage */
  $active_storage = \Drupal::service('config.storage');
  $test1_storage = $active_storage->createCollection('collection.test1');
  $test1_storage->write('config_test.create', [
    'foo' => 'bar',
  ]);
  $test1_storage->write('config_test.update', [
    'foo' => 'bar',
  ]);
  $test2_storage = $active_storage->createCollection('collection.test2');
  $test2_storage->write('config_test.another_create', [
    'foo' => 'bar',
  ]);
  $test2_storage->write('config_test.another_update', [
    'foo' => 'bar',
  ]);
  // Export the configuration.
  $this->drupalGet('admin/config/development/configuration/full/export');
  $this->submitForm([], 'Export');
  $this->tarball = $this->getSession()
    ->getPage()
    ->getContent();
  $filename = \Drupal::service('file_system')->getTempDirectory() . '/' . $this->randomMachineName();
  file_put_contents($filename, $this->tarball);
  // Set up the active storage collections to test import.
  $test1_storage->delete('config_test.create');
  $test1_storage->write('config_test.update', [
    'foo' => 'baz',
  ]);
  $test1_storage->write('config_test.delete', [
    'foo' => 'bar',
  ]);
  $test2_storage->delete('config_test.another_create');
  $test2_storage->write('config_test.another_update', [
    'foo' => 'baz',
  ]);
  $test2_storage->write('config_test.another_delete', [
    'foo' => 'bar',
  ]);
  // Create a snapshot.
  $snapshot_storage = \Drupal::service('config.storage.snapshot');
  \Drupal::service('config.manager')->createSnapshot($active_storage, $snapshot_storage);
  // Ensure that the snapshot has the expected collection data before import.
  $test1_snapshot = $snapshot_storage->createCollection('collection.test1');
  $data = $test1_snapshot->read('config_test.delete');
  $this->assertEquals([
    'foo' => 'bar',
  ], $data, 'The config_test.delete in collection.test1 exists in the snapshot storage.');
  $data = $test1_snapshot->read('config_test.update');
  $this->assertEquals([
    'foo' => 'baz',
  ], $data, 'The config_test.update in collection.test1 exists in the snapshot storage.');
  $this->assertFalse($test1_snapshot->read('config_test.create'), 'The config_test.create in collection.test1 does not exist in the snapshot storage.');
  $test2_snapshot = $snapshot_storage->createCollection('collection.test2');
  $data = $test2_snapshot->read('config_test.another_delete');
  $this->assertEquals([
    'foo' => 'bar',
  ], $data, 'The config_test.another_delete in collection.test2 exists in the snapshot storage.');
  $data = $test2_snapshot->read('config_test.another_update');
  $this->assertEquals([
    'foo' => 'baz',
  ], $data, 'The config_test.another_update in collection.test2 exists in the snapshot storage.');
  $this->assertFalse($test2_snapshot->read('config_test.another_create'), 'The config_test.another_create in collection.test2 does not exist in the snapshot storage.');
  // Create the tar that contains the expected content for the collections.
  $tar = new ArchiveTar($filename, 'gz');
  $content_list = $tar->listContent();
  // Convert the list of files into something easy to search.
  $files = [];
  foreach ($content_list as $file) {
    $files[] = $file['filename'];
  }
  $this->assertContains('collection/test1/config_test.create.yml', $files, 'Config export contains collection/test1/config_test.create.yml.');
  $this->assertContains('collection/test2/config_test.another_create.yml', $files, 'Config export contains collection/test2/config_test.another_create.yml.');
  $this->assertContains('collection/test1/config_test.update.yml', $files, 'Config export contains collection/test1/config_test.update.yml.');
  $this->assertContains('collection/test2/config_test.another_update.yml', $files, 'Config export contains collection/test2/config_test.another_update.yml.');
  $this->assertNotContains('collection/test1/config_test.delete.yml', $files, 'Config export does not contain collection/test1/config_test.delete.yml.');
  $this->assertNotContains('collection/test2/config_test.another_delete.yml', $files, 'Config export does not contain collection/test2/config_test.another_delete.yml.');
  $this->drupalGet('admin/config/development/configuration/full/import');
  $this->submitForm([
    'files[import_tarball]' => $filename,
  ], 'Upload');
  // Verify that there are configuration differences to import.
  $this->drupalGet('admin/config/development/configuration');
  $this->assertSession()
    ->pageTextNotContains('There is no staged configuration.');
  $this->assertSession()
    ->pageTextContains('collection.test1 configuration collection');
  $this->assertSession()
    ->pageTextContains('collection.test2 configuration collection');
  $this->assertSession()
    ->pageTextContains('config_test.create');
  $this->assertSession()
    ->linkByHrefExists('admin/config/development/configuration/sync/diff_collection/collection.test1/config_test.create');
  $this->assertSession()
    ->pageTextContains('config_test.update');
  $this->assertSession()
    ->linkByHrefExists('admin/config/development/configuration/sync/diff_collection/collection.test1/config_test.update');
  $this->assertSession()
    ->pageTextContains('config_test.delete');
  $this->assertSession()
    ->linkByHrefExists('admin/config/development/configuration/sync/diff_collection/collection.test1/config_test.delete');
  $this->assertSession()
    ->pageTextContains('config_test.another_create');
  $this->assertSession()
    ->linkByHrefExists('admin/config/development/configuration/sync/diff_collection/collection.test2/config_test.another_create');
  $this->assertSession()
    ->pageTextContains('config_test.another_update');
  $this->assertSession()
    ->linkByHrefExists('admin/config/development/configuration/sync/diff_collection/collection.test2/config_test.another_update');
  $this->assertSession()
    ->pageTextContains('config_test.another_delete');
  $this->assertSession()
    ->linkByHrefExists('admin/config/development/configuration/sync/diff_collection/collection.test2/config_test.another_delete');
  $this->submitForm([], 'Import all');
  $this->assertSession()
    ->pageTextContains('The staged configuration is identical to the active configuration.');
  // Test data in collections.
  $data = $test1_storage->read('config_test.create');
  $this->assertEquals([
    'foo' => 'bar',
  ], $data, 'The config_test.create in collection.test1 has been created.');
  $data = $test1_storage->read('config_test.update');
  $this->assertEquals([
    'foo' => 'bar',
  ], $data, 'The config_test.update in collection.test1 has been updated.');
  $this->assertFalse($test1_storage->read('config_test.delete'), 'The config_test.delete in collection.test1 has been deleted.');
  $data = $test2_storage->read('config_test.another_create');
  $this->assertEquals([
    'foo' => 'bar',
  ], $data, 'The config_test.another_create in collection.test2 has been created.');
  $data = $test2_storage->read('config_test.another_update');
  $this->assertEquals([
    'foo' => 'bar',
  ], $data, 'The config_test.another_update in collection.test2 has been updated.');
  $this->assertFalse($test2_storage->read('config_test.another_delete'), 'The config_test.another_delete in collection.test2 has been deleted.');
  // Ensure that the snapshot has been updated with the collection data.
  $snapshot_storage = \Drupal::service('config.storage.snapshot');
  $test1_snapshot = $snapshot_storage->createCollection('collection.test1');
  $data = $test1_snapshot->read('config_test.create');
  $this->assertEquals([
    'foo' => 'bar',
  ], $data, 'The config_test.create in collection.test1 has been created in the snapshot storage.');
  $data = $test1_snapshot->read('config_test.update');
  $this->assertEquals([
    'foo' => 'bar',
  ], $data, 'The config_test.update in collection.test1 has been updated in the snapshot storage.');
  $this->assertFalse($test1_snapshot->read('config_test.delete'), 'The config_test.delete in collection.test1 does not exist in the snapshot storage.');
  $test2_snapshot = $snapshot_storage->createCollection('collection.test2');
  $data = $test2_snapshot->read('config_test.another_create');
  $this->assertEquals([
    'foo' => 'bar',
  ], $data, 'The config_test.another_create in collection.test2 has been created in the snapshot storage.');
  $data = $test2_snapshot->read('config_test.another_update');
  $this->assertEquals([
    'foo' => 'bar',
  ], $data, 'The config_test.another_update in collection.test2 has been updated in the snapshot storage.');
  $this->assertFalse($test2_snapshot->read('config_test.another_delete'), 'The config_test.another_delete in collection.test2 does not exist in the snapshot storage.');
}