class BlockStorageUnitTest

Tests the storage of blocks.

Hierarchy

Expanded class hierarchy of BlockStorageUnitTest

See also

\Drupal\block\BlockStorageController

File

drupal/core/modules/block/lib/Drupal/block/Tests/BlockStorageUnitTest.php, line 23
Contains \Drupal\block\Tests\BlockStorageUnitTest.

Namespace

Drupal\block\Tests
View source
class BlockStorageUnitTest extends DrupalUnitTestBase {

  /**
   * Modules to enable.
   *
   * @var array
   */
  public static $modules = array(
    'block',
    'block_test',
  );

  /**
   * 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();
    $this->controller = $this->container
      ->get('plugin.manager.entity')
      ->getStorageController('block');
  }

  /**
   * 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();
      $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.
    $actual_properties = config('block.block.stark.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(
      'id' => 'stark.test_block',
      'weight' => '',
      'status' => '1',
      'langcode' => language_default()->langcode,
      'region' => '-1',
      'plugin' => 'test_html_id',
      'settings' => array(
        'cache' => '1',
        'label' => '',
        'module' => 'block_test',
        'label_display' => BLOCK_LABEL_VISIBLE,
      ),
      'visibility' => '',
    );
    $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');
    $output = entity_view($entity, 'block');
    $expected = array();
    $expected[] = '<div class="block block-block-test" id="block-test-block">';
    $expected[] = '  ';
    $expected[] = '    ';
    $expected[] = '';
    $expected[] = '  <div class="content">';
    $expected[] = '    ';
    $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();
    $output = entity_view($entity, 'block');
    $expected = array();
    $expected[] = '<div class="block block-block-test" id="block-test-block2">';
    $expected[] = '  ';
    $expected[] = '      <h2>Powered by Bananas</h2>';
    $expected[] = '    ';
    $expected[] = '';
    $expected[] = '  <div class="content">';
    $expected[] = '    ';
    $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();
  }

  /**
   * 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');
    $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() {
    $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',
    ));
    $entities = $this->controller
      ->load();
    $entity = reset($entities);
    $this
      ->assertEqual($entity
      ->id(), 'stark.test_block', 'The default test block was loaded.');
  }

}

Members

Namesort descending Modifiers Type Description Overrides
BlockStorageUnitTest::$controller protected property The block storage controller.
BlockStorageUnitTest::$modules public static property Modules to enable. Overrides DrupalUnitTestBase::$modules
BlockStorageUnitTest::createTests protected function Tests the creation of blocks.
BlockStorageUnitTest::deleteTests protected function Tests the deleting of blocks.
BlockStorageUnitTest::getInfo public static function
BlockStorageUnitTest::loadTests protected function Tests the rendering of blocks.
BlockStorageUnitTest::renderTests protected function Tests the rendering of blocks.
BlockStorageUnitTest::setUp protected function Sets up Drupal unit test environment. Overrides DrupalUnitTestBase::setUp
BlockStorageUnitTest::testBlockCRUD public function Tests CRUD operations.
BlockStorageUnitTest::testDefaultBlocks public function Tests the installation of default blocks.
DrupalUnitTestBase::$keyValueFactory protected property A KeyValueMemoryFactory instance to use when building the container.
DrupalUnitTestBase::$moduleFiles private property
DrupalUnitTestBase::$themeData private property
DrupalUnitTestBase::$themeFiles private property
DrupalUnitTestBase::containerBuild public function Sets up the base service container for this test. 1
DrupalUnitTestBase::disableModules protected function Disables modules for this test.
DrupalUnitTestBase::enableModules protected function Enables modules for this test.
DrupalUnitTestBase::installConfig protected function Installs default configuration for a given list of modules.
DrupalUnitTestBase::installSchema protected function Installs a specific table from a module schema definition.
DrupalUnitTestBase::tearDown protected function Deletes created files, database tables, and reverts all environment changes. Overrides TestBase::tearDown 2
DrupalUnitTestBase::__construct function Overrides \Drupal\simpletest\UnitTestBase::__construct(). Overrides UnitTestBase::__construct
TestBase::$assertions protected property Assertions thrown in that test case.
TestBase::$configImporter protected property The config importer that can used in a test. 1
TestBase::$container protected property The dependency injection container used in the test. 1
TestBase::$databasePrefix protected property The database prefix of this test run.
TestBase::$dieOnFail public property Whether to die in case any test assertion fails.
TestBase::$originalFileDirectory protected property The original file directory, before it was changed for testing purposes.
TestBase::$originalPrefix protected property The original database prefix when running inside Simpletest.
TestBase::$originalSettings protected property The settings array.
TestBase::$public_files_directory protected property The public file directory for the test environment.
TestBase::$results public property Current results of this test case.
TestBase::$setup protected property Flag to indicate whether the test has been set up.
TestBase::$setupDatabasePrefix protected property
TestBase::$setupEnvironment protected property
TestBase::$skipClasses protected property This class is skipped when looking for the source of an assertion.
TestBase::$testId protected property The test run ID.
TestBase::$timeLimit protected property Time limit for the test.
TestBase::$verbose protected property TRUE if verbose debugging is enabled.
TestBase::$verboseClassName protected property Safe class name for use in verbose output filenames.
TestBase::$verboseDirectory protected property Directory where verbose output files are put.
TestBase::$verboseDirectoryUrl protected property URL to the verbose output file directory.
TestBase::$verboseId protected property Incrementing identifier for verbose output filenames.
TestBase::assert protected function Internal helper: stores the assert.
TestBase::assertEqual protected function Check to see if two values are equal.
TestBase::assertFalse protected function Check to see if a value is false (an empty string, 0, NULL, or FALSE).
TestBase::assertIdentical protected function Check to see if two values are identical.
TestBase::assertIdenticalObject protected function Checks to see if two objects are identical.
TestBase::assertNotEqual protected function Check to see if two values are not equal.
TestBase::assertNotIdentical protected function Check to see if two values are not identical.
TestBase::assertNotNull protected function Check to see if a value is not NULL.
TestBase::assertNull protected function Check to see if a value is NULL.
TestBase::assertTrue protected function Check to see if a value is not false (not an empty string, 0, NULL, or FALSE).
TestBase::changeDatabasePrefix protected function Changes the database connection to the prefixed one.
TestBase::checkRequirements protected function Checks the matching requirements for Test. 4
TestBase::configImporter public function Returns a ConfigImporter object to import test importing of configuration. 1
TestBase::copyConfig public function Copies configuration objects from source storage to target storage.
TestBase::deleteAssert public static function Delete an assertion record by message ID.
TestBase::error protected function Fire an error assertion. 1
TestBase::errorHandler public function Handle errors during test runs.
TestBase::exceptionHandler protected function Handle exceptions.
TestBase::fail protected function Fire an assertion that is always negative.
TestBase::filePreDeleteCallback public static function Ensures test files are deletable within file_unmanaged_delete_recursive().
TestBase::generatePermutations public static function Converts a list of possible parameters into a stack of permutations.
TestBase::getAssertionCall protected function Cycles through backtrace until the first non-assertion method is found.
TestBase::getDatabaseConnection public static function Returns the database connection to the site running Simpletest.
TestBase::insertAssert public static function Store an assertion from outside the testing context.
TestBase::pass protected function Fire an assertion that is always positive.
TestBase::prepareConfigDirectories protected function Create and set new configuration directories. 1
TestBase::prepareDatabasePrefix protected function Generates a database prefix for running tests.
TestBase::prepareEnvironment protected function Prepares the current environment for running the test.
TestBase::randomName public static function Generates a random string containing letters and numbers.
TestBase::randomObject public static function Generates a random PHP object.
TestBase::randomString public static function Generates a random string of ASCII characters of codes 32 to 126.
TestBase::rebuildContainer protected function Rebuild drupal_container(). 1
TestBase::run public function Run all tests in this class.
TestBase::settingsSet protected function Changes in memory settings.
TestBase::verbose protected function Logs verbose message in a text file.
UnitTestBase::$configDirectories protected property