class NodeTokenReplaceTest

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

Tests node token replacement.

@group node

Hierarchy

Expanded class hierarchy of NodeTokenReplaceTest

File

core/modules/node/tests/src/Kernel/NodeTokenReplaceTest.php, line 18

Namespace

Drupal\Tests\node\Kernel
View source
class NodeTokenReplaceTest extends TokenReplaceKernelTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'node',
        'filter',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->installConfig([
            'filter',
            'node',
        ]);
        $node_type = NodeType::create([
            'type' => 'article',
            'name' => 'Article',
        ]);
        $node_type->save();
        node_add_body_field($node_type);
    }
    
    /**
     * Creates a node, then tests the tokens generated from it.
     */
    public function testNodeTokenReplacement() : void {
        $url_options = [
            'absolute' => TRUE,
            'language' => $this->interfaceLanguage,
        ];
        // Create a user and a node.
        $account = $this->createUser();
        
        /** @var \Drupal\node\NodeInterface $node */
        $node = Node::create([
            'type' => 'article',
            'uid' => $account->id(),
            'title' => '<blink>Blinking Text</blink>',
            'body' => [
                [
                    'value' => 'Regular NODE body for the test.',
                    'summary' => 'Fancy NODE summary.',
                    'format' => 'plain_text',
                ],
            ],
        ]);
        $node->save();
        // Generate and test tokens.
        $tests = [];
        $tests['[node:nid]'] = $node->id();
        $tests['[node:uuid]'] = $node->uuid();
        $tests['[node:vid]'] = $node->getRevisionId();
        $tests['[node:type]'] = 'article';
        $tests['[node:type-name]'] = 'Article';
        $tests['[node:title]'] = Html::escape($node->getTitle());
        $tests['[node:body]'] = $node->body->processed;
        $tests['[node:summary]'] = $node->body->summary_processed;
        $tests['[node:langcode]'] = $node->language()
            ->getId();
        $tests['[node:published_status]'] = 'Published';
        $tests['[node:url]'] = $node->toUrl('canonical', $url_options)
            ->toString();
        $tests['[node:edit-url]'] = $node->toUrl('edit-form', $url_options)
            ->toString();
        $tests['[node:author]'] = $account->getAccountName();
        $tests['[node:author:uid]'] = $node->getOwnerId();
        $tests['[node:author:name]'] = $account->getAccountName();
        
        /** @var \Drupal\Core\Datetime\DateFormatterInterface $date_formatter */
        $date_formatter = $this->container
            ->get('date.formatter');
        $tests['[node:created:since]'] = $date_formatter->formatTimeDiffSince($node->getCreatedTime(), [
            'langcode' => $this->interfaceLanguage
                ->getId(),
        ]);
        $tests['[node:changed:since]'] = $date_formatter->formatTimeDiffSince($node->getChangedTime(), [
            'langcode' => $this->interfaceLanguage
                ->getId(),
        ]);
        $base_bubbleable_metadata = BubbleableMetadata::createFromObject($node);
        $metadata_tests = [];
        $metadata_tests['[node:nid]'] = $base_bubbleable_metadata;
        $metadata_tests['[node:uuid]'] = $base_bubbleable_metadata;
        $metadata_tests['[node:vid]'] = $base_bubbleable_metadata;
        $metadata_tests['[node:type]'] = $base_bubbleable_metadata;
        $metadata_tests['[node:type-name]'] = $base_bubbleable_metadata;
        $metadata_tests['[node:title]'] = $base_bubbleable_metadata;
        $metadata_tests['[node:body]'] = $base_bubbleable_metadata;
        $metadata_tests['[node:summary]'] = $base_bubbleable_metadata;
        $metadata_tests['[node:langcode]'] = $base_bubbleable_metadata;
        $metadata_tests['[node:published_status]'] = $base_bubbleable_metadata;
        $metadata_tests['[node:url]'] = $base_bubbleable_metadata;
        $metadata_tests['[node:edit-url]'] = $base_bubbleable_metadata;
        $bubbleable_metadata = clone $base_bubbleable_metadata;
        $metadata_tests['[node:author]'] = $bubbleable_metadata->addCacheTags([
            'user:1',
        ]);
        $metadata_tests['[node:author:uid]'] = $bubbleable_metadata;
        $metadata_tests['[node:author:name]'] = $bubbleable_metadata;
        $bubbleable_metadata = clone $base_bubbleable_metadata;
        $metadata_tests['[node:created:since]'] = $bubbleable_metadata->setCacheMaxAge(0);
        $metadata_tests['[node:changed:since]'] = $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, [
                'node' => $node,
            ], [
                'langcode' => $this->interfaceLanguage
                    ->getId(),
            ], $bubbleable_metadata);
            $this->assertSame((string) $expected, (string) $output, "Failed test case: {$input}");
            $this->assertEquals($metadata_tests[$input], $bubbleable_metadata);
        }
        // Repeat for an unpublished node.
        $node = Node::create([
            'type' => 'article',
            'uid' => $account->id(),
            'title' => '<blink>Blinking Text</blink>',
        ]);
        $node->setUnpublished();
        $node->save();
        // Generate and test tokens.
        $tests = [];
        $tests['[node:published_status]'] = 'Unpublished';
        // Test to make sure that we generated something for each token.
        $this->assertFalse(in_array(0, array_map('strlen', $tests)), 'No empty tokens generated for unpublished node.');
        foreach ($tests as $input => $expected) {
            $output = $this->tokenService
                ->replace($input, [
                'node' => $node,
            ], [
                'language' => $this->interfaceLanguage,
            ]);
            $this->assertEquals($output, $expected, "Node token {$input} replaced for unpublished node.");
        }
        // Repeat for a node without a summary.
        $node = Node::create([
            'type' => 'article',
            'uid' => $account->id(),
            'title' => '<blink>Blinking Text</blink>',
            'body' => [
                [
                    'value' => 'A string that looks random like TR5c2I',
                    'format' => 'plain_text',
                ],
            ],
        ]);
        $node->save();
        // Generate and test token - use full body as expected value.
        $tests = [];
        $tests['[node:summary]'] = $node->body->processed;
        // Test to make sure that we generated something for each token.
        $this->assertNotContains(0, array_map('strlen', $tests), 'No empty tokens generated for node without a summary.');
        foreach ($tests as $input => $expected) {
            $output = $this->tokenService
                ->replace($input, [
                'node' => $node,
            ], [
                'language' => $this->interfaceLanguage,
            ]);
            $this->assertSame((string) $expected, (string) $output, "Failed test case: {$input}");
        }
    }

}

Members

Title Sort descending Deprecated 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 Deprecated 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 Deprecated 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 Deprecated 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 Deprecated protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById Deprecated protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName Deprecated protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath Deprecated protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked Deprecated 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 Deprecated protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion Deprecated protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption Deprecated protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected Deprecated 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 Deprecated 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 Deprecated protected function Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected Deprecated protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector Deprecated 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 Deprecated 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 Deprecated protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper Deprecated 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. 2
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 28
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. 3
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.
NodeTokenReplaceTest::$modules protected static property Modules to install. Overrides TokenReplaceKernelTestBase::$modules
NodeTokenReplaceTest::setUp protected function Overrides TokenReplaceKernelTestBase::setUp
NodeTokenReplaceTest::testNodeTokenReplacement public function Creates a node, then tests the tokens generated from it.
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.
TokenReplaceKernelTestBase::$interfaceLanguage protected property The interface language.
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.