BackendCompilerPassTest.php

<?php

declare (strict_types=1);
namespace Drupal\Tests\Core\DependencyInjection\Compiler;

use Drupal\Core\DependencyInjection\Compiler\BackendCompilerPass;
use Drupal\Tests\UnitTestCase;
use Symfony\Component\DependencyInjection\Alias;
use Symfony\Component\DependencyInjection\ContainerBuilder;
use Symfony\Component\DependencyInjection\Definition;

/**
 * @coversDefaultClass \Drupal\Core\DependencyInjection\Compiler\BackendCompilerPass
 * @group DependencyInjection
 */
class BackendCompilerPassTest extends UnitTestCase {
    
    /**
     * The tested backend compiler pass.
     *
     * @var \Drupal\Core\DependencyInjection\Compiler\BackendCompilerPass
     */
    protected $backendPass;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        $this->backendPass = new BackendCompilerPass();
    }
    
    /**
     * Tests the process method.
     *
     * @covers ::process
     */
    public function testProcess() : void {
        // Add a container with no set default_backend.
        $prefix = __NAMESPACE__ . '\\ServiceClass';
        $service = (new Definition($prefix . 'Default'))->addTag('backend_overridable');
        $container = $this->getMysqlContainer($service);
        $this->backendPass
            ->process($container);
        $this->assertEquals($prefix . 'Default', get_class($container->get('service')));
        // Set the default_backend so the mysql service should be used.
        $container = $this->getMysqlContainer($service);
        $container->setParameter('default_backend', 'mysql');
        $this->backendPass
            ->process($container);
        $this->assertEquals($prefix . 'Mysql', get_class($container->get('service')));
        // Configure a manual alias for the service, so ensure that it is not
        // overridden by the default backend.
        $container = $this->getMysqlContainer($service);
        $container->setParameter('default_backend', 'mysql');
        $container->setDefinition('mariadb.service', new Definition($prefix . 'MariaDb'));
        $container->setAlias('service', new Alias('mariadb.service'));
        $this->backendPass
            ->process($container);
        $this->assertEquals($prefix . 'MariaDb', get_class($container->get('service')));
        // Check the database driver is the default.
        $container = $this->getSqliteContainer($service);
        $this->backendPass
            ->process($container);
        $this->assertEquals($prefix . 'Sqlite', get_class($container->get('service')));
        // Test the opt out.
        $container = $this->getSqliteContainer($service);
        $container->setParameter('default_backend', '');
        $this->backendPass
            ->process($container);
        $this->assertEquals($prefix . 'Default', get_class($container->get('service')));
        // Set the mysql and the DrivertestMysql service, now the DrivertestMysql
        // service, as it is the driver override, should be used.
        $container = $this->getDrivertestMysqlContainer($service);
        $container->setDefinition('mysql.service', new Definition(__NAMESPACE__ . '\\ServiceClassMysql'));
        $container->setDefinition('DrivertestMysql.service', new Definition(__NAMESPACE__ . '\\ServiceClassDrivertestMysql'));
        $this->backendPass
            ->process($container);
        $this->assertEquals($prefix . 'DrivertestMysql', get_class($container->get('service')));
        // Set the mysql service, now the mysql service, as it is the database_type
        // override, should be used.
        $container = $this->getDrivertestMysqlContainer($service);
        $container->setDefinition('mysql.service', new Definition(__NAMESPACE__ . '\\ServiceClassMysql'));
        $this->backendPass
            ->process($container);
        $this->assertEquals($prefix . 'Mysql', get_class($container->get('service')));
        // Set the DrivertestMysql service, now the DrivertestMysql service, as it
        // is the driver override, should be used.
        $container = $this->getDrivertestMysqlContainer($service);
        $container->setDefinition('DrivertestMysql.service', new Definition(__NAMESPACE__ . '\\ServiceClassDrivertestMysql'));
        $this->backendPass
            ->process($container);
        $this->assertEquals($prefix . 'DrivertestMysql', get_class($container->get('service')));
    }
    
    /**
     * Creates a container with a sqlite database service in it.
     *
     * This is necessary because the container clone does not clone the parameter
     * bag so the setParameter() call effects the parent container as well.
     *
     * @param $service
     *   The service definition.
     *
     * @return \Symfony\Component\DependencyInjection\ContainerBuilder
     */
    protected function getSqliteContainer($service) {
        $container = new ContainerBuilder();
        $container->setDefinition('service', $service);
        $container->setDefinition('sqlite.service', new Definition(__NAMESPACE__ . '\\ServiceClassSqlite'));
        $mock = $this->getMockBuilder('Drupal\\sqlite\\Driver\\Database\\sqlite\\Connection')
            ->onlyMethods([])
            ->disableOriginalConstructor()
            ->getMock();
        $container->set('database', $mock);
        return $container;
    }
    
    /**
     * Creates a container with a mysql database service definition in it.
     *
     * This is necessary because the container clone does not clone the parameter
     * bag so the setParameter() call effects the parent container as well.
     *
     * @param $service
     *   The service definition.
     *
     * @return \Symfony\Component\DependencyInjection\ContainerBuilder
     */
    protected function getMysqlContainer($service) {
        $container = new ContainerBuilder();
        $container->setDefinition('service', $service);
        $container->setDefinition('mysql.service', new Definition(__NAMESPACE__ . '\\ServiceClassMysql'));
        return $container;
    }
    
    /**
     * Creates a container with a DrivertestMysql database mock definition in it.
     *
     * This is necessary because the container clone does not clone the parameter
     * bag so the setParameter() call effects the parent container as well.
     *
     * @param $service
     *   The service definition.
     *
     * @return \Symfony\Component\DependencyInjection\ContainerBuilder
     */
    protected function getDrivertestMysqlContainer($service) {
        $container = new ContainerBuilder();
        $container->setDefinition('service', $service);
        $mock = $this->getMockBuilder('Drupal\\driver_test\\Driver\\Database\\DrivertestMysql\\Connection')
            ->onlyMethods([])
            ->disableOriginalConstructor()
            ->getMock();
        $container->set('database', $mock);
        return $container;
    }

}
class ServiceClassDefault {

}
class ServiceClassMysql extends ServiceClassDefault {

}
class ServiceClassMariaDb extends ServiceClassMysql {

}
class ServiceClassSqlite extends ServiceClassDefault {

}
class ServiceClassDrivertestMysql extends ServiceClassDefault {

}