class RowRenderCacheTest

Same name in other branches
  1. 8.9.x core/modules/views/tests/src/Kernel/Plugin/RowRenderCacheTest.php \Drupal\Tests\views\Kernel\Plugin\RowRenderCacheTest
  2. 10 core/modules/views/tests/src/Kernel/Plugin/RowRenderCacheTest.php \Drupal\Tests\views\Kernel\Plugin\RowRenderCacheTest
  3. 11.x core/modules/views/tests/src/Kernel/Plugin/RowRenderCacheTest.php \Drupal\Tests\views\Kernel\Plugin\RowRenderCacheTest

Tests row render caching.

@group views

Hierarchy

Expanded class hierarchy of RowRenderCacheTest

File

core/modules/views/tests/src/Kernel/Plugin/RowRenderCacheTest.php, line 18

Namespace

Drupal\Tests\views\Kernel\Plugin
View source
class RowRenderCacheTest extends ViewsKernelTestBase {
    use UserCreationTrait;
    
    /**
     * Modules to enable.
     *
     * @var array
     */
    protected static $modules = [
        'user',
        'node',
    ];
    
    /**
     * Views used by this test.
     *
     * @var array
     */
    public static $testViews = [
        'test_row_render_cache',
        'test_row_render_cache_none',
    ];
    
    /**
     * An editor user account.
     *
     * @var \Drupal\user\UserInterface
     */
    protected $editorUser;
    
    /**
     * A power user account.
     *
     * @var \Drupal\user\UserInterface
     */
    protected $powerUser;
    
    /**
     * A regular user account.
     *
     * @var \Drupal\user\UserInterface
     */
    protected $regularUser;
    
    /**
     * {@inheritdoc}
     */
    protected function setUpFixtures() {
        parent::setUpFixtures();
        $this->installEntitySchema('user');
        $this->installEntitySchema('node');
        $this->installSchema('node', 'node_access');
        $type = NodeType::create([
            'type' => 'test',
        ]);
        $type->save();
        $this->editorUser = $this->createUser([
            'bypass node access',
        ]);
        $this->powerUser = $this->createUser([
            'access content',
            'create test content',
            'edit own test content',
            'delete own test content',
        ]);
        $this->regularUser = $this->createUser([
            'access content',
        ]);
        // Create some test entities.
        for ($i = 0; $i < 5; $i++) {
            Node::create([
                'title' => 'b' . $i . $this->randomMachineName(),
                'type' => 'test',
            ])
                ->save();
        }
        // Create a power user node.
        Node::create([
            'title' => 'z' . $this->randomMachineName(),
            'uid' => $this->powerUser
                ->id(),
            'type' => 'test',
        ])
            ->save();
    }
    
    /**
     * Tests complex field rewriting and uncacheable field handlers.
     */
    public function testAdvancedCaching() {
        // Test that row field output is actually cached and with the proper cache
        // contexts.
        $this->doTestRenderedOutput($this->editorUser);
        $this->doTestRenderedOutput($this->editorUser, TRUE);
        $this->doTestRenderedOutput($this->powerUser);
        $this->doTestRenderedOutput($this->powerUser, TRUE);
        $this->doTestRenderedOutput($this->regularUser);
        $this->doTestRenderedOutput($this->regularUser, TRUE);
        // Alter the result set order and check that counter is still working
        // correctly.
        $this->doTestRenderedOutput($this->editorUser);
        
        /** @var \Drupal\node\NodeInterface $node */
        $node = Node::load(6);
        $node->setTitle('a' . $this->randomMachineName());
        $node->save();
        $this->doTestRenderedOutput($this->editorUser);
    }
    
    /**
     * Tests that rows are not cached when the none cache plugin is used.
     */
    public function testNoCaching() {
        $this->setCurrentUser($this->regularUser);
        $view = Views::getView('test_row_render_cache_none');
        $view->setDisplay();
        $view->preview();
        
        /** @var \Drupal\Core\Render\RenderCacheInterface $render_cache */
        $render_cache = $this->container
            ->get('render_cache');
        
        /** @var \Drupal\views\Plugin\views\cache\CachePluginBase $cache_plugin */
        $cache_plugin = $view->display_handler
            ->getPlugin('cache');
        foreach ($view->result as $row) {
            $keys = $cache_plugin->getRowCacheKeys($row);
            $cache = [
                '#cache' => [
                    'keys' => $keys,
                    'contexts' => [
                        'languages:language_interface',
                        'theme',
                        'user.permissions',
                    ],
                ],
            ];
            $element = $render_cache->get($cache);
            $this->assertFalse($element);
        }
    }
    
    /**
     * Check whether the rendered output matches expectations.
     *
     * @param \Drupal\Core\Session\AccountInterface $account
     *   The user account to tests rendering with.
     * @param bool $check_cache
     *   (optional) Whether explicitly test render cache entries.
     */
    protected function doTestRenderedOutput(AccountInterface $account, $check_cache = FALSE) {
        $this->setCurrentUser($account);
        $view = Views::getView('test_row_render_cache');
        $view->setDisplay();
        $view->preview();
        
        /** @var \Drupal\Core\Render\RenderCacheInterface $render_cache */
        $render_cache = $this->container
            ->get('render_cache');
        
        /** @var \Drupal\views\Plugin\views\cache\CachePluginBase $cache_plugin */
        $cache_plugin = $view->display_handler
            ->getPlugin('cache');
        // Retrieve nodes and sort them in alphabetical order to match view results.
        $nodes = Node::loadMultiple();
        usort($nodes, function (NodeInterface $a, NodeInterface $b) {
            return strcmp($a->label(), $b->label());
        });
        $index = 0;
        foreach ($nodes as $node) {
            $nid = $node->id();
            $access = $node->access('update');
            $counter = $index + 1;
            $expected = "{$nid}: {$counter} (just in case: {$nid})";
            $counter_output = $view->style_plugin
                ->getField($index, 'counter');
            $this->assertEquals($expected, $counter_output);
            $node_url = $node->toUrl()
                ->toString();
            $expected = "<a href=\"{$node_url}\"><span class=\"da-title\">{$node->label()}</span> <span class=\"counter\">{$counter_output}</span></a>";
            $output = $view->style_plugin
                ->getField($index, 'title');
            $this->assertEquals($expected, $output);
            $expected = $access ? "<a href=\"{$node_url}/edit?destination=/\" hreflang=\"en\">edit</a>" : "";
            $output = $view->style_plugin
                ->getField($index, 'edit_node');
            $this->assertEquals($expected, $output);
            $expected = $access ? "<a href=\"{$node_url}/delete?destination=/\" hreflang=\"en\">delete</a>" : "";
            $output = $view->style_plugin
                ->getField($index, 'delete_node');
            $this->assertEquals($expected, $output);
            $expected = $access ? '  <div class="dropbutton-wrapper"><div class="dropbutton-widget"><ul class="dropbutton">' . '<li><a href="' . $node_url . '/edit?destination=/" hreflang="en">Edit</a></li>' . '<li><a href="' . $node_url . '/delete?destination=/" hreflang="en">Delete</a></li>' . '</ul></div></div>' : '';
            $output = $view->style_plugin
                ->getField($index, 'operations');
            $this->assertEquals($expected, $output);
            if ($check_cache) {
                $keys = $cache_plugin->getRowCacheKeys($view->result[$index]);
                $cache = [
                    '#cache' => [
                        'keys' => $keys,
                        'contexts' => [
                            'languages:language_interface',
                            'theme',
                            'user.permissions',
                        ],
                    ],
                ];
                $element = $render_cache->get($cache);
                $this->assertNotEmpty($element);
            }
            $index++;
        }
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
AssertContentTrait::$content protected property The current raw content.
AssertContentTrait::$drupalSettings protected property The drupalSettings value from the current raw $content.
AssertContentTrait::$elements protected property The XML structure parsed from the current raw $content. 1
AssertContentTrait::$plainTextContent protected property The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById 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 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 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 protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked 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 protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected 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 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 protected function Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector 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 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 protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper 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::getUrl protected function Get the current URL from the cURL handler. 1
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.
AssertLegacyTrait::assert Deprecated protected function
AssertLegacyTrait::assertEqual Deprecated protected function
AssertLegacyTrait::assertIdentical Deprecated protected function
AssertLegacyTrait::assertIdenticalObject Deprecated protected function
AssertLegacyTrait::assertNotEqual Deprecated protected function
AssertLegacyTrait::assertNotIdentical Deprecated protected function
AssertLegacyTrait::pass Deprecated protected function
AssertLegacyTrait::verbose Deprecated protected function
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.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
KernelTestBase::$backupGlobals protected property Back up and restore any global variables that may be changed by tests.
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.
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$keyValue protected property The key_value service that must persist between container rebuilds.
KernelTestBase::$preserveGlobalState protected property Do not forward any global state from the parent process to the processes
that run the actual tests.
KernelTestBase::$root protected property The app root.
KernelTestBase::$runTestInSeparateProcess 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::$siteDirectory protected property
KernelTestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 7
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 private function Bootstraps a kernel for a test.
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.
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. 3
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to enable.
KernelTestBase::getModulesToEnable private static function Returns the modules to enable 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 26
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::stop protected function Stops test execution.
KernelTestBase::tearDown protected function 5
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__sleep public function Prevents serializing any properties.
PhpUnitWarnings::$deprecationWarnings private static property Deprecation warnings from PHPUnit to raise with @trigger_error().
PhpUnitWarnings::addWarning public function Converts PHPUnit deprecation warnings to E_USER_DEPRECATED.
RandomGeneratorTrait::$randomGenerator protected property The random generator.
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. 1
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.
RandomGeneratorTrait::randomStringValidate public function Callback for random string validation.
RowRenderCacheTest::$editorUser protected property An editor user account.
RowRenderCacheTest::$modules protected static property Modules to enable. Overrides ViewsKernelTestBase::$modules
RowRenderCacheTest::$powerUser protected property A power user account.
RowRenderCacheTest::$regularUser protected property A regular user account.
RowRenderCacheTest::$testViews public static property Views used by this test. Overrides ViewsKernelTestBase::$testViews
RowRenderCacheTest::doTestRenderedOutput protected function Check whether the rendered output matches expectations.
RowRenderCacheTest::setUpFixtures protected function Sets up the configuration and schema of views and views_test_data modules. Overrides ViewsKernelTestBase::setUpFixtures
RowRenderCacheTest::testAdvancedCaching public function Tests complex field rewriting and uncacheable field handlers.
RowRenderCacheTest::testNoCaching public function Tests that rows are not cached when the none cache plugin is used.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::checkModuleRequirements private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements protected function Check module requirements for the Drupal use case.
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid.
UserCreationTrait::createAdminRole protected function Creates an administrative role.
UserCreationTrait::createRole protected function Creates a role with specified permissions.
UserCreationTrait::createUser protected function Create a user with a given set of permissions.
UserCreationTrait::grantPermissions protected function Grant permissions to a user role.
UserCreationTrait::setCurrentUser protected function Switch the current logged in user.
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user.
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. 8
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. 5
ViewsKernelTestBase::setUp protected function Overrides KernelTestBase::setUp 66
ViewsKernelTestBase::viewsData protected function Returns the views data definition. 21

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