Version 1
[yaffs-website] / web / core / modules / views / tests / src / Kernel / Plugin / JoinTest.php
diff --git a/web/core/modules/views/tests/src/Kernel/Plugin/JoinTest.php b/web/core/modules/views/tests/src/Kernel/Plugin/JoinTest.php
new file mode 100644 (file)
index 0000000..0839fcb
--- /dev/null
@@ -0,0 +1,207 @@
+<?php
+
+namespace Drupal\Tests\views\Kernel\Plugin;
+
+use Drupal\views_test_data\Plugin\views\join\JoinTest as JoinTestPlugin;
+use Drupal\views\Plugin\views\join\JoinPluginBase;
+use Drupal\views\Views;
+
+
+/**
+ * Tests the join plugin.
+ *
+ * @group views
+ * @see \Drupal\views_test_data\Plugin\views\join\JoinTest
+ * @see \Drupal\views\Plugin\views\join\JoinPluginBase
+ */
+class JoinTest extends RelationshipJoinTestBase {
+
+  /**
+   * Views used by this test.
+   *
+   * @var array
+   */
+  public static $testViews = ['test_view'];
+
+  /**
+   * A plugin manager which handlers the instances of joins.
+   *
+   * @var \Drupal\views\Plugin\ViewsPluginManager
+   */
+  protected $manager;
+
+  protected function setUp($import_test_views = TRUE) {
+    parent::setUp();
+
+    // Add a join plugin manager which can be used in all of the tests.
+    $this->manager = $this->container->get('plugin.manager.views.join');
+  }
+
+  /**
+   * Tests an example join plugin.
+   */
+  public function testExamplePlugin() {
+
+    // Setup a simple join and test the result sql.
+    $view = Views::getView('test_view');
+    $view->initDisplay();
+    $view->initQuery();
+
+    $configuration = [
+      'left_table' => 'views_test_data',
+      'left_field' => 'uid',
+      'table' => 'users_field_data',
+      'field' => 'uid',
+    ];
+    $join = $this->manager->createInstance('join_test', $configuration);
+    $this->assertTrue($join instanceof JoinTestPlugin, 'The correct join class got loaded.');
+
+    $rand_int = rand(0, 1000);
+    $join->setJoinValue($rand_int);
+
+    $query = db_select('views_test_data');
+    $table = ['alias' => 'users_field_data'];
+    $join->buildJoin($query, $table, $view->query);
+
+    $tables = $query->getTables();
+    $join_info = $tables['users_field_data'];
+    $this->assertTrue(strpos($join_info['condition'], "views_test_data.uid = $rand_int") !== FALSE, 'Make sure that the custom join plugin can extend the join base and alter the result.');
+  }
+
+  /**
+   * Tests the join plugin base.
+   */
+  public function testBasePlugin() {
+
+    // Setup a simple join and test the result sql.
+    $view = Views::getView('test_view');
+    $view->initDisplay();
+    $view->initQuery();
+
+    // First define a simple join without an extra condition.
+    // Set the various options on the join object.
+    $configuration = [
+      'left_table' => 'views_test_data',
+      'left_field' => 'uid',
+      'table' => 'users_field_data',
+      'field' => 'uid',
+      'adjusted' => TRUE,
+    ];
+    $join = $this->manager->createInstance('standard', $configuration);
+    $this->assertTrue($join instanceof JoinPluginBase, 'The correct join class got loaded.');
+    $this->assertNull($join->extra, 'The field extra was not overridden.');
+    $this->assertTrue($join->adjusted, 'The field adjusted was set correctly.');
+
+    // Build the actual join values and read them back from the dbtng query
+    // object.
+    $query = db_select('views_test_data');
+    $table = ['alias' => 'users_field_data'];
+    $join->buildJoin($query, $table, $view->query);
+
+    $tables = $query->getTables();
+    $join_info = $tables['users_field_data'];
+    $this->assertEqual($join_info['join type'], 'LEFT', 'Make sure the default join type is LEFT');
+    $this->assertEqual($join_info['table'], $configuration['table']);
+    $this->assertEqual($join_info['alias'], 'users_field_data');
+    $this->assertEqual($join_info['condition'], 'views_test_data.uid = users_field_data.uid');
+
+    // Set a different alias and make sure table info is as expected.
+    $join = $this->manager->createInstance('standard', $configuration);
+    $table = ['alias' => 'users1'];
+    $join->buildJoin($query, $table, $view->query);
+
+    $tables = $query->getTables();
+    $join_info = $tables['users1'];
+    $this->assertEqual($join_info['alias'], 'users1');
+
+    // Set a different join type (INNER) and make sure it is used.
+    $configuration['type'] = 'INNER';
+    $join = $this->manager->createInstance('standard', $configuration);
+    $table = ['alias' => 'users2'];
+    $join->buildJoin($query, $table, $view->query);
+
+    $tables = $query->getTables();
+    $join_info = $tables['users2'];
+    $this->assertEqual($join_info['join type'], 'INNER');
+
+    // Setup addition conditions and make sure it is used.
+    $random_name_1 = $this->randomMachineName();
+    $random_name_2 = $this->randomMachineName();
+    $configuration['extra'] = [
+      [
+        'field' => 'name',
+        'value' => $random_name_1
+      ],
+      [
+        'field' => 'name',
+        'value' => $random_name_2,
+        'operator' => '<>'
+      ],
+    ];
+    $join = $this->manager->createInstance('standard', $configuration);
+    $table = ['alias' => 'users3'];
+    $join->buildJoin($query, $table, $view->query);
+
+    $tables = $query->getTables();
+    $join_info = $tables['users3'];
+    $this->assertTrue(strpos($join_info['condition'], "views_test_data.uid = users3.uid") !== FALSE, 'Make sure the join condition appears in the query.');
+    $this->assertTrue(strpos($join_info['condition'], "users3.name = :views_join_condition_0") !== FALSE, 'Make sure the first extra join condition appears in the query and uses the first placeholder.');
+    $this->assertTrue(strpos($join_info['condition'], "users3.name <> :views_join_condition_1") !== FALSE, 'Make sure the second extra join condition appears in the query and uses the second placeholder.');
+    $this->assertEqual(array_values($join_info['arguments']), [$random_name_1, $random_name_2], 'Make sure the arguments are in the right order');
+
+    // Test that 'IN' conditions are properly built.
+    $random_name_1 = $this->randomMachineName();
+    $random_name_2 = $this->randomMachineName();
+    $random_name_3 = $this->randomMachineName();
+    $random_name_4 = $this->randomMachineName();
+    $configuration['extra'] = [
+      [
+        'field' => 'name',
+        'value' => $random_name_1
+      ],
+      [
+        'field' => 'name',
+        'value' => [$random_name_2, $random_name_3, $random_name_4],
+      ],
+    ];
+    $join = $this->manager->createInstance('standard', $configuration);
+    $table = ['alias' => 'users4'];
+    $join->buildJoin($query, $table, $view->query);
+
+    $tables = $query->getTables();
+    $join_info = $tables['users4'];
+    $this->assertTrue(strpos($join_info['condition'], "views_test_data.uid = users4.uid") !== FALSE, 'Make sure the join condition appears in the query.');
+    $this->assertTrue(strpos($join_info['condition'], "users4.name = :views_join_condition_2") !== FALSE, 'Make sure the first extra join condition appears in the query.');
+    $this->assertTrue(strpos($join_info['condition'], "users4.name IN ( :views_join_condition_3[] )") !== FALSE, 'The IN condition for the join is properly formed.');
+    $this->assertEqual($join_info['arguments'][':views_join_condition_3[]'], [$random_name_2, $random_name_3, $random_name_4], 'Make sure the IN arguments are still part of an array.');
+
+    // Test that all the conditions are properly built.
+    $configuration['extra'] = [
+      [
+        'field' => 'langcode',
+        'value' => 'en'
+      ],
+      [
+        'left_field' => 'status',
+        'value' => 0,
+        'numeric' => TRUE,
+      ],
+      [
+        'field' => 'name',
+        'left_field' => 'name'
+      ],
+    ];
+    $join = $this->manager->createInstance('standard', $configuration);
+    $table = ['alias' => 'users5'];
+    $join->buildJoin($query, $table, $view->query);
+
+    $tables = $query->getTables();
+    $join_info = $tables['users5'];
+    $this->assertTrue(strpos($join_info['condition'], "views_test_data.uid = users5.uid") !== FALSE, 'Make sure the join condition appears in the query.');
+    $this->assertTrue(strpos($join_info['condition'], "users5.langcode = :views_join_condition_4") !== FALSE, 'Make sure the first extra join condition appears in the query.');
+    $this->assertTrue(strpos($join_info['condition'], "views_test_data.status = :views_join_condition_5") !== FALSE, 'Make sure the second extra join condition appears in the query.');
+    $this->assertTrue(strpos($join_info['condition'], "users5.name = views_test_data.name") !== FALSE, 'Make sure the third extra join condition appears in the query.');
+    $this->assertEqual(array_values($join_info['arguments']), ['en', 0], 'Make sure the arguments are in the right order');
+  }
+
+}