class OverrideDisplaysTest

Same name in other branches
  1. 9 core/modules/views_ui/tests/src/Functional/OverrideDisplaysTest.php \Drupal\Tests\views_ui\Functional\OverrideDisplaysTest
  2. 8.9.x core/modules/views_ui/tests/src/Functional/OverrideDisplaysTest.php \Drupal\Tests\views_ui\Functional\OverrideDisplaysTest
  3. 10 core/modules/views_ui/tests/src/Functional/OverrideDisplaysTest.php \Drupal\Tests\views_ui\Functional\OverrideDisplaysTest

Tests that displays can be correctly overridden via the user interface.

@group views_ui

Hierarchy

Expanded class hierarchy of OverrideDisplaysTest

File

core/modules/views_ui/tests/src/Functional/OverrideDisplaysTest.php, line 12

Namespace

Drupal\Tests\views_ui\Functional
View source 
class OverrideDisplaysTest extends UITestBase {
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * {@inheritdoc}
     */
    protected function setUp($import_test_views = TRUE, $modules = [
        'views_test_config',
    ]) : void {
        parent::setUp($import_test_views, $modules);
        $this->drupalPlaceBlock('page_title_block');
    }
    
    /**
     * Tests that displays can be overridden via the UI.
     */
    public function testOverrideDisplays() : void {
        // Create a basic view that shows all content, with a page and a block
        // display.
        $view['label'] = $this->randomMachineName(16);
        $view['id'] = $this->randomMachineName(16);
        $view['page[create]'] = 1;
        $view['page[path]'] = $this->randomMachineName(16);
        $view['block[create]'] = 1;
        $view_path = $view['page[path]'];
        $this->drupalGet('admin/structure/views/add');
        $this->submitForm($view, 'Save and edit');
        // Configure its title. Since the page and block both started off with the
        // same (empty) title in the views wizard, we expect the wizard to have set
        // things up so that they both inherit from the default display, and we
        // therefore only need to change that to have it take effect for both.
        $edit = [];
        $edit['title'] = $original_title = $this->randomMachineName(16);
        $edit['override[dropdown]'] = 'default';
        $this->drupalGet("admin/structure/views/nojs/display/{$view['id']}/page_1/title");
        $this->submitForm($edit, 'Apply');
        $this->drupalGet("admin/structure/views/view/{$view['id']}/edit/page_1");
        $this->submitForm([], 'Save');
        // Add a node that will appear in the view, so that the block will actually
        // be displayed.
        $this->drupalCreateContentType([
            'type' => 'page',
        ]);
        $this->drupalCreateNode();
        // Make sure the title appears in the page.
        $this->drupalGet($view_path);
        $this->assertSession()
            ->statusCodeEquals(200);
        $this->assertSession()
            ->pageTextContains($original_title);
        // Confirm that the view block is available in the block administration UI.
        $this->drupalGet('admin/structure/block/list/' . $this->config('system.theme')
            ->get('default'));
        $this->clickLink('Place block');
        $this->assertSession()
            ->pageTextContains($view['label']);
        // Place the block.
        $this->container
            ->get('plugin.manager.block')
            ->clearCachedDefinitions();
        $this->drupalPlaceBlock("views_block:{$view['id']}-block_1");
        // Make sure the title appears in the block.
        $this->drupalGet('');
        $this->assertSession()
            ->pageTextContains($original_title);
        // Change the title for the page display only, and make sure that the
        // original title still appears on the page.
        $edit = [];
        $edit['title'] = $new_title = $this->randomMachineName(16);
        $edit['override[dropdown]'] = 'page_1';
        $this->drupalGet("admin/structure/views/nojs/display/{$view['id']}/page_1/title");
        $this->submitForm($edit, 'Apply');
        $this->drupalGet("admin/structure/views/view/{$view['id']}/edit/page_1");
        $this->submitForm([], 'Save');
        $this->drupalGet($view_path);
        $this->assertSession()
            ->statusCodeEquals(200);
        $this->assertSession()
            ->pageTextContains($new_title);
        $this->assertSession()
            ->pageTextContains($original_title);
    }
    
    /**
     * Tests that the wizard correctly sets up default and overridden displays.
     */
    public function testWizardMixedDefaultOverriddenDisplays() : void {
        // Create a basic view with a page, block, and feed. Give the page and feed
        // identical titles, but give the block a different one, so we expect the
        // page and feed to inherit their titles from the default display, but the
        // block to override it.
        $view['label'] = $this->randomMachineName(16);
        $view['id'] = $this->randomMachineName(16);
        $view['page[create]'] = 1;
        $view['page[title]'] = $this->randomMachineName(16);
        $view['page[path]'] = $this->randomMachineName(16);
        $view['page[feed]'] = 1;
        $view['page[feed_properties][path]'] = $this->randomMachineName(16);
        $view['block[create]'] = 1;
        $view['block[title]'] = $this->randomMachineName(16);
        $this->drupalGet('admin/structure/views/add');
        $this->submitForm($view, 'Save and edit');
        // Add a node that will appear in the view, so that the block will actually
        // be displayed.
        $this->drupalCreateContentType([
            'type' => 'page',
        ]);
        $this->drupalCreateNode();
        // Make sure that the feed, page and block all start off with the correct
        // titles.
        $this->drupalGet($view['page[path]']);
        $this->assertSession()
            ->statusCodeEquals(200);
        $this->assertSession()
            ->pageTextContains($view['page[title]']);
        $this->assertSession()
            ->pageTextNotContains($view['block[title]']);
        $this->drupalGet($view['page[feed_properties][path]']);
        $this->assertSession()
            ->statusCodeEquals(200);
        $this->assertSession()
            ->responseContains($view['page[title]']);
        $this->assertSession()
            ->responseNotContains($view['block[title]']);
        // Confirm that the block is available in the block administration UI.
        $this->drupalGet('admin/structure/block/list/' . $this->config('system.theme')
            ->get('default'));
        $this->clickLink('Place block');
        $this->assertSession()
            ->pageTextContains($view['label']);
        // Put the block into the first sidebar region, and make sure it will not
        // display on the view's page display (since we will be searching for the
        // presence/absence of the view's title in both the page and the block).
        $this->container
            ->get('plugin.manager.block')
            ->clearCachedDefinitions();
        $this->drupalPlaceBlock("views_block:{$view['id']}-block_1", [
            'visibility' => [
                'request_path' => [
                    'pages' => '/' . $view['page[path]'],
                    'negate' => TRUE,
                ],
            ],
        ]);
        $this->drupalGet('');
        $this->assertSession()
            ->pageTextContains($view['block[title]']);
        $this->assertSession()
            ->pageTextNotContains($view['page[title]']);
        // Edit the page and change the title. This should automatically change
        // the feed's title also, but not the block.
        $edit = [];
        $edit['title'] = $new_default_title = $this->randomMachineName(16);
        $this->drupalGet("admin/structure/views/nojs/display/{$view['id']}/page_1/title");
        $this->submitForm($edit, 'Apply');
        $this->drupalGet("admin/structure/views/view/{$view['id']}/edit/page_1");
        $this->submitForm([], 'Save');
        $this->drupalGet($view['page[path]']);
        $this->assertSession()
            ->statusCodeEquals(200);
        $this->assertSession()
            ->pageTextContains($new_default_title);
        $this->assertSession()
            ->pageTextNotContains($view['page[title]']);
        $this->assertSession()
            ->pageTextNotContains($view['block[title]']);
        $this->drupalGet($view['page[feed_properties][path]']);
        $this->assertSession()
            ->statusCodeEquals(200);
        $this->assertSession()
            ->responseContains($new_default_title);
        $this->assertSession()
            ->responseNotContains($view['page[title]']);
        $this->assertSession()
            ->responseNotContains($view['block[title]']);
        $this->drupalGet('');
        $this->assertSession()
            ->pageTextNotContains($new_default_title);
        $this->assertSession()
            ->pageTextNotContains($view['page[title]']);
        $this->assertSession()
            ->pageTextContains($view['block[title]']);
        // Edit the block and change the title. This should automatically change
        // the block title only, and leave the defaults alone.
        $edit = [];
        $edit['title'] = $new_block_title = $this->randomMachineName(16);
        $this->drupalGet("admin/structure/views/nojs/display/{$view['id']}/block_1/title");
        $this->submitForm($edit, 'Apply');
        $this->drupalGet("admin/structure/views/view/{$view['id']}/edit/block_1");
        $this->submitForm([], 'Save');
        $this->drupalGet($view['page[path]']);
        $this->assertSession()
            ->statusCodeEquals(200);
        $this->assertSession()
            ->pageTextContains($new_default_title);
        $this->drupalGet($view['page[feed_properties][path]']);
        $this->assertSession()
            ->statusCodeEquals(200);
        $this->assertSession()
            ->responseContains($new_default_title);
        $this->assertSession()
            ->responseNotContains($new_block_title);
        $this->drupalGet('');
        $this->assertSession()
            ->pageTextContains($new_block_title);
        $this->assertSession()
            ->pageTextNotContains($view['block[title]']);
    }
    
    /**
     * Tests that the revert to all displays select-option works as expected.
     */
    public function testRevertAllDisplays() : void {
        // Create a basic view with a page, block.
        // Because there is both a title on page and block we expect the title on
        // the block be overridden.
        $view['label'] = $this->randomMachineName(16);
        $view['id'] = $this->randomMachineName(16);
        $view['page[create]'] = 1;
        $view['page[title]'] = $this->randomMachineName(16);
        $view['page[path]'] = $this->randomMachineName(16);
        $view['block[create]'] = 1;
        $view['block[title]'] = $this->randomMachineName(16);
        $this->drupalGet('admin/structure/views/add');
        $this->submitForm($view, 'Save and edit');
        // Revert the title of the block to the default ones, but submit some new
        // values to be sure that the new value is not stored.
        $edit = [];
        $edit['title'] = $this->randomMachineName();
        $edit['override[dropdown]'] = 'default_revert';
        $this->drupalGet("admin/structure/views/nojs/display/{$view['id']}/block_1/title");
        $this->submitForm($edit, 'Apply');
        $this->drupalGet("admin/structure/views/view/{$view['id']}/edit/block_1");
        $this->submitForm([], 'Save');
        $this->assertSession()
            ->pageTextContains($view['page[title]']);
    }

}

Members

Title 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. 41
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 1
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
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. 8
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. 29
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
OverrideDisplaysTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
OverrideDisplaysTest::setUp protected function Sets up the test. Overrides UITestBase::setUp
OverrideDisplaysTest::testOverrideDisplays public function Tests that displays can be overridden via the UI.
OverrideDisplaysTest::testRevertAllDisplays public function Tests that the revert to all displays select-option works as expected.
OverrideDisplaysTest::testWizardMixedDefaultOverriddenDisplays public function Tests that the wizard correctly sets up default and overridden displays.
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.
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. 3
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::$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::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.
UITestBase::$adminUser protected property An admin user with the 'administer views' permission. 5
UITestBase::$fullAdminUser protected property An admin user with administrative permissions for views, blocks, and nodes.
UITestBase::$modules protected static property Modules to install. Overrides ViewTestBase::$modules 24
UITestBase::drupalGet protected function Retrieves a Drupal path or an absolute path. Overrides UiHelperTrait::drupalGet
UITestBase::randomView public function A helper method which creates a random view.
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.
ViewResultAssertionTrait::assertIdenticalResultset protected function Verifies that a result set returned by a View matches expected values.
ViewResultAssertionTrait::assertIdenticalResultsetHelper protected function Performs View result assertions.
ViewResultAssertionTrait::assertNotIdenticalResultset protected function Verifies that a result set returned by a View differs from certain values.
ViewTestBase::dataSet protected function Returns a very simple test dataset. 1
ViewTestBase::enableViewsTestModule protected function Sets up the views_test_data.module.
ViewTestBase::executeView protected function Executes a view.
ViewTestBase::helperButtonHasLabel protected function Asserts the existence of a button with a certain ID and label.
ViewTestBase::orderResultSet protected function Orders a nested array containing a result set based on a given column.
ViewTestBase::schemaDefinition protected function Returns the schema definition. 1
ViewTestBase::viewsData protected function Returns the views data definition. 8
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.