www.aleph1.co.uk Git - yaffs-website/blob - web/core/modules/hal/tests/src/Kernel/NormalizeTest.php

   1 <?php
   2
   3 namespace Drupal\Tests\hal\Kernel;
   4
   5 use Drupal\Core\Entity\EntityInterface;
   6 use Drupal\Core\Url;
   7 use Drupal\entity_test\Entity\EntityTest;
   8 use Drupal\filter\Entity\FilterFormat;
   9
  10 /**
  11  * Tests HAL normalization edge cases for EntityResource.
  12  *
  13  * @group hal
  14  */
  15 class NormalizeTest extends NormalizerTestBase {
  16
  17   /**
  18    * {@inheritdoc}
  19    */
  20   protected function setUp() {
  21     parent::setUp();
  22
  23     FilterFormat::create([
  24       'format' => 'my_text_format',
  25       'name' => 'My Text Format',
  26       'filters' => [
  27         'filter_html' => [
  28           'module' => 'filter',
  29           'status' => TRUE,
  30           'weight' => 10,
  31           'settings' => [
  32             'allowed_html' => '<p>',
  33           ],
  34         ],
  35         'filter_autop' => [
  36           'module' => 'filter',
  37           'status' => TRUE,
  38           'weight' => 10,
  39           'settings' => [],
  40         ],
  41       ],
  42     ])->save();
  43
  44     \Drupal::service('router.builder')->rebuild();
  45   }
  46
  47   /**
  48    * Tests the normalize function.
  49    */
  50   public function testNormalize() {
  51     $target_entity_de = EntityTest::create((['langcode' => 'de', 'field_test_entity_reference' => NULL]));
  52     $target_entity_de->save();
  53     $target_entity_en = EntityTest::create((['langcode' => 'en', 'field_test_entity_reference' => NULL]));
  54     $target_entity_en->save();
  55
  56     // Create a German entity.
  57     $values = [
  58       'langcode' => 'de',
  59       'name' => $this->randomMachineName(),
  60       'field_test_text' => [
  61         'value' => $this->randomMachineName(),
  62         'format' => 'my_text_format',
  63       ],
  64       'field_test_entity_reference' => [
  65         'target_id' => $target_entity_de->id(),
  66       ],
  67     ];
  68     // Array of translated values.
  69     $translation_values = [
  70       'name' => $this->randomMachineName(),
  71       'field_test_entity_reference' => [
  72         'target_id' => $target_entity_en->id(),
  73       ],
  74     ];
  75
  76     $entity = EntityTest::create($values);
  77     $entity->save();
  78     // Add an English value for name and entity reference properties.
  79     $entity->addTranslation('en')->set('name', [0 => ['value' => $translation_values['name']]]);
  80     $entity->getTranslation('en')->set('field_test_entity_reference', [0 => $translation_values['field_test_entity_reference']]);
  81     $entity->save();
  82
  83     $type_uri = Url::fromUri('base:rest/type/entity_test/entity_test', ['absolute' => TRUE])->toString();
  84     $relation_uri = Url::fromUri('base:rest/relation/entity_test/entity_test/field_test_entity_reference', ['absolute' => TRUE])->toString();
  85
  86     $expected_array = [
  87       '_links' => [
  88         'curies' => [
  89           [
  90             'href' => '/relations',
  91             'name' => 'site',
  92             'templated' => TRUE,
  93           ],
  94         ],
  95         'self' => [
  96           'href' => $this->getEntityUri($entity),
  97         ],
  98         'type' => [
  99           'href' => $type_uri,
 100         ],
 101         $relation_uri => [
 102           [
 103             'href' => $this->getEntityUri($target_entity_de),
 104             'lang' => 'de',
 105           ],
 106           [
 107             'href' => $this->getEntityUri($target_entity_en),
 108             'lang' => 'en',
 109           ],
 110         ],
 111       ],
 112       '_embedded' => [
 113         $relation_uri => [
 114           [
 115             '_links' => [
 116               'self' => [
 117                 'href' => $this->getEntityUri($target_entity_de),
 118               ],
 119               'type' => [
 120                 'href' => $type_uri,
 121               ],
 122             ],
 123             'uuid' => [
 124               [
 125                 'value' => $target_entity_de->uuid(),
 126               ],
 127             ],
 128             'lang' => 'de',
 129           ],
 130           [
 131             '_links' => [
 132               'self' => [
 133                 'href' => $this->getEntityUri($target_entity_en),
 134               ],
 135               'type' => [
 136                 'href' => $type_uri,
 137               ],
 138             ],
 139             'uuid' => [
 140               [
 141                 'value' => $target_entity_en->uuid(),
 142               ],
 143             ],
 144             'lang' => 'en',
 145           ],
 146         ],
 147       ],
 148       'id' => [
 149         [
 150           'value' => $entity->id(),
 151         ],
 152       ],
 153       'uuid' => [
 154         [
 155           'value' => $entity->uuid(),
 156         ],
 157       ],
 158       'langcode' => [
 159         [
 160           'value' => 'de',
 161         ],
 162       ],
 163       'name' => [
 164         [
 165           'value' => $values['name'],
 166           'lang' => 'de',
 167         ],
 168         [
 169           'value' => $translation_values['name'],
 170           'lang' => 'en',
 171         ],
 172       ],
 173       'field_test_text' => [
 174         [
 175           'value' => $values['field_test_text']['value'],
 176           'format' => $values['field_test_text']['format'],
 177           'processed' => "<p>{$values['field_test_text']['value']}</p>",
 178         ],
 179       ],
 180     ];
 181
 182     $normalized = $this->serializer->normalize($entity, $this->format);
 183     $this->assertEqual($normalized['_links']['self'], $expected_array['_links']['self'], 'self link placed correctly.');
 184     // @todo Test curies.
 185     // @todo Test type.
 186     $this->assertEqual($normalized['id'], $expected_array['id'], 'Internal id is exposed.');
 187     $this->assertEqual($normalized['uuid'], $expected_array['uuid'], 'Non-translatable fields is normalized.');
 188     $this->assertEqual($normalized['name'], $expected_array['name'], 'Translatable field with multiple language values is normalized.');
 189     $this->assertEqual($normalized['field_test_text'], $expected_array['field_test_text'], 'Field with properties is normalized.');
 190     $this->assertEqual($normalized['_embedded'][$relation_uri], $expected_array['_embedded'][$relation_uri], 'Entity reference field is normalized.');
 191     $this->assertEqual($normalized['_links'][$relation_uri], $expected_array['_links'][$relation_uri], 'Links are added for entity reference field.');
 192   }
 193
 194   /**
 195    * Constructs the entity URI.
 196    *
 197    * @param \Drupal\Core\Entity\EntityInterface $entity
 198    *   The entity.
 199    *
 200    * @return string
 201    *   The entity URI.
 202    */
 203   protected function getEntityUri(EntityInterface $entity) {
 204     $url = $entity->urlInfo('canonical', ['absolute' => TRUE]);
 205     return $url->setRouteParameter('_format', 'hal_json')->toString();
 206   }
 207
 208 }