MigrateBlockTest.php 8.02 KB
Newer Older
1 2
<?php

3
namespace Drupal\Tests\block\Kernel\Migrate\d6;
4

5
use Drupal\block\Entity\Block;
6
use Drupal\Tests\migrate_drupal\Kernel\d6\MigrateDrupal6TestBase;
7 8

/**
9
 * Tests migration of blocks to configuration entities.
10
 *
11
 * @group migrate_drupal_6
12
 */
13
class MigrateBlockTest extends MigrateDrupal6TestBase {
14 15

  /**
16
   * {@inheritdoc}
17
   */
18
  public static $modules = [
19 20 21 22
    'block',
    'views',
    'comment',
    'menu_ui',
23
    'block_content',
24 25 26 27 28 29
    'taxonomy',
    'node',
    'aggregator',
    'book',
    'forum',
    'statistics',
30
  ];
31 32 33 34

  /**
   * {@inheritdoc}
   */
35
  protected function setUp() {
36
    parent::setUp();
37 38

    // Install the themes used for this test.
39
    $this->container->get('theme_installer')->install(['bartik', 'test_theme']);
40

41
    $this->installEntitySchema('block_content');
42
    $this->installConfig(['block_content']);
43

44
    // Set Bartik as the default public theme.
45
    $config = $this->config('system.theme');
46 47 48
    $config->set('default', 'bartik');
    $config->save();

49 50 51 52 53 54 55 56
    $this->executeMigrations([
      'd6_filter_format',
      'block_content_type',
      'block_content_body_field',
      'd6_custom_block',
      'd6_user_role',
      'd6_block',
    ]);
57
    block_rebuild();
58 59 60
  }

  /**
61 62 63 64 65 66 67 68 69 70 71 72
   * Asserts various aspects of a block.
   *
   * @param string $id
   *   The block ID.
   * @param array $visibility
   *   The block visibility settings.
   * @param string $region
   *   The display region.
   * @param string $theme
   *   The theme.
   * @param string $weight
   *   The block weight.
73 74
   * @param array $settings
   *   (optional) The block settings.
75 76
   * @param bool $status
   *   Whether the block is expected to be enabled or disabled.
77
   */
78
  public function assertEntity($id, $visibility, $region, $theme, $weight, array $settings = NULL, $status = TRUE) {
79 80
    $block = Block::load($id);
    $this->assertTrue($block instanceof Block);
81 82 83 84 85
    $this->assertSame($visibility, $block->getVisibility());
    $this->assertSame($region, $block->getRegion());
    $this->assertSame($theme, $block->getTheme());
    $this->assertSame($weight, $block->getWeight());
    $this->assertSame($status, $block->status());
86 87 88 89 90
    if ($settings) {
      $block_settings = $block->get('settings');
      $block_settings['id'] = current(explode(':', $block_settings['id']));
      $this->assertEquals($settings, $block_settings);
    }
91 92 93 94
  }

  /**
   * Tests the block migration.
95 96
   */
  public function testBlockMigration() {
97
    $blocks = Block::loadMultiple();
98
    $this->assertCount(14, $blocks);
99

100 101 102 103 104 105 106 107 108 109 110 111 112 113 114
    // Check user blocks.
    $visibility = [
      'request_path' => [
        'id' => 'request_path',
        'negate' => TRUE,
        'pages' => "<front>\n/node/1\n/blog/*",
      ],
    ];
    $settings = [
      'id' => 'user_login_block',
      'label' => '',
      'provider' => 'user',
      'label_display' => '0',
    ];
    $this->assertEntity('user', $visibility, 'sidebar_first', 'bartik', -10, $settings);
115 116

    $visibility = [];
117 118
    $settings = [
      'id' => 'system_menu_block',
119
      'label' => 'zu - Navigation',
120
      'provider' => 'system',
121
      'label_display' => 'visible',
122
      'level' => 1,
123
      'expand_all_items' => FALSE,
124 125 126
      'depth' => 0,
    ];
    $this->assertEntity('user_1', $visibility, 'sidebar_first', 'bartik', -11, $settings);
127

128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147
    $visibility = [
      'user_role' => [
        'id' => 'user_role',
        'roles' => [
          'authenticated' => 'authenticated',
        ],
        'context_mapping' => [
          'user' => '@user.current_user_context:current_user',
        ],
        'negate' => FALSE,
      ],
    ];
    $settings = [
      'id' => 'broken',
      'label' => '',
      'provider' => 'core',
      'label_display' => '0',
      'items_per_page' => '5',
    ];
    $this->assertEntity('user_2', $visibility, 'sidebar_second', 'bartik', -11, $settings);
148

149 150 151 152 153 154 155 156 157 158 159
    $visibility = [
      'user_role' => [
        'id' => 'user_role',
        'roles' => [
          'migrate_test_role_1' => 'migrate_test_role_1',
        ],
        'context_mapping' => [
          'user' => '@user.current_user_context:current_user',
        ],
        'negate' => FALSE,
      ],
160
    ];
161 162 163 164 165 166 167 168
    $settings = [
      'id' => 'broken',
      'label' => '',
      'provider' => 'core',
      'label_display' => '0',
      'items_per_page' => '10',
    ];
    $this->assertEntity('user_3', $visibility, 'sidebar_second', 'bartik', -10, $settings);
169

170 171 172 173 174 175 176 177 178 179 180 181 182 183 184
    // Check system block.
    $visibility = [
      'request_path' => [
        'id' => 'request_path',
        'negate' => TRUE,
        'pages' => '/node/1',
      ],
    ];
    $settings = [
      'id' => 'system_powered_by_block',
      'label' => '',
      'provider' => 'system',
      'label_display' => '0',
    ];
    $this->assertEntity('system', $visibility, 'footer_fifth', 'bartik', -5, $settings);
185

186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239
    // Check menu blocks.
    $settings = [
      'id' => 'broken',
      'label' => '',
      'provider' => 'core',
      'label_display' => '0',
    ];
    $this->assertEntity('menu', [], 'header', 'bartik', -5, $settings);

    // Check aggregator block.
    $settings = [
      'id' => 'aggregator_feed_block',
      'label' => '',
      'provider' => 'aggregator',
      'label_display' => '0',
      'block_count' => 7,
      'feed' => '5',
    ];
    $this->assertEntity('aggregator', [], 'sidebar_second', 'bartik', -2, $settings);

    // Check book block.
    $settings = [
      'id' => 'book_navigation',
      'label' => '',
      'provider' => 'book',
      'label_display' => '0',
      'block_mode' => 'book pages',
    ];
    $this->assertEntity('book', [], 'sidebar_second', 'bartik', -4, $settings);

    // Check forum block settings.
    $settings = [
      'id' => 'forum_active_block',
      'label' => '',
      'provider' => 'forum',
      'label_display' => '0',
      'block_count' => 3,
      'properties' => [
        'administrative' => '1',
      ],
    ];
    $this->assertEntity('forum', [], 'sidebar_first', 'bartik', -8, $settings);

    $settings = [
      'id' => 'forum_new_block',
      'label' => '',
      'provider' => 'forum',
      'label_display' => '0',
      'block_count' => 4,
      'properties' => [
        'administrative' => '1',
      ],
    ];
    $this->assertEntity('forum_1', [], 'sidebar_first', 'bartik', -9, $settings);
240

241 242 243 244 245 246 247 248 249 250 251
    // Check statistic block settings.
    $settings = [
      'id' => 'broken',
      'label' => '',
      'provider' => 'core',
      'label_display' => '0',
      'top_day_num' => 7,
      'top_all_num' => 8,
      'top_last_num' => 9,
    ];
    $this->assertEntity('statistics', [], 'sidebar_second', 'bartik', 0, $settings);
252

253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287
    // Check custom blocks.
    $visibility = [
      'request_path' => [
        'id' => 'request_path',
        'negate' => FALSE,
        'pages' => '<front>',
      ],
    ];
    $settings = [
      'id' => 'block_content',
      'label' => 'Static Block',
      'provider' => 'block_content',
      'label_display' => 'visible',
      'status' => TRUE,
      'info' => '',
      'view_mode' => 'full',
    ];
    $this->assertEntity('block', $visibility, 'content', 'bartik', 0, $settings);

    $visibility = [
      'request_path' => [
        'id' => 'request_path',
        'negate' => FALSE,
        'pages' => '/node',
      ],
    ];
    $settings = [
      'id' => 'block_content',
      'label' => 'Another Static Block',
      'provider' => 'block_content',
      'label_display' => 'visible',
      'status' => TRUE,
      'info' => '',
      'view_mode' => 'full',
    ];
288 289
    // We expect this block to be disabled because '' is not a valid region,
    // and block_rebuild() will disable any block in an invalid region.
290
    $this->assertEntity('block_1', $visibility, '', 'bluemarine', -4, $settings, FALSE);
291

292 293 294 295 296 297 298 299 300 301
    $settings = [
      'id' => 'block_content',
      'label' => '',
      'provider' => 'block_content',
      'label_display' => '0',
      'status' => TRUE,
      'info' => '',
      'view_mode' => 'full',
    ];
    $this->assertEntity('block_2', [], 'right', 'test_theme', -7, $settings);
302 303 304 305

    // Custom block with php code is not migrated.
    $block = Block::load('block_3');
    $this->assertFalse($block instanceof Block);
306
  }
307

308
}