BlockStorageUnitTest.php 6.28 KB
Newer Older
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28
<?php

/**
 * @file
 * Contains \Drupal\block\Tests\BlockStorageUnitTest.
 */

namespace Drupal\block\Tests;

use Drupal\simpletest\DrupalUnitTestBase;
use Drupal\block_test\Plugin\block\block\TestHtmlIdBlock;
use Drupal\Component\Plugin\Exception\PluginException;
use Drupal\block\BlockStorageController;
use Drupal\Core\Entity\EntityMalformedException;
use Drupal\block\Plugin\Core\Entity\Block;

/**
 * Tests the storage of blocks.
 *
 * @see \Drupal\block\BlockStorageController
 */
class BlockStorageUnitTest extends DrupalUnitTestBase {

  /**
   * Modules to enable.
   *
   * @var array
   */
29
  public static $modules = array('block', 'block_test');
30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48

  /**
   * The block storage controller.
   *
   * @var \Drupal\block\BlockStorageController.
   */
  protected $controller;

  public static function getInfo() {
    return array(
      'name' => 'Block storage',
      'description' => 'Tests the storage of blocks.',
      'group' => 'Block'
    );
  }

  protected function setUp() {
    parent::setUp();

49
    $this->controller = $this->container->get('plugin.manager.entity')->getStorageController('block');
50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87
  }

  /**
   * Tests CRUD operations.
   */
  public function testBlockCRUD() {
    $this->assertTrue($this->controller instanceof BlockStorageController, 'The block storage controller is loaded.');

    // Run each test method in the same installation.
    $this->createTests();
    $this->loadTests();
    $this->renderTests();
    $this->deleteTests();
  }

  /**
   * Tests the creation of blocks.
   */
  protected function createTests() {
    // Attempt to create a block without a plugin.
    try {
      $entity = $this->controller->create(array());
      $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' => 'stark.test_block',
      'plugin' => 'test_html_id',
    ));
    $entity->save();

    $this->assertTrue($entity instanceof Block, 'The newly created entity is a Block.');

    // Verify all of the block properties.
88
    $actual_properties = config('block.block.stark.test_block')->get();
89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178
    $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(
      'id' => 'stark.test_block',
      'label' => '',
      'region' => '-1',
      'weight' => '',
      'module' => 'block_test',
      'status' => '1',
      'visibility' => array(),
      'plugin' => 'test_html_id',
      'settings' => array(
        'cache' => '1',
        'subject' => t('Test block html id'),
      ),
    );
    $this->assertIdentical($actual_properties, $expected_properties, 'The block properties are exported correctly.');

    $this->assertTrue($entity->getPlugin() instanceof TestHtmlIdBlock, 'The entity has an instance of the correct block plugin.');
  }

  /**
   * Tests the rendering of blocks.
   */
  protected function loadTests() {
    $entities = $this->controller->load(array('stark.test_block'));
    $entity = reset($entities);

    $this->assertTrue($entity instanceof Block, 'The loaded entity is a Block.');

    // Verify several properties of the block.
    $this->assertEqual($entity->get('region'), '-1');
    $this->assertTrue($entity->get('status'));
    $this->assertEqual($entity->get('theme'), 'stark');
    $this->assertEqual($entity->get('module'), 'block_test');
    $this->assertTrue($entity->uuid());
  }

  /**
   * Tests the rendering of blocks.
   */
  protected function renderTests() {
    $entity = $this->controller->create(array(
      'id' => 'stark.test_block',
      'plugin' => 'test_html_id',
    ));

    // Test the rendering of a block.
    $output = entity_view($entity, 'block');
    $expected = array();
    $expected[] = '  <div id="block-test-block"  class="block block-block-test">';
    $expected[] = '';
    $expected[] = '    ';
    $expected[] = '  <div class="content">';
    $expected[] = '      </div>';
    $expected[] = '</div>';
    $expected[] = '';
    $expected_output = implode("\n", $expected);
    $this->assertEqual(drupal_render($output), $expected_output, 'The block rendered correctly.');

    // Reset the HTML IDs so that the next render is not affected.
    drupal_static_reset('drupal_html_id');

    // Test the rendering of a block with a given title.
    $entity->set('label', 'Powered by Bananas');
    $output = entity_view($entity, 'block');
    $expected = array();
    $expected[] = '  <div id="block-test-block"  class="block block-block-test">';
    $expected[] = '';
    $expected[] = '    <h2 class="">Powered by Bananas</h2>';
    $expected[] = '  ';
    $expected[] = '  <div class="content">';
    $expected[] = '      </div>';
    $expected[] = '</div>';
    $expected[] = '';
    $expected_output = implode("\n", $expected);
    $this->assertEqual(drupal_render($output), $expected_output, 'The block rendered correctly.');
  }

  /**
   * Tests the deleting of blocks.
   */
  protected function deleteTests() {
    $entities = $this->controller->load(array('stark.test_block'));
    $entity = reset($entities);

    // Ensure that the storage isn't currently empty.
    $config_storage = $this->container->get('config.storage');
179
    $config = $config_storage->listAll('block.block.');
180 181 182 183 184 185
    $this->assertFalse(empty($config), 'There are blocks in config storage.');

    // Delete the block.
    $entity->delete();

    // Ensure that the storage is now empty.
186
    $config = $config_storage->listAll('block.block.');
187 188 189 190 191 192 193 194 195 196 197
    $this->assertTrue(empty($config), 'There are no blocks in config storage.');
  }

  /**
   * Tests the installation of default blocks.
   */
  public function testDefaultBlocks() {
    $entities = $this->controller->load();
    $this->assertTrue(empty($entities), 'There are no blocks initially.');

    // Install the block_test.module, so that its default config is installed.
198
    $this->installConfig(array('block_test'));
199 200 201 202 203 204 205

    $entities = $this->controller->load();
    $entity = reset($entities);
    $this->assertEqual($entity->id(), 'stark.test_block', 'The default test block was loaded.');
  }

}