class UserValidationTest in Drupal 9
Same name and namespace in other branches
- 8 core/modules/user/tests/src/Kernel/UserValidationTest.php \Drupal\Tests\user\Kernel\UserValidationTest
Verify that user validity checks behave as designed.
@group user
Hierarchy
- class \Drupal\KernelTests\KernelTestBase extends \PHPUnit\Framework\TestCase implements ServiceProviderInterface uses \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, AssertContentTrait, AssertLegacyTrait, ConfigTestTrait, ExtensionListTestTrait, PhpUnitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait, PhpUnitWarnings
- class \Drupal\Tests\user\Kernel\UserValidationTest
Expanded class hierarchy of UserValidationTest
File
- core/
modules/ user/ tests/ src/ Kernel/ UserValidationTest.php, line 18
Namespace
Drupal\Tests\user\KernelView source
class UserValidationTest extends KernelTestBase {
/**
* Modules to enable.
*
* @var array
*/
protected static $modules = [
'field',
'user',
'system',
];
/**
* {@inheritdoc}
*/
protected function setUp() : void {
parent::setUp();
$this
->installEntitySchema('user');
$this
->installSchema('system', [
'sequences',
]);
// Make sure that the default roles exist.
$this
->installConfig([
'user',
]);
}
/**
* Tests user name validation.
*/
public function testUsernames() {
// 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 \' \'',
'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',
],
];
// cSpell:enable
foreach ($test_cases as $name => $test_case) {
list($description, $test) = $test_case;
$result = user_validate_name($name);
$this
->{$test}($result, $description . ' (' . $name . ')');
}
}
/**
* Runs entity validation checks.
*/
public function testValidation() {
$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(t('The username %name is too long: it must be %max characters or less.', [
'%name' => $name,
'%max' => 60,
]), $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(t('The username %name is already taken.', [
'%name' => 'existing',
]), $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(t('%name: the email address can not be longer than @max characters.', [
'%name' => $user
->get('mail')
->getFieldDefinition()
->getLabel(),
'@max' => 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(t('The email address %mail is already taken.', [
'%mail' => 'existing@example.com',
]), $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(t('@name field is required.', [
'@name' => $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',
])
->save();
Role::create([
'id' => 'role2',
])
->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(t('The referenced entity (%entity_type: %name) does not exist.', [
'%entity_type' => 'user_role',
'%name' => 'unknown_role',
]), $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.
*/
protected function assertLengthViolation(EntityInterface $entity, $field_name, $length, $count = 1, $expected_index = 0) {
$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(t('%name: may not be longer than @max characters.', [
'%name' => $field_label,
'@max' => $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.
*/
protected function assertAllowedValuesViolation(EntityInterface $entity, $field_name) {
$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
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
AssertContentTrait:: |
protected | property | The current raw content. | |
AssertContentTrait:: |
protected | property | The drupalSettings value from the current raw $content. | |
AssertContentTrait:: |
protected | property | The XML structure parsed from the current raw $content. | 1 |
AssertContentTrait:: |
protected | property | The plain-text content of raw $content (text nodes). | |
AssertContentTrait:: |
protected | function | Passes if the raw text IS found escaped on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists with the given name or ID. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists with the given ID and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists with the given name and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists in the current page by the given XPath. | |
AssertContentTrait:: |
protected | function | Asserts that a checkbox field in the current page is checked. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists in the current page with a given Xpath result. | |
AssertContentTrait:: |
protected | function | Passes if a link with the specified label is found. | |
AssertContentTrait:: |
protected | function | Passes if a link containing a given href (part) is found. | |
AssertContentTrait:: |
protected | function | Asserts that each HTML ID is used for just a single element. | |
AssertContentTrait:: |
protected | function | Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist with the given name or ID. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist with the given ID and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist with the given name and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist or its value does not match, by XPath. | |
AssertContentTrait:: |
protected | function | Asserts that a checkbox field in the current page is not checked. | |
AssertContentTrait:: |
protected | function | Passes if a link with the specified label is not found. | |
AssertContentTrait:: |
protected | function | Passes if a link containing a given href (part) is not found. | |
AssertContentTrait:: |
protected | function | Passes if a link containing a given href is not found in the main region. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page does not exist. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page is not checked. | |
AssertContentTrait:: |
protected | function | Triggers a pass if the perl regex pattern is not found in raw content. | |
AssertContentTrait:: |
protected | function | Passes if the raw text is NOT found on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Passes if the page (with HTML stripped) does not contains the text. | |
AssertContentTrait:: |
protected | function | Pass if the page title is not the given string. | |
AssertContentTrait:: |
protected | function | Passes if the text is found MORE THAN ONCE on the text version of the page. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page exists. | |
AssertContentTrait:: |
protected | function | Asserts that a select option with the visible text exists. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page is checked. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page is checked. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page exists. | |
AssertContentTrait:: |
protected | function | Triggers a pass if the Perl regex pattern is found in the raw content. | |
AssertContentTrait:: |
protected | function | Passes if the raw text IS found on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Passes if the page (with HTML stripped) contains the text. | |
AssertContentTrait:: |
protected | function | Helper for assertText and assertNoText. | |
AssertContentTrait:: |
protected | function | Asserts that a Perl regex pattern is found in the plain-text content. | |
AssertContentTrait:: |
protected | function | Asserts themed output. | |
AssertContentTrait:: |
protected | function | Pass if the page title is the given string. | |
AssertContentTrait:: |
protected | function | Passes if the text is found ONLY ONCE on the text version of the page. | |
AssertContentTrait:: |
protected | function | Helper for assertUniqueText and assertNoUniqueText. | |
AssertContentTrait:: |
protected | function | Builds an XPath query. | |
AssertContentTrait:: |
protected | function | Helper: Constructs an XPath for the given set of attributes and value. | |
AssertContentTrait:: |
protected | function | Searches elements using a CSS selector in the raw content. | |
AssertContentTrait:: |
protected | function | Get all option elements, including nested options, in a select. | |
AssertContentTrait:: |
protected | function | Gets the value of drupalSettings for the currently-loaded page. | |
AssertContentTrait:: |
protected | function | Gets the current raw content. | |
AssertContentTrait:: |
protected | function | Get the selected value from a select field. | |
AssertContentTrait:: |
protected | function | Retrieves the plain-text content from the current raw content. | |
AssertContentTrait:: |
protected | function | Get the current URL from the cURL handler. | 1 |
AssertContentTrait:: |
protected | function | Parse content returned from curlExec using DOM and SimpleXML. | |
AssertContentTrait:: |
protected | function | Removes all white-space between HTML tags from the raw content. | |
AssertContentTrait:: |
protected | function | Sets the value of drupalSettings for the currently-loaded page. | |
AssertContentTrait:: |
protected | function | Sets the raw content (e.g. HTML). | |
AssertContentTrait:: |
protected | function | Performs an xpath search on the contents of the internal browser. | |
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
ConfigTestTrait:: |
protected | function | Returns a ConfigImporter object to import test configuration. | |
ConfigTestTrait:: |
protected | function | Copies configuration objects from source storage to target storage. | |
ExtensionListTestTrait:: |
protected | function | Gets the path for the specified module. | |
ExtensionListTestTrait:: |
protected | function | Gets the path for the specified theme. | |
KernelTestBase:: |
protected | property | Back up and restore any global variables that may be changed by tests. | |
KernelTestBase:: |
protected | property | Back up and restore static class properties that may be changed by tests. | |
KernelTestBase:: |
protected | property | Contains a few static class properties for performance. | |
KernelTestBase:: |
protected | property | ||
KernelTestBase:: |
protected | property | @todo Move into Config test base class. | 7 |
KernelTestBase:: |
protected static | property | An array of config object names that are excluded from schema checking. | |
KernelTestBase:: |
protected | property | ||
KernelTestBase:: |
protected | property | ||
KernelTestBase:: |
protected | property | Do not forward any global state from the parent process to the processes that run the actual tests. | |
KernelTestBase:: |
protected | property | The app root. | |
KernelTestBase:: |
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:: |
protected | property | ||
KernelTestBase:: |
protected | property | Set to TRUE to strict check all configuration saved. | 6 |
KernelTestBase:: |
protected | property | The virtual filesystem root directory. | |
KernelTestBase:: |
protected | function | 1 | |
KernelTestBase:: |
protected | function | Bootstraps a basic test environment. | |
KernelTestBase:: |
private | function | Bootstraps a kernel for a test. | |
KernelTestBase:: |
protected | function | Configuration accessor for tests. Returns non-overridden configuration. | |
KernelTestBase:: |
protected | function | Disables modules for this test. | |
KernelTestBase:: |
protected | function | Enables modules for this test. | |
KernelTestBase:: |
protected | function | Gets the config schema exclusions for this test. | |
KernelTestBase:: |
protected | function | Returns the Database connection info to be used for this test. | 3 |
KernelTestBase:: |
public | function | ||
KernelTestBase:: |
private | function | Returns Extension objects for $modules to enable. | |
KernelTestBase:: |
private static | function | Returns the modules to enable for this test. | |
KernelTestBase:: |
protected | function | Initializes the FileCache component. | |
KernelTestBase:: |
protected | function | Installs default configuration for a given list of modules. | |
KernelTestBase:: |
protected | function | Installs the storage schema for a specific entity type. | |
KernelTestBase:: |
protected | function | Installs database tables from a module schema definition. | |
KernelTestBase:: |
protected | function | ||
KernelTestBase:: |
public | function |
Registers test-specific services. Overrides ServiceProviderInterface:: |
24 |
KernelTestBase:: |
protected | function | Renders a render array. | 1 |
KernelTestBase:: |
protected | function | Sets the install profile and rebuilds the container to update it. | |
KernelTestBase:: |
protected | function | Sets an in-memory Settings variable. | |
KernelTestBase:: |
public static | function | 1 | |
KernelTestBase:: |
protected | function | Sets up the filesystem, so things like the file directory. | 2 |
KernelTestBase:: |
protected | function | Stops test execution. | |
KernelTestBase:: |
protected | function | 4 | |
KernelTestBase:: |
public | function | @after | |
KernelTestBase:: |
protected | function | Dumps the current state of the virtual filesystem to STDOUT. | |
KernelTestBase:: |
public | function | Prevents serializing any properties. | |
PhpUnitWarnings:: |
private static | property | Deprecation warnings from PHPUnit to raise with @trigger_error(). | |
PhpUnitWarnings:: |
public | function | Converts PHPUnit deprecation warnings to E_USER_DEPRECATED. | |
RandomGeneratorTrait:: |
protected | property | The random generator. | |
RandomGeneratorTrait:: |
protected | function | Gets the random generator for the utility methods. | |
RandomGeneratorTrait:: |
protected | function | Generates a unique random string containing letters and numbers. | 1 |
RandomGeneratorTrait:: |
public | function | Generates a random PHP object. | |
RandomGeneratorTrait:: |
public | function | Generates a pseudo-random string of ASCII characters of codes 32 to 126. | |
RandomGeneratorTrait:: |
public | function | Callback for random string validation. | |
StorageCopyTrait:: |
protected static | function | Copy the configuration from one storage to another and remove stale items. | |
TestRequirementsTrait:: |
private | function | Checks missing module requirements. | |
TestRequirementsTrait:: |
protected | function | Check module requirements for the Drupal use case. | 1 |
TestRequirementsTrait:: |
protected static | function | Returns the Drupal root directory. | |
UserValidationTest:: |
protected static | property |
Modules to enable. Overrides KernelTestBase:: |
|
UserValidationTest:: |
protected | function | Verifies that an AllowedValues violation exists for the given field. | |
UserValidationTest:: |
protected | function | Verifies that a length violation exists for the given field. | |
UserValidationTest:: |
protected | function |
Overrides KernelTestBase:: |
|
UserValidationTest:: |
public | function | Tests user name validation. | |
UserValidationTest:: |
public | function | Runs entity validation checks. |