class ThemeUiTest

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

Tests the theme UI.

@group Theme

Hierarchy

Expanded class hierarchy of ThemeUiTest

File

core/modules/system/tests/src/Functional/Theme/ThemeUiTest.php, line 13

Namespace

Drupal\Tests\system\Functional\Theme
View source
class ThemeUiTest extends BrowserTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * Modules used for testing.
     *
     * @var array
     */
    protected $testModules = [
        'help' => 'Help',
        'test_module_required_by_theme' => 'Test Module Required by Theme',
        'test_another_module_required_by_theme' => 'Test Another Module Required by Theme',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->drupalLogin($this->drupalCreateUser([
            'administer themes',
            'administer modules',
        ]));
    }
    
    /**
     * Tests permissions for enabling themes depending on disabled modules.
     */
    public function testModulePermissions() {
        // Log in as a user without permission to enable modules.
        $this->drupalLogin($this->drupalCreateUser([
            'administer themes',
        ]));
        $this->drupalGet('admin/appearance');
        // The links to install a theme that would enable modules should be replaced
        // by this message.
        $this->assertSession()
            ->pageTextContains('This theme requires the listed modules to operate correctly. They must first be enabled by a user with permissions to do so.');
        // The install page should not be reachable.
        $this->drupalGet('admin/appearance/install?theme=test_theme_depending_on_modules');
        $this->assertSession()
            ->statusCodeEquals(404);
        $this->drupalLogin($this->drupalCreateUser([
            'administer themes',
            'administer modules',
        ]));
        $this->drupalGet('admin/appearance');
        $this->assertSession()
            ->pageTextNotContains('This theme requires the listed modules to operate correctly. They must first be enabled by a user with permissions to do so.');
    }
    
    /**
     * Tests installing a theme with module dependencies.
     *
     * @param string $theme_name
     *   The name of the theme being tested.
     * @param string[] $first_modules
     *   Machine names of first modules to enable.
     * @param string[] $second_modules
     *   Machine names of second modules to enable.
     * @param string[] $required_by_messages
     *   Expected messages when attempting to uninstall $module_names.
     * @param string $base_theme_to_uninstall
     *   The name of the theme $theme_name has set as a base theme.
     * @param string[] $base_theme_module_names
     *   Machine names of the modules required by $base_theme_to_uninstall.
     *
     * @dataProvider providerTestThemeInstallWithModuleDependencies
     */
    public function testThemeInstallWithModuleDependencies($theme_name, array $first_modules, array $second_modules, array $required_by_messages, $base_theme_to_uninstall, array $base_theme_module_names) {
        $assert_session = $this->assertSession();
        $page = $this->getSession()
            ->getPage();
        $all_dependent_modules = array_merge($first_modules, $second_modules);
        $this->drupalGet('admin/appearance');
        $assert_module_enabled_message = function ($enabled_modules) {
            $count = count($enabled_modules);
            $module_enabled_text = $count === 1 ? "{$this->testModules[$enabled_modules[0]]} has been enabled." : $count . " modules have been enabled:";
            $this->assertSession()
                ->pageTextContains($module_enabled_text);
        };
        // All the modules should be listed as disabled.
        foreach ($all_dependent_modules as $module) {
            $expected_required_list_items[$module] = $this->testModules[$module] . " (disabled)";
        }
        $this->assertUninstallableTheme($expected_required_list_items, $theme_name);
        // Enable the first group of dependee modules.
        $first_module_form_post = [];
        foreach ($first_modules as $module) {
            $first_module_form_post["modules[{$module}][enable]"] = 1;
        }
        $this->drupalGet('admin/modules');
        $this->submitForm($first_module_form_post, 'Install');
        $assert_module_enabled_message($first_modules);
        $this->drupalGet('admin/appearance');
        // Confirm the theme is still uninstallable due to a remaining module
        // dependency.
        // The modules that have already been enabled will no longer be listed as
        // disabled.
        foreach ($first_modules as $module) {
            $expected_required_list_items[$module] = $this->testModules[$module];
        }
        $this->assertUninstallableTheme($expected_required_list_items, $theme_name);
        // Enable the second group of dependee modules.
        $second_module_form_post = [];
        foreach ($second_modules as $module) {
            $second_module_form_post["modules[{$module}][enable]"] = 1;
        }
        $this->drupalGet('admin/modules');
        $this->submitForm($second_module_form_post, 'Install');
        $assert_module_enabled_message($second_modules);
        // The theme should now be installable, so install it.
        $this->drupalGet('admin/appearance');
        $page->clickLink("Install {$theme_name} theme");
        $assert_session->addressEquals('admin/appearance');
        $assert_session->pageTextContains("The {$theme_name} theme has been installed");
        // Confirm that the dependee modules can't be uninstalled because an enabled
        // theme depends on them.
        $this->drupalGet('admin/modules/uninstall');
        foreach ($all_dependent_modules as $attribute) {
            $assert_session->elementExists('css', "[name=\"uninstall[{$attribute}]\"][disabled]");
        }
        foreach ($required_by_messages as $selector => $message) {
            $assert_session->elementTextContains('css', $selector, $message);
        }
        // Uninstall the theme that depends on the modules, and confirm the modules
        // can now be uninstalled.
        $this->uninstallTheme($theme_name);
        $this->drupalGet('admin/modules/uninstall');
        // Only attempt to uninstall modules not required by the base theme.
        $modules_to_uninstall = array_diff($all_dependent_modules, $base_theme_module_names);
        $this->uninstallModules($modules_to_uninstall);
        if (!empty($base_theme_to_uninstall)) {
            $this->uninstallTheme($base_theme_to_uninstall);
            $this->drupalGet('admin/modules/uninstall');
            $this->uninstallModules($base_theme_module_names);
        }
    }
    
    /**
     * Uninstalls modules via the admin UI.
     *
     * @param string[] $module_names
     *   An array of module machine names.
     */
    protected function uninstallModules(array $module_names) {
        $assert_session = $this->assertSession();
        $this->drupalGet('admin/modules/uninstall');
        foreach ($module_names as $attribute) {
            $assert_session->elementExists('css', "[name=\"uninstall[{$attribute}]\"]:not([disabled])");
        }
        $to_uninstall = [];
        foreach ($module_names as $attribute) {
            $to_uninstall["uninstall[{$attribute}]"] = 1;
        }
        if (!empty($to_uninstall)) {
            $this->drupalGet('admin/modules/uninstall');
            $this->submitForm($to_uninstall, 'Uninstall');
            $assert_session->pageTextContains('The following modules will be completely uninstalled from your site, and all data from these modules will be lost!');
            $assert_session->pageTextContains('Would you like to continue with uninstalling the above?');
            foreach ($module_names as $module_name) {
                $assert_session->pageTextContains($this->testModules[$module_name]);
            }
            $this->getSession()
                ->getPage()
                ->pressButton('Uninstall');
            $assert_session->pageTextContains('The selected modules have been uninstalled.');
        }
    }
    
    /**
     * Uninstalls a theme via the admin UI.
     *
     * @param string $theme_name
     *   The theme name.
     */
    protected function uninstallTheme($theme_name) {
        $this->drupalGet('admin/appearance');
        $this->clickLink("Uninstall {$theme_name} theme");
        $this->assertSession()
            ->pageTextContains("The {$theme_name} theme has been uninstalled.");
    }
    
    /**
     * Data provider for testThemeInstallWithModuleDependencies().
     *
     * @return array
     *   An array of arrays. Details on the specific elements can be found in the
     *   function body.
     */
    public function providerTestThemeInstallWithModuleDependencies() {
        // Data provider values with the following keys:
        // -'theme_name': The name of the theme being tested.
        // -'first_modules': Array of module machine names to enable first.
        // -'second_modules': Array of module machine names to enable second.
        // -'required_by_messages': Array for checking the messages explaining why a
        // module can't be uninstalled. The array key is the selector where the
        // message should appear, the array value is the expected message.
        // -'base_theme_to_uninstall': The name of a base theme that needs to be
        // uninstalled before modules it depends on can be uninstalled.
        // -'base_theme_module_names': Array of machine names of the modules
        // required by base_theme_to_uninstall.
        return [
            'test theme with a module dependency and base theme with a different module dependency' => [
                'theme_name' => 'Test Theme with a Module Dependency and Base Theme with a Different Module Dependency',
                'first_modules' => [
                    'test_module_required_by_theme',
                    'test_another_module_required_by_theme',
                ],
                'second_modules' => [
                    'help',
                ],
                'required_by_messages' => [
                    '[data-drupal-selector="edit-test-another-module-required-by-theme"] .item-list' => 'Required by the theme: Test Theme Depending on Modules',
                    '[data-drupal-selector="edit-test-module-required-by-theme"] .item-list' => 'Required by the theme: Test Theme Depending on Modules',
                    '[data-drupal-selector="edit-help"] .item-list' => 'Required by the theme: Test Theme with a Module Dependency and Base Theme with a Different Module Dependency',
                ],
                'base_theme_to_uninstall' => 'Test Theme Depending on Modules',
                'base_theme_module_names' => [
                    'test_module_required_by_theme',
                    'test_another_module_required_by_theme',
                ],
            ],
            'Test Theme Depending on Modules' => [
                'theme_name' => 'Test Theme Depending on Modules',
                'first_modules' => [
                    'test_module_required_by_theme',
                ],
                'second_modules' => [
                    'test_another_module_required_by_theme',
                ],
                'required_by_messages' => [
                    '[data-drupal-selector="edit-test-another-module-required-by-theme"] .item-list' => 'Required by the theme: Test Theme Depending on Modules',
                    '[data-drupal-selector="edit-test-module-required-by-theme"] .item-list' => 'Required by the theme: Test Theme Depending on Modules',
                ],
                'base_theme_to_uninstall' => '',
                'base_theme_module_names' => [],
            ],
            'test theme with a base theme depending on modules' => [
                'theme_name' => 'Test Theme with a Base Theme Depending on Modules',
                'first_modules' => [
                    'test_module_required_by_theme',
                ],
                'second_modules' => [
                    'test_another_module_required_by_theme',
                ],
                'required_by_messages' => [
                    '[data-drupal-selector="edit-test-another-module-required-by-theme"] .item-list' => 'Required by the theme: Test Theme Depending on Modules',
                    '[data-drupal-selector="edit-test-module-required-by-theme"] .item-list' => 'Required by the theme: Test Theme Depending on Modules',
                ],
                'base_theme_to_uninstall' => 'Test Theme Depending on Modules',
                'base_theme_module_names' => [
                    'test_module_required_by_theme',
                    'test_another_module_required_by_theme',
                ],
            ],
        ];
    }
    
    /**
     * Checks related to uninstallable themes due to module dependencies.
     *
     * @param string[] $expected_requires_list_items
     *   The modules listed as being required to install the theme.
     * @param string $theme_name
     *   The name of the theme.
     *
     * @internal
     */
    protected function assertUninstallableTheme(array $expected_requires_list_items, string $theme_name) : void {
        $theme_container = $this->getSession()
            ->getPage()
            ->find('css', "h3:contains(\"{$theme_name}\")")
            ->getParent();
        $requires_list_items = $theme_container->findAll('css', '.theme-info__requires li');
        $this->assertSameSize($expected_requires_list_items, $requires_list_items);
        foreach ($requires_list_items as $key => $item) {
            $this->assertContains($item->getText(), $expected_requires_list_items);
        }
        $incompatible = $theme_container->find('css', '.incompatible');
        $expected_incompatible_text = 'This theme requires the listed modules to operate correctly. They must first be enabled via the Extend page.';
        $this->assertSame($expected_incompatible_text, $incompatible->getText());
        $this->assertFalse($theme_container->hasLink('Install Test Theme Depending on Modules theme'));
    }
    
    /**
     * Tests installing a theme with missing module dependencies.
     */
    public function testInstallModuleWithMissingDependencies() {
        $this->drupalGet('admin/appearance');
        $theme_container = $this->getSession()
            ->getPage()
            ->find('css', 'h3:contains("Test Theme Depending on Nonexisting Module")')
            ->getParent();
        $this->assertStringContainsString('Requires: test_module_non_existing (missing)', $theme_container->getText());
        $this->assertStringContainsString('This theme requires the listed modules to operate correctly.', $theme_container->getText());
    }
    
    /**
     * Tests installing a theme with incompatible module dependencies.
     */
    public function testInstallModuleWithIncompatibleDependencies() {
        $this->container
            ->get('module_installer')
            ->install([
            'test_module_compatible_constraint',
            'test_module_incompatible_constraint',
        ]);
        $this->drupalGet('admin/appearance');
        $theme_container = $this->getSession()
            ->getPage()
            ->find('css', 'h3:contains("Test Theme Depending on Version Constrained Modules")')
            ->getParent();
        $this->assertStringContainsString('Requires: Test Module Theme Depends on with Compatible ConstraintTest Module Theme Depends on with Incompatible Constraint (>=8.x-2.x) (incompatible with version 8.x-1.8)', $theme_container->getText());
        $this->assertStringContainsString('This theme requires the listed modules to operate correctly.', $theme_container->getText());
    }
    
    /**
     * Tests that incompatible themes message is shown.
     */
    public function testInstalledIncompatibleTheme() {
        $page = $this->getSession()
            ->getPage();
        $assert_session = $this->assertSession();
        $incompatible_themes_message = 'There are errors with some installed themes. Visit the status report page for more information.';
        $path = \Drupal::getContainer()->getParameter('site.path') . "/themes/changing_theme";
        mkdir($path, 0777, TRUE);
        $file_path = "{$path}/changing_theme.info.yml";
        $theme_name = 'Theme that changes';
        $info = [
            'name' => $theme_name,
            'type' => 'theme',
            'base theme' => FALSE,
        ];
        $compatible_info = $info + [
            'core_version_requirement' => '*',
        ];
        file_put_contents($file_path, Yaml::encode($compatible_info));
        $this->drupalGet('admin/appearance');
        $this->assertSession()
            ->pageTextNotContains($incompatible_themes_message);
        $page->clickLink("Install {$theme_name} theme");
        $assert_session->addressEquals('admin/appearance');
        $assert_session->pageTextContains("The {$theme_name} theme has been installed");
        $incompatible_updates = [
            [
                'core_version_requirement' => '^1',
            ],
            [
                'core' => '8.x',
            ],
        ];
        foreach ($incompatible_updates as $incompatible_update) {
            $incompatible_info = $info + $incompatible_update;
            file_put_contents($file_path, Yaml::encode($incompatible_info));
            $this->drupalGet('admin/appearance');
            $this->assertSession()
                ->pageTextContains($incompatible_themes_message);
            file_put_contents($file_path, Yaml::encode($compatible_info));
            $this->drupalGet('admin/appearance');
            $this->assertSession()
                ->pageTextNotContains($incompatible_themes_message);
        }
        // Uninstall the theme and ensure that incompatible themes message is not
        // displayed for themes that are not installed.
        $this->uninstallTheme($theme_name);
        foreach ($incompatible_updates as $incompatible_update) {
            $incompatible_info = $info + $incompatible_update;
            file_put_contents($file_path, Yaml::encode($incompatible_info));
            $this->drupalGet('admin/appearance');
            $this->assertSession()
                ->pageTextNotContains($incompatible_themes_message);
        }
    }

}

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'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::$modules protected static property Modules to enable. 673
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 '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::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
ThemeUiTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
ThemeUiTest::$testModules protected property Modules used for testing.
ThemeUiTest::assertUninstallableTheme protected function Checks related to uninstallable themes due to module dependencies.
ThemeUiTest::providerTestThemeInstallWithModuleDependencies public function Data provider for testThemeInstallWithModuleDependencies().
ThemeUiTest::setUp protected function Overrides BrowserTestBase::setUp
ThemeUiTest::testInstalledIncompatibleTheme public function Tests that incompatible themes message is shown.
ThemeUiTest::testInstallModuleWithIncompatibleDependencies public function Tests installing a theme with incompatible module dependencies.
ThemeUiTest::testInstallModuleWithMissingDependencies public function Tests installing a theme with missing module dependencies.
ThemeUiTest::testModulePermissions public function Tests permissions for enabling themes depending on disabled modules.
ThemeUiTest::testThemeInstallWithModuleDependencies public function Tests installing a theme with module dependencies.
ThemeUiTest::uninstallModules protected function Uninstalls modules via the admin UI.
ThemeUiTest::uninstallTheme protected function Uninstalls a theme via the admin UI.
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.