ConfigExportImportUITest.php

<?php

declare (strict_types=1);
namespace Drupal\Tests\config\Functional;

use Drupal\Core\Archiver\ArchiveTar;
use Drupal\field\Entity\FieldConfig;
use Drupal\field\Entity\FieldStorageConfig;
use Drupal\Tests\BrowserTestBase;

/**
 * Tests the user interface for importing/exporting configuration.
 *
 * Each testX method does a complete rebuild of a Drupal site, so values being
 * tested need to be stored in protected properties in order to survive until
 * the next rebuild.
 *
 * @group config
 */
class ConfigExportImportUITest extends BrowserTestBase {
    
    /**
     * The contents of the config export tarball, held between test methods.
     *
     * @var string
     */
    protected $tarball;
    
    /**
     * Holds the original 'site slogan' before testing.
     *
     * @var string
     */
    protected $originalSlogan;
    
    /**
     * Holds a randomly generated new 'site slogan' for testing.
     *
     * @var string
     */
    protected $newSlogan;
    
    /**
     * Holds a content type.
     *
     * @var \Drupal\node\NodeInterface
     */
    protected $contentType;
    
    /**
     * Holds the randomly-generated name of a field.
     *
     * @var string
     */
    protected $fieldName;
    
    /**
     * Holds the field storage entity for $fieldName.
     *
     * @var \Drupal\field\FieldStorageConfigInterface
     */
    protected $fieldStorage;
    
    /**
     * Modules to enable.
     *
     * @var array
     */
    protected static $modules = [
        'config',
        'node',
        'field',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        // Create a content type.
        $this->contentType = $this->drupalCreateContentType([
            'type' => 'test',
        ]);
        $this->drupalLogin($this->drupalCreateUser([
            'export configuration',
            'import configuration',
            'synchronize configuration',
            'access administration pages',
            'administer site configuration',
            'create test content',
            'view the administration theme',
        ]));
    }
    
    /**
     * Tests a simple site export import case.
     */
    public function testExportImport() : void {
        // After installation there is no snapshot and nothing to import.
        $this->drupalGet('admin/config/development/configuration');
        $this->assertSession()
            ->pageTextNotContains('Warning message');
        $this->assertSession()
            ->pageTextContains('There is no staged configuration.');
        $this->originalSlogan = $this->config('system.site')
            ->get('slogan');
        $this->newSlogan = $this->randomString(16);
        $this->assertNotEquals($this->originalSlogan, $this->newSlogan);
        $this->config('system.site')
            ->set('slogan', $this->newSlogan)
            ->save();
        $this->assertEquals($this->newSlogan, $this->config('system.site')
            ->get('slogan'));
        // Create a field.
        $this->fieldName = $this->randomMachineName();
        $this->fieldStorage = FieldStorageConfig::create([
            'field_name' => $this->fieldName,
            'entity_type' => 'node',
            'type' => 'text',
        ]);
        $this->fieldStorage
            ->save();
        FieldConfig::create([
            'field_storage' => $this->fieldStorage,
            'bundle' => $this->contentType
                ->id(),
        ])
            ->save();
        $display_repository = $this->container
            ->get('entity_display.repository');
        // Update the displays so that configuration does not change unexpectedly on
        // import.
        $display_repository->getFormDisplay('node', $this->contentType
            ->id(), 'default')
            ->setComponent($this->fieldName, [
            'type' => 'text_textfield',
        ])
            ->save();
        $display_repository->getViewDisplay('node', $this->contentType
            ->id(), 'full')
            ->setComponent($this->fieldName)
            ->save();
        $display_repository->getViewDisplay('node', $this->contentType
            ->id(), 'default')
            ->setComponent($this->fieldName)
            ->save();
        $display_repository->getViewDisplay('node', $this->contentType
            ->id(), 'teaser')
            ->removeComponent($this->fieldName)
            ->save();
        $this->drupalGet('node/add/' . $this->contentType
            ->id());
        $this->assertSession()
            ->fieldValueEquals("{$this->fieldName}[0][value]", '');
        // Export the configuration.
        $this->drupalGet('admin/config/development/configuration/full/export');
        $this->submitForm([], 'Export');
        $this->tarball = $this->getSession()
            ->getPage()
            ->getContent();
        $this->config('system.site')
            ->set('slogan', $this->originalSlogan)
            ->save();
        $this->assertEquals($this->originalSlogan, $this->config('system.site')
            ->get('slogan'));
        // Delete the custom field.
        $fields = FieldConfig::loadMultiple();
        foreach ($fields as $field) {
            if ($field->getName() == $this->fieldName) {
                $field->delete();
            }
        }
        $field_storages = FieldStorageConfig::loadMultiple();
        foreach ($field_storages as $field_storage) {
            if ($field_storage->getName() == $this->fieldName) {
                $field_storage->delete();
            }
        }
        $this->drupalGet('node/add/' . $this->contentType
            ->id());
        $this->assertSession()
            ->fieldNotExists("{$this->fieldName}[0][value]");
        // Import the configuration.
        $filename = 'temporary://' . $this->randomMachineName();
        file_put_contents($filename, $this->tarball);
        $this->drupalGet('admin/config/development/configuration/full/import');
        $this->submitForm([
            'files[import_tarball]' => $filename,
        ], 'Upload');
        // There is no snapshot yet because an import has never run.
        $this->assertSession()
            ->pageTextNotContains('Warning message');
        $this->assertSession()
            ->pageTextNotContains('There is no staged configuration.');
        $this->assertSession()
            ->pageTextContains($this->contentType
            ->label());
        $this->submitForm([], 'Import all');
        // After importing the snapshot has been updated and there are no warnings.
        $this->assertSession()
            ->pageTextNotContains('Warning message');
        $this->assertSession()
            ->pageTextContains('The staged configuration is identical to the active configuration.');
        $this->assertEquals($this->newSlogan, $this->config('system.site')
            ->get('slogan'));
        $this->drupalGet('node/add');
        $this->assertSession()
            ->fieldValueEquals("{$this->fieldName}[0][value]", '');
        $this->config('system.site')
            ->set('slogan', $this->originalSlogan)
            ->save();
        $this->drupalGet('admin/config/development/configuration');
        $this->assertSession()
            ->pageTextContains('Warning message');
        $this->assertSession()
            ->pageTextContains('The following items in your active configuration have changes since the last import that may be lost on the next import.');
        // Ensure the item is displayed as part of a list (to avoid false matches
        // on the rest of the page) and that the list markup is not escaped.
        $this->assertSession()
            ->responseContains('<li>system.site</li>');
        // Remove everything from sync. The warning about differences between the
        // active and snapshot should no longer exist.
        \Drupal::service('config.storage.sync')->deleteAll();
        $this->drupalGet('admin/config/development/configuration');
        $this->assertSession()
            ->pageTextNotContains('Warning message');
        $this->assertSession()
            ->pageTextNotContains('The following items in your active configuration have changes since the last import that may be lost on the next import.');
        $this->assertSession()
            ->pageTextContains('There is no staged configuration.');
        // Write a file to sync. The warning about differences between the active
        // and snapshot should now exist.
        
        /** @var \Drupal\Core\Config\StorageInterface $sync */
        $sync = $this->container
            ->get('config.storage.sync');
        $data = $this->config('system.site')
            ->get();
        $data['slogan'] = 'in the face';
        $this->copyConfig($this->container
            ->get('config.storage'), $sync);
        $sync->write('system.site', $data);
        $this->drupalGet('admin/config/development/configuration');
        $this->assertSession()
            ->pageTextContains('Warning message');
        $this->assertSession()
            ->pageTextContains('The following items in your active configuration have changes since the last import that may be lost on the next import.');
        // Ensure the item is displayed as part of a list (to avoid false matches
        // on the rest of the page) and that the list markup is not escaped.
        $this->assertSession()
            ->responseContains('<li>system.site</li>');
    }
    
    /**
     * Tests an export and import of collections.
     */
    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.');
    }

}