ComplexDataConstraintValidatorTest.php

<?php

declare (strict_types=1);
namespace Drupal\KernelTests\Core\TypedData;

use Drupal\Core\TypedData\DataDefinition;
use Drupal\Core\TypedData\MapDataDefinition;
use Drupal\KernelTests\KernelTestBase;

/**
 * Tests ComplexData validation with both valid and invalid values.
 *
 * @group Validation
 */
class ComplexDataConstraintValidatorTest extends KernelTestBase {
    
    /**
     * The typed data manager to use.
     *
     * @var \Drupal\Core\TypedData\TypedDataManager
     */
    protected $typedData;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->typedData = $this->container
            ->get('typed_data_manager');
    }
    
    /**
     * Tests the ComplexData validation constraint validator.
     *
     * For testing a map including a constraint on one of its keys is defined.
     */
    public function testValidation() : void {
        // Create a definition that specifies some ComplexData constraint.
        $definition = MapDataDefinition::create()->setPropertyDefinition('key', DataDefinition::create('integer'))
            ->addConstraint('ComplexData', [
            'key' => [
                'AllowedValues' => [
                    1,
                    2,
                    3,
                ],
            ],
        ]);
        // Test the validation.
        $typed_data = $this->typedData
            ->create($definition, [
            'key' => 1,
        ]);
        $violations = $typed_data->validate();
        $this->assertEquals(0, $violations->count(), 'Validation passed for correct value.');
        // Test the validation when an invalid value is passed.
        $typed_data = $this->typedData
            ->create($definition, [
            'key' => 4,
        ]);
        $violations = $typed_data->validate();
        $this->assertEquals(1, $violations->count(), 'Validation failed for incorrect value.');
        // Make sure the information provided by a violation is correct.
        $violation = $violations[0];
        $this->assertEquals('The value you selected is not a valid choice.', $violation->getMessage(), 'The message for invalid value is correct.');
        $this->assertEquals($typed_data, $violation->getRoot(), 'Violation root is correct.');
        $this->assertEquals(4, $violation->getInvalidValue(), 'The invalid value is set correctly in the violation.');
        // Test using the constraint with a map without the specified key. This
        // should be ignored as long as there is no NotNull or NotBlank constraint.
        $typed_data = $this->typedData
            ->create($definition, [
            'foo' => 'bar',
        ]);
        $violations = $typed_data->validate();
        $this->assertEquals(0, $violations->count(), 'Constraint on non-existing key is ignored.');
        $definition = MapDataDefinition::create()->setPropertyDefinition('key', DataDefinition::create('integer'))
            ->addConstraint('ComplexData', [
            'key' => [
                'NotNull' => [],
            ],
        ]);
        $typed_data = $this->typedData
            ->create($definition, [
            'foo' => 'bar',
        ]);
        $violations = $typed_data->validate();
        $this->assertEquals(1, $violations->count(), 'Key is required.');
    }

}