ConfigLanguageOverrideTest.php in Drupal 8

Namespace

Drupal\KernelTests\Core\Config

File

core/tests/Drupal/KernelTests/Core/Config/ConfigLanguageOverrideTest.php

<?php

namespace Drupal\KernelTests\Core\Config;

use Drupal\language\Entity\ConfigurableLanguage;
use Drupal\KernelTests\KernelTestBase;

/**
 * Confirm that language overrides work.
 *
 * @group config
 */
class ConfigLanguageOverrideTest extends KernelTestBase {

  /**
   * Modules to enable.
   *
   * @var array
   */
  public static $modules = [
    'user',
    'language',
    'config_test',
    'system',
    'field',
  ];

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this
      ->installConfig([
      'config_test',
    ]);
  }

  /**
   * Tests locale override based on language.
   */
  public function testConfigLanguageOverride() {

    // The language module implements a config factory override object that
    // overrides configuration when the Language module is enabled. This test ensures that
    // English overrides work.
    \Drupal::languageManager()
      ->setConfigOverrideLanguage(\Drupal::languageManager()
      ->getLanguage('en'));
    $config = \Drupal::config('config_test.system');
    $this
      ->assertIdentical($config
      ->get('foo'), 'en bar');

    // Ensure that the raw data is not translated.
    $raw = $config
      ->getRawData();
    $this
      ->assertIdentical($raw['foo'], 'bar');
    ConfigurableLanguage::createFromLangcode('fr')
      ->save();
    ConfigurableLanguage::createFromLangcode('de')
      ->save();
    \Drupal::languageManager()
      ->setConfigOverrideLanguage(\Drupal::languageManager()
      ->getLanguage('fr'));
    $config = \Drupal::config('config_test.system');
    $this
      ->assertIdentical($config
      ->get('foo'), 'fr bar');
    \Drupal::languageManager()
      ->setConfigOverrideLanguage(\Drupal::languageManager()
      ->getLanguage('de'));
    $config = \Drupal::config('config_test.system');
    $this
      ->assertIdentical($config
      ->get('foo'), 'de bar');

    // Test overrides of completely new configuration objects. In normal runtime
    // this should only happen for configuration entities as we should not be
    // creating simple configuration objects on the fly.
    \Drupal::languageManager()
      ->getLanguageConfigOverride('de', 'config_test.new')
      ->set('language', 'override')
      ->save();
    $config = \Drupal::config('config_test.new');
    $this
      ->assertTrue($config
      ->isNew(), 'The configuration object config_test.new is new');
    $this
      ->assertIdentical($config
      ->get('language'), 'override');
    $this
      ->assertIdentical($config
      ->getOriginal('language', FALSE), NULL);

    // Test how overrides react to base configuration changes. Set up some base
    // values.
    \Drupal::configFactory()
      ->getEditable('config_test.foo')
      ->set('value', [
      'key' => 'original',
    ])
      ->set('label', 'Original')
      ->save();
    \Drupal::languageManager()
      ->getLanguageConfigOverride('de', 'config_test.foo')
      ->set('value', [
      'key' => 'override',
    ])
      ->set('label', 'Override')
      ->save();
    \Drupal::languageManager()
      ->getLanguageConfigOverride('fr', 'config_test.foo')
      ->set('value', [
      'key' => 'override',
    ])
      ->save();
    \Drupal::configFactory()
      ->clearStaticCache();
    $config = \Drupal::config('config_test.foo');
    $this
      ->assertIdentical($config
      ->get('value'), [
      'key' => 'override',
    ]);

    // Ensure renaming the config will rename the override.
    \Drupal::languageManager()
      ->setConfigOverrideLanguage(\Drupal::languageManager()
      ->getLanguage('en'));
    \Drupal::configFactory()
      ->rename('config_test.foo', 'config_test.bar');
    $config = \Drupal::config('config_test.bar');
    $this
      ->assertEqual($config
      ->get('value'), [
      'key' => 'original',
    ]);
    $override = \Drupal::languageManager()
      ->getLanguageConfigOverride('de', 'config_test.foo');
    $this
      ->assertTrue($override
      ->isNew());
    $this
      ->assertEqual($override
      ->get('value'), NULL);
    $override = \Drupal::languageManager()
      ->getLanguageConfigOverride('de', 'config_test.bar');
    $this
      ->assertFalse($override
      ->isNew());
    $this
      ->assertEqual($override
      ->get('value'), [
      'key' => 'override',
    ]);
    $override = \Drupal::languageManager()
      ->getLanguageConfigOverride('fr', 'config_test.bar');
    $this
      ->assertFalse($override
      ->isNew());
    $this
      ->assertEqual($override
      ->get('value'), [
      'key' => 'override',
    ]);

    // Ensure changing data in the config will update the overrides.
    $config = \Drupal::configFactory()
      ->getEditable('config_test.bar')
      ->clear('value.key')
      ->save();
    $this
      ->assertEqual($config
      ->get('value'), []);
    $override = \Drupal::languageManager()
      ->getLanguageConfigOverride('de', 'config_test.bar');
    $this
      ->assertFalse($override
      ->isNew());
    $this
      ->assertEqual($override
      ->get('value'), NULL);

    // The French override will become empty and therefore removed.
    $override = \Drupal::languageManager()
      ->getLanguageConfigOverride('fr', 'config_test.bar');
    $this
      ->assertTrue($override
      ->isNew());
    $this
      ->assertEqual($override
      ->get('value'), NULL);

    // Ensure deleting the config will delete the override.
    \Drupal::configFactory()
      ->getEditable('config_test.bar')
      ->delete();
    $override = \Drupal::languageManager()
      ->getLanguageConfigOverride('de', 'config_test.bar');
    $this
      ->assertTrue($override
      ->isNew());
    $this
      ->assertEqual($override
      ->get('value'), NULL);
  }

}

Classes

Name	Description
ConfigLanguageOverrideTest	Confirm that language overrides work.