class EntityViewBuilderTest in Zircon Profile 8
Same name and namespace in other branches
- 8.0 core/modules/system/src/Tests/Entity/EntityViewBuilderTest.php \Drupal\system\Tests\Entity\EntityViewBuilderTest
Tests the entity view builder.
@group Entity
Hierarchy
- class \Drupal\simpletest\TestBase uses AssertHelperTrait, RandomGeneratorTrait, SessionTestTrait
- class \Drupal\simpletest\KernelTestBase uses AssertContentTrait
- class \Drupal\system\Tests\Entity\EntityUnitTestBase
- class \Drupal\system\Tests\Entity\EntityViewBuilderTest uses EntityReferenceTestTrait
- class \Drupal\system\Tests\Entity\EntityUnitTestBase
- class \Drupal\simpletest\KernelTestBase uses AssertContentTrait
Expanded class hierarchy of EntityViewBuilderTest
File
- core/
modules/ system/ src/ Tests/ Entity/ EntityViewBuilderTest.php, line 21 - Contains \Drupal\system\Tests\Entity\EntityViewBuilderTest.
Namespace
Drupal\system\Tests\EntityView source
class EntityViewBuilderTest extends EntityUnitTestBase {
use EntityReferenceTestTrait;
/**
* {@inheritdoc}
*/
protected function setUp() {
parent::setUp();
$this
->installConfig(array(
'user',
'entity_test',
));
// Give anonymous users permission to view test entities.
Role::load(RoleInterface::ANONYMOUS_ID)
->grantPermission('view test entity')
->save();
}
/**
* Tests entity render cache handling.
*/
public function testEntityViewBuilderCache() {
/** @var \Drupal\Core\Render\RendererInterface $renderer */
$renderer = $this->container
->get('renderer');
$cache_contexts_manager = \Drupal::service("cache_contexts_manager");
$cache = \Drupal::cache();
// Force a request via GET so we can get drupal_render() cache working.
$request = \Drupal::request();
$request_method = $request->server
->get('REQUEST_METHOD');
$request
->setMethod('GET');
$entity_test = $this
->createTestEntity('entity_test');
// Test that new entities (before they are saved for the first time) do not
// generate a cache entry.
$build = $this->container
->get('entity.manager')
->getViewBuilder('entity_test')
->view($entity_test, 'full');
$this
->assertTrue(isset($build['#cache']) && array_keys($build['#cache']) == [
'tags',
'contexts',
'max-age',
], 'The render array element of new (unsaved) entities is not cached, but does have cache tags set.');
// Get a fully built entity view render array.
$entity_test
->save();
$build = $this->container
->get('entity.manager')
->getViewBuilder('entity_test')
->view($entity_test, 'full');
$cid_parts = array_merge($build['#cache']['keys'], $cache_contexts_manager
->convertTokensToKeys([
'languages:' . LanguageInterface::TYPE_INTERFACE,
'theme',
'user.permissions',
])
->getKeys());
$cid = implode(':', $cid_parts);
$bin = $build['#cache']['bin'];
// Mock the build array to not require the theme registry.
unset($build['#theme']);
$build['#markup'] = 'entity_render_test';
// Test that a cache entry is created.
$renderer
->renderRoot($build);
$this
->assertTrue($this->container
->get('cache.' . $bin)
->get($cid), 'The entity render element has been cached.');
// Re-save the entity and check that the cache entry has been deleted.
$cache
->set('kittens', 'Kitten data', Cache::PERMANENT, $build['#cache']['tags']);
$entity_test
->save();
$this
->assertFalse($this->container
->get('cache.' . $bin)
->get($cid), 'The entity render cache has been cleared when the entity was saved.');
$this
->assertFalse($cache
->get('kittens'), 'The entity saving has invalidated cache tags.');
// Rebuild the render array (creating a new cache entry in the process) and
// delete the entity to check the cache entry is deleted.
unset($build['#printed']);
$renderer
->renderRoot($build);
$this
->assertTrue($this->container
->get('cache.' . $bin)
->get($cid), 'The entity render element has been cached.');
$entity_test
->delete();
$this
->assertFalse($this->container
->get('cache.' . $bin)
->get($cid), 'The entity render cache has been cleared when the entity was deleted.');
// Restore the previous request method.
$request
->setMethod($request_method);
}
/**
* Tests entity render cache with references.
*/
public function testEntityViewBuilderCacheWithReferences() {
/** @var \Drupal\Core\Render\RendererInterface $renderer */
$renderer = $this->container
->get('renderer');
$cache_contexts_manager = \Drupal::service("cache_contexts_manager");
// Force a request via GET so we can get drupal_render() cache working.
$request = \Drupal::request();
$request_method = $request->server
->get('REQUEST_METHOD');
$request
->setMethod('GET');
// Create an entity reference field and an entity that will be referenced.
$this
->createEntityReferenceField('entity_test', 'entity_test', 'reference_field', 'Reference', 'entity_test');
entity_get_display('entity_test', 'entity_test', 'full')
->setComponent('reference_field', [
'type' => 'entity_reference_entity_view',
'settings' => [
'link' => FALSE,
],
])
->save();
$entity_test_reference = $this
->createTestEntity('entity_test');
$entity_test_reference
->save();
// Get a fully built entity view render array for the referenced entity.
$build = $this->container
->get('entity.manager')
->getViewBuilder('entity_test')
->view($entity_test_reference, 'full');
$cid_parts = array_merge($build['#cache']['keys'], $cache_contexts_manager
->convertTokensToKeys([
'languages:' . LanguageInterface::TYPE_INTERFACE,
'theme',
'user.permissions',
])
->getKeys());
$cid_reference = implode(':', $cid_parts);
$bin_reference = $build['#cache']['bin'];
// Mock the build array to not require the theme registry.
unset($build['#theme']);
$build['#markup'] = 'entity_render_test';
$renderer
->renderRoot($build);
// Test that a cache entry was created for the referenced entity.
$this
->assertTrue($this->container
->get('cache.' . $bin_reference)
->get($cid_reference), 'The entity render element for the referenced entity has been cached.');
// Create another entity that references the first one.
$entity_test = $this
->createTestEntity('entity_test');
$entity_test->reference_field->entity = $entity_test_reference;
$entity_test
->save();
// Get a fully built entity view render array.
$build = $this->container
->get('entity.manager')
->getViewBuilder('entity_test')
->view($entity_test, 'full');
$cid_parts = array_merge($build['#cache']['keys'], $cache_contexts_manager
->convertTokensToKeys([
'languages:' . LanguageInterface::TYPE_INTERFACE,
'theme',
'user.permissions',
])
->getKeys());
$cid = implode(':', $cid_parts);
$bin = $build['#cache']['bin'];
// Mock the build array to not require the theme registry.
unset($build['#theme']);
$build['#markup'] = 'entity_render_test';
$renderer
->renderRoot($build);
// Test that a cache entry is created.
$this
->assertTrue($this->container
->get('cache.' . $bin)
->get($cid), 'The entity render element has been cached.');
// Save the entity and verify that both cache entries have been deleted.
$entity_test_reference
->save();
$this
->assertFalse($this->container
->get('cache.' . $bin)
->get($cid), 'The entity render cache has been cleared when the entity was deleted.');
$this
->assertFalse($this->container
->get('cache.' . $bin_reference)
->get($cid_reference), 'The entity render cache for the referenced entity has been cleared when the entity was deleted.');
// Restore the previous request method.
$request
->setMethod($request_method);
}
/**
* Tests entity render cache toggling.
*/
public function testEntityViewBuilderCacheToggling() {
$entity_test = $this
->createTestEntity('entity_test');
$entity_test
->save();
// Test a view mode in default conditions: render caching is enabled for
// the entity type and the view mode.
$build = $this->container
->get('entity.manager')
->getViewBuilder('entity_test')
->view($entity_test, 'full');
$this
->assertTrue(isset($build['#cache']) && array_keys($build['#cache']) == [
'tags',
'contexts',
'max-age',
'keys',
'bin',
], 'A view mode with render cache enabled has the correct output (cache tags, keys, contexts, max-age and bin).');
// Test that a view mode can opt out of render caching.
$build = $this->container
->get('entity.manager')
->getViewBuilder('entity_test')
->view($entity_test, 'test');
$this
->assertTrue(isset($build['#cache']) && array_keys($build['#cache']) == [
'tags',
'contexts',
'max-age',
], 'A view mode with render cache disabled has the correct output (only cache tags, contexts and max-age).');
// Test that an entity type can opt out of render caching completely.
$entity_test_no_cache = $this
->createTestEntity('entity_test_label');
$entity_test_no_cache
->save();
$build = $this->container
->get('entity.manager')
->getViewBuilder('entity_test_label')
->view($entity_test_no_cache, 'full');
$this
->assertTrue(isset($build['#cache']) && array_keys($build['#cache']) == [
'tags',
'contexts',
'max-age',
], 'An entity type can opt out of render caching regardless of view mode configuration, but always has cache tags, contexts and max-age set.');
}
/**
* Tests weighting of display components.
*/
public function testEntityViewBuilderWeight() {
/** @var \Drupal\Core\Render\RendererInterface $renderer */
$renderer = $this->container
->get('renderer');
// Set a weight for the label component.
entity_get_display('entity_test', 'entity_test', 'full')
->setComponent('label', array(
'weight' => 20,
))
->save();
// Create and build a test entity.
$entity_test = $this
->createTestEntity('entity_test');
$view = $this->container
->get('entity.manager')
->getViewBuilder('entity_test')
->view($entity_test, 'full');
$renderer
->renderRoot($view);
// Check that the weight is respected.
$this
->assertEqual($view['label']['#weight'], 20, 'The weight of a display component is respected.');
}
/**
* Creates an entity for testing.
*
* @param string $entity_type
* The entity type.
*
* @return \Drupal\Core\Entity\EntityInterface
* The created entity.
*/
protected function createTestEntity($entity_type) {
$data = array(
'bundle' => $entity_type,
'name' => $this
->randomMachineName(),
);
return $this->container
->get('entity.manager')
->getStorage($entity_type)
->create($data);
}
}
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. | 2 |
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 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. | |
AssertHelperTrait:: |
protected | function | Casts MarkupInterface objects into strings. | |
EntityReferenceTestTrait:: |
protected | function | Creates a field of an entity reference field storage on the specified bundle. | |
EntityUnitTestBase:: |
protected | property | The entity manager service. | |
EntityUnitTestBase:: |
protected | property | A list of generated identifiers. | |
EntityUnitTestBase:: |
public static | property |
Modules to enable. Overrides KernelTestBase:: |
35 |
EntityUnitTestBase:: |
protected | property | The state service. | |
EntityUnitTestBase:: |
protected | function | Creates a user. | |
EntityUnitTestBase:: |
protected | function | Generates a random ID avoiding collisions. | |
EntityUnitTestBase:: |
protected | function | Returns the entity_test hook invocation info. | |
EntityUnitTestBase:: |
protected | function | Installs a module and refreshes services. | |
EntityUnitTestBase:: |
protected | function | Refresh services. | 1 |
EntityUnitTestBase:: |
protected | function | Reloads the given entity from the storage and returns it. | |
EntityUnitTestBase:: |
protected | function | Uninstalls a module and refreshes services. | |
EntityViewBuilderTest:: |
protected | function | Creates an entity for testing. | |
EntityViewBuilderTest:: |
protected | function |
Performs setup tasks before each individual test method is run. Overrides EntityUnitTestBase:: |
|
EntityViewBuilderTest:: |
public | function | Tests entity render cache handling. | |
EntityViewBuilderTest:: |
public | function | Tests entity render cache toggling. | |
EntityViewBuilderTest:: |
public | function | Tests entity render cache with references. | |
EntityViewBuilderTest:: |
public | function | Tests weighting of display components. | |
KernelTestBase:: |
protected | property | The configuration directories for this test run. | |
KernelTestBase:: |
protected | property | A KeyValueMemoryFactory instance to use when building the container. | |
KernelTestBase:: |
private | property | ||
KernelTestBase:: |
protected | property | Array of registered stream wrappers. | |
KernelTestBase:: |
private | property | ||
KernelTestBase:: |
protected | function |
Act on global state information before the environment is altered for a test. Overrides TestBase:: |
|
KernelTestBase:: |
public | function | Sets up the base service container for this test. | 12 |
KernelTestBase:: |
protected | function | Provides the data for setting the default language on the container. | 1 |
KernelTestBase:: |
protected | function | Disables modules for this test. | |
KernelTestBase:: |
protected | function | Enables modules for this test. | |
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 a specific table from a module schema definition. | |
KernelTestBase:: |
protected | function | Create and set new configuration directories. | 1 |
KernelTestBase:: |
protected | function | Registers a stream wrapper for this test. | |
KernelTestBase:: |
protected | function | Renders a render array. | |
KernelTestBase:: |
protected | function |
Performs cleanup tasks after each individual test method has been run. Overrides TestBase:: |
|
KernelTestBase:: |
function |
Constructor for Test. Overrides TestBase:: |
||
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. | |
SessionTestTrait:: |
protected | property | The name of the session cookie. | |
SessionTestTrait:: |
protected | function | Generates a session cookie name. | |
SessionTestTrait:: |
protected | function | Returns the session name in use on the child site. | |
TestBase:: |
protected | property | Assertions thrown in that test case. | |
TestBase:: |
protected | property | The config importer that can used in a test. | 5 |
TestBase:: |
protected static | property | An array of config object names that are excluded from schema checking. | |
TestBase:: |
protected | property | The dependency injection container used in the test. | |
TestBase:: |
protected | property | The database prefix of this test run. | |
TestBase:: |
public | property | Whether to die in case any test assertion fails. | |
TestBase:: |
protected | property | HTTP authentication credentials (<username>:<password>). | |
TestBase:: |
protected | property | HTTP authentication method (specified as a CURLAUTH_* constant). | |
TestBase:: |
protected | property | The DrupalKernel instance used in the test. | 1 |
TestBase:: |
protected | property | The original configuration (variables), if available. | |
TestBase:: |
protected | property | The original configuration (variables). | |
TestBase:: |
protected | property | The original configuration directories. | |
TestBase:: |
protected | property | The original container. | |
TestBase:: |
protected | property | The original file directory, before it was changed for testing purposes. | |
TestBase:: |
protected | property | The original language. | |
TestBase:: |
protected | property | The original database prefix when running inside Simpletest. | |
TestBase:: |
protected | property | The original installation profile. | |
TestBase:: |
protected | property | The name of the session cookie of the test-runner. | |
TestBase:: |
protected | property | The settings array. | |
TestBase:: |
protected | property | The original array of shutdown function callbacks. | 1 |
TestBase:: |
protected | property | The site directory of the original parent site. | |
TestBase:: |
protected | property | The original user, before testing began. | 1 |
TestBase:: |
protected | property | The private file directory for the test environment. | |
TestBase:: |
protected | property | The public file directory for the test environment. | |
TestBase:: |
public | property | Current results of this test case. | |
TestBase:: |
protected | property | The site directory of this test run. | |
TestBase:: |
protected | property | This class is skipped when looking for the source of an assertion. | |
TestBase:: |
protected | property | Set to TRUE to strict check all configuration saved. | 4 |
TestBase:: |
protected | property | The temporary file directory for the test environment. | |
TestBase:: |
protected | property | The test run ID. | |
TestBase:: |
protected | property | Time limit for the test. | |
TestBase:: |
protected | property | The translation file directory for the test environment. | |
TestBase:: |
public | property | TRUE if verbose debugging is enabled. | |
TestBase:: |
protected | property | Safe class name for use in verbose output filenames. | |
TestBase:: |
protected | property | Directory where verbose output files are put. | |
TestBase:: |
protected | property | URL to the verbose output file directory. | |
TestBase:: |
protected | property | Incrementing identifier for verbose output filenames. | |
TestBase:: |
protected | function | Internal helper: stores the assert. | |
TestBase:: |
protected | function | Check to see if two values are equal. | |
TestBase:: |
protected | function | Asserts that a specific error has been logged to the PHP error log. | |
TestBase:: |
protected | function | Check to see if a value is false. | |
TestBase:: |
protected | function | Check to see if two values are identical. | |
TestBase:: |
protected | function | Checks to see if two objects are identical. | |
TestBase:: |
protected | function | Asserts that no errors have been logged to the PHP error.log thus far. | |
TestBase:: |
protected | function | Check to see if two values are not equal. | |
TestBase:: |
protected | function | Check to see if two values are not identical. | |
TestBase:: |
protected | function | Check to see if a value is not NULL. | |
TestBase:: |
protected | function | Check to see if a value is NULL. | |
TestBase:: |
protected | function | Check to see if a value is not false. | |
TestBase:: |
private | function | Changes the database connection to the prefixed one. | |
TestBase:: |
protected | function | Checks the matching requirements for Test. | 2 |
TestBase:: |
protected | function | Configuration accessor for tests. Returns non-overridden configuration. | |
TestBase:: |
public | function | Returns a ConfigImporter object to import test importing of configuration. | 5 |
TestBase:: |
public | function | Copies configuration objects from source storage to target storage. | |
TestBase:: |
public static | function | Delete an assertion record by message ID. | |
TestBase:: |
protected | function | Fire an error assertion. | 3 |
TestBase:: |
public | function | Handle errors during test runs. | |
TestBase:: |
protected | function | Handle exceptions. | |
TestBase:: |
protected | function | Fire an assertion that is always negative. | |
TestBase:: |
public static | function | Ensures test files are deletable within file_unmanaged_delete_recursive(). | |
TestBase:: |
public static | function | Converts a list of possible parameters into a stack of permutations. | |
TestBase:: |
protected | function | Cycles through backtrace until the first non-assertion method is found. | |
TestBase:: |
protected | function | Gets the config schema exclusions for this test. | |
TestBase:: |
public static | function | Returns the database connection to the site running Simpletest. | |
TestBase:: |
public | function | Gets the database prefix. | |
TestBase:: |
public | function | Gets the temporary files directory. | |
TestBase:: |
public static | function | Store an assertion from outside the testing context. | |
TestBase:: |
protected | function | Fire an assertion that is always positive. | |
TestBase:: |
private | function | Generates a database prefix for running tests. | |
TestBase:: |
private | function | Prepares the current environment for running the test. | |
TestBase:: |
private | function | Cleans up the test environment and restores the original environment. | |
TestBase:: |
public | function | Run all tests in this class. | 1 |
TestBase:: |
protected | function | Changes in memory settings. | |
TestBase:: |
protected | function | Helper method to store an assertion record in the configured database. | |
TestBase:: |
protected | function | Logs a verbose message in a text file. |