Issue #2664292 by harings_rob, xjm, Spokje, claudiu.cristea, bircher,...

Issue #2664292 by harings_rob, xjm, Spokje, claudiu.cristea, bircher, dawehner, alexpott, klausi: Convert Module\InstallTest into a Kernel test

(cherry picked from commit 8a2f6514)

core/modules/system/tests/src/Functional/Module/InstallTest.php → core/modules/system/tests/src/Kernel/Module/InstallTest.php

 <?php
 
-namespace Drupal\Tests\system\Functional\Module;
+namespace Drupal\Tests\system\Kernel\Module;
 
-use Drupal\Component\Render\FormattableMarkup;
-use Drupal\Core\Database\Database;
 use Drupal\Core\Extension\ExtensionNameLengthException;
-use Drupal\Tests\BrowserTestBase;
+use Drupal\Core\Extension\ModuleInstallerInterface;
+use Drupal\KernelTests\KernelTestBase;
 
 /**
  * Tests the installation of modules.
  *
  * @group Module
  */
-class InstallTest extends BrowserTestBase {
+class InstallTest extends KernelTestBase {
 
   /**
-   * Modules to enable.
-   *
-   * @var array
+   * The module installer service.
    */
-  protected static $modules = ['module_test'];
+  protected ModuleInstallerInterface $moduleInstaller;
 
   /**
    * {@inheritdoc}
    */
-  protected $defaultTheme = 'stark';
+  protected function setUp(): void {
+    parent::setUp();
+
+    $this->moduleInstaller = $this->container->get('module_installer');
+    $this->moduleInstaller->install([
+      'module_test',
+      'system',
+      'user',
+    ]);
+  }
 
   /**
-   * Verify that module's schema can be used during module installation.
+   * Verify that drupal_get_schema() can be used during module installation.
    */
-  public function testGetSchemaAtInstallTime() {
+  public function testGetSchemaAtInstallTime(): void {
     // @see module_test_install()
-    $value = Database::getConnection()->select('module_test', 'mt')->fields('mt', ['data'])->execute()->fetchField();
-    $this->assertSame('varchar', $value);
+    $database = $this->container->get('database');
+    $value = $database->select('module_test')
+      ->fields('module_test', ['data'])
+      ->execute()
+      ->fetchField();
+    $this->assertEquals('varchar', $value);
   }
 
   /**
    * Tests enabling User module once more.
    *
    * Regression: The installer might enable a module twice due to automatic
-   * dependency resolution. A bug caused the stored weight for User module to
+   * dependency resolution. A bug caused the stored weight for user.module to
    * be an array.
    */
-  public function testEnableUserTwice() {
-    \Drupal::service('module_installer')->install(['user'], FALSE);
+  public function testEnableUserTwice(): void {
+    $this->moduleInstaller->install(['user'], FALSE);
     $this->assertSame(0, $this->config('core.extension')->get('module.user'));
+
+    // To avoid false positives, ensure that a module that does not exist does
+    // not return exactly zero.
+    $this->assertNotSame(0, $this->config('core.extension')
+      ->get('module.does_not_exist'));
   }
 
   /**
    * Tests recorded schema versions of early installed modules in the installer.
    */
-  public function testRequiredModuleSchemaVersions() {
+  public function testRequiredModuleSchemaVersions(): void {
     /** @var \Drupal\Core\Update\UpdateHookRegistry $update_registry */
     $update_registry = \Drupal::service('update.update_hook_registry');
     $version = $update_registry->getInstalledVersion('system');
@@ -64,12 +79,20 @@ public function testRequiredModuleSchemaVersions() {
   }
 
   /**
-   * Ensures that post update functions are removed on uninstall.
+   * Ensures that post update functions are removed on uninstallation.
    */
-  public function testUninstallPostUpdateFunctions() {
-    \Drupal::service('module_installer')->uninstall(['module_test']);
+  public function testUninstallPostUpdateFunctions(): void {
+    // First, to avoid false positives, ensure that the post_update function
+    // exists while the module is still installed.
+    $post_update_key_value = $this->container->get('keyvalue')
+      ->get('post_update');
+    $existing_updates = $post_update_key_value->get('existing_updates', []);
+    $this->assertContains('module_test_post_update_test', $existing_updates);
 
-    $post_update_key_value = \Drupal::keyValue('post_update');
+    // Uninstall the module.
+    $this->moduleInstaller->uninstall(['module_test']);
+
+    // Ensure the post update function is no longer listed.
     $existing_updates = $post_update_key_value->get('existing_updates', []);
     $this->assertNotContains('module_test_post_update_test', $existing_updates);
   }
@@ -77,26 +100,23 @@ public function testUninstallPostUpdateFunctions() {
   /**
    * Tests that an exception is thrown when a module name is too long.
    */
-  public function testModuleNameLength() {
+  public function testModuleNameLength(): void {
+    $module_name = 'invalid_module_name_over_the_maximum_allowed_character_length';
+    $this->expectException(ExtensionNameLengthException::class);
+    $this->expectExceptionMessage("Module name 'invalid_module_name_over_the_maximum_allowed_character_length' is over the maximum allowed length of 50 characters");
+    $this->moduleInstaller->install([$module_name]);
+  }
+
+  /**
+   * Tests that an exception is thrown when a module name is too long.
+   *
+   * We do this without checking dependencies for the module to install.
+   */
+  public function testModuleNameLengthWithoutDependencyCheck(): void {
     $module_name = 'invalid_module_name_over_the_maximum_allowed_character_length';
-    $message = new FormattableMarkup('Exception thrown when enabling module %name with a name length over the allowed maximum', ['%name' => $module_name]);
-    try {
-      $this->container->get('module_installer')->install([$module_name]);
-      $this->fail($message);
-    }
-    catch (\Exception $e) {
-      $this->assertInstanceOf(ExtensionNameLengthException::class, $e);
-    }
-
-    // Since for the UI, the submit callback uses FALSE, test that too.
-    $message = new FormattableMarkup('Exception thrown when enabling as if via the UI the module %name with a name length over the allowed maximum', ['%name' => $module_name]);
-    try {
-      $this->container->get('module_installer')->install([$module_name], FALSE);
-      $this->fail($message);
-    }
-    catch (\Exception $e) {
-      $this->assertInstanceOf(ExtensionNameLengthException::class, $e);
-    }
+    $this->expectException(ExtensionNameLengthException::class);
+    $this->expectExceptionMessage("Module name 'invalid_module_name_over_the_maximum_allowed_character_length' is over the maximum allowed length of 50 characters");
+    $this->moduleInstaller->install([$module_name], FALSE);
   }
 
 }