ClassLoaderTest.php

<?php

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

use Drupal\module_autoload_test\SomeClass;
use Drupal\Tests\BrowserTestBase;

/**
 * Tests class loading for modules.
 *
 * @group Module
 */
class ClassLoaderTest extends BrowserTestBase {
  
  /**
   * The expected result from calling the module-provided class' method.
   *
   * @var string
   */
  protected $expected = 'Drupal\\module_autoload_test\\SomeClass::testMethod() was invoked.';
  
  /**
   * {@inheritdoc}
   */
  protected $apcuEnsureUniquePrefix = TRUE;
  
  /**
   * {@inheritdoc}
   */
  protected $defaultTheme = 'stark';
  
  /**
   * Tests that module-provided classes can be loaded when a module is enabled.
   *
   * @see \Drupal\module_autoload_test\SomeClass
   */
  public function testClassLoading() : void {
    // Enable the module_test and module_autoload_test modules.
    \Drupal::service('module_installer')->install([
      'module_test',
      'module_autoload_test',
    ], FALSE);
    $this->resetAll();
    // Check twice to test an unprimed and primed system_list() cache.
    for ($i = 0; $i < 2; $i++) {
      $this->drupalGet('module-test/class-loading');
      $this->assertSession()
        ->statusCodeEquals(200);
      $this->assertSession()
        ->pageTextContains($this->expected);
    }
  }
  
  /**
   * Tests that module-provided classes can't be loaded if module not installed.
   *
   * @see \Drupal\module_autoload_test\SomeClass
   */
  public function testClassLoadingNotInstalledModules() : void {
    // Enable the module_test module.
    \Drupal::service('module_installer')->install([
      'module_test',
    ], FALSE);
    $this->resetAll();
    // Check twice to test an unprimed and primed system_list() cache.
    for ($i = 0; $i < 2; $i++) {
      $this->drupalGet('module-test/class-loading');
      $this->assertSession()
        ->statusCodeEquals(200);
      $this->assertSession()
        ->pageTextNotContains($this->expected);
    }
  }
  
  /**
   * Tests that module-provided classes can't be loaded from disabled modules.
   *
   * @see \Drupal\module_autoload_test\SomeClass
   */
  public function testClassLoadingDisabledModules() : void {
    // Enable the module_test and module_autoload_test modules.
    \Drupal::service('module_installer')->install([
      'module_test',
      'module_autoload_test',
    ], FALSE);
    $this->resetAll();
    // Ensure that module_autoload_test is disabled.
    $this->container
      ->get('module_installer')
      ->uninstall([
      'module_autoload_test',
    ], FALSE);
    $this->resetAll();
    // Check twice to test an unprimed and primed system_list() cache.
    for ($i = 0; $i < 2; $i++) {
      $this->drupalGet('module-test/class-loading');
      $this->assertSession()
        ->statusCodeEquals(200);
      $this->assertSession()
        ->pageTextNotContains($this->expected);
    }
  }
  
  /**
   * Ensures the negative caches in the class loader don't result in crashes.
   */
  public function testMultipleModules() : void {
    $this->drupalLogin($this->drupalCreateUser([
      'administer modules',
    ]));
    $edit = [
      "modules[module_install_class_loader_test1][enable]" => TRUE,
      "modules[module_install_class_loader_test2][enable]" => TRUE,
    ];
    $this->drupalGet('admin/modules');
    $this->submitForm($edit, 'Install');
    $this->rebuildContainer();
    $this->assertTrue(\Drupal::moduleHandler()->moduleExists('module_install_class_loader_test2'), 'The module_install_class_loader_test2 module has been installed.');
  }
  
  /**
   * Tests that .module files can use class constants in main section.
   */
  public function testAutoloadFromModuleFile() : void {
    $this->assertFalse(defined('MODULE_AUTOLOAD_TEST_CONSTANT'));
    // Create use with required permissions.
    $this->drupalLogin($this->drupalCreateUser([
      'administer modules',
    ]));
    $edit = [
      "modules[module_autoload_test][enable]" => TRUE,
    ];
    $this->drupalGet('admin/modules');
    $this->submitForm($edit, 'Install');
    $this->assertSession()
      ->statusCodeEquals(200);
    $this->resetAll();
    $this->assertSame(SomeClass::TEST, MODULE_AUTOLOAD_TEST_CONSTANT);
  }

}