class WorkspacesLayoutBuilderIntegrationTest

Same name in other branches
  1. 11.x core/modules/workspaces/tests/src/FunctionalJavascript/WorkspacesLayoutBuilderIntegrationTest.php \Drupal\Tests\workspaces\FunctionalJavascript\WorkspacesLayoutBuilderIntegrationTest

Tests for layout editing in workspaces.

@group layout_builder @group workspaces @group #slow

Hierarchy

Expanded class hierarchy of WorkspacesLayoutBuilderIntegrationTest

File

core/modules/workspaces/tests/src/FunctionalJavascript/WorkspacesLayoutBuilderIntegrationTest.php, line 19

Namespace

Drupal\Tests\workspaces\FunctionalJavascript
View source
class WorkspacesLayoutBuilderIntegrationTest extends InlineBlockTestBase {
    use OffCanvasTestTrait;
    use WorkspaceTestUtilities;
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'starterkit_theme';
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'field_ui',
        'workspaces',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->drupalLogin($this->drupalCreateUser([
            'access contextual links',
            'configure any layout',
            'administer node display',
            'administer node fields',
            'create and edit custom blocks',
            'administer blocks',
            'administer content types',
            'administer workspaces',
            'view any workspace',
            'administer site configuration',
            'administer nodes',
            'bypass node access',
        ]));
        $this->setupWorkspaceSwitcherBlock();
        // Enable layout builder.
        $this->drupalGet(static::FIELD_UI_PREFIX . '/display/default');
        $this->submitForm([
            'layout[enabled]' => TRUE,
            'layout[allow_custom]' => TRUE,
        ], 'Save');
        $this->clickLink('Manage layout');
        $this->assertSession()
            ->addressEquals(static::FIELD_UI_PREFIX . '/display/default/layout');
        // Add a basic block with the body field set.
        $this->addInlineBlockToLayout('Block title', 'The DEFAULT block body');
        $this->assertSaveLayout();
    }
    
    /**
     * Tests changing a layout/blocks inside a workspace.
     */
    public function testBlocksInWorkspaces() : void {
        $assert_session = $this->assertSession();
        $this->drupalGet('node/1');
        $assert_session->pageTextContains('The DEFAULT block body');
        $this->drupalGet('node/2');
        $assert_session->pageTextContains('The DEFAULT block body');
        $stage = Workspace::load('stage');
        $this->switchToWorkspace($stage);
        // Confirm the block can be edited.
        $this->drupalGet('node/1/layout');
        $new_block_body = 'The NEW block body';
        $this->configureInlineBlock('The DEFAULT block body', $new_block_body);
        $this->assertSaveLayout();
        $this->drupalGet('node/1');
        $assert_session->pageTextContains($new_block_body);
        $assert_session->pageTextNotContains('The DEFAULT block body');
        $this->drupalGet('node/2');
        // Node 2 should use default layout.
        $assert_session->pageTextContains('The DEFAULT block body');
        $assert_session->pageTextNotContains($new_block_body);
        // Switch back to the live workspace and verify that the changes are not
        // visible there.
        $this->switchToLive();
        $this->drupalGet('node/1');
        $assert_session->pageTextNotContains($new_block_body);
        $assert_session->pageTextContains('The DEFAULT block body');
        $this->switchToWorkspace($stage);
        // Add a basic block with the body field set.
        $this->drupalGet('node/1/layout');
        $second_block_body = 'The 2nd block body';
        $this->addInlineBlockToLayout('2nd Block title', $second_block_body);
        $this->assertSaveLayout();
        $this->drupalGet('node/1');
        $assert_session->pageTextContains($second_block_body);
        $this->drupalGet('node/2');
        // Node 2 should use default layout.
        $assert_session->pageTextContains('The DEFAULT block body');
        $assert_session->pageTextNotContains($new_block_body);
        $assert_session->pageTextNotContains($second_block_body);
        // Switch back to the live workspace and verify that the new added block is
        // not visible there.
        $this->switchToLive();
        $this->drupalGet('node/1');
        $assert_session->pageTextNotContains($second_block_body);
        $assert_session->pageTextContains('The DEFAULT block body');
        // Check the concurrent editing protection on the Layout Builder form.
        $this->drupalGet('/node/1/layout');
        $assert_session->pageTextContains('The content is being edited in the Stage workspace. As a result, your changes cannot be saved.');
        $stage->publish();
        $this->drupalGet('node/1');
        $assert_session->pageTextNotContains('The DEFAULT block body');
        $assert_session->pageTextContains($new_block_body);
        $assert_session->pageTextContains($second_block_body);
    }
    
    /**
     * Tests that blocks can be deleted inside workspaces.
     */
    public function testBlockDeletionInWorkspaces() : void {
        $assert_session = $this->assertSession();
        $stage = Workspace::load('stage');
        $this->switchToWorkspace($stage);
        $this->drupalGet('node/1/layout');
        $workspace_block_content = 'The WORKSPACE block body';
        $this->addInlineBlockToLayout('Workspace block title', $workspace_block_content);
        $this->assertSaveLayout();
        $this->drupalGet('node/1');
        $assert_session->pageTextContains('The DEFAULT block body');
        $assert_session->pageTextContains($workspace_block_content);
        $this->switchToLive();
        $assert_session->pageTextNotContains($workspace_block_content);
        $this->switchToWorkspace($stage);
        $this->drupalGet('node/1/layout');
        $this->removeInlineBlockFromLayout(static::INLINE_BLOCK_LOCATOR . ' ~ ' . static::INLINE_BLOCK_LOCATOR);
        $this->assertSaveLayout();
        $this->drupalGet('node/1');
        $assert_session->pageTextContains('The DEFAULT block body');
        $assert_session->pageTextNotContains($workspace_block_content);
        $this->drupalGet('node/1/layout');
        $this->removeInlineBlockFromLayout();
        $this->assertSaveLayout();
        $this->drupalGet('node/1');
        $assert_session->pageTextNotContains('The DEFAULT block body');
        $assert_session->pageTextNotContains($workspace_block_content);
        $this->switchToLive();
        $this->drupalGet('node/1');
        $assert_session->pageTextContains('The DEFAULT block body');
        $stage->publish();
        $this->drupalGet('node/1');
        $assert_session->pageTextNotContains('The DEFAULT block body');
        $assert_session->pageTextNotContains($workspace_block_content);
    }

}

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.
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::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::$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::getHttpClient protected function Obtain the HTTP client for the system under test.
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::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::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
ContextualLinkClickTrait::clickContextualLink protected function Clicks a contextual link. 1
ContextualLinkClickTrait::toggleContextualTriggerVisibility protected function Toggles the visibility of a contextual trigger.
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. 15
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::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
InlineBlockTestBase::$blockStorage protected property The block storage.
InlineBlockTestBase::addInlineBlockToLayout protected function Adds an entity block to the layout.
InlineBlockTestBase::assertDialogClosedAndTextVisible protected function Asserts that the dialog closes and the new text appears on the main canvas.
InlineBlockTestBase::assertSaveLayout protected function Saves a layout and asserts the message is correct.
InlineBlockTestBase::configureInlineBlock protected function Configures an inline block in the Layout Builder.
InlineBlockTestBase::createBlockContentType protected function Creates a block content type.
InlineBlockTestBase::FIELD_UI_PREFIX constant Path prefix for the field UI for the test bundle.
InlineBlockTestBase::getLatestBlockEntityId protected function Gets the latest block entity id.
InlineBlockTestBase::INLINE_BLOCK_LOCATOR constant Locator for inline blocks.
InlineBlockTestBase::removeInlineBlockFromLayout protected function Removes an entity block from the layout but does not save the layout.
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
OffCanvasTestTrait::waitForOffCanvasArea protected function Waits for the off-canvas area to appear, resized and visible.
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::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.
WebDriverTestBase::$disableCssAnimations protected property Disables CSS animations in tests for more reliable testing.
WebDriverTestBase::$failOnJavascriptConsoleErrors protected property Determines if a test should fail on JavaScript console errors. 2
WebDriverTestBase::$minkDefaultDriverClass protected property Mink class for the default driver to use. Overrides BrowserTestBase::$minkDefaultDriverClass
WebDriverTestBase::assertJsCondition protected function Waits for the given time or until the given JS condition becomes TRUE.
WebDriverTestBase::assertSession public function Returns WebAssert object. Overrides UiHelperTrait::assertSession
WebDriverTestBase::createScreenshot protected function Creates a screenshot.
WebDriverTestBase::failOnJavaScriptErrors protected function Triggers a test failure if a JavaScript error was encountered.
WebDriverTestBase::getDrupalSettings protected function Gets the current Drupal javascript settings and parses into an array. Overrides BrowserTestBase::getDrupalSettings
WebDriverTestBase::getHtmlOutputHeaders protected function Returns headers in HTML output format. Overrides BrowserHtmlDebugTrait::getHtmlOutputHeaders
WebDriverTestBase::getMinkDriverArgs protected function Gets the Mink driver args from an environment variable. Overrides BrowserTestBase::getMinkDriverArgs 1
WebDriverTestBase::initFrontPage protected function Visits the front page when initializing Mink. Overrides BrowserTestBase::initFrontPage
WebDriverTestBase::initMink protected function Initializes Mink sessions. Overrides BrowserTestBase::initMink
WebDriverTestBase::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. Overrides FunctionalTestSetupTrait::installModulesFromClassProperty 1
WebDriverTestBase::tearDown protected function Overrides BrowserTestBase::tearDown 1
WorkspacesLayoutBuilderIntegrationTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
WorkspacesLayoutBuilderIntegrationTest::$modules protected static property Modules to install. Overrides InlineBlockTestBase::$modules
WorkspacesLayoutBuilderIntegrationTest::setUp protected function Overrides InlineBlockTestBase::setUp
WorkspacesLayoutBuilderIntegrationTest::testBlockDeletionInWorkspaces public function Tests that blocks can be deleted inside workspaces.
WorkspacesLayoutBuilderIntegrationTest::testBlocksInWorkspaces public function Tests changing a layout/blocks inside a workspace.
WorkspaceTestUtilities::$switcherBlockConfigured protected property
WorkspaceTestUtilities::createAndActivateWorkspaceThroughUi protected function Creates and activates a new Workspace through the UI.
WorkspaceTestUtilities::createNodeThroughUi protected function Creates a node by "clicking" buttons.
WorkspaceTestUtilities::createWorkspaceThroughUi protected function Creates a new Workspace through the UI.
WorkspaceTestUtilities::getOneEntityByLabel protected function Loads a single entity by its label.
WorkspaceTestUtilities::ignoreEntityType protected function Marks an entity type as ignored in a workspace.
WorkspaceTestUtilities::isLabelInContentOverview protected function Determine if the content list has an entity's label.
WorkspaceTestUtilities::setupWorkspaceSwitcherBlock protected function Adds the workspace switcher block to the site.
WorkspaceTestUtilities::switchToLive protected function Switches to the live version of the site for subsequent requests.
WorkspaceTestUtilities::switchToWorkspace protected function Sets a given workspace as "active" for subsequent requests.
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.