public function InstallUninstallTest::testInstallUninstall in Drupal 10

Same name and namespace in other branches
8 core/modules/system/tests/src/Functional/Module/InstallUninstallTest.php \Drupal\Tests\system\Functional\Module\InstallUninstallTest::testInstallUninstall()
9 core/modules/system/tests/src/Functional/Module/InstallUninstallTest.php \Drupal\Tests\system\Functional\Module\InstallUninstallTest::testInstallUninstall()
Tests that a fixed set of modules can be installed and uninstalled.
File

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

InstallUninstallTest: Install/uninstall core module and confirm table creation/deletion.
Namespace

Drupal\Tests\system\Functional\Module
Code

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: ');
}
You are here

public function InstallUninstallTest::testInstallUninstall in Drupal 10

File

Class

Namespace

Code

API Navigation
