Chris@0: installEntitySchema('user'); Chris@0: $this->installEntitySchema('node'); Chris@0: $this->installEntitySchema('comment'); Chris@0: $this->installSchema('comment', ['comment_entity_statistics']); Chris@0: $this->installConfig(['system', 'field', 'node', 'comment']); Chris@0: Chris@0: NodeType::create([ Chris@0: 'type' => 'page', Chris@0: 'name' => 'Page', Chris@0: ])->save(); Chris@0: $this->addDefaultCommentField('node', 'page'); Chris@0: parent::setUpFixtures(); Chris@0: Chris@0: $this->installConfig(['filter']); Chris@0: } Chris@0: Chris@0: /** Chris@0: * Tests the views.executable container service. Chris@0: */ Chris@0: public function testFactoryService() { Chris@0: $factory = $this->container->get('views.executable'); Chris@0: $this->assertTrue($factory instanceof ViewExecutableFactory, 'A ViewExecutableFactory instance was returned from the container.'); Chris@0: $view = View::load('test_executable_displays'); Chris@0: $this->assertTrue($factory->get($view) instanceof ViewExecutable, 'A ViewExecutable instance was returned from the factory.'); Chris@0: } Chris@0: Chris@0: /** Chris@0: * Tests the initDisplay() and initHandlers() methods. Chris@0: */ Chris@0: public function testInitMethods() { Chris@0: $view = Views::getView('test_destroy'); Chris@0: $view->initDisplay(); Chris@0: Chris@0: $this->assertTrue($view->display_handler instanceof DefaultDisplay, 'Make sure a reference to the current display handler is set.'); Chris@0: $this->assertTrue($view->displayHandlers->get('default') instanceof DefaultDisplay, 'Make sure a display handler is created for each display.'); Chris@0: Chris@0: $view->destroy(); Chris@0: $view->initHandlers(); Chris@0: Chris@0: // Check for all handler types. Chris@0: $handler_types = array_keys(ViewExecutable::getHandlerTypes()); Chris@0: foreach ($handler_types as $type) { Chris@0: // The views_test integration doesn't have relationships. Chris@0: if ($type == 'relationship') { Chris@0: continue; Chris@0: } Chris@0: $this->assertTrue(count($view->$type), format_string('Make sure a %type instance got instantiated.', ['%type' => $type])); Chris@0: } Chris@0: Chris@0: // initHandlers() should create display handlers automatically as well. Chris@0: $this->assertTrue($view->display_handler instanceof DefaultDisplay, 'Make sure a reference to the current display handler is set.'); Chris@0: $this->assertTrue($view->displayHandlers->get('default') instanceof DefaultDisplay, 'Make sure a display handler is created for each display.'); Chris@0: Chris@0: $view_hash = spl_object_hash($view); Chris@0: $display_hash = spl_object_hash($view->display_handler); Chris@0: Chris@0: // Test the initStyle() method. Chris@0: $view->initStyle(); Chris@0: $this->assertTrue($view->style_plugin instanceof DefaultStyle, 'Make sure a reference to the style plugin is set.'); Chris@17: // Test the plugin has been invited and view have references to the view and Chris@0: // display handler. Chris@0: $this->assertEqual(spl_object_hash($view->style_plugin->view), $view_hash); Chris@0: $this->assertEqual(spl_object_hash($view->style_plugin->displayHandler), $display_hash); Chris@0: Chris@0: // Test the initQuery method(). Chris@0: $view->initQuery(); Chris@0: $this->assertTrue($view->query instanceof Sql, 'Make sure a reference to the query is set'); Chris@0: $this->assertEqual(spl_object_hash($view->query->view), $view_hash); Chris@0: $this->assertEqual(spl_object_hash($view->query->displayHandler), $display_hash); Chris@0: Chris@0: $view->destroy(); Chris@0: Chris@0: // Test the plugin get methods. Chris@0: $display_plugin = $view->getDisplay(); Chris@0: $this->assertTrue($display_plugin instanceof DefaultDisplay, 'An instance of DefaultDisplay was returned.'); Chris@0: $this->assertTrue($view->display_handler instanceof DefaultDisplay, 'The display_handler property has been set.'); Chris@0: $this->assertIdentical($display_plugin, $view->getDisplay(), 'The same display plugin instance was returned.'); Chris@0: Chris@0: $style_plugin = $view->getStyle(); Chris@0: $this->assertTrue($style_plugin instanceof DefaultStyle, 'An instance of DefaultStyle was returned.'); Chris@0: $this->assertTrue($view->style_plugin instanceof DefaultStyle, 'The style_plugin property has been set.'); Chris@0: $this->assertIdentical($style_plugin, $view->getStyle(), 'The same style plugin instance was returned.'); Chris@0: Chris@0: $pager_plugin = $view->getPager(); Chris@0: $this->assertTrue($pager_plugin instanceof PagerPluginBase, 'An instance of PagerPluginBase was returned.'); Chris@0: $this->assertTrue($view->pager instanceof PagerPluginBase, 'The pager property has been set.'); Chris@0: $this->assertIdentical($pager_plugin, $view->getPager(), 'The same pager plugin instance was returned.'); Chris@0: Chris@0: $query_plugin = $view->getQuery(); Chris@0: $this->assertTrue($query_plugin instanceof QueryPluginBase, 'An instance of QueryPluginBase was returned.'); Chris@0: $this->assertTrue($view->query instanceof QueryPluginBase, 'The query property has been set.'); Chris@0: $this->assertIdentical($query_plugin, $view->getQuery(), 'The same query plugin instance was returned.'); Chris@0: } Chris@0: Chris@0: /** Chris@0: * Tests the generation of the executable object. Chris@0: */ Chris@0: public function testConstructing() { Chris@0: Views::getView('test_destroy'); Chris@0: } Chris@0: Chris@0: /** Chris@0: * Tests the accessing of values on the object. Chris@0: */ Chris@0: public function testProperties() { Chris@0: $view = Views::getView('test_destroy'); Chris@0: foreach ($this->executableProperties as $property) { Chris@0: $this->assertTrue(isset($view->{$property})); Chris@0: } Chris@0: Chris@0: // Per default exposed input should fall back to an empty array. Chris@0: $this->assertEqual($view->getExposedInput(), []); Chris@0: } Chris@0: Chris@0: public function testSetDisplayWithInvalidDisplay() { Chris@0: $view = Views::getView('test_executable_displays'); Chris@0: $view->initDisplay(); Chris@0: Chris@0: // Error is triggered while calling the wrong display. Chris@0: try { Chris@0: $view->setDisplay('invalid'); Chris@0: $this->fail('Expected error, when setDisplay() called with invalid display ID'); Chris@0: } Chris@0: catch (\PHPUnit_Framework_Error_Warning $e) { Chris@0: $this->assertEquals('setDisplay() called with invalid display ID "invalid".', $e->getMessage()); Chris@0: } Chris@0: Chris@0: $this->assertEqual($view->current_display, 'default', 'If setDisplay is called with an invalid display id the default display should be used.'); Chris@0: $this->assertEqual(spl_object_hash($view->display_handler), spl_object_hash($view->displayHandlers->get('default'))); Chris@0: } Chris@0: Chris@0: /** Chris@0: * Tests the display related methods and properties. Chris@0: */ Chris@0: public function testDisplays() { Chris@0: $view = Views::getView('test_executable_displays'); Chris@0: Chris@0: // Tests Drupal\views\ViewExecutable::initDisplay(). Chris@0: $view->initDisplay(); Chris@0: $this->assertTrue($view->displayHandlers instanceof DisplayPluginCollection, 'The displayHandlers property has the right class.'); Chris@0: // Tests the classes of the instances. Chris@0: $this->assertTrue($view->displayHandlers->get('default') instanceof DefaultDisplay); Chris@0: $this->assertTrue($view->displayHandlers->get('page_1') instanceof Page); Chris@0: $this->assertTrue($view->displayHandlers->get('page_2') instanceof Page); Chris@0: Chris@0: // After initializing the default display is the current used display. Chris@0: $this->assertEqual($view->current_display, 'default'); Chris@0: $this->assertEqual(spl_object_hash($view->display_handler), spl_object_hash($view->displayHandlers->get('default'))); Chris@0: Chris@0: // All handlers should have a reference to the default display. Chris@0: $this->assertEqual(spl_object_hash($view->displayHandlers->get('page_1')->default_display), spl_object_hash($view->displayHandlers->get('default'))); Chris@0: $this->assertEqual(spl_object_hash($view->displayHandlers->get('page_2')->default_display), spl_object_hash($view->displayHandlers->get('default'))); Chris@0: Chris@0: // Tests Drupal\views\ViewExecutable::setDisplay(). Chris@0: $view->setDisplay(); Chris@0: $this->assertEqual($view->current_display, 'default', 'If setDisplay is called with no parameter the default display should be used.'); Chris@0: $this->assertEqual(spl_object_hash($view->display_handler), spl_object_hash($view->displayHandlers->get('default'))); Chris@0: Chris@0: // Set two different valid displays. Chris@0: $view->setDisplay('page_1'); Chris@0: $this->assertEqual($view->current_display, 'page_1', 'If setDisplay is called with a valid display id the appropriate display should be used.'); Chris@0: $this->assertEqual(spl_object_hash($view->display_handler), spl_object_hash($view->displayHandlers->get('page_1'))); Chris@0: Chris@0: $view->setDisplay('page_2'); Chris@0: $this->assertEqual($view->current_display, 'page_2', 'If setDisplay is called with a valid display id the appropriate display should be used.'); Chris@0: $this->assertEqual(spl_object_hash($view->display_handler), spl_object_hash($view->displayHandlers->get('page_2'))); Chris@0: Chris@0: // Destroy the view, so we can start again and test an invalid display. Chris@0: $view->destroy(); Chris@0: Chris@0: // Test the style and row plugins are replaced correctly when setting the Chris@0: // display. Chris@0: $view->setDisplay('page_1'); Chris@0: $view->initStyle(); Chris@0: $this->assertTrue($view->style_plugin instanceof DefaultStyle); Chris@0: $this->assertTrue($view->rowPlugin instanceof Fields); Chris@0: Chris@0: $view->setDisplay('page_2'); Chris@0: $view->initStyle(); Chris@0: $this->assertTrue($view->style_plugin instanceof Grid); Chris@0: // @todo Change this rowPlugin type too. Chris@0: $this->assertTrue($view->rowPlugin instanceof Fields); Chris@0: Chris@0: // Test the newDisplay() method. Chris@0: $view = $this->container->get('entity.manager')->getStorage('view')->create(['id' => 'test_executable_displays']); Chris@0: $executable = $view->getExecutable(); Chris@0: Chris@0: $executable->newDisplay('page'); Chris@0: $executable->newDisplay('page'); Chris@0: $executable->newDisplay('display_test'); Chris@0: Chris@0: $this->assertTrue($executable->displayHandlers->get('default') instanceof DefaultDisplay); Chris@0: $this->assertFalse(isset($executable->displayHandlers->get('default')->default_display)); Chris@0: $this->assertTrue($executable->displayHandlers->get('page_1') instanceof Page); Chris@0: $this->assertTrue($executable->displayHandlers->get('page_1')->default_display instanceof DefaultDisplay); Chris@0: $this->assertTrue($executable->displayHandlers->get('page_2') instanceof Page); Chris@0: $this->assertTrue($executable->displayHandlers->get('page_2')->default_display instanceof DefaultDisplay); Chris@0: $this->assertTrue($executable->displayHandlers->get('display_test_1') instanceof DisplayTest); Chris@0: $this->assertTrue($executable->displayHandlers->get('display_test_1')->default_display instanceof DefaultDisplay); Chris@0: } Chris@0: Chris@0: /** Chris@0: * Tests the setting/getting of properties. Chris@0: */ Chris@0: public function testPropertyMethods() { Chris@0: $view = Views::getView('test_executable_displays'); Chris@0: Chris@0: // Test the setAjaxEnabled() method. Chris@0: $this->assertFalse($view->ajaxEnabled()); Chris@0: $view->setAjaxEnabled(TRUE); Chris@0: $this->assertTrue($view->ajaxEnabled()); Chris@0: Chris@0: $view->setDisplay(); Chris@0: // There should be no pager set initially. Chris@0: $this->assertNull($view->usePager()); Chris@0: Chris@0: // Add a pager, initialize, and test. Chris@0: $view->displayHandlers->get('default')->overrideOption('pager', [ Chris@0: 'type' => 'full', Chris@0: 'options' => ['items_per_page' => 10], Chris@0: ]); Chris@0: $view->initPager(); Chris@0: $this->assertTrue($view->usePager()); Chris@0: Chris@0: // Test setting and getting the offset. Chris@0: $rand = rand(); Chris@0: $view->setOffset($rand); Chris@0: $this->assertEqual($view->getOffset(), $rand); Chris@0: Chris@0: // Test the getBaseTable() method. Chris@0: $expected = [ Chris@0: 'views_test_data' => TRUE, Chris@0: '#global' => TRUE, Chris@0: ]; Chris@0: $this->assertIdentical($view->getBaseTables(), $expected); Chris@0: Chris@0: // Test response methods. Chris@0: $this->assertTrue($view->getResponse() instanceof Response, 'New response object returned.'); Chris@0: $new_response = new Response(); Chris@0: $view->setResponse($new_response); Chris@0: $this->assertIdentical(spl_object_hash($view->getResponse()), spl_object_hash($new_response), 'New response object correctly set.'); Chris@0: Chris@0: // Test the getPath() method. Chris@0: $path = $this->randomMachineName(); Chris@0: $view->displayHandlers->get('page_1')->overrideOption('path', $path); Chris@0: $view->setDisplay('page_1'); Chris@0: $this->assertEqual($view->getPath(), $path); Chris@0: // Test the override_path property override. Chris@0: $override_path = $this->randomMachineName(); Chris@0: $view->override_path = $override_path; Chris@0: $this->assertEqual($view->getPath(), $override_path); Chris@0: Chris@0: // Test the title methods. Chris@0: $title = $this->randomString(); Chris@0: $view->setTitle($title); Chris@0: $this->assertEqual($view->getTitle(), Xss::filterAdmin($title)); Chris@0: } Chris@0: Chris@0: /** Chris@0: * Tests the deconstructor to be sure that necessary objects are removed. Chris@0: */ Chris@0: public function testDestroy() { Chris@0: $view = Views::getView('test_destroy'); Chris@0: Chris@0: $view->preview(); Chris@0: $view->destroy(); Chris@0: Chris@0: $this->assertViewDestroy($view); Chris@0: } Chris@0: Chris@0: /** Chris@0: * Asserts that expected view properties have been unset by destroy(). Chris@0: * Chris@0: * @param \Drupal\views\ViewExecutable $view Chris@0: */ Chris@0: protected function assertViewDestroy($view) { Chris@0: $reflection = new \ReflectionClass($view); Chris@0: $defaults = $reflection->getDefaultProperties(); Chris@0: // The storage and user should remain. Chris@0: unset( Chris@0: $defaults['storage'], Chris@0: $defaults['user'], Chris@0: $defaults['request'], Chris@0: $defaults['routeProvider'], Chris@0: $defaults['viewsData'] Chris@0: ); Chris@0: Chris@0: foreach ($defaults as $property => $default) { Chris@0: $this->assertIdentical($this->getProtectedProperty($view, $property), $default); Chris@0: } Chris@0: } Chris@0: Chris@0: /** Chris@0: * Returns a protected property from a class instance. Chris@0: * Chris@0: * @param object $instance Chris@0: * The class instance to return the property from. Chris@0: * @param string $property Chris@0: * The name of the property to return. Chris@0: * Chris@0: * @return mixed Chris@0: * The instance property value. Chris@0: */ Chris@0: protected function getProtectedProperty($instance, $property) { Chris@0: $reflection = new \ReflectionProperty($instance, $property); Chris@0: $reflection->setAccessible(TRUE); Chris@0: return $reflection->getValue($instance); Chris@0: } Chris@0: Chris@0: /** Chris@0: * Tests ViewExecutable::getHandlerTypes(). Chris@0: */ Chris@0: public function testGetHandlerTypes() { Chris@0: $types = ViewExecutable::getHandlerTypes(); Chris@0: foreach (['field', 'filter', 'argument', 'sort', 'header', 'footer', 'empty'] as $type) { Chris@0: $this->assertTrue(isset($types[$type])); Chris@0: // @todo The key on the display should be footers, headers and empties Chris@0: // or something similar instead of the singular, but so long check for Chris@0: // this special case. Chris@0: if (isset($types[$type]['type']) && $types[$type]['type'] == 'area') { Chris@0: $this->assertEqual($types[$type]['plural'], $type); Chris@0: } Chris@0: else { Chris@0: $this->assertEqual($types[$type]['plural'], $type . 's'); Chris@0: } Chris@0: } Chris@0: } Chris@0: Chris@0: /** Chris@0: * Tests ViewExecutable::getHandlers(). Chris@0: */ Chris@0: public function testGetHandlers() { Chris@0: $view = Views::getView('test_executable_displays'); Chris@0: $view->setDisplay('page_1'); Chris@0: Chris@0: $view->getHandlers('field', 'page_2'); Chris@0: Chris@0: // getHandlers() shouldn't change the active display. Chris@0: $this->assertEqual('page_1', $view->current_display, "The display shouldn't change after getHandlers()"); Chris@0: } Chris@0: Chris@0: /** Chris@0: * Tests the validation of display handlers. Chris@0: */ Chris@0: public function testValidate() { Chris@0: $view = Views::getView('test_executable_displays'); Chris@0: $view->setDisplay('page_1'); Chris@0: Chris@0: $validate = $view->validate(); Chris@0: Chris@0: // Validating a view shouldn't change the active display. Chris@0: $this->assertEqual('page_1', $view->current_display, "The display should be constant while validating"); Chris@0: Chris@0: $count = 0; Chris@0: foreach ($view->displayHandlers as $id => $display) { Chris@0: $match = function ($value) use ($display) { Chris@0: return strpos($value, $display->display['display_title']) !== FALSE; Chris@0: }; Chris@0: $this->assertTrue(array_filter($validate[$id], $match), format_string('Error message found for @id display', ['@id' => $id])); Chris@0: $count++; Chris@0: } Chris@0: Chris@0: $this->assertEqual(count($view->displayHandlers), $count, 'Error messages from all handlers merged.'); Chris@0: Chris@0: // Test that a deleted display is not included. Chris@0: $display = &$view->storage->getDisplay('default'); Chris@0: $display['deleted'] = TRUE; Chris@0: $validate_deleted = $view->validate(); Chris@0: Chris@0: $this->assertNotIdentical($validate, $validate_deleted, 'Master display has not been validated.'); Chris@0: } Chris@0: Chris@0: /** Chris@0: * Tests that nested loops of the display handlers won't break validation. Chris@0: */ Chris@0: public function testValidateNestedLoops() { Chris@0: $view = View::create(['id' => 'test_validate_nested_loops']); Chris@0: $executable = $view->getExecutable(); Chris@0: Chris@0: $executable->newDisplay('display_test'); Chris@0: $executable->newDisplay('display_test'); Chris@0: $errors = $executable->validate(); Chris@0: $total_error_count = array_reduce($errors, function ($carry, $item) { Chris@0: $carry += count($item); Chris@0: Chris@0: return $carry; Chris@0: }); Chris@0: // Assert that there were 9 total errors across 3 displays. Chris@0: $this->assertIdentical(9, $total_error_count); Chris@0: $this->assertIdentical(3, count($errors)); Chris@0: } Chris@0: Chris@0: /** Chris@0: * Tests serialization of the ViewExecutable object. Chris@0: */ Chris@0: public function testSerialization() { Chris@0: $view = Views::getView('test_executable_displays'); Chris@0: $view->setDisplay('page_1'); Chris@0: $view->setArguments(['test']); Chris@0: $view->setCurrentPage(2); Chris@0: Chris@0: $serialized = serialize($view); Chris@0: Chris@0: // Test the view storage object is not present in the actual serialized Chris@0: // string. Chris@0: $this->assertIdentical(strpos($serialized, '"Drupal\views\Entity\View"'), FALSE, 'The Drupal\views\Entity\View class was not found in the serialized string.'); Chris@0: Chris@0: /** @var \Drupal\views\ViewExecutable $unserialized */ Chris@0: $unserialized = unserialize($serialized); Chris@0: Chris@0: $this->assertTrue($unserialized instanceof ViewExecutable); Chris@0: $this->assertIdentical($view->storage->id(), $unserialized->storage->id(), 'The expected storage entity was loaded on the unserialized view.'); Chris@0: $this->assertIdentical($unserialized->current_display, 'page_1', 'The expected display was set on the unserialized view.'); Chris@0: $this->assertIdentical($unserialized->args, ['test'], 'The expected argument was set on the unserialized view.'); Chris@0: $this->assertIdentical($unserialized->getCurrentPage(), 2, 'The expected current page was set on the unserialized view.'); Chris@0: Chris@0: // Get the definition of node's nid field, for example. Only get it not from Chris@0: // the field manager directly, but from the item data definition. It should Chris@0: // be the same base field definition object (the field and item definitions Chris@0: // refer to each other). Chris@0: // See https://bugs.php.net/bug.php?id=66052 Chris@0: $field_manager = $this->container->get('entity_field.manager'); Chris@0: $nid_definition_before = $field_manager->getBaseFieldDefinitions('node')['nid'] Chris@0: ->getItemDefinition() Chris@0: ->getFieldDefinition(); Chris@0: Chris@0: // Load and execute a view. Chris@0: $view_entity = View::load('content'); Chris@0: $view_executable = $view_entity->getExecutable(); Chris@0: $view_executable->execute('page_1'); Chris@0: Chris@0: // Reset the static cache. Don't use clearCachedFieldDefinitions() since Chris@0: // that clears the persistent cache and we need to get the serialized cache Chris@0: // data. Chris@0: $field_manager->useCaches(FALSE); Chris@0: $field_manager->useCaches(TRUE); Chris@0: Chris@0: // Serialize the ViewExecutable as part of other data. Chris@0: unserialize(serialize(['SOMETHING UNEXPECTED', $view_executable])); Chris@0: Chris@0: // Make sure the serialisation of the ViewExecutable didn't influence the Chris@0: // field definitions. Chris@0: $nid_definition_after = $field_manager->getBaseFieldDefinitions('node')['nid'] Chris@0: ->getItemDefinition() Chris@0: ->getFieldDefinition(); Chris@0: $this->assertEquals($nid_definition_before->getPropertyDefinitions(), $nid_definition_after->getPropertyDefinitions()); Chris@0: } Chris@0: Chris@16: /** Chris@16: * Tests if argument overrides by validators are propagated to tokens. Chris@16: */ Chris@16: public function testArgumentValidatorValueOverride() { Chris@16: $view = Views::getView('test_argument_dependency'); Chris@16: $view->setDisplay('page_1'); Chris@16: $view->setArguments(['1', 'this value should be replaced']); Chris@16: $view->execute(); Chris@16: $expected = [ Chris@16: '{{ arguments.uid }}' => '1', Chris@16: '{{ raw_arguments.uid }}' => '1', Chris@16: ]; Chris@16: $this->assertEquals($expected, $view->build_info['substitutions']); Chris@16: } Chris@16: Chris@0: }