function ConfigSchemaTest::testSchemaMapping

Tests the basic metadata retrieval layer.

File

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

Class

ConfigSchemaTest

Tests schema for configuration objects.

Namespace

Code

public function testSchemaMapping() : void {
  // 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.no_schema'));
  $definition = \Drupal::service('config.typed')->getDefinition('config_schema_test.no_schema');
  $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.some_schema'));
  $definition = \Drupal::service('config.typed')->getDefinition('config_schema_test.some_schema');
  $expected = [];
  $expected['label'] = 'Schema test data';
  $expected['class'] = Mapping::class;
  $expected['mapping']['langcode']['type'] = 'langcode';
  $expected['mapping']['langcode']['requiredKey'] = FALSE;
  $expected['mapping']['_core']['type'] = '_core_config_info';
  $expected['mapping']['_core']['requiredKey'] = FALSE;
  $expected['mapping']['test_item'] = [
    'label' => 'Test item',
  ];
  $expected['mapping']['test_list'] = [
    'label' => 'Test list',
  ];
  $expected['type'] = 'config_schema_test.some_schema';
  $expected['definition_class'] = '\\Drupal\\Core\\TypedData\\MapDataDefinition';
  $expected['unwrap_for_canonical_representation'] = TRUE;
  $expected['constraints'] = [
    'ValidKeys' => '<infer>',
    'LangcodeRequiredIfTranslatableValues' => NULL,
  ];
  $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.some_schema');
  $definition = $config->get('test_item')
    ->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;
  $expected['requiredKey'] = TRUE;
  $this->assertEquals($expected, $definition, 'Automatic type detected for a scalar is undefined.');
  $definition = $config->get('test_list')
    ->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;
  $expected['requiredKey'] = 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'] = [
    'type' => 'langcode',
  ];
  $expected['mapping']['langcode']['requiredKey'] = FALSE;
  $expected['mapping']['_core']['type'] = '_core_config_info';
  $expected['mapping']['_core']['requiredKey'] = FALSE;
  $expected['type'] = 'system.maintenance';
  $expected['definition_class'] = '\\Drupal\\Core\\TypedData\\MapDataDefinition';
  $expected['unwrap_for_canonical_representation'] = TRUE;
  $expected['constraints'] = [
    'ValidKeys' => '<infer>',
    'FullyValidatable' => NULL,
    'LangcodeRequiredIfTranslatableValues' => NULL,
  ];
  $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' => 'langcode',
  ];
  $expected['mapping']['langcode']['requiredKey'] = FALSE;
  $expected['mapping']['_core']['type'] = '_core_config_info';
  $expected['mapping']['_core']['requiredKey'] = FALSE;
  $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' => 'weight',
  ];
  $expected['type'] = 'config_schema_test.ignore';
  $expected['unwrap_for_canonical_representation'] = TRUE;
  $expected['constraints'] = [
    'ValidKeys' => '<infer>',
    'LangcodeRequiredIfTranslatableValues' => NULL,
  ];
  $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;
  $expected['requiredKey'] = 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'] = 'machine_name';
  $expected['mapping']['uuid']['type'] = 'uuid';
  $expected['mapping']['uuid']['label'] = 'UUID';
  $expected['mapping']['langcode']['type'] = 'langcode';
  $expected['mapping']['status']['type'] = 'boolean';
  $expected['mapping']['status']['label'] = 'Status';
  $expected['mapping']['dependencies']['type'] = 'config_dependencies';
  $expected['mapping']['dependencies']['label'] = 'Dependencies';
  $expected['mapping']['label']['type'] = 'required_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']['id']['constraints'] = [
    'PluginExists' => [
      'manager' => 'plugin.manager.image.effect',
      'interface' => ImageEffectInterface::class,
    ],
  ];
  $expected['mapping']['effects']['sequence']['mapping']['data']['type'] = 'image.effect.[%parent.id]';
  $expected['mapping']['effects']['sequence']['mapping']['weight']['type'] = 'weight';
  $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']['third_party_settings']['requiredKey'] = FALSE;
  $expected['mapping']['_core']['type'] = '_core_config_info';
  $expected['mapping']['_core']['requiredKey'] = FALSE;
  $expected['type'] = 'image.style.*';
  $expected['constraints'] = [
    'ValidKeys' => '<infer>',
    'FullyValidatable' => NULL,
  ];
  $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']['width']['nullable'] = TRUE;
  $expected['mapping']['width']['constraints'] = [
    'NotBlank' => [
      'allowNull' => TRUE,
    ],
  ];
  $expected['mapping']['height']['type'] = 'integer';
  $expected['mapping']['height']['label'] = 'Height';
  $expected['mapping']['height']['nullable'] = TRUE;
  $expected['mapping']['height']['constraints'] = [
    'NotBlank' => [
      'allowNull' => TRUE,
    ],
  ];
  $expected['mapping']['upscale']['type'] = 'boolean';
  $expected['mapping']['upscale']['label'] = 'Upscale';
  $expected['type'] = 'image.effect.image_scale';
  $expected['constraints'] = [
    'ValidKeys' => '<infer>',
    'FullyValidatable' => NULL,
  ];
  $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';
  $expected['mapping']['width']['requiredKey'] = TRUE;
  $expected['mapping']['height']['requiredKey'] = TRUE;
  $expected['mapping']['upscale']['requiredKey'] = TRUE;
  $expected['requiredKey'] = TRUE;
  $expected['required'] = TRUE;
  $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',
      'requiredKey' => TRUE,
    ],
    'string' => [
      'type' => 'string',
      'requiredKey' => TRUE,
    ],
  ];
  $expected['constraints'] = [
    'ValidKeys' => '<infer>',
  ];
  $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.some_schema.some_module.section_one.subsection');
  // This should be the schema of
  // config_schema_test.some_schema.some_module.*.*.
  $expected = [];
  $expected['label'] = 'Schema multiple filesystem marker test';
  $expected['class'] = Mapping::class;
  $expected['mapping']['langcode']['type'] = 'langcode';
  $expected['mapping']['langcode']['requiredKey'] = FALSE;
  $expected['mapping']['_core']['type'] = '_core_config_info';
  $expected['mapping']['_core']['requiredKey'] = FALSE;
  $expected['mapping']['test_id']['type'] = 'string';
  $expected['mapping']['test_id']['label'] = 'ID';
  $expected['mapping']['test_description']['type'] = 'text';
  $expected['mapping']['test_description']['label'] = 'Description';
  $expected['type'] = 'config_schema_test.some_schema.some_module.*.*';
  $expected['definition_class'] = '\\Drupal\\Core\\TypedData\\MapDataDefinition';
  $expected['unwrap_for_canonical_representation'] = TRUE;
  $expected['constraints'] = [
    'ValidKeys' => '<infer>',
    'LangcodeRequiredIfTranslatableValues' => NULL,
  ];
  $this->assertEquals($expected, $definition, 'Retrieved the right metadata for config_schema_test.some_schema.some_module.section_one.subsection');
  $definition = \Drupal::service('config.typed')->getDefinition('config_schema_test.some_schema.some_module.section_two.subsection');
  // The other file should have the same schema.
  $this->assertEquals($expected, $definition, 'Retrieved the right metadata for config_schema_test.some_schema.some_module.section_two.subsection');
}