class RowEntityRenderersTest

Same name and namespace in other branches
  1. 9 core/modules/views/tests/src/Kernel/Entity/RowEntityRenderersTest.php \Drupal\Tests\views\Kernel\Entity\RowEntityRenderersTest
  2. 10 core/modules/views/tests/src/Kernel/Entity/RowEntityRenderersTest.php \Drupal\Tests\views\Kernel\Entity\RowEntityRenderersTest
  3. 11.x core/modules/views/tests/src/Kernel/Entity/RowEntityRenderersTest.php \Drupal\Tests\views\Kernel\Entity\RowEntityRenderersTest

Tests the entity row renderers.

@group views

Hierarchy

Expanded class hierarchy of RowEntityRenderersTest

See also

\Drupal\views\Entity\Render\RendererBase

File

core/modules/views/tests/src/Kernel/Entity/RowEntityRenderersTest.php, line 17

Namespace

Drupal\Tests\views\Kernel\Entity
View source
class RowEntityRenderersTest extends ViewsKernelTestBase {
    
    /**
     * Modules to enable.
     *
     * @var array
     */
    public static $modules = [
        'field',
        'filter',
        'text',
        'node',
        'user',
        'language',
        'views_test_language',
    ];
    
    /**
     * Views used by this test.
     *
     * @var array
     */
    public static $testViews = [
        'test_entity_row_renderers',
        'test_entity_row_renderers_revisions_base',
    ];
    
    /**
     * An array of added languages.
     *
     * @var array
     */
    protected $langcodes;
    
    /**
     * An array of titles for each node per language.
     *
     * @var array
     */
    protected $expected;
    
    /**
     * The author of the test content.
     *
     * @var \Drupal\user\UserInterface
     */
    protected $testAuthor;
    
    /**
     * An array of IDs of the test content.
     *
     * @var array[]
     */
    protected $testIds;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp($import_test_views = TRUE) {
        parent::setUp();
        $this->installEntitySchema('node');
        $this->installEntitySchema('user');
        $this->installSchema('node', [
            'node_access',
        ]);
        $this->installConfig([
            'node',
            'language',
        ]);
        // The entity.node.canonical route must exist when nodes are rendered.
        $this->container
            ->get('router.builder')
            ->rebuild();
        $this->langcodes = [
            \Drupal::languageManager()->getDefaultLanguage()
                ->getId(),
        ];
        for ($i = 0; $i < 2; $i++) {
            $langcode = 'l' . $i;
            $this->langcodes[] = $langcode;
            ConfigurableLanguage::createFromLangcode($langcode)->save();
        }
        $this->testAuthor = User::create([
            'name' => 'foo',
        ]);
        $this->testAuthor
            ->save();
        // Make sure we do not try to render non-existing user data.
        $node_type = NodeType::create([
            'type' => 'test',
        ]);
        $node_type->setDisplaySubmitted(FALSE);
        $node_type->save();
        $this->values = [];
        $this->ids = [];
        $controller = \Drupal::entityTypeManager()->getStorage('node');
        $langcode_index = 0;
        for ($i = 0; $i < count($this->langcodes); $i++) {
            // Create a node with a different default language each time.
            $default_langcode = $this->langcodes[$langcode_index++];
            $node = $controller->create([
                'type' => 'test',
                'uid' => $this->testAuthor
                    ->id(),
                'langcode' => $default_langcode,
            ]);
            // Ensure the default language is processed first.
            $langcodes = array_merge([
                $default_langcode,
            ], array_diff($this->langcodes, [
                $default_langcode,
            ]));
            foreach ($langcodes as $langcode) {
                // Ensure we have a predictable result order.
                $this->values[$i][$langcode] = $i . '-' . $langcode . '-' . $this->randomMachineName();
                if ($langcode != $default_langcode) {
                    $node->addTranslation($langcode, [
                        'title' => $this->values[$i][$langcode],
                    ]);
                }
                else {
                    $node->setTitle($this->values[$i][$langcode]);
                }
                $node->save();
                $this->ids[] = [
                    'nid' => $node->id(),
                    'uid' => $this->testAuthor
                        ->id(),
                ];
            }
        }
    }
    
    /**
     * Tests the entity row renderers.
     */
    public function testEntityRenderers() {
        $this->checkLanguageRenderers('page_1', $this->values);
    }
    
    /**
     * Tests the field row renderers.
     */
    public function testFieldRenderers() {
        $this->checkLanguageRenderers('page_2', $this->values);
    }
    
    /**
     * Tests the row renderer with a revision base table.
     */
    public function testRevisionBaseTable() {
        $view = Views::getView('test_entity_row_renderers_revisions_base');
        $view->execute();
        $this->assertIdenticalResultset($view, $this->ids, [
            'nid' => 'nid',
            'uid' => 'uid',
        ]);
    }
    
    /**
     * Checks that the language renderer configurations work as expected.
     *
     * @param string $display
     *   Name of display to test with.
     * @param array $values
     *   An array of node information which are each an array of node titles
     *   associated with language keys appropriate for the translation of that
     *   node.
     */
    protected function checkLanguageRenderers($display, $values) {
        $expected = [
            $values[0]['en'],
            $values[0]['en'],
            $values[0]['en'],
            $values[1]['en'],
            $values[1]['en'],
            $values[1]['en'],
            $values[2]['en'],
            $values[2]['en'],
            $values[2]['en'],
        ];
        $this->assertTranslations($display, '***LANGUAGE_language_content***', $expected, 'The current language renderer behaves as expected.');
        $expected = [
            $values[0]['en'],
            $values[0]['en'],
            $values[0]['en'],
            $values[1]['l0'],
            $values[1]['l0'],
            $values[1]['l0'],
            $values[2]['l1'],
            $values[2]['l1'],
            $values[2]['l1'],
        ];
        $this->assertTranslations($display, '***LANGUAGE_entity_default***', $expected, 'The default language renderer behaves as expected.');
        $expected = [
            $values[0]['en'],
            $values[0]['l0'],
            $values[0]['l1'],
            $values[1]['en'],
            $values[1]['l0'],
            $values[1]['l1'],
            $values[2]['en'],
            $values[2]['l0'],
            $values[2]['l1'],
        ];
        $this->assertTranslations($display, '***LANGUAGE_entity_translation***', $expected, 'The translation language renderer behaves as expected.');
        $expected = [
            $values[0][$this->langcodes[0]],
            $values[0][$this->langcodes[0]],
            $values[0][$this->langcodes[0]],
            $values[1][$this->langcodes[0]],
            $values[1][$this->langcodes[0]],
            $values[1][$this->langcodes[0]],
            $values[2][$this->langcodes[0]],
            $values[2][$this->langcodes[0]],
            $values[2][$this->langcodes[0]],
        ];
        $this->assertTranslations($display, '***LANGUAGE_site_default***', $expected, 'The site default language renderer behaves as expected.');
        $expected = [
            $values[0]['l0'],
            $values[0]['l0'],
            $values[0]['l0'],
            $values[1]['l0'],
            $values[1]['l0'],
            $values[1]['l0'],
            $values[2]['l0'],
            $values[2]['l0'],
            $values[2]['l0'],
        ];
        $this->assertTranslations($display, 'l0', $expected, 'The language specific renderer behaves as expected.');
    }
    
    /**
     * Checks that the view results match the expected values.
     *
     * @param string $display
     *   Name of display to test with.
     * @param string $renderer_id
     *   The id of the renderer to be tested.
     * @param array $expected
     *   An array of expected title translation values, one for each result row.
     * @param string $message
     *   (optional) A message to display with the assertion.
     * @param string $group
     *   (optional) The group this message is in.
     *
     * @return bool
     *   TRUE if the assertion succeeded, FALSE otherwise.
     */
    protected function assertTranslations($display, $renderer_id, array $expected, $message = '', $group = 'Other') {
        $view = Views::getView('test_entity_row_renderers');
        $view->storage
            ->invalidateCaches();
        $view->setDisplay($display);
        $view->getDisplay()
            ->setOption('rendering_language', $renderer_id);
        $view->preview();
        $result = FALSE;
        foreach ($expected as $index => $expected_output) {
            if (!empty($view->result[$index])) {
                $build = $view->rowPlugin
                    ->render($view->result[$index]);
                $output = \Drupal::service('renderer')->renderRoot($build);
                $result = strpos($output, $expected_output) !== FALSE;
                if (!$result) {
                    break;
                }
            }
            else {
                $result = FALSE;
                break;
            }
        }
        return $this->assertTrue($result, $message, $group);
    }

}

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 the raw text IS NOT found escaped on the 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.
AssertHelperTrait::castSafeStrings protected static function Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert protected function
AssertLegacyTrait::assertEqual protected function
AssertLegacyTrait::assertIdentical protected function
AssertLegacyTrait::assertIdenticalObject protected function
AssertLegacyTrait::assertNotEqual protected function
AssertLegacyTrait::assertNotIdentical protected function
AssertLegacyTrait::pass protected function
AssertLegacyTrait::verbose 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.
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. 7
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::$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. 6
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. 1
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::isTestInIsolation Deprecated protected function Returns whether the current test method is running in a separate process.
KernelTestBase::prepareTemplate protected function
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. 2
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::__get Deprecated public function BC: Automatically resolve former KernelTestBase class properties.
KernelTestBase::__sleep public function Prevents serializing any properties.
PhpunitCompatibilityTrait::getMock Deprecated public function Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated public function Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
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.
RowEntityRenderersTest::$expected protected property An array of titles for each node per language.
RowEntityRenderersTest::$langcodes protected property An array of added languages.
RowEntityRenderersTest::$modules public static property Modules to enable. Overrides ViewsKernelTestBase::$modules
RowEntityRenderersTest::$testAuthor protected property The author of the test content.
RowEntityRenderersTest::$testIds protected property An array of IDs of the test content.
RowEntityRenderersTest::$testViews public static property Views used by this test. Overrides ViewsKernelTestBase::$testViews
RowEntityRenderersTest::assertTranslations protected function Checks that the view results match the expected values.
RowEntityRenderersTest::checkLanguageRenderers protected function Checks that the language renderer configurations work as expected.
RowEntityRenderersTest::setUp protected function Overrides ViewsKernelTestBase::setUp
RowEntityRenderersTest::testEntityRenderers public function Tests the entity row renderers.
RowEntityRenderersTest::testFieldRenderers public function Tests the field row renderers.
RowEntityRenderersTest::testRevisionBaseTable public function Tests the row renderer with a revision base table.
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. 1
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.
ViewResultAssertionTrait::assertIdenticalResultset protected function Verifies that a result set returned by a View matches expected values.
ViewResultAssertionTrait::assertIdenticalResultsetHelper protected function Performs View result assertions.
ViewResultAssertionTrait::assertNotIdenticalResultset protected function Verifies that a result set returned by a View differs from certain values.
ViewsKernelTestBase::dataSet protected function Returns a very simple test dataset. 8
ViewsKernelTestBase::executeView protected function Executes a view with debugging.
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::setUpFixtures protected function Sets up the configuration and schema of views and views_test_data modules. 6
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.