Version 1
[yaffs-website] / web / core / modules / views / tests / src / Kernel / ViewStorageTest.php
diff --git a/web/core/modules/views/tests/src/Kernel/ViewStorageTest.php b/web/core/modules/views/tests/src/Kernel/ViewStorageTest.php
new file mode 100644 (file)
index 0000000..7cf953a
--- /dev/null
@@ -0,0 +1,351 @@
+<?php
+
+namespace Drupal\Tests\views\Kernel;
+
+use Drupal\Core\Entity\EntityTypeInterface;
+use Drupal\views\Entity\View;
+use Drupal\views\Plugin\views\display\Page;
+use Drupal\views\Views;
+
+/**
+ * Tests the CRUD functionality for a view.
+ *
+ * @group views
+ * @see \Drupal\views\Entity\View
+ * @see \Drupal\Core\Config\Entity\ConfigEntityStorage
+ */
+class ViewStorageTest extends ViewsKernelTestBase {
+
+  /**
+   * Properties that should be stored in the configuration.
+   *
+   * @var array
+   */
+  protected $configProperties = [
+    'status',
+    'module',
+    'id',
+    'description',
+    'tag',
+    'base_table',
+    'label',
+    'core',
+    'display',
+  ];
+
+  /**
+   * The entity type definition.
+   *
+   * @var \Drupal\Core\Entity\EntityTypeInterface
+   */
+  protected $entityType;
+
+  /**
+   * The configuration entity storage.
+   *
+   * @var \Drupal\Core\Config\Entity\ConfigEntityStorage
+   */
+  protected $controller;
+
+  /**
+   * Views used by this test.
+   *
+   * @var array
+   */
+  public static $testViews = ['test_view_storage'];
+
+  /**
+   * Tests CRUD operations.
+   */
+  public function testConfigurationEntityCRUD() {
+    // Get the configuration entity type and controller.
+    $this->entityType = \Drupal::entityManager()->getDefinition('view');
+    $this->controller = $this->container->get('entity.manager')->getStorage('view');
+
+    // Confirm that an info array has been returned.
+    $this->assertTrue($this->entityType instanceof EntityTypeInterface, 'The View info array is loaded.');
+
+    // CRUD tests.
+    $this->loadTests();
+    $this->createTests();
+    $this->displayTests();
+
+    // Helper method tests
+    $this->displayMethodTests();
+  }
+
+  /**
+   * Tests loading configuration entities.
+   */
+  protected function loadTests() {
+    $view = View::load('test_view_storage');
+    $data = $this->config('views.view.test_view_storage')->get();
+
+    // Confirm that an actual view object is loaded and that it returns all of
+    // expected properties.
+    $this->assertTrue($view instanceof View, 'Single View instance loaded.');
+    foreach ($this->configProperties as $property) {
+      $this->assertTrue($view->get($property) !== NULL, format_string('Property: @property loaded onto View.', ['@property' => $property]));
+    }
+
+    // Check the displays have been loaded correctly from config display data.
+    $expected_displays = ['default', 'block_1', 'page_1'];
+    $this->assertEqual(array_keys($view->get('display')), $expected_displays, 'The correct display names are present.');
+
+    // Check each ViewDisplay object and confirm that it has the correct key and
+    // property values.
+    foreach ($view->get('display') as $key => $display) {
+      $this->assertEqual($key, $display['id'], 'The display has the correct ID assigned.');
+
+      // Get original display data and confirm that the display options array
+      // exists.
+      $original_options = $data['display'][$key];
+      foreach ($original_options as $orig_key => $value) {
+        $this->assertIdentical($display[$orig_key], $value, format_string('@key is identical to saved data', ['@key' => $key]));
+      }
+    }
+
+    // Make sure that loaded default views get a UUID.
+    $view = Views::getView('test_view_storage');
+    $this->assertTrue($view->storage->uuid());
+  }
+
+  /**
+   * Tests creating configuration entities.
+   */
+  protected function createTests() {
+    // Create a new View instance with empty values.
+    $created = $this->controller->create([]);
+
+    $this->assertTrue($created instanceof View, 'Created object is a View.');
+    // Check that the View contains all of the properties.
+    foreach ($this->configProperties as $property) {
+      $this->assertTrue(property_exists($created, $property), format_string('Property: @property created on View.', ['@property' => $property]));
+    }
+
+    // Create a new View instance with config values.
+    $values = $this->config('views.view.test_view_storage')->get();
+    $values['id'] = 'test_view_storage_new';
+    unset($values['uuid']);
+    $created = $this->controller->create($values);
+
+    $this->assertTrue($created instanceof View, 'Created object is a View.');
+    // Check that the View contains all of the properties.
+    $properties = $this->configProperties;
+    // Remove display from list.
+    array_pop($properties);
+
+    // Test all properties except displays.
+    foreach ($properties as $property) {
+      $this->assertTrue($created->get($property) !== NULL, format_string('Property: @property created on View.', ['@property' => $property]));
+      $this->assertIdentical($values[$property], $created->get($property), format_string('Property value: @property matches configuration value.', ['@property' => $property]));
+    }
+
+    // Check the UUID of the loaded View.
+    $created->save();
+    $created_loaded = View::load('test_view_storage_new');
+    $this->assertIdentical($created->uuid(), $created_loaded->uuid(), 'The created UUID has been saved correctly.');
+  }
+
+  /**
+   * Tests adding, saving, and loading displays on configuration entities.
+   */
+  protected function displayTests() {
+    // Check whether a display can be added and saved to a View.
+    $view = View::load('test_view_storage_new');
+
+    $new_id = $view->addDisplay('page', 'Test', 'test');
+    $display = $view->get('display');
+
+    // Ensure the right display_plugin is created/instantiated.
+    $this->assertEqual($display[$new_id]['display_plugin'], 'page', 'New page display "test" uses the right display plugin.');
+
+    $executable = $view->getExecutable();
+    $executable->initDisplay();
+    $this->assertTrue($executable->displayHandlers->get($new_id) instanceof Page, 'New page display "test" uses the right display plugin.');
+
+    // To save this with a new ID, we should use createDuplicate().
+    $view = $view->createDuplicate();
+    $view->set('id', 'test_view_storage_new_new2');
+    $view->save();
+    $values = $this->config('views.view.test_view_storage_new_new2')->get();
+
+    $this->assertTrue(isset($values['display']['test']) && is_array($values['display']['test']), 'New display was saved.');
+  }
+
+  /**
+   * Tests the display related functions like getDisplaysList().
+   */
+  protected function displayMethodTests() {
+    $config['display'] = [
+      'page_1' => [
+        'display_options' => ['path' => 'test'],
+        'display_plugin' => 'page',
+        'id' => 'page_2',
+        'display_title' => 'Page 1',
+        'position' => 1
+      ],
+      'feed_1' => [
+        'display_options' => ['path' => 'test.xml'],
+        'display_plugin' => 'feed',
+        'id' => 'feed',
+        'display_title' => 'Feed',
+        'position' => 2
+      ],
+      'page_2' => [
+        'display_options' => ['path' => 'test/%/extra'],
+        'display_plugin' => 'page',
+        'id' => 'page_2',
+        'display_title' => 'Page 2',
+        'position' => 3
+      ]
+    ];
+    $view = $this->controller->create($config);
+
+    // Tests Drupal\views\Entity\View::addDisplay()
+    $view = $this->controller->create([]);
+    $random_title = $this->randomMachineName();
+
+    $id = $view->addDisplay('page', $random_title);
+    $this->assertEqual($id, 'page_1', format_string('Make sure the first display (%id_new) has the expected ID (%id)', ['%id_new' => $id, '%id' => 'page_1']));
+    $display = $view->get('display');
+    $this->assertEqual($display[$id]['display_title'], $random_title);
+
+    $random_title = $this->randomMachineName();
+    $id = $view->addDisplay('page', $random_title);
+    $display = $view->get('display');
+    $this->assertEqual($id, 'page_2', format_string('Make sure the second display (%id_new) has the expected ID (%id)', ['%id_new' => $id, '%id' => 'page_2']));
+    $this->assertEqual($display[$id]['display_title'], $random_title);
+
+    $id = $view->addDisplay('page');
+    $display = $view->get('display');
+    $this->assertEqual($display[$id]['display_title'], 'Page 3');
+
+    // Ensure the 'default' display always has position zero, regardless of when
+    // it was set relative to other displays. Even if the 'default' display
+    // exists, adding it again will overwrite it, which is asserted with the new
+    // title.
+    $view->addDisplay('default', $random_title);
+    $displays = $view->get('display');
+    $this->assertEqual($displays['default']['display_title'], $random_title, 'Default display is defined with the new title');
+    $this->assertEqual($displays['default']['position'], 0, 'Default displays are always in position zero');
+
+    // Tests Drupal\views\Entity\View::generateDisplayId(). Since
+    // generateDisplayId() is protected, we have to use reflection to unit-test
+    // it.
+    $view = $this->controller->create([]);
+    $ref_generate_display_id = new \ReflectionMethod($view, 'generateDisplayId');
+    $ref_generate_display_id->setAccessible(TRUE);
+    $this->assertEqual(
+      $ref_generate_display_id->invoke($view, 'default'),
+      'default',
+      'The plugin ID for default is always default.'
+    );
+    $this->assertEqual(
+      $ref_generate_display_id->invoke($view, 'feed'),
+      'feed_1',
+      'The generated ID for the first instance of a plugin type should have an suffix of _1.'
+    );
+    $view->addDisplay('feed', 'feed title');
+    $this->assertEqual(
+      $ref_generate_display_id->invoke($view, 'feed'),
+      'feed_2',
+      'The generated ID for the first instance of a plugin type should have an suffix of _2.'
+    );
+
+    // Tests item related methods().
+    $view = $this->controller->create(['base_table' => 'views_test_data']);
+    $view->addDisplay('default');
+    $view = $view->getExecutable();
+
+    $display_id = 'default';
+    $expected_items = [];
+    // Tests addHandler with getItem.
+    // Therefore add one item without any options and one item with some
+    // options.
+    $id1 = $view->addHandler($display_id, 'field', 'views_test_data', 'id');
+    $item1 = $view->getHandler($display_id, 'field', 'id');
+    $expected_items[$id1] = $expected_item = [
+      'id' => 'id',
+      'table' => 'views_test_data',
+      'field' => 'id',
+      'plugin_id' => 'numeric',
+    ];
+    $this->assertEqual($item1, $expected_item);
+
+    $options = [
+      'alter' => [
+        'text' => $this->randomMachineName()
+      ]
+    ];
+    $id2 = $view->addHandler($display_id, 'field', 'views_test_data', 'name', $options);
+    $item2 = $view->getHandler($display_id, 'field', 'name');
+    $expected_items[$id2] = $expected_item = [
+      'id' => 'name',
+      'table' => 'views_test_data',
+      'field' => 'name',
+      'plugin_id' => 'standard',
+    ] + $options;
+    $this->assertEqual($item2, $expected_item);
+
+    // Tests the expected fields from the previous additions.
+    $this->assertEqual($view->getHandlers('field', $display_id), $expected_items);
+
+    // Alter an existing item via setItem and check the result via getItem
+    // and getItems.
+    $item = [
+      'alter' => [
+        'text' => $this->randomMachineName(),
+      ]
+    ] + $item1;
+    $expected_items[$id1] = $item;
+    $view->setHandler($display_id, 'field', $id1, $item);
+    $this->assertEqual($view->getHandler($display_id, 'field', 'id'), $item);
+    $this->assertEqual($view->getHandlers('field', $display_id), $expected_items);
+
+    // Test removeItem method.
+    unset($expected_items[$id2]);
+    $view->removeHandler($display_id, 'field', $id2);
+    $this->assertEqual($view->getHandlers('field', $display_id), $expected_items);
+  }
+
+  /**
+   * Tests the createDuplicate() View method.
+   */
+  public function testCreateDuplicate() {
+    $view = Views::getView('test_view_storage');
+    $copy = $view->storage->createDuplicate();
+
+    $this->assertTrue($copy instanceof View, 'The copied object is a View.');
+
+    // Check that the original view and the copy have different UUIDs.
+    $this->assertNotIdentical($view->storage->uuid(), $copy->uuid(), 'The copied view has a new UUID.');
+
+    // Check the 'name' (ID) is using the View objects default value (NULL) as it
+    // gets unset.
+    $this->assertIdentical($copy->id(), NULL, 'The ID has been reset.');
+
+    // Check the other properties.
+    // @todo Create a reusable property on the base test class for these?
+    $config_properties = [
+      'disabled',
+      'description',
+      'tag',
+      'base_table',
+      'label',
+      'core',
+    ];
+
+    foreach ($config_properties as $property) {
+      $this->assertIdentical($view->storage->get($property), $copy->get($property), format_string('@property property is identical.', ['@property' => $property]));
+    }
+
+    // Check the displays are the same.
+    $copy_display = $copy->get('display');
+    foreach ($view->storage->get('display') as $id => $display) {
+      // assertIdentical will not work here.
+      $this->assertEqual($display, $copy_display[$id], format_string('The @display display has been copied correctly.', ['@display' => $id]));
+    }
+  }
+
+}