Version 1
[yaffs-website] / web / core / modules / views_ui / src / Tests / HandlerTest.php
diff --git a/web/core/modules/views_ui/src/Tests/HandlerTest.php b/web/core/modules/views_ui/src/Tests/HandlerTest.php
new file mode 100644 (file)
index 0000000..8fb29f9
--- /dev/null
@@ -0,0 +1,282 @@
+<?php
+
+namespace Drupal\views_ui\Tests;
+
+use Drupal\Component\Utility\SafeMarkup;
+use Drupal\field\Entity\FieldConfig;
+use Drupal\field\Entity\FieldStorageConfig;
+use Drupal\views\Tests\ViewTestData;
+use Drupal\views\ViewExecutable;
+
+/**
+ * Tests handler UI for views.
+ *
+ * @group views_ui
+ * @see \Drupal\views\Plugin\views\HandlerBase
+ */
+class HandlerTest extends UITestBase {
+
+  /**
+   * {@inheritdoc}
+   */
+  public static $modules = ['node_test_views'];
+
+  /**
+   * Views used by this test.
+   *
+   * @var array
+   */
+  public static $testViews = ['test_view_empty', 'test_view_broken', 'node', 'test_node_view'];
+
+  /**
+   * {@inheritdoc}
+   */
+  protected function setUp() {
+    parent::setUp();
+
+    $this->drupalPlaceBlock('page_title_block');
+    ViewTestData::createTestViews(get_class($this), ['node_test_views']);
+  }
+
+  /**
+   * Overrides \Drupal\views\Tests\ViewTestBase::schemaDefinition().
+   *
+   * Adds a uid column to test the relationships.
+   */
+  protected function schemaDefinition() {
+    $schema = parent::schemaDefinition();
+
+    $schema['views_test_data']['fields']['uid'] = [
+      'description' => "The {users}.uid of the author of the beatle entry.",
+      'type' => 'int',
+      'unsigned' => TRUE,
+      'not null' => TRUE,
+      'default' => 0
+    ];
+
+    return $schema;
+  }
+
+  /**
+   * Overrides \Drupal\views\Tests\ViewTestBase::viewsData().
+   *
+   * Adds:
+   * - a relationship for the uid column.
+   * - a dummy field with no help text.
+   */
+  protected function viewsData() {
+    $data = parent::viewsData();
+    $data['views_test_data']['uid'] = [
+      'title' => t('UID'),
+      'help' => t('The test data UID'),
+      'relationship' => [
+        'id' => 'standard',
+        'base' => 'users_field_data',
+        'base field' => 'uid'
+      ]
+    ];
+
+    // Create a dummy field with no help text.
+    $data['views_test_data']['no_help'] = $data['views_test_data']['name'];
+    $data['views_test_data']['no_help']['field']['title'] = t('No help');
+    $data['views_test_data']['no_help']['field']['real field'] = 'name';
+    unset($data['views_test_data']['no_help']['help']);
+
+    return $data;
+  }
+
+  /**
+   * Tests UI CRUD.
+   */
+  public function testUICRUD() {
+    $handler_types = ViewExecutable::getHandlerTypes();
+    foreach ($handler_types as $type => $type_info) {
+      // Test adding handlers.
+      $add_handler_url = "admin/structure/views/nojs/add-handler/test_view_empty/default/$type";
+
+      // Area handler types need to use a different handler.
+      if (in_array($type, ['header', 'footer', 'empty'])) {
+        $this->drupalPostForm($add_handler_url, ['name[views.area]' => TRUE], t('Add and configure @handler', ['@handler' => $type_info['ltitle']]));
+        $id = 'area';
+        $edit_handler_url = "admin/structure/views/nojs/handler/test_view_empty/default/$type/$id";
+      }
+      elseif ($type == 'relationship') {
+        $this->drupalPostForm($add_handler_url, ['name[views_test_data.uid]' => TRUE], t('Add and configure @handler', ['@handler' => $type_info['ltitle']]));
+        $id = 'uid';
+        $edit_handler_url = "admin/structure/views/nojs/handler/test_view_empty/default/$type/$id";
+      }
+      else {
+        $this->drupalPostForm($add_handler_url, ['name[views_test_data.job]' => TRUE], t('Add and configure @handler', ['@handler' => $type_info['ltitle']]));
+        $id = 'job';
+        $edit_handler_url = "admin/structure/views/nojs/handler/test_view_empty/default/$type/$id";
+      }
+
+      $this->assertUrl($edit_handler_url, [], 'The user got redirected to the handler edit form.');
+      $random_label = $this->randomMachineName();
+      $this->drupalPostForm(NULL, ['options[admin_label]' => $random_label], t('Apply'));
+
+      $this->assertUrl('admin/structure/views/view/test_view_empty/edit/default', [], 'The user got redirected to the views edit form.');
+
+      $this->assertLinkByHref($edit_handler_url, 0, 'The handler edit link appears in the UI.');
+      $links = $this->xpath('//a[starts-with(normalize-space(text()), :label)]', [':label' => $random_label]);
+      $this->assertTrue(isset($links[0]), 'The handler edit link has the right label');
+
+      // Save the view and have a look whether the handler was added as expected.
+      $this->drupalPostForm(NULL, [], t('Save'));
+      $view = $this->container->get('entity.manager')->getStorage('view')->load('test_view_empty');
+      $display = $view->getDisplay('default');
+      $this->assertTrue(isset($display['display_options'][$type_info['plural']][$id]), 'Ensure the field was added to the view itself.');
+
+      // Remove the item and check that it's removed
+      $this->drupalPostForm($edit_handler_url, [], t('Remove'));
+      $this->assertNoLinkByHref($edit_handler_url, 0, 'The handler edit link does not appears in the UI after removing.');
+
+      $this->drupalPostForm(NULL, [], t('Save'));
+      $view = $this->container->get('entity.manager')->getStorage('view')->load('test_view_empty');
+      $display = $view->getDisplay('default');
+      $this->assertFalse(isset($display['display_options'][$type_info['plural']][$id]), 'Ensure the field was removed from the view itself.');
+    }
+
+    // Test adding a field of the user table using the uid relationship.
+    $type_info = $handler_types['relationship'];
+    $add_handler_url = "admin/structure/views/nojs/add-handler/test_view_empty/default/relationship";
+    $this->drupalPostForm($add_handler_url, ['name[views_test_data.uid]' => TRUE], t('Add and configure @handler', ['@handler' => $type_info['ltitle']]));
+
+    $add_handler_url = "admin/structure/views/nojs/add-handler/test_view_empty/default/field";
+    $type_info = $handler_types['field'];
+    $this->drupalPostForm($add_handler_url, ['name[users_field_data.name]' => TRUE], t('Add and configure @handler', ['@handler' => $type_info['ltitle']]));
+    $id = 'name';
+    $edit_handler_url = "admin/structure/views/nojs/handler/test_view_empty/default/field/$id";
+
+    $this->assertUrl($edit_handler_url, [], 'The user got redirected to the handler edit form.');
+    $this->assertFieldByName('options[relationship]', 'uid', 'Ensure the relationship select is filled with the UID relationship.');
+    $this->drupalPostForm(NULL, [], t('Apply'));
+
+    $this->drupalPostForm(NULL, [], t('Save'));
+    $view = $this->container->get('entity.manager')->getStorage('view')->load('test_view_empty');
+    $display = $view->getDisplay('default');
+    $this->assertTrue(isset($display['display_options'][$type_info['plural']][$id]), 'Ensure the field was added to the view itself.');
+  }
+
+  /**
+   * Tests escaping of field labels in help text.
+   */
+  public function testHandlerHelpEscaping() {
+    // Setup a field with two instances using a different label.
+    // Ensure that the label is escaped properly.
+
+    $this->drupalCreateContentType(['type' => 'article']);
+    $this->drupalCreateContentType(['type' => 'page']);
+
+    FieldStorageConfig::create([
+      'field_name' => 'field_test',
+      'entity_type' => 'node',
+      'type' => 'string',
+    ])->save();
+
+    FieldConfig::create([
+      'field_name' => 'field_test',
+      'entity_type' => 'node',
+      'bundle' => 'page',
+      'label' => 'The giraffe" label'
+    ])->save();
+
+    FieldConfig::create([
+      'field_name' => 'field_test',
+      'entity_type' => 'node',
+      'bundle' => 'article',
+      'label' => 'The <em>giraffe"</em> label <script>alert("the return of the xss")</script>'
+    ])->save();
+
+    $this->drupalGet('admin/structure/views/nojs/add-handler/content/default/field');
+    $this->assertEscaped('The <em>giraffe"</em> label <script>alert("the return of the xss")</script>');
+    $this->assertEscaped('Appears in: page, article. Also known as: Content: The giraffe" label');
+  }
+
+  /**
+   * Tests broken handlers.
+   */
+  public function testBrokenHandlers() {
+    $handler_types = ViewExecutable::getHandlerTypes();
+    foreach ($handler_types as $type => $type_info) {
+      $this->drupalGet('admin/structure/views/view/test_view_broken/edit');
+
+      $href = "admin/structure/views/nojs/handler/test_view_broken/default/$type/id_broken";
+
+      $result = $this->xpath('//a[contains(@href, :href)]', [':href' => $href]);
+      $this->assertEqual(count($result), 1, SafeMarkup::format('Handler (%type) edit link found.', ['%type' => $type]));
+
+      $text = 'Broken/missing handler';
+
+      $this->assertIdentical((string) $result[0], $text, 'Ensure the broken handler text was found.');
+
+      $this->drupalGet($href);
+      $result = $this->xpath('//h1[@class="page-title"]');
+      $this->assertTrue(strpos((string) $result[0], $text) !== FALSE, 'Ensure the broken handler text was found.');
+
+      $original_configuration = [
+        'field' => 'id_broken',
+        'id' => 'id_broken',
+        'relationship' => 'none',
+        'table' => 'views_test_data',
+        'plugin_id' => 'numeric',
+      ];
+
+      foreach ($original_configuration as $key => $value) {
+        $this->assertText(SafeMarkup::format('@key: @value', ['@key' => $key, '@value' => $value]));
+      }
+    }
+  }
+
+  /**
+   * Ensures that neither node type or node ID appears multiple times.
+   *
+   * @see \Drupal\views\EntityViewsData
+   */
+  public function testNoDuplicateFields() {
+    $handler_types = ['field', 'filter', 'sort', 'argument'];
+
+    foreach ($handler_types as $handler_type) {
+      $add_handler_url = 'admin/structure/views/nojs/add-handler/test_node_view/default/' . $handler_type;
+      $this->drupalGet($add_handler_url);
+
+      $this->assertNoDuplicateField('ID', 'Content');
+      $this->assertNoDuplicateField('ID', 'Content revision');
+      $this->assertNoDuplicateField('Content type', 'Content');
+      $this->assertNoDuplicateField('UUID', 'Content');
+      $this->assertNoDuplicateField('Revision ID', 'Content');
+      $this->assertNoDuplicateField('Revision ID', 'Content revision');
+    }
+  }
+
+  /**
+   * Ensures that no missing help text is shown.
+   *
+   * @see \Drupal\views\EntityViewsData
+   */
+  public function testErrorMissingHelp() {
+    // Test that the error message is not shown for entity fields but an empty
+    // description field is shown instead.
+    $this->drupalGet('admin/structure/views/nojs/add-handler/test_node_view/default/field');
+    $this->assertNoText('Error: missing help');
+    $this->assertRaw('<td class="description"></td>', 'Empty description found');
+
+    // Test that no error message is shown for other fields.
+    $this->drupalGet('admin/structure/views/nojs/add-handler/test_view_empty/default/field');
+    $this->assertNoText('Error: missing help');
+  }
+
+  /**
+   * Asserts that fields only appear once.
+   *
+   * @param string $field_name
+   *   The field name.
+   * @param string $entity_type
+   *   The entity type to which the field belongs.
+   */
+  public function assertNoDuplicateField($field_name, $entity_type) {
+    $elements = $this->xpath('//td[.=:entity_type]/preceding-sibling::td[@class="title" and .=:title]', [':title' => $field_name, ':entity_type' => $entity_type]);
+    $this->assertEqual(1, count($elements), $field_name . ' appears just once in ' . $entity_type . '.');
+  }
+
+}