class LayoutBuilderTranslationTest

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

Tests that the Layout Builder works with translated content.

@group layout_builder

Hierarchy

Expanded class hierarchy of LayoutBuilderTranslationTest

File

core/modules/layout_builder/tests/src/Functional/LayoutBuilderTranslationTest.php, line 16

Namespace

Drupal\Tests\layout_builder\Functional
View source
class LayoutBuilderTranslationTest extends ContentTranslationTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'content_translation',
        'contextual',
        'entity_test',
        'layout_builder',
        'block',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * The entity used for testing.
     *
     * @var \Drupal\Core\Entity\EntityInterface
     */
    protected $entity;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->doSetup();
        $this->setUpViewDisplay();
        $this->setUpEntities();
    }
    
    /**
     * Tests that layout overrides work when created after a translation.
     */
    public function testTranslationBeforeLayoutOverride() : void {
        $assert_session = $this->assertSession();
        $this->addEntityTranslation();
        $entity_url = $this->entity
            ->toUrl()
            ->toString();
        $language = \Drupal::languageManager()->getLanguage($this->langcodes[2]);
        $translated_entity_url = $this->entity
            ->toUrl('canonical', [
            'language' => $language,
        ])
            ->toString();
        $translated_layout_url = $translated_entity_url . '/layout';
        $this->drupalGet($entity_url);
        $assert_session->pageTextNotContains('The translated field value');
        $assert_session->pageTextContains('The untranslated field value');
        $assert_session->linkExists('Layout');
        $this->drupalGet($translated_entity_url);
        $assert_session->pageTextNotContains('The untranslated field value');
        $assert_session->pageTextContains('The translated field value');
        $assert_session->linkNotExists('Layout');
        $this->drupalGet($translated_layout_url);
        $assert_session->pageTextContains('Access denied');
        $this->addLayoutOverride();
        $this->drupalGet($entity_url);
        $assert_session->pageTextNotContains('The translated field value');
        $assert_session->pageTextContains('The untranslated field value');
        $assert_session->pageTextContains('Powered by Drupal');
        // Ensure that the layout change propagates to the translated entity.
        $this->drupalGet($translated_entity_url);
        $assert_session->pageTextNotContains('The untranslated field value');
        $assert_session->pageTextContains('The translated field value');
        $assert_session->pageTextContains('Powered by Drupal');
    }
    
    /**
     * Tests that layout overrides work when created before a translation.
     */
    public function testLayoutOverrideBeforeTranslation() : void {
        $assert_session = $this->assertSession();
        $entity_url = $this->entity
            ->toUrl()
            ->toString();
        $language = \Drupal::languageManager()->getLanguage($this->langcodes[2]);
        $this->addLayoutOverride();
        $this->drupalGet($entity_url);
        $assert_session->pageTextNotContains('The translated field value');
        $assert_session->pageTextContains('The untranslated field value');
        $assert_session->pageTextContains('Powered by Drupal');
        $assert_session->linkExists('Layout');
        $this->addEntityTranslation();
        $translated_entity_url = $this->entity
            ->toUrl('canonical', [
            'language' => $language,
        ])
            ->toString();
        $translated_layout_url = $translated_entity_url . '/layout';
        $this->drupalGet($entity_url);
        $assert_session->pageTextNotContains('The translated field value');
        $assert_session->pageTextContains('The untranslated field value');
        $assert_session->pageTextContains('Powered by Drupal');
        $assert_session->linkExists('Layout');
        $this->drupalGet($translated_entity_url);
        $assert_session->pageTextNotContains('The untranslated field value');
        $assert_session->pageTextContains('The translated field value');
        $assert_session->pageTextContains('Powered by Drupal');
        $assert_session->linkNotExists('Layout');
        $this->drupalGet($translated_layout_url);
        $assert_session->pageTextContains('Access denied');
    }
    
    /**
     * {@inheritdoc}
     */
    protected function getTranslatorPermissions() {
        $permissions = parent::getTranslatorPermissions();
        $permissions[] = 'view test entity translations';
        $permissions[] = 'view test entity';
        $permissions[] = 'configure any layout';
        return $permissions;
    }
    
    /**
     * Setup translated entity with layouts.
     */
    protected function setUpEntities() {
        $this->drupalLogin($this->administrator);
        // @todo The Layout Builder UI relies on local tasks; fix in
        //   https://www.drupal.org/project/drupal/issues/2917777.
        $this->drupalPlaceBlock('local_tasks_block');
        // Create a test entity.
        $id = $this->createEntity([
            $this->fieldName => [
                [
                    'value' => 'The untranslated field value',
                ],
            ],
            'name' => 'Test entity',
        ], $this->langcodes[0]);
        $storage = $this->container
            ->get('entity_type.manager')
            ->getStorage($this->entityTypeId);
        $storage->resetCache([
            $id,
        ]);
        $this->entity = $storage->load($id);
    }
    
    /**
     * Set up the View Display.
     */
    protected function setUpViewDisplay() {
        EntityViewDisplay::create([
            'targetEntityType' => $this->entityTypeId,
            'bundle' => $this->bundle,
            'mode' => 'default',
            'status' => TRUE,
        ])
            ->setComponent($this->fieldName, [
            'type' => 'string',
        ])
            ->enableLayoutBuilder()
            ->setOverridable()
            ->save();
    }
    
    /**
     * Adds an entity translation.
     */
    protected function addEntityTranslation() {
        $user = $this->loggedInUser;
        $this->drupalLogin($this->translator);
        $add_translation_url = Url::fromRoute("entity.{$this->entityTypeId}.content_translation_add", [
            $this->entityTypeId => $this->entity
                ->id(),
            'source' => $this->langcodes[0],
            'target' => $this->langcodes[2],
        ]);
        $this->drupalGet($add_translation_url);
        $this->submitForm([
            "{$this->fieldName}[0][value]" => 'The translated field value',
        ], 'Save');
        $this->drupalLogin($user);
    }
    
    /**
     * Adds a layout override.
     */
    protected function addLayoutOverride() {
        $assert_session = $this->assertSession();
        $page = $this->getSession()
            ->getPage();
        $entity_url = $this->entity
            ->toUrl()
            ->toString();
        $layout_url = $entity_url . '/layout';
        $this->drupalGet($layout_url);
        $assert_session->pageTextNotContains('The translated field value');
        $assert_session->pageTextContains('The untranslated field value');
        // Adjust the layout.
        $assert_session->linkExists('Add block');
        $this->clickLink('Add block');
        $assert_session->linkExists('Powered by Drupal');
        $this->clickLink('Powered by Drupal');
        $page->pressButton('Add block');
        $assert_session->pageTextContains('Powered by Drupal');
        $assert_session->buttonExists('Save layout');
        $page->pressButton('Save layout');
    }

}

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.
ContentTranslationTestBase::$administrator protected property The account to be used to test access to both workflows.
ContentTranslationTestBase::$bundle protected property The bundle being tested. 1
ContentTranslationTestBase::$controller protected property The translation controller for the current entity type.
ContentTranslationTestBase::$editor protected property The account to be used to test multilingual entity editing.
ContentTranslationTestBase::$entityTypeId protected property The entity type being tested. 2
ContentTranslationTestBase::$fieldName protected property The name of the field used to test translation.
ContentTranslationTestBase::$langcodes protected property The added languages.
ContentTranslationTestBase::$manager protected property
ContentTranslationTestBase::$translator protected property The account to be used to test translation operations.
ContentTranslationTestBase::createEntity protected function Creates the entity to be translated. 3
ContentTranslationTestBase::doSetup protected function Completes preparation for content translation tests.
ContentTranslationTestBase::enableTranslation protected function Enables translation for the current entity type and bundle.
ContentTranslationTestBase::getAdministratorPermissions protected function Returns an array of permissions needed for the administrator. 3
ContentTranslationTestBase::getEditorPermissions protected function Returns an array of permissions needed for the editor. 5
ContentTranslationTestBase::getEditUrl protected function Returns the edit URL for the specified entity. 1
ContentTranslationTestBase::getTranslatePermission protected function Returns the translate permissions for the current entity and bundle.
ContentTranslationTestBase::setupBundle protected function Creates or initializes the bundle date if needed. 6
ContentTranslationTestBase::setupLanguages protected function Adds additional languages.
ContentTranslationTestBase::setupTestFields protected function Creates the test fields. 2
ContentTranslationTestBase::setupUsers protected function Creates and activates translator, editor and admin users. 1
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
LayoutBuilderTranslationTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
LayoutBuilderTranslationTest::$entity protected property The entity used for testing.
LayoutBuilderTranslationTest::$modules protected static property Modules to install. Overrides ContentTranslationTestBase::$modules
LayoutBuilderTranslationTest::addEntityTranslation protected function Adds an entity translation.
LayoutBuilderTranslationTest::addLayoutOverride protected function Adds a layout override.
LayoutBuilderTranslationTest::getTranslatorPermissions protected function Returns an array of permissions needed for the translator. Overrides ContentTranslationTestBase::getTranslatorPermissions
LayoutBuilderTranslationTest::setUp protected function Overrides BrowserTestBase::setUp
LayoutBuilderTranslationTest::setUpEntities protected function Setup translated entity with layouts.
LayoutBuilderTranslationTest::setUpViewDisplay protected function Set up the View Display.
LayoutBuilderTranslationTest::testLayoutOverrideBeforeTranslation public function Tests that layout overrides work when created before a translation.
LayoutBuilderTranslationTest::testTranslationBeforeLayoutOverride public function Tests that layout overrides work when created after a translation.
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.
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.