BaseFieldOverrideTest.php

<?php

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

use Drupal\Core\Field\Entity\BaseFieldOverride;
use Drupal\Core\Url;
use Drupal\node\Entity\NodeType;

/**
 * JSON:API integration test for the "BaseFieldOverride" config entity type.
 *
 * @group jsonapi
 */
class BaseFieldOverrideTest extends ConfigEntityResourceTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'field',
        'node',
        'field_ui',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected static $entityTypeId = 'base_field_override';
    
    /**
     * {@inheritdoc}
     */
    protected static $resourceTypeName = 'base_field_override--base_field_override';
    
    /**
     * {@inheritdoc}
     *
     * @var \Drupal\Core\Field\Entity\BaseFieldOverride
     */
    protected $entity;
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * {@inheritdoc}
     */
    protected function setUpAuthorization($method) : void {
        $this->grantPermissionsToTestedRole([
            'administer node fields',
        ]);
    }
    
    /**
     * {@inheritdoc}
     */
    protected function createEntity() {
        $camelids = NodeType::create([
            'name' => 'Camelids',
            'type' => 'camelids',
        ]);
        $camelids->save();
        $entity = BaseFieldOverride::create([
            'field_name' => 'promote',
            'entity_type' => 'node',
            'bundle' => 'camelids',
            'label' => 'Promote to front page',
        ]);
        $entity->save();
        return $entity;
    }
    
    /**
     * {@inheritdoc}
     */
    protected function getExpectedDocument() : array {
        $self_url = Url::fromUri('base:/jsonapi/base_field_override/base_field_override/' . $this->entity
            ->uuid())
            ->setAbsolute()
            ->toString(TRUE)
            ->getGeneratedUrl();
        return [
            'jsonapi' => [
                'meta' => [
                    'links' => [
                        'self' => [
                            'href' => 'http://jsonapi.org/format/1.0/',
                        ],
                    ],
                ],
                'version' => '1.0',
            ],
            'links' => [
                'self' => [
                    'href' => $self_url,
                ],
            ],
            'data' => [
                'id' => $this->entity
                    ->uuid(),
                'type' => 'base_field_override--base_field_override',
                'links' => [
                    'self' => [
                        'href' => $self_url,
                    ],
                ],
                'attributes' => [
                    'bundle' => 'camelids',
                    'default_value' => [],
                    'default_value_callback' => '',
                    'dependencies' => [
                        'config' => [
                            'node.type.camelids',
                        ],
                    ],
                    'description' => '',
                    'entity_type' => 'node',
                    'field_name' => 'promote',
                    'field_type' => 'boolean',
                    'label' => 'Promote to front page',
                    'langcode' => 'en',
                    'required' => FALSE,
                    'settings' => [
                        'on_label' => 'On',
                        'off_label' => 'Off',
                    ],
                    'status' => TRUE,
                    'translatable' => TRUE,
                    'drupal_internal__id' => 'node.camelids.promote',
                ],
            ],
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    protected function getPostDocument() : array {
        // @todo Update in https://www.drupal.org/node/2300677.
        return [];
    }
    
    /**
     * {@inheritdoc}
     */
    protected function getExpectedUnauthorizedAccessMessage($method) : string {
        return "The 'administer node fields' permission is required.";
    }
    
    /**
     * {@inheritdoc}
     */
    protected function createAnotherEntity($key) {
        $entity = BaseFieldOverride::create([
            'field_name' => 'status',
            'entity_type' => 'node',
            'bundle' => 'camelids',
            'label' => 'Published',
        ]);
        $entity->save();
        return $entity;
    }

}