class UserCancelTest

Same name in other branches
  1. 9 core/modules/user/tests/src/Functional/UserCancelTest.php \Drupal\Tests\user\Functional\UserCancelTest
  2. 10 core/modules/user/tests/src/Functional/UserCancelTest.php \Drupal\Tests\user\Functional\UserCancelTest
  3. 11.x core/modules/user/tests/src/Functional/UserCancelTest.php \Drupal\Tests\user\Functional\UserCancelTest

Ensure that account cancellation methods work as expected.

@group user

Hierarchy

Expanded class hierarchy of UserCancelTest

File

core/modules/user/tests/src/Functional/UserCancelTest.php, line 17

Namespace

Drupal\Tests\user\Functional
View source
class UserCancelTest extends BrowserTestBase {
    use CommentTestTrait;
    
    /**
     * Modules to enable.
     *
     * @var array
     */
    public static $modules = [
        'node',
        'comment',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    protected function setUp() {
        parent::setUp();
        $this->drupalCreateContentType([
            'type' => 'page',
            'name' => 'Basic page',
        ]);
    }
    
    /**
     * Attempt to cancel account without permission.
     */
    public function testUserCancelWithoutPermission() {
        $node_storage = $this->container
            ->get('entity_type.manager')
            ->getStorage('node');
        $this->config('user.settings')
            ->set('cancel_method', 'user_cancel_reassign')
            ->save();
        $user_storage = $this->container
            ->get('entity_type.manager')
            ->getStorage('user');
        // Create a user.
        $account = $this->drupalCreateUser([]);
        $this->drupalLogin($account);
        // Load a real user object.
        $user_storage->resetCache([
            $account->id(),
        ]);
        $account = $user_storage->load($account->id());
        // Create a node.
        $node = $this->drupalCreateNode([
            'uid' => $account->id(),
        ]);
        // Attempt to cancel account.
        $this->drupalGet('user/' . $account->id() . '/edit');
        $this->assertNoRaw(t('Cancel account'), 'No cancel account button displayed.');
        // Attempt bogus account cancellation request confirmation.
        $timestamp = $account->getLastLoginTime();
        $this->drupalGet("user/" . $account->id() . "/cancel/confirm/{$timestamp}/" . user_pass_rehash($account, $timestamp));
        $this->assertSession()
            ->statusCodeEquals(403);
        $user_storage->resetCache([
            $account->id(),
        ]);
        $account = $user_storage->load($account->id());
        $this->assertTrue($account->isActive(), 'User account was not canceled.');
        // Confirm user's content has not been altered.
        $node_storage->resetCache([
            $node->id(),
        ]);
        $test_node = $node_storage->load($node->id());
        $this->assertTrue($test_node->getOwnerId() == $account->id() && $test_node->isPublished(), 'Node of the user has not been altered.');
    }
    
    /**
     * Test ability to change the permission for canceling users.
     */
    public function testUserCancelChangePermission() {
        \Drupal::service('module_installer')->install([
            'user_form_test',
        ]);
        \Drupal::service('router.builder')->rebuild();
        $this->config('user.settings')
            ->set('cancel_method', 'user_cancel_reassign')
            ->save();
        // Create a regular user.
        $account = $this->drupalCreateUser([]);
        $admin_user = $this->drupalCreateUser([
            'cancel other accounts',
        ]);
        $this->drupalLogin($admin_user);
        // Delete regular user.
        $this->drupalPostForm('user_form_test_cancel/' . $account->id(), [], t('Cancel account'));
        // Confirm deletion.
        $this->assertRaw(t('%name has been deleted.', [
            '%name' => $account->getAccountName(),
        ]), 'User deleted.');
        $this->assertNull(User::load($account->id()), 'User is not found in the database.');
    }
    
    /**
     * Tests that user account for uid 1 cannot be cancelled.
     *
     * This should never be possible, or the site owner would become unable to
     * administer the site.
     */
    public function testUserCancelUid1() {
        $user_storage = $this->container
            ->get('entity_type.manager')
            ->getStorage('user');
        \Drupal::service('module_installer')->install([
            'views',
        ]);
        \Drupal::service('router.builder')->rebuild();
        // Try to cancel uid 1's account with a different user.
        $admin_user = $this->drupalCreateUser([
            'administer users',
        ]);
        $this->drupalLogin($admin_user);
        $edit = [
            'action' => 'user_cancel_user_action',
            'user_bulk_form[0]' => TRUE,
        ];
        $this->drupalPostForm('admin/people', $edit, t('Apply to selected items'));
        // Verify that uid 1's account was not cancelled.
        $user_storage->resetCache([
            1,
        ]);
        $user1 = $user_storage->load(1);
        $this->assertTrue($user1->isActive(), 'User #1 still exists and is not blocked.');
    }
    
    /**
     * Attempt invalid account cancellations.
     */
    public function testUserCancelInvalid() {
        $node_storage = $this->container
            ->get('entity_type.manager')
            ->getStorage('node');
        $this->config('user.settings')
            ->set('cancel_method', 'user_cancel_reassign')
            ->save();
        $user_storage = $this->container
            ->get('entity_type.manager')
            ->getStorage('user');
        // Create a user.
        $account = $this->drupalCreateUser([
            'cancel account',
        ]);
        $this->drupalLogin($account);
        // Load a real user object.
        $user_storage->resetCache([
            $account->id(),
        ]);
        $account = $user_storage->load($account->id());
        // Create a node.
        $node = $this->drupalCreateNode([
            'uid' => $account->id(),
        ]);
        // Attempt to cancel account.
        $this->drupalPostForm('user/' . $account->id() . '/edit', NULL, t('Cancel account'));
        // Confirm account cancellation.
        $timestamp = time();
        $this->drupalPostForm(NULL, NULL, t('Cancel account'));
        $this->assertText(t('A confirmation request to cancel your account has been sent to your email address.'), 'Account cancellation request mailed message displayed.');
        // Attempt bogus account cancellation request confirmation.
        $bogus_timestamp = $timestamp + 60;
        $this->drupalGet("user/" . $account->id() . "/cancel/confirm/{$bogus_timestamp}/" . user_pass_rehash($account, $bogus_timestamp));
        $this->assertText(t('You have tried to use an account cancellation link that has expired. Please request a new one using the form below.'), 'Bogus cancelling request rejected.');
        $user_storage->resetCache([
            $account->id(),
        ]);
        $account = $user_storage->load($account->id());
        $this->assertTrue($account->isActive(), 'User account was not canceled.');
        // Attempt expired account cancellation request confirmation.
        $bogus_timestamp = $timestamp - 86400 - 60;
        $this->drupalGet("user/" . $account->id() . "/cancel/confirm/{$bogus_timestamp}/" . user_pass_rehash($account, $bogus_timestamp));
        $this->assertText(t('You have tried to use an account cancellation link that has expired. Please request a new one using the form below.'), 'Expired cancel account request rejected.');
        $user_storage->resetCache([
            $account->id(),
        ]);
        $account = $user_storage->load($account->id());
        $this->assertTrue($account->isActive(), 'User account was not canceled.');
        // Confirm user's content has not been altered.
        $node_storage->resetCache([
            $node->id(),
        ]);
        $test_node = $node_storage->load($node->id());
        $this->assertTrue($test_node->getOwnerId() == $account->id() && $test_node->isPublished(), 'Node of the user has not been altered.');
    }
    
    /**
     * Disable account and keep all content.
     */
    public function testUserBlock() {
        $this->config('user.settings')
            ->set('cancel_method', 'user_cancel_block')
            ->save();
        $user_storage = $this->container
            ->get('entity_type.manager')
            ->getStorage('user');
        // Create a user.
        $web_user = $this->drupalCreateUser([
            'cancel account',
        ]);
        $this->drupalLogin($web_user);
        // Load a real user object.
        $user_storage->resetCache([
            $web_user->id(),
        ]);
        $account = $user_storage->load($web_user->id());
        // Attempt to cancel account.
        $this->drupalGet('user/' . $account->id() . '/edit');
        $this->drupalPostForm(NULL, NULL, t('Cancel account'));
        $this->assertText(t('Are you sure you want to cancel your account?'), 'Confirmation form to cancel account displayed.');
        $this->assertText(t('Your account will be blocked and you will no longer be able to log in. All of your content will remain attributed to your username.'), 'Informs that all content will be remain as is.');
        $this->assertNoText(t('Select the method to cancel the account above.'), 'Does not allow user to select account cancellation method.');
        // Confirm account cancellation.
        $timestamp = time();
        $this->drupalPostForm(NULL, NULL, t('Cancel account'));
        $this->assertText(t('A confirmation request to cancel your account has been sent to your email address.'), 'Account cancellation request mailed message displayed.');
        // Confirm account cancellation request.
        $this->drupalGet("user/" . $account->id() . "/cancel/confirm/{$timestamp}/" . user_pass_rehash($account, $timestamp));
        $user_storage->resetCache([
            $account->id(),
        ]);
        $account = $user_storage->load($account->id());
        $this->assertTrue($account->isBlocked(), 'User has been blocked.');
        // Confirm that the confirmation message made it through to the end user.
        $this->assertRaw(t('%name has been disabled.', [
            '%name' => $account->getAccountName(),
        ]), "Confirmation message displayed to user.");
    }
    
    /**
     * Disable account and unpublish all content.
     */
    public function testUserBlockUnpublish() {
        $node_storage = $this->container
            ->get('entity_type.manager')
            ->getStorage('node');
        $this->config('user.settings')
            ->set('cancel_method', 'user_cancel_block_unpublish')
            ->save();
        // Create comment field on page.
        $this->addDefaultCommentField('node', 'page');
        $user_storage = $this->container
            ->get('entity_type.manager')
            ->getStorage('user');
        // Create a user.
        $account = $this->drupalCreateUser([
            'cancel account',
        ]);
        $this->drupalLogin($account);
        // Load a real user object.
        $user_storage->resetCache([
            $account->id(),
        ]);
        $account = $user_storage->load($account->id());
        // Create a node with two revisions.
        $node = $this->drupalCreateNode([
            'uid' => $account->id(),
        ]);
        $settings = get_object_vars($node);
        $settings['revision'] = 1;
        $node = $this->drupalCreateNode($settings);
        // Add a comment to the page.
        $comment_subject = $this->randomMachineName(8);
        $comment_body = $this->randomMachineName(8);
        $comment = Comment::create([
            'subject' => $comment_subject,
            'comment_body' => $comment_body,
            'entity_id' => $node->id(),
            'entity_type' => 'node',
            'field_name' => 'comment',
            'status' => CommentInterface::PUBLISHED,
            'uid' => $account->id(),
        ]);
        $comment->save();
        // Attempt to cancel account.
        $this->drupalGet('user/' . $account->id() . '/edit');
        $this->drupalPostForm(NULL, NULL, t('Cancel account'));
        $this->assertText(t('Are you sure you want to cancel your account?'), 'Confirmation form to cancel account displayed.');
        $this->assertText(t('Your account will be blocked and you will no longer be able to log in. All of your content will be hidden from everyone but administrators.'), 'Informs that all content will be unpublished.');
        // Confirm account cancellation.
        $timestamp = time();
        $this->drupalPostForm(NULL, NULL, t('Cancel account'));
        $this->assertText(t('A confirmation request to cancel your account has been sent to your email address.'), 'Account cancellation request mailed message displayed.');
        // Confirm account cancellation request.
        $this->drupalGet("user/" . $account->id() . "/cancel/confirm/{$timestamp}/" . user_pass_rehash($account, $timestamp));
        // Confirm that the user was redirected to the front page.
        $this->assertSession()
            ->addressEquals('');
        $this->assertSession()
            ->statusCodeEquals(200);
        // Confirm that the confirmation message made it through to the end user.
        $this->assertRaw(t('%name has been disabled.', [
            '%name' => $account->getAccountName(),
        ]), "Confirmation message displayed to user.");
        $user_storage->resetCache([
            $account->id(),
        ]);
        $account = $user_storage->load($account->id());
        $this->assertTrue($account->isBlocked(), 'User has been blocked.');
        // Confirm user's content has been unpublished.
        $node_storage->resetCache([
            $node->id(),
        ]);
        $test_node = $node_storage->load($node->id());
        $this->assertFalse($test_node->isPublished(), 'Node of the user has been unpublished.');
        $test_node = node_revision_load($node->getRevisionId());
        $this->assertFalse($test_node->isPublished(), 'Node revision of the user has been unpublished.');
        $storage = \Drupal::entityTypeManager()->getStorage('comment');
        $storage->resetCache([
            $comment->id(),
        ]);
        $comment = $storage->load($comment->id());
        $this->assertFalse($comment->isPublished(), 'Comment of the user has been unpublished.');
    }
    
    /**
     * Delete account and anonymize all content.
     */
    public function testUserAnonymize() {
        $node_storage = $this->container
            ->get('entity_type.manager')
            ->getStorage('node');
        $this->config('user.settings')
            ->set('cancel_method', 'user_cancel_reassign')
            ->save();
        // Create comment field on page.
        $this->addDefaultCommentField('node', 'page');
        $user_storage = $this->container
            ->get('entity_type.manager')
            ->getStorage('user');
        // Create a user.
        $account = $this->drupalCreateUser([
            'cancel account',
        ]);
        $this->drupalLogin($account);
        // Load a real user object.
        $user_storage->resetCache([
            $account->id(),
        ]);
        $account = $user_storage->load($account->id());
        // Create a simple node.
        $node = $this->drupalCreateNode([
            'uid' => $account->id(),
        ]);
        // Add a comment to the page.
        $comment_subject = $this->randomMachineName(8);
        $comment_body = $this->randomMachineName(8);
        $comment = Comment::create([
            'subject' => $comment_subject,
            'comment_body' => $comment_body,
            'entity_id' => $node->id(),
            'entity_type' => 'node',
            'field_name' => 'comment',
            'status' => CommentInterface::PUBLISHED,
            'uid' => $account->id(),
        ]);
        $comment->save();
        // Create a node with two revisions, the initial one belonging to the
        // cancelling user.
        $revision_node = $this->drupalCreateNode([
            'uid' => $account->id(),
        ]);
        $revision = $revision_node->getRevisionId();
        $settings = get_object_vars($revision_node);
        $settings['revision'] = 1;
        // Set new/current revision to someone else.
        $settings['uid'] = 1;
        $revision_node = $this->drupalCreateNode($settings);
        // Attempt to cancel account.
        $this->drupalGet('user/' . $account->id() . '/edit');
        $this->drupalPostForm(NULL, NULL, t('Cancel account'));
        $this->assertText(t('Are you sure you want to cancel your account?'), 'Confirmation form to cancel account displayed.');
        $this->assertRaw(t('Your account will be removed and all account information deleted. All of your content will be assigned to the %anonymous-name user.', [
            '%anonymous-name' => $this->config('user.settings')
                ->get('anonymous'),
        ]), 'Informs that all content will be attributed to anonymous account.');
        // Confirm account cancellation.
        $timestamp = time();
        $this->drupalPostForm(NULL, NULL, t('Cancel account'));
        $this->assertText(t('A confirmation request to cancel your account has been sent to your email address.'), 'Account cancellation request mailed message displayed.');
        // Confirm account cancellation request.
        $this->drupalGet("user/" . $account->id() . "/cancel/confirm/{$timestamp}/" . user_pass_rehash($account, $timestamp));
        $user_storage->resetCache([
            $account->id(),
        ]);
        $this->assertNull($user_storage->load($account->id()), 'User is not found in the database.');
        // Confirm that user's content has been attributed to anonymous user.
        $anonymous_user = User::getAnonymousUser();
        $node_storage->resetCache([
            $node->id(),
        ]);
        $test_node = $node_storage->load($node->id());
        $this->assertTrue($test_node->getOwnerId() == 0 && $test_node->isPublished(), 'Node of the user has been attributed to anonymous user.');
        $test_node = node_revision_load($revision, TRUE);
        $this->assertTrue($test_node->getRevisionUser()
            ->id() == 0 && $test_node->isPublished(), 'Node revision of the user has been attributed to anonymous user.');
        $node_storage->resetCache([
            $revision_node->id(),
        ]);
        $test_node = $node_storage->load($revision_node->id());
        $this->assertTrue($test_node->getOwnerId() != 0 && $test_node->isPublished(), "Current revision of the user's node was not attributed to anonymous user.");
        $storage = \Drupal::entityTypeManager()->getStorage('comment');
        $storage->resetCache([
            $comment->id(),
        ]);
        $test_comment = $storage->load($comment->id());
        $this->assertTrue($test_comment->getOwnerId() == 0 && $test_comment->isPublished(), 'Comment of the user has been attributed to anonymous user.');
        $this->assertEqual($test_comment->getAuthorName(), $anonymous_user->getDisplayName(), 'Comment of the user has been attributed to anonymous user name.');
        // Confirm that the confirmation message made it through to the end user.
        $this->assertRaw(t('%name has been deleted.', [
            '%name' => $account->getAccountName(),
        ]), "Confirmation message displayed to user.");
    }
    
    /**
     * Delete account and anonymize all content using a batch process.
     */
    public function testUserAnonymizeBatch() {
        $node_storage = $this->container
            ->get('entity_type.manager')
            ->getStorage('node');
        $this->config('user.settings')
            ->set('cancel_method', 'user_cancel_reassign')
            ->save();
        $user_storage = $this->container
            ->get('entity_type.manager')
            ->getStorage('user');
        // Create a user.
        $account = $this->drupalCreateUser([
            'cancel account',
        ]);
        $this->drupalLogin($account);
        // Load a real user object.
        $user_storage->resetCache([
            $account->id(),
        ]);
        $account = $user_storage->load($account->id());
        // Create 11 nodes in order to trigger batch processing in
        // node_mass_update().
        $nodes = [];
        for ($i = 0; $i < 11; $i++) {
            $node = $this->drupalCreateNode([
                'uid' => $account->id(),
            ]);
            $nodes[$node->id()] = $node;
        }
        // Attempt to cancel account.
        $this->drupalGet('user/' . $account->id() . '/edit');
        $this->drupalPostForm(NULL, NULL, t('Cancel account'));
        $this->assertText(t('Are you sure you want to cancel your account?'), 'Confirmation form to cancel account displayed.');
        $this->assertRaw(t('Your account will be removed and all account information deleted. All of your content will be assigned to the %anonymous-name user.', [
            '%anonymous-name' => $this->config('user.settings')
                ->get('anonymous'),
        ]), 'Informs that all content will be attributed to anonymous account.');
        // Confirm account cancellation.
        $timestamp = time();
        $this->drupalPostForm(NULL, NULL, t('Cancel account'));
        $this->assertText(t('A confirmation request to cancel your account has been sent to your email address.'), 'Account cancellation request mailed message displayed.');
        // Confirm account cancellation request.
        $this->drupalGet("user/" . $account->id() . "/cancel/confirm/{$timestamp}/" . user_pass_rehash($account, $timestamp));
        $user_storage->resetCache([
            $account->id(),
        ]);
        $this->assertNull($user_storage->load($account->id()), 'User is not found in the database.');
        // Confirm that user's content has been attributed to anonymous user.
        $node_storage->resetCache(array_keys($nodes));
        $test_nodes = $node_storage->loadMultiple(array_keys($nodes));
        foreach ($test_nodes as $test_node) {
            $this->assertTrue($test_node->getOwnerId() == 0 && $test_node->isPublished(), 'Node ' . $test_node->id() . ' of the user has been attributed to anonymous user.');
        }
    }
    
    /**
     * Delete account and remove all content.
     */
    public function testUserDelete() {
        $node_storage = $this->container
            ->get('entity_type.manager')
            ->getStorage('node');
        $this->config('user.settings')
            ->set('cancel_method', 'user_cancel_delete')
            ->save();
        \Drupal::service('module_installer')->install([
            'comment',
        ]);
        $this->resetAll();
        $this->addDefaultCommentField('node', 'page');
        $user_storage = $this->container
            ->get('entity_type.manager')
            ->getStorage('user');
        // Create a user.
        $account = $this->drupalCreateUser([
            'cancel account',
            'post comments',
            'skip comment approval',
        ]);
        $this->drupalLogin($account);
        // Load a real user object.
        $user_storage->resetCache([
            $account->id(),
        ]);
        $account = $user_storage->load($account->id());
        // Create a simple node.
        $node = $this->drupalCreateNode([
            'uid' => $account->id(),
        ]);
        // Create comment.
        $edit = [];
        $edit['subject[0][value]'] = $this->randomMachineName(8);
        $edit['comment_body[0][value]'] = $this->randomMachineName(16);
        $this->drupalPostForm('comment/reply/node/' . $node->id() . '/comment', $edit, t('Preview'));
        $this->drupalPostForm(NULL, [], t('Save'));
        $this->assertText(t('Your comment has been posted.'));
        $comments = \Drupal::entityTypeManager()->getStorage('comment')
            ->loadByProperties([
            'subject' => $edit['subject[0][value]'],
        ]);
        $comment = reset($comments);
        $this->assertNotEmpty($comment->id(), 'Comment found.');
        // Create a node with two revisions, the initial one belonging to the
        // cancelling user.
        $revision_node = $this->drupalCreateNode([
            'uid' => $account->id(),
        ]);
        $revision = $revision_node->getRevisionId();
        $settings = get_object_vars($revision_node);
        $settings['revision'] = 1;
        // Set new/current revision to someone else.
        $settings['uid'] = 1;
        $revision_node = $this->drupalCreateNode($settings);
        // Attempt to cancel account.
        $this->drupalGet('user/' . $account->id() . '/edit');
        $this->drupalPostForm(NULL, NULL, t('Cancel account'));
        $this->assertText(t('Are you sure you want to cancel your account?'), 'Confirmation form to cancel account displayed.');
        $this->assertText(t('Your account will be removed and all account information deleted. All of your content will also be deleted.'), 'Informs that all content will be deleted.');
        // Confirm account cancellation.
        $timestamp = time();
        $this->drupalPostForm(NULL, NULL, t('Cancel account'));
        $this->assertText(t('A confirmation request to cancel your account has been sent to your email address.'), 'Account cancellation request mailed message displayed.');
        // Confirm account cancellation request.
        $this->drupalGet("user/" . $account->id() . "/cancel/confirm/{$timestamp}/" . user_pass_rehash($account, $timestamp));
        $user_storage->resetCache([
            $account->id(),
        ]);
        $this->assertNull($user_storage->load($account->id()), 'User is not found in the database.');
        // Confirm that user's content has been deleted.
        $node_storage->resetCache([
            $node->id(),
        ]);
        $this->assertNull($node_storage->load($node->id()), 'Node of the user has been deleted.');
        $this->assertNull(node_revision_load($revision), 'Node revision of the user has been deleted.');
        $node_storage->resetCache([
            $revision_node->id(),
        ]);
        $this->assertInstanceOf(Node::class, $node_storage->load($revision_node->id()));
        \Drupal::entityTypeManager()->getStorage('comment')
            ->resetCache([
            $comment->id(),
        ]);
        $this->assertNull(Comment::load($comment->id()), 'Comment of the user has been deleted.');
        // Confirm that the confirmation message made it through to the end user.
        $this->assertRaw(t('%name has been deleted.', [
            '%name' => $account->getAccountName(),
        ]), "Confirmation message displayed to user.");
    }
    
    /**
     * Create an administrative user and delete another user.
     */
    public function testUserCancelByAdmin() {
        $this->config('user.settings')
            ->set('cancel_method', 'user_cancel_reassign')
            ->save();
        // Create a regular user.
        $account = $this->drupalCreateUser([]);
        // Create administrative user.
        $admin_user = $this->drupalCreateUser([
            'administer users',
        ]);
        $this->drupalLogin($admin_user);
        // Delete regular user.
        $this->drupalGet('user/' . $account->id() . '/edit');
        $this->drupalPostForm(NULL, NULL, t('Cancel account'));
        $this->assertRaw(t('Are you sure you want to cancel the account %name?', [
            '%name' => $account->getAccountName(),
        ]), 'Confirmation form to cancel account displayed.');
        $this->assertText(t('Select the method to cancel the account above.'), 'Allows to select account cancellation method.');
        // Confirm deletion.
        $this->drupalPostForm(NULL, NULL, t('Cancel account'));
        $this->assertRaw(t('%name has been deleted.', [
            '%name' => $account->getAccountName(),
        ]), 'User deleted.');
        $this->assertNull(User::load($account->id()), 'User is not found in the database.');
    }
    
    /**
     * Tests deletion of a user account without an email address.
     */
    public function testUserWithoutEmailCancelByAdmin() {
        $this->config('user.settings')
            ->set('cancel_method', 'user_cancel_reassign')
            ->save();
        // Create a regular user.
        $account = $this->drupalCreateUser([]);
        // This user has no email address.
        $account->mail = '';
        $account->save();
        // Create administrative user.
        $admin_user = $this->drupalCreateUser([
            'administer users',
        ]);
        $this->drupalLogin($admin_user);
        // Delete regular user without email address.
        $this->drupalGet('user/' . $account->id() . '/edit');
        $this->drupalPostForm(NULL, NULL, t('Cancel account'));
        $this->assertRaw(t('Are you sure you want to cancel the account %name?', [
            '%name' => $account->getAccountName(),
        ]), 'Confirmation form to cancel account displayed.');
        $this->assertText(t('Select the method to cancel the account above.'), 'Allows to select account cancellation method.');
        // Confirm deletion.
        $this->drupalPostForm(NULL, NULL, t('Cancel account'));
        $this->assertRaw(t('%name has been deleted.', [
            '%name' => $account->getAccountName(),
        ]), 'User deleted.');
        $this->assertNull(User::load($account->id()), 'User is not found in the database.');
    }
    
    /**
     * Create an administrative user and mass-delete other users.
     */
    public function testMassUserCancelByAdmin() {
        \Drupal::service('module_installer')->install([
            'views',
        ]);
        \Drupal::service('router.builder')->rebuild();
        $this->config('user.settings')
            ->set('cancel_method', 'user_cancel_reassign')
            ->save();
        $user_storage = $this->container
            ->get('entity_type.manager')
            ->getStorage('user');
        // Enable account cancellation notification.
        $this->config('user.settings')
            ->set('notify.status_canceled', TRUE)
            ->save();
        // Create administrative user.
        $admin_user = $this->drupalCreateUser([
            'administer users',
        ]);
        $this->drupalLogin($admin_user);
        // Create some users.
        $users = [];
        for ($i = 0; $i < 3; $i++) {
            $account = $this->drupalCreateUser([]);
            $users[$account->id()] = $account;
        }
        // Cancel user accounts, including own one.
        $edit = [];
        $edit['action'] = 'user_cancel_user_action';
        for ($i = 0; $i <= 4; $i++) {
            $edit['user_bulk_form[' . $i . ']'] = TRUE;
        }
        $this->drupalPostForm('admin/people', $edit, t('Apply to selected items'));
        $this->assertText(t('Are you sure you want to cancel these user accounts?'), 'Confirmation form to cancel accounts displayed.');
        $this->assertText(t('When cancelling these accounts'), 'Allows to select account cancellation method.');
        $this->assertText(t('Require email confirmation to cancel account'), 'Allows to send confirmation mail.');
        $this->assertText(t('Notify user when account is canceled'), 'Allows to send notification mail.');
        // Confirm deletion.
        $this->drupalPostForm(NULL, NULL, t('Cancel accounts'));
        $status = TRUE;
        foreach ($users as $account) {
            $status = $status && strpos($this->getTextContent(), $account->getAccountName() . ' has been deleted.') !== FALSE;
            $user_storage->resetCache([
                $account->id(),
            ]);
            $status = $status && !$user_storage->load($account->id());
        }
        $this->assertTrue($status, 'Users deleted and not found in the database.');
        // Ensure that admin account was not cancelled.
        $this->assertText(t('A confirmation request to cancel your account has been sent to your email address.'), 'Account cancellation request mailed message displayed.');
        $admin_user = $user_storage->load($admin_user->id());
        $this->assertTrue($admin_user->isActive(), 'Administrative user is found in the database and enabled.');
        // Verify that uid 1's account was not cancelled.
        $user_storage->resetCache([
            1,
        ]);
        $user1 = $user_storage->load(1);
        $this->assertTrue($user1->isActive(), 'User #1 still exists and is not blocked.');
    }
    
    /**
     * Tests user cancel with node access.
     */
    public function testUserDeleteWithContentAndNodeAccess() {
        \Drupal::service('module_installer')->install([
            'node_access_test',
        ]);
        // Rebuild node access.
        node_access_rebuild();
        $account = $this->drupalCreateUser([
            'access content',
        ]);
        $node = $this->drupalCreateNode([
            'type' => 'page',
            'uid' => $account->id(),
        ]);
        $account->delete();
        $load2 = \Drupal::entityTypeManager()->getStorage('node')
            ->load($node->id());
        $this->assertTrue(empty($load2));
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Member alias Overriden Title Overrides
AssertHelperTrait::castSafeStrings protected static function Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert protected function
AssertLegacyTrait::assertCacheTag protected function Asserts whether an expected cache tag was present in the last response.
AssertLegacyTrait::assertElementNotPresent protected function Asserts that the element with the given CSS selector is not present.
AssertLegacyTrait::assertElementPresent protected function Asserts that the element with the given CSS selector is present.
AssertLegacyTrait::assertEqual protected function
AssertLegacyTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertLegacyTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertLegacyTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertLegacyTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertLegacyTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertLegacyTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertLegacyTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertLegacyTrait::assertHeader protected function Checks that current response header equals value.
AssertLegacyTrait::assertIdentical protected function
AssertLegacyTrait::assertIdenticalObject protected function
AssertLegacyTrait::assertLink protected function Passes if a link with the specified label is found.
AssertLegacyTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertLegacyTrait::assertNoCacheTag protected function Asserts whether an expected cache tag was absent in the last response.
AssertLegacyTrait::assertNoEscaped protected function Passes if the raw text is not found escaped on the loaded page.
AssertLegacyTrait::assertNoField protected function Asserts that a field does NOT exist with the given name or ID.
AssertLegacyTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertLegacyTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertLegacyTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertLegacyTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertLegacyTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertLegacyTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertLegacyTrait::assertNoOption protected function Asserts that a select option does NOT exist in the current page.
AssertLegacyTrait::assertNoPattern protected function Triggers a pass if the Perl regex pattern is not found in the raw content.
AssertLegacyTrait::assertNoRaw protected function Passes if the raw text IS not found on the loaded page, fail otherwise. 1
AssertLegacyTrait::assertNotEqual protected function
AssertLegacyTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text. 1
AssertLegacyTrait::assertNotIdentical protected function
AssertLegacyTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertLegacyTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertLegacyTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertLegacyTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertLegacyTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertLegacyTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise. 1
AssertLegacyTrait::assertResponse protected function Asserts the page responds with the specified response code. 1
AssertLegacyTrait::assertText protected function Passes if the page (with HTML stripped) contains the text. 1
AssertLegacyTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertLegacyTrait::assertTitle protected function Pass if the page title is the given string.
AssertLegacyTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertLegacyTrait::assertUrl protected function Passes if the internal browser&#039;s URL matches the given path.
AssertLegacyTrait::buildXPathQuery protected function Builds an XPath query.
AssertLegacyTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertLegacyTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertLegacyTrait::getRawContent protected function Gets the current raw content.
AssertLegacyTrait::pass protected function
AssertLegacyTrait::verbose protected function
BlockCreationTrait::placeBlock protected function Creates a block instance based on default settings. Aliased as: drupalPlaceBlock
BrowserHtmlDebugTrait::$htmlOutputBaseUrl protected property The Base URI to use for links to the output files.
BrowserHtmlDebugTrait::$htmlOutputClassName protected property Class name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounter protected property Counter for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounterStorage protected property Counter storage for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputDirectory protected property Directory name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputEnabled protected property HTML output output enabled.
BrowserHtmlDebugTrait::$htmlOutputFile protected property The file name to write the list of URLs to.
BrowserHtmlDebugTrait::$htmlOutputTestId protected property HTML output test ID.
BrowserHtmlDebugTrait::formatHtmlOutputHeaders protected function Formats HTTP headers as string for HTML output logging.
BrowserHtmlDebugTrait::getHtmlOutputHeaders protected function Returns headers in HTML output format. 1
BrowserHtmlDebugTrait::htmlOutput protected function Logs a HTML output message in a text file.
BrowserHtmlDebugTrait::initBrowserOutputFile protected function Creates the directory to store browser output.
BrowserTestBase::$baseUrl protected property The base URL.
BrowserTestBase::$configImporter protected property The config importer that can be used in a test.
BrowserTestBase::$customTranslations protected property An array of custom translations suitable for drupal_rewrite_settings().
BrowserTestBase::$databasePrefix protected property The database prefix of this test run.
BrowserTestBase::$mink protected property Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs protected property
BrowserTestBase::$minkDefaultDriverClass protected property 1
BrowserTestBase::$originalContainer protected property The original container.
BrowserTestBase::$originalShutdownCallbacks protected property The original array of shutdown function callbacks.
BrowserTestBase::$preserveGlobalState protected property
BrowserTestBase::$profile protected property The profile to install as a basis for testing. 39
BrowserTestBase::$root protected property The app root.
BrowserTestBase::$runTestInSeparateProcess protected property Browser tests are run in separate processes to prevent collisions between
code that may be loaded by tests.
BrowserTestBase::$timeLimit protected property Time limit in seconds for the test.
BrowserTestBase::$translationFilesDirectory protected property The translation file directory for the test environment.
BrowserTestBase::cleanupEnvironment protected function Clean up the Simpletest environment.
BrowserTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
BrowserTestBase::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
BrowserTestBase::drupalGetHeader protected function Gets the value of an HTTP response header.
BrowserTestBase::drupalGetHeaders Deprecated protected function Returns all response headers.
BrowserTestBase::filePreDeleteCallback public static function Ensures test files are deletable.
BrowserTestBase::getDefaultDriverInstance protected function Gets an instance of the default Mink driver.
BrowserTestBase::getDrupalSettings protected function Gets the JavaScript drupalSettings variable for the currently-loaded page. 1
BrowserTestBase::getHttpClient protected function Obtain the HTTP client for the system under test.
BrowserTestBase::getMinkDriverArgs protected function Get the Mink driver args from an environment variable, if it is set. Can
be overridden in a derived class so it is possible to use a different
value for a subset of tests, e.g. the JavaScript tests.
1
BrowserTestBase::getOptions protected function Helper function to get the options of select field.
BrowserTestBase::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received. Overrides BrowserHtmlDebugTrait::getResponseLogHandler
BrowserTestBase::getSession public function Returns Mink session.
BrowserTestBase::getSessionCookies protected function Get session cookies from current session.
BrowserTestBase::getTestMethodCaller protected function Retrieves the current calling line in the class under test. Overrides BrowserHtmlDebugTrait::getTestMethodCaller
BrowserTestBase::initFrontPage protected function Visits the front page when initializing Mink. 3
BrowserTestBase::initMink protected function Initializes Mink sessions. 1
BrowserTestBase::installDrupal public function Installs Drupal into the Simpletest site. 1
BrowserTestBase::registerSessions protected function Registers additional Mink sessions.
BrowserTestBase::tearDown protected function 3
BrowserTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for drupalPostForm().
BrowserTestBase::xpath protected function Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__construct public function 1
BrowserTestBase::__sleep public function Prevents serializing any properties.
CommentTestTrait::addDefaultCommentField public function Adds the default comment field to an entity.
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. Aliased as: drupalCreateContentType 1
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix protected property The flag to set &#039;apcu_ensure_unique_prefix&#039; setting. 1
FunctionalTestSetupTrait::$classLoader protected property The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$configDirectories Deprecated protected property The config directories used in this test.
FunctionalTestSetupTrait::$rootUser protected property The &quot;#1&quot; admin user.
FunctionalTestSetupTrait::doInstall protected function Execute the non-interactive installer. 1
FunctionalTestSetupTrait::getDatabaseTypes protected function Returns all supported database driver installer objects.
FunctionalTestSetupTrait::initConfig protected function Initialize various configurations post-installation. 2
FunctionalTestSetupTrait::initKernel protected function Initializes the kernel after installation.
FunctionalTestSetupTrait::initSettings protected function Initialize settings created during install.
FunctionalTestSetupTrait::initUserSession protected function Initializes user 1 for the site to be installed.
FunctionalTestSetupTrait::installDefaultThemeFromClassProperty protected function Installs the default theme defined by `static::$defaultTheme` when needed.
FunctionalTestSetupTrait::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. 1
FunctionalTestSetupTrait::installParameters protected function Returns the parameters that will be used when Simpletest installs Drupal. 9
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 23
FunctionalTestSetupTrait::prepareRequestForGenerator protected function Creates a mock request and sets it on the generator.
FunctionalTestSetupTrait::prepareSettings protected function Prepares site settings and services before installation. 2
FunctionalTestSetupTrait::rebuildAll protected function Resets and rebuilds the environment after setup.
FunctionalTestSetupTrait::rebuildContainer protected function Rebuilds \Drupal::getContainer().
FunctionalTestSetupTrait::resetAll protected function Resets all data structures after having enabled new modules.
FunctionalTestSetupTrait::setContainerParameter protected function Changes parameters in the services.yml file.
FunctionalTestSetupTrait::setupBaseUrl protected function Sets up the base URL based upon the environment variable.
FunctionalTestSetupTrait::writeSettings protected function Rewrites the settings.php file of the test site.
NodeCreationTrait::createNode protected function Creates a node based on default settings. Aliased as: drupalCreateNode
NodeCreationTrait::getNodeByTitle public function Get a node from the database based on its title. Aliased as: drupalGetNodeByTitle
PhpunitCompatibilityTrait::getMock Deprecated public function Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated public function Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
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. 1
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.
RefreshVariablesTrait::refreshVariables protected function Refreshes in-memory configuration and state information. 3
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.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements protected function Check module requirements for the Drupal use case. 1
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.
TestSetupTrait::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking.
TestSetupTrait::$container protected property The dependency injection container used in the test.
TestSetupTrait::$kernel protected property The DrupalKernel instance used in the test.
TestSetupTrait::$originalSite protected property The site directory of the original parent site.
TestSetupTrait::$privateFilesDirectory protected property The private file directory for the test environment.
TestSetupTrait::$publicFilesDirectory protected property The public file directory for the test environment.
TestSetupTrait::$siteDirectory protected property The site directory of this test run.
TestSetupTrait::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 2
TestSetupTrait::$tempFilesDirectory protected property The temporary file directory for the test environment.
TestSetupTrait::$testId protected property The test run ID.
TestSetupTrait::changeDatabasePrefix protected function Changes the database connection to the prefixed one.
TestSetupTrait::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
TestSetupTrait::getDatabaseConnection public static function Returns the database connection to the site running Simpletest.
TestSetupTrait::prepareDatabasePrefix protected function Generates a database prefix for running tests. 2
UiHelperTrait::$loggedInUser protected property The current user logged in using the Mink controlled browser.
UiHelperTrait::$maximumMetaRefreshCount protected property The number of meta refresh redirects to follow, or NULL if unlimited.
UiHelperTrait::$metaRefreshCount protected property The number of meta refresh redirects followed during ::drupalGet().
UiHelperTrait::assertSession public function Returns WebAssert object. 1
UiHelperTrait::buildUrl protected function Builds an a absolute URL from a system path or a URL object.
UiHelperTrait::checkForMetaRefresh protected function Checks for meta refresh tag and if found call drupalGet() recursively.
UiHelperTrait::click protected function Clicks the element with the given CSS selector.
UiHelperTrait::clickLink protected function Follows a link by complete name.
UiHelperTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
UiHelperTrait::drupalGet protected function Retrieves a Drupal path or an absolute path. 3
UiHelperTrait::drupalLogin protected function Logs in a user using the Mink controlled browser.
UiHelperTrait::drupalLogout protected function Logs a user out of the Mink controlled browser and confirms.
UiHelperTrait::drupalPostForm protected function Executes a form submission.
UiHelperTrait::drupalUserIsLoggedIn protected function Returns whether a given user account is logged in.
UiHelperTrait::getAbsoluteUrl protected function Takes a path and returns an absolute path.
UiHelperTrait::getTextContent protected function Retrieves the plain-text content from the current page.
UiHelperTrait::getUrl protected function Get the current URL from the browser.
UiHelperTrait::prepareRequest protected function Prepare for a request to testing site. 1
UiHelperTrait::submitForm protected function Fills and submits a form.
UserCancelTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
UserCancelTest::$modules public static property Modules to enable. Overrides BrowserTestBase::$modules
UserCancelTest::setUp protected function Overrides BrowserTestBase::setUp
UserCancelTest::testMassUserCancelByAdmin public function Create an administrative user and mass-delete other users.
UserCancelTest::testUserAnonymize public function Delete account and anonymize all content.
UserCancelTest::testUserAnonymizeBatch public function Delete account and anonymize all content using a batch process.
UserCancelTest::testUserBlock public function Disable account and keep all content.
UserCancelTest::testUserBlockUnpublish public function Disable account and unpublish all content.
UserCancelTest::testUserCancelByAdmin public function Create an administrative user and delete another user.
UserCancelTest::testUserCancelChangePermission public function Test ability to change the permission for canceling users.
UserCancelTest::testUserCancelInvalid public function Attempt invalid account cancellations.
UserCancelTest::testUserCancelUid1 public function Tests that user account for uid 1 cannot be cancelled.
UserCancelTest::testUserCancelWithoutPermission public function Attempt to cancel account without permission.
UserCancelTest::testUserDelete public function Delete account and remove all content.
UserCancelTest::testUserDeleteWithContentAndNodeAccess public function Tests user cancel with node access.
UserCancelTest::testUserWithoutEmailCancelByAdmin public function Tests deletion of a user account without an email address.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole protected function Creates an administrative role.
UserCreationTrait::createRole protected function Creates a role with specified permissions. Aliased as: drupalCreateRole
UserCreationTrait::createUser protected function Create a user with a given set of permissions. Aliased as: drupalCreateUser
UserCreationTrait::grantPermissions protected function Grant permissions to a user role.
UserCreationTrait::setCurrentUser protected function Switch the current logged in user.
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user.
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.