public function UserValidationTest::testValidation in Drupal 9

Same name and namespace in other branches

1. 8 core/modules/user/tests/src/Kernel/UserValidationTest.php \Drupal\Tests\user\Kernel\UserValidationTest::testValidation()

Runs entity validation checks.

File

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

Class

UserValidationTest

Verify that user validity checks behave as designed.

Namespace

Drupal\Tests\user\Kernel

Code

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());
}