class ToolbarAdminMenuTest

Same name in other branches
  1. 8.9.x core/modules/toolbar/tests/src/Functional/ToolbarAdminMenuTest.php \Drupal\Tests\toolbar\Functional\ToolbarAdminMenuTest
  2. 10 core/modules/toolbar/tests/src/Functional/ToolbarAdminMenuTest.php \Drupal\Tests\toolbar\Functional\ToolbarAdminMenuTest
  3. 11.x core/modules/toolbar/tests/src/Functional/ToolbarAdminMenuTest.php \Drupal\Tests\toolbar\Functional\ToolbarAdminMenuTest

Tests the caching of the admin menu subtree items.

The cache of the admin menu subtree items will be invalidated if the following hooks are invoked.

toolbar_modules_enabled() toolbar_modules_disabled() toolbar_menu_link_update() toolbar_user_update() toolbar_user_role_update()

Each hook invocation is simulated and then the previous hash of the admin menu subtrees is compared to the new hash.

@group toolbar

Hierarchy

Expanded class hierarchy of ToolbarAdminMenuTest

File

core/modules/toolbar/tests/src/Functional/ToolbarAdminMenuTest.php, line 30

Namespace

Drupal\Tests\toolbar\Functional
View source
class ToolbarAdminMenuTest extends BrowserTestBase {
    
    /**
     * A user with permission to access the administrative toolbar.
     *
     * @var \Drupal\user\UserInterface
     */
    protected $adminUser;
    
    /**
     * A second user with permission to access the administrative toolbar.
     *
     * @var \Drupal\user\UserInterface
     */
    protected $adminUser2;
    
    /**
     * The current admin menu subtrees hash for adminUser.
     *
     * @var string
     */
    protected $hash;
    
    /**
     * Modules to enable.
     *
     * @var array
     */
    protected static $modules = [
        'node',
        'block',
        'menu_ui',
        'user',
        'taxonomy',
        'toolbar',
        'language',
        'test_page_test',
        'locale',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $perms = [
            'access toolbar',
            'access administration pages',
            'administer site configuration',
            'bypass node access',
            'administer themes',
            'administer nodes',
            'access content overview',
            'administer blocks',
            'administer menu',
            'administer modules',
            'administer permissions',
            'administer users',
            'access user profiles',
            'administer taxonomy',
            'administer languages',
            'translate interface',
        ];
        // Create an administrative user and log it in.
        $this->adminUser = $this->drupalCreateUser($perms);
        $this->adminUser2 = $this->drupalCreateUser($perms);
        $this->drupalLogin($this->adminUser);
        $this->drupalGet('test-page');
        $this->assertSession()
            ->statusCodeEquals(200);
        // Assert that the toolbar is present in the HTML.
        $this->assertSession()
            ->responseContains('id="toolbar-administration"');
        // Store the adminUser admin menu subtrees hash for comparison later.
        $this->hash = $this->getSubtreesHash();
    }
    
    /**
     * Tests Toolbar's responses to installing and uninstalling modules.
     *
     * @see toolbar_modules_installed()
     * @see toolbar_modules_uninstalled()
     */
    public function testModuleStatusChangeSubtreesHashCacheClear() {
        // Use an admin role to ensure the user has all available permissions. This
        // results in the admin menu links changing as the taxonomy module is
        // installed and uninstalled because the role will always have the
        // 'administer taxonomy' permission if it exists.
        $role = Role::load($this->createRole([]));
        $role->setIsAdmin(TRUE);
        $role->save();
        $this->adminUser
            ->addRole($role->id());
        $this->adminUser
            ->save();
        // Uninstall a module.
        $edit = [];
        $edit['uninstall[taxonomy]'] = TRUE;
        $this->drupalGet('admin/modules/uninstall');
        $this->submitForm($edit, 'Uninstall');
        // Confirm the uninstall form.
        $this->submitForm([], 'Uninstall');
        $this->rebuildContainer();
        // Assert that the subtrees hash has been altered because the subtrees
        // structure changed.
        $this->assertDifferentHash();
        // Enable a module.
        $edit = [];
        $edit['modules[taxonomy][enable]'] = TRUE;
        $this->drupalGet('admin/modules');
        $this->submitForm($edit, 'Install');
        $this->rebuildContainer();
        // Assert that the subtrees hash has been altered because the subtrees
        // structure changed.
        $this->assertDifferentHash();
    }
    
    /**
     * Tests toolbar cache tags implementation.
     */
    public function testMenuLinkUpdateSubtreesHashCacheClear() {
        // The ID of (any) admin menu link.
        $admin_menu_link_id = 'system.admin_config_development';
        // Disable the link.
        $edit = [];
        $edit['enabled'] = FALSE;
        $this->drupalGet("admin/structure/menu/link/" . $admin_menu_link_id . "/edit");
        $this->submitForm($edit, 'Save');
        $this->assertSession()
            ->statusCodeEquals(200);
        $this->assertSession()
            ->pageTextContains('The menu link has been saved.');
        // Assert that the subtrees hash has been altered because the subtrees
        // structure changed.
        $this->assertDifferentHash();
    }
    
    /**
     * Tests Toolbar's responses to user data updates.
     *
     * @see toolbar_user_role_update()
     * @see toolbar_user_update()
     */
    public function testUserRoleUpdateSubtreesHashCacheClear() {
        // Find the new role ID.
        $all_rids = $this->adminUser
            ->getRoles();
        unset($all_rids[array_search(RoleInterface::AUTHENTICATED_ID, $all_rids)]);
        $rid = reset($all_rids);
        $edit = [];
        $edit[$rid . '[administer taxonomy]'] = FALSE;
        $this->drupalGet('admin/people/permissions');
        $this->submitForm($edit, 'Save permissions');
        // Assert that the subtrees hash has been altered because the subtrees
        // structure changed.
        $this->assertDifferentHash();
        // Test that assigning a user an extra role only affects that single user.
        // Get the hash for a second user.
        $this->drupalLogin($this->adminUser2);
        $this->drupalGet('test-page');
        $this->assertSession()
            ->statusCodeEquals(200);
        // Assert that the toolbar is present in the HTML.
        $this->assertSession()
            ->responseContains('id="toolbar-administration"');
        $admin_user_2_hash = $this->getSubtreesHash();
        // Log in the first admin user again.
        $this->drupalLogin($this->adminUser);
        $this->drupalGet('test-page');
        $this->assertSession()
            ->statusCodeEquals(200);
        // Assert that the toolbar is present in the HTML.
        $this->assertSession()
            ->responseContains('id="toolbar-administration"');
        $this->hash = $this->getSubtreesHash();
        $rid = $this->drupalCreateRole([
            'administer content types',
        ]);
        // Assign the role to the user.
        $this->drupalGet('user/' . $this->adminUser
            ->id() . '/edit');
        $this->submitForm([
            "roles[{$rid}]" => $rid,
        ], 'Save');
        $this->assertSession()
            ->pageTextContains('The changes have been saved.');
        // Assert that the subtrees hash has been altered because the subtrees
        // structure changed.
        $this->assertDifferentHash();
        // Log in the second user again and assert that their subtrees hash did not
        // change.
        $this->drupalLogin($this->adminUser2);
        // Request a new page to refresh the drupalSettings object.
        $this->drupalGet('test-page');
        $this->assertSession()
            ->statusCodeEquals(200);
        $new_subtree_hash = $this->getSubtreesHash();
        // Assert that the old admin menu subtree hash and the new admin menu
        // subtree hash are the same.
        $this->assertNotEmpty($new_subtree_hash, 'A valid hash value for the admin menu subtrees was created.');
        $this->assertEquals($admin_user_2_hash, $new_subtree_hash, 'The user-specific subtree menu hash has not been updated.');
    }
    
    /**
     * Tests cache invalidation when one user modifies another user.
     */
    public function testNonCurrentUserAccountUpdates() {
        $admin_user_id = $this->adminUser
            ->id();
        $this->hash = $this->getSubtreesHash();
        // adminUser2 will add a role to adminUser.
        $this->drupalLogin($this->adminUser2);
        $rid = $this->drupalCreateRole([
            'administer content types',
        ]);
        // Get the subtree hash for adminUser2 to check later that it has not
        // changed. Request a new page to refresh the drupalSettings object.
        $this->drupalGet('test-page');
        $this->assertSession()
            ->statusCodeEquals(200);
        $admin_user_2_hash = $this->getSubtreesHash();
        // Assign the role to the user.
        $this->drupalGet('user/' . $admin_user_id . '/edit');
        $this->submitForm([
            "roles[{$rid}]" => $rid,
        ], 'Save');
        $this->assertSession()
            ->pageTextContains('The changes have been saved.');
        // Log in adminUser and assert that the subtrees hash has changed.
        $this->drupalLogin($this->adminUser);
        $this->assertDifferentHash();
        // Log in adminUser2 to check that its subtrees hash has not changed.
        $this->drupalLogin($this->adminUser2);
        $new_subtree_hash = $this->getSubtreesHash();
        // Assert that the old adminUser subtree hash and the new adminUser
        // subtree hash are the same.
        $this->assertNotEmpty($new_subtree_hash, 'A valid hash value for the admin menu subtrees was created.');
        $this->assertEquals($new_subtree_hash, $admin_user_2_hash, 'The user-specific subtree menu hash has not been updated.');
    }
    
    /**
     * Tests that toolbar cache is cleared when string translations are made.
     */
    public function testLocaleTranslationSubtreesHashCacheClear() {
        $admin_user = $this->adminUser;
        // User to translate and delete string.
        $translate_user = $this->drupalCreateUser([
            'translate interface',
            'access administration pages',
        ]);
        // Create a new language with the langcode 'xx'.
        $langcode = 'xx';
        // The English name for the language. This will be translated.
        $name = $this->randomMachineName(16);
        // This will be the translation of $name.
        $translation = $this->randomMachineName(16);
        // Add custom language.
        $this->drupalLogin($admin_user);
        $edit = [
            'predefined_langcode' => 'custom',
            'langcode' => $langcode,
            'label' => $name,
            'direction' => LanguageInterface::DIRECTION_LTR,
        ];
        $this->drupalGet('admin/config/regional/language/add');
        $this->submitForm($edit, 'Add custom language');
        t($name, [], [
            'langcode' => $langcode,
        ]);
        // Reset locale cache.
        $this->container
            ->get('string_translation')
            ->reset();
        $this->assertSession()
            ->responseContains('"edit-languages-' . $langcode . '-weight"');
        // Verify that the test language was added.
        $this->assertSession()
            ->pageTextContains($name);
        // Have the adminUser request a page in the new language.
        $this->drupalGet($langcode . '/test-page');
        $this->assertSession()
            ->statusCodeEquals(200);
        // Get a baseline hash for the admin menu subtrees before translating one
        // of the menu link items.
        $original_subtree_hash = $this->getSubtreesHash();
        $this->assertNotEmpty($original_subtree_hash, 'A valid hash value for the admin menu subtrees was created.');
        $this->drupalLogout();
        // Translate the string 'Search and metadata' in the xx language. This
        // string appears in a link in the admin menu subtrees. Changing the string
        // should create a new menu hash if the toolbar subtrees cache is correctly
        // invalidated.
        $this->drupalLogin($translate_user);
        $search = [
            'string' => 'Search and metadata',
            'langcode' => $langcode,
            'translation' => 'untranslated',
        ];
        $this->drupalGet('admin/config/regional/translate');
        $this->submitForm($search, 'Filter');
        $this->assertSession()
            ->pageTextNotContains('No strings available');
        // Verify that search found the string as untranslated.
        $this->assertSession()
            ->pageTextContains($name);
        // Assume this is the only result.
        // Translate the string to a random string.
        $textarea = $this->assertSession()
            ->elementExists('xpath', '//textarea');
        $lid = (string) $textarea->getAttribute('name');
        $edit = [
            $lid => $translation,
        ];
        $this->drupalGet('admin/config/regional/translate');
        $this->submitForm($edit, 'Save translations');
        $this->assertSession()
            ->pageTextContains('The strings have been saved.');
        // Verify that the user is redirected to the correct page.
        $this->assertSession()
            ->addressEquals(Url::fromRoute('locale.translate_page'));
        $this->drupalLogout();
        // Log in the adminUser. Check the admin menu subtrees hash now that one
        // of the link items in the Structure tree (Menus) has had its text
        // translated.
        $this->drupalLogin($admin_user);
        // Have the adminUser request a page in the new language.
        $this->drupalGet($langcode . '/test-page');
        $this->assertSession()
            ->statusCodeEquals(200);
        $new_subtree_hash = $this->getSubtreesHash();
        // Assert that the old admin menu subtrees hash and the new admin menu
        // subtrees hash are different.
        $this->assertNotEmpty($new_subtree_hash, 'A valid hash value for the admin menu subtrees was created.');
        $this->assertNotEquals($original_subtree_hash, $new_subtree_hash, 'The user-specific subtree menu hash has been updated.');
    }
    
    /**
     * Tests that the 'toolbar/subtrees/{hash}' is reachable and correct.
     */
    public function testSubtreesJsonRequest() {
        $admin_user = $this->adminUser;
        $this->drupalLogin($admin_user);
        // Request a new page to refresh the drupalSettings object.
        $subtrees_hash = $this->getSubtreesHash();
        $this->drupalGet('toolbar/subtrees/' . $subtrees_hash, [
            'query' => [
                MainContentViewSubscriber::WRAPPER_FORMAT => 'drupal_ajax',
            ],
        ], [
            'X-Requested-With: XMLHttpRequest',
        ]);
        $ajax_result = json_decode($this->getSession()
            ->getPage()
            ->getContent(), TRUE);
        $this->assertEquals('setToolbarSubtrees', $ajax_result[0]['command'], 'Subtrees response uses the correct command.');
        $this->assertEquals([
            'system-admin_content',
            'system-admin_structure',
            'system-themes_page',
            'system-modules_list',
            'system-admin_config',
            'entity-user-collection',
            'front',
        ], array_keys($ajax_result[0]['subtrees']), 'Correct subtrees returned.');
    }
    
    /**
     * Tests that subtrees hashes vary by the language of the page.
     */
    public function testLanguageSwitching() {
        // Create a new language with the langcode 'xx'.
        $langcode = 'xx';
        $language = ConfigurableLanguage::createFromLangcode($langcode);
        $language->save();
        // The language path processor is just registered for more than one
        // configured language, so rebuild the container now that we are
        // multilingual.
        $this->rebuildContainer();
        // Get a page with the new language langcode in the URL.
        $this->drupalGet('test-page', [
            'language' => $language,
        ]);
        // Assert different hash.
        $new_subtree_hash = $this->getSubtreesHash();
        // Assert that the old admin menu subtree hash and the new admin menu
        // subtree hash are different.
        $this->assertNotEmpty($new_subtree_hash, 'A valid hash value for the admin menu subtrees was created.');
        $this->assertNotEquals($this->hash, $new_subtree_hash, 'The user-specific subtree menu hash has been updated.');
    }
    
    /**
     * Tests that back to site link exists on admin pages, not on content pages.
     */
    public function testBackToSiteLink() {
        // Back to site link should exist in the markup.
        $this->drupalGet('test-page');
        $back_link = $this->cssSelect('.home-toolbar-tab');
        $this->assertNotEmpty($back_link);
    }
    
    /**
     * Tests that external links added to the menu appear in the toolbar.
     */
    public function testExternalLink() {
        $edit = [
            'title[0][value]' => 'External URL',
            'link[0][uri]' => 'http://example.org',
            'menu_parent' => 'admin:system.admin',
            'description[0][value]' => 'External URL & escaped',
        ];
        $this->drupalGet('admin/structure/menu/manage/admin/add');
        $this->submitForm($edit, 'Save');
        // Assert that the new menu link is shown on the menu link listing.
        $this->drupalGet('admin/structure/menu/manage/admin');
        $this->assertSession()
            ->pageTextContains('External URL');
        // Assert that the new menu link is shown in the toolbar on a regular page.
        $this->drupalGet(Url::fromRoute('<front>'));
        $this->assertSession()
            ->pageTextContains('External URL');
        // Ensure the description is escaped as expected.
        $this->assertSession()
            ->responseContains('title="External URL &amp; escaped"');
    }
    
    /**
     * Get the hash value from the admin menu subtrees route path.
     *
     * @return string
     *   The hash value from the admin menu subtrees route path.
     */
    private function getSubtreesHash() {
        $settings = $this->getDrupalSettings();
        // The toolbar module defines a route '/toolbar/subtrees/{hash}' that
        // returns JSON for the rendered subtrees. This hash is provided to the
        // client in drupalSettings.
        return $settings['toolbar']['subtreesHash'];
    }
    
    /**
     * Checks the subtree hash of the current page with that of the previous page.
     *
     * Asserts that the subtrees hash on a fresh page GET is different from the
     * subtree hash from the previous page GET.
     *
     * @internal
     */
    private function assertDifferentHash() : void {
        // Request a new page to refresh the drupalSettings object.
        $this->drupalGet('test-page');
        $this->assertSession()
            ->statusCodeEquals(200);
        $new_subtree_hash = $this->getSubtreesHash();
        // Assert that the old admin menu subtree hash and the new admin menu
        // subtree hash are different.
        $this->assertNotEmpty($new_subtree_hash, 'A valid hash value for the admin menu subtrees was created.');
        $this->assertNotEquals($this->hash, $new_subtree_hash, 'The user-specific subtree menu hash has been updated.');
        // Save the new subtree hash as the original.
        $this->hash = $new_subtree_hash;
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Member alias Overriden Title Overrides
AssertLegacyTrait::assert Deprecated protected function
AssertLegacyTrait::assertCacheTag Deprecated protected function Asserts whether an expected cache tag was present in the last response.
AssertLegacyTrait::assertElementNotPresent Deprecated protected function Asserts that the element with the given CSS selector is not present.
AssertLegacyTrait::assertElementPresent Deprecated protected function Asserts that the element with the given CSS selector is present.
AssertLegacyTrait::assertEqual Deprecated protected function
AssertLegacyTrait::assertEscaped Deprecated protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertLegacyTrait::assertField Deprecated protected function Asserts that a field exists with the given name or ID.
AssertLegacyTrait::assertFieldById Deprecated protected function Asserts that a field exists with the given ID and value.
AssertLegacyTrait::assertFieldByName Deprecated protected function Asserts that a field exists with the given name and value.
AssertLegacyTrait::assertFieldByXPath Deprecated protected function Asserts that a field exists in the current page by the given XPath.
AssertLegacyTrait::assertFieldChecked Deprecated protected function Asserts that a checkbox field in the current page is checked.
AssertLegacyTrait::assertFieldsByValue Deprecated protected function Asserts that a field exists in the current page with a given Xpath result.
AssertLegacyTrait::assertHeader Deprecated protected function Checks that current response header equals value.
AssertLegacyTrait::assertIdentical Deprecated protected function
AssertLegacyTrait::assertIdenticalObject Deprecated protected function
AssertLegacyTrait::assertLink Deprecated protected function Passes if a link with the specified label is found.
AssertLegacyTrait::assertLinkByHref Deprecated protected function Passes if a link containing a given href (part) is found.
AssertLegacyTrait::assertNoCacheTag Deprecated protected function Asserts whether an expected cache tag was absent in the last response.
AssertLegacyTrait::assertNoEscaped Deprecated protected function Passes if the raw text is not found escaped on the loaded page.
AssertLegacyTrait::assertNoField Deprecated protected function Asserts that a field does NOT exist with the given name or ID.
AssertLegacyTrait::assertNoFieldById Deprecated protected function Asserts that a field does not exist with the given ID and value.
AssertLegacyTrait::assertNoFieldByName Deprecated protected function Asserts that a field does not exist with the given name and value.
AssertLegacyTrait::assertNoFieldByXPath Deprecated protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertLegacyTrait::assertNoFieldChecked Deprecated protected function Asserts that a checkbox field in the current page is not checked.
AssertLegacyTrait::assertNoLink Deprecated protected function Passes if a link with the specified label is not found.
AssertLegacyTrait::assertNoLinkByHref Deprecated protected function Passes if a link containing a given href (part) is not found.
AssertLegacyTrait::assertNoOption Deprecated protected function Asserts that a select option does NOT exist in the current page.
AssertLegacyTrait::assertNoPattern Deprecated protected function Triggers a pass if the Perl regex pattern is not found in the raw content.
AssertLegacyTrait::assertNoRaw Deprecated protected function Passes if the raw text IS not found on the loaded page, fail otherwise.
AssertLegacyTrait::assertNotEqual Deprecated protected function
AssertLegacyTrait::assertNoText Deprecated protected function Passes if the page (with HTML stripped) does not contains the text.
AssertLegacyTrait::assertNotIdentical Deprecated protected function
AssertLegacyTrait::assertNoUniqueText Deprecated protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertLegacyTrait::assertOption Deprecated protected function Asserts that a select option in the current page exists.
AssertLegacyTrait::assertOptionByText Deprecated protected function Asserts that a select option with the visible text exists.
AssertLegacyTrait::assertOptionSelected Deprecated protected function Asserts that a select option in the current page is checked.
AssertLegacyTrait::assertPattern Deprecated protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertLegacyTrait::assertRaw Deprecated protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertLegacyTrait::assertResponse Deprecated protected function Asserts the page responds with the specified response code.
AssertLegacyTrait::assertText Deprecated protected function Passes if the page (with HTML stripped) contains the text.
AssertLegacyTrait::assertTextHelper Deprecated protected function Helper for assertText and assertNoText.
AssertLegacyTrait::assertTitle Deprecated protected function Pass if the page title is the given string.
AssertLegacyTrait::assertUniqueText Deprecated protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertLegacyTrait::assertUrl Deprecated protected function Passes if the internal browser&#039;s URL matches the given path.
AssertLegacyTrait::buildXPathQuery Deprecated protected function Builds an XPath query.
AssertLegacyTrait::constructFieldXpath Deprecated protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertLegacyTrait::getAllOptions Deprecated protected function Get all option elements, including nested options, in a select.
AssertLegacyTrait::getRawContent Deprecated protected function Gets the current raw content.
AssertLegacyTrait::pass Deprecated protected function
AssertLegacyTrait::verbose Deprecated protected function
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 drupal_rewrite_settings().
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. 37
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 Simpletest environment.
BrowserTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
BrowserTestBase::drupalGetHeader Deprecated protected function Gets the value of an HTTP response header.
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 Simpletest site. 1
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::__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 &#039;apcu_ensure_unique_prefix&#039; setting. 1
FunctionalTestSetupTrait::$classLoader protected property The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$rootUser protected property The &quot;#1&quot; admin user.
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.
FunctionalTestSetupTrait::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. 1
FunctionalTestSetupTrait::installParameters protected function Returns the parameters that will be used when Simpletest installs Drupal. 8
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 22
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. 3
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
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::$randomGenerator protected property The random generator.
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. 1
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 public function Callback for random string validation.
RefreshVariablesTrait::refreshVariables protected function Refreshes in-memory configuration and state information. 1
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 private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements 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. 1
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. 1
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 public static function Returns the database connection to the site running Simpletest.
TestSetupTrait::prepareDatabasePrefix protected function Generates a database prefix for running tests. 1
ToolbarAdminMenuTest::$adminUser protected property A user with permission to access the administrative toolbar.
ToolbarAdminMenuTest::$adminUser2 protected property A second user with permission to access the administrative toolbar.
ToolbarAdminMenuTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
ToolbarAdminMenuTest::$hash protected property The current admin menu subtrees hash for adminUser.
ToolbarAdminMenuTest::$modules protected static property Modules to enable. Overrides BrowserTestBase::$modules
ToolbarAdminMenuTest::assertDifferentHash private function Checks the subtree hash of the current page with that of the previous page.
ToolbarAdminMenuTest::getSubtreesHash private function Get the hash value from the admin menu subtrees route path.
ToolbarAdminMenuTest::setUp protected function Overrides BrowserTestBase::setUp
ToolbarAdminMenuTest::testBackToSiteLink public function Tests that back to site link exists on admin pages, not on content pages.
ToolbarAdminMenuTest::testExternalLink public function Tests that external links added to the menu appear in the toolbar.
ToolbarAdminMenuTest::testLanguageSwitching public function Tests that subtrees hashes vary by the language of the page.
ToolbarAdminMenuTest::testLocaleTranslationSubtreesHashCacheClear public function Tests that toolbar cache is cleared when string translations are made.
ToolbarAdminMenuTest::testMenuLinkUpdateSubtreesHashCacheClear public function Tests toolbar cache tags implementation.
ToolbarAdminMenuTest::testModuleStatusChangeSubtreesHashCacheClear public function Tests Toolbar&#039;s responses to installing and uninstalling modules.
ToolbarAdminMenuTest::testNonCurrentUserAccountUpdates public function Tests cache invalidation when one user modifies another user.
ToolbarAdminMenuTest::testSubtreesJsonRequest public function Tests that the &#039;toolbar/subtrees/{hash}&#039; is reachable and correct.
ToolbarAdminMenuTest::testUserRoleUpdateSubtreesHashCacheClear public function Tests Toolbar&#039;s responses to user data updates.
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::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. 2
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::drupalPostForm Deprecated protected function Executes a form submission.
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.