annotate core/modules/path/tests/src/Functional/PathAliasTest.php @ 19:fa3358dc1485 tip

Add ndrum files
author Chris Cannam
date Wed, 28 Aug 2019 13:14:47 +0100
parents 129ea1e6d783
children
rev   line source
Chris@0 1 <?php
Chris@0 2
Chris@0 3 namespace Drupal\Tests\path\Functional;
Chris@0 4
Chris@0 5 use Drupal\Core\Cache\Cache;
Chris@0 6 use Drupal\Core\Database\Database;
Chris@17 7 use Drupal\Core\Url;
Chris@0 8
Chris@0 9 /**
Chris@0 10 * Add, edit, delete, and change alias and verify its consistency in the
Chris@0 11 * database.
Chris@0 12 *
Chris@0 13 * @group path
Chris@0 14 */
Chris@0 15 class PathAliasTest extends PathTestBase {
Chris@0 16
Chris@0 17 /**
Chris@0 18 * Modules to enable.
Chris@0 19 *
Chris@0 20 * @var array
Chris@0 21 */
Chris@0 22 public static $modules = ['path'];
Chris@0 23
Chris@0 24 protected function setUp() {
Chris@0 25 parent::setUp();
Chris@0 26
Chris@0 27 // Create test user and log in.
Chris@17 28 $web_user = $this->drupalCreateUser(['create page content', 'edit own page content', 'administer url aliases', 'create url aliases', 'access content overview']);
Chris@0 29 $this->drupalLogin($web_user);
Chris@0 30 }
Chris@0 31
Chris@0 32 /**
Chris@0 33 * Tests the path cache.
Chris@0 34 */
Chris@0 35 public function testPathCache() {
Chris@0 36 // Create test node.
Chris@0 37 $node1 = $this->drupalCreateNode();
Chris@0 38
Chris@0 39 // Create alias.
Chris@0 40 $edit = [];
Chris@0 41 $edit['source'] = '/node/' . $node1->id();
Chris@0 42 $edit['alias'] = '/' . $this->randomMachineName(8);
Chris@0 43 $this->drupalPostForm('admin/config/search/path/add', $edit, t('Save'));
Chris@0 44
Chris@0 45 // Check the path alias whitelist cache.
Chris@0 46 $whitelist = \Drupal::cache('bootstrap')->get('path_alias_whitelist');
Chris@0 47 $this->assertTrue($whitelist->data['node']);
Chris@0 48 $this->assertFalse($whitelist->data['admin']);
Chris@0 49
Chris@0 50 // Visit the system path for the node and confirm a cache entry is
Chris@0 51 // created.
Chris@0 52 \Drupal::cache('data')->deleteAll();
Chris@0 53 // Make sure the path is not converted to the alias.
Chris@0 54 $this->drupalGet(trim($edit['source'], '/'), ['alias' => TRUE]);
Chris@0 55 $this->assertTrue(\Drupal::cache('data')->get('preload-paths:' . $edit['source']), 'Cache entry was created.');
Chris@0 56
Chris@0 57 // Visit the alias for the node and confirm a cache entry is created.
Chris@0 58 \Drupal::cache('data')->deleteAll();
Chris@0 59 // @todo Remove this once https://www.drupal.org/node/2480077 lands.
Chris@0 60 Cache::invalidateTags(['rendered']);
Chris@0 61 $this->drupalGet(trim($edit['alias'], '/'));
Chris@0 62 $this->assertTrue(\Drupal::cache('data')->get('preload-paths:' . $edit['source']), 'Cache entry was created.');
Chris@0 63 }
Chris@0 64
Chris@0 65 /**
Chris@0 66 * Tests alias functionality through the admin interfaces.
Chris@0 67 */
Chris@0 68 public function testAdminAlias() {
Chris@0 69 // Create test node.
Chris@0 70 $node1 = $this->drupalCreateNode();
Chris@0 71
Chris@0 72 // Create alias.
Chris@0 73 $edit = [];
Chris@0 74 $edit['source'] = '/node/' . $node1->id();
Chris@0 75 $edit['alias'] = '/' . $this->getRandomGenerator()->word(8);
Chris@0 76 $this->drupalPostForm('admin/config/search/path/add', $edit, t('Save'));
Chris@0 77
Chris@0 78 // Confirm that the alias works.
Chris@0 79 $this->drupalGet($edit['alias']);
Chris@0 80 $this->assertText($node1->label(), 'Alias works.');
Chris@0 81 $this->assertResponse(200);
Chris@0 82 // Confirm that the alias works in a case-insensitive way.
Chris@0 83 $this->assertTrue(ctype_lower(ltrim($edit['alias'], '/')));
Chris@0 84 $this->drupalGet($edit['alias']);
Chris@0 85 $this->assertText($node1->label(), 'Alias works lower case.');
Chris@0 86 $this->assertResponse(200);
Chris@17 87 $this->drupalGet(mb_strtoupper($edit['alias']));
Chris@0 88 $this->assertText($node1->label(), 'Alias works upper case.');
Chris@0 89 $this->assertResponse(200);
Chris@0 90
Chris@0 91 // Change alias to one containing "exotic" characters.
Chris@0 92 $pid = $this->getPID($edit['alias']);
Chris@0 93
Chris@0 94 $previous = $edit['alias'];
Chris@0 95 // Lower-case letters.
Chris@0 96 $edit['alias'] = '/alias' .
Chris@0 97 // "Special" ASCII characters.
Chris@0 98 "- ._~!$'\"()*@[]?&+%#,;=:" .
Chris@0 99 // Characters that look like a percent-escaped string.
Chris@0 100 "%23%25%26%2B%2F%3F" .
Chris@0 101 // Characters from various non-ASCII alphabets.
Chris@0 102 "中國書۞";
Chris@0 103 $connection = Database::getConnection();
Chris@0 104 if ($connection->databaseType() != 'sqlite') {
Chris@0 105 // When using LIKE for case-insensitivity, the SQLite driver is
Chris@0 106 // currently unable to find the upper-case versions of non-ASCII
Chris@0 107 // characters.
Chris@0 108 // @todo fix this in https://www.drupal.org/node/2607432
Chris@0 109 $edit['alias'] .= "ïвβéø";
Chris@0 110 }
Chris@0 111 $this->drupalPostForm('admin/config/search/path/edit/' . $pid, $edit, t('Save'));
Chris@0 112
Chris@0 113 // Confirm that the alias works.
Chris@17 114 $this->drupalGet(mb_strtoupper($edit['alias']));
Chris@0 115 $this->assertText($node1->label(), 'Changed alias works.');
Chris@0 116 $this->assertResponse(200);
Chris@0 117
Chris@0 118 $this->container->get('path.alias_manager')->cacheClear();
Chris@0 119 // Confirm that previous alias no longer works.
Chris@0 120 $this->drupalGet($previous);
Chris@0 121 $this->assertNoText($node1->label(), 'Previous alias no longer works.');
Chris@0 122 $this->assertResponse(404);
Chris@0 123
Chris@0 124 // Create second test node.
Chris@0 125 $node2 = $this->drupalCreateNode();
Chris@0 126
Chris@0 127 // Set alias to second test node.
Chris@0 128 $edit['source'] = '/node/' . $node2->id();
Chris@0 129 // leave $edit['alias'] the same
Chris@0 130 $this->drupalPostForm('admin/config/search/path/add', $edit, t('Save'));
Chris@0 131
Chris@0 132 // Confirm no duplicate was created.
Chris@0 133 $this->assertRaw(t('The alias %alias is already in use in this language.', ['%alias' => $edit['alias']]), 'Attempt to move alias was rejected.');
Chris@0 134
Chris@0 135 $edit_upper = $edit;
Chris@17 136 $edit_upper['alias'] = mb_strtoupper($edit['alias']);
Chris@0 137 $this->drupalPostForm('admin/config/search/path/add', $edit_upper, t('Save'));
Chris@0 138 $this->assertRaw(t('The alias %alias could not be added because it is already in use in this language with different capitalization: %stored_alias.', [
Chris@0 139 '%alias' => $edit_upper['alias'],
Chris@0 140 '%stored_alias' => $edit['alias'],
Chris@0 141 ]), 'Attempt to move upper-case alias was rejected.');
Chris@0 142
Chris@0 143 // Delete alias.
Chris@0 144 $this->drupalGet('admin/config/search/path/edit/' . $pid);
Chris@0 145 $this->clickLink(t('Delete'));
Chris@0 146 $this->assertRaw(t('Are you sure you want to delete path alias %name?', ['%name' => $edit['alias']]));
Chris@0 147 $this->drupalPostForm(NULL, [], t('Confirm'));
Chris@0 148
Chris@0 149 // Confirm that the alias no longer works.
Chris@0 150 $this->drupalGet($edit['alias']);
Chris@0 151 $this->assertNoText($node1->label(), 'Alias was successfully deleted.');
Chris@0 152 $this->assertResponse(404);
Chris@0 153
Chris@0 154 // Create a really long alias.
Chris@0 155 $edit = [];
Chris@0 156 $edit['source'] = '/node/' . $node1->id();
Chris@0 157 $alias = '/' . $this->randomMachineName(128);
Chris@0 158 $edit['alias'] = $alias;
Chris@0 159 // The alias is shortened to 50 characters counting the ellipsis.
Chris@0 160 $truncated_alias = substr($alias, 0, 47);
Chris@0 161 $this->drupalPostForm('admin/config/search/path/add', $edit, t('Save'));
Chris@0 162 $this->assertNoText($alias, 'The untruncated alias was not found.');
Chris@0 163 // The 'truncated' alias will always be found.
Chris@0 164 $this->assertText($truncated_alias, 'The truncated alias was found.');
Chris@0 165
Chris@0 166 // Create third test node.
Chris@0 167 $node3 = $this->drupalCreateNode();
Chris@0 168
Chris@0 169 // Create absolute path alias.
Chris@0 170 $edit = [];
Chris@0 171 $edit['source'] = '/node/' . $node3->id();
Chris@0 172 $node3_alias = '/' . $this->randomMachineName(8);
Chris@0 173 $edit['alias'] = $node3_alias;
Chris@0 174 $this->drupalPostForm('admin/config/search/path/add', $edit, t('Save'));
Chris@0 175
Chris@0 176 // Create fourth test node.
Chris@0 177 $node4 = $this->drupalCreateNode();
Chris@0 178
Chris@0 179 // Create alias with trailing slash.
Chris@0 180 $edit = [];
Chris@0 181 $edit['source'] = '/node/' . $node4->id();
Chris@0 182 $node4_alias = '/' . $this->randomMachineName(8);
Chris@0 183 $edit['alias'] = $node4_alias . '/';
Chris@0 184 $this->drupalPostForm('admin/config/search/path/add', $edit, t('Save'));
Chris@0 185
Chris@0 186 // Confirm that the alias with trailing slash is not found.
Chris@0 187 $this->assertNoText($edit['alias'], 'The absolute alias was not found.');
Chris@0 188 // The alias without trailing flash is found.
Chris@0 189 $this->assertText(trim($edit['alias'], '/'), 'The alias without trailing slash was found.');
Chris@0 190
Chris@0 191 // Update an existing alias to point to a different source.
Chris@0 192 $pid = $this->getPID($node4_alias);
Chris@0 193 $edit = [];
Chris@0 194 $edit['alias'] = $node4_alias;
Chris@0 195 $edit['source'] = '/node/' . $node2->id();
Chris@0 196 $this->drupalPostForm('admin/config/search/path/edit/' . $pid, $edit, t('Save'));
Chris@0 197 $this->assertText('The alias has been saved.');
Chris@0 198 $this->drupalGet($edit['alias']);
Chris@0 199 $this->assertNoText($node4->label(), 'Previous alias no longer works.');
Chris@0 200 $this->assertText($node2->label(), 'Alias works.');
Chris@0 201 $this->assertResponse(200);
Chris@0 202
Chris@0 203 // Update an existing alias to use a duplicate alias.
Chris@0 204 $pid = $this->getPID($node3_alias);
Chris@0 205 $edit = [];
Chris@0 206 $edit['alias'] = $node4_alias;
Chris@0 207 $edit['source'] = '/node/' . $node3->id();
Chris@0 208 $this->drupalPostForm('admin/config/search/path/edit/' . $pid, $edit, t('Save'));
Chris@0 209 $this->assertRaw(t('The alias %alias is already in use in this language.', ['%alias' => $edit['alias']]));
Chris@0 210
Chris@0 211 // Create an alias without a starting slash.
Chris@0 212 $node5 = $this->drupalCreateNode();
Chris@0 213
Chris@0 214 $edit = [];
Chris@0 215 $edit['source'] = 'node/' . $node5->id();
Chris@0 216 $node5_alias = $this->randomMachineName(8);
Chris@0 217 $edit['alias'] = $node5_alias . '/';
Chris@0 218 $this->drupalPostForm('admin/config/search/path/add', $edit, t('Save'));
Chris@0 219
Chris@0 220 $this->assertUrl('admin/config/search/path/add');
Chris@0 221 $this->assertText('The source path has to start with a slash.');
Chris@0 222 $this->assertText('The alias path has to start with a slash.');
Chris@0 223 }
Chris@0 224
Chris@0 225 /**
Chris@0 226 * Tests alias functionality through the node interfaces.
Chris@0 227 */
Chris@0 228 public function testNodeAlias() {
Chris@0 229 // Create test node.
Chris@0 230 $node1 = $this->drupalCreateNode();
Chris@0 231
Chris@0 232 // Create alias.
Chris@0 233 $edit = [];
Chris@0 234 $edit['path[0][alias]'] = '/' . $this->randomMachineName(8);
Chris@0 235 $this->drupalPostForm('node/' . $node1->id() . '/edit', $edit, t('Save'));
Chris@0 236
Chris@0 237 // Confirm that the alias works.
Chris@0 238 $this->drupalGet($edit['path[0][alias]']);
Chris@0 239 $this->assertText($node1->label(), 'Alias works.');
Chris@0 240 $this->assertResponse(200);
Chris@0 241
Chris@0 242 // Confirm the 'canonical' and 'shortlink' URLs.
Chris@0 243 $elements = $this->xpath("//link[contains(@rel, 'canonical') and contains(@href, '" . $edit['path[0][alias]'] . "')]");
Chris@0 244 $this->assertTrue(!empty($elements), 'Page contains canonical link URL.');
Chris@0 245 $elements = $this->xpath("//link[contains(@rel, 'shortlink') and contains(@href, 'node/" . $node1->id() . "')]");
Chris@0 246 $this->assertTrue(!empty($elements), 'Page contains shortlink URL.');
Chris@0 247
Chris@0 248 $previous = $edit['path[0][alias]'];
Chris@0 249 // Change alias to one containing "exotic" characters.
Chris@0 250 // Lower-case letters.
Chris@0 251 $edit['path[0][alias]'] = '/alias' .
Chris@0 252 // "Special" ASCII characters.
Chris@0 253 "- ._~!$'\"()*@[]?&+%#,;=:" .
Chris@0 254 // Characters that look like a percent-escaped string.
Chris@0 255 "%23%25%26%2B%2F%3F" .
Chris@0 256 // Characters from various non-ASCII alphabets.
Chris@0 257 "中國書۞";
Chris@0 258 $connection = Database::getConnection();
Chris@0 259 if ($connection->databaseType() != 'sqlite') {
Chris@0 260 // When using LIKE for case-insensitivity, the SQLite driver is
Chris@0 261 // currently unable to find the upper-case versions of non-ASCII
Chris@0 262 // characters.
Chris@0 263 // @todo fix this in https://www.drupal.org/node/2607432
Chris@0 264 $edit['path[0][alias]'] .= "ïвβéø";
Chris@0 265 }
Chris@0 266 $this->drupalPostForm('node/' . $node1->id() . '/edit', $edit, t('Save'));
Chris@0 267
Chris@0 268 // Confirm that the alias works.
Chris@17 269 $this->drupalGet(mb_strtoupper($edit['path[0][alias]']));
Chris@0 270 $this->assertText($node1->label(), 'Changed alias works.');
Chris@0 271 $this->assertResponse(200);
Chris@0 272
Chris@0 273 // Make sure that previous alias no longer works.
Chris@0 274 $this->drupalGet($previous);
Chris@0 275 $this->assertNoText($node1->label(), 'Previous alias no longer works.');
Chris@0 276 $this->assertResponse(404);
Chris@0 277
Chris@0 278 // Create second test node.
Chris@0 279 $node2 = $this->drupalCreateNode();
Chris@0 280
Chris@0 281 // Set alias to second test node.
Chris@0 282 // Leave $edit['path[0][alias]'] the same.
Chris@0 283 $this->drupalPostForm('node/' . $node2->id() . '/edit', $edit, t('Save'));
Chris@0 284
Chris@0 285 // Confirm that the alias didn't make a duplicate.
Chris@0 286 $this->assertText(t('The alias is already in use.'), 'Attempt to moved alias was rejected.');
Chris@0 287
Chris@0 288 // Delete alias.
Chris@0 289 $this->drupalPostForm('node/' . $node1->id() . '/edit', ['path[0][alias]' => ''], t('Save'));
Chris@0 290
Chris@0 291 // Confirm that the alias no longer works.
Chris@0 292 $this->drupalGet($edit['path[0][alias]']);
Chris@0 293 $this->assertNoText($node1->label(), 'Alias was successfully deleted.');
Chris@0 294 $this->assertResponse(404);
Chris@0 295
Chris@0 296 // Create third test node.
Chris@0 297 $node3 = $this->drupalCreateNode();
Chris@0 298
Chris@0 299 // Set its path alias to an absolute path.
Chris@0 300 $edit = ['path[0][alias]' => '/' . $this->randomMachineName(8)];
Chris@0 301 $this->drupalPostForm('node/' . $node3->id() . '/edit', $edit, t('Save'));
Chris@0 302
Chris@0 303 // Confirm that the alias was converted to a relative path.
Chris@0 304 $this->drupalGet(trim($edit['path[0][alias]'], '/'));
Chris@0 305 $this->assertText($node3->label(), 'Alias became relative.');
Chris@0 306 $this->assertResponse(200);
Chris@0 307
Chris@0 308 // Create fourth test node.
Chris@0 309 $node4 = $this->drupalCreateNode();
Chris@0 310
Chris@0 311 // Set its path alias to have a trailing slash.
Chris@0 312 $edit = ['path[0][alias]' => '/' . $this->randomMachineName(8) . '/'];
Chris@0 313 $this->drupalPostForm('node/' . $node4->id() . '/edit', $edit, t('Save'));
Chris@0 314
Chris@0 315 // Confirm that the alias was converted to a relative path.
Chris@0 316 $this->drupalGet(trim($edit['path[0][alias]'], '/'));
Chris@0 317 $this->assertText($node4->label(), 'Alias trimmed trailing slash.');
Chris@0 318 $this->assertResponse(200);
Chris@0 319
Chris@0 320 // Create fifth test node.
Chris@0 321 $node5 = $this->drupalCreateNode();
Chris@0 322
Chris@0 323 // Set a path alias.
Chris@0 324 $edit = ['path[0][alias]' => '/' . $this->randomMachineName(8)];
Chris@0 325 $this->drupalPostForm('node/' . $node5->id() . '/edit', $edit, t('Save'));
Chris@0 326
Chris@0 327 // Delete the node and check that the path alias is also deleted.
Chris@0 328 $node5->delete();
Chris@0 329 $path_alias = \Drupal::service('path.alias_storage')->lookupPathAlias('/node/' . $node5->id(), $node5->language()->getId());
Chris@0 330 $this->assertFalse($path_alias, 'Alias was successfully deleted when the referenced node was deleted.');
Chris@17 331
Chris@17 332 // Create sixth test node.
Chris@17 333 $node6 = $this->drupalCreateNode();
Chris@17 334
Chris@17 335 // Create an invalid alias with two leading slashes and verify that the
Chris@17 336 // extra slash is removed when the link is generated. This ensures that URL
Chris@17 337 // aliases cannot be used to inject external URLs.
Chris@17 338 // @todo The user interface should either display an error message or
Chris@17 339 // automatically trim these invalid aliases, rather than allowing them to
Chris@17 340 // be silently created, at which point the functional aspects of this
Chris@17 341 // test will need to be moved elsewhere and switch to using a
Chris@17 342 // programmatically-created alias instead.
Chris@17 343 $alias = $this->randomMachineName(8);
Chris@17 344 $edit = ['path[0][alias]' => '//' . $alias];
Chris@17 345 $this->drupalPostForm($node6->toUrl('edit-form'), $edit, t('Save'));
Chris@17 346 $this->drupalGet(Url::fromRoute('system.admin_content'));
Chris@17 347 // This checks the link href before clicking it, rather than using
Chris@17 348 // \Drupal\Tests\BrowserTestBase::assertSession()->addressEquals() after
Chris@17 349 // clicking it, because the test browser does not always preserve the
Chris@17 350 // correct number of slashes in the URL when it visits internal links;
Chris@17 351 // using \Drupal\Tests\BrowserTestBase::assertSession()->addressEquals()
Chris@17 352 // would actually make the test pass unconditionally on the testbot (or
Chris@17 353 // anywhere else where Drupal is installed in a subdirectory).
Chris@17 354 $link_xpath = $this->xpath('//a[normalize-space(text())=:label]', [':label' => $node6->getTitle()]);
Chris@17 355 $link_href = $link_xpath[0]->getAttribute('href');
Chris@17 356 $this->assertEquals($link_href, base_path() . $alias);
Chris@17 357 $this->clickLink($node6->getTitle());
Chris@17 358 $this->assertResponse(404);
Chris@0 359 }
Chris@0 360
Chris@0 361 /**
Chris@0 362 * Returns the path ID.
Chris@0 363 *
Chris@0 364 * @param string $alias
Chris@0 365 * A string containing an aliased path.
Chris@0 366 *
Chris@0 367 * @return int
Chris@0 368 * Integer representing the path ID.
Chris@0 369 */
Chris@0 370 public function getPID($alias) {
Chris@0 371 return db_query("SELECT pid FROM {url_alias} WHERE alias = :alias", [':alias' => $alias])->fetchField();
Chris@0 372 }
Chris@0 373
Chris@0 374 /**
Chris@0 375 * Tests that duplicate aliases fail validation.
Chris@0 376 */
Chris@0 377 public function testDuplicateNodeAlias() {
Chris@0 378 // Create one node with a random alias.
Chris@0 379 $node_one = $this->drupalCreateNode();
Chris@0 380 $edit = [];
Chris@0 381 $edit['path[0][alias]'] = '/' . $this->randomMachineName();
Chris@0 382 $this->drupalPostForm('node/' . $node_one->id() . '/edit', $edit, t('Save'));
Chris@0 383
Chris@0 384 // Now create another node and try to set the same alias.
Chris@0 385 $node_two = $this->drupalCreateNode();
Chris@0 386 $this->drupalPostForm('node/' . $node_two->id() . '/edit', $edit, t('Save'));
Chris@0 387 $this->assertText(t('The alias is already in use.'));
Chris@0 388 $this->assertFieldByXPath("//input[@name='path[0][alias]' and contains(@class, 'error')]", $edit['path[0][alias]'], 'Textfield exists and has the error class.');
Chris@0 389
Chris@0 390 // Behavior here differs with the inline_form_errors module enabled.
Chris@0 391 // Enable the inline_form_errors module and try this again. This module
Chris@0 392 // improves validation with a link in the error message(s) to the fields
Chris@0 393 // which have invalid input.
Chris@0 394 $this->assertTrue($this->container->get('module_installer')->install(['inline_form_errors'], TRUE), 'Installed inline_form_errors.');
Chris@0 395 // Attempt to edit the second node again, as before.
Chris@0 396 $this->drupalPostForm('node/' . $node_two->id() . '/edit', $edit, t('Preview'));
Chris@0 397 // This error should still be present next to the field.
Chris@0 398 $this->assertSession()->pageTextContains(t('The alias is already in use.'), 'Field error found with expected text.');
Chris@0 399 // The validation error set for the page should include this text.
Chris@0 400 $this->assertSession()->pageTextContains(t('1 error has been found: URL alias'), 'Form error found with expected text.');
Chris@0 401 // The text 'URL alias' should be a link.
Chris@0 402 $this->assertSession()->linkExists('URL alias');
Chris@0 403 // The link should be to the ID of the URL alias field.
Chris@0 404 $this->assertSession()->linkByHrefExists('#edit-path-0-alias');
Chris@0 405 }
Chris@0 406
Chris@0 407 }