Update to Drupal 8.1.0. For more information, see https://www.drupal.org/drupal-8.1.0-release-notes

core/modules/block/tests/modules/block_test/src/ContextProvider/MultipleStaticContext.php

@@ -1,10 +1,5 @@
 <?php
 
-/**
- * @file
- * Contains \Drupal\block_test\ContextProvider\MultipleStaticContext.
- */
-
 namespace Drupal\block_test\ContextProvider;
 
 use Drupal\Core\Cache\CacheableMetadata;

core/modules/block/tests/modules/block_test/src/Controller/TestMultipleFormController.php

@@ -1,8 +1,4 @@
 <?php
-/**
- * @file
- * Contains \Drupal\block_test\Controller\TestMultipleFormController.
- */
 
 namespace Drupal\block_test\Controller;
 

core/modules/block/tests/modules/block_test/src/Form/FavoriteAnimalTestForm.php

@@ -1,10 +1,5 @@
 <?php
 
-/**
- * @file
- * Contains \Drupal\block_test\Form\FavoriteAnimalTestForm.
- */
-
 namespace Drupal\block_test\Form;
 
 use Drupal\Core\Form\FormBase;

core/modules/block/tests/modules/block_test/src/Form/TestForm.php

@@ -1,10 +1,5 @@
 <?php
 
-/**
- * @file
- * Contains \Drupal\block_test\Form\TestForm.
- */
-
 namespace Drupal\block_test\Form;
 
 use Drupal\Core\Form\FormBase;

core/modules/block/tests/modules/block_test/src/Plugin/Block/TestAccessBlock.php

@@ -1,10 +1,5 @@
 <?php
 
-/**
- * @file
- * Contains \Drupal\block_test\Plugin\Block\TestAccessBlock.
- */
-
 namespace Drupal\block_test\Plugin\Block;
 
 use Drupal\Core\Access\AccessResult;

core/modules/block/tests/modules/block_test/src/Plugin/Block/TestBlockInstantiation.php

@@ -1,10 +1,5 @@
 <?php
 
-/**
- * @file
- * Contains \Drupal\block_test\Plugin\Block\TestBlockInstantiation.
- */
-
 namespace Drupal\block_test\Plugin\Block;
 
 use Drupal\Core\Access\AccessResult;

core/modules/block/tests/modules/block_test/src/Plugin/Block/TestCacheBlock.php

@@ -1,10 +1,5 @@
 <?php
 
-/**
- * @file
- * Contains \Drupal\block_test\Plugin\Block\TestCacheBlock.
- */
-
 namespace Drupal\block_test\Plugin\Block;
 
 use Drupal\Core\Block\BlockBase;

core/modules/block/tests/modules/block_test/src/Plugin/Block/TestContextAwareBlock.php

@@ -1,10 +1,5 @@
 <?php
 
-/**
- * @file
- * Contains \Drupal\block_test\Plugin\Block\TestContextAwareBlock.
- */
-
 namespace Drupal\block_test\Plugin\Block;
 
 use Drupal\Core\Block\BlockBase;

core/modules/block/tests/modules/block_test/src/Plugin/Block/TestContextAwareUnsatisfiedBlock.php

@@ -1,10 +1,5 @@
 <?php
 
-/**
- * @file
- * Contains \Drupal\block_test\Plugin\Block\TestContextAwareUnsatisfiedBlock.
- */
-
 namespace Drupal\block_test\Plugin\Block;
 
 use Drupal\Core\Block\BlockBase;

core/modules/block/tests/modules/block_test/src/Plugin/Block/TestFormBlock.php

@@ -1,10 +1,5 @@
 <?php
 
-/**
- * @file
- * Contains \Drupal\block_test\Plugin\Block\TestFormBlock.
- */
-
 namespace Drupal\block_test\Plugin\Block;
 
 use Drupal\Core\Block\BlockBase;

core/modules/block/tests/modules/block_test/src/Plugin/Block/TestHtmlBlock.php

@@ -1,10 +1,5 @@
 <?php
 
-/**
- * @file
- * Contains \Drupal\block_test\Plugin\Block\TestHtmlBlock.
- */
-
 namespace Drupal\block_test\Plugin\Block;
 
 use Drupal\Core\Block\BlockBase;

core/modules/block/tests/modules/block_test/src/Plugin/Block/TestXSSTitleBlock.php

@@ -1,10 +1,5 @@
 <?php
 
-/**
- * @file
- * Contains \Drupal\block_test\Plugin\Block\TestXSSTitleBlock.
- */
-
 namespace Drupal\block_test\Plugin\Block;
 
 /**

core/modules/block/tests/modules/block_test/src/Plugin/Condition/BaloneySpam.php

@@ -1,10 +1,5 @@
 <?php
 
-/**
- * @file
- * Contains \Drupal\block_test\Plugin\Condition\BaloneySpam.
- */
-
 namespace Drupal\block_test\Plugin\Condition;
 
 use Drupal\Core\Condition\ConditionPluginBase;

core/modules/block/tests/src/Kernel/BlockConfigSchemaTest.php

@@ -0,0 +1,93 @@
+<?php
+
+namespace Drupal\Tests\block\Kernel;
+
+use Drupal\block\Entity\Block;
+use Drupal\config\Tests\SchemaCheckTestTrait;
+use Drupal\KernelTests\KernelTestBase;
+
+/**
+ * Tests the block config schema.
+ *
+ * @group block
+ */
+class BlockConfigSchemaTest extends KernelTestBase {
+
+  use SchemaCheckTestTrait;
+
+  /**
+   * {@inheritdoc}
+   */
+  public static $modules = array(
+    'block',
+    'aggregator',
+    'book',
+    'block_content',
+    'comment',
+    'forum',
+    'node',
+    'statistics',
+    // BlockManager->getModuleName() calls system_get_info().
+    '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() {
+    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', array('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(array(
+        'id' => $id,
+        'theme' => 'classy',
+        'weight' => 00,
+        'status' => TRUE,
+        'region' => 'content',
+        'plugin' => $block_id,
+        'settings' => array(
+          'label' => $this->randomMachineName(),
+          'provider' => 'system',
+          'label_display' => FALSE,
+        ),
+        'visibility' => array(),
+      ));
+      $block->save();
+
+      $config = $this->config("block.block.$id");
+      $this->assertEqual($config->get('id'), $id);
+      $this->assertConfigSchema($this->typedConfig, $config->getName(), $config->get());
+    }
+  }
+
+}

core/modules/block/tests/src/Kernel/BlockInterfaceTest.php

@@ -0,0 +1,102 @@
+<?php
+
+namespace Drupal\Tests\block\Kernel;
+
+use Drupal\Core\Form\FormState;
+use Drupal\block\BlockInterface;
+use Drupal\KernelTests\KernelTestBase;
+
+/**
+ * Tests that the block plugin can work properly without a supporting entity.
+ *
+ * @group block
+ */
+class BlockInterfaceTest extends KernelTestBase {
+
+  public static $modules = array('system', 'block', 'block_test', 'user');
+
+  /**
+   * Test configuration and subsequent form() and build() method calls.
+   *
+   * This test is attempting to test the existing block plugin api and all
+   * functionality that is expected to remain consistent. The arrays that are
+   * used for comparison can change, but only to include elements that are
+   * contained within BlockBase or the plugin being tested. Likely these
+   * comparison arrays should get smaller, not larger, as more form/build
+   * elements are moved into a more suitably responsible class.
+   *
+   * Instantiation of the plugin is the primary element being tested here. The
+   * subsequent method calls are just attempting to cause a failure if a
+   * dependency outside of the plugin configuration is required.
+   */
+  public function testBlockInterface() {
+    $manager = $this->container->get('plugin.manager.block');
+    $configuration = array(
+      'label' => 'Custom Display Message',
+    );
+    $expected_configuration = array(
+      'id' => 'test_block_instantiation',
+      'label' => 'Custom Display Message',
+      'provider' => 'block_test',
+      'label_display' => BlockInterface::BLOCK_LABEL_VISIBLE,
+      'display_message' => 'no message set',
+    );
+    // Initial configuration of the block at construction time.
+    /** @var $display_block \Drupal\Core\Block\BlockPluginInterface */
+    $display_block = $manager->createInstance('test_block_instantiation', $configuration);
+    $this->assertIdentical($display_block->getConfiguration(), $expected_configuration, 'The block was configured correctly.');
+
+    // Updating an element of the configuration.
+    $display_block->setConfigurationValue('display_message', 'My custom display message.');
+    $expected_configuration['display_message'] = 'My custom display message.';
+    $this->assertIdentical($display_block->getConfiguration(), $expected_configuration, 'The block configuration was updated correctly.');
+    $definition = $display_block->getPluginDefinition();
+
+    $expected_form = array(
+      'provider' => array(
+        '#type' => 'value',
+        '#value' => 'block_test',
+      ),
+      'admin_label' => array(
+        '#type' => 'item',
+        '#title' => t('Block description'),
+        '#plain_text' => $definition['admin_label'],
+      ),
+      'label' => array(
+        '#type' => 'textfield',
+        '#title' => 'Title',
+        '#maxlength' => 255,
+        '#default_value' => 'Custom Display Message',
+        '#required' => TRUE,
+      ),
+      'label_display' => array(
+        '#type' => 'checkbox',
+        '#title' => 'Display title',
+        '#default_value' => TRUE,
+        '#return_value' => 'visible',
+      ),
+      'context_mapping' => array(),
+      'display_message' => array(
+        '#type' => 'textfield',
+        '#title' => t('Display message'),
+        '#default_value' => 'My custom display message.',
+      ),
+    );
+    $form_state = new FormState();
+    // Ensure there are no form elements that do not belong to the plugin.
+    $actual_form = $display_block->buildConfigurationForm(array(), $form_state);
+    // Remove the visibility sections, as that just tests condition plugins.
+    unset($actual_form['visibility'], $actual_form['visibility_tabs']);
+    $this->assertIdentical($this->castSafeStrings($actual_form), $this->castSafeStrings($expected_form), 'Only the expected form elements were present.');
+
+    $expected_build = array(
+      '#children' => 'My custom display message.',
+    );
+    // Ensure the build array is proper.
+    $this->assertIdentical($display_block->build(), $expected_build, 'The plugin returned the appropriate build array.');
+
+    // Ensure the machine name suggestion is correct. In truth, this is actually
+    // testing BlockBase's implementation, not the interface itself.
+    $this->assertIdentical($display_block->getMachineNameSuggestion(), 'displaymessage', 'The plugin returned the expected machine name suggestion.');
+  }
+}

core/modules/block/tests/src/Kernel/BlockStorageUnitTest.php

@@ -0,0 +1,155 @@
+<?php
+
+namespace Drupal\Tests\block\Kernel;
+
+use Drupal\Core\Config\Entity\ConfigEntityStorage;
+use Drupal\KernelTests\KernelTestBase;
+use Drupal\block_test\Plugin\Block\TestHtmlBlock;
+use Drupal\Component\Plugin\Exception\PluginException;
+use Drupal\block\Entity\Block;
+use Drupal\block\BlockInterface;
+
+/**
+ * Tests the storage of blocks.
+ *
+ * @group block
+ */
+class BlockStorageUnitTest extends KernelTestBase {
+
+  /**
+   * Modules to install.
+   *
+   * @var array
+   */
+  public static $modules = array('block', 'block_test', 'system');
+
+  /**
+   * The block storage.
+   *
+   * @var \Drupal\Core\Config\Entity\ConfigEntityStorageInterface.
+   */
+  protected $controller;
+
+  protected function setUp() {
+    parent::setUp();
+
+    $this->controller = $this->container->get('entity_type.manager')->getStorage('block');
+  }
+
+  /**
+   * Tests CRUD operations.
+   */
+  public function testBlockCRUD() {
+    $this->assertTrue($this->controller instanceof ConfigEntityStorage, 'The block storage is loaded.');
+
+    // Run each test method in the same installation.
+    $this->createTests();
+    $this->loadTests();
+    $this->deleteTests();
+  }
+
+  /**
+   * Tests the creation of blocks.
+   */
+  protected function createTests() {
+    // Attempt to create a block without a plugin.
+    try {
+      $entity = $this->controller->create(array());
+      $entity->getPlugin();
+      $this->fail('A block without a plugin was created with no exception thrown.');
+    }
+    catch (PluginException $e) {
+      $this->assertEqual('The block \'\' did not specify a plugin.', $e->getMessage(), 'An exception was thrown when a block was created without a plugin.');
+    }
+
+    // Create a block with only required values.
+    $entity = $this->controller->create(array(
+      'id' => 'test_block',
+      'theme' => 'stark',
+      'plugin' => 'test_html',
+    ));
+    $entity->save();
+
+    $this->assertTrue($entity instanceof Block, 'The newly created entity is a Block.');
+
+    // Verify all of the block properties.
+    $actual_properties = $this->config('block.block.test_block')->get();
+    $this->assertTrue(!empty($actual_properties['uuid']), 'The block UUID is set.');
+    unset($actual_properties['uuid']);
+
+    // Ensure that default values are filled in.
+    $expected_properties = array(
+      'langcode' => \Drupal::languageManager()->getDefaultLanguage()->getId(),
+      'status' => TRUE,
+      'dependencies' => array('module' => array('block_test'), 'theme' => array('stark')),
+      'id' => 'test_block',
+      'theme' => 'stark',
+      'region' => '-1',
+      'weight' => NULL,
+      'provider' => NULL,
+      'plugin' => 'test_html',
+      'settings' => array(
+        'id' => 'test_html',
+        'label' => '',
+        'provider' => 'block_test',
+        'label_display' => BlockInterface::BLOCK_LABEL_VISIBLE,
+      ),
+      'visibility' => array(),
+    );
+
+    $this->assertIdentical($actual_properties, $expected_properties);
+
+    $this->assertTrue($entity->getPlugin() instanceof TestHtmlBlock, 'The entity has an instance of the correct block plugin.');
+  }
+
+  /**
+   * Tests the loading of blocks.
+   */
+  protected function loadTests() {
+    $entity = $this->controller->load('test_block');
+
+    $this->assertTrue($entity instanceof Block, 'The loaded entity is a Block.');
+
+    // Verify several properties of the block.
+    $this->assertEqual($entity->getRegion(), '-1');
+    $this->assertTrue($entity->status());
+    $this->assertEqual($entity->getTheme(), 'stark');
+    $this->assertTrue($entity->uuid());
+  }
+
+  /**
+   * Tests the deleting of blocks.
+   */
+  protected function deleteTests() {
+    $entity = $this->controller->load('test_block');
+
+    // Ensure that the storage isn't currently empty.
+    $config_storage = $this->container->get('config.storage');
+    $config = $config_storage->listAll('block.block.');
+    $this->assertFalse(empty($config), 'There are blocks in config storage.');
+
+    // Delete the block.
+    $entity->delete();
+
+    // Ensure that the storage is now empty.
+    $config = $config_storage->listAll('block.block.');
+    $this->assertTrue(empty($config), 'There are no blocks in config storage.');
+  }
+
+  /**
+   * Tests the installation of default blocks.
+   */
+  public function testDefaultBlocks() {
+    \Drupal::service('theme_handler')->install(['classy']);
+    $entities = $this->controller->loadMultiple();
+    $this->assertTrue(empty($entities), 'There are no blocks initially.');
+
+    // Install the block_test.module, so that its default config is installed.
+    $this->installConfig(array('block_test'));
+
+    $entities = $this->controller->loadMultiple();
+    $entity = reset($entities);
+    $this->assertEqual($entity->id(), 'test_block', 'The default test block was loaded.');
+  }
+
+}

core/modules/block/tests/src/Kernel/BlockViewBuilderTest.php

@@ -0,0 +1,328 @@
+<?php
+
+namespace Drupal\Tests\block\Kernel;
+
+use Drupal\Component\Utility\Html;
+use Drupal\Core\Cache\Cache;
+use Drupal\Core\Language\LanguageInterface;
+use Drupal\KernelTests\KernelTestBase;
+use Drupal\block\Entity\Block;
+
+/**
+ * Tests the block view builder.
+ *
+ * @group block
+ */
+class BlockViewBuilderTest extends KernelTestBase {
+
+  /**
+   * Modules to install.
+   *
+   * @var array
+   */
+  public static $modules = array('block', 'block_test', 'system', 'user');
+
+  /**
+   * The block being tested.
+   *
+   * @var \Drupal\block\Entity\BlockInterface
+   */
+  protected $block;
+
+  /**
+   * The block storage.
+   *
+   * @var \Drupal\Core\Config\Entity\ConfigEntityStorageInterface
+   */
+  protected $controller;
+
+  /**
+   * The renderer.
+   *
+   * @var \Drupal\Core\Render\RendererInterface
+   */
+  protected $renderer;
+
+  /**
+   * {@inheritdoc}
+   */
+  protected function setUp() {
+    parent::setUp();
+
+    $this->controller = $this->container
+      ->get('entity_type.manager')
+      ->getStorage('block');
+
+    \Drupal::state()->set('block_test.content', 'Llamas &gt; unicorns!');
+
+    // Create a block with only required values.
+    $this->block = $this->controller->create(array(
+      'id' => 'test_block',
+      'theme' => 'stark',
+      'plugin' => 'test_cache',
+    ));
+    $this->block->save();
+
+    $this->container->get('cache.render')->deleteAll();
+
+    $this->renderer = $this->container->get('renderer');
+  }
+
+  /**
+   * Tests the rendering of blocks.
+   */
+  public function testBasicRendering() {
+    \Drupal::state()->set('block_test.content', '');
+
+    $entity = $this->controller->create(array(
+      'id' => 'test_block1',
+      'theme' => 'stark',
+      'plugin' => 'test_html',
+    ));
+    $entity->save();
+
+    // Test the rendering of a block.
+    $entity = Block::load('test_block1');
+    $output = entity_view($entity, 'block');
+    $expected = array();
+    $expected[] = '<div id="block-test-block1">';
+    $expected[] = '  ';
+    $expected[] = '    ';
+    $expected[] = '      ';
+    $expected[] = '  </div>';
+    $expected[] = '';
+    $expected_output = implode("\n", $expected);
+    $this->assertEqual($this->renderer->renderRoot($output), $expected_output);
+
+    // Reset the HTML IDs so that the next render is not affected.
+    Html::resetSeenIds();
+
+    // Test the rendering of a block with a given title.
+    $entity = $this->controller->create(array(
+      'id' => 'test_block2',
+      'theme' => 'stark',
+      'plugin' => 'test_html',
+      'settings' => array(
+        'label' => 'Powered by Bananas',
+      ),
+    ));
+    $entity->save();
+    $output = entity_view($entity, 'block');
+    $expected = array();
+    $expected[] = '<div id="block-test-block2">';
+    $expected[] = '  ';
+    $expected[] = '      <h2>Powered by Bananas</h2>';
+    $expected[] = '    ';
+    $expected[] = '      ';
+    $expected[] = '  </div>';
+    $expected[] = '';
+    $expected_output = implode("\n", $expected);
+    $this->assertEqual($this->renderer->renderRoot($output), $expected_output);
+  }
+
+  /**
+   * Tests block render cache handling.
+   */
+  public function testBlockViewBuilderCache() {
+    // Verify cache handling for a non-empty block.
+    $this->verifyRenderCacheHandling();
+
+    // Create an empty block.
+    $this->block = $this->controller->create(array(
+      'id' => 'test_block',
+      'theme' => 'stark',
+      'plugin' => 'test_cache',
+    ));
+    $this->block->save();
+    \Drupal::state()->set('block_test.content', NULL);
+
+    // Verify cache handling for an empty block.
+    $this->verifyRenderCacheHandling();
+  }
+
+  /**
+   * Verifies render cache handling of the block being tested.
+   *
+   * @see ::testBlockViewBuilderCache()
+   */
+  protected function verifyRenderCacheHandling() {
+    // Force a request via GET so we can test the render cache.
+    $request = \Drupal::request();
+    $request_method = $request->server->get('REQUEST_METHOD');
+    $request->setMethod('GET');
+
+    // Test that a cache entry is created.
+    $build = $this->getBlockRenderArray();
+    $cid = 'entity_view:block:test_block:' . implode(':', \Drupal::service('cache_contexts_manager')->convertTokensToKeys(['languages:' . LanguageInterface::TYPE_INTERFACE, 'theme', 'user.permissions'])->getKeys());
+    $this->renderer->renderRoot($build);
+    $this->assertTrue($this->container->get('cache.render')->get($cid), 'The block render element has been cached.');
+
+    // Re-save the block and check that the cache entry has been deleted.
+    $this->block->save();
+    $this->assertFalse($this->container->get('cache.render')->get($cid), 'The block render cache entry has been cleared when the block was saved.');
+
+    // Rebuild the render array (creating a new cache entry in the process) and
+    // delete the block to check the cache entry is deleted.
+    unset($build['#printed']);
+    // Re-add the block because \Drupal\block\BlockViewBuilder::buildBlock()
+    // removes it.
+    $build['#block'] = $this->block;
+
+    $this->renderer->renderRoot($build);
+    $this->assertTrue($this->container->get('cache.render')->get($cid), 'The block render element has been cached.');
+    $this->block->delete();
+    $this->assertFalse($this->container->get('cache.render')->get($cid), 'The block render cache entry has been cleared when the block was deleted.');
+
+    // Restore the previous request method.
+    $request->setMethod($request_method);
+  }
+
+  /**
+   * Tests block view altering.
+   *
+   * @see hook_block_view_alter()
+   * @see hook_block_view_BASE_BLOCK_ID_alter()
+   */
+  public function testBlockViewBuilderViewAlter() {
+    // Establish baseline.
+    $build = $this->getBlockRenderArray();
+    $this->setRawContent((string) $this->renderer->renderRoot($build));
+    $this->assertIdentical(trim((string) $this->cssSelect('div')[0]), 'Llamas > unicorns!');
+
+    // Enable the block view alter hook that adds a foo=bar attribute.
+    \Drupal::state()->set('block_test_view_alter_suffix', TRUE);
+    Cache::invalidateTags($this->block->getCacheTagsToInvalidate());
+    $build = $this->getBlockRenderArray();
+    $this->setRawContent((string) $this->renderer->renderRoot($build));
+    $this->assertIdentical(trim((string) $this->cssSelect('[foo=bar]')[0]), 'Llamas > unicorns!');
+    \Drupal::state()->set('block_test_view_alter_suffix', FALSE);
+
+    \Drupal::state()->set('block_test.content', NULL);
+    Cache::invalidateTags($this->block->getCacheTagsToInvalidate());
+
+    // Advanced: cached block, but an alter hook adds a #pre_render callback to
+    // alter the eventual content.
+    \Drupal::state()->set('block_test_view_alter_append_pre_render_prefix', TRUE);
+    $build = $this->getBlockRenderArray();
+    $this->assertFalse(isset($build['#prefix']), 'The appended #pre_render callback has not yet run before rendering.');
+    $this->assertIdentical((string) $this->renderer->renderRoot($build), 'Hiya!<br>');
+    $this->assertTrue(isset($build['#prefix']) && $build['#prefix'] === 'Hiya!<br>', 'A cached block without content is altered.');
+  }
+
+  /**
+   * Tests block build altering.
+   *
+   * @see hook_block_build_alter()
+   * @see hook_block_build_BASE_BLOCK_ID_alter()
+   */
+  public function testBlockViewBuilderBuildAlter() {
+    // Force a request via GET so we can test the render cache.
+    $request = \Drupal::request();
+    $request_method = $request->server->get('REQUEST_METHOD');
+    $request->setMethod('GET');
+
+    $default_keys = ['entity_view', 'block', 'test_block'];
+    $default_contexts = [];
+    $default_tags = ['block_view', 'config:block.block.test_block'];
+    $default_max_age = Cache::PERMANENT;
+
+    // hook_block_build_alter() adds an additional cache key.
+    $alter_add_key = $this->randomMachineName();
+    \Drupal::state()->set('block_test_block_alter_cache_key', $alter_add_key);
+    $this->assertBlockRenderedWithExpectedCacheability(array_merge($default_keys, [$alter_add_key]), $default_contexts, $default_tags, $default_max_age);
+    \Drupal::state()->set('block_test_block_alter_cache_key', NULL);
+
+    // hook_block_build_alter() adds an additional cache context.
+    $alter_add_context = 'url.query_args:' . $this->randomMachineName();
+    \Drupal::state()->set('block_test_block_alter_cache_context', $alter_add_context);
+    $this->assertBlockRenderedWithExpectedCacheability($default_keys, Cache::mergeContexts($default_contexts, [$alter_add_context]), $default_tags, $default_max_age);
+    \Drupal::state()->set('block_test_block_alter_cache_context', NULL);
+
+    // hook_block_build_alter() adds an additional cache tag.
+    $alter_add_tag = $this->randomMachineName();
+    \Drupal::state()->set('block_test_block_alter_cache_tag', $alter_add_tag);
+    $this->assertBlockRenderedWithExpectedCacheability($default_keys, $default_contexts, Cache::mergeTags($default_tags, [$alter_add_tag]), $default_max_age);
+    \Drupal::state()->set('block_test_block_alter_cache_tag', NULL);
+
+    // hook_block_build_alter() alters the max-age.
+    $alter_max_age = 300;
+    \Drupal::state()->set('block_test_block_alter_cache_max_age', $alter_max_age);
+    $this->assertBlockRenderedWithExpectedCacheability($default_keys, $default_contexts, $default_tags, $alter_max_age);
+    \Drupal::state()->set('block_test_block_alter_cache_max_age', NULL);
+
+    // hook_block_build_alter() alters cache keys, contexts, tags and max-age.
+    \Drupal::state()->set('block_test_block_alter_cache_key', $alter_add_key);
+    \Drupal::state()->set('block_test_block_alter_cache_context', $alter_add_context);
+    \Drupal::state()->set('block_test_block_alter_cache_tag', $alter_add_tag);
+    \Drupal::state()->set('block_test_block_alter_cache_max_age', $alter_max_age);
+    $this->assertBlockRenderedWithExpectedCacheability(array_merge($default_keys, [$alter_add_key]), Cache::mergeContexts($default_contexts, [$alter_add_context]), Cache::mergeTags($default_tags, [$alter_add_tag]), $alter_max_age);
+    \Drupal::state()->set('block_test_block_alter_cache_key', NULL);
+    \Drupal::state()->set('block_test_block_alter_cache_context', NULL);
+    \Drupal::state()->set('block_test_block_alter_cache_tag', NULL);
+    \Drupal::state()->set('block_test_block_alter_cache_max_age', NULL);
+
+    // hook_block_build_alter() sets #create_placeholder.
+    foreach ([TRUE, FALSE] as $value) {
+      \Drupal::state()->set('block_test_block_alter_create_placeholder', $value);
+      $build = $this->getBlockRenderArray();
+      $this->assertTrue(isset($build['#create_placeholder']));
+      $this->assertIdentical($value, $build['#create_placeholder']);
+    }
+    \Drupal::state()->set('block_test_block_alter_create_placeholder', NULL);
+
+    // Restore the previous request method.
+    $request->setMethod($request_method);
+  }
+
+  /**
+   * Asserts that a block is built/rendered/cached with expected cacheability.
+   *
+   * @param string[] $expected_keys
+   *   The expected cache keys.
+   * @param string[] $expected_contexts
+   *   The expected cache contexts.
+   * @param string[] $expected_tags
+   *   The expected cache tags.
+   * @param int $expected_max_age
+   *   The expected max-age.
+   */
+  protected function assertBlockRenderedWithExpectedCacheability(array $expected_keys, array $expected_contexts, array $expected_tags, $expected_max_age) {
+    $required_cache_contexts = ['languages:' . LanguageInterface::TYPE_INTERFACE, 'theme', 'user.permissions'];
+
+    // Check that the expected cacheability metadata is present in:
+    // - the built render array;
+    $this->pass('Built render array');
+    $build = $this->getBlockRenderArray();
+    $this->assertIdentical($expected_keys, $build['#cache']['keys']);
+    $this->assertIdentical($expected_contexts, $build['#cache']['contexts']);
+    $this->assertIdentical($expected_tags, $build['#cache']['tags']);
+    $this->assertIdentical($expected_max_age, $build['#cache']['max-age']);
+    $this->assertFalse(isset($build['#create_placeholder']));
+    // - the rendered render array;
+    $this->pass('Rendered render array');
+    $this->renderer->renderRoot($build);
+    // - the render cache item.
+    $this->pass('Render cache item');
+    $final_cache_contexts = Cache::mergeContexts($expected_contexts, $required_cache_contexts);
+    $cid = implode(':', $expected_keys) . ':' . implode(':', \Drupal::service('cache_contexts_manager')->convertTokensToKeys($final_cache_contexts)->getKeys());
+    $cache_item = $this->container->get('cache.render')->get($cid);
+    $this->assertTrue($cache_item, 'The block render element has been cached with the expected cache ID.');
+    $this->assertIdentical(Cache::mergeTags($expected_tags, ['rendered']), $cache_item->tags);
+    $this->assertIdentical($final_cache_contexts, $cache_item->data['#cache']['contexts']);
+    $this->assertIdentical($expected_tags, $cache_item->data['#cache']['tags']);
+    $this->assertIdentical($expected_max_age, $cache_item->data['#cache']['max-age']);
+
+    $this->container->get('cache.render')->delete($cid);
+  }
+
+  /**
+   * Get a fully built render array for a block.
+   *
+   * @return array
+   *   The render array.
+   */
+  protected function getBlockRenderArray() {
+    return $this->container->get('entity_type.manager')->getViewBuilder('block')->view($this->block, 'block');
+  }
+
+}

core/modules/block/tests/src/Kernel/Migrate/d6/MigrateBlockTest.php

@@ -0,0 +1,150 @@
+<?php
+
+namespace Drupal\Tests\block\Kernel\Migrate\d6;
+
+use Drupal\block\Entity\Block;
+use Drupal\Tests\migrate_drupal\Kernel\d6\MigrateDrupal6TestBase;
+
+/**
+ * Tests migration of blocks to configuration entities.
+ *
+ * @group migrate_drupal_6
+ */
+class MigrateBlockTest extends MigrateDrupal6TestBase {
+
+  /**
+   * {@inheritdoc}
+   */
+  public static $modules = [
+    'block',
+    'views',
+    'comment',
+    'menu_ui',
+    'block_content',
+  ];
+
+  /**
+   * {@inheritdoc}
+   */
+  protected function setUp() {
+    parent::setUp();
+    $this->installConfig(['block_content']);
+    $this->installEntitySchema('block_content');
+
+    // Set Bartik and Seven as the default public and admin theme.
+    $config = $this->config('system.theme');
+    $config->set('default', 'bartik');
+    $config->set('admin', 'seven');
+    $config->save();
+
+    // Install one of D8's test themes.
+    \Drupal::service('theme_handler')->install(['test_theme']);
+
+    $this->executeMigrations([
+      'd6_filter_format',
+      'block_content_type',
+      'block_content_body_field',
+      'd6_custom_block',
+      'menu',
+      'd6_user_role',
+      'd6_block',
+    ]);
+  }
+
+  /**
+   * 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.
+   * @param string $label
+   *   The block label.
+   * @param string $label_display
+   *   The block label display setting.
+   */
+  public function assertEntity($id, $visibility, $region, $theme, $weight, $label, $label_display) {
+    $block = Block::load($id);
+    $this->assertTrue($block instanceof Block);
+    $this->assertIdentical($visibility, $block->getVisibility());
+    $this->assertIdentical($region, $block->getRegion());
+    $this->assertIdentical($theme, $block->getTheme());
+    $this->assertIdentical($weight, $block->getWeight());
+
+    $config = $this->config('block.block.' . $id);
+    $this->assertIdentical($label, $config->get('settings.label'));
+    $this->assertIdentical($label_display, $config->get('settings.label_display'));
+  }
+
+  /**
+   * Tests the block migration.
+   */
+  public function testBlockMigration() {
+    $blocks = Block::loadMultiple();
+    $this->assertIdentical(9, count($blocks));
+
+    // User blocks
+    $visibility = [];
+    $visibility['request_path']['id'] = 'request_path';
+    $visibility['request_path']['negate'] = TRUE;
+    $visibility['request_path']['pages'] = "<front>\n/node/1\n/blog/*";
+    $this->assertEntity('user', $visibility, 'sidebar_first', 'bartik', 0, '', '0');
+
+    $visibility = [];
+    $this->assertEntity('user_1', $visibility, 'sidebar_first', 'bartik', 0, '', '0');
+
+    $visibility['user_role']['id'] = 'user_role';
+    $roles['authenticated'] = 'authenticated';
+    $visibility['user_role']['roles'] = $roles;
+    $context_mapping['user'] = '@user.current_user_context:current_user';
+    $visibility['user_role']['context_mapping'] = $context_mapping;
+    $visibility['user_role']['negate'] = FALSE;
+    $this->assertEntity('user_2', $visibility, 'sidebar_second', 'bartik', -9, '', '0');
+
+    $visibility = [];
+    $visibility['user_role']['id'] = 'user_role';
+    $visibility['user_role']['roles'] = [
+      'migrate_test_role_1' => 'migrate_test_role_1'
+    ];
+    $context_mapping['user'] = '@user.current_user_context:current_user';
+    $visibility['user_role']['context_mapping'] = $context_mapping;
+    $visibility['user_role']['negate'] = FALSE;
+    $this->assertEntity('user_3', $visibility, 'sidebar_second', 'bartik', -6, '', '0');
+
+    // Check system block
+    $visibility = [];
+    $visibility['request_path']['id'] = 'request_path';
+    $visibility['request_path']['negate'] = TRUE;
+    $visibility['request_path']['pages'] = '/node/1';
+    $this->assertEntity('system', $visibility, 'footer', 'bartik', -5, '', '0');
+
+    // Check menu blocks
+    $visibility = [];
+    $this->assertEntity('menu', $visibility, 'header', 'bartik', -5, '', '0');
+
+    // Check custom blocks
+    $visibility['request_path']['id'] = 'request_path';
+    $visibility['request_path']['negate'] = FALSE;
+    $visibility['request_path']['pages'] = '<front>';
+    $this->assertEntity('block', $visibility, 'content', 'bartik', 0, 'Static Block', 'visible');
+
+    $visibility['request_path']['id'] = 'request_path';
+    $visibility['request_path']['negate'] = FALSE;
+    $visibility['request_path']['pages'] = '/node';
+    $this->assertEntity('block_1', $visibility, 'sidebar_second', 'bluemarine', -4, 'Another Static Block', 'visible');
+
+    $visibility = [];
+    $this->assertEntity('block_2', $visibility, 'right', 'test_theme', -7, '', '0');
+
+    // Custom block with php code is not migrated.
+    $block = Block::load('block_3');
+    $this->assertFalse($block instanceof Block);
+  }
+
+}

core/modules/block/tests/src/Kernel/Migrate/d7/MigrateBlockTest.php

@@ -0,0 +1,165 @@
+<?php
+
+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}
+   */
+  static $modules = [
+    'block',
+    'views',
+    'comment',
+    'menu_ui',
+    'block_content',
+    'node',
+    'text',
+    'filter',
+    'user',
+  ];
+
+  /**
+   * {@inheritdoc}
+   */
+  protected function setUp() {
+    parent::setUp();
+    $this->installConfig(static::$modules);
+    $this->installEntitySchema('block_content');
+
+    // Set Bartik and Seven as the default public and admin theme.
+    $config = $this->config('system.theme');
+    $config->set('default', 'bartik');
+    $config->set('admin', 'seven');
+    $config->save();
+
+    // Install one of D8's test themes.
+    \Drupal::service('theme_handler')->install(['bartik']);
+
+    $this->executeMigrations([
+      'd7_filter_format',
+      'd7_user_role',
+      'block_content_type',
+      'block_content_body_field',
+      'd7_custom_block',
+      'd7_block',
+    ]);
+  }
+
+  /**
+   * 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 string $weight
+   *   The block weight.
+   * @param string $label
+   *   The block label.
+   * @param string $label_display
+   *   The block label display setting.
+   */
+  public function assertEntity($id, $plugin_id, array $roles, $pages, $region, $theme, $weight, $label, $label_display) {
+    $block = Block::load($id);
+    $this->assertTrue($block instanceof Block);
+    /** @var \Drupal\block\BlockInterface $block */
+    $this->assertIdentical($plugin_id, $block->getPluginId());
+
+    $visibility = $block->getVisibility();
+    if ($roles) {
+      $this->assertIdentical($roles, array_values($visibility['user_role']['roles']));
+      $this->assertIdentical('@user.current_user_context:current_user', $visibility['user_role']['context_mapping']['user']);
+    }
+    if ($pages) {
+      $this->assertIdentical($pages, $visibility['request_path']['pages']);
+    }
+
+    $this->assertIdentical($region, $block->getRegion());
+    $this->assertIdentical($theme, $block->getTheme());
+    $this->assertIdentical($weight, $block->getWeight());
+
+    $config = $this->config('block.block.' . $id);
+    $this->assertIdentical($label, $config->get('settings.label'));
+    $this->assertIdentical($label_display, $config->get('settings.label_display'));
+  }
+
+  /**
+   * Tests the block migration.
+   */
+  public function testBlockMigration() {
+    $this->assertEntity('bartik_system_main', 'system_main_block', [], '', 'content', 'bartik', 0, '', '0');
+    $this->assertEntity('bartik_search_form', 'search_form_block', [], '', 'sidebar_first', 'bartik', -1, '', '0');
+    $this->assertEntity('bartik_user_login', 'user_login_block', [], '', 'sidebar_first', 'bartik', 0, '', '0');
+    $this->assertEntity('bartik_system_powered-by', 'system_powered_by_block', [], '', 'footer', 'bartik', 10, '', '0');
+    $this->assertEntity('seven_system_main', 'system_main_block', [], '', 'content', 'seven', 0, '', '0');
+    $this->assertEntity('seven_user_login', 'user_login_block', [], '', 'content', 'seven', 10, '', '0');
+
+    // 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'], '', 'highlighted', 'bartik', 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->assertTrue(empty(Block::loadMultiple($non_existent_blocks)));
+  }
+
+}

core/modules/block/tests/src/Unit/BlockConfigEntityUnitTest.php

@@ -1,10 +1,5 @@
 <?php
 
-/**
- * @file
- * Contains \Drupal\Tests\block\Unit\BlockConfigEntityUnitTest.
- */
-
 namespace Drupal\Tests\block\Unit;
 
 use Drupal\Core\DependencyInjection\ContainerBuilder;

core/modules/block/tests/src/Unit/BlockFormTest.php

@@ -1,10 +1,5 @@
 <?php
 
-/**
- * @file
- * Contains \Drupal\Tests\block\Unit\BlockFormTest.
- */
-
 namespace Drupal\Tests\block\Unit;
 
 use Drupal\block\BlockForm;

core/modules/block/tests/src/Unit/CategoryAutocompleteTest.php

@@ -1,10 +1,5 @@
 <?php
 
-/**
- * @file
- * Contains \Drupal\Tests\block\Unit\CategoryAutocompleteTest.
- */
-
 namespace Drupal\Tests\block\Unit;
 
 use Drupal\Component\Utility\Html;

core/modules/block/tests/src/Unit/Menu/BlockLocalTasksTest.php

@@ -1,10 +1,5 @@
 <?php
 
-/**
- * @file
- * Contains \Drupal\Tests\block\Unit\Menu\BlockLocalTasksTest.
- */
-
 namespace Drupal\Tests\block\Unit\Menu;
 
 use Drupal\Tests\Core\Menu\LocalTaskIntegrationTestBase;

core/modules/block/tests/src/Unit/Plugin/DisplayVariant/BlockPageVariantTest.php

@@ -1,10 +1,5 @@
 <?php
 
-/**
- * @file
- * Contains \Drupal\Tests\block\Unit\Plugin\DisplayVariant\BlockPageVariantTest.
- */
-
 namespace Drupal\Tests\block\Unit\Plugin\DisplayVariant;
 
 use Drupal\Core\Cache\CacheableMetadata;

core/modules/block/tests/src/Unit/Plugin/migrate/process/BlockRegionTest.php

@@ -1,10 +1,5 @@
 <?php
 
-/**
- * @file
- * Contains \Drupal\Tests\block\Unit\Plugin\migrate\process\BlockRegionTest.
- */
-
 namespace Drupal\Tests\block\Unit\Plugin\migrate\process;
 
 use Drupal\block\Plugin\migrate\process\BlockRegion;

core/modules/block/tests/src/Unit/Plugin/migrate/process/BlockVisibilityTest.php

@@ -1,10 +1,5 @@
 <?php
 
-/**
- * @file
- * Contains \Drupal\Tests\block\Unit\Plugin\migrate\process\BlockVisibilityTest.
- */
-
 namespace Drupal\Tests\block\Unit\Plugin\migrate\process;
 
 use Drupal\block\Plugin\migrate\process\BlockVisibility;

core/modules/block/tests/src/Unit/Plugin/migrate/source/BlockTest.php

@@ -1,10 +1,5 @@
 <?php
 
-/**
- * @file
- * Contains \Drupal\Tests\block\Unit\Plugin\migrate\source\BlockTest.
- */
-
 namespace Drupal\Tests\block\Unit\Plugin\migrate\source;
 
 use Drupal\Tests\migrate\Unit\MigrateSqlSourceTestCase;