1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
|
<?php
declare(strict_types=1);
namespace Drupal\Tests\navigation\FunctionalJavascript;
use Drupal\Core\Url;
use Drupal\FunctionalJavascriptTests\WebDriverTestBase;
use Drupal\Tests\block\Traits\BlockCreationTrait;
use Drupal\Tests\contextual\FunctionalJavascript\ContextualLinkClickTrait;
use Drupal\Tests\layout_builder\FunctionalJavascript\LayoutBuilderSortTrait;
use Drupal\Tests\system\Traits\OffCanvasTestTrait;
use Drupal\user\UserInterface;
use PHPUnit\Framework\Attributes\Group;
/**
* Tests that the navigation block UI exists and stores data correctly.
*/
#[Group('navigation')]
class NavigationBlockUiTest extends WebDriverTestBase {
use BlockCreationTrait;
use ContextualLinkClickTrait;
use LayoutBuilderSortTrait;
use OffCanvasTestTrait;
/**
* {@inheritdoc}
*/
protected static $modules = [
'navigation',
'block_content',
'layout_builder',
'layout_test',
'layout_builder_form_block_test',
'node',
'field_ui',
'shortcut',
'off_canvas_test',
'navigation_test',
];
/**
* {@inheritdoc}
*/
protected $defaultTheme = 'starterkit_theme';
/**
* An administrative user to configure the test environment.
*
* @var \Drupal\user\UserInterface
*/
protected UserInterface $adminUser;
/**
* {@inheritdoc}
*/
protected function setUp(): void {
parent::setUp();
$this->drupalPlaceBlock('page_title_block', ['id' => 'title']);
// Create an administrative user.
$this->adminUser = $this->drupalCreateUser([
'configure navigation layout',
'access administration pages',
'access navigation',
'access shortcuts',
'access contextual links',
'administer shortcuts',
'administer site configuration',
'access administration pages',
]);
}
/**
* Tests navigation block admin page exists and functions correctly.
*/
public function testNavigationBlockAdminUiPageNestedForm(): void {
$layout_url = '/admin/config/user-interface/navigation-block';
$this->drupalLogin($this->adminUser);
// Edit the layout and add a block that contains a form.
$this->drupalGet($layout_url);
$this->getSession()->getPage()->pressButton('Enable edit mode');
$this->assertSession()->assertWaitOnAjaxRequest();
$this->openAddBlockForm('Layout Builder form block test form api form block');
$this->getSession()->getPage()->checkField('settings[label_display]');
// Save the new block, and ensure it is displayed on the page.
$this->getSession()->getPage()->pressButton('Add block');
$this->assertSession()->assertWaitOnAjaxRequest();
$this->assertSession()->assertNoElementAfterWait('css', '#drupal-off-canvas');
$this->assertSession()->addressEquals($layout_url);
$this->assertSession()->pageTextContains('Layout Builder form block test form api form block');
$this->getSession()->getPage()->pressButton('Save');
$unexpected_save_message = 'You have unsaved changes';
$expected_save_message = 'Saved navigation blocks';
$this->assertSession()->statusMessageNotContains($unexpected_save_message);
$this->assertSession()->statusMessageContains($expected_save_message);
// Try to save the layout again and confirm it can save because there are no
// nested form tags.
$this->drupalGet($layout_url);
$this->getSession()->getPage()->pressButton('Enable edit mode');
$this->assertSession()->assertWaitOnAjaxRequest();
$this->getSession()->getPage()->checkField('toggle_content_preview');
$this->getSession()->getPage()->pressButton('Save');
$this->assertSession()->statusMessageNotContains($unexpected_save_message);
$this->assertSession()->statusMessageContains($expected_save_message);
}
/**
* Tests navigation block admin page exists and functions correctly.
*/
public function testNavigationBlockAdminUiPage(): void {
$layout_url = '/admin/config/user-interface/navigation-block';
$this->drupalGet($layout_url);
$this->assertSession()->pageTextContains('Access denied');
// Add at least one shortcut.
$shortcut_set = \Drupal::entityTypeManager()
->getStorage('shortcut_set')
->getDisplayedToUser($this->adminUser);
$shortcut = \Drupal::entityTypeManager()->getStorage('shortcut')->create([
'title' => 'Run cron',
'shortcut_set' => $shortcut_set->id(),
'link' => [
'uri' => 'internal:/admin/config/system/cron',
],
]);
$shortcut->save();
$this->drupalLogin($this->adminUser);
$this->drupalGet($layout_url);
$page = $this->getSession()->getPage();
$this->getSession()->getPage()->pressButton('Enable edit mode');
$this->assertSession()->assertWaitOnAjaxRequest();
// Add section should not be present
$this->assertSession()->linkNotExists('Add section');
// Configure section should not be present.
$this->assertSession()->linkNotExists('Configure Section 1');
// Remove section should not be present.
$this->assertSession()->linkNotExists('Remove Section 1');
// Remove the shortcut block.
$this->assertSession()->pageTextContains('Shortcuts');
$this->clickContextualLink('.layout-builder .block-navigation-shortcuts', 'Remove block');
$this->assertOffCanvasFormAfterWait('layout_builder_remove_block');
$this->assertSession()->pageTextContains('Are you sure you want to remove the Shortcuts block?');
$this->assertSession()->pageTextContains('This action cannot be undone.');
$page->pressButton('Remove');
$this->assertSession()->assertWaitOnAjaxRequest();
$this->assertSession()->assertNoElementAfterWait('css', '#drupal-off-canvas');
$this->assertSession()->elementNotExists('css', '.layout-builder .block-navigation-shortcuts');
// Add a new block.
$this->getSession()->getPage()->uncheckField('toggle_content_preview');
$this->openAddBlockForm('Navigation Shortcuts');
$page->fillField('settings[label]', 'New Shortcuts');
$page->checkField('settings[label_display]');
// Save the new block, and ensure it is displayed on the page.
$page->pressButton('Add block');
$this->assertSession()->assertWaitOnAjaxRequest();
$this->assertSession()->assertNoElementAfterWait('css', '#drupal-off-canvas');
$this->assertSession()->addressEquals($layout_url);
$this->assertSession()->pageTextContains('Shortcuts');
$this->assertSession()->pageTextContains('New Shortcuts');
// Until the layout is saved, the new block is not visible on the node page.
$front = Url::fromRoute('<front>');
$this->drupalGet($front);
$this->assertSession()->pageTextNotContains('New Shortcuts');
// When returning to the layout page, the new block is not visible.
$this->drupalGet($layout_url);
$this->assertSession()->pageTextNotContains('New Shortcuts');
// When returning to the layout edit mode, the new block is visible.
$this->getSession()->getPage()->pressButton('Enable edit mode');
$this->assertSession()->assertWaitOnAjaxRequest();
$this->assertSession()->pageTextContains('New Shortcuts');
// Save the layout, and the new block is visible in the front page.
$page->pressButton('Save');
$this->drupalGet($front);
$this->assertSession()->pageTextContains('New Shortcuts');
// Reconfigure a block and ensure that the layout content is updated.
$this->drupalGet($layout_url);
$this->getSession()->getPage()->pressButton('Enable edit mode');
$this->assertSession()->assertWaitOnAjaxRequest();
$this->clickContextualLink('.layout-builder .block-navigation-shortcuts', 'Configure');
$this->assertOffCanvasFormAfterWait('layout_builder_update_block');
$page->fillField('settings[label]', 'Newer Shortcuts');
$page->pressButton('Update');
$this->assertSession()->assertWaitOnAjaxRequest();
$this->assertSession()->assertNoElementAfterWait('css', '#drupal-off-canvas');
$this->assertSession()->addressEquals($layout_url);
$this->assertSession()->pageTextContains('Newer Shortcuts');
$this->assertSession()->elementTextNotContains('css', 'form', 'New Shortcuts');
}
/**
* Opens the add block form in the off-canvas dialog.
*
* @param string $block_title
* The block title which will be the link text.
*
* @todo move this from into a trait from
* \Drupal\Tests\layout_builder\FunctionalJavascript\LayoutBuilderTest
*/
private function openAddBlockForm($block_title): void {
$this->assertSession()->linkExists('Add block');
$this->clickLink('Add block');
$this->assertSession()->assertWaitOnAjaxRequest();
$this->assertNotEmpty($this->assertSession()->waitForElementVisible('named', ['link', $block_title]));
$this->clickLink($block_title);
$this->assertOffCanvasFormAfterWait('layout_builder_add_block');
}
/**
* Waits for the specified form and returns it when available and visible.
*
* @param string $expected_form_id
* The expected form ID.
*
* @todo move this from into a trait from
* \Drupal\Tests\layout_builder\FunctionalJavascript\LayoutBuilderTest
*/
private function assertOffCanvasFormAfterWait(string $expected_form_id): void {
$this->assertSession()->assertWaitOnAjaxRequest();
$this->waitForOffCanvasArea();
$off_canvas = $this->assertSession()->elementExists('css', '#drupal-off-canvas');
$this->assertNotNull($off_canvas);
$form_id_element = $off_canvas->find('hidden_field_selector', ['hidden_field', 'form_id']);
// Ensure the form ID has the correct value and that the form is visible.
$this->assertNotEmpty($form_id_element);
$this->assertSame($expected_form_id, $form_id_element->getValue());
$this->assertTrue($form_id_element->getParent()->isVisible());
}
}
|
