function ConfigSchemaTest::testSchemaMapping in Zircon Profile 8.0

Same name and namespace in other branches

1. 8 core/modules/config/src/Tests/ConfigSchemaTest.php \Drupal\config\Tests\ConfigSchemaTest::testSchemaMapping()

Tests the basic metadata retrieval layer.

File

core/modules/config/src/Tests/ConfigSchemaTest.php, line 42

Contains \Drupal\config\Tests\ConfigSchemaTest.

Class

ConfigSchemaTest

Tests schema for configuration objects.

Namespace

Drupal\config\Tests

Code

function testSchemaMapping() {

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

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

  // Configuration file with only some schema.
  $this
    ->assertIdentical(TRUE, \Drupal::service('config.typed')
    ->hasConfigSchema('config_schema_test.someschema'));
  $definition = \Drupal::service('config.typed')
    ->getDefinition('config_schema_test.someschema');
  $expected = array();
  $expected['label'] = 'Schema test data';
  $expected['class'] = '\\Drupal\\Core\\Config\\Schema\\Mapping';
  $expected['mapping']['langcode']['type'] = 'string';
  $expected['mapping']['langcode']['label'] = 'Language code';
  $expected['mapping']['testitem'] = array(
    'label' => 'Test item',
  );
  $expected['mapping']['testlist'] = array(
    'label' => 'Test list',
  );
  $expected['type'] = 'config_schema_test.someschema';
  $expected['definition_class'] = '\\Drupal\\Core\\TypedData\\MapDataDefinition';
  $this
    ->assertEqual($definition, $expected, '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 = array();
  $expected['label'] = 'Test item';
  $expected['class'] = '\\Drupal\\Core\\Config\\Schema\\Undefined';
  $expected['type'] = 'undefined';
  $expected['definition_class'] = '\\Drupal\\Core\\TypedData\\DataDefinition';
  $this
    ->assertEqual($definition, $expected, 'Automatic type detected for a scalar is undefined.');
  $definition = $config
    ->get('testlist')
    ->getDataDefinition()
    ->toArray();
  $expected = array();
  $expected['label'] = 'Test list';
  $expected['class'] = '\\Drupal\\Core\\Config\\Schema\\Undefined';
  $expected['type'] = 'undefined';
  $expected['definition_class'] = '\\Drupal\\Core\\TypedData\\DataDefinition';
  $this
    ->assertEqual($definition, $expected, 'Automatic type detected for a list is undefined.');
  $definition = $config
    ->get('testnoschema')
    ->getDataDefinition()
    ->toArray();
  $expected = array();
  $expected['label'] = 'Undefined';
  $expected['class'] = '\\Drupal\\Core\\Config\\Schema\\Undefined';
  $expected['type'] = 'undefined';
  $expected['definition_class'] = '\\Drupal\\Core\\TypedData\\DataDefinition';
  $this
    ->assertEqual($definition, $expected, 'Automatic type detected for an undefined integer is undefined.');

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

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

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

  // More complex case, generic type. Metadata for image style.
  $definition = \Drupal::service('config.typed')
    ->getDefinition('image.style.large');
  $expected = array();
  $expected['label'] = 'Image style';
  $expected['class'] = '\\Drupal\\Core\\Config\\Schema\\Mapping';
  $expected['definition_class'] = '\\Drupal\\Core\\TypedData\\MapDataDefinition';
  $expected['mapping']['name']['type'] = 'string';
  $expected['mapping']['uuid']['type'] = 'string';
  $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'] = 'string';
  $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['type'] = 'image.style.*';
  $this
    ->assertEqual($definition, $expected);

  // 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 = array();
  $expected['label'] = 'Image scale';
  $expected['class'] = '\\Drupal\\Core\\Config\\Schema\\Mapping';
  $expected['definition_class'] = '\\Drupal\\Core\\TypedData\\MapDataDefinition';
  $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
    ->assertEqual($definition, $expected, '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
    ->assertEqual($definition, $expected, 'Retrieved the right metadata for the first effect of image.style.medium');
  $a = \Drupal::config('config_test.dynamic.third_party');
  $test = \Drupal::service('config.typed')
    ->get('config_test.dynamic.third_party')
    ->get('third_party_settings.config_schema_test');
  $definition = $test
    ->getDataDefinition()
    ->toArray();
  $expected = array();
  $expected['type'] = 'config_test.dynamic.*.third_party.config_schema_test';
  $expected['label'] = 'Mapping';
  $expected['class'] = '\\Drupal\\Core\\Config\\Schema\\Mapping';
  $expected['definition_class'] = '\\Drupal\\Core\\TypedData\\MapDataDefinition';
  $expected['mapping'] = [
    'integer' => [
      'type' => 'integer',
    ],
    'string' => [
      'type' => 'string',
    ],
  ];
  $this
    ->assertEqual($definition, $expected, '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 = array();
  $expected['label'] = 'Schema multiple filesystem marker test';
  $expected['class'] = '\\Drupal\\Core\\Config\\Schema\\Mapping';
  $expected['mapping']['langcode']['type'] = 'string';
  $expected['mapping']['langcode']['label'] = 'Language code';
  $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';
  $this
    ->assertEqual($definition, $expected, '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
    ->assertEqual($definition, $expected, 'Retrieved the right metadata for config_schema_test.someschema.somemodule.section_two.subsection');
}