Newer
Older
Angie Byron
committed
<?php
/**
* @file
* Contains \Drupal\block\Tests\BlockStorageUnitTest.
*/
namespace Drupal\block\Tests;
use Drupal\simpletest\DrupalUnitTestBase;
use Drupal\block_test\Plugin\Block\TestHtmlIdBlock;
Angie Byron
committed
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
*/
public static $modules = array('block', 'block_test');
Angie Byron
committed
/**
* 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();
Angie Byron
committed
$this->controller = $this->container->get('plugin.manager.entity')->getStorageController('block');
Angie Byron
committed
}
/**
* 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());
$entity->getPlugin();
Angie Byron
committed
$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.
Angie Byron
committed
$actual_properties = config('block.block.stark.test_block')->get();
Angie Byron
committed
$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',
'weight' => '',
'status' => '1',
'langcode' => language_default()->langcode,
'region' => '-1',
Angie Byron
committed
'plugin' => 'test_html_id',
'settings' => array(
'cache' => '1',
'label' => '',
'module' => 'block_test',
'label_display' => BLOCK_LABEL_VISIBLE,
Angie Byron
committed
),
'visibility' => '',
Angie Byron
committed
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
);
$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->assertTrue($entity->uuid());
}
/**
* Tests the rendering of blocks.
*/
protected function renderTests() {
// Test the rendering of a block.
$entity = entity_load('block', 'stark.test_block');
Angie Byron
committed
$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 = $this->controller->create(array(
'id' => 'stark.test_block2',
'plugin' => 'test_html_id',
'settings' => array(
'label' => 'Powered by Bananas',
),
));
$entity->save();
Angie Byron
committed
$output = entity_view($entity, 'block');
$expected = array();
$expected[] = ' <div id="block-test-block2" class="block block-block-test">';
Angie Byron
committed
$expected[] = '';
$expected[] = ' <h2>Powered by Bananas</h2>';
Angie Byron
committed
$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.');
// Clean up this entity.
$entity->delete();
Angie Byron
committed
}
/**
* 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');
Angie Byron
committed
$config = $config_storage->listAll('block.block.');
Angie Byron
committed
$this->assertFalse(empty($config), 'There are blocks in config storage.');
// Delete the block.
$entity->delete();
// Ensure that the storage is now empty.
Angie Byron
committed
$config = $config_storage->listAll('block.block.');
Angie Byron
committed
$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.
$this->installConfig(array('block_test'));
Angie Byron
committed
$entities = $this->controller->load();
$entity = reset($entities);
$this->assertEqual($entity->id(), 'stark.test_block', 'The default test block was loaded.');
}
}