UserEditTest.php

<?php

declare (strict_types=1);
namespace Drupal\Tests\user\Functional;

use Drupal\Core\Cache\Cache;
use Drupal\Tests\BrowserTestBase;

/**
 * Tests user edit page.
 *
 * @group user
 */
class UserEditTest extends BrowserTestBase {
  
  /**
   * {@inheritdoc}
   */
  protected $defaultTheme = 'stark';
  
  /**
   * Tests user edit page.
   */
  public function testUserEdit() : void {
    // Test user edit functionality.
    $user1 = $this->drupalCreateUser([
      'change own username',
    ]);
    $user2 = $this->drupalCreateUser([]);
    $this->drupalLogin($user1);
    // Test that error message appears when attempting to use a non-unique user
    // name.
    $edit['name'] = $user2->getAccountName();
    $this->drupalGet("user/" . $user1->id() . "/edit");
    $this->submitForm($edit, 'Save');
    $this->assertSession()
      ->pageTextContains("The username {$edit['name']} is already taken.");
    // Check that the default value in user name field
    // is the raw value and not a formatted one.
    \Drupal::keyValue('user_hooks_test')->set('user_format_name_alter', TRUE);
    \Drupal::service('module_installer')->install([
      'user_hooks_test',
    ]);
    Cache::invalidateTags([
      'rendered',
    ]);
    $this->drupalGet('user/' . $user1->id() . '/edit');
    $this->assertSession()
      ->fieldValueEquals('name', $user1->getAccountName());
    // Ensure the formatted name is displayed when expected.
    $this->drupalGet('user/' . $user1->id());
    $this->assertSession()
      ->responseContains($user1->getDisplayName());
    $this->assertSession()
      ->titleEquals(strip_tags($user1->getDisplayName()) . ' | Drupal');
    // Check that filling out a single password field does not validate.
    $edit = [];
    $edit['pass[pass1]'] = '';
    $edit['pass[pass2]'] = $this->randomMachineName();
    $this->drupalGet("user/" . $user1->id() . "/edit");
    $this->submitForm($edit, 'Save');
    $this->assertSession()
      ->pageTextContains("The specified passwords do not match.");
    $edit['pass[pass1]'] = $this->randomMachineName();
    $edit['pass[pass2]'] = '';
    $this->drupalGet("user/" . $user1->id() . "/edit");
    $this->submitForm($edit, 'Save');
    $this->assertSession()
      ->pageTextContains("The specified passwords do not match.");
    // Test that the error message appears when attempting to change the mail or
    // pass without the current password.
    $edit = [];
    $edit['mail'] = $this->randomMachineName() . '@new.example.com';
    $this->drupalGet("user/" . $user1->id() . "/edit");
    $this->submitForm($edit, 'Save');
    $this->assertSession()
      ->pageTextContains("Your current password is missing or incorrect; it's required to change the Email.");
    $edit['current_pass'] = $user1->passRaw;
    $this->drupalGet("user/" . $user1->id() . "/edit");
    $this->submitForm($edit, 'Save');
    $this->assertSession()
      ->pageTextContains("The changes have been saved.");
    // Test that the user must enter current password before changing passwords.
    $edit = [];
    $edit['pass[pass1]'] = $new_pass = $this->randomMachineName();
    $edit['pass[pass2]'] = $new_pass;
    $this->drupalGet("user/" . $user1->id() . "/edit");
    $this->submitForm($edit, 'Save');
    $this->assertSession()
      ->pageTextContains("Your current password is missing or incorrect; it's required to change the Password.");
    // Try again with the current password.
    $edit['current_pass'] = $user1->passRaw;
    $this->drupalGet("user/" . $user1->id() . "/edit");
    $this->submitForm($edit, 'Save');
    $this->assertSession()
      ->pageTextContains("The changes have been saved.");
    // Confirm there's only one session in the database as the existing session
    // has been migrated when the password is changed.
    // @see \Drupal\user\Entity\User::postSave()
    $this->assertSame(1, (int) \Drupal::database()->select('sessions', 's')
      ->countQuery()
      ->execute()
      ->fetchField());
    // Make sure the changed timestamp is updated.
    $this->assertEquals(\Drupal::time()->getRequestTime(), $user1->getChangedTime(), 'Changing a user sets "changed" timestamp.');
    // Make sure the user can log in with their new password.
    $this->drupalLogout();
    $user1->passRaw = $new_pass;
    $this->drupalLogin($user1);
    $this->drupalLogout();
    // Test that the password strength indicator displays.
    $config = $this->config('user.settings');
    $this->drupalLogin($user1);
    $config->set('password_strength', TRUE)
      ->save();
    $this->drupalGet("user/" . $user1->id() . "/edit");
    $this->submitForm($edit, 'Save');
    $this->assertSession()
      ->responseContains("Password strength:");
    $config->set('password_strength', FALSE)
      ->save();
    $this->drupalGet("user/" . $user1->id() . "/edit");
    $this->submitForm($edit, 'Save');
    $this->assertSession()
      ->responseNotContains("Password strength:");
    // Check that the user status field has the correct value and that it is
    // properly displayed.
    $admin_user = $this->drupalCreateUser([
      'administer users',
    ]);
    $this->drupalLogin($admin_user);
    $this->drupalGet('user/' . $user1->id() . '/edit');
    $this->assertSession()
      ->checkboxNotChecked('edit-status-0');
    $this->assertSession()
      ->checkboxChecked('edit-status-1');
    $edit = [
      'status' => 0,
    ];
    $this->drupalGet('user/' . $user1->id() . '/edit');
    $this->submitForm($edit, 'Save');
    $this->assertSession()
      ->pageTextContains('The changes have been saved.');
    $this->assertSession()
      ->checkboxChecked('edit-status-0');
    $this->assertSession()
      ->checkboxNotChecked('edit-status-1');
    $edit = [
      'status' => 1,
    ];
    $this->drupalGet('user/' . $user1->id() . '/edit');
    $this->submitForm($edit, 'Save');
    $this->assertSession()
      ->pageTextContains('The changes have been saved.');
    $this->assertSession()
      ->checkboxNotChecked('edit-status-0');
    $this->assertSession()
      ->checkboxChecked('edit-status-1');
  }
  
  /**
   * Tests setting the password to "0".
   *
   * We discovered in https://www.drupal.org/node/2563751 that logging in with a
   * password that is literally "0" was not possible. This test ensures that
   * this regression can't happen again.
   */
  public function testUserWith0Password() : void {
    $admin = $this->drupalCreateUser([
      'administer users',
    ]);
    $this->drupalLogin($admin);
    // Create a regular user.
    $user1 = $this->drupalCreateUser([]);
    $edit = [
      'pass[pass1]' => '0',
      'pass[pass2]' => '0',
    ];
    $this->drupalGet("user/" . $user1->id() . "/edit");
    $this->submitForm($edit, 'Save');
    $this->assertSession()
      ->pageTextContains("The changes have been saved.");
  }
  
  /**
   * Tests editing of a user account without an email address.
   */
  public function testUserWithoutEmailEdit() : void {
    // Test that an admin can edit users without an email address.
    $admin = $this->drupalCreateUser([
      'administer users',
    ]);
    $this->drupalLogin($admin);
    // Create a regular user.
    $user1 = $this->drupalCreateUser([]);
    // This user has no email address.
    $user1->mail = '';
    $user1->save();
    $this->drupalGet("user/" . $user1->id() . "/edit");
    $this->submitForm([
      'mail' => '',
    ], 'Save');
    $this->assertSession()
      ->pageTextContains("The changes have been saved.");
  }
  
  /**
   * Tests well known change password route redirects to user edit form.
   */
  public function testUserWellKnownChangePasswordAuth() : void {
    $account = $this->drupalCreateUser([]);
    $this->drupalLogin($account);
    $this->drupalGet('.well-known/change-password');
    $this->assertSession()
      ->addressEquals("user/" . $account->id() . "/edit");
  }
  
  /**
   * Tests well known change password route returns 403 to anonymous user.
   */
  public function testUserWellKnownChangePasswordAnon() : void {
    $this->drupalGet('.well-known/change-password');
    $this->assertSession()
      ->statusCodeEquals(403);
  }
  
  /**
   * Tests that a user is able to change site language.
   */
  public function testUserChangeSiteLanguage() : void {
    // Install these modules here as these aren't needed for other test methods.
    \Drupal::service('module_installer')->install([
      'content_translation',
      'language',
    ]);
    // Create and login as an admin user to add a new language and enable
    // translation for user accounts.
    $adminUser = $this->drupalCreateUser([
      'administer account settings',
      'administer languages',
      'administer content translation',
      'administer users',
      'translate any entity',
    ]);
    $this->drupalLogin($adminUser);
    // Add a new language into the system.
    $edit = [
      'predefined_langcode' => 'fr',
    ];
    $this->drupalGet('admin/config/regional/language/add');
    $this->submitForm($edit, 'Add language');
    $this->assertSession()
      ->pageTextContains('French');
    // Enable translation for user accounts.
    $edit = [
      'language[content_translation]' => 1,
    ];
    $this->drupalGet('admin/config/people/accounts');
    $this->submitForm($edit, 'Save configuration');
    $this->assertSession()
      ->pageTextContains('The configuration options have been saved.');
    // Create a regular user for whom translation will be enabled.
    $webUser = $this->drupalCreateUser();
    // Create a translation for a regular user account.
    $this->drupalGet('user/' . $webUser->id() . '/translations/add/en/fr');
    $this->submitForm([], 'Save');
    $this->assertSession()
      ->pageTextContains('The changes have been saved.');
    // Update the site language of the user account.
    $edit = [
      'preferred_langcode' => 'fr',
    ];
    $this->drupalGet('user/' . $webUser->id() . '/edit');
    $this->submitForm($edit, 'Save');
    $this->assertSession()
      ->statusCodeEquals(200);
  }
  
  /**
   * Tests the account form implements entity field access for mail.
   */
  public function testUserMailFieldAccess() : void {
    \Drupal::state()->set('user_access_test_forbid_mail_edit', TRUE);
    \Drupal::service('module_installer')->install([
      'user_access_test',
    ]);
    $user = $this->drupalCreateUser();
    $this->drupalLogin($user);
    $this->drupalGet("user/" . $user->id() . "/edit");
    $this->assertFalse($this->getSession()
      ->getPage()
      ->hasField('mail'));
  }
  
  /**
   * Tests that an admin cannot edit their own account status.
   */
  public function testAdminSelfBlocking() : void {
    // Create an admin user with permission to manage other users.
    $admin = $this->drupalCreateUser([
      'administer users',
    ]);
    $user = $this->drupalCreateUser();
    // Log in as the admin and attempt to edit their own profile.
    $this->drupalLogin($admin);
    $this->drupalGet("user/" . $admin->id() . "/edit");
    // Ensure the status field is not rendered.
    $this->assertSession()
      ->fieldNotExists('edit-status-0');
    $this->assertSession()
      ->fieldNotExists('edit-status-1');
    // Test editing another user to ensure the status field is rendered.
    $this->drupalGet("user/" . $user->id() . "/edit");
    $this->assertSession()
      ->fieldExists('edit-status-0');
    $this->assertSession()
      ->fieldEnabled('edit-status-0');
    $this->assertSession()
      ->fieldEnabled('edit-status-1');
  }
  
  /**
   * Tests constraint violations are triggered on the user account form.
   */
  public function testRolesValidation() : void {
    $admin_user = $this->drupalCreateUser([
      'administer users',
    ]);
    $this->drupalLogin($admin_user);
    $this->drupalGet("user/" . $admin_user->id() . "/edit");
    $this->submitForm([], 'Save');
    $this->assertSession()
      ->pageTextContains('The changes have been saved.');
    \Drupal::keyvalue('user_form_test')->set('user_form_test_constraint_roles_edit', TRUE);
    \Drupal::service('module_installer')->install([
      'entity_test',
      'user_form_test',
    ]);
    $this->drupalGet("user/" . $admin_user->id() . "/edit");
    $this->submitForm([], 'Save');
    $this->assertSession()
      ->pageTextContains('Widget constraint has failed.');
    $this->assertSession()
      ->pageTextNotContains('The changes have been saved.');
  }

}