EntityTestResourceTestBase.php

<?php

declare (strict_types=1);
namespace Drupal\Tests\entity_test\Functional\Rest;

use Drupal\Core\Entity\EntityDefinitionUpdateManagerInterface;
use Drupal\Core\State\StateInterface;
use Drupal\Tests\rest\Functional\EntityResource\ConfigEntityResourceTestBase;
use Drupal\Tests\system\Functional\Entity\Traits\EntityDefinitionTestTrait;
use Drupal\user\Entity\User;
abstract class EntityTestResourceTestBase extends ConfigEntityResourceTestBase {
    use EntityDefinitionTestTrait;
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'entity_test',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected static $entityTypeId = 'entity_test';
    
    /**
     * {@inheritdoc}
     */
    protected static $patchProtectedFieldNames = [];
    
    /**
     * The state object.
     *
     * @var \Drupal\Core\State\StateInterface
     */
    protected StateInterface $state;
    
    /**
     * @var \Drupal\entity_test\Entity\EntityTest
     */
    protected $entity;
    
    /**
     * The entity definition update manager.
     *
     * @var \Drupal\Core\Entity\EntityDefinitionUpdateManagerInterface
     */
    protected EntityDefinitionUpdateManagerInterface $entityDefinitionUpdateManager;
    
    /**
     * {@inheritdoc}
     */
    protected function setUpAuthorization($method) {
        switch ($method) {
            case 'GET':
                $this->grantPermissionsToTestedRole([
                    'view test entity',
                ]);
                break;
            case 'POST':
                $this->grantPermissionsToTestedRole([
                    'create entity_test entity_test_with_bundle entities',
                ]);
                break;
            case 'PATCH':
            case 'DELETE':
                $this->grantPermissionsToTestedRole([
                    'administer entity_test content',
                ]);
                break;
        }
    }
    
    /**
     * {@inheritdoc}
     */
    protected function createEntity() {
        // Set flag so that internal field 'internal_string_field' is created.
        // @see entity_test_entity_base_field_info()
        $this->container
            ->get('state')
            ->set('entity_test.internal_field', TRUE);
        $this->applyEntityUpdates('entity_test');
        $entity_test = \Drupal::entityTypeManager()->getStorage(static::$entityTypeId)
            ->create([
            'name' => 'Llama',
            'type' => static::$entityTypeId,
            // Set a value for the internal field to confirm that it will not be
            // returned in normalization.
            // @see entity_test_entity_base_field_info().
'internal_string_field' => [
                'value' => 'This value shall not be internal!',
            ],
        ]);
        $entity_test->setOwnerId(0);
        $entity_test->save();
        return $entity_test;
    }
    
    /**
     * {@inheritdoc}
     */
    protected function getExpectedNormalizedEntity() {
        $author = User::load(0);
        $normalization = [
            'uuid' => [
                [
                    'value' => $this->entity
                        ->uuid(),
                ],
            ],
            'id' => [
                [
                    'value' => 1,
                ],
            ],
            'langcode' => [
                [
                    'value' => 'en',
                ],
            ],
            'type' => [
                [
                    'value' => static::$entityTypeId,
                ],
            ],
            'name' => [
                [
                    'value' => 'Llama',
                ],
            ],
            'created' => [
                [
                    'value' => (new \DateTime())->setTimestamp((int) $this->entity
                        ->get('created')->value)
                        ->setTimezone(new \DateTimeZone('UTC'))
                        ->format(\DateTime::RFC3339),
                    'format' => \DateTime::RFC3339,
                ],
            ],
            'user_id' => [
                [
                    'target_id' => (int) $author->id(),
                    'target_type' => 'user',
                    'target_uuid' => $author->uuid(),
                    'url' => $author->toUrl()
                        ->toString(),
                ],
            ],
            'field_test_text' => [],
        ];
        return $normalization;
    }
    
    /**
     * {@inheritdoc}
     */
    protected function getNormalizedPostEntity() {
        return [
            'type' => [
                [
                    'value' => static::$entityTypeId,
                ],
            ],
            'name' => [
                [
                    'value' => 'Drama llama',
                ],
            ],
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    protected function getExpectedUnauthorizedAccessMessage($method) {
        switch ($method) {
            case 'GET':
                return "The 'view test entity' permission is required.";
            case 'POST':
                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'.";
            default:
                return parent::getExpectedUnauthorizedAccessMessage($method);
        }
    }

}