function UninstallTest::testUninstallPage

Same name in other branches
  1. 8.9.x core/modules/system/tests/src/Functional/Module/UninstallTest.php \Drupal\Tests\system\Functional\Module\UninstallTest::testUninstallPage()
  2. 10 core/modules/system/tests/src/Functional/Module/UninstallTest.php \Drupal\Tests\system\Functional\Module\UninstallTest::testUninstallPage()
  3. 11.x core/modules/system/tests/src/Functional/Module/UninstallTest.php \Drupal\Tests\system\Functional\Module\UninstallTest::testUninstallPage()

Tests the Uninstall page and Uninstall confirmation page.

File

core/modules/system/tests/src/Functional/Module/UninstallTest.php, line 46

Class

UninstallTest
Tests the uninstallation of modules.

Namespace

Drupal\Tests\system\Functional\Module

Code

public function testUninstallPage() {
    $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, new FormattableMarkup('Cache entry found: @bin', [
        '@bin' => $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. Please try again.');
    // 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.');
}

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