abstract class BlockResourceTestBase in Drupal 10

Hierarchy

• class \Drupal\Tests\BrowserTestBase extends \PHPUnit\Framework\TestCase uses \Drupal\Tests\PhpUnitCompatibilityTrait, \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, FunctionalTestSetupTrait, TestSetupTrait, BlockCreationTrait, ConfigTestTrait, ExtensionListTestTrait, ContentTypeCreationTrait, NodeCreationTrait, RandomGeneratorTrait, TestRequirementsTrait, PhpUnitWarnings, UiHelperTrait, UserCreationTrait, XdebugRequestTrait
  • class \Drupal\Tests\rest\Functional\ResourceTestBase
    • class \Drupal\Tests\rest\Functional\EntityResource\EntityResourceTestBase
      • class \Drupal\Tests\rest\Functional\EntityResource\ConfigEntityResourceTestBase
        • class \Drupal\Tests\block\Functional\Rest\BlockResourceTestBase

File

core/modules/block/tests/src/Functional/Rest/BlockResourceTestBase.php, line 9

Namespace

Drupal\Tests\block\Functional\Rest

abstract class BlockResourceTestBase extends ConfigEntityResourceTestBase {

  /**
   * {@inheritdoc}
   */
  protected static $modules = [
    'block',
  ];

  /**
   * {@inheritdoc}
   */
  protected static $entityTypeId = 'block';

  /**
   * @var \Drupal\block\BlockInterface
   */
  protected $entity;

  /**
   * {@inheritdoc}
   */
  protected function setUpAuthorization($method) {
    switch ($method) {
      case 'GET':
        $this->entity
          ->setVisibilityConfig('user_role', [])
          ->save();
        break;
      case 'POST':
        $this
          ->grantPermissionsToTestedRole([
          'administer blocks',
        ]);
        break;
      case 'PATCH':
        $this
          ->grantPermissionsToTestedRole([
          'administer blocks',
        ]);
        break;
    }
  }

  /**
   * {@inheritdoc}
   */
  protected function createEntity() {
    $block = Block::create([
      'plugin' => 'llama_block',
      'region' => 'header',
      'id' => 'llama',
      'theme' => 'stark',
    ]);

    // All blocks can be viewed by the anonymous user by default. An interesting
    // side effect of this is that any anonymous user is also able to read the
    // corresponding block config entity via REST, even if an authentication
    // provider is configured for the block config entity REST resource! In
    // other words: Block entities do not distinguish between 'view' as in
    // "render on a page" and 'view' as in "read the configuration".
    // This prevents that.
    // @todo Fix this in https://www.drupal.org/node/2820315.
    $block
      ->setVisibilityConfig('user_role', [
      'id' => 'user_role',
      'roles' => [
        'non-existing-role' => 'non-existing-role',
      ],
      'negate' => FALSE,
      'context_mapping' => [
        'user' => '@user.current_user_context:current_user',
      ],
    ]);
    $block
      ->save();
    return $block;
  }

  /**
   * {@inheritdoc}
   */
  protected function getExpectedNormalizedEntity() {
    $normalization = [
      'uuid' => $this->entity
        ->uuid(),
      'id' => 'llama',
      'weight' => NULL,
      'langcode' => 'en',
      'status' => TRUE,
      'dependencies' => [
        'theme' => [
          'stark',
        ],
      ],
      'theme' => 'stark',
      'region' => 'header',
      'provider' => NULL,
      'plugin' => 'llama_block',
      'settings' => [
        'id' => 'broken',
        'label' => '',
        'provider' => 'core',
        'label_display' => 'visible',
      ],
      'visibility' => [],
    ];
    return $normalization;
  }

  /**
   * {@inheritdoc}
   */
  protected function getNormalizedPostEntity() {

    // @todo Update in https://www.drupal.org/node/2300677.
    return [];
  }

  /**
   * {@inheritdoc}
   */
  protected function getExpectedCacheContexts() {

    // @see ::createEntity()
    return [
      'url.site',
    ];
  }

  /**
   * {@inheritdoc}
   */
  protected function getExpectedCacheTags() {

    // Because the 'user.permissions' cache context is missing, the cache tag
    // for the anonymous user role is never added automatically.
    return array_values(array_diff(parent::getExpectedCacheTags(), [
      'config:user.role.anonymous',
    ]));
  }

  /**
   * {@inheritdoc}
   */
  protected function getExpectedUnauthorizedAccessMessage($method) {
    switch ($method) {
      case 'GET':
        return "The block visibility condition 'user_role' denied access.";
      default:
        return parent::getExpectedUnauthorizedAccessMessage($method);
    }
  }

  /**
   * {@inheritdoc}
   *
   * @todo Fix this in https://www.drupal.org/node/2820315.
   */
  protected function getExpectedUnauthorizedAccessCacheability() {
    return (new CacheableMetadata())
      ->setCacheTags([
      '4xx-response',
      'http_response',
    ])
      ->setCacheContexts([
      'user.roles',
    ]);
  }

  /**
   * {@inheritdoc}
   */
  protected function getExpectedUnauthorizedEntityAccessCacheability($is_authenticated) {

    // @see \Drupal\block\BlockAccessControlHandler::checkAccess()
    return parent::getExpectedUnauthorizedEntityAccessCacheability($is_authenticated)
      ->addCacheTags([
      'config:block.block.llama',
      $is_authenticated ? 'user:2' : 'user:0',
    ]);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
BlockResourceTestBase::$entity	protected	property
BlockResourceTestBase::$entityTypeId	protected static	property
BlockResourceTestBase::$modules	protected static	property		2
BlockResourceTestBase::createEntity	protected	function
BlockResourceTestBase::getExpectedCacheContexts	protected	function
BlockResourceTestBase::getExpectedCacheTags	protected	function
BlockResourceTestBase::getExpectedNormalizedEntity	protected	function
BlockResourceTestBase::getExpectedUnauthorizedAccessCacheability	protected	function	@todo Fix this in https://www.drupal.org/node/2820315.
BlockResourceTestBase::getExpectedUnauthorizedAccessMessage	protected	function
BlockResourceTestBase::getExpectedUnauthorizedEntityAccessCacheability	protected	function
BlockResourceTestBase::getNormalizedPostEntity	protected	function
BlockResourceTestBase::setUpAuthorization	protected	function