class UserValidationTest

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

Verify that user validity checks behave as designed.

@group user

Hierarchy

Expanded class hierarchy of UserValidationTest

File

core/modules/user/tests/src/Kernel/UserValidationTest.php, line 20

Namespace

Drupal\Tests\user\Kernel
View source
class UserValidationTest extends KernelTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'field',
        'user',
        'system',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->installEntitySchema('user');
        // Make sure that the default roles exist.
        $this->installConfig([
            'user',
        ]);
    }
    
    /**
     * Tests user name validation.
     *
     * @group legacy
     */
    public function testUsernames() : void {
        // cSpell:disable
        $test_cases = [
            // '<username>' => ['<description>', 'assert<testName>'].
'foo' => [
                'Valid username',
                'assertNull',
            ],
            'FOO' => [
                'Valid username',
                'assertNull',
            ],
            'Foo O\'Bar' => [
                'Valid username',
                'assertNull',
            ],
            'foo@bar' => [
                'Valid username',
                'assertNull',
            ],
            'foo@example.com' => [
                'Valid username',
                'assertNull',
            ],
            // Invalid domains are allowed in usernames.
'foo@-example.com' => [
                'Valid username',
                'assertNull',
            ],
            'þòøÇߪř€' => [
                'Valid username',
                'assertNull',
            ],
            // '+' symbol is allowed.
'foo+bar' => [
                'Valid username',
                'assertNull',
            ],
            // runes.
'ᚠᛇᚻ᛫ᛒᛦᚦ' => [
                'Valid UTF8 username',
                'assertNull',
            ],
            ' foo' => [
                'Invalid username that starts with a space',
                'assertNotNull',
            ],
            'foo ' => [
                'Invalid username that ends with a space',
                'assertNotNull',
            ],
            'foo  bar' => [
                'Invalid username that contains 2 spaces \'&nbsp;&nbsp;\'',
                'assertNotNull',
            ],
            '' => [
                'Invalid empty username',
                'assertNotNull',
            ],
            'foo/' => [
                'Invalid username containing invalid chars',
                'assertNotNull',
            ],
            // NULL.
'foo' . chr(0) . 'bar' => [
                'Invalid username containing chr(0)',
                'assertNotNull',
            ],
            // CR.
'foo' . chr(13) . 'bar' => [
                'Invalid username containing chr(13)',
                'assertNotNull',
            ],
            str_repeat('x', UserInterface::USERNAME_MAX_LENGTH + 1) => [
                'Invalid excessively long username',
                'assertNotNull',
            ],
        ];
        $this->expectDeprecation('user_validate_name() is deprecated in drupal:10.3.0 and is removed from drupal:12.0.0. Use \\Drupal\\user\\UserNameValidator::validateName() instead. See https://www.drupal.org/node/3431205');
        // cSpell:enable
        foreach ($test_cases as $name => $test_case) {
            [
                $description,
                $test,
            ] = $test_case;
            $result = user_validate_name($name);
            $this->{$test}($result, $description . ' (' . $name . ')');
        }
    }
    
    /**
     * Runs entity validation checks.
     */
    public function testValidation() : void {
        $user = User::create([
            'name' => 'test',
            'mail' => 'test@example.com',
        ]);
        $violations = $user->validate();
        $this->assertCount(0, $violations, 'No violations when validating a default user.');
        // Only test one example invalid name here, the rest is already covered in
        // the testUsernames() method in this class.
        $name = $this->randomMachineName(61);
        $user->set('name', $name);
        $violations = $user->validate();
        $this->assertCount(1, $violations, 'Violation found when name is too long.');
        $this->assertEquals('name', $violations[0]->getPropertyPath());
        $this->assertEquals(sprintf('The username %s is too long: it must be 60 characters or less.', $name), $violations[0]->getMessage());
        // Create a second test user to provoke a name collision.
        $user2 = User::create([
            'name' => 'existing',
            'mail' => 'existing@example.com',
        ]);
        $user2->save();
        $user->set('name', 'existing');
        $violations = $user->validate();
        $this->assertCount(1, $violations, 'Violation found on name collision.');
        $this->assertEquals('name', $violations[0]->getPropertyPath());
        $this->assertEquals('The username existing is already taken.', $violations[0]->getMessage());
        // Make the name valid.
        $user->set('name', $this->randomMachineName());
        $user->set('mail', 'invalid');
        $violations = $user->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());
        $mail = $this->randomMachineName(Email::EMAIL_MAX_LENGTH - 11) . '@example.com';
        $user->set('mail', $mail);
        $violations = $user->validate();
        // @todo There are two violations because EmailItem::getConstraints()
        //   overlaps with the implicit constraint of the 'email' property type used
        //   in EmailItem::propertyDefinitions(). Resolve this in
        //   https://www.drupal.org/node/2023465.
        $this->assertCount(2, $violations, 'Violations found when email is too long');
        $this->assertEquals('mail.0.value', $violations[0]->getPropertyPath());
        $this->assertEquals(sprintf('%s: the email address can not be longer than %s characters.', $user->get('mail')
            ->getFieldDefinition()
            ->getLabel(), Email::EMAIL_MAX_LENGTH), $violations[0]->getMessage());
        $this->assertEquals('mail.0.value', $violations[1]->getPropertyPath());
        $this->assertEquals('This value is not a valid email address.', $violations[1]->getMessage());
        // Provoke an email collision with an existing user.
        $user->set('mail', 'existing@example.com');
        $violations = $user->validate();
        $this->assertCount(1, $violations, 'Violation found when email already exists.');
        $this->assertEquals('mail', $violations[0]->getPropertyPath());
        $this->assertEquals('The email address existing@example.com is already taken.', $violations[0]->getMessage());
        $user->set('mail', NULL);
        $violations = $user->validate();
        $this->assertCount(1, $violations, 'Email addresses may not be removed');
        $this->assertEquals('mail', $violations[0]->getPropertyPath());
        $this->assertEquals(sprintf('%s field is required.', $user->getFieldDefinition('mail')
            ->getLabel()), $violations[0]->getMessage());
        $user->set('mail', 'someone@example.com');
        $user->set('timezone', $this->randomString(33));
        $this->assertLengthViolation($user, 'timezone', 32, 2, 1);
        $user->set('timezone', 'invalid zone');
        $this->assertAllowedValuesViolation($user, 'timezone');
        $user->set('timezone', NULL);
        $user->set('init', 'invalid');
        $violations = $user->validate();
        $this->assertCount(1, $violations, 'Violation found when init email is invalid');
        $user->set('init', NULL);
        $user->set('langcode', 'invalid');
        $this->assertAllowedValuesViolation($user, 'langcode');
        $user->set('langcode', NULL);
        // Only configurable langcodes are allowed for preferred languages.
        $user->set('preferred_langcode', Language::LANGCODE_NOT_SPECIFIED);
        $this->assertAllowedValuesViolation($user, 'preferred_langcode');
        $user->set('preferred_langcode', NULL);
        $user->set('preferred_admin_langcode', Language::LANGCODE_NOT_SPECIFIED);
        $this->assertAllowedValuesViolation($user, 'preferred_admin_langcode');
        $user->set('preferred_admin_langcode', NULL);
        Role::create([
            'id' => 'role1',
            'label' => 'Role 1',
        ])->save();
        Role::create([
            'id' => 'role2',
            'label' => 'Role 2',
        ])->save();
        // Test cardinality of user roles.
        $user = User::create([
            'name' => 'role_test',
            'mail' => 'test@example.com',
            'roles' => [
                'role1',
                'role2',
            ],
        ]);
        $violations = $user->validate();
        $this->assertCount(0, $violations);
        $user->roles[1]->target_id = 'unknown_role';
        $violations = $user->validate();
        $this->assertCount(1, $violations);
        $this->assertEquals('roles.1.target_id', $violations[0]->getPropertyPath());
        $this->assertEquals('The referenced entity (user_role: unknown_role) does not exist.', $violations[0]->getMessage());
    }
    
    /**
     * Verifies that a length violation exists for the given field.
     *
     * @param \Drupal\Core\Entity\EntityInterface $entity
     *   The entity object to validate.
     * @param string $field_name
     *   The field that violates the maximum length.
     * @param int $length
     *   Number of characters that was exceeded.
     * @param int $count
     *   (optional) The number of expected violations. Defaults to 1.
     * @param int $expected_index
     *   (optional) The index at which to expect the violation. Defaults to 0.
     *
     * @internal
     */
    protected function assertLengthViolation(EntityInterface $entity, string $field_name, int $length, int $count = 1, int $expected_index = 0) : void {
        $violations = $entity->validate();
        $this->assertCount($count, $violations, "Violation found when {$field_name} is too long.");
        $this->assertEquals("{$field_name}.0.value", $violations[$expected_index]->getPropertyPath());
        $field_label = $entity->get($field_name)
            ->getFieldDefinition()
            ->getLabel();
        $this->assertEquals(sprintf('%s: may not be longer than %s characters.', $field_label, $length), $violations[$expected_index]->getMessage());
    }
    
    /**
     * Verifies that an AllowedValues violation exists for the given field.
     *
     * @param \Drupal\Core\Entity\EntityInterface $entity
     *   The entity object to validate.
     * @param string $field_name
     *   The name of the field to verify.
     *
     * @internal
     */
    protected function assertAllowedValuesViolation(EntityInterface $entity, string $field_name) : void {
        $violations = $entity->validate();
        $this->assertCount(1, $violations, "Allowed values violation for {$field_name} found.");
        $this->assertEquals($field_name === 'langcode' ? "{$field_name}.0" : "{$field_name}.0.value", $violations[0]->getPropertyPath());
        $this->assertEquals('The value you selected is not a valid choice.', $violations[0]->getMessage());
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary 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.
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.
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.
UserValidationTest::$modules protected static property Modules to install. Overrides KernelTestBase::$modules
UserValidationTest::assertAllowedValuesViolation protected function Verifies that an AllowedValues violation exists for the given field.
UserValidationTest::assertLengthViolation protected function Verifies that a length violation exists for the given field.
UserValidationTest::setUp protected function Overrides KernelTestBase::setUp
UserValidationTest::testUsernames public function Tests user name validation.
UserValidationTest::testValidation public function Runs entity validation checks.

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