class UserPictureTest

Same name in this branch
  1. 11.x core/modules/user/tests/src/Kernel/Plugin/migrate/source/d6/UserPictureTest.php \Drupal\Tests\user\Kernel\Plugin\migrate\source\d6\UserPictureTest
Same name and namespace in other branches
  1. 9 core/modules/user/tests/src/Kernel/Plugin/migrate/source/d6/UserPictureTest.php \Drupal\Tests\user\Kernel\Plugin\migrate\source\d6\UserPictureTest
  2. 9 core/modules/user/tests/src/Functional/UserPictureTest.php \Drupal\Tests\user\Functional\UserPictureTest
  3. 8.9.x core/modules/user/tests/src/Kernel/Plugin/migrate/source/d6/UserPictureTest.php \Drupal\Tests\user\Kernel\Plugin\migrate\source\d6\UserPictureTest
  4. 8.9.x core/modules/user/tests/src/Functional/UserPictureTest.php \Drupal\Tests\user\Functional\UserPictureTest
  5. 10 core/modules/user/tests/src/Kernel/Plugin/migrate/source/d6/UserPictureTest.php \Drupal\Tests\user\Kernel\Plugin\migrate\source\d6\UserPictureTest
  6. 10 core/modules/user/tests/src/Functional/UserPictureTest.php \Drupal\Tests\user\Functional\UserPictureTest

Tests user picture functionality.

@group user

Hierarchy

Expanded class hierarchy of UserPictureTest

File

core/modules/user/tests/src/Functional/UserPictureTest.php, line 21

Namespace

Drupal\Tests\user\Functional
View source
class UserPictureTest extends BrowserTestBase {
    use TestFileCreationTrait {
        getTestFiles as drupalGetTestFiles;
    }
    use CommentTestTrait;
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'test_user_config',
        'node',
        'comment',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * A regular user.
     *
     * @var \Drupal\user\UserInterface
     */
    protected $webUser;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        // This test expects unused managed files to be marked temporary and then
        // cleaned up by file_cron().
        $this->config('file.settings')
            ->set('make_unused_managed_files_temporary', TRUE)
            ->save();
        $this->webUser = $this->drupalCreateUser([
            'access content',
            'access comments',
            'post comments',
            'skip comment approval',
        ]);
    }
    
    /**
     * Tests creation, display, and deletion of user pictures.
     */
    public function testCreateDeletePicture() : void {
        $this->drupalLogin($this->webUser);
        // Save a new picture.
        $image = current($this->drupalGetTestFiles('image'));
        $file = $this->saveUserPicture($image);
        // Verify that the image is displayed on the user account page.
        $this->drupalGet('user');
        $this->assertSession()
            ->responseContains(StreamWrapperManager::getTarget($file->getFileUri()));
        // Delete the picture.
        $edit = [];
        $this->drupalGet('user/' . $this->webUser
            ->id() . '/edit');
        $this->submitForm($edit, 'Remove');
        $this->submitForm([], 'Save');
        // Call file_cron() to clean up the file. Make sure the timestamp
        // of the file is older than the system.file.temporary_maximum_age
        // configuration value. We use an UPDATE statement because using the API
        // would set the timestamp.
        Database::getConnection()->update('file_managed')
            ->fields([
            'changed' => \Drupal::time()->getRequestTime() - ($this->config('system.file')
                ->get('temporary_maximum_age') + 1),
        ])
            ->condition('fid', $file->id())
            ->execute();
        \Drupal::service('cron')->run();
        // Verify that the image has been deleted.
        $this->assertNull(File::load($file->id()), 'File was removed from the database.');
        // Clear out PHP's file stat cache so we see the current value.
        clearstatcache(TRUE, $file->getFileUri());
        $this->assertFileDoesNotExist($file->getFileUri());
    }
    
    /**
     * Tests embedded users on node pages.
     */
    public function testPictureOnNodeComment() : void {
        $this->drupalLogin($this->webUser);
        $this->drupalCreateContentType([
            'type' => 'article',
            'name' => 'Article',
        ]);
        $this->addDefaultCommentField('node', 'article');
        // Save a new picture.
        $image = current($this->drupalGetTestFiles('image'));
        $file = $this->saveUserPicture($image);
        $node = $this->drupalCreateNode([
            'type' => 'article',
        ]);
        // Enable user pictures on nodes.
        $this->config('system.theme.global')
            ->set('features.node_user_picture', TRUE)
            ->save();
        $image_style_id = $this->config('core.entity_view_display.user.user.compact')
            ->get('content.user_picture.settings.image_style');
        $style = ImageStyle::load($image_style_id);
        $image_url = \Drupal::service('file_url_generator')->transformRelative($style->buildUrl($file->getFileUri()));
        $alt_text = 'Profile picture for user ' . $this->webUser
            ->getAccountName();
        // Verify that the image is displayed on the node page.
        $this->drupalGet('node/' . $node->id());
        $elements = $this->cssSelect('article > footer img[alt="' . $alt_text . '"][src="' . $image_url . '"]');
        $this->assertCount(1, $elements, 'User picture with alt text found on node page.');
        // Enable user pictures on comments, instead of nodes.
        $this->config('system.theme.global')
            ->set('features.node_user_picture', FALSE)
            ->set('features.comment_user_picture', TRUE)
            ->save();
        $edit = [
            'comment_body[0][value]' => $this->randomString(),
        ];
        $this->drupalGet('comment/reply/node/' . $node->id() . '/comment');
        $this->submitForm($edit, 'Save');
        $elements = $this->cssSelect('#comment-1 img[alt="' . $alt_text . '"][src="' . $image_url . '"]');
        $this->assertCount(1, $elements, 'User picture with alt text found on the comment.');
        // Disable user pictures on comments and nodes.
        $this->config('system.theme.global')
            ->set('features.node_user_picture', FALSE)
            ->set('features.comment_user_picture', FALSE)
            ->save();
        $this->drupalGet('node/' . $node->id());
        $this->assertSession()
            ->responseNotContains(StreamWrapperManager::getTarget($file->getFileUri()));
    }
    
    /**
     * Edits the user picture for the test user.
     */
    public function saveUserPicture($image) {
        $edit = [
            'files[user_picture_0]' => \Drupal::service('file_system')->realpath($image->uri),
        ];
        $this->drupalGet('user/' . $this->webUser
            ->id() . '/edit');
        $this->submitForm($edit, 'Save');
        // Load actual user data from database.
        $user_storage = $this->container
            ->get('entity_type.manager')
            ->getStorage('user');
        $user_storage->resetCache([
            $this->webUser
                ->id(),
        ]);
        $account = $user_storage->load($this->webUser
            ->id());
        return File::load($account->user_picture->target_id);
    }
    
    /**
     * Tests user picture field with a non-standard field formatter.
     *
     * @see user_user_view_alter()
     */
    public function testUserViewAlter() : void {
        \Drupal::service('module_installer')->install([
            'image_module_test',
        ]);
        // Set dummy_image_formatter to the default view mode of user entity.
        EntityViewDisplay::load('user.user.default')->setComponent('user_picture', [
            'region' => 'content',
            'type' => 'dummy_image_formatter',
        ])
            ->save();
        $this->drupalLogin($this->webUser);
        $this->assertSession()
            ->statusCodeEquals(200);
        $this->assertSession()
            ->pageTextContains('Dummy');
    }

}

Members

Title Sort descending Modifiers Object type Summary Member alias Overriden Title Overrides
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::$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::$profile protected property The profile to install as a basis for testing. 40
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::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::__construct public function
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
ExpectDeprecationTrait::expectDeprecation public function Adds an expected deprecation.
ExpectDeprecationTrait::getCallableName private static function Returns a callable as a string suitable for inclusion in a message.
ExpectDeprecationTrait::setUpErrorHandler public function Sets up the test error handler.
ExpectDeprecationTrait::tearDownErrorHandler public function Tears down the test error handler.
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. 19
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. 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
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.
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.
TestFileCreationTrait::$generatedTestFiles protected property Whether the files were copied to the test files directory.
TestFileCreationTrait::compareFiles protected function Compares two files based on size and file name.
TestFileCreationTrait::generateFile public static function Generates a test file.
TestFileCreationTrait::getTestFiles protected function Gets a list of files that can be used in tests. Aliased as: drupalGetTestFiles
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. 4
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::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::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.
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.
UserPictureTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
UserPictureTest::$modules protected static property Modules to enable. Overrides BrowserTestBase::$modules
UserPictureTest::$webUser protected property A regular user.
UserPictureTest::saveUserPicture public function Edits the user picture for the test user.
UserPictureTest::setUp protected function Overrides BrowserTestBase::setUp
UserPictureTest::testCreateDeletePicture public function Tests creation, display, and deletion of user pictures.
UserPictureTest::testPictureOnNodeComment public function Tests embedded users on node pages.
UserPictureTest::testUserViewAlter public function Tests user picture field with a non-standard field formatter.
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.