'Block functionality', 'description' => 'Add, edit and delete custom block. Configure and move a module-defined block.', 'group' => 'Block', ); } function setUp() { parent::setUp(); // Create and log in an administrative user having access to the Full HTML // text format. $full_html_format = filter_format_load('full_html'); $this->admin_user = $this->drupalCreateUser(array( 'administer blocks', filter_permission_name($full_html_format), 'access administration pages', )); $this->drupalLogin($this->admin_user); // Define the existing regions $this->regions = array(); $this->regions[] = 'header'; $this->regions[] = 'sidebar_first'; $this->regions[] = 'content'; $this->regions[] = 'sidebar_second'; $this->regions[] = 'footer'; } /** * Test creating custom block, moving it to a specific region and then deleting it. */ function testCustomBlock() { // Confirm that the add block link appears on block overview pages. $this->drupalGet('admin/structure/block'); $this->assertRaw(l('Add block', 'admin/structure/block/add'), t('Add block link is present on block overview page for default theme.')); $this->drupalGet('admin/structure/block/list/seven'); $this->assertRaw(l('Add block', 'admin/structure/block/list/seven/add'), t('Add block link is present on block overview page for non-default theme.')); // Confirm that hidden regions are not shown as options for block placement // when adding a new block. theme_enable(array('stark')); $themes = list_themes(); $this->drupalGet('admin/structure/block/add'); foreach ($themes as $key => $theme) { if ($theme->status) { foreach ($theme->info['regions_hidden'] as $hidden_region) { $elements = $this->xpath('//select[@id=:id]//option[@value=:value]', array(':id' => 'edit-regions-' . $key, ':value' => $hidden_region)); $this->assertFalse(isset($elements[0]), t('The hidden region @region is not available for @theme.', array('@region' => $hidden_region, '@theme' => $key))); } } } // Add a new custom block by filling out the input form on the admin/structure/block/add page. $custom_block = array(); $custom_block['info'] = $this->randomName(8); $custom_block['title'] = $this->randomName(8); $custom_block['body[value]'] = $this->randomName(32); $this->drupalPost('admin/structure/block/add', $custom_block, t('Save block')); // Confirm that the custom block has been created, and then query the created bid. $this->assertText(t('The block has been created.'), t('Custom block successfully created.')); $bid = db_query("SELECT bid FROM {block_custom} WHERE info = :info", array(':info' => $custom_block['info']))->fetchField(); // Check to see if the custom block was created by checking that it's in the database. $this->assertNotNull($bid, t('Custom block found in database')); // Check that block_block_view() returns the correct title and content. $data = block_block_view($bid); $format = db_query("SELECT format FROM {block_custom} WHERE bid = :bid", array(':bid' => $bid))->fetchField(); $this->assertTrue(array_key_exists('subject', $data) && empty($data['subject']), t('block_block_view() provides an empty block subject, since custom blocks do not have default titles.')); $this->assertEqual(check_markup($custom_block['body[value]'], $format), $data['content'], t('block_block_view() provides correct block content.')); // Check if the block can be moved to all availble regions. $custom_block['module'] = 'block'; $custom_block['delta'] = $bid; foreach ($this->regions as $region) { $this->moveBlockToRegion($custom_block, $region); } // Verify presence of configure and delete links for custom block. $this->drupalGet('admin/structure/block'); $this->assertLinkByHref('admin/structure/block/manage/block/' . $bid . '/configure', 0, t('Custom block configure link found.')); $this->assertLinkByHref('admin/structure/block/manage/block/' . $bid . '/delete', 0, t('Custom block delete link found.')); // Set visibility only for authenticated users, to verify delete functionality. $edit = array(); $edit['roles[2]'] = TRUE; $this->drupalPost('admin/structure/block/manage/block/' . $bid . '/configure', $edit, t('Save block')); // Delete the created custom block & verify that it's been deleted and no longer appearing on the page. $this->clickLink(t('delete')); $this->drupalPost('admin/structure/block/manage/block/' . $bid . '/delete', array(), t('Delete')); $this->assertRaw(t('The block %title has been removed.', array('%title' => $custom_block['info'])), t('Custom block successfully deleted.')); $this->assertNoText(t($custom_block['title']), t('Custom block no longer appears on page.')); $count = db_query("SELECT 1 FROM {block_role} WHERE module = :module AND delta = :delta", array(':module' => $custom_block['module'], ':delta' => $custom_block['delta']))->fetchField(); $this->assertFalse($count, t('Table block_role being cleaned.')); } /** * Test creating custom block using Full HTML. */ function testCustomBlockFormat() { // Add a new custom block by filling out the input form on the admin/structure/block/add page. $custom_block = array(); $custom_block['info'] = $this->randomName(8); $custom_block['title'] = $this->randomName(8); $custom_block['body[value]'] = '

Full HTML

'; $full_html_format = filter_format_load('full_html'); $custom_block['body[format]'] = $full_html_format->format; $this->drupalPost('admin/structure/block/add', $custom_block, t('Save block')); // Set the created custom block to a specific region. $bid = db_query("SELECT bid FROM {block_custom} WHERE info = :info", array(':info' => $custom_block['info']))->fetchField(); $edit = array(); $edit['blocks[block_' . $bid . '][region]'] = $this->regions[1]; $this->drupalPost('admin/structure/block', $edit, t('Save blocks')); // Confirm that the custom block is being displayed using configured text format. $this->drupalGet('node'); $this->assertRaw('

Full HTML

', t('Custom block successfully being displayed using Full HTML.')); // Confirm that a user without access to Full HTML can not see the body field, // but can still submit the form without errors. $block_admin = $this->drupalCreateUser(array('administer blocks')); $this->drupalLogin($block_admin); $this->drupalGet('admin/structure/block/manage/block/' . $bid . '/configure'); $this->assertFieldByXPath("//textarea[@name='body[value]' and @disabled='disabled']", t('This field has been disabled because you do not have sufficient permissions to edit it.'), t('Body field contains denied message')); $this->drupalPost('admin/structure/block/manage/block/' . $bid . '/configure', array(), t('Save block')); $this->assertNoText(t('Ensure that each block description is unique.')); // Confirm that the custom block is still being displayed using configured text format. $this->drupalGet('node'); $this->assertRaw('

Full HTML

', t('Custom block successfully being displayed using Full HTML.')); } /** * Test block visibility. */ function testBlockVisibility() { $block = array(); // Create a random title for the block $title = $this->randomName(8); // Create the custom block $custom_block = array(); $custom_block['info'] = $this->randomName(8); $custom_block['title'] = $title; $custom_block['body[value]'] = $this->randomName(32); $this->drupalPost('admin/structure/block/add', $custom_block, t('Save block')); $bid = db_query("SELECT bid FROM {block_custom} WHERE info = :info", array(':info' => $custom_block['info']))->fetchField(); $block['module'] = 'block'; $block['delta'] = $bid; $block['title'] = $title; // Set the block to be hidden on any user path, and to be shown only to // authenticated users. $edit = array(); $edit['pages'] = 'user*'; $edit['roles[2]'] = TRUE; $this->drupalPost('admin/structure/block/manage/' . $block['module'] . '/' . $block['delta'] . '/configure', $edit, t('Save block')); // Move block to the first sidebar. $this->moveBlockToRegion($block, $this->regions[1]); $this->drupalGet(''); $this->assertText($title, t('Block was displayed on the front page.')); $this->drupalGet('user'); $this->assertNoText($title, t('Block was not displayed according to block visibility rules.')); $this->drupalGet('USER/' . $this->admin_user->uid); $this->assertNoText($title, t('Block was not displayed according to block visibility rules regardless of path case.')); // Confirm that the block is not displayed to anonymous users. $this->drupalLogout(); $this->drupalGet(''); $this->assertNoText($title, t('Block was not displayed to anonymous users.')); } /** * Test user customization of block visibility. */ function testBlockVisibilityPerUser() { $block = array(); // Create a random title for the block. $title = $this->randomName(8); // Create our custom test block. $custom_block = array(); $custom_block['info'] = $this->randomName(8); $custom_block['title'] = $title; $custom_block['body[value]'] = $this->randomName(32); $this->drupalPost('admin/structure/block/add', $custom_block, t('Save block')); $bid = db_query("SELECT bid FROM {block_custom} WHERE info = :info", array(':info' => $custom_block['info']))->fetchField(); $block['module'] = 'block'; $block['delta'] = $bid; $block['title'] = $title; // Move block to the first sidebar. $this->moveBlockToRegion($block, $this->regions[1]); // Set the block to be customizable per user, visible by default. $edit = array(); $edit['custom'] = BLOCK_CUSTOM_ENABLED; $this->drupalPost('admin/structure/block/manage/' . $block['module'] . '/' . $block['delta'] . '/configure', $edit, t('Save block')); // Disable block visibility for the admin user. $edit = array(); $edit['block[' . $block['module'] . '][' . $block['delta'] . ']'] = FALSE; $this->drupalPost('user/' . $this->admin_user->uid . '/edit', $edit, t('Save')); $this->drupalGet(''); $this->assertNoText($block['title'], t('Block was not displayed according to per user block visibility setting.')); // Set the block to be customizable per user, hidden by default. $edit = array(); $edit['custom'] = BLOCK_CUSTOM_DISABLED; $this->drupalPost('admin/structure/block/manage/' . $block['module'] . '/' . $block['delta'] . '/configure', $edit, t('Save block')); // Enable block visibility for the admin user. $edit = array(); $edit['block[' . $block['module'] . '][' . $block['delta'] . ']'] = TRUE; $this->drupalPost('user/' . $this->admin_user->uid . '/edit', $edit, t('Save')); $this->drupalGet(''); $this->assertText($block['title'], t('Block was displayed according to per user block visibility setting.')); } /** * Test configuring and moving a module-define block to specific regions. */ function testBlock() { // Select the Navigation block to be configured and moved. $block = array(); $block['module'] = 'system'; $block['delta'] = 'management'; $block['title'] = $this->randomName(8); // Set block title to confirm that interface works and override any custom titles. $this->drupalPost('admin/structure/block/manage/' . $block['module'] . '/' . $block['delta'] . '/configure', array('title' => $block['title']), t('Save block')); $this->assertText(t('The block configuration has been saved.'), t('Block title set.')); $bid = db_query("SELECT bid FROM {block} WHERE module = :module AND delta = :delta", array( ':module' => $block['module'], ':delta' => $block['delta'], ))->fetchField(); // Check to see if the block was created by checking that it's in the database. $this->assertNotNull($bid, t('Block found in database')); // Check if the block can be moved to all availble regions. foreach ($this->regions as $region) { $this->moveBlockToRegion($block, $region); } // Set the block to the disabled region. $edit = array(); $edit['blocks[' . $block['module'] . '_' . $block['delta'] . '][region]'] = '-1'; $this->drupalPost('admin/structure/block', $edit, t('Save blocks')); // Confirm that the block was moved to the proper region. $this->assertText(t('The block settings have been updated.'), t('Block successfully move to disabled region.')); $this->assertNoText(t($block['title']), t('Block no longer appears on page.')); // Confirm that the regions xpath is not availble $xpath = $this->buildXPathQuery('//div[@id=:id]/*', array(':id' => 'block-block-' . $bid)); $this->assertNoFieldByXPath($xpath, FALSE, t('Custom block found in no regions.')); // For convenience of developers, put the navigation block back. $edit = array(); $edit['blocks[' . $block['module'] . '_' . $block['delta'] . '][region]'] = $this->regions[1]; $this->drupalPost('admin/structure/block', $edit, t('Save blocks')); $this->assertText(t('The block settings have been updated.'), t('Block successfully move to first sidebar region.')); $this->drupalPost('admin/structure/block/manage/' . $block['module'] . '/' . $block['delta'] . '/configure', array('title' => 'Navigation'), t('Save block')); $this->assertText(t('The block configuration has been saved.'), t('Block title set.')); } function moveBlockToRegion($block, $region) { // Set the created block to a specific region. $edit = array(); $edit['blocks[' . $block['module'] . '_' . $block['delta'] . '][region]'] = $region; $this->drupalPost('admin/structure/block', $edit, t('Save blocks')); // Confirm that the block was moved to the proper region. $this->assertText(t('The block settings have been updated.'), t('Block successfully moved to %region_name region.', array( '%region_name' => $region))); // Confirm that the block is being displayed. $this->drupalGet('node'); $this->assertText(t($block['title']), t('Block successfully being displayed on the page.')); // Confirm that the custom block was found at the proper region. $xpath = $this->buildXPathQuery('//div[@class=:region-class]//div[@id=:block-id]/*', array( ':region-class' => 'region region-' . str_replace('_', '-', $region), ':block-id' => 'block-' . $block['module'] . '-' . $block['delta'], )); $this->assertFieldByXPath($xpath, NULL, t('Custom block found in %region_name region.', array('%region_name' => $region))); } /** * Test _block_rehash(). */ function testBlockRehash() { module_enable(array('block_test')); $this->assertTrue(module_exists('block_test'), t('Test block module enabled.')); // Our new block should be inserted in the database when we visit the // block management page. $this->drupalGet('admin/structure/block'); // Our test block's caching should default to DRUPAL_CACHE_PER_ROLE. $current_caching = db_query("SELECT cache FROM {block} WHERE module = 'block_test' AND delta = 'test_cache'")->fetchField(); $this->assertEqual($current_caching, DRUPAL_CACHE_PER_ROLE, t('Test block cache mode defaults to DRUPAL_CACHE_PER_ROLE.')); // Disable caching for this block. variable_set('block_test_caching', DRUPAL_NO_CACHE); // Flushing all caches should call _block_rehash(). drupal_flush_all_caches(); // Verify that the database is updated with the new caching mode. $current_caching = db_query("SELECT cache FROM {block} WHERE module = 'block_test' AND delta = 'test_cache'")->fetchField(); $this->assertEqual($current_caching, DRUPAL_NO_CACHE, t("Test block's database entry updated to DRUPAL_NO_CACHE.")); } } class NonDefaultBlockAdmin extends DrupalWebTestCase { public static function getInfo() { return array( 'name' => 'Non default theme admin', 'description' => 'Check the administer page for non default theme.', 'group' => 'Block', ); } /** * Test non-default theme admin. */ function testNonDefaultBlockAdmin() { $admin_user = $this->drupalCreateUser(array('administer blocks', 'administer themes')); $this->drupalLogin($admin_user); theme_enable(array('stark')); $this->drupalGet('admin/structure/block/list/stark'); } } /** * Test blocks correctly initialized when picking a new default theme. */ class NewDefaultThemeBlocks extends DrupalWebTestCase { public static function getInfo() { return array( 'name' => 'New default theme blocks', 'description' => 'Checks that the new default theme gets blocks.', 'group' => 'Block', ); } /** * Check the enabled Bartik blocks are correctly copied over. */ function testNewDefaultThemeBlocks() { // Create administrative user. $admin_user = $this->drupalCreateUser(array('administer themes')); $this->drupalLogin($admin_user); // Ensure no other theme's blocks are in the block table yet. $themes = array(); $themes['default'] = variable_get('theme_default', 'bartik'); if ($admin_theme = variable_get('admin_theme')) { $themes['admin'] = $admin_theme; } $count = db_query_range('SELECT 1 FROM {block} WHERE theme NOT IN (:themes)', 0, 1, array(':themes' => $themes))->fetchField(); $this->assertFalse($count, t('Only the default theme and the admin theme have blocks.')); // Populate list of all blocks for matching against new theme. $blocks = array(); $result = db_query('SELECT * FROM {block} WHERE theme = :theme', array(':theme' => $themes['default'])); foreach ($result as $block) { // $block->theme and $block->bid will not match, so remove them. unset($block->theme, $block->bid); $blocks[$block->module][$block->delta] = $block; } // Turn on the Stark theme and ensure that it contains all of the blocks // the default theme had. theme_enable(array('stark')); variable_set('theme_default', 'stark'); $result = db_query('SELECT * FROM {block} WHERE theme = :theme', array(':theme' => 'stark')); foreach ($result as $block) { unset($block->theme, $block->bid); $this->assertEqual($blocks[$block->module][$block->delta], $block, t('Block %name matched', array('%name' => $block->module . '-' . $block->delta))); } } } /** * Test the block system with admin themes. */ class BlockAdminThemeTestCase extends DrupalWebTestCase { public static function getInfo() { return array( 'name' => 'Admin theme block admin accessibility', 'description' => "Check whether the block administer page for a disabled theme acccessible if and only if it's the admin theme.", 'group' => 'Block', ); } /** * Check for the accessibility of the admin theme on the block admin page. */ function testAdminTheme() { // Create administrative user. $admin_user = $this->drupalCreateUser(array('administer blocks', 'administer themes')); $this->drupalLogin($admin_user); // Ensure that access to block admin page is denied when theme is disabled. $this->drupalGet('admin/structure/block/list/stark'); $this->assertResponse(403, t('The block admin page for a disabled theme can not be accessed')); // Enable admin theme and confirm that tab is accessible. $edit['admin_theme'] = 'stark'; $this->drupalPost('admin/appearance', $edit, t('Save configuration')); $this->drupalGet('admin/structure/block/list/stark'); $this->assertResponse(200, t('The block admin page for the admin theme can be accessed')); } } /** * Test block caching. */ class BlockCacheTestCase extends DrupalWebTestCase { protected $admin_user; protected $normal_user; protected $normal_user_alt; public static function getInfo() { return array( 'name' => 'Block caching', 'description' => 'Test block caching.', 'group' => 'Block', ); } function setUp() { parent::setUp('block_test'); // Create an admin user, log in and enable test blocks. $this->admin_user = $this->drupalCreateUser(array('administer blocks', 'access administration pages')); $this->drupalLogin($this->admin_user); // Create additional users to test caching modes. $this->normal_user = $this->drupalCreateUser(); $this->normal_user_alt = $this->drupalCreateUser(); // Sync the roles, since drupalCreateUser() creates separate roles for // the same permission sets. user_save($this->normal_user_alt, array('roles' => $this->normal_user->roles)); $this->normal_user_alt->roles = $this->normal_user->roles; // Enable block caching. variable_set('block_cache', TRUE); // Enable our test block. $edit['blocks[block_test_test_cache][region]'] = 'sidebar_first'; $this->drupalPost('admin/structure/block', $edit, t('Save blocks')); } /** * Test DRUPAL_CACHE_PER_ROLE. */ function testCachePerRole() { $this->setCacheMode(DRUPAL_CACHE_PER_ROLE); // Enable our test block. Set some content for it to display. $current_content = $this->randomName(); variable_set('block_test_content', $current_content); $this->drupalLogin($this->normal_user); $this->drupalGet(''); $this->assertText($current_content, t('Block content displays.')); // Change the content, but the cached copy should still be served. $old_content = $current_content; $current_content = $this->randomName(); variable_set('block_test_content', $current_content); $this->drupalGet(''); $this->assertText($old_content, t('Block is served from the cache.')); // Clear the cache and verify that the stale data is no longer there. cache_clear_all(); $this->drupalGet(''); $this->assertNoText($old_content, t('Block cache clear removes stale cache data.')); $this->assertText($current_content, t('Fresh block content is displayed after clearing the cache.')); // Test whether the cached data is served for the correct users. $old_content = $current_content; $current_content = $this->randomName(); variable_set('block_test_content', $current_content); $this->drupalLogout(); $this->drupalGet(''); $this->assertNoText($old_content, t('Anonymous user does not see content cached per-role for normal user.')); $this->drupalLogin($this->normal_user_alt); $this->drupalGet(''); $this->assertText($old_content, t('User with the same roles sees per-role cached content.')); $this->drupalLogin($this->admin_user); $this->drupalGet(''); $this->assertNoText($old_content, t('Admin user does not see content cached per-role for normal user.')); $this->drupalLogin($this->normal_user); $this->drupalGet(''); $this->assertText($old_content, t('Block is served from the per-role cache.')); } /** * Test DRUPAL_CACHE_GLOBAL. */ function testCacheGlobal() { $this->setCacheMode(DRUPAL_CACHE_GLOBAL); $current_content = $this->randomName(); variable_set('block_test_content', $current_content); $this->drupalGet(''); $this->assertText($current_content, t('Block content displays.')); $old_content = $current_content; $current_content = $this->randomName(); variable_set('block_test_content', $current_content); $this->drupalLogout(); $this->drupalGet('user'); $this->assertText($old_content, t('Block content served from global cache.')); } /** * Test DRUPAL_NO_CACHE. */ function testNoCache() { $this->setCacheMode(DRUPAL_NO_CACHE); $current_content = $this->randomName(); variable_set('block_test_content', $current_content); // If DRUPAL_NO_CACHE has no effect, the next request would be cached. $this->drupalGet(''); $this->assertText($current_content, t('Block content displays.')); // A cached copy should not be served. $current_content = $this->randomName(); variable_set('block_test_content', $current_content); $this->drupalGet(''); $this->assertText($current_content, t('DRUPAL_NO_CACHE prevents blocks from being cached.')); } /** * Test DRUPAL_CACHE_PER_USER. */ function testCachePerUser() { $this->setCacheMode(DRUPAL_CACHE_PER_USER); $current_content = $this->randomName(); variable_set('block_test_content', $current_content); $this->drupalLogin($this->normal_user); $this->drupalGet(''); $this->assertText($current_content, t('Block content displays.')); $old_content = $current_content; $current_content = $this->randomName(); variable_set('block_test_content', $current_content); $this->drupalGet(''); $this->assertText($old_content, t('Block is served from per-user cache.')); $this->drupalLogin($this->normal_user_alt); $this->drupalGet(''); $this->assertText($current_content, t('Per-user block cache is not served for other users.')); $this->drupalLogin($this->normal_user); $this->drupalGet(''); $this->assertText($old_content, t('Per-user block cache is persistent.')); } /** * Test DRUPAL_CACHE_PER_PAGE. */ function testCachePerPage() { $this->setCacheMode(DRUPAL_CACHE_PER_PAGE); $current_content = $this->randomName(); variable_set('block_test_content', $current_content); $this->drupalGet('node'); $this->assertText($current_content, t('Block content displays on the node page.')); $old_content = $current_content; $current_content = $this->randomName(); variable_set('block_test_content', $current_content); $this->drupalGet('user'); $this->assertNoText($old_content, t('Block content cached for the node page does not show up for the user page.')); $this->drupalGet('node'); $this->assertText($old_content, t('Block content cached for the node page.')); } /** * Private helper method to set the test block's cache mode. */ private function setCacheMode($cache_mode) { db_update('block') ->fields(array('cache' => $cache_mode)) ->condition('module', 'block_test') ->execute(); $current_mode = db_query("SELECT cache FROM {block} WHERE module = 'block_test'")->fetchField(); if ($current_mode != $cache_mode) { $this->fail(t('Unable to set cache mode to %mode. Current mode: %current_mode', array('%mode' => $cache_mode, '%current_mode' => $current_mode))); } } } /** * Test block HTML id validity. */ class BlockHTMLIdTestCase extends DrupalWebTestCase { public static function getInfo() { return array( 'name' => 'Block HTML id', 'description' => 'Test block HTML id validity.', 'group' => 'Block', ); } function setUp() { parent::setUp('block_test'); // Create an admin user, log in and enable test blocks. $this->admin_user = $this->drupalCreateUser(array('administer blocks', 'access administration pages')); $this->drupalLogin($this->admin_user); // Enable our test block. $edit['blocks[block_test_test_html_id][region]'] = 'sidebar_first'; $this->drupalPost('admin/structure/block', $edit, t('Save blocks')); // Make sure the block has some content so it will appear $current_content = $this->randomName(); variable_set('block_test_content', $current_content); } /** * Test valid HTML id. */ function testHTMLId() { $this->drupalGet(''); $this->assertRaw('block-block-test-test-html-id', t('HTML id for test block is valid.')); } }