ConfigImportUITest.php

<?php

/**
 * @file
 * Definition of Drupal\config\Tests\ConfigImportUITest.
 */
namespace Drupal\config\Tests;

use Drupal\simpletest\WebTestBase;

/**
 * Tests importing configuration from files into active store.
 */
class ConfigImportUITest extends WebTestBase {
  public static $modules = array(
    'config',
    'config_test',
  );
  public static function getInfo() {
    return array(
      'name' => 'Import UI',
      'description' => 'Tests the user interface for importing/exporting configuration.',
      'group' => 'Configuration',
    );
  }
  function setUp() {
    parent::setUp();
    $this->web_user = $this
      ->drupalCreateUser(array(
      'synchronize configuration',
    ));
    $this
      ->drupalLogin($this->web_user);
  }

  /**
   * Tests importing configuration.
   */
  function testImport() {
    $name = 'system.site';
    $dynamic_name = 'config_test.dynamic.new';
    $storage = $this->container
      ->get('config.storage');
    $staging = $this->container
      ->get('config.storage.staging');

    // Verify the configuration to create and update does not exist yet.
    $this
      ->assertIdentical($staging
      ->exists($name), FALSE, $name . ' not found.');
    $this
      ->assertIdentical($staging
      ->exists($dynamic_name), FALSE, $dynamic_name . ' not found.');

    // Verify that the import UI recognises that the staging folder is empty.
    $this
      ->drupalGet('admin/config/development/sync');
    $this
      ->assertText('There is no configuration to import.');

    // Create updated configuration object.
    $new_site_name = 'Config import test ' . $this
      ->randomString();
    $this
      ->prepareSiteNameUpdate($new_site_name);
    $this
      ->assertIdentical($staging
      ->exists($name), TRUE, $name . ' found.');

    // Create new config entity.
    $original_dynamic_data = array(
      'id' => 'new',
      'uuid' => '30df59bd-7b03-4cf7-bb35-d42fc49f0651',
      'label' => 'New',
      'style' => '',
      'langcode' => 'und',
    );
    $staging
      ->write($dynamic_name, $original_dynamic_data);

    // Create manifest for new config entity.
    $manifest_data = config('manifest.config_test.dynamic')
      ->get();
    $manifest_data[$original_dynamic_data['id']]['name'] = 'config_test.dynamic.' . $original_dynamic_data['id'];
    $staging
      ->write('manifest.config_test.dynamic', $manifest_data);
    $this
      ->assertIdentical($staging
      ->exists($dynamic_name), TRUE, $dynamic_name . ' found.');

    // Verify that both appear as new.
    $this
      ->drupalGet('admin/config/development/sync');
    $this
      ->assertText($name);
    $this
      ->assertText($dynamic_name);

    // Import and verify that both do not appear anymore.
    $this
      ->drupalPost(NULL, array(), t('Import all'));
    $this
      ->assertUrl('admin/config/development/sync');
    $this
      ->assertNoText($name);
    $this
      ->assertNoText($dynamic_name);

    // Verify that there are no further changes to import.
    $this
      ->assertText(t('There is no configuration to import.'));

    // Verify site name has changed.
    $this
      ->assertIdentical($new_site_name, config('system.site')
      ->get('name'));

    // Verify that new config entity exists.
    $this
      ->assertIdentical($original_dynamic_data, config($dynamic_name)
      ->get());

    // Verify the cache got cleared.
    $this
      ->assertTrue(isset($GLOBALS['hook_cache_flush']));
  }

  /**
   * Tests concurrent importing of configuration.
   */
  function testImportLock() {

    // Create updated configuration object.
    $new_site_name = 'Config import test ' . $this
      ->randomString();
    $this
      ->prepareSiteNameUpdate($new_site_name);

    // Verify that there are configuration differences to import.
    $this
      ->drupalGet('admin/config/development/sync');
    $this
      ->assertNoText(t('There are no configuration changes.'));

    // Acquire a fake-lock on the import mechanism.
    lock()
      ->acquire('config_import');

    // Attempt to import configuration and verify that an error message appears.
    $this
      ->drupalPost(NULL, array(), t('Import all'));
    $this
      ->assertUrl('admin/config/development/sync');
    $this
      ->assertText(t('Another request may be synchronizing configuration already.'));

    // Release the lock, just to keep testing sane.
    lock()
      ->release('config_import');

    // Verify site name has not changed.
    $this
      ->assertNotEqual($new_site_name, config('system.site')
      ->get('name'));
  }
  function prepareSiteNameUpdate($new_site_name) {
    $staging = $this->container
      ->get('config.storage.staging');

    // Create updated configuration object.
    $config_data = config('system.site')
      ->get();
    $config_data['name'] = $new_site_name;
    $staging
      ->write('system.site', $config_data);
  }

}