class LocalTasksTest

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

Tests local tasks derived from router and added/altered via hooks.

@group Menu

Hierarchy

Expanded class hierarchy of LocalTasksTest

File

core/modules/system/tests/src/Functional/Menu/LocalTasksTest.php, line 14

Namespace

Drupal\Tests\system\Functional\Menu
View source
class LocalTasksTest extends BrowserTestBase {
    
    /**
     * Modules to enable.
     *
     * @var string[]
     */
    protected static $modules = [
        'block',
        'menu_test',
        'entity_test',
        'node',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'starterkit_theme';
    
    /**
     * The local tasks block under testing.
     *
     * @var \Drupal\block\Entity\Block
     */
    protected $sut;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->sut = $this->drupalPlaceBlock('local_tasks_block', [
            'id' => 'tabs_block',
        ]);
    }
    
    /**
     * Asserts local tasks in the page output.
     *
     * @param array $routes
     *   A list of expected local tasks, prepared as an array of route names and
     *   their associated route parameters, to assert on the page (in the given
     *   order).
     * @param int $level
     *   (optional) The local tasks level to assert; 0 for primary, 1 for
     *   secondary. Defaults to 0.
     *
     * @internal
     */
    protected function assertLocalTasks(array $routes, int $level = 0) : void {
        $elements = $this->xpath('//*[contains(@class, :class)]//a', [
            ':class' => $level == 0 ? 'tabs primary' : 'tabs secondary',
        ]);
        $this->assertGreaterThan(0, count($elements), 'Local tasks found.');
        foreach ($routes as $index => $route_info) {
            [
                $route_name,
                $route_parameters,
            ] = $route_info;
            $expected = Url::fromRoute($route_name, $route_parameters)->toString();
            $this->assertEquals($expected, $elements[$index]->getAttribute('href'), "Task " . ($index + 1) . "number href " . $elements[$index]->getAttribute('href') . " equals {$expected}.");
        }
        $this->assertEquals(count($routes), count($elements), 'Only expected local tasks are found.');
    }
    
    /**
     * Ensures that some local task appears.
     *
     * @param string $title
     *   The expected title.
     *
     * @internal
     */
    protected function assertLocalTaskAppears(string $title) : void {
        // SimpleXML gives us the unescaped text, not the actual escaped markup,
        // so use a pattern instead to check the raw content.
        // This behavior is a bug in libxml, see
        // https://bugs.php.net/bug.php?id=49437.
        $this->assertSession()
            ->responseMatches('@<a [^>]*>' . preg_quote($title, '@') . '</a>@');
    }
    
    /**
     * Asserts that the local tasks on the specified level are not being printed.
     *
     * @param int $level
     *   (optional) The local tasks level to assert; 0 for primary, 1 for
     *   secondary. Defaults to 0.
     *
     * @internal
     */
    protected function assertNoLocalTasks(int $level = 0) : void {
        $this->assertSession()
            ->elementNotExists('xpath', '//*[contains(@class, "' . ($level == 0 ? 'tabs primary' : 'tabs secondary') . '")]//a');
    }
    
    /**
     * Tests the plugin based local tasks.
     */
    public function testPluginLocalTask() {
        // Verify local tasks defined in the hook.
        $this->drupalGet(Url::fromRoute('menu_test.tasks_default'));
        $this->assertLocalTasks([
            [
                'menu_test.tasks_default',
                [],
            ],
            [
                'menu_test.router_test1',
                [
                    'bar' => 'unsafe',
                ],
            ],
            [
                'menu_test.router_test1',
                [
                    'bar' => '1',
                ],
            ],
            [
                'menu_test.router_test2',
                [
                    'bar' => '2',
                ],
            ],
        ]);
        // Verify that script tags are escaped on output.
        $title = Html::escape("Task 1 <script>alert('Welcome to the jungle!')</script>");
        $this->assertLocalTaskAppears($title);
        $title = Html::escape("<script>alert('Welcome to the derived jungle!')</script>");
        $this->assertLocalTaskAppears($title);
        // Verify that local tasks appear as defined in the router.
        $this->drupalGet(Url::fromRoute('menu_test.local_task_test_tasks_view'));
        $this->assertLocalTasks([
            [
                'menu_test.local_task_test_tasks_view',
                [],
            ],
            [
                'menu_test.local_task_test_tasks_edit',
                [],
            ],
            [
                'menu_test.local_task_test_tasks_settings',
                [],
            ],
            [
                'menu_test.local_task_test_tasks_settings_dynamic',
                [],
            ],
        ]);
        $title = Html::escape("<script>alert('Welcome to the jungle!')</script>");
        $this->assertLocalTaskAppears($title);
        // Ensure the view tab is active.
        $this->assertSession()
            ->elementsCount('xpath', '//ul[contains(@class, "tabs")]//li[contains(@class, "active")]/a', 1);
        $this->assertSession()
            ->elementTextEquals('xpath', '//ul[contains(@class, "tabs")]//li[contains(@class, "active")]/a', 'View(active tab)');
        // Verify that local tasks in the second level appear.
        $sub_tasks = [
            [
                'menu_test.local_task_test_tasks_settings_sub1',
                [],
            ],
            [
                'menu_test.local_task_test_tasks_settings_sub2',
                [],
            ],
            [
                'menu_test.local_task_test_tasks_settings_sub3',
                [],
            ],
            [
                'menu_test.local_task_test_tasks_settings_derived',
                [
                    'placeholder' => 'derive1',
                ],
            ],
            [
                'menu_test.local_task_test_tasks_settings_derived',
                [
                    'placeholder' => 'derive2',
                ],
            ],
        ];
        $this->drupalGet(Url::fromRoute('menu_test.local_task_test_tasks_settings'));
        $this->assertLocalTasks($sub_tasks, 1);
        $this->assertSession()
            ->elementsCount('xpath', '//ul[contains(@class, "tabs")]//li[contains(@class, "active")]/a', 1);
        $this->assertSession()
            ->elementTextEquals('xpath', '//ul[contains(@class, "tabs")]//li[contains(@class, "active")]/a', 'Settings(active tab)');
        $this->drupalGet(Url::fromRoute('menu_test.local_task_test_tasks_settings_sub1'));
        $this->assertLocalTasks($sub_tasks, 1);
        $xpath = '//ul[contains(@class, "tabs")]//a[contains(@class, "active")]';
        $this->assertSession()
            ->elementsCount('xpath', $xpath, 2);
        $links = $this->xpath($xpath);
        $this->assertEquals('Settings(active tab)', $links[0]->getText(), 'The settings tab is active.');
        $this->assertEquals('Dynamic title for TestTasksSettingsSub1(active tab)', $links[1]->getText(), 'The sub1 tab is active.');
        $this->assertSession()
            ->responseHeaderContains('X-Drupal-Cache-Tags', 'kittens:ragdoll');
        $this->assertSession()
            ->responseHeaderContains('X-Drupal-Cache-Tags', 'kittens:dwarf-cat');
        $this->drupalGet(Url::fromRoute('menu_test.local_task_test_tasks_settings_derived', [
            'placeholder' => 'derive1',
        ]));
        $this->assertLocalTasks($sub_tasks, 1);
        $result = $this->xpath('//ul[contains(@class, "tabs")]//li[contains(@class, "active")]');
        $this->assertCount(2, $result, 'There are tabs active on both levels.');
        $this->assertEquals('Settings(active tab)', $result[0]->getText(), 'The settings tab is active.');
        $this->assertEquals('Derive 1(active tab)', $result[1]->getText(), 'The derive1 tab is active.');
        // Ensures that the local tasks contains the proper 'provider key'
        $definitions = $this->container
            ->get('plugin.manager.menu.local_task')
            ->getDefinitions();
        $this->assertEquals('menu_test', $definitions['menu_test.local_task_test_tasks_view']['provider']);
        $this->assertEquals('menu_test', $definitions['menu_test.local_task_test_tasks_edit']['provider']);
        $this->assertEquals('menu_test', $definitions['menu_test.local_task_test_tasks_settings']['provider']);
        $this->assertEquals('menu_test', $definitions['menu_test.local_task_test_tasks_settings_sub1']['provider']);
        $this->assertEquals('menu_test', $definitions['menu_test.local_task_test_tasks_settings_sub2']['provider']);
        $this->assertEquals('menu_test', $definitions['menu_test.local_task_test_tasks_settings_sub3']['provider']);
        // Test that we correctly apply the active class to tabs where one of the
        // request attributes is upcast to an entity object.
        $entity = \Drupal::entityTypeManager()->getStorage('entity_test')
            ->create([
            'bundle' => 'test',
        ]);
        $entity->save();
        $this->drupalGet(Url::fromRoute('menu_test.local_task_test_upcasting_sub1', [
            'entity_test' => '1',
        ]));
        $tasks = [
            [
                'menu_test.local_task_test_upcasting_sub1',
                [
                    'entity_test' => '1',
                ],
            ],
            [
                'menu_test.local_task_test_upcasting_sub2',
                [
                    'entity_test' => '1',
                ],
            ],
        ];
        $this->assertLocalTasks($tasks, 0);
        $this->assertSession()
            ->elementsCount('xpath', '//ul[contains(@class, "tabs")]//li[contains(@class, "active")]', 1);
        $this->assertSession()
            ->elementTextEquals('xpath', '//ul[contains(@class, "tabs")]//li[contains(@class, "active")]', 'upcasting sub1(active tab)');
        $this->drupalGet(Url::fromRoute('menu_test.local_task_test_upcasting_sub2', [
            'entity_test' => '1',
        ]));
        $tasks = [
            [
                'menu_test.local_task_test_upcasting_sub1',
                [
                    'entity_test' => '1',
                ],
            ],
            [
                'menu_test.local_task_test_upcasting_sub2',
                [
                    'entity_test' => '1',
                ],
            ],
        ];
        $this->assertLocalTasks($tasks, 0);
        $this->assertSession()
            ->elementsCount('xpath', '//ul[contains(@class, "tabs")]//li[contains(@class, "active")]', 1);
        $this->assertSession()
            ->elementTextEquals('xpath', '//ul[contains(@class, "tabs")]//li[contains(@class, "active")]', 'upcasting sub2(active tab)');
    }
    
    /**
     * Tests that local task blocks are configurable to show a specific level.
     */
    public function testLocalTaskBlock() {
        // Remove the default block and create a new one.
        $this->sut
            ->delete();
        $this->sut = $this->drupalPlaceBlock('local_tasks_block', [
            'id' => 'tabs_block',
            'primary' => TRUE,
            'secondary' => FALSE,
        ]);
        $this->drupalGet(Url::fromRoute('menu_test.local_task_test_tasks_settings'));
        // Verify that local tasks in the first level appear.
        $this->assertLocalTasks([
            [
                'menu_test.local_task_test_tasks_view',
                [],
            ],
            [
                'menu_test.local_task_test_tasks_edit',
                [],
            ],
            [
                'menu_test.local_task_test_tasks_settings',
                [],
            ],
            [
                'menu_test.local_task_test_tasks_settings_dynamic',
                [],
            ],
        ]);
        // Verify that local tasks in the second level doesn't appear.
        $this->assertNoLocalTasks(1);
        $this->sut
            ->delete();
        $this->sut = $this->drupalPlaceBlock('local_tasks_block', [
            'id' => 'tabs_block',
            'primary' => FALSE,
            'secondary' => TRUE,
        ]);
        $this->drupalGet(Url::fromRoute('menu_test.local_task_test_tasks_settings'));
        // Verify that local tasks in the first level doesn't appear.
        $this->assertNoLocalTasks(0);
        // Verify that local tasks in the second level appear.
        $sub_tasks = [
            [
                'menu_test.local_task_test_tasks_settings_sub1',
                [],
            ],
            [
                'menu_test.local_task_test_tasks_settings_sub2',
                [],
            ],
            [
                'menu_test.local_task_test_tasks_settings_sub3',
                [],
            ],
            [
                'menu_test.local_task_test_tasks_settings_derived',
                [
                    'placeholder' => 'derive1',
                ],
            ],
            [
                'menu_test.local_task_test_tasks_settings_derived',
                [
                    'placeholder' => 'derive2',
                ],
            ],
        ];
        $this->assertLocalTasks($sub_tasks, 1);
    }
    
    /**
     * Tests that local tasks blocks cache is invalidated correctly.
     */
    public function testLocalTaskBlockCache() {
        $this->drupalLogin($this->rootUser);
        $this->drupalCreateContentType([
            'type' => 'page',
        ]);
        // Only the Edit task. The block avoids showing a single tab.
        $this->drupalGet('/admin/config/people/accounts');
        $this->assertNoLocalTasks();
        // Only the Edit and Manage permission tabs.
        $this->drupalGet('/admin/structure/types/manage/page');
        $this->assertLocalTasks([
            [
                'entity.node_type.edit_form',
                [
                    'node_type' => 'page',
                ],
            ],
            [
                'entity.node_type.entity_permissions_form',
                [
                    'node_type' => 'page',
                ],
            ],
        ]);
        // Field UI adds the usual Manage fields etc tabs.
        \Drupal::service('module_installer')->install([
            'field_ui',
        ]);
        $this->drupalGet('/admin/structure/types/manage/page');
        $this->assertLocalTasks([
            [
                'entity.node_type.edit_form',
                [
                    'node_type' => 'page',
                ],
            ],
            [
                'entity.node.field_ui_fields',
                [
                    'node_type' => 'page',
                ],
            ],
            [
                'entity.entity_form_display.node.default',
                [
                    'node_type' => 'page',
                ],
            ],
            [
                'entity.entity_view_display.node.default',
                [
                    'node_type' => 'page',
                ],
            ],
            [
                'entity.node_type.entity_permissions_form',
                [
                    'node_type' => 'page',
                ],
            ],
        ]);
    }

}

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
LocalTasksTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
LocalTasksTest::$modules protected static property Modules to enable. Overrides BrowserTestBase::$modules
LocalTasksTest::$sut protected property The local tasks block under testing.
LocalTasksTest::assertLocalTaskAppears protected function Ensures that some local task appears.
LocalTasksTest::assertLocalTasks protected function Asserts local tasks in the page output.
LocalTasksTest::assertNoLocalTasks protected function Asserts that the local tasks on the specified level are not being printed.
LocalTasksTest::setUp protected function Overrides BrowserTestBase::setUp
LocalTasksTest::testLocalTaskBlock public function Tests that local task blocks are configurable to show a specific level.
LocalTasksTest::testLocalTaskBlockCache public function Tests that local tasks blocks cache is invalidated correctly.
LocalTasksTest::testPluginLocalTask public function Tests the plugin based local tasks.
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
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.