class StableLibraryOverrideTest in Drupal 10

Tests Stable's library overrides.

@group Theme

Hierarchy

• class \Drupal\KernelTests\KernelTestBase extends \PHPUnit\Framework\TestCase implements ServiceProviderInterface uses \Drupal\Tests\PhpUnitCompatibilityTrait, \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, AssertContentTrait, ConfigTestTrait, ExtensionListTestTrait, RandomGeneratorTrait, TestRequirementsTrait, PhpUnitWarnings
  • class \Drupal\KernelTests\Core\Theme\StableLibraryOverrideTestBase
    • class \Drupal\KernelTests\Core\Theme\StableLibraryOverrideTest

File

core/tests/Drupal/KernelTests/Core/Theme/StableLibraryOverrideTest.php, line 10

Namespace

Drupal\KernelTests\Core\Theme

class StableLibraryOverrideTest extends StableLibraryOverrideTestBase {

  /**
   * The theme manager.
   *
   * @var \Drupal\Core\Theme\ThemeManagerInterface
   */
  protected $themeManager;

  /**
   * The theme initialization.
   *
   * @var \Drupal\Core\Theme\ThemeInitializationInterface
   */
  protected $themeInitialization;

  /**
   * The library discovery service.
   *
   * @var \Drupal\Core\Asset\LibraryDiscoveryInterface
   */
  protected $libraryDiscovery;

  /**
   * A list of all core modules.
   *
   * @var string[]
   */
  protected $allModules;

  /**
   * A list of libraries to skip checking, in the format extension/library_name.
   *
   * @var string[]
   */
  protected $librariesToSkip = [
    'views/views.responsive-grid',
  ];

  /**
   * {@inheritdoc}
   */
  protected static $modules = [
    'system',
    'user',
    'path_alias',
  ];

  /**
   * {@inheritdoc}
   */
  protected function setUp() : void {
    parent::setUp();
    $this->container
      ->get('theme_installer')
      ->install([
      'stable',
    ]);

    // Enable all core modules.
    $this
      ->enableVisibleAndStableCoreModules();
    $this->themeManager = $this->container
      ->get('theme.manager');
    $this->themeInitialization = $this->container
      ->get('theme.initialization');
    $this->libraryDiscovery = $this->container
      ->get('library.discovery');
  }

  /**
   * Ensures that Stable overrides all relevant core library assets.
   */
  public function testStableLibraryOverrides() {

    // First get the clean library definitions with no active theme.
    $libraries_before = $this
      ->getAllLibraries();
    $libraries_before = $this
      ->removeVendorAssets($libraries_before);
    $this->themeManager
      ->setActiveTheme($this->themeInitialization
      ->getActiveThemeByName('stable'));
    $this->libraryDiscovery
      ->clearCachedDefinitions();

    // Now get the library definitions with Stable as the active theme.
    $libraries_after = $this
      ->getAllLibraries();
    $libraries_after = $this
      ->removeVendorAssets($libraries_after);
    foreach ($libraries_before as $extension => $libraries) {
      foreach ($libraries as $library_name => $library) {

        // Allow skipping libraries.
        if (in_array("{$extension}/{$library_name}", $this->librariesToSkip)) {
          continue;
        }
        $library_after = $libraries_after[$extension][$library_name];

        // Check that all the CSS assets are overridden.
        foreach ($library['css'] as $index => $asset) {
          $clean_path = $asset['data'];
          $stable_path = $library_after['css'][$index]['data'];

          // Make core/misc assets look like they are coming from a "core"
          // module.
          $replacements = [
            'core/misc/' => "core/modules/core/css/",
          ];
          $expected_path = strtr($clean_path, $replacements);

          // Adjust the module asset paths to correspond with the Stable folder
          // structure.
          $expected_path = str_replace("core/modules/{$extension}/css/", "core/themes/stable/css/{$extension}/", $expected_path);
          $assert_path = str_replace("core/modules/{$extension}/", '', $clean_path);
          $this
            ->assertEquals($expected_path, $stable_path, "{$assert_path} from the {$extension}/{$library_name} library is overridden in Stable.");
        }
      }
    }
  }

}