class TypedDataTest in Drupal 9

Tests the functionality of all core data types.

@group TypedData

Hierarchy

• class \Drupal\KernelTests\KernelTestBase extends \PHPUnit\Framework\TestCase implements ServiceProviderInterface uses \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, AssertContentTrait, AssertLegacyTrait, ConfigTestTrait, ExtensionListTestTrait, PhpUnitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait, PhpUnitWarnings
  • class \Drupal\KernelTests\Core\TypedData\TypedDataTest

File

core/tests/Drupal/KernelTests/Core/TypedData/TypedDataTest.php, line 27

Namespace

Drupal\KernelTests\Core\TypedData

class TypedDataTest extends KernelTestBase {

  /**
   * The typed data manager to use.
   *
   * @var \Drupal\Core\TypedData\TypedDataManager
   */
  protected $typedDataManager;

  /**
   * Modules to enable.
   *
   * @var array
   */
  protected static $modules = [
    'system',
    'field',
    'file',
    'user',
  ];
  protected function setUp() : void {
    parent::setUp();
    $this
      ->installEntitySchema('file');
    $this->typedDataManager = $this->container
      ->get('typed_data_manager');
  }

  /**
   * Creates a typed data object and ensures it implements TypedDataInterface.
   *
   * @see \Drupal\Core\TypedData\TypedDataManager::create()
   */
  protected function createTypedData($definition, $value = NULL, $name = NULL) {
    if (is_array($definition)) {
      $definition = DataDefinition::create($definition['type']);
    }
    $data = $this->typedDataManager
      ->create($definition, $value, $name);
    $this
      ->assertInstanceOf(TypedDataInterface::class, $data);
    return $data;
  }

  /**
   * Tests the basics around constructing and working with typed data objects.
   */
  public function testGetAndSet() {

    // Boolean type.
    $typed_data = $this
      ->createTypedData([
      'type' => 'boolean',
    ], TRUE);
    $this
      ->assertInstanceOf(BooleanInterface::class, $typed_data);
    $this
      ->assertTrue($typed_data
      ->getValue(), 'Boolean value was fetched.');
    $this
      ->assertEquals(0, $typed_data
      ->validate()
      ->count());
    $typed_data
      ->setValue(FALSE);
    $this
      ->assertFalse($typed_data
      ->getValue(), 'Boolean value was changed.');
    $this
      ->assertEquals(0, $typed_data
      ->validate()
      ->count());
    $this
      ->assertIsString($typed_data
      ->getString());
    $typed_data
      ->setValue(NULL);
    $this
      ->assertNull($typed_data
      ->getValue(), 'Boolean wrapper is null-able.');
    $this
      ->assertEquals(0, $typed_data
      ->validate()
      ->count());
    $typed_data
      ->setValue('invalid');
    $this
      ->assertEquals(1, $typed_data
      ->validate()
      ->count(), 'Validation detected invalid value.');

    // String type.
    $value = $this
      ->randomString();
    $typed_data = $this
      ->createTypedData([
      'type' => 'string',
    ], $value);
    $this
      ->assertInstanceOf(StringInterface::class, $typed_data);
    $this
      ->assertSame($value, $typed_data
      ->getValue(), 'String value was fetched.');
    $this
      ->assertEquals(0, $typed_data
      ->validate()
      ->count());
    $new_value = $this
      ->randomString();
    $typed_data
      ->setValue($new_value);
    $this
      ->assertSame($new_value, $typed_data
      ->getValue(), 'String value was changed.');
    $this
      ->assertEquals(0, $typed_data
      ->validate()
      ->count());

    // Funky test.
    $this
      ->assertIsString($typed_data
      ->getString());
    $typed_data
      ->setValue(NULL);
    $this
      ->assertNull($typed_data
      ->getValue(), 'String wrapper is null-able.');
    $this
      ->assertEquals(0, $typed_data
      ->validate()
      ->count());
    $typed_data
      ->setValue([
      'no string',
    ]);
    $this
      ->assertEquals(1, $typed_data
      ->validate()
      ->count(), 'Validation detected invalid value.');

    // Integer type.
    $value = rand();
    $typed_data = $this
      ->createTypedData([
      'type' => 'integer',
    ], $value);
    $this
      ->assertInstanceOf(IntegerInterface::class, $typed_data);
    $this
      ->assertSame($value, $typed_data
      ->getValue(), 'Integer value was fetched.');
    $this
      ->assertEquals(0, $typed_data
      ->validate()
      ->count());
    $new_value = rand();
    $typed_data
      ->setValue($new_value);
    $this
      ->assertSame($new_value, $typed_data
      ->getValue(), 'Integer value was changed.');
    $this
      ->assertIsString($typed_data
      ->getString());
    $this
      ->assertEquals(0, $typed_data
      ->validate()
      ->count());
    $typed_data
      ->setValue(NULL);
    $this
      ->assertNull($typed_data
      ->getValue(), 'Integer wrapper is null-able.');
    $this
      ->assertEquals(0, $typed_data
      ->validate()
      ->count());
    $typed_data
      ->setValue('invalid');
    $this
      ->assertEquals(1, $typed_data
      ->validate()
      ->count(), 'Validation detected invalid value.');

    // Float type.
    $value = 123.45;
    $typed_data = $this
      ->createTypedData([
      'type' => 'float',
    ], $value);
    $this
      ->assertInstanceOf(FloatInterface::class, $typed_data);
    $this
      ->assertSame($value, $typed_data
      ->getValue(), 'Float value was fetched.');
    $this
      ->assertEquals(0, $typed_data
      ->validate()
      ->count());
    $new_value = 678.9;
    $typed_data
      ->setValue($new_value);
    $this
      ->assertSame($new_value, $typed_data
      ->getValue(), 'Float value was changed.');
    $this
      ->assertIsString($typed_data
      ->getString());
    $this
      ->assertEquals(0, $typed_data
      ->validate()
      ->count());
    $typed_data
      ->setValue(NULL);
    $this
      ->assertNull($typed_data
      ->getValue(), 'Float wrapper is null-able.');
    $this
      ->assertEquals(0, $typed_data
      ->validate()
      ->count());
    $typed_data
      ->setValue('invalid');
    $this
      ->assertEquals(1, $typed_data
      ->validate()
      ->count(), 'Validation detected invalid value.');

    // Date Time type; values with timezone offset.
    $value = '2014-01-01T20:00:00+00:00';
    $typed_data = $this
      ->createTypedData([
      'type' => 'datetime_iso8601',
    ], $value);
    $this
      ->assertInstanceOf(DateTimeInterface::class, $typed_data);
    $this
      ->assertSame($value, $typed_data
      ->getValue());
    $this
      ->assertEquals($typed_data
      ->getDateTime()
      ->format('c'), $typed_data
      ->getValue(), 'Value representation of a date is ISO 8601');
    $this
      ->assertSame('+00:00', $typed_data
      ->getDateTime()
      ->getTimezone()
      ->getName());
    $this
      ->assertEquals(0, $typed_data
      ->validate()
      ->count());
    $new_value = '2014-01-02T20:00:00+00:00';
    $typed_data
      ->setValue($new_value);
    $this
      ->assertSame($new_value, $typed_data
      ->getDateTime()
      ->format('c'), 'Date value was changed and set by an ISO8601 date.');
    $this
      ->assertEquals(0, $typed_data
      ->validate()
      ->count());
    $this
      ->assertSame('2014-01-02', $typed_data
      ->getDateTime()
      ->format('Y-m-d'), 'Date value was changed and set by date string.');
    $this
      ->assertSame('+00:00', $typed_data
      ->getDateTime()
      ->getTimezone()
      ->getName());
    $this
      ->assertEquals(0, $typed_data
      ->validate()
      ->count());
    $typed_data
      ->setValue(NULL);
    $this
      ->assertNull($typed_data
      ->getDateTime(), 'Date wrapper is null-able.');
    $this
      ->assertEquals(0, $typed_data
      ->validate()
      ->count());
    $typed_data
      ->setValue('invalid');
    $this
      ->assertEquals(1, $typed_data
      ->validate()
      ->count(), 'Validation detected invalid value.');

    // Check implementation of DateTimeInterface.
    $typed_data = $this
      ->createTypedData([
      'type' => 'datetime_iso8601',
    ], '2014-01-01T20:00:00+00:00');
    $this
      ->assertInstanceOf(DrupalDateTime::class, $typed_data
      ->getDateTime());
    $this
      ->assertSame('+00:00', $typed_data
      ->getDateTime()
      ->getTimezone()
      ->getName());
    $typed_data
      ->setDateTime(new DrupalDateTime('2014-01-02T20:00:00+00:00'));
    $this
      ->assertSame('+00:00', $typed_data
      ->getDateTime()
      ->getTimezone()
      ->getName());
    $this
      ->assertEquals('2014-01-02T20:00:00+00:00', $typed_data
      ->getValue());
    $typed_data
      ->setValue(NULL);
    $this
      ->assertNull($typed_data
      ->getDateTime());

    // Date Time type; values without timezone offset.
    $value = '2014-01-01T20:00';
    $typed_data = $this
      ->createTypedData([
      'type' => 'datetime_iso8601',
    ], $value);
    $this
      ->assertInstanceOf(DateTimeInterface::class, $typed_data);
    $this
      ->assertSame($value, $typed_data
      ->getValue(), 'Date value was fetched.');

    // @todo Uncomment this assertion in https://www.drupal.org/project/drupal/issues/2716891.
    // $this->assertEquals($typed_data->getDateTime()->format('c'), $typed_data->getValue(), 'Value representation of a date is ISO 8601');
    $this
      ->assertSame('UTC', $typed_data
      ->getDateTime()
      ->getTimezone()
      ->getName());
    $this
      ->assertEquals(0, $typed_data
      ->validate()
      ->count());
    $new_value = '2014-01-02T20:00';
    $typed_data
      ->setValue($new_value);

    // @todo Uncomment this assertion in https://www.drupal.org/project/drupal/issues/2716891.
    // $this->assertTrue($typed_data->getDateTime()->format('c') === $new_value, 'Date value was changed and set by an ISO8601 date.');
    $this
      ->assertEquals(0, $typed_data
      ->validate()
      ->count());
    $this
      ->assertSame('2014-01-02', $typed_data
      ->getDateTime()
      ->format('Y-m-d'), 'Date value was changed and set by date string.');
    $this
      ->assertSame('UTC', $typed_data
      ->getDateTime()
      ->getTimezone()
      ->getName());
    $this
      ->assertEquals(0, $typed_data
      ->validate()
      ->count());
    $typed_data
      ->setValue(NULL);
    $this
      ->assertNull($typed_data
      ->getDateTime(), 'Date wrapper is null-able.');
    $this
      ->assertEquals(0, $typed_data
      ->validate()
      ->count());
    $typed_data
      ->setValue('invalid');
    $this
      ->assertEquals(1, $typed_data
      ->validate()
      ->count(), 'Validation detected invalid value.');

    // Check implementation of DateTimeInterface.
    $typed_data = $this
      ->createTypedData([
      'type' => 'datetime_iso8601',
    ], '2014-01-01T20:00:00');
    $this
      ->assertInstanceOf(DrupalDateTime::class, $typed_data
      ->getDateTime());
    $this
      ->assertSame('UTC', $typed_data
      ->getDateTime()
      ->getTimezone()
      ->getName());

    // When setting datetime without a timezone offset, the default timezone is
    // used (Australia/Sydney). DateTimeIso8601::setDateTime() converts this
    // DrupalDateTime object to a string using ::format('c'), it gets converted
    // to an offset. The offset for Australia/Sydney is +11:00.
    $typed_data
      ->setDateTime(new DrupalDateTime('2014-01-02T20:00:00'));
    $this
      ->assertSame('+11:00', $typed_data
      ->getDateTime()
      ->getTimezone()
      ->getName());
    $this
      ->assertEquals('2014-01-02T20:00:00+11:00', $typed_data
      ->getValue());
    $typed_data
      ->setValue(NULL);
    $this
      ->assertNull($typed_data
      ->getDateTime());

    // Timestamp type.
    $value = REQUEST_TIME;
    $typed_data = $this
      ->createTypedData([
      'type' => 'timestamp',
    ], $value);
    $this
      ->assertInstanceOf(DateTimeInterface::class, $typed_data);
    $this
      ->assertSame($typed_data
      ->getValue(), $value, 'Timestamp value was fetched.');
    $this
      ->assertEquals(0, $typed_data
      ->validate()
      ->count());
    $new_value = REQUEST_TIME + 1;
    $typed_data
      ->setValue($new_value);
    $this
      ->assertSame($typed_data
      ->getValue(), $new_value, 'Timestamp value was changed and set.');
    $this
      ->assertEquals(0, $typed_data
      ->validate()
      ->count());
    $typed_data
      ->setValue(NULL);
    $this
      ->assertNull($typed_data
      ->getDateTime(), 'Timestamp wrapper is null-able.');
    $this
      ->assertEquals(0, $typed_data
      ->validate()
      ->count());
    $typed_data
      ->setValue('invalid');
    $this
      ->assertEquals(1, $typed_data
      ->validate()
      ->count(), 'Validation detected invalid value.');

    // Check implementation of DateTimeInterface.
    $typed_data = $this
      ->createTypedData([
      'type' => 'timestamp',
    ], REQUEST_TIME);
    $this
      ->assertInstanceOf(DrupalDateTime::class, $typed_data
      ->getDateTime());
    $typed_data
      ->setDateTime(DrupalDateTime::createFromTimestamp(REQUEST_TIME + 1));
    $this
      ->assertEquals(REQUEST_TIME + 1, $typed_data
      ->getValue());
    $typed_data
      ->setValue(NULL);
    $this
      ->assertNull($typed_data
      ->getDateTime());

    // DurationIso8601 type.
    $value = 'PT20S';
    $typed_data = $this
      ->createTypedData([
      'type' => 'duration_iso8601',
    ], $value);
    $this
      ->assertInstanceOf(DurationInterface::class, $typed_data);
    $this
      ->assertSame($value, $typed_data
      ->getValue(), 'DurationIso8601 value was fetched.');
    $this
      ->assertEquals(0, $typed_data
      ->validate()
      ->count());
    $typed_data
      ->setValue('P40D');
    $this
      ->assertEquals(40, $typed_data
      ->getDuration()->d, 'DurationIso8601 value was changed and set by duration string.');
    $this
      ->assertIsString($typed_data
      ->getString());
    $this
      ->assertEquals(0, $typed_data
      ->validate()
      ->count());
    $typed_data
      ->setValue(NULL);
    $this
      ->assertNull($typed_data
      ->getValue(), 'DurationIso8601 wrapper is null-able.');
    $this
      ->assertEquals(0, $typed_data
      ->validate()
      ->count());
    $typed_data
      ->setValue('invalid');
    $this
      ->assertEquals(1, $typed_data
      ->validate()
      ->count(), 'Validation detected invalid value.');

    // Check implementation of DurationInterface.
    $typed_data = $this
      ->createTypedData([
      'type' => 'duration_iso8601',
    ], 'PT20S');
    $this
      ->assertInstanceOf(\DateInterval::class, $typed_data
      ->getDuration());
    $typed_data
      ->setDuration(new \DateInterval('P40D'));

    // @todo: Should we make this "nicer"?
    $this
      ->assertEquals('P0Y0M40DT0H0M0S', $typed_data
      ->getValue());
    $typed_data
      ->setValue(NULL);
    $this
      ->assertNull($typed_data
      ->getDuration());

    // Time span type.
    $value = 20;
    $typed_data = $this
      ->createTypedData([
      'type' => 'timespan',
    ], $value);
    $this
      ->assertInstanceOf(DurationInterface::class, $typed_data);
    $this
      ->assertSame($value, $typed_data
      ->getValue(), 'Time span value was fetched.');
    $this
      ->assertEquals(0, $typed_data
      ->validate()
      ->count());
    $typed_data
      ->setValue(60 * 60 * 4);
    $this
      ->assertEquals(14400, $typed_data
      ->getDuration()->s, 'Time span was changed');
    $this
      ->assertIsString($typed_data
      ->getString());
    $this
      ->assertEquals(0, $typed_data
      ->validate()
      ->count());
    $typed_data
      ->setValue(NULL);
    $this
      ->assertNull($typed_data
      ->getValue(), 'Time span wrapper is null-able.');
    $this
      ->assertEquals(0, $typed_data
      ->validate()
      ->count());
    $typed_data
      ->setValue('invalid');
    $this
      ->assertEquals(1, $typed_data
      ->validate()
      ->count(), 'Validation detected invalid value.');

    // Check implementation of DurationInterface.
    $typed_data = $this
      ->createTypedData([
      'type' => 'timespan',
    ], 20);
    $this
      ->assertInstanceOf(\DateInterval::class, $typed_data
      ->getDuration());
    $typed_data
      ->setDuration(new \DateInterval('PT4H'));
    $this
      ->assertEquals(60 * 60 * 4, $typed_data
      ->getValue());
    $typed_data
      ->setValue(NULL);
    $this
      ->assertNull($typed_data
      ->getDuration());

    // URI type.
    $uri = 'http://example.com/foo/';
    $typed_data = $this
      ->createTypedData([
      'type' => 'uri',
    ], $uri);
    $this
      ->assertInstanceOf(UriInterface::class, $typed_data);
    $this
      ->assertSame($uri, $typed_data
      ->getValue(), 'URI value was fetched.');
    $this
      ->assertEquals(0, $typed_data
      ->validate()
      ->count());
    $typed_data
      ->setValue($uri . 'bar.txt');
    $this
      ->assertSame($uri . 'bar.txt', $typed_data
      ->getValue(), 'URI value was changed.');
    $this
      ->assertIsString($typed_data
      ->getString());
    $this
      ->assertEquals(0, $typed_data
      ->validate()
      ->count());
    $typed_data
      ->setValue(NULL);
    $this
      ->assertNull($typed_data
      ->getValue(), 'URI wrapper is null-able.');
    $this
      ->assertEquals(0, $typed_data
      ->validate()
      ->count());
    $typed_data
      ->setValue('invalid');
    $this
      ->assertEquals(1, $typed_data
      ->validate()
      ->count(), 'Validation detected invalid value.');
    $typed_data
      ->setValue('public://field/image/Photo on 4-28-14 at 12.01 PM.jpg');
    $this
      ->assertEquals(0, $typed_data
      ->validate()
      ->count(), 'Filename with spaces is valid.');

    // Generate some files that will be used to test the binary data type.
    $files = [];
    for ($i = 0; $i < 3; $i++) {
      $path = "public://example_{$i}.png";
      \Drupal::service('file_system')
        ->copy($this->root . '/core/misc/druplicon.png', $path);
      $image = File::create([
        'uri' => $path,
      ]);
      $image
        ->save();
      $files[] = $image;
    }

    // Email type.
    $value = $this
      ->randomString();
    $typed_data = $this
      ->createTypedData([
      'type' => 'email',
    ], $value);
    $this
      ->assertInstanceOf(StringInterface::class, $typed_data);
    $this
      ->assertSame($value, $typed_data
      ->getValue(), 'Email value was fetched.');
    $new_value = '[e-mail]';
    $typed_data
      ->setValue($new_value);
    $this
      ->assertSame($new_value, $typed_data
      ->getValue(), 'Email value was changed.');
    $this
      ->assertIsString($typed_data
      ->getString());
    $this
      ->assertEquals(0, $typed_data
      ->validate()
      ->count());
    $typed_data
      ->setValue(NULL);
    $this
      ->assertNull($typed_data
      ->getValue(), 'Email wrapper is null-able.');
    $this
      ->assertEquals(0, $typed_data
      ->validate()
      ->count());
    $typed_data
      ->setValue('invalidATexample.com');
    $this
      ->assertEquals(1, $typed_data
      ->validate()
      ->count(), 'Validation detected invalid value.');

    // Binary type.
    $typed_data = $this
      ->createTypedData([
      'type' => 'binary',
    ], $files[0]
      ->getFileUri());
    $this
      ->assertInstanceOf(BinaryInterface::class, $typed_data);
    $this
      ->assertIsResource($typed_data
      ->getValue());
    $this
      ->assertEquals(0, $typed_data
      ->validate()
      ->count());

    // Try setting by URI.
    $typed_data
      ->setValue($files[1]
      ->getFileUri());
    $this
      ->assertEquals(fgets(fopen($files[1]
      ->getFileUri(), 'r')), fgets($typed_data
      ->getValue()), 'Binary value was changed.');
    $this
      ->assertIsString($typed_data
      ->getString());
    $this
      ->assertEquals(0, $typed_data
      ->validate()
      ->count());

    // Try setting by resource.
    $typed_data
      ->setValue(fopen($files[2]
      ->getFileUri(), 'r'));
    $this
      ->assertEquals(fgets($typed_data
      ->getValue()), fgets(fopen($files[2]
      ->getFileUri(), 'r')), 'Binary value was changed.');
    $this
      ->assertIsString($typed_data
      ->getString());
    $this
      ->assertEquals(0, $typed_data
      ->validate()
      ->count());
    $typed_data
      ->setValue(NULL);
    $this
      ->assertNull($typed_data
      ->getValue(), 'Binary wrapper is null-able.');
    $this
      ->assertEquals(0, $typed_data
      ->validate()
      ->count());
    $typed_data
      ->setValue('invalid');
    $this
      ->assertEquals(1, $typed_data
      ->validate()
      ->count(), 'Validation detected invalid value.');

    // Any type.
    $value = [
      'foo',
    ];
    $typed_data = $this
      ->createTypedData([
      'type' => 'any',
    ], $value);
    $this
      ->assertSame($value, $typed_data
      ->getValue(), 'Any value was fetched.');
    $new_value = '[e-mail]';
    $typed_data
      ->setValue($new_value);
    $this
      ->assertSame($new_value, $typed_data
      ->getValue(), 'Any value was changed.');
    $this
      ->assertIsString($typed_data
      ->getString());
    $this
      ->assertEquals(0, $typed_data
      ->validate()
      ->count());
    $typed_data
      ->setValue(NULL);
    $this
      ->assertNull($typed_data
      ->getValue(), 'Any wrapper is null-able.');
    $this
      ->assertEquals(0, $typed_data
      ->validate()
      ->count());

    // We cannot test invalid values as everything is valid for the any type,
    // but make sure an array or object value passes validation also.
    $typed_data
      ->setValue([
      'entry',
    ]);
    $this
      ->assertEquals(0, $typed_data
      ->validate()
      ->count());
    $typed_data
      ->setValue((object) [
      'entry',
    ]);
    $this
      ->assertEquals(0, $typed_data
      ->validate()
      ->count());
  }

  /**
   * Tests using typed data lists.
   */
  public function testTypedDataLists() {

    // Test working with an existing list of strings.
    $value = [
      'one',
      'two',
      'three',
    ];
    $typed_data = $this
      ->createTypedData(ListDataDefinition::create('string'), $value);
    $this
      ->assertEquals($value, $typed_data
      ->getValue(), 'List value has been set.');

    // Test iterating.
    $count = 0;
    foreach ($typed_data as $item) {
      $this
        ->assertInstanceOf(TypedDataInterface::class, $item);
      $count++;
    }
    $this
      ->assertEquals(3, $count);

    // Test getting the string representation.
    $this
      ->assertEquals('one, two, three', $typed_data
      ->getString());
    $typed_data[1] = '';
    $this
      ->assertEquals('one, three', $typed_data
      ->getString());

    // Test using array access.
    $this
      ->assertEquals('one', $typed_data[0]
      ->getValue());
    $typed_data[] = 'four';
    $this
      ->assertEquals('four', $typed_data[3]
      ->getValue());
    $this
      ->assertEquals(4, $typed_data
      ->count());
    $this
      ->assertTrue(isset($typed_data[0]));
    $this
      ->assertTrue(!isset($typed_data[6]));

    // Test isEmpty and cloning.
    $this
      ->assertFalse($typed_data
      ->isEmpty());
    $clone = clone $typed_data;
    $this
      ->assertSame($typed_data
      ->getValue(), $clone
      ->getValue());
    $this
      ->assertNotSame($typed_data[0], $clone[0]);
    $clone
      ->setValue([]);
    $this
      ->assertTrue($clone
      ->isEmpty());

    // Make sure that resetting the value using NULL results in an empty array.
    $clone
      ->setValue([]);
    $typed_data
      ->setValue(NULL);
    $this
      ->assertSame([], $typed_data
      ->getValue());
    $this
      ->assertSame([], $clone
      ->getValue());

    // Test dealing with NULL items.
    $typed_data[] = NULL;
    $this
      ->assertTrue($typed_data
      ->isEmpty());
    $this
      ->assertCount(1, $typed_data);
    $typed_data[] = '';
    $this
      ->assertFalse($typed_data
      ->isEmpty());
    $this
      ->assertCount(2, $typed_data);
    $typed_data[] = 'three';
    $this
      ->assertFalse($typed_data
      ->isEmpty());
    $this
      ->assertCount(3, $typed_data);
    $this
      ->assertEquals([
      NULL,
      '',
      'three',
    ], $typed_data
      ->getValue());

    // Test unsetting.
    unset($typed_data[1]);
    $this
      ->assertCount(2, $typed_data);

    // Check that items were shifted.
    $this
      ->assertEquals('three', $typed_data[1]
      ->getValue());

    // Getting a not set list item returns NULL, and does not create a new item.
    $this
      ->assertNull($typed_data[2]);
    $this
      ->assertCount(2, $typed_data);

    // Test setting the list with less values.
    $typed_data
      ->setValue([
      'one',
    ]);
    $this
      ->assertEquals(1, $typed_data
      ->count());

    // Test setting invalid values.
    try {
      $typed_data
        ->setValue('string');
      $this
        ->fail('No exception has been thrown when setting an invalid value.');
    } catch (\Exception $e) {

      // Expected exception; just continue testing.
    }
  }

  /**
   * Tests the filter() method on typed data lists.
   */
  public function testTypedDataListsFilter() {

    // Check that an all-pass filter leaves the list untouched.
    $value = [
      'zero',
      'one',
    ];
    $typed_data = $this
      ->createTypedData(ListDataDefinition::create('string'), $value);
    $typed_data
      ->filter(function (TypedDataInterface $item) {
      return TRUE;
    });
    $this
      ->assertEquals(2, $typed_data
      ->count());
    $this
      ->assertEquals('zero', $typed_data[0]
      ->getValue());
    $this
      ->assertEquals(0, $typed_data[0]
      ->getName());
    $this
      ->assertEquals('one', $typed_data[1]
      ->getValue());
    $this
      ->assertEquals(1, $typed_data[1]
      ->getName());

    // Check that a none-pass filter empties the list.
    $value = [
      'zero',
      'one',
    ];
    $typed_data = $this
      ->createTypedData(ListDataDefinition::create('string'), $value);
    $typed_data
      ->filter(function (TypedDataInterface $item) {
      return FALSE;
    });
    $this
      ->assertEquals(0, $typed_data
      ->count());

    // Check that filtering correctly renumbers elements.
    $value = [
      'zero',
      'one',
      'two',
    ];
    $typed_data = $this
      ->createTypedData(ListDataDefinition::create('string'), $value);
    $typed_data
      ->filter(function (TypedDataInterface $item) {
      return $item
        ->getValue() !== 'one';
    });
    $this
      ->assertEquals(2, $typed_data
      ->count());
    $this
      ->assertEquals('zero', $typed_data[0]
      ->getValue());
    $this
      ->assertEquals(0, $typed_data[0]
      ->getName());
    $this
      ->assertEquals('two', $typed_data[1]
      ->getValue());
    $this
      ->assertEquals(1, $typed_data[1]
      ->getName());
  }

  /**
   * Tests using a typed data map.
   */
  public function testTypedDataMaps() {

    // Test working with a simple map.
    $value = [
      'one' => 'eins',
      'two' => 'zwei',
      'three' => 'drei',
    ];
    $definition = MapDataDefinition::create()
      ->setPropertyDefinition('one', DataDefinition::create('string'))
      ->setPropertyDefinition('two', DataDefinition::create('string'))
      ->setPropertyDefinition('three', DataDefinition::create('string'));
    $typed_data = $this
      ->createTypedData($definition, $value);

    // Test iterating.
    $count = 0;
    foreach ($typed_data as $item) {
      $this
        ->assertInstanceOf(TypedDataInterface::class, $item);
      $count++;
    }
    $this
      ->assertEquals(3, $count);

    // Test retrieving metadata.
    $this
      ->assertEquals(array_keys($value), array_keys($typed_data
      ->getDataDefinition()
      ->getPropertyDefinitions()));
    $definition = $typed_data
      ->getDataDefinition()
      ->getPropertyDefinition('one');
    $this
      ->assertEquals('string', $definition
      ->getDataType());
    $this
      ->assertNull($typed_data
      ->getDataDefinition()
      ->getPropertyDefinition('invalid'));

    // Test getting and setting properties.
    $this
      ->assertEquals('eins', $typed_data
      ->get('one')
      ->getValue());
    $this
      ->assertEquals($value, $typed_data
      ->toArray());
    $typed_data
      ->set('one', 'uno');
    $this
      ->assertEquals('uno', $typed_data
      ->get('one')
      ->getValue());

    // Make sure the update is reflected in the value of the map also.
    $value = $typed_data
      ->getValue();
    $this
      ->assertEquals([
      'one' => 'uno',
      'two' => 'zwei',
      'three' => 'drei',
    ], $value);
    $properties = $typed_data
      ->getProperties();
    $this
      ->assertEquals(array_keys($value), array_keys($properties));
    $this
      ->assertSame($typed_data
      ->get('one'), $properties['one'], 'Properties are identical.');

    // Test setting a not defined property. It shouldn't show up in the
    // properties, but be kept in the values.
    $typed_data
      ->setValue([
      'foo' => 'bar',
    ]);
    $this
      ->assertEquals([
      'one',
      'two',
      'three',
    ], array_keys($typed_data
      ->getProperties()));
    $this
      ->assertEquals([
      'foo',
      'one',
      'two',
      'three',
    ], array_keys($typed_data
      ->getValue()));

    // Test getting the string representation.
    $typed_data
      ->setValue([
      'one' => 'eins',
      'two' => '',
      'three' => 'drei',
    ]);
    $this
      ->assertEquals('eins, drei', $typed_data
      ->getString());

    // Test isEmpty and cloning.
    $this
      ->assertFalse($typed_data
      ->isEmpty());
    $clone = clone $typed_data;
    $this
      ->assertSame($typed_data
      ->getValue(), $clone
      ->getValue());
    $this
      ->assertNotSame($typed_data
      ->get('one'), $clone
      ->get('one'));
    $clone
      ->setValue([]);
    $this
      ->assertTrue($clone
      ->isEmpty());

    // Make sure the difference between NULL (not set) and an empty array is
    // kept.
    $typed_data
      ->setValue(NULL);
    $this
      ->assertNull($typed_data
      ->getValue());
    $typed_data
      ->setValue([]);
    $value = $typed_data
      ->getValue();
    $this
      ->assertIsArray($value);

    // Test accessing invalid properties.
    $typed_data
      ->setValue($value);
    try {
      $typed_data
        ->get('invalid');
      $this
        ->fail('No exception has been thrown when getting an invalid value.');
    } catch (\Exception $e) {

      // Expected exception; just continue testing.
    }

    // Test setting invalid values.
    try {
      $typed_data
        ->setValue('invalid');
      $this
        ->fail('No exception has been thrown when setting an invalid value.');
    } catch (\Exception $e) {

      // Expected exception; just continue testing.
    }

    // Test adding a new property to the map.
    $typed_data
      ->getDataDefinition()
      ->setPropertyDefinition('zero', DataDefinition::create('any'));
    $typed_data
      ->set('zero', 'null');
    $this
      ->assertEquals('null', $typed_data
      ->get('zero')
      ->getValue());
    $definition = $typed_data
      ->get('zero')
      ->getDataDefinition();
    $this
      ->assertEquals('any', $definition
      ->getDataType(), 'Definition for a new map entry returned.');
  }

  /**
   * Tests typed data validation.
   */
  public function testTypedDataValidation() {
    $definition = DataDefinition::create('integer')
      ->setConstraints([
      'Range' => [
        'min' => 5,
      ],
    ]);
    $violations = $this->typedDataManager
      ->create($definition, 10)
      ->validate();
    $this
      ->assertEquals(0, $violations
      ->count());
    $integer = $this->typedDataManager
      ->create($definition, 1);
    $violations = $integer
      ->validate();
    $this
      ->assertEquals(1, $violations
      ->count());

    // Test translating violation messages.
    $message = t('This value should be %limit or more.', [
      '%limit' => 5,
    ]);
    $this
      ->assertEquals($message, $violations[0]
      ->getMessage(), 'Translated violation message retrieved.');
    $this
      ->assertEquals('', $violations[0]
      ->getPropertyPath());
    $this
      ->assertSame($integer, $violations[0]
      ->getRoot(), 'Root object returned.');

    // Test translating violation messages when pluralization is used.
    $definition = DataDefinition::create('string')
      ->setConstraints([
      'Length' => [
        'min' => 10,
        'allowEmptyString' => FALSE,
      ],
    ]);
    $violations = $this->typedDataManager
      ->create($definition, "short")
      ->validate();
    $this
      ->assertEquals(1, $violations
      ->count());
    $message = t('This value is too short. It should have %limit characters or more.', [
      '%limit' => 10,
    ]);
    $this
      ->assertEquals($message, $violations[0]
      ->getMessage(), 'Translated violation message retrieved.');

    // Test having multiple violations.
    $definition = DataDefinition::create('integer')
      ->setConstraints([
      'Range' => [
        'min' => 5,
      ],
      'Null' => [],
    ]);
    $violations = $this->typedDataManager
      ->create($definition, 10)
      ->validate();
    $this
      ->assertEquals(1, $violations
      ->count());
    $violations = $this->typedDataManager
      ->create($definition, 1)
      ->validate();
    $this
      ->assertEquals(2, $violations
      ->count());

    // Test validating property containers and make sure the NotNull and Null
    // constraints work with typed data containers.
    $definition = BaseFieldDefinition::create('integer')
      ->setConstraints([
      'NotNull' => [],
    ]);
    $field_item = $this->typedDataManager
      ->create($definition, [
      'value' => 10,
    ]);
    $violations = $field_item
      ->validate();
    $this
      ->assertEquals(0, $violations
      ->count());
    $field_item = $this->typedDataManager
      ->create($definition, [
      'value' => 'no integer',
    ]);
    $violations = $field_item
      ->validate();
    $this
      ->assertEquals(1, $violations
      ->count());
    $this
      ->assertEquals('0.value', $violations[0]
      ->getPropertyPath());

    // Test that the field item may not be empty.
    $field_item = $this->typedDataManager
      ->create($definition);
    $violations = $field_item
      ->validate();
    $this
      ->assertEquals(1, $violations
      ->count());

    // Test the Null constraint with typed data containers.
    $definition = BaseFieldDefinition::create('float')
      ->setConstraints([
      'Null' => [],
    ]);
    $field_item = $this->typedDataManager
      ->create($definition, [
      'value' => 11.5,
    ]);
    $violations = $field_item
      ->validate();
    $this
      ->assertEquals(1, $violations
      ->count());
    $field_item = $this->typedDataManager
      ->create($definition);
    $violations = $field_item
      ->validate();
    $this
      ->assertEquals(0, $violations
      ->count());

    // Test getting constraint definitions by type.
    $definitions = $this->typedDataManager
      ->getValidationConstraintManager()
      ->getDefinitionsByType('entity');
    $this
      ->assertTrue(isset($definitions['EntityType']), 'Constraint plugin found for type entity.');
    $this
      ->assertTrue(isset($definitions['Null']), 'Constraint plugin found for type entity.');
    $this
      ->assertTrue(isset($definitions['NotNull']), 'Constraint plugin found for type entity.');
    $definitions = $this->typedDataManager
      ->getValidationConstraintManager()
      ->getDefinitionsByType('string');
    $this
      ->assertFalse(isset($definitions['EntityType']), 'Constraint plugin not found for type string.');
    $this
      ->assertTrue(isset($definitions['Null']), 'Constraint plugin found for type string.');
    $this
      ->assertTrue(isset($definitions['NotNull']), 'Constraint plugin found for type string.');

    // Test automatic 'required' validation.
    $definition = DataDefinition::create('integer')
      ->setRequired(TRUE);
    $violations = $this->typedDataManager
      ->create($definition)
      ->validate();
    $this
      ->assertEquals(1, $violations
      ->count());
    $violations = $this->typedDataManager
      ->create($definition, 0)
      ->validate();
    $this
      ->assertEquals(0, $violations
      ->count());

    // Test validating a list of a values and make sure property paths starting
    // with "0" are created.
    $definition = BaseFieldDefinition::create('integer');
    $violations = $this->typedDataManager
      ->create($definition, [
      [
        'value' => 10,
      ],
    ])
      ->validate();
    $this
      ->assertEquals(0, $violations
      ->count());
    $violations = $this->typedDataManager
      ->create($definition, [
      [
        'value' => 'string',
      ],
    ])
      ->validate();
    $this
      ->assertEquals(1, $violations
      ->count());
    $this
      ->assertEquals('string', $violations[0]
      ->getInvalidValue());
    $this
      ->assertSame('0.value', $violations[0]
      ->getPropertyPath());
  }

}

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.	1
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::assertOptionByText	protected	function	Asserts that a select option with the visible text 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.
AssertLegacyTrait::assert Deprecated	protected	function
AssertLegacyTrait::assertEqual Deprecated	protected	function
AssertLegacyTrait::assertIdentical Deprecated	protected	function
AssertLegacyTrait::assertIdenticalObject Deprecated	protected	function
AssertLegacyTrait::assertNotEqual Deprecated	protected	function
AssertLegacyTrait::assertNotIdentical Deprecated	protected	function
AssertLegacyTrait::pass Deprecated	protected	function
AssertLegacyTrait::verbose Deprecated	protected	function
ConfigTestTrait::configImporter	protected	function	Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig	protected	function	Copies configuration objects from source storage to target storage.
ExtensionListTestTrait::getModulePath	protected	function	Gets the path for the specified module.
ExtensionListTestTrait::getThemePath	protected	function	Gets the path for the specified theme.
KernelTestBase::$backupGlobals	protected	property	Back up and restore any global variables that may be changed by tests.
KernelTestBase::$backupStaticAttributes	protected	property	Back up and restore static class properties that may be changed by tests.
KernelTestBase::$backupStaticAttributesBlacklist	protected	property	Contains a few static class properties for performance.
KernelTestBase::$classLoader	protected	property
KernelTestBase::$configImporter	protected	property	@todo Move into Config test base class.	7
KernelTestBase::$configSchemaCheckerExclusions	protected static	property	An array of config object names that are excluded from schema checking.
KernelTestBase::$container	protected	property
KernelTestBase::$databasePrefix	protected	property
KernelTestBase::$preserveGlobalState	protected	property	Do not forward any global state from the parent process to the processes that run the actual tests.
KernelTestBase::$root	protected	property	The app root.
KernelTestBase::$runTestInSeparateProcess	protected	property	Kernel tests are run in separate processes because they allow autoloading of code from extensions. Running the test in a separate process isolates this behavior from other tests. Subclasses should not override this property.
KernelTestBase::$siteDirectory	protected	property
KernelTestBase::$strictConfigSchema	protected	property	Set to TRUE to strict check all configuration saved.	6
KernelTestBase::$vfsRoot	protected	property	The virtual filesystem root directory.
KernelTestBase::assertPostConditions	protected	function		1
KernelTestBase::bootEnvironment	protected	function	Bootstraps a basic test environment.
KernelTestBase::bootKernel	private	function	Bootstraps a kernel for a test.
KernelTestBase::config	protected	function	Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::disableModules	protected	function	Disables modules for this test.
KernelTestBase::enableModules	protected	function	Enables modules for this test.
KernelTestBase::getConfigSchemaExclusions	protected	function	Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo	protected	function	Returns the Database connection info to be used for this test.	3
KernelTestBase::getDatabasePrefix	public	function
KernelTestBase::getExtensionsForModules	private	function	Returns Extension objects for $modules to enable.
KernelTestBase::getModulesToEnable	private static	function	Returns the modules to enable for this test.
KernelTestBase::initFileCache	protected	function	Initializes the FileCache component.
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 database tables from a module schema definition.
KernelTestBase::prepareTemplate	protected	function
KernelTestBase::register	public	function	Registers test-specific services. Overrides ServiceProviderInterface::register	24
KernelTestBase::render	protected	function	Renders a render array.	1
KernelTestBase::setInstallProfile	protected	function	Sets the install profile and rebuilds the container to update it.
KernelTestBase::setSetting	protected	function	Sets an in-memory Settings variable.
KernelTestBase::setUpBeforeClass	public static	function		1
KernelTestBase::setUpFilesystem	protected	function	Sets up the filesystem, so things like the file directory.	2
KernelTestBase::stop	protected	function	Stops test execution.
KernelTestBase::tearDown	protected	function		4
KernelTestBase::tearDownCloseDatabaseConnection	public	function	@after
KernelTestBase::vfsDump	protected	function	Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__sleep	public	function	Prevents serializing any properties.
PhpUnitWarnings::$deprecationWarnings	private static	property	Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning	public	function	Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
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.	1
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.
StorageCopyTrait::replaceStorageContents	protected static	function	Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements	private	function	Checks missing module requirements.
TestRequirementsTrait::checkRequirements	protected	function	Check module requirements for the Drupal use case.	1
TestRequirementsTrait::getDrupalRoot	protected static	function	Returns the Drupal root directory.
TypedDataTest::$modules	protected static	property	Modules to enable. Overrides KernelTestBase::$modules
TypedDataTest::$typedDataManager	protected	property	The typed data manager to use.
TypedDataTest::createTypedData	protected	function	Creates a typed data object and ensures it implements TypedDataInterface.
TypedDataTest::setUp	protected	function	Overrides KernelTestBase::setUp
TypedDataTest::testGetAndSet	public	function	Tests the basics around constructing and working with typed data objects.
TypedDataTest::testTypedDataLists	public	function	Tests using typed data lists.
TypedDataTest::testTypedDataListsFilter	public	function	Tests the filter() method on typed data lists.
TypedDataTest::testTypedDataMaps	public	function	Tests using a typed data map.
TypedDataTest::testTypedDataValidation	public	function	Tests typed data validation.