class Stable9LibraryOverrideTest

Same name in other branches
  1. 9 core/tests/Drupal/KernelTests/Core/Theme/Stable9LibraryOverrideTest.php \Drupal\KernelTests\Core\Theme\Stable9LibraryOverrideTest
  2. 10 core/tests/Drupal/KernelTests/Core/Theme/Stable9LibraryOverrideTest.php \Drupal\KernelTests\Core\Theme\Stable9LibraryOverrideTest

Tests Stable 9's library overrides.

@group Theme

Hierarchy

Expanded class hierarchy of Stable9LibraryOverrideTest

File

core/tests/Drupal/KernelTests/Core/Theme/Stable9LibraryOverrideTest.php, line 12

Namespace

Drupal\KernelTests\Core\Theme
View source
class Stable9LibraryOverrideTest extends StableLibraryOverrideTestBase {
    
    /**
     * A list of libraries to skip checking, in the format extension/library_name.
     *
     * @var string[]
     */
    protected $librariesToSkip = [
        'core/drupal.dialog.off_canvas',
        'layout_builder/drupal.layout_builder',
        'views/views.responsive-grid',
        'field_ui/drupal.field_ui.manage_fields',
        'comment/drupal.comment-icon',
        'file/drupal.file-icon',
        'text/drupal.text-icon',
        'link/drupal.link-icon',
        'media/drupal.media-icon',
        'options/drupal.options-icon',
        'telephone/drupal.telephone-icon',
        // This library will be changed in https://www.drupal.org/i/3096017.
'workspaces/drupal.workspaces.toolbar',
        // This library will be removed in https://www.drupal.org/i/3207233.
'workspaces/drupal.workspaces.overview',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'system',
        'user',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->container
            ->get('theme_installer')
            ->install([
            'stable9',
        ]);
        // 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 9 overrides all relevant core library assets.
     */
    public function testStable9LibraryOverrides() : void {
        // 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('stable9'));
        $this->libraryDiscovery
            ->clear();
        // Now get the library definitions with Stable 9 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;
                }
                // Skip internal libraries.
                if (str_starts_with($library_name, 'internal.')) {
                    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 9
                    // folder structure.
                    $replacements = [
                        "core/modules/{$extension}/css/" => "core/themes/stable9/css/{$extension}/",
                        "core/modules/{$extension}/layouts/" => "core/themes/stable9/layouts/{$extension}/",
                    ];
                    $expected_path = strtr($expected_path, $replacements);
                    $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 9.");
                    $this->assertFileExists("{$this->root}/{$clean_path}");
                    $this->assertFileExists("{$this->root}/{$stable_path}");
                }
            }
        }
    }

}

Members

Title Sort descending 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.
ExpectDeprecationTrait::expectDeprecation public function Adds an expected deprecation.
ExpectDeprecationTrait::getCallableName private static function Returns a callable as a string suitable for inclusion in a message.
ExpectDeprecationTrait::setUpErrorHandler public function Sets up the test error handler.
ExpectDeprecationTrait::tearDownErrorHandler public function Tears down the test error handler.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
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. 4
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$keyValue protected property The key_value service that must persist between container rebuilds.
KernelTestBase::$root protected property The app root.
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. 3
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::tearDown protected function 7
KernelTestBase::tearDownCloseDatabaseConnection public function Additional tear down method to close the connection at the end.
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__construct public function
KernelTestBase::__sleep public function Prevents serializing any properties.
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.
Stable9LibraryOverrideTest::$librariesToSkip protected property A list of libraries to skip checking, in the format extension/library_name. Overrides StableLibraryOverrideTestBase::$librariesToSkip
Stable9LibraryOverrideTest::$modules protected static property Modules to install. Overrides KernelTestBase::$modules
Stable9LibraryOverrideTest::setUp protected function Overrides KernelTestBase::setUp
Stable9LibraryOverrideTest::testStable9LibraryOverrides public function Ensures that Stable 9 overrides all relevant core library assets.
StableLibraryOverrideTestBase::$allModules protected property A list of all core modules.
StableLibraryOverrideTestBase::$libraryDiscovery protected property The library discovery service.
StableLibraryOverrideTestBase::$themeInitialization protected property The theme initialization.
StableLibraryOverrideTestBase::$themeManager protected property The theme manager.
StableLibraryOverrideTestBase::enableVisibleAndStableCoreModules protected function Enable all core modules that are not hidden or experimental.
StableLibraryOverrideTestBase::getAllLibraries protected function Gets all libraries for core and all installed modules.
StableLibraryOverrideTestBase::removeVendorAssets protected function Removes all vendor libraries and assets from the library definitions.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
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.