MigrateBlockTest.php

<?php

declare (strict_types=1);
namespace Drupal\Tests\block\Kernel\Migrate\d7;

use Drupal\block\Entity\Block;
use Drupal\block_content\Entity\BlockContent;
use Drupal\Tests\migrate_drupal\Kernel\d7\MigrateDrupal7TestBase;

/**
 * Tests migration of blocks to configuration entities.
 *
 * @group block
 */
class MigrateBlockTest extends MigrateDrupal7TestBase {
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'block',
        'views',
        'comment',
        'menu_ui',
        'block_content',
        'node',
        'text',
        'filter',
        'path_alias',
        'user',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->installEntitySchema('path_alias');
        // Install the themes used for this test.
        $this->installEntitySchema('block_content');
        $this->container
            ->get('theme_installer')
            ->install([
            'olivero',
            'claro',
        ]);
        $this->installConfig(static::$modules);
        // Set Olivero and Claro as the default public and admin theme.
        $config = $this->config('system.theme');
        $config->set('default', 'olivero');
        $config->set('admin', 'claro');
        $config->save();
        $this->executeMigrations([
            'd7_filter_format',
            'd7_user_role',
            'block_content_type',
            'block_content_body_field',
            'd7_custom_block',
            'd7_block',
        ]);
        block_rebuild();
    }
    
    /**
     * Asserts various aspects of a block.
     *
     * @param string $id
     *   The block ID.
     * @param string $plugin_id
     *   The block's plugin ID.
     * @param array $roles
     *   Role IDs the block is expected to have.
     * @param string $pages
     *   The list of pages on which the block should appear.
     * @param string $region
     *   The display region.
     * @param string $theme
     *   The theme.
     * @param int $weight
     *   The block weight.
     * @param string $label
     *   The block label.
     * @param string $label_display
     *   The block label display setting.
     * @param bool $status
     *   Whether the block is expected to be enabled or disabled.
     *
     * @internal
     */
    public function assertEntity(string $id, string $plugin_id, array $roles, string $pages, string $region, string $theme, int $weight, string $label, string $label_display, bool $status = TRUE) : void {
        $block = Block::load($id);
        $this->assertInstanceOf(Block::class, $block);
        
        /** @var \Drupal\block\BlockInterface $block */
        $this->assertSame($plugin_id, $block->getPluginId());
        $visibility = $block->getVisibility();
        if ($roles) {
            $this->assertSame($roles, array_values($visibility['user_role']['roles']));
            $this->assertSame('@user.current_user_context:current_user', $visibility['user_role']['context_mapping']['user']);
        }
        if ($pages) {
            $this->assertSame($pages, $visibility['request_path']['pages']);
        }
        $this->assertSame($region, $block->getRegion());
        $this->assertSame($theme, $block->getTheme());
        $this->assertSame($weight, $block->getWeight());
        $this->assertSame($status, $block->status());
        $config = $this->config('block.block.' . $id);
        $this->assertSame($label, $config->get('settings.label'));
        $this->assertSame($label_display, $config->get('settings.label_display'));
    }
    
    /**
     * Tests the block migration.
     */
    public function testBlockMigration() : void {
        $this->assertEntity('bartik_system_main', 'system_main_block', [], '', 'content', 'olivero', 0, '', '0');
        $this->assertEntity('bartik_search_form', 'search_form_block', [], '', 'content', 'olivero', -1, '', '0');
        $this->assertEntity('bartik_user_login', 'user_login_block', [], '', 'content', 'olivero', 0, 'User login title', 'visible');
        $this->assertEntity('bartik_system_powered_by', 'system_powered_by_block', [], '', 'footer_bottom', 'olivero', 10, '', '0');
        $this->assertEntity('seven_system_main', 'system_main_block', [], '', 'content', 'claro', 0, '', '0');
        $this->assertEntity('seven_user_login', 'user_login_block', [], '', 'content', 'claro', 10, 'User login title', 'visible');
        // The d7_custom_block migration should have migrated a block containing a
        // mildly amusing limerick. We'll need its UUID to determine
        // bartik_block_1's plugin ID.
        $uuid = BlockContent::load(1)->uuid();
        $this->assertEntity('bartik_block_1', 'block_content:' . $uuid, [
            'authenticated',
        ], '', 'content', 'olivero', 0, 'Mildly amusing limerick of the day', 'visible');
        // Assert that disabled blocks (or enabled blocks whose plugin IDs could
        // be resolved) did not migrate.
        $non_existent_blocks = [
            'bartik_system_navigation',
            'bartik_system_help',
            'seven_user_new',
            'seven_search_form',
            'bartik_comment_recent',
            'bartik_node_syndicate',
            'bartik_node_recent',
            'bartik_shortcut_shortcuts',
            'bartik_system_management',
            'bartik_system_user-menu',
            'bartik_system_main-menu',
            'bartik_user_new',
            'bartik_user_online',
            'seven_comment_recent',
            'seven_node_syndicate',
            'seven_shortcut_shortcuts',
            'seven_system_powered-by',
            'seven_system_navigation',
            'seven_system_management',
            'seven_system_user-menu',
            'seven_system_main-menu',
            'seven_user_online',
            'bartik_blog_recent',
            'bartik_book_navigation',
            'bartik_locale_language',
            'bartik_forum_active',
            'bartik_forum_new',
            'seven_blog_recent',
            'seven_book_navigation',
            'seven_locale_language',
            'seven_forum_active',
            'seven_forum_new',
            'bartik_menu_menu-test-menu',
            'bartik_statistics_popular',
            'seven_menu_menu-test-menu',
            'seven_statistics_popular',
            'seven_block_1',
        ];
        $this->assertEmpty(Block::loadMultiple($non_existent_blocks));
    }

}