class TokenReplaceKernelTest

Same name in other branches
  1. 9 core/modules/system/tests/src/Kernel/Token/TokenReplaceKernelTest.php \Drupal\Tests\system\Kernel\Token\TokenReplaceKernelTest
  2. 8.9.x core/modules/system/tests/src/Kernel/Token/TokenReplaceKernelTest.php \Drupal\Tests\system\Kernel\Token\TokenReplaceKernelTest
  3. 10 core/modules/system/tests/src/Kernel/Token/TokenReplaceKernelTest.php \Drupal\Tests\system\Kernel\Token\TokenReplaceKernelTest

Tests token replacement.

@group system

Hierarchy

Expanded class hierarchy of TokenReplaceKernelTest

File

core/modules/system/tests/src/Kernel/Token/TokenReplaceKernelTest.php, line 20

Namespace

Drupal\Tests\system\Kernel\Token
View source
class TokenReplaceKernelTest extends TokenReplaceKernelTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        // Set the site name to something other than an empty string.
        $this->config('system.site')
            ->set('name', 'Drupal')
            ->save();
    }
    
    /**
     * Tests whether token-replacement works in various contexts.
     */
    public function testSystemTokenRecognition() : void {
        // Generate prefixes and suffixes for the token context.
        $tests = [
            [
                'prefix' => 'this is the ',
                'suffix' => ' site',
            ],
            [
                'prefix' => 'this is the',
                'suffix' => 'site',
            ],
            [
                'prefix' => '[',
                'suffix' => ']',
            ],
            [
                'prefix' => '',
                'suffix' => ']]]',
            ],
            [
                'prefix' => '[[[',
                'suffix' => '',
            ],
            [
                'prefix' => ':[:',
                'suffix' => '--]',
            ],
            [
                'prefix' => '-[-',
                'suffix' => ':]:',
            ],
            [
                'prefix' => '[:',
                'suffix' => ']',
            ],
            [
                'prefix' => '[site:',
                'suffix' => ':name]',
            ],
            [
                'prefix' => '[site:',
                'suffix' => ']',
            ],
        ];
        // Check if the token is recognized in each of the contexts.
        foreach ($tests as $test) {
            $input = $test['prefix'] . '[site:name]' . $test['suffix'];
            $expected = $test['prefix'] . 'Drupal' . $test['suffix'];
            $output = $this->tokenService
                ->replace($input, [], [
                'langcode' => $this->interfaceLanguage
                    ->getId(),
            ]);
            $this->assertSame($expected, $output, "Token recognized in string {$input}");
        }
        // Test token replacement when the string contains no tokens.
        $this->assertEquals('No tokens here.', $this->tokenService
            ->replace('No tokens here.'));
    }
    
    /**
     * Tests the clear parameter.
     */
    public function testClear() : void {
        // Valid token.
        $source = '[site:name]';
        // No user passed in, should be untouched.
        $source .= '[user:name]';
        // Non-existing token.
        $source .= '[bogus:token]';
        // Replace with the clear parameter, only the valid token should remain.
        $target = Html::escape($this->config('system.site')
            ->get('name'));
        $result = $this->tokenService
            ->replace($source, [], [
            'langcode' => $this->interfaceLanguage
                ->getId(),
            'clear' => TRUE,
        ]);
        $this->assertEquals($target, $result, 'Valid tokens replaced while invalid tokens ignored.');
        $target .= '[user:name]';
        $target .= '[bogus:token]';
        $result = $this->tokenService
            ->replace($source, [], [
            'langcode' => $this->interfaceLanguage
                ->getId(),
        ]);
        $this->assertEquals($target, $result, 'Valid tokens replaced while invalid tokens ignored.');
    }
    
    /**
     * Tests the generation of all system site information tokens.
     */
    public function testSystemSiteTokenReplacement() : void {
        $url_options = [
            'absolute' => TRUE,
            'language' => $this->interfaceLanguage,
        ];
        $slogan = '<blink>Slogan</blink>';
        $safe_slogan = Xss::filterAdmin($slogan);
        // Set a few site variables.
        $config = $this->config('system.site');
        $config->set('name', '<strong>Drupal<strong>')
            ->set('slogan', $slogan)
            ->set('mail', 'simpletest@example.com')
            ->save();
        // Generate and test tokens.
        $tests = [];
        $tests['[site:name]'] = Html::escape($config->get('name'));
        $tests['[site:slogan]'] = $safe_slogan;
        $tests['[site:mail]'] = $config->get('mail');
        $tests['[site:url]'] = Url::fromRoute('<front>', [], $url_options)->toString();
        $tests['[site:url-brief]'] = preg_replace([
            '!^https?://!',
            '!/$!',
        ], '', Url::fromRoute('<front>', [], $url_options)->toString());
        $tests['[site:base-url]'] = 'http://localhost';
        $tests['[site:login-url]'] = Url::fromRoute('user.page', [], $url_options)->toString();
        $base_bubbleable_metadata = new BubbleableMetadata();
        $metadata_tests = [];
        $metadata_tests['[site:name]'] = BubbleableMetadata::createFromObject(\Drupal::config('system.site'));
        $metadata_tests['[site:slogan]'] = BubbleableMetadata::createFromObject(\Drupal::config('system.site'));
        $metadata_tests['[site:mail]'] = BubbleableMetadata::createFromObject(\Drupal::config('system.site'));
        $bubbleable_metadata = clone $base_bubbleable_metadata;
        $metadata_tests['[site:base-url]'] = $bubbleable_metadata->addCacheContexts([
            'url.site',
        ]);
        $metadata_tests['[site:url]'] = $bubbleable_metadata->addCacheContexts([
            'url.site',
        ]);
        $metadata_tests['[site:url-brief]'] = $bubbleable_metadata;
        $metadata_tests['[site:login-url]'] = $bubbleable_metadata;
        // Test to make sure that we generated something for each token.
        $this->assertNotContains(0, array_map('strlen', $tests), 'No empty tokens generated.');
        foreach ($tests as $input => $expected) {
            $bubbleable_metadata = new BubbleableMetadata();
            $output = $this->tokenService
                ->replace($input, [], [
                'langcode' => $this->interfaceLanguage
                    ->getId(),
            ], $bubbleable_metadata);
            $this->assertEquals($expected, $output, "System site information token {$input} replaced.");
            $this->assertEquals($metadata_tests[$input], $bubbleable_metadata);
        }
        // Test [site:base-url] and [site:base-path] token with a subdirectory.
        $request_stack = \Drupal::requestStack();
        // Test request with subdirectory on homepage.
        $server = [
            'SCRIPT_NAME' => '/subdir/index.php',
            'SCRIPT_FILENAME' => $this->root . '/subdir/index.php',
            'SERVER_NAME' => 'http://localhost',
        ];
        $request = Request::create('/subdir/', 'GET', [], [], [], $server);
        $request->setSession(new Session(new MockArraySessionStorage()));
        $request->server
            ->add($server);
        $request_stack->push($request);
        $bubbleable_metadata = new BubbleableMetadata();
        $this->container
            ->get('router.request_context')
            ->setCompleteBaseUrl('http://localhost/subdir');
        $this->assertEquals('http://localhost/subdir', $this->tokenService
            ->replace('[site:base-url]', [], [
            'langcode' => $this->interfaceLanguage
                ->getId(),
        ], $bubbleable_metadata));
        $this->assertEquals((new BubbleableMetadata())->addCacheContexts([
            'url.site',
        ]), $bubbleable_metadata);
        $bubbleable_metadata = new BubbleableMetadata();
        $this->assertEquals('/subdir', $this->tokenService
            ->replace('[site:base-path]', [], [
            'langcode' => $this->interfaceLanguage
                ->getId(),
        ], $bubbleable_metadata));
        $this->assertEquals((new BubbleableMetadata())->addCacheContexts([
            'url.site',
        ]), $bubbleable_metadata);
    }
    
    /**
     * Tests the generation of all system date tokens.
     */
    public function testSystemDateTokenReplacement() : void {
        // Set time to one hour before request.
        $date = \Drupal::time()->getRequestTime() - 3600;
        // Generate and test tokens.
        $tests = [];
        $date_formatter = \Drupal::service('date.formatter');
        $tests['[date:short]'] = $date_formatter->format($date, 'short', '', NULL, $this->interfaceLanguage
            ->getId());
        $tests['[date:medium]'] = $date_formatter->format($date, 'medium', '', NULL, $this->interfaceLanguage
            ->getId());
        $tests['[date:long]'] = $date_formatter->format($date, 'long', '', NULL, $this->interfaceLanguage
            ->getId());
        $tests['[date:custom:m/j/Y]'] = $date_formatter->format($date, 'custom', 'm/j/Y', NULL, $this->interfaceLanguage
            ->getId());
        $tests['[date:since]'] = $date_formatter->formatTimeDiffSince($date, [
            'langcode' => $this->interfaceLanguage
                ->getId(),
        ]);
        $tests['[date:raw]'] = Xss::filter($date);
        // Test to make sure that we generated something for each token.
        $this->assertNotContains(0, array_map('strlen', $tests), 'No empty tokens generated.');
        foreach ($tests as $input => $expected) {
            $output = $this->tokenService
                ->replace($input, [
                'date' => $date,
            ], [
                'langcode' => $this->interfaceLanguage
                    ->getId(),
            ]);
            $this->assertEquals($expected, $output, "Date token {$input} replaced.");
        }
    }

}

Members

Title Sort descending Modifiers Object type Summary Member alias Overriden Title Overrides
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 raw text IS NOT found escaped on 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::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.
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.
EntityKernelTestBase::$entityTypeManager protected property The entity type manager service. 1
EntityKernelTestBase::$state protected property The state service.
EntityKernelTestBase::createUser protected function Creates a user.
EntityKernelTestBase::getHooksInfo protected function Returns the entity_test hook invocation info.
EntityKernelTestBase::installModule protected function Installs a module and refreshes services.
EntityKernelTestBase::refreshServices protected function Refresh services. 1
EntityKernelTestBase::uninstallModule protected function Uninstalls a module and refreshes services.
EntityTrait::$generatedIds protected property A list of entity IDs generated by self::generateRandomEntityId().
EntityTrait::generateRandomEntityId protected function Generates a random ID avoiding collisions.
EntityTrait::reloadEntity protected function Reloads the given entity from the storage and returns it.
ExpectDeprecationTrait::expectDeprecation public function Adds an expected deprecation.
ExpectDeprecationTrait::getCallableName private static function Returns a callable as a string suitable for inclusion in a message.
ExpectDeprecationTrait::setUpErrorHandler public function Sets up the test error handler.
ExpectDeprecationTrait::tearDownErrorHandler public function Tears down the test error handler.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
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. 6
KernelTestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking. 4
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$keyValue protected property The key_value service that must persist between container rebuilds.
KernelTestBase::$root protected property The app root.
KernelTestBase::$siteDirectory protected property
KernelTestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 9
KernelTestBase::$usesSuperUserAccessPolicy protected property Set to TRUE to make user 1 a super user. 3
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 protected function Bootstraps a kernel for a test. 1
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. 1
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. 2
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to install.
KernelTestBase::getModulesToEnable private static function Returns the modules to install 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::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 27
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::tearDown protected function 7
KernelTestBase::tearDownCloseDatabaseConnection public function Additional tear down method to close the connection at the end.
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__construct public function
KernelTestBase::__sleep public function Prevents serializing any properties.
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.
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.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.
TokenReplaceKernelTest::setUp protected function Overrides TokenReplaceKernelTestBase::setUp
TokenReplaceKernelTest::testClear public function Tests the clear parameter.
TokenReplaceKernelTest::testSystemDateTokenReplacement public function Tests the generation of all system date tokens.
TokenReplaceKernelTest::testSystemSiteTokenReplacement public function Tests the generation of all system site information tokens.
TokenReplaceKernelTest::testSystemTokenRecognition public function Tests whether token-replacement works in various contexts.
TokenReplaceKernelTestBase::$interfaceLanguage protected property The interface language.
TokenReplaceKernelTestBase::$modules protected static property Modules to install. Overrides EntityKernelTestBase::$modules 1
TokenReplaceKernelTestBase::$tokenService protected property Token service.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid. Aliased as: drupalCheckPermissions
UserCreationTrait::createAdminRole protected function Creates an administrative role. Aliased as: drupalCreateAdminRole
UserCreationTrait::createRole protected function Creates a role with specified permissions. Aliased as: drupalCreateRole
UserCreationTrait::createUser protected function Create a user with a given set of permissions. Aliased as: drupalCreateUser
UserCreationTrait::grantPermissions protected function Grant permissions to a user role. Aliased as: drupalGrantPermissions
UserCreationTrait::setCurrentUser protected function Switch the current logged in user. Aliased as: drupalSetCurrentUser
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user. Aliased as: drupalSetUpCurrentUser

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.