UserAdminTest.php

<?php

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

use Drupal\Core\Test\AssertMailTrait;
use Drupal\Tests\BrowserTestBase;
use Drupal\user\RoleInterface;
use Drupal\user\UserInterface;

/**
 * Tests user administration page functionality.
 *
 * @group user
 */
class UserAdminTest extends BrowserTestBase {
  use AssertMailTrait {
    getMails as drupalGetMails;
  }
  
  /**
   * {@inheritdoc}
   */
  protected static $modules = [
    'taxonomy',
    'views',
  ];
  
  /**
   * {@inheritdoc}
   */
  protected $defaultTheme = 'stark';
  
  /**
   * Gets the xpath selector for a user account.
   *
   * @param \Drupal\user\UserInterface $user
   *   The user to get the link for.
   *
   * @return string
   *   The xpath selector for the user link.
   */
  private static function getLinkSelectorForUser(UserInterface $user) : string {
    return '//td[contains(@class, "views-field-name")]/a[text()="' . $user->getAccountName() . '"]';
  }
  
  /**
   * Registers a user and deletes it.
   */
  public function testUserAdmin() : void {
    $config = $this->config('user.settings');
    $user_a = $this->drupalCreateUser();
    $user_a->name = 'User A';
    $user_a->mail = $this->randomMachineName() . '@example.com';
    $user_a->save();
    $user_b = $this->drupalCreateUser([
      'administer taxonomy',
    ]);
    $user_b->name = 'User B';
    $user_b->save();
    $user_c = $this->drupalCreateUser([
      'administer taxonomy',
    ]);
    $user_c->name = 'User C';
    $user_c->save();
    $user_storage = $this->container
      ->get('entity_type.manager')
      ->getStorage('user');
    // Create admin user to delete registered user.
    $admin_user = $this->drupalCreateUser([
      'administer users',
    ]);
    // Use a predictable name so that we can reliably order the user admin page
    // by name.
    $admin_user->name = 'Admin user';
    $admin_user->save();
    $this->drupalLogin($admin_user);
    $this->drupalGet('admin/people');
    $this->assertSession()
      ->pageTextContains($user_a->getAccountName());
    $this->assertSession()
      ->pageTextContains($user_b->getAccountName());
    $this->assertSession()
      ->pageTextContains($user_c->getAccountName());
    $this->assertSession()
      ->pageTextContains($admin_user->getAccountName());
    // Test for existence of edit link in table.
    $link = $user_a->toLink('Edit', 'edit-form', [
      'query' => [
        'destination' => $user_a->toUrl('collection')
          ->toString(),
      ],
      'attributes' => [
        'aria-label' => 'Edit ' . $user_a->label(),
      ],
    ])
      ->toString();
    $this->assertSession()
      ->responseContains($link);
    // Test exposed filter elements.
    foreach ([
      'user',
      'role',
      'permission',
      'status',
    ] as $field) {
      $this->assertSession()
        ->fieldExists("edit-{$field}");
    }
    // Make sure the reduce duplicates element from the ManyToOneHelper is not
    // displayed.
    $this->assertSession()
      ->fieldNotExists('edit-reduce-duplicates');
    // Filter the users by name/email.
    $this->drupalGet('admin/people', [
      'query' => [
        'user' => $user_a->getAccountName(),
      ],
    ]);
    $result = $this->xpath('//table/tbody/tr');
    $this->assertCount(1, $result, 'Filter by username returned the right amount.');
    $this->assertEquals($user_a->getAccountName(), $result[0]->find('xpath', '/td[2]/a')
      ->getText(), 'Filter by username returned the right user.');
    $this->drupalGet('admin/people', [
      'query' => [
        'user' => $user_a->getEmail(),
      ],
    ]);
    $result = $this->xpath('//table/tbody/tr');
    $this->assertCount(1, $result, 'Filter by username returned the right amount.');
    $this->assertEquals($user_a->getAccountName(), $result[0]->find('xpath', '/td[2]/a')
      ->getText(), 'Filter by username returned the right user.');
    // Filter the users by permission 'administer taxonomy'.
    $this->drupalGet('admin/people', [
      'query' => [
        'permission' => 'administer taxonomy',
      ],
    ]);
    // Check if the correct users show up.
    $this->assertSession()
      ->elementNotExists('xpath', static::getLinkSelectorForUser($user_a));
    $this->assertSession()
      ->elementExists('xpath', static::getLinkSelectorForUser($user_b));
    $this->assertSession()
      ->elementExists('xpath', static::getLinkSelectorForUser($user_c));
    // Filter the users by role. Grab the system-generated role name for User C.
    $roles = $user_c->getRoles();
    unset($roles[array_search(RoleInterface::AUTHENTICATED_ID, $roles)]);
    $this->drupalGet('admin/people', [
      'query' => [
        'role' => reset($roles),
      ],
    ]);
    // Check if the correct users show up when filtered by role.
    $this->assertSession()
      ->elementNotExists('xpath', static::getLinkSelectorForUser($user_a));
    $this->assertSession()
      ->elementNotExists('xpath', static::getLinkSelectorForUser($user_b));
    $this->assertSession()
      ->elementExists('xpath', static::getLinkSelectorForUser($user_c));
    // Test blocking of a user.
    $account = $user_storage->load($user_c->id());
    $this->assertTrue($account->isActive(), 'User C not blocked');
    $edit = [];
    $edit['action'] = 'user_block_user_action';
    $edit['user_bulk_form[4]'] = TRUE;
    $config->set('notify.status_blocked', TRUE)
      ->save();
    $this->drupalGet('admin/people', [
      // Sort the table by username so that we know reliably which user will be
      // targeted with the blocking action.
'query' => [
        'order' => 'name',
        'sort' => 'asc',
      ],
    ]);
    $this->submitForm($edit, 'Apply to selected items');
    $site_name = $this->config('system.site')
      ->get('name');
    $this->assertMailString('body', 'Your account on ' . $site_name . ' has been blocked.', 1, 'Blocked message found in the mail sent to user C.');
    $account = $user_storage->load($user_c->id());
    $this->assertTrue($account->isBlocked(), 'User C blocked');
    // Test filtering on admin page for blocked users
    $this->drupalGet('admin/people', [
      'query' => [
        'status' => 2,
      ],
    ]);
    $this->assertSession()
      ->elementNotExists('xpath', static::getLinkSelectorForUser($user_a));
    $this->assertSession()
      ->elementNotExists('xpath', static::getLinkSelectorForUser($user_b));
    $this->assertSession()
      ->elementExists('xpath', static::getLinkSelectorForUser($user_c));
    // Test unblocking of a user from /admin/people page and sending of
    // activation mail
    $edit_unblock = [];
    $edit_unblock['action'] = 'user_unblock_user_action';
    $edit_unblock['user_bulk_form[4]'] = TRUE;
    $this->drupalGet('admin/people', [
      // Sort the table by username so that we know reliably which user will be
      // targeted with the blocking action.
'query' => [
        'order' => 'name',
        'sort' => 'asc',
      ],
    ]);
    $this->submitForm($edit_unblock, 'Apply to selected items');
    $account = $user_storage->load($user_c->id());
    $this->assertTrue($account->isActive(), 'User C unblocked');
    $this->assertMail("to", $account->getEmail(), "Activation mail sent to user C");
    // Test blocking and unblocking another user from /user/[uid]/edit form and
    // sending of activation mail.
    $user_d = $this->drupalCreateUser([]);
    $account1 = $user_storage->load($user_d->id());
    $this->drupalGet('user/' . $account1->id() . '/edit');
    $this->submitForm([
      'status' => 0,
    ], 'Save');
    $account1 = $user_storage->load($user_d->id());
    $this->assertTrue($account1->isBlocked(), 'User D blocked');
    $this->drupalGet('user/' . $account1->id() . '/edit');
    $this->submitForm([
      'status' => TRUE,
    ], 'Save');
    $account1 = $user_storage->load($user_d->id());
    $this->assertTrue($account1->isActive(), 'User D unblocked');
    $this->assertMail("to", $account1->getEmail(), "Activation mail sent to user D");
  }
  
  /**
   * Tests the alternate notification email address for user mails.
   */
  public function testNotificationEmailAddress() : void {
    // Test that the Notification Email address field is on the config page.
    $admin_user = $this->drupalCreateUser([
      'administer users',
      'administer account settings',
    ]);
    $this->drupalLogin($admin_user);
    $this->drupalGet('admin/config/people/accounts');
    $this->assertSession()
      ->responseContains('id="edit-mail-notification-address"');
    $this->drupalLogout();
    // Test custom user registration approval email address(es).
    $config = $this->config('user.settings');
    // Allow users to register with admin approval.
    $config->set('verify_mail', TRUE)
      ->set('register', UserInterface::REGISTER_VISITORS_ADMINISTRATIVE_APPROVAL)
      ->save();
    // Set the site and notification email addresses.
    $system = $this->config('system.site');
    $server_address = $this->randomMachineName() . '@example.com';
    $notify_address = $this->randomMachineName() . '@example.com';
    $system->set('mail', $server_address)
      ->set('mail_notification', $notify_address)
      ->save();
    // Register a new user account.
    $edit = [];
    $edit['name'] = $this->randomMachineName();
    $edit['mail'] = $edit['name'] . '@example.com';
    $this->drupalGet('user/register');
    $this->submitForm($edit, 'Create new account');
    $subject = 'Account details for ' . $edit['name'] . ' at ' . $system->get('name') . ' (pending admin approval)';
    // Ensure that admin notification mail is sent to the configured
    // Notification Email address.
    $admin_mail = $this->drupalGetMails([
      'to' => $notify_address,
      'from' => $server_address,
      'subject' => $subject,
    ]);
    $this->assertCount(1, $admin_mail, 'New user mail to admin is sent to configured Notification Email address');
    // Ensure that user notification mail is sent from the configured
    // Notification Email address.
    $user_mail = $this->drupalGetMails([
      'to' => $edit['mail'],
      'from' => $server_address,
      'reply-to' => $notify_address,
      'subject' => $subject,
    ]);
    $this->assertCount(1, $user_mail, 'New user mail to user is sent from configured Notification Email address');
  }

}