class FileOnTranslatedEntityTest

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

Uploads files to translated nodes.

@group file

Hierarchy

Expanded class hierarchy of FileOnTranslatedEntityTest

File

core/modules/file/tests/src/Functional/FileOnTranslatedEntityTest.php, line 18

Namespace

Drupal\Tests\file\Functional
View source
class FileOnTranslatedEntityTest extends FileFieldTestBase {
    use ContentTranslationTestTrait;
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'language',
        'content_translation',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * The name of the file field used in the test.
     *
     * @var string
     */
    protected $fieldName;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        // This test expects unused managed files to be marked as temporary a file.
        $this->config('file.settings')
            ->set('make_unused_managed_files_temporary', TRUE)
            ->save();
        // Create the "Basic page" node type.
        // @todo Remove the disabling of new revision creation in
        //   https://www.drupal.org/node/1239558.
        $this->drupalCreateContentType([
            'type' => 'page',
            'name' => 'Basic page',
            'new_revision' => FALSE,
        ]);
        // Create a file field on the "Basic page" node type.
        $this->fieldName = $this->randomMachineName();
        $this->createFileField($this->fieldName, 'node', 'page');
        // Create and log in user.
        $permissions = [
            'access administration pages',
            'administer content translation',
            'administer content types',
            'administer languages',
            'create content translations',
            'create page content',
            'edit any page content',
            'translate any entity',
            'delete any page content',
        ];
        $admin_user = $this->drupalCreateUser($permissions);
        $this->drupalLogin($admin_user);
        // Add a second and third language.
        static::createLanguageFromLangcode('fr');
        static::createLanguageFromLangcode('nl');
        // Enable translation for "Basic page" nodes.
        static::enableContentTranslation('node', 'page');
        static::setFieldTranslatable('node', 'page', $this->fieldName, TRUE);
    }
    
    /**
     * Tests synced file fields on translated nodes.
     */
    public function testSyncedFiles() : void {
        // Verify that the file field on the "Basic page" node type is translatable.
        $definitions = \Drupal::service('entity_field.manager')->getFieldDefinitions('node', 'page');
        $this->assertTrue($definitions[$this->fieldName]
            ->isTranslatable(), 'Node file field is translatable.');
        // Create a default language node.
        $default_language_node = $this->drupalCreateNode([
            'type' => 'page',
            'title' => 'Lost in translation',
        ]);
        // Edit the node to upload a file.
        $edit = [];
        $name = 'files[' . $this->fieldName . '_0]';
        $edit[$name] = \Drupal::service('file_system')->realpath($this->drupalGetTestFiles('text')[0]->uri);
        $this->drupalGet('node/' . $default_language_node->id() . '/edit');
        $this->submitForm($edit, 'Save');
        $first_fid = $this->getLastFileId();
        // Translate the node into French: remove the existing file.
        $this->drupalGet('node/' . $default_language_node->id() . '/translations/add/en/fr');
        $this->submitForm([], 'Remove');
        // Upload a different file.
        $edit = [];
        $edit['title[0][value]'] = 'Bill Murray';
        $name = 'files[' . $this->fieldName . '_0]';
        $edit[$name] = \Drupal::service('file_system')->realpath($this->drupalGetTestFiles('text')[1]->uri);
        $this->submitForm($edit, 'Save (this translation)');
        // This inspects the HTML after the post of the translation, the file
        // should be displayed on the original node.
        $this->assertSession()
            ->responseContains('file--mime-text-plain');
        $second_fid = $this->getLastFileId();
        \Drupal::entityTypeManager()->getStorage('file')
            ->resetCache();
        
        /** @var \Drupal\file\FileInterface $file */
        // Ensure the file status of the first file permanent.
        $file = File::load($first_fid);
        $this->assertTrue($file->isPermanent());
        // Ensure the file status of the second file is permanent.
        $file = File::load($second_fid);
        $this->assertTrue($file->isPermanent());
        // Translate the node into dutch: remove the existing file.
        $this->drupalGet('node/' . $default_language_node->id() . '/translations/add/en/nl');
        $this->submitForm([], 'Remove');
        // Upload a different file.
        $edit = [];
        $edit['title[0][value]'] = 'Scarlett Johansson';
        $name = 'files[' . $this->fieldName . '_0]';
        $edit[$name] = \Drupal::service('file_system')->realpath($this->drupalGetTestFiles('text')[2]->uri);
        $this->submitForm($edit, 'Save (this translation)');
        $third_fid = $this->getLastFileId();
        \Drupal::entityTypeManager()->getStorage('file')
            ->resetCache();
        // Ensure the first file is untouched.
        $file = File::load($first_fid);
        $this->assertTrue($file->isPermanent(), 'First file still exists and is permanent.');
        // This inspects the HTML after the post of the translation, the file
        // should be displayed on the original node.
        $this->assertSession()
            ->responseContains('file--mime-text-plain');
        // Ensure the file status of the second file is permanent.
        $file = File::load($second_fid);
        $this->assertTrue($file->isPermanent());
        // Ensure the file status of the third file is permanent.
        $file = File::load($third_fid);
        $this->assertTrue($file->isPermanent());
        // Edit the second translation: remove the existing file.
        $this->drupalGet('fr/node/' . $default_language_node->id() . '/edit');
        $this->submitForm([], 'Remove');
        // Upload a different file.
        $edit = [];
        $edit['title[0][value]'] = 'David Bowie';
        $name = 'files[' . $this->fieldName . '_0]';
        $edit[$name] = \Drupal::service('file_system')->realpath($this->drupalGetTestFiles('text')[3]->uri);
        $this->submitForm($edit, 'Save (this translation)');
        $replaced_second_fid = $this->getLastFileId();
        \Drupal::entityTypeManager()->getStorage('file')
            ->resetCache();
        // Ensure the first and third files are untouched.
        $file = File::load($first_fid);
        $this->assertTrue($file->isPermanent(), 'First file still exists and is permanent.');
        $file = File::load($third_fid);
        $this->assertTrue($file->isPermanent());
        // Ensure the file status of the replaced second file is permanent.
        $file = File::load($replaced_second_fid);
        $this->assertTrue($file->isPermanent());
        // Delete the third translation.
        $this->drupalGet('nl/node/' . $default_language_node->id() . '/delete');
        $this->submitForm([], 'Delete Dutch translation');
        \Drupal::entityTypeManager()->getStorage('file')
            ->resetCache();
        // Ensure the first and replaced second files are untouched.
        $file = File::load($first_fid);
        $this->assertTrue($file->isPermanent(), 'First file still exists and is permanent.');
        $file = File::load($replaced_second_fid);
        $this->assertTrue($file->isPermanent());
        // Ensure the file status of the third file is now temporary.
        $file = File::load($third_fid);
        $this->assertTrue($file->isTemporary());
        // Delete the all translations.
        $this->drupalGet('node/' . $default_language_node->id() . '/delete');
        $this->submitForm([], 'Delete all translations');
        \Drupal::entityTypeManager()->getStorage('file')
            ->resetCache();
        // Ensure the file status of the all files are now temporary.
        $file = File::load($first_fid);
        $this->assertTrue($file->isTemporary(), 'First file still exists and is temporary.');
        $file = File::load($replaced_second_fid);
        $this->assertTrue($file->isTemporary());
    }
    
    /**
     * Tests if file field tracks file usages correctly on translated nodes.
     */
    public function testFileUsage() : void {
        
        /** @var \Drupal\file\FileUsage\FileUsageInterface $file_usage */
        $file_usage = \Drupal::service('file.usage');
        // Create a node and upload a file.
        $node = $this->drupalCreateNode([
            'type' => 'page',
        ]);
        $edit = [
            'files[' . $this->fieldName . '_0]' => \Drupal::service('file_system')->realpath($this->drupalGetTestFiles('text')[0]->uri),
        ];
        $this->drupalGet('node/' . $node->id() . '/edit');
        $this->submitForm($edit, 'Save');
        // Check if the file usage is correct.
        $file = File::load($this->getLastFileId());
        $this->assertEquals($file_usage->listUsage($file), [
            'file' => [
                'node' => [
                    $node->id() => '1',
                ],
            ],
        ]);
        // Check if the file usage is tracked correctly when changing the original
        // language of an entity.
        $node = Node::load($node->id());
        $node->set('langcode', 'fr');
        $node->save();
        $this->assertEquals($file_usage->listUsage($file), [
            'file' => [
                'node' => [
                    $node->id() => '1',
                ],
            ],
        ]);
    }

}

Members

Title Sort descending Deprecated 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::$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::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.
ContentTranslationTestTrait::enableContentTranslation public function Enables content translation for the given entity type bundle.
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.
FileFieldCreationTrait::attachFileField protected function Attaches a file field to an entity.
FileFieldCreationTrait::createFileField protected function Creates a new file field.
FileFieldTestBase::$adminUser protected property A user with administration permissions.
FileFieldTestBase::assertFileEntryExists public function Asserts that a file exists in the database.
FileFieldTestBase::assertFileEntryNotExists public function Asserts that a file does not exist in the database.
FileFieldTestBase::assertFileIsPermanent public function Asserts that a file's status is set to permanent in the database.
FileFieldTestBase::getLastFileId public function Retrieves the fid of the last inserted file.
FileFieldTestBase::getTestFile public function Retrieves a sample file of the specified type.
FileFieldTestBase::removeNodeFile public function Removes a file from a node.
FileFieldTestBase::replaceNodeFile public function Replaces a file within a node.
FileFieldTestBase::updateFileField public function Updates an existing file field with new settings.
FileFieldTestBase::uploadNodeFile public function Uploads a file to a node.
FileFieldTestBase::uploadNodeFiles public function Uploads multiple files to a node.
FileOnTranslatedEntityTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
FileOnTranslatedEntityTest::$fieldName protected property The name of the file field used in the test.
FileOnTranslatedEntityTest::$modules protected static property Modules to install. Overrides FileFieldTestBase::$modules
FileOnTranslatedEntityTest::setUp protected function Overrides FileFieldTestBase::setUp
FileOnTranslatedEntityTest::testFileUsage public function Tests if file field tracks file usages correctly on translated nodes.
FileOnTranslatedEntityTest::testSyncedFiles public function Tests synced file fields on translated nodes.
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
LanguageTestTrait::createLanguageFromLangcode public static function Creates a configurable language object from a langcode.
LanguageTestTrait::disableBundleTranslation public static function Disables translations for the given entity type bundle.
LanguageTestTrait::enableBundleTranslation public static function Enables translations for the given entity type bundle.
LanguageTestTrait::setFieldTranslatable public static function Sets and saves a given field instance translation status.
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.
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::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. 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::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.
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.