UninstallTest.php

<?php

declare (strict_types=1);
namespace Drupal\Tests\system\Functional\Module;

use Drupal\Core\Cache\Cache;
use Drupal\Core\Entity\EntityMalformedException;
use Drupal\node\Entity\Node;
use Drupal\node\Entity\NodeType;
use Drupal\Tests\BrowserTestBase;
use Drupal\user\Entity\Role;
use Drupal\user\RoleInterface;

/**
 * Tests the uninstallation of modules.
 *
 * @group Module
 */
class UninstallTest extends BrowserTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'module_test',
        'user',
        'views',
        'node',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * Tests the hook_modules_uninstalled() of the user module.
     */
    public function testUserPermsUninstalled() : void {
        // Uninstalls the module_test module, so hook_modules_uninstalled()
        // is executed.
        $this->container
            ->get('module_installer')
            ->uninstall([
            'module_test',
        ]);
        // Are the perms defined by module_test removed?
        $roles = array_filter(Role::loadMultiple(), fn(RoleInterface $role) => $role->hasPermission('module_test perm'));
        $this->assertEmpty($roles, 'Permissions were all removed.');
    }
    
    /**
     * Tests the Uninstall page and Uninstall confirmation page.
     */
    public function testUninstallPage() : void {
        $account = $this->drupalCreateUser([
            'administer modules',
        ]);
        $this->drupalLogin($account);
        // Create a node type.
        $node_type = NodeType::create([
            'type' => 'uninstall_blocker',
            'name' => 'Uninstall blocker',
        ]);
        // Create a dependency that can be fixed.
        $node_type->setThirdPartySetting('module_test', 'key', 'value');
        $node_type->save();
        // Add a node to prevent node from being uninstalled.
        $node = Node::create([
            'type' => 'uninstall_blocker',
            'title' => $this->randomString(),
        ]);
        $node->save();
        // Change the config directly to "install" non-stable modules.
        $this->config('core.extension')
            ->set('module.system_status_obsolete_test', 0)
            ->set('module.deprecated_module', 0)
            ->set('module.experimental_module_test', 0)
            ->save();
        $this->rebuildAll();
        $this->drupalGet('admin/modules/uninstall');
        $this->assertSession()
            ->titleEquals('Uninstall | Drupal');
        // Check that the experimental module link was rendered correctly.
        $this->assertSession()
            ->elementExists('xpath', "//a[contains(@aria-label, 'View information on the Experimental status of the module Experimental Test')]");
        $this->assertSession()
            ->elementExists('xpath', "//a[contains(@href, 'https://example.com/experimental')]");
        // 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 the obsolete module link was rendered correctly.
        $this->assertSession()
            ->elementExists('xpath', "//a[contains(@aria-label, 'View information on the Obsolete status of the module System obsolete status test')]");
        $this->assertSession()
            ->elementExists('xpath', "//a[contains(@href, 'https://example.com/obsolete')]");
        $form = $this->assertSession()
            ->elementExists('xpath', "//form[@id='system-modules-uninstall']");
        $form_html = $form->getOuterHtml();
        // Select the first stable module on the uninstall list.
        $module_stable = $this->assertSession()
            ->elementExists('xpath', "//label[contains(@class, 'module-name') and not(./a[contains(@class, 'module-link--non-stable')])]")
            ->getOuterHtml();
        // Select the unstable modules (deprecated, and obsolete).
        $module_unstable_1 = $this->assertSession()
            ->elementExists('xpath', "//label[./a[contains(@aria-label, 'View information on the Deprecated status of the module Deprecated module')]]")
            ->getOuterHtml();
        $module_unstable_2 = $this->assertSession()
            ->elementExists('xpath', "//label[./a[contains(@aria-label, 'View information on the Obsolete status of the module System obsolete status test')]]")
            ->getOuterHtml();
        // Check that all unstable modules appear before the first stable module.
        $this->assertGreaterThan(strpos($form_html, $module_unstable_1), strpos($form_html, $module_stable));
        $this->assertGreaterThan(strpos($form_html, $module_unstable_2), strpos($form_html, $module_stable));
        foreach (\Drupal::service('extension.list.module')->getAllInstalledInfo() as $module => $info) {
            $field_name = "uninstall[{$module}]";
            if (!empty($info['required'])) {
                // A required module should not be listed on the uninstall page.
                $this->assertSession()
                    ->fieldNotExists($field_name);
            }
            else {
                $this->assertSession()
                    ->fieldExists($field_name);
            }
        }
        // Be sure labels are rendered properly.
        // @see regression https://www.drupal.org/node/2512106
        $this->assertSession()
            ->responseContains('<label for="edit-uninstall-node" class="module-name table-filter-text-source">Node</label>');
        $this->assertSession()
            ->pageTextContains('The following reason prevents Node from being uninstalled:');
        $this->assertSession()
            ->pageTextContains('There is content for the entity type: Content');
        // Delete the node to allow node to be uninstalled.
        $node->delete();
        // Uninstall module_test.
        $edit = [];
        $edit['uninstall[module_test]'] = TRUE;
        $this->drupalGet('admin/modules/uninstall');
        $this->submitForm($edit, 'Uninstall');
        $this->assertSession()
            ->pageTextNotContains('Configuration deletions');
        $this->assertSession()
            ->pageTextContains('Configuration updates');
        $this->assertSession()
            ->pageTextContains($node_type->label());
        $this->submitForm([], 'Uninstall');
        $this->assertSession()
            ->pageTextContains('The selected modules have been uninstalled.');
        // Uninstall node testing that the configuration that will be deleted is
        // listed.
        $node_dependencies = \Drupal::service('config.manager')->findConfigEntityDependenciesAsEntities('module', [
            'node',
        ]);
        $edit = [];
        $edit['uninstall[node]'] = TRUE;
        $this->drupalGet('admin/modules/uninstall');
        $this->submitForm($edit, 'Uninstall');
        $this->assertSession()
            ->pageTextContains('Configuration deletions');
        $this->assertSession()
            ->pageTextNotContains('Configuration updates');
        $entity_types = [];
        foreach ($node_dependencies as $entity) {
            $label = $entity->label() ?: $entity->id();
            $this->assertSession()
                ->pageTextContains($label);
            $entity_types[] = $entity->getEntityTypeId();
        }
        $entity_types = array_unique($entity_types);
        foreach ($entity_types as $entity_type_id) {
            $entity_type = \Drupal::entityTypeManager()->getDefinition($entity_type_id);
            // Add h3's since the entity type label is often repeated in the entity
            // labels.
            $this->assertSession()
                ->responseContains('<h3>' . $entity_type->getLabel() . '</h3>');
        }
        // Set a unique cache entry to be able to test whether all caches are
        // cleared during the uninstall.
        \Drupal::cache()->set('uninstall_test', 'test_uninstall_page', Cache::PERMANENT);
        $cached = \Drupal::cache()->get('uninstall_test');
        $this->assertEquals('test_uninstall_page', $cached->data, "Cache entry found: {$cached->data}");
        $this->submitForm([], 'Uninstall');
        $this->assertSession()
            ->pageTextContains('The selected modules have been uninstalled.');
        // Check that the page does not have double escaped HTML tags.
        $this->assertSession()
            ->responseNotContains('&lt;label');
        // Make sure our unique cache entry is gone.
        $cached = \Drupal::cache()->get('uninstall_test');
        $this->assertFalse($cached, 'Cache entry not found');
        // Make sure we get an error message when we try to confirm uninstallation
        // of an empty list of modules.
        $this->drupalGet('admin/modules/uninstall/confirm');
        $this->assertSession()
            ->pageTextContains('The selected modules could not be uninstalled, either due to a website problem or due to the uninstall confirmation form timing out.');
        // Make sure confirmation page is accessible only during uninstall process.
        $this->drupalGet('admin/modules/uninstall/confirm');
        $this->assertSession()
            ->addressEquals('admin/modules/uninstall');
        $this->assertSession()
            ->titleEquals('Uninstall | Drupal');
        // Make sure the correct error is shown when no modules are selected.
        $edit = [];
        $this->drupalGet('admin/modules/uninstall');
        $this->submitForm($edit, 'Uninstall');
        $this->assertSession()
            ->pageTextContains('No modules selected.');
    }
    
    /**
     * Tests that a module which fails to install can still be uninstalled.
     */
    public function testFailedInstallStatus() : void {
        $account = $this->drupalCreateUser([
            'administer modules',
        ]);
        $this->drupalLogin($account);
        $message = 'Exception thrown when installing module_installer_config_test with an invalid configuration file.';
        try {
            $this->container
                ->get('module_installer')
                ->install([
                'module_installer_config_test',
            ]);
            $this->fail($message);
        } catch (EntityMalformedException) {
            // Expected exception; just continue testing.
        }
        // Even though the module failed to install properly, its configuration
        // status is "enabled" and should still be available to uninstall.
        $this->drupalGet('admin/modules/uninstall');
        $this->assertSession()
            ->pageTextContains('Module installer config test');
        $edit['uninstall[module_installer_config_test]'] = TRUE;
        $this->drupalGet('admin/modules/uninstall');
        $this->submitForm($edit, 'Uninstall');
        $this->submitForm([], 'Uninstall');
        $this->assertSession()
            ->pageTextContains('The selected modules have been uninstalled.');
        $this->assertSession()
            ->pageTextNotContains('Module installer config test');
    }

}