annotate core/modules/jsonapi/tests/src/Functional/EntityTestMapFieldTest.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents af1871eacc83
children
rev   line source
Chris@18 1 <?php
Chris@18 2
Chris@18 3 namespace Drupal\Tests\jsonapi\Functional;
Chris@18 4
Chris@18 5 use Drupal\Core\Url;
Chris@18 6 use Drupal\entity_test\Entity\EntityTestMapField;
Chris@18 7 use Drupal\user\Entity\User;
Chris@18 8
Chris@18 9 /**
Chris@18 10 * JSON:API integration test for the "EntityTestMapField" content entity type.
Chris@18 11 *
Chris@18 12 * @group jsonapi
Chris@18 13 */
Chris@18 14 class EntityTestMapFieldTest extends ResourceTestBase {
Chris@18 15
Chris@18 16 /**
Chris@18 17 * {@inheritdoc}
Chris@18 18 */
Chris@18 19 public static $modules = ['entity_test'];
Chris@18 20
Chris@18 21 /**
Chris@18 22 * {@inheritdoc}
Chris@18 23 */
Chris@18 24 protected static $entityTypeId = 'entity_test_map_field';
Chris@18 25
Chris@18 26 /**
Chris@18 27 * {@inheritdoc}
Chris@18 28 */
Chris@18 29 protected static $resourceTypeName = 'entity_test_map_field--entity_test_map_field';
Chris@18 30
Chris@18 31 /**
Chris@18 32 * {@inheritdoc}
Chris@18 33 */
Chris@18 34 protected static $patchProtectedFieldNames = [];
Chris@18 35
Chris@18 36 /**
Chris@18 37 * {@inheritdoc}
Chris@18 38 *
Chris@18 39 * @var \Drupal\entity_test\Entity\EntityTestMapField
Chris@18 40 */
Chris@18 41 protected $entity;
Chris@18 42
Chris@18 43 /**
Chris@18 44 * The complex nested value to assign to a @FieldType=map field.
Chris@18 45 *
Chris@18 46 * @var array
Chris@18 47 */
Chris@18 48 protected static $mapValue = [
Chris@18 49 'key1' => 'value',
Chris@18 50 'key2' => 'no, val you',
Chris@18 51 'π' => 3.14159,
Chris@18 52 TRUE => 42,
Chris@18 53 'nested' => [
Chris@18 54 'bird' => 'robin',
Chris@18 55 'doll' => 'Russian',
Chris@18 56 ],
Chris@18 57 ];
Chris@18 58
Chris@18 59 /**
Chris@18 60 * {@inheritdoc}
Chris@18 61 */
Chris@18 62 protected function setUpAuthorization($method) {
Chris@18 63 $this->grantPermissionsToTestedRole(['administer entity_test content']);
Chris@18 64 }
Chris@18 65
Chris@18 66 /**
Chris@18 67 * {@inheritdoc}
Chris@18 68 */
Chris@18 69 protected function createEntity() {
Chris@18 70 $entity = EntityTestMapField::create([
Chris@18 71 'name' => 'Llama',
Chris@18 72 'type' => 'entity_test_map_field',
Chris@18 73 'data' => [
Chris@18 74 static::$mapValue,
Chris@18 75 ],
Chris@18 76 ]);
Chris@18 77 $entity->setOwnerId(0);
Chris@18 78 $entity->save();
Chris@18 79 return $entity;
Chris@18 80 }
Chris@18 81
Chris@18 82 /**
Chris@18 83 * {@inheritdoc}
Chris@18 84 */
Chris@18 85 protected function getExpectedDocument() {
Chris@18 86 $self_url = Url::fromUri('base:/jsonapi/entity_test_map_field/entity_test_map_field/' . $this->entity->uuid())->setAbsolute()->toString(TRUE)->getGeneratedUrl();
Chris@18 87 $author = User::load(0);
Chris@18 88 return [
Chris@18 89 'jsonapi' => [
Chris@18 90 'meta' => [
Chris@18 91 'links' => [
Chris@18 92 'self' => ['href' => 'http://jsonapi.org/format/1.0/'],
Chris@18 93 ],
Chris@18 94 ],
Chris@18 95 'version' => '1.0',
Chris@18 96 ],
Chris@18 97 'links' => [
Chris@18 98 'self' => ['href' => $self_url],
Chris@18 99 ],
Chris@18 100 'data' => [
Chris@18 101 'id' => $this->entity->uuid(),
Chris@18 102 'type' => 'entity_test_map_field--entity_test_map_field',
Chris@18 103 'links' => [
Chris@18 104 'self' => ['href' => $self_url],
Chris@18 105 ],
Chris@18 106 'attributes' => [
Chris@18 107 'created' => (new \DateTime())->setTimestamp($this->entity->get('created')->value)->setTimezone(new \DateTimeZone('UTC'))->format(\DateTime::RFC3339),
Chris@18 108 'langcode' => 'en',
Chris@18 109 'name' => 'Llama',
Chris@18 110 'data' => static::$mapValue,
Chris@18 111 'drupal_internal__id' => 1,
Chris@18 112 ],
Chris@18 113 'relationships' => [
Chris@18 114 'user_id' => [
Chris@18 115 'data' => [
Chris@18 116 'id' => $author->uuid(),
Chris@18 117 'type' => 'user--user',
Chris@18 118 ],
Chris@18 119 'links' => [
Chris@18 120 'related' => ['href' => $self_url . '/user_id'],
Chris@18 121 'self' => ['href' => $self_url . '/relationships/user_id'],
Chris@18 122 ],
Chris@18 123 ],
Chris@18 124 ],
Chris@18 125 ],
Chris@18 126 ];
Chris@18 127 }
Chris@18 128
Chris@18 129 /**
Chris@18 130 * {@inheritdoc}
Chris@18 131 */
Chris@18 132 protected function getPostDocument() {
Chris@18 133 return [
Chris@18 134 'data' => [
Chris@18 135 'type' => 'entity_test_map_field--entity_test_map_field',
Chris@18 136 'attributes' => [
Chris@18 137 'name' => 'Dramallama',
Chris@18 138 'data' => static::$mapValue,
Chris@18 139 ],
Chris@18 140 ],
Chris@18 141 ];
Chris@18 142 }
Chris@18 143
Chris@18 144 /**
Chris@18 145 * {@inheritdoc}
Chris@18 146 */
Chris@18 147 protected function getExpectedUnauthorizedAccessMessage($method) {
Chris@18 148 return "The 'administer entity_test content' permission is required.";
Chris@18 149 }
Chris@18 150
Chris@18 151 /**
Chris@18 152 * {@inheritdoc}
Chris@18 153 */
Chris@18 154 protected function getSparseFieldSets() {
Chris@18 155 // EntityTestMapField's owner field name is `user_id`, not `uid`, which
Chris@18 156 // breaks nested sparse fieldset tests.
Chris@18 157 return array_diff_key(parent::getSparseFieldSets(), array_flip([
Chris@18 158 'nested_empty_fieldset',
Chris@18 159 'nested_fieldset_with_owner_fieldset',
Chris@18 160 ]));
Chris@18 161 }
Chris@18 162
Chris@18 163 }