FieldValidationTest.php

<?php

declare (strict_types=1);
namespace Drupal\Tests\field\Kernel;

use PHPUnit\Framework\Attributes\Group;
use PHPUnit\Framework\Attributes\RunTestsInSeparateProcesses;

/**
 * Tests field validation.
 */
class FieldValidationTest extends FieldKernelTestBase {
  
  /**
   * @var string
   */
  private $entityType;
  
  /**
   * @var string
   */
  private $bundle;
  
  /**
   * @var \Drupal\Core\Entity\EntityInterface
   */
  private $entity;
  
  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();
    // Create a field and storage of type 'test_field', on the 'entity_test'
    // entity type.
    $this->entityType = 'entity_test';
    $this->bundle = 'entity_test';
    $this->createFieldWithStorage('', $this->entityType, $this->bundle);
    // Create an 'entity_test' entity.
    $this->entity = \Drupal::entityTypeManager()->getStorage($this->entityType)
      ->create([
      'type' => $this->bundle,
    ]);
  }
  
  /**
   * Tests that the number of values is validated against the field cardinality.
   */
  public function testCardinalityConstraint() : void {
    $cardinality = $this->fieldTestData->field_storage
      ->getCardinality();
    $entity = $this->entity;
    for ($delta = 0; $delta < $cardinality + 1; $delta++) {
      $entity->{$this->fieldTestData->field_name}[] = [
        'value' => 1,
      ];
    }
    // Validate the field.
    $violations = $entity->{$this->fieldTestData->field_name}
      ->validate();
    // Check that the expected constraint violations are reported.
    $this->assertCount(1, $violations);
    $this->assertEquals('', $violations[0]->getPropertyPath());
    $this->assertEquals(sprintf('%s: this field cannot hold more than %s values.', $this->fieldTestData->field
      ->getLabel(), $cardinality), $violations[0]->getMessage());
  }
  
  /**
   * Tests that constraints defined by the field type are validated.
   */
  public function testFieldConstraints() : void {
    $cardinality = $this->fieldTestData->field_storage
      ->getCardinality();
    $entity = $this->entity;
    // The test is only valid if the field cardinality is greater than 1.
    $this->assertGreaterThan(1, $cardinality);
    // Set up values for the field.
    $expected_violations = [];
    for ($delta = 0; $delta < $cardinality; $delta++) {
      // All deltas except '1' have incorrect values.
      if ($delta == 1) {
        $value = 1;
      }
      else {
        $value = -1;
        $expected_violations[$delta . '.value'][] = $this->fieldTestData->field
          ->getLabel() . ' does not accept the value -1.';
      }
      $entity->{$this->fieldTestData->field_name}[] = $value;
    }
    // Validate the field.
    $violations = $entity->{$this->fieldTestData->field_name}
      ->validate();
    // Check that the expected constraint violations are reported.
    $violations_by_path = [];
    foreach ($violations as $violation) {
      $violations_by_path[$violation->getPropertyPath()][] = $violation->getMessage();
    }
    $this->assertEquals($expected_violations, $violations_by_path);
  }

}