class CommentFieldsTest

Same name in other branches
  1. 7.x modules/comment/comment.test \CommentFieldsTest
  2. 9 core/modules/comment/tests/src/Functional/CommentFieldsTest.php \Drupal\Tests\comment\Functional\CommentFieldsTest
  3. 8.9.x core/modules/comment/tests/src/Functional/CommentFieldsTest.php \Drupal\Tests\comment\Functional\CommentFieldsTest
  4. 11.x core/modules/comment/tests/src/Functional/CommentFieldsTest.php \Drupal\Tests\comment\Functional\CommentFieldsTest

Tests fields on comments.

@group comment

Hierarchy

Expanded class hierarchy of CommentFieldsTest

File

core/modules/comment/tests/src/Functional/CommentFieldsTest.php, line 17

Namespace

Drupal\Tests\comment\Functional
View source
class CommentFieldsTest extends CommentTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'field_ui',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * Tests that the default 'comment_body' field is correctly added.
     */
    public function testCommentDefaultFields() : void {
        // Do not make assumptions on default node types created by the test
        // installation profile, and create our own.
        $this->drupalCreateContentType([
            'type' => 'test_node_type',
        ]);
        $this->addDefaultCommentField('node', 'test_node_type');
        // Check that the 'comment_body' field is present on the comment bundle.
        $field = FieldConfig::loadByName('comment', 'comment', 'comment_body');
        $this->assertNotEmpty($field, 'The comment_body field is added when a comment bundle is created');
        $field->delete();
        // Check that the 'comment_body' field is not deleted since it is persisted
        // even if it has no fields.
        $field_storage = FieldStorageConfig::loadByName('comment', 'comment_body');
        $this->assertInstanceOf(FieldStorageConfig::class, $field_storage);
        // Create a new content type.
        $type_name = 'test_node_type_2';
        $this->drupalCreateContentType([
            'type' => $type_name,
        ]);
        $this->addDefaultCommentField('node', $type_name);
        // Check that the 'comment_body' field exists and has an instance on the
        // new comment bundle.
        $field_storage = FieldStorageConfig::loadByName('comment', 'comment_body');
        $this->assertInstanceOf(FieldStorageConfig::class, $field_storage);
        $field = FieldConfig::loadByName('comment', 'comment', 'comment_body');
        $this->assertTrue(isset($field), "The comment_body field is present for comments on type {$type_name}");
        // Test adding a field that defaults to CommentItemInterface::CLOSED.
        $this->addDefaultCommentField('node', 'test_node_type', 'who_likes_ponies', CommentItemInterface::CLOSED, 'who_likes_ponies');
        $field = FieldConfig::load('node.test_node_type.who_likes_ponies');
        $this->assertEquals(CommentItemInterface::CLOSED, $field->getDefaultValueLiteral()[0]['status']);
    }
    
    /**
     * Tests that you can remove a comment field.
     */
    public function testCommentFieldDelete() : void {
        $this->drupalCreateContentType([
            'type' => 'test_node_type',
        ]);
        $this->addDefaultCommentField('node', 'test_node_type');
        // We want to test the handling of removing the primary comment field, so we
        // ensure there is at least one other comment field attached to a node type
        // so that comment_entity_load() runs for nodes.
        $this->addDefaultCommentField('node', 'test_node_type', 'comment2');
        // Create a sample node.
        $node = $this->drupalCreateNode([
            'title' => 'Baloney',
            'type' => 'test_node_type',
        ]);
        $this->drupalLogin($this->webUser);
        $this->drupalGet('node/' . $node->nid->value);
        $elements = $this->cssSelect('.comment-form');
        $this->assertCount(2, $elements, 'There are two comment fields on the node.');
        // Delete the first comment field.
        FieldStorageConfig::loadByName('node', 'comment')->delete();
        $this->drupalGet('node/' . $node->nid->value);
        $elements = $this->cssSelect('.comment-form');
        $this->assertCount(1, $elements, 'There is one comment field on the node.');
    }
    
    /**
     * Tests link building with non-default comment field names.
     */
    public function testCommentFieldLinksNonDefaultName() : void {
        $this->drupalCreateContentType([
            'type' => 'test_node_type',
        ]);
        $this->addDefaultCommentField('node', 'test_node_type', 'comment2');
        $web_user2 = $this->drupalCreateUser([
            'access comments',
            'post comments',
            'create article content',
            'edit own comments',
            'skip comment approval',
            'access content',
        ]);
        // Create a sample node.
        $node = $this->drupalCreateNode([
            'title' => 'Baloney',
            'type' => 'test_node_type',
        ]);
        // Go to the node first so that web_user2 see new comments.
        $this->drupalLogin($web_user2);
        $this->drupalGet($node->toUrl());
        $this->drupalLogout();
        // Test that buildCommentedEntityLinks() does not break when the 'comment'
        // field does not exist. Requires at least one comment.
        $this->drupalLogin($this->webUser);
        $this->postComment($node, 'Here is a comment', '', NULL, 'comment2');
        $this->drupalLogout();
        $this->drupalLogin($web_user2);
        // We want to check the attached drupalSettings of
        // \Drupal\comment\CommentLinkBuilder::buildCommentedEntityLinks. Therefore
        // we need a node listing, let's use views for that.
        $this->container
            ->get('module_installer')
            ->install([
            'views',
        ], TRUE);
        $this->drupalGet('node');
        $link_info = $this->getDrupalSettings()['comment']['newCommentsLinks']['node']['comment2']['2'];
        $this->assertSame(1, $link_info['new_comment_count']);
        $this->assertSame($node->toUrl('canonical', [
            'fragment' => 'new',
        ])
            ->toString(), $link_info['first_new_comment_link']);
    }
    
    /**
     * Tests creating a comment field through the interface.
     */
    public function testCommentFieldCreate() : void {
        // Create user who can administer user fields.
        $user = $this->drupalCreateUser([
            'administer user fields',
        ]);
        $this->drupalLogin($user);
        // Create comment field in account settings.
        $edit = [
            'new_storage_type' => 'comment',
        ];
        $this->drupalGet('admin/config/people/accounts/fields/add-field');
        $this->submitForm($edit, 'Continue');
        $edit = [
            'label' => 'User comment',
            'field_name' => 'user_comment',
        ];
        $this->submitForm($edit, 'Continue');
        // Try to save the comment field without selecting a comment type.
        $edit = [];
        $this->submitForm($edit, 'Update settings');
        // We should get an error message.
        $this->assertSession()
            ->pageTextContains('The submitted value in the Comment type element is not allowed.');
        // Create a comment type for users.
        $bundle = CommentType::create([
            'id' => 'user_comment_type',
            'label' => 'user_comment_type',
            'description' => '',
            'target_entity_type_id' => 'user',
        ]);
        $bundle->save();
        // Select a comment type and try to save again.
        $edit = [
            'field_storage[subform][settings][comment_type]' => 'user_comment_type',
        ];
        $this->drupalGet('admin/config/people/accounts/add-field/user/field_user_comment');
        $this->submitForm($edit, 'Update settings');
        // We shouldn't get an error message.
        $this->assertSession()
            ->pageTextNotContains('The submitted value in the Comment type element is not allowed.');
        // Try to save the comment field with "Comments per page"
        // setting value as zero.
        $edit = [
            'settings[per_page]' => 0,
        ];
        $this->drupalGet('admin/config/people/accounts/add-field/user/field_user_comment');
        $this->submitForm($edit, 'Save settings');
        $this->assertSession()
            ->statusMessageContains('Saved User comment configuration.', 'status');
    }

}

Members

Title Sort descending Deprecated 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::$htmlOutputFile protected property The file name to write the list of URLs to.
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::$preserveGlobalState protected property
BrowserTestBase::$profile protected property The profile to install as a basis for testing. 40
BrowserTestBase::$runTestInSeparateProcess protected property Browser tests are run in separate processes to prevent collisions between
code that may be loaded by tests.
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::__get public function
BrowserTestBase::__sleep public function Prevents serializing any properties.
CommentFieldsTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
CommentFieldsTest::$modules protected static property Modules to install. Overrides CommentTestBase::$modules
CommentFieldsTest::testCommentDefaultFields public function Tests that the default 'comment_body' field is correctly added.
CommentFieldsTest::testCommentFieldCreate public function Tests creating a comment field through the interface.
CommentFieldsTest::testCommentFieldDelete public function Tests that you can remove a comment field.
CommentFieldsTest::testCommentFieldLinksNonDefaultName public function Tests link building with non-default comment field names.
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 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.
CommentTestBase::setUp protected function Overrides BrowserTestBase::setUp 14
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
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. 10
FunctionalTestSetupTrait::doInstall protected function Execute the non-interactive installer. 2
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
PhpUnitWarnings::$deprecationWarnings private static property Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning public function Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
RandomGeneratorTrait::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.
RandomGeneratorTrait::randomStringValidate Deprecated public function Callback for random string validation.
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::checkModuleRequirements Deprecated private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements Deprecated protected function Check module requirements for the Drupal use case.
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. 5
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::getDatabaseConnection Deprecated public static function Returns the database connection to the site under 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.