Newer
Older
Daniel Wehner
committed
<?php
/**
* @file
Dries Buytaert
committed
* Contains \Drupal\views\Tests\ViewExecutableTest.
Daniel Wehner
committed
*/
namespace Drupal\views\Tests;
Dries Buytaert
committed
use Drupal\views\Views;
use Drupal\views\ViewExecutable;
use Drupal\views\ViewExecutableFactory;
use Drupal\views\DisplayBag;
use Drupal\views\Plugin\views\display\DefaultDisplay;
use Drupal\views\Plugin\views\display\Page;
use Drupal\views\Plugin\views\style\DefaultStyle;
Angie Byron
committed
use Drupal\views\Plugin\views\style\Grid;
use Drupal\views\Plugin\views\row\Fields;
use Drupal\views\Plugin\views\query\Sql;
catch
committed
use Drupal\views\Plugin\views\pager\PagerPluginBase;
use Drupal\views\Plugin\views\query\QueryPluginBase;
use Drupal\views_test_data\Plugin\views\display\DisplayTest;
use Symfony\Component\HttpFoundation\Response;
Daniel Wehner
committed
/**
* Tests the ViewExecutable class.
*
Alex Pott
committed
* @see \Drupal\views\ViewExecutable
Daniel Wehner
committed
*/
class ViewExecutableTest extends ViewUnitTestBase {
Daniel Wehner
committed
public static $modules = array('system', 'node', 'comment', 'user', 'filter', 'entity', 'field', 'field_sql_storage', 'text');
catch
committed
/**
* Views used by this test.
*
* @var array
*/
public static $testViews = array('test_destroy', 'test_executable_displays');
Daniel Wehner
committed
/**
* Properties that should be stored in the configuration.
*
* @var array
*/
protected $configProperties = array(
'disabled',
'name',
'description',
'tag',
'base_table',
Angie Byron
committed
'label',
Daniel Wehner
committed
'core',
'display',
);
/**
* Properties that should be stored in the executable.
*
* @var array
*/
protected $executableProperties = array(
'storage',
'built',
'executed',
'args',
'build_info',
'result',
'attachment_before',
'attachment_after',
'exposed_data',
'exposed_input',
'exposed_raw_input',
'old_view',
'parent_views',
Daniel Wehner
committed
);
public static function getInfo() {
return array(
'name' => 'View executable tests',
'description' => 'Tests the ViewExecutable class.',
'group' => 'Views'
);
}
protected function setUpFixtures() {
$this->installSchema('user', array('users'));
$this->installSchema('node', array('node', 'node_field_data'));
$this->installSchema('comment', array('comment', 'comment_entity_statistics'));
$this->installConfig(array('field'));
$this->container->get('comment.manager')->addDefaultField('node', 'page');
parent::setUpFixtures();
$this->installConfig(array('filter'));
}
/**
* Tests the views.exectuable container service.
*/
public function testFactoryService() {
$factory = $this->container->get('views.executable');
$this->assertTrue($factory instanceof ViewExecutableFactory, 'A ViewExecutableFactory instance was returned from the container.');
$view = entity_load('view', 'test_executable_displays');
$this->assertTrue($factory->get($view) instanceof ViewExecutable, 'A ViewExecutable instance was returned from the factory.');
}
Tim Plunkett
committed
/**
* Tests the initDisplay() and initHandlers() methods.
*/
public function testInitMethods() {
catch
committed
$view = views_get_view('test_destroy');
Tim Plunkett
committed
$view->initDisplay();
$this->assertTrue($view->display_handler instanceof DefaultDisplay, 'Make sure a reference to the current display handler is set.');
$this->assertTrue($view->displayHandlers->get('default') instanceof DefaultDisplay, 'Make sure a display handler is created for each display.');
Tim Plunkett
committed
$view->destroy();
$view->initHandlers();
// Check for all handler types.
$handler_types = array_keys(ViewExecutable::viewsHandlerTypes());
foreach ($handler_types as $type) {
// The views_test integration doesn't have relationships.
if ($type == 'relationship') {
continue;
}
$this->assertTrue(count($view->$type), format_string('Make sure a %type instance got instantiated.', array('%type' => $type)));
}
// initHandlers() should create display handlers automatically as well.
$this->assertTrue($view->display_handler instanceof DefaultDisplay, 'Make sure a reference to the current display handler is set.');
$this->assertTrue($view->displayHandlers->get('default') instanceof DefaultDisplay, 'Make sure a display handler is created for each display.');
$view_hash = spl_object_hash($view);
$display_hash = spl_object_hash($view->display_handler);
// Test the initStyle() method.
$view->initStyle();
$this->assertTrue($view->style_plugin instanceof DefaultStyle, 'Make sure a reference to the style plugin is set.');
// Test the plugin has been inited and view have references to the view and
// display handler.
$this->assertEqual(spl_object_hash($view->style_plugin->view), $view_hash);
$this->assertEqual(spl_object_hash($view->style_plugin->displayHandler), $display_hash);
// Test the initQuery method().
$view->initQuery();
$this->assertTrue($view->query instanceof Sql, 'Make sure a reference to the query is set');
$this->assertEqual(spl_object_hash($view->query->view), $view_hash);
$this->assertEqual(spl_object_hash($view->query->displayHandler), $display_hash);
catch
committed
$view->destroy();
// Test the plugin get methods.
$display_plugin = $view->getDisplay();
$this->assertTrue($display_plugin instanceof DefaultDisplay, 'An instance of DefaultDisplay was returned.');
$this->assertTrue($view->display_handler instanceof DefaultDisplay, 'The display_handler property has been set.');
$this->assertIdentical($display_plugin, $view->getDisplay(), 'The same display plugin instance was returned.');
$style_plugin = $view->getStyle();
$this->assertTrue($style_plugin instanceof DefaultStyle, 'An instance of DefaultStyle was returned.');
$this->assertTrue($view->style_plugin instanceof DefaultStyle, 'The style_plugin property has been set.');
$this->assertIdentical($style_plugin, $view->getStyle(), 'The same style plugin instance was returned.');
$pager_plugin = $view->getPager();
$this->assertTrue($pager_plugin instanceof PagerPluginBase, 'An instance of PagerPluginBase was returned.');
$this->assertTrue($view->pager instanceof PagerPluginBase, 'The pager property has been set.');
$this->assertIdentical($pager_plugin, $view->getPager(), 'The same pager plugin instance was returned.');
$query_plugin = $view->getQuery();
$this->assertTrue($query_plugin instanceof QueryPluginBase, 'An instance of QueryPluginBase was returned.');
$this->assertTrue($view->query instanceof QueryPluginBase, 'The query property has been set.');
$this->assertIdentical($query_plugin, $view->getQuery(), 'The same query plugin instance was returned.');
Tim Plunkett
committed
}
Daniel Wehner
committed
/**
* Tests the generation of the executable object.
*/
public function testConstructing() {
catch
committed
views_get_view('test_destroy');
Daniel Wehner
committed
}
/**
* Tests the accessing of values on the object.
*/
public function testProperties() {
catch
committed
$view = views_get_view('test_destroy');
Daniel Wehner
committed
foreach ($this->executableProperties as $property) {
$this->assertTrue(isset($view->{$property}));
}
}
Daniel Wehner
committed
/**
* Tests the display related methods and properties.
*/
public function testDisplays() {
$view = views_get_view('test_executable_displays');
// Tests Drupal\views\ViewExecutable::initDisplay().
$view->initDisplay();
$this->assertTrue($view->displayHandlers instanceof DisplayBag, 'The displayHandlers property has the right class.');
Daniel Wehner
committed
// Tests the classes of the instances.
$this->assertTrue($view->displayHandlers->get('default') instanceof DefaultDisplay);
$this->assertTrue($view->displayHandlers->get('page_1') instanceof Page);
$this->assertTrue($view->displayHandlers->get('page_2') instanceof Page);
Daniel Wehner
committed
// After initializing the default display is the current used display.
$this->assertEqual($view->current_display, 'default');
$this->assertEqual(spl_object_hash($view->display_handler), spl_object_hash($view->displayHandlers->get('default')));
Daniel Wehner
committed
// All handlers should have a reference to the default display.
$this->assertEqual(spl_object_hash($view->displayHandlers->get('page_1')->default_display), spl_object_hash($view->displayHandlers->get('default')));
$this->assertEqual(spl_object_hash($view->displayHandlers->get('page_2')->default_display), spl_object_hash($view->displayHandlers->get('default')));
Daniel Wehner
committed
// Tests Drupal\views\ViewExecutable::setDisplay().
$view->setDisplay();
$this->assertEqual($view->current_display, 'default', 'If setDisplay is called with no parameter the default display should be used.');
$this->assertEqual(spl_object_hash($view->display_handler), spl_object_hash($view->displayHandlers->get('default')));
Daniel Wehner
committed
// Set two different valid displays.
$view->setDisplay('page_1');
$this->assertEqual($view->current_display, 'page_1', 'If setDisplay is called with a valid display id the appropriate display should be used.');
$this->assertEqual(spl_object_hash($view->display_handler), spl_object_hash($view->displayHandlers->get('page_1')));
Daniel Wehner
committed
$view->setDisplay('page_2');
$this->assertEqual($view->current_display, 'page_2', 'If setDisplay is called with a valid display id the appropriate display should be used.');
$this->assertEqual(spl_object_hash($view->display_handler), spl_object_hash($view->displayHandlers->get('page_2')));
Dries Buytaert
committed
// Destroy the view, so we can start again and test an invalid display.
$view->destroy();
$count_before = count($this->assertions);
$view->setDisplay('invalid');
Dries Buytaert
committed
$count_after = count($this->assertions);
$this->assertTrue($count_after - $count_before, 'Error is triggered while calling the wrong display.');
$this->assertEqual($view->current_display, 'default', 'If setDisplay is called with an invalid display id the default display should be used.');
$this->assertEqual(spl_object_hash($view->display_handler), spl_object_hash($view->displayHandlers->get('default')));
Angie Byron
committed
// Test the style and row plugins are replaced correctly when setting the
// display.
$view->setDisplay('page_1');
$view->initStyle();
$this->assertTrue($view->style_plugin instanceof DefaultStyle);
$this->assertTrue($view->rowPlugin instanceof Fields);
$view->setDisplay('page_2');
$view->initStyle();
$this->assertTrue($view->style_plugin instanceof Grid);
// @todo Change this rowPlugin type too.
$this->assertTrue($view->rowPlugin instanceof Fields);
// Test the newDisplay() method.
$view = $this->container->get('entity.manager')->getStorageController('view')->create(array('id' => 'test_executable_displays'));
$executable = $view->getExecutable();
$executable->newDisplay('page');
$executable->newDisplay('page');
$executable->newDisplay('display_test');
$this->assertTrue($executable->displayHandlers->get('default') instanceof DefaultDisplay);
$this->assertFalse(isset($executable->displayHandlers->get('default')->default_display));
$this->assertTrue($executable->displayHandlers->get('page_1') instanceof Page);
$this->assertTrue($executable->displayHandlers->get('page_1')->default_display instanceof DefaultDisplay);
$this->assertTrue($executable->displayHandlers->get('page_2') instanceof Page);
$this->assertTrue($executable->displayHandlers->get('page_2')->default_display instanceof DefaultDisplay);
$this->assertTrue($executable->displayHandlers->get('display_test_1') instanceof DisplayTest);
$this->assertTrue($executable->displayHandlers->get('display_test_1')->default_display instanceof DefaultDisplay);
Daniel Wehner
committed
}
/**
* Tests the setting/getting of properties.
public function testPropertyMethods() {
$view = views_get_view('test_executable_displays');
// Test the setAjaxEnabled() method.
$this->assertFalse($view->ajaxEnabled());
$view->setAjaxEnabled(TRUE);
$this->assertTrue($view->ajaxEnabled());
$view->setDisplay();
// There should be no pager set initially.
$this->assertNull($view->usePager());
// Add a pager, initialize, and test.
$view->displayHandlers->get('default')->overrideOption('pager', array(
'type' => 'full',
'options' => array('items_per_page' => 10),
));
$view->initPager();
$this->assertTrue($view->usePager());
// Test setting and getting the offset.
$rand = rand();
$view->setOffset($rand);
$this->assertEqual($view->getOffset(), $rand);
// Test the getBaseTable() method.
$expected = array(
'views_test_data' => TRUE,
'#global' => TRUE,
);
$this->assertIdentical($view->getBaseTables(), $expected);
// Test response methods.
$this->assertTrue($view->getResponse() instanceof Response, 'New response object returned.');
$new_response = new Response();
$view->setResponse($new_response);
$this->assertIdentical(spl_object_hash($view->getResponse()), spl_object_hash($new_response), 'New response object correctly set.');
Angie Byron
committed
// Test the generateHandlerId() method.
$test_ids = drupal_map_assoc(array('test', 'test_1'));
Angie Byron
committed
$this->assertEqual($view->generateHandlerId('new', $test_ids), 'new');
$this->assertEqual($view->generateHandlerId('test', $test_ids), 'test_2');
// Test the getPath() method.
$path = $this->randomName();
$view->displayHandlers->get('page_1')->overrideOption('path', $path);
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
$view->setDisplay('page_1');
$this->assertEqual($view->getPath(), $path);
// Test the override_path property override.
$override_path = $this->randomName();
$view->override_path = $override_path;
$this->assertEqual($view->getPath(), $override_path);
// Test the getUrl method().
$url = $this->randomString();
$this->assertEqual($view->getUrl(NULL, $url), $url);
// Test with arguments.
$arg1 = $this->randomString();
$arg2 = rand();
$this->assertEqual($view->getUrl(array($arg1, $arg2), $url), "$url/$arg1/$arg2");
// Test the override_url property override.
$override_url = $this->randomString();
$view->override_url = $override_url;
$this->assertEqual($view->getUrl(NULL, $url), $override_url);
// Test the title methods.
$title = $this->randomString();
$view->setTitle($title);
$this->assertEqual($view->getTitle(), $title);
}
/**
* Tests the deconstructor to be sure that necessary objects are removed.
*/
public function testDestroy() {
catch
committed
$view = views_get_view('test_destroy');
$view->preview();
$view->destroy();
$this->assertViewDestroy($view);
}
/**
* Asserts that expected view properties have been unset by destroy().
*
* @param \Drupal\views\ViewExecutable $view
*/
protected function assertViewDestroy($view) {
Alex Pott
committed
$reflection = new \ReflectionClass($view);
$defaults = $reflection->getDefaultProperties();
Angie Byron
committed
// The storage and user should remain.
Alex Pott
committed
unset($defaults['storage']);
Angie Byron
committed
unset($defaults['user']);
Alex Pott
committed
foreach ($defaults as $property => $default) {
$this->assertIdentical($this->getProtectedProperty($view, $property), $default);
Alex Pott
committed
}
/**
* Returns a protected property from a class instance.
*
* @param object $instance
* The class instance to return the property from.
* @param string $property
* The name of the property to return.
*
* @return mixed
* The instance property value.
*/
protected function getProtectedProperty($instance, $property) {
$reflection = new \ReflectionProperty($instance, $property);
$reflection->setAccessible(TRUE);
return $reflection->getValue($instance);
}
/**
* Tests ViewExecutable::viewsHandlerTypes().
*/
public function testViewsHandlerTypes() {
$types = ViewExecutable::viewsHandlerTypes();
foreach (array('field', 'filter', 'argument', 'sort', 'header', 'footer', 'empty') as $type) {
$this->assertTrue(isset($types[$type]));
// @todo The key on the display should be footers, headers and empties
// or something similar instead of the singular, but so long check for
// this special case.
if (isset($types[$type]['type']) && $types[$type]['type'] == 'area') {
$this->assertEqual($types[$type]['plural'], $type);
}
else {
$this->assertEqual($types[$type]['plural'], $type . 's');
}
}
}
/**
* Tests the validation of display handlers.
*/
public function testValidate() {
$view = views_get_view('test_executable_displays');
catch
committed
$view->setDisplay('page_1');
$validate = $view->validate();
// Validating a view shouldn't change the active display.
catch
committed
$this->assertEqual('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->assertTrue(array_filter($validate[$id], $match), format_string('Error message found for @id display', array('@id' => $id)));
$count++;
}
$this->assertEqual(count($view->displayHandlers), $count, 'Error messages from all handlers merged.');
// Test that a deleted display is not included.
$display = &$view->storage->getDisplay('default');
$display['deleted'] = TRUE;
$validate_deleted = $view->validate();
$this->assertNotIdentical($validate, $validate_deleted, 'Master display has not been validated.');
}