View source
<?php
namespace Drupal\Tests\block\Functional\Views;
use Drupal\Component\Serialization\Json;
use Drupal\Component\Utility\Crypt;
use Drupal\Core\Site\Settings;
use Drupal\Core\Url;
use Drupal\Tests\block\Functional\AssertBlockAppearsTrait;
use Drupal\Tests\system\Functional\Cache\AssertPageCacheContextsAndTagsTrait;
use Drupal\Tests\views\Functional\ViewTestBase;
use Drupal\views\Entity\View;
use Drupal\views\Views;
use Drupal\views\Tests\ViewTestData;
use Drupal\Core\Template\Attribute;
class DisplayBlockTest extends ViewTestBase {
use AssertPageCacheContextsAndTagsTrait;
use AssertBlockAppearsTrait;
protected static $modules = [
'node',
'block_test_views',
'test_page_test',
'contextual',
'views_ui',
];
protected $defaultTheme = 'classy';
public static $testViews = [
'test_view_block',
'test_view_block2',
];
protected function setUp($import_test_views = TRUE) : void {
parent::setUp($import_test_views);
ViewTestData::createTestViews(static::class, [
'block_test_views',
]);
$this
->enableViewsTestModule();
}
public function testBlockCategory() {
$this
->drupalLogin($this
->drupalCreateUser([
'administer views',
'administer blocks',
]));
$edit = [];
$edit['label'] = $this
->randomString();
$edit['id'] = strtolower($this
->randomMachineName());
$edit['show[wizard_key]'] = 'standard:views_test_data';
$edit['description'] = $this
->randomString();
$edit['block[create]'] = TRUE;
$edit['block[style][row_plugin]'] = 'fields';
$this
->drupalGet('admin/structure/views/add');
$this
->submitForm($edit, 'Save and edit');
$pattern = '//tr[.//td[text()=:category] and .//td//a[contains(@href, :href)]]';
$arguments = [
':href' => Url::fromRoute('block.admin_add', [
'plugin_id' => 'views_block:' . $edit['id'] . '-block_1',
'theme' => 'classy',
])
->toString(),
':category' => 'Lists (Views)',
];
$this
->drupalGet('admin/structure/block');
$this
->clickLink('Place block');
$this
->assertSession()
->elementExists('xpath', $this
->assertSession()
->buildXPathQuery($pattern, $arguments));
$this
->drupalGet('admin/structure/views/view/' . $edit['id'] . '/edit/block_1');
$this
->submitForm([], 'Duplicate Block');
$this
->assertSession()
->addressEquals('admin/structure/views/view/' . $edit['id'] . '/edit/block_2');
$this
->drupalGet('admin/structure/views/view/' . $edit['id'] . '/edit/block_1');
$this
->assertSession()
->elementTextEquals('named', [
'id',
'views-block-1-block-category',
], 'Lists (Views)');
$this
->clickLink('Lists (Views)');
$category = $this
->randomString();
$this
->submitForm([
'block_category' => $category,
], 'Apply');
$this
->submitForm([], 'Duplicate Block');
$this
->assertSession()
->addressEquals('admin/structure/views/view/' . $edit['id'] . '/edit/block_3');
$this
->submitForm([], 'Save');
$arguments[':category'] = $category;
$this
->drupalGet('admin/structure/block');
$this
->clickLink('Place block');
$this
->assertSession()
->elementExists('xpath', $this
->assertSession()
->buildXPathQuery($pattern, $arguments));
$arguments = [
':href' => Url::fromRoute('block.admin_add', [
'plugin_id' => 'views_block:' . $edit['id'] . '-block_2',
'theme' => 'classy',
])
->toString(),
':category' => 'Lists (Views)',
];
$this
->assertSession()
->elementExists('xpath', $this
->assertSession()
->buildXPathQuery($pattern, $arguments));
$arguments = [
':href' => Url::fromRoute('block.admin_add', [
'plugin_id' => 'views_block:' . $edit['id'] . '-block_3',
'theme' => 'classy',
])
->toString(),
':category' => $category,
];
$this
->assertSession()
->elementExists('xpath', $this
->assertSession()
->buildXPathQuery($pattern, $arguments));
}
public function testDeleteBlockDisplay() {
$block_1 = $this
->drupalPlaceBlock('views_block:test_view_block-block_1', [
'label' => 'test_view_block-block_1:1',
]);
$block_2 = $this
->drupalPlaceBlock('views_block:test_view_block-block_1', [
'label' => 'test_view_block-block_1:2',
]);
$block_3 = $this
->drupalPlaceBlock('views_block:test_view_block2-block_1', [
'label' => 'test_view_block2-block_1',
]);
$block_4 = $this
->drupalPlaceBlock('views_block:test_view_block2-block_2', [
'label' => 'test_view_block2-block_2',
]);
$this
->drupalGet('test-page');
$this
->assertBlockAppears($block_1);
$this
->assertBlockAppears($block_2);
$this
->assertBlockAppears($block_3);
$this
->assertBlockAppears($block_4);
$block_storage = $this->container
->get('entity_type.manager')
->getStorage('block');
$view = Views::getView('test_view_block');
$view
->initDisplay();
$view->displayHandlers
->remove('block_1');
$view->storage
->save();
$this
->assertNull($block_storage
->load($block_1
->id()), 'The block for this display was removed.');
$this
->assertNull($block_storage
->load($block_2
->id()), 'The block for this display was removed.');
$this
->assertNotEmpty($block_storage
->load($block_3
->id()), 'A block from another view was unaffected.');
$this
->assertNotEmpty($block_storage
->load($block_4
->id()), 'A block from another view was unaffected.');
$this
->drupalGet('test-page');
$this
->assertNoBlockAppears($block_1);
$this
->assertNoBlockAppears($block_2);
$this
->assertBlockAppears($block_3);
$this
->assertBlockAppears($block_4);
$view = Views::getView('test_view_block2');
$view
->initDisplay();
$view->displayHandlers
->remove('block_1');
$view->storage
->save();
$this
->assertNull($block_storage
->load($block_3
->id()), 'The block for this display was removed.');
$this
->assertNotEmpty($block_storage
->load($block_4
->id()), 'A block from another display on the same view was unaffected.');
$this
->drupalGet('test-page');
$this
->assertNoBlockAppears($block_3);
$this
->assertBlockAppears($block_4);
}
public function testViewsBlockForm() {
$this
->drupalLogin($this
->drupalCreateUser([
'administer blocks',
]));
$default_theme = $this
->config('system.theme')
->get('default');
$this
->drupalGet('admin/structure/block/add/views_block:test_view_block-block_1/' . $default_theme);
$this
->assertSession()
->fieldNotExists('label');
$this
->assertSession()
->fieldNotExists('edit-machine-name', NULL);
$edit = [
'region' => 'content',
];
$this
->submitForm($edit, 'Save block');
$storage = $this->container
->get('entity_type.manager')
->getStorage('block');
$block = $storage
->load('views_block__test_view_block_block_1');
$this
->assertTrue(!empty($block), 'The expected block was loaded.');
for ($i = 2; $i <= 3; $i++) {
$this
->drupalGet('admin/structure/block/add/views_block:test_view_block-block_1/' . $default_theme);
$this
->submitForm($edit, 'Save block');
$block = $storage
->load('views_block__test_view_block_block_1_' . $i);
$this
->assertTrue(!empty($block), 'The expected block was loaded.');
}
$this
->drupalGet('admin/structure/block/add/views_block:test_view_block-block_1/' . $default_theme);
$edit = [
'region' => 'content',
];
$edit['settings[override][items_per_page]'] = 10;
$this
->drupalGet('admin/structure/block/add/views_block:test_view_block-block_1/' . $default_theme);
$this
->submitForm($edit, 'Save block');
$block = $storage
->load('views_block__test_view_block_block_1_4');
$config = $block
->getPlugin()
->getConfiguration();
$this
->assertEquals(10, $config['items_per_page'], "'Items per page' is properly saved.");
$edit['settings[override][items_per_page]'] = 5;
$this
->drupalGet('admin/structure/block/manage/views_block__test_view_block_block_1_4');
$this
->submitForm($edit, 'Save block');
$block = $storage
->load('views_block__test_view_block_block_1_4');
$config = $block
->getPlugin()
->getConfiguration();
$this
->assertEquals(5, $config['items_per_page'], "'Items per page' is properly saved.");
$edit = [
'region' => 'content',
];
$edit['settings[views_label_checkbox]'] = 1;
$edit['settings[views_label]'] = 'Custom title';
$this
->drupalGet('admin/structure/block/add/views_block:test_view_block-block_1/' . $default_theme);
$this
->submitForm($edit, 'Save block');
$block = $storage
->load('views_block__test_view_block_block_1_5');
$config = $block
->getPlugin()
->getConfiguration();
$this
->assertEquals('Custom title', $config['views_label'], "'Label' is properly saved.");
}
public function testBlockRendering() {
$block = $this
->drupalPlaceBlock('views_block:test_view_block-block_1', [
'label' => 'test_view_block-block_1:1',
'views_label' => 'Custom title',
]);
$this
->drupalGet('');
$this
->assertSession()
->elementTextEquals('xpath', '//div[contains(@class, "region-sidebar-first")]/div[contains(@class, "block-views")]/h2', 'Custom title');
$plugin = $block
->getPlugin();
$plugin
->setConfigurationValue('views_label', '');
$block
->save();
$this
->drupalGet('');
$this
->assertSession()
->elementTextEquals('xpath', '//div[contains(@class, "region-sidebar-first")]/div[contains(@class, "block-views")]/h2', 'test_view_block');
$block
->getPlugin()
->setConfigurationValue('label_display', FALSE);
$block
->save();
$this
->drupalGet('');
$this
->assertSession()
->elementNotExists('xpath', '//div[contains(@class, "region-sidebar-first")]/div[contains(@class, "block-views")]/h2');
$this
->assertCacheTags(array_merge($block
->getCacheTags(), [
'block_view',
'config:block_list',
'config:system.site',
'config:views.view.test_view_block',
'http_response',
'rendered',
]));
}
public function testBlockEmptyRendering() {
$url = new Url('test_page_test.test_page');
\Drupal::database()
->truncate('views_test_data')
->execute();
$view = View::load('test_view_block');
$view
->invalidateCaches();
$block = $this
->drupalPlaceBlock('views_block:test_view_block-block_1', [
'label' => 'test_view_block-block_1:1',
'views_label' => 'Custom title',
]);
$this
->drupalGet('');
$this
->assertSession()
->elementsCount('xpath', '//div[contains(@class, "block-views-blocktest-view-block-block-1")]', 1);
$display =& $view
->getDisplay('block_1');
$display['display_options']['block_hide_empty'] = TRUE;
$view
->save();
$this
->drupalGet($url);
$this
->assertSession()
->elementNotExists('xpath', '//div[contains(@class, "block-views-blocktest-view-block-block-1")]');
$this
->assertCacheTags(array_merge($block
->getCacheTags(), [
'block_view',
'config:block_list',
'config:views.view.test_view_block',
'http_response',
'rendered',
]));
$this
->assertCacheContexts([
'url.query_args:_wrapper_format',
]);
$display =& $view
->getDisplay('block_1');
$display['display_options']['defaults']['header'] = FALSE;
$display['display_options']['header']['example'] = [
'field' => 'area_text_custom',
'id' => 'area_text_custom',
'table' => 'views',
'plugin_id' => 'text_custom',
'content' => 'test header',
'empty' => TRUE,
];
$view
->save();
$this
->drupalGet($url);
$this
->assertSession()
->elementsCount('xpath', '//div[contains(@class, "block-views-blocktest-view-block-block-1")]', 1);
$this
->assertCacheTags(array_merge($block
->getCacheTags(), [
'block_view',
'config:block_list',
'config:views.view.test_view_block',
'http_response',
'rendered',
]));
$this
->assertCacheContexts([
'url.query_args:_wrapper_format',
]);
$display =& $view
->getDisplay('block_1');
$display['display_options']['defaults']['header'] = FALSE;
$display['display_options']['header']['example'] = [
'field' => 'area_text_custom',
'id' => 'area_text_custom',
'table' => 'views',
'plugin_id' => 'text_custom',
'content' => 'test header',
'empty' => FALSE,
];
$view
->save();
$this
->drupalGet($url);
$this
->assertSession()
->elementNotExists('xpath', '//div[contains(@class, "block-views-blocktest-view-block-block-1")]');
$this
->assertCacheTags(array_merge($block
->getCacheTags(), [
'block_view',
'config:block_list',
'config:views.view.test_view_block',
'http_response',
'rendered',
]));
$this
->assertCacheContexts([
'url.query_args:_wrapper_format',
]);
$display =& $view
->getDisplay('block_1');
$display['display_options']['defaults']['empty'] = FALSE;
$display['display_options']['empty']['example'] = [
'field' => 'area_text_custom',
'id' => 'area_text_custom',
'table' => 'views',
'plugin_id' => 'text_custom',
'content' => 'test empty',
];
$view
->save();
$this
->drupalGet($url);
$this
->assertSession()
->elementsCount('xpath', '//div[contains(@class, "block-views-blocktest-view-block-block-1")]', 1);
$this
->assertCacheTags(array_merge($block
->getCacheTags(), [
'block_view',
'config:block_list',
'config:views.view.test_view_block',
'http_response',
'rendered',
]));
$this
->assertCacheContexts([
'url.query_args:_wrapper_format',
]);
}
public function testBlockContextualLinks() {
$this
->drupalLogin($this
->drupalCreateUser([
'administer views',
'access contextual links',
'administer blocks',
]));
$block = $this
->drupalPlaceBlock('views_block:test_view_block-block_1');
$cached_block = $this
->drupalPlaceBlock('views_block:test_view_block-block_1');
$this
->drupalGet('test-page');
$id = 'block:block=' . $block
->id() . ':langcode=en|entity.view.edit_form:view=test_view_block:location=block&name=test_view_block&display_id=block_1&langcode=en';
$id_token = Crypt::hmacBase64($id, Settings::getHashSalt() . $this->container
->get('private_key')
->get());
$cached_id = 'block:block=' . $cached_block
->id() . ':langcode=en|entity.view.edit_form:view=test_view_block:location=block&name=test_view_block&display_id=block_1&langcode=en';
$cached_id_token = Crypt::hmacBase64($cached_id, Settings::getHashSalt() . $this->container
->get('private_key')
->get());
$this
->assertSession()
->responseContains('<div' . new Attribute([
'data-contextual-id' => $id,
'data-contextual-token' => $id_token,
]) . '></div>');
$this
->assertSession()
->responseContains('<div' . new Attribute([
'data-contextual-id' => $cached_id,
'data-contextual-token' => $cached_id_token,
]) . '></div>');
$post = [
'ids[0]' => $id,
'ids[1]' => $cached_id,
'tokens[0]' => $id_token,
'tokens[1]' => $cached_id_token,
];
$url = 'contextual/render?_format=json,destination=test-page';
$this
->getSession()
->getDriver()
->getClient()
->request('POST', $url, $post);
$this
->assertSession()
->statusCodeEquals(200);
$json = Json::decode($this
->getSession()
->getPage()
->getContent());
$this
->assertSame('<ul class="contextual-links"><li class="block-configure"><a href="' . base_path() . 'admin/structure/block/manage/' . $block
->id() . '">Configure block</a></li><li class="block-remove"><a href="' . base_path() . 'admin/structure/block/manage/' . $block
->id() . '/delete">Remove block</a></li><li class="entityviewedit-form"><a href="' . base_path() . 'admin/structure/views/view/test_view_block/edit/block_1">Edit view</a></li></ul>', $json[$id]);
$this
->assertSame('<ul class="contextual-links"><li class="block-configure"><a href="' . base_path() . 'admin/structure/block/manage/' . $cached_block
->id() . '">Configure block</a></li><li class="block-remove"><a href="' . base_path() . 'admin/structure/block/manage/' . $cached_block
->id() . '/delete">Remove block</a></li><li class="entityviewedit-form"><a href="' . base_path() . 'admin/structure/views/view/test_view_block/edit/block_1">Edit view</a></li></ul>', $json[$cached_id]);
}
}