SelectExtenderTest.php in Drupal 10

Namespace

Drupal\KernelTests\Core\Database

File

core/tests/Drupal/KernelTests/Core/Database/SelectExtenderTest.php

<?php

namespace Drupal\KernelTests\Core\Database;

use Composer\Autoload\ClassLoader;
use Drupal\Core\Database\Query\SelectExtender;
use Drupal\KernelTests\KernelTestBase;
use Drupal\Tests\Core\Database\Stub\StubConnection;
use Drupal\Tests\Core\Database\Stub\StubPDO;

/**
 * Tests the Select query extender classes.
 *
 * @coversDefaultClass \Drupal\Core\Database\Query\Select
 * @group Database
 */
class SelectExtenderTest extends KernelTestBase {

  /**
   * Data provider for testExtend().
   *
   * @return array
   *   Array of arrays with the following elements:
   *   - Expected namespaced class name.
   *   - The database driver namespace.
   *   - The namespaced class name for which to extend.
   */
  public function providerExtend() : array {
    return [
      [
        'Drupal\\Core\\Database\\Query\\PagerSelectExtender',
        'Drupal\\corefake\\Driver\\Database\\corefake',
        'Drupal\\Core\\Database\\Query\\PagerSelectExtender',
      ],
      [
        'Drupal\\Core\\Database\\Query\\PagerSelectExtender',
        'Drupal\\corefake\\Driver\\Database\\corefake',
        '\\Drupal\\Core\\Database\\Query\\PagerSelectExtender',
      ],
      [
        'Drupal\\Core\\Database\\Query\\TableSortExtender',
        'Drupal\\corefake\\Driver\\Database\\corefake',
        'Drupal\\Core\\Database\\Query\\TableSortExtender',
      ],
      [
        'Drupal\\Core\\Database\\Query\\TableSortExtender',
        'Drupal\\corefake\\Driver\\Database\\corefake',
        '\\Drupal\\Core\\Database\\Query\\TableSortExtender',
      ],
      [
        'Drupal\\search\\SearchQuery',
        'Drupal\\corefake\\Driver\\Database\\corefake',
        'Drupal\\search\\SearchQuery',
      ],
      [
        'Drupal\\search\\SearchQuery',
        'Drupal\\corefake\\Driver\\Database\\corefake',
        '\\Drupal\\search\\SearchQuery',
      ],
      [
        'Drupal\\search\\ViewsSearchQuery',
        'Drupal\\corefake\\Driver\\Database\\corefake',
        'Drupal\\search\\ViewsSearchQuery',
      ],
      [
        'Drupal\\search\\ViewsSearchQuery',
        'Drupal\\corefake\\Driver\\Database\\corefake',
        '\\Drupal\\search\\ViewsSearchQuery',
      ],
      [
        'Drupal\\corefake\\Driver\\Database\\corefakeWithAllCustomClasses\\PagerSelectExtender',
        'Drupal\\corefake\\Driver\\Database\\corefakeWithAllCustomClasses',
        'Drupal\\Core\\Database\\Query\\PagerSelectExtender',
      ],
      [
        'Drupal\\corefake\\Driver\\Database\\corefakeWithAllCustomClasses\\PagerSelectExtender',
        'Drupal\\corefake\\Driver\\Database\\corefakeWithAllCustomClasses',
        '\\Drupal\\Core\\Database\\Query\\PagerSelectExtender',
      ],
      [
        'Drupal\\corefake\\Driver\\Database\\corefakeWithAllCustomClasses\\TableSortExtender',
        'Drupal\\corefake\\Driver\\Database\\corefakeWithAllCustomClasses',
        'Drupal\\Core\\Database\\Query\\TableSortExtender',
      ],
      [
        'Drupal\\corefake\\Driver\\Database\\corefakeWithAllCustomClasses\\TableSortExtender',
        'Drupal\\corefake\\Driver\\Database\\corefakeWithAllCustomClasses',
        '\\Drupal\\Core\\Database\\Query\\TableSortExtender',
      ],
      [
        'Drupal\\corefake\\Driver\\Database\\corefakeWithAllCustomClasses\\SearchQuery',
        'Drupal\\corefake\\Driver\\Database\\corefakeWithAllCustomClasses',
        'Drupal\\search\\SearchQuery',
      ],
      [
        'Drupal\\corefake\\Driver\\Database\\corefakeWithAllCustomClasses\\SearchQuery',
        'Drupal\\corefake\\Driver\\Database\\corefakeWithAllCustomClasses',
        '\\Drupal\\search\\SearchQuery',
      ],
      [
        'Drupal\\corefake\\Driver\\Database\\corefakeWithAllCustomClasses\\ViewsSearchQuery',
        'Drupal\\corefake\\Driver\\Database\\corefakeWithAllCustomClasses',
        'Drupal\\search\\ViewsSearchQuery',
      ],
      [
        'Drupal\\corefake\\Driver\\Database\\corefakeWithAllCustomClasses\\ViewsSearchQuery',
        'Drupal\\corefake\\Driver\\Database\\corefakeWithAllCustomClasses',
        '\\Drupal\\search\\ViewsSearchQuery',
      ],
    ];
  }

  /**
   * @covers ::extend
   * @covers \Drupal\Core\Database\Query\SelectExtender::extend
   * @dataProvider providerExtend
   */
  public function testExtend(string $expected, string $namespace, string $extend) : void {
    $additional_class_loader = new ClassLoader();
    $additional_class_loader
      ->addPsr4("Drupal\\corefake\\Driver\\Database\\corefake\\", __DIR__ . "/../../../../../tests/fixtures/database_drivers/module/corefake/src/Driver/Database/corefake");
    $additional_class_loader
      ->addPsr4("Drupal\\corefake\\Driver\\Database\\corefakeWithAllCustomClasses\\", __DIR__ . "/../../../../../tests/fixtures/database_drivers/module/corefake/src/Driver/Database/corefakeWithAllCustomClasses");
    $additional_class_loader
      ->register(TRUE);
    $mock_pdo = $this
      ->createMock(StubPDO::class);
    $connection = new StubConnection($mock_pdo, [
      'namespace' => $namespace,
    ]);

    // Tests the method \Drupal\Core\Database\Query\Select::extend().
    $select = $connection
      ->select('test')
      ->extend($extend);
    $this
      ->assertEquals($expected, get_class($select));

    // Get an instance of the class \Drupal\Core\Database\Query\SelectExtender.
    $select_extender = $connection
      ->select('test')
      ->extend(SelectExtender::class);
    $this
      ->assertEquals(SelectExtender::class, get_class($select_extender));

    // Tests the method \Drupal\Core\Database\Query\SelectExtender::extend().
    $select_extender_extended = $select_extender
      ->extend($extend);
    $this
      ->assertEquals($expected, get_class($select_extender_extended));
  }

}

Classes

Name	Description
SelectExtenderTest	Tests the Select query extender classes.