class HandlerFieldFieldTest in Drupal 10
Same name and namespace in other branches
- 8 core/modules/field/tests/src/Kernel/Views/HandlerFieldFieldTest.php \Drupal\Tests\field\Kernel\Views\HandlerFieldFieldTest
- 9 core/modules/field/tests/src/Kernel/Views/HandlerFieldFieldTest.php \Drupal\Tests\field\Kernel\Views\HandlerFieldFieldTest
Tests the field rendering in views.
@group field
@todo Extend test coverage in #3046722.
Hierarchy
- class \Drupal\KernelTests\KernelTestBase extends \PHPUnit\Framework\TestCase implements ServiceProviderInterface uses \Drupal\Tests\PhpUnitCompatibilityTrait, \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, AssertContentTrait, ConfigTestTrait, ExtensionListTestTrait, RandomGeneratorTrait, TestRequirementsTrait, PhpUnitWarnings
- class \Drupal\Tests\field\Kernel\Views\HandlerFieldFieldTest uses NodeCreationTrait
Expanded class hierarchy of HandlerFieldFieldTest
See also
https://www.drupal.org/project/drupal/issues/3046722
File
- core/
modules/ field/ tests/ src/ Kernel/ Views/ HandlerFieldFieldTest.php, line 24
Namespace
Drupal\Tests\field\Kernel\ViewsView source
class HandlerFieldFieldTest extends KernelTestBase {
use NodeCreationTrait;
/**
* {@inheritdoc}
*/
protected static $modules = [
'field',
'field_test',
'field_test_views',
'filter',
'node',
'system',
'text',
'user',
'views',
];
/**
* Views used by this test.
*
* @var array
*/
public static $testViews = [
'test_view_fieldapi',
];
/**
* Test field storage.
*
* @var \Drupal\field\FieldStorageConfigInterface[]
*/
protected $fieldStorages = [];
/**
* Test nodes.
*
* @var \Drupal\node\NodeInterface[]
*/
protected $nodes = [];
/**
* Tests fields rendering in views.
*/
public function testFieldRender() {
$this
->installConfig([
'filter',
]);
$this
->installEntitySchema('user');
$this
->installEntitySchema('node');
NodeType::create([
'type' => 'page',
])
->save();
ViewTestData::createTestViews(static::class, [
'field_test_views',
]);
// Setup basic fields.
$this
->createFields();
// Create some nodes.
$this->nodes = [];
for ($i = 0; $i < 3; $i++) {
$values = [
'type' => 'page',
];
foreach ([
0,
1,
2,
5,
] as $key) {
$field_storage = $this->fieldStorages[$key];
$values[$field_storage
->getName()][0]['value'] = $this
->randomMachineName(8);
}
// Add a hidden value for the no-view field.
$values[$this->fieldStorages[6]
->getName()][0]['value'] = 'ssh secret squirrel';
for ($j = 0; $j < 5; $j++) {
$values[$this->fieldStorages[3]
->getName()][$j]['value'] = $this
->randomMachineName(8);
}
// Set this field to be empty.
$values[$this->fieldStorages[4]
->getName()] = [
[
'value' => NULL,
],
];
$this->nodes[$i] = $this
->createNode($values);
}
// Perform actual tests.
$this
->doTestSimpleFieldRender();
$this
->doTestInaccessibleFieldRender();
$this
->doTestFormatterSimpleFieldRender();
$this
->doTestMultipleFieldRender();
}
/**
* Tests simple field rendering.
*/
public function doTestSimpleFieldRender() {
$view = Views::getView('test_view_fieldapi');
$this
->prepareView($view);
$view
->preview();
// Tests that the rendered fields match the actual value of the fields.
for ($i = 0; $i < 3; $i++) {
for ($key = 0; $key < 2; $key++) {
$field_name = $this->fieldStorages[$key]
->getName();
$rendered_field = $view->style_plugin
->getField($i, $field_name);
$expected_field = $this->nodes[$i]->{$field_name}->value;
$this
->assertEquals($expected_field, $rendered_field);
}
}
}
/**
* Tests inaccessible field rendering.
*/
public function doTestInaccessibleFieldRender() {
$view = Views::getView('test_view_fieldapi');
$this
->prepareView($view);
$view
->preview();
// Check that the field handler for the hidden field is correctly removed
// from the display.
// @see https://www.drupal.org/node/2382931
$this
->assertArrayNotHasKey('field_no_view_access', $view->field);
// Check that the access-denied field is not visible.
for ($i = 0; $i < 3; $i++) {
$field_name = $this->fieldStorages[6]
->getName();
$rendered_field = $view->style_plugin
->getField($i, $field_name);
// Check that a hidden field is not rendered.
$this
->assertNull($rendered_field);
}
}
/**
* Tests that fields with formatters runs as expected.
*/
public function doTestFormatterSimpleFieldRender() {
$view = Views::getView('test_view_fieldapi');
$this
->prepareView($view);
$view->displayHandlers
->get('default')->options['fields'][$this->fieldStorages[5]
->getName()]['type'] = 'text_trimmed';
$view->displayHandlers
->get('default')->options['fields'][$this->fieldStorages[5]
->getName()]['settings'] = [
'trim_length' => 3,
];
$view
->preview();
// Make sure that the formatter works as expected.
// @todo Add a specific formatter in #3046722.
// @see https://www.drupal.org/project/drupal/issues/3046722
for ($i = 0; $i < 2; $i++) {
$field_name = $this->fieldStorages[5]
->getName();
$rendered_field = $view->style_plugin
->getField($i, $field_name);
$this
->assertEquals(3, strlen(html_entity_decode($rendered_field)));
}
}
/**
* Tests multi-value field rendering.
*/
public function doTestMultipleFieldRender() {
$view = Views::getView('test_view_fieldapi');
$field_name = $this->fieldStorages[3]
->getName();
// Test delta limit.
$this
->prepareView($view);
$view->displayHandlers
->get('default')->options['fields'][$field_name]['group_rows'] = TRUE;
$view->displayHandlers
->get('default')->options['fields'][$field_name]['delta_limit'] = 3;
$view
->preview();
for ($i = 0; $i < 3; $i++) {
$rendered_field = $view->style_plugin
->getField($i, $field_name);
$items = [];
$pure_items = $this->nodes[$i]->{$field_name}
->getValue();
$pure_items = array_splice($pure_items, 0, 3);
foreach ($pure_items as $j => $item) {
$items[] = $pure_items[$j]['value'];
}
// Check that the amount of items is limited.
$this
->assertEquals(implode(', ', $items), $rendered_field);
}
// Test that an empty field is rendered without error.
$view->style_plugin
->getField(4, $this->fieldStorages[4]
->getName());
$view
->destroy();
// Test delta limit + offset
$this
->prepareView($view);
$view->displayHandlers
->get('default')->options['fields'][$field_name]['group_rows'] = TRUE;
$view->displayHandlers
->get('default')->options['fields'][$field_name]['delta_limit'] = 3;
$view->displayHandlers
->get('default')->options['fields'][$field_name]['delta_offset'] = 1;
$view
->preview();
for ($i = 0; $i < 3; $i++) {
$rendered_field = $view->style_plugin
->getField($i, $field_name);
$items = [];
$pure_items = $this->nodes[$i]->{$field_name}
->getValue();
$pure_items = array_splice($pure_items, 1, 3);
foreach ($pure_items as $j => $item) {
$items[] = $pure_items[$j]['value'];
}
// Check that the amount of items is limited and the offset is correct.
$this
->assertEquals(implode(', ', $items), $rendered_field);
}
$view
->destroy();
// Test delta limit + reverse.
$this
->prepareView($view);
$view->displayHandlers
->get('default')->options['fields'][$field_name]['delta_offset'] = 0;
$view->displayHandlers
->get('default')->options['fields'][$field_name]['group_rows'] = TRUE;
$view->displayHandlers
->get('default')->options['fields'][$field_name]['delta_limit'] = 3;
$view->displayHandlers
->get('default')->options['fields'][$field_name]['delta_reversed'] = TRUE;
$view
->preview();
for ($i = 0; $i < 3; $i++) {
$rendered_field = $view->style_plugin
->getField($i, $field_name);
$items = [];
$pure_items = $this->nodes[$i]->{$field_name}
->getValue();
array_splice($pure_items, 0, -3);
$pure_items = array_reverse($pure_items);
foreach ($pure_items as $j => $item) {
$items[] = $pure_items[$j]['value'];
}
// Check that the amount of items is limited and they are reversed.
$this
->assertEquals(implode(', ', $items), $rendered_field);
}
$view
->destroy();
// Test delta first last.
$this
->prepareView($view);
$view->displayHandlers
->get('default')->options['fields'][$field_name]['group_rows'] = TRUE;
$view->displayHandlers
->get('default')->options['fields'][$field_name]['delta_limit'] = 0;
$view->displayHandlers
->get('default')->options['fields'][$field_name]['delta_first_last'] = TRUE;
$view->displayHandlers
->get('default')->options['fields'][$field_name]['delta_reversed'] = FALSE;
$view
->preview();
for ($i = 0; $i < 3; $i++) {
$rendered_field = $view->style_plugin
->getField($i, $field_name);
$items = [];
$pure_items = $this->nodes[$i]->{$field_name}
->getValue();
$items[] = $pure_items[0]['value'];
$items[] = $pure_items[4]['value'];
// Check that items are limited to first and last.
$this
->assertEquals(implode(', ', $items), $rendered_field);
}
$view
->destroy();
// Test delta limit + custom separator.
$this
->prepareView($view);
$view->displayHandlers
->get('default')->options['fields'][$field_name]['delta_first_last'] = FALSE;
$view->displayHandlers
->get('default')->options['fields'][$field_name]['delta_limit'] = 3;
$view->displayHandlers
->get('default')->options['fields'][$field_name]['group_rows'] = TRUE;
$view->displayHandlers
->get('default')->options['fields'][$field_name]['separator'] = ':';
$view
->preview();
for ($i = 0; $i < 3; $i++) {
$rendered_field = $view->style_plugin
->getField($i, $field_name);
$items = [];
$pure_items = $this->nodes[$i]->{$field_name}
->getValue();
$pure_items = array_splice($pure_items, 0, 3);
foreach ($pure_items as $j => $item) {
$items[] = $pure_items[$j]['value'];
}
// Check that the amount of items is limited and the custom separator is
// correct.
$this
->assertEquals(implode(':', $items), $rendered_field);
}
$view
->destroy();
// Test separator with HTML, ensure it is escaped.
$this
->prepareView($view);
$view->displayHandlers
->get('default')->options['fields'][$field_name]['group_rows'] = TRUE;
$view->displayHandlers
->get('default')->options['fields'][$field_name]['delta_limit'] = 3;
$view->displayHandlers
->get('default')->options['fields'][$field_name]['separator'] = '<h2>test</h2>';
$view
->preview();
for ($i = 0; $i < 3; $i++) {
$rendered_field = $view->style_plugin
->getField($i, $field_name);
$items = [];
$pure_items = $this->nodes[$i]->{$field_name}
->getValue();
$pure_items = array_splice($pure_items, 0, 3);
foreach ($pure_items as $j => $item) {
$items[] = $pure_items[$j]['value'];
}
// Check that the custom separator is correctly escaped.
$this
->assertEquals(implode('<h2>test</h2>', $items), $rendered_field);
}
}
/**
* Sets up the testing view with random field data.
*
* @param \Drupal\views\ViewExecutable $view
* The view to add field data to.
*/
protected function prepareView(ViewExecutable $view) {
$view->storage
->invalidateCaches();
$view
->initDisplay();
foreach ($this->fieldStorages as $field_storage) {
$field_name = $field_storage
->getName();
$view->display_handler->options['fields'][$field_name]['id'] = $field_name;
$view->display_handler->options['fields'][$field_name]['table'] = 'node__' . $field_name;
$view->display_handler->options['fields'][$field_name]['field'] = $field_name;
}
}
/**
* Creates the testing fields.
*/
protected function createFields() {
$fields_data = [
[
'field_name' => 'field_name_0',
'type' => 'string',
],
[
'field_name' => 'field_name_1',
'type' => 'string',
],
[
'field_name' => 'field_name_2',
'type' => 'string',
],
// Field with cardinality > 1.
[
'field_name' => 'field_name_3',
'type' => 'string',
'cardinality' => FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED,
],
// Field that will have no value.
[
'field_name' => 'field_name_4',
'type' => 'string',
'cardinality' => FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED,
],
// Text field.
[
'field_name' => 'field_name_5',
'type' => 'text',
],
// Text field with access control.
// @see field_test_entity_field_access()
[
'field_name' => 'field_no_view_access',
'type' => 'text',
],
];
foreach ($fields_data as $field_data) {
$field_data += [
'entity_type' => 'node',
];
$field_storage = FieldStorageConfig::create($field_data);
$field_storage
->save();
$this->fieldStorages[] = $field_storage;
FieldConfig::create([
'field_storage' => $field_storage,
'bundle' => 'page',
])
->save();
}
}
}
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 | 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. | |
ConfigTestTrait:: |
protected | function | Returns a ConfigImporter object to import test configuration. | |
ConfigTestTrait:: |
protected | function | Copies configuration objects from source storage to target storage. | |
ExtensionListTestTrait:: |
protected | function | Gets the path for the specified module. | |
ExtensionListTestTrait:: |
protected | function | Gets the path for the specified theme. | |
HandlerFieldFieldTest:: |
protected | property | Test field storage. | |
HandlerFieldFieldTest:: |
protected static | property |
Modules to enable. Overrides KernelTestBase:: |
|
HandlerFieldFieldTest:: |
protected | property | Test nodes. | |
HandlerFieldFieldTest:: |
public static | property | Views used by this test. | |
HandlerFieldFieldTest:: |
protected | function | Creates the testing fields. | |
HandlerFieldFieldTest:: |
public | function | Tests that fields with formatters runs as expected. | |
HandlerFieldFieldTest:: |
public | function | Tests inaccessible field rendering. | |
HandlerFieldFieldTest:: |
public | function | Tests multi-value field rendering. | |
HandlerFieldFieldTest:: |
public | function | Tests simple field rendering. | |
HandlerFieldFieldTest:: |
protected | function | Sets up the testing view with random field data. | |
HandlerFieldFieldTest:: |
public | function | Tests fields rendering in views. | |
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. | 3 |
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. | 4 |
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. | 2 |
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:: |
14 |
KernelTestBase:: |
protected | function | Renders a render array. | |
KernelTestBase:: |
protected | function | Sets the install profile and rebuilds the container to update it. | |
KernelTestBase:: |
protected | function | Sets an in-memory Settings variable. | |
KernelTestBase:: |
protected | function | 126 | |
KernelTestBase:: |
public static | function | ||
KernelTestBase:: |
protected | function | Sets up the filesystem, so things like the file directory. | 1 |
KernelTestBase:: |
protected | function | Stops test execution. | |
KernelTestBase:: |
protected | function | 3 | |
KernelTestBase:: |
public | function | @after | |
KernelTestBase:: |
protected | function | Dumps the current state of the virtual filesystem to STDOUT. | |
KernelTestBase:: |
public | function | Prevents serializing any properties. | |
NodeCreationTrait:: |
protected | function | Creates a node based on default settings. | |
NodeCreationTrait:: |
public | function | Get a node from the database based on its title. | |
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. | |
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. | |
TestRequirementsTrait:: |
protected static | function | Returns the Drupal root directory. |