class BlockValidationTest
Same name in other branches
- 10 core/modules/block/tests/src/Kernel/BlockValidationTest.php \Drupal\Tests\block\Kernel\BlockValidationTest
Tests validation of block entities.
@group block @group #slow
Hierarchy
- class \Drupal\KernelTests\KernelTestBase extends \PHPUnit\Framework\TestCase implements \Drupal\Core\DependencyInjection\ServiceProviderInterface uses \Drupal\KernelTests\AssertContentTrait, \Drupal\Tests\RandomGeneratorTrait, \Drupal\Tests\ConfigTestTrait, \Drupal\Tests\ExtensionListTestTrait, \Drupal\Tests\TestRequirementsTrait, \Drupal\Tests\PhpUnitCompatibilityTrait, \Prophecy\PhpUnit\ProphecyTrait, \Drupal\TestTools\Extension\DeprecationBridge\ExpectDeprecationTrait
- class \Drupal\KernelTests\Core\Config\ConfigEntityValidationTestBase extends \Drupal\KernelTests\KernelTestBase
- class \Drupal\Tests\block\Kernel\BlockValidationTest extends \Drupal\KernelTests\Core\Config\ConfigEntityValidationTestBase
- class \Drupal\KernelTests\Core\Config\ConfigEntityValidationTestBase extends \Drupal\KernelTests\KernelTestBase
Expanded class hierarchy of BlockValidationTest
File
-
core/
modules/ block/ tests/ src/ Kernel/ BlockValidationTest.php, line 17
Namespace
Drupal\Tests\block\KernelView source
class BlockValidationTest extends ConfigEntityValidationTestBase {
/**
* {@inheritdoc}
*/
protected static $modules = [
'block',
];
/**
* {@inheritdoc}
*/
protected static array $propertiesWithRequiredKeys = [
'settings' => [
"'id' is a required key.",
"'label' is a required key.",
"'label_display' is a required key.",
"'provider' is a required key.",
],
];
/**
* {@inheritdoc}
*/
protected static array $propertiesWithOptionalValues = [
'provider',
];
/**
* {@inheritdoc}
*/
protected function setUp() : void {
parent::setUp();
$this->container
->get('theme_installer')
->install([
'stark',
]);
$this->entity = Block::create([
'id' => 'test_block',
'theme' => 'stark',
'plugin' => 'system_powered_by_block',
'settings' => [
'label' => 'Powered by Drupal 🚀',
],
]);
$this->entity
->save();
}
/**
* Tests validating a block with an unknown plugin ID.
*/
public function testInvalidPluginId() : void {
$this->entity
->set('plugin', 'block_content:d7c9d8ba-663f-41b4-8756-86bc55c44653');
// Block config entities with invalid block plugin IDs automatically fall
// back to the `broken` block plugin.
// @see https://www.drupal.org/node/2249303
// @see \Drupal\Core\Block\BlockManager::getFallbackPluginId()
// @see \Drupal\Core\Block\Plugin\Block\Broken
$this->assertValidationErrors([]);
$this->entity
->set('plugin', 'non_existent');
// @todo Expect error for this in https://www.drupal.org/project/drupal/issues/3377709
$this->assertValidationErrors([]);
}
/**
* Block names are atypical in that they allow periods in the machine name.
*/
public static function providerInvalidMachineNameCharacters() : array {
$cases = parent::providerInvalidMachineNameCharacters();
// Remove the existing test case that verifies a machine name containing
// periods is invalid.
self::assertSame([
'period.separated',
FALSE,
], $cases['INVALID: period separated']);
unset($cases['INVALID: period separated']);
// And instead add a test case that verifies it is allowed for blocks.
$cases['VALID: period separated'] = [
'period.separated',
TRUE,
];
return $cases;
}
/**
* {@inheritdoc}
*/
protected static function setLabel(ConfigEntityInterface $block, string $label) : void {
static::assertInstanceOf(Block::class, $block);
$settings = $block->get('settings');
static::assertNotEmpty($settings['label']);
$settings['label'] = $label;
$block->set('settings', $settings);
}
/**
* {@inheritdoc}
*/
public function testLabelValidation() : void {
static::setLabel($this->entity, "Multi\nLine");
// TRICKY: because the Block config entity type does not specify a `label`
// key, it is impossible for the generic ::testLabelValidation()
// implementation in the base class to know at which property to expect a
// validation error. Hence it is hardcoded in this case.
$this->assertValidationErrors([
'settings.label' => "Labels are not allowed to span multiple lines or contain control characters.",
]);
}
/**
* Tests validating a block with a non-existent theme.
*/
public function testThemeValidation() : void {
$this->entity
->set('theme', 'non_existent');
$this->assertValidationErrors([
'region' => 'This is not a valid region of the <em class="placeholder">non_existent</em> theme.',
'theme' => "Theme 'non_existent' is not installed.",
]);
}
/**
* {@inheritdoc}
*/
public function testRequiredPropertyValuesMissing(?array $additional_expected_validation_errors_when_missing = NULL) : void {
parent::testRequiredPropertyValuesMissing([
'region' => [
'region' => [
'This is not a valid region of the <em class="placeholder">stark</em> theme.',
'This value should not be null.',
],
],
'theme' => [
'region' => 'This block does not say which theme it appears in.',
],
]);
}
/**
* Tests validating a block's region in a theme.
*/
public function testRegionValidation() : void {
$this->entity
->set('region', 'non_existent');
$this->assertValidationErrors([
'region' => 'This is not a valid region of the <em class="placeholder">stark</em> theme.',
]);
// Set a valid region and assert it is saved properly.
$this->entity
->set('region', 'header');
$this->assertValidationErrors([]);
}
/**
* Tests validating weight.
*/
public function testWeightValidation() : void {
$this->entity
->set('weight', $this->randomString());
$this->assertValidationErrors([
'weight' => [
'This value should be a valid number.',
'This value should be of the correct primitive type.',
],
]);
$this->entity
->set('weight', 10);
$this->assertValidationErrors([]);
}
/**
* @group legacy
*/
public function testWeightCannotBeNull() : void {
$this->entity
->set('weight', NULL);
$this->assertNull($this->entity
->getWeight());
$this->expectDeprecation('Saving a block with a non-integer weight is deprecated in drupal:11.1.0 and removed in drupal:12.0.0. See https://www.drupal.org/node/3462474');
$this->entity
->save();
}
}
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 | Deprecated | 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 | Deprecated | 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 | Deprecated | 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 | Deprecated | protected | function | Asserts that a field does not exist with the given name or ID. | ||
AssertContentTrait::assertNoFieldById | Deprecated | protected | function | Asserts that a field does not exist with the given ID and value. | ||
AssertContentTrait::assertNoFieldByName | Deprecated | protected | function | Asserts that a field does not exist with the given name and value. | ||
AssertContentTrait::assertNoFieldByXPath | Deprecated | protected | function | Asserts that a field does not exist or its value does not match, by XPath. | ||
AssertContentTrait::assertNoFieldChecked | Deprecated | 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 | Deprecated | protected | function | Passes if a link containing a given href (part) is not found. | ||
AssertContentTrait::assertNoLinkByHrefInMainRegion | Deprecated | protected | function | Passes if a link containing a given href is not found in the main region. | ||
AssertContentTrait::assertNoOption | Deprecated | protected | function | Asserts that a select option in the current page does not exist. | ||
AssertContentTrait::assertNoOptionSelected | Deprecated | 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 | Deprecated | 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 | Deprecated | protected | function | Asserts that a select option with the visible text exists. | ||
AssertContentTrait::assertOptionSelected | Deprecated | protected | function | Asserts that a select option in the current page is checked. | ||
AssertContentTrait::assertOptionSelectedWithDrupalSelector | Deprecated | 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 | Deprecated | 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 | Deprecated | protected | function | Passes if the text is found ONLY ONCE on the text version of the page. | ||
AssertContentTrait::assertUniqueTextHelper | Deprecated | 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. | |||
BlockValidationTest::$modules | protected static | property | Modules to install. | Overrides ConfigEntityValidationTestBase::$modules | ||
BlockValidationTest::$propertiesWithOptionalValues | protected static | property | The config entity properties whose values are optional (set to NULL). | Overrides ConfigEntityValidationTestBase::$propertiesWithOptionalValues | ||
BlockValidationTest::$propertiesWithRequiredKeys | protected static | property | The config entity mapping properties with >=1 required keys. | Overrides ConfigEntityValidationTestBase::$propertiesWithRequiredKeys | ||
BlockValidationTest::providerInvalidMachineNameCharacters | public static | function | Block names are atypical in that they allow periods in the machine name. | Overrides ConfigEntityValidationTestBase::providerInvalidMachineNameCharacters | ||
BlockValidationTest::setLabel | protected static | function | Sets the label of the given config entity. | Overrides ConfigEntityValidationTestBase::setLabel | ||
BlockValidationTest::setUp | protected | function | Overrides ConfigEntityValidationTestBase::setUp | |||
BlockValidationTest::testInvalidPluginId | public | function | Tests validating a block with an unknown plugin ID. | |||
BlockValidationTest::testLabelValidation | public | function | Tests validation of config entity's label. | Overrides ConfigEntityValidationTestBase::testLabelValidation | ||
BlockValidationTest::testRegionValidation | public | function | Tests validating a block's region in a theme. | |||
BlockValidationTest::testRequiredPropertyValuesMissing | public | function | A property that is required must have a value (i.e. not NULL). | Overrides ConfigEntityValidationTestBase::testRequiredPropertyValuesMissing | ||
BlockValidationTest::testThemeValidation | public | function | Tests validating a block with a non-existent theme. | |||
BlockValidationTest::testWeightCannotBeNull | public | function | @group legacy | |||
BlockValidationTest::testWeightValidation | public | function | Tests validating weight. | |||
ConfigEntityValidationTestBase::$entity | protected | property | The config entity being tested. | |||
ConfigEntityValidationTestBase::$hasLabel | protected | property | Whether a config entity of this type has a label. | 4 | ||
ConfigEntityValidationTestBase::assertValidationErrors | protected | function | Asserts a set of validation errors is raised when the entity is validated. | |||
ConfigEntityValidationTestBase::getMachineNameConstraints | protected | function | Returns the validation constraints applied to the entity's ID. | |||
ConfigEntityValidationTestBase::getPropertiesWithOptionalValues | protected | function | Determines the config entity properties with optional values. | |||
ConfigEntityValidationTestBase::getRequiredPropertyKeys | protected | function | Determines the config entity mapping properties with required keys. | |||
ConfigEntityValidationTestBase::isFullyValidatable | protected | function | Whether the tested config entity type is fully validatable. | |||
ConfigEntityValidationTestBase::providerConfigDependenciesValidation | public static | function | Data provider for ::testConfigDependenciesValidation(). | |||
ConfigEntityValidationTestBase::testConfigDependenciesValidation | public | function | Tests validation of config dependencies. | |||
ConfigEntityValidationTestBase::testEntityIsValid | public | function | Ensures that the entity created in ::setUp() has no validation errors. | |||
ConfigEntityValidationTestBase::testImmutableProperties | public | function | Tests that immutable properties cannot be changed. | 12 | ||
ConfigEntityValidationTestBase::testInvalidMachineNameCharacters | public | function | Tests that the entity's ID is tested for invalid characters. | |||
ConfigEntityValidationTestBase::testLangcode | public | function | Tests that the config entity's langcode is validated. | |||
ConfigEntityValidationTestBase::testMachineNameLength | public | function | Tests that the entity ID's length is validated if it is a machine name. | |||
ConfigEntityValidationTestBase::testRequiredPropertyKeysMissing | public | function | A property that is required must have a value (i.e. not NULL). | 2 | ||
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. | 2 | ||
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. | 2 | ||
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 | 28 | |
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 | ||||
KernelTestBase::setUpFilesystem | protected | function | Sets up the filesystem, so things like the file directory. | 3 | ||
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.