README

This library provides some infrastructure for tests of Doctrine ORM entities, featuring:

configuration of a SQLite in memory database, compromising well between speed and a database environment being both realistic and isolated
a mechanism for importing fixtures into your database that circumvents Doctrine's caching. This results in a more realistic test environment when loading entities from a repository.

We use it to test Doctrine repositories and entities in Symfony applications. It's a lightweight alternative to the heavyweight functional tests suggested in the Symfony documentation (we don't suggest you should skip those - we just want to open another path).

In non-application bundles, where functional tests are not possible, it is our only way to test repositories and entities.

Installation

Install via composer (see http://getcomposer.org/):

composer require --dev webfactory/doctrine-orm-test-infrastructure

Usage

<?php

use Doctrine\ORM\EntityManagerInterface;
use Entity\MyEntity;
use Entity\MyEntityRepository;
use PHPUnit\Framework\TestCase;
use Webfactory\Doctrine\ORMTestInfrastructure\ORMInfrastructure;

class MyEntityRepositoryTest extends TestCase
{
    private ORMInfrastructure $infrastructure;
    private MyEntityRepository $repository;

    protected function setUp(): void
    {
        /*
           This will create an in-memory SQLite database with the necessary schema
           for the MyEntity entity class and and everything reachable from it through
           associations.
        */
        $this->infrastructure = ORMInfrastructure::createWithDependenciesFor(MyEntity::class);
        $this->repository = $this->infrastructure->getRepository(MyEntity::class);
    }

    /**
     * Example test: Asserts imported fixtures are retrieved with findAll().
     */
    public function testFindAllRetrievesFixtures(): void
    {
        $myEntityFixture = new MyEntity();

        $this->infrastructure->import($myEntityFixture);
        $entitiesLoadedFromDatabase = $this->repository->findAll();

        /* 
            import() will use a dedicated entity manager, so imported entities do not
            end up in the identity map. But this also means loading entities from the
            database will create _different object instances_.

            So, this does not hold:
        */
        // self::assertContains($myEntityFixture, $entitiesLoadedFromDatabase);

        // But you can do things like this (you probably want to extract that in a convenient assertion method):
        self::assertCount(1, $entitiesLoadedFromDatabase);
        $entityLoadedFromDatabase = $entitiesLoadedFromDatabase[0];
        self::assertSame($myEntityFixture->getId(), $entityLoadedFromDatabase->getId());
    }

    /**
     * Example test for retrieving Doctrine's entity manager.
     */
    public function testSomeFancyThingWithEntityManager(): void
    {
        $entityManager = $this->infrastructure->getEntityManager();
        // ...
    }
}

Migrating to attribute-based mapping configuration

The ORMInfrastructure::createWithDependenciesFor() and ``ORMInfrastructure::createOnlyFor()` methods by default assume that the Doctrine ORM mapping is provided through annotations. This has been deprecated in Doctrine ORM 2.x and is no longer be supported in ORM 3.0.

To allow for a seamless transition towards attribute-based or other types of mapping, a mapping driver can be passed when creating instances of the ORMInfrastructure.

If you wish to switch to attribute-based mappings, pass a new \Doctrine\ORM\Mapping\Driver\AttributeDriver($paths), where $paths is an array of directory paths where your entity classes are stored.

For hybrid (annotations and attributes) mapping configurations, you can use \Doctrine\Persistence\Mapping\Driver\MappingDriverChain. Multiple mapping drivers can be registered on the driver chain by providing namespace prefixes. For every namespace prefix, only one mapping driver can be used.

Testing the library itself

After installing the dependencies managed via composer, just run

vendor/bin/phpunit

from the library's root folder. This uses the shipped phpunit.xml.dist - feel free to create your own phpunit.xml if you need local changes.

Happy testing!

Changelog

1.5.0 -> 1.5.1

Clear entity manager after import to avoid problems with entities detected by cascade operations (#23)
Use separate entity managers for imports to avoid interference between import and test phase (#2)
Deprecated internal class \Webfactory\Doctrine\ORMTestInfrastructure\MemorizingObjectManagerDecorator as it is not needed anymore: there are no more selective detach() calls`after imports

1.4.6 -> 1.5.0

Introduced ConnectionConfiguration to explicitly define the type of database connection (#15)
Added support for simple SQLite file databases via FileDatabaseConnectionConfiguration; useful when data must persist for some time, but the connection is reset, e.g. in Symfony's Functional Tests

Create file-backed database:

$configuration = new FileDatabaseConnectionConfiguration();
$infrastructure = ORMInfrastructure::createOnlyFor(
    MyEntity::class,
    $configuration
);
// Used database file:
echo $configuration->getDatabaseFile();

1.4.5 -> 1.4.6

Ignore associations against interfaces when detecting dependencies via ORMInfrastructure::createWithDependenciesFor to avoid errors
Exposed event manager and created helper method to be able to register entity mappings

$infrastructure->registerEntityMapping(EntityInterface::class, EntityImplementation::class);

Do not rely on this "feature" if you don't have to. Might be restructured in future versions.

1.4.4 -> 1.4.5

Fixed bug #20: Entities might have been imported twice in case of bidirectional cascade
Deprecated class Webfactory\Doctrine\ORMTestInfrastructure\DetachingObjectManagerDecorator (will be removed in next major release)

1.4.3 -> 1.4.4

Improved garbage collection
Dropped support for PHP < 5.5
Officially support PHP 7

Known Issues

Please note that apart from any open issues in this library, you may stumble upon any Doctrine issues. Especially take care of it's known sqlite issues.

Credits, Copyright and License

This package was first written by webfactory GmbH (Bonn, Germany) and received contributions from other people since then.

webfactory is a software development agency with a focus on PHP (mostly Symfony). If you're a developer looking for new challenges, we'd like to hear from you!

https://www.webfactory.de

webfactory / doctrine-orm-test-infrastructure

Maintainers

Details