class ModulesListFormWebTest

Same name in other branches
  1. 9 core/modules/system/tests/src/Functional/Form/ModulesListFormWebTest.php \Drupal\Tests\system\Functional\Form\ModulesListFormWebTest
  2. 8.9.x core/modules/system/tests/src/Functional/Form/ModulesListFormWebTest.php \Drupal\Tests\system\Functional\Form\ModulesListFormWebTest
  3. 11.x core/modules/system/tests/src/Functional/Form/ModulesListFormWebTest.php \Drupal\Tests\system\Functional\Form\ModulesListFormWebTest

Tests \Drupal\system\Form\ModulesListForm.

@group Form @group #slow

Hierarchy

Expanded class hierarchy of ModulesListFormWebTest

File

core/modules/system/tests/src/Functional/Form/ModulesListFormWebTest.php, line 16

Namespace

Drupal\Tests\system\Functional\Form
View source
class ModulesListFormWebTest extends BrowserTestBase {
    use InfoWriterTrait;
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'system_test',
        'help',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        \Drupal::state()->set('system_test.module_hidden', FALSE);
        $this->drupalLogin($this->drupalCreateUser([
            'administer modules',
            'administer permissions',
        ]));
    }
    
    /**
     * Tests the module list form.
     */
    public function testModuleListForm() : void {
        $this->drupalGet('admin/modules');
        // Check that system_test's configure link was rendered correctly.
        $this->assertSession()
            ->elementExists('xpath', "//a[contains(@href, '/system-test/configure/bar') and text()='Configure ']/span[contains(@class, 'visually-hidden') and text()='System test']");
        // Check that system_test's permissions link was rendered correctly.
        $this->assertSession()
            ->elementExists('xpath', "//a[contains(@href, '/admin/people/permissions/module/system_test') and text()='Permissions ']/span[contains(@class, 'visually-hidden') and text()='for System test']");
        // Check that system_test's help link was rendered correctly.
        $this->assertSession()
            ->elementExists('xpath', "//a[contains(@href, '/admin/help/system_test') and text()='Help ']/span[contains(@class, 'visually-hidden') and text()='for System test']");
        // Ensure that the Database Logging module's machine name is printed. This
        // module is used because its machine name is different than its human
        // readable name.
        $this->assertSession()
            ->pageTextContains('dblog');
        // Check that the deprecated module link was rendered correctly.
        $this->assertSession()
            ->elementExists('xpath', "//a[contains(@aria-label, 'View information on the Deprecated status of the module Deprecated module')]");
        $this->assertSession()
            ->elementExists('xpath', "//a[contains(@href, 'http://example.com/deprecated')]");
        // Check that obsolete modules are not displayed.
        $this->assertSession()
            ->pageTextNotContains('(Obsolete)');
    }
    
    /**
     * Tests the status message when enabling one or more modules.
     */
    public function testModulesListFormStatusMessage() : void {
        $this->drupalGet('admin/modules');
        // Enable a module that does not define permissions.
        $edit = [
            'modules[layout_discovery][enable]' => 'layout_discovery',
        ];
        $this->submitForm($edit, 'Install');
        $this->assertSession()
            ->elementTextContains('xpath', "//div[@role='contentinfo' and h2[text()='Status message']]", 'Module Layout Discovery has been installed.');
        $this->assertSession()
            ->elementNotExists('xpath', "//div[@role='contentinfo' and h2[text()='Status message']]//a");
        // Enable a module that defines permissions.
        $edit = [
            'modules[filter][enable]' => 'filter',
        ];
        $this->submitForm($edit, 'Install');
        $this->assertSession()
            ->elementTextContains('xpath', "//div[@role='contentinfo' and h2[text()='Status message']]", 'Module Filter has been installed.');
        $this->assertSession()
            ->elementExists('xpath', "//div[@role='contentinfo' and h2[text()='Status message']]//a[contains(@href, '/admin/people/permissions/module/filter')]");
        // Enable a module that has dependencies and both define permissions.
        $edit = [
            'modules[content_moderation][enable]' => 'content_moderation',
        ];
        $this->submitForm($edit, 'Install');
        $this->submitForm([], 'Continue');
        $this->assertSession()
            ->elementTextContains('xpath', "//div[@role='contentinfo' and h2[text()='Status message']]", '2 modules have been installed: Content Moderation, Workflows.');
        $this->assertSession()
            ->elementExists('xpath', "//div[@role='contentinfo' and h2[text()='Status message']]//a[contains(@href, '/admin/people/permissions/module/content_moderation%2Cworkflows')]");
    }
    
    /**
     * Tests the module form with a module with an invalid info.yml file.
     */
    public function testModulesListFormWithInvalidInfoFile() : void {
        $path = \Drupal::getContainer()->getParameter('site.path') . "/modules/broken";
        mkdir($path, 0777, TRUE);
        $file_path = "{$path}/broken.info.yml";
        $yml = <<<BROKEN
name: Module with no core_version_requirement
type: module
BROKEN;
        file_put_contents($file_path, $yml);
        $this->drupalGet('admin/modules');
        $this->assertSession()
            ->statusCodeEquals(200);
        $this->assertSession()
            ->pageTextContains("Modules could not be listed due to an error: The 'core_version_requirement' key must be present in {$file_path}");
        // Check that the module filter text box is available.
        $this->assertSession()
            ->elementExists('xpath', '//input[@name="text"]');
        unlink($file_path);
        $this->drupalGet('admin/modules');
        $this->assertSession()
            ->statusCodeEquals(200);
        // Check that the module filter text box is available.
        $this->assertSession()
            ->elementExists('xpath', '//input[@name="text"]');
        $this->assertSession()
            ->pageTextNotContains('Modules could not be listed due to an error');
    }
    
    /**
     * Tests the module form with a module with an empty description in info.yml.
     */
    public function testModulesListFormWithEmptyDescriptionInfoFile() : void {
        $path = \Drupal::getContainer()->getParameter('site.path') . "/modules/missing_description";
        mkdir($path, 0777, TRUE);
        $file_path = "{$path}/missing_description.info.yml";
        $yml = <<<BROKEN
name: Module with empty description
type: module
core_version_requirement: '*'
description:
BROKEN;
        file_put_contents($file_path, $yml);
        $this->drupalGet('admin/modules');
        $this->assertSession()
            ->statusCodeEquals(200);
        $this->assertSession()
            ->pageTextContains("Module with empty description");
        // Check that the module filter text box is available.
        $this->assertSession()
            ->elementExists('xpath', '//input[@name="text"]');
    }
    
    /**
     * Confirm that module 'Required By' descriptions include dependent themes.
     */
    public function testRequiredByThemeMessage() : void {
        $this->drupalGet('admin/modules');
        $module_theme_depends_on_description = $this->getSession()
            ->getPage()
            ->findAll('css', '#edit-modules-test-module-required-by-theme-enable-description .admin-requirements li:contains("Test Theme Depending on Modules (theme) (disabled)")');
        // Confirm that 'Test Theme Depending on Modules' is listed as being
        // required by the module 'Test Module Required by Theme'.
        $this->assertCount(1, $module_theme_depends_on_description);
        // Confirm that the required by message does not appear anywhere else.
        $this->assertSession()
            ->pageTextContains('Test Theme Depending on Modules (Theme) (Disabled)');
    }
    
    /**
     * Tests that incompatible modules message is shown.
     */
    public function testInstalledIncompatibleModule() : void {
        $incompatible_modules_message = 'There are errors with some installed modules. Visit the status report page for more information.';
        $path = \Drupal::getContainer()->getParameter('site.path') . "/modules/changing_module";
        mkdir($path, 0777, TRUE);
        $file_path = "{$path}/changing_module.info.yml";
        $info = [
            'name' => 'Module that changes',
            'type' => 'module',
        ];
        $compatible_info = $info + [
            'core_version_requirement' => '*',
        ];
        $incompatible_info = $info + [
            'core_version_requirement' => '^1',
        ];
        $this->writeInfoFile($file_path, $compatible_info);
        $edit = [
            'modules[changing_module][enable]' => 'changing_module',
        ];
        $this->drupalGet('admin/modules');
        $this->submitForm($edit, 'Install');
        $this->assertSession()
            ->pageTextContains('Module Module that changes has been installed.');
        $this->writeInfoFile($file_path, $incompatible_info);
        $this->drupalGet('admin/modules');
        $this->assertSession()
            ->pageTextContains($incompatible_modules_message);
        $this->writeInfoFile($file_path, $compatible_info);
        $this->drupalGet('admin/modules');
        $this->assertSession()
            ->pageTextNotContains($incompatible_modules_message);
        // Uninstall the module and ensure that incompatible modules message is not
        // displayed for modules that are not installed.
        $edit = [
            'uninstall[changing_module]' => 'changing_module',
        ];
        $this->drupalGet('admin/modules/uninstall');
        $this->submitForm($edit, 'Uninstall');
        $this->submitForm([], 'Uninstall');
        $this->assertSession()
            ->pageTextContains('The selected modules have been uninstalled.');
        $this->writeInfoFile($file_path, $incompatible_info);
        $this->drupalGet('admin/modules');
        $this->assertSession()
            ->pageTextNotContains($incompatible_modules_message);
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Member alias Overriden Title Overrides
BlockCreationTrait::placeBlock protected function Creates a block instance based on default settings. Aliased as: drupalPlaceBlock
BrowserHtmlDebugTrait::$htmlOutputBaseUrl protected property The Base URI to use for links to the output files.
BrowserHtmlDebugTrait::$htmlOutputClassName protected property Class name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounter protected property Counter for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputCounterStorage protected property Counter storage for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputDirectory protected property Directory name for HTML output logging.
BrowserHtmlDebugTrait::$htmlOutputEnabled protected property HTML output enabled.
BrowserHtmlDebugTrait::$htmlOutputFile protected property The file name to write the list of URLs to.
BrowserHtmlDebugTrait::$htmlOutputTestId protected property HTML output test ID.
BrowserHtmlDebugTrait::formatHtmlOutputHeaders protected function Formats HTTP headers as string for HTML output logging.
BrowserHtmlDebugTrait::getHtmlOutputHeaders protected function Returns headers in HTML output format. 1
BrowserHtmlDebugTrait::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received.
BrowserHtmlDebugTrait::htmlOutput protected function Logs a HTML output message in a text file.
BrowserHtmlDebugTrait::initBrowserOutputFile protected function Creates the directory to store browser output.
BrowserTestBase::$baseUrl protected property The base URL.
BrowserTestBase::$configImporter protected property The config importer that can be used in a test.
BrowserTestBase::$customTranslations protected property An array of custom translations suitable for SettingsEditor::rewrite().
BrowserTestBase::$mink protected property Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs protected property Mink default driver params.
BrowserTestBase::$minkDefaultDriverClass protected property Mink class for the default driver to use. 1
BrowserTestBase::$originalContainer protected property The original container.
BrowserTestBase::$originalShutdownCallbacks protected property The original array of shutdown function callbacks.
BrowserTestBase::$preserveGlobalState protected property
BrowserTestBase::$profile protected property The profile to install as a basis for testing. 40
BrowserTestBase::$runTestInSeparateProcess protected property Browser tests are run in separate processes to prevent collisions between
code that may be loaded by tests.
BrowserTestBase::$timeLimit protected property Time limit in seconds for the test.
BrowserTestBase::$translationFilesDirectory protected property The translation file directory for the test environment.
BrowserTestBase::cleanupEnvironment protected function Clean up the test environment.
BrowserTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
BrowserTestBase::filePreDeleteCallback public static function Ensures test files are deletable.
BrowserTestBase::getDefaultDriverInstance protected function Gets an instance of the default Mink driver.
BrowserTestBase::getDrupalSettings protected function Gets the JavaScript drupalSettings variable for the currently-loaded page. 1
BrowserTestBase::getHttpClient protected function Obtain the HTTP client for the system under test.
BrowserTestBase::getMinkDriverArgs protected function Gets the Mink driver args from an environment variable. 1
BrowserTestBase::getOptions protected function Helper function to get the options of select field.
BrowserTestBase::getSession public function Returns Mink session.
BrowserTestBase::getSessionCookies protected function Get session cookies from current session.
BrowserTestBase::getTestMethodCaller protected function Retrieves the current calling line in the class under test. Overrides BrowserHtmlDebugTrait::getTestMethodCaller
BrowserTestBase::initFrontPage protected function Visits the front page when initializing Mink. 3
BrowserTestBase::initMink protected function Initializes Mink sessions. 1
BrowserTestBase::installDrupal public function Installs Drupal into the test site. 2
BrowserTestBase::registerSessions protected function Registers additional Mink sessions.
BrowserTestBase::setUpAppRoot protected function Sets up the root application path.
BrowserTestBase::setUpBeforeClass public static function 1
BrowserTestBase::tearDown protected function 3
BrowserTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for submitForm().
BrowserTestBase::xpath protected function Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__get public function
BrowserTestBase::__sleep public function Prevents serializing any properties.
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
ContentTypeCreationTrait::createContentType protected function Creates a custom content type based on default settings. Aliased as: drupalCreateContentType 1
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix protected property The flag to set &#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::$usesSuperUserAccessPolicy protected property Set to TRUE to make user 1 a super user. 10
FunctionalTestSetupTrait::doInstall protected function Execute the non-interactive installer. 2
FunctionalTestSetupTrait::getDatabaseTypes protected function Returns all supported database driver installer objects.
FunctionalTestSetupTrait::initConfig protected function Initialize various configurations post-installation. 1
FunctionalTestSetupTrait::initKernel protected function Initializes the kernel after installation.
FunctionalTestSetupTrait::initSettings protected function Initialize settings created during install.
FunctionalTestSetupTrait::initUserSession protected function Initializes user 1 for the site to be installed.
FunctionalTestSetupTrait::installDefaultThemeFromClassProperty protected function Installs the default theme defined by `static::$defaultTheme` when needed. 1
FunctionalTestSetupTrait::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. 1
FunctionalTestSetupTrait::installParameters protected function Returns the parameters that will be used when the test installs Drupal. 8
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 28
FunctionalTestSetupTrait::prepareRequestForGenerator protected function Creates a mock request and sets it on the generator.
FunctionalTestSetupTrait::prepareSettings protected function Prepares site settings and services before installation. 4
FunctionalTestSetupTrait::rebuildAll protected function Resets and rebuilds the environment after setup.
FunctionalTestSetupTrait::rebuildContainer protected function Rebuilds \Drupal::getContainer().
FunctionalTestSetupTrait::resetAll protected function Resets all data structures after having enabled new modules.
FunctionalTestSetupTrait::setContainerParameter protected function Changes parameters in the services.yml file.
FunctionalTestSetupTrait::setupBaseUrl protected function Sets up the base URL based upon the environment variable.
FunctionalTestSetupTrait::writeSettings protected function Rewrites the settings.php file of the test site. 1
InfoWriterTrait::writeInfoFile private function Writes the info file and ensures the mtime changes.
ModulesListFormWebTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
ModulesListFormWebTest::$modules protected static property Modules to install. Overrides BrowserTestBase::$modules
ModulesListFormWebTest::setUp protected function Overrides BrowserTestBase::setUp
ModulesListFormWebTest::testInstalledIncompatibleModule public function Tests that incompatible modules message is shown.
ModulesListFormWebTest::testModuleListForm public function Tests the module list form.
ModulesListFormWebTest::testModulesListFormStatusMessage public function Tests the status message when enabling one or more modules.
ModulesListFormWebTest::testModulesListFormWithEmptyDescriptionInfoFile public function Tests the module form with a module with an empty description in info.yml.
ModulesListFormWebTest::testModulesListFormWithInvalidInfoFile public function Tests the module form with a module with an invalid info.yml file.
ModulesListFormWebTest::testRequiredByThemeMessage public function Confirm that module &#039;Required By&#039; descriptions include dependent themes.
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::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers.
RandomGeneratorTrait::randomObject public function Generates a random PHP object.
RandomGeneratorTrait::randomString public function Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate Deprecated public function Callback for random string validation.
RefreshVariablesTrait::refreshVariables protected function Refreshes in-memory configuration and state information. 2
SessionTestTrait::$sessionName protected property The name of the session cookie.
SessionTestTrait::generateSessionName protected function Generates a session cookie name.
SessionTestTrait::getSessionName protected function Returns the session name in use on the child site.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements Deprecated private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements Deprecated protected function Check module requirements for the Drupal use case.
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.
TestSetupTrait::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking. 2
TestSetupTrait::$container protected property The dependency injection container used in the test.
TestSetupTrait::$databasePrefix protected property The database prefix of this test run.
TestSetupTrait::$kernel protected property The DrupalKernel instance used in the test.
TestSetupTrait::$originalSite protected property The site directory of the original parent site.
TestSetupTrait::$privateFilesDirectory protected property The private file directory for the test environment.
TestSetupTrait::$publicFilesDirectory protected property The public file directory for the test environment.
TestSetupTrait::$root protected property The app root.
TestSetupTrait::$siteDirectory protected property The site directory of this test run.
TestSetupTrait::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 4
TestSetupTrait::$tempFilesDirectory protected property The temporary file directory for the test environment.
TestSetupTrait::$testId protected property The test run ID.
TestSetupTrait::changeDatabasePrefix protected function Changes the database connection to the prefixed one.
TestSetupTrait::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
TestSetupTrait::getDatabaseConnection Deprecated public static function Returns the database connection to the site under test.
TestSetupTrait::prepareDatabasePrefix protected function Generates a database prefix for running tests. 1
UiHelperTrait::$loggedInUser protected property The current user logged in using the Mink controlled browser.
UiHelperTrait::$maximumMetaRefreshCount protected property The number of meta refresh redirects to follow, or NULL if unlimited.
UiHelperTrait::$metaRefreshCount protected property The number of meta refresh redirects followed during ::drupalGet().
UiHelperTrait::$useOneTimeLoginLinks protected property Use one-time login links instead of submitting the login form. 3
UiHelperTrait::assertSession public function Returns WebAssert object. 1
UiHelperTrait::buildUrl protected function Builds an absolute URL from a system path or a URL object.
UiHelperTrait::checkForMetaRefresh protected function Checks for meta refresh tag and if found call drupalGet() recursively.
UiHelperTrait::click protected function Clicks the element with the given CSS selector.
UiHelperTrait::clickLink protected function Follows a link by complete name.
UiHelperTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
UiHelperTrait::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
UiHelperTrait::drupalGet protected function Retrieves a Drupal path or an absolute path. 3
UiHelperTrait::drupalLogin protected function Logs in a user using the Mink controlled browser.
UiHelperTrait::drupalLogout protected function Logs a user out of the Mink controlled browser and confirms.
UiHelperTrait::drupalResetSession protected function Resets the current active session back to Anonymous session.
UiHelperTrait::drupalUserIsLoggedIn protected function Returns whether a given user account is logged in.
UiHelperTrait::getAbsoluteUrl protected function Takes a path and returns an absolute path.
UiHelperTrait::getTextContent protected function Retrieves the plain-text content from the current page.
UiHelperTrait::getUrl protected function Get the current URL from the browser.
UiHelperTrait::isTestUsingGuzzleClient protected function Determines if test is using DrupalTestBrowser.
UiHelperTrait::prepareRequest protected function Prepare for a request to testing site. 1
UiHelperTrait::submitForm protected function Fills and submits a form.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole protected function Creates an administrative role.
UserCreationTrait::createRole protected function Creates a role with specified permissions. Aliased as: drupalCreateRole
UserCreationTrait::createUser protected function Create a user with a given set of permissions. Aliased as: drupalCreateUser
UserCreationTrait::grantPermissions protected function Grant permissions to a user role.
UserCreationTrait::setCurrentUser protected function Switch the current logged in user.
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user.
XdebugRequestTrait::extractCookiesFromRequest protected function Adds xdebug cookies, from request setup.

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