class CommentTokenReplaceTest

Same name and namespace in other branches
  1. 9 core/modules/comment/tests/src/Functional/CommentTokenReplaceTest.php \Drupal\Tests\comment\Functional\CommentTokenReplaceTest
  2. 8.9.x core/modules/comment/tests/src/Functional/CommentTokenReplaceTest.php \Drupal\Tests\comment\Functional\CommentTokenReplaceTest
  3. 10 core/modules/comment/tests/src/Functional/CommentTokenReplaceTest.php \Drupal\Tests\comment\Functional\CommentTokenReplaceTest

Tests comment token replacement.

@group comment

Hierarchy

Expanded class hierarchy of CommentTokenReplaceTest

File

core/modules/comment/tests/src/Functional/CommentTokenReplaceTest.php, line 22

Namespace

Drupal\Tests\comment\Functional
View source 
class CommentTokenReplaceTest extends CommentTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'taxonomy',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * Creates a comment, then tests the tokens generated from it.
     */
    public function testCommentTokenReplacement() : void {
        $token_service = \Drupal::token();
        $language_interface = \Drupal::languageManager()->getCurrentLanguage();
        $url_options = [
            'absolute' => TRUE,
            'language' => $language_interface,
        ];
        // Setup vocabulary.
        Vocabulary::create([
            'vid' => 'tags',
            'name' => 'Tags',
        ])->save();
        // Change the title of the admin user.
        $this->adminUser->name->value = 'This is a title with some special & > " stuff.';
        $this->adminUser
            ->save();
        $this->drupalLogin($this->adminUser);
        // Set comment variables.
        $this->setCommentSubject(TRUE);
        // To test hostname token field should be populated.
        \Drupal::configFactory()->getEditable('comment.settings')
            ->set('log_ip_addresses', TRUE)
            ->save(TRUE);
        // Create a node and a comment.
        $node = $this->drupalCreateNode([
            'type' => 'article',
            'title' => '<script>alert("123")</script>',
        ]);
        $parent_comment = $this->postComment($node, $this->randomMachineName(), $this->randomMachineName(), TRUE);
        // Post a reply to the comment.
        $this->drupalGet('comment/reply/node/' . $node->id() . '/comment/' . $parent_comment->id());
        $child_comment = $this->postComment(NULL, $this->randomMachineName(), $this->randomMachineName());
        $comment = Comment::load($child_comment->id());
        $comment->setHomepage('http://example.org/');
        // Add HTML to ensure that sanitation of some fields tested directly.
        $comment->setSubject('<blink>Blinking Comment</blink>');
        // Generate and test tokens.
        $tests = [];
        $tests['[comment:cid]'] = $comment->id();
        $tests['[comment:hostname]'] = $comment->getHostname();
        $tests['[comment:author]'] = Html::escape($comment->getAuthorName());
        $tests['[comment:mail]'] = $this->adminUser
            ->getEmail();
        $tests['[comment:homepage]'] = UrlHelper::filterBadProtocol($comment->getHomepage());
        $tests['[comment:title]'] = Html::escape($comment->getSubject());
        $tests['[comment:body]'] = $comment->comment_body->processed;
        $tests['[comment:langcode]'] = $comment->language()
            ->getId();
        $tests['[comment:url]'] = $comment->toUrl('canonical', $url_options + [
            'fragment' => 'comment-' . $comment->id(),
        ])
            ->toString();
        $tests['[comment:edit-url]'] = $comment->toUrl('edit-form', $url_options)
            ->toString();
        $tests['[comment:created]'] = \Drupal::service('date.formatter')->format($comment->getCreatedTime(), 'medium', [
            'langcode' => $language_interface->getId(),
        ]);
        $tests['[comment:created:since]'] = \Drupal::service('date.formatter')->formatTimeDiffSince($comment->getCreatedTime(), [
            'langcode' => $language_interface->getId(),
        ]);
        $tests['[comment:changed:since]'] = \Drupal::service('date.formatter')->formatTimeDiffSince($comment->getChangedTimeAcrossTranslations(), [
            'langcode' => $language_interface->getId(),
        ]);
        $tests['[comment:parent:cid]'] = $comment->hasParentComment() ? $comment->getParentComment()
            ->id() : NULL;
        $tests['[comment:parent:title]'] = $parent_comment->getSubject();
        $tests['[comment:entity]'] = Html::escape($node->getTitle());
        // Test node specific tokens.
        $tests['[comment:entity:nid]'] = $comment->getCommentedEntityId();
        $tests['[comment:entity:title]'] = Html::escape($node->getTitle());
        $tests['[comment:author:uid]'] = $comment->getOwnerId();
        $tests['[comment:author:name]'] = Html::escape($this->adminUser
            ->getDisplayName());
        $base_bubbleable_metadata = BubbleableMetadata::createFromObject($comment);
        $metadata_tests = [];
        $metadata_tests['[comment:cid]'] = $base_bubbleable_metadata;
        $metadata_tests['[comment:hostname]'] = $base_bubbleable_metadata;
        $bubbleable_metadata = clone $base_bubbleable_metadata;
        $bubbleable_metadata->addCacheableDependency($this->adminUser);
        $metadata_tests['[comment:author]'] = $bubbleable_metadata;
        $bubbleable_metadata = clone $base_bubbleable_metadata;
        $bubbleable_metadata->addCacheableDependency($this->adminUser);
        $metadata_tests['[comment:mail]'] = $bubbleable_metadata;
        $metadata_tests['[comment:homepage]'] = $base_bubbleable_metadata;
        $metadata_tests['[comment:title]'] = $base_bubbleable_metadata;
        $metadata_tests['[comment:body]'] = $base_bubbleable_metadata;
        $metadata_tests['[comment:langcode]'] = $base_bubbleable_metadata;
        $metadata_tests['[comment:url]'] = $base_bubbleable_metadata;
        $metadata_tests['[comment:edit-url]'] = $base_bubbleable_metadata;
        $bubbleable_metadata = clone $base_bubbleable_metadata;
        $metadata_tests['[comment:created]'] = $bubbleable_metadata->addCacheTags([
            'rendered',
        ]);
        $bubbleable_metadata = clone $base_bubbleable_metadata;
        $metadata_tests['[comment:created:since]'] = $bubbleable_metadata->setCacheMaxAge(0);
        $bubbleable_metadata = clone $base_bubbleable_metadata;
        $metadata_tests['[comment:changed:since]'] = $bubbleable_metadata->setCacheMaxAge(0);
        $bubbleable_metadata = clone $base_bubbleable_metadata;
        $metadata_tests['[comment:parent:cid]'] = $bubbleable_metadata->addCacheTags([
            'comment:1',
        ]);
        $metadata_tests['[comment:parent:title]'] = $bubbleable_metadata;
        $bubbleable_metadata = clone $base_bubbleable_metadata;
        $metadata_tests['[comment:entity]'] = $bubbleable_metadata->addCacheTags([
            'node:2',
        ]);
        // Test node specific tokens.
        $metadata_tests['[comment:entity:nid]'] = $bubbleable_metadata;
        $metadata_tests['[comment:entity:title]'] = $bubbleable_metadata;
        $bubbleable_metadata = clone $base_bubbleable_metadata;
        $metadata_tests['[comment:author:uid]'] = $bubbleable_metadata->addCacheTags([
            'user:2',
        ]);
        $metadata_tests['[comment:author:name]'] = $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 = $token_service->replace($input, [
                'comment' => $comment,
            ], [
                'langcode' => $language_interface->getId(),
            ], $bubbleable_metadata);
            $this->assertSame((string) $expected, (string) $output, "Failed test case: {$input}");
            $this->assertEquals($metadata_tests[$input], $bubbleable_metadata);
        }
        // Test anonymous comment author.
        $author_name = 'This is a random & " > string';
        $comment->setOwnerId(0)
            ->setAuthorName($author_name);
        $input = '[comment:author]';
        $output = $token_service->replace($input, [
            'comment' => $comment,
        ], [
            'langcode' => $language_interface->getId(),
        ]);
        $this->assertSame((string) Html::escape($author_name), (string) $output);
        // Add comment field to user and term entities.
        $this->addDefaultCommentField('user', 'user', 'comment', CommentItemInterface::OPEN, 'comment_user');
        $this->addDefaultCommentField('taxonomy_term', 'tags', 'comment', CommentItemInterface::OPEN, 'comment_term');
        // Create a user and a comment.
        $user = User::create([
            'name' => 'alice',
        ]);
        $user->activate();
        $user->save();
        $this->postComment($user, 'user body', 'user subject', TRUE);
        // Create a term and a comment.
        $term = Term::create([
            'vid' => 'tags',
            'name' => 'term',
        ]);
        $term->save();
        $this->postComment($term, 'term body', 'term subject', TRUE);
        // Load node, user and term again so comment_count gets computed.
        $node = Node::load($node->id());
        $user = User::load($user->id());
        $term = Term::load($term->id());
        // Generate comment tokens for node (it has 2 comments, both new),
        // user and term.
        $tests = [];
        $tests['[entity:comment-count]'] = 2;
        $tests['[entity:comment-count-new]'] = 2;
        $tests['[node:comment-count]'] = 2;
        $tests['[node:comment-count-new]'] = 2;
        $tests['[user:comment-count]'] = 1;
        $tests['[user:comment-count-new]'] = 1;
        $tests['[term:comment-count]'] = 1;
        $tests['[term:comment-count-new]'] = 1;
        foreach ($tests as $input => $expected) {
            $output = $token_service->replace($input, [
                'entity' => $node,
                'node' => $node,
                'user' => $user,
                'term' => $term,
            ], [
                'langcode' => $language_interface->getId(),
            ]);
            $this->assertSame((string) $expected, (string) $output, "Failed test case: {$input}");
        }
    }

}

Members

Title Modifiers Object type Summary Member alias Overriden Title Overrides
BlockCreationTrait::placeBlock protected function Creates a block instance based on default settings. Aliased as: drupalPlaceBlock
BrowserHtmlDebugTrait::$htmlOutputBaseUrl protected property The Base URI to use for links to the output files.
BrowserHtmlDebugTrait::$htmlOutputClassName protected property Class name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounter protected property Counter for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounterStorage protected property Counter storage for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputDirectory protected property Directory name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputEnabled protected property HTML output enabled.
BrowserHtmlDebugTrait::$htmlOutputTestId protected property HTML output test ID.
BrowserHtmlDebugTrait::formatHtmlOutputHeaders protected function Formats HTTP headers as string for HTML output logging.
BrowserHtmlDebugTrait::getHtmlOutputHeaders protected function Returns headers in HTML output format. 1
BrowserHtmlDebugTrait::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received.
BrowserHtmlDebugTrait::htmlOutput protected function Logs a HTML output message in a text file.
BrowserHtmlDebugTrait::initBrowserOutputFile protected function Creates the directory to store browser output.
BrowserTestBase::$baseUrl protected property The base URL.
BrowserTestBase::$configImporter protected property The config importer that can be used in a test.
BrowserTestBase::$customTranslations protected property An array of custom translations suitable for SettingsEditor::rewrite().
BrowserTestBase::$mink protected property Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs protected property Mink default driver params.
BrowserTestBase::$minkDefaultDriverClass protected property Mink class for the default driver to use. 1
BrowserTestBase::$originalContainer protected property The original container.
BrowserTestBase::$originalShutdownCallbacks protected property The original array of shutdown function callbacks.
BrowserTestBase::$profile protected property The profile to install as a basis for testing. 40
BrowserTestBase::$timeLimit protected property Time limit in seconds for the test.
BrowserTestBase::$translationFilesDirectory protected property The translation file directory for the test environment.
BrowserTestBase::cleanupEnvironment protected function Clean up the test environment.
BrowserTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
BrowserTestBase::filePreDeleteCallback public static function Ensures test files are deletable.
BrowserTestBase::getDefaultDriverInstance protected function Gets an instance of the default Mink driver.
BrowserTestBase::getDrupalSettings protected function Gets the JavaScript drupalSettings variable for the currently-loaded page. 1
BrowserTestBase::getHttpClient protected function Obtain the HTTP client for the system under test.
BrowserTestBase::getMinkDriverArgs protected function Gets the Mink driver args from an environment variable. 1
BrowserTestBase::getOptions protected function Helper function to get the options of select field.
BrowserTestBase::getSession public function Returns Mink session.
BrowserTestBase::getSessionCookies protected function Get session cookies from current session.
BrowserTestBase::getTestMethodCaller protected function Retrieves the current calling line in the class under test. Overrides BrowserHtmlDebugTrait::getTestMethodCaller
BrowserTestBase::initFrontPage protected function Visits the front page when initializing Mink. 3
BrowserTestBase::initMink protected function Initializes Mink sessions. 1
BrowserTestBase::installDrupal public function Installs Drupal into the test site. 2
BrowserTestBase::registerSessions protected function Registers additional Mink sessions.
BrowserTestBase::setUpAppRoot protected function Sets up the root application path.
BrowserTestBase::setUpBeforeClass public static function 1
BrowserTestBase::tearDown protected function 3
BrowserTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for submitForm().
BrowserTestBase::xpath protected function Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__construct public function
BrowserTestBase::__sleep public function Prevents serializing any properties.
CommentTestBase::$adminUser protected property An administrative user with permission to configure comment settings. 1
CommentTestBase::$node protected property A test node to which comments will be posted.
CommentTestBase::$webUser protected property A normal user with permission to post comments.
CommentTestBase::commentContactInfoAvailable public function Checks whether the commenter&#039;s contact information is displayed.
CommentTestBase::commentExists public function Checks current page for specified comment.
CommentTestBase::createCommentType protected function Creates a comment type (bundle).
CommentTestBase::deleteComment public function Deletes a comment.
CommentTestBase::getUnapprovedComment public function Gets the comment ID for an unapproved comment.
CommentTestBase::performCommentOperation public function Performs the specified operation on the specified comment.
CommentTestBase::postComment public function Posts a comment.
CommentTestBase::setCommentAnonymous public function Sets the value governing restrictions on anonymous comments.
CommentTestBase::setCommentForm public function Sets the value governing whether the comment form is on its own page.
CommentTestBase::setCommentPreview public function Sets the value governing the previewing mode for the comment form.
CommentTestBase::setCommentSettings public function Sets a comment settings variable for the article content type.
CommentTestBase::setCommentsPerPage public function Sets the value specifying the default number of comments per page.
CommentTestBase::setCommentSubject public function Sets the value governing whether the subject field should be enabled.
CommentTestBase::setUp protected function Overrides BrowserTestBase::setUp 14
CommentTestTrait::addDefaultCommentField public function Adds the default comment field to an entity.
CommentTokenReplaceTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
CommentTokenReplaceTest::$modules protected static property Modules to install. Overrides CommentTestBase::$modules
CommentTokenReplaceTest::testCommentTokenReplacement public function Creates a comment, then tests the tokens generated from it.
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.
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. Aliased as: drupalCreateContentType 1
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.
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix protected property The flag to set &#039;apcu_ensure_unique_prefix&#039; setting. 1
FunctionalTestSetupTrait::$classLoader protected property The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$rootUser protected property The &quot;#1&quot; admin user.
FunctionalTestSetupTrait::$usesSuperUserAccessPolicy protected property Set to TRUE to make user 1 a super user. 19
FunctionalTestSetupTrait::doInstall protected function Execute the non-interactive installer. 1
FunctionalTestSetupTrait::getDatabaseTypes protected function Returns all supported database driver installer objects.
FunctionalTestSetupTrait::initConfig protected function Initialize various configurations post-installation. 1
FunctionalTestSetupTrait::initKernel protected function Initializes the kernel after installation.
FunctionalTestSetupTrait::initSettings protected function Initialize settings created during install.
FunctionalTestSetupTrait::initUserSession protected function Initializes user 1 for the site to be installed.
FunctionalTestSetupTrait::installDefaultThemeFromClassProperty protected function Installs the default theme defined by `static::$defaultTheme` when needed. 1
FunctionalTestSetupTrait::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. 1
FunctionalTestSetupTrait::installParameters protected function Returns the parameters that will be used when the test installs Drupal. 8
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 28
FunctionalTestSetupTrait::prepareRequestForGenerator protected function Creates a mock request and sets it on the generator.
FunctionalTestSetupTrait::prepareSettings protected function Prepares site settings and services before installation. 4
FunctionalTestSetupTrait::rebuildAll protected function Resets and rebuilds the environment after setup.
FunctionalTestSetupTrait::rebuildContainer protected function Rebuilds \Drupal::getContainer().
FunctionalTestSetupTrait::resetAll protected function Resets all data structures after having enabled new modules.
FunctionalTestSetupTrait::setContainerParameter protected function Changes parameters in the services.yml file.
FunctionalTestSetupTrait::setupBaseUrl protected function Sets up the base URL based upon the environment variable.
FunctionalTestSetupTrait::writeSettings protected function Rewrites the settings.php file of the test site. 1
NodeCreationTrait::createNode protected function Creates a node based on default settings. Aliased as: drupalCreateNode
NodeCreationTrait::getNodeByTitle public function Get a node from the database based on its title. Aliased as: drupalGetNodeByTitle
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.
RefreshVariablesTrait::refreshVariables protected function Refreshes in-memory configuration and state information. 2
SessionTestTrait::$sessionName protected property The name of the session cookie.
SessionTestTrait::generateSessionName protected function Generates a session cookie name.
SessionTestTrait::getSessionName protected function Returns the session name in use on the child site.
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.
TestSetupTrait::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking. 2
TestSetupTrait::$container protected property The dependency injection container used in the test.
TestSetupTrait::$databasePrefix protected property The database prefix of this test run.
TestSetupTrait::$kernel protected property The DrupalKernel instance used in the test.
TestSetupTrait::$originalSite protected property The site directory of the original parent site.
TestSetupTrait::$privateFilesDirectory protected property The private file directory for the test environment.
TestSetupTrait::$publicFilesDirectory protected property The public file directory for the test environment.
TestSetupTrait::$root protected property The app root.
TestSetupTrait::$siteDirectory protected property The site directory of this test run.
TestSetupTrait::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 4
TestSetupTrait::$tempFilesDirectory protected property The temporary file directory for the test environment.
TestSetupTrait::$testId protected property The test run ID.
TestSetupTrait::changeDatabasePrefix protected function Changes the database connection to the prefixed one.
TestSetupTrait::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
TestSetupTrait::prepareDatabasePrefix protected function Generates a database prefix for running tests. 1
UiHelperTrait::$loggedInUser protected property The current user logged in using the Mink controlled browser.
UiHelperTrait::$maximumMetaRefreshCount protected property The number of meta refresh redirects to follow, or NULL if unlimited.
UiHelperTrait::$metaRefreshCount protected property The number of meta refresh redirects followed during ::drupalGet().
UiHelperTrait::assertSession public function Returns WebAssert object. 1
UiHelperTrait::buildUrl protected function Builds an absolute URL from a system path or a URL object.
UiHelperTrait::checkForMetaRefresh protected function Checks for meta refresh tag and if found call drupalGet() recursively.
UiHelperTrait::click protected function Clicks the element with the given CSS selector.
UiHelperTrait::clickLink protected function Follows a link by complete name.
UiHelperTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
UiHelperTrait::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
UiHelperTrait::drupalGet protected function Retrieves a Drupal path or an absolute path. 3
UiHelperTrait::drupalLogin protected function Logs in a user using the Mink controlled browser.
UiHelperTrait::drupalLogout protected function Logs a user out of the Mink controlled browser and confirms.
UiHelperTrait::drupalResetSession protected function Resets the current active session back to Anonymous session.
UiHelperTrait::drupalUserIsLoggedIn protected function Returns whether a given user account is logged in.
UiHelperTrait::getAbsoluteUrl protected function Takes a path and returns an absolute path.
UiHelperTrait::getTextContent protected function Retrieves the plain-text content from the current page.
UiHelperTrait::getUrl protected function Get the current URL from the browser.
UiHelperTrait::isTestUsingGuzzleClient protected function Determines if test is using DrupalTestBrowser.
UiHelperTrait::prepareRequest protected function Prepare for a request to testing site. 1
UiHelperTrait::submitForm protected function Fills and submits a form.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole protected function Creates an administrative role.
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.
UserCreationTrait::setCurrentUser protected function Switch the current logged in user.
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user.
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.

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