class AreaEntityTest
Same name in other branches
- 9 core/modules/views/tests/src/Kernel/Handler/AreaEntityTest.php \Drupal\Tests\views\Kernel\Handler\AreaEntityTest
- 8.9.x core/modules/views/tests/src/Kernel/Handler/AreaEntityTest.php \Drupal\Tests\views\Kernel\Handler\AreaEntityTest
- 10 core/modules/views/tests/src/Kernel/Handler/AreaEntityTest.php \Drupal\Tests\views\Kernel\Handler\AreaEntityTest
Tests the generic entity area handler.
@group views
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\Tests\views\Kernel\ViewsKernelTestBase extends \Drupal\KernelTests\KernelTestBase uses \Drupal\views\Tests\ViewResultAssertionTrait
- class \Drupal\Tests\views\Kernel\Handler\AreaEntityTest extends \Drupal\Tests\views\Kernel\ViewsKernelTestBase uses \Drupal\Tests\block\Traits\BlockCreationTrait
- class \Drupal\Tests\views\Kernel\ViewsKernelTestBase extends \Drupal\KernelTests\KernelTestBase uses \Drupal\views\Tests\ViewResultAssertionTrait
Expanded class hierarchy of AreaEntityTest
See also
\Drupal\views\Plugin\views\area\Entity
File
-
core/
modules/ views/ tests/ src/ Kernel/ Handler/ AreaEntityTest.php, line 20
Namespace
Drupal\Tests\views\Kernel\HandlerView source
class AreaEntityTest extends ViewsKernelTestBase {
use BlockCreationTrait;
/**
* {@inheritdoc}
*/
protected static $modules = [
'entity_test',
'user',
'block',
];
/**
* Views used by this test.
*
* @var array
*/
public static $testViews = [
'test_entity_area',
];
/**
* {@inheritdoc}
*/
protected function setUp($import_test_views = TRUE) : void {
parent::setUp();
}
/**
* {@inheritdoc}
*/
protected function setUpFixtures() : void {
// Install the themes used for this test.
$this->container
->get('theme_installer')
->install([
'olivero',
]);
$this->container
->get('config.factory')
->getEditable('system.theme')
->set('default', 'olivero')
->save();
$this->installEntitySchema('user');
$this->installEntitySchema('entity_test');
$this->installConfig([
'entity_test',
]);
$this->placeBlock('system_main_block', [
'id' => 'test_block',
]);
parent::setUpFixtures();
}
/**
* Tests views data for entity area handlers.
*/
public function testEntityAreaData() : void {
$data = $this->container
->get('views.views_data')
->get('views');
$entity_types = $this->container
->get('entity_type.manager')
->getDefinitions();
$expected_entities = array_filter($entity_types, function (EntityTypeInterface $entity_type) {
return $entity_type->hasViewBuilderClass();
});
// Test that all expected entity types have data.
foreach (array_keys($expected_entities) as $entity) {
$this->assertNotEmpty($data['entity_' . $entity], "Views entity '{$entity}' should have a data area.");
// Test that entity_type is set correctly in the area data.
$this->assertEquals($data['entity_' . $entity]['area']['entity_type'], $entity, "Correct entity_type set for {$entity}");
}
$expected_entities = array_filter($entity_types, function (EntityTypeInterface $type) {
return !$type->hasViewBuilderClass();
});
// Test that no configuration entity types have data.
foreach (array_keys($expected_entities) as $entity) {
$this->assertArrayNotHasKey('entity_' . $entity, $data, "Views config entity '{$entity}' should not have a data area.");
}
}
/**
* Tests the area handler.
*/
public function testEntityArea() : void {
/** @var \Drupal\Core\Entity\EntityInterface[] $entities */
$entities = [];
for ($i = 0; $i < 3; $i++) {
$random_label = $this->randomMachineName();
$data = [
'bundle' => 'entity_test',
'name' => $random_label,
];
$entity_test = $this->container
->get('entity_type.manager')
->getStorage('entity_test')
->create($data);
$uuid_map[0] = 'aa0c61cb-b7bb-4795-972a-493dabcf529c';
$uuid_map[1] = '62cef0ff-6f30-4f7a-b9d6-a8ed5a3a6bf3';
$uuid_map[2] = '3161d6e9-3326-4719-b513-8fa68a731ba2';
$entity_test->uuid->value = $uuid_map[$i];
$entity_test->save();
$entities[] = $entity_test;
\Drupal::state()->set('entity_test_entity_access.view.' . $entity_test->id(), $i != 2);
}
$this->doTestCalculateDependencies();
$this->doTestRender($entities);
}
/**
* Tests rendering the entity area handler.
*
* @param \Drupal\Core\Entity\EntityInterface[] $entities
* The entities.
*/
public function doTestRender($entities) : void {
/** @var \Drupal\Core\Render\RendererInterface $renderer */
$renderer = $this->container
->get('renderer');
$view = Views::getView('test_entity_area');
$preview = $view->preview('default', [
$entities[1]->id(),
]);
$this->setRawContent(\Drupal::service('renderer')->renderRoot($preview));
$view_class = 'js-view-dom-id-' . $view->dom_id;
$header_xpath = '//div[@class = "' . $view_class . '"]/header[1]';
$footer_xpath = '//div[@class = "' . $view_class . '"]/footer[1]';
$result = $this->xpath($header_xpath);
$this->assertStringContainsString($entities[0]->label(), (string) $result[0], 'The rendered entity appears in the header of the view.');
$this->assertStringContainsString('full', (string) $result[0], 'The rendered entity appeared in the right view mode.');
$result = $this->xpath($footer_xpath);
$this->assertStringContainsString($entities[1]->label(), (string) $result[0], 'The rendered entity appears in the footer of the view.');
$this->assertStringContainsString('full', (string) $result[0], 'The rendered entity appeared in the right view mode.');
$preview = $view->preview('default', [
$entities[1]->id(),
]);
$this->setRawContent($renderer->renderRoot($preview));
$result = $this->xpath($header_xpath);
$this->assertStringContainsString($entities[0]->label(), (string) $result[0], 'The rendered entity appears in the header of the view.');
$this->assertStringContainsString('full', (string) $result[0], 'The rendered entity appeared in the right view mode.');
$result = $this->xpath($footer_xpath);
$this->assertStringContainsString($entities[1]->label(), (string) $result[0], 'The rendered entity appears in the footer of the view.');
$this->assertStringContainsString('full', (string) $result[0], 'The rendered entity appeared in the right view mode.');
// Mark entity_test test view_mode as customizable.
$entity_view_mode = \Drupal::entityTypeManager()->getStorage('entity_view_mode')
->load('entity_test.test');
$entity_view_mode->enable();
$entity_view_mode->save();
// Change the view mode of the area handler.
$view = Views::getView('test_entity_area');
$item = $view->getHandler('default', 'header', 'entity_entity_test');
$item['view_mode'] = 'test';
$view->setHandler('default', 'header', 'entity_entity_test', $item);
$preview = $view->preview('default', [
$entities[1]->id(),
]);
$this->setRawContent($renderer->renderRoot($preview));
$view_class = 'js-view-dom-id-' . $view->dom_id;
$result = $this->xpath('//div[@class = "' . $view_class . '"]/header[1]');
$this->assertStringContainsString($entities[0]->label(), (string) $result[0], 'The rendered entity appears in the header of the view.');
$this->assertStringContainsString('test', (string) $result[0], 'The rendered entity appeared in the right view mode.');
// Test entity access.
$view = Views::getView('test_entity_area');
$preview = $view->preview('default', [
$entities[2]->id(),
]);
$this->setRawContent($renderer->renderRoot($preview));
$view_class = 'js-view-dom-id-' . $view->dom_id;
$result = $this->xpath('//div[@class = "' . $view_class . '"]/footer[1]');
$this->assertStringNotContainsString($entities[2]->label(), (string) $result[0], 'The rendered entity does not appear in the footer of the view.');
// Test the available view mode options.
$form = [];
$form_state = (new FormState())->set('type', 'header');
/** @var \Drupal\views\Plugin\views\area\DisplayLink $display_handler */
$display_handler = $view->display_handler
->getHandler('header', 'entity_entity_test');
$display_handler->buildOptionsForm($form, $form_state);
$this->assertTrue(isset($form['view_mode']['#options']['test']), 'Ensure that the test view mode is available.');
$this->assertTrue(isset($form['view_mode']['#options']['default']), 'Ensure that the default view mode is available.');
}
/**
* Tests the calculation of the rendered dependencies.
*/
public function doTestCalculateDependencies() : void {
$view = View::load('test_entity_area');
$dependencies = $view->calculateDependencies()
->getDependencies();
// Ensure that both config and content entity dependencies are calculated.
$this->assertEquals([
'config' => [
'block.block.test_block',
],
'content' => [
'entity_test:entity_test:aa0c61cb-b7bb-4795-972a-493dabcf529c',
],
'module' => [
'views_test_data',
],
], $dependencies);
}
}
Members
Title Sort descending | Deprecated | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|---|
AreaEntityTest::$modules | protected static | property | Modules to install. | Overrides ViewsKernelTestBase::$modules | ||
AreaEntityTest::$testViews | public static | property | Views used by this test. | Overrides ViewsKernelTestBase::$testViews | ||
AreaEntityTest::doTestCalculateDependencies | public | function | Tests the calculation of the rendered dependencies. | |||
AreaEntityTest::doTestRender | public | function | Tests rendering the entity area handler. | |||
AreaEntityTest::setUp | protected | function | Overrides ViewsKernelTestBase::setUp | |||
AreaEntityTest::setUpFixtures | protected | function | Sets up the configuration and schema of views and views_test_data modules. | Overrides ViewsKernelTestBase::setUpFixtures | ||
AreaEntityTest::testEntityArea | public | function | Tests the area handler. | |||
AreaEntityTest::testEntityAreaData | public | function | Tests views data for entity area handlers. | |||
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. | |||
BlockCreationTrait::placeBlock | protected | function | Creates a block instance based on default settings. | |||
ConfigTestTrait::configImporter | protected | function | Returns a ConfigImporter object to import test configuration. | |||
ConfigTestTrait::copyConfig | protected | function | Copies configuration objects from source storage to target storage. | |||
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. | 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 | 1 | |||
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. | |||
ViewResultAssertionTrait::assertIdenticalResultset | protected | function | Verifies that a result set returned by a View matches expected values. | |||
ViewResultAssertionTrait::assertIdenticalResultsetHelper | protected | function | Performs View result assertions. | |||
ViewResultAssertionTrait::assertNotIdenticalResultset | protected | function | Verifies that a result set returned by a View differs from certain values. | |||
ViewsKernelTestBase::dataSet | protected | function | Returns a very simple test dataset. | 10 | ||
ViewsKernelTestBase::executeView | protected | function | Executes a view. | |||
ViewsKernelTestBase::orderResultSet | protected | function | Orders a nested array containing a result set based on a given column. | |||
ViewsKernelTestBase::schemaDefinition | protected | function | Returns the schema definition. | 7 | ||
ViewsKernelTestBase::viewsData | protected | function | Returns the views data definition. | 23 |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.