function TypedConfigTest::testSimpleConfigValidation

Tests config validation via the Typed Data API.

File

core/tests/Drupal/KernelTests/Config/TypedConfigTest.php, line 147

Class

TypedConfigTest

Tests config validation mechanism.

Namespace

Code

public function testSimpleConfigValidation() : void {
    $config = \Drupal::configFactory()->getEditable('config_test.validation');
    
    /** @var \Drupal\Core\Config\TypedConfigManagerInterface $typed_config_manager */
    $typed_config_manager = \Drupal::service('config.typed');
    
    /** @var \Drupal\Core\Config\Schema\TypedConfigInterface $typed_config */
    $typed_config = $typed_config_manager->get('config_test.validation');
    $result = $typed_config->validate();
    $this->assertInstanceOf(ConstraintViolationListInterface::class, $result);
    $this->assertEmpty($result);
    // Test constraints on primitive types.
    $config->set('llama', 'elephant');
    $config->save();
    $typed_config = $typed_config_manager->get('config_test.validation');
    $result = $typed_config->validate();
    // Its not a valid llama anymore.
    $this->assertCount(1, $result);
    $this->assertEquals('no valid llama', $result->get(0)
        ->getMessage());
    // Test constraints on mapping.
    $config->set('llama', 'llama');
    $config->set('cat.type', 'nyans');
    $config->save();
    $typed_config = $typed_config_manager->get('config_test.validation');
    $result = $typed_config->validate();
    $this->assertEmpty($result);
    // Test constrains on nested mapping.
    $config->set('cat.type', 'tiger');
    $config->save();
    $typed_config = $typed_config_manager->get('config_test.validation');
    $result = $typed_config->validate();
    $this->assertCount(1, $result);
    $this->assertEquals('no valid cat', $result->get(0)
        ->getMessage());
    // Test constrains on sequences elements.
    $config->set('cat.type', 'nyans');
    $config->set('giraffe', [
        'muh',
        'hum2',
    ]);
    $config->save();
    $typed_config = $typed_config_manager->get('config_test.validation');
    $result = $typed_config->validate();
    $this->assertCount(1, $result);
    $this->assertEquals('Giraffes just hum', $result->get(0)
        ->getMessage());
    // Test constrains on the sequence itself.
    $config->set('giraffe', [
        'hum',
        'hum2',
        'invalid-key' => 'hum',
    ]);
    $config->save();
    $typed_config = $typed_config_manager->get('config_test.validation');
    $result = $typed_config->validate();
    $this->assertCount(1, $result);
    $this->assertEquals('giraffe', $result->get(0)
        ->getPropertyPath());
    $this->assertEquals('Invalid giraffe key.', $result->get(0)
        ->getMessage());
    // Validates mapping.
    $typed_config = $typed_config_manager->get('config_test.validation');
    $value = $typed_config->getValue();
    unset($value['giraffe']);
    $value['elephant'] = 'foo';
    $value['zebra'] = 'foo';
    $typed_config->setValue($value);
    $result = $typed_config->validate();
    $this->assertCount(3, $result);
    // 2 constraint violations triggered by the default validation constraint
    // for `type: mapping`
    // @see \Drupal\Core\Validation\Plugin\Validation\Constraint\ValidKeysConstraint
    $this->assertSame('elephant', $result->get(0)
        ->getPropertyPath());
    $this->assertEquals("'elephant' is not a supported key.", $result->get(0)
        ->getMessage());
    $this->assertSame('zebra', $result->get(1)
        ->getPropertyPath());
    $this->assertEquals("'zebra' is not a supported key.", $result->get(1)
        ->getMessage());
    // 1 additional constraint violation triggered by the custom
    // constraint for the `config_test.validation` type, which indirectly
    // extends `type: mapping` (via `type: config_object`).
    // @see \Drupal\config_test\ConfigValidation::validateMapping()
    $this->assertEquals('', $result->get(2)
        ->getPropertyPath());
    $this->assertEquals('Unexpected keys: elephant, zebra', $result->get(2)
        ->getMessage());
}