function BlockContentCacheTagsTest::testBlock

Same name in other branches
  1. 9 core/modules/block_content/tests/src/Functional/BlockContentCacheTagsTest.php \Drupal\Tests\block_content\Functional\BlockContentCacheTagsTest::testBlock()
  2. 8.9.x core/modules/block_content/tests/src/Functional/BlockContentCacheTagsTest.php \Drupal\Tests\block_content\Functional\BlockContentCacheTagsTest::testBlock()
  3. 10 core/modules/block_content/tests/src/Functional/BlockContentCacheTagsTest.php \Drupal\Tests\block_content\Functional\BlockContentCacheTagsTest::testBlock()

Tests that the block is cached with the correct contexts and tags.

File

core/modules/block_content/tests/src/Functional/BlockContentCacheTagsTest.php, line 78

Class

BlockContentCacheTagsTest
Tests the Content Block entity's cache tags.

Namespace

Drupal\Tests\block_content\Functional

Code

public function testBlock() : void {
    $block = $this->drupalPlaceBlock('block_content:' . $this->entity
        ->uuid());
    $build = $this->container
        ->get('entity_type.manager')
        ->getViewBuilder('block')
        ->view($block, 'block');
    // Render the block.
    $this->container
        ->get('renderer')
        ->renderRoot($build);
    // Expected keys, contexts, and tags for the block.
    // @see \Drupal\block\BlockViewBuilder::viewMultiple()
    $expected_block_cache_keys = [
        'entity_view',
        'block',
        $block->id(),
    ];
    $expected_block_cache_tags = Cache::mergeTags([
        'block_view',
        'rendered',
    ], $block->getCacheTags());
    $expected_block_cache_tags = Cache::mergeTags($expected_block_cache_tags, $block->getPlugin()
        ->getCacheTags());
    // Expected contexts and tags for the BlockContent entity.
    // @see \Drupal\Core\Entity\EntityViewBuilder::getBuildDefaults().
    $expected_entity_cache_tags = Cache::mergeTags([
        'block_content_view',
    ], $this->entity
        ->getCacheTags());
    $expected_entity_cache_tags = Cache::mergeTags($expected_entity_cache_tags, $this->getAdditionalCacheTagsForEntity($this->entity));
    // Verify that what was render cached matches the above expectations.
    $this->verifyRenderCache($expected_block_cache_keys, Cache::mergeTags($expected_block_cache_tags, $expected_entity_cache_tags), CacheableMetadata::createFromRenderArray($build));
}

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.