class FieldBlockTest

Same name in this branch
  1. 11.x core/modules/layout_builder/tests/src/FunctionalJavascript/FieldBlockTest.php \Drupal\Tests\layout_builder\FunctionalJavascript\FieldBlockTest
Same name in other branches
  1. 9 core/modules/layout_builder/tests/src/FunctionalJavascript/FieldBlockTest.php \Drupal\Tests\layout_builder\FunctionalJavascript\FieldBlockTest
  2. 9 core/modules/layout_builder/tests/src/Kernel/FieldBlockTest.php \Drupal\Tests\layout_builder\Kernel\FieldBlockTest
  3. 8.9.x core/modules/layout_builder/tests/src/FunctionalJavascript/FieldBlockTest.php \Drupal\Tests\layout_builder\FunctionalJavascript\FieldBlockTest
  4. 8.9.x core/modules/layout_builder/tests/src/Kernel/FieldBlockTest.php \Drupal\Tests\layout_builder\Kernel\FieldBlockTest
  5. 10 core/modules/layout_builder/tests/src/FunctionalJavascript/FieldBlockTest.php \Drupal\Tests\layout_builder\FunctionalJavascript\FieldBlockTest
  6. 10 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

Expanded class hierarchy of FieldBlockTest

File

core/modules/layout_builder/tests/src/Kernel/FieldBlockTest.php, line 33

Namespace

Drupal\Tests\layout_builder\Kernel
View 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) : void {
        $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 static 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() : void {
        $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() : void {
        $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) : void {
        $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, $default_value) : void {
        $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);
        $field_definition = $this->prophesize(FieldDefinitionInterface::class);
        $field->getFieldDefinition()
            ->willReturn($field_definition->reveal());
        $field_definition->getDefaultValue($entity->reveal())
            ->willReturn($default_value);
        $field_definition->getType()
            ->willReturn('not_an_image');
        $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 static function providerTestBlockAccessEntityAllowedFieldHasValue() {
        $data = [];
        $data['empty'] = [
            FALSE,
            TRUE,
            FALSE,
        ];
        $data['populated'] = [
            TRUE,
            FALSE,
            FALSE,
        ];
        $data['empty, with default'] = [
            TRUE,
            TRUE,
            TRUE,
        ];
        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 = []) : void {
        $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[0]['content']['#markup'] = $expected_markup;
        }
        $actual = $block->build();
        $this->assertEquals($expected, $actual);
    }
    
    /**
     * Provides test data for ::testBuild().
     */
    public static 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() : void {
        // 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() : void {
        $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

Title Sort descending Deprecated Modifiers Object type Summary Member alias 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.
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.
EntityKernelTestBase::$entityTypeManager protected property The entity type manager service. 1
EntityKernelTestBase::$modules protected static property Modules to install. Overrides KernelTestBase::$modules 60
EntityKernelTestBase::$state protected property The state service.
EntityKernelTestBase::createUser protected function Creates a user.
EntityKernelTestBase::getHooksInfo protected function Returns the entity_test hook invocation info.
EntityKernelTestBase::installModule protected function Installs a module and refreshes services.
EntityKernelTestBase::refreshServices protected function Refresh services. 1
EntityKernelTestBase::uninstallModule protected function Uninstalls a module and refreshes services.
EntityTrait::$generatedIds protected property A list of entity IDs generated by self::generateRandomEntityId().
EntityTrait::generateRandomEntityId protected function Generates a random ID avoiding collisions.
EntityTrait::reloadEntity protected function Reloads the given entity from the storage and returns it.
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.
FieldBlockTest::$entityFieldManager protected property The entity field manager.
FieldBlockTest::$logger protected property The logger.
FieldBlockTest::getTestBlock protected function Instantiates a block for testing.
FieldBlockTest::providerTestBlockAccessEntityAllowedFieldHasValue public static function Provides test data for ::testBlockAccessEntityAllowedFieldHasValue().
FieldBlockTest::providerTestBlockAccessNotAllowed public static function Provides test data for ::testBlockAccessEntityNotAllowed().
FieldBlockTest::providerTestBuild public static function Provides test data for ::testBuild().
FieldBlockTest::setUp protected function Overrides EntityKernelTestBase::setUp
FieldBlockTest::testBlockAccessEntityAllowedFieldHasValue public function Tests populated vs empty build.
FieldBlockTest::testBlockAccessEntityAllowedFieldNotAllowed public function Tests field access.
FieldBlockTest::testBlockAccessEntityAllowedNoField public function Tests fieldable entity without a particular field.
FieldBlockTest::testBlockAccessEntityAllowedNotFieldable public function Tests unfieldable entity.
FieldBlockTest::testBlockAccessEntityNotAllowed public function Tests entity access.
FieldBlockTest::testBuild public function @covers ::build
@dataProvider providerTestBuild
FieldBlockTest::testBuildException public function @covers ::build
FieldBlockTest::testBuildWithFormException public function Tests a field block that throws a form exception.
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.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid. Aliased as: drupalCheckPermissions
UserCreationTrait::createAdminRole protected function Creates an administrative role. Aliased as: drupalCreateAdminRole
UserCreationTrait::createRole protected function Creates a role with specified permissions. Aliased as: drupalCreateRole
UserCreationTrait::createUser protected function Create a user with a given set of permissions. Aliased as: drupalCreateUser
UserCreationTrait::grantPermissions protected function Grant permissions to a user role. Aliased as: drupalGrantPermissions
UserCreationTrait::setCurrentUser protected function Switch the current logged in user. Aliased as: drupalSetCurrentUser
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user. Aliased as: drupalSetUpCurrentUser

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.