ConfigExportImportUITest.php 13.4 KB
Newer Older
1 2 3 4 5 6 7 8 9
<?php

/**
 * @file
 * Contains \Drupal\config\Tests\ConfigExportImportUITest.
 */

namespace Drupal\config\Tests;

10
use Drupal\Component\Utility\Unicode;
11
use Drupal\Core\Archiver\ArchiveTar;
12
use Drupal\field\Entity\FieldConfig;
13
use Drupal\field\Entity\FieldStorageConfig;
14 15 16
use Drupal\simpletest\WebTestBase;

/**
17
 * Tests the user interface for importing/exporting configuration.
18 19 20 21
 *
 * 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.
22 23
 *
 * @group config
24 25 26 27 28 29 30 31 32 33
 */
class ConfigExportImportUITest extends WebTestBase {

  /**
   * The contents of the config export tarball, held between test methods.
   *
   * @var string
   */
  protected $tarball;

34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69
  /**
   * 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;

70
  /**
71
   * Modules to enable.
72
   *
73
   * @var array
74
   */
75
  public static $modules = array('config', 'node', 'field');
76

77 78 79
  /**
   * {@inheritdoc}
   */
80 81 82 83 84 85
  protected function setUp() {
    parent::setUp();
    // The initial import must be done with uid 1 because if separately named
    // roles are created then the role is lost after import. If the roles
    // created have the same name then the sync will fail because they will
    // have different UUIDs.
86
    $this->drupalLogin($this->rootUser);
87 88 89
  }

  /**
90
   * Tests a simple site export import case.
91
   */
92
  public function testExportImport() {
93
    $this->originalSlogan = $this->config('system.site')->get('slogan');
94 95
    $this->newSlogan = $this->randomString(16);
    $this->assertNotEqual($this->newSlogan, $this->originalSlogan);
96
    $this->config('system.site')
97
      ->set('slogan', $this->newSlogan)
98
      ->save();
99
    $this->assertEqual($this->config('system.site')->get('slogan'), $this->newSlogan);
100

101
    // Create a content type.
102
    $this->contentType = $this->drupalCreateContentType();
103 104

    // Create a field.
105
    $this->fieldName = Unicode::strtolower($this->randomMachineName());
106
    $this->fieldStorage = entity_create('field_storage_config', array(
107
      'field_name' => $this->fieldName,
108 109 110
      'entity_type' => 'node',
      'type' => 'text',
    ));
111
    $this->fieldStorage->save();
112
    entity_create('field_config', array(
113
      'field_storage' => $this->fieldStorage,
114
      'bundle' => $this->contentType->id(),
115
    ))->save();
116
    entity_get_form_display('node', $this->contentType->id(), 'default')
117
      ->setComponent($this->fieldName, array(
118 119 120
        'type' => 'text_textfield',
      ))
      ->save();
121
    entity_get_display('node', $this->contentType->id(), 'full')
122
      ->setComponent($this->fieldName)
123 124
      ->save();

125
    $this->drupalGet('node/add/' . $this->contentType->id());
126
    $this->assertFieldByName("{$this->fieldName}[0][value]", '', 'Widget is displayed');
127 128

    // Export the configuration.
129
    $this->drupalPostForm('admin/config/development/configuration/full/export', array(), 'Export');
130
    $this->tarball = $this->getRawContent();
131

132
    $this->config('system.site')
133
      ->set('slogan', $this->originalSlogan)
134
      ->save();
135
    $this->assertEqual($this->config('system.site')->get('slogan'), $this->originalSlogan);
136

137
    // Delete the custom field.
138
    $fields = FieldConfig::loadMultiple();
139 140 141
    foreach ($fields as $field) {
      if ($field->field_name == $this->fieldName) {
        $field->delete();
142 143
      }
    }
144
    $field_storages = FieldStorageConfig::loadMultiple();
145
    foreach ($field_storages as $field_storage) {
146
      if ($field_storage->getName() == $this->fieldName) {
147
        $field_storage->delete();
148 149
      }
    }
150
    $this->drupalGet('node/add/' . $this->contentType->id());
151
    $this->assertNoFieldByName("{$this->fieldName}[0][value]", '', 'Widget is not displayed');
152 153

    // Import the configuration.
154
    $filename = 'temporary://' . $this->randomMachineName();
155
    file_put_contents($filename, $this->tarball);
156
    $this->drupalPostForm('admin/config/development/configuration/full/import', array('files[import_tarball]' => $filename), 'Upload');
157
    $this->drupalPostForm(NULL, array(), 'Import all');
158

159
    $this->assertEqual($this->config('system.site')->get('slogan'), $this->newSlogan);
160 161

    $this->drupalGet('node/add');
162
    $this->assertFieldByName("{$this->fieldName}[0][value]", '', 'Widget is displayed');
163

164
    $this->config('system.site')
165 166 167 168
      ->set('slogan', $this->originalSlogan)
      ->save();
    $this->drupalGet('admin/config/development/configuration');
    $this->assertText('Your current configuration has changed. Changes to these configuration items will be lost on the next synchronization: system.site');
169
  }
170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186

  /**
   * Tests an export and import of collections.
   */
  public function testExportImportCollections() {

    /** @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', array('foo' => 'bar'));
    $test1_storage->write('config_test.update', array('foo' => 'bar'));
    $test2_storage = $active_storage->createCollection('collection.test2');
    $test2_storage->write('config_test.another_create', array('foo' => 'bar'));
    $test2_storage->write('config_test.another_update', array('foo' => 'bar'));

    // Export the configuration.
    $this->drupalPostForm('admin/config/development/configuration/full/export', array(), 'Export');
187
    $this->tarball = $this->getRawContent();
188
    $filename = file_directory_temp() .'/' . $this->randomMachineName();
189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234
    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', array('foo' => 'baz'));
    $test1_storage->write('config_test.delete', array('foo' => 'bar'));
    $test2_storage->delete('config_test.another_create');
    $test2_storage->write('config_test.another_update', array('foo' => 'baz'));
    $test2_storage->write('config_test.another_delete', array('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->assertEqual($data, array('foo' => 'bar'), 'The config_test.delete in collection.test1 exists in the snapshot storage.');
    $data = $test1_snapshot->read('config_test.update');
    $this->assertEqual($data, array('foo' => 'baz'), '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->assertEqual($data, array('foo' => 'bar'), 'The config_test.another_delete in collection.test2 exists in the snapshot storage.');
    $data = $test2_snapshot->read('config_test.another_update');
    $this->assertEqual($data, array('foo' => 'baz'), '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 contains the expected contect for the collections.
    $tar = new ArchiveTar($filename, 'gz');
    $content_list = $tar->listContent();
    // Convert the list of files into something easy to search.
    $files = array();
    foreach ($content_list as $file) {
      $files[] = $file['filename'];
    }
    $this->assertTrue(in_array('collection/test1/config_test.create.yml', $files), 'Config export contains collection/test1/config_test.create.yml.');
    $this->assertTrue(in_array('collection/test2/config_test.another_create.yml', $files), 'Config export contains collection/test2/config_test.another_create.yml.');
    $this->assertTrue(in_array('collection/test1/config_test.update.yml', $files), 'Config export contains collection/test1/config_test.update.yml.');
    $this->assertTrue(in_array('collection/test2/config_test.another_update.yml', $files), 'Config export contains collection/test2/config_test.another_update.yml.');
    $this->assertFalse(in_array('collection/test1/config_test.delete.yml', $files), 'Config export does not contain collection/test1/config_test.delete.yml.');
    $this->assertFalse(in_array('collection/test2/config_test.another_delete.yml', $files), 'Config export does not contain collection/test2/config_test.another_delete.yml.');

    $this->drupalPostForm('admin/config/development/configuration/full/import', array('files[import_tarball]' => $filename), 'Upload');
    // Verify that there are configuration differences to import.
    $this->drupalGet('admin/config/development/configuration');
235
    $this->assertNoText(t('There are no configuration changes to import.'));
236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251
    $this->assertText(t('!collection configuration collection', array('!collection' => 'collection.test1')));
    $this->assertText(t('!collection configuration collection', array('!collection' => 'collection.test2')));
    $this->assertText('config_test.create');
    $this->assertLinkByHref('admin/config/development/configuration/sync/diff_collection/collection.test1/config_test.create');
    $this->assertText('config_test.update');
    $this->assertLinkByHref('admin/config/development/configuration/sync/diff_collection/collection.test1/config_test.update');
    $this->assertText('config_test.delete');
    $this->assertLinkByHref('admin/config/development/configuration/sync/diff_collection/collection.test1/config_test.delete');
    $this->assertText('config_test.another_create');
    $this->assertLinkByHref('admin/config/development/configuration/sync/diff_collection/collection.test2/config_test.another_create');
    $this->assertText('config_test.another_update');
    $this->assertLinkByHref('admin/config/development/configuration/sync/diff_collection/collection.test2/config_test.another_update');
    $this->assertText('config_test.another_delete');
    $this->assertLinkByHref('admin/config/development/configuration/sync/diff_collection/collection.test2/config_test.another_delete');

    $this->drupalPostForm(NULL, array(), 'Import all');
252
    $this->assertText(t('There are no configuration changes to import.'));
253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282

    // Test data in collections.
    $data = $test1_storage->read('config_test.create');
    $this->assertEqual($data, array('foo' => 'bar'), 'The config_test.create in collection.test1 has been created.');
    $data = $test1_storage->read('config_test.update');
    $this->assertEqual($data, array('foo' => 'bar'), '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->assertEqual($data, array('foo' => 'bar'), 'The config_test.another_create in collection.test2 has been created.');
    $data = $test2_storage->read('config_test.another_update');
    $this->assertEqual($data, array('foo' => 'bar'), '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->assertEqual($data, array('foo' => 'bar'), 'The config_test.create in collection.test1 has been created in the snapshot storage.');
    $data = $test1_snapshot->read('config_test.update');
    $this->assertEqual($data, array('foo' => 'bar'), '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->assertEqual($data, array('foo' => 'bar'), 'The config_test.another_create in collection.test2 has been created in the snapshot storage.');
    $data = $test2_snapshot->read('config_test.another_update');
    $this->assertEqual($data, array('foo' => 'bar'), '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.');
  }

283
}