class ConfigSchemaTest in Zircon Profile 8

Same name and namespace in other branches

8.0 core/modules/config/src/Tests/ConfigSchemaTest.php \Drupal\config\Tests\ConfigSchemaTest

Tests schema for configuration objects.

@group config

View source

class ConfigSchemaTest extends KernelTestBase {

  /**
   * Modules to enable.
   *
   * @var array
   */
  public static $modules = array(
    'system',
    'language',
    'field',
    'image',
    'config_test',
    'config_schema_test',
  );

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

  /**
   * Tests the basic metadata retrieval layer.
   */
  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');
  }

  /**
   * Tests metadata retrieval with several levels of %parent indirection.
   */
  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 = array(
      'type' => 'config_schema_test.someschema.with_parents.key_1',
      'label' => 'Test item nested one level',
      'class' => '\\Drupal\\Core\\TypedData\\Plugin\\DataType\\StringData',
      'definition_class' => '\\Drupal\\Core\\TypedData\\DataDefinition',
    );
    $this
      ->assertEqual($definition, $expected);

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

    // 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 = array(
      'type' => 'config_schema_test.someschema.with_parents.key_3',
      'label' => 'Test item nested three levels',
      'class' => '\\Drupal\\Core\\TypedData\\Plugin\\DataType\\StringData',
      'definition_class' => '\\Drupal\\Core\\TypedData\\DataDefinition',
    );
    $this
      ->assertEqual($definition, $expected);
  }

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

    // Try a simple property.
    $meta = \Drupal::service('config.typed')
      ->get('system.site');
    $property = $meta
      ->get('page')
      ->get('front');
    $this
      ->assertTrue($property instanceof StringInterface, 'Got the right wrapper fo the page.front property.');
    $this
      ->assertEqual($property
      ->getValue(), '/user/login', '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
      ->assertEqual(count($list), 3, 'Got a list with the right number of properties for site page data');
    $this
      ->assertTrue(isset($list['front']) && isset($list['403']) && isset($list['404']), 'Got a list with the right properties for site page data.');
    $this
      ->assertEqual($list['front']
      ->getValue(), '/user/login', 'Got the right value for page.front data from the list.');

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

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

  /**
   * Test configuration value data type enforcement using schemas.
   */
  public function testConfigSaveWithSchema() {
    $untyped_values = array(
      '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' => array(
        'string' => 1,
      ),
      'float' => '3.14',
      'null_float' => '',
      'sequence' => array(
        1,
        0,
        1,
      ),
      'sequence_bc' => array(
        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 = array(
      'string' => '1',
      'empty_string' => '',
      'null_string' => NULL,
      'integer' => 100,
      'null_integer' => NULL,
      'boolean' => TRUE,
      'no_type' => 1,
      'mapping' => array(
        'string' => '1',
      ),
      'float' => 3.14,
      'null_float' => NULL,
      'sequence' => array(
        TRUE,
        FALSE,
        TRUE,
      ),
      'sequence_bc' => array(
        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
      ->assertIdentical($this
      ->config('config_schema_test.schema_data_types')
      ->get(), $typed_values);

    // 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
      ->assertIdentical($this
      ->config('config_schema_test.no_schema_data_types')
      ->get(), $untyped_values);

    // 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 = drupal_get_path('module', 'config_schema_test');
    $install_storage = new FileStorage($extension_path . '/' . InstallStorage::CONFIG_INSTALL_DIRECTORY);
    $original_data = $install_storage
      ->read('config_schema_test.ignore');
    $this
      ->assertIdentical($this
      ->config('config_schema_test.ignore')
      ->get(), $original_data);
  }

  /**
   * Tests fallback to a greedy wildcard.
   */
  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 = array();
    $expected['label'] = 'Schema wildcard fallback test';
    $expected['class'] = '\\Drupal\\Core\\Config\\Schema\\Mapping';
    $expected['definition_class'] = '\\Drupal\\Core\\TypedData\\MapDataDefinition';
    $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.wildcard_fallback.*';
    $this
      ->assertEqual($definition, $expected, '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
      ->assertIdentical($definition, $definition2);
  }

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

  /**
   * 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);
    $message = 'Expected ConfigSchemaAlterException thrown.';
    try {
      $typed_config
        ->getDefinitions();
      $this
        ->fail($message);
    } catch (ConfigSchemaAlterException $e) {
      $this
        ->pass($message);
      $this
        ->assertEqual($e
        ->getMessage(), 'Invoking hook_config_schema_info_alter() has removed (config_schema_test.hook) schema definitions');
    }
    \Drupal::state()
      ->set('config_schema_test_exception_add', TRUE);
    $message = 'Expected ConfigSchemaAlterException thrown.';
    try {
      $typed_config
        ->getDefinitions();
      $this
        ->fail($message);
    } catch (ConfigSchemaAlterException $e) {
      $this
        ->pass($message);
      $this
        ->assertEqual($e
        ->getMessage(), 'Invoking hook_config_schema_info_alter() has added (config_schema_test.hook_added_defintion) and removed (config_schema_test.hook) schema definitions');
    }
    \Drupal::state()
      ->set('config_schema_test_exception_remove', FALSE);
    $message = 'Expected ConfigSchemaAlterException thrown.';
    try {
      $typed_config
        ->getDefinitions();
      $this
        ->fail($message);
    } catch (ConfigSchemaAlterException $e) {
      $this
        ->pass($message);
      $this
        ->assertEqual($e
        ->getMessage(), 'Invoking hook_config_schema_info_alter() has added (config_schema_test.hook_added_defintion) schema definitions');
    }

    // 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
      ->assertEqual($definitions['config_schema_test.hook']['additional_metadata'], 'new schema info');
  }

}

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.	2
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::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.
AssertHelperTrait::castSafeStrings	protected	function	Casts MarkupInterface objects into strings.
ConfigSchemaTest::$modules	public static	property	Modules to enable. Overrides KernelTestBase::$modules
ConfigSchemaTest::setUp	protected	function	Performs setup tasks before each individual test method is run. Overrides KernelTestBase::setUp
ConfigSchemaTest::testColonsInSchemaTypeDetermination		function	Tests use of colons in schema type determination.
ConfigSchemaTest::testConfigSaveWithSchema	public	function	Test configuration value data type enforcement using schemas.
ConfigSchemaTest::testConfigSchemaInfoAlter	public	function	Tests hook_config_schema_info_alter().
ConfigSchemaTest::testSchemaData		function	Tests metadata applied to configuration objects.
ConfigSchemaTest::testSchemaFallback		function	Tests fallback to a greedy wildcard.
ConfigSchemaTest::testSchemaMapping		function	Tests the basic metadata retrieval layer.
ConfigSchemaTest::testSchemaMappingWithParents		function	Tests metadata retrieval with several levels of %parent indirection.
KernelTestBase::$configDirectories	protected	property	The configuration directories for this test run.
KernelTestBase::$keyValueFactory	protected	property	A KeyValueMemoryFactory instance to use when building the container.
KernelTestBase::$moduleFiles	private	property
KernelTestBase::$streamWrappers	protected	property	Array of registered stream wrappers.
KernelTestBase::$themeFiles	private	property
KernelTestBase::beforePrepareEnvironment	protected	function	Act on global state information before the environment is altered for a test. Overrides TestBase::beforePrepareEnvironment
KernelTestBase::containerBuild	public	function	Sets up the base service container for this test.	12
KernelTestBase::defaultLanguageData	protected	function	Provides the data for setting the default language on the container.	1
KernelTestBase::disableModules	protected	function	Disables modules for this test.
KernelTestBase::enableModules	protected	function	Enables modules for this test.
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 a specific table from a module schema definition.
KernelTestBase::prepareConfigDirectories	protected	function	Create and set new configuration directories.	1
KernelTestBase::registerStreamWrapper	protected	function	Registers a stream wrapper for this test.
KernelTestBase::render	protected	function	Renders a render array.
KernelTestBase::tearDown	protected	function	Performs cleanup tasks after each individual test method has been run. Overrides TestBase::tearDown
KernelTestBase::__construct		function	Constructor for Test. Overrides TestBase::__construct
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.
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.
SessionTestTrait::$sessionName	protected	property	The name of the session cookie.
SessionTestTrait::generateSessionName	protected	function	Generates a session cookie name.
SessionTestTrait::getSessionName	protected	function	Returns the session name in use on the child site.
TestBase::$assertions	protected	property	Assertions thrown in that test case.
TestBase::$configImporter	protected	property	The config importer that can used in a test.	5
TestBase::$configSchemaCheckerExclusions	protected static	property	An array of config object names that are excluded from schema checking.
TestBase::$container	protected	property	The dependency injection container used in the test.
TestBase::$databasePrefix	protected	property	The database prefix of this test run.
TestBase::$dieOnFail	public	property	Whether to die in case any test assertion fails.
TestBase::$httpAuthCredentials	protected	property	HTTP authentication credentials (<username>:<password>).
TestBase::$httpAuthMethod	protected	property	HTTP authentication method (specified as a CURLAUTH_* constant).
TestBase::$kernel	protected	property	The DrupalKernel instance used in the test.	1
TestBase::$originalConf	protected	property	The original configuration (variables), if available.
TestBase::$originalConfig	protected	property	The original configuration (variables).
TestBase::$originalConfigDirectories	protected	property	The original configuration directories.
TestBase::$originalContainer	protected	property	The original container.
TestBase::$originalFileDirectory	protected	property	The original file directory, before it was changed for testing purposes.
TestBase::$originalLanguage	protected	property	The original language.
TestBase::$originalPrefix	protected	property	The original database prefix when running inside Simpletest.
TestBase::$originalProfile	protected	property	The original installation profile.
TestBase::$originalSessionName	protected	property	The name of the session cookie of the test-runner.
TestBase::$originalSettings	protected	property	The settings array.
TestBase::$originalShutdownCallbacks	protected	property	The original array of shutdown function callbacks.	1
TestBase::$originalSite	protected	property	The site directory of the original parent site.
TestBase::$originalUser	protected	property	The original user, before testing began.	1
TestBase::$privateFilesDirectory	protected	property	The private file directory for the test environment.
TestBase::$publicFilesDirectory	protected	property	The public file directory for the test environment.
TestBase::$results	public	property	Current results of this test case.
TestBase::$siteDirectory	protected	property	The site directory of this test run.
TestBase::$skipClasses	protected	property	This class is skipped when looking for the source of an assertion.
TestBase::$strictConfigSchema	protected	property	Set to TRUE to strict check all configuration saved.	4
TestBase::$tempFilesDirectory	protected	property	The temporary file directory for the test environment.
TestBase::$testId	protected	property	The test run ID.
TestBase::$timeLimit	protected	property	Time limit for the test.
TestBase::$translationFilesDirectory	protected	property	The translation file directory for the test environment.
TestBase::$verbose	public	property	TRUE if verbose debugging is enabled.
TestBase::$verboseClassName	protected	property	Safe class name for use in verbose output filenames.
TestBase::$verboseDirectory	protected	property	Directory where verbose output files are put.
TestBase::$verboseDirectoryUrl	protected	property	URL to the verbose output file directory.
TestBase::$verboseId	protected	property	Incrementing identifier for verbose output filenames.
TestBase::assert	protected	function	Internal helper: stores the assert.
TestBase::assertEqual	protected	function	Check to see if two values are equal.
TestBase::assertErrorLogged	protected	function	Asserts that a specific error has been logged to the PHP error log.
TestBase::assertFalse	protected	function	Check to see if a value is false.
TestBase::assertIdentical	protected	function	Check to see if two values are identical.
TestBase::assertIdenticalObject	protected	function	Checks to see if two objects are identical.
TestBase::assertNoErrorsLogged	protected	function	Asserts that no errors have been logged to the PHP error.log thus far.
TestBase::assertNotEqual	protected	function	Check to see if two values are not equal.
TestBase::assertNotIdentical	protected	function	Check to see if two values are not identical.
TestBase::assertNotNull	protected	function	Check to see if a value is not NULL.
TestBase::assertNull	protected	function	Check to see if a value is NULL.
TestBase::assertTrue	protected	function	Check to see if a value is not false.
TestBase::changeDatabasePrefix	private	function	Changes the database connection to the prefixed one.
TestBase::checkRequirements	protected	function	Checks the matching requirements for Test.	2
TestBase::config	protected	function	Configuration accessor for tests. Returns non-overridden configuration.
TestBase::configImporter	public	function	Returns a ConfigImporter object to import test importing of configuration.	5
TestBase::copyConfig	public	function	Copies configuration objects from source storage to target storage.
TestBase::deleteAssert	public static	function	Delete an assertion record by message ID.
TestBase::error	protected	function	Fire an error assertion.	3
TestBase::errorHandler	public	function	Handle errors during test runs.
TestBase::exceptionHandler	protected	function	Handle exceptions.
TestBase::fail	protected	function	Fire an assertion that is always negative.
TestBase::filePreDeleteCallback	public static	function	Ensures test files are deletable within file_unmanaged_delete_recursive().
TestBase::generatePermutations	public static	function	Converts a list of possible parameters into a stack of permutations.
TestBase::getAssertionCall	protected	function	Cycles through backtrace until the first non-assertion method is found.
TestBase::getConfigSchemaExclusions	protected	function	Gets the config schema exclusions for this test.
TestBase::getDatabaseConnection	public static	function	Returns the database connection to the site running Simpletest.
TestBase::getDatabasePrefix	public	function	Gets the database prefix.
TestBase::getTempFilesDirectory	public	function	Gets the temporary files directory.
TestBase::insertAssert	public static	function	Store an assertion from outside the testing context.
TestBase::pass	protected	function	Fire an assertion that is always positive.
TestBase::prepareDatabasePrefix	private	function	Generates a database prefix for running tests.
TestBase::prepareEnvironment	private	function	Prepares the current environment for running the test.
TestBase::restoreEnvironment	private	function	Cleans up the test environment and restores the original environment.
TestBase::run	public	function	Run all tests in this class.	1
TestBase::settingsSet	protected	function	Changes in memory settings.
TestBase::storeAssertion	protected	function	Helper method to store an assertion record in the configured database.
TestBase::verbose	protected	function	Logs a verbose message in a text file.

You are here

class ConfigSchemaTest in Zircon Profile 8

Hierarchy

File

Namespace

Members

API Navigation