class ConfigSchemaTest in Drupal 9

Same name and namespace in other branches

8 core/tests/Drupal/KernelTests/Core/Config/ConfigSchemaTest.php \Drupal\KernelTests\Core\Config\ConfigSchemaTest

Tests schema for configuration objects.

@group config

Hierarchy

class \Drupal\KernelTests\KernelTestBase extends \PHPUnit\Framework\TestCase implements ServiceProviderInterface uses \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, AssertContentTrait, AssertLegacyTrait, ConfigTestTrait, ExtensionListTestTrait, PhpUnitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait, PhpUnitWarnings
- class \Drupal\KernelTests\Core\Config\ConfigSchemaTest

Expanded class hierarchy of ConfigSchemaTest

File

core/tests/Drupal/KernelTests/Core/Config/ConfigSchemaTest.php, line 21

Namespace

Drupal\KernelTests\Core\Config

View source

class ConfigSchemaTest extends KernelTestBase {

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

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

  /**
   * Tests the basic metadata retrieval layer.
   */
  public function testSchemaMapping() {

    // Nonexistent configuration key will have Undefined as metadata.
    $this
      ->assertFalse(\Drupal::service('config.typed')
      ->hasConfigSchema('config_schema_test.no_such_key'));
    $definition = \Drupal::service('config.typed')
      ->getDefinition('config_schema_test.no_such_key');
    $expected = [];
    $expected['label'] = 'Undefined';
    $expected['class'] = Undefined::class;
    $expected['type'] = 'undefined';
    $expected['definition_class'] = '\\Drupal\\Core\\TypedData\\DataDefinition';
    $expected['unwrap_for_canonical_representation'] = TRUE;
    $this
      ->assertEquals($expected, $definition, 'Retrieved the right metadata for nonexistent configuration.');

    // Configuration file without schema will return Undefined as well.
    $this
      ->assertFalse(\Drupal::service('config.typed')
      ->hasConfigSchema('config_schema_test.noschema'));
    $definition = \Drupal::service('config.typed')
      ->getDefinition('config_schema_test.noschema');
    $this
      ->assertEquals($expected, $definition, 'Retrieved the right metadata for configuration with no schema.');

    // Configuration file with only some schema.
    $this
      ->assertTrue(\Drupal::service('config.typed')
      ->hasConfigSchema('config_schema_test.someschema'));
    $definition = \Drupal::service('config.typed')
      ->getDefinition('config_schema_test.someschema');
    $expected = [];
    $expected['label'] = 'Schema test data';
    $expected['class'] = Mapping::class;
    $expected['mapping']['langcode']['type'] = 'string';
    $expected['mapping']['langcode']['label'] = 'Language code';
    $expected['mapping']['_core']['type'] = '_core_config_info';
    $expected['mapping']['testitem'] = [
      'label' => 'Test item',
    ];
    $expected['mapping']['testlist'] = [
      'label' => 'Test list',
    ];
    $expected['type'] = 'config_schema_test.someschema';
    $expected['definition_class'] = '\\Drupal\\Core\\TypedData\\MapDataDefinition';
    $expected['unwrap_for_canonical_representation'] = TRUE;
    $this
      ->assertEquals($expected, $definition, 'Retrieved the right metadata for configuration with only some schema.');

    // Check type detection on elements with undefined types.
    $config = \Drupal::service('config.typed')
      ->get('config_schema_test.someschema');
    $definition = $config
      ->get('testitem')
      ->getDataDefinition()
      ->toArray();
    $expected = [];
    $expected['label'] = 'Test item';
    $expected['class'] = Undefined::class;
    $expected['type'] = 'undefined';
    $expected['definition_class'] = '\\Drupal\\Core\\TypedData\\DataDefinition';
    $expected['unwrap_for_canonical_representation'] = TRUE;
    $this
      ->assertEquals($expected, $definition, 'Automatic type detected for a scalar is undefined.');
    $definition = $config
      ->get('testlist')
      ->getDataDefinition()
      ->toArray();
    $expected = [];
    $expected['label'] = 'Test list';
    $expected['class'] = Undefined::class;
    $expected['type'] = 'undefined';
    $expected['definition_class'] = '\\Drupal\\Core\\TypedData\\DataDefinition';
    $expected['unwrap_for_canonical_representation'] = TRUE;
    $this
      ->assertEquals($expected, $definition, 'Automatic type detected for a list is undefined.');
    $definition = $config
      ->get('test_no_schema')
      ->getDataDefinition()
      ->toArray();
    $expected = [];
    $expected['label'] = 'Undefined';
    $expected['class'] = Undefined::class;
    $expected['type'] = 'undefined';
    $expected['definition_class'] = '\\Drupal\\Core\\TypedData\\DataDefinition';
    $expected['unwrap_for_canonical_representation'] = TRUE;
    $this
      ->assertEquals($expected, $definition, 'Automatic type detected for an undefined integer is undefined.');

    // Simple case, straight metadata.
    $definition = \Drupal::service('config.typed')
      ->getDefinition('system.maintenance');
    $expected = [];
    $expected['label'] = 'Maintenance mode';
    $expected['class'] = Mapping::class;
    $expected['mapping']['message'] = [
      'label' => 'Message to display when in maintenance mode',
      'type' => 'text',
    ];
    $expected['mapping']['langcode'] = [
      'label' => 'Language code',
      'type' => 'string',
    ];
    $expected['mapping']['_core']['type'] = '_core_config_info';
    $expected['type'] = 'system.maintenance';
    $expected['definition_class'] = '\\Drupal\\Core\\TypedData\\MapDataDefinition';
    $expected['unwrap_for_canonical_representation'] = TRUE;
    $this
      ->assertEquals($expected, $definition, 'Retrieved the right metadata for system.maintenance');

    // Mixed schema with ignore elements.
    $definition = \Drupal::service('config.typed')
      ->getDefinition('config_schema_test.ignore');
    $expected = [];
    $expected['label'] = 'Ignore test';
    $expected['class'] = Mapping::class;
    $expected['definition_class'] = '\\Drupal\\Core\\TypedData\\MapDataDefinition';
    $expected['mapping']['langcode'] = [
      'type' => 'string',
      'label' => 'Language code',
    ];
    $expected['mapping']['_core']['type'] = '_core_config_info';
    $expected['mapping']['label'] = [
      'label' => 'Label',
      'type' => 'label',
    ];
    $expected['mapping']['irrelevant'] = [
      'label' => 'Irrelevant',
      'type' => 'ignore',
    ];
    $expected['mapping']['indescribable'] = [
      'label' => 'Indescribable',
      'type' => 'ignore',
    ];
    $expected['mapping']['weight'] = [
      'label' => 'Weight',
      'type' => 'integer',
    ];
    $expected['type'] = 'config_schema_test.ignore';
    $expected['unwrap_for_canonical_representation'] = TRUE;
    $this
      ->assertEquals($expected, $definition);

    // The ignore elements themselves.
    $definition = \Drupal::service('config.typed')
      ->get('config_schema_test.ignore')
      ->get('irrelevant')
      ->getDataDefinition()
      ->toArray();
    $expected = [];
    $expected['type'] = 'ignore';
    $expected['label'] = 'Irrelevant';
    $expected['class'] = Ignore::class;
    $expected['definition_class'] = '\\Drupal\\Core\\TypedData\\DataDefinition';
    $expected['unwrap_for_canonical_representation'] = TRUE;
    $this
      ->assertEquals($expected, $definition);
    $definition = \Drupal::service('config.typed')
      ->get('config_schema_test.ignore')
      ->get('indescribable')
      ->getDataDefinition()
      ->toArray();
    $expected['label'] = 'Indescribable';
    $this
      ->assertEquals($expected, $definition);

    // More complex case, generic type. Metadata for image style.
    $definition = \Drupal::service('config.typed')
      ->getDefinition('image.style.large');
    $expected = [];
    $expected['label'] = 'Image style';
    $expected['class'] = Mapping::class;
    $expected['definition_class'] = '\\Drupal\\Core\\TypedData\\MapDataDefinition';
    $expected['unwrap_for_canonical_representation'] = TRUE;
    $expected['mapping']['name']['type'] = 'string';
    $expected['mapping']['uuid']['type'] = 'uuid';
    $expected['mapping']['uuid']['label'] = 'UUID';
    $expected['mapping']['langcode']['type'] = 'string';
    $expected['mapping']['langcode']['label'] = 'Language code';
    $expected['mapping']['status']['type'] = 'boolean';
    $expected['mapping']['status']['label'] = 'Status';
    $expected['mapping']['dependencies']['type'] = 'config_dependencies';
    $expected['mapping']['dependencies']['label'] = 'Dependencies';
    $expected['mapping']['name']['type'] = 'string';
    $expected['mapping']['label']['type'] = 'label';
    $expected['mapping']['label']['label'] = 'Label';
    $expected['mapping']['effects']['type'] = 'sequence';
    $expected['mapping']['effects']['sequence']['type'] = 'mapping';
    $expected['mapping']['effects']['sequence']['mapping']['id']['type'] = 'string';
    $expected['mapping']['effects']['sequence']['mapping']['data']['type'] = 'image.effect.[%parent.id]';
    $expected['mapping']['effects']['sequence']['mapping']['weight']['type'] = 'integer';
    $expected['mapping']['effects']['sequence']['mapping']['uuid']['type'] = 'uuid';
    $expected['mapping']['third_party_settings']['type'] = 'sequence';
    $expected['mapping']['third_party_settings']['label'] = 'Third party settings';
    $expected['mapping']['third_party_settings']['sequence']['type'] = '[%parent.%parent.%type].third_party.[%key]';
    $expected['mapping']['_core']['type'] = '_core_config_info';
    $expected['type'] = 'image.style.*';
    $this
      ->assertEquals($expected, $definition);

    // More complex, type based on a complex one.
    $definition = \Drupal::service('config.typed')
      ->getDefinition('image.effect.image_scale');

    // This should be the schema for image.effect.image_scale.
    $expected = [];
    $expected['label'] = 'Image scale';
    $expected['class'] = Mapping::class;
    $expected['definition_class'] = '\\Drupal\\Core\\TypedData\\MapDataDefinition';
    $expected['unwrap_for_canonical_representation'] = TRUE;
    $expected['mapping']['width']['type'] = 'integer';
    $expected['mapping']['width']['label'] = 'Width';
    $expected['mapping']['height']['type'] = 'integer';
    $expected['mapping']['height']['label'] = 'Height';
    $expected['mapping']['upscale']['type'] = 'boolean';
    $expected['mapping']['upscale']['label'] = 'Upscale';
    $expected['type'] = 'image.effect.image_scale';
    $this
      ->assertEquals($expected, $definition, 'Retrieved the right metadata for image.effect.image_scale');

    // Most complex case, get metadata for actual configuration element.
    $effects = \Drupal::service('config.typed')
      ->get('image.style.medium')
      ->get('effects');
    $definition = $effects
      ->get('bddf0d06-42f9-4c75-a700-a33cafa25ea0')
      ->get('data')
      ->getDataDefinition()
      ->toArray();

    // This should be the schema for image.effect.image_scale, reuse previous one.
    $expected['type'] = 'image.effect.image_scale';
    $this
      ->assertEquals($expected, $definition, 'Retrieved the right metadata for the first effect of image.style.medium');
    $test = \Drupal::service('config.typed')
      ->get('config_test.dynamic.third_party')
      ->get('third_party_settings.config_schema_test');
    $definition = $test
      ->getDataDefinition()
      ->toArray();
    $expected = [];
    $expected['type'] = 'config_test.dynamic.*.third_party.config_schema_test';
    $expected['label'] = 'Mapping';
    $expected['class'] = Mapping::class;
    $expected['definition_class'] = '\\Drupal\\Core\\TypedData\\MapDataDefinition';
    $expected['unwrap_for_canonical_representation'] = TRUE;
    $expected['mapping'] = [
      'integer' => [
        'type' => 'integer',
      ],
      'string' => [
        'type' => 'string',
      ],
    ];
    $this
      ->assertEquals($expected, $definition, 'Retrieved the right metadata for config_test.dynamic.third_party:third_party_settings.config_schema_test');

    // More complex, several level deep test.
    $definition = \Drupal::service('config.typed')
      ->getDefinition('config_schema_test.someschema.somemodule.section_one.subsection');

    // This should be the schema of config_schema_test.someschema.somemodule.*.*.
    $expected = [];
    $expected['label'] = 'Schema multiple filesystem marker test';
    $expected['class'] = Mapping::class;
    $expected['mapping']['langcode']['type'] = 'string';
    $expected['mapping']['langcode']['label'] = 'Language code';
    $expected['mapping']['_core']['type'] = '_core_config_info';
    $expected['mapping']['testid']['type'] = 'string';
    $expected['mapping']['testid']['label'] = 'ID';
    $expected['mapping']['testdescription']['type'] = 'text';
    $expected['mapping']['testdescription']['label'] = 'Description';
    $expected['type'] = 'config_schema_test.someschema.somemodule.*.*';
    $expected['definition_class'] = '\\Drupal\\Core\\TypedData\\MapDataDefinition';
    $expected['unwrap_for_canonical_representation'] = TRUE;
    $this
      ->assertEquals($expected, $definition, 'Retrieved the right metadata for config_schema_test.someschema.somemodule.section_one.subsection');
    $definition = \Drupal::service('config.typed')
      ->getDefinition('config_schema_test.someschema.somemodule.section_two.subsection');

    // The other file should have the same schema.
    $this
      ->assertEquals($expected, $definition, 'Retrieved the right metadata for config_schema_test.someschema.somemodule.section_two.subsection');
  }

  /**
   * Tests metadata retrieval with several levels of %parent indirection.
   */
  public function testSchemaMappingWithParents() {
    $config_data = \Drupal::service('config.typed')
      ->get('config_schema_test.someschema.with_parents');

    // Test fetching parent one level up.
    $entry = $config_data
      ->get('one_level');
    $definition = $entry
      ->get('testitem')
      ->getDataDefinition()
      ->toArray();
    $expected = [
      'type' => 'config_schema_test.someschema.with_parents.key_1',
      'label' => 'Test item nested one level',
      'class' => StringData::class,
      'definition_class' => '\\Drupal\\Core\\TypedData\\DataDefinition',
      'unwrap_for_canonical_representation' => TRUE,
    ];
    $this
      ->assertEquals($expected, $definition);

    // Test fetching parent two levels up.
    $entry = $config_data
      ->get('two_levels');
    $definition = $entry
      ->get('wrapper')
      ->get('testitem')
      ->getDataDefinition()
      ->toArray();
    $expected = [
      'type' => 'config_schema_test.someschema.with_parents.key_2',
      'label' => 'Test item nested two levels',
      'class' => StringData::class,
      'definition_class' => '\\Drupal\\Core\\TypedData\\DataDefinition',
      'unwrap_for_canonical_representation' => TRUE,
    ];
    $this
      ->assertEquals($expected, $definition);

    // Test fetching parent three levels up.
    $entry = $config_data
      ->get('three_levels');
    $definition = $entry
      ->get('wrapper_1')
      ->get('wrapper_2')
      ->get('testitem')
      ->getDataDefinition()
      ->toArray();
    $expected = [
      'type' => 'config_schema_test.someschema.with_parents.key_3',
      'label' => 'Test item nested three levels',
      'class' => StringData::class,
      'definition_class' => '\\Drupal\\Core\\TypedData\\DataDefinition',
      'unwrap_for_canonical_representation' => TRUE,
    ];
    $this
      ->assertEquals($expected, $definition);
  }

  /**
   * Tests metadata applied to configuration objects.
   */
  public function testSchemaData() {

    // Try a simple property.
    $meta = \Drupal::service('config.typed')
      ->get('system.site');
    $property = $meta
      ->get('page')
      ->get('front');
    $this
      ->assertInstanceOf(StringInterface::class, $property);
    $this
      ->assertEquals('/user/login', $property
      ->getValue(), 'Got the right value for page.front data.');
    $definition = $property
      ->getDataDefinition();
    $this
      ->assertTrue(empty($definition['translatable']), 'Got the right translatability setting for page.front data.');

    // Check nested array of properties.
    $list = $meta
      ->get('page')
      ->getElements();
    $this
      ->assertCount(3, $list, 'Got a list with the right number of properties for site page data');
    $this
      ->assertArrayHasKey('front', $list);
    $this
      ->assertArrayHasKey('403', $list);
    $this
      ->assertArrayHasKey('404', $list);
    $this
      ->assertEquals('/user/login', $list['front']
      ->getValue(), 'Got the right value for page.front data from the list.');

    // And test some TypedConfigInterface methods.
    $properties = $list;
    $this
      ->assertCount(3, $properties, 'Got the right number of properties for site page.');
    $this
      ->assertSame($list['front'], $properties['front']);
    $values = $meta
      ->get('page')
      ->toArray();
    $this
      ->assertCount(3, $values, 'Got the right number of property values for site page.');
    $this
      ->assertSame($values['front'], '/user/login');

    // Now let's try something more complex, with nested objects.
    $wrapper = \Drupal::service('config.typed')
      ->get('image.style.large');
    $effects = $wrapper
      ->get('effects');
    $this
      ->assertCount(1, $effects
      ->toArray(), 'Got an array with effects for image.style.large data');
    $uuid = key($effects
      ->getValue());
    $effect = $effects
      ->get($uuid)
      ->getElements();
    $this
      ->assertFalse($effect['data']
      ->isEmpty(), 'Got data for the image scale effect from metadata.');
    $this
      ->assertSame('image_scale', $effect['id']
      ->getValue(), 'Got data for the image scale effect from metadata.');
    $this
      ->assertInstanceOf(IntegerInterface::class, $effect['data']
      ->get('width'));
    $this
      ->assertEquals(480, $effect['data']
      ->get('width')
      ->getValue(), 'Got the right value for the scale effect width.');
  }

  /**
   * Tests configuration value data type enforcement using schemas.
   */
  public function testConfigSaveWithSchema() {
    $untyped_values = [
      'string' => 1,
      'empty_string' => '',
      'null_string' => NULL,
      'integer' => '100',
      'null_integer' => '',
      'boolean' => 1,
      // If the config schema doesn't have a type it shouldn't be casted.
      'no_type' => 1,
      'mapping' => [
        'string' => 1,
      ],
      'float' => '3.14',
      'null_float' => '',
      'sequence' => [
        1,
        0,
        1,
      ],
      'sequence_bc' => [
        1,
        0,
        1,
      ],
      // Not in schema and therefore should be left untouched.
      'not_present_in_schema' => TRUE,
      // Test a custom type.
      'config_schema_test_integer' => '1',
      'config_schema_test_integer_empty_string' => '',
    ];
    $untyped_to_typed = $untyped_values;
    $typed_values = [
      'string' => '1',
      'empty_string' => '',
      'null_string' => NULL,
      'integer' => 100,
      'null_integer' => NULL,
      'boolean' => TRUE,
      'no_type' => 1,
      'mapping' => [
        'string' => '1',
      ],
      'float' => 3.14,
      'null_float' => NULL,
      'sequence' => [
        TRUE,
        FALSE,
        TRUE,
      ],
      'sequence_bc' => [
        TRUE,
        FALSE,
        TRUE,
      ],
      'not_present_in_schema' => TRUE,
      'config_schema_test_integer' => 1,
      'config_schema_test_integer_empty_string' => NULL,
    ];

    // Save config which has a schema that enforces types.
    $this
      ->config('config_schema_test.schema_data_types')
      ->setData($untyped_to_typed)
      ->save();
    $this
      ->assertSame($typed_values, $this
      ->config('config_schema_test.schema_data_types')
      ->get());

    // Save config which does not have a schema that enforces types.
    $this
      ->config('config_schema_test.no_schema_data_types')
      ->setData($untyped_values)
      ->save();
    $this
      ->assertSame($untyped_values, $this
      ->config('config_schema_test.no_schema_data_types')
      ->get());

    // Ensure that configuration objects with keys marked as ignored are not
    // changed when saved. The 'config_schema_test.ignore' will have been saved
    // during the installation of configuration in the setUp method.
    $extension_path = __DIR__ . '/../../../../../modules/config/tests/config_schema_test/';
    $install_storage = new FileStorage($extension_path . InstallStorage::CONFIG_INSTALL_DIRECTORY);
    $original_data = $install_storage
      ->read('config_schema_test.ignore');
    $installed_data = $this
      ->config('config_schema_test.ignore')
      ->get();
    unset($installed_data['_core']);
    $this
      ->assertSame($original_data, $installed_data);
  }

  /**
   * Tests configuration sequence sorting using schemas.
   */
  public function testConfigSaveWithSequenceSorting() {
    $data = [
      'keyed_sort' => [
        'b' => '1',
        'a' => '2',
      ],
      'no_sort' => [
        'b' => '2',
        'a' => '1',
      ],
    ];

    // Save config which has a schema that enforces sorting.
    $this
      ->config('config_schema_test.schema_sequence_sort')
      ->setData($data)
      ->save();
    $this
      ->assertSame([
      'a' => '2',
      'b' => '1',
    ], $this
      ->config('config_schema_test.schema_sequence_sort')
      ->get('keyed_sort'));
    $this
      ->assertSame([
      'b' => '2',
      'a' => '1',
    ], $this
      ->config('config_schema_test.schema_sequence_sort')
      ->get('no_sort'));
    $data = [
      'value_sort' => [
        'b',
        'a',
      ],
      'no_sort' => [
        'b',
        'a',
      ],
    ];

    // Save config which has a schema that enforces sorting.
    $this
      ->config('config_schema_test.schema_sequence_sort')
      ->setData($data)
      ->save();
    $this
      ->assertSame([
      'a',
      'b',
    ], $this
      ->config('config_schema_test.schema_sequence_sort')
      ->get('value_sort'));
    $this
      ->assertSame([
      'b',
      'a',
    ], $this
      ->config('config_schema_test.schema_sequence_sort')
      ->get('no_sort'));

    // Value sort does not preserve keys - this is intentional.
    $data = [
      'value_sort' => [
        1 => 'b',
        2 => 'a',
      ],
      'no_sort' => [
        1 => 'b',
        2 => 'a',
      ],
    ];

    // Save config which has a schema that enforces sorting.
    $this
      ->config('config_schema_test.schema_sequence_sort')
      ->setData($data)
      ->save();
    $this
      ->assertSame([
      'a',
      'b',
    ], $this
      ->config('config_schema_test.schema_sequence_sort')
      ->get('value_sort'));
    $this
      ->assertSame([
      1 => 'b',
      2 => 'a',
    ], $this
      ->config('config_schema_test.schema_sequence_sort')
      ->get('no_sort'));

    // Test sorts do not destroy complex values.
    $data = [
      'complex_sort_value' => [
        [
          'foo' => 'b',
          'bar' => 'b',
        ],
        [
          'foo' => 'a',
          'bar' => 'a',
        ],
      ],
      'complex_sort_key' => [
        'b' => [
          'foo' => '1',
          'bar' => '1',
        ],
        'a' => [
          'foo' => '2',
          'bar' => '2',
        ],
      ],
    ];
    $this
      ->config('config_schema_test.schema_sequence_sort')
      ->setData($data)
      ->save();
    $this
      ->assertSame([
      [
        'foo' => 'a',
        'bar' => 'a',
      ],
      [
        'foo' => 'b',
        'bar' => 'b',
      ],
    ], $this
      ->config('config_schema_test.schema_sequence_sort')
      ->get('complex_sort_value'));
    $this
      ->assertSame([
      'a' => [
        'foo' => '2',
        'bar' => '2',
      ],
      'b' => [
        'foo' => '1',
        'bar' => '1',
      ],
    ], $this
      ->config('config_schema_test.schema_sequence_sort')
      ->get('complex_sort_key'));

    // Swap the previous test scenario around.
    $data = [
      'complex_sort_value' => [
        'b' => [
          'foo' => '1',
          'bar' => '1',
        ],
        'a' => [
          'foo' => '2',
          'bar' => '2',
        ],
      ],
      'complex_sort_key' => [
        [
          'foo' => 'b',
          'bar' => 'b',
        ],
        [
          'foo' => 'a',
          'bar' => 'a',
        ],
      ],
    ];
    $this
      ->config('config_schema_test.schema_sequence_sort')
      ->setData($data)
      ->save();
    $this
      ->assertSame([
      [
        'foo' => '1',
        'bar' => '1',
      ],
      [
        'foo' => '2',
        'bar' => '2',
      ],
    ], $this
      ->config('config_schema_test.schema_sequence_sort')
      ->get('complex_sort_value'));
    $this
      ->assertSame([
      [
        'foo' => 'b',
        'bar' => 'b',
      ],
      [
        'foo' => 'a',
        'bar' => 'a',
      ],
    ], $this
      ->config('config_schema_test.schema_sequence_sort')
      ->get('complex_sort_key'));
  }

  /**
   * Tests fallback to a greedy wildcard.
   */
  public function testSchemaFallback() {
    $definition = \Drupal::service('config.typed')
      ->getDefinition('config_schema_test.wildcard_fallback.something');

    // This should be the schema of config_schema_test.wildcard_fallback.*.
    $expected = [];
    $expected['label'] = 'Schema wildcard fallback test';
    $expected['class'] = Mapping::class;
    $expected['definition_class'] = '\\Drupal\\Core\\TypedData\\MapDataDefinition';
    $expected['unwrap_for_canonical_representation'] = TRUE;
    $expected['mapping']['langcode']['type'] = 'string';
    $expected['mapping']['langcode']['label'] = 'Language code';
    $expected['mapping']['_core']['type'] = '_core_config_info';
    $expected['mapping']['testid']['type'] = 'string';
    $expected['mapping']['testid']['label'] = 'ID';
    $expected['mapping']['testdescription']['type'] = 'text';
    $expected['mapping']['testdescription']['label'] = 'Description';
    $expected['type'] = 'config_schema_test.wildcard_fallback.*';
    $this
      ->assertEquals($expected, $definition, 'Retrieved the right metadata for config_schema_test.wildcard_fallback.something');
    $definition2 = \Drupal::service('config.typed')
      ->getDefinition('config_schema_test.wildcard_fallback.something.something');

    // This should be the schema of config_schema_test.wildcard_fallback.* as
    // well.
    $this
      ->assertSame($definition, $definition2);
  }

  /**
   * Tests use of colons in schema type determination.
   *
   * @see \Drupal\Core\Config\TypedConfigManager::getFallbackName()
   */
  public function testColonsInSchemaTypeDetermination() {
    $tests = \Drupal::service('config.typed')
      ->get('config_schema_test.plugin_types')
      ->get('tests')
      ->getElements();
    $definition = $tests[0]
      ->getDataDefinition()
      ->toArray();
    $this
      ->assertEquals('test.plugin_types.boolean', $definition['type']);
    $definition = $tests[1]
      ->getDataDefinition()
      ->toArray();
    $this
      ->assertEquals('test.plugin_types.boolean:*', $definition['type']);
    $definition = $tests[2]
      ->getDataDefinition()
      ->toArray();
    $this
      ->assertEquals('test.plugin_types.*', $definition['type']);
    $definition = $tests[3]
      ->getDataDefinition()
      ->toArray();
    $this
      ->assertEquals('test.plugin_types.*', $definition['type']);
    $tests = \Drupal::service('config.typed')
      ->get('config_schema_test.plugin_types')
      ->get('test_with_parents')
      ->getElements();
    $definition = $tests[0]
      ->get('settings')
      ->getDataDefinition()
      ->toArray();
    $this
      ->assertEquals('test_with_parents.plugin_types.boolean', $definition['type']);
    $definition = $tests[1]
      ->get('settings')
      ->getDataDefinition()
      ->toArray();
    $this
      ->assertEquals('test_with_parents.plugin_types.boolean:*', $definition['type']);
    $definition = $tests[2]
      ->get('settings')
      ->getDataDefinition()
      ->toArray();
    $this
      ->assertEquals('test_with_parents.plugin_types.*', $definition['type']);
    $definition = $tests[3]
      ->get('settings')
      ->getDataDefinition()
      ->toArray();
    $this
      ->assertEquals('test_with_parents.plugin_types.*', $definition['type']);
  }

  /**
   * Tests hook_config_schema_info_alter().
   */
  public function testConfigSchemaInfoAlter() {

    /** @var \Drupal\Core\Config\TypedConfigManagerInterface $typed_config */
    $typed_config = \Drupal::service('config.typed');
    $typed_config
      ->clearCachedDefinitions();

    // Ensure that keys can not be added or removed by
    // hook_config_schema_info_alter().
    \Drupal::state()
      ->set('config_schema_test_exception_remove', TRUE);
    try {
      $typed_config
        ->getDefinitions();
      $this
        ->fail('Expected ConfigSchemaAlterException thrown.');
    } catch (ConfigSchemaAlterException $e) {
      $this
        ->assertEquals('Invoking hook_config_schema_info_alter() has removed (config_schema_test.hook) schema definitions', $e
        ->getMessage());
    }
    \Drupal::state()
      ->set('config_schema_test_exception_add', TRUE);
    try {
      $typed_config
        ->getDefinitions();
      $this
        ->fail('Expected ConfigSchemaAlterException thrown.');
    } catch (ConfigSchemaAlterException $e) {
      $this
        ->assertEquals('Invoking hook_config_schema_info_alter() has added (config_schema_test.hook_added_definition) and removed (config_schema_test.hook) schema definitions', $e
        ->getMessage());
    }
    \Drupal::state()
      ->set('config_schema_test_exception_remove', FALSE);
    try {
      $typed_config
        ->getDefinitions();
      $this
        ->fail('Expected ConfigSchemaAlterException thrown.');
    } catch (ConfigSchemaAlterException $e) {
      $this
        ->assertEquals('Invoking hook_config_schema_info_alter() has added (config_schema_test.hook_added_definition) schema definitions', $e
        ->getMessage());
    }

    // Tests that hook_config_schema_info_alter() can add additional metadata to
    // existing configuration schema.
    \Drupal::state()
      ->set('config_schema_test_exception_add', FALSE);
    $definitions = $typed_config
      ->getDefinitions();
    $this
      ->assertEquals('new schema info', $definitions['config_schema_test.hook']['additional_metadata']);
  }

  /**
   * Tests saving config when the type is wrapped by a dynamic type.
   */
  public function testConfigSaveWithWrappingSchema() {
    $untyped_values = [
      'tests' => [
        [
          'wrapper_value' => 'foo',
          'plugin_id' => 'wrapper:foo',
          'internal_value' => 100,
        ],
      ],
    ];
    $typed_values = [
      'tests' => [
        [
          'wrapper_value' => 'foo',
          'plugin_id' => 'wrapper:foo',
          'internal_value' => '100',
        ],
      ],
    ];

    // Save config which has a schema that enforces types.
    \Drupal::configFactory()
      ->getEditable('wrapping.config_schema_test.plugin_types')
      ->setData($untyped_values)
      ->save();
    $this
      ->assertSame($typed_values, \Drupal::config('wrapping.config_schema_test.plugin_types')
      ->get());
  }

  /**
   * Tests dynamic config schema type with multiple sub-key references.
   */
  public function testConfigSaveWithWrappingSchemaDoubleBrackets() {
    $untyped_values = [
      'tests' => [
        [
          'wrapper_value' => 'foo',
          'foo' => 'turtle',
          'bar' => 'horse',
          // Converted to a string by 'test.double_brackets.turtle.horse'
          // schema.
          'another_key' => '100',
        ],
      ],
    ];
    $typed_values = [
      'tests' => [
        [
          'wrapper_value' => 'foo',
          'foo' => 'turtle',
          'bar' => 'horse',
          'another_key' => 100,
        ],
      ],
    ];

    // Save config which has a schema that enforces types.
    \Drupal::configFactory()
      ->getEditable('wrapping.config_schema_test.double_brackets')
      ->setData($untyped_values)
      ->save();
    $this
      ->assertSame($typed_values, \Drupal::config('wrapping.config_schema_test.double_brackets')
      ->get());
    $tests = \Drupal::service('config.typed')
      ->get('wrapping.config_schema_test.double_brackets')
      ->get('tests')
      ->getElements();
    $definition = $tests[0]
      ->getDataDefinition()
      ->toArray();
    $this
      ->assertEquals('wrapping.test.double_brackets.*||test.double_brackets.turtle.horse', $definition['type']);
    $untyped_values = [
      'tests' => [
        [
          'wrapper_value' => 'foo',
          'foo' => 'cat',
          'bar' => 'dog',
          // Converted to a string by 'test.double_brackets.cat.dog' schema.
          'another_key' => 100,
        ],
      ],
    ];
    $typed_values = [
      'tests' => [
        [
          'wrapper_value' => 'foo',
          'foo' => 'cat',
          'bar' => 'dog',
          'another_key' => '100',
        ],
      ],
    ];

    // Save config which has a schema that enforces types.
    \Drupal::configFactory()
      ->getEditable('wrapping.config_schema_test.double_brackets')
      ->setData($untyped_values)
      ->save();
    $this
      ->assertSame($typed_values, \Drupal::config('wrapping.config_schema_test.double_brackets')
      ->get());
    $tests = \Drupal::service('config.typed')
      ->get('wrapping.config_schema_test.double_brackets')
      ->get('tests')
      ->getElements();
    $definition = $tests[0]
      ->getDataDefinition()
      ->toArray();
    $this
      ->assertEquals('wrapping.test.double_brackets.*||test.double_brackets.cat.dog', $definition['type']);

    // Combine everything in a single save.
    $typed_values = [
      'tests' => [
        [
          'wrapper_value' => 'foo',
          'foo' => 'cat',
          'bar' => 'dog',
          'another_key' => 100,
        ],
        [
          'wrapper_value' => 'foo',
          'foo' => 'turtle',
          'bar' => 'horse',
          'another_key' => '100',
        ],
      ],
    ];
    \Drupal::configFactory()
      ->getEditable('wrapping.config_schema_test.double_brackets')
      ->setData($typed_values)
      ->save();
    $tests = \Drupal::service('config.typed')
      ->get('wrapping.config_schema_test.double_brackets')
      ->get('tests')
      ->getElements();
    $definition = $tests[0]
      ->getDataDefinition()
      ->toArray();
    $this
      ->assertEquals('wrapping.test.double_brackets.*||test.double_brackets.cat.dog', $definition['type']);
    $definition = $tests[1]
      ->getDataDefinition()
      ->toArray();
    $this
      ->assertEquals('wrapping.test.double_brackets.*||test.double_brackets.turtle.horse', $definition['type']);
    $typed_values = [
      'tests' => [
        [
          'id' => 'cat:persian.dog',
          'foo' => 'cat',
          'bar' => 'dog',
          'breed' => 'persian',
        ],
      ],
    ];
    \Drupal::configFactory()
      ->getEditable('wrapping.config_schema_test.other_double_brackets')
      ->setData($typed_values)
      ->save();
    $tests = \Drupal::service('config.typed')
      ->get('wrapping.config_schema_test.other_double_brackets')
      ->get('tests')
      ->getElements();
    $definition = $tests[0]
      ->getDataDefinition()
      ->toArray();

    // Check that definition type is a merge of the expected types.
    $this
      ->assertEquals('wrapping.test.other_double_brackets.*||test.double_brackets.cat:*.*', $definition['type']);

    // Check that breed was inherited from parent definition.
    $this
      ->assertEquals([
      'type' => 'string',
    ], $definition['mapping']['breed']);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
AssertContentTrait::$content	protected	property	The current raw content.
AssertContentTrait::$drupalSettings	protected	property	The drupalSettings value from the current raw $content.
AssertContentTrait::$elements	protected	property	The XML structure parsed from the current raw $content.	1
AssertContentTrait::$plainTextContent	protected	property	The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped	protected	function	Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField	protected	function	Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById	protected	function	Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName	protected	function	Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath	protected	function	Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked	protected	function	Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue	protected	function	Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink	protected	function	Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref	protected	function	Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds	protected	function	Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped	protected	function	Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertNoField	protected	function	Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById	protected	function	Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName	protected	function	Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath	protected	function	Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked	protected	function	Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink	protected	function	Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref	protected	function	Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion	protected	function	Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption	protected	function	Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected	protected	function	Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern	protected	function	Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw	protected	function	Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText	protected	function	Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle	protected	function	Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText	protected	function	Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption	protected	function	Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionByText	protected	function	Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected	protected	function	Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector	protected	function	Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector	protected	function	Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern	protected	function	Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw	protected	function	Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText	protected	function	Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper	protected	function	Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern	protected	function	Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput	protected	function	Asserts themed output.
AssertContentTrait::assertTitle	protected	function	Pass if the page title is the given string.
AssertContentTrait::assertUniqueText	protected	function	Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper	protected	function	Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery	protected	function	Builds an XPath query.
AssertContentTrait::constructFieldXpath	protected	function	Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect	protected	function	Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions	protected	function	Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings	protected	function	Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent	protected	function	Gets the current raw content.
AssertContentTrait::getSelectedItem	protected	function	Get the selected value from a select field.
AssertContentTrait::getTextContent	protected	function	Retrieves the plain-text content from the current raw content.
AssertContentTrait::getUrl	protected	function	Get the current URL from the cURL handler.	1
AssertContentTrait::parse	protected	function	Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace	protected	function	Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings	protected	function	Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent	protected	function	Sets the raw content (e.g. HTML).
AssertContentTrait::xpath	protected	function	Performs an xpath search on the contents of the internal browser.
AssertLegacyTrait::assert Deprecated	protected	function
AssertLegacyTrait::assertEqual Deprecated	protected	function
AssertLegacyTrait::assertIdentical Deprecated	protected	function
AssertLegacyTrait::assertIdenticalObject Deprecated	protected	function
AssertLegacyTrait::assertNotEqual Deprecated	protected	function
AssertLegacyTrait::assertNotIdentical Deprecated	protected	function
AssertLegacyTrait::pass Deprecated	protected	function
AssertLegacyTrait::verbose Deprecated	protected	function
ConfigSchemaTest::$modules	protected static	property	Modules to enable. Overrides KernelTestBase::$modules
ConfigSchemaTest::setUp	protected	function	Overrides KernelTestBase::setUp
ConfigSchemaTest::testColonsInSchemaTypeDetermination	public	function	Tests use of colons in schema type determination.
ConfigSchemaTest::testConfigSaveWithSchema	public	function	Tests configuration value data type enforcement using schemas.
ConfigSchemaTest::testConfigSaveWithSequenceSorting	public	function	Tests configuration sequence sorting using schemas.
ConfigSchemaTest::testConfigSaveWithWrappingSchema	public	function	Tests saving config when the type is wrapped by a dynamic type.
ConfigSchemaTest::testConfigSaveWithWrappingSchemaDoubleBrackets	public	function	Tests dynamic config schema type with multiple sub-key references.
ConfigSchemaTest::testConfigSchemaInfoAlter	public	function	Tests hook_config_schema_info_alter().
ConfigSchemaTest::testSchemaData	public	function	Tests metadata applied to configuration objects.
ConfigSchemaTest::testSchemaFallback	public	function	Tests fallback to a greedy wildcard.
ConfigSchemaTest::testSchemaMapping	public	function	Tests the basic metadata retrieval layer.
ConfigSchemaTest::testSchemaMappingWithParents	public	function	Tests metadata retrieval with several levels of %parent indirection.
ConfigTestTrait::configImporter	protected	function	Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig	protected	function	Copies configuration objects from source storage to target storage.
ExtensionListTestTrait::getModulePath	protected	function	Gets the path for the specified module.
ExtensionListTestTrait::getThemePath	protected	function	Gets the path for the specified theme.
KernelTestBase::$backupGlobals	protected	property	Back up and restore any global variables that may be changed by tests.
KernelTestBase::$backupStaticAttributes	protected	property	Back up and restore static class properties that may be changed by tests.
KernelTestBase::$backupStaticAttributesBlacklist	protected	property	Contains a few static class properties for performance.
KernelTestBase::$classLoader	protected	property
KernelTestBase::$configImporter	protected	property	@todo Move into Config test base class.	7
KernelTestBase::$configSchemaCheckerExclusions	protected static	property	An array of config object names that are excluded from schema checking.
KernelTestBase::$container	protected	property
KernelTestBase::$databasePrefix	protected	property
KernelTestBase::$preserveGlobalState	protected	property	Do not forward any global state from the parent process to the processes that run the actual tests.
KernelTestBase::$root	protected	property	The app root.
KernelTestBase::$runTestInSeparateProcess	protected	property	Kernel tests are run in separate processes because they allow autoloading of code from extensions. Running the test in a separate process isolates this behavior from other tests. Subclasses should not override this property.
KernelTestBase::$siteDirectory	protected	property
KernelTestBase::$strictConfigSchema	protected	property	Set to TRUE to strict check all configuration saved.	6
KernelTestBase::$vfsRoot	protected	property	The virtual filesystem root directory.
KernelTestBase::assertPostConditions	protected	function		1
KernelTestBase::bootEnvironment	protected	function	Bootstraps a basic test environment.
KernelTestBase::bootKernel	private	function	Bootstraps a kernel for a test.
KernelTestBase::config	protected	function	Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::disableModules	protected	function	Disables modules for this test.
KernelTestBase::enableModules	protected	function	Enables modules for this test.
KernelTestBase::getConfigSchemaExclusions	protected	function	Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo	protected	function	Returns the Database connection info to be used for this test.	3
KernelTestBase::getDatabasePrefix	public	function
KernelTestBase::getExtensionsForModules	private	function	Returns Extension objects for $modules to enable.
KernelTestBase::getModulesToEnable	private static	function	Returns the modules to enable for this test.
KernelTestBase::initFileCache	protected	function	Initializes the FileCache component.
KernelTestBase::installConfig	protected	function	Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema	protected	function	Installs the storage schema for a specific entity type.
KernelTestBase::installSchema	protected	function	Installs database tables from a module schema definition.
KernelTestBase::prepareTemplate	protected	function
KernelTestBase::register	public	function	Registers test-specific services. Overrides ServiceProviderInterface::register	24
KernelTestBase::render	protected	function	Renders a render array.	1
KernelTestBase::setInstallProfile	protected	function	Sets the install profile and rebuilds the container to update it.
KernelTestBase::setSetting	protected	function	Sets an in-memory Settings variable.
KernelTestBase::setUpBeforeClass	public static	function		1
KernelTestBase::setUpFilesystem	protected	function	Sets up the filesystem, so things like the file directory.	2
KernelTestBase::stop	protected	function	Stops test execution.
KernelTestBase::tearDown	protected	function		4
KernelTestBase::tearDownCloseDatabaseConnection	public	function	@after
KernelTestBase::vfsDump	protected	function	Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__sleep	public	function	Prevents serializing any properties.
PhpUnitWarnings::$deprecationWarnings	private static	property	Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning	public	function	Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
RandomGeneratorTrait::$randomGenerator	protected	property	The random generator.
RandomGeneratorTrait::getRandomGenerator	protected	function	Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName	protected	function	Generates a unique random string containing letters and numbers.	1
RandomGeneratorTrait::randomObject	public	function	Generates a random PHP object.
RandomGeneratorTrait::randomString	public	function	Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate	public	function	Callback for random string validation.
StorageCopyTrait::replaceStorageContents	protected static	function	Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements	private	function	Checks missing module requirements.
TestRequirementsTrait::checkRequirements	protected	function	Check module requirements for the Drupal use case.	1
TestRequirementsTrait::getDrupalRoot	protected static	function	Returns the Drupal root directory.

You are here

class ConfigSchemaTest in Drupal 9

Hierarchy

File

Namespace

Members

API Navigation