class FieldBlockTest in Drupal 9
Same name in this branch
- 9 core/modules/layout_builder/tests/src/FunctionalJavascript/FieldBlockTest.php \Drupal\Tests\layout_builder\FunctionalJavascript\FieldBlockTest
- 9 core/modules/layout_builder/tests/src/Kernel/FieldBlockTest.php \Drupal\Tests\layout_builder\Kernel\FieldBlockTest
Same name and namespace in other branches
- 8 core/modules/layout_builder/tests/src/Kernel/FieldBlockTest.php \Drupal\Tests\layout_builder\Kernel\FieldBlockTest
@coversDefaultClass \Drupal\layout_builder\Plugin\Block\FieldBlock @group Field
Hierarchy
- class \Drupal\KernelTests\KernelTestBase extends \PHPUnit\Framework\TestCase implements ServiceProviderInterface uses \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, AssertContentTrait, AssertLegacyTrait, ConfigTestTrait, ExtensionListTestTrait, PhpUnitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait, PhpUnitWarnings
- class \Drupal\KernelTests\Core\Entity\EntityKernelTestBase uses UserCreationTrait
- class \Drupal\Tests\layout_builder\Kernel\FieldBlockTest
- class \Drupal\KernelTests\Core\Entity\EntityKernelTestBase uses UserCreationTrait
Expanded class hierarchy of FieldBlockTest
File
- core/
modules/ layout_builder/ tests/ src/ Kernel/ FieldBlockTest.php, line 31
Namespace
Drupal\Tests\layout_builder\KernelView source
class FieldBlockTest extends EntityKernelTestBase {
/**
* The entity field manager.
*
* @var \Drupal\Core\Entity\EntityFieldManagerInterface
*/
protected $entityFieldManager;
/**
* The logger.
*
* @var \Psr\Log\LoggerInterface
*/
protected $logger;
/**
* {@inheritdoc}
*/
protected function setUp() : void {
parent::setUp();
$this->entityFieldManager = $this
->prophesize(EntityFieldManagerInterface::class);
$this->logger = $this
->prophesize(LoggerInterface::class);
}
/**
* Tests entity access.
*
* @covers ::blockAccess
* @dataProvider providerTestBlockAccessNotAllowed
*/
public function testBlockAccessEntityNotAllowed($expected, $entity_access) {
$entity = $this
->prophesize(FieldableEntityInterface::class);
$block = $this
->getTestBlock($entity);
$account = $this
->prophesize(AccountInterface::class);
$entity
->access('view', $account
->reveal(), TRUE)
->willReturn($entity_access);
$entity
->hasField()
->shouldNotBeCalled();
$access = $block
->access($account
->reveal(), TRUE);
$this
->assertSame($expected, $access
->isAllowed());
}
/**
* Provides test data for ::testBlockAccessEntityNotAllowed().
*/
public function providerTestBlockAccessNotAllowed() {
$data = [];
$data['entity_forbidden'] = [
FALSE,
AccessResult::forbidden(),
];
$data['entity_neutral'] = [
FALSE,
AccessResult::neutral(),
];
return $data;
}
/**
* Tests unfieldable entity.
*
* @covers ::blockAccess
*/
public function testBlockAccessEntityAllowedNotFieldable() {
$entity = $this
->prophesize(EntityInterface::class);
$block = $this
->getTestBlock($entity);
$account = $this
->prophesize(AccountInterface::class);
$entity
->access('view', $account
->reveal(), TRUE)
->willReturn(AccessResult::allowed());
$access = $block
->access($account
->reveal(), TRUE);
$this
->assertFalse($access
->isAllowed());
}
/**
* Tests fieldable entity without a particular field.
*
* @covers ::blockAccess
*/
public function testBlockAccessEntityAllowedNoField() {
$entity = $this
->prophesize(FieldableEntityInterface::class);
$block = $this
->getTestBlock($entity);
$account = $this
->prophesize(AccountInterface::class);
$entity
->access('view', $account
->reveal(), TRUE)
->willReturn(AccessResult::allowed());
$entity
->hasField('the_field_name')
->willReturn(FALSE);
$entity
->get('the_field_name')
->shouldNotBeCalled();
$access = $block
->access($account
->reveal(), TRUE);
$this
->assertFalse($access
->isAllowed());
}
/**
* Tests field access.
*
* @covers ::blockAccess
* @dataProvider providerTestBlockAccessNotAllowed
*/
public function testBlockAccessEntityAllowedFieldNotAllowed($expected, $field_access) {
$entity = $this
->prophesize(FieldableEntityInterface::class);
$block = $this
->getTestBlock($entity);
$account = $this
->prophesize(AccountInterface::class);
$entity
->access('view', $account
->reveal(), TRUE)
->willReturn(AccessResult::allowed());
$entity
->hasField('the_field_name')
->willReturn(TRUE);
$field = $this
->prophesize(FieldItemListInterface::class);
$entity
->get('the_field_name')
->willReturn($field
->reveal());
$field
->access('view', $account
->reveal(), TRUE)
->willReturn($field_access);
$field
->isEmpty()
->shouldNotBeCalled();
$access = $block
->access($account
->reveal(), TRUE);
$this
->assertSame($expected, $access
->isAllowed());
}
/**
* Tests populated vs empty build.
*
* @covers ::blockAccess
* @covers ::build
* @dataProvider providerTestBlockAccessEntityAllowedFieldHasValue
*/
public function testBlockAccessEntityAllowedFieldHasValue($expected, $is_empty) {
$entity = $this
->prophesize(FieldableEntityInterface::class);
$block = $this
->getTestBlock($entity);
$account = $this
->prophesize(AccountInterface::class);
$entity
->access('view', $account
->reveal(), TRUE)
->willReturn(AccessResult::allowed());
$entity
->hasField('the_field_name')
->willReturn(TRUE);
$field = $this
->prophesize(FieldItemListInterface::class);
$entity
->get('the_field_name')
->willReturn($field
->reveal());
$field
->access('view', $account
->reveal(), TRUE)
->willReturn(AccessResult::allowed());
$field
->isEmpty()
->willReturn($is_empty)
->shouldBeCalled();
$access = $block
->access($account
->reveal(), TRUE);
$this
->assertSame($expected, $access
->isAllowed());
}
/**
* Provides test data for ::testBlockAccessEntityAllowedFieldHasValue().
*/
public function providerTestBlockAccessEntityAllowedFieldHasValue() {
$data = [];
$data['empty'] = [
FALSE,
TRUE,
];
$data['populated'] = [
TRUE,
FALSE,
];
return $data;
}
/**
* Instantiates a block for testing.
*
* @param \Prophecy\Prophecy\ProphecyInterface $entity_prophecy
* An entity prophecy for use as an entity context value.
* @param array $configuration
* A configuration array containing information about the plugin instance.
* @param array $plugin_definition
* The plugin implementation definition.
*
* @return \Drupal\layout_builder\Plugin\Block\FieldBlock
* The block to test.
*/
protected function getTestBlock(ProphecyInterface $entity_prophecy, array $configuration = [], array $plugin_definition = []) {
$entity_prophecy
->getCacheContexts()
->willReturn([]);
$entity_prophecy
->getCacheTags()
->willReturn([]);
$entity_prophecy
->getCacheMaxAge()
->willReturn(0);
$plugin_definition += [
'provider' => 'test',
'default_formatter' => '',
'category' => 'Test',
'admin_label' => 'Test Block',
'bundles' => [
'entity_test',
],
'context_definitions' => [
'entity' => EntityContextDefinition::fromEntityTypeId('entity_test')
->setLabel('Test'),
'view_mode' => new ContextDefinition('string'),
],
];
$formatter_manager = $this
->prophesize(FormatterPluginManager::class);
$module_handler = $this
->prophesize(ModuleHandlerInterface::class);
$block = new FieldBlock($configuration, 'field_block:entity_test:entity_test:the_field_name', $plugin_definition, $this->entityFieldManager
->reveal(), $formatter_manager
->reveal(), $module_handler
->reveal(), $this->logger
->reveal());
$block
->setContextValue('entity', $entity_prophecy
->reveal());
$block
->setContextValue('view_mode', 'default');
return $block;
}
/**
* @covers ::build
* @dataProvider providerTestBuild
*/
public function testBuild(PromiseInterface $promise, $expected_markup, $log_message = '', $log_arguments = []) {
$entity = $this
->prophesize(FieldableEntityInterface::class);
$field = $this
->prophesize(FieldItemListInterface::class);
$entity
->get('the_field_name')
->willReturn($field
->reveal());
$field
->view(Argument::type('array'))
->will($promise);
$field_definition = $this
->prophesize(FieldDefinitionInterface::class);
$field_definition
->getLabel()
->willReturn('The Field Label');
$this->entityFieldManager
->getFieldDefinitions('entity_test', 'entity_test')
->willReturn([
'the_field_name' => $field_definition,
]);
if ($log_message) {
$this->logger
->warning($log_message, $log_arguments)
->shouldBeCalled();
}
else {
$this->logger
->warning(Argument::cetera())
->shouldNotBeCalled();
}
$block = $this
->getTestBlock($entity);
$expected = [
'#cache' => [
'contexts' => [],
'tags' => [],
'max-age' => 0,
],
];
if ($expected_markup) {
$expected['content']['#markup'] = $expected_markup;
}
$actual = $block
->build();
$this
->assertEquals($expected, $actual);
}
/**
* Provides test data for ::testBuild().
*/
public function providerTestBuild() {
$data = [];
$data['array'] = [
new ReturnPromise([
[
'content' => [
'#markup' => 'The field value',
],
],
]),
'The field value',
];
$data['empty array'] = [
new ReturnPromise([
[],
]),
'',
];
return $data;
}
/**
* @covers ::build
*/
public function testBuildException() {
// In PHP 7.4 ReflectionClass cannot be serialized so this cannot be part of
// providerTestBuild().
$promise = new ThrowPromise(new \Exception('The exception message'));
$this
->testBuild($promise, '', 'The field "%field" failed to render with the error of "%error".', [
'%field' => 'the_field_name',
'%error' => 'The exception message',
]);
}
/**
* Tests a field block that throws a form exception.
*
* @todo Remove in https://www.drupal.org/project/drupal/issues/2367555.
*/
public function testBuildWithFormException() {
$field = $this
->prophesize(FieldItemListInterface::class);
$field
->view(Argument::type('array'))
->willThrow(new EnforcedResponseException(new Response()));
$entity = $this
->prophesize(FieldableEntityInterface::class);
$entity
->get('the_field_name')
->willReturn($field
->reveal());
$block = $this
->getTestBlock($entity);
$this
->expectException(EnforcedResponseException::class);
$block
->build();
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
AssertContentTrait:: |
protected | property | The current raw content. | |
AssertContentTrait:: |
protected | property | The drupalSettings value from the current raw $content. | |
AssertContentTrait:: |
protected | property | The XML structure parsed from the current raw $content. | 1 |
AssertContentTrait:: |
protected | property | The plain-text content of raw $content (text nodes). | |
AssertContentTrait:: |
protected | function | Passes if the raw text IS found escaped on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists with the given name or ID. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists with the given ID and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists with the given name and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists in the current page by the given XPath. | |
AssertContentTrait:: |
protected | function | Asserts that a checkbox field in the current page is checked. | |
AssertContentTrait:: |
protected | function | Asserts that a field exists in the current page with a given Xpath result. | |
AssertContentTrait:: |
protected | function | Passes if a link with the specified label is found. | |
AssertContentTrait:: |
protected | function | Passes if a link containing a given href (part) is found. | |
AssertContentTrait:: |
protected | function | Asserts that each HTML ID is used for just a single element. | |
AssertContentTrait:: |
protected | function | Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist with the given name or ID. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist with the given ID and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist with the given name and value. | |
AssertContentTrait:: |
protected | function | Asserts that a field does not exist or its value does not match, by XPath. | |
AssertContentTrait:: |
protected | function | Asserts that a checkbox field in the current page is not checked. | |
AssertContentTrait:: |
protected | function | Passes if a link with the specified label is not found. | |
AssertContentTrait:: |
protected | function | Passes if a link containing a given href (part) is not found. | |
AssertContentTrait:: |
protected | function | Passes if a link containing a given href is not found in the main region. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page does not exist. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page is not checked. | |
AssertContentTrait:: |
protected | function | Triggers a pass if the perl regex pattern is not found in raw content. | |
AssertContentTrait:: |
protected | function | Passes if the raw text is NOT found on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Passes if the page (with HTML stripped) does not contains the text. | |
AssertContentTrait:: |
protected | function | Pass if the page title is not the given string. | |
AssertContentTrait:: |
protected | function | Passes if the text is found MORE THAN ONCE on the text version of the page. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page exists. | |
AssertContentTrait:: |
protected | function | Asserts that a select option with the visible text exists. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page is checked. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page is checked. | |
AssertContentTrait:: |
protected | function | Asserts that a select option in the current page exists. | |
AssertContentTrait:: |
protected | function | Triggers a pass if the Perl regex pattern is found in the raw content. | |
AssertContentTrait:: |
protected | function | Passes if the raw text IS found on the loaded page, fail otherwise. | |
AssertContentTrait:: |
protected | function | Passes if the page (with HTML stripped) contains the text. | |
AssertContentTrait:: |
protected | function | Helper for assertText and assertNoText. | |
AssertContentTrait:: |
protected | function | Asserts that a Perl regex pattern is found in the plain-text content. | |
AssertContentTrait:: |
protected | function | Asserts themed output. | |
AssertContentTrait:: |
protected | function | Pass if the page title is the given string. | |
AssertContentTrait:: |
protected | function | Passes if the text is found ONLY ONCE on the text version of the page. | |
AssertContentTrait:: |
protected | function | Helper for assertUniqueText and assertNoUniqueText. | |
AssertContentTrait:: |
protected | function | Builds an XPath query. | |
AssertContentTrait:: |
protected | function | Helper: Constructs an XPath for the given set of attributes and value. | |
AssertContentTrait:: |
protected | function | Searches elements using a CSS selector in the raw content. | |
AssertContentTrait:: |
protected | function | Get all option elements, including nested options, in a select. | |
AssertContentTrait:: |
protected | function | Gets the value of drupalSettings for the currently-loaded page. | |
AssertContentTrait:: |
protected | function | Gets the current raw content. | |
AssertContentTrait:: |
protected | function | Get the selected value from a select field. | |
AssertContentTrait:: |
protected | function | Retrieves the plain-text content from the current raw content. | |
AssertContentTrait:: |
protected | function | Get the current URL from the cURL handler. | 1 |
AssertContentTrait:: |
protected | function | Parse content returned from curlExec using DOM and SimpleXML. | |
AssertContentTrait:: |
protected | function | Removes all white-space between HTML tags from the raw content. | |
AssertContentTrait:: |
protected | function | Sets the value of drupalSettings for the currently-loaded page. | |
AssertContentTrait:: |
protected | function | Sets the raw content (e.g. HTML). | |
AssertContentTrait:: |
protected | function | Performs an xpath search on the contents of the internal browser. | |
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
ConfigTestTrait:: |
protected | function | Returns a ConfigImporter object to import test configuration. | |
ConfigTestTrait:: |
protected | function | Copies configuration objects from source storage to target storage. | |
EntityKernelTestBase:: |
protected | property | The entity type manager service. | 1 |
EntityKernelTestBase:: |
protected | property | A list of generated identifiers. | |
EntityKernelTestBase:: |
protected static | property |
Modules to enable. Overrides KernelTestBase:: |
57 |
EntityKernelTestBase:: |
protected | property | The state service. | |
EntityKernelTestBase:: |
protected | function | Creates a user. | |
EntityKernelTestBase:: |
protected | function | Generates a random ID avoiding collisions. | |
EntityKernelTestBase:: |
protected | function | Returns the entity_test hook invocation info. | |
EntityKernelTestBase:: |
protected | function | Installs a module and refreshes services. | |
EntityKernelTestBase:: |
protected | function | Refresh services. | 1 |
EntityKernelTestBase:: |
protected | function | Reloads the given entity from the storage and returns it. | |
EntityKernelTestBase:: |
protected | function | Uninstalls a module and refreshes services. | |
ExtensionListTestTrait:: |
protected | function | Gets the path for the specified module. | |
ExtensionListTestTrait:: |
protected | function | Gets the path for the specified theme. | |
FieldBlockTest:: |
protected | property | The entity field manager. | |
FieldBlockTest:: |
protected | property | The logger. | |
FieldBlockTest:: |
protected | function | Instantiates a block for testing. | |
FieldBlockTest:: |
public | function | Provides test data for ::testBlockAccessEntityAllowedFieldHasValue(). | |
FieldBlockTest:: |
public | function | Provides test data for ::testBlockAccessEntityNotAllowed(). | |
FieldBlockTest:: |
public | function | Provides test data for ::testBuild(). | |
FieldBlockTest:: |
protected | function |
Overrides EntityKernelTestBase:: |
|
FieldBlockTest:: |
public | function | Tests populated vs empty build. | |
FieldBlockTest:: |
public | function | Tests field access. | |
FieldBlockTest:: |
public | function | Tests fieldable entity without a particular field. | |
FieldBlockTest:: |
public | function | Tests unfieldable entity. | |
FieldBlockTest:: |
public | function | Tests entity access. | |
FieldBlockTest:: |
public | function | @covers ::build @dataProvider providerTestBuild | |
FieldBlockTest:: |
public | function | @covers ::build | |
FieldBlockTest:: |
public | function | Tests a field block that throws a form exception. | |
KernelTestBase:: |
protected | property | Back up and restore any global variables that may be changed by tests. | |
KernelTestBase:: |
protected | property | Back up and restore static class properties that may be changed by tests. | |
KernelTestBase:: |
protected | property | Contains a few static class properties for performance. | |
KernelTestBase:: |
protected | property | ||
KernelTestBase:: |
protected | property | @todo Move into Config test base class. | 7 |
KernelTestBase:: |
protected static | property | An array of config object names that are excluded from schema checking. | |
KernelTestBase:: |
protected | property | ||
KernelTestBase:: |
protected | property | ||
KernelTestBase:: |
protected | property | Do not forward any global state from the parent process to the processes that run the actual tests. | |
KernelTestBase:: |
protected | property | The app root. | |
KernelTestBase:: |
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:: |
protected | property | ||
KernelTestBase:: |
protected | property | Set to TRUE to strict check all configuration saved. | 6 |
KernelTestBase:: |
protected | property | The virtual filesystem root directory. | |
KernelTestBase:: |
protected | function | 1 | |
KernelTestBase:: |
protected | function | Bootstraps a basic test environment. | |
KernelTestBase:: |
private | function | Bootstraps a kernel for a test. | |
KernelTestBase:: |
protected | function | Configuration accessor for tests. Returns non-overridden configuration. | |
KernelTestBase:: |
protected | function | Disables modules for this test. | |
KernelTestBase:: |
protected | function | Enables modules for this test. | |
KernelTestBase:: |
protected | function | Gets the config schema exclusions for this test. | |
KernelTestBase:: |
protected | function | Returns the Database connection info to be used for this test. | 3 |
KernelTestBase:: |
public | function | ||
KernelTestBase:: |
private | function | Returns Extension objects for $modules to enable. | |
KernelTestBase:: |
private static | function | Returns the modules to enable for this test. | |
KernelTestBase:: |
protected | function | Initializes the FileCache component. | |
KernelTestBase:: |
protected | function | Installs default configuration for a given list of modules. | |
KernelTestBase:: |
protected | function | Installs the storage schema for a specific entity type. | |
KernelTestBase:: |
protected | function | Installs database tables from a module schema definition. | |
KernelTestBase:: |
protected | function | ||
KernelTestBase:: |
public | function |
Registers test-specific services. Overrides ServiceProviderInterface:: |
24 |
KernelTestBase:: |
protected | function | Renders a render array. | 1 |
KernelTestBase:: |
protected | function | Sets the install profile and rebuilds the container to update it. | |
KernelTestBase:: |
protected | function | Sets an in-memory Settings variable. | |
KernelTestBase:: |
public static | function | 1 | |
KernelTestBase:: |
protected | function | Sets up the filesystem, so things like the file directory. | 2 |
KernelTestBase:: |
protected | function | Stops test execution. | |
KernelTestBase:: |
protected | function | 4 | |
KernelTestBase:: |
public | function | @after | |
KernelTestBase:: |
protected | function | Dumps the current state of the virtual filesystem to STDOUT. | |
KernelTestBase:: |
public | function | Prevents serializing any properties. | |
PhpUnitWarnings:: |
private static | property | Deprecation warnings from PHPUnit to raise with @trigger_error(). | |
PhpUnitWarnings:: |
public | function | Converts PHPUnit deprecation warnings to E_USER_DEPRECATED. | |
RandomGeneratorTrait:: |
protected | property | The random generator. | |
RandomGeneratorTrait:: |
protected | function | Gets the random generator for the utility methods. | |
RandomGeneratorTrait:: |
protected | function | Generates a unique random string containing letters and numbers. | 1 |
RandomGeneratorTrait:: |
public | function | Generates a random PHP object. | |
RandomGeneratorTrait:: |
public | function | Generates a pseudo-random string of ASCII characters of codes 32 to 126. | |
RandomGeneratorTrait:: |
public | function | Callback for random string validation. | |
StorageCopyTrait:: |
protected static | function | Copy the configuration from one storage to another and remove stale items. | |
TestRequirementsTrait:: |
private | function | Checks missing module requirements. | |
TestRequirementsTrait:: |
protected | function | Check module requirements for the Drupal use case. | 1 |
TestRequirementsTrait:: |
protected static | function | Returns the Drupal root directory. | |
UserCreationTrait:: |
protected | function | Checks whether a given list of permission names is valid. Aliased as: drupalCheckPermissions | |
UserCreationTrait:: |
protected | function | Creates an administrative role. Aliased as: drupalCreateAdminRole | |
UserCreationTrait:: |
protected | function | Creates a role with specified permissions. Aliased as: drupalCreateRole | |
UserCreationTrait:: |
protected | function | Create a user with a given set of permissions. Aliased as: drupalCreateUser | |
UserCreationTrait:: |
protected | function | Grant permissions to a user role. Aliased as: drupalGrantPermissions | |
UserCreationTrait:: |
protected | function | Switch the current logged in user. Aliased as: drupalSetCurrentUser | |
UserCreationTrait:: |
protected | function | Creates a random user account and sets it as current user. Aliased as: drupalSetUpCurrentUser |