class BlockCacheTest in MongoDB 7

Test block caching.

Hierarchy

• class \Drupal\mongodb_block_ui\Tests\BlockCacheTest extends \Drupal\mongodb_block_ui\Tests\DrupalWebTestCase

File

mongodb_block_ui/src/Tests/BlockCacheTest.php, line 8

Namespace

Drupal\mongodb_block_ui\Tests

class BlockCacheTest extends \DrupalWebTestCase {

  /**
   * A pseudo-random user with admin powers.
   *
   * @var object
   */
  protected $adminUser;

  /**
   * A pseudo-random normal user.
   *
   * @var object
   */
  protected $normalUser;

  /**
   * Another pseudo-random normal user.
   *
   * @var object
   */
  protected $normalUserAlt;

  /**
   * Name the test.
   */
  public static function getInfo() {
    return array(
      'name' => 'Block caching',
      'description' => 'Test block caching.',
      'group' => 'MongoDB: Block',
    );
  }

  /**
   * Setup the test.
   */
  public function setUp() {
    parent::setUp('block_test');

    // Create an admin user, log in and enable test blocks.
    $this->adminUser = $this
      ->drupalCreateUser(array(
      'administer blocks',
      'access administration pages',
    ));
    $this
      ->drupalLogin($this->adminUser);

    // Create additional users to test caching modes.
    $this->normalUser = $this
      ->drupalCreateUser();
    $this->normalUserAlt = $this
      ->drupalCreateUser();

    // Sync the roles, since drupalCreateUser() creates separate roles for
    // the same permission sets.
    user_save($this->normalUserAlt, array(
      'roles' => $this->normalUser->roles,
    ));
    $this->normalUserAlt->roles = $this->normalUser->roles;

    // Enable block caching.
    variable_set('block_cache', TRUE);

    // Enable our test block.
    $edit['block_test_test_cache[region]'] = 'sidebar_first';
    $this
      ->drupalPost('admin/structure/block', $edit, t('Save blocks'));
  }

  /**
   * Test DRUPAL_CACHE_PER_ROLE.
   */
  public 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->normalUser);
    $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->normalUserAlt);
    $this
      ->drupalGet('');
    $this
      ->assertText($old_content, t('User with the same roles sees per-role cached content.'));
    $this
      ->drupalLogin($this->adminUser);
    $this
      ->drupalGet('');
    $this
      ->assertNoText($old_content, t('Admin user does not see content cached per-role for normal user.'));
    $this
      ->drupalLogin($this->normalUser);
    $this
      ->drupalGet('');
    $this
      ->assertText($old_content, t('Block is served from the per-role cache.'));
  }

  /**
   * Test DRUPAL_CACHE_GLOBAL.
   */
  public 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.
   */
  public 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.
   */
  public function testCachePerUser() {
    $this
      ->setCacheMode(DRUPAL_CACHE_PER_USER);
    $current_content = $this
      ->randomName();
    variable_set('block_test_content', $current_content);
    $this
      ->drupalLogin($this->normalUser);
    $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->normalUserAlt);
    $this
      ->drupalGet('');
    $this
      ->assertText($current_content, t('Per-user block cache is not served for other users.'));
    $this
      ->drupalLogin($this->normalUser);
    $this
      ->drupalGet('');
    $this
      ->assertText($old_content, t('Per-user block cache is persistent.'));
  }

  /**
   * Test DRUPAL_CACHE_PER_PAGE.
   */
  public 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.
   */
  protected 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,
      )));
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
BlockCacheTest::$adminUser	protected	property	A pseudo-random user with admin powers.
BlockCacheTest::$normalUser	protected	property	A pseudo-random normal user.
BlockCacheTest::$normalUserAlt	protected	property	Another pseudo-random normal user.
BlockCacheTest::getInfo	public static	function	Name the test.
BlockCacheTest::setCacheMode	protected	function	Private helper method to set the test block's cache mode.
BlockCacheTest::setUp	public	function	Setup the test.
BlockCacheTest::testCacheGlobal	public	function	Test DRUPAL_CACHE_GLOBAL.
BlockCacheTest::testCachePerPage	public	function	Test DRUPAL_CACHE_PER_PAGE.
BlockCacheTest::testCachePerRole	public	function	Test DRUPAL_CACHE_PER_ROLE.
BlockCacheTest::testCachePerUser	public	function	Test DRUPAL_CACHE_PER_USER.
BlockCacheTest::testNoCache	public	function	Test DRUPAL_NO_CACHE.