class DefaultViewsTest

Same name in this branch
  1. 11.x core/modules/views/tests/src/Functional/DefaultViewsTest.php \Drupal\Tests\views\Functional\DefaultViewsTest
Same name in other branches
  1. 9 core/modules/views/tests/src/Functional/DefaultViewsTest.php \Drupal\Tests\views\Functional\DefaultViewsTest
  2. 9 core/modules/views_ui/tests/src/Functional/DefaultViewsTest.php \Drupal\Tests\views_ui\Functional\DefaultViewsTest
  3. 8.9.x core/modules/views/tests/src/Functional/DefaultViewsTest.php \Drupal\Tests\views\Functional\DefaultViewsTest
  4. 8.9.x core/modules/views_ui/tests/src/Functional/DefaultViewsTest.php \Drupal\Tests\views_ui\Functional\DefaultViewsTest
  5. 10 core/modules/views/tests/src/Functional/DefaultViewsTest.php \Drupal\Tests\views\Functional\DefaultViewsTest
  6. 10 core/modules/views_ui/tests/src/Functional/DefaultViewsTest.php \Drupal\Tests\views_ui\Functional\DefaultViewsTest

Tests enabling, disabling, and reverting default views via the listing page.

@group views_ui

Hierarchy

Expanded class hierarchy of DefaultViewsTest

File

core/modules/views_ui/tests/src/Functional/DefaultViewsTest.php, line 16

Namespace

Drupal\Tests\views_ui\Functional
View source
class DefaultViewsTest extends UITestBase {
    
    /**
     * Views used by this test.
     *
     * @var array
     */
    public static $testViews = [
        'test_view_status',
        'test_page_display_menu',
        'test_page_display_arguments',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * {@inheritdoc}
     */
    protected function setUp($import_test_views = TRUE, $modules = [
        'views_test_config',
    ]) : void {
        parent::setUp($import_test_views, $modules);
        $this->placeBlock('page_title_block');
    }
    
    /**
     * Tests default views.
     */
    public function testDefaultViews() : void {
        // Make sure the view starts off as disabled (does not appear on the listing
        // page).
        $edit_href = 'admin/structure/views/view/glossary';
        $this->drupalGet('admin/structure/views');
        // @todo Disabled default views do now appear on the front page. Test this
        // behavior with templates instead.
        // $this->assertSession()->linkByHrefNotExists($edit_href);
        // Enable the view, and make sure it is now visible on the main listing
        // page.
        $this->drupalGet('admin/structure/views');
        $this->clickViewsOperationLink('Enable', '/glossary/');
        $this->assertSession()
            ->addressEquals('admin/structure/views');
        $this->assertSession()
            ->linkByHrefExists($edit_href);
        // It should not be possible to revert the view yet.
        // @todo Figure out how to handle this with the new configuration system.
        // $this->assertSession()->linkNotExists('Revert');
        // $revert_href = 'admin/structure/views/view/glossary/revert';
        // $this->assertSession()->linkByHrefNotExists($revert_href);
        // Edit the view and change the title. Make sure that the new title is
        // displayed.
        $new_title = $this->randomMachineName(16);
        $edit = [
            'title' => $new_title,
        ];
        $this->drupalGet('admin/structure/views/nojs/display/glossary/page_1/title');
        $this->submitForm($edit, 'Apply');
        $this->drupalGet('admin/structure/views/view/glossary/edit/page_1');
        $this->submitForm([], 'Save');
        $this->drupalGet('glossary');
        $this->assertSession()
            ->statusCodeEquals(200);
        $this->assertSession()
            ->pageTextContains($new_title);
        // Save another view in the UI.
        $this->drupalGet('admin/structure/views/nojs/display/archive/page_1/title');
        $this->submitForm([], 'Apply');
        $this->drupalGet('admin/structure/views/view/archive/edit/page_1');
        $this->submitForm([], 'Save');
        // Check there is an enable link. i.e. The view has not been enabled after
        // editing.
        $this->drupalGet('admin/structure/views');
        $this->assertSession()
            ->linkByHrefExists('admin/structure/views/view/archive/enable');
        // Enable it again so it can be tested for access permissions.
        $this->clickViewsOperationLink('Enable', '/archive/');
        // It should now be possible to revert the view. Do that, and make sure the
        // view title we added above no longer is displayed.
        // $this->drupalGet('admin/structure/views');
        // $this->assertSession()->linkExists('Revert');
        // $this->assertSession()->linkByHrefExists($revert_href);
        // $this->drupalGet($revert_href);
        // $this->submitForm(array(), 'Revert');
        // $this->drupalGet('glossary');
        // $this->assertSession()->pageTextNotContains($new_title);
        // Duplicate the view and check that the normal schema of duplicated views is used.
        $this->drupalGet('admin/structure/views');
        $this->clickViewsOperationLink('Duplicate', '/glossary');
        $edit = [
            'id' => 'duplicate_of_glossary',
        ];
        $this->assertSession()
            ->titleEquals('Duplicate of Glossary | Drupal');
        $this->submitForm($edit, 'Duplicate');
        $this->assertSession()
            ->addressEquals('admin/structure/views/view/duplicate_of_glossary');
        // Duplicate a view and set a custom name.
        $this->drupalGet('admin/structure/views');
        $this->clickViewsOperationLink('Duplicate', '/glossary');
        $random_name = $this->randomMachineName();
        $this->submitForm([
            'id' => $random_name,
        ], 'Duplicate');
        $this->assertSession()
            ->addressEquals("admin/structure/views/view/{$random_name}");
        // Now disable the view, and make sure it stops appearing on the main view
        // listing page but instead goes back to displaying on the disabled views
        // listing page.
        // @todo Test this behavior with templates instead.
        $this->drupalGet('admin/structure/views');
        $this->clickViewsOperationLink('Disable', '/glossary/');
        // $this->assertSession()->addressEquals('admin/structure/views');
        // $this->assertSession()->linkByHrefNotExists($edit_href);
        // The easiest way to verify it appears on the disabled views listing page
        // is to try to click the "enable" link from there again.
        $this->drupalGet('admin/structure/views');
        $this->clickViewsOperationLink('Enable', '/glossary/');
        $this->assertSession()
            ->addressEquals('admin/structure/views');
        $this->assertSession()
            ->linkByHrefExists($edit_href);
        // Clear permissions for anonymous users to check access for default views.
        Role::load(RoleInterface::ANONYMOUS_ID)->revokePermission('access content')
            ->save();
        // Test the default views disclose no data by default.
        $this->drupalLogout();
        $this->drupalGet('glossary');
        $this->assertSession()
            ->statusCodeEquals(403);
        $this->drupalGet('archive');
        $this->assertSession()
            ->statusCodeEquals(403);
        // Test deleting a view.
        $this->drupalLogin($this->fullAdminUser);
        $this->drupalGet('admin/structure/views');
        $this->clickViewsOperationLink('Delete', '/glossary/');
        // Submit the confirmation form.
        $this->submitForm([], 'Delete');
        // Ensure the view is no longer listed.
        $this->assertSession()
            ->addressEquals('admin/structure/views');
        $this->assertSession()
            ->linkByHrefNotExists($edit_href);
        // Ensure the view is no longer available.
        $this->drupalGet($edit_href);
        $this->assertSession()
            ->statusCodeEquals(404);
        $this->assertSession()
            ->pageTextContains('Page not found');
        // Delete all duplicated Glossary views.
        $this->drupalGet('admin/structure/views');
        $this->clickViewsOperationLink('Delete', 'duplicate_of_glossary');
        // Submit the confirmation form.
        $this->submitForm([], 'Delete');
        $this->drupalGet('glossary');
        $this->assertSession()
            ->statusCodeEquals(200);
        $this->drupalGet('admin/structure/views');
        $this->clickViewsOperationLink('Delete', $random_name);
        // Submit the confirmation form.
        $this->submitForm([], 'Delete');
        $this->drupalGet('glossary');
        $this->assertSession()
            ->statusCodeEquals(404);
        $this->assertSession()
            ->pageTextContains('Page not found');
    }
    
    /**
     * Tests that enabling views moves them to the correct table.
     */
    public function testSplitListing() : void {
        $this->drupalGet('admin/structure/views');
        $this->assertSession()
            ->elementNotExists('xpath', '//div[@id="views-entity-list"]/div[@class = "views-list-section enabled"]/table//td/text()[contains(., "test_view_status")]');
        $this->assertSession()
            ->elementsCount('xpath', '//div[@id="views-entity-list"]/div[@class = "views-list-section disabled"]/table//td/text()[contains(., "test_view_status")]', 1);
        // Enable the view.
        $this->clickViewsOperationLink('Enable', '/test_view_status/');
        $this->assertSession()
            ->elementNotExists('xpath', '//div[@id="views-entity-list"]/div[@class = "views-list-section disabled"]/table//td/text()[contains(., "test_view_status")]');
        $this->assertSession()
            ->elementsCount('xpath', '//div[@id="views-entity-list"]/div[@class = "views-list-section enabled"]/table//td/text()[contains(., "test_view_status")]', 1);
        // Attempt to disable the view by path directly, with no token.
        $this->drupalGet('admin/structure/views/view/test_view_status/disable');
        $this->assertSession()
            ->statusCodeEquals(403);
    }
    
    /**
     * Tests that page displays show the correct path.
     */
    public function testPathDestination() : void {
        $this->drupalGet('admin/structure/views');
        // Check that links to views on default tabs are rendered correctly.
        $this->assertSession()
            ->linkByHrefExists('test_page_display_menu');
        $this->assertSession()
            ->linkByHrefNotExists('test_page_display_menu/default');
        $this->assertSession()
            ->linkByHrefExists('test_page_display_menu/local');
        // Check that a dynamic path is shown as text.
        $this->assertSession()
            ->responseContains('test_route_with_suffix/%/suffix');
        $this->assertSession()
            ->linkByHrefNotExists(Url::fromUri('base:test_route_with_suffix/%/suffix')->toString());
    }
    
    /**
     * Click a link to perform an operation on a view.
     *
     * In general, we expect lots of links titled "enable" or "disable" on the
     * various views listing pages, and they might have tokens in them. So we
     * need special code to find the correct one to click.
     *
     * @param string $label
     *   Text between the anchor tags of the desired link.
     * @param string $unique_href_part
     *   A unique string that is expected to occur within the href of the desired
     *   link. For example, if the link URL is expected to look like
     *   "admin/structure/views/view/glossary/*", then "/glossary/" could be
     *   passed as the expected unique string.
     */
    public function clickViewsOperationLink($label, $unique_href_part) : void {
        $this->assertSession()
            ->elementExists('xpath', "//a[normalize-space(text())='{$label}' and contains(@href, '{$unique_href_part}')]")
            ->click();
    }

}

Members

Title Sort descending Modifiers Object type Summary Member alias Overriden Title Overrides
BlockCreationTrait::placeBlock protected function Creates a block instance based on default settings. Aliased as: drupalPlaceBlock
BrowserHtmlDebugTrait::$htmlOutputBaseUrl protected property The Base URI to use for links to the output files.
BrowserHtmlDebugTrait::$htmlOutputClassName protected property Class name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounter protected property Counter for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounterStorage protected property Counter storage for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputDirectory protected property Directory name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputEnabled protected property HTML output enabled.
BrowserHtmlDebugTrait::$htmlOutputTestId protected property HTML output test ID.
BrowserHtmlDebugTrait::formatHtmlOutputHeaders protected function Formats HTTP headers as string for HTML output logging.
BrowserHtmlDebugTrait::getHtmlOutputHeaders protected function Returns headers in HTML output format. 1
BrowserHtmlDebugTrait::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received.
BrowserHtmlDebugTrait::htmlOutput protected function Logs a HTML output message in a text file.
BrowserHtmlDebugTrait::initBrowserOutputFile protected function Creates the directory to store browser output.
BrowserTestBase::$baseUrl protected property The base URL.
BrowserTestBase::$configImporter protected property The config importer that can be used in a test.
BrowserTestBase::$customTranslations protected property An array of custom translations suitable for SettingsEditor::rewrite().
BrowserTestBase::$mink protected property Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs protected property Mink default driver params.
BrowserTestBase::$minkDefaultDriverClass protected property Mink class for the default driver to use. 1
BrowserTestBase::$originalContainer protected property The original container.
BrowserTestBase::$originalShutdownCallbacks protected property The original array of shutdown function callbacks.
BrowserTestBase::$profile protected property The profile to install as a basis for testing. 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
DefaultViewsTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
DefaultViewsTest::$testViews public static property Views used by this test.
DefaultViewsTest::clickViewsOperationLink public function Click a link to perform an operation on a view.
DefaultViewsTest::setUp protected function Sets up the test. Overrides UITestBase::setUp
DefaultViewsTest::testDefaultViews public function Tests default views.
DefaultViewsTest::testPathDestination public function Tests that page displays show the correct path.
DefaultViewsTest::testSplitListing public function Tests that enabling views moves them to the correct table.
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. 3
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
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.