class ResolvedLibraryDefinitionsFilesMatchTest

Same name in other branches
  1. 9 core/tests/Drupal/KernelTests/Core/Asset/ResolvedLibraryDefinitionsFilesMatchTest.php \Drupal\KernelTests\Core\Asset\ResolvedLibraryDefinitionsFilesMatchTest
  2. 8.9.x core/tests/Drupal/KernelTests/Core/Asset/ResolvedLibraryDefinitionsFilesMatchTest.php \Drupal\KernelTests\Core\Asset\ResolvedLibraryDefinitionsFilesMatchTest
  3. 11.x core/tests/Drupal/KernelTests/Core/Asset/ResolvedLibraryDefinitionsFilesMatchTest.php \Drupal\KernelTests\Core\Asset\ResolvedLibraryDefinitionsFilesMatchTest

Tests that the asset files for all core libraries exist.

This test also changes the active theme to each core theme to verify the libraries after theme-level libraries-override and libraries-extend are applied.

@group Asset

Hierarchy

Expanded class hierarchy of ResolvedLibraryDefinitionsFilesMatchTest

File

core/tests/Drupal/KernelTests/Core/Asset/ResolvedLibraryDefinitionsFilesMatchTest.php, line 19

Namespace

Drupal\KernelTests\Core\Asset
View source
class ResolvedLibraryDefinitionsFilesMatchTest extends KernelTestBase {
    
    /**
     * The theme handler.
     *
     * @var \Drupal\Core\Extension\ThemeHandlerInterface
     */
    protected $themeHandler;
    
    /**
     * The theme initialization.
     *
     * @var \Drupal\Core\Theme\ThemeInitializationInterface
     */
    protected $themeInitialization;
    
    /**
     * The theme manager.
     *
     * @var \Drupal\Core\Theme\ThemeManagerInterface
     */
    protected $themeManager;
    
    /**
     * The library discovery service.
     *
     * @var \Drupal\Core\Asset\LibraryDiscoveryInterface
     */
    protected $libraryDiscovery;
    
    /**
     * A list of all core modules.
     *
     * @var string[]
     */
    protected $allModules;
    
    /**
     * A list of all core themes.
     *
     * We hardcode this because test themes don't use a 'package' or 'hidden' key
     * so we don't have a good way of filtering to only get "real" themes.
     *
     * @var string[]
     */
    protected $allThemes = [
        'claro',
        'olivero',
        'stable9',
        'stark',
    ];
    
    /**
     * A list of libraries to skip checking, in the format extension/library_name.
     *
     * @var string[]
     */
    protected $librariesToSkip = [
        // Locale has a "dummy" library that does not actually exist.
'locale/translations',
        // Core has a "dummy" library that does not actually exist.
'core/ckeditor5.translations',
    ];
    
    /**
     * A list of all paths that have been checked.
     *
     * @var array[]
     */
    protected $pathsChecked;
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'system',
        'user',
        'path_alias',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        // Enable all core modules.
        $all_modules = $this->container
            ->get('extension.list.module')
            ->getList();
        $all_modules = array_filter($all_modules, function ($module) {
            // Filter contrib, hidden, already enabled modules and modules in the
            // Testing package.
            if ($module->origin !== 'core' || !empty($module->info['hidden']) || $module->status == TRUE || $module->info['package'] == 'Testing' || $module->info[ExtensionLifecycle::LIFECYCLE_IDENTIFIER] === ExtensionLifecycle::EXPERIMENTAL || $module->info[ExtensionLifecycle::LIFECYCLE_IDENTIFIER] === ExtensionLifecycle::DEPRECATED) {
                return FALSE;
            }
            return TRUE;
        });
        // Install the 'user' entity schema because the workspaces module's install
        // hook creates a workspace with default uid of 1. Then the layout_builder
        // module's implementation of hook_entity_presave will cause
        // \Drupal\Core\TypedData\Validation\RecursiveValidator::validate() to run
        // on the workspace which will fail because the user table is not present.
        // @todo Remove this in https://www.drupal.org/node/3039217.
        $this->installEntitySchema('user');
        // Install the 'path_alias' entity schema because the path alias path
        // processor requires it.
        $this->installEntitySchema('path_alias');
        // Remove demo_umami_content module as its install hook creates content
        // that relies on the presence of entity tables and various other elements
        // not present in a kernel test.
        unset($all_modules['demo_umami_content']);
        $this->allModules = array_keys($all_modules);
        $this->allModules[] = 'system';
        $this->allModules[] = 'user';
        $this->allModules[] = 'path_alias';
        $database_module = \Drupal::database()->getProvider();
        if ($database_module !== 'core') {
            $this->allModules[] = $database_module;
        }
        sort($this->allModules);
        $this->container
            ->get('module_installer')
            ->install($this->allModules);
        // Install all core themes.
        sort($this->allThemes);
        $this->container
            ->get('theme_installer')
            ->install($this->allThemes);
        $this->themeHandler = $this->container
            ->get('theme_handler');
        $this->themeInitialization = $this->container
            ->get('theme.initialization');
        $this->themeManager = $this->container
            ->get('theme.manager');
        $this->libraryDiscovery = $this->container
            ->get('library.discovery');
    }
    
    /**
     * Ensures that all core module and theme library files exist.
     */
    public function testCoreLibraryCompleteness() : void {
        // First verify all libraries with no active theme.
        $this->verifyLibraryFilesExist($this->getAllLibraries());
        // Then verify all libraries for each core theme. This may seem like
        // overkill but themes can override and extend other extensions' libraries
        // and these changes are only applied for the active theme.
        foreach ($this->allThemes as $theme) {
            $this->themeManager
                ->setActiveTheme($this->themeInitialization
                ->getActiveThemeByName($theme));
            $this->libraryDiscovery
                ->clearCachedDefinitions();
            $this->verifyLibraryFilesExist($this->getAllLibraries());
        }
    }
    
    /**
     * Checks that all the library files exist.
     *
     * @param array[] $library_definitions
     *   An array of library definitions, keyed by extension, then by library, and
     *   so on.
     */
    protected function verifyLibraryFilesExist($library_definitions) {
        foreach ($library_definitions as $extension => $libraries) {
            foreach ($libraries as $library_name => $library) {
                if (in_array("{$extension}/{$library_name}", $this->librariesToSkip)) {
                    continue;
                }
                // Check that all the assets exist.
                foreach ([
                    'css',
                    'js',
                ] as $asset_type) {
                    foreach ($library[$asset_type] as $asset) {
                        $file = $asset['data'];
                        $path = $this->root . '/' . $file;
                        // Only check and assert each file path once.
                        if (!isset($this->pathsChecked[$path])) {
                            $this->assertFileExists($path, "{$file} file referenced from the {$extension}/{$library_name} library does not exist.");
                            $this->pathsChecked[$path] = TRUE;
                        }
                    }
                }
            }
        }
    }
    
    /**
     * Gets all libraries for core and all installed modules.
     *
     * @return \Drupal\Core\Extension\Extension[]
     */
    protected function getAllLibraries() {
        $modules = \Drupal::moduleHandler()->getModuleList();
        $extensions = $modules;
        $module_list = array_keys($modules);
        sort($module_list);
        $this->assertEquals($this->allModules, $module_list, 'All core modules are installed.');
        $themes = $this->themeHandler
            ->listInfo();
        $extensions += $themes;
        $theme_list = array_keys($themes);
        sort($theme_list);
        $this->assertEquals($this->allThemes, $theme_list, 'All core themes are installed.');
        $libraries['core'] = $this->libraryDiscovery
            ->getLibrariesByExtension('core');
        foreach ($extensions as $extension_name => $extension) {
            $library_file = $extension->getPath() . '/' . $extension_name . '.libraries.yml';
            if (is_file($this->root . '/' . $library_file)) {
                $libraries[$extension_name] = $this->libraryDiscovery
                    ->getLibrariesByExtension($extension_name);
            }
        }
        return $libraries;
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
AssertContentTrait::$content protected property The current raw content.
AssertContentTrait::$drupalSettings protected property The drupalSettings value from the current raw $content.
AssertContentTrait::$elements protected property The XML structure parsed from the current raw $content. 1
AssertContentTrait::$plainTextContent protected property The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink protected function Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds protected function Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped protected function Passes if raw text IS NOT found escaped on loaded page, fail otherwise.
AssertContentTrait::assertNoField protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected protected function Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern protected function Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw protected function Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle protected function Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText protected function Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern protected function Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput protected function Asserts themed output.
AssertContentTrait::assertTitle protected function Pass if the page title is the given string.
AssertContentTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper protected function Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery protected function Builds an XPath query.
AssertContentTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings protected function Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent protected function Gets the current raw content.
AssertContentTrait::getSelectedItem protected function Get the selected value from a select field.
AssertContentTrait::getTextContent protected function Retrieves the plain-text content from the current raw content.
AssertContentTrait::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace protected function Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings protected function Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent protected function Sets the raw content (e.g. HTML).
AssertContentTrait::xpath protected function Performs an xpath search on the contents of the internal browser.
ConfigTestTrait::configImporter protected function Returns a ConfigImporter object to import test configuration.
ConfigTestTrait::copyConfig protected function Copies configuration objects from source storage to target storage.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
KernelTestBase::$backupGlobals protected property Back up and restore any global variables that may be changed by tests.
KernelTestBase::$backupStaticAttributes protected property Back up and restore static class properties that may be changed by tests.
KernelTestBase::$backupStaticAttributesBlacklist protected property Contains a few static class properties for performance.
KernelTestBase::$classLoader protected property
KernelTestBase::$configImporter protected property @todo Move into Config test base class. 6
KernelTestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking. 3
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$keyValue protected property The key_value service that must persist between container rebuilds.
KernelTestBase::$preserveGlobalState protected property Do not forward any global state from the parent process to the processes
that run the actual tests.
KernelTestBase::$root protected property The app root.
KernelTestBase::$runTestInSeparateProcess protected property Kernel tests are run in separate processes because they allow autoloading
of code from extensions. Running the test in a separate process isolates
this behavior from other tests. Subclasses should not override this
property.
KernelTestBase::$siteDirectory protected property
KernelTestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 9
KernelTestBase::$usesSuperUserAccessPolicy protected property Set to TRUE to make user 1 a super user. 7
KernelTestBase::$vfsRoot protected property The virtual filesystem root directory.
KernelTestBase::assertPostConditions protected function 1
KernelTestBase::bootEnvironment protected function Bootstraps a basic test environment.
KernelTestBase::bootKernel protected function Bootstraps a kernel for a test. 1
KernelTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::disableModules protected function Disables modules for this test.
KernelTestBase::enableModules protected function Enables modules for this test. 1
KernelTestBase::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo protected function Returns the Database connection info to be used for this test. 2
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to install.
KernelTestBase::getModulesToEnable private static function Returns the modules to install for this test.
KernelTestBase::initFileCache protected function Initializes the FileCache component.
KernelTestBase::installConfig protected function Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema protected function Installs the storage schema for a specific entity type.
KernelTestBase::installSchema protected function Installs database tables from a module schema definition.
KernelTestBase::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 27
KernelTestBase::render protected function Renders a render array. 1
KernelTestBase::setInstallProfile protected function Sets the install profile and rebuilds the container to update it.
KernelTestBase::setSetting protected function Sets an in-memory Settings variable.
KernelTestBase::setUpBeforeClass public static function 1
KernelTestBase::setUpFilesystem protected function Sets up the filesystem, so things like the file directory. 2
KernelTestBase::stop Deprecated protected function Stops test execution.
KernelTestBase::tearDown protected function 6
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__get public function
KernelTestBase::__sleep public function Prevents serializing any properties.
PhpUnitWarnings::$deprecationWarnings private static property Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning public function Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
RandomGeneratorTrait::getRandomGenerator protected function Gets the random generator for the utility methods.
RandomGeneratorTrait::randomMachineName protected function Generates a unique random string containing letters and numbers.
RandomGeneratorTrait::randomObject public function Generates a random PHP object.
RandomGeneratorTrait::randomString public function Generates a pseudo-random string of ASCII characters of codes 32 to 126.
RandomGeneratorTrait::randomStringValidate Deprecated public function Callback for random string validation.
ResolvedLibraryDefinitionsFilesMatchTest::$allModules protected property A list of all core modules.
ResolvedLibraryDefinitionsFilesMatchTest::$allThemes protected property A list of all core themes.
ResolvedLibraryDefinitionsFilesMatchTest::$librariesToSkip protected property A list of libraries to skip checking, in the format extension/library_name.
ResolvedLibraryDefinitionsFilesMatchTest::$libraryDiscovery protected property The library discovery service.
ResolvedLibraryDefinitionsFilesMatchTest::$modules protected static property Modules to install. Overrides KernelTestBase::$modules
ResolvedLibraryDefinitionsFilesMatchTest::$pathsChecked protected property A list of all paths that have been checked.
ResolvedLibraryDefinitionsFilesMatchTest::$themeHandler protected property The theme handler.
ResolvedLibraryDefinitionsFilesMatchTest::$themeInitialization protected property The theme initialization.
ResolvedLibraryDefinitionsFilesMatchTest::$themeManager protected property The theme manager.
ResolvedLibraryDefinitionsFilesMatchTest::getAllLibraries protected function Gets all libraries for core and all installed modules.
ResolvedLibraryDefinitionsFilesMatchTest::setUp protected function Overrides KernelTestBase::setUp
ResolvedLibraryDefinitionsFilesMatchTest::testCoreLibraryCompleteness public function Ensures that all core module and theme library files exist.
ResolvedLibraryDefinitionsFilesMatchTest::verifyLibraryFilesExist protected function Checks that all the library files exist.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements Deprecated private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements Deprecated protected function Check module requirements for the Drupal use case.
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.

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