class CommentCSSTest

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

Tests CSS classes on comments.

@group comment

Hierarchy

Expanded class hierarchy of CommentCSSTest

File

core/modules/comment/tests/src/Functional/CommentCSSTest.php, line 18

Namespace

Drupal\Tests\comment\Functional
View source
class CommentCSSTest extends CommentTestBase {
    use GeneratePermutationsTrait;
    
    /**
     * The theme to install as the default for testing.
     *
     * @var string
     */
    protected $defaultTheme = 'starterkit_theme';
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        // Allow anonymous users to see comments.
        user_role_grant_permissions(RoleInterface::ANONYMOUS_ID, [
            'access comments',
            'access content',
        ]);
    }
    
    /**
     * Tests CSS classes on comments.
     */
    public function testCommentClasses() : void {
        // Create all permutations for comments, users, and nodes.
        $parameters = [
            'node_uid' => [
                0,
                $this->webUser
                    ->id(),
            ],
            'comment_uid' => [
                0,
                $this->webUser
                    ->id(),
                $this->adminUser
                    ->id(),
            ],
            'comment_status' => [
                CommentInterface::PUBLISHED,
                CommentInterface::NOT_PUBLISHED,
            ],
            'user' => [
                'anonymous',
                'authenticated',
                'admin',
            ],
        ];
        $permutations = $this->generatePermutations($parameters);
        foreach ($permutations as $case) {
            // Create a new node.
            $node = $this->drupalCreateNode([
                'type' => 'article',
                'uid' => $case['node_uid'],
            ]);
            // Add a comment.
            
            /** @var \Drupal\comment\CommentInterface $comment */
            $comment = Comment::create([
                'entity_id' => $node->id(),
                'entity_type' => 'node',
                'field_name' => 'comment',
                'uid' => $case['comment_uid'],
                'status' => $case['comment_status'],
                'subject' => $this->randomMachineName(),
                'language' => LanguageInterface::LANGCODE_NOT_SPECIFIED,
                'comment_body' => [
                    LanguageInterface::LANGCODE_NOT_SPECIFIED => [
                        $this->randomMachineName(),
                    ],
                ],
            ]);
            $comment->save();
            // Adjust the current/viewing user.
            switch ($case['user']) {
                case 'anonymous':
                    if ($this->loggedInUser) {
                        $this->drupalLogout();
                    }
                    $case['user_uid'] = 0;
                    break;
                case 'authenticated':
                    $this->drupalLogin($this->webUser);
                    $case['user_uid'] = $this->webUser
                        ->id();
                    break;
                case 'admin':
                    $this->drupalLogin($this->adminUser);
                    $case['user_uid'] = $this->adminUser
                        ->id();
                    break;
            }
            // Request the node with the comment.
            $this->drupalGet('node/' . $node->id());
            $settings = $this->getDrupalSettings();
            // Verify the data-history-node-id attribute, which is necessary for the
            // by-viewer class and the "new" indicator, see below.
            $this->assertSession()
                ->elementsCount('xpath', '//*[@data-history-node-id="' . $node->id() . '"]', 1);
            // Verify classes if the comment is visible for the current user.
            if ($case['comment_status'] == CommentInterface::PUBLISHED || $case['user'] == 'admin') {
                // Verify the by-anonymous class.
                $comments = '//*[contains(@class, "comment") and contains(@class, "by-anonymous")]';
                if ($case['comment_uid'] == 0) {
                    $this->assertSession()
                        ->elementsCount('xpath', $comments, 1);
                }
                else {
                    $this->assertSession()
                        ->elementNotExists('xpath', $comments);
                }
                // Verify the by-node-author class.
                $comments = '//*[contains(@class, "comment") and contains(@class, "by-node-author")]';
                if ($case['comment_uid'] > 0 && $case['comment_uid'] == $case['node_uid']) {
                    $this->assertSession()
                        ->elementsCount('xpath', $comments, 1);
                }
                else {
                    $this->assertSession()
                        ->elementNotExists('xpath', $comments);
                }
                // Verify the data-comment-user-id attribute, which is used by the
                // drupal.comment-by-viewer library to add a by-viewer when the current
                // user (the viewer) was the author of the comment. We do this in Java-
                // Script to prevent breaking the render cache.
                $this->assertSession()
                    ->elementsCount('xpath', '//*[contains(@class, "comment") and @data-comment-user-id="' . $case['comment_uid'] . '"]', 1);
                $this->assertSession()
                    ->responseContains($this->getModulePath('comment') . '/js/comment-by-viewer.js');
            }
            // Verify the unpublished class.
            $comments = '//*[contains(@class, "comment") and contains(@class, "unpublished")]';
            if ($case['comment_status'] == CommentInterface::NOT_PUBLISHED && $case['user'] == 'admin') {
                $this->assertSession()
                    ->elementsCount('xpath', $comments, 1);
            }
            else {
                $this->assertSession()
                    ->elementNotExists('xpath', $comments);
            }
            // Verify the data-comment-timestamp attribute, which is used by the
            // drupal.comment-new-indicator library to add a "new" indicator to each
            // comment that was created or changed after the last time the current
            // user read the corresponding node.
            if ($case['comment_status'] == CommentInterface::PUBLISHED || $case['user'] == 'admin') {
                $this->assertSession()
                    ->elementsCount('xpath', '//*[contains(@class, "comment")]/*[@data-comment-timestamp="' . $comment->getChangedTime() . '"]', 1);
                $expectedJS = $case['user'] !== 'anonymous';
                $this->assertSame($expectedJS, isset($settings['ajaxPageState']['libraries']) && in_array('comment/drupal.comment-new-indicator', explode(',', $settings['ajaxPageState']['libraries'])), 'drupal.comment-new-indicator library is present.');
            }
        }
    }

}

Members

Title Sort descending 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. 41
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 1
BrowserTestBase::__sleep public function Prevents serializing any properties.
CommentCSSTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
CommentCSSTest::setUp protected function Overrides CommentTestBase::setUp
CommentCSSTest::testCommentClasses public function Tests CSS classes on comments.
CommentTestBase::$adminUser protected property An administrative user with permission to configure comment settings. 1
CommentTestBase::$modules protected static property Overrides BrowserTestBase::$modules 11
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 protected function Checks whether the commenter's contact information is displayed.
CommentTestBase::commentExists protected function Checks current page for specified comment.
CommentTestBase::createCommentType protected function Creates a comment type (bundle).
CommentTestBase::deleteComment protected function Deletes a comment.
CommentTestBase::getUnapprovedComment protected function Gets the comment ID for an unapproved comment.
CommentTestBase::performCommentOperation protected function Performs the specified operation on the specified comment.
CommentTestBase::postComment protected function Posts a comment.
CommentTestBase::setCommentAnonymous protected function Sets the value governing restrictions on anonymous comments.
CommentTestBase::setCommentForm protected function Sets the value governing whether the comment form is on its own page.
CommentTestBase::setCommentPreview protected function Sets the value governing the previewing mode for the comment form.
CommentTestBase::setCommentSettings protected function Sets a comment settings variable for the article content type.
CommentTestBase::setCommentsPerPage protected function Sets the value specifying the default number of comments per page.
CommentTestBase::setCommentSubject protected function Sets the value governing whether the subject field should be enabled.
CommentTestTrait::addDefaultCommentField protected function Adds the default comment field to an entity.
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 'apcu_ensure_unique_prefix' setting. 1
FunctionalTestSetupTrait::$classLoader protected property The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$rootUser protected property The "#1" admin user.
FunctionalTestSetupTrait::$usesSuperUserAccessPolicy protected property Set to TRUE to make user 1 a super user. 8
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. 29
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
GeneratePermutationsTrait::generatePermutations public static function Converts a list of possible parameters into a stack of permutations.
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. 3
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::$useOneTimeLoginLinks protected property Use one-time login links instead of submitting the login form. 3
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.