class InstallUninstallTest

Same name in other branches
  1. 8.9.x core/modules/system/tests/src/Functional/Module/InstallUninstallTest.php \Drupal\Tests\system\Functional\Module\InstallUninstallTest

Install/uninstall core module and confirm table creation/deletion.

@group #slow @group Module

Hierarchy

Expanded class hierarchy of InstallUninstallTest

File

core/modules/system/tests/src/Functional/Module/InstallUninstallTest.php, line 15

Namespace

Drupal\Tests\system\Functional\Module
View source
class InstallUninstallTest extends ModuleTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'system_test',
        'dblog',
        'taxonomy',
        'update_test_postupdate',
    ];
    
    /**
     * Tests that a fixed set of modules can be installed and uninstalled.
     */
    public function testInstallUninstall() {
        // Set a variable so that the hook implementations in system_test.module
        // will display messages via
        // \Drupal\Core\Messenger\MessengerInterface::addStatus().
        $this->container
            ->get('state')
            ->set('system_test.verbose_module_hooks', TRUE);
        // Install and uninstall module_test to ensure hook_preinstall_module and
        // hook_preuninstall_module are fired as expected.
        $this->container
            ->get('module_installer')
            ->install([
            'module_test',
        ]);
        $this->assertEquals('module_test', $this->container
            ->get('state')
            ->get('system_test_preinstall_module'));
        $this->container
            ->get('module_installer')
            ->uninstall([
            'module_test',
        ]);
        $this->assertEquals('module_test', $this->container
            ->get('state')
            ->get('system_test_preuninstall_module'));
        $this->resetAll();
        $all_modules = $this->container
            ->get('extension.list.module')
            ->getList();
        // Test help on required modules, but do not test uninstalling.
        $required_modules = array_filter($all_modules, function ($module) {
            if (!empty($module->info['required']) || $module->status == TRUE) {
                if ($module->info['package'] != 'Testing' && empty($module->info['hidden'])) {
                    return TRUE;
                }
            }
            return FALSE;
        });
        $required_modules['help'] = $all_modules['help'];
        // Filter out contrib, hidden, testing, experimental, and deprecated
        // modules. We also don't need to enable modules that are already enabled.
        $all_modules = array_filter($all_modules, function ($module) {
            if (!empty($module->info['hidden']) || !empty($module->info['required']) || $module->status == TRUE || $module->info['package'] === 'Testing' || $module->info[ExtensionLifecycle::LIFECYCLE_IDENTIFIER] === ExtensionLifecycle::DEPRECATED) {
                return FALSE;
            }
            return TRUE;
        });
        // Install the Help module, and verify it installed successfully.
        unset($all_modules['help']);
        $this->assertModuleNotInstalled('help');
        $edit = [];
        $edit["modules[help][enable]"] = TRUE;
        $this->drupalGet('admin/modules');
        $this->submitForm($edit, 'Install');
        $this->assertSession()
            ->pageTextContains('has been enabled');
        $this->assertSession()
            ->pageTextContains('hook_modules_installed fired for help');
        $this->assertModuleSuccessfullyInstalled('help');
        // Test help for the required modules.
        foreach ($required_modules as $name => $module) {
            $this->assertHelp($name, $module->info['name']);
        }
        // Go through each module in the list and try to install and uninstall
        // it with its dependencies.
        foreach ($all_modules as $name => $module) {
            $was_installed_list = \Drupal::moduleHandler()->getModuleList();
            // Start a list of modules that we expect to be installed this time.
            $modules_to_install = [
                $name,
            ];
            foreach (array_keys($module->requires) as $dependency) {
                if (isset($all_modules[$dependency])) {
                    $modules_to_install[] = $dependency;
                }
            }
            // Check that each module is not yet enabled and does not have any
            // database tables yet.
            foreach ($modules_to_install as $module_to_install) {
                $this->assertModuleNotInstalled($module_to_install);
            }
            // Install the module.
            $edit = [];
            $lifecycle = $module->info[ExtensionLifecycle::LIFECYCLE_IDENTIFIER];
            $edit['modules[' . $name . '][enable]'] = TRUE;
            $this->drupalGet('admin/modules');
            $this->submitForm($edit, 'Install');
            // Handle experimental modules, which require a confirmation screen.
            if ($lifecycle === ExtensionLifecycle::EXPERIMENTAL) {
                $this->assertSession()
                    ->pageTextContains('Are you sure you wish to enable an experimental module?');
                if (count($modules_to_install) > 1) {
                    // When there are experimental modules, needed dependencies do not
                    // result in the same page title, but there will be expected text
                    // indicating they need to be enabled.
                    $this->assertSession()
                        ->pageTextContains('You must enable');
                }
                $this->submitForm([], 'Continue');
            }
            elseif ($lifecycle === ExtensionLifecycle::DEPRECATED) {
                $this->assertSession()
                    ->pageTextContains('Are you sure you wish to enable a deprecated module?');
                if (count($modules_to_install) > 1) {
                    // When there are deprecated modules, needed dependencies do not
                    // result in the same page title, but there will be expected text
                    // indicating they need to be enabled.
                    $this->assertSession()
                        ->pageTextContains('You must enable');
                }
                $this->submitForm([], 'Continue');
            }
            elseif (count($modules_to_install) > 1) {
                // Verify that we are on the correct form and that the expected text
                // about enabling dependencies appears.
                $this->assertSession()
                    ->pageTextContains('Some required modules must be enabled');
                $this->assertSession()
                    ->pageTextContains('You must enable');
                $this->submitForm([], 'Continue');
            }
            // List the module display names to check the confirmation message.
            $module_names = [];
            foreach ($modules_to_install as $module_to_install) {
                $module_names[] = $all_modules[$module_to_install]->info['name'];
            }
            if (count($modules_to_install) > 1) {
                $this->assertSession()
                    ->pageTextContains(count($module_names) . ' modules have been enabled: ' . implode(', ', $module_names));
            }
            else {
                $this->assertSession()
                    ->pageTextContains('Module ' . $module_names[0] . ' has been enabled.');
            }
            // Check that hook_modules_installed() was invoked with the expected list
            // of modules, that each module's database tables now exist, and that
            // appropriate messages appear in the logs.
            foreach ($modules_to_install as $module_to_install) {
                $this->assertSession()
                    ->pageTextContains('hook_modules_installed fired for ' . $module_to_install);
                $this->assertLogMessage('system', "%module module installed.", [
                    '%module' => $module_to_install,
                ], RfcLogLevel::INFO);
                $this->assertInstallModuleUpdates($module_to_install);
                $this->assertModuleSuccessfullyInstalled($module_to_install);
            }
            // Verify the help page.
            $this->assertHelp($name, $module->info['name']);
            // Uninstall the original module, plus everything else that was installed
            // with it.
            if ($name == 'forum') {
                // Forum has an extra step to be able to uninstall it.
                $this->preUninstallForum();
            }
            // Delete all workspaces before uninstall.
            if ($name == 'workspaces') {
                $workspaces = Workspace::loadMultiple();
                \Drupal::entityTypeManager()->getStorage('workspace')
                    ->delete($workspaces);
            }
            $now_installed_list = \Drupal::moduleHandler()->getModuleList();
            $added_modules = array_diff(array_keys($now_installed_list), array_keys($was_installed_list));
            while ($added_modules) {
                $initial_count = count($added_modules);
                foreach ($added_modules as $to_uninstall) {
                    // See if we can currently uninstall this module (if its dependencies
                    // have been uninstalled), and do so if we can.
                    $this->drupalGet('admin/modules/uninstall');
                    $checkbox = $this->assertSession()
                        ->fieldExists("uninstall[{$to_uninstall}]");
                    if (!$checkbox->hasAttribute('disabled')) {
                        // This one is eligible for being uninstalled.
                        $package = $all_modules[$to_uninstall]->info['package'];
                        $this->assertSuccessfulUninstall($to_uninstall, $package);
                        $added_modules = array_diff($added_modules, [
                            $to_uninstall,
                        ]);
                    }
                }
                // If we were not able to find a module to uninstall, fail and exit the
                // loop.
                $final_count = count($added_modules);
                if ($initial_count == $final_count) {
                    $this->fail('Remaining modules could not be uninstalled for ' . $name);
                    break;
                }
            }
        }
        // Uninstall the help module and put it back into the list of modules.
        $all_modules['help'] = $required_modules['help'];
        $this->assertSuccessfulUninstall('help', $required_modules['help']->info['package']);
        // Now that all modules have been tested, go back and try to enable them
        // all again at once. This tests two things:
        // - That each module can be successfully enabled again after being
        //   uninstalled.
        // - That enabling more than one module at the same time does not lead to
        //   any errors.
        $edit = [];
        $count_experimental = 0;
        $count_deprecated = 0;
        foreach ($all_modules as $name => $module) {
            $edit['modules[' . $name . '][enable]'] = TRUE;
            if ($module->info[ExtensionLifecycle::LIFECYCLE_IDENTIFIER] === ExtensionLifecycle::EXPERIMENTAL) {
                $count_experimental++;
            }
            if ($module->info[ExtensionLifecycle::LIFECYCLE_IDENTIFIER] === ExtensionLifecycle::DEPRECATED) {
                $count_deprecated++;
            }
        }
        $this->drupalGet('admin/modules');
        $this->submitForm($edit, 'Install');
        // If there are experimental and deprecated modules, click the confirm form.
        if ($count_experimental > 0 && $count_deprecated > 0) {
            $this->assertSession()
                ->titleEquals('Are you sure you wish to enable experimental and deprecated modules? | Drupal');
            $this->submitForm([], 'Continue');
        }
        elseif ($count_experimental > 0) {
            if ($count_experimental === 1) {
                $page_title = 'Are you sure you wish to enable an experimental module? | Drupal';
            }
            else {
                $page_title = 'Are you sure you wish to enable experimental modules? | Drupal';
            }
            $this->assertSession()
                ->titleEquals($page_title);
            $this->submitForm([], 'Continue');
        }
        elseif ($count_deprecated > 0) {
            if ($count_deprecated === 1) {
                $page_title = 'Are you sure you wish to enable a deprecated module? | Drupal';
            }
            else {
                $page_title = 'Are you sure you wish to enable deprecated modules? | Drupal';
            }
            $this->assertSession()
                ->titleEquals($page_title);
            $this->submitForm([], 'Continue');
        }
        $this->assertSession()
            ->pageTextContains(count($all_modules) . ' modules have been enabled: ');
    }
    
    /**
     * Asserts that a module is not yet installed.
     *
     * @param string $name
     *   Name of the module to check.
     *
     * @internal
     */
    protected function assertModuleNotInstalled(string $name) : void {
        $this->assertModules([
            $name,
        ], FALSE);
        $this->assertModuleTablesDoNotExist($name);
    }
    
    /**
     * Asserts that a module was successfully installed.
     *
     * @param string $name
     *   Name of the module to check.
     *
     * @internal
     */
    protected function assertModuleSuccessfullyInstalled(string $name) : void {
        $this->assertModules([
            $name,
        ], TRUE);
        $this->assertModuleTablesExist($name);
        $this->assertModuleConfig($name);
    }
    
    /**
     * Uninstalls a module and asserts that it was done correctly.
     *
     * @param string $module
     *   The name of the module to uninstall.
     * @param string $package
     *   (optional) The package of the module to uninstall. Defaults
     *   to 'Core'.
     *
     * @internal
     */
    protected function assertSuccessfulUninstall(string $module, string $package = 'Core') : void {
        $edit = [];
        $edit['uninstall[' . $module . ']'] = TRUE;
        $this->drupalGet('admin/modules/uninstall');
        $this->submitForm($edit, 'Uninstall');
        $this->submitForm([], 'Uninstall');
        $this->assertSession()
            ->pageTextContains('The selected modules have been uninstalled.');
        $this->assertModules([
            $module,
        ], FALSE);
        // Check that the appropriate hook was fired and the appropriate log
        // message appears. (But don't check for the log message if the dblog
        // module was just uninstalled, since the {watchdog} table won't be there
        // anymore.)
        $this->assertSession()
            ->pageTextContains('hook_modules_uninstalled fired for ' . $module);
        $this->assertLogMessage('system', "%module module uninstalled.", [
            '%module' => $module,
        ], RfcLogLevel::INFO);
        // Check that the module's database tables no longer exist.
        $this->assertModuleTablesDoNotExist($module);
        // Check that the module's config files no longer exist.
        $this->assertNoModuleConfig($module);
        $this->assertUninstallModuleUpdates($module);
    }
    
    /**
     * Asserts the module post update functions after install.
     *
     * @param string $module
     *   The module that got installed.
     *
     * @internal
     */
    protected function assertInstallModuleUpdates(string $module) : void {
        
        /** @var \Drupal\Core\Update\UpdateRegistry $post_update_registry */
        $post_update_registry = \Drupal::service('update.post_update_registry');
        $all_update_functions = $post_update_registry->getPendingUpdateFunctions();
        $empty_result = TRUE;
        foreach ($all_update_functions as $function) {
            [
                $function_module,
            ] = explode('_post_update_', $function);
            if ($module === $function_module) {
                $empty_result = FALSE;
                break;
            }
        }
        $this->assertTrue($empty_result, 'Ensures that no pending post update functions are available.');
        $existing_updates = \Drupal::keyValue('post_update')->get('existing_updates', []);
        switch ($module) {
            case 'update_test_postupdate':
                $expected = [
                    'update_test_postupdate_post_update_first',
                    'update_test_postupdate_post_update_second',
                    'update_test_postupdate_post_update_test1',
                    'update_test_postupdate_post_update_test0',
                    'update_test_postupdate_post_update_foo',
                    'update_test_postupdate_post_update_bar',
                    'update_test_postupdate_post_update_baz',
                ];
                $this->assertSame($expected, $existing_updates);
                break;
        }
    }
    
    /**
     * Asserts the module post update functions after uninstall.
     *
     * @param string $module
     *   The module that got installed.
     *
     * @internal
     */
    protected function assertUninstallModuleUpdates(string $module) : void {
        
        /** @var \Drupal\Core\Update\UpdateRegistry $post_update_registry */
        $post_update_registry = \Drupal::service('update.post_update_registry');
        $all_update_functions = $post_update_registry->getPendingUpdateFunctions();
        switch ($module) {
            case 'update_test_postupdate':
                $this->assertEmpty(array_intersect([
                    'update_test_postupdate_post_update_first',
                ], $all_update_functions), 'Asserts that no pending post update functions are available.');
                $existing_updates = \Drupal::keyValue('post_update')->get('existing_updates', []);
                $this->assertEmpty(array_intersect([
                    'update_test_postupdate_post_update_first',
                ], $existing_updates), 'Asserts that no post update functions are stored in keyvalue store.');
                break;
        }
    }
    
    /**
     * Verifies a module's help.
     *
     * Verifies that the module help page from hook_help() exists and can be
     * displayed, and that it contains the phrase "Foo Bar module", where "Foo
     * Bar" is the name of the module from the .info.yml file.
     *
     * @param string $module
     *   Machine name of the module to verify.
     * @param string $name
     *   Human-readable name of the module to verify.
     *
     * @internal
     */
    protected function assertHelp(string $module, string $name) : void {
        $this->drupalGet('admin/help/' . $module);
        $this->assertSession()
            ->statusCodeEquals(200);
        $this->assertSession()
            ->pageTextContains($name . ' module');
        $this->assertSession()
            ->linkExists('online documentation for the ' . $name . ' module', 0, "Correct online documentation link is in the help page for {$module}");
    }
    
    /**
     * Deletes forum taxonomy terms, so Forum can be uninstalled.
     */
    protected function preUninstallForum() {
        // There only should be a 'General discussion' term in the 'forums'
        // vocabulary, but just delete any terms there in case the name changes.
        $query = \Drupal::entityQuery('taxonomy_term')->accessCheck(FALSE);
        $query->condition('vid', 'forums');
        $ids = $query->execute();
        $storage = \Drupal::entityTypeManager()->getStorage('taxonomy_term');
        $terms = $storage->loadMultiple($ids);
        $storage->delete($terms);
    }

}

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::$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
InstallUninstallTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
InstallUninstallTest::$modules protected static property Modules to enable. Overrides ModuleTestBase::$modules
InstallUninstallTest::assertHelp protected function Verifies a module's help.
InstallUninstallTest::assertInstallModuleUpdates protected function Asserts the module post update functions after install.
InstallUninstallTest::assertModuleNotInstalled protected function Asserts that a module is not yet installed.
InstallUninstallTest::assertModuleSuccessfullyInstalled protected function Asserts that a module was successfully installed.
InstallUninstallTest::assertSuccessfulUninstall protected function Uninstalls a module and asserts that it was done correctly.
InstallUninstallTest::assertUninstallModuleUpdates protected function Asserts the module post update functions after uninstall.
InstallUninstallTest::preUninstallForum protected function Deletes forum taxonomy terms, so Forum can be uninstalled.
InstallUninstallTest::testInstallUninstall public function Tests that a fixed set of modules can be installed and uninstalled.
ModuleTestBase::$adminUser protected property
ModuleTestBase::assertLogMessage public function Verify a log entry was entered for a module's status change.
ModuleTestBase::assertModuleConfig public function Asserts that the default configuration of a module has been installed.
ModuleTestBase::assertModules public function Assert the list of modules are enabled or disabled.
ModuleTestBase::assertModuleTablesDoNotExist public function Assert that none of the tables defined in a module's hook_schema() exist.
ModuleTestBase::assertModuleTablesExist public function Assert that all tables defined in a module's hook_schema() exist.
ModuleTestBase::assertNoModuleConfig public function Asserts that no configuration exists for a given module.
ModuleTestBase::setUp protected function Overrides BrowserTestBase::setUp 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
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.