WorkspaceResourceTestBase.php

<?php

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

use Drupal\Tests\rest\Functional\EntityResource\EntityResourceTestBase;
use Drupal\user\Entity\User;
use Drupal\workspaces\Entity\Workspace;

/**
 * Base class for workspace EntityResource tests.
 */
abstract class WorkspaceResourceTestBase extends EntityResourceTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'workspaces',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected static $entityTypeId = 'workspace';
    
    /**
     * {@inheritdoc}
     */
    protected static $patchProtectedFieldNames = [
        'changed' => NULL,
    ];
    
    /**
     * {@inheritdoc}
     */
    protected static $uniqueFieldNames = [
        'id',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected static $firstCreatedEntityId = 'running_on_faith';
    
    /**
     * {@inheritdoc}
     */
    protected static $secondCreatedEntityId = 'running_on_faith_2';
    
    /**
     * {@inheritdoc}
     */
    protected function setUpAuthorization($method) {
        switch ($method) {
            case 'GET':
                $this->grantPermissionsToTestedRole([
                    'view any workspace',
                ]);
                break;
            case 'POST':
                $this->grantPermissionsToTestedRole([
                    'create workspace',
                ]);
                break;
            case 'PATCH':
                $this->grantPermissionsToTestedRole([
                    'edit any workspace',
                ]);
                break;
            case 'DELETE':
                $this->grantPermissionsToTestedRole([
                    'delete any workspace',
                ]);
                break;
        }
    }
    
    /**
     * {@inheritdoc}
     */
    protected function createEntity() {
        $workspace = Workspace::create([
            'id' => 'layla',
            'label' => 'Layla',
        ]);
        $workspace->save();
        return $workspace;
    }
    
    /**
     * {@inheritdoc}
     */
    protected function createAnotherEntity() {
        $workspace = $this->entity
            ->createDuplicate();
        $workspace->id = 'layla_dupe';
        $workspace->label = 'Layla_dupe';
        $workspace->save();
        return $workspace;
    }
    
    /**
     * {@inheritdoc}
     */
    protected function getExpectedNormalizedEntity() {
        $author = User::load($this->entity
            ->getOwnerId());
        return [
            'created' => [
                [
                    'value' => (new \DateTime())->setTimestamp((int) $this->entity
                        ->getCreatedTime())
                        ->setTimezone(new \DateTimeZone('UTC'))
                        ->format(\DateTime::RFC3339),
                    'format' => \DateTime::RFC3339,
                ],
            ],
            'changed' => [
                [
                    'value' => (new \DateTime())->setTimestamp($this->entity
                        ->getChangedTime())
                        ->setTimezone(new \DateTimeZone('UTC'))
                        ->format(\DateTime::RFC3339),
                    'format' => \DateTime::RFC3339,
                ],
            ],
            'id' => [
                [
                    'value' => 'layla',
                ],
            ],
            'label' => [
                [
                    'value' => 'Layla',
                ],
            ],
            'revision_id' => [
                [
                    'value' => 2,
                ],
            ],
            'parent' => [],
            'uid' => [
                [
                    'target_id' => (int) $author->id(),
                    'target_type' => 'user',
                    'target_uuid' => $author->uuid(),
                    'url' => base_path() . 'user/' . $author->id(),
                ],
            ],
            'uuid' => [
                [
                    'value' => $this->entity
                        ->uuid(),
                ],
            ],
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    protected function getNormalizedPostEntity() {
        return [
            'id' => [
                [
                    'value' => static::$firstCreatedEntityId,
                ],
            ],
            'label' => [
                [
                    'value' => 'Running on faith',
                ],
            ],
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    protected function getNormalizedPatchEntity() {
        return array_diff_key($this->getNormalizedPostEntity(), [
            'id' => TRUE,
        ]);
    }
    
    /**
     * {@inheritdoc}
     */
    protected function getExpectedUnauthorizedAccessMessage($method) {
        switch ($method) {
            case 'GET':
                return "The 'view any workspace' permission is required.";
            case 'POST':
                return "The following permissions are required: 'administer workspaces' OR 'create workspace'.";
            case 'PATCH':
                return "The 'edit any workspace' permission is required.";
            case 'DELETE':
                return "The 'delete any workspace' permission is required.";
        }
        return parent::getExpectedUnauthorizedAccessMessage($method);
    }
    
    /**
     * {@inheritdoc}
     */
    protected function getModifiedEntityForPostTesting() {
        $modified = parent::getModifiedEntityForPostTesting();
        // Even though the field type of the workspace ID is 'string', it acts as a
        // machine name through a custom constraint, so we need to ensure that we
        // generate a proper random value for it.
        // @see \Drupal\workspaces\Entity\Workspace::baseFieldDefinitions()
        $modified['id'] = [
            $this->randomMachineName(),
        ];
        return $modified;
    }

}