class CommentValidationTest

Same name in other branches
  1. 9 core/modules/comment/tests/src/Kernel/CommentValidationTest.php \Drupal\Tests\comment\Kernel\CommentValidationTest
  2. 8.9.x core/modules/comment/tests/src/Kernel/CommentValidationTest.php \Drupal\Tests\comment\Kernel\CommentValidationTest
  3. 11.x core/modules/comment/tests/src/Kernel/CommentValidationTest.php \Drupal\Tests\comment\Kernel\CommentValidationTest

Tests comment validation constraints.

@group comment

Hierarchy

Expanded class hierarchy of CommentValidationTest

File

core/modules/comment/tests/src/Kernel/CommentValidationTest.php, line 21

Namespace

Drupal\Tests\comment\Kernel
View source
class CommentValidationTest extends EntityKernelTestBase {
    use CommentTestTrait;
    use EntityReferenceFieldCreationTrait;
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'comment',
        'node',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->installSchema('comment', [
            'comment_entity_statistics',
        ]);
        $this->installConfig([
            'comment',
        ]);
    }
    
    /**
     * Tests the comment validation constraints.
     */
    public function testValidation() : void {
        // Add a user.
        $user = User::create([
            'name' => 'test',
            'status' => TRUE,
        ]);
        $user->save();
        // Add comment type.
        $this->entityTypeManager
            ->getStorage('comment_type')
            ->create([
            'id' => 'comment',
            'label' => 'comment',
            'target_entity_type_id' => 'node',
        ])
            ->save();
        // Add comment field to content.
        $this->entityTypeManager
            ->getStorage('field_storage_config')
            ->create([
            'entity_type' => 'node',
            'field_name' => 'comment',
            'type' => 'comment',
            'settings' => [
                'comment_type' => 'comment',
            ],
        ])
            ->save();
        // Create a page node type.
        $this->entityTypeManager
            ->getStorage('node_type')
            ->create([
            'type' => 'page',
            'name' => 'page',
        ])
            ->save();
        // Add comment field to page content.
        
        /** @var \Drupal\field\FieldConfigInterface $field */
        $field = $this->entityTypeManager
            ->getStorage('field_config')
            ->create([
            'field_name' => 'comment',
            'entity_type' => 'node',
            'bundle' => 'page',
            'label' => 'Comment settings',
        ]);
        $field->save();
        $node = $this->entityTypeManager
            ->getStorage('node')
            ->create([
            'type' => 'page',
            'title' => 'test',
        ]);
        $node->save();
        $comment = $this->entityTypeManager
            ->getStorage('comment')
            ->create([
            'entity_id' => $node->id(),
            'entity_type' => 'node',
            'field_name' => 'comment',
            'comment_body' => $this->randomMachineName(),
        ]);
        $violations = $comment->validate();
        $this->assertCount(0, $violations, 'No violations when validating a default comment.');
        $comment->set('subject', $this->randomString(65));
        $this->assertLengthViolation($comment, 'subject', 64);
        // Make the subject valid.
        $comment->set('subject', $this->randomString());
        $comment->set('name', $this->randomString(61));
        $this->assertLengthViolation($comment, 'name', 60);
        // Validate a name collision between an anonymous comment author name and an
        // existing user account name.
        $comment->set('name', 'test');
        $comment->set('uid', 0);
        $violations = $comment->validate();
        $this->assertCount(1, $violations, "Violation found on author name collision");
        $this->assertEquals("name", $violations[0]->getPropertyPath());
        $this->assertEquals('The name you used (test) belongs to a registered user.', $violations[0]->getMessage());
        // Make the name valid.
        $comment->set('name', 'valid unused name');
        $comment->set('mail', 'invalid');
        $violations = $comment->validate();
        $this->assertCount(1, $violations, 'Violation found when email is invalid');
        $this->assertEquals('mail.0.value', $violations[0]->getPropertyPath());
        $this->assertEquals('This value is not a valid email address.', $violations[0]->getMessage());
        $comment->set('mail', NULL);
        $comment->set('homepage', 'http://example.com/' . $this->randomMachineName(237));
        $this->assertLengthViolation($comment, 'homepage', 255);
        $comment->set('homepage', 'invalid');
        $violations = $comment->validate();
        $this->assertCount(1, $violations, 'Violation found when homepage is invalid');
        $this->assertEquals('homepage.0.value', $violations[0]->getPropertyPath());
        // @todo This message should be improved in
        //   https://www.drupal.org/node/2012690.
        $this->assertEquals('This value should be of the correct primitive type.', $violations[0]->getMessage());
        $comment->set('homepage', NULL);
        $comment->set('hostname', $this->randomString(129));
        $this->assertLengthViolation($comment, 'hostname', 128);
        $comment->set('hostname', NULL);
        $comment->set('thread', $this->randomString(256));
        $this->assertLengthViolation($comment, 'thread', 255);
        $comment->set('thread', NULL);
        // Force anonymous users to enter contact details.
        $field->setSetting('anonymous', CommentInterface::ANONYMOUS_MUST_CONTACT);
        $field->save();
        // Reset the node entity.
        \Drupal::entityTypeManager()->getStorage('node')
            ->resetCache([
            $node->id(),
        ]);
        $node = Node::load($node->id());
        // Create a new comment with the new field.
        $comment = $this->entityTypeManager
            ->getStorage('comment')
            ->create([
            'entity_id' => $node->id(),
            'entity_type' => 'node',
            'field_name' => 'comment',
            'comment_body' => $this->randomMachineName(),
            'uid' => 0,
            'name' => '',
        ]);
        $violations = $comment->validate();
        $this->assertCount(1, $violations, 'Violation found when name is required, but empty and UID is anonymous.');
        $this->assertEquals('name', $violations[0]->getPropertyPath());
        $this->assertEquals('You have to specify a valid author.', $violations[0]->getMessage());
        // Test creating a default comment with a given user id works.
        $comment = $this->entityTypeManager
            ->getStorage('comment')
            ->create([
            'entity_id' => $node->id(),
            'entity_type' => 'node',
            'field_name' => 'comment',
            'comment_body' => $this->randomMachineName(),
            'uid' => $user->id(),
        ]);
        $violations = $comment->validate();
        $this->assertCount(0, $violations, 'No violations when validating a default comment with an author.');
        // Test specifying a wrong author name does not work.
        $comment = $this->entityTypeManager
            ->getStorage('comment')
            ->create([
            'entity_id' => $node->id(),
            'entity_type' => 'node',
            'field_name' => 'comment',
            'comment_body' => $this->randomMachineName(),
            'uid' => $user->id(),
            'name' => 'not-test',
        ]);
        $violations = $comment->validate();
        $this->assertCount(1, $violations, 'Violation found when author name and comment author do not match.');
        $this->assertEquals('name', $violations[0]->getPropertyPath());
        $this->assertEquals('The specified author name does not match the comment author.', $violations[0]->getMessage());
    }
    
    /**
     * Tests that comments of unpublished nodes are not valid.
     */
    public function testValidationOfCommentOfUnpublishedNode() : void {
        // Create a page node type.
        $this->entityTypeManager
            ->getStorage('node_type')
            ->create([
            'type' => 'page',
            'name' => 'page',
        ])
            ->save();
        // Create a comment type.
        CommentType::create([
            'id' => 'comment',
            'label' => 'Default comments',
            'description' => 'Default comment field',
            'target_entity_type_id' => 'node',
        ])->save();
        // Add comment and entity reference comment fields.
        $this->addDefaultCommentField('node', 'page', 'comment');
        $this->createEntityReferenceField('node', 'page', 'entity_reference_comment', 'Entity Reference Comment', 'comment', 'default', [
            'target_bundles' => [
                'comment',
            ],
        ]);
        $comment_admin_user = $this->drupalCreateUser([
            'skip comment approval',
            'post comments',
            'access comments',
            'access content',
            'administer nodes',
            'administer comments',
            'bypass node access',
        ]);
        $comment_non_admin_user = $this->drupalCreateUser([
            'access comments',
            'post comments',
            'create page content',
            'edit own comments',
            'skip comment approval',
            'access content',
        ]);
        // Create a node with a comment and make it unpublished.
        $node1 = $this->entityTypeManager
            ->getStorage('node')
            ->create([
            'type' => 'page',
            'title' => 'test 1',
            'promote' => 1,
            'status' => 0,
            'uid' => $comment_non_admin_user->id(),
        ]);
        $node1->save();
        $comment1 = $this->entityTypeManager
            ->getStorage('comment')
            ->create([
            'entity_id' => $node1->id(),
            'entity_type' => 'node',
            'field_name' => 'comment',
            'comment_body' => $this->randomMachineName(),
        ]);
        $comment1->save();
        $this->assertInstanceOf(Comment::class, $comment1);
        // Create a second published node.
        
        /** @var \Drupal\node\Entity\Node $node2 */
        $node2 = $this->entityTypeManager
            ->getStorage('node')
            ->create([
            'type' => 'page',
            'title' => 'test 2',
            'promote' => 1,
            'status' => 1,
            'uid' => $comment_non_admin_user->id(),
        ]);
        $node2->save();
        // Test the validation API directly.
        $this->drupalSetCurrentUser($comment_non_admin_user);
        $this->assertEquals(\Drupal::currentUser()->id(), $comment_non_admin_user->id());
        $node2->set('entity_reference_comment', $comment1->id());
        $violations = $node2->validate();
        $this->assertCount(1, $violations);
        $this->assertEquals('entity_reference_comment.0.target_id', $violations[0]->getPropertyPath());
        $this->assertEquals(sprintf('This entity (%s: %s) cannot be referenced.', $comment1->getEntityTypeId(), $comment1->id()), $violations[0]->getMessage());
        $this->drupalSetCurrentUser($comment_admin_user);
        $this->assertEquals(\Drupal::currentUser()->id(), $comment_admin_user->id());
        $node2->set('entity_reference_comment', $comment1->id());
        $violations = $node2->validate();
        $this->assertCount(0, $violations);
    }
    
    /**
     * Verifies that a length violation exists for the given field.
     *
     * @param \Drupal\comment\CommentInterface $comment
     *   The comment object to validate.
     * @param string $field_name
     *   The field that violates the maximum length.
     * @param int $length
     *   Number of characters that was exceeded.
     *
     * @internal
     */
    protected function assertLengthViolation(CommentInterface $comment, string $field_name, int $length) : void {
        $violations = $comment->validate();
        $this->assertCount(1, $violations, "Violation found when {$field_name} is too long.");
        $this->assertEquals("{$field_name}.0.value", $violations[0]->getPropertyPath());
        $field_label = $comment->get($field_name)
            ->getFieldDefinition()
            ->getLabel();
        $this->assertEquals("{$field_label}: may not be longer than {$length} characters.", $violations[0]->getMessage());
    }

}

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 protected function Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink protected function Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds protected function Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped protected function Passes if raw text IS NOT found escaped on loaded page, fail otherwise.
AssertContentTrait::assertNoField protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected protected function Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern protected function Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw protected function Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle protected function Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText protected function Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern protected function Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput protected function Asserts themed output.
AssertContentTrait::assertTitle protected function Pass if the page title is the given string.
AssertContentTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper protected function Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery protected function Builds an XPath query.
AssertContentTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings protected function Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent protected function Gets the current raw content.
AssertContentTrait::getSelectedItem protected function Get the selected value from a select field.
AssertContentTrait::getTextContent protected function Retrieves the plain-text content from the current raw content.
AssertContentTrait::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace protected function Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings protected function Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent protected function Sets the raw content (e.g. HTML).
AssertContentTrait::xpath protected function Performs an xpath search on the contents of the internal browser.
CommentTestTrait::addDefaultCommentField protected function Adds the default comment field to an entity.
CommentValidationTest::$modules protected static property Modules to install. Overrides EntityKernelTestBase::$modules
CommentValidationTest::assertLengthViolation protected function Verifies that a length violation exists for the given field.
CommentValidationTest::setUp protected function Overrides EntityKernelTestBase::setUp
CommentValidationTest::testValidation public function Tests the comment validation constraints.
CommentValidationTest::testValidationOfCommentOfUnpublishedNode public function Tests that comments of unpublished nodes are not valid.
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::$generatedIds protected property A list of generated identifiers.
EntityKernelTestBase::$state protected property The state service.
EntityKernelTestBase::createUser protected function Creates a user.
EntityKernelTestBase::generateRandomEntityId protected function Generates a random ID avoiding collisions.
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::reloadEntity protected function Reloads the given entity from the storage and returns it.
EntityKernelTestBase::uninstallModule protected function Uninstalls a module and refreshes services.
EntityReferenceFieldCreationTrait::createEntityReferenceField protected function Creates a field of an entity reference field storage on the specified bundle.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
KernelTestBase::$backupGlobals protected property Back up and restore any global variables that may be changed by tests.
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. 3
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$keyValue protected property The key_value service that must persist between container rebuilds.
KernelTestBase::$preserveGlobalState protected property Do not forward any global state from the parent process to the processes
that run the actual tests.
KernelTestBase::$root protected property The app root.
KernelTestBase::$runTestInSeparateProcess protected property Kernel tests are run in separate processes because they allow autoloading
of code from extensions. Running the test in a separate process isolates
this behavior from other tests. Subclasses should not override this
property.
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. 7
KernelTestBase::$vfsRoot protected property The virtual filesystem root directory.
KernelTestBase::assertPostConditions protected function 1
KernelTestBase::bootEnvironment protected function Bootstraps a basic test environment.
KernelTestBase::bootKernel protected function Bootstraps a kernel for a test. 1
KernelTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::disableModules protected function Disables modules for this test.
KernelTestBase::enableModules protected function Enables modules for this test. 1
KernelTestBase::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo protected function Returns the Database connection info to be used for this test. 2
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to install.
KernelTestBase::getModulesToEnable private static function Returns the modules to install for this test.
KernelTestBase::initFileCache protected function Initializes the FileCache component.
KernelTestBase::installConfig protected function Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema protected function Installs the storage schema for a specific entity type.
KernelTestBase::installSchema protected function Installs database tables from a module schema definition.
KernelTestBase::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 27
KernelTestBase::render protected function Renders a render array. 1
KernelTestBase::setInstallProfile protected function Sets the install profile and rebuilds the container to update it.
KernelTestBase::setSetting protected function Sets an in-memory Settings variable.
KernelTestBase::setUpBeforeClass public static function 1
KernelTestBase::setUpFilesystem protected function Sets up the filesystem, so things like the file directory. 2
KernelTestBase::stop Deprecated protected function Stops test execution.
KernelTestBase::tearDown protected function 6
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__get public function
KernelTestBase::__sleep public function Prevents serializing any properties.
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.
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.
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.