class UserAdminTest

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

Tests user administration page functionality.

@group user

Hierarchy

Expanded class hierarchy of UserAdminTest

File

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

Namespace

Drupal\Tests\user\Functional
View source
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.');
        $user_storage->resetCache([
            $user_c->id(),
        ]);
        $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');
        $user_storage->resetCache([
            $user_c->id(),
        ]);
        $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([]);
        $user_storage->resetCache([
            $user_d->id(),
        ]);
        $account1 = $user_storage->load($user_d->id());
        $this->drupalGet('user/' . $account1->id() . '/edit');
        $this->submitForm([
            'status' => 0,
        ], 'Save');
        $user_storage->resetCache([
            $user_d->id(),
        ]);
        $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');
        $user_storage->resetCache([
            $user_d->id(),
        ]);
        $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');
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Member alias Overriden Title Overrides
AssertMailTrait::assertMail protected function Asserts that the most recently sent email message has the given value.
AssertMailTrait::assertMailPattern protected function Asserts that the most recently sent email message has the pattern in it.
AssertMailTrait::assertMailString protected function Asserts that the most recently sent email message has the string in it.
AssertMailTrait::getMails protected function Gets an array containing all emails sent during this test case. Aliased as: drupalGetMails
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 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::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received.
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 SettingsEditor::rewrite().
BrowserTestBase::$mink protected property Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs protected property Mink default driver params.
BrowserTestBase::$minkDefaultDriverClass protected property Mink class for the default driver to use. 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. 40
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 test environment.
BrowserTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
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 Gets the Mink driver args from an environment variable. 1
BrowserTestBase::getOptions protected function Helper function to get the options of select field.
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 test site. 2
BrowserTestBase::registerSessions protected function Registers additional Mink sessions.
BrowserTestBase::setUp protected function 544
BrowserTestBase::setUpAppRoot protected function Sets up the root application path.
BrowserTestBase::setUpBeforeClass public static function 1
BrowserTestBase::tearDown protected function 3
BrowserTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for submitForm().
BrowserTestBase::xpath protected function Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__get public function
BrowserTestBase::__sleep public function Prevents serializing any properties.
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
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix protected property The flag to set 'apcu_ensure_unique_prefix' setting. 1
FunctionalTestSetupTrait::$classLoader protected property The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$rootUser protected property The "#1" admin user.
FunctionalTestSetupTrait::$usesSuperUserAccessPolicy protected property Set to TRUE to make user 1 a super user. 10
FunctionalTestSetupTrait::doInstall protected function Execute the non-interactive installer. 2
FunctionalTestSetupTrait::getDatabaseTypes protected function Returns all supported database driver installer objects.
FunctionalTestSetupTrait::initConfig protected function Initialize various configurations post-installation. 1
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. 1
FunctionalTestSetupTrait::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. 1
FunctionalTestSetupTrait::installParameters protected function Returns the parameters that will be used when the test installs Drupal. 8
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 28
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. 4
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. 1
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
PhpUnitWarnings::$deprecationWarnings private static property Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning public function Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
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 Deprecated public function Callback for random string validation.
RefreshVariablesTrait::refreshVariables protected function Refreshes in-memory configuration and state information. 2
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 Deprecated private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements Deprecated protected function Check module requirements for the Drupal use case.
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. 2
TestSetupTrait::$container protected property The dependency injection container used in the test.
TestSetupTrait::$databasePrefix protected property The database prefix of this test run.
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::$root protected property The app root.
TestSetupTrait::$siteDirectory protected property The site directory of this test run.
TestSetupTrait::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 5
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 Deprecated public static function Returns the database connection to the site under test.
TestSetupTrait::prepareDatabasePrefix protected function Generates a database prefix for running tests. 1
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::$useOneTimeLoginLinks protected property Use one-time login links instead of submitting the login form. 3
UiHelperTrait::assertSession public function Returns WebAssert object. 1
UiHelperTrait::buildUrl protected function Builds an 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::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
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::drupalResetSession protected function Resets the current active session back to Anonymous session.
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::isTestUsingGuzzleClient protected function Determines if test is using DrupalTestBrowser.
UiHelperTrait::prepareRequest protected function Prepare for a request to testing site. 1
UiHelperTrait::submitForm protected function Fills and submits a form.
UserAdminTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
UserAdminTest::$modules protected static property Modules to install. Overrides BrowserTestBase::$modules
UserAdminTest::getLinkSelectorForUser private static function Gets the xpath selector for a user account.
UserAdminTest::testNotificationEmailAddress public function Tests the alternate notification email address for user mails.
UserAdminTest::testUserAdmin public function Registers a user and deletes it.
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.