View source
<?php
namespace Drupal\Tests\views\Kernel;
use Drupal\Component\Render\FormattableMarkup;
use Drupal\comment\Tests\CommentTestTrait;
use Drupal\Component\Utility\Xss;
use Drupal\node\Entity\NodeType;
use Drupal\views\Entity\View;
use Drupal\views\Views;
use Drupal\views\ViewExecutable;
use Drupal\views\ViewExecutableFactory;
use Drupal\views\DisplayPluginCollection;
use Drupal\views\Plugin\views\display\DefaultDisplay;
use Drupal\views\Plugin\views\display\Page;
use Drupal\views\Plugin\views\style\DefaultStyle;
use Drupal\views\Plugin\views\style\Grid;
use Drupal\views\Plugin\views\row\Fields;
use Drupal\views\Plugin\views\query\Sql;
use Drupal\views\Plugin\views\pager\PagerPluginBase;
use Drupal\views\Plugin\views\query\QueryPluginBase;
use Drupal\views_test_data\Plugin\views\display\DisplayTest;
use PHPUnit\Framework\Error\Warning;
use Symfony\Component\HttpFoundation\Response;
class ViewExecutableTest extends ViewsKernelTestBase {
use CommentTestTrait;
protected static $modules = [
'system',
'node',
'comment',
'user',
'filter',
'field',
'text',
];
public static $testViews = [
'test_destroy',
'test_executable_displays',
'test_argument_dependency',
];
protected $configProperties = [
'disabled',
'name',
'description',
'tag',
'base_table',
'label',
'core',
'display',
];
protected $executableProperties = [
'storage',
'built',
'executed',
'args',
'build_info',
'result',
'attachment_before',
'attachment_after',
'exposed_data',
'exposed_raw_input',
'old_view',
'parent_views',
];
protected function setUpFixtures() {
$this
->installEntitySchema('user');
$this
->installEntitySchema('node');
$this
->installEntitySchema('comment');
$this
->installSchema('comment', [
'comment_entity_statistics',
]);
$this
->installConfig([
'system',
'field',
'node',
'comment',
]);
NodeType::create([
'type' => 'page',
'name' => 'Page',
])
->save();
$this
->addDefaultCommentField('node', 'page');
parent::setUpFixtures();
$this
->installConfig([
'filter',
]);
}
public function testFactoryService() {
$factory = $this->container
->get('views.executable');
$this
->assertInstanceOf(ViewExecutableFactory::class, $factory);
$view = View::load('test_executable_displays');
$this
->assertInstanceOf(ViewExecutable::class, $factory
->get($view));
}
public function testInitMethods() {
$view = Views::getView('test_destroy');
$view
->initDisplay();
$this
->assertInstanceOf(DefaultDisplay::class, $view->display_handler);
$this
->assertInstanceOf(DefaultDisplay::class, $view->displayHandlers
->get('default'));
$view
->destroy();
$view
->initHandlers();
$handler_types = array_keys(ViewExecutable::getHandlerTypes());
foreach ($handler_types as $type) {
if ($type == 'relationship') {
continue;
}
$this
->assertGreaterThan(0, count($view->{$type}), new FormattableMarkup('Make sure a %type instance got instantiated.', [
'%type' => $type,
]));
}
$this
->assertInstanceOf(DefaultDisplay::class, $view->display_handler);
$this
->assertInstanceOf(DefaultDisplay::class, $view->displayHandlers
->get('default'));
$view_hash = spl_object_hash($view);
$display_hash = spl_object_hash($view->display_handler);
$view
->initStyle();
$this
->assertInstanceOf(DefaultStyle::class, $view->style_plugin);
$this
->assertEquals($view_hash, spl_object_hash($view->style_plugin->view));
$this
->assertEquals($display_hash, spl_object_hash($view->style_plugin->displayHandler));
$view
->initQuery();
$this
->assertInstanceOf(Sql::class, $view->query);
$this
->assertEquals($view_hash, spl_object_hash($view->query->view));
$this
->assertEquals($display_hash, spl_object_hash($view->query->displayHandler));
$view
->destroy();
$display_plugin = $view
->getDisplay();
$this
->assertInstanceOf(DefaultDisplay::class, $display_plugin);
$this
->assertInstanceOf(DefaultDisplay::class, $view->display_handler);
$this
->assertSame($display_plugin, $view
->getDisplay(), 'The same display plugin instance was returned.');
$style_plugin = $view
->getStyle();
$this
->assertInstanceOf(DefaultStyle::class, $style_plugin);
$this
->assertInstanceOf(DefaultStyle::class, $view->style_plugin);
$this
->assertSame($style_plugin, $view
->getStyle(), 'The same style plugin instance was returned.');
$pager_plugin = $view
->getPager();
$this
->assertInstanceOf(PagerPluginBase::class, $pager_plugin);
$this
->assertInstanceOf(PagerPluginBase::class, $view->pager);
$this
->assertSame($pager_plugin, $view
->getPager(), 'The same pager plugin instance was returned.');
$query_plugin = $view
->getQuery();
$this
->assertInstanceOf(QueryPluginBase::class, $query_plugin);
$this
->assertInstanceOf(QueryPluginBase::class, $view->query);
$this
->assertSame($query_plugin, $view
->getQuery(), 'The same query plugin instance was returned.');
}
public function testConstructing() {
Views::getView('test_destroy');
}
public function testProperties() {
$view = Views::getView('test_destroy');
foreach ($this->executableProperties as $property) {
$this
->assertTrue(isset($view->{$property}));
}
$this
->assertEquals([], $view
->getExposedInput());
}
public function testSetDisplayWithInvalidDisplay() {
$view = Views::getView('test_executable_displays');
$view
->initDisplay();
try {
$view
->setDisplay('invalid');
$this
->fail('Expected error, when setDisplay() called with invalid display ID');
} catch (Warning $e) {
$this
->assertEquals('setDisplay() called with invalid display ID "invalid".', $e
->getMessage());
}
$this
->assertEquals('default', $view->current_display, 'If setDisplay is called with an invalid display id the default display should be used.');
$this
->assertEquals(spl_object_hash($view->displayHandlers
->get('default')), spl_object_hash($view->display_handler));
}
public function testDisplays() {
$view = Views::getView('test_executable_displays');
$view
->initDisplay();
$this
->assertInstanceOf(DisplayPluginCollection::class, $view->displayHandlers);
$this
->assertInstanceOf(DefaultDisplay::class, $view->displayHandlers
->get('default'));
$this
->assertInstanceOf(Page::class, $view->displayHandlers
->get('page_1'));
$this
->assertInstanceOf(Page::class, $view->displayHandlers
->get('page_2'));
$this
->assertEquals('default', $view->current_display);
$this
->assertEquals(spl_object_hash($view->displayHandlers
->get('default')), spl_object_hash($view->display_handler));
$this
->assertEquals(spl_object_hash($view->displayHandlers
->get('default')), spl_object_hash($view->displayHandlers
->get('page_1')->default_display));
$this
->assertEquals(spl_object_hash($view->displayHandlers
->get('default')), spl_object_hash($view->displayHandlers
->get('page_2')->default_display));
$view
->setDisplay();
$this
->assertEquals('default', $view->current_display, 'If setDisplay is called with no parameter the default display should be used.');
$this
->assertEquals(spl_object_hash($view->displayHandlers
->get('default')), spl_object_hash($view->display_handler));
$view
->setDisplay('page_1');
$this
->assertEquals('page_1', $view->current_display, 'If setDisplay is called with a valid display id the appropriate display should be used.');
$this
->assertEquals(spl_object_hash($view->displayHandlers
->get('page_1')), spl_object_hash($view->display_handler));
$view
->setDisplay('page_2');
$this
->assertEquals('page_2', $view->current_display, 'If setDisplay is called with a valid display id the appropriate display should be used.');
$this
->assertEquals(spl_object_hash($view->displayHandlers
->get('page_2')), spl_object_hash($view->display_handler));
$view
->destroy();
$view
->setDisplay('page_1');
$view
->initStyle();
$this
->assertInstanceOf(DefaultStyle::class, $view->style_plugin);
$this
->assertInstanceOf(Fields::class, $view->rowPlugin);
$view
->setDisplay('page_2');
$view
->initStyle();
$this
->assertInstanceOf(Grid::class, $view->style_plugin);
$this
->assertInstanceOf(Fields::class, $view->rowPlugin);
$view = $this->container
->get('entity_type.manager')
->getStorage('view')
->create([
'id' => 'test_executable_displays',
]);
$executable = $view
->getExecutable();
$executable
->newDisplay('page');
$executable
->newDisplay('page');
$executable
->newDisplay('display_test');
$this
->assertInstanceOf(DefaultDisplay::class, $executable->displayHandlers
->get('default'));
$this
->assertFalse(isset($executable->displayHandlers
->get('default')->default_display));
$this
->assertInstanceOf(Page::class, $executable->displayHandlers
->get('page_1'));
$this
->assertInstanceOf(DefaultDisplay::class, $executable->displayHandlers
->get('page_1')->default_display);
$this
->assertInstanceOf(Page::class, $executable->displayHandlers
->get('page_2'));
$this
->assertInstanceOf(DefaultDisplay::class, $executable->displayHandlers
->get('page_2')->default_display);
$this
->assertInstanceOf(DisplayTest::class, $executable->displayHandlers
->get('display_test_1'));
$this
->assertInstanceOf(DefaultDisplay::class, $executable->displayHandlers
->get('display_test_1')->default_display);
}
public function testPropertyMethods() {
$view = Views::getView('test_executable_displays');
$this
->assertFalse($view
->ajaxEnabled());
$view
->setAjaxEnabled(TRUE);
$this
->assertTrue($view
->ajaxEnabled());
$view
->setDisplay();
$this
->assertNull($view
->usePager());
$view->displayHandlers
->get('default')
->overrideOption('pager', [
'type' => 'full',
'options' => [
'items_per_page' => 10,
],
]);
$view
->initPager();
$this
->assertTrue($view
->usePager());
$rand = rand();
$view
->setOffset($rand);
$this
->assertEquals($rand, $view
->getOffset());
$expected = [
'views_test_data' => TRUE,
'#global' => TRUE,
];
$this
->assertSame($expected, $view
->getBaseTables());
$this
->assertInstanceOf(Response::class, $view
->getResponse());
$new_response = new Response();
$view
->setResponse($new_response);
$this
->assertSame(spl_object_hash($view
->getResponse()), spl_object_hash($new_response), 'New response object correctly set.');
$path = $this
->randomMachineName();
$view->displayHandlers
->get('page_1')
->overrideOption('path', $path);
$view
->setDisplay('page_1');
$this
->assertEquals($path, $view
->getPath());
$override_path = $this
->randomMachineName();
$view->override_path = $override_path;
$this
->assertEquals($override_path, $view
->getPath());
$title = $this
->randomString();
$view
->setTitle($title);
$this
->assertEquals(Xss::filterAdmin($title), $view
->getTitle());
}
public function testDestroy() {
$view = Views::getView('test_destroy');
$view
->preview();
$view
->destroy();
$this
->assertViewDestroy($view);
}
protected function assertViewDestroy(ViewExecutable $view) : void {
$reflection = new \ReflectionClass($view);
$defaults = $reflection
->getDefaultProperties();
unset($defaults['storage'], $defaults['user'], $defaults['request'], $defaults['routeProvider'], $defaults['viewsData']);
foreach ($defaults as $property => $default) {
$this
->assertSame($this
->getProtectedProperty($view, $property), $default);
}
}
protected function getProtectedProperty($instance, $property) {
$reflection = new \ReflectionProperty($instance, $property);
$reflection
->setAccessible(TRUE);
return $reflection
->getValue($instance);
}
public function testGetHandlerTypes() {
$types = ViewExecutable::getHandlerTypes();
foreach ([
'field',
'filter',
'argument',
'sort',
'header',
'footer',
'empty',
] as $type) {
$this
->assertTrue(isset($types[$type]));
if (isset($types[$type]['type']) && $types[$type]['type'] == 'area') {
$this
->assertEquals($type, $types[$type]['plural']);
}
else {
$this
->assertEquals($type . 's', $types[$type]['plural']);
}
}
}
public function testGetHandlers() {
$view = Views::getView('test_executable_displays');
$view
->setDisplay('page_1');
$view
->getHandlers('field', 'page_2');
$this
->assertEquals('page_1', $view->current_display, "The display shouldn't change after getHandlers()");
}
public function testValidate() {
$view = Views::getView('test_executable_displays');
$view
->setDisplay('page_1');
$validate = $view
->validate();
$this
->assertEquals('page_1', $view->current_display, "The display should be constant while validating");
$count = 0;
foreach ($view->displayHandlers as $id => $display) {
$match = function ($value) use ($display) {
return strpos($value, $display->display['display_title']) !== FALSE;
};
$this
->assertNotEmpty(array_filter($validate[$id], $match), new FormattableMarkup('Error message found for @id display', [
'@id' => $id,
]));
$count++;
}
$this
->assertCount($count, $view->displayHandlers, 'Error messages from all handlers merged.');
$display =& $view->storage
->getDisplay('default');
$display['deleted'] = TRUE;
$validate_deleted = $view
->validate();
$this
->assertNotSame($validate, $validate_deleted);
}
public function testValidateNestedLoops() {
$view = View::create([
'id' => 'test_validate_nested_loops',
]);
$executable = $view
->getExecutable();
$executable
->newDisplay('display_test');
$executable
->newDisplay('display_test');
$errors = $executable
->validate();
$total_error_count = array_reduce($errors, function ($carry, $item) {
$carry += count($item);
return $carry;
});
$this
->assertSame(9, $total_error_count);
$this
->assertCount(3, $errors);
}
public function testSerialization() {
$view = Views::getView('test_executable_displays');
$view
->setDisplay('page_1');
$view
->setArguments([
'test',
]);
$view
->setCurrentPage(2);
$serialized = serialize($view);
$this
->assertStringNotContainsString('"Drupal\\views\\Entity\\View"', $serialized, 'The Drupal\\views\\Entity\\View class was not found in the serialized string.');
$unserialized = unserialize($serialized);
$this
->assertInstanceOf(ViewExecutable::class, $unserialized);
$this
->assertSame($unserialized->storage
->id(), $view->storage
->id(), 'The expected storage entity was loaded on the unserialized view.');
$this
->assertSame('page_1', $unserialized->current_display, 'The expected display was set on the unserialized view.');
$this
->assertSame([
'test',
], $unserialized->args, 'The expected argument was set on the unserialized view.');
$this
->assertSame(2, $unserialized
->getCurrentPage(), 'The expected current page was set on the unserialized view.');
$field_manager = $this->container
->get('entity_field.manager');
$nid_definition_before = $field_manager
->getBaseFieldDefinitions('node')['nid']
->getItemDefinition()
->getFieldDefinition();
$view_entity = View::load('content');
$view_executable = $view_entity
->getExecutable();
$view_executable
->execute('page_1');
$field_manager
->useCaches(FALSE);
$field_manager
->useCaches(TRUE);
unserialize(serialize([
'SOMETHING UNEXPECTED',
$view_executable,
]));
$nid_definition_after = $field_manager
->getBaseFieldDefinitions('node')['nid']
->getItemDefinition()
->getFieldDefinition();
$this
->assertEquals($nid_definition_before
->getPropertyDefinitions(), $nid_definition_after
->getPropertyDefinitions());
}
public function testArgumentValidatorValueOverride() {
$view = Views::getView('test_argument_dependency');
$view
->setDisplay('page_1');
$view
->setArguments([
'1',
'this value should be replaced',
]);
$view
->execute();
$expected = [
'{{ arguments.uid }}' => '1',
'{{ raw_arguments.uid }}' => '1',
];
$this
->assertEquals($expected, $view->build_info['substitutions']);
}
}