Doctrine\Tests\ORM\ConfigurationTest

Complexity

Total Complexity

35

Size/Duplication

Total Lines	387
Duplicated Lines	0 %

Importance

Changes	2
Bugs	0	Features	0

33 Methods

Rating	Name	Duplication	Size	Complexity
A	testSetGetMetadataDriverImpl()	0	7	1
A	testNewDefaultAnnotationDriver()	0	13	1
A	setUp()	0	4	1
A	testSetGetEntityListenerResolver()	0	10	1
A	testAddGetNamedQuery()	0	8	1
A	testAddGetFilters()	0	7	1
A	testSetGetNamingStrategy()	0	9	1
A	testAddGetCustomDatetimeFunction()	0	10	1
A	testSetCustomHydrationModes()	0	14	1
A	testSetGetQueryCacheImpl()	0	6	1
A	makeTemporaryValidDirectory()	0	8	1
A	testEnsureProductionSettingsQueryArrayCache()	0	9	1
A	testAddGetCustomStringFunction()	0	10	1
A	setProductionSettings()	0	12	3
A	testAddGetCustomNumericFunction()	0	10	1
A	testSetGetClassMetadataFactoryName()	0	7	1
A	testEnsureProductionSettings()	0	6	1
A	testProxyManagerConfigurationWillBeUpdatedWithCorrectGeneratorStrategies()	0	9	1
B	expectedGeneratorStrategies()	0	26	1
A	testProxyManagerConfigurationContainsGivenProxyTargetDir()	0	6	1
A	testEnsureProductionSettingsMetadataCache()	0	8	1
A	testEnsureProductionSettingsMetadataArrayCache()	0	9	1
A	testSetGetHydrationCacheImpl()	0	6	1
A	testWillProduceGhostObjectFactory()	0	12	1
A	testEnsureProductionSettingsAutoGenerateProxyClassesEval()	0	9	1
A	setDefaultRepositoryClassName()	0	10	1
A	testAddGetCustomHydrationMode()	0	7	1
A	testSetGetSecondLevelCacheConfig()	0	7	1
A	testProxyManagerConfigurationContainsGivenProxyNamespace()	0	6	1
A	testEnsureProductionSettingsQueryCache()	0	8	1
A	testAddGetNamedNativeQuery()	0	11	1
A	testSetGetMetadataCacheImpl()	0	6	1
A	testGetProxyManagerConfiguration()	0	5	1

<?php

declare(strict_types=1);

namespace Doctrine\Tests\ORM;

use Doctrine\Common\Cache\ArrayCache;
use Doctrine\Common\Cache\Cache;
use Doctrine\Common\Proxy\AbstractProxyFactory;
use Doctrine\ORM\Annotation as AnnotationNamespace;
use Doctrine\ORM\Cache\CacheConfiguration;
use Doctrine\ORM\Configuration;
use Doctrine\ORM\EntityRepository;
use Doctrine\ORM\Mapping\ClassMetadataFactory;
use Doctrine\ORM\Mapping\DefaultEntityListenerResolver;
use Doctrine\ORM\Mapping\Driver\MappingDriver;
use Doctrine\ORM\Mapping\EntityListenerResolver;
use Doctrine\ORM\Mapping\Factory\NamingStrategy;
use Doctrine\ORM\ORMException;
use Doctrine\ORM\Proxy\Factory\StaticProxyFactory;
use Doctrine\ORM\Query\ResultSetMapping;
use Doctrine\Tests\DoctrineTestCase;
use Doctrine\Tests\Models\DDC753\DDC753CustomRepository;
use ProxyManager\GeneratorStrategy\EvaluatingGeneratorStrategy;
use ProxyManager\GeneratorStrategy\FileWriterGeneratorStrategy;
use ReflectionClass;

/**
 * Tests for the Configuration object
 * @author Marco Pivetta <ocramius@gmail.com>
 */
class ConfigurationTest extends DoctrineTestCase
{
    /**
     * @var Configuration
     */
    private $configuration;

    protected function setUp()
    {
        parent::setUp();
        $this->configuration = new Configuration();
    }

    public function testSetGetMetadataDriverImpl()
    {
        self::assertNull($this->configuration->getMetadataDriverImpl()); // defaults

        $metadataDriver = $this->createMock(MappingDriver::class);
        $this->configuration->setMetadataDriverImpl($metadataDriver);
        self::assertSame($metadataDriver, $this->configuration->getMetadataDriverImpl());
    }

    public function testNewDefaultAnnotationDriver()
    {
        $paths = [__DIR__];
        $reflectionClass = new ReflectionClass(ConfigurationTestAnnotationReaderChecker::class);

        $annotationDriver = $this->configuration->newDefaultAnnotationDriver($paths);
        $reader = $annotationDriver->getReader();
        $annotation = $reader->getMethodAnnotation(
            $reflectionClass->getMethod('annotatedMethod'),
            AnnotationNamespace\PrePersist::class
        );

        self::assertInstanceOf(AnnotationNamespace\PrePersist::class, $annotation);
    }

    public function testSetGetQueryCacheImpl()
    {
        self::assertNull($this->configuration->getQueryCacheImpl()); // defaults
        $queryCacheImpl = $this->createMock(Cache::class);
        $this->configuration->setQueryCacheImpl($queryCacheImpl);
        self::assertSame($queryCacheImpl, $this->configuration->getQueryCacheImpl());
    }

    public function testSetGetHydrationCacheImpl()
    {
        self::assertNull($this->configuration->getHydrationCacheImpl()); // defaults
        $queryCacheImpl = $this->createMock(Cache::class);
        $this->configuration->setHydrationCacheImpl($queryCacheImpl);
        self::assertSame($queryCacheImpl, $this->configuration->getHydrationCacheImpl());
    }

    public function testSetGetMetadataCacheImpl()
    {
        self::assertNull($this->configuration->getMetadataCacheImpl()); // defaults
        $queryCacheImpl = $this->createMock(Cache::class);
        $this->configuration->setMetadataCacheImpl($queryCacheImpl);
        self::assertSame($queryCacheImpl, $this->configuration->getMetadataCacheImpl());
    }

    public function testAddGetNamedQuery()
    {
        $dql = 'SELECT u FROM User u';
        $this->configuration->addNamedQuery('QueryName', $dql);
        self::assertSame($dql, $this->configuration->getNamedQuery('QueryName'));
        $this->expectException(ORMException::class);
        $this->expectExceptionMessage('a named query');
        $this->configuration->getNamedQuery('NonExistingQuery');
    }

    public function testAddGetNamedNativeQuery()
    {
        $sql = 'SELECT * FROM user';
        $rsm = $this->createMock(ResultSetMapping::class);
        $this->configuration->addNamedNativeQuery('QueryName', $sql, $rsm);
        $fetched = $this->configuration->getNamedNativeQuery('QueryName');
        self::assertSame($sql, $fetched[0]);
        self::assertSame($rsm, $fetched[1]);
        $this->expectException(ORMException::class);
        $this->expectExceptionMessage('a named native query');
        $this->configuration->getNamedNativeQuery('NonExistingQuery');
    }

    /**
     * Configures $this->configuration to use production settings.
     *
     * @param string $skipCache Do not configure a cache of this type, either "query" or "metadata".
     */
    protected function setProductionSettings($skipCache = false)
    {
        $this->configuration->setAutoGenerateProxyClasses(AbstractProxyFactory::AUTOGENERATE_FILE_NOT_EXISTS);

        $cache = $this->createMock(Cache::class);

        if ('query' !== $skipCache) {
            $this->configuration->setQueryCacheImpl($cache);
        }

        if ('metadata' !== $skipCache) {
            $this->configuration->setMetadataCacheImpl($cache);
        }
    }

    public function testEnsureProductionSettings()
    {
        $this->setProductionSettings();
        $this->configuration->ensureProductionSettings();

        self::addToAssertionCount(1);

The method PHPUnit\Framework\TestCase::addToAssertionCount() is not static, but was called statically.

    }

    public function testEnsureProductionSettingsQueryCache()
    {
        $this->setProductionSettings('query');

        $this->expectException(ORMException::class);
        $this->expectExceptionMessage('Query Cache is not configured.');

        $this->configuration->ensureProductionSettings();
    }

    public function testEnsureProductionSettingsMetadataCache()
    {
        $this->setProductionSettings('metadata');

        $this->expectException(ORMException::class);
        $this->expectExceptionMessage('Metadata Cache is not configured.');

        $this->configuration->ensureProductionSettings();
    }

    public function testEnsureProductionSettingsQueryArrayCache()
    {
        $this->setProductionSettings();
        $this->configuration->setQueryCacheImpl(new ArrayCache());

        $this->expectException(ORMException::class);
        $this->expectExceptionMessage('Query Cache uses a non-persistent cache driver, Doctrine\Common\Cache\ArrayCache.');

        $this->configuration->ensureProductionSettings();
    }

    public function testEnsureProductionSettingsMetadataArrayCache()
    {
        $this->setProductionSettings();
        $this->configuration->setMetadataCacheImpl(new ArrayCache());

        $this->expectException(ORMException::class);
        $this->expectExceptionMessage('Metadata Cache uses a non-persistent cache driver, Doctrine\Common\Cache\ArrayCache.');

        $this->configuration->ensureProductionSettings();
    }

    public function testEnsureProductionSettingsAutoGenerateProxyClassesEval()
    {
        $this->setProductionSettings();
        $this->configuration->setAutoGenerateProxyClasses(AbstractProxyFactory::AUTOGENERATE_EVAL);

        $this->expectException(ORMException::class);
        $this->expectExceptionMessage('Proxy Classes are always regenerating.');

        $this->configuration->ensureProductionSettings();
    }

    public function testAddGetCustomStringFunction()
    {
        $this->configuration->addCustomStringFunction('FunctionName', __CLASS__);

        self::assertSame(__CLASS__, $this->configuration->getCustomStringFunction('FunctionName'));
        self::assertNull($this->configuration->getCustomStringFunction('NonExistingFunction'));

        $this->configuration->setCustomStringFunctions(['OtherFunctionName' => __CLASS__]);

        self::assertSame(__CLASS__, $this->configuration->getCustomStringFunction('OtherFunctionName'));
    }

    public function testAddGetCustomNumericFunction()
    {
        $this->configuration->addCustomNumericFunction('FunctionName', __CLASS__);

        self::assertSame(__CLASS__, $this->configuration->getCustomNumericFunction('FunctionName'));
        self::assertNull($this->configuration->getCustomNumericFunction('NonExistingFunction'));

        $this->configuration->setCustomNumericFunctions(['OtherFunctionName' => __CLASS__]);

        self::assertSame(__CLASS__, $this->configuration->getCustomNumericFunction('OtherFunctionName'));
    }

    public function testAddGetCustomDatetimeFunction()
    {
        $this->configuration->addCustomDatetimeFunction('FunctionName', __CLASS__);

        self::assertSame(__CLASS__, $this->configuration->getCustomDatetimeFunction('FunctionName'));
        self::assertNull($this->configuration->getCustomDatetimeFunction('NonExistingFunction'));

        $this->configuration->setCustomDatetimeFunctions(['OtherFunctionName' => __CLASS__]);

        self::assertSame(__CLASS__, $this->configuration->getCustomDatetimeFunction('OtherFunctionName'));
    }

    public function testAddGetCustomHydrationMode()
    {
        self::assertNull($this->configuration->getCustomHydrationMode('NonExisting'));

        $this->configuration->addCustomHydrationMode('HydrationModeName', __CLASS__);

        self::assertSame(__CLASS__, $this->configuration->getCustomHydrationMode('HydrationModeName'));
    }

    public function testSetCustomHydrationModes()
    {
        $this->configuration->addCustomHydrationMode('HydrationModeName', __CLASS__);

        self::assertSame(__CLASS__, $this->configuration->getCustomHydrationMode('HydrationModeName'));

        $this->configuration->setCustomHydrationModes(
            [
                'AnotherHydrationModeName' => __CLASS__
            ]
        );

        self::assertNull($this->configuration->getCustomHydrationMode('HydrationModeName'));
        self::assertSame(__CLASS__, $this->configuration->getCustomHydrationMode('AnotherHydrationModeName'));
    }

    public function testSetGetClassMetadataFactoryName()
    {
        self::assertSame(ClassMetadataFactory::class, $this->configuration->getClassMetadataFactoryName());

        $this->configuration->setClassMetadataFactoryName(__CLASS__);

        self::assertSame(__CLASS__, $this->configuration->getClassMetadataFactoryName());
    }

    public function testAddGetFilters()
    {
        self::assertNull($this->configuration->getFilterClassName('NonExistingFilter'));

        $this->configuration->addFilter('FilterName', __CLASS__);

        self::assertSame(__CLASS__, $this->configuration->getFilterClassName('FilterName'));
    }

    public function setDefaultRepositoryClassName()
    {
        self::assertSame(EntityRepository::class, $this->configuration->getDefaultRepositoryClassName());

        $this->configuration->setDefaultRepositoryClassName(DDC753CustomRepository::class);

        self::assertSame(DDC753CustomRepository::class, $this->configuration->getDefaultRepositoryClassName());

        $this->expectException(ORMException::class);
        $this->configuration->setDefaultRepositoryClassName(__CLASS__);
    }

    public function testSetGetNamingStrategy()
    {
        self::assertInstanceOf(NamingStrategy::class, $this->configuration->getNamingStrategy());

        $namingStrategy = $this->createMock(NamingStrategy::class);

        $this->configuration->setNamingStrategy($namingStrategy);

        self::assertSame($namingStrategy, $this->configuration->getNamingStrategy());
    }

    /**
     * @group DDC-1955
     */
    public function testSetGetEntityListenerResolver()
    {
        self::assertInstanceOf(EntityListenerResolver::class, $this->configuration->getEntityListenerResolver());
        self::assertInstanceOf(DefaultEntityListenerResolver::class, $this->configuration->getEntityListenerResolver());

        $resolver = $this->createMock(EntityListenerResolver::class);

        $this->configuration->setEntityListenerResolver($resolver);

        self::assertSame($resolver, $this->configuration->getEntityListenerResolver());
    }

    /**
     * @group DDC-2183
     */
    public function testSetGetSecondLevelCacheConfig()
    {
        $mockClass = $this->createMock(CacheConfiguration::class);

        self::assertNull($this->configuration->getSecondLevelCacheConfiguration());
        $this->configuration->setSecondLevelCacheConfiguration($mockClass);
        self::assertEquals($mockClass, $this->configuration->getSecondLevelCacheConfiguration());
    }

    public function testGetProxyManagerConfiguration() : void
    {
        self::assertInstanceOf(
            \ProxyManager\Configuration::class,
            $this->configuration->getProxyManagerConfiguration()
        );
    }

    public function testProxyManagerConfigurationContainsGivenProxyTargetDir() : void
    {
        $proxyPath = $this->makeTemporaryValidDirectory();

        $this->configuration->setProxyDir($proxyPath);
        self::assertSame($proxyPath, $this->configuration->getProxyManagerConfiguration()->getProxiesTargetDir());
    }

    public function testProxyManagerConfigurationContainsGivenProxyNamespace() : void
    {
        $namespace = \str_replace('.', '', \uniqid('Namespace', true));

        $this->configuration->setProxyNamespace($namespace);
        self::assertSame($namespace, $this->configuration->getProxyManagerConfiguration()->getProxiesNamespace());
    }

    /**
     * @dataProvider expectedGeneratorStrategies
     *
     * @param int|bool $proxyAutoGenerateFlag
     */
    public function testProxyManagerConfigurationWillBeUpdatedWithCorrectGeneratorStrategies(
        $proxyAutoGenerateFlag,
        string $expectedGeneratorStrategy
    ) : void {
        $this->configuration->setAutoGenerateProxyClasses($proxyAutoGenerateFlag);

        self::assertInstanceOf(
            $expectedGeneratorStrategy,
            $this->configuration->getProxyManagerConfiguration()->getGeneratorStrategy()
        );
    }

    public function expectedGeneratorStrategies() : array
    {
        return [
            [
                StaticProxyFactory::AUTOGENERATE_NEVER,
                EvaluatingGeneratorStrategy::class,
            ],
            [
                StaticProxyFactory::AUTOGENERATE_EVAL,
                EvaluatingGeneratorStrategy::class,
            ],
            [
                false,
                EvaluatingGeneratorStrategy::class,
            ],
            [
                StaticProxyFactory::AUTOGENERATE_ALWAYS,
                FileWriterGeneratorStrategy::class,
            ],
            [
                StaticProxyFactory::AUTOGENERATE_FILE_NOT_EXISTS,
                FileWriterGeneratorStrategy::class,
            ],
            [
                true,
                FileWriterGeneratorStrategy::class,
            ],
        ];
    }

    private function makeTemporaryValidDirectory() : string
    {
        $path = \tempnam(\sys_get_temp_dir(), 'ProxyConfigurationTest');

        unlink($path);
        mkdir($path);

        return $path;
    }

    public function testWillProduceGhostObjectFactory() : void
    {
        $factory1 = $this->configuration->buildGhostObjectFactory();
        $factory2 = $this->configuration->buildGhostObjectFactory();

        $this->configuration->setProxyDir($this->makeTemporaryValidDirectory());

        $factory3 = $this->configuration->buildGhostObjectFactory();

        self::assertNotSame($factory1, $factory2);
        self::assertEquals($factory1, $factory2);
        self::assertNotEquals($factory2, $factory3);
    }
}

class ConfigurationTestAnnotationReaderChecker
{
    /** @AnnotationNamespace\PrePersist */
    public function annotatedMethod()
    {
    }
}