You are here

Home » API reference » Zircon Profile 8 » UserValidationTest.php

class UserValidationTest in Zircon Profile 8

Same name and namespace in other branches
  1. 8.0 core/modules/user/src/Tests/UserValidationTest.php \Drupal\user\Tests\UserValidationTest

Verify that user validity checks behave as designed.

@group user

Hierarchy

Expanded class hierarchy of UserValidationTest

File

core/modules/user/src/Tests/UserValidationTest.php, line 22
Contains \Drupal\user\Tests\UserValidationTest.

Namespace

Drupal\user\Tests
View source 
class UserValidationTest extends KernelTestBase {

  /**
   * Modules to enable.
   *
   * @var array
   */
  public static $modules = array(
    'field',
    'user',
    'system',
  );

  /**
   * {@inheritdoc}
   */
  protected function setUp() {
    parent::setUp();
    $this
      ->installEntitySchema('user');
    $this
      ->installSchema('system', array(
      'sequences',
    ));

    // Make sure that the default roles exist.
    $this
      ->installConfig(array(
      'user',
    ));
  }

  /**
   * Tests user name validation.
   */
  function testUsernames() {
    $test_cases = array(
      // '<username>' => array('<description>', 'assert<testName>'),
      'foo' => array(
        'Valid username',
        'assertNull',
      ),
      'FOO' => array(
        'Valid username',
        'assertNull',
      ),
      'Foo O\'Bar' => array(
        'Valid username',
        'assertNull',
      ),
      'foo@bar' => array(
        'Valid username',
        'assertNull',
      ),
      'foo@example.com' => array(
        'Valid username',
        'assertNull',
      ),
      'foo@-example.com' => array(
        'Valid username',
        'assertNull',
      ),
      // invalid domains are allowed in usernames
      'þòøÇߪř€' => array(
        'Valid username',
        'assertNull',
      ),
      'ᚠᛇᚻ᛫ᛒᛦᚦ' => array(
        'Valid UTF8 username',
        'assertNull',
      ),
      // runes
      ' foo' => array(
        'Invalid username that starts with a space',
        'assertNotNull',
      ),
      'foo ' => array(
        'Invalid username that ends with a space',
        'assertNotNull',
      ),
      'foo  bar' => array(
        'Invalid username that contains 2 spaces \'&nbsp;&nbsp;\'',
        'assertNotNull',
      ),
      '' => array(
        'Invalid empty username',
        'assertNotNull',
      ),
      'foo/' => array(
        'Invalid username containing invalid chars',
        'assertNotNull',
      ),
      'foo' . chr(0) . 'bar' => array(
        'Invalid username containing chr(0)',
        'assertNotNull',
      ),
      // NULL
      'foo' . chr(13) . 'bar' => array(
        'Invalid username containing chr(13)',
        'assertNotNull',
      ),
      // CR
      str_repeat('x', USERNAME_MAX_LENGTH + 1) => array(
        'Invalid excessively long username',
        'assertNotNull',
      ),
    );
    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.
   */
  function testValidation() {
    $user = User::create(array(
      'name' => 'test',
      'mail' => 'test@example.com',
    ));
    $violations = $user
      ->validate();
    $this
      ->assertEqual(count($violations), 0, '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
      ->assertEqual(count($violations), 1, 'Violation found when name is too long.');
    $this
      ->assertEqual($violations[0]
      ->getPropertyPath(), 'name');
    $this
      ->assertEqual($violations[0]
      ->getMessage(), t('The username %name is too long: it must be %max characters or less.', array(
      '%name' => $name,
      '%max' => 60,
    )));

    // Create a second test user to provoke a name collision.
    $user2 = entity_create('user', array(
      'name' => 'existing',
      'mail' => 'existing@example.com',
    ));
    $user2
      ->save();
    $user
      ->set('name', 'existing');
    $violations = $user
      ->validate();
    $this
      ->assertEqual(count($violations), 1, 'Violation found on name collision.');
    $this
      ->assertEqual($violations[0]
      ->getPropertyPath(), 'name');
    $this
      ->assertEqual($violations[0]
      ->getMessage(), t('The username %name is already taken.', array(
      '%name' => 'existing',
    )));

    // Make the name valid.
    $user
      ->set('name', $this
      ->randomMachineName());
    $user
      ->set('mail', 'invalid');
    $violations = $user
      ->validate();
    $this
      ->assertEqual(count($violations), 1, 'Violation found when email is invalid');
    $this
      ->assertEqual($violations[0]
      ->getPropertyPath(), 'mail.0.value');
    $this
      ->assertEqual($violations[0]
      ->getMessage(), t('This value is not a valid email address.'));
    $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
      ->assertEqual(count($violations), 2, 'Violations found when email is too long');
    $this
      ->assertEqual($violations[0]
      ->getPropertyPath(), 'mail.0.value');
    $this
      ->assertEqual($violations[0]
      ->getMessage(), t('%name: the email address can not be longer than @max characters.', array(
      '%name' => $user
        ->get('mail')
        ->getFieldDefinition()
        ->getLabel(),
      '@max' => Email::EMAIL_MAX_LENGTH,
    )));
    $this
      ->assertEqual($violations[1]
      ->getPropertyPath(), 'mail.0.value');
    $this
      ->assertEqual($violations[1]
      ->getMessage(), t('This value is not a valid email address.'));

    // Provoke an email collision with an existing user.
    $user
      ->set('mail', 'existing@example.com');
    $violations = $user
      ->validate();
    $this
      ->assertEqual(count($violations), 1, 'Violation found when email already exists.');
    $this
      ->assertEqual($violations[0]
      ->getPropertyPath(), 'mail');
    $this
      ->assertEqual($violations[0]
      ->getMessage(), t('The email address %mail is already taken.', array(
      '%mail' => 'existing@example.com',
    )));
    $user
      ->set('mail', NULL);
    $violations = $user
      ->validate();
    $this
      ->assertEqual(count($violations), 1, 'Email addresses may not be removed');
    $this
      ->assertEqual($violations[0]
      ->getPropertyPath(), 'mail');
    $this
      ->assertEqual($violations[0]
      ->getMessage(), t('@name field is required.', array(
      '@name' => $user
        ->getFieldDefinition('mail')
        ->getLabel(),
    )));
    $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
      ->assertEqual(count($violations), 1, '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(array(
      'id' => 'role1',
    ))
      ->save();
    Role::create(array(
      'id' => 'role2',
    ))
      ->save();

    // Test cardinality of user roles.
    $user = entity_create('user', array(
      'name' => 'role_test',
      'mail' => 'test@example.com',
      'roles' => array(
        'role1',
        'role2',
      ),
    ));
    $violations = $user
      ->validate();
    $this
      ->assertEqual(count($violations), 0);
    $user->roles[1]->target_id = 'unknown_role';
    $violations = $user
      ->validate();
    $this
      ->assertEqual(count($violations), 1);
    $this
      ->assertEqual($violations[0]
      ->getPropertyPath(), 'roles.1.target_id');
    $this
      ->assertEqual($violations[0]
      ->getMessage(), t('The referenced entity (%entity_type: %name) does not exist.', array(
      '%entity_type' => 'user_role',
      '%name' => 'unknown_role',
    )));
  }

  /**
   * 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
      ->assertEqual(count($violations), $count, "Violation found when {$field_name} is too long.");
    $this
      ->assertEqual($violations[$expected_index]
      ->getPropertyPath(), "{$field_name}.0.value");
    $field_label = $entity
      ->get($field_name)
      ->getFieldDefinition()
      ->getLabel();
    $this
      ->assertEqual($violations[$expected_index]
      ->getMessage(), t('%name: may not be longer than @max characters.', array(
      '%name' => $field_label,
      '@max' => $length,
    )));
  }

  /**
   * Verifies that a 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
      ->assertEqual(count($violations), 1, "Allowed values violation for {$field_name} found.");
    $this
      ->assertEqual($violations[0]
      ->getPropertyPath(), "{$field_name}.0.value");
    $this
      ->assertEqual($violations[0]
      ->getMessage(), t('The value you selected is not a valid choice.'));
  }

}

Members

Namesort descending Modifiers Type Description 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. 2
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 the raw text IS NOT found escaped on the 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::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::getUrl protected function Get the current URL from the cURL handler. 1
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.
AssertHelperTrait::castSafeStrings protected function Casts MarkupInterface objects into strings.
KernelTestBase::$configDirectories protected property The configuration directories for this test run.
KernelTestBase::$keyValueFactory protected property A KeyValueMemoryFactory instance to use when building the container.
KernelTestBase::$moduleFiles private property
KernelTestBase::$streamWrappers protected property Array of registered stream wrappers.
KernelTestBase::$themeFiles private property
KernelTestBase::beforePrepareEnvironment protected function Act on global state information before the environment is altered for a test. Overrides TestBase::beforePrepareEnvironment
KernelTestBase::containerBuild public function Sets up the base service container for this test. 12
KernelTestBase::defaultLanguageData protected function Provides the data for setting the default language on the container. 1
KernelTestBase::disableModules protected function Disables modules for this test.
KernelTestBase::enableModules protected function Enables modules for this test.
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 a specific table from a module schema definition.
KernelTestBase::prepareConfigDirectories protected function Create and set new configuration directories. 1
KernelTestBase::registerStreamWrapper protected function Registers a stream wrapper for this test.
KernelTestBase::render protected function Renders a render array.
KernelTestBase::tearDown protected function Performs cleanup tasks after each individual test method has been run. Overrides TestBase::tearDown
KernelTestBase::__construct function Constructor for Test. Overrides TestBase::__construct
RandomGeneratorTrait::$randomGenerator protected property The random generator.
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 public function Callback for random string validation.
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.
TestBase::$assertions protected property Assertions thrown in that test case.
TestBase::$configImporter protected property The config importer that can used in a test. 5
TestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
TestBase::$container protected property The dependency injection container used in the test.
TestBase::$databasePrefix protected property The database prefix of this test run.
TestBase::$dieOnFail public property Whether to die in case any test assertion fails.
TestBase::$httpAuthCredentials protected property HTTP authentication credentials (<username>:<password>).
TestBase::$httpAuthMethod protected property HTTP authentication method (specified as a CURLAUTH_* constant).
TestBase::$kernel protected property The DrupalKernel instance used in the test. 1
TestBase::$originalConf protected property The original configuration (variables), if available.
TestBase::$originalConfig protected property The original configuration (variables).
TestBase::$originalConfigDirectories protected property The original configuration directories.
TestBase::$originalContainer protected property The original container.
TestBase::$originalFileDirectory protected property The original file directory, before it was changed for testing purposes.
TestBase::$originalLanguage protected property The original language.
TestBase::$originalPrefix protected property The original database prefix when running inside Simpletest.
TestBase::$originalProfile protected property The original installation profile.
TestBase::$originalSessionName protected property The name of the session cookie of the test-runner.
TestBase::$originalSettings protected property The settings array.
TestBase::$originalShutdownCallbacks protected property The original array of shutdown function callbacks. 1
TestBase::$originalSite protected property The site directory of the original parent site.
TestBase::$originalUser protected property The original user, before testing began. 1
TestBase::$privateFilesDirectory protected property The private file directory for the test environment.
TestBase::$publicFilesDirectory protected property The public file directory for the test environment.
TestBase::$results public property Current results of this test case.
TestBase::$siteDirectory protected property The site directory of this test run.
TestBase::$skipClasses protected property This class is skipped when looking for the source of an assertion.
TestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 4
TestBase::$tempFilesDirectory protected property The temporary file directory for the test environment.
TestBase::$testId protected property The test run ID.
TestBase::$timeLimit protected property Time limit for the test.
TestBase::$translationFilesDirectory protected property The translation file directory for the test environment.
TestBase::$verbose public property TRUE if verbose debugging is enabled.
TestBase::$verboseClassName protected property Safe class name for use in verbose output filenames.
TestBase::$verboseDirectory protected property Directory where verbose output files are put.
TestBase::$verboseDirectoryUrl protected property URL to the verbose output file directory.
TestBase::$verboseId protected property Incrementing identifier for verbose output filenames.
TestBase::assert protected function Internal helper: stores the assert.
TestBase::assertEqual protected function Check to see if two values are equal.
TestBase::assertErrorLogged protected function Asserts that a specific error has been logged to the PHP error log.
TestBase::assertFalse protected function Check to see if a value is false.
TestBase::assertIdentical protected function Check to see if two values are identical.
TestBase::assertIdenticalObject protected function Checks to see if two objects are identical.
TestBase::assertNoErrorsLogged protected function Asserts that no errors have been logged to the PHP error.log thus far.
TestBase::assertNotEqual protected function Check to see if two values are not equal.
TestBase::assertNotIdentical protected function Check to see if two values are not identical.
TestBase::assertNotNull protected function Check to see if a value is not NULL.
TestBase::assertNull protected function Check to see if a value is NULL.
TestBase::assertTrue protected function Check to see if a value is not false.
TestBase::changeDatabasePrefix private function Changes the database connection to the prefixed one.
TestBase::checkRequirements protected function Checks the matching requirements for Test. 2
TestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
TestBase::configImporter public function Returns a ConfigImporter object to import test importing of configuration. 5
TestBase::copyConfig public function Copies configuration objects from source storage to target storage.
TestBase::deleteAssert public static function Delete an assertion record by message ID.
TestBase::error protected function Fire an error assertion. 3
TestBase::errorHandler public function Handle errors during test runs.
TestBase::exceptionHandler protected function Handle exceptions.
TestBase::fail protected function Fire an assertion that is always negative.
TestBase::filePreDeleteCallback public static function Ensures test files are deletable within file_unmanaged_delete_recursive().
TestBase::generatePermutations public static function Converts a list of possible parameters into a stack of permutations.
TestBase::getAssertionCall protected function Cycles through backtrace until the first non-assertion method is found.
TestBase::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
TestBase::getDatabaseConnection public static function Returns the database connection to the site running Simpletest.
TestBase::getDatabasePrefix public function Gets the database prefix.
TestBase::getTempFilesDirectory public function Gets the temporary files directory.
TestBase::insertAssert public static function Store an assertion from outside the testing context.
TestBase::pass protected function Fire an assertion that is always positive.
TestBase::prepareDatabasePrefix private function Generates a database prefix for running tests.
TestBase::prepareEnvironment private function Prepares the current environment for running the test.
TestBase::restoreEnvironment private function Cleans up the test environment and restores the original environment.
TestBase::run public function Run all tests in this class. 1
TestBase::settingsSet protected function Changes in memory settings.
TestBase::storeAssertion protected function Helper method to store an assertion record in the configured database.
TestBase::verbose protected function Logs a verbose message in a text file.
UserValidationTest::$modules public static property Modules to enable. Overrides KernelTestBase::$modules
UserValidationTest::assertAllowedValuesViolation protected function Verifies that a 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 Performs setup tasks before each individual test method is run. Overrides KernelTestBase::setUp
UserValidationTest::testUsernames function Tests user name validation.
UserValidationTest::testValidation function Runs entity validation checks.