class ConfigActionsTest

Same name in this branch
  1. 11.x core/modules/media/tests/src/Kernel/ConfigActionsTest.php \Drupal\Tests\media\Kernel\ConfigActionsTest
  2. 11.x core/modules/language/tests/src/Kernel/ConfigActionsTest.php \Drupal\Tests\language\Kernel\ConfigActionsTest
  3. 11.x core/modules/field/tests/src/Kernel/ConfigActionsTest.php \Drupal\Tests\field\Kernel\ConfigActionsTest
  4. 11.x core/modules/contact/tests/src/Kernel/ConfigActionsTest.php \Drupal\Tests\contact\Kernel\ConfigActionsTest
  5. 11.x core/modules/node/tests/src/Kernel/ConfigActionsTest.php \Drupal\Tests\node\Kernel\ConfigActionsTest
  6. 11.x core/modules/image/tests/src/Kernel/ConfigActionsTest.php \Drupal\Tests\image\Kernel\ConfigActionsTest

@covers \Drupal\block\Plugin\ConfigAction\PlaceBlock @covers \Drupal\block\Plugin\ConfigAction\PlaceBlockDeriver @group block

Hierarchy

Expanded class hierarchy of ConfigActionsTest

File

core/modules/block/tests/src/Kernel/ConfigActionsTest.php, line 21

Namespace

Drupal\Tests\block\Kernel
View source
class ConfigActionsTest extends KernelTestBase {
    use BlockCreationTrait;
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'block',
        'system',
        'user',
    ];
    private readonly ConfigActionManager $configActionManager;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->container
            ->get(ThemeInstallerInterface::class)
            ->install([
            'olivero',
            'claro',
            'umami',
        ]);
        $this->config('system.theme')
            ->set('default', 'olivero')
            ->set('admin', 'claro')
            ->save();
        $this->configActionManager = $this->container
            ->get('plugin.manager.config_action');
    }
    public function testEntityMethodActions() : void {
        $block = $this->placeBlock('system_messages_block', [
            'theme' => 'olivero',
        ]);
        $this->assertSame('content', $block->getRegion());
        $this->assertSame(0, $block->getWeight());
        $this->configActionManager
            ->applyAction('entity_method:block.block:setRegion', $block->getConfigDependencyName(), 'highlighted');
        $this->configActionManager
            ->applyAction('entity_method:block.block:setWeight', $block->getConfigDependencyName(), -10);
        $block = Block::load($block->id());
        $this->assertSame('highlighted', $block->getRegion());
        $this->assertSame(-10, $block->getWeight());
    }
    
    /**
     * @testWith ["placeBlockInDefaultTheme"]
     *           ["placeBlockInAdminTheme"]
     */
    public function testPlaceBlockActionOnlyWorksOnBlocks(string $action) : void {
        $this->expectException(PluginNotFoundException::class);
        $this->expectExceptionMessage("The \"{$action}\" plugin does not exist.");
        $this->configActionManager
            ->applyAction($action, 'user.role.anonymous', []);
    }
    public function testPlaceBlockActionDoesNotChangeExistingBlock() : void {
        $extant_region = Block::load('olivero_powered')->getRegion();
        $this->assertNotSame('content', $extant_region);
        $this->configActionManager
            ->applyAction('placeBlockInDefaultTheme', 'block.block.olivero_powered', [
            'plugin' => 'system_powered_by_block',
            'region' => [
                'olivero' => 'content',
            ],
        ]);
        // The extant block should be unchanged.
        $this->assertSame($extant_region, Block::load('olivero_powered')->getRegion());
    }
    
    /**
     * @testWith ["placeBlockInDefaultTheme", "olivero", "header"]
     *           ["placeBlockInAdminTheme", "claro", "page_bottom"]
     */
    public function testPlaceBlockInDynamicRegion(string $action, string $expected_theme, string $expected_region) : void {
        $this->configActionManager
            ->applyAction($action, 'block.block.test_block', [
            'plugin' => 'system_powered_by_block',
            'region' => [
                'olivero' => 'header',
                'claro' => 'page_bottom',
            ],
            'default_region' => 'content',
        ]);
        $block = Block::load('test_block');
        $this->assertInstanceOf(Block::class, $block);
        $this->assertSame('system_powered_by_block', $block->getPluginId());
        $this->assertSame($expected_theme, $block->getTheme());
        $this->assertSame($expected_region, $block->getRegion());
        $this->expectException(ConfigActionException::class);
        $this->expectExceptionMessage('Cannot determine which region to place this block into, because no default region was provided.');
        $this->configActionManager
            ->applyAction($action, 'block.block.no_region', [
            'plugin' => 'system_powered_by_block',
            'region' => [],
        ]);
    }
    
    /**
     * @testWith ["placeBlockInDefaultTheme", "olivero"]
     *           ["placeBlockInAdminTheme", "claro"]
     */
    public function testPlaceBlockInStaticRegion(string $action, string $expected_theme) : void {
        $this->configActionManager
            ->applyAction($action, 'block.block.test_block', [
            'plugin' => 'system_powered_by_block',
            'region' => 'content',
        ]);
        $block = Block::load('test_block');
        $this->assertInstanceOf(Block::class, $block);
        $this->assertSame('system_powered_by_block', $block->getPluginId());
        $this->assertSame($expected_theme, $block->getTheme());
        $this->assertSame('content', $block->getRegion());
    }
    public function testPlaceBlockInDefaultRegion() : void {
        $this->config('system.theme')
            ->set('default', 'umami')
            ->save();
        $this->testPlaceBlockInDynamicRegion('placeBlockInDefaultTheme', 'umami', 'content');
    }
    public function testPlaceBlockAtPosition() : void {
        // Ensure there's at least one block already in the region.
        $block = Block::create([
            'id' => 'block_1',
            'theme' => 'olivero',
            'region' => 'content_above',
            'weight' => 0,
            'plugin' => 'system_powered_by_block',
        ]);
        $block->save();
        $this->configActionManager
            ->applyAction('placeBlockInDefaultTheme', 'block.block.first', [
            'plugin' => $block->getPluginId(),
            'region' => [
                $block->getTheme() => $block->getRegion(),
            ],
            'position' => 'first',
        ]);
        $this->configActionManager
            ->applyAction('placeBlockInDefaultTheme', 'block.block.last', [
            'plugin' => $block->getPluginId(),
            'region' => [
                $block->getTheme() => $block->getRegion(),
            ],
            'position' => 'last',
        ]);
        // Query for blocks in the region, ordered by weight.
        $blocks = $this->container
            ->get(EntityTypeManagerInterface::class)
            ->getStorage('block')
            ->getQuery()
            ->condition('theme', $block->getTheme())
            ->condition('region', $block->getRegion())
            ->sort('weight', 'ASC')
            ->execute();
        $this->assertGreaterThanOrEqual(3, $blocks);
        $this->assertSame('first', key($blocks));
        $this->assertSame('last', end($blocks));
    }

}

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.
BlockCreationTrait::placeBlock protected function Creates a block instance based on default settings.
ConfigActionsTest::$configActionManager private property
ConfigActionsTest::$modules protected static property Modules to install. Overrides KernelTestBase::$modules
ConfigActionsTest::setUp protected function Overrides KernelTestBase::setUp
ConfigActionsTest::testEntityMethodActions public function
ConfigActionsTest::testPlaceBlockActionDoesNotChangeExistingBlock public function
ConfigActionsTest::testPlaceBlockActionOnlyWorksOnBlocks public function @testWith ["placeBlockInDefaultTheme"]
["placeBlockInAdminTheme"]
ConfigActionsTest::testPlaceBlockAtPosition public function
ConfigActionsTest::testPlaceBlockInDefaultRegion public function
ConfigActionsTest::testPlaceBlockInDynamicRegion public function @testWith ["placeBlockInDefaultTheme", "olivero", "header"]
["placeBlockInAdminTheme", "claro", "page_bottom"]
ConfigActionsTest::testPlaceBlockInStaticRegion public function @testWith ["placeBlockInDefaultTheme", "olivero"]
["placeBlockInAdminTheme", "claro"]
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.
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.