SelectExtenderTest.php

<?php

declare (strict_types=1);
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 static 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\\core_fake\\Driver\\Database\\CoreFakeWithAllCustomClasses\\PagerSelectExtender',
                'Drupal\\core_fake\\Driver\\Database\\CoreFakeWithAllCustomClasses',
                'Drupal\\Core\\Database\\Query\\PagerSelectExtender',
            ],
            [
                'Drupal\\core_fake\\Driver\\Database\\CoreFakeWithAllCustomClasses\\PagerSelectExtender',
                'Drupal\\core_fake\\Driver\\Database\\CoreFakeWithAllCustomClasses',
                '\\Drupal\\Core\\Database\\Query\\PagerSelectExtender',
            ],
            [
                'Drupal\\core_fake\\Driver\\Database\\CoreFakeWithAllCustomClasses\\TableSortExtender',
                'Drupal\\core_fake\\Driver\\Database\\CoreFakeWithAllCustomClasses',
                'Drupal\\Core\\Database\\Query\\TableSortExtender',
            ],
            [
                'Drupal\\core_fake\\Driver\\Database\\CoreFakeWithAllCustomClasses\\TableSortExtender',
                'Drupal\\core_fake\\Driver\\Database\\CoreFakeWithAllCustomClasses',
                '\\Drupal\\Core\\Database\\Query\\TableSortExtender',
            ],
            [
                'Drupal\\core_fake\\Driver\\Database\\CoreFakeWithAllCustomClasses\\SearchQuery',
                'Drupal\\core_fake\\Driver\\Database\\CoreFakeWithAllCustomClasses',
                'Drupal\\search\\SearchQuery',
            ],
            [
                'Drupal\\core_fake\\Driver\\Database\\CoreFakeWithAllCustomClasses\\SearchQuery',
                'Drupal\\core_fake\\Driver\\Database\\CoreFakeWithAllCustomClasses',
                '\\Drupal\\search\\SearchQuery',
            ],
            [
                'Drupal\\core_fake\\Driver\\Database\\CoreFakeWithAllCustomClasses\\ViewsSearchQuery',
                'Drupal\\core_fake\\Driver\\Database\\CoreFakeWithAllCustomClasses',
                'Drupal\\search\\ViewsSearchQuery',
            ],
            [
                'Drupal\\core_fake\\Driver\\Database\\CoreFakeWithAllCustomClasses\\ViewsSearchQuery',
                'Drupal\\core_fake\\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\\core_fake\\Driver\\Database\\coreFake\\", __DIR__ . "/../../../../../tests/fixtures/database_drivers/module/core_fake/src/Driver/Database/CoreFake");
        $additional_class_loader->addPsr4("Drupal\\core_fake\\Driver\\Database\\CoreFakeWithAllCustomClasses\\", __DIR__ . "/../../../../../tests/fixtures/database_drivers/module/core_fake/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));
    }

}