You are here

Home » API reference » Drupal 9 » AliasTest.php

class AliasTest in Drupal 9

Same name and namespace in other branches
  1. 8 core/modules/path_alias/tests/src/Kernel/AliasTest.php \Drupal\Tests\path_alias\Kernel\AliasTest

Tests path alias CRUD and lookup functionality.

@coversDefaultClass \Drupal\path_alias\AliasRepository

@group path_alias

Hierarchy

Expanded class hierarchy of AliasTest

File

core/modules/path_alias/tests/src/Kernel/AliasTest.php, line 19

Namespace

Drupal\Tests\path_alias\Kernel
View source 
class AliasTest extends KernelTestBase {
  use PathAliasTestTrait;

  /**
   * {@inheritdoc}
   */
  protected static $modules = [
    'path_alias',
  ];

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();

    // The alias whitelist expects that the menu path roots are set by a
    // menu router rebuild.
    \Drupal::state()
      ->set('router.path_roots', [
      'user',
      'admin',
    ]);
    $this
      ->installEntitySchema('path_alias');
  }

  /**
   * @covers ::lookupBySystemPath
   */
  public function testLookupBySystemPath() {
    $this
      ->createPathAlias('/test-source-Case', '/test-alias');
    $path_alias_repository = $this->container
      ->get('path_alias.repository');
    $this
      ->assertEquals('/test-alias', $path_alias_repository
      ->lookupBySystemPath('/test-source-Case', LanguageInterface::LANGCODE_NOT_SPECIFIED)['alias']);
    $this
      ->assertEquals('/test-alias', $path_alias_repository
      ->lookupBySystemPath('/test-source-case', LanguageInterface::LANGCODE_NOT_SPECIFIED)['alias']);
  }

  /**
   * @covers ::lookupByAlias
   */
  public function testLookupByAlias() {
    $this
      ->createPathAlias('/test-source', '/test-alias-Case');
    $path_alias_repository = $this->container
      ->get('path_alias.repository');
    $this
      ->assertEquals('/test-source', $path_alias_repository
      ->lookupByAlias('/test-alias-Case', LanguageInterface::LANGCODE_NOT_SPECIFIED)['path']);
    $this
      ->assertEquals('/test-source', $path_alias_repository
      ->lookupByAlias('/test-alias-case', LanguageInterface::LANGCODE_NOT_SPECIFIED)['path']);
  }

  /**
   * @covers \Drupal\path_alias\AliasManager::getPathByAlias
   * @covers \Drupal\path_alias\AliasManager::getAliasByPath
   */
  public function testLookupPath() {

    // Create AliasManager and Path object.
    $aliasManager = $this->container
      ->get('path_alias.manager');

    // Test the situation where the source is the same for multiple aliases.
    // Start with a language-neutral alias, which we will override.
    $path_alias = $this
      ->createPathAlias('/user/1', '/foo');
    $this
      ->assertEquals($path_alias
      ->getAlias(), $aliasManager
      ->getAliasByPath($path_alias
      ->getPath()), 'Basic alias lookup works.');
    $this
      ->assertEquals($path_alias
      ->getPath(), $aliasManager
      ->getPathByAlias($path_alias
      ->getAlias()), 'Basic source lookup works.');

    // Create a language specific alias for the default language (English).
    $path_alias = $this
      ->createPathAlias('/user/1', '/users/Dries', 'en');
    $this
      ->assertEquals($path_alias
      ->getAlias(), $aliasManager
      ->getAliasByPath($path_alias
      ->getPath()), 'English alias overrides language-neutral alias.');
    $this
      ->assertEquals($path_alias
      ->getPath(), $aliasManager
      ->getPathByAlias($path_alias
      ->getAlias()), 'English source overrides language-neutral source.');

    // Create a language-neutral alias for the same path, again.
    $path_alias = $this
      ->createPathAlias('/user/1', '/bar');
    $this
      ->assertEquals("/users/Dries", $aliasManager
      ->getAliasByPath($path_alias
      ->getPath()), 'English alias still returned after entering a language-neutral alias.');

    // Create a language-specific (xx-lolspeak) alias for the same path.
    $path_alias = $this
      ->createPathAlias('/user/1', '/LOL', 'xx-lolspeak');
    $this
      ->assertEquals("/users/Dries", $aliasManager
      ->getAliasByPath($path_alias
      ->getPath()), 'English alias still returned after entering a LOLspeak alias.');

    // The LOLspeak alias should be returned if we really want LOLspeak.
    $this
      ->assertEquals('/LOL', $aliasManager
      ->getAliasByPath($path_alias
      ->getPath(), 'xx-lolspeak'), 'LOLspeak alias returned if we specify xx-lolspeak to the alias manager.');

    // Create a new alias for this path in English, which should override the
    // previous alias for "user/1".
    $path_alias = $this
      ->createPathAlias('/user/1', '/users/my-new-path', 'en');
    $this
      ->assertEquals($path_alias
      ->getAlias(), $aliasManager
      ->getAliasByPath($path_alias
      ->getPath()), 'Recently created English alias returned.');
    $this
      ->assertEquals($path_alias
      ->getPath(), $aliasManager
      ->getPathByAlias($path_alias
      ->getAlias()), 'Recently created English source returned.');

    // Remove the English aliases, which should cause a fallback to the most
    // recently created language-neutral alias, 'bar'.
    $path_alias_storage = $this->container
      ->get('entity_type.manager')
      ->getStorage('path_alias');
    $entities = $path_alias_storage
      ->loadByProperties([
      'langcode' => 'en',
    ]);
    $path_alias_storage
      ->delete($entities);
    $this
      ->assertEquals('/bar', $aliasManager
      ->getAliasByPath($path_alias
      ->getPath()), 'Path lookup falls back to recently created language-neutral alias.');

    // Test the situation where the alias and language are the same, but
    // the source differs. The newer alias record should be returned.
    $this
      ->createPathAlias('/user/2', '/bar');
    $aliasManager
      ->cacheClear();
    $this
      ->assertEquals('/user/2', $aliasManager
      ->getPathByAlias('/bar'), 'Newer alias record is returned when comparing two LanguageInterface::LANGCODE_NOT_SPECIFIED paths with the same alias.');
  }

  /**
   * Tests the alias whitelist.
   */
  public function testWhitelist() {
    $memoryCounterBackend = new MemoryCounterBackend();

    // Create AliasManager and Path object.
    $whitelist = new AliasWhitelist('path_alias_whitelist', $memoryCounterBackend, $this->container
      ->get('lock'), $this->container
      ->get('state'), $this->container
      ->get('path_alias.repository'));
    $aliasManager = new AliasManager($this->container
      ->get('path_alias.repository'), $whitelist, $this->container
      ->get('language_manager'), $memoryCounterBackend);

    // No alias for user and admin yet, so should be NULL.
    $this
      ->assertNull($whitelist
      ->get('user'));
    $this
      ->assertNull($whitelist
      ->get('admin'));

    // Non-existing path roots should be NULL too. Use a length of 7 to avoid
    // possible conflict with random aliases below.
    $this
      ->assertNull($whitelist
      ->get($this
      ->randomMachineName()));

    // Add an alias for user/1, user should get whitelisted now.
    $this
      ->createPathAlias('/user/1', '/' . $this
      ->randomMachineName());
    $aliasManager
      ->cacheClear();
    $this
      ->assertTrue($whitelist
      ->get('user'));
    $this
      ->assertNull($whitelist
      ->get('admin'));
    $this
      ->assertNull($whitelist
      ->get($this
      ->randomMachineName()));

    // Add an alias for admin, both should get whitelisted now.
    $this
      ->createPathAlias('/admin/something', '/' . $this
      ->randomMachineName());
    $aliasManager
      ->cacheClear();
    $this
      ->assertTrue($whitelist
      ->get('user'));
    $this
      ->assertTrue($whitelist
      ->get('admin'));
    $this
      ->assertNull($whitelist
      ->get($this
      ->randomMachineName()));

    // Remove the user alias again, whitelist entry should be removed.
    $path_alias_storage = $this->container
      ->get('entity_type.manager')
      ->getStorage('path_alias');
    $entities = $path_alias_storage
      ->loadByProperties([
      'path' => '/user/1',
    ]);
    $path_alias_storage
      ->delete($entities);
    $aliasManager
      ->cacheClear();
    $this
      ->assertNull($whitelist
      ->get('user'));
    $this
      ->assertTrue($whitelist
      ->get('admin'));
    $this
      ->assertNull($whitelist
      ->get($this
      ->randomMachineName()));

    // Destruct the whitelist so that the caches are written.
    $whitelist
      ->destruct();
    $this
      ->assertEquals(1, $memoryCounterBackend
      ->getCounter('set', 'path_alias_whitelist'));
    $memoryCounterBackend
      ->resetCounter();

    // Re-initialize the whitelist using the same cache backend, should load
    // from cache.
    $whitelist = new AliasWhitelist('path_alias_whitelist', $memoryCounterBackend, $this->container
      ->get('lock'), $this->container
      ->get('state'), $this->container
      ->get('path_alias.repository'));
    $this
      ->assertNull($whitelist
      ->get('user'));
    $this
      ->assertTrue($whitelist
      ->get('admin'));
    $this
      ->assertNull($whitelist
      ->get($this
      ->randomMachineName()));
    $this
      ->assertEquals(1, $memoryCounterBackend
      ->getCounter('get', 'path_alias_whitelist'));
    $this
      ->assertEquals(0, $memoryCounterBackend
      ->getCounter('set', 'path_alias_whitelist'));

    // Destruct the whitelist, should not attempt to write the cache again.
    $whitelist
      ->destruct();
    $this
      ->assertEquals(1, $memoryCounterBackend
      ->getCounter('get', 'path_alias_whitelist'));
    $this
      ->assertEquals(0, $memoryCounterBackend
      ->getCounter('set', 'path_alias_whitelist'));
  }

  /**
   * Tests situation where the whitelist cache is deleted mid-request.
   */
  public function testWhitelistCacheDeletionMidRequest() {
    $memoryCounterBackend = new MemoryCounterBackend();

    // Create AliasManager and Path object.
    $whitelist = new AliasWhitelist('path_alias_whitelist', $memoryCounterBackend, $this->container
      ->get('lock'), $this->container
      ->get('state'), $this->container
      ->get('path_alias.repository'));

    // Whitelist cache should not exist at all yet.
    $this
      ->assertFalse($memoryCounterBackend
      ->get('path_alias_whitelist'));

    // Add some aliases for both menu routes we have.
    $this
      ->createPathAlias('/admin/something', '/' . $this
      ->randomMachineName());
    $this
      ->createPathAlias('/user/something', '/' . $this
      ->randomMachineName());

    // Lookup admin path in whitelist. It will query the DB and figure out
    // that it indeed has an alias, and add it to the internal whitelist and
    // flag it to be persisted to cache.
    $this
      ->assertTrue($whitelist
      ->get('admin'));

    // Destruct the whitelist so it persists its cache.
    $whitelist
      ->destruct();
    $this
      ->assertEquals(1, $memoryCounterBackend
      ->getCounter('set', 'path_alias_whitelist'));

    // Cache data should have data for 'user' and 'admin', even though just
    // 'admin' was looked up. This is because the cache is primed with all
    // menu router base paths.
    $this
      ->assertEquals([
      'user' => FALSE,
      'admin' => TRUE,
    ], $memoryCounterBackend
      ->get('path_alias_whitelist')->data);
    $memoryCounterBackend
      ->resetCounter();

    // Re-initialize the whitelist and lookup an alias for the 'user' path.
    // Whitelist should load data from its cache, see that it hasn't done a
    // check for 'user' yet, perform the check, then mark the result to be
    // persisted to cache.
    $whitelist = new AliasWhitelist('path_alias_whitelist', $memoryCounterBackend, $this->container
      ->get('lock'), $this->container
      ->get('state'), $this->container
      ->get('path_alias.repository'));
    $this
      ->assertTrue($whitelist
      ->get('user'));

    // Delete the whitelist cache. This could happen from an outside process,
    // like a code deployment that performs a cache rebuild.
    $memoryCounterBackend
      ->delete('path_alias_whitelist');

    // Destruct whitelist so it attempts to save the whitelist data to cache.
    // However it should recognize that the previous cache entry was deleted
    // from underneath it and not save anything to cache, to protect from
    // cache corruption.
    $whitelist
      ->destruct();
    $this
      ->assertEquals(0, $memoryCounterBackend
      ->getCounter('set', 'path_alias_whitelist'));
    $this
      ->assertFalse($memoryCounterBackend
      ->get('path_alias_whitelist'));
    $memoryCounterBackend
      ->resetCounter();
  }

}

Members

Namesort descending Modifiers Type Description Overrides
AliasTest::$modules protected static property Modules to enable. Overrides KernelTestBase::$modules
AliasTest::setUp protected function Overrides KernelTestBase::setUp
AliasTest::testLookupByAlias public function @covers ::lookupByAlias
AliasTest::testLookupBySystemPath public function @covers ::lookupBySystemPath
AliasTest::testLookupPath public function @covers \Drupal\path_alias\AliasManager::getPathByAlias @covers \Drupal\path_alias\AliasManager::getAliasByPath
AliasTest::testWhitelist public function Tests the alias whitelist.
AliasTest::testWhitelistCacheDeletionMidRequest public function Tests situation where the whitelist cache is deleted mid-request.
AssertContentTrait::$content protected property The current raw content.
AssertContentTrait::$drupalSettings protected property The drupalSettings value from the current raw $content.
AssertContentTrait::$elements protected property The XML structure parsed from the current raw $content. 1
AssertContentTrait::$plainTextContent protected property The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink protected function Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds protected function Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped protected function Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertNoField protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected protected function Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern protected function Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw protected function Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle protected function Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText protected function Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern protected function Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput protected function Asserts themed output.
AssertContentTrait::assertTitle protected function Pass if the page title is the given string.
AssertContentTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper protected function Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery protected function Builds an XPath query.
AssertContentTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings protected function Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent protected function Gets the current raw content.
AssertContentTrait::getSelectedItem protected function Get the selected value from a select field.
AssertContentTrait::getTextContent protected function Retrieves the plain-text content from the current raw content.
AssertContentTrait::getUrl protected function Get the current URL from the cURL handler. 1
AssertContentTrait::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace protected function Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings protected function Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent protected function Sets the raw content (e.g. HTML).
AssertContentTrait::xpath protected function Performs an xpath search on the contents of the internal browser.
AssertLegacyTrait::assert Deprecated protected function
AssertLegacyTrait::assertEqual Deprecated protected function
AssertLegacyTrait::assertIdentical Deprecated protected function
AssertLegacyTrait::assertIdenticalObject Deprecated protected function
AssertLegacyTrait::assertNotEqual Deprecated protected function
AssertLegacyTrait::assertNotIdentical Deprecated protected function
AssertLegacyTrait::pass Deprecated protected function
AssertLegacyTrait::verbose Deprecated protected function
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
KernelTestBase::$backupGlobals protected property Back up and restore any global variables that may be changed by tests.
KernelTestBase::$backupStaticAttributes protected property Back up and restore static class properties that may be changed by tests.
KernelTestBase::$backupStaticAttributesBlacklist protected property Contains a few static class properties for performance.
KernelTestBase::$classLoader protected property
KernelTestBase::$configImporter protected property @todo Move into Config test base class. 7
KernelTestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$preserveGlobalState protected property Do not forward any global state from the parent process to the processes that run the actual tests.
KernelTestBase::$root protected property The app root.
KernelTestBase::$runTestInSeparateProcess protected property Kernel tests are run in separate processes because they allow autoloading of code from extensions. Running the test in a separate process isolates this behavior from other tests. Subclasses should not override this property.
KernelTestBase::$siteDirectory protected property
KernelTestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 6
KernelTestBase::$vfsRoot protected property The virtual filesystem root directory.
KernelTestBase::assertPostConditions protected function 1
KernelTestBase::bootEnvironment protected function Bootstraps a basic test environment.
KernelTestBase::bootKernel private function Bootstraps a kernel for a test.
KernelTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::disableModules protected function Disables modules for this test.
KernelTestBase::enableModules protected function Enables modules for this test.
KernelTestBase::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo protected function Returns the Database connection info to be used for this test. 3
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to enable.
KernelTestBase::getModulesToEnable private static function Returns the modules to enable for this test.
KernelTestBase::initFileCache protected function Initializes the FileCache component.
KernelTestBase::installConfig protected function Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema protected function Installs the storage schema for a specific entity type.
KernelTestBase::installSchema protected function Installs database tables from a module schema definition.
KernelTestBase::prepareTemplate protected function
KernelTestBase::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 24
KernelTestBase::render protected function Renders a render array. 1
KernelTestBase::setInstallProfile protected function Sets the install profile and rebuilds the container to update it.
KernelTestBase::setSetting protected function Sets an in-memory Settings variable.
KernelTestBase::setUpBeforeClass public static function 1
KernelTestBase::setUpFilesystem protected function Sets up the filesystem, so things like the file directory. 2
KernelTestBase::stop protected function Stops test execution.
KernelTestBase::tearDown protected function 4
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__sleep public function Prevents serializing any properties.
PathAliasTestTrait::assertPathAliasExists protected function Asserts that a path alias exists in the storage.
PathAliasTestTrait::assertPathAliasNotExists protected function Asserts that a path alias does not exist in the storage.
PathAliasTestTrait::createPathAlias protected function Creates a new path alias.
PathAliasTestTrait::loadPathAliasByConditions protected function Gets the first result from a 'load by properties' storage call.
PhpUnitWarnings::$deprecationWarnings private static property Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning public function Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
RandomGeneratorTrait::$randomGenerator protected property The random generator.
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers. 1
RandomGeneratorTrait::randomObject public function Generates a random PHP object.
RandomGeneratorTrait::randomString public function Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate public function Callback for random string validation.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements protected function Check module requirements for the Drupal use case. 1
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.