You are here

BlockConfigSchemaTest.php in Drupal 10

File

core/modules/block/tests/src/Kernel/BlockConfigSchemaTest.php
View source
<?php

namespace Drupal\Tests\block\Kernel;

use Drupal\block\Entity\Block;
use Drupal\Tests\SchemaCheckTestTrait;
use Drupal\KernelTests\KernelTestBase;

/**
 * Tests the block config schema.
 *
 * @group block
 */
class BlockConfigSchemaTest extends KernelTestBase {
  use SchemaCheckTestTrait;

  /**
   * {@inheritdoc}
   */
  protected static $modules = [
    'block',
    'book',
    'block_content',
    'comment',
    'forum',
    'node',
    'statistics',
    // \Drupal\block\Entity\Block->preSave() calls system_region_list().
    'system',
    'taxonomy',
    'user',
    'text',
  ];

  /**
   * The typed config manager.
   *
   * @var \Drupal\Core\Config\TypedConfigManagerInterface
   */
  protected $typedConfig;

  /**
   * The block manager.
   *
   * @var \Drupal\Core\Block\BlockManagerInterface
   */
  protected $blockManager;

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();
    $this->typedConfig = \Drupal::service('config.typed');
    $this->blockManager = \Drupal::service('plugin.manager.block');
    $this
      ->installEntitySchema('block_content');
    $this
      ->installEntitySchema('taxonomy_term');
    $this
      ->installEntitySchema('node');
    $this
      ->installSchema('book', [
      'book',
    ]);
  }

  /**
   * Tests the block config schema for block plugins.
   */
  public function testBlockConfigSchema() {
    foreach ($this->blockManager
      ->getDefinitions() as $block_id => $definition) {
      $id = strtolower($this
        ->randomMachineName());
      $block = Block::create([
        'id' => $id,
        'theme' => 'stark',
        'weight' => 00,
        'status' => TRUE,
        'region' => 'content',
        'plugin' => $block_id,
        'settings' => [
          'label' => $this
            ->randomMachineName(),
          'provider' => 'system',
          'label_display' => FALSE,
        ],
        'visibility' => [],
      ]);
      $block
        ->save();
      $config = $this
        ->config("block.block.{$id}");
      $this
        ->assertEquals($id, $config
        ->get('id'));
      $this
        ->assertConfigSchema($this->typedConfig, $config
        ->getName(), $config
        ->get());
    }
  }

}

Classes

Namesort descending Description
BlockConfigSchemaTest Tests the block config schema.