class NewDefaultThemeBlocksTest

Same name in other branches
  1. 9 core/modules/block/tests/src/Kernel/NewDefaultThemeBlocksTest.php \Drupal\Tests\block\Kernel\NewDefaultThemeBlocksTest
  2. 8.9.x core/modules/block/tests/src/Kernel/NewDefaultThemeBlocksTest.php \Drupal\Tests\block\Kernel\NewDefaultThemeBlocksTest
  3. 11.x core/modules/block/tests/src/Kernel/NewDefaultThemeBlocksTest.php \Drupal\Tests\block\Kernel\NewDefaultThemeBlocksTest

Tests that a new default theme gets blocks.

@group block

Hierarchy

Expanded class hierarchy of NewDefaultThemeBlocksTest

File

core/modules/block/tests/src/Kernel/NewDefaultThemeBlocksTest.php, line 15

Namespace

Drupal\Tests\block\Kernel
View source
class NewDefaultThemeBlocksTest extends KernelTestBase {
    use BlockCreationTrait;
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'block',
        'system',
        'user',
    ];
    
    /**
     * The theme installer service.
     *
     * @var \Drupal\Core\Extension\ThemeInstallerInterface
     */
    protected $themeInstaller;
    
    /**
     * The default theme.
     */
    protected $defaultTheme;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->installConfig([
            'system',
        ]);
        
        /** @var \Drupal\Core\Extension\ThemeInstallerInterface $themeInstaller */
        $this->themeInstaller = $this->container
            ->get('theme_installer');
        $this->defaultTheme = $this->config('system.theme')
            ->get('default');
    }
    
    /**
     * Check the blocks are correctly copied by block_themes_installed().
     */
    public function testNewDefaultThemeBlocks() : void {
        $default_theme = $this->defaultTheme;
        $theme_installer = $this->themeInstaller;
        $theme_installer->install([
            $default_theme,
        ]);
        // Add two instances of the user login block.
        $this->placeBlock('user_login_block', [
            'id' => $default_theme . '_' . $this->randomMachineName(8),
        ]);
        $this->placeBlock('user_login_block', [
            'id' => $default_theme . '_' . $this->randomMachineName(8),
        ]);
        // Add an instance of a different block.
        $this->placeBlock('system_powered_by_block', [
            'id' => $default_theme . '_' . $this->randomMachineName(8),
        ]);
        // Install a different theme that does not have blocks.
        $new_theme = 'test_theme';
        // The new theme is different from the previous default theme.
        $this->assertNotEquals($new_theme, $default_theme);
        $theme_installer->install([
            $new_theme,
        ]);
        $this->config('system.theme')
            ->set('default', $new_theme)
            ->save();
        $block_storage = $this->container
            ->get('entity_type.manager')
            ->getStorage('block');
        // Ensure that the new default theme has the same blocks as the previous
        // default theme.
        $default_block_names = $block_storage->getQuery()
            ->accessCheck(FALSE)
            ->condition('theme', $default_theme)
            ->execute();
        $new_blocks = $block_storage->getQuery()
            ->accessCheck(FALSE)
            ->condition('theme', $new_theme)
            ->execute();
        $this->assertSameSize($default_block_names, $new_blocks);
        foreach ($default_block_names as $default_block_name) {
            // Remove the matching block from the list of blocks in the new theme.
            // For example, if the old theme has block.block.stark_admin,
            // unset block.block.olivero_admin.
            unset($new_blocks[str_replace($default_theme . '_', $new_theme . '_', $default_block_name)]);
        }
        $this->assertEmpty($new_blocks);
        // Install a hidden base theme and ensure blocks are not copied.
        $base_theme = 'test_basetheme';
        $theme_installer->install([
            $base_theme,
        ]);
        $new_blocks = $block_storage->getQuery()
            ->accessCheck(FALSE)
            ->condition('theme', $base_theme)
            ->execute();
        $this->assertEmpty($new_blocks);
    }
    
    /**
     * Checks that a theme block is still created when same ID exists.
     */
    public function testBlockCollision() : void {
        $default_theme = $this->defaultTheme;
        $theme_installer = $this->themeInstaller;
        $theme_installer->install([
            $default_theme,
        ]);
        // Add two instances of the user login block with machine
        // names that will collide.
        $this->placeBlock('user_login_block', [
            'id' => 'user_login_block',
        ]);
        $this->placeBlock('user_login_block', [
            'id' => $default_theme . '_user_login_block',
        ]);
        // Add an instance of a different block.
        $this->placeBlock('system_powered_by_block', [
            'id' => $default_theme . '_' . strtolower($this->randomMachineName(8)),
        ]);
        // Install a different theme that does not have blocks.
        $new_theme = 'test_theme';
        // The new theme is different from the previous default theme.
        $this->assertNotEquals($new_theme, $default_theme);
        $theme_installer->install([
            $new_theme,
        ]);
        $this->config('system.theme')
            ->set('default', $new_theme)
            ->save();
        $block_storage = $this->container
            ->get('entity_type.manager')
            ->getStorage('block');
        // Ensure that the new default theme has the same blocks as the previous
        // default theme.
        $default_block_names = $block_storage->getQuery()
            ->accessCheck(FALSE)
            ->condition('theme', $default_theme)
            ->execute();
        $new_blocks = $block_storage->getQuery()
            ->accessCheck(FALSE)
            ->condition('theme', $new_theme)
            ->execute();
        $this->assertSameSize($default_block_names, $new_blocks);
        foreach ($default_block_names as $default_block_name) {
            // Remove the matching block from the list of blocks in the new theme.
            // For example, if the old theme has block.block.stark_admin,
            // unset block.block.olivero_admin.
            unset($new_blocks[str_replace($default_theme . '_', $new_theme . '_', $default_block_name)]);
        }
        // The test_theme_user_login_block machine name is already in use, so therefore
        // \Drupal\block\BlockRepository::getUniqueMachineName
        // appends a counter.
        unset($new_blocks[$new_theme . '_user_login_block_2']);
        $this->assertEmpty($new_blocks);
        // Install a hidden base theme and ensure blocks are not copied.
        $base_theme = 'test_basetheme';
        $theme_installer->install([
            $base_theme,
        ]);
        $new_blocks = $block_storage->getQuery()
            ->accessCheck(FALSE)
            ->condition('theme', $base_theme)
            ->execute();
        // Installing a hidden base theme does not copy the blocks from the default
        // theme.
        $this->assertEmpty($new_blocks);
    }

}

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.
BlockCreationTrait::placeBlock protected function Creates a block instance based on default settings.
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.
NewDefaultThemeBlocksTest::$defaultTheme protected property The default theme.
NewDefaultThemeBlocksTest::$modules protected static property Modules to install. Overrides KernelTestBase::$modules
NewDefaultThemeBlocksTest::$themeInstaller protected property The theme installer service.
NewDefaultThemeBlocksTest::setUp protected function Overrides KernelTestBase::setUp
NewDefaultThemeBlocksTest::testBlockCollision public function Checks that a theme block is still created when same ID exists.
NewDefaultThemeBlocksTest::testNewDefaultThemeBlocks public function Check the blocks are correctly copied by block_themes_installed().
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.
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.