class NavigationShortcutsBlockTest

Same name in other branches
  1. 11.x core/modules/navigation/tests/src/Functional/NavigationShortcutsBlockTest.php \Drupal\Tests\navigation\Functional\NavigationShortcutsBlockTest

Tests for \Drupal\navigation\Plugin\Block\NavigationShortcutsBlock.

@group navigation

Hierarchy

Expanded class hierarchy of NavigationShortcutsBlockTest

File

core/modules/navigation/tests/src/Functional/NavigationShortcutsBlockTest.php, line 18

Namespace

Drupal\Tests\navigation\Functional
View source
class NavigationShortcutsBlockTest extends PageCacheTagsTestBase {
    use AssertPageCacheContextsAndTagsTrait;
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'navigation',
        'shortcut',
        'test_page_test',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * Tests visibility and cacheability of shortcuts in the navigation bar.
     */
    public function testNavigationBlock() : void {
        $this->drupalPlaceBlock('page_title_block', [
            'id' => 'title',
        ]);
        $test_page_url = Url::fromRoute('test_page_test.test_page');
        $this->verifyPageCache($test_page_url, 'MISS');
        $this->verifyPageCache($test_page_url, 'HIT');
        // Ensure that without enabling the shortcuts-in-page-title-link feature
        // in the theme, the shortcut_list cache tag is not added to the page.
        $this->drupalLogin($this->drupalCreateUser([
            'administer site configuration',
            'access navigation',
            'administer shortcuts',
            'access shortcuts',
        ]));
        $this->drupalGet('admin/config/system/cron');
        $expected_cache_tags = [
            'CACHE_MISS_IF_UNCACHEABLE_HTTP_METHOD:form',
            'block_view',
            'config:block.block.title',
            'config:block_list',
            'config:navigation.settings',
            'config:navigation.block_layout',
            'config:shortcut.set.default',
            'config:system.menu.admin',
            'config:system.menu.content',
            'http_response',
            'rendered',
        ];
        $this->assertCacheTags($expected_cache_tags);
        \Drupal::configFactory()->getEditable('stark.settings')
            ->set('third_party_settings.shortcut.module_link', TRUE)
            ->save(TRUE);
        // Add cron to the default shortcut set, now the shortcut list cache tag
        // is expected.
        $this->drupalGet('admin/config/system/cron');
        $this->clickLink('Add to Default shortcuts');
        $expected_cache_tags[] = 'config:shortcut_set_list';
        $this->assertCacheTags($expected_cache_tags);
        // Verify that users without the 'access shortcuts' permission can't see the
        // shortcuts.
        $this->drupalLogin($this->drupalCreateUser([
            'access navigation',
        ]));
        $this->assertSession()
            ->pageTextNotContains('Shortcuts');
        $this->verifyDynamicPageCache($test_page_url, 'MISS');
        $this->verifyDynamicPageCache($test_page_url, 'HIT');
        // Verify that users without the 'administer site configuration' permission
        // can't see the cron shortcut nor the shortcuts navigation item.
        $this->drupalLogin($this->drupalCreateUser([
            'access navigation',
            'access shortcuts',
        ]));
        $this->verifyDynamicPageCache($test_page_url, 'MISS');
        $this->verifyDynamicPageCache($test_page_url, 'HIT');
        $this->assertSession()
            ->elementNotExists('css', '#menu--shortcuts');
        $this->assertSession()
            ->pageTextNotContains('Shortcuts');
        $this->assertSession()
            ->linkNotExists('Cron');
        // Create a role with access to shortcuts as well as the necessary
        // permissions to see specific shortcuts.
        $site_configuration_role = $this->drupalCreateRole([
            'access navigation',
            'access shortcuts',
            'administer site configuration',
            'access administration pages',
            'configure navigation layout',
        ]);
        // Create two different users with the same role to assert that the second
        // user has a cache hit despite the user cache context, as
        // the returned cache contexts include those from lazy-builder content.
        $site_configuration_user1 = $this->drupalCreateUser();
        $site_configuration_user1->addRole($site_configuration_role)
            ->save();
        $site_configuration_user2 = $this->drupalCreateUser();
        $site_configuration_user2->addRole($site_configuration_role)
            ->save();
        $this->drupalLogin($site_configuration_user1);
        $this->verifyDynamicPageCache($test_page_url, 'MISS');
        $this->verifyDynamicPageCache($test_page_url, 'HIT');
        $this->assertCacheContexts([
            'user',
            'url.query_args:_wrapper_format',
            'session',
        ]);
        $this->assertSession()
            ->elementExists('css', '#menu--shortcuts');
        $this->assertSession()
            ->pageTextContains('Shortcuts');
        $this->assertSession()
            ->linkExists('Cron');
        $this->drupalLogin($site_configuration_user2);
        $this->verifyDynamicPageCache($test_page_url, 'HIT');
        $this->assertCacheContexts([
            'user',
            'url.query_args:_wrapper_format',
            'session',
        ]);
        $this->assertSession()
            ->pageTextContains('Shortcuts');
        $this->assertSession()
            ->linkExists('Cron');
        // Add another shortcut.
        $shortcut = Shortcut::create([
            'shortcut_set' => 'default',
            'title' => 'Llama',
            'weight' => 0,
            'link' => [
                [
                    'uri' => 'internal:/admin/config',
                ],
            ],
        ]);
        $shortcut->save();
        // The shortcuts are displayed in a lazy builder, so the page is still a
        // cache HIT but shows the new shortcut immediately.
        $this->verifyDynamicPageCache($test_page_url, 'HIT');
        $this->assertSession()
            ->linkExists('Cron');
        $this->assertSession()
            ->linkExists('Llama');
        // Update the shortcut title and assert that it is updated.
        $shortcut->set('title', 'Alpaca');
        $shortcut->save();
        $this->verifyDynamicPageCache($test_page_url, 'HIT');
        $this->assertSession()
            ->linkExists('Cron');
        $this->assertSession()
            ->linkExists('Alpaca');
        // Delete the shortcut and assert that the link is gone.
        $shortcut->delete();
        $this->verifyDynamicPageCache($test_page_url, 'HIT');
        $this->assertSession()
            ->linkExists('Cron');
        $this->assertSession()
            ->linkNotExists('Alpaca');
        // Add a new Shortcut Set with a single link.
        $new_set = ShortcutSet::create([
            'id' => 'llama-set',
            'label' => 'Llama Set',
        ]);
        $new_set->save();
        $new_shortcut = Shortcut::create([
            'shortcut_set' => 'llama-set',
            'title' => 'New Llama',
            'weight' => 0,
            'link' => [
                [
                    'uri' => 'internal:/admin/config',
                ],
            ],
        ]);
        $new_shortcut->save();
        // Assign the new shortcut set to user 2 and confirm that links are changed
        // automatically.
        \Drupal::entityTypeManager()->getStorage('shortcut_set')
            ->assignUser($new_set, $site_configuration_user2);
        $this->verifyDynamicPageCache($test_page_url, 'HIT');
        $this->assertSession()
            ->linkExists('Cron');
        $this->assertSession()
            ->linkExists('New Llama');
        // Confirm that links for user 1 have not been affected.
        $this->drupalLogin($site_configuration_user1);
        $this->verifyDynamicPageCache($test_page_url, 'HIT');
        $this->assertSession()
            ->linkExists('Cron');
        $this->assertSession()
            ->linkNotExists('New Llama');
        // Confirm that removing assignment automatically changes the links too.
        $this->drupalLogin($site_configuration_user2);
        $this->verifyDynamicPageCache($test_page_url, 'HIT');
        $this->assertSession()
            ->linkExists('Cron');
        $this->assertSession()
            ->linkExists('New Llama');
        \Drupal::entityTypeManager()->getStorage('shortcut_set')
            ->unassignUser($site_configuration_user2);
        $this->verifyDynamicPageCache($test_page_url, 'HIT');
        $this->assertSession()
            ->linkExists('Cron');
        $this->assertSession()
            ->linkNotExists('New Llama');
        // Confirm that deleting a shortcut set automatically changes the links too.
        \Drupal::entityTypeManager()->getStorage('shortcut_set')
            ->assignUser($new_set, $site_configuration_user2);
        $this->verifyDynamicPageCache($test_page_url, 'HIT');
        $this->assertSession()
            ->linkExists('Cron');
        $this->assertSession()
            ->linkExists('New Llama');
        \Drupal::entityTypeManager()->getStorage('shortcut_set')
            ->delete([
            $new_set,
        ]);
        $this->verifyDynamicPageCache($test_page_url, 'HIT');
        $this->assertSession()
            ->linkExists('Cron');
        $this->assertSession()
            ->linkNotExists('New Llama');
        // Verify that block disappears gracefully when shortcut module is disabled.
        // Shortcut entities has to be removed first.
        $link_storage = \Drupal::entityTypeManager()->getStorage('shortcut');
        $link_storage->delete($link_storage->loadMultiple());
        \Drupal::service('module_installer')->uninstall([
            'shortcut',
        ]);
        $this->verifyDynamicPageCache($test_page_url, 'MISS');
        $this->assertSession()
            ->statusCodeEquals(200);
        $this->assertSession()
            ->pageTextNotContains('Shortcuts');
        // Confirm that Navigation Blocks page is working.
        // @see https://www.drupal.org/project/drupal/issues/3445184
        $this->drupalGet('/admin/config/user-interface/navigation-block');
        $this->assertSession()
            ->statusCodeEquals(200);
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Member alias Overriden Title Overrides
AssertPageCacheContextsAndTagsTrait::assertCacheContext protected function Asserts whether an expected cache context was present in the last response.
AssertPageCacheContextsAndTagsTrait::assertCacheContexts protected function Ensures that some cache contexts are present in the current response.
AssertPageCacheContextsAndTagsTrait::assertCacheMaxAge protected function Asserts the max age header.
AssertPageCacheContextsAndTagsTrait::assertCacheTags protected function Ensures that some cache tags are present in the current response.
AssertPageCacheContextsAndTagsTrait::assertNoCacheContext protected function Asserts that a cache context was not present in the last response.
AssertPageCacheContextsAndTagsTrait::assertPageCacheContextsAndTags protected function Asserts page cache miss, then hit for the given URL; checks cache headers.
AssertPageCacheContextsAndTagsTrait::enablePageCaching protected function Enables page caching.
AssertPageCacheContextsAndTagsTrait::getCacheHeaderValues protected function Gets a specific header value as array.
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.
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
NavigationShortcutsBlockTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
NavigationShortcutsBlockTest::$modules protected static property Modules to install. Overrides BrowserTestBase::$modules
NavigationShortcutsBlockTest::testNavigationBlock public function Tests visibility and cacheability of shortcuts in the navigation bar.
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
PageCacheTagsTestBase::setUp protected function Overrides BrowserTestBase::setUp 3
PageCacheTagsTestBase::verifyDynamicPageCache protected function Verify that when loading a given page, it's a page cache hit or miss.
PageCacheTagsTestBase::verifyPageCache protected function Verify that when loading a given page, it's a page cache hit or miss.
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. 4
TestSetupTrait::$tempFilesDirectory protected property The temporary file directory for the test environment.
TestSetupTrait::$testId protected property The test run ID.
TestSetupTrait::changeDatabasePrefix protected function Changes the database connection to the prefixed one.
TestSetupTrait::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
TestSetupTrait::getDatabaseConnection Deprecated public static function Returns the database connection to the site under test.
TestSetupTrait::prepareDatabasePrefix protected function Generates a database prefix for running tests. 1
UiHelperTrait::$loggedInUser protected property The current user logged in using the Mink controlled browser.
UiHelperTrait::$maximumMetaRefreshCount protected property The number of meta refresh redirects to follow, or NULL if unlimited.
UiHelperTrait::$metaRefreshCount protected property The number of meta refresh redirects followed during ::drupalGet().
UiHelperTrait::$useOneTimeLoginLinks protected property Use one-time login links instead of submitting the login form. 3
UiHelperTrait::assertSession public function Returns WebAssert object. 1
UiHelperTrait::buildUrl protected function Builds an absolute URL from a system path or a URL object.
UiHelperTrait::checkForMetaRefresh protected function Checks for meta refresh tag and if found call drupalGet() recursively.
UiHelperTrait::click protected function Clicks the element with the given CSS selector.
UiHelperTrait::clickLink protected function Follows a link by complete name.
UiHelperTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
UiHelperTrait::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
UiHelperTrait::drupalGet protected function Retrieves a Drupal path or an absolute path. 3
UiHelperTrait::drupalLogin protected function Logs in a user using the Mink controlled browser.
UiHelperTrait::drupalLogout protected function Logs a user out of the Mink controlled browser and confirms.
UiHelperTrait::drupalResetSession protected function Resets the current active session back to Anonymous session.
UiHelperTrait::drupalUserIsLoggedIn protected function Returns whether a given user account is logged in.
UiHelperTrait::getAbsoluteUrl protected function Takes a path and returns an absolute path.
UiHelperTrait::getTextContent protected function Retrieves the plain-text content from the current page.
UiHelperTrait::getUrl protected function Get the current URL from the browser.
UiHelperTrait::isTestUsingGuzzleClient protected function Determines if test is using DrupalTestBrowser.
UiHelperTrait::prepareRequest protected function Prepare for a request to testing site. 1
UiHelperTrait::submitForm protected function Fills and submits a form.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole protected function Creates an administrative role.
UserCreationTrait::createRole protected function Creates a role with specified permissions. Aliased as: drupalCreateRole
UserCreationTrait::createUser protected function Create a user with a given set of permissions. Aliased as: drupalCreateUser
UserCreationTrait::grantPermissions protected function Grant permissions to a user role.
UserCreationTrait::setCurrentUser protected function Switch the current logged in user.
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user.
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.