123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383 |
- <?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;
- /**
- * Tests the block display plugin.
- *
- * @group block
- * @see \Drupal\views\Plugin\views\display\Block
- */
- class DisplayBlockTest extends ViewTestBase {
- use AssertPageCacheContextsAndTagsTrait;
- use AssertBlockAppearsTrait;
- /**
- * Modules to install.
- *
- * @var array
- */
- public static $modules = ['node', 'block_test_views', 'test_page_test', 'contextual', 'views_ui'];
- /**
- * Views used by this test.
- *
- * @var array
- */
- public static $testViews = ['test_view_block', 'test_view_block2'];
- /**
- * {@inheritdoc}
- */
- protected function setUp($import_test_views = TRUE) {
- parent::setUp($import_test_views);
- ViewTestData::createTestViews(get_class($this), ['block_test_views']);
- $this->enableViewsTestModule();
- }
- /**
- * Tests default and custom block categories.
- */
- public function testBlockCategory() {
- $this->drupalLogin($this->drupalCreateUser(['administer views', 'administer blocks']));
- // Create a new view in the UI.
- $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->drupalPostForm('admin/structure/views/add', $edit, t('Save and edit'));
- $pattern = '//tr[.//td[text()=:category] and .//td//a[contains(@href, :href)]]';
- // Test that the block was given a default category corresponding to its
- // base table.
- $arguments = [
- ':href' => \Drupal::Url('block.admin_add', [
- 'plugin_id' => 'views_block:' . $edit['id'] . '-block_1',
- 'theme' => 'classy',
- ]),
- ':category' => 'Lists (Views)',
- ];
- $this->drupalGet('admin/structure/block');
- $this->clickLink('Place block');
- $elements = $this->xpath($pattern, $arguments);
- $this->assertTrue(!empty($elements), 'The test block appears in the category for its base table.');
- // Duplicate the block before changing the category.
- $this->drupalPostForm('admin/structure/views/view/' . $edit['id'] . '/edit/block_1', [], t('Duplicate @display_title', ['@display_title' => 'Block']));
- $this->assertUrl('admin/structure/views/view/' . $edit['id'] . '/edit/block_2');
- // Change the block category to a random string.
- $this->drupalGet('admin/structure/views/view/' . $edit['id'] . '/edit/block_1');
- $link = $this->xpath('//a[@id="views-block-1-block-category" and normalize-space(text())=:category]', $arguments);
- $this->assertTrue(!empty($link));
- $this->clickLink(t('Lists (Views)'));
- $category = $this->randomString();
- $this->drupalPostForm(NULL, ['block_category' => $category], t('Apply'));
- // Duplicate the block after changing the category.
- $this->drupalPostForm(NULL, [], t('Duplicate @display_title', ['@display_title' => 'Block']));
- $this->assertUrl('admin/structure/views/view/' . $edit['id'] . '/edit/block_3');
- $this->drupalPostForm(NULL, [], t('Save'));
- // Test that the blocks are listed under the correct categories.
- $arguments[':category'] = $category;
- $this->drupalGet('admin/structure/block');
- $this->clickLink('Place block');
- $elements = $this->xpath($pattern, $arguments);
- $this->assertTrue(!empty($elements), 'The test block appears in the custom category.');
- $arguments = [
- ':href' => \Drupal::Url('block.admin_add', [
- 'plugin_id' => 'views_block:' . $edit['id'] . '-block_2',
- 'theme' => 'classy',
- ]),
- ':category' => 'Lists (Views)',
- ];
- $elements = $this->xpath($pattern, $arguments);
- $this->assertTrue(!empty($elements), 'The first duplicated test block remains in the original category.');
- $arguments = [
- ':href' => \Drupal::Url('block.admin_add', [
- 'plugin_id' => 'views_block:' . $edit['id'] . '-block_3',
- 'theme' => 'classy',
- ]),
- ':category' => $category,
- ];
- $elements = $this->xpath($pattern, $arguments);
- $this->assertTrue(!empty($elements), 'The second duplicated test block appears in the custom category.');
- }
- /**
- * Tests removing a block display.
- */
- public function testDeleteBlockDisplay() {
- // To test all combinations possible we first place create two instances
- // of the block display of the first view.
- $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']);
- // Then we add one instance of blocks for each of the two displays of the
- // second view.
- $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');
- // Remove the block display, so both block entities from the first view
- // should both disappear.
- $view = Views::getView('test_view_block');
- $view->initDisplay();
- $view->displayHandlers->remove('block_1');
- $view->storage->save();
- $this->assertFalse($block_storage->load($block_1->id()), 'The block for this display was removed.');
- $this->assertFalse($block_storage->load($block_2->id()), 'The block for this display was removed.');
- $this->assertTrue($block_storage->load($block_3->id()), 'A block from another view was unaffected.');
- $this->assertTrue($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);
- // Remove the first block display of the second view and ensure the block
- // instance of the second block display still exists.
- $view = Views::getView('test_view_block2');
- $view->initDisplay();
- $view->displayHandlers->remove('block_1');
- $view->storage->save();
- $this->assertFalse($block_storage->load($block_3->id()), 'The block for this display was removed.');
- $this->assertTrue($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);
- }
- /**
- * Test the block form for a Views block.
- */
- 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);
- $elements = $this->xpath('//input[@name="label"]');
- $this->assertTrue(empty($elements), 'The label field is not found for Views blocks.');
- // Test that that machine name field is hidden from display and has been
- // saved as expected from the default value.
- $this->assertNoFieldById('edit-machine-name', 'views_block__test_view_block_1', 'The machine name is hidden on the views block form.');
- // Save the block.
- $edit = ['region' => 'content'];
- $this->drupalPostForm(NULL, $edit, t('Save block'));
- $storage = $this->container->get('entity_type.manager')->getStorage('block');
- $block = $storage->load('views_block__test_view_block_block_1');
- // This will only return a result if our new block has been created with the
- // expected machine name.
- $this->assertTrue(!empty($block), 'The expected block was loaded.');
- for ($i = 2; $i <= 3; $i++) {
- // Place the same block again and make sure we have a new ID.
- $this->drupalPostForm('admin/structure/block/add/views_block:test_view_block-block_1/' . $default_theme, $edit, t('Save block'));
- $block = $storage->load('views_block__test_view_block_block_1_' . $i);
- // This will only return a result if our new block has been created with the
- // expected machine name.
- $this->assertTrue(!empty($block), 'The expected block was loaded.');
- }
- // Tests the override capability of items per page.
- $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->drupalPostForm('admin/structure/block/add/views_block:test_view_block-block_1/' . $default_theme, $edit, t('Save block'));
- $block = $storage->load('views_block__test_view_block_block_1_4');
- $config = $block->getPlugin()->getConfiguration();
- $this->assertEqual(10, $config['items_per_page'], "'Items per page' is properly saved.");
- $edit['settings[override][items_per_page]'] = 5;
- $this->drupalPostForm('admin/structure/block/manage/views_block__test_view_block_block_1_4', $edit, t('Save block'));
- $block = $storage->load('views_block__test_view_block_block_1_4');
- $config = $block->getPlugin()->getConfiguration();
- $this->assertEqual(5, $config['items_per_page'], "'Items per page' is properly saved.");
- // Tests the override of the label capability.
- $edit = ['region' => 'content'];
- $edit['settings[views_label_checkbox]'] = 1;
- $edit['settings[views_label]'] = 'Custom title';
- $this->drupalPostForm('admin/structure/block/add/views_block:test_view_block-block_1/' . $default_theme, $edit, t('Save block'));
- $block = $storage->load('views_block__test_view_block_block_1_5');
- $config = $block->getPlugin()->getConfiguration();
- $this->assertEqual('Custom title', $config['views_label'], "'Label' is properly saved.");
- }
- /**
- * Tests the actual rendering of the views block.
- */
- public function testBlockRendering() {
- // Create a block and set a custom title.
- $block = $this->drupalPlaceBlock('views_block:test_view_block-block_1', ['label' => 'test_view_block-block_1:1', 'views_label' => 'Custom title']);
- $this->drupalGet('');
- $result = $this->xpath('//div[contains(@class, "region-sidebar-first")]/div[contains(@class, "block-views")]/h2');
- $this->assertEqual($result[0]->getText(), 'Custom title');
- // Don't override the title anymore.
- $plugin = $block->getPlugin();
- $plugin->setConfigurationValue('views_label', '');
- $block->save();
- $this->drupalGet('');
- $result = $this->xpath('//div[contains(@class, "region-sidebar-first")]/div[contains(@class, "block-views")]/h2');
- $this->assertEqual($result[0]->getText(), 'test_view_block');
- // Hide the title.
- $block->getPlugin()->setConfigurationValue('label_display', FALSE);
- $block->save();
- $this->drupalGet('');
- $result = $this->xpath('//div[contains(@class, "region-sidebar-first")]/div[contains(@class, "block-views")]/h2');
- $this->assertTrue(empty($result), 'The title is not visible.');
- $this->assertCacheTags(array_merge($block->getCacheTags(), ['block_view', 'config:block_list', 'config:system.site', 'config:views.view.test_view_block', 'http_response', 'rendered']));
- }
- /**
- * Tests the various testcases of empty block rendering.
- */
- public function testBlockEmptyRendering() {
- $url = new Url('test_page_test.test_page');
- // Remove all views_test_data entries.
- \Drupal::database()->truncate('views_test_data')->execute();
- /** @var \Drupal\views\ViewEntityInterface $view */
- $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->assertEqual(1, count($this->xpath('//div[contains(@class, "block-views-blocktest-view-block-block-1")]')));
- $display = &$view->getDisplay('block_1');
- $display['display_options']['block_hide_empty'] = TRUE;
- $view->save();
- $this->drupalGet($url);
- $this->assertEqual(0, count($this->xpath('//div[contains(@class, "block-views-blocktest-view-block-block-1")]')));
- // Ensure that the view cacheability metadata is propagated even, for an
- // empty block.
- $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']);
- // Add a header displayed on empty result.
- $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->assertEqual(1, count($this->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']);
- // Hide the header on empty results.
- $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->assertEqual(0, count($this->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']);
- // Add an empty text.
- $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->assertEqual(1, count($this->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']);
- }
- /**
- * Tests the contextual links on a Views block.
- */
- 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());
- // @see \Drupal\contextual\Tests\ContextualDynamicContextTest:assertContextualLinkPlaceHolder()
- $this->assertRaw('<div' . new Attribute(['data-contextual-id' => $id, 'data-contextual-token' => $id_token]) . '></div>', format_string('Contextual link placeholder with id @id exists.', ['@id' => $id]));
- $this->assertRaw('<div' . new Attribute(['data-contextual-id' => $cached_id, 'data-contextual-token' => $cached_id_token]) . '></div>', format_string('Contextual link placeholder with id @id exists.', ['@id' => $cached_id]));
- // Get server-rendered contextual links.
- // @see \Drupal\contextual\Tests\ContextualDynamicContextTest:renderContextualLinks()
- $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->assertResponse(200);
- $json = Json::decode($this->getSession()->getPage()->getContent());
- $this->assertIdentical($json[$id], '<ul class="contextual-links"><li class="block-configure"><a href="' . base_path() . 'admin/structure/block/manage/' . $block->id() . '">Configure 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>');
- $this->assertIdentical($json[$cached_id], '<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="entityviewedit-form"><a href="' . base_path() . 'admin/structure/views/view/test_view_block/edit/block_1">Edit view</a></li></ul>');
- }
- }
|