annotate core/modules/jsonapi/tests/src/Functional/EntityTestTest.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\Field\BaseFieldDefinition;
Chris@18 6 use Drupal\Core\Session\AccountInterface;
Chris@18 7 use Drupal\Core\Url;
Chris@18 8 use Drupal\entity_test\Entity\EntityTest;
Chris@18 9 use Drupal\Tests\rest\Functional\BcTimestampNormalizerUnixTestTrait;
Chris@18 10 use Drupal\user\Entity\User;
Chris@18 11
Chris@18 12 /**
Chris@18 13 * JSON:API integration test for the "EntityTest" content entity type.
Chris@18 14 *
Chris@18 15 * @group jsonapi
Chris@18 16 */
Chris@18 17 class EntityTestTest extends ResourceTestBase {
Chris@18 18
Chris@18 19 use BcTimestampNormalizerUnixTestTrait;
Chris@18 20
Chris@18 21 /**
Chris@18 22 * {@inheritdoc}
Chris@18 23 */
Chris@18 24 public static $modules = ['entity_test'];
Chris@18 25
Chris@18 26 /**
Chris@18 27 * {@inheritdoc}
Chris@18 28 */
Chris@18 29 protected static $entityTypeId = 'entity_test';
Chris@18 30
Chris@18 31 /**
Chris@18 32 * {@inheritdoc}
Chris@18 33 */
Chris@18 34 protected static $resourceTypeName = 'entity_test--entity_test';
Chris@18 35
Chris@18 36 /**
Chris@18 37 * {@inheritdoc}
Chris@18 38 */
Chris@18 39 protected static $patchProtectedFieldNames = [];
Chris@18 40
Chris@18 41 /**
Chris@18 42 * {@inheritdoc}
Chris@18 43 *
Chris@18 44 * @var \Drupal\entity_test\Entity\EntityTest
Chris@18 45 */
Chris@18 46 protected $entity;
Chris@18 47
Chris@18 48 /**
Chris@18 49 * {@inheritdoc}
Chris@18 50 */
Chris@18 51 protected function setUpAuthorization($method) {
Chris@18 52 switch ($method) {
Chris@18 53 case 'GET':
Chris@18 54 $this->grantPermissionsToTestedRole(['view test entity']);
Chris@18 55 break;
Chris@18 56
Chris@18 57 case 'POST':
Chris@18 58 $this->grantPermissionsToTestedRole(['create entity_test entity_test_with_bundle entities']);
Chris@18 59 break;
Chris@18 60
Chris@18 61 case 'PATCH':
Chris@18 62 case 'DELETE':
Chris@18 63 $this->grantPermissionsToTestedRole(['administer entity_test content']);
Chris@18 64 break;
Chris@18 65 }
Chris@18 66 }
Chris@18 67
Chris@18 68 /**
Chris@18 69 * {@inheritdoc}
Chris@18 70 */
Chris@18 71 protected function createEntity() {
Chris@18 72 // Set flag so that internal field 'internal_string_field' is created.
Chris@18 73 // @see entity_test_entity_base_field_info()
Chris@18 74 $this->container->get('state')->set('entity_test.internal_field', TRUE);
Chris@18 75 $field_storage_definition = BaseFieldDefinition::create('string')
Chris@18 76 ->setLabel('Internal field')
Chris@18 77 ->setInternal(TRUE);
Chris@18 78 \Drupal::entityDefinitionUpdateManager()->installFieldStorageDefinition('internal_string_field', 'entity_test', 'entity_test', $field_storage_definition);
Chris@18 79
Chris@18 80 $entity_test = EntityTest::create([
Chris@18 81 'name' => 'Llama',
Chris@18 82 'type' => 'entity_test',
Chris@18 83 // Set a value for the internal field to confirm that it will not be
Chris@18 84 // returned in normalization.
Chris@18 85 // @see entity_test_entity_base_field_info().
Chris@18 86 'internal_string_field' => [
Chris@18 87 'value' => 'This value shall not be internal!',
Chris@18 88 ],
Chris@18 89 ]);
Chris@18 90 $entity_test->setOwnerId(0);
Chris@18 91 $entity_test->save();
Chris@18 92
Chris@18 93 return $entity_test;
Chris@18 94 }
Chris@18 95
Chris@18 96 /**
Chris@18 97 * {@inheritdoc}
Chris@18 98 */
Chris@18 99 protected function getExpectedDocument() {
Chris@18 100 $self_url = Url::fromUri('base:/jsonapi/entity_test/entity_test/' . $this->entity->uuid())->setAbsolute()->toString(TRUE)->getGeneratedUrl();
Chris@18 101 $author = User::load(0);
Chris@18 102 return [
Chris@18 103 'jsonapi' => [
Chris@18 104 'meta' => [
Chris@18 105 'links' => [
Chris@18 106 'self' => ['href' => 'http://jsonapi.org/format/1.0/'],
Chris@18 107 ],
Chris@18 108 ],
Chris@18 109 'version' => '1.0',
Chris@18 110 ],
Chris@18 111 'links' => [
Chris@18 112 'self' => ['href' => $self_url],
Chris@18 113 ],
Chris@18 114 'data' => [
Chris@18 115 'id' => $this->entity->uuid(),
Chris@18 116 'type' => 'entity_test--entity_test',
Chris@18 117 'links' => [
Chris@18 118 'self' => ['href' => $self_url],
Chris@18 119 ],
Chris@18 120 'attributes' => [
Chris@18 121 'created' => (new \DateTime())->setTimestamp($this->entity->get('created')->value)->setTimezone(new \DateTimeZone('UTC'))->format(\DateTime::RFC3339),
Chris@18 122 'field_test_text' => NULL,
Chris@18 123 'langcode' => 'en',
Chris@18 124 'name' => 'Llama',
Chris@18 125 'entity_test_type' => 'entity_test',
Chris@18 126 'drupal_internal__id' => 1,
Chris@18 127 ],
Chris@18 128 'relationships' => [
Chris@18 129 'user_id' => [
Chris@18 130 'data' => [
Chris@18 131 'id' => $author->uuid(),
Chris@18 132 'type' => 'user--user',
Chris@18 133 ],
Chris@18 134 'links' => [
Chris@18 135 'related' => ['href' => $self_url . '/user_id'],
Chris@18 136 'self' => ['href' => $self_url . '/relationships/user_id'],
Chris@18 137 ],
Chris@18 138 ],
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 getPostDocument() {
Chris@18 148 return [
Chris@18 149 'data' => [
Chris@18 150 'type' => 'entity_test--entity_test',
Chris@18 151 'attributes' => [
Chris@18 152 'name' => 'Dramallama',
Chris@18 153 ],
Chris@18 154 ],
Chris@18 155 ];
Chris@18 156 }
Chris@18 157
Chris@18 158 /**
Chris@18 159 * {@inheritdoc}
Chris@18 160 */
Chris@18 161 protected function getExpectedUnauthorizedAccessMessage($method) {
Chris@18 162 switch ($method) {
Chris@18 163 case 'GET':
Chris@18 164 return "The 'view test entity' permission is required.";
Chris@18 165
Chris@18 166 case 'POST':
Chris@18 167 return "The following permissions are required: 'administer entity_test content' OR 'administer entity_test_with_bundle content' OR 'create entity_test entity_test_with_bundle entities'.";
Chris@18 168
Chris@18 169 default:
Chris@18 170 return parent::getExpectedUnauthorizedAccessMessage($method);
Chris@18 171 }
Chris@18 172 }
Chris@18 173
Chris@18 174 /**
Chris@18 175 * {@inheritdoc}
Chris@18 176 */
Chris@18 177 protected function getSparseFieldSets() {
Chris@18 178 // EntityTest's owner field name is `user_id`, not `uid`, which breaks
Chris@18 179 // nested sparse fieldset tests.
Chris@18 180 return array_diff_key(parent::getSparseFieldSets(), array_flip([
Chris@18 181 'nested_empty_fieldset',
Chris@18 182 'nested_fieldset_with_owner_fieldset',
Chris@18 183 ]));
Chris@18 184 }
Chris@18 185
Chris@18 186 /**
Chris@18 187 * {@inheritdoc}
Chris@18 188 */
Chris@18 189 protected static function getExpectedCollectionCacheability(AccountInterface $account, array $collection, array $sparse_fieldset = NULL, $filtered = FALSE) {
Chris@18 190 $cacheability = parent::getExpectedCollectionCacheability($account, $collection, $sparse_fieldset, $filtered);
Chris@18 191 if ($filtered) {
Chris@18 192 $cacheability->addCacheTags(['state:jsonapi__entity_test_filter_access_blacklist']);
Chris@18 193 }
Chris@18 194 return $cacheability;
Chris@18 195 }
Chris@18 196
Chris@18 197 }