class FieldApiDataTest in Drupal 9
Same name and namespace in other branches
- 8 core/modules/views/tests/src/Kernel/FieldApiDataTest.php \Drupal\Tests\views\Kernel\FieldApiDataTest
Tests the Field Views data.
@group views
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\Tests\views\Kernel\ViewsKernelTestBase uses ViewResultAssertionTrait
- class \Drupal\Tests\views\Kernel\FieldApiDataTest
- class \Drupal\Tests\views\Kernel\ViewsKernelTestBase uses ViewResultAssertionTrait
Expanded class hierarchy of FieldApiDataTest
File
- core/
modules/ views/ tests/ src/ Kernel/ FieldApiDataTest.php, line 19
Namespace
Drupal\Tests\views\KernelView source
class FieldApiDataTest extends ViewsKernelTestBase {
/**
* {@inheritdoc}
*/
protected static $modules = [
'field',
'filter',
'language',
'node',
'user',
];
/**
* {@inheritdoc}
*/
public static $testViews = [
'test_field_config_translation_filter',
];
/**
* {@inheritdoc}
*/
protected function setUp($import_test_views = TRUE) : void {
parent::setUp($import_test_views);
$this
->installEntitySchema('user');
$this
->installEntitySchema('node');
$this
->installSchema('node', [
'node_access',
]);
}
/**
* Unit testing the views data structure.
*
* We check data structure for both node and node revision tables.
*/
public function testViewsData() {
$field_storage_string = FieldStorageConfig::create([
'field_name' => 'field_string',
'entity_type' => 'node',
'type' => 'string',
]);
$field_storage_string
->save();
$field_storage_string_long = FieldStorageConfig::create([
'field_name' => 'field_string_long',
'entity_type' => 'node',
'type' => 'string_long',
]);
$field_storage_string_long
->save();
NodeType::create([
'type' => 'page',
])
->save();
NodeType::create([
'type' => 'article',
])
->save();
// Attach the field to nodes.
FieldConfig::create([
'field_name' => 'field_string',
'entity_type' => 'node',
'bundle' => 'page',
'label' => 'GiraffeA" label',
])
->save();
// Attach the string_long field to the page node type.
FieldConfig::create([
'field_name' => 'field_string_long',
'entity_type' => 'node',
'bundle' => 'page',
'label' => 'string_long label',
])
->save();
// Attach the same field to a different bundle with a different label.
FieldConfig::create([
'field_name' => 'field_string',
'entity_type' => 'node',
'bundle' => 'article',
'label' => 'GiraffeB" label',
])
->save();
// Now create some example nodes/users for the view result.
for ($i = 0; $i < 5; $i++) {
$edit = [
'field_string' => [
[
'value' => $this
->randomMachineName(),
],
],
];
$nodes[] = Node::create([
'type' => 'page',
] + $edit);
}
/** @var \Drupal\Core\Entity\Sql\DefaultTableMapping $table_mapping */
$table_mapping = $this->container
->get('entity_type.manager')
->getStorage('node')
->getTableMapping();
$current_table = $table_mapping
->getDedicatedDataTableName($field_storage_string);
$revision_table = $table_mapping
->getDedicatedRevisionTableName($field_storage_string);
$data = $this
->getViewsData();
$this
->assertArrayHasKey($current_table, $data);
$this
->assertArrayHasKey($revision_table, $data);
// The node field should join against node_field_data.
$this
->assertArrayHasKey('node_field_data', $data[$current_table]['table']['join']);
$this
->assertArrayHasKey('node_field_revision', $data[$revision_table]['table']['join']);
$expected_join = [
'table' => $current_table,
'left_field' => 'nid',
'field' => 'entity_id',
'extra' => [
[
'field' => 'deleted',
'value' => 0,
'numeric' => TRUE,
],
[
'left_field' => 'langcode',
'field' => 'langcode',
],
],
];
$this
->assertSame($expected_join, $data[$current_table]['table']['join']['node_field_data']);
$expected_join = [
'table' => $revision_table,
'left_field' => 'vid',
'field' => 'revision_id',
'extra' => [
[
'field' => 'deleted',
'value' => 0,
'numeric' => TRUE,
],
[
'left_field' => 'langcode',
'field' => 'langcode',
],
],
];
$this
->assertSame($expected_join, $data[$revision_table]['table']['join']['node_field_revision']);
// Test click sortable for string field.
$this
->assertTrue($data[$current_table][$field_storage_string
->getName()]['field']['click sortable']);
// Click sort should only be on the primary field.
$this
->assertTrue(empty($data[$revision_table][$field_storage_string
->getName()]['field']['click sortable']));
// Test click sortable for long text field.
$data_long = $this
->getViewsData('field_string_long');
$current_table_long = $table_mapping
->getDedicatedDataTableName($field_storage_string_long);
$this
->assertTrue($data_long[$current_table_long][$field_storage_string_long
->getName()]['field']['click sortable']);
$this
->assertInstanceOf(MarkupInterface::class, $data[$current_table][$field_storage_string
->getName()]['help']);
$this
->assertEquals('Appears in: page, article. Also known as: Content: GiraffeB" label', $data[$current_table][$field_storage_string
->getName()]['help']);
$this
->assertInstanceOf(MarkupInterface::class, $data[$current_table][$field_storage_string
->getName() . '_value']['help']);
$this
->assertEquals('Appears in: page, article. Also known as: Content: GiraffeA" label (field_string)', $data[$current_table][$field_storage_string
->getName() . '_value']['help']);
// Since each label is only used once, views_entity_field_label() will
// return a label using alphabetical sorting.
$this
->assertEquals('GiraffeA" label (field_string)', $data[$current_table][$field_storage_string
->getName() . '_value']['title']);
// Attach the same field to a different bundle with a different label.
NodeType::create([
'type' => 'news',
])
->save();
FieldConfig::create([
'field_name' => $field_storage_string
->getName(),
'entity_type' => 'node',
'bundle' => 'news',
'label' => 'GiraffeB" label',
])
->save();
$this->container
->get('views.views_data')
->clear();
$data = $this
->getViewsData();
// Now the 'GiraffeB" label' is used twice and therefore will be
// selected by views_entity_field_label().
$this
->assertEquals('GiraffeB" label (field_string)', $data[$current_table][$field_storage_string
->getName() . '_value']['title']);
$this
->assertInstanceOf(MarkupInterface::class, $data[$current_table][$field_storage_string
->getName()]['help']);
$this
->assertEquals('Appears in: page, article, news. Also known as: Content: GiraffeA" label', $data[$current_table][$field_storage_string
->getName()]['help']);
}
/**
* Gets the views data for the field created in setUp().
*
* @param string $field_storage_key
* (optional) The optional field name.
*
* @return array
* Views data.
*/
protected function getViewsData($field_storage_key = 'field_string') {
$views_data = $this->container
->get('views.views_data');
$data = [];
// Check the table and the joins of the first field. Attached to node only.
/** @var \Drupal\Core\Entity\Sql\DefaultTableMapping $table_mapping */
$table_mapping = $this->container
->get('entity_type.manager')
->getStorage('node')
->getTableMapping();
$field_storage = FieldStorageConfig::loadByName('node', $field_storage_key);
$current_table = $table_mapping
->getDedicatedDataTableName($field_storage);
$revision_table = $table_mapping
->getDedicatedRevisionTableName($field_storage);
$data[$current_table] = $views_data
->get($current_table);
$data[$revision_table] = $views_data
->get($revision_table);
return $data;
}
/**
* Tests filtering entries with different translatability.
*/
public function testEntityFieldFilter() {
NodeType::create([
'type' => 'bundle1',
])
->save();
NodeType::create([
'type' => 'bundle2',
])
->save();
// Create some example content.
ConfigurableLanguage::create([
'id' => 'es',
])
->save();
ConfigurableLanguage::create([
'id' => 'fr',
])
->save();
ContentLanguageSettings::loadByEntityTypeBundle('node', 'bundle1')
->setDefaultLangcode('es')
->setLanguageAlterable(TRUE)
->save();
ContentLanguageSettings::loadByEntityTypeBundle('node', 'bundle2')
->setDefaultLangcode('es')
->setLanguageAlterable(TRUE)
->save();
$field_translation_map = [
1 => [
'bundle1' => TRUE,
'bundle2' => TRUE,
],
2 => [
'bundle1' => FALSE,
'bundle2' => FALSE,
],
3 => [
'bundle1' => TRUE,
'bundle2' => FALSE,
],
];
for ($i = 1; $i < 4; $i++) {
$field_name = "field_name_{$i}";
FieldStorageConfig::create([
'field_name' => $field_name,
'entity_type' => 'node',
'type' => 'string',
])
->save();
foreach ([
'bundle1',
'bundle2',
] as $bundle) {
FieldConfig::create([
'field_name' => $field_name,
'entity_type' => 'node',
'bundle' => $bundle,
'translatable' => $field_translation_map[$i][$bundle],
])
->save();
}
}
$node1 = Node::create([
'title' => 'Test title bundle1',
'type' => 'bundle1',
'langcode' => 'es',
'field_name_1' => 'field name 1: es',
'field_name_2' => 'field name 2: es',
'field_name_3' => 'field name 3: es',
]);
$node1
->save();
/** @var \Drupal\node\NodeInterface $translation */
$node1
->addTranslation('fr', [
'title' => $node1->title->value,
'field_name_1' => 'field name 1: fr',
'field_name_3' => 'field name 3: fr',
])
->save();
$node2 = Node::create([
'title' => 'Test title bundle2',
'type' => 'bundle2',
'langcode' => 'es',
'field_name_1' => 'field name 1: es',
'field_name_2' => 'field name 2: es',
'field_name_3' => 'field name 3: es',
]);
$node2
->save();
$node2
->addTranslation('fr', [
'title' => $node2->title->value,
'field_name_1' => 'field name 1: fr',
])
->save();
$map = [
'nid' => 'nid',
'langcode' => 'langcode',
];
$view = Views::getView('test_field_config_translation_filter');
// Filter by 'field name 1: es'.
$view
->setDisplay('embed_1');
$this
->executeView($view);
$expected = [
[
'nid' => $node1
->id(),
'langcode' => 'es',
],
[
'nid' => $node2
->id(),
'langcode' => 'es',
],
];
$this
->assertIdenticalResultset($view, $expected, $map);
$view
->destroy();
// Filter by 'field name 1: fr'.
$view
->setDisplay('embed_2');
$this
->executeView($view);
$expected = [
[
'nid' => $node1
->id(),
'langcode' => 'fr',
],
[
'nid' => $node2
->id(),
'langcode' => 'fr',
],
];
$this
->assertIdenticalResultset($view, $expected, $map);
$view
->destroy();
// Filter by 'field name 2: es'.
$view
->setDisplay('embed_3');
$this
->executeView($view);
$expected = [
[
'nid' => $node1
->id(),
'langcode' => 'es',
],
[
'nid' => $node1
->id(),
'langcode' => 'fr',
],
[
'nid' => $node2
->id(),
'langcode' => 'es',
],
[
'nid' => $node2
->id(),
'langcode' => 'fr',
],
];
$this
->assertIdenticalResultset($view, $expected, $map);
$view
->destroy();
// Filter by 'field name 2: fr', which doesn't exist.
$view
->setDisplay('embed_4');
$this
->executeView($view);
$expected = [];
$this
->assertIdenticalResultset($view, $expected, $map);
$view
->destroy();
// Filter by 'field name 3: es'.
$view
->setDisplay('embed_5');
$this
->executeView($view);
$expected = [
[
'nid' => $node1
->id(),
'langcode' => 'es',
],
[
'nid' => $node2
->id(),
'langcode' => 'es',
],
// Why is this one returned?
[
'nid' => $node2
->id(),
'langcode' => 'fr',
],
];
$this
->assertIdenticalResultset($view, $expected, $map);
$view
->destroy();
// Filter by 'field name 3: fr'.
$view
->setDisplay('embed_6');
$this
->executeView($view);
$expected = [
[
'nid' => $node1
->id(),
'langcode' => 'fr',
],
];
$this
->assertIdenticalResultset($view, $expected, $map);
$view
->destroy();
}
}
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. | |
ExtensionListTestTrait:: |
protected | function | Gets the path for the specified module. | |
ExtensionListTestTrait:: |
protected | function | Gets the path for the specified theme. | |
FieldApiDataTest:: |
protected static | property |
Modules to enable. Overrides ViewsKernelTestBase:: |
|
FieldApiDataTest:: |
public static | property |
Views to be enabled. Overrides ViewsKernelTestBase:: |
|
FieldApiDataTest:: |
protected | function | Gets the views data for the field created in setUp(). | |
FieldApiDataTest:: |
protected | function |
Overrides ViewsKernelTestBase:: |
|
FieldApiDataTest:: |
public | function | Tests filtering entries with different translatability. | |
FieldApiDataTest:: |
public | function | Unit testing the views data structure. | |
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. | |
ViewResultAssertionTrait:: |
protected | function | Verifies that a result set returned by a View matches expected values. | |
ViewResultAssertionTrait:: |
protected | function | Performs View result assertions. | |
ViewResultAssertionTrait:: |
protected | function | Verifies that a result set returned by a View differs from certain values. | |
ViewsKernelTestBase:: |
protected | function | Returns a very simple test dataset. | 8 |
ViewsKernelTestBase:: |
protected | function | Executes a view. | |
ViewsKernelTestBase:: |
protected | function | Orders a nested array containing a result set based on a given column. | |
ViewsKernelTestBase:: |
protected | function | Returns the schema definition. | 6 |
ViewsKernelTestBase:: |
protected | function | Sets up the configuration and schema of views and views_test_data modules. | 7 |
ViewsKernelTestBase:: |
protected | function | Returns the views data definition. | 22 |