Chris@0: <?php
Chris@0: 
Chris@0: namespace Drupal\Tests\serialization\Kernel;
Chris@0: 
Chris@14: use Drupal\Component\Serialization\Json;
Chris@17: use Drupal\Component\Render\FormattableMarkup;
Chris@17: use Drupal\entity_test\Entity\EntitySerializedField;
Chris@0: use Drupal\entity_test\Entity\EntityTestMulRev;
Chris@14: use Drupal\filter\Entity\FilterFormat;
Chris@0: use Drupal\Tests\rest\Functional\BcTimestampNormalizerUnixTestTrait;
Chris@0: 
Chris@0: /**
Chris@0:  * Tests that entities can be serialized to supported core formats.
Chris@0:  *
Chris@0:  * @group serialization
Chris@0:  */
Chris@0: class EntitySerializationTest extends NormalizerTestBase {
Chris@0: 
Chris@0:   use BcTimestampNormalizerUnixTestTrait;
Chris@0: 
Chris@0:   /**
Chris@0:    * Modules to install.
Chris@0:    *
Chris@0:    * @var array
Chris@0:    */
Chris@0:   public static $modules = ['serialization', 'system', 'field', 'entity_test', 'text', 'filter', 'user', 'entity_serialization_test'];
Chris@0: 
Chris@0:   /**
Chris@0:    * The test values.
Chris@0:    *
Chris@0:    * @var array
Chris@0:    */
Chris@0:   protected $values;
Chris@0: 
Chris@0:   /**
Chris@0:    * The test entity.
Chris@0:    *
Chris@0:    * @var \Drupal\Core\Entity\ContentEntityInterface
Chris@0:    */
Chris@0:   protected $entity;
Chris@0: 
Chris@0:   /**
Chris@0:    * The test user.
Chris@0:    *
Chris@0:    * @var \Drupal\user\Entity\User
Chris@0:    */
Chris@0:   protected $user;
Chris@0: 
Chris@0:   /**
Chris@0:    * The serializer service.
Chris@0:    *
Chris@17:    * @var \Symfony\Component\Serializer\Serializer
Chris@0:    */
Chris@0:   protected $serializer;
Chris@0: 
Chris@0:   /**
Chris@0:    * The class name of the test class.
Chris@0:    *
Chris@0:    * @var string
Chris@0:    */
Chris@0:   protected $entityClass = 'Drupal\entity_test\Entity\EntityTest';
Chris@0: 
Chris@0:   protected function setUp() {
Chris@0:     parent::setUp();
Chris@0: 
Chris@0:     // User create needs sequence table.
Chris@0:     $this->installSchema('system', ['sequences']);
Chris@0: 
Chris@14:     FilterFormat::create([
Chris@14:       'format' => 'my_text_format',
Chris@14:       'name' => 'My Text Format',
Chris@14:       'filters' => [
Chris@14:         'filter_html' => [
Chris@14:           'module' => 'filter',
Chris@14:           'status' => TRUE,
Chris@14:           'weight' => 10,
Chris@14:           'settings' => [
Chris@14:             'allowed_html' => '<p>',
Chris@14:           ],
Chris@14:         ],
Chris@14:         'filter_autop' => [
Chris@14:           'module' => 'filter',
Chris@14:           'status' => TRUE,
Chris@14:           'weight' => 10,
Chris@14:           'settings' => [],
Chris@14:         ],
Chris@14:       ],
Chris@14:     ])->save();
Chris@14: 
Chris@0:     // Create a test user to use as the entity owner.
Chris@0:     $this->user = \Drupal::entityManager()->getStorage('user')->create([
Chris@0:       'name' => 'serialization_test_user',
Chris@0:       'mail' => 'foo@example.com',
Chris@0:       'pass' => '123456',
Chris@0:     ]);
Chris@0:     $this->user->save();
Chris@0: 
Chris@0:     // Create a test entity to serialize.
Chris@14:     $test_text_value = $this->randomMachineName();
Chris@0:     $this->values = [
Chris@0:       'name' => $this->randomMachineName(),
Chris@0:       'user_id' => $this->user->id(),
Chris@0:       'field_test_text' => [
Chris@14:         'value' => $test_text_value,
Chris@14:         'format' => 'my_text_format',
Chris@0:       ],
Chris@0:     ];
Chris@0:     $this->entity = EntityTestMulRev::create($this->values);
Chris@0:     $this->entity->save();
Chris@0: 
Chris@0:     $this->serializer = $this->container->get('serializer');
Chris@0: 
Chris@0:     $this->installConfig(['field']);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Test the normalize function.
Chris@0:    */
Chris@0:   public function testNormalize() {
Chris@0:     $expected = [
Chris@0:       'id' => [
Chris@0:         ['value' => 1],
Chris@0:       ],
Chris@0:       'uuid' => [
Chris@0:         ['value' => $this->entity->uuid()],
Chris@0:       ],
Chris@0:       'langcode' => [
Chris@0:         ['value' => 'en'],
Chris@0:       ],
Chris@0:       'name' => [
Chris@0:         ['value' => $this->values['name']],
Chris@0:       ],
Chris@0:       'type' => [
Chris@0:         ['value' => 'entity_test_mulrev'],
Chris@0:       ],
Chris@0:       'created' => [
Chris@0:         $this->formatExpectedTimestampItemValues($this->entity->created->value),
Chris@0:       ],
Chris@0:       'user_id' => [
Chris@0:         [
Chris@0:           // id() will return the string value as it comes from the database.
Chris@0:           'target_id' => (int) $this->user->id(),
Chris@0:           'target_type' => $this->user->getEntityTypeId(),
Chris@0:           'target_uuid' => $this->user->uuid(),
Chris@18:           'url' => $this->user->toUrl()->toString(),
Chris@0:         ],
Chris@0:       ],
Chris@0:       'revision_id' => [
Chris@0:         ['value' => 1],
Chris@0:       ],
Chris@0:       'default_langcode' => [
Chris@0:         ['value' => TRUE],
Chris@0:       ],
Chris@0:       'revision_translation_affected' => [
Chris@0:         ['value' => TRUE],
Chris@0:       ],
Chris@0:       'non_rev_field' => [],
Chris@14:       'non_mul_field' => [],
Chris@0:       'field_test_text' => [
Chris@0:         [
Chris@0:           'value' => $this->values['field_test_text']['value'],
Chris@0:           'format' => $this->values['field_test_text']['format'],
Chris@14:           'processed' => "<p>{$this->values['field_test_text']['value']}</p>",
Chris@0:         ],
Chris@0:       ],
Chris@0:     ];
Chris@0: 
Chris@0:     $normalized = $this->serializer->normalize($this->entity);
Chris@0: 
Chris@0:     foreach (array_keys($expected) as $fieldName) {
Chris@0:       $this->assertSame($expected[$fieldName], $normalized[$fieldName], "Normalization produces expected array for $fieldName.");
Chris@0:     }
Chris@0:     $this->assertEqual(array_diff_key($normalized, $expected), [], 'No unexpected data is added to the normalized array.');
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Tests user normalization, using the entity_serialization_test module to
Chris@0:    * override some default access controls.
Chris@0:    */
Chris@0:   public function testUserNormalize() {
Chris@0:     // Test password isn't available.
Chris@0:     $normalized = $this->serializer->normalize($this->user);
Chris@0: 
Chris@0:     $this->assertFalse(array_key_exists('pass', $normalized), '"pass" key does not exist in normalized user');
Chris@0:     $this->assertFalse(array_key_exists('mail', $normalized), '"mail" key does not exist in normalized user');
Chris@0: 
Chris@0:     // Test again using our test user, so that our access control override will
Chris@0:     // allow password viewing.
Chris@0:     $normalized = $this->serializer->normalize($this->user, NULL, ['account' => $this->user]);
Chris@0: 
Chris@0:     // The key 'pass' will now exist, but the password value should be
Chris@0:     // normalized to NULL.
Chris@0:     $this->assertIdentical($normalized['pass'], [NULL], '"pass" value is normalized to [NULL]');
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Test registered Serializer's entity serialization for core's formats.
Chris@0:    */
Chris@0:   public function testSerialize() {
Chris@0:     // Test that Serializer responds using the ComplexDataNormalizer and
Chris@0:     // JsonEncoder. The output of ComplexDataNormalizer::normalize() is tested
Chris@0:     // elsewhere, so we can just assume that it works properly here.
Chris@0:     $normalized = $this->serializer->normalize($this->entity, 'json');
Chris@14:     $expected = Json::encode($normalized);
Chris@0:     // Test 'json'.
Chris@0:     $actual = $this->serializer->serialize($this->entity, 'json');
Chris@0:     $this->assertIdentical($actual, $expected, 'Entity serializes to JSON when "json" is requested.');
Chris@0:     $actual = $this->serializer->serialize($normalized, 'json');
Chris@0:     $this->assertIdentical($actual, $expected, 'A normalized array serializes to JSON when "json" is requested');
Chris@0:     // Test 'ajax'.
Chris@0:     $actual = $this->serializer->serialize($this->entity, 'ajax');
Chris@0:     $this->assertIdentical($actual, $expected, 'Entity serializes to JSON when "ajax" is requested.');
Chris@0:     $actual = $this->serializer->serialize($normalized, 'ajax');
Chris@0:     $this->assertIdentical($actual, $expected, 'A normalized array serializes to JSON when "ajax" is requested');
Chris@0: 
Chris@0:     // Generate the expected xml in a way that allows changes to entity property
Chris@0:     // order.
Chris@0:     $expected_created = $this->formatExpectedTimestampItemValues($this->entity->created->value);
Chris@0: 
Chris@0:     $expected = [
Chris@0:       'id' => '<id><value>' . $this->entity->id() . '</value></id>',
Chris@0:       'uuid' => '<uuid><value>' . $this->entity->uuid() . '</value></uuid>',
Chris@0:       'langcode' => '<langcode><value>en</value></langcode>',
Chris@0:       'name' => '<name><value>' . $this->values['name'] . '</value></name>',
Chris@0:       'type' => '<type><value>entity_test_mulrev</value></type>',
Chris@0:       'created' => '<created><value>' . $expected_created['value'] . '</value><format>' . $expected_created['format'] . '</format></created>',
Chris@18:       'user_id' => '<user_id><target_id>' . $this->user->id() . '</target_id><target_type>' . $this->user->getEntityTypeId() . '</target_type><target_uuid>' . $this->user->uuid() . '</target_uuid><url>' . $this->user->toUrl()->toString() . '</url></user_id>',
Chris@0:       'revision_id' => '<revision_id><value>' . $this->entity->getRevisionId() . '</value></revision_id>',
Chris@0:       'default_langcode' => '<default_langcode><value>1</value></default_langcode>',
Chris@0:       'revision_translation_affected' => '<revision_translation_affected><value>1</value></revision_translation_affected>',
Chris@14:       'non_mul_field' => '<non_mul_field/>',
Chris@0:       'non_rev_field' => '<non_rev_field/>',
Chris@14:       'field_test_text' => '<field_test_text><value>' . $this->values['field_test_text']['value'] . '</value><format>' . $this->values['field_test_text']['format'] . '</format><processed><![CDATA[<p>' . $this->values['field_test_text']['value'] . '</p>]]></processed></field_test_text>',
Chris@0:     ];
Chris@0:     // Sort it in the same order as normalised.
Chris@0:     $expected = array_merge($normalized, $expected);
Chris@0:     // Add header and footer.
Chris@0:     array_unshift($expected, '<?xml version="1.0"?>' . PHP_EOL . '<response>');
Chris@0:     $expected[] = '</response>' . PHP_EOL;
Chris@0:     // Reduced the array to a string.
Chris@0:     $expected = implode('', $expected);
Chris@0:     // Test 'xml'. The output should match that of Symfony's XmlEncoder.
Chris@0:     $actual = $this->serializer->serialize($this->entity, 'xml');
Chris@0:     $this->assertIdentical($actual, $expected);
Chris@0:     $actual = $this->serializer->serialize($normalized, 'xml');
Chris@0:     $this->assertIdentical($actual, $expected);
Chris@0:   }
Chris@0: 
Chris@0:   /**
Chris@0:    * Tests denormalization of an entity.
Chris@0:    */
Chris@0:   public function testDenormalize() {
Chris@0:     $normalized = $this->serializer->normalize($this->entity);
Chris@0: 
Chris@0:     foreach (['json', 'xml'] as $type) {
Chris@0:       $denormalized = $this->serializer->denormalize($normalized, $this->entityClass, $type, ['entity_type' => 'entity_test_mulrev']);
Chris@17:       $this->assertTrue($denormalized instanceof $this->entityClass, new FormattableMarkup('Denormalized entity is an instance of @class', ['@class' => $this->entityClass]));
Chris@0:       $this->assertIdentical($denormalized->getEntityTypeId(), $this->entity->getEntityTypeId(), 'Expected entity type found.');
Chris@0:       $this->assertIdentical($denormalized->bundle(), $this->entity->bundle(), 'Expected entity bundle found.');
Chris@0:       $this->assertIdentical($denormalized->uuid(), $this->entity->uuid(), 'Expected entity UUID found.');
Chris@0:     }
Chris@0:   }
Chris@0: 
Chris@18:   /**
Chris@18:    * Tests denormalizing serialized columns.
Chris@18:    */
Chris@18:   public function testDenormalizeSerializedItem() {
Chris@18:     $this->setExpectedException(\LogicException::class, 'The generic FieldItemNormalizer cannot denormalize string values for "value" properties of the "serialized" field (field item class: Drupal\entity_test\Plugin\Field\FieldType\SerializedItem).');
Chris@18:     $this->serializer->denormalize([
Chris@18:       'serialized' => [
Chris@18:         [
Chris@18:           'value' => 'boo',
Chris@18:         ],
Chris@18:       ],
Chris@18:       'type' => 'entity_test_serialized_field',
Chris@18:     ], EntitySerializedField::class);
Chris@18:   }
Chris@18: 
Chris@18:   /**
Chris@18:    * Tests normalizing/denormalizing custom serialized columns.
Chris@18:    */
Chris@18:   public function testDenormalizeCustomSerializedItem() {
Chris@18:     $entity = EntitySerializedField::create(['serialized_text' => serialize(['Hello world!'])]);
Chris@18:     $normalized = $this->serializer->normalize($entity);
Chris@18:     $this->assertEquals($normalized['serialized_text'][0]['value'], ['Hello world!']);
Chris@18:     $this->setExpectedException(\LogicException::class, 'The generic FieldItemNormalizer cannot denormalize string values for "value" properties of the "serialized_text" field (field item class: Drupal\entity_test\Plugin\Field\FieldType\SerializedPropertyItem).');
Chris@18:     $this->serializer->denormalize([
Chris@18:       'serialized_text' => [
Chris@18:         [
Chris@18:           'value' => 'boo',
Chris@18:         ],
Chris@18:       ],
Chris@18:       'type' => 'entity_test_serialized_field',
Chris@18:     ], EntitySerializedField::class);
Chris@18:   }
Chris@18: 
Chris@18:   /**
Chris@18:    * Tests normalizing/denormalizing invalid custom serialized fields.
Chris@18:    */
Chris@18:   public function testDenormalizeInvalidCustomSerializedField() {
Chris@18:     $entity = EntitySerializedField::create(['serialized_long' => serialize(['Hello world!'])]);
Chris@18:     $normalized = $this->serializer->normalize($entity);
Chris@18:     $this->assertEquals($normalized['serialized_long'][0]['value'], ['Hello world!']);
Chris@18:     $this->setExpectedException(\LogicException::class, 'The generic FieldItemNormalizer cannot denormalize string values for "value" properties of the "serialized_long" field (field item class: Drupal\Core\Field\Plugin\Field\FieldType\StringLongItem).');
Chris@18:     $this->serializer->denormalize([
Chris@18:       'serialized_long' => [
Chris@18:         [
Chris@18:          'value' => 'boo',
Chris@18:         ],
Chris@18:       ],
Chris@18:       'type' => 'entity_test_serialized_field',
Chris@18:     ], EntitySerializedField::class);
Chris@18:   }
Chris@18: 
Chris@18:   /**
Chris@18:    * Tests normalizing/denormalizing empty custom serialized fields.
Chris@18:    */
Chris@18:   public function testDenormalizeEmptyCustomSerializedField() {
Chris@18:     $entity = EntitySerializedField::create(['serialized_long' => serialize([])]);
Chris@18:     $normalized = $this->serializer->normalize($entity);
Chris@18:     $this->assertEquals([], $normalized['serialized_long'][0]['value']);
Chris@18: 
Chris@18:     $entity = $this->serializer->denormalize($normalized, EntitySerializedField::class);
Chris@18: 
Chris@18:     $this->assertEquals(serialize([]), $entity->get('serialized_long')->value);
Chris@18:   }
Chris@18: 
Chris@18:   /**
Chris@18:    * Tests normalizing/denormalizing valid custom serialized fields.
Chris@18:    */
Chris@18:   public function testDenormalizeValidCustomSerializedField() {
Chris@18:     $entity = EntitySerializedField::create(['serialized_long' => serialize(['key' => 'value'])]);
Chris@18:     $normalized = $this->serializer->normalize($entity);
Chris@18:     $this->assertEquals(['key' => 'value'], $normalized['serialized_long'][0]['value']);
Chris@18: 
Chris@18:     $entity = $this->serializer->denormalize($normalized, EntitySerializedField::class);
Chris@18: 
Chris@18:     $this->assertEquals(serialize(['key' => 'value']), $entity->get('serialized_long')->value);
Chris@18:   }
Chris@18: 
Chris@18:   /**
Chris@18:    * Tests normalizing/denormalizing using string values.
Chris@18:    */
Chris@18:   public function testDenormalizeStringValue() {
Chris@18:     $this->setExpectedException(\LogicException::class, 'The generic FieldItemNormalizer cannot denormalize string values for "value" properties of the "serialized_long" field (field item class: Drupal\Core\Field\Plugin\Field\FieldType\StringLongItem).');
Chris@18:     $this->serializer->denormalize([
Chris@18:       'serialized_long' => ['boo'],
Chris@18:       'type' => 'entity_test_serialized_field',
Chris@18:     ], EntitySerializedField::class);
Chris@18:   }
Chris@18: 
Chris@0: }