SchemaConfigListenerTestTrait.php

<?php

declare (strict_types=1);
namespace Drupal\Tests\Traits\Core\Config;

use Drupal\Core\Config\Schema\SchemaIncompleteException;

/**
 * Adds a test for the configuration schema checker use in tests.
 */
trait SchemaConfigListenerTestTrait {
    
    /**
     * Tests \Drupal\Core\Config\Development\ConfigSchemaChecker.
     */
    public function testConfigSchemaChecker() : void {
        // Test a non-existing schema.
        $message = 'Expected SchemaIncompleteException thrown';
        try {
            $this->config('config_schema_test.schemaless')
                ->set('foo', 'bar')
                ->save();
            $this->fail($message);
        } catch (SchemaIncompleteException $e) {
            $this->assertEquals('No schema for config_schema_test.schemaless', $e->getMessage());
        }
        // Test a valid schema.
        $message = 'Unexpected SchemaIncompleteException thrown';
        $config = $this->config('config_test.types')
            ->set('int', 10);
        try {
            $config->save();
        } catch (SchemaIncompleteException $e) {
            $this->fail($message);
        }
        // Test a valid schema, where the value is accessed before saving. Ensures
        // that overridden data is correctly reset after casting.
        $message = 'Unexpected SchemaIncompleteException thrown';
        $config = $this->config('config_test.types')
            ->set('int', '10');
        $config->get('int');
        try {
            $config->save();
        } catch (SchemaIncompleteException $e) {
            $this->fail($message);
        }
        // Test an invalid schema.
        $message = 'Expected SchemaIncompleteException thrown';
        $config = $this->config('config_test.types')
            ->set('foo', 'bar')
            ->set('array', 1);
        try {
            $config->save();
            $this->fail($message);
        } catch (SchemaIncompleteException $e) {
            $this->assertEquals("Schema errors for config_test.types with the following errors: config_test.types:array variable type is integer but applied schema class is Drupal\\Core\\Config\\Schema\\Sequence, config_test.types:foo missing schema, 0 [foo] &#039;foo&#039; is not a supported key.", $e->getMessage());
        }
    }

}